2 * Gas Gauge driver for TI's BQ20Z75
4 * Copyright (c) 2010, NVIDIA Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/err.h>
25 #include <linux/power_supply.h>
26 #include <linux/i2c.h>
27 #include <linux/slab.h>
28 #include <linux/interrupt.h>
29 #include <linux/gpio.h>
31 #include <linux/power/bq20z75.h>
34 REG_MANUFACTURER_DATA,
44 REG_REMAINING_CAPACITY,
45 REG_REMAINING_CAPACITY_CHARGE,
46 REG_FULL_CHARGE_CAPACITY,
47 REG_FULL_CHARGE_CAPACITY_CHARGE,
49 REG_DESIGN_CAPACITY_CHARGE,
53 /* Battery Mode defines */
54 #define BATTERY_MODE_OFFSET 0x03
55 #define BATTERY_MODE_MASK 0x8000
56 enum bq20z75_battery_mode {
61 /* manufacturer access defines */
62 #define MANUFACTURER_ACCESS_STATUS 0x0006
63 #define MANUFACTURER_ACCESS_SLEEP 0x0011
65 /* battery status value bits */
66 #define BATTERY_DISCHARGING 0x40
67 #define BATTERY_FULL_CHARGED 0x20
68 #define BATTERY_FULL_DISCHARGED 0x10
70 #define BQ20Z75_DATA(_psp, _addr, _min_value, _max_value) { \
73 .min_value = _min_value, \
74 .max_value = _max_value, \
77 static const struct bq20z75_device_data {
78 enum power_supply_property psp;
83 [REG_MANUFACTURER_DATA] =
84 BQ20Z75_DATA(POWER_SUPPLY_PROP_PRESENT, 0x00, 0, 65535),
86 BQ20Z75_DATA(POWER_SUPPLY_PROP_TEMP, 0x08, 0, 65535),
88 BQ20Z75_DATA(POWER_SUPPLY_PROP_VOLTAGE_NOW, 0x09, 0, 20000),
90 BQ20Z75_DATA(POWER_SUPPLY_PROP_CURRENT_NOW, 0x0A, -32768,
93 BQ20Z75_DATA(POWER_SUPPLY_PROP_CAPACITY, 0x0E, 0, 100),
94 [REG_REMAINING_CAPACITY] =
95 BQ20Z75_DATA(POWER_SUPPLY_PROP_ENERGY_NOW, 0x0F, 0, 65535),
96 [REG_REMAINING_CAPACITY_CHARGE] =
97 BQ20Z75_DATA(POWER_SUPPLY_PROP_CHARGE_NOW, 0x0F, 0, 65535),
98 [REG_FULL_CHARGE_CAPACITY] =
99 BQ20Z75_DATA(POWER_SUPPLY_PROP_ENERGY_FULL, 0x10, 0, 65535),
100 [REG_FULL_CHARGE_CAPACITY_CHARGE] =
101 BQ20Z75_DATA(POWER_SUPPLY_PROP_CHARGE_FULL, 0x10, 0, 65535),
102 [REG_TIME_TO_EMPTY] =
103 BQ20Z75_DATA(POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG, 0x12, 0,
106 BQ20Z75_DATA(POWER_SUPPLY_PROP_TIME_TO_FULL_AVG, 0x13, 0,
109 BQ20Z75_DATA(POWER_SUPPLY_PROP_STATUS, 0x16, 0, 65535),
111 BQ20Z75_DATA(POWER_SUPPLY_PROP_CYCLE_COUNT, 0x17, 0, 65535),
112 [REG_DESIGN_CAPACITY] =
113 BQ20Z75_DATA(POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN, 0x18, 0,
115 [REG_DESIGN_CAPACITY_CHARGE] =
116 BQ20Z75_DATA(POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN, 0x18, 0,
118 [REG_DESIGN_VOLTAGE] =
119 BQ20Z75_DATA(POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN, 0x19, 0,
121 [REG_SERIAL_NUMBER] =
122 BQ20Z75_DATA(POWER_SUPPLY_PROP_SERIAL_NUMBER, 0x1C, 0, 65535),
125 static enum power_supply_property bq20z75_properties[] = {
126 POWER_SUPPLY_PROP_STATUS,
127 POWER_SUPPLY_PROP_HEALTH,
128 POWER_SUPPLY_PROP_PRESENT,
129 POWER_SUPPLY_PROP_TECHNOLOGY,
130 POWER_SUPPLY_PROP_CYCLE_COUNT,
131 POWER_SUPPLY_PROP_VOLTAGE_NOW,
132 POWER_SUPPLY_PROP_CURRENT_NOW,
133 POWER_SUPPLY_PROP_CAPACITY,
134 POWER_SUPPLY_PROP_TEMP,
135 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
136 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
137 POWER_SUPPLY_PROP_SERIAL_NUMBER,
138 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
139 POWER_SUPPLY_PROP_ENERGY_NOW,
140 POWER_SUPPLY_PROP_ENERGY_FULL,
141 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
142 POWER_SUPPLY_PROP_CHARGE_NOW,
143 POWER_SUPPLY_PROP_CHARGE_FULL,
144 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
147 struct bq20z75_info {
148 struct i2c_client *client;
149 struct power_supply power_supply;
150 struct bq20z75_platform_data *pdata;
153 bool enable_detection;
157 static int bq20z75_read_word_data(struct i2c_client *client, u8 address)
159 struct bq20z75_info *bq20z75_device = i2c_get_clientdata(client);
163 if (bq20z75_device->pdata)
164 retries = max(bq20z75_device->pdata->i2c_retry_count + 1, 1);
166 while (retries > 0) {
167 ret = i2c_smbus_read_word_data(client, address);
174 dev_dbg(&client->dev,
175 "%s: i2c read at address 0x%x failed\n",
180 return le16_to_cpu(ret);
183 static int bq20z75_write_word_data(struct i2c_client *client, u8 address,
186 struct bq20z75_info *bq20z75_device = i2c_get_clientdata(client);
190 if (bq20z75_device->pdata)
191 retries = max(bq20z75_device->pdata->i2c_retry_count + 1, 1);
193 while (retries > 0) {
194 ret = i2c_smbus_write_word_data(client, address,
202 dev_dbg(&client->dev,
203 "%s: i2c write to address 0x%x failed\n",
211 static int bq20z75_get_battery_presence_and_health(
212 struct i2c_client *client, enum power_supply_property psp,
213 union power_supply_propval *val)
216 struct bq20z75_info *bq20z75_device = i2c_get_clientdata(client);
218 if (psp == POWER_SUPPLY_PROP_PRESENT &&
219 bq20z75_device->gpio_detect) {
220 ret = gpio_get_value(
221 bq20z75_device->pdata->battery_detect);
222 if (ret == bq20z75_device->pdata->battery_detect_present)
226 bq20z75_device->is_present = val->intval;
230 /* Write to ManufacturerAccess with
231 * ManufacturerAccess command and then
233 ret = bq20z75_write_word_data(client,
234 bq20z75_data[REG_MANUFACTURER_DATA].addr,
235 MANUFACTURER_ACCESS_STATUS);
237 if (psp == POWER_SUPPLY_PROP_PRESENT)
238 val->intval = 0; /* battery removed */
242 ret = bq20z75_read_word_data(client,
243 bq20z75_data[REG_MANUFACTURER_DATA].addr);
247 if (ret < bq20z75_data[REG_MANUFACTURER_DATA].min_value ||
248 ret > bq20z75_data[REG_MANUFACTURER_DATA].max_value) {
253 /* Mask the upper nibble of 2nd byte and
254 * lower byte of response then
255 * shift the result by 8 to get status*/
258 if (psp == POWER_SUPPLY_PROP_PRESENT) {
260 /* battery removed */
264 } else if (psp == POWER_SUPPLY_PROP_HEALTH) {
266 val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
267 else if (ret == 0x0B)
268 val->intval = POWER_SUPPLY_HEALTH_OVERHEAT;
269 else if (ret == 0x0C)
270 val->intval = POWER_SUPPLY_HEALTH_DEAD;
272 val->intval = POWER_SUPPLY_HEALTH_GOOD;
278 static int bq20z75_get_battery_property(struct i2c_client *client,
279 int reg_offset, enum power_supply_property psp,
280 union power_supply_propval *val)
284 ret = bq20z75_read_word_data(client,
285 bq20z75_data[reg_offset].addr);
289 /* returned values are 16 bit */
290 if (bq20z75_data[reg_offset].min_value < 0)
293 if (ret >= bq20z75_data[reg_offset].min_value &&
294 ret <= bq20z75_data[reg_offset].max_value) {
296 if (psp == POWER_SUPPLY_PROP_STATUS) {
297 if (ret & BATTERY_FULL_CHARGED)
298 val->intval = POWER_SUPPLY_STATUS_FULL;
299 else if (ret & BATTERY_FULL_DISCHARGED)
300 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
301 else if (ret & BATTERY_DISCHARGING)
302 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
304 val->intval = POWER_SUPPLY_STATUS_CHARGING;
307 if (psp == POWER_SUPPLY_PROP_STATUS)
308 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
316 static void bq20z75_unit_adjustment(struct i2c_client *client,
317 enum power_supply_property psp, union power_supply_propval *val)
319 #define BASE_UNIT_CONVERSION 1000
320 #define BATTERY_MODE_CAP_MULT_WATT (10 * BASE_UNIT_CONVERSION)
321 #define TIME_UNIT_CONVERSION 600
322 #define TEMP_KELVIN_TO_CELCIUS 2731
324 case POWER_SUPPLY_PROP_ENERGY_NOW:
325 case POWER_SUPPLY_PROP_ENERGY_FULL:
326 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
327 val->intval *= BATTERY_MODE_CAP_MULT_WATT;
330 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
331 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
332 case POWER_SUPPLY_PROP_CURRENT_NOW:
333 case POWER_SUPPLY_PROP_CHARGE_NOW:
334 case POWER_SUPPLY_PROP_CHARGE_FULL:
335 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
336 val->intval *= BASE_UNIT_CONVERSION;
339 case POWER_SUPPLY_PROP_TEMP:
340 /* bq20z75 provides battery tempreture in 0.1°K
341 * so convert it to 0.1°C */
342 val->intval -= TEMP_KELVIN_TO_CELCIUS;
346 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG:
347 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG:
348 val->intval *= TIME_UNIT_CONVERSION;
352 dev_dbg(&client->dev,
353 "%s: no need for unit conversion %d\n", __func__, psp);
357 static enum bq20z75_battery_mode
358 bq20z75_set_battery_mode(struct i2c_client *client,
359 enum bq20z75_battery_mode mode)
361 int ret, original_val;
363 original_val = bq20z75_read_word_data(client, BATTERY_MODE_OFFSET);
364 if (original_val < 0)
367 if ((original_val & BATTERY_MODE_MASK) == mode)
370 if (mode == BATTERY_MODE_AMPS)
371 ret = original_val & ~BATTERY_MODE_MASK;
373 ret = original_val | BATTERY_MODE_MASK;
375 ret = bq20z75_write_word_data(client, BATTERY_MODE_OFFSET, ret);
379 return original_val & BATTERY_MODE_MASK;
382 static int bq20z75_get_battery_capacity(struct i2c_client *client,
383 int reg_offset, enum power_supply_property psp,
384 union power_supply_propval *val)
387 enum bq20z75_battery_mode mode = BATTERY_MODE_WATTS;
389 if (power_supply_is_amp_property(psp))
390 mode = BATTERY_MODE_AMPS;
392 mode = bq20z75_set_battery_mode(client, mode);
396 ret = bq20z75_read_word_data(client, bq20z75_data[reg_offset].addr);
400 if (psp == POWER_SUPPLY_PROP_CAPACITY) {
401 /* bq20z75 spec says that this can be >100 %
402 * even if max value is 100 % */
403 val->intval = min(ret, 100);
407 ret = bq20z75_set_battery_mode(client, mode);
414 static char bq20z75_serial[5];
415 static int bq20z75_get_battery_serial_number(struct i2c_client *client,
416 union power_supply_propval *val)
420 ret = bq20z75_read_word_data(client,
421 bq20z75_data[REG_SERIAL_NUMBER].addr);
425 ret = sprintf(bq20z75_serial, "%04x", ret);
426 val->strval = bq20z75_serial;
431 static int bq20z75_get_property_index(struct i2c_client *client,
432 enum power_supply_property psp)
435 for (count = 0; count < ARRAY_SIZE(bq20z75_data); count++)
436 if (psp == bq20z75_data[count].psp)
439 dev_warn(&client->dev,
440 "%s: Invalid Property - %d\n", __func__, psp);
445 static int bq20z75_get_property(struct power_supply *psy,
446 enum power_supply_property psp,
447 union power_supply_propval *val)
450 struct bq20z75_info *bq20z75_device = container_of(psy,
451 struct bq20z75_info, power_supply);
452 struct i2c_client *client = bq20z75_device->client;
455 case POWER_SUPPLY_PROP_PRESENT:
456 case POWER_SUPPLY_PROP_HEALTH:
457 ret = bq20z75_get_battery_presence_and_health(client, psp, val);
458 if (psp == POWER_SUPPLY_PROP_PRESENT)
462 case POWER_SUPPLY_PROP_TECHNOLOGY:
463 val->intval = POWER_SUPPLY_TECHNOLOGY_LION;
466 case POWER_SUPPLY_PROP_ENERGY_NOW:
467 case POWER_SUPPLY_PROP_ENERGY_FULL:
468 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
469 case POWER_SUPPLY_PROP_CHARGE_NOW:
470 case POWER_SUPPLY_PROP_CHARGE_FULL:
471 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
472 case POWER_SUPPLY_PROP_CAPACITY:
473 ret = bq20z75_get_property_index(client, psp);
477 ret = bq20z75_get_battery_capacity(client, ret, psp, val);
480 case POWER_SUPPLY_PROP_SERIAL_NUMBER:
481 ret = bq20z75_get_battery_serial_number(client, val);
484 case POWER_SUPPLY_PROP_STATUS:
485 case POWER_SUPPLY_PROP_CYCLE_COUNT:
486 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
487 case POWER_SUPPLY_PROP_CURRENT_NOW:
488 case POWER_SUPPLY_PROP_TEMP:
489 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG:
490 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG:
491 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
492 ret = bq20z75_get_property_index(client, psp);
496 ret = bq20z75_get_battery_property(client, ret, psp, val);
500 dev_err(&client->dev,
501 "%s: INVALID property\n", __func__);
505 if (!bq20z75_device->enable_detection)
508 if (!bq20z75_device->gpio_detect &&
509 bq20z75_device->is_present != (ret >= 0)) {
510 bq20z75_device->is_present = (ret >= 0);
511 power_supply_changed(&bq20z75_device->power_supply);
516 /* Convert units to match requirements for power supply class */
517 bq20z75_unit_adjustment(client, psp, val);
520 dev_dbg(&client->dev,
521 "%s: property = %d, value = %x\n", __func__, psp, val->intval);
523 if (ret && bq20z75_device->is_present)
526 /* battery not present, so return NODATA for properties */
533 static irqreturn_t bq20z75_irq(int irq, void *devid)
535 struct power_supply *battery = devid;
537 power_supply_changed(battery);
542 static int __devinit bq20z75_probe(struct i2c_client *client,
543 const struct i2c_device_id *id)
545 struct bq20z75_info *bq20z75_device;
546 struct bq20z75_platform_data *pdata = client->dev.platform_data;
550 bq20z75_device = kzalloc(sizeof(struct bq20z75_info), GFP_KERNEL);
554 bq20z75_device->client = client;
555 bq20z75_device->enable_detection = false;
556 bq20z75_device->gpio_detect = false;
557 bq20z75_device->power_supply.name = "battery";
558 bq20z75_device->power_supply.type = POWER_SUPPLY_TYPE_BATTERY;
559 bq20z75_device->power_supply.properties = bq20z75_properties;
560 bq20z75_device->power_supply.num_properties =
561 ARRAY_SIZE(bq20z75_properties);
562 bq20z75_device->power_supply.get_property = bq20z75_get_property;
565 bq20z75_device->gpio_detect =
566 gpio_is_valid(pdata->battery_detect);
567 bq20z75_device->pdata = pdata;
570 i2c_set_clientdata(client, bq20z75_device);
572 if (!bq20z75_device->gpio_detect)
575 rc = gpio_request(pdata->battery_detect, dev_name(&client->dev));
577 dev_warn(&client->dev, "Failed to request gpio: %d\n", rc);
578 bq20z75_device->gpio_detect = false;
582 rc = gpio_direction_input(pdata->battery_detect);
584 dev_warn(&client->dev, "Failed to get gpio as input: %d\n", rc);
585 gpio_free(pdata->battery_detect);
586 bq20z75_device->gpio_detect = false;
590 irq = gpio_to_irq(pdata->battery_detect);
592 dev_warn(&client->dev, "Failed to get gpio as irq: %d\n", irq);
593 gpio_free(pdata->battery_detect);
594 bq20z75_device->gpio_detect = false;
598 rc = request_irq(irq, bq20z75_irq,
599 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
600 dev_name(&client->dev), &bq20z75_device->power_supply);
602 dev_warn(&client->dev, "Failed to request irq: %d\n", rc);
603 gpio_free(pdata->battery_detect);
604 bq20z75_device->gpio_detect = false;
608 bq20z75_device->irq = irq;
612 rc = power_supply_register(&client->dev, &bq20z75_device->power_supply);
614 dev_err(&client->dev,
615 "%s: Failed to register power supply\n", __func__);
619 dev_info(&client->dev,
620 "%s: battery gas gauge device registered\n", client->name);
625 if (bq20z75_device->irq)
626 free_irq(bq20z75_device->irq, &bq20z75_device->power_supply);
627 if (bq20z75_device->gpio_detect)
628 gpio_free(pdata->battery_detect);
630 kfree(bq20z75_device);
635 static int __devexit bq20z75_remove(struct i2c_client *client)
637 struct bq20z75_info *bq20z75_device = i2c_get_clientdata(client);
639 if (bq20z75_device->irq)
640 free_irq(bq20z75_device->irq, &bq20z75_device->power_supply);
641 if (bq20z75_device->gpio_detect)
642 gpio_free(bq20z75_device->pdata->battery_detect);
644 power_supply_unregister(&bq20z75_device->power_supply);
645 kfree(bq20z75_device);
646 bq20z75_device = NULL;
651 #if defined CONFIG_PM
652 static int bq20z75_suspend(struct i2c_client *client,
655 struct bq20z75_info *bq20z75_device = i2c_get_clientdata(client);
658 /* write to manufacturer access with sleep command */
659 ret = bq20z75_write_word_data(client,
660 bq20z75_data[REG_MANUFACTURER_DATA].addr,
661 MANUFACTURER_ACCESS_SLEEP);
662 if (bq20z75_device->is_present && ret < 0)
668 #define bq20z75_suspend NULL
670 /* any smbus transaction will wake up bq20z75 */
671 #define bq20z75_resume NULL
673 static const struct i2c_device_id bq20z75_id[] = {
677 MODULE_DEVICE_TABLE(i2c, bq20z75_id);
679 static struct i2c_driver bq20z75_battery_driver = {
680 .probe = bq20z75_probe,
681 .remove = __devexit_p(bq20z75_remove),
682 .suspend = bq20z75_suspend,
683 .resume = bq20z75_resume,
684 .id_table = bq20z75_id,
686 .name = "bq20z75-battery",
690 static int __init bq20z75_battery_init(void)
692 return i2c_add_driver(&bq20z75_battery_driver);
694 module_init(bq20z75_battery_init);
696 static void __exit bq20z75_battery_exit(void)
698 i2c_del_driver(&bq20z75_battery_driver);
700 module_exit(bq20z75_battery_exit);
702 MODULE_DESCRIPTION("BQ20z75 battery monitor driver");
703 MODULE_LICENSE("GPL");