Merge tag 'regmap-v4.8' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie...
[sfrench/cifs-2.6.git] / drivers / power / bq27xxx_battery.c
1 /*
2  * BQ27xxx battery driver
3  *
4  * Copyright (C) 2008 Rodolfo Giometti <giometti@linux.it>
5  * Copyright (C) 2008 Eurotech S.p.A. <info@eurotech.it>
6  * Copyright (C) 2010-2011 Lars-Peter Clausen <lars@metafoo.de>
7  * Copyright (C) 2011 Pali Rohár <pali.rohar@gmail.com>
8  *
9  * Based on a previous work by Copyright (C) 2008 Texas Instruments, Inc.
10  *
11  * This package is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  *
15  * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
17  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
18  *
19  * Datasheets:
20  * http://www.ti.com/product/bq27000
21  * http://www.ti.com/product/bq27200
22  * http://www.ti.com/product/bq27010
23  * http://www.ti.com/product/bq27210
24  * http://www.ti.com/product/bq27500
25  * http://www.ti.com/product/bq27510-g3
26  * http://www.ti.com/product/bq27520-g4
27  * http://www.ti.com/product/bq27530-g1
28  * http://www.ti.com/product/bq27531-g1
29  * http://www.ti.com/product/bq27541-g1
30  * http://www.ti.com/product/bq27542-g1
31  * http://www.ti.com/product/bq27546-g1
32  * http://www.ti.com/product/bq27742-g1
33  * http://www.ti.com/product/bq27545-g1
34  * http://www.ti.com/product/bq27421-g1
35  * http://www.ti.com/product/bq27425-g1
36  * http://www.ti.com/product/bq27411-g1
37  * http://www.ti.com/product/bq27621-g1
38  */
39
40 #include <linux/device.h>
41 #include <linux/module.h>
42 #include <linux/param.h>
43 #include <linux/jiffies.h>
44 #include <linux/workqueue.h>
45 #include <linux/delay.h>
46 #include <linux/platform_device.h>
47 #include <linux/power_supply.h>
48 #include <linux/slab.h>
49 #include <linux/of.h>
50
51 #include <linux/power/bq27xxx_battery.h>
52
53 #define DRIVER_VERSION          "1.2.0"
54
55 #define BQ27XXX_MANUFACTURER    "Texas Instruments"
56
57 /* BQ27XXX Flags */
58 #define BQ27XXX_FLAG_DSC        BIT(0)
59 #define BQ27XXX_FLAG_SOCF       BIT(1) /* State-of-Charge threshold final */
60 #define BQ27XXX_FLAG_SOC1       BIT(2) /* State-of-Charge threshold 1 */
61 #define BQ27XXX_FLAG_FC         BIT(9)
62 #define BQ27XXX_FLAG_OTD        BIT(14)
63 #define BQ27XXX_FLAG_OTC        BIT(15)
64 #define BQ27XXX_FLAG_UT         BIT(14)
65 #define BQ27XXX_FLAG_OT         BIT(15)
66
67 /* BQ27000 has different layout for Flags register */
68 #define BQ27000_FLAG_EDVF       BIT(0) /* Final End-of-Discharge-Voltage flag */
69 #define BQ27000_FLAG_EDV1       BIT(1) /* First End-of-Discharge-Voltage flag */
70 #define BQ27000_FLAG_CI         BIT(4) /* Capacity Inaccurate flag */
71 #define BQ27000_FLAG_FC         BIT(5)
72 #define BQ27000_FLAG_CHGS       BIT(7) /* Charge state flag */
73
74 #define BQ27XXX_RS                      (20) /* Resistor sense mOhm */
75 #define BQ27XXX_POWER_CONSTANT          (29200) /* 29.2 µV^2 * 1000 */
76 #define BQ27XXX_CURRENT_CONSTANT        (3570) /* 3.57 µV * 1000 */
77
78 #define INVALID_REG_ADDR        0xff
79
80 /*
81  * bq27xxx_reg_index - Register names
82  *
83  * These are indexes into a device's register mapping array.
84  */
85 enum bq27xxx_reg_index {
86         BQ27XXX_REG_CTRL = 0,   /* Control */
87         BQ27XXX_REG_TEMP,       /* Temperature */
88         BQ27XXX_REG_INT_TEMP,   /* Internal Temperature */
89         BQ27XXX_REG_VOLT,       /* Voltage */
90         BQ27XXX_REG_AI,         /* Average Current */
91         BQ27XXX_REG_FLAGS,      /* Flags */
92         BQ27XXX_REG_TTE,        /* Time-to-Empty */
93         BQ27XXX_REG_TTF,        /* Time-to-Full */
94         BQ27XXX_REG_TTES,       /* Time-to-Empty Standby */
95         BQ27XXX_REG_TTECP,      /* Time-to-Empty at Constant Power */
96         BQ27XXX_REG_NAC,        /* Nominal Available Capacity */
97         BQ27XXX_REG_FCC,        /* Full Charge Capacity */
98         BQ27XXX_REG_CYCT,       /* Cycle Count */
99         BQ27XXX_REG_AE,         /* Available Energy */
100         BQ27XXX_REG_SOC,        /* State-of-Charge */
101         BQ27XXX_REG_DCAP,       /* Design Capacity */
102         BQ27XXX_REG_AP,         /* Average Power */
103 };
104
105 /* Register mappings */
106 static u8 bq27000_regs[] = {
107         0x00,   /* CONTROL      */
108         0x06,   /* TEMP         */
109         INVALID_REG_ADDR,       /* INT TEMP - NA*/
110         0x08,   /* VOLT         */
111         0x14,   /* AVG CURR     */
112         0x0a,   /* FLAGS        */
113         0x16,   /* TTE          */
114         0x18,   /* TTF          */
115         0x1c,   /* TTES         */
116         0x26,   /* TTECP        */
117         0x0c,   /* NAC          */
118         0x12,   /* LMD(FCC)     */
119         0x2a,   /* CYCT         */
120         0x22,   /* AE           */
121         0x0b,   /* SOC(RSOC)    */
122         0x76,   /* DCAP(ILMD)   */
123         0x24,   /* AP           */
124 };
125
126 static u8 bq27010_regs[] = {
127         0x00,   /* CONTROL      */
128         0x06,   /* TEMP         */
129         INVALID_REG_ADDR,       /* INT TEMP - NA*/
130         0x08,   /* VOLT         */
131         0x14,   /* AVG CURR     */
132         0x0a,   /* FLAGS        */
133         0x16,   /* TTE          */
134         0x18,   /* TTF          */
135         0x1c,   /* TTES         */
136         0x26,   /* TTECP        */
137         0x0c,   /* NAC          */
138         0x12,   /* LMD(FCC)     */
139         0x2a,   /* CYCT         */
140         INVALID_REG_ADDR,       /* AE - NA      */
141         0x0b,   /* SOC(RSOC)    */
142         0x76,   /* DCAP(ILMD)   */
143         INVALID_REG_ADDR,       /* AP - NA      */
144 };
145
146 static u8 bq27500_regs[] = {
147         0x00,   /* CONTROL      */
148         0x06,   /* TEMP         */
149         0x28,   /* INT TEMP     */
150         0x08,   /* VOLT         */
151         0x14,   /* AVG CURR     */
152         0x0a,   /* FLAGS        */
153         0x16,   /* TTE          */
154         INVALID_REG_ADDR,       /* TTF - NA     */
155         0x1a,   /* TTES         */
156         INVALID_REG_ADDR,       /* TTECP - NA   */
157         0x0c,   /* NAC          */
158         0x12,   /* LMD(FCC)     */
159         0x2a,   /* CYCT         */
160         INVALID_REG_ADDR,       /* AE - NA      */
161         0x2c,   /* SOC(RSOC)    */
162         0x3c,   /* DCAP(ILMD)   */
163         INVALID_REG_ADDR,       /* AP - NA      */
164 };
165
166 static u8 bq27530_regs[] = {
167         0x00,   /* CONTROL      */
168         0x06,   /* TEMP         */
169         0x32,   /* INT TEMP     */
170         0x08,   /* VOLT         */
171         0x14,   /* AVG CURR     */
172         0x0a,   /* FLAGS        */
173         0x16,   /* TTE          */
174         INVALID_REG_ADDR,       /* TTF - NA     */
175         INVALID_REG_ADDR,       /* TTES - NA    */
176         INVALID_REG_ADDR,       /* TTECP - NA   */
177         0x0c,   /* NAC          */
178         0x12,   /* LMD(FCC)     */
179         0x2a,   /* CYCT         */
180         INVALID_REG_ADDR,       /* AE - NA      */
181         0x2c,   /* SOC(RSOC)    */
182         INVALID_REG_ADDR,       /* DCAP - NA    */
183         0x24,   /* AP           */
184 };
185
186 static u8 bq27541_regs[] = {
187         0x00,   /* CONTROL      */
188         0x06,   /* TEMP         */
189         0x28,   /* INT TEMP     */
190         0x08,   /* VOLT         */
191         0x14,   /* AVG CURR     */
192         0x0a,   /* FLAGS        */
193         0x16,   /* TTE          */
194         INVALID_REG_ADDR,       /* TTF - NA     */
195         INVALID_REG_ADDR,       /* TTES - NA    */
196         INVALID_REG_ADDR,       /* TTECP - NA   */
197         0x0c,   /* NAC          */
198         0x12,   /* LMD(FCC)     */
199         0x2a,   /* CYCT         */
200         INVALID_REG_ADDR,       /* AE - NA      */
201         0x2c,   /* SOC(RSOC)    */
202         0x3c,   /* DCAP         */
203         0x24,   /* AP           */
204 };
205
206 static u8 bq27545_regs[] = {
207         0x00,   /* CONTROL      */
208         0x06,   /* TEMP         */
209         0x28,   /* INT TEMP     */
210         0x08,   /* VOLT         */
211         0x14,   /* AVG CURR     */
212         0x0a,   /* FLAGS        */
213         0x16,   /* TTE          */
214         INVALID_REG_ADDR,       /* TTF - NA     */
215         INVALID_REG_ADDR,       /* TTES - NA    */
216         INVALID_REG_ADDR,       /* TTECP - NA   */
217         0x0c,   /* NAC          */
218         0x12,   /* LMD(FCC)     */
219         0x2a,   /* CYCT         */
220         INVALID_REG_ADDR,       /* AE - NA      */
221         0x2c,   /* SOC(RSOC)    */
222         INVALID_REG_ADDR,       /* DCAP - NA */
223         0x24,   /* AP           */
224 };
225
226 static u8 bq27421_regs[] = {
227         0x00,   /* CONTROL      */
228         0x02,   /* TEMP         */
229         0x1e,   /* INT TEMP     */
230         0x04,   /* VOLT         */
231         0x10,   /* AVG CURR     */
232         0x06,   /* FLAGS        */
233         INVALID_REG_ADDR,       /* TTE - NA     */
234         INVALID_REG_ADDR,       /* TTF - NA     */
235         INVALID_REG_ADDR,       /* TTES - NA    */
236         INVALID_REG_ADDR,       /* TTECP - NA   */
237         0x08,   /* NAC          */
238         0x0e,   /* FCC          */
239         INVALID_REG_ADDR,       /* CYCT - NA    */
240         INVALID_REG_ADDR,       /* AE - NA      */
241         0x1c,   /* SOC          */
242         0x3c,   /* DCAP         */
243         0x18,   /* AP           */
244 };
245
246 static u8 *bq27xxx_regs[] = {
247         [BQ27000] = bq27000_regs,
248         [BQ27010] = bq27010_regs,
249         [BQ27500] = bq27500_regs,
250         [BQ27530] = bq27530_regs,
251         [BQ27541] = bq27541_regs,
252         [BQ27545] = bq27545_regs,
253         [BQ27421] = bq27421_regs,
254 };
255
256 static enum power_supply_property bq27000_battery_props[] = {
257         POWER_SUPPLY_PROP_STATUS,
258         POWER_SUPPLY_PROP_PRESENT,
259         POWER_SUPPLY_PROP_VOLTAGE_NOW,
260         POWER_SUPPLY_PROP_CURRENT_NOW,
261         POWER_SUPPLY_PROP_CAPACITY,
262         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
263         POWER_SUPPLY_PROP_TEMP,
264         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
265         POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
266         POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
267         POWER_SUPPLY_PROP_TECHNOLOGY,
268         POWER_SUPPLY_PROP_CHARGE_FULL,
269         POWER_SUPPLY_PROP_CHARGE_NOW,
270         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
271         POWER_SUPPLY_PROP_CYCLE_COUNT,
272         POWER_SUPPLY_PROP_ENERGY_NOW,
273         POWER_SUPPLY_PROP_POWER_AVG,
274         POWER_SUPPLY_PROP_HEALTH,
275         POWER_SUPPLY_PROP_MANUFACTURER,
276 };
277
278 static enum power_supply_property bq27010_battery_props[] = {
279         POWER_SUPPLY_PROP_STATUS,
280         POWER_SUPPLY_PROP_PRESENT,
281         POWER_SUPPLY_PROP_VOLTAGE_NOW,
282         POWER_SUPPLY_PROP_CURRENT_NOW,
283         POWER_SUPPLY_PROP_CAPACITY,
284         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
285         POWER_SUPPLY_PROP_TEMP,
286         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
287         POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
288         POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
289         POWER_SUPPLY_PROP_TECHNOLOGY,
290         POWER_SUPPLY_PROP_CHARGE_FULL,
291         POWER_SUPPLY_PROP_CHARGE_NOW,
292         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
293         POWER_SUPPLY_PROP_CYCLE_COUNT,
294         POWER_SUPPLY_PROP_HEALTH,
295         POWER_SUPPLY_PROP_MANUFACTURER,
296 };
297
298 static enum power_supply_property bq27500_battery_props[] = {
299         POWER_SUPPLY_PROP_STATUS,
300         POWER_SUPPLY_PROP_PRESENT,
301         POWER_SUPPLY_PROP_VOLTAGE_NOW,
302         POWER_SUPPLY_PROP_CURRENT_NOW,
303         POWER_SUPPLY_PROP_CAPACITY,
304         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
305         POWER_SUPPLY_PROP_TEMP,
306         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
307         POWER_SUPPLY_PROP_TECHNOLOGY,
308         POWER_SUPPLY_PROP_CHARGE_FULL,
309         POWER_SUPPLY_PROP_CHARGE_NOW,
310         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
311         POWER_SUPPLY_PROP_CYCLE_COUNT,
312         POWER_SUPPLY_PROP_HEALTH,
313         POWER_SUPPLY_PROP_MANUFACTURER,
314 };
315
316 static enum power_supply_property bq27530_battery_props[] = {
317         POWER_SUPPLY_PROP_STATUS,
318         POWER_SUPPLY_PROP_PRESENT,
319         POWER_SUPPLY_PROP_VOLTAGE_NOW,
320         POWER_SUPPLY_PROP_CURRENT_NOW,
321         POWER_SUPPLY_PROP_CAPACITY,
322         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
323         POWER_SUPPLY_PROP_TEMP,
324         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
325         POWER_SUPPLY_PROP_TECHNOLOGY,
326         POWER_SUPPLY_PROP_CHARGE_FULL,
327         POWER_SUPPLY_PROP_CHARGE_NOW,
328         POWER_SUPPLY_PROP_POWER_AVG,
329         POWER_SUPPLY_PROP_HEALTH,
330         POWER_SUPPLY_PROP_CYCLE_COUNT,
331         POWER_SUPPLY_PROP_MANUFACTURER,
332 };
333
334 static enum power_supply_property bq27541_battery_props[] = {
335         POWER_SUPPLY_PROP_STATUS,
336         POWER_SUPPLY_PROP_PRESENT,
337         POWER_SUPPLY_PROP_VOLTAGE_NOW,
338         POWER_SUPPLY_PROP_CURRENT_NOW,
339         POWER_SUPPLY_PROP_CAPACITY,
340         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
341         POWER_SUPPLY_PROP_TEMP,
342         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
343         POWER_SUPPLY_PROP_TECHNOLOGY,
344         POWER_SUPPLY_PROP_CHARGE_FULL,
345         POWER_SUPPLY_PROP_CHARGE_NOW,
346         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
347         POWER_SUPPLY_PROP_CYCLE_COUNT,
348         POWER_SUPPLY_PROP_POWER_AVG,
349         POWER_SUPPLY_PROP_HEALTH,
350         POWER_SUPPLY_PROP_MANUFACTURER,
351 };
352
353 static enum power_supply_property bq27545_battery_props[] = {
354         POWER_SUPPLY_PROP_STATUS,
355         POWER_SUPPLY_PROP_PRESENT,
356         POWER_SUPPLY_PROP_VOLTAGE_NOW,
357         POWER_SUPPLY_PROP_CURRENT_NOW,
358         POWER_SUPPLY_PROP_CAPACITY,
359         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
360         POWER_SUPPLY_PROP_TEMP,
361         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
362         POWER_SUPPLY_PROP_TECHNOLOGY,
363         POWER_SUPPLY_PROP_CHARGE_FULL,
364         POWER_SUPPLY_PROP_CHARGE_NOW,
365         POWER_SUPPLY_PROP_HEALTH,
366         POWER_SUPPLY_PROP_CYCLE_COUNT,
367         POWER_SUPPLY_PROP_POWER_AVG,
368         POWER_SUPPLY_PROP_MANUFACTURER,
369 };
370
371 static enum power_supply_property bq27421_battery_props[] = {
372         POWER_SUPPLY_PROP_STATUS,
373         POWER_SUPPLY_PROP_PRESENT,
374         POWER_SUPPLY_PROP_VOLTAGE_NOW,
375         POWER_SUPPLY_PROP_CURRENT_NOW,
376         POWER_SUPPLY_PROP_CAPACITY,
377         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
378         POWER_SUPPLY_PROP_TEMP,
379         POWER_SUPPLY_PROP_TECHNOLOGY,
380         POWER_SUPPLY_PROP_CHARGE_FULL,
381         POWER_SUPPLY_PROP_CHARGE_NOW,
382         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
383         POWER_SUPPLY_PROP_MANUFACTURER,
384 };
385
386 #define BQ27XXX_PROP(_id, _prop)                \
387         [_id] = {                               \
388                 .props = _prop,                 \
389                 .size = ARRAY_SIZE(_prop),      \
390         }
391
392 static struct {
393         enum power_supply_property *props;
394         size_t size;
395 } bq27xxx_battery_props[] = {
396         BQ27XXX_PROP(BQ27000, bq27000_battery_props),
397         BQ27XXX_PROP(BQ27010, bq27010_battery_props),
398         BQ27XXX_PROP(BQ27500, bq27500_battery_props),
399         BQ27XXX_PROP(BQ27530, bq27530_battery_props),
400         BQ27XXX_PROP(BQ27541, bq27541_battery_props),
401         BQ27XXX_PROP(BQ27545, bq27545_battery_props),
402         BQ27XXX_PROP(BQ27421, bq27421_battery_props),
403 };
404
405 static unsigned int poll_interval = 360;
406 module_param(poll_interval, uint, 0644);
407 MODULE_PARM_DESC(poll_interval,
408                  "battery poll interval in seconds - 0 disables polling");
409
410 /*
411  * Common code for BQ27xxx devices
412  */
413
414 static inline int bq27xxx_read(struct bq27xxx_device_info *di, int reg_index,
415                                bool single)
416 {
417         /* Reports EINVAL for invalid/missing registers */
418         if (!di || di->regs[reg_index] == INVALID_REG_ADDR)
419                 return -EINVAL;
420
421         return di->bus.read(di, di->regs[reg_index], single);
422 }
423
424 /*
425  * Return the battery State-of-Charge
426  * Or < 0 if something fails.
427  */
428 static int bq27xxx_battery_read_soc(struct bq27xxx_device_info *di)
429 {
430         int soc;
431
432         if (di->chip == BQ27000 || di->chip == BQ27010)
433                 soc = bq27xxx_read(di, BQ27XXX_REG_SOC, true);
434         else
435                 soc = bq27xxx_read(di, BQ27XXX_REG_SOC, false);
436
437         if (soc < 0)
438                 dev_dbg(di->dev, "error reading State-of-Charge\n");
439
440         return soc;
441 }
442
443 /*
444  * Return a battery charge value in µAh
445  * Or < 0 if something fails.
446  */
447 static int bq27xxx_battery_read_charge(struct bq27xxx_device_info *di, u8 reg)
448 {
449         int charge;
450
451         charge = bq27xxx_read(di, reg, false);
452         if (charge < 0) {
453                 dev_dbg(di->dev, "error reading charge register %02x: %d\n",
454                         reg, charge);
455                 return charge;
456         }
457
458         if (di->chip == BQ27000 || di->chip == BQ27010)
459                 charge *= BQ27XXX_CURRENT_CONSTANT / BQ27XXX_RS;
460         else
461                 charge *= 1000;
462
463         return charge;
464 }
465
466 /*
467  * Return the battery Nominal available capacity in µAh
468  * Or < 0 if something fails.
469  */
470 static inline int bq27xxx_battery_read_nac(struct bq27xxx_device_info *di)
471 {
472         int flags;
473
474         if (di->chip == BQ27000 || di->chip == BQ27010) {
475                 flags = bq27xxx_read(di, BQ27XXX_REG_FLAGS, true);
476                 if (flags >= 0 && (flags & BQ27000_FLAG_CI))
477                         return -ENODATA;
478         }
479
480         return bq27xxx_battery_read_charge(di, BQ27XXX_REG_NAC);
481 }
482
483 /*
484  * Return the battery Full Charge Capacity in µAh
485  * Or < 0 if something fails.
486  */
487 static inline int bq27xxx_battery_read_fcc(struct bq27xxx_device_info *di)
488 {
489         return bq27xxx_battery_read_charge(di, BQ27XXX_REG_FCC);
490 }
491
492 /*
493  * Return the Design Capacity in µAh
494  * Or < 0 if something fails.
495  */
496 static int bq27xxx_battery_read_dcap(struct bq27xxx_device_info *di)
497 {
498         int dcap;
499
500         if (di->chip == BQ27000 || di->chip == BQ27010)
501                 dcap = bq27xxx_read(di, BQ27XXX_REG_DCAP, true);
502         else
503                 dcap = bq27xxx_read(di, BQ27XXX_REG_DCAP, false);
504
505         if (dcap < 0) {
506                 dev_dbg(di->dev, "error reading initial last measured discharge\n");
507                 return dcap;
508         }
509
510         if (di->chip == BQ27000 || di->chip == BQ27010)
511                 dcap = (dcap << 8) * BQ27XXX_CURRENT_CONSTANT / BQ27XXX_RS;
512         else
513                 dcap *= 1000;
514
515         return dcap;
516 }
517
518 /*
519  * Return the battery Available energy in µWh
520  * Or < 0 if something fails.
521  */
522 static int bq27xxx_battery_read_energy(struct bq27xxx_device_info *di)
523 {
524         int ae;
525
526         ae = bq27xxx_read(di, BQ27XXX_REG_AE, false);
527         if (ae < 0) {
528                 dev_dbg(di->dev, "error reading available energy\n");
529                 return ae;
530         }
531
532         if (di->chip == BQ27000 || di->chip == BQ27010)
533                 ae *= BQ27XXX_POWER_CONSTANT / BQ27XXX_RS;
534         else
535                 ae *= 1000;
536
537         return ae;
538 }
539
540 /*
541  * Return the battery temperature in tenths of degree Kelvin
542  * Or < 0 if something fails.
543  */
544 static int bq27xxx_battery_read_temperature(struct bq27xxx_device_info *di)
545 {
546         int temp;
547
548         temp = bq27xxx_read(di, BQ27XXX_REG_TEMP, false);
549         if (temp < 0) {
550                 dev_err(di->dev, "error reading temperature\n");
551                 return temp;
552         }
553
554         if (di->chip == BQ27000 || di->chip == BQ27010)
555                 temp = 5 * temp / 2;
556
557         return temp;
558 }
559
560 /*
561  * Return the battery Cycle count total
562  * Or < 0 if something fails.
563  */
564 static int bq27xxx_battery_read_cyct(struct bq27xxx_device_info *di)
565 {
566         int cyct;
567
568         cyct = bq27xxx_read(di, BQ27XXX_REG_CYCT, false);
569         if (cyct < 0)
570                 dev_err(di->dev, "error reading cycle count total\n");
571
572         return cyct;
573 }
574
575 /*
576  * Read a time register.
577  * Return < 0 if something fails.
578  */
579 static int bq27xxx_battery_read_time(struct bq27xxx_device_info *di, u8 reg)
580 {
581         int tval;
582
583         tval = bq27xxx_read(di, reg, false);
584         if (tval < 0) {
585                 dev_dbg(di->dev, "error reading time register %02x: %d\n",
586                         reg, tval);
587                 return tval;
588         }
589
590         if (tval == 65535)
591                 return -ENODATA;
592
593         return tval * 60;
594 }
595
596 /*
597  * Read an average power register.
598  * Return < 0 if something fails.
599  */
600 static int bq27xxx_battery_read_pwr_avg(struct bq27xxx_device_info *di)
601 {
602         int tval;
603
604         tval = bq27xxx_read(di, BQ27XXX_REG_AP, false);
605         if (tval < 0) {
606                 dev_err(di->dev, "error reading average power register  %02x: %d\n",
607                         BQ27XXX_REG_AP, tval);
608                 return tval;
609         }
610
611         if (di->chip == BQ27000 || di->chip == BQ27010)
612                 return (tval * BQ27XXX_POWER_CONSTANT) / BQ27XXX_RS;
613         else
614                 return tval;
615 }
616
617 /*
618  * Returns true if a battery over temperature condition is detected
619  */
620 static bool bq27xxx_battery_overtemp(struct bq27xxx_device_info *di, u16 flags)
621 {
622         if (di->chip == BQ27500 || di->chip == BQ27541 || di->chip == BQ27545)
623                 return flags & (BQ27XXX_FLAG_OTC | BQ27XXX_FLAG_OTD);
624         if (di->chip == BQ27530 || di->chip == BQ27421)
625                 return flags & BQ27XXX_FLAG_OT;
626
627         return false;
628 }
629
630 /*
631  * Returns true if a battery under temperature condition is detected
632  */
633 static bool bq27xxx_battery_undertemp(struct bq27xxx_device_info *di, u16 flags)
634 {
635         if (di->chip == BQ27530 || di->chip == BQ27421)
636                 return flags & BQ27XXX_FLAG_UT;
637
638         return false;
639 }
640
641 /*
642  * Returns true if a low state of charge condition is detected
643  */
644 static bool bq27xxx_battery_dead(struct bq27xxx_device_info *di, u16 flags)
645 {
646         if (di->chip == BQ27000 || di->chip == BQ27010)
647                 return flags & (BQ27000_FLAG_EDV1 | BQ27000_FLAG_EDVF);
648         else
649                 return flags & (BQ27XXX_FLAG_SOC1 | BQ27XXX_FLAG_SOCF);
650 }
651
652 /*
653  * Read flag register.
654  * Return < 0 if something fails.
655  */
656 static int bq27xxx_battery_read_health(struct bq27xxx_device_info *di)
657 {
658         int flags;
659
660         flags = bq27xxx_read(di, BQ27XXX_REG_FLAGS, false);
661         if (flags < 0) {
662                 dev_err(di->dev, "error reading flag register:%d\n", flags);
663                 return flags;
664         }
665
666         /* Unlikely but important to return first */
667         if (unlikely(bq27xxx_battery_overtemp(di, flags)))
668                 return POWER_SUPPLY_HEALTH_OVERHEAT;
669         if (unlikely(bq27xxx_battery_undertemp(di, flags)))
670                 return POWER_SUPPLY_HEALTH_COLD;
671         if (unlikely(bq27xxx_battery_dead(di, flags)))
672                 return POWER_SUPPLY_HEALTH_DEAD;
673
674         return POWER_SUPPLY_HEALTH_GOOD;
675 }
676
677 void bq27xxx_battery_update(struct bq27xxx_device_info *di)
678 {
679         struct bq27xxx_reg_cache cache = {0, };
680         bool has_ci_flag = di->chip == BQ27000 || di->chip == BQ27010;
681         bool has_singe_flag = di->chip == BQ27000 || di->chip == BQ27010;
682
683         cache.flags = bq27xxx_read(di, BQ27XXX_REG_FLAGS, has_singe_flag);
684         if ((cache.flags & 0xff) == 0xff)
685                 cache.flags = -1; /* read error */
686         if (cache.flags >= 0) {
687                 cache.temperature = bq27xxx_battery_read_temperature(di);
688                 if (has_ci_flag && (cache.flags & BQ27000_FLAG_CI)) {
689                         dev_info_once(di->dev, "battery is not calibrated! ignoring capacity values\n");
690                         cache.capacity = -ENODATA;
691                         cache.energy = -ENODATA;
692                         cache.time_to_empty = -ENODATA;
693                         cache.time_to_empty_avg = -ENODATA;
694                         cache.time_to_full = -ENODATA;
695                         cache.charge_full = -ENODATA;
696                         cache.health = -ENODATA;
697                 } else {
698                         if (di->regs[BQ27XXX_REG_TTE] != INVALID_REG_ADDR)
699                                 cache.time_to_empty = bq27xxx_battery_read_time(di, BQ27XXX_REG_TTE);
700                         if (di->regs[BQ27XXX_REG_TTECP] != INVALID_REG_ADDR)
701                                 cache.time_to_empty_avg = bq27xxx_battery_read_time(di, BQ27XXX_REG_TTECP);
702                         if (di->regs[BQ27XXX_REG_TTF] != INVALID_REG_ADDR)
703                                 cache.time_to_full = bq27xxx_battery_read_time(di, BQ27XXX_REG_TTF);
704                         cache.charge_full = bq27xxx_battery_read_fcc(di);
705                         cache.capacity = bq27xxx_battery_read_soc(di);
706                         if (di->regs[BQ27XXX_REG_AE] != INVALID_REG_ADDR)
707                                 cache.energy = bq27xxx_battery_read_energy(di);
708                         cache.health = bq27xxx_battery_read_health(di);
709                 }
710                 if (di->regs[BQ27XXX_REG_CYCT] != INVALID_REG_ADDR)
711                         cache.cycle_count = bq27xxx_battery_read_cyct(di);
712                 if (di->regs[BQ27XXX_REG_AP] != INVALID_REG_ADDR)
713                         cache.power_avg = bq27xxx_battery_read_pwr_avg(di);
714
715                 /* We only have to read charge design full once */
716                 if (di->charge_design_full <= 0)
717                         di->charge_design_full = bq27xxx_battery_read_dcap(di);
718         }
719
720         if (di->cache.capacity != cache.capacity)
721                 power_supply_changed(di->bat);
722
723         if (memcmp(&di->cache, &cache, sizeof(cache)) != 0)
724                 di->cache = cache;
725
726         di->last_update = jiffies;
727 }
728 EXPORT_SYMBOL_GPL(bq27xxx_battery_update);
729
730 static void bq27xxx_battery_poll(struct work_struct *work)
731 {
732         struct bq27xxx_device_info *di =
733                         container_of(work, struct bq27xxx_device_info,
734                                      work.work);
735
736         bq27xxx_battery_update(di);
737
738         if (poll_interval > 0)
739                 schedule_delayed_work(&di->work, poll_interval * HZ);
740 }
741
742 /*
743  * Return the battery average current in µA
744  * Note that current can be negative signed as well
745  * Or 0 if something fails.
746  */
747 static int bq27xxx_battery_current(struct bq27xxx_device_info *di,
748                                    union power_supply_propval *val)
749 {
750         int curr;
751         int flags;
752
753         curr = bq27xxx_read(di, BQ27XXX_REG_AI, false);
754         if (curr < 0) {
755                 dev_err(di->dev, "error reading current\n");
756                 return curr;
757         }
758
759         if (di->chip == BQ27000 || di->chip == BQ27010) {
760                 flags = bq27xxx_read(di, BQ27XXX_REG_FLAGS, false);
761                 if (flags & BQ27000_FLAG_CHGS) {
762                         dev_dbg(di->dev, "negative current!\n");
763                         curr = -curr;
764                 }
765
766                 val->intval = curr * BQ27XXX_CURRENT_CONSTANT / BQ27XXX_RS;
767         } else {
768                 /* Other gauges return signed value */
769                 val->intval = (int)((s16)curr) * 1000;
770         }
771
772         return 0;
773 }
774
775 static int bq27xxx_battery_status(struct bq27xxx_device_info *di,
776                                   union power_supply_propval *val)
777 {
778         int status;
779
780         if (di->chip == BQ27000 || di->chip == BQ27010) {
781                 if (di->cache.flags & BQ27000_FLAG_FC)
782                         status = POWER_SUPPLY_STATUS_FULL;
783                 else if (di->cache.flags & BQ27000_FLAG_CHGS)
784                         status = POWER_SUPPLY_STATUS_CHARGING;
785                 else if (power_supply_am_i_supplied(di->bat))
786                         status = POWER_SUPPLY_STATUS_NOT_CHARGING;
787                 else
788                         status = POWER_SUPPLY_STATUS_DISCHARGING;
789         } else {
790                 if (di->cache.flags & BQ27XXX_FLAG_FC)
791                         status = POWER_SUPPLY_STATUS_FULL;
792                 else if (di->cache.flags & BQ27XXX_FLAG_DSC)
793                         status = POWER_SUPPLY_STATUS_DISCHARGING;
794                 else
795                         status = POWER_SUPPLY_STATUS_CHARGING;
796         }
797
798         val->intval = status;
799
800         return 0;
801 }
802
803 static int bq27xxx_battery_capacity_level(struct bq27xxx_device_info *di,
804                                           union power_supply_propval *val)
805 {
806         int level;
807
808         if (di->chip == BQ27000 || di->chip == BQ27010) {
809                 if (di->cache.flags & BQ27000_FLAG_FC)
810                         level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
811                 else if (di->cache.flags & BQ27000_FLAG_EDV1)
812                         level = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
813                 else if (di->cache.flags & BQ27000_FLAG_EDVF)
814                         level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
815                 else
816                         level = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
817         } else {
818                 if (di->cache.flags & BQ27XXX_FLAG_FC)
819                         level = POWER_SUPPLY_CAPACITY_LEVEL_FULL;
820                 else if (di->cache.flags & BQ27XXX_FLAG_SOC1)
821                         level = POWER_SUPPLY_CAPACITY_LEVEL_LOW;
822                 else if (di->cache.flags & BQ27XXX_FLAG_SOCF)
823                         level = POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
824                 else
825                         level = POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
826         }
827
828         val->intval = level;
829
830         return 0;
831 }
832
833 /*
834  * Return the battery Voltage in millivolts
835  * Or < 0 if something fails.
836  */
837 static int bq27xxx_battery_voltage(struct bq27xxx_device_info *di,
838                                    union power_supply_propval *val)
839 {
840         int volt;
841
842         volt = bq27xxx_read(di, BQ27XXX_REG_VOLT, false);
843         if (volt < 0) {
844                 dev_err(di->dev, "error reading voltage\n");
845                 return volt;
846         }
847
848         val->intval = volt * 1000;
849
850         return 0;
851 }
852
853 static int bq27xxx_simple_value(int value,
854                                 union power_supply_propval *val)
855 {
856         if (value < 0)
857                 return value;
858
859         val->intval = value;
860
861         return 0;
862 }
863
864 static int bq27xxx_battery_get_property(struct power_supply *psy,
865                                         enum power_supply_property psp,
866                                         union power_supply_propval *val)
867 {
868         int ret = 0;
869         struct bq27xxx_device_info *di = power_supply_get_drvdata(psy);
870
871         mutex_lock(&di->lock);
872         if (time_is_before_jiffies(di->last_update + 5 * HZ)) {
873                 cancel_delayed_work_sync(&di->work);
874                 bq27xxx_battery_poll(&di->work.work);
875         }
876         mutex_unlock(&di->lock);
877
878         if (psp != POWER_SUPPLY_PROP_PRESENT && di->cache.flags < 0)
879                 return -ENODEV;
880
881         switch (psp) {
882         case POWER_SUPPLY_PROP_STATUS:
883                 ret = bq27xxx_battery_status(di, val);
884                 break;
885         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
886                 ret = bq27xxx_battery_voltage(di, val);
887                 break;
888         case POWER_SUPPLY_PROP_PRESENT:
889                 val->intval = di->cache.flags < 0 ? 0 : 1;
890                 break;
891         case POWER_SUPPLY_PROP_CURRENT_NOW:
892                 ret = bq27xxx_battery_current(di, val);
893                 break;
894         case POWER_SUPPLY_PROP_CAPACITY:
895                 ret = bq27xxx_simple_value(di->cache.capacity, val);
896                 break;
897         case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
898                 ret = bq27xxx_battery_capacity_level(di, val);
899                 break;
900         case POWER_SUPPLY_PROP_TEMP:
901                 ret = bq27xxx_simple_value(di->cache.temperature, val);
902                 if (ret == 0)
903                         val->intval -= 2731; /* convert decidegree k to c */
904                 break;
905         case POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW:
906                 ret = bq27xxx_simple_value(di->cache.time_to_empty, val);
907                 break;
908         case POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG:
909                 ret = bq27xxx_simple_value(di->cache.time_to_empty_avg, val);
910                 break;
911         case POWER_SUPPLY_PROP_TIME_TO_FULL_NOW:
912                 ret = bq27xxx_simple_value(di->cache.time_to_full, val);
913                 break;
914         case POWER_SUPPLY_PROP_TECHNOLOGY:
915                 val->intval = POWER_SUPPLY_TECHNOLOGY_LION;
916                 break;
917         case POWER_SUPPLY_PROP_CHARGE_NOW:
918                 ret = bq27xxx_simple_value(bq27xxx_battery_read_nac(di), val);
919                 break;
920         case POWER_SUPPLY_PROP_CHARGE_FULL:
921                 ret = bq27xxx_simple_value(di->cache.charge_full, val);
922                 break;
923         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
924                 ret = bq27xxx_simple_value(di->charge_design_full, val);
925                 break;
926         case POWER_SUPPLY_PROP_CYCLE_COUNT:
927                 ret = bq27xxx_simple_value(di->cache.cycle_count, val);
928                 break;
929         case POWER_SUPPLY_PROP_ENERGY_NOW:
930                 ret = bq27xxx_simple_value(di->cache.energy, val);
931                 break;
932         case POWER_SUPPLY_PROP_POWER_AVG:
933                 ret = bq27xxx_simple_value(di->cache.power_avg, val);
934                 break;
935         case POWER_SUPPLY_PROP_HEALTH:
936                 ret = bq27xxx_simple_value(di->cache.health, val);
937                 break;
938         case POWER_SUPPLY_PROP_MANUFACTURER:
939                 val->strval = BQ27XXX_MANUFACTURER;
940                 break;
941         default:
942                 return -EINVAL;
943         }
944
945         return ret;
946 }
947
948 static void bq27xxx_external_power_changed(struct power_supply *psy)
949 {
950         struct bq27xxx_device_info *di = power_supply_get_drvdata(psy);
951
952         cancel_delayed_work_sync(&di->work);
953         schedule_delayed_work(&di->work, 0);
954 }
955
956 int bq27xxx_battery_setup(struct bq27xxx_device_info *di)
957 {
958         struct power_supply_desc *psy_desc;
959         struct power_supply_config psy_cfg = { .drv_data = di, };
960
961         INIT_DELAYED_WORK(&di->work, bq27xxx_battery_poll);
962         mutex_init(&di->lock);
963         di->regs = bq27xxx_regs[di->chip];
964
965         psy_desc = devm_kzalloc(di->dev, sizeof(*psy_desc), GFP_KERNEL);
966         if (!psy_desc)
967                 return -ENOMEM;
968
969         psy_desc->name = di->name;
970         psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
971         psy_desc->properties = bq27xxx_battery_props[di->chip].props;
972         psy_desc->num_properties = bq27xxx_battery_props[di->chip].size;
973         psy_desc->get_property = bq27xxx_battery_get_property;
974         psy_desc->external_power_changed = bq27xxx_external_power_changed;
975
976         di->bat = power_supply_register_no_ws(di->dev, psy_desc, &psy_cfg);
977         if (IS_ERR(di->bat)) {
978                 dev_err(di->dev, "failed to register battery\n");
979                 return PTR_ERR(di->bat);
980         }
981
982         dev_info(di->dev, "support ver. %s enabled\n", DRIVER_VERSION);
983
984         bq27xxx_battery_update(di);
985
986         return 0;
987 }
988 EXPORT_SYMBOL_GPL(bq27xxx_battery_setup);
989
990 void bq27xxx_battery_teardown(struct bq27xxx_device_info *di)
991 {
992         /*
993          * power_supply_unregister call bq27xxx_battery_get_property which
994          * call bq27xxx_battery_poll.
995          * Make sure that bq27xxx_battery_poll will not call
996          * schedule_delayed_work again after unregister (which cause OOPS).
997          */
998         poll_interval = 0;
999
1000         cancel_delayed_work_sync(&di->work);
1001
1002         power_supply_unregister(di->bat);
1003
1004         mutex_destroy(&di->lock);
1005 }
1006 EXPORT_SYMBOL_GPL(bq27xxx_battery_teardown);
1007
1008 static int bq27xxx_battery_platform_read(struct bq27xxx_device_info *di, u8 reg,
1009                                          bool single)
1010 {
1011         struct device *dev = di->dev;
1012         struct bq27xxx_platform_data *pdata = dev->platform_data;
1013         unsigned int timeout = 3;
1014         int upper, lower;
1015         int temp;
1016
1017         if (!single) {
1018                 /* Make sure the value has not changed in between reading the
1019                  * lower and the upper part */
1020                 upper = pdata->read(dev, reg + 1);
1021                 do {
1022                         temp = upper;
1023                         if (upper < 0)
1024                                 return upper;
1025
1026                         lower = pdata->read(dev, reg);
1027                         if (lower < 0)
1028                                 return lower;
1029
1030                         upper = pdata->read(dev, reg + 1);
1031                 } while (temp != upper && --timeout);
1032
1033                 if (timeout == 0)
1034                         return -EIO;
1035
1036                 return (upper << 8) | lower;
1037         }
1038
1039         return pdata->read(dev, reg);
1040 }
1041
1042 static int bq27xxx_battery_platform_probe(struct platform_device *pdev)
1043 {
1044         struct bq27xxx_device_info *di;
1045         struct bq27xxx_platform_data *pdata = pdev->dev.platform_data;
1046
1047         if (!pdata) {
1048                 dev_err(&pdev->dev, "no platform_data supplied\n");
1049                 return -EINVAL;
1050         }
1051
1052         if (!pdata->read) {
1053                 dev_err(&pdev->dev, "no hdq read callback supplied\n");
1054                 return -EINVAL;
1055         }
1056
1057         if (!pdata->chip) {
1058                 dev_err(&pdev->dev, "no device supplied\n");
1059                 return -EINVAL;
1060         }
1061
1062         di = devm_kzalloc(&pdev->dev, sizeof(*di), GFP_KERNEL);
1063         if (!di)
1064                 return -ENOMEM;
1065
1066         platform_set_drvdata(pdev, di);
1067
1068         di->dev = &pdev->dev;
1069         di->chip = pdata->chip;
1070         di->name = pdata->name ?: dev_name(&pdev->dev);
1071         di->bus.read = bq27xxx_battery_platform_read;
1072
1073         return bq27xxx_battery_setup(di);
1074 }
1075
1076 static int bq27xxx_battery_platform_remove(struct platform_device *pdev)
1077 {
1078         struct bq27xxx_device_info *di = platform_get_drvdata(pdev);
1079
1080         bq27xxx_battery_teardown(di);
1081
1082         return 0;
1083 }
1084
1085 static const struct platform_device_id bq27xxx_battery_platform_id_table[] = {
1086         { "bq27000-battery", },
1087         { /* sentinel */ }
1088 };
1089 MODULE_DEVICE_TABLE(platform, bq27xxx_battery_platform_id_table);
1090
1091 #ifdef CONFIG_OF
1092 static const struct of_device_id bq27xxx_battery_platform_of_match_table[] = {
1093         { .compatible = "ti,bq27000" },
1094         {},
1095 };
1096 MODULE_DEVICE_TABLE(of, bq27xxx_battery_platform_of_match_table);
1097 #endif
1098
1099 static struct platform_driver bq27xxx_battery_platform_driver = {
1100         .probe  = bq27xxx_battery_platform_probe,
1101         .remove = bq27xxx_battery_platform_remove,
1102         .driver = {
1103                 .name = "bq27000-battery",
1104                 .of_match_table = of_match_ptr(bq27xxx_battery_platform_of_match_table),
1105         },
1106         .id_table = bq27xxx_battery_platform_id_table,
1107 };
1108 module_platform_driver(bq27xxx_battery_platform_driver);
1109
1110 MODULE_ALIAS("platform:bq27000-battery");
1111
1112 MODULE_AUTHOR("Rodolfo Giometti <giometti@linux.it>");
1113 MODULE_DESCRIPTION("BQ27xxx battery monitor driver");
1114 MODULE_LICENSE("GPL");