1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) ST-Ericsson AB 2012
5 * Main and Back-up battery management driver.
7 * Note: Backup battery management is required in case of Li-Ion battery and not
8 * for capacitive battery. HREF boards have capacitive battery and hence backup
9 * battery management is not used and the supported code is available in this
13 * Johan Palsson <johan.palsson@stericsson.com>
14 * Karl Komierowski <karl.komierowski@stericsson.com>
15 * Arun R Murthy <arun.murthy@stericsson.com>
18 #include <linux/init.h>
19 #include <linux/module.h>
20 #include <linux/component.h>
21 #include <linux/device.h>
22 #include <linux/interrupt.h>
23 #include <linux/platform_device.h>
24 #include <linux/power_supply.h>
25 #include <linux/kobject.h>
26 #include <linux/slab.h>
27 #include <linux/delay.h>
28 #include <linux/time.h>
29 #include <linux/time64.h>
31 #include <linux/completion.h>
32 #include <linux/mfd/core.h>
33 #include <linux/mfd/abx500.h>
34 #include <linux/mfd/abx500/ab8500.h>
35 #include <linux/iio/consumer.h>
36 #include <linux/kernel.h>
37 #include <linux/fixp-arith.h>
39 #include "ab8500-bm.h"
41 #define FG_LSB_IN_MA 1627
42 #define QLSB_NANO_AMP_HOURS_X10 1071
43 #define INS_CURR_TIMEOUT (3 * HZ)
45 #define SEC_TO_SAMPLE(S) (S * 4)
47 #define NBR_AVG_SAMPLES 20
49 #define LOW_BAT_CHECK_INTERVAL (HZ / 16) /* 62.5 ms */
51 #define VALID_CAPACITY_SEC (45 * 60) /* 45 minutes */
52 #define BATT_OK_MIN 2360 /* mV */
53 #define BATT_OK_INCREMENT 50 /* mV */
54 #define BATT_OK_MAX_NR_INCREMENTS 0xE
60 * struct ab8500_fg_interrupts - ab8500 fg interrupts
61 * @name: name of the interrupt
62 * @isr function pointer to the isr
64 struct ab8500_fg_interrupts {
66 irqreturn_t (*isr)(int irq, void *data);
69 enum ab8500_fg_discharge_state {
70 AB8500_FG_DISCHARGE_INIT,
71 AB8500_FG_DISCHARGE_INITMEASURING,
72 AB8500_FG_DISCHARGE_INIT_RECOVERY,
73 AB8500_FG_DISCHARGE_RECOVERY,
74 AB8500_FG_DISCHARGE_READOUT_INIT,
75 AB8500_FG_DISCHARGE_READOUT,
76 AB8500_FG_DISCHARGE_WAKEUP,
79 static char *discharge_state[] = {
81 "DISCHARGE_INITMEASURING",
82 "DISCHARGE_INIT_RECOVERY",
84 "DISCHARGE_READOUT_INIT",
89 enum ab8500_fg_charge_state {
90 AB8500_FG_CHARGE_INIT,
91 AB8500_FG_CHARGE_READOUT,
94 static char *charge_state[] = {
99 enum ab8500_fg_calibration_state {
100 AB8500_FG_CALIB_INIT,
101 AB8500_FG_CALIB_WAIT,
105 struct ab8500_fg_avg_cap {
107 int samples[NBR_AVG_SAMPLES];
108 time64_t time_stamps[NBR_AVG_SAMPLES];
114 struct ab8500_fg_cap_scaling {
117 int disable_cap_level;
121 struct ab8500_fg_battery_capacity {
131 struct ab8500_fg_cap_scaling cap_scale;
134 struct ab8500_fg_flags {
146 bool batt_id_received;
149 struct inst_curr_result_list {
150 struct list_head list;
155 * struct ab8500_fg - ab8500 FG device information
156 * @dev: Pointer to the structure device
157 * @node: a list of AB8500 FGs, hence prepared for reentrance
158 * @irq holds the CCEOC interrupt number
159 * @vbat_uv: Battery voltage in uV
160 * @vbat_nom_uv: Nominal battery voltage in uV
161 * @inst_curr_ua: Instantenous battery current in uA
162 * @avg_curr_ua: Average battery current in uA
163 * @bat_temp battery temperature
164 * @fg_samples: Number of samples used in the FG accumulation
165 * @accu_charge: Accumulated charge from the last conversion
166 * @recovery_cnt: Counter for recovery mode
167 * @high_curr_cnt: Counter for high current mode
168 * @init_cnt: Counter for init mode
169 * @low_bat_cnt Counter for number of consecutive low battery measures
170 * @nbr_cceoc_irq_cnt Counter for number of CCEOC irqs received since enabled
171 * @recovery_needed: Indicate if recovery is needed
172 * @high_curr_mode: Indicate if we're in high current mode
173 * @init_capacity: Indicate if initial capacity measuring should be done
174 * @turn_off_fg: True if fg was off before current measurement
175 * @calib_state State during offset calibration
176 * @discharge_state: Current discharge state
177 * @charge_state: Current charge state
178 * @ab8500_fg_started Completion struct used for the instant current start
179 * @ab8500_fg_complete Completion struct used for the instant current reading
180 * @flags: Structure for information about events triggered
181 * @bat_cap: Structure for battery capacity specific parameters
182 * @avg_cap: Average capacity filter
183 * @parent: Pointer to the struct ab8500
184 * @main_bat_v: ADC channel for the main battery voltage
185 * @bm: Platform specific battery management information
186 * @fg_psy: Structure that holds the FG specific battery properties
187 * @fg_wq: Work queue for running the FG algorithm
188 * @fg_periodic_work: Work to run the FG algorithm periodically
189 * @fg_low_bat_work: Work to check low bat condition
190 * @fg_reinit_work Work used to reset and reinitialise the FG algorithm
191 * @fg_work: Work to run the FG algorithm instantly
192 * @fg_acc_cur_work: Work to read the FG accumulator
193 * @fg_check_hw_failure_work: Work for checking HW state
194 * @cc_lock: Mutex for locking the CC
195 * @fg_kobject: Structure of type kobject
199 struct list_head node;
212 int nbr_cceoc_irq_cnt;
213 bool recovery_needed;
217 enum ab8500_fg_calibration_state calib_state;
218 enum ab8500_fg_discharge_state discharge_state;
219 enum ab8500_fg_charge_state charge_state;
220 struct completion ab8500_fg_started;
221 struct completion ab8500_fg_complete;
222 struct ab8500_fg_flags flags;
223 struct ab8500_fg_battery_capacity bat_cap;
224 struct ab8500_fg_avg_cap avg_cap;
225 struct ab8500 *parent;
226 struct iio_channel *main_bat_v;
227 struct ab8500_bm_data *bm;
228 struct power_supply *fg_psy;
229 struct workqueue_struct *fg_wq;
230 struct delayed_work fg_periodic_work;
231 struct delayed_work fg_low_bat_work;
232 struct delayed_work fg_reinit_work;
233 struct work_struct fg_work;
234 struct work_struct fg_acc_cur_work;
235 struct delayed_work fg_check_hw_failure_work;
236 struct mutex cc_lock;
237 struct kobject fg_kobject;
239 static LIST_HEAD(ab8500_fg_list);
242 * ab8500_fg_get() - returns a reference to the primary AB8500 fuel gauge
243 * (i.e. the first fuel gauge in the instance list)
245 struct ab8500_fg *ab8500_fg_get(void)
247 return list_first_entry_or_null(&ab8500_fg_list, struct ab8500_fg,
251 /* Main battery properties */
252 static enum power_supply_property ab8500_fg_props[] = {
253 POWER_SUPPLY_PROP_VOLTAGE_NOW,
254 POWER_SUPPLY_PROP_CURRENT_NOW,
255 POWER_SUPPLY_PROP_CURRENT_AVG,
256 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
257 POWER_SUPPLY_PROP_ENERGY_FULL,
258 POWER_SUPPLY_PROP_ENERGY_NOW,
259 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
260 POWER_SUPPLY_PROP_CHARGE_FULL,
261 POWER_SUPPLY_PROP_CHARGE_NOW,
262 POWER_SUPPLY_PROP_CAPACITY,
263 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
267 * This array maps the raw hex value to lowbat voltage used by the AB8500
268 * Values taken from the UM0836, in microvolts.
270 static int ab8500_fg_lowbat_voltage_map[] = {
337 static u8 ab8500_volt_to_regval(int voltage_uv)
341 if (voltage_uv < ab8500_fg_lowbat_voltage_map[0])
344 for (i = 0; i < ARRAY_SIZE(ab8500_fg_lowbat_voltage_map); i++) {
345 if (voltage_uv < ab8500_fg_lowbat_voltage_map[i])
349 /* If not captured above, return index of last element */
350 return (u8) ARRAY_SIZE(ab8500_fg_lowbat_voltage_map) - 1;
354 * ab8500_fg_is_low_curr() - Low or high current mode
355 * @di: pointer to the ab8500_fg structure
356 * @curr_ua: the current to base or our decision on in microampere
358 * Low current mode if the current consumption is below a certain threshold
360 static int ab8500_fg_is_low_curr(struct ab8500_fg *di, int curr_ua)
363 * We want to know if we're in low current mode
365 if (curr_ua > -di->bm->fg_params->high_curr_threshold_ua)
372 * ab8500_fg_add_cap_sample() - Add capacity to average filter
373 * @di: pointer to the ab8500_fg structure
374 * @sample: the capacity in mAh to add to the filter
376 * A capacity is added to the filter and a new mean capacity is calculated and
379 static int ab8500_fg_add_cap_sample(struct ab8500_fg *di, int sample)
381 time64_t now = ktime_get_boottime_seconds();
382 struct ab8500_fg_avg_cap *avg = &di->avg_cap;
385 avg->sum += sample - avg->samples[avg->pos];
386 avg->samples[avg->pos] = sample;
387 avg->time_stamps[avg->pos] = now;
390 if (avg->pos == NBR_AVG_SAMPLES)
393 if (avg->nbr_samples < NBR_AVG_SAMPLES)
397 * Check the time stamp for each sample. If too old,
398 * replace with latest sample
400 } while (now - VALID_CAPACITY_SEC > avg->time_stamps[avg->pos]);
402 avg->avg = avg->sum / avg->nbr_samples;
408 * ab8500_fg_clear_cap_samples() - Clear average filter
409 * @di: pointer to the ab8500_fg structure
411 * The capacity filter is is reset to zero.
413 static void ab8500_fg_clear_cap_samples(struct ab8500_fg *di)
416 struct ab8500_fg_avg_cap *avg = &di->avg_cap;
419 avg->nbr_samples = 0;
423 for (i = 0; i < NBR_AVG_SAMPLES; i++) {
425 avg->time_stamps[i] = 0;
430 * ab8500_fg_fill_cap_sample() - Fill average filter
431 * @di: pointer to the ab8500_fg structure
432 * @sample: the capacity in mAh to fill the filter with
434 * The capacity filter is filled with a capacity in mAh
436 static void ab8500_fg_fill_cap_sample(struct ab8500_fg *di, int sample)
440 struct ab8500_fg_avg_cap *avg = &di->avg_cap;
442 now = ktime_get_boottime_seconds();
444 for (i = 0; i < NBR_AVG_SAMPLES; i++) {
445 avg->samples[i] = sample;
446 avg->time_stamps[i] = now;
450 avg->nbr_samples = NBR_AVG_SAMPLES;
451 avg->sum = sample * NBR_AVG_SAMPLES;
456 * ab8500_fg_coulomb_counter() - enable coulomb counter
457 * @di: pointer to the ab8500_fg structure
458 * @enable: enable/disable
460 * Enable/Disable coulomb counter.
461 * On failure returns negative value.
463 static int ab8500_fg_coulomb_counter(struct ab8500_fg *di, bool enable)
466 mutex_lock(&di->cc_lock);
468 /* To be able to reprogram the number of samples, we have to
469 * first stop the CC and then enable it again */
470 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
471 AB8500_RTC_CC_CONF_REG, 0x00);
475 /* Program the samples */
476 ret = abx500_set_register_interruptible(di->dev,
477 AB8500_GAS_GAUGE, AB8500_GASG_CC_NCOV_ACCU,
483 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
484 AB8500_RTC_CC_CONF_REG,
485 (CC_DEEP_SLEEP_ENA | CC_PWR_UP_ENA));
489 di->flags.fg_enabled = true;
491 /* Clear any pending read requests */
492 ret = abx500_mask_and_set_register_interruptible(di->dev,
493 AB8500_GAS_GAUGE, AB8500_GASG_CC_CTRL_REG,
494 (RESET_ACCU | READ_REQ), 0);
498 ret = abx500_set_register_interruptible(di->dev,
499 AB8500_GAS_GAUGE, AB8500_GASG_CC_NCOV_ACCU_CTRL, 0);
504 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
505 AB8500_RTC_CC_CONF_REG, 0);
509 di->flags.fg_enabled = false;
512 dev_dbg(di->dev, " CC enabled: %d Samples: %d\n",
513 enable, di->fg_samples);
515 mutex_unlock(&di->cc_lock);
519 dev_err(di->dev, "%s Enabling coulomb counter failed\n", __func__);
520 mutex_unlock(&di->cc_lock);
525 * ab8500_fg_inst_curr_start() - start battery instantaneous current
526 * @di: pointer to the ab8500_fg structure
528 * Returns 0 or error code
529 * Note: This is part "one" and has to be called before
530 * ab8500_fg_inst_curr_finalize()
532 int ab8500_fg_inst_curr_start(struct ab8500_fg *di)
537 mutex_lock(&di->cc_lock);
539 di->nbr_cceoc_irq_cnt = 0;
540 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
541 AB8500_RTC_CC_CONF_REG, ®_val);
545 if (!(reg_val & CC_PWR_UP_ENA)) {
546 dev_dbg(di->dev, "%s Enable FG\n", __func__);
547 di->turn_off_fg = true;
549 /* Program the samples */
550 ret = abx500_set_register_interruptible(di->dev,
551 AB8500_GAS_GAUGE, AB8500_GASG_CC_NCOV_ACCU,
557 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
558 AB8500_RTC_CC_CONF_REG,
559 (CC_DEEP_SLEEP_ENA | CC_PWR_UP_ENA));
563 di->turn_off_fg = false;
567 reinit_completion(&di->ab8500_fg_started);
568 reinit_completion(&di->ab8500_fg_complete);
571 /* Note: cc_lock is still locked */
574 mutex_unlock(&di->cc_lock);
579 * ab8500_fg_inst_curr_started() - check if fg conversion has started
580 * @di: pointer to the ab8500_fg structure
582 * Returns 1 if conversion started, 0 if still waiting
584 int ab8500_fg_inst_curr_started(struct ab8500_fg *di)
586 return completion_done(&di->ab8500_fg_started);
590 * ab8500_fg_inst_curr_done() - check if fg conversion is done
591 * @di: pointer to the ab8500_fg structure
593 * Returns 1 if conversion done, 0 if still waiting
595 int ab8500_fg_inst_curr_done(struct ab8500_fg *di)
597 return completion_done(&di->ab8500_fg_complete);
601 * ab8500_fg_inst_curr_finalize() - battery instantaneous current
602 * @di: pointer to the ab8500_fg structure
603 * @curr_ua: battery instantenous current in microampere (on success)
605 * Returns 0 or an error code
606 * Note: This is part "two" and has to be called at earliest 250 ms
607 * after ab8500_fg_inst_curr_start()
609 int ab8500_fg_inst_curr_finalize(struct ab8500_fg *di, int *curr_ua)
614 unsigned long timeout;
616 if (!completion_done(&di->ab8500_fg_complete)) {
617 timeout = wait_for_completion_timeout(
618 &di->ab8500_fg_complete,
620 dev_dbg(di->dev, "Finalize time: %d ms\n",
621 jiffies_to_msecs(INS_CURR_TIMEOUT - timeout));
624 disable_irq(di->irq);
625 di->nbr_cceoc_irq_cnt = 0;
626 dev_err(di->dev, "completion timed out [%d]\n",
632 disable_irq(di->irq);
633 di->nbr_cceoc_irq_cnt = 0;
635 ret = abx500_mask_and_set_register_interruptible(di->dev,
636 AB8500_GAS_GAUGE, AB8500_GASG_CC_CTRL_REG,
639 /* 100uS between read request and read is needed */
640 usleep_range(100, 100);
642 /* Read CC Sample conversion value Low and high */
643 ret = abx500_get_register_interruptible(di->dev, AB8500_GAS_GAUGE,
644 AB8500_GASG_CC_SMPL_CNVL_REG, &low);
648 ret = abx500_get_register_interruptible(di->dev, AB8500_GAS_GAUGE,
649 AB8500_GASG_CC_SMPL_CNVH_REG, &high);
654 * negative value for Discharging
655 * convert 2's complement into decimal
658 val = (low | (high << 8) | 0xFFFFE000);
660 val = (low | (high << 8));
663 * Convert to unit value in mA
664 * Full scale input voltage is
665 * 63.160mV => LSB = 63.160mV/(4096*res) = 1.542.000 uA
666 * Given a 250ms conversion cycle time the LSB corresponds
667 * to 107.1 nAh. Convert to current by dividing by the conversion
668 * time in hours (250ms = 1 / (3600 * 4)h)
669 * 107.1nAh assumes 10mOhm, but fg_res is in 0.1mOhm
671 val = (val * QLSB_NANO_AMP_HOURS_X10 * 36 * 4) / di->bm->fg_res;
673 if (di->turn_off_fg) {
674 dev_dbg(di->dev, "%s Disable FG\n", __func__);
676 /* Clear any pending read requests */
677 ret = abx500_set_register_interruptible(di->dev,
678 AB8500_GAS_GAUGE, AB8500_GASG_CC_CTRL_REG, 0);
683 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
684 AB8500_RTC_CC_CONF_REG, 0);
688 mutex_unlock(&di->cc_lock);
693 mutex_unlock(&di->cc_lock);
698 * ab8500_fg_inst_curr_blocking() - battery instantaneous current
699 * @di: pointer to the ab8500_fg structure
701 * Returns battery instantenous current in microampere (on success)
704 int ab8500_fg_inst_curr_blocking(struct ab8500_fg *di)
707 unsigned long timeout;
710 ret = ab8500_fg_inst_curr_start(di);
712 dev_err(di->dev, "Failed to initialize fg_inst\n");
716 /* Wait for CC to actually start */
717 if (!completion_done(&di->ab8500_fg_started)) {
718 timeout = wait_for_completion_timeout(
719 &di->ab8500_fg_started,
721 dev_dbg(di->dev, "Start time: %d ms\n",
722 jiffies_to_msecs(INS_CURR_TIMEOUT - timeout));
725 dev_err(di->dev, "completion timed out [%d]\n",
731 ret = ab8500_fg_inst_curr_finalize(di, &curr_ua);
733 dev_err(di->dev, "Failed to finalize fg_inst\n");
737 dev_dbg(di->dev, "%s instant current: %d uA", __func__, curr_ua);
740 disable_irq(di->irq);
741 mutex_unlock(&di->cc_lock);
746 * ab8500_fg_acc_cur_work() - average battery current
747 * @work: pointer to the work_struct structure
749 * Updated the average battery current obtained from the
752 static void ab8500_fg_acc_cur_work(struct work_struct *work)
758 struct ab8500_fg *di = container_of(work,
759 struct ab8500_fg, fg_acc_cur_work);
761 mutex_lock(&di->cc_lock);
762 ret = abx500_set_register_interruptible(di->dev, AB8500_GAS_GAUGE,
763 AB8500_GASG_CC_NCOV_ACCU_CTRL, RD_NCONV_ACCU_REQ);
767 ret = abx500_get_register_interruptible(di->dev, AB8500_GAS_GAUGE,
768 AB8500_GASG_CC_NCOV_ACCU_LOW, &low);
772 ret = abx500_get_register_interruptible(di->dev, AB8500_GAS_GAUGE,
773 AB8500_GASG_CC_NCOV_ACCU_MED, &med);
777 ret = abx500_get_register_interruptible(di->dev, AB8500_GAS_GAUGE,
778 AB8500_GASG_CC_NCOV_ACCU_HIGH, &high);
782 /* Check for sign bit in case of negative value, 2's complement */
784 val = (low | (med << 8) | (high << 16) | 0xFFE00000);
786 val = (low | (med << 8) | (high << 16));
790 * Given a 250ms conversion cycle time the LSB corresponds
792 * 112.9nAh assumes 10mOhm, but fg_res is in 0.1mOhm
794 di->accu_charge = (val * QLSB_NANO_AMP_HOURS_X10) /
795 (100 * di->bm->fg_res);
798 * Convert to unit value in uA
799 * by dividing by the conversion
800 * time in hours (= samples / (3600 * 4)h)
802 di->avg_curr_ua = (val * QLSB_NANO_AMP_HOURS_X10 * 36) /
803 (di->bm->fg_res * (di->fg_samples / 4));
805 di->flags.conv_done = true;
807 mutex_unlock(&di->cc_lock);
809 queue_work(di->fg_wq, &di->fg_work);
811 dev_dbg(di->dev, "fg_res: %d, fg_samples: %d, gasg: %d, accu_charge: %d \n",
812 di->bm->fg_res, di->fg_samples, val, di->accu_charge);
816 "Failed to read or write gas gauge registers\n");
817 mutex_unlock(&di->cc_lock);
818 queue_work(di->fg_wq, &di->fg_work);
822 * ab8500_fg_bat_voltage() - get battery voltage
823 * @di: pointer to the ab8500_fg structure
825 * Returns battery voltage in microvolts (on success) else error code
827 static int ab8500_fg_bat_voltage(struct ab8500_fg *di)
832 ret = iio_read_channel_processed(di->main_bat_v, &vbat);
835 "%s ADC conversion failed, using previous value\n",
840 /* IIO returns millivolts but we want microvolts */
847 * ab8500_fg_volt_to_capacity() - Voltage based capacity
848 * @di: pointer to the ab8500_fg structure
849 * @voltage_uv: The voltage to convert to a capacity in microvolt
851 * Returns battery capacity in per mille based on voltage
853 static int ab8500_fg_volt_to_capacity(struct ab8500_fg *di, int voltage_uv)
855 struct power_supply_battery_info *bi = di->bm->bi;
857 /* Multiply by 10 because the capacity is tracked in per mille */
858 return power_supply_batinfo_ocv2cap(bi, voltage_uv, di->bat_temp) * 10;
862 * ab8500_fg_uncomp_volt_to_capacity() - Uncompensated voltage based capacity
863 * @di: pointer to the ab8500_fg structure
865 * Returns battery capacity based on battery voltage that is not compensated
866 * for the voltage drop due to the load
868 static int ab8500_fg_uncomp_volt_to_capacity(struct ab8500_fg *di)
870 di->vbat_uv = ab8500_fg_bat_voltage(di);
871 return ab8500_fg_volt_to_capacity(di, di->vbat_uv);
875 * ab8500_fg_battery_resistance() - Returns the battery inner resistance
876 * @di: pointer to the ab8500_fg structure
878 * Returns battery inner resistance added with the fuel gauge resistor value
879 * to get the total resistance in the whole link from gnd to bat+ node
882 static int ab8500_fg_battery_resistance(struct ab8500_fg *di)
884 struct power_supply_battery_info *bi = di->bm->bi;
885 int resistance_percent = 0;
888 resistance_percent = power_supply_temp2resist_simple(bi->resist_table,
889 bi->resist_table_size,
892 * We get a percentage of factory resistance here so first get
893 * the factory resistance in milliohms then calculate how much
894 * resistance we have at this temperature.
896 resistance = (bi->factory_internal_resistance_uohm / 1000);
897 resistance = resistance * resistance_percent / 100;
899 dev_dbg(di->dev, "%s Temp: %d battery internal resistance: %d"
900 " fg resistance %d, total: %d (mOhm)\n",
901 __func__, di->bat_temp, resistance, di->bm->fg_res / 10,
902 (di->bm->fg_res / 10) + resistance);
904 /* fg_res variable is in 0.1mOhm */
905 resistance += di->bm->fg_res / 10;
911 * ab8500_fg_load_comp_volt_to_capacity() - Load compensated voltage based capacity
912 * @di: pointer to the ab8500_fg structure
914 * Returns battery capacity based on battery voltage that is load compensated
915 * for the voltage drop
917 static int ab8500_fg_load_comp_volt_to_capacity(struct ab8500_fg *di)
919 int vbat_comp_uv, res;
923 ab8500_fg_inst_curr_start(di);
926 vbat_uv += ab8500_fg_bat_voltage(di);
928 usleep_range(5000, 6000);
929 } while (!ab8500_fg_inst_curr_done(di));
931 ab8500_fg_inst_curr_finalize(di, &di->inst_curr_ua);
933 di->vbat_uv = vbat_uv / i;
934 res = ab8500_fg_battery_resistance(di);
937 * Use Ohms law to get the load compensated voltage.
938 * Divide by 1000 to get from milliohms to ohms.
940 vbat_comp_uv = di->vbat_uv - (di->inst_curr_ua * res) / 1000;
942 dev_dbg(di->dev, "%s Measured Vbat: %d uV,Compensated Vbat %d uV, "
943 "R: %d mOhm, Current: %d uA Vbat Samples: %d\n",
944 __func__, di->vbat_uv, vbat_comp_uv, res, di->inst_curr_ua, i);
946 return ab8500_fg_volt_to_capacity(di, vbat_comp_uv);
950 * ab8500_fg_convert_mah_to_permille() - Capacity in mAh to permille
951 * @di: pointer to the ab8500_fg structure
952 * @cap_mah: capacity in mAh
954 * Converts capacity in mAh to capacity in permille
956 static int ab8500_fg_convert_mah_to_permille(struct ab8500_fg *di, int cap_mah)
958 return (cap_mah * 1000) / di->bat_cap.max_mah_design;
962 * ab8500_fg_convert_permille_to_mah() - Capacity in permille to mAh
963 * @di: pointer to the ab8500_fg structure
964 * @cap_pm: capacity in permille
966 * Converts capacity in permille to capacity in mAh
968 static int ab8500_fg_convert_permille_to_mah(struct ab8500_fg *di, int cap_pm)
970 return cap_pm * di->bat_cap.max_mah_design / 1000;
974 * ab8500_fg_convert_mah_to_uwh() - Capacity in mAh to uWh
975 * @di: pointer to the ab8500_fg structure
976 * @cap_mah: capacity in mAh
978 * Converts capacity in mAh to capacity in uWh
980 static int ab8500_fg_convert_mah_to_uwh(struct ab8500_fg *di, int cap_mah)
986 * Capacity is in milli ampere hours (10^-3)Ah
987 * Nominal voltage is in microvolts (10^-6)V
988 * divide by 1000000 after multiplication to get to mWh
990 div_res = ((u64) cap_mah) * ((u64) di->vbat_nom_uv);
991 div_rem = do_div(div_res, 1000000);
993 /* Make sure to round upwards if necessary */
994 if (div_rem >= 1000000 / 2)
997 return (int) div_res;
1001 * ab8500_fg_calc_cap_charging() - Calculate remaining capacity while charging
1002 * @di: pointer to the ab8500_fg structure
1004 * Return the capacity in mAh based on previous calculated capcity and the FG
1005 * accumulator register value. The filter is filled with this capacity
1007 static int ab8500_fg_calc_cap_charging(struct ab8500_fg *di)
1009 dev_dbg(di->dev, "%s cap_mah %d accu_charge %d\n",
1014 /* Capacity should not be less than 0 */
1015 if (di->bat_cap.mah + di->accu_charge > 0)
1016 di->bat_cap.mah += di->accu_charge;
1018 di->bat_cap.mah = 0;
1020 * We force capacity to 100% once when the algorithm
1021 * reports that it's full.
1023 if (di->bat_cap.mah >= di->bat_cap.max_mah_design ||
1024 di->flags.force_full) {
1025 di->bat_cap.mah = di->bat_cap.max_mah_design;
1028 ab8500_fg_fill_cap_sample(di, di->bat_cap.mah);
1029 di->bat_cap.permille =
1030 ab8500_fg_convert_mah_to_permille(di, di->bat_cap.mah);
1032 /* We need to update battery voltage and inst current when charging */
1033 di->vbat_uv = ab8500_fg_bat_voltage(di);
1034 di->inst_curr_ua = ab8500_fg_inst_curr_blocking(di);
1036 return di->bat_cap.mah;
1040 * ab8500_fg_calc_cap_discharge_voltage() - Capacity in discharge with voltage
1041 * @di: pointer to the ab8500_fg structure
1042 * @comp: if voltage should be load compensated before capacity calc
1044 * Return the capacity in mAh based on the battery voltage. The voltage can
1045 * either be load compensated or not. This value is added to the filter and a
1046 * new mean value is calculated and returned.
1048 static int ab8500_fg_calc_cap_discharge_voltage(struct ab8500_fg *di, bool comp)
1053 permille = ab8500_fg_load_comp_volt_to_capacity(di);
1055 permille = ab8500_fg_uncomp_volt_to_capacity(di);
1057 mah = ab8500_fg_convert_permille_to_mah(di, permille);
1059 di->bat_cap.mah = ab8500_fg_add_cap_sample(di, mah);
1060 di->bat_cap.permille =
1061 ab8500_fg_convert_mah_to_permille(di, di->bat_cap.mah);
1063 return di->bat_cap.mah;
1067 * ab8500_fg_calc_cap_discharge_fg() - Capacity in discharge with FG
1068 * @di: pointer to the ab8500_fg structure
1070 * Return the capacity in mAh based on previous calculated capcity and the FG
1071 * accumulator register value. This value is added to the filter and a
1072 * new mean value is calculated and returned.
1074 static int ab8500_fg_calc_cap_discharge_fg(struct ab8500_fg *di)
1076 int permille_volt, permille;
1078 dev_dbg(di->dev, "%s cap_mah %d accu_charge %d\n",
1083 /* Capacity should not be less than 0 */
1084 if (di->bat_cap.mah + di->accu_charge > 0)
1085 di->bat_cap.mah += di->accu_charge;
1087 di->bat_cap.mah = 0;
1089 if (di->bat_cap.mah >= di->bat_cap.max_mah_design)
1090 di->bat_cap.mah = di->bat_cap.max_mah_design;
1093 * Check against voltage based capacity. It can not be lower
1094 * than what the uncompensated voltage says
1096 permille = ab8500_fg_convert_mah_to_permille(di, di->bat_cap.mah);
1097 permille_volt = ab8500_fg_uncomp_volt_to_capacity(di);
1099 if (permille < permille_volt) {
1100 di->bat_cap.permille = permille_volt;
1101 di->bat_cap.mah = ab8500_fg_convert_permille_to_mah(di,
1102 di->bat_cap.permille);
1104 dev_dbg(di->dev, "%s voltage based: perm %d perm_volt %d\n",
1109 ab8500_fg_fill_cap_sample(di, di->bat_cap.mah);
1111 ab8500_fg_fill_cap_sample(di, di->bat_cap.mah);
1112 di->bat_cap.permille =
1113 ab8500_fg_convert_mah_to_permille(di, di->bat_cap.mah);
1116 return di->bat_cap.mah;
1120 * ab8500_fg_capacity_level() - Get the battery capacity level
1121 * @di: pointer to the ab8500_fg structure
1123 * Get the battery capacity level based on the capacity in percent
1125 static int ab8500_fg_capacity_level(struct ab8500_fg *di)
1129 percent = DIV_ROUND_CLOSEST(di->bat_cap.permille, 10);
1131 if (percent <= di->bm->cap_levels->critical ||
1133 ret = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
1134 else if (percent <= di->bm->cap_levels->low)
1135 ret = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
1136 else if (percent <= di->bm->cap_levels->normal)
1137 ret = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
1138 else if (percent <= di->bm->cap_levels->high)
1139 ret = POWER_SUPPLY_CAPACITY_LEVEL_HIGH;
1141 ret = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
1147 * ab8500_fg_calculate_scaled_capacity() - Capacity scaling
1148 * @di: pointer to the ab8500_fg structure
1150 * Calculates the capacity to be shown to upper layers. Scales the capacity
1151 * to have 100% as a reference from the actual capacity upon removal of charger
1152 * when charging is in maintenance mode.
1154 static int ab8500_fg_calculate_scaled_capacity(struct ab8500_fg *di)
1156 struct ab8500_fg_cap_scaling *cs = &di->bat_cap.cap_scale;
1157 int capacity = di->bat_cap.prev_percent;
1163 * As long as we are in fully charge mode scale the capacity
1166 if (di->flags.fully_charged) {
1167 cs->cap_to_scale[0] = 100;
1168 cs->cap_to_scale[1] =
1169 max(capacity, di->bm->fg_params->maint_thres);
1170 dev_dbg(di->dev, "Scale cap with %d/%d\n",
1171 cs->cap_to_scale[0], cs->cap_to_scale[1]);
1174 /* Calculates the scaled capacity. */
1175 if ((cs->cap_to_scale[0] != cs->cap_to_scale[1])
1176 && (cs->cap_to_scale[1] > 0))
1178 DIV_ROUND_CLOSEST(di->bat_cap.prev_percent *
1179 cs->cap_to_scale[0],
1180 cs->cap_to_scale[1]));
1182 if (di->flags.charging) {
1183 if (capacity < cs->disable_cap_level) {
1184 cs->disable_cap_level = capacity;
1185 dev_dbg(di->dev, "Cap to stop scale lowered %d%%\n",
1186 cs->disable_cap_level);
1187 } else if (!di->flags.fully_charged) {
1188 if (di->bat_cap.prev_percent >=
1189 cs->disable_cap_level) {
1190 dev_dbg(di->dev, "Disabling scaled capacity\n");
1192 capacity = di->bat_cap.prev_percent;
1195 "Waiting in cap to level %d%%\n",
1196 cs->disable_cap_level);
1197 capacity = cs->disable_cap_level;
1206 * ab8500_fg_update_cap_scalers() - Capacity scaling
1207 * @di: pointer to the ab8500_fg structure
1209 * To be called when state change from charge<->discharge to update
1210 * the capacity scalers.
1212 static void ab8500_fg_update_cap_scalers(struct ab8500_fg *di)
1214 struct ab8500_fg_cap_scaling *cs = &di->bat_cap.cap_scale;
1218 if (di->flags.charging) {
1219 di->bat_cap.cap_scale.disable_cap_level =
1220 di->bat_cap.cap_scale.scaled_cap;
1221 dev_dbg(di->dev, "Cap to stop scale at charge %d%%\n",
1222 di->bat_cap.cap_scale.disable_cap_level);
1224 if (cs->scaled_cap != 100) {
1225 cs->cap_to_scale[0] = cs->scaled_cap;
1226 cs->cap_to_scale[1] = di->bat_cap.prev_percent;
1228 cs->cap_to_scale[0] = 100;
1229 cs->cap_to_scale[1] =
1230 max(di->bat_cap.prev_percent,
1231 di->bm->fg_params->maint_thres);
1234 dev_dbg(di->dev, "Cap to scale at discharge %d/%d\n",
1235 cs->cap_to_scale[0], cs->cap_to_scale[1]);
1240 * ab8500_fg_check_capacity_limits() - Check if capacity has changed
1241 * @di: pointer to the ab8500_fg structure
1242 * @init: capacity is allowed to go up in init mode
1244 * Check if capacity or capacity limit has changed and notify the system
1245 * about it using the power_supply framework
1247 static void ab8500_fg_check_capacity_limits(struct ab8500_fg *di, bool init)
1249 bool changed = false;
1250 int percent = DIV_ROUND_CLOSEST(di->bat_cap.permille, 10);
1252 di->bat_cap.level = ab8500_fg_capacity_level(di);
1254 if (di->bat_cap.level != di->bat_cap.prev_level) {
1256 * We do not allow reported capacity level to go up
1257 * unless we're charging or if we're in init
1259 if (!(!di->flags.charging && di->bat_cap.level >
1260 di->bat_cap.prev_level) || init) {
1261 dev_dbg(di->dev, "level changed from %d to %d\n",
1262 di->bat_cap.prev_level,
1264 di->bat_cap.prev_level = di->bat_cap.level;
1267 dev_dbg(di->dev, "level not allowed to go up "
1268 "since no charger is connected: %d to %d\n",
1269 di->bat_cap.prev_level,
1275 * If we have received the LOW_BAT IRQ, set capacity to 0 to initiate
1278 if (di->flags.low_bat) {
1279 dev_dbg(di->dev, "Battery low, set capacity to 0\n");
1280 di->bat_cap.prev_percent = 0;
1281 di->bat_cap.permille = 0;
1283 di->bat_cap.prev_mah = 0;
1284 di->bat_cap.mah = 0;
1286 } else if (di->flags.fully_charged) {
1288 * We report 100% if algorithm reported fully charged
1289 * and show 100% during maintenance charging (scaling).
1291 if (di->flags.force_full) {
1292 di->bat_cap.prev_percent = percent;
1293 di->bat_cap.prev_mah = di->bat_cap.mah;
1297 if (!di->bat_cap.cap_scale.enable &&
1298 di->bm->capacity_scaling) {
1299 di->bat_cap.cap_scale.enable = true;
1300 di->bat_cap.cap_scale.cap_to_scale[0] = 100;
1301 di->bat_cap.cap_scale.cap_to_scale[1] =
1302 di->bat_cap.prev_percent;
1303 di->bat_cap.cap_scale.disable_cap_level = 100;
1305 } else if (di->bat_cap.prev_percent != percent) {
1307 "battery reported full "
1308 "but capacity dropping: %d\n",
1310 di->bat_cap.prev_percent = percent;
1311 di->bat_cap.prev_mah = di->bat_cap.mah;
1315 } else if (di->bat_cap.prev_percent != percent) {
1318 * We will not report 0% unless we've got
1319 * the LOW_BAT IRQ, no matter what the FG
1322 di->bat_cap.prev_percent = 1;
1326 } else if (!(!di->flags.charging &&
1327 percent > di->bat_cap.prev_percent) || init) {
1329 * We do not allow reported capacity to go up
1330 * unless we're charging or if we're in init
1333 "capacity changed from %d to %d (%d)\n",
1334 di->bat_cap.prev_percent,
1336 di->bat_cap.permille);
1337 di->bat_cap.prev_percent = percent;
1338 di->bat_cap.prev_mah = di->bat_cap.mah;
1342 dev_dbg(di->dev, "capacity not allowed to go up since "
1343 "no charger is connected: %d to %d (%d)\n",
1344 di->bat_cap.prev_percent,
1346 di->bat_cap.permille);
1351 if (di->bm->capacity_scaling) {
1352 di->bat_cap.cap_scale.scaled_cap =
1353 ab8500_fg_calculate_scaled_capacity(di);
1355 dev_info(di->dev, "capacity=%d (%d)\n",
1356 di->bat_cap.prev_percent,
1357 di->bat_cap.cap_scale.scaled_cap);
1359 power_supply_changed(di->fg_psy);
1360 if (di->flags.fully_charged && di->flags.force_full) {
1361 dev_dbg(di->dev, "Battery full, notifying.\n");
1362 di->flags.force_full = false;
1363 sysfs_notify(&di->fg_kobject, NULL, "charge_full");
1365 sysfs_notify(&di->fg_kobject, NULL, "charge_now");
1369 static void ab8500_fg_charge_state_to(struct ab8500_fg *di,
1370 enum ab8500_fg_charge_state new_state)
1372 dev_dbg(di->dev, "Charge state from %d [%s] to %d [%s]\n",
1374 charge_state[di->charge_state],
1376 charge_state[new_state]);
1378 di->charge_state = new_state;
1381 static void ab8500_fg_discharge_state_to(struct ab8500_fg *di,
1382 enum ab8500_fg_discharge_state new_state)
1384 dev_dbg(di->dev, "Discharge state from %d [%s] to %d [%s]\n",
1385 di->discharge_state,
1386 discharge_state[di->discharge_state],
1388 discharge_state[new_state]);
1390 di->discharge_state = new_state;
1394 * ab8500_fg_algorithm_charging() - FG algorithm for when charging
1395 * @di: pointer to the ab8500_fg structure
1397 * Battery capacity calculation state machine for when we're charging
1399 static void ab8500_fg_algorithm_charging(struct ab8500_fg *di)
1402 * If we change to discharge mode
1403 * we should start with recovery
1405 if (di->discharge_state != AB8500_FG_DISCHARGE_INIT_RECOVERY)
1406 ab8500_fg_discharge_state_to(di,
1407 AB8500_FG_DISCHARGE_INIT_RECOVERY);
1409 switch (di->charge_state) {
1410 case AB8500_FG_CHARGE_INIT:
1411 di->fg_samples = SEC_TO_SAMPLE(
1412 di->bm->fg_params->accu_charging);
1414 ab8500_fg_coulomb_counter(di, true);
1415 ab8500_fg_charge_state_to(di, AB8500_FG_CHARGE_READOUT);
1419 case AB8500_FG_CHARGE_READOUT:
1421 * Read the FG and calculate the new capacity
1423 mutex_lock(&di->cc_lock);
1424 if (!di->flags.conv_done && !di->flags.force_full) {
1425 /* Wasn't the CC IRQ that got us here */
1426 mutex_unlock(&di->cc_lock);
1427 dev_dbg(di->dev, "%s CC conv not done\n",
1432 di->flags.conv_done = false;
1433 mutex_unlock(&di->cc_lock);
1435 ab8500_fg_calc_cap_charging(di);
1443 /* Check capacity limits */
1444 ab8500_fg_check_capacity_limits(di, false);
1447 static void force_capacity(struct ab8500_fg *di)
1451 ab8500_fg_clear_cap_samples(di);
1452 cap = di->bat_cap.user_mah;
1453 if (cap > di->bat_cap.max_mah_design) {
1454 dev_dbg(di->dev, "Remaining cap %d can't be bigger than total"
1455 " %d\n", cap, di->bat_cap.max_mah_design);
1456 cap = di->bat_cap.max_mah_design;
1458 ab8500_fg_fill_cap_sample(di, di->bat_cap.user_mah);
1459 di->bat_cap.permille = ab8500_fg_convert_mah_to_permille(di, cap);
1460 di->bat_cap.mah = cap;
1461 ab8500_fg_check_capacity_limits(di, true);
1464 static bool check_sysfs_capacity(struct ab8500_fg *di)
1466 int cap, lower, upper;
1469 cap = di->bat_cap.user_mah;
1471 cap_permille = ab8500_fg_convert_mah_to_permille(di,
1472 di->bat_cap.user_mah);
1474 lower = di->bat_cap.permille - di->bm->fg_params->user_cap_limit * 10;
1475 upper = di->bat_cap.permille + di->bm->fg_params->user_cap_limit * 10;
1479 /* 1000 is permille, -> 100 percent */
1483 dev_dbg(di->dev, "Capacity limits:"
1484 " (Lower: %d User: %d Upper: %d) [user: %d, was: %d]\n",
1485 lower, cap_permille, upper, cap, di->bat_cap.mah);
1487 /* If within limits, use the saved capacity and exit estimation...*/
1488 if (cap_permille > lower && cap_permille < upper) {
1489 dev_dbg(di->dev, "OK! Using users cap %d uAh now\n", cap);
1493 dev_dbg(di->dev, "Capacity from user out of limits, ignoring");
1498 * ab8500_fg_algorithm_discharging() - FG algorithm for when discharging
1499 * @di: pointer to the ab8500_fg structure
1501 * Battery capacity calculation state machine for when we're discharging
1503 static void ab8500_fg_algorithm_discharging(struct ab8500_fg *di)
1507 /* If we change to charge mode we should start with init */
1508 if (di->charge_state != AB8500_FG_CHARGE_INIT)
1509 ab8500_fg_charge_state_to(di, AB8500_FG_CHARGE_INIT);
1511 switch (di->discharge_state) {
1512 case AB8500_FG_DISCHARGE_INIT:
1513 /* We use the FG IRQ to work on */
1515 di->fg_samples = SEC_TO_SAMPLE(di->bm->fg_params->init_timer);
1516 ab8500_fg_coulomb_counter(di, true);
1517 ab8500_fg_discharge_state_to(di,
1518 AB8500_FG_DISCHARGE_INITMEASURING);
1521 case AB8500_FG_DISCHARGE_INITMEASURING:
1523 * Discard a number of samples during startup.
1524 * After that, use compensated voltage for a few
1525 * samples to get an initial capacity.
1526 * Then go to READOUT
1528 sleep_time = di->bm->fg_params->init_timer;
1530 /* Discard the first [x] seconds */
1531 if (di->init_cnt > di->bm->fg_params->init_discard_time) {
1532 ab8500_fg_calc_cap_discharge_voltage(di, true);
1534 ab8500_fg_check_capacity_limits(di, true);
1537 di->init_cnt += sleep_time;
1538 if (di->init_cnt > di->bm->fg_params->init_total_time)
1539 ab8500_fg_discharge_state_to(di,
1540 AB8500_FG_DISCHARGE_READOUT_INIT);
1544 case AB8500_FG_DISCHARGE_INIT_RECOVERY:
1545 di->recovery_cnt = 0;
1546 di->recovery_needed = true;
1547 ab8500_fg_discharge_state_to(di,
1548 AB8500_FG_DISCHARGE_RECOVERY);
1552 case AB8500_FG_DISCHARGE_RECOVERY:
1553 sleep_time = di->bm->fg_params->recovery_sleep_timer;
1556 * We should check the power consumption
1557 * If low, go to READOUT (after x min) or
1558 * RECOVERY_SLEEP if time left.
1559 * If high, go to READOUT
1561 di->inst_curr_ua = ab8500_fg_inst_curr_blocking(di);
1563 if (ab8500_fg_is_low_curr(di, di->inst_curr_ua)) {
1564 if (di->recovery_cnt >
1565 di->bm->fg_params->recovery_total_time) {
1566 di->fg_samples = SEC_TO_SAMPLE(
1567 di->bm->fg_params->accu_high_curr);
1568 ab8500_fg_coulomb_counter(di, true);
1569 ab8500_fg_discharge_state_to(di,
1570 AB8500_FG_DISCHARGE_READOUT);
1571 di->recovery_needed = false;
1573 queue_delayed_work(di->fg_wq,
1574 &di->fg_periodic_work,
1577 di->recovery_cnt += sleep_time;
1579 di->fg_samples = SEC_TO_SAMPLE(
1580 di->bm->fg_params->accu_high_curr);
1581 ab8500_fg_coulomb_counter(di, true);
1582 ab8500_fg_discharge_state_to(di,
1583 AB8500_FG_DISCHARGE_READOUT);
1587 case AB8500_FG_DISCHARGE_READOUT_INIT:
1588 di->fg_samples = SEC_TO_SAMPLE(
1589 di->bm->fg_params->accu_high_curr);
1590 ab8500_fg_coulomb_counter(di, true);
1591 ab8500_fg_discharge_state_to(di,
1592 AB8500_FG_DISCHARGE_READOUT);
1595 case AB8500_FG_DISCHARGE_READOUT:
1596 di->inst_curr_ua = ab8500_fg_inst_curr_blocking(di);
1598 if (ab8500_fg_is_low_curr(di, di->inst_curr_ua)) {
1599 /* Detect mode change */
1600 if (di->high_curr_mode) {
1601 di->high_curr_mode = false;
1602 di->high_curr_cnt = 0;
1605 if (di->recovery_needed) {
1606 ab8500_fg_discharge_state_to(di,
1607 AB8500_FG_DISCHARGE_INIT_RECOVERY);
1609 queue_delayed_work(di->fg_wq,
1610 &di->fg_periodic_work, 0);
1615 ab8500_fg_calc_cap_discharge_voltage(di, true);
1617 mutex_lock(&di->cc_lock);
1618 if (!di->flags.conv_done) {
1619 /* Wasn't the CC IRQ that got us here */
1620 mutex_unlock(&di->cc_lock);
1621 dev_dbg(di->dev, "%s CC conv not done\n",
1626 di->flags.conv_done = false;
1627 mutex_unlock(&di->cc_lock);
1629 /* Detect mode change */
1630 if (!di->high_curr_mode) {
1631 di->high_curr_mode = true;
1632 di->high_curr_cnt = 0;
1635 di->high_curr_cnt +=
1636 di->bm->fg_params->accu_high_curr;
1637 if (di->high_curr_cnt >
1638 di->bm->fg_params->high_curr_time)
1639 di->recovery_needed = true;
1641 ab8500_fg_calc_cap_discharge_fg(di);
1644 ab8500_fg_check_capacity_limits(di, false);
1648 case AB8500_FG_DISCHARGE_WAKEUP:
1649 ab8500_fg_calc_cap_discharge_voltage(di, true);
1651 di->fg_samples = SEC_TO_SAMPLE(
1652 di->bm->fg_params->accu_high_curr);
1653 ab8500_fg_coulomb_counter(di, true);
1654 ab8500_fg_discharge_state_to(di,
1655 AB8500_FG_DISCHARGE_READOUT);
1657 ab8500_fg_check_capacity_limits(di, false);
1667 * ab8500_fg_algorithm_calibrate() - Internal columb counter offset calibration
1668 * @di: pointer to the ab8500_fg structure
1671 static void ab8500_fg_algorithm_calibrate(struct ab8500_fg *di)
1675 switch (di->calib_state) {
1676 case AB8500_FG_CALIB_INIT:
1677 dev_dbg(di->dev, "Calibration ongoing...\n");
1679 ret = abx500_mask_and_set_register_interruptible(di->dev,
1680 AB8500_GAS_GAUGE, AB8500_GASG_CC_CTRL_REG,
1681 CC_INT_CAL_N_AVG_MASK, CC_INT_CAL_SAMPLES_8);
1685 ret = abx500_mask_and_set_register_interruptible(di->dev,
1686 AB8500_GAS_GAUGE, AB8500_GASG_CC_CTRL_REG,
1687 CC_INTAVGOFFSET_ENA, CC_INTAVGOFFSET_ENA);
1690 di->calib_state = AB8500_FG_CALIB_WAIT;
1692 case AB8500_FG_CALIB_END:
1693 ret = abx500_mask_and_set_register_interruptible(di->dev,
1694 AB8500_GAS_GAUGE, AB8500_GASG_CC_CTRL_REG,
1695 CC_MUXOFFSET, CC_MUXOFFSET);
1698 di->flags.calibrate = false;
1699 dev_dbg(di->dev, "Calibration done...\n");
1700 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
1702 case AB8500_FG_CALIB_WAIT:
1703 dev_dbg(di->dev, "Calibration WFI\n");
1710 /* Something went wrong, don't calibrate then */
1711 dev_err(di->dev, "failed to calibrate the CC\n");
1712 di->flags.calibrate = false;
1713 di->calib_state = AB8500_FG_CALIB_INIT;
1714 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
1718 * ab8500_fg_algorithm() - Entry point for the FG algorithm
1719 * @di: pointer to the ab8500_fg structure
1721 * Entry point for the battery capacity calculation state machine
1723 static void ab8500_fg_algorithm(struct ab8500_fg *di)
1725 if (di->flags.calibrate)
1726 ab8500_fg_algorithm_calibrate(di);
1728 if (di->flags.charging)
1729 ab8500_fg_algorithm_charging(di);
1731 ab8500_fg_algorithm_discharging(di);
1734 dev_dbg(di->dev, "[FG_DATA] %d %d %d %d %d %d %d %d %d %d "
1735 "%d %d %d %d %d %d %d\n",
1736 di->bat_cap.max_mah_design,
1737 di->bat_cap.max_mah,
1739 di->bat_cap.permille,
1741 di->bat_cap.prev_mah,
1742 di->bat_cap.prev_percent,
1743 di->bat_cap.prev_level,
1750 di->discharge_state,
1752 di->recovery_needed);
1756 * ab8500_fg_periodic_work() - Run the FG state machine periodically
1757 * @work: pointer to the work_struct structure
1759 * Work queue function for periodic work
1761 static void ab8500_fg_periodic_work(struct work_struct *work)
1763 struct ab8500_fg *di = container_of(work, struct ab8500_fg,
1764 fg_periodic_work.work);
1766 if (di->init_capacity) {
1767 /* Get an initial capacity calculation */
1768 ab8500_fg_calc_cap_discharge_voltage(di, true);
1769 ab8500_fg_check_capacity_limits(di, true);
1770 di->init_capacity = false;
1772 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
1773 } else if (di->flags.user_cap) {
1774 if (check_sysfs_capacity(di)) {
1775 ab8500_fg_check_capacity_limits(di, true);
1776 if (di->flags.charging)
1777 ab8500_fg_charge_state_to(di,
1778 AB8500_FG_CHARGE_INIT);
1780 ab8500_fg_discharge_state_to(di,
1781 AB8500_FG_DISCHARGE_READOUT_INIT);
1783 di->flags.user_cap = false;
1784 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
1786 ab8500_fg_algorithm(di);
1791 * ab8500_fg_check_hw_failure_work() - Check OVV_BAT condition
1792 * @work: pointer to the work_struct structure
1794 * Work queue function for checking the OVV_BAT condition
1796 static void ab8500_fg_check_hw_failure_work(struct work_struct *work)
1801 struct ab8500_fg *di = container_of(work, struct ab8500_fg,
1802 fg_check_hw_failure_work.work);
1805 * If we have had a battery over-voltage situation,
1806 * check ovv-bit to see if it should be reset.
1808 ret = abx500_get_register_interruptible(di->dev,
1809 AB8500_CHARGER, AB8500_CH_STAT_REG,
1812 dev_err(di->dev, "%s ab8500 read failed\n", __func__);
1815 if ((reg_value & BATT_OVV) == BATT_OVV) {
1816 if (!di->flags.bat_ovv) {
1817 dev_dbg(di->dev, "Battery OVV\n");
1818 di->flags.bat_ovv = true;
1819 power_supply_changed(di->fg_psy);
1821 /* Not yet recovered from ovv, reschedule this test */
1822 queue_delayed_work(di->fg_wq, &di->fg_check_hw_failure_work,
1825 dev_dbg(di->dev, "Battery recovered from OVV\n");
1826 di->flags.bat_ovv = false;
1827 power_supply_changed(di->fg_psy);
1832 * ab8500_fg_low_bat_work() - Check LOW_BAT condition
1833 * @work: pointer to the work_struct structure
1835 * Work queue function for checking the LOW_BAT condition
1837 static void ab8500_fg_low_bat_work(struct work_struct *work)
1841 struct ab8500_fg *di = container_of(work, struct ab8500_fg,
1842 fg_low_bat_work.work);
1844 vbat_uv = ab8500_fg_bat_voltage(di);
1846 /* Check if LOW_BAT still fulfilled */
1847 if (vbat_uv < di->bm->fg_params->lowbat_threshold_uv) {
1848 /* Is it time to shut down? */
1849 if (di->low_bat_cnt < 1) {
1850 di->flags.low_bat = true;
1851 dev_warn(di->dev, "Shut down pending...\n");
1854 * Else we need to re-schedule this check to be able to detect
1855 * if the voltage increases again during charging or
1856 * due to decreasing load.
1859 dev_warn(di->dev, "Battery voltage still LOW\n");
1860 queue_delayed_work(di->fg_wq, &di->fg_low_bat_work,
1861 round_jiffies(LOW_BAT_CHECK_INTERVAL));
1864 di->flags.low_bat_delay = false;
1865 di->low_bat_cnt = 10;
1866 dev_warn(di->dev, "Battery voltage OK again\n");
1869 /* This is needed to dispatch LOW_BAT */
1870 ab8500_fg_check_capacity_limits(di, false);
1874 * ab8500_fg_battok_calc - calculate the bit pattern corresponding
1875 * to the target voltage.
1876 * @di: pointer to the ab8500_fg structure
1877 * @target: target voltage
1879 * Returns bit pattern closest to the target voltage
1880 * valid return values are 0-14. (0-BATT_OK_MAX_NR_INCREMENTS)
1883 static int ab8500_fg_battok_calc(struct ab8500_fg *di, int target)
1885 if (target > BATT_OK_MIN +
1886 (BATT_OK_INCREMENT * BATT_OK_MAX_NR_INCREMENTS))
1887 return BATT_OK_MAX_NR_INCREMENTS;
1888 if (target < BATT_OK_MIN)
1890 return (target - BATT_OK_MIN) / BATT_OK_INCREMENT;
1894 * ab8500_fg_battok_init_hw_register - init battok levels
1895 * @di: pointer to the ab8500_fg structure
1899 static int ab8500_fg_battok_init_hw_register(struct ab8500_fg *di)
1909 sel0 = di->bm->fg_params->battok_falling_th_sel0;
1910 sel1 = di->bm->fg_params->battok_raising_th_sel1;
1912 cbp_sel0 = ab8500_fg_battok_calc(di, sel0);
1913 cbp_sel1 = ab8500_fg_battok_calc(di, sel1);
1915 selected = BATT_OK_MIN + cbp_sel0 * BATT_OK_INCREMENT;
1917 if (selected != sel0)
1918 dev_warn(di->dev, "Invalid voltage step:%d, using %d %d\n",
1919 sel0, selected, cbp_sel0);
1921 selected = BATT_OK_MIN + cbp_sel1 * BATT_OK_INCREMENT;
1923 if (selected != sel1)
1924 dev_warn(di->dev, "Invalid voltage step:%d, using %d %d\n",
1925 sel1, selected, cbp_sel1);
1927 new_val = cbp_sel0 | (cbp_sel1 << 4);
1929 dev_dbg(di->dev, "using: %x %d %d\n", new_val, cbp_sel0, cbp_sel1);
1930 ret = abx500_set_register_interruptible(di->dev, AB8500_SYS_CTRL2_BLOCK,
1931 AB8500_BATT_OK_REG, new_val);
1936 * ab8500_fg_instant_work() - Run the FG state machine instantly
1937 * @work: pointer to the work_struct structure
1939 * Work queue function for instant work
1941 static void ab8500_fg_instant_work(struct work_struct *work)
1943 struct ab8500_fg *di = container_of(work, struct ab8500_fg, fg_work);
1945 ab8500_fg_algorithm(di);
1949 * ab8500_fg_cc_data_end_handler() - end of data conversion isr.
1950 * @irq: interrupt number
1951 * @_di: pointer to the ab8500_fg structure
1953 * Returns IRQ status(IRQ_HANDLED)
1955 static irqreturn_t ab8500_fg_cc_data_end_handler(int irq, void *_di)
1957 struct ab8500_fg *di = _di;
1958 if (!di->nbr_cceoc_irq_cnt) {
1959 di->nbr_cceoc_irq_cnt++;
1960 complete(&di->ab8500_fg_started);
1962 di->nbr_cceoc_irq_cnt = 0;
1963 complete(&di->ab8500_fg_complete);
1969 * ab8500_fg_cc_int_calib_handler () - end of calibration isr.
1970 * @irq: interrupt number
1971 * @_di: pointer to the ab8500_fg structure
1973 * Returns IRQ status(IRQ_HANDLED)
1975 static irqreturn_t ab8500_fg_cc_int_calib_handler(int irq, void *_di)
1977 struct ab8500_fg *di = _di;
1978 di->calib_state = AB8500_FG_CALIB_END;
1979 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
1984 * ab8500_fg_cc_convend_handler() - isr to get battery avg current.
1985 * @irq: interrupt number
1986 * @_di: pointer to the ab8500_fg structure
1988 * Returns IRQ status(IRQ_HANDLED)
1990 static irqreturn_t ab8500_fg_cc_convend_handler(int irq, void *_di)
1992 struct ab8500_fg *di = _di;
1994 queue_work(di->fg_wq, &di->fg_acc_cur_work);
2000 * ab8500_fg_batt_ovv_handler() - Battery OVV occured
2001 * @irq: interrupt number
2002 * @_di: pointer to the ab8500_fg structure
2004 * Returns IRQ status(IRQ_HANDLED)
2006 static irqreturn_t ab8500_fg_batt_ovv_handler(int irq, void *_di)
2008 struct ab8500_fg *di = _di;
2010 dev_dbg(di->dev, "Battery OVV\n");
2012 /* Schedule a new HW failure check */
2013 queue_delayed_work(di->fg_wq, &di->fg_check_hw_failure_work, 0);
2019 * ab8500_fg_lowbatf_handler() - Battery voltage is below LOW threshold
2020 * @irq: interrupt number
2021 * @_di: pointer to the ab8500_fg structure
2023 * Returns IRQ status(IRQ_HANDLED)
2025 static irqreturn_t ab8500_fg_lowbatf_handler(int irq, void *_di)
2027 struct ab8500_fg *di = _di;
2029 /* Initiate handling in ab8500_fg_low_bat_work() if not already initiated. */
2030 if (!di->flags.low_bat_delay) {
2031 dev_warn(di->dev, "Battery voltage is below LOW threshold\n");
2032 di->flags.low_bat_delay = true;
2034 * Start a timer to check LOW_BAT again after some time
2035 * This is done to avoid shutdown on single voltage dips
2037 queue_delayed_work(di->fg_wq, &di->fg_low_bat_work,
2038 round_jiffies(LOW_BAT_CHECK_INTERVAL));
2044 * ab8500_fg_get_property() - get the fg properties
2045 * @psy: pointer to the power_supply structure
2046 * @psp: pointer to the power_supply_property structure
2047 * @val: pointer to the power_supply_propval union
2049 * This function gets called when an application tries to get the
2050 * fg properties by reading the sysfs files.
2051 * voltage_now: battery voltage
2052 * current_now: battery instant current
2053 * current_avg: battery average current
2054 * charge_full_design: capacity where battery is considered full
2055 * charge_now: battery capacity in nAh
2056 * capacity: capacity in percent
2057 * capacity_level: capacity level
2059 * Returns error code in case of failure else 0 on success
2061 static int ab8500_fg_get_property(struct power_supply *psy,
2062 enum power_supply_property psp,
2063 union power_supply_propval *val)
2065 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2068 * If battery is identified as unknown and charging of unknown
2069 * batteries is disabled, we always report 100% capacity and
2070 * capacity level UNKNOWN, since we can't calculate
2071 * remaining capacity
2075 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
2076 if (di->flags.bat_ovv)
2077 val->intval = BATT_OVV_VALUE;
2079 val->intval = di->vbat_uv;
2081 case POWER_SUPPLY_PROP_CURRENT_NOW:
2082 val->intval = di->inst_curr_ua;
2084 case POWER_SUPPLY_PROP_CURRENT_AVG:
2085 val->intval = di->avg_curr_ua;
2087 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
2088 val->intval = ab8500_fg_convert_mah_to_uwh(di,
2089 di->bat_cap.max_mah_design);
2091 case POWER_SUPPLY_PROP_ENERGY_FULL:
2092 val->intval = ab8500_fg_convert_mah_to_uwh(di,
2093 di->bat_cap.max_mah);
2095 case POWER_SUPPLY_PROP_ENERGY_NOW:
2096 if (di->flags.batt_unknown && !di->bm->chg_unknown_bat &&
2097 di->flags.batt_id_received)
2098 val->intval = ab8500_fg_convert_mah_to_uwh(di,
2099 di->bat_cap.max_mah);
2101 val->intval = ab8500_fg_convert_mah_to_uwh(di,
2102 di->bat_cap.prev_mah);
2104 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
2105 val->intval = di->bat_cap.max_mah_design;
2107 case POWER_SUPPLY_PROP_CHARGE_FULL:
2108 val->intval = di->bat_cap.max_mah;
2110 case POWER_SUPPLY_PROP_CHARGE_NOW:
2111 if (di->flags.batt_unknown && !di->bm->chg_unknown_bat &&
2112 di->flags.batt_id_received)
2113 val->intval = di->bat_cap.max_mah;
2115 val->intval = di->bat_cap.prev_mah;
2117 case POWER_SUPPLY_PROP_CAPACITY:
2118 if (di->flags.batt_unknown && !di->bm->chg_unknown_bat &&
2119 di->flags.batt_id_received)
2122 val->intval = di->bat_cap.prev_percent;
2124 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
2125 if (di->flags.batt_unknown && !di->bm->chg_unknown_bat &&
2126 di->flags.batt_id_received)
2127 val->intval = POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
2129 val->intval = di->bat_cap.prev_level;
2137 static int ab8500_fg_get_ext_psy_data(struct device *dev, void *data)
2139 struct power_supply *psy;
2140 struct power_supply *ext = dev_get_drvdata(dev);
2141 const char **supplicants = (const char **)ext->supplied_to;
2142 struct ab8500_fg *di;
2143 struct power_supply_battery_info *bi;
2144 union power_supply_propval ret;
2147 psy = (struct power_supply *)data;
2148 di = power_supply_get_drvdata(psy);
2152 * For all psy where the name of your driver
2153 * appears in any supplied_to
2155 j = match_string(supplicants, ext->num_supplicants, psy->desc->name);
2159 /* Go through all properties for the psy */
2160 for (j = 0; j < ext->desc->num_properties; j++) {
2161 enum power_supply_property prop;
2162 prop = ext->desc->properties[j];
2164 if (power_supply_get_property(ext, prop, &ret))
2168 case POWER_SUPPLY_PROP_STATUS:
2169 switch (ext->desc->type) {
2170 case POWER_SUPPLY_TYPE_BATTERY:
2171 switch (ret.intval) {
2172 case POWER_SUPPLY_STATUS_UNKNOWN:
2173 case POWER_SUPPLY_STATUS_DISCHARGING:
2174 case POWER_SUPPLY_STATUS_NOT_CHARGING:
2175 if (!di->flags.charging)
2177 di->flags.charging = false;
2178 di->flags.fully_charged = false;
2179 if (di->bm->capacity_scaling)
2180 ab8500_fg_update_cap_scalers(di);
2181 queue_work(di->fg_wq, &di->fg_work);
2183 case POWER_SUPPLY_STATUS_FULL:
2184 if (di->flags.fully_charged)
2186 di->flags.fully_charged = true;
2187 di->flags.force_full = true;
2188 /* Save current capacity as maximum */
2189 di->bat_cap.max_mah = di->bat_cap.mah;
2190 queue_work(di->fg_wq, &di->fg_work);
2192 case POWER_SUPPLY_STATUS_CHARGING:
2193 if (di->flags.charging &&
2194 !di->flags.fully_charged)
2196 di->flags.charging = true;
2197 di->flags.fully_charged = false;
2198 if (di->bm->capacity_scaling)
2199 ab8500_fg_update_cap_scalers(di);
2200 queue_work(di->fg_wq, &di->fg_work);
2208 case POWER_SUPPLY_PROP_TECHNOLOGY:
2209 switch (ext->desc->type) {
2210 case POWER_SUPPLY_TYPE_BATTERY:
2211 if (!di->flags.batt_id_received &&
2212 (bi && (bi->technology !=
2213 POWER_SUPPLY_TECHNOLOGY_UNKNOWN))) {
2214 const struct ab8500_battery_type *b;
2216 b = di->bm->bat_type;
2218 di->flags.batt_id_received = true;
2220 di->bat_cap.max_mah_design =
2221 di->bm->bi->charge_full_design_uah;
2223 di->bat_cap.max_mah =
2224 di->bat_cap.max_mah_design;
2227 di->bm->bi->voltage_max_design_uv;
2231 di->flags.batt_unknown = false;
2233 di->flags.batt_unknown = true;
2239 case POWER_SUPPLY_PROP_TEMP:
2240 switch (ext->desc->type) {
2241 case POWER_SUPPLY_TYPE_BATTERY:
2242 if (di->flags.batt_id_received)
2243 di->bat_temp = ret.intval;
2257 * ab8500_fg_init_hw_registers() - Set up FG related registers
2258 * @di: pointer to the ab8500_fg structure
2260 * Set up battery OVV, low battery voltage registers
2262 static int ab8500_fg_init_hw_registers(struct ab8500_fg *di)
2266 /* Set VBAT OVV threshold */
2267 ret = abx500_mask_and_set_register_interruptible(di->dev,
2273 dev_err(di->dev, "failed to set BATT_OVV\n");
2277 /* Enable VBAT OVV detection */
2278 ret = abx500_mask_and_set_register_interruptible(di->dev,
2284 dev_err(di->dev, "failed to enable BATT_OVV\n");
2288 /* Low Battery Voltage */
2289 ret = abx500_set_register_interruptible(di->dev,
2290 AB8500_SYS_CTRL2_BLOCK,
2292 ab8500_volt_to_regval(
2293 di->bm->fg_params->lowbat_threshold_uv) << 1 |
2296 dev_err(di->dev, "%s write failed\n", __func__);
2300 /* Battery OK threshold */
2301 ret = ab8500_fg_battok_init_hw_register(di);
2303 dev_err(di->dev, "BattOk init write failed.\n");
2307 if (is_ab8505(di->parent)) {
2308 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2309 AB8505_RTC_PCUT_MAX_TIME_REG, di->bm->fg_params->pcut_max_time);
2312 dev_err(di->dev, "%s write failed AB8505_RTC_PCUT_MAX_TIME_REG\n", __func__);
2316 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2317 AB8505_RTC_PCUT_FLAG_TIME_REG, di->bm->fg_params->pcut_flag_time);
2320 dev_err(di->dev, "%s write failed AB8505_RTC_PCUT_FLAG_TIME_REG\n", __func__);
2324 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2325 AB8505_RTC_PCUT_RESTART_REG, di->bm->fg_params->pcut_max_restart);
2328 dev_err(di->dev, "%s write failed AB8505_RTC_PCUT_RESTART_REG\n", __func__);
2332 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2333 AB8505_RTC_PCUT_DEBOUNCE_REG, di->bm->fg_params->pcut_debounce_time);
2336 dev_err(di->dev, "%s write failed AB8505_RTC_PCUT_DEBOUNCE_REG\n", __func__);
2340 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2341 AB8505_RTC_PCUT_CTL_STATUS_REG, di->bm->fg_params->pcut_enable);
2344 dev_err(di->dev, "%s write failed AB8505_RTC_PCUT_CTL_STATUS_REG\n", __func__);
2353 * ab8500_fg_external_power_changed() - callback for power supply changes
2354 * @psy: pointer to the structure power_supply
2356 * This function is the entry point of the pointer external_power_changed
2357 * of the structure power_supply.
2358 * This function gets executed when there is a change in any external power
2359 * supply that this driver needs to be notified of.
2361 static void ab8500_fg_external_power_changed(struct power_supply *psy)
2363 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2365 class_for_each_device(power_supply_class, NULL,
2366 di->fg_psy, ab8500_fg_get_ext_psy_data);
2370 * ab8500_fg_reinit_work() - work to reset the FG algorithm
2371 * @work: pointer to the work_struct structure
2373 * Used to reset the current battery capacity to be able to
2374 * retrigger a new voltage base capacity calculation. For
2375 * test and verification purpose.
2377 static void ab8500_fg_reinit_work(struct work_struct *work)
2379 struct ab8500_fg *di = container_of(work, struct ab8500_fg,
2380 fg_reinit_work.work);
2382 if (!di->flags.calibrate) {
2383 dev_dbg(di->dev, "Resetting FG state machine to init.\n");
2384 ab8500_fg_clear_cap_samples(di);
2385 ab8500_fg_calc_cap_discharge_voltage(di, true);
2386 ab8500_fg_charge_state_to(di, AB8500_FG_CHARGE_INIT);
2387 ab8500_fg_discharge_state_to(di, AB8500_FG_DISCHARGE_INIT);
2388 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
2391 dev_err(di->dev, "Residual offset calibration ongoing "
2393 /* Wait one second until next try*/
2394 queue_delayed_work(di->fg_wq, &di->fg_reinit_work,
2399 /* Exposure to the sysfs interface */
2401 struct ab8500_fg_sysfs_entry {
2402 struct attribute attr;
2403 ssize_t (*show)(struct ab8500_fg *, char *);
2404 ssize_t (*store)(struct ab8500_fg *, const char *, size_t);
2407 static ssize_t charge_full_show(struct ab8500_fg *di, char *buf)
2409 return sprintf(buf, "%d\n", di->bat_cap.max_mah);
2412 static ssize_t charge_full_store(struct ab8500_fg *di, const char *buf,
2415 unsigned long charge_full;
2418 ret = kstrtoul(buf, 10, &charge_full);
2422 di->bat_cap.max_mah = (int) charge_full;
2426 static ssize_t charge_now_show(struct ab8500_fg *di, char *buf)
2428 return sprintf(buf, "%d\n", di->bat_cap.prev_mah);
2431 static ssize_t charge_now_store(struct ab8500_fg *di, const char *buf,
2434 unsigned long charge_now;
2437 ret = kstrtoul(buf, 10, &charge_now);
2441 di->bat_cap.user_mah = (int) charge_now;
2442 di->flags.user_cap = true;
2443 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
2447 static struct ab8500_fg_sysfs_entry charge_full_attr =
2448 __ATTR(charge_full, 0644, charge_full_show, charge_full_store);
2450 static struct ab8500_fg_sysfs_entry charge_now_attr =
2451 __ATTR(charge_now, 0644, charge_now_show, charge_now_store);
2454 ab8500_fg_show(struct kobject *kobj, struct attribute *attr, char *buf)
2456 struct ab8500_fg_sysfs_entry *entry;
2457 struct ab8500_fg *di;
2459 entry = container_of(attr, struct ab8500_fg_sysfs_entry, attr);
2460 di = container_of(kobj, struct ab8500_fg, fg_kobject);
2465 return entry->show(di, buf);
2468 ab8500_fg_store(struct kobject *kobj, struct attribute *attr, const char *buf,
2471 struct ab8500_fg_sysfs_entry *entry;
2472 struct ab8500_fg *di;
2474 entry = container_of(attr, struct ab8500_fg_sysfs_entry, attr);
2475 di = container_of(kobj, struct ab8500_fg, fg_kobject);
2480 return entry->store(di, buf, count);
2483 static const struct sysfs_ops ab8500_fg_sysfs_ops = {
2484 .show = ab8500_fg_show,
2485 .store = ab8500_fg_store,
2488 static struct attribute *ab8500_fg_attrs[] = {
2489 &charge_full_attr.attr,
2490 &charge_now_attr.attr,
2494 static struct kobj_type ab8500_fg_ktype = {
2495 .sysfs_ops = &ab8500_fg_sysfs_ops,
2496 .default_attrs = ab8500_fg_attrs,
2500 * ab8500_fg_sysfs_exit() - de-init of sysfs entry
2501 * @di: pointer to the struct ab8500_chargalg
2503 * This function removes the entry in sysfs.
2505 static void ab8500_fg_sysfs_exit(struct ab8500_fg *di)
2507 kobject_del(&di->fg_kobject);
2511 * ab8500_fg_sysfs_init() - init of sysfs entry
2512 * @di: pointer to the struct ab8500_chargalg
2514 * This function adds an entry in sysfs.
2515 * Returns error code in case of failure else 0(on success)
2517 static int ab8500_fg_sysfs_init(struct ab8500_fg *di)
2521 ret = kobject_init_and_add(&di->fg_kobject,
2525 dev_err(di->dev, "failed to create sysfs entry\n");
2530 static ssize_t ab8505_powercut_flagtime_read(struct device *dev,
2531 struct device_attribute *attr,
2536 struct power_supply *psy = dev_get_drvdata(dev);
2537 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2539 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2540 AB8505_RTC_PCUT_FLAG_TIME_REG, ®_value);
2543 dev_err(dev, "Failed to read AB8505_RTC_PCUT_FLAG_TIME_REG\n");
2547 return scnprintf(buf, PAGE_SIZE, "%d\n", (reg_value & 0x7F));
2553 static ssize_t ab8505_powercut_flagtime_write(struct device *dev,
2554 struct device_attribute *attr,
2555 const char *buf, size_t count)
2559 struct power_supply *psy = dev_get_drvdata(dev);
2560 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2562 if (kstrtoint(buf, 10, ®_value))
2565 if (reg_value > 0x7F) {
2566 dev_err(dev, "Incorrect parameter, echo 0 (1.98s) - 127 (15.625ms) for flagtime\n");
2570 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2571 AB8505_RTC_PCUT_FLAG_TIME_REG, (u8)reg_value);
2574 dev_err(dev, "Failed to set AB8505_RTC_PCUT_FLAG_TIME_REG\n");
2580 static ssize_t ab8505_powercut_maxtime_read(struct device *dev,
2581 struct device_attribute *attr,
2586 struct power_supply *psy = dev_get_drvdata(dev);
2587 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2589 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2590 AB8505_RTC_PCUT_MAX_TIME_REG, ®_value);
2593 dev_err(dev, "Failed to read AB8505_RTC_PCUT_MAX_TIME_REG\n");
2597 return scnprintf(buf, PAGE_SIZE, "%d\n", (reg_value & 0x7F));
2604 static ssize_t ab8505_powercut_maxtime_write(struct device *dev,
2605 struct device_attribute *attr,
2606 const char *buf, size_t count)
2610 struct power_supply *psy = dev_get_drvdata(dev);
2611 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2613 if (kstrtoint(buf, 10, ®_value))
2616 if (reg_value > 0x7F) {
2617 dev_err(dev, "Incorrect parameter, echo 0 (0.0s) - 127 (1.98s) for maxtime\n");
2621 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2622 AB8505_RTC_PCUT_MAX_TIME_REG, (u8)reg_value);
2625 dev_err(dev, "Failed to set AB8505_RTC_PCUT_MAX_TIME_REG\n");
2631 static ssize_t ab8505_powercut_restart_read(struct device *dev,
2632 struct device_attribute *attr,
2637 struct power_supply *psy = dev_get_drvdata(dev);
2638 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2640 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2641 AB8505_RTC_PCUT_RESTART_REG, ®_value);
2644 dev_err(dev, "Failed to read AB8505_RTC_PCUT_RESTART_REG\n");
2648 return scnprintf(buf, PAGE_SIZE, "%d\n", (reg_value & 0xF));
2654 static ssize_t ab8505_powercut_restart_write(struct device *dev,
2655 struct device_attribute *attr,
2656 const char *buf, size_t count)
2660 struct power_supply *psy = dev_get_drvdata(dev);
2661 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2663 if (kstrtoint(buf, 10, ®_value))
2666 if (reg_value > 0xF) {
2667 dev_err(dev, "Incorrect parameter, echo 0 - 15 for number of restart\n");
2671 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2672 AB8505_RTC_PCUT_RESTART_REG, (u8)reg_value);
2675 dev_err(dev, "Failed to set AB8505_RTC_PCUT_RESTART_REG\n");
2682 static ssize_t ab8505_powercut_timer_read(struct device *dev,
2683 struct device_attribute *attr,
2688 struct power_supply *psy = dev_get_drvdata(dev);
2689 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2691 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2692 AB8505_RTC_PCUT_TIME_REG, ®_value);
2695 dev_err(dev, "Failed to read AB8505_RTC_PCUT_TIME_REG\n");
2699 return scnprintf(buf, PAGE_SIZE, "%d\n", (reg_value & 0x7F));
2705 static ssize_t ab8505_powercut_restart_counter_read(struct device *dev,
2706 struct device_attribute *attr,
2711 struct power_supply *psy = dev_get_drvdata(dev);
2712 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2714 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2715 AB8505_RTC_PCUT_RESTART_REG, ®_value);
2718 dev_err(dev, "Failed to read AB8505_RTC_PCUT_RESTART_REG\n");
2722 return scnprintf(buf, PAGE_SIZE, "%d\n", (reg_value & 0xF0) >> 4);
2728 static ssize_t ab8505_powercut_read(struct device *dev,
2729 struct device_attribute *attr,
2734 struct power_supply *psy = dev_get_drvdata(dev);
2735 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2737 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2738 AB8505_RTC_PCUT_CTL_STATUS_REG, ®_value);
2743 return scnprintf(buf, PAGE_SIZE, "%d\n", (reg_value & 0x1));
2749 static ssize_t ab8505_powercut_write(struct device *dev,
2750 struct device_attribute *attr,
2751 const char *buf, size_t count)
2755 struct power_supply *psy = dev_get_drvdata(dev);
2756 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2758 if (kstrtoint(buf, 10, ®_value))
2761 if (reg_value > 0x1) {
2762 dev_err(dev, "Incorrect parameter, echo 0/1 to disable/enable Pcut feature\n");
2766 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2767 AB8505_RTC_PCUT_CTL_STATUS_REG, (u8)reg_value);
2770 dev_err(dev, "Failed to set AB8505_RTC_PCUT_CTL_STATUS_REG\n");
2776 static ssize_t ab8505_powercut_flag_read(struct device *dev,
2777 struct device_attribute *attr,
2783 struct power_supply *psy = dev_get_drvdata(dev);
2784 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2786 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2787 AB8505_RTC_PCUT_CTL_STATUS_REG, ®_value);
2790 dev_err(dev, "Failed to read AB8505_RTC_PCUT_CTL_STATUS_REG\n");
2794 return scnprintf(buf, PAGE_SIZE, "%d\n", ((reg_value & 0x10) >> 4));
2800 static ssize_t ab8505_powercut_debounce_read(struct device *dev,
2801 struct device_attribute *attr,
2806 struct power_supply *psy = dev_get_drvdata(dev);
2807 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2809 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2810 AB8505_RTC_PCUT_DEBOUNCE_REG, ®_value);
2813 dev_err(dev, "Failed to read AB8505_RTC_PCUT_DEBOUNCE_REG\n");
2817 return scnprintf(buf, PAGE_SIZE, "%d\n", (reg_value & 0x7));
2823 static ssize_t ab8505_powercut_debounce_write(struct device *dev,
2824 struct device_attribute *attr,
2825 const char *buf, size_t count)
2829 struct power_supply *psy = dev_get_drvdata(dev);
2830 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2832 if (kstrtoint(buf, 10, ®_value))
2835 if (reg_value > 0x7) {
2836 dev_err(dev, "Incorrect parameter, echo 0 to 7 for debounce setting\n");
2840 ret = abx500_set_register_interruptible(di->dev, AB8500_RTC,
2841 AB8505_RTC_PCUT_DEBOUNCE_REG, (u8)reg_value);
2844 dev_err(dev, "Failed to set AB8505_RTC_PCUT_DEBOUNCE_REG\n");
2850 static ssize_t ab8505_powercut_enable_status_read(struct device *dev,
2851 struct device_attribute *attr,
2856 struct power_supply *psy = dev_get_drvdata(dev);
2857 struct ab8500_fg *di = power_supply_get_drvdata(psy);
2859 ret = abx500_get_register_interruptible(di->dev, AB8500_RTC,
2860 AB8505_RTC_PCUT_CTL_STATUS_REG, ®_value);
2863 dev_err(dev, "Failed to read AB8505_RTC_PCUT_CTL_STATUS_REG\n");
2867 return scnprintf(buf, PAGE_SIZE, "%d\n", ((reg_value & 0x20) >> 5));
2873 static struct device_attribute ab8505_fg_sysfs_psy_attrs[] = {
2874 __ATTR(powercut_flagtime, (S_IRUGO | S_IWUSR | S_IWGRP),
2875 ab8505_powercut_flagtime_read, ab8505_powercut_flagtime_write),
2876 __ATTR(powercut_maxtime, (S_IRUGO | S_IWUSR | S_IWGRP),
2877 ab8505_powercut_maxtime_read, ab8505_powercut_maxtime_write),
2878 __ATTR(powercut_restart_max, (S_IRUGO | S_IWUSR | S_IWGRP),
2879 ab8505_powercut_restart_read, ab8505_powercut_restart_write),
2880 __ATTR(powercut_timer, S_IRUGO, ab8505_powercut_timer_read, NULL),
2881 __ATTR(powercut_restart_counter, S_IRUGO,
2882 ab8505_powercut_restart_counter_read, NULL),
2883 __ATTR(powercut_enable, (S_IRUGO | S_IWUSR | S_IWGRP),
2884 ab8505_powercut_read, ab8505_powercut_write),
2885 __ATTR(powercut_flag, S_IRUGO, ab8505_powercut_flag_read, NULL),
2886 __ATTR(powercut_debounce_time, (S_IRUGO | S_IWUSR | S_IWGRP),
2887 ab8505_powercut_debounce_read, ab8505_powercut_debounce_write),
2888 __ATTR(powercut_enable_status, S_IRUGO,
2889 ab8505_powercut_enable_status_read, NULL),
2892 static int ab8500_fg_sysfs_psy_create_attrs(struct ab8500_fg *di)
2896 if (is_ab8505(di->parent)) {
2897 for (i = 0; i < ARRAY_SIZE(ab8505_fg_sysfs_psy_attrs); i++)
2898 if (device_create_file(&di->fg_psy->dev,
2899 &ab8505_fg_sysfs_psy_attrs[i]))
2900 goto sysfs_psy_create_attrs_failed_ab8505;
2903 sysfs_psy_create_attrs_failed_ab8505:
2904 dev_err(&di->fg_psy->dev, "Failed creating sysfs psy attrs for ab8505.\n");
2906 device_remove_file(&di->fg_psy->dev,
2907 &ab8505_fg_sysfs_psy_attrs[i]);
2912 static void ab8500_fg_sysfs_psy_remove_attrs(struct ab8500_fg *di)
2916 if (is_ab8505(di->parent)) {
2917 for (i = 0; i < ARRAY_SIZE(ab8505_fg_sysfs_psy_attrs); i++)
2918 (void)device_remove_file(&di->fg_psy->dev,
2919 &ab8505_fg_sysfs_psy_attrs[i]);
2923 /* Exposure to the sysfs interface <<END>> */
2925 static int __maybe_unused ab8500_fg_resume(struct device *dev)
2927 struct ab8500_fg *di = dev_get_drvdata(dev);
2930 * Change state if we're not charging. If we're charging we will wake
2933 if (!di->flags.charging) {
2934 ab8500_fg_discharge_state_to(di, AB8500_FG_DISCHARGE_WAKEUP);
2935 queue_work(di->fg_wq, &di->fg_work);
2941 static int __maybe_unused ab8500_fg_suspend(struct device *dev)
2943 struct ab8500_fg *di = dev_get_drvdata(dev);
2945 flush_delayed_work(&di->fg_periodic_work);
2946 flush_work(&di->fg_work);
2947 flush_work(&di->fg_acc_cur_work);
2948 flush_delayed_work(&di->fg_reinit_work);
2949 flush_delayed_work(&di->fg_low_bat_work);
2950 flush_delayed_work(&di->fg_check_hw_failure_work);
2953 * If the FG is enabled we will disable it before going to suspend
2954 * only if we're not charging
2956 if (di->flags.fg_enabled && !di->flags.charging)
2957 ab8500_fg_coulomb_counter(di, false);
2962 /* ab8500 fg driver interrupts and their respective isr */
2963 static struct ab8500_fg_interrupts ab8500_fg_irq[] = {
2964 {"NCONV_ACCU", ab8500_fg_cc_convend_handler},
2965 {"BATT_OVV", ab8500_fg_batt_ovv_handler},
2966 {"LOW_BAT_F", ab8500_fg_lowbatf_handler},
2967 {"CC_INT_CALIB", ab8500_fg_cc_int_calib_handler},
2968 {"CCEOC", ab8500_fg_cc_data_end_handler},
2971 static char *supply_interface[] = {
2976 static const struct power_supply_desc ab8500_fg_desc = {
2977 .name = "ab8500_fg",
2978 .type = POWER_SUPPLY_TYPE_BATTERY,
2979 .properties = ab8500_fg_props,
2980 .num_properties = ARRAY_SIZE(ab8500_fg_props),
2981 .get_property = ab8500_fg_get_property,
2982 .external_power_changed = ab8500_fg_external_power_changed,
2985 static int ab8500_fg_bind(struct device *dev, struct device *master,
2988 struct ab8500_fg *di = dev_get_drvdata(dev);
2990 /* Create a work queue for running the FG algorithm */
2991 di->fg_wq = alloc_ordered_workqueue("ab8500_fg_wq", WQ_MEM_RECLAIM);
2992 if (di->fg_wq == NULL) {
2993 dev_err(dev, "failed to create work queue\n");
2997 di->bat_cap.max_mah_design = di->bm->bi->charge_full_design_uah;
2998 di->bat_cap.max_mah = di->bat_cap.max_mah_design;
2999 di->vbat_nom_uv = di->bm->bi->voltage_max_design_uv;
3001 /* Start the coulomb counter */
3002 ab8500_fg_coulomb_counter(di, true);
3003 /* Run the FG algorithm */
3004 queue_delayed_work(di->fg_wq, &di->fg_periodic_work, 0);
3009 static void ab8500_fg_unbind(struct device *dev, struct device *master,
3012 struct ab8500_fg *di = dev_get_drvdata(dev);
3015 /* Disable coulomb counter */
3016 ret = ab8500_fg_coulomb_counter(di, false);
3018 dev_err(dev, "failed to disable coulomb counter\n");
3020 destroy_workqueue(di->fg_wq);
3021 flush_scheduled_work();
3024 static const struct component_ops ab8500_fg_component_ops = {
3025 .bind = ab8500_fg_bind,
3026 .unbind = ab8500_fg_unbind,
3029 static int ab8500_fg_probe(struct platform_device *pdev)
3031 struct device *dev = &pdev->dev;
3032 struct power_supply_config psy_cfg = {};
3033 struct ab8500_fg *di;
3037 di = devm_kzalloc(dev, sizeof(*di), GFP_KERNEL);
3041 di->bm = &ab8500_bm_data;
3043 mutex_init(&di->cc_lock);
3045 /* get parent data */
3047 di->parent = dev_get_drvdata(pdev->dev.parent);
3049 di->main_bat_v = devm_iio_channel_get(dev, "main_bat_v");
3050 if (IS_ERR(di->main_bat_v)) {
3051 ret = dev_err_probe(dev, PTR_ERR(di->main_bat_v),
3052 "failed to get main battery ADC channel\n");
3056 psy_cfg.supplied_to = supply_interface;
3057 psy_cfg.num_supplicants = ARRAY_SIZE(supply_interface);
3058 psy_cfg.drv_data = di;
3060 di->init_capacity = true;
3062 ab8500_fg_charge_state_to(di, AB8500_FG_CHARGE_INIT);
3063 ab8500_fg_discharge_state_to(di, AB8500_FG_DISCHARGE_INIT);
3065 /* Init work for running the fg algorithm instantly */
3066 INIT_WORK(&di->fg_work, ab8500_fg_instant_work);
3068 /* Init work for getting the battery accumulated current */
3069 INIT_WORK(&di->fg_acc_cur_work, ab8500_fg_acc_cur_work);
3071 /* Init work for reinitialising the fg algorithm */
3072 INIT_DEFERRABLE_WORK(&di->fg_reinit_work,
3073 ab8500_fg_reinit_work);
3075 /* Work delayed Queue to run the state machine */
3076 INIT_DEFERRABLE_WORK(&di->fg_periodic_work,
3077 ab8500_fg_periodic_work);
3079 /* Work to check low battery condition */
3080 INIT_DEFERRABLE_WORK(&di->fg_low_bat_work,
3081 ab8500_fg_low_bat_work);
3083 /* Init work for HW failure check */
3084 INIT_DEFERRABLE_WORK(&di->fg_check_hw_failure_work,
3085 ab8500_fg_check_hw_failure_work);
3087 /* Reset battery low voltage flag */
3088 di->flags.low_bat = false;
3090 /* Initialize low battery counter */
3091 di->low_bat_cnt = 10;
3093 /* Initialize OVV, and other registers */
3094 ret = ab8500_fg_init_hw_registers(di);
3096 dev_err(dev, "failed to initialize registers\n");
3100 /* Consider battery unknown until we're informed otherwise */
3101 di->flags.batt_unknown = true;
3102 di->flags.batt_id_received = false;
3104 /* Register FG power supply class */
3105 di->fg_psy = devm_power_supply_register(dev, &ab8500_fg_desc, &psy_cfg);
3106 if (IS_ERR(di->fg_psy)) {
3107 dev_err(dev, "failed to register FG psy\n");
3108 return PTR_ERR(di->fg_psy);
3111 di->fg_samples = SEC_TO_SAMPLE(di->bm->fg_params->init_timer);
3114 * Initialize completion used to notify completion and start
3117 init_completion(&di->ab8500_fg_started);
3118 init_completion(&di->ab8500_fg_complete);
3120 /* Register primary interrupt handlers */
3121 for (i = 0; i < ARRAY_SIZE(ab8500_fg_irq); i++) {
3122 irq = platform_get_irq_byname(pdev, ab8500_fg_irq[i].name);
3126 ret = devm_request_threaded_irq(dev, irq, NULL,
3127 ab8500_fg_irq[i].isr,
3128 IRQF_SHARED | IRQF_NO_SUSPEND | IRQF_ONESHOT,
3129 ab8500_fg_irq[i].name, di);
3132 dev_err(dev, "failed to request %s IRQ %d: %d\n",
3133 ab8500_fg_irq[i].name, irq, ret);
3136 dev_dbg(dev, "Requested %s IRQ %d: %d\n",
3137 ab8500_fg_irq[i].name, irq, ret);
3140 di->irq = platform_get_irq_byname(pdev, "CCEOC");
3141 disable_irq(di->irq);
3142 di->nbr_cceoc_irq_cnt = 0;
3144 platform_set_drvdata(pdev, di);
3146 ret = ab8500_fg_sysfs_init(di);
3148 dev_err(dev, "failed to create sysfs entry\n");
3152 ret = ab8500_fg_sysfs_psy_create_attrs(di);
3154 dev_err(dev, "failed to create FG psy\n");
3155 ab8500_fg_sysfs_exit(di);
3159 /* Calibrate the fg first time */
3160 di->flags.calibrate = true;
3161 di->calib_state = AB8500_FG_CALIB_INIT;
3163 /* Use room temp as default value until we get an update from driver. */
3166 list_add_tail(&di->node, &ab8500_fg_list);
3168 return component_add(dev, &ab8500_fg_component_ops);
3171 static int ab8500_fg_remove(struct platform_device *pdev)
3174 struct ab8500_fg *di = platform_get_drvdata(pdev);
3176 component_del(&pdev->dev, &ab8500_fg_component_ops);
3177 list_del(&di->node);
3178 ab8500_fg_sysfs_exit(di);
3179 ab8500_fg_sysfs_psy_remove_attrs(di);
3184 static SIMPLE_DEV_PM_OPS(ab8500_fg_pm_ops, ab8500_fg_suspend, ab8500_fg_resume);
3186 static const struct of_device_id ab8500_fg_match[] = {
3187 { .compatible = "stericsson,ab8500-fg", },
3190 MODULE_DEVICE_TABLE(of, ab8500_fg_match);
3192 struct platform_driver ab8500_fg_driver = {
3193 .probe = ab8500_fg_probe,
3194 .remove = ab8500_fg_remove,
3196 .name = "ab8500-fg",
3197 .of_match_table = ab8500_fg_match,
3198 .pm = &ab8500_fg_pm_ops,
3201 MODULE_LICENSE("GPL v2");
3202 MODULE_AUTHOR("Johan Palsson, Karl Komierowski");
3203 MODULE_ALIAS("platform:ab8500-fg");
3204 MODULE_DESCRIPTION("AB8500 Fuel Gauge driver");