1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Gas Gauge driver for SBS Compliant Batteries
5 * Copyright (c) 2010, NVIDIA Corporation.
8 #include <linux/bits.h>
9 #include <linux/delay.h>
10 #include <linux/err.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/i2c.h>
13 #include <linux/init.h>
14 #include <linux/interrupt.h>
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/property.h>
18 #include <linux/of_device.h>
19 #include <linux/power/sbs-battery.h>
20 #include <linux/power_supply.h>
21 #include <linux/slab.h>
22 #include <linux/stat.h>
25 REG_MANUFACTURER_DATA,
39 REG_REMAINING_CAPACITY,
40 REG_REMAINING_CAPACITY_CHARGE,
41 REG_FULL_CHARGE_CAPACITY,
42 REG_FULL_CHARGE_CAPACITY_CHARGE,
44 REG_DESIGN_CAPACITY_CHARGE,
45 REG_DESIGN_VOLTAGE_MIN,
46 REG_DESIGN_VOLTAGE_MAX,
54 #define REG_ADDR_SPEC_INFO 0x1A
55 #define SPEC_INFO_VERSION_MASK GENMASK(7, 4)
56 #define SPEC_INFO_VERSION_SHIFT 4
58 #define SBS_VERSION_1_0 1
59 #define SBS_VERSION_1_1 2
60 #define SBS_VERSION_1_1_WITH_PEC 3
62 #define REG_ADDR_MANUFACTURE_DATE 0x1B
64 /* Battery Mode defines */
65 #define BATTERY_MODE_OFFSET 0x03
66 #define BATTERY_MODE_CAPACITY_MASK BIT(15)
67 enum sbs_capacity_mode {
68 CAPACITY_MODE_AMPS = 0,
69 CAPACITY_MODE_WATTS = BATTERY_MODE_CAPACITY_MASK
71 #define BATTERY_MODE_CHARGER_MASK (1<<14)
73 /* manufacturer access defines */
74 #define MANUFACTURER_ACCESS_STATUS 0x0006
75 #define MANUFACTURER_ACCESS_SLEEP 0x0011
77 /* battery status value bits */
78 #define BATTERY_INITIALIZED 0x80
79 #define BATTERY_DISCHARGING 0x40
80 #define BATTERY_FULL_CHARGED 0x20
81 #define BATTERY_FULL_DISCHARGED 0x10
83 /* min_value and max_value are only valid for numerical data */
84 #define SBS_DATA(_psp, _addr, _min_value, _max_value) { \
87 .min_value = _min_value, \
88 .max_value = _max_value, \
91 static const struct chip_data {
92 enum power_supply_property psp;
97 [REG_MANUFACTURER_DATA] =
98 SBS_DATA(POWER_SUPPLY_PROP_PRESENT, 0x00, 0, 65535),
100 SBS_DATA(-1, 0x03, 0, 65535),
102 SBS_DATA(POWER_SUPPLY_PROP_TEMP, 0x08, 0, 65535),
104 SBS_DATA(POWER_SUPPLY_PROP_VOLTAGE_NOW, 0x09, 0, 20000),
106 SBS_DATA(POWER_SUPPLY_PROP_CURRENT_NOW, 0x0A, -32768, 32767),
108 SBS_DATA(POWER_SUPPLY_PROP_CURRENT_AVG, 0x0B, -32768, 32767),
110 SBS_DATA(POWER_SUPPLY_PROP_CAPACITY_ERROR_MARGIN, 0x0c, 0, 100),
112 SBS_DATA(POWER_SUPPLY_PROP_CAPACITY, 0x0D, 0, 100),
113 [REG_REMAINING_CAPACITY] =
114 SBS_DATA(POWER_SUPPLY_PROP_ENERGY_NOW, 0x0F, 0, 65535),
115 [REG_REMAINING_CAPACITY_CHARGE] =
116 SBS_DATA(POWER_SUPPLY_PROP_CHARGE_NOW, 0x0F, 0, 65535),
117 [REG_FULL_CHARGE_CAPACITY] =
118 SBS_DATA(POWER_SUPPLY_PROP_ENERGY_FULL, 0x10, 0, 65535),
119 [REG_FULL_CHARGE_CAPACITY_CHARGE] =
120 SBS_DATA(POWER_SUPPLY_PROP_CHARGE_FULL, 0x10, 0, 65535),
121 [REG_TIME_TO_EMPTY] =
122 SBS_DATA(POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG, 0x12, 0, 65535),
124 SBS_DATA(POWER_SUPPLY_PROP_TIME_TO_FULL_AVG, 0x13, 0, 65535),
125 [REG_CHARGE_CURRENT] =
126 SBS_DATA(POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX, 0x14, 0, 65535),
127 [REG_CHARGE_VOLTAGE] =
128 SBS_DATA(POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX, 0x15, 0, 65535),
130 SBS_DATA(POWER_SUPPLY_PROP_STATUS, 0x16, 0, 65535),
131 [REG_CAPACITY_LEVEL] =
132 SBS_DATA(POWER_SUPPLY_PROP_CAPACITY_LEVEL, 0x16, 0, 65535),
134 SBS_DATA(POWER_SUPPLY_PROP_CYCLE_COUNT, 0x17, 0, 65535),
135 [REG_DESIGN_CAPACITY] =
136 SBS_DATA(POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN, 0x18, 0, 65535),
137 [REG_DESIGN_CAPACITY_CHARGE] =
138 SBS_DATA(POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN, 0x18, 0, 65535),
139 [REG_DESIGN_VOLTAGE_MIN] =
140 SBS_DATA(POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN, 0x19, 0, 65535),
141 [REG_DESIGN_VOLTAGE_MAX] =
142 SBS_DATA(POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN, 0x19, 0, 65535),
143 [REG_SERIAL_NUMBER] =
144 SBS_DATA(POWER_SUPPLY_PROP_SERIAL_NUMBER, 0x1C, 0, 65535),
145 /* Properties of type `const char *' */
147 SBS_DATA(POWER_SUPPLY_PROP_MANUFACTURER, 0x20, 0, 65535),
149 SBS_DATA(POWER_SUPPLY_PROP_MODEL_NAME, 0x21, 0, 65535),
151 SBS_DATA(POWER_SUPPLY_PROP_TECHNOLOGY, 0x22, 0, 65535)
154 static const enum power_supply_property sbs_properties[] = {
155 POWER_SUPPLY_PROP_STATUS,
156 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
157 POWER_SUPPLY_PROP_HEALTH,
158 POWER_SUPPLY_PROP_PRESENT,
159 POWER_SUPPLY_PROP_TECHNOLOGY,
160 POWER_SUPPLY_PROP_CYCLE_COUNT,
161 POWER_SUPPLY_PROP_VOLTAGE_NOW,
162 POWER_SUPPLY_PROP_CURRENT_NOW,
163 POWER_SUPPLY_PROP_CURRENT_AVG,
164 POWER_SUPPLY_PROP_CAPACITY,
165 POWER_SUPPLY_PROP_CAPACITY_ERROR_MARGIN,
166 POWER_SUPPLY_PROP_TEMP,
167 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
168 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
169 POWER_SUPPLY_PROP_SERIAL_NUMBER,
170 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
171 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
172 POWER_SUPPLY_PROP_ENERGY_NOW,
173 POWER_SUPPLY_PROP_ENERGY_FULL,
174 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
175 POWER_SUPPLY_PROP_CHARGE_NOW,
176 POWER_SUPPLY_PROP_CHARGE_FULL,
177 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
178 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
179 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
180 POWER_SUPPLY_PROP_MANUFACTURE_YEAR,
181 POWER_SUPPLY_PROP_MANUFACTURE_MONTH,
182 POWER_SUPPLY_PROP_MANUFACTURE_DAY,
183 /* Properties of type `const char *' */
184 POWER_SUPPLY_PROP_MANUFACTURER,
185 POWER_SUPPLY_PROP_MODEL_NAME
188 /* Supports special manufacturer commands from TI BQ20Z65 and BQ20Z75 IC. */
189 #define SBS_FLAGS_TI_BQ20ZX5 BIT(0)
192 struct i2c_client *client;
193 struct power_supply *power_supply;
195 struct gpio_desc *gpio_detect;
196 bool enable_detection;
197 bool charger_broadcasts;
201 u32 poll_retry_count;
202 struct delayed_work work;
203 struct mutex mode_lock;
207 static char model_name[I2C_SMBUS_BLOCK_MAX + 1];
208 static char manufacturer[I2C_SMBUS_BLOCK_MAX + 1];
209 static char chemistry[I2C_SMBUS_BLOCK_MAX + 1];
210 static bool force_load;
212 static int sbs_read_word_data(struct i2c_client *client, u8 address);
213 static int sbs_write_word_data(struct i2c_client *client, u8 address, u16 value);
215 static void sbs_disable_charger_broadcasts(struct sbs_info *chip)
217 int val = sbs_read_word_data(chip->client, BATTERY_MODE_OFFSET);
221 val |= BATTERY_MODE_CHARGER_MASK;
223 val = sbs_write_word_data(chip->client, BATTERY_MODE_OFFSET, val);
227 dev_err(&chip->client->dev,
228 "Failed to disable charger broadcasting: %d\n", val);
230 dev_dbg(&chip->client->dev, "%s\n", __func__);
233 static int sbs_update_presence(struct sbs_info *chip, bool is_present)
235 struct i2c_client *client = chip->client;
236 int retries = chip->i2c_retry_count;
240 if (chip->is_present == is_present)
244 chip->is_present = false;
245 /* Disable PEC when no device is present */
246 client->flags &= ~I2C_CLIENT_PEC;
250 /* Check if device supports packet error checking and use it */
251 while (retries > 0) {
252 ret = i2c_smbus_read_word_data(client, REG_ADDR_SPEC_INFO);
257 * Some batteries trigger the detection pin before the
258 * I2C bus is properly connected. This works around the
267 dev_dbg(&client->dev, "failed to read spec info: %d\n", ret);
269 /* fallback to old behaviour */
270 client->flags &= ~I2C_CLIENT_PEC;
271 chip->is_present = true;
276 version = (ret & SPEC_INFO_VERSION_MASK) >> SPEC_INFO_VERSION_SHIFT;
278 if (version == SBS_VERSION_1_1_WITH_PEC)
279 client->flags |= I2C_CLIENT_PEC;
281 client->flags &= ~I2C_CLIENT_PEC;
283 dev_dbg(&client->dev, "PEC: %s\n", (client->flags & I2C_CLIENT_PEC) ?
284 "enabled" : "disabled");
286 if (!chip->is_present && is_present && !chip->charger_broadcasts)
287 sbs_disable_charger_broadcasts(chip);
289 chip->is_present = true;
294 static int sbs_read_word_data(struct i2c_client *client, u8 address)
296 struct sbs_info *chip = i2c_get_clientdata(client);
297 int retries = chip->i2c_retry_count;
300 while (retries > 0) {
301 ret = i2c_smbus_read_word_data(client, address);
308 dev_dbg(&client->dev,
309 "%s: i2c read at address 0x%x failed\n",
317 static int sbs_read_string_data_fallback(struct i2c_client *client, u8 address, char *values)
319 struct sbs_info *chip = i2c_get_clientdata(client);
320 s32 ret = 0, block_length = 0;
321 int retries_length, retries_block;
322 u8 block_buffer[I2C_SMBUS_BLOCK_MAX + 1];
324 retries_length = chip->i2c_retry_count;
325 retries_block = chip->i2c_retry_count;
327 dev_warn_once(&client->dev, "I2C adapter does not support I2C_FUNC_SMBUS_READ_BLOCK_DATA.\n"
328 "Fallback method does not support PEC.\n");
330 /* Adapter needs to support these two functions */
331 if (!i2c_check_functionality(client->adapter,
332 I2C_FUNC_SMBUS_BYTE_DATA |
333 I2C_FUNC_SMBUS_I2C_BLOCK)){
337 /* Get the length of block data */
338 while (retries_length > 0) {
339 ret = i2c_smbus_read_byte_data(client, address);
346 dev_dbg(&client->dev,
347 "%s: i2c read at address 0x%x failed\n",
352 /* block_length does not include NULL terminator */
354 if (block_length > I2C_SMBUS_BLOCK_MAX) {
355 dev_err(&client->dev,
356 "%s: Returned block_length is longer than 0x%x\n",
357 __func__, I2C_SMBUS_BLOCK_MAX);
361 /* Get the block data */
362 while (retries_block > 0) {
363 ret = i2c_smbus_read_i2c_block_data(
365 block_length + 1, block_buffer);
372 dev_dbg(&client->dev,
373 "%s: i2c read at address 0x%x failed\n",
378 /* block_buffer[0] == block_length */
379 memcpy(values, block_buffer + 1, block_length);
380 values[block_length] = '\0';
385 static int sbs_read_string_data(struct i2c_client *client, u8 address, char *values)
387 struct sbs_info *chip = i2c_get_clientdata(client);
388 int retries = chip->i2c_retry_count;
391 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_BLOCK_DATA)) {
392 bool pec = client->flags & I2C_CLIENT_PEC;
393 client->flags &= ~I2C_CLIENT_PEC;
394 ret = sbs_read_string_data_fallback(client, address, values);
396 client->flags |= I2C_CLIENT_PEC;
400 while (retries > 0) {
401 ret = i2c_smbus_read_block_data(client, address, values);
408 dev_dbg(&client->dev, "failed to read block 0x%x: %d\n", address, ret);
412 /* add string termination */
417 static int sbs_write_word_data(struct i2c_client *client, u8 address,
420 struct sbs_info *chip = i2c_get_clientdata(client);
421 int retries = chip->i2c_retry_count;
424 while (retries > 0) {
425 ret = i2c_smbus_write_word_data(client, address, value);
432 dev_dbg(&client->dev,
433 "%s: i2c write to address 0x%x failed\n",
441 static int sbs_status_correct(struct i2c_client *client, int *intval)
445 ret = sbs_read_word_data(client, sbs_data[REG_CURRENT_NOW].addr);
451 /* Not drawing current -> not charging (i.e. idle) */
452 if (*intval != POWER_SUPPLY_STATUS_FULL && ret == 0)
453 *intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
455 if (*intval == POWER_SUPPLY_STATUS_FULL) {
456 /* Drawing or providing current when full */
458 *intval = POWER_SUPPLY_STATUS_CHARGING;
460 *intval = POWER_SUPPLY_STATUS_DISCHARGING;
466 static bool sbs_bat_needs_calibration(struct i2c_client *client)
470 ret = sbs_read_word_data(client, sbs_data[REG_BATTERY_MODE].addr);
474 return !!(ret & BIT(7));
477 static int sbs_get_battery_presence_and_health(
478 struct i2c_client *client, enum power_supply_property psp,
479 union power_supply_propval *val)
483 /* Dummy command; if it succeeds, battery is present. */
484 ret = sbs_read_word_data(client, sbs_data[REG_STATUS].addr);
486 if (ret < 0) { /* battery not present*/
487 if (psp == POWER_SUPPLY_PROP_PRESENT) {
494 if (psp == POWER_SUPPLY_PROP_PRESENT)
495 val->intval = 1; /* battery present */
496 else { /* POWER_SUPPLY_PROP_HEALTH */
497 if (sbs_bat_needs_calibration(client)) {
498 val->intval = POWER_SUPPLY_HEALTH_CALIBRATION_REQUIRED;
500 /* SBS spec doesn't have a general health command. */
501 val->intval = POWER_SUPPLY_HEALTH_UNKNOWN;
508 static int sbs_get_ti_battery_presence_and_health(
509 struct i2c_client *client, enum power_supply_property psp,
510 union power_supply_propval *val)
515 * Write to ManufacturerAccess with ManufacturerAccess command
516 * and then read the status.
518 ret = sbs_write_word_data(client, sbs_data[REG_MANUFACTURER_DATA].addr,
519 MANUFACTURER_ACCESS_STATUS);
521 if (psp == POWER_SUPPLY_PROP_PRESENT)
522 val->intval = 0; /* battery removed */
526 ret = sbs_read_word_data(client, sbs_data[REG_MANUFACTURER_DATA].addr);
528 if (psp == POWER_SUPPLY_PROP_PRESENT)
529 val->intval = 0; /* battery removed */
533 if (ret < sbs_data[REG_MANUFACTURER_DATA].min_value ||
534 ret > sbs_data[REG_MANUFACTURER_DATA].max_value) {
539 /* Mask the upper nibble of 2nd byte and
540 * lower byte of response then
541 * shift the result by 8 to get status*/
544 if (psp == POWER_SUPPLY_PROP_PRESENT) {
546 /* battery removed */
550 } else if (psp == POWER_SUPPLY_PROP_HEALTH) {
552 val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
553 else if (ret == 0x0B)
554 val->intval = POWER_SUPPLY_HEALTH_OVERHEAT;
555 else if (ret == 0x0C)
556 val->intval = POWER_SUPPLY_HEALTH_DEAD;
557 else if (sbs_bat_needs_calibration(client))
558 val->intval = POWER_SUPPLY_HEALTH_CALIBRATION_REQUIRED;
560 val->intval = POWER_SUPPLY_HEALTH_GOOD;
566 static int sbs_get_battery_property(struct i2c_client *client,
567 int reg_offset, enum power_supply_property psp,
568 union power_supply_propval *val)
570 struct sbs_info *chip = i2c_get_clientdata(client);
573 ret = sbs_read_word_data(client, sbs_data[reg_offset].addr);
577 /* returned values are 16 bit */
578 if (sbs_data[reg_offset].min_value < 0)
581 if (ret >= sbs_data[reg_offset].min_value &&
582 ret <= sbs_data[reg_offset].max_value) {
584 if (psp == POWER_SUPPLY_PROP_CAPACITY_LEVEL) {
585 if (!(ret & BATTERY_INITIALIZED))
587 POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN;
588 else if (ret & BATTERY_FULL_CHARGED)
590 POWER_SUPPLY_CAPACITY_LEVEL_FULL;
591 else if (ret & BATTERY_FULL_DISCHARGED)
593 POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
596 POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
598 } else if (psp != POWER_SUPPLY_PROP_STATUS) {
602 if (ret & BATTERY_FULL_CHARGED)
603 val->intval = POWER_SUPPLY_STATUS_FULL;
604 else if (ret & BATTERY_DISCHARGING)
605 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
607 val->intval = POWER_SUPPLY_STATUS_CHARGING;
609 sbs_status_correct(client, &val->intval);
611 if (chip->poll_time == 0)
612 chip->last_state = val->intval;
613 else if (chip->last_state != val->intval) {
614 cancel_delayed_work_sync(&chip->work);
615 power_supply_changed(chip->power_supply);
619 if (psp == POWER_SUPPLY_PROP_STATUS)
620 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
621 else if (psp == POWER_SUPPLY_PROP_CAPACITY)
622 /* sbs spec says that this can be >100 %
623 * even if max value is 100 %
625 val->intval = min(ret, 100);
633 static int sbs_get_battery_string_property(struct i2c_client *client,
634 int reg_offset, enum power_supply_property psp, char *val)
638 ret = sbs_read_string_data(client, sbs_data[reg_offset].addr, val);
646 static void sbs_unit_adjustment(struct i2c_client *client,
647 enum power_supply_property psp, union power_supply_propval *val)
649 #define BASE_UNIT_CONVERSION 1000
650 #define BATTERY_MODE_CAP_MULT_WATT (10 * BASE_UNIT_CONVERSION)
651 #define TIME_UNIT_CONVERSION 60
652 #define TEMP_KELVIN_TO_CELSIUS 2731
654 case POWER_SUPPLY_PROP_ENERGY_NOW:
655 case POWER_SUPPLY_PROP_ENERGY_FULL:
656 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
657 /* sbs provides energy in units of 10mWh.
660 val->intval *= BATTERY_MODE_CAP_MULT_WATT;
663 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
664 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
665 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
666 case POWER_SUPPLY_PROP_CURRENT_NOW:
667 case POWER_SUPPLY_PROP_CURRENT_AVG:
668 case POWER_SUPPLY_PROP_CHARGE_NOW:
669 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
670 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
671 case POWER_SUPPLY_PROP_CHARGE_FULL:
672 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
673 val->intval *= BASE_UNIT_CONVERSION;
676 case POWER_SUPPLY_PROP_TEMP:
677 /* sbs provides battery temperature in 0.1K
678 * so convert it to 0.1°C
680 val->intval -= TEMP_KELVIN_TO_CELSIUS;
683 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG:
684 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG:
685 /* sbs provides time to empty and time to full in minutes.
688 val->intval *= TIME_UNIT_CONVERSION;
692 dev_dbg(&client->dev,
693 "%s: no need for unit conversion %d\n", __func__, psp);
697 static enum sbs_capacity_mode sbs_set_capacity_mode(struct i2c_client *client,
698 enum sbs_capacity_mode mode)
700 int ret, original_val;
702 original_val = sbs_read_word_data(client, BATTERY_MODE_OFFSET);
703 if (original_val < 0)
706 if ((original_val & BATTERY_MODE_CAPACITY_MASK) == mode)
709 if (mode == CAPACITY_MODE_AMPS)
710 ret = original_val & ~BATTERY_MODE_CAPACITY_MASK;
712 ret = original_val | BATTERY_MODE_CAPACITY_MASK;
714 ret = sbs_write_word_data(client, BATTERY_MODE_OFFSET, ret);
718 usleep_range(1000, 2000);
720 return original_val & BATTERY_MODE_CAPACITY_MASK;
723 static int sbs_get_battery_capacity(struct i2c_client *client,
724 int reg_offset, enum power_supply_property psp,
725 union power_supply_propval *val)
728 enum sbs_capacity_mode mode = CAPACITY_MODE_WATTS;
730 if (power_supply_is_amp_property(psp))
731 mode = CAPACITY_MODE_AMPS;
733 mode = sbs_set_capacity_mode(client, mode);
737 ret = sbs_read_word_data(client, sbs_data[reg_offset].addr);
743 ret = sbs_set_capacity_mode(client, mode);
750 static char sbs_serial[5];
751 static int sbs_get_battery_serial_number(struct i2c_client *client,
752 union power_supply_propval *val)
756 ret = sbs_read_word_data(client, sbs_data[REG_SERIAL_NUMBER].addr);
760 sprintf(sbs_serial, "%04x", ret);
761 val->strval = sbs_serial;
766 static int sbs_get_property_index(struct i2c_client *client,
767 enum power_supply_property psp)
770 for (count = 0; count < ARRAY_SIZE(sbs_data); count++)
771 if (psp == sbs_data[count].psp)
774 dev_warn(&client->dev,
775 "%s: Invalid Property - %d\n", __func__, psp);
780 static int sbs_get_chemistry(struct i2c_client *client,
781 union power_supply_propval *val)
783 enum power_supply_property psp = POWER_SUPPLY_PROP_TECHNOLOGY;
786 ret = sbs_get_property_index(client, psp);
790 ret = sbs_get_battery_string_property(client, ret, psp,
795 if (!strncasecmp(chemistry, "LION", 4))
796 val->intval = POWER_SUPPLY_TECHNOLOGY_LION;
797 else if (!strncasecmp(chemistry, "LiP", 3))
798 val->intval = POWER_SUPPLY_TECHNOLOGY_LIPO;
799 else if (!strncasecmp(chemistry, "NiCd", 4))
800 val->intval = POWER_SUPPLY_TECHNOLOGY_NiCd;
801 else if (!strncasecmp(chemistry, "NiMH", 4))
802 val->intval = POWER_SUPPLY_TECHNOLOGY_NiMH;
804 val->intval = POWER_SUPPLY_TECHNOLOGY_UNKNOWN;
806 if (val->intval == POWER_SUPPLY_TECHNOLOGY_UNKNOWN)
807 dev_warn(&client->dev, "Unknown chemistry: %s\n", chemistry);
812 static int sbs_get_battery_manufacture_date(struct i2c_client *client,
813 enum power_supply_property psp,
814 union power_supply_propval *val)
817 u16 day, month, year;
819 ret = sbs_read_word_data(client, REG_ADDR_MANUFACTURE_DATE);
823 day = ret & GENMASK(4, 0);
824 month = (ret & GENMASK(8, 5)) >> 5;
825 year = ((ret & GENMASK(15, 9)) >> 9) + 1980;
828 case POWER_SUPPLY_PROP_MANUFACTURE_YEAR:
831 case POWER_SUPPLY_PROP_MANUFACTURE_MONTH:
834 case POWER_SUPPLY_PROP_MANUFACTURE_DAY:
844 static int sbs_get_property(struct power_supply *psy,
845 enum power_supply_property psp,
846 union power_supply_propval *val)
849 struct sbs_info *chip = power_supply_get_drvdata(psy);
850 struct i2c_client *client = chip->client;
852 if (chip->gpio_detect) {
853 ret = gpiod_get_value_cansleep(chip->gpio_detect);
856 if (psp == POWER_SUPPLY_PROP_PRESENT) {
858 sbs_update_presence(chip, ret);
866 case POWER_SUPPLY_PROP_PRESENT:
867 case POWER_SUPPLY_PROP_HEALTH:
868 if (chip->flags & SBS_FLAGS_TI_BQ20ZX5)
869 ret = sbs_get_ti_battery_presence_and_health(client,
872 ret = sbs_get_battery_presence_and_health(client, psp,
875 /* this can only be true if no gpio is used */
876 if (psp == POWER_SUPPLY_PROP_PRESENT)
880 case POWER_SUPPLY_PROP_TECHNOLOGY:
881 ret = sbs_get_chemistry(client, val);
885 goto done; /* don't trigger power_supply_changed()! */
887 case POWER_SUPPLY_PROP_ENERGY_NOW:
888 case POWER_SUPPLY_PROP_ENERGY_FULL:
889 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
890 case POWER_SUPPLY_PROP_CHARGE_NOW:
891 case POWER_SUPPLY_PROP_CHARGE_FULL:
892 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
893 ret = sbs_get_property_index(client, psp);
897 /* sbs_get_battery_capacity() will change the battery mode
898 * temporarily to read the requested attribute. Ensure we stay
899 * in the desired mode for the duration of the attribute read.
901 mutex_lock(&chip->mode_lock);
902 ret = sbs_get_battery_capacity(client, ret, psp, val);
903 mutex_unlock(&chip->mode_lock);
906 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
907 ret = sbs_get_battery_serial_number(client, val);
910 case POWER_SUPPLY_PROP_STATUS:
911 case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
912 case POWER_SUPPLY_PROP_CYCLE_COUNT:
913 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
914 case POWER_SUPPLY_PROP_CURRENT_NOW:
915 case POWER_SUPPLY_PROP_CURRENT_AVG:
916 case POWER_SUPPLY_PROP_TEMP:
917 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG:
918 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG:
919 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
920 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
921 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
922 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
923 case POWER_SUPPLY_PROP_CAPACITY:
924 case POWER_SUPPLY_PROP_CAPACITY_ERROR_MARGIN:
925 ret = sbs_get_property_index(client, psp);
929 ret = sbs_get_battery_property(client, ret, psp, val);
932 case POWER_SUPPLY_PROP_MODEL_NAME:
933 ret = sbs_get_property_index(client, psp);
937 ret = sbs_get_battery_string_property(client, ret, psp,
939 val->strval = model_name;
942 case POWER_SUPPLY_PROP_MANUFACTURER:
943 ret = sbs_get_property_index(client, psp);
947 ret = sbs_get_battery_string_property(client, ret, psp,
949 val->strval = manufacturer;
952 case POWER_SUPPLY_PROP_MANUFACTURE_YEAR:
953 case POWER_SUPPLY_PROP_MANUFACTURE_MONTH:
954 case POWER_SUPPLY_PROP_MANUFACTURE_DAY:
955 ret = sbs_get_battery_manufacture_date(client, psp, val);
959 dev_err(&client->dev,
960 "%s: INVALID property\n", __func__);
964 if (!chip->enable_detection)
967 if (!chip->gpio_detect &&
968 chip->is_present != (ret >= 0)) {
969 sbs_update_presence(chip, (ret >= 0));
970 power_supply_changed(chip->power_supply);
975 /* Convert units to match requirements for power supply class */
976 sbs_unit_adjustment(client, psp, val);
979 dev_dbg(&client->dev,
980 "%s: property = %d, value = %x\n", __func__, psp, val->intval);
982 if (ret && chip->is_present)
985 /* battery not present, so return NODATA for properties */
992 static void sbs_supply_changed(struct sbs_info *chip)
994 struct power_supply *battery = chip->power_supply;
997 ret = gpiod_get_value_cansleep(chip->gpio_detect);
1000 sbs_update_presence(chip, ret);
1001 power_supply_changed(battery);
1004 static irqreturn_t sbs_irq(int irq, void *devid)
1006 sbs_supply_changed(devid);
1010 static void sbs_alert(struct i2c_client *client, enum i2c_alert_protocol prot,
1013 sbs_supply_changed(i2c_get_clientdata(client));
1016 static void sbs_external_power_changed(struct power_supply *psy)
1018 struct sbs_info *chip = power_supply_get_drvdata(psy);
1020 /* cancel outstanding work */
1021 cancel_delayed_work_sync(&chip->work);
1023 schedule_delayed_work(&chip->work, HZ);
1024 chip->poll_time = chip->poll_retry_count;
1027 static void sbs_delayed_work(struct work_struct *work)
1029 struct sbs_info *chip;
1032 chip = container_of(work, struct sbs_info, work.work);
1034 ret = sbs_read_word_data(chip->client, sbs_data[REG_STATUS].addr);
1035 /* if the read failed, give up on this work */
1037 chip->poll_time = 0;
1041 if (ret & BATTERY_FULL_CHARGED)
1042 ret = POWER_SUPPLY_STATUS_FULL;
1043 else if (ret & BATTERY_DISCHARGING)
1044 ret = POWER_SUPPLY_STATUS_DISCHARGING;
1046 ret = POWER_SUPPLY_STATUS_CHARGING;
1048 sbs_status_correct(chip->client, &ret);
1050 if (chip->last_state != ret) {
1051 chip->poll_time = 0;
1052 power_supply_changed(chip->power_supply);
1055 if (chip->poll_time > 0) {
1056 schedule_delayed_work(&chip->work, HZ);
1062 static const struct power_supply_desc sbs_default_desc = {
1063 .type = POWER_SUPPLY_TYPE_BATTERY,
1064 .properties = sbs_properties,
1065 .num_properties = ARRAY_SIZE(sbs_properties),
1066 .get_property = sbs_get_property,
1067 .external_power_changed = sbs_external_power_changed,
1070 static int sbs_probe(struct i2c_client *client)
1072 struct sbs_info *chip;
1073 struct power_supply_desc *sbs_desc;
1074 struct sbs_platform_data *pdata = client->dev.platform_data;
1075 struct power_supply_config psy_cfg = {};
1079 sbs_desc = devm_kmemdup(&client->dev, &sbs_default_desc,
1080 sizeof(*sbs_desc), GFP_KERNEL);
1084 sbs_desc->name = devm_kasprintf(&client->dev, GFP_KERNEL, "sbs-%s",
1085 dev_name(&client->dev));
1086 if (!sbs_desc->name)
1089 chip = devm_kzalloc(&client->dev, sizeof(struct sbs_info), GFP_KERNEL);
1093 chip->flags = (u32)(uintptr_t)device_get_match_data(&client->dev);
1094 chip->client = client;
1095 chip->enable_detection = false;
1096 psy_cfg.of_node = client->dev.of_node;
1097 psy_cfg.drv_data = chip;
1098 chip->last_state = POWER_SUPPLY_STATUS_UNKNOWN;
1099 mutex_init(&chip->mode_lock);
1101 /* use pdata if available, fall back to DT properties,
1102 * or hardcoded defaults if not
1104 rc = device_property_read_u32(&client->dev, "sbs,i2c-retry-count",
1105 &chip->i2c_retry_count);
1107 chip->i2c_retry_count = 0;
1109 rc = device_property_read_u32(&client->dev, "sbs,poll-retry-count",
1110 &chip->poll_retry_count);
1112 chip->poll_retry_count = 0;
1115 chip->poll_retry_count = pdata->poll_retry_count;
1116 chip->i2c_retry_count = pdata->i2c_retry_count;
1118 chip->i2c_retry_count = chip->i2c_retry_count + 1;
1120 chip->charger_broadcasts = !device_property_read_bool(&client->dev,
1121 "sbs,disable-charger-broadcasts");
1123 chip->gpio_detect = devm_gpiod_get_optional(&client->dev,
1124 "sbs,battery-detect", GPIOD_IN);
1125 if (IS_ERR(chip->gpio_detect)) {
1126 dev_err(&client->dev, "Failed to get gpio: %ld\n",
1127 PTR_ERR(chip->gpio_detect));
1128 return PTR_ERR(chip->gpio_detect);
1131 i2c_set_clientdata(client, chip);
1133 if (!chip->gpio_detect)
1136 irq = gpiod_to_irq(chip->gpio_detect);
1138 dev_warn(&client->dev, "Failed to get gpio as irq: %d\n", irq);
1142 rc = devm_request_threaded_irq(&client->dev, irq, NULL, sbs_irq,
1143 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
1144 dev_name(&client->dev), chip);
1146 dev_warn(&client->dev, "Failed to request irq: %d\n", rc);
1152 * Before we register, we might need to make sure we can actually talk
1155 if (!(force_load || chip->gpio_detect)) {
1156 rc = sbs_read_word_data(client, sbs_data[REG_STATUS].addr);
1159 dev_err(&client->dev, "%s: Failed to get device status\n",
1165 chip->power_supply = devm_power_supply_register(&client->dev, sbs_desc,
1167 if (IS_ERR(chip->power_supply)) {
1168 dev_err(&client->dev,
1169 "%s: Failed to register power supply\n", __func__);
1170 rc = PTR_ERR(chip->power_supply);
1174 dev_info(&client->dev,
1175 "%s: battery gas gauge device registered\n", client->name);
1177 INIT_DELAYED_WORK(&chip->work, sbs_delayed_work);
1179 chip->enable_detection = true;
1187 static int sbs_remove(struct i2c_client *client)
1189 struct sbs_info *chip = i2c_get_clientdata(client);
1191 cancel_delayed_work_sync(&chip->work);
1196 #if defined CONFIG_PM_SLEEP
1198 static int sbs_suspend(struct device *dev)
1200 struct i2c_client *client = to_i2c_client(dev);
1201 struct sbs_info *chip = i2c_get_clientdata(client);
1204 if (chip->poll_time > 0)
1205 cancel_delayed_work_sync(&chip->work);
1207 if (chip->flags & SBS_FLAGS_TI_BQ20ZX5) {
1208 /* Write to manufacturer access with sleep command. */
1209 ret = sbs_write_word_data(client,
1210 sbs_data[REG_MANUFACTURER_DATA].addr,
1211 MANUFACTURER_ACCESS_SLEEP);
1212 if (chip->is_present && ret < 0)
1219 static SIMPLE_DEV_PM_OPS(sbs_pm_ops, sbs_suspend, NULL);
1220 #define SBS_PM_OPS (&sbs_pm_ops)
1223 #define SBS_PM_OPS NULL
1226 static const struct i2c_device_id sbs_id[] = {
1229 { "sbs-battery", 1 },
1232 MODULE_DEVICE_TABLE(i2c, sbs_id);
1234 static const struct of_device_id sbs_dt_ids[] = {
1235 { .compatible = "sbs,sbs-battery" },
1237 .compatible = "ti,bq20z65",
1238 .data = (void *)SBS_FLAGS_TI_BQ20ZX5,
1241 .compatible = "ti,bq20z75",
1242 .data = (void *)SBS_FLAGS_TI_BQ20ZX5,
1246 MODULE_DEVICE_TABLE(of, sbs_dt_ids);
1248 static struct i2c_driver sbs_battery_driver = {
1249 .probe_new = sbs_probe,
1250 .remove = sbs_remove,
1254 .name = "sbs-battery",
1255 .of_match_table = sbs_dt_ids,
1259 module_i2c_driver(sbs_battery_driver);
1261 MODULE_DESCRIPTION("SBS battery monitor driver");
1262 MODULE_LICENSE("GPL");
1264 module_param(force_load, bool, 0444);
1265 MODULE_PARM_DESC(force_load,
1266 "Attempt to load the driver even if no battery is connected");