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 60
322 #define TEMP_KELVIN_TO_CELSIUS 2731
324 case POWER_SUPPLY_PROP_ENERGY_NOW
:
325 case POWER_SUPPLY_PROP_ENERGY_FULL
:
326 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN
:
327 /* bq20z75 provides energy in units of 10mWh.
330 val
->intval
*= BATTERY_MODE_CAP_MULT_WATT
;
333 case POWER_SUPPLY_PROP_VOLTAGE_NOW
:
334 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN
:
335 case POWER_SUPPLY_PROP_CURRENT_NOW
:
336 case POWER_SUPPLY_PROP_CHARGE_NOW
:
337 case POWER_SUPPLY_PROP_CHARGE_FULL
:
338 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN
:
339 val
->intval
*= BASE_UNIT_CONVERSION
;
342 case POWER_SUPPLY_PROP_TEMP
:
343 /* bq20z75 provides battery temperature in 0.1K
344 * so convert it to 0.1°C
346 val
->intval
-= TEMP_KELVIN_TO_CELSIUS
;
349 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG
:
350 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG
:
351 /* bq20z75 provides time to empty and time to full in minutes.
354 val
->intval
*= TIME_UNIT_CONVERSION
;
358 dev_dbg(&client
->dev
,
359 "%s: no need for unit conversion %d\n", __func__
, psp
);
363 static enum bq20z75_battery_mode
364 bq20z75_set_battery_mode(struct i2c_client
*client
,
365 enum bq20z75_battery_mode mode
)
367 int ret
, original_val
;
369 original_val
= bq20z75_read_word_data(client
, BATTERY_MODE_OFFSET
);
370 if (original_val
< 0)
373 if ((original_val
& BATTERY_MODE_MASK
) == mode
)
376 if (mode
== BATTERY_MODE_AMPS
)
377 ret
= original_val
& ~BATTERY_MODE_MASK
;
379 ret
= original_val
| BATTERY_MODE_MASK
;
381 ret
= bq20z75_write_word_data(client
, BATTERY_MODE_OFFSET
, ret
);
385 return original_val
& BATTERY_MODE_MASK
;
388 static int bq20z75_get_battery_capacity(struct i2c_client
*client
,
389 int reg_offset
, enum power_supply_property psp
,
390 union power_supply_propval
*val
)
393 enum bq20z75_battery_mode mode
= BATTERY_MODE_WATTS
;
395 if (power_supply_is_amp_property(psp
))
396 mode
= BATTERY_MODE_AMPS
;
398 mode
= bq20z75_set_battery_mode(client
, mode
);
402 ret
= bq20z75_read_word_data(client
, bq20z75_data
[reg_offset
].addr
);
406 if (psp
== POWER_SUPPLY_PROP_CAPACITY
) {
407 /* bq20z75 spec says that this can be >100 %
408 * even if max value is 100 % */
409 val
->intval
= min(ret
, 100);
413 ret
= bq20z75_set_battery_mode(client
, mode
);
420 static char bq20z75_serial
[5];
421 static int bq20z75_get_battery_serial_number(struct i2c_client
*client
,
422 union power_supply_propval
*val
)
426 ret
= bq20z75_read_word_data(client
,
427 bq20z75_data
[REG_SERIAL_NUMBER
].addr
);
431 ret
= sprintf(bq20z75_serial
, "%04x", ret
);
432 val
->strval
= bq20z75_serial
;
437 static int bq20z75_get_property_index(struct i2c_client
*client
,
438 enum power_supply_property psp
)
441 for (count
= 0; count
< ARRAY_SIZE(bq20z75_data
); count
++)
442 if (psp
== bq20z75_data
[count
].psp
)
445 dev_warn(&client
->dev
,
446 "%s: Invalid Property - %d\n", __func__
, psp
);
451 static int bq20z75_get_property(struct power_supply
*psy
,
452 enum power_supply_property psp
,
453 union power_supply_propval
*val
)
456 struct bq20z75_info
*bq20z75_device
= container_of(psy
,
457 struct bq20z75_info
, power_supply
);
458 struct i2c_client
*client
= bq20z75_device
->client
;
461 case POWER_SUPPLY_PROP_PRESENT
:
462 case POWER_SUPPLY_PROP_HEALTH
:
463 ret
= bq20z75_get_battery_presence_and_health(client
, psp
, val
);
464 if (psp
== POWER_SUPPLY_PROP_PRESENT
)
468 case POWER_SUPPLY_PROP_TECHNOLOGY
:
469 val
->intval
= POWER_SUPPLY_TECHNOLOGY_LION
;
472 case POWER_SUPPLY_PROP_ENERGY_NOW
:
473 case POWER_SUPPLY_PROP_ENERGY_FULL
:
474 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN
:
475 case POWER_SUPPLY_PROP_CHARGE_NOW
:
476 case POWER_SUPPLY_PROP_CHARGE_FULL
:
477 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN
:
478 case POWER_SUPPLY_PROP_CAPACITY
:
479 ret
= bq20z75_get_property_index(client
, psp
);
483 ret
= bq20z75_get_battery_capacity(client
, ret
, psp
, val
);
486 case POWER_SUPPLY_PROP_SERIAL_NUMBER
:
487 ret
= bq20z75_get_battery_serial_number(client
, val
);
490 case POWER_SUPPLY_PROP_STATUS
:
491 case POWER_SUPPLY_PROP_CYCLE_COUNT
:
492 case POWER_SUPPLY_PROP_VOLTAGE_NOW
:
493 case POWER_SUPPLY_PROP_CURRENT_NOW
:
494 case POWER_SUPPLY_PROP_TEMP
:
495 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG
:
496 case POWER_SUPPLY_PROP_TIME_TO_FULL_AVG
:
497 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN
:
498 ret
= bq20z75_get_property_index(client
, psp
);
502 ret
= bq20z75_get_battery_property(client
, ret
, psp
, val
);
506 dev_err(&client
->dev
,
507 "%s: INVALID property\n", __func__
);
511 if (!bq20z75_device
->enable_detection
)
514 if (!bq20z75_device
->gpio_detect
&&
515 bq20z75_device
->is_present
!= (ret
>= 0)) {
516 bq20z75_device
->is_present
= (ret
>= 0);
517 power_supply_changed(&bq20z75_device
->power_supply
);
522 /* Convert units to match requirements for power supply class */
523 bq20z75_unit_adjustment(client
, psp
, val
);
526 dev_dbg(&client
->dev
,
527 "%s: property = %d, value = %x\n", __func__
, psp
, val
->intval
);
529 if (ret
&& bq20z75_device
->is_present
)
532 /* battery not present, so return NODATA for properties */
539 static irqreturn_t
bq20z75_irq(int irq
, void *devid
)
541 struct power_supply
*battery
= devid
;
543 power_supply_changed(battery
);
548 static int __devinit
bq20z75_probe(struct i2c_client
*client
,
549 const struct i2c_device_id
*id
)
551 struct bq20z75_info
*bq20z75_device
;
552 struct bq20z75_platform_data
*pdata
= client
->dev
.platform_data
;
556 bq20z75_device
= kzalloc(sizeof(struct bq20z75_info
), GFP_KERNEL
);
560 bq20z75_device
->client
= client
;
561 bq20z75_device
->enable_detection
= false;
562 bq20z75_device
->gpio_detect
= false;
563 bq20z75_device
->power_supply
.name
= "battery";
564 bq20z75_device
->power_supply
.type
= POWER_SUPPLY_TYPE_BATTERY
;
565 bq20z75_device
->power_supply
.properties
= bq20z75_properties
;
566 bq20z75_device
->power_supply
.num_properties
=
567 ARRAY_SIZE(bq20z75_properties
);
568 bq20z75_device
->power_supply
.get_property
= bq20z75_get_property
;
571 bq20z75_device
->gpio_detect
=
572 gpio_is_valid(pdata
->battery_detect
);
573 bq20z75_device
->pdata
= pdata
;
576 i2c_set_clientdata(client
, bq20z75_device
);
578 if (!bq20z75_device
->gpio_detect
)
581 rc
= gpio_request(pdata
->battery_detect
, dev_name(&client
->dev
));
583 dev_warn(&client
->dev
, "Failed to request gpio: %d\n", rc
);
584 bq20z75_device
->gpio_detect
= false;
588 rc
= gpio_direction_input(pdata
->battery_detect
);
590 dev_warn(&client
->dev
, "Failed to get gpio as input: %d\n", rc
);
591 gpio_free(pdata
->battery_detect
);
592 bq20z75_device
->gpio_detect
= false;
596 irq
= gpio_to_irq(pdata
->battery_detect
);
598 dev_warn(&client
->dev
, "Failed to get gpio as irq: %d\n", irq
);
599 gpio_free(pdata
->battery_detect
);
600 bq20z75_device
->gpio_detect
= false;
604 rc
= request_irq(irq
, bq20z75_irq
,
605 IRQF_TRIGGER_RISING
| IRQF_TRIGGER_FALLING
,
606 dev_name(&client
->dev
), &bq20z75_device
->power_supply
);
608 dev_warn(&client
->dev
, "Failed to request irq: %d\n", rc
);
609 gpio_free(pdata
->battery_detect
);
610 bq20z75_device
->gpio_detect
= false;
614 bq20z75_device
->irq
= irq
;
618 rc
= power_supply_register(&client
->dev
, &bq20z75_device
->power_supply
);
620 dev_err(&client
->dev
,
621 "%s: Failed to register power supply\n", __func__
);
625 dev_info(&client
->dev
,
626 "%s: battery gas gauge device registered\n", client
->name
);
631 if (bq20z75_device
->irq
)
632 free_irq(bq20z75_device
->irq
, &bq20z75_device
->power_supply
);
633 if (bq20z75_device
->gpio_detect
)
634 gpio_free(pdata
->battery_detect
);
636 kfree(bq20z75_device
);
641 static int __devexit
bq20z75_remove(struct i2c_client
*client
)
643 struct bq20z75_info
*bq20z75_device
= i2c_get_clientdata(client
);
645 if (bq20z75_device
->irq
)
646 free_irq(bq20z75_device
->irq
, &bq20z75_device
->power_supply
);
647 if (bq20z75_device
->gpio_detect
)
648 gpio_free(bq20z75_device
->pdata
->battery_detect
);
650 power_supply_unregister(&bq20z75_device
->power_supply
);
651 kfree(bq20z75_device
);
652 bq20z75_device
= NULL
;
657 #if defined CONFIG_PM
658 static int bq20z75_suspend(struct i2c_client
*client
,
661 struct bq20z75_info
*bq20z75_device
= i2c_get_clientdata(client
);
664 /* write to manufacturer access with sleep command */
665 ret
= bq20z75_write_word_data(client
,
666 bq20z75_data
[REG_MANUFACTURER_DATA
].addr
,
667 MANUFACTURER_ACCESS_SLEEP
);
668 if (bq20z75_device
->is_present
&& ret
< 0)
674 #define bq20z75_suspend NULL
676 /* any smbus transaction will wake up bq20z75 */
677 #define bq20z75_resume NULL
679 static const struct i2c_device_id bq20z75_id
[] = {
683 MODULE_DEVICE_TABLE(i2c
, bq20z75_id
);
685 static struct i2c_driver bq20z75_battery_driver
= {
686 .probe
= bq20z75_probe
,
687 .remove
= __devexit_p(bq20z75_remove
),
688 .suspend
= bq20z75_suspend
,
689 .resume
= bq20z75_resume
,
690 .id_table
= bq20z75_id
,
692 .name
= "bq20z75-battery",
696 static int __init
bq20z75_battery_init(void)
698 return i2c_add_driver(&bq20z75_battery_driver
);
700 module_init(bq20z75_battery_init
);
702 static void __exit
bq20z75_battery_exit(void)
704 i2c_del_driver(&bq20z75_battery_driver
);
706 module_exit(bq20z75_battery_exit
);
708 MODULE_DESCRIPTION("BQ20z75 battery monitor driver");
709 MODULE_LICENSE("GPL");