bfbc499ea7958b795e471ea700af7517d7837fc7
[linux-2.6.git] / include / linux / power / max17042_battery.h
1 /*
2  * Fuel gauge driver for Maxim 17042 / 8966 / 8997
3  *  Note that Maxim 8966 and 8997 are mfd and this is its subdevice.
4  *
5  * Copyright (C) 2011 Samsung Electronics
6  * MyungJoo Ham <myungjoo.ham@samsung.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23 #ifndef __MAX17042_BATTERY_H_
24 #define __MAX17042_BATTERY_H_
25
26 #include <linux/edp.h>
27
28 #define MAX17042_STATUS_BattAbsent      (1 << 3)
29 #define MAX17042_BATTERY_FULL   (100)
30 #define MAX17042_DEFAULT_SNS_RESISTOR   (10000)
31
32 #define MAX17042_CHARACTERIZATION_DATA_SIZE 48
33
34 #define MAX_TEMP 700
35 #define MIN_TEMP -200
36
37 enum max17042_register {
38         MAX17042_STATUS         = 0x00,
39         MAX17042_VALRT_Th       = 0x01,
40         MAX17042_TALRT_Th       = 0x02,
41         MAX17042_SALRT_Th       = 0x03,
42         MAX17042_AtRate         = 0x04,
43         MAX17042_RepCap         = 0x05,
44         MAX17042_RepSOC         = 0x06,
45         MAX17042_Age            = 0x07,
46         MAX17042_TEMP           = 0x08,
47         MAX17042_VCELL          = 0x09,
48         MAX17042_Current        = 0x0A,
49         MAX17042_AvgCurrent     = 0x0B,
50
51         MAX17042_SOC            = 0x0D,
52         MAX17042_AvSOC          = 0x0E,
53         MAX17042_RemCap         = 0x0F,
54         MAX17042_FullCAP        = 0x10,
55         MAX17042_TTE            = 0x11,
56         MAX17042_V_empty        = 0x12,
57
58         MAX17042_RSLOW          = 0x14,
59
60         MAX17042_AvgTA          = 0x16,
61         MAX17042_Cycles         = 0x17,
62         MAX17042_DesignCap      = 0x18,
63         MAX17042_AvgVCELL       = 0x19,
64         MAX17042_MinMaxTemp     = 0x1A,
65         MAX17042_MinMaxVolt     = 0x1B,
66         MAX17042_MinMaxCurr     = 0x1C,
67         MAX17042_CONFIG         = 0x1D,
68         MAX17042_ICHGTerm       = 0x1E,
69         MAX17042_AvCap          = 0x1F,
70         MAX17042_ManName        = 0x20,
71         MAX17042_DevName        = 0x21,
72
73         MAX17042_FullCAPNom     = 0x23,
74         MAX17042_TempNom        = 0x24,
75         MAX17042_TempLim        = 0x25,
76         MAX17042_TempHot        = 0x26,
77         MAX17042_AIN            = 0x27,
78         MAX17042_LearnCFG       = 0x28,
79         MAX17042_FilterCFG      = 0x29,
80         MAX17042_RelaxCFG       = 0x2A,
81         MAX17042_MiscCFG        = 0x2B,
82         MAX17042_TGAIN          = 0x2C,
83         MAx17042_TOFF           = 0x2D,
84         MAX17042_CGAIN          = 0x2E,
85         MAX17042_COFF           = 0x2F,
86
87         MAX17042_MaskSOC        = 0x32,
88         MAX17042_SOC_empty      = 0x33,
89         MAX17042_T_empty        = 0x34,
90
91         MAX17042_FullCAP0       = 0x35,
92         MAX17042_LAvg_empty     = 0x36,
93         MAX17042_FCTC           = 0x37,
94         MAX17042_RCOMP0         = 0x38,
95         MAX17042_TempCo         = 0x39,
96         MAX17042_EmptyTempCo    = 0x3A,
97         MAX17042_K_empty0       = 0x3B,
98         MAX17042_TaskPeriod     = 0x3C,
99         MAX17042_FSTAT          = 0x3D,
100
101         MAX17042_SHDNTIMER      = 0x3F,
102
103         MAX17042_dQacc          = 0x45,
104         MAX17042_dPacc          = 0x46,
105
106         MAX17042_VFSOC0         = 0x48,
107
108         MAX17042_QH             = 0x4D,
109         MAX17042_QL             = 0x4E,
110
111         MAX17042_VFSOC0Enable   = 0x60,
112         MAX17042_MLOCKReg1      = 0x62,
113         MAX17042_MLOCKReg2      = 0x63,
114
115         MAX17042_MODELChrTbl    = 0x80,
116
117         MAX17042_OCV            = 0xEE,
118
119         MAX17042_OCVInternal    = 0xFB,
120
121         MAX17042_VFSOC          = 0xFF,
122 };
123
124 /* Registers specific to max17047/50 */
125 enum max17047_register {
126         MAX17047_QRTbl00        = 0x12,
127         MAX17047_FullSOCThr     = 0x13,
128         MAX17047_QRTbl10        = 0x22,
129         MAX17047_QRTbl20        = 0x32,
130         MAX17047_V_empty        = 0x3A,
131         MAX17047_QRTbl30        = 0x42,
132 };
133
134 enum max170xx_chip_type {MAX17042, MAX17047};
135
136 /*
137  * used for setting a register to a desired value
138  * addr : address for a register
139  * data : setting value for the register
140  */
141 struct max17042_reg_data {
142         u8 addr;
143         u16 data;
144 };
145
146 struct max17042_config_data {
147         /* External current sense resistor value in milli-ohms */
148         u32     cur_sense_val;
149
150         /* A/D measurement */
151         u16     tgain;          /* 0x2C */
152         u16     toff;           /* 0x2D */
153         u16     cgain;          /* 0x2E */
154         u16     coff;           /* 0x2F */
155
156         /* Alert / Status */
157         u16     valrt_thresh;   /* 0x01 */
158         u16     talrt_thresh;   /* 0x02 */
159         u16     soc_alrt_thresh;        /* 0x03 */
160         u16     config;         /* 0x01D */
161         u16     shdntimer;      /* 0x03F */
162
163         /* App data */
164         u16     full_soc_thresh;        /* 0x13 */
165         u16     design_cap;     /* 0x18 */
166         u16     ichgt_term;     /* 0x1E */
167
168         /* MG3 config */
169         u16     at_rate;        /* 0x04 */
170         u16     learn_cfg;      /* 0x28 */
171         u16     filter_cfg;     /* 0x29 */
172         u16     relax_cfg;      /* 0x2A */
173         u16     misc_cfg;       /* 0x2B */
174         u16     masksoc;        /* 0x32 */
175
176         /* MG3 save and restore */
177         u16     fullcap;        /* 0x10 */
178         u16     fullcapnom;     /* 0x23 */
179         u16     socempty;       /* 0x33 */
180         u16     lavg_empty;     /* 0x36 */
181         u16     dqacc;          /* 0x45 */
182         u16     dpacc;          /* 0x46 */
183         u16     qrtbl00;        /* 0x12 */
184         u16     qrtbl10;        /* 0x22 */
185         u16     qrtbl20;        /* 0x32 */
186         u16     qrtbl30;        /* 0x42 */
187
188         /* Cell technology from power_supply.h */
189         u16     cell_technology;
190
191         /* Cell Data */
192         u16     vempty;         /* 0x12 */
193         u16     temp_nom;       /* 0x24 */
194         u16     temp_lim;       /* 0x25 */
195         u16     fctc;           /* 0x37 */
196         u16     rcomp0;         /* 0x38 */
197         u16     tcompc0;        /* 0x39 */
198         u16     empty_tempco;   /* 0x3A */
199         u16     kempty0;        /* 0x3B */
200         u16     cell_char_tbl[MAX17042_CHARACTERIZATION_DATA_SIZE];
201 } __packed;
202
203 struct max17042_platform_data {
204         struct max17042_reg_data *init_data;
205         struct max17042_config_data *config_data;
206         int num_init_data; /* Number of enties in init_data array */
207         bool enable_current_sense;
208         bool enable_por_init; /* Use POR init from Maxim appnote */
209
210         /*
211          * R_sns in micro-ohms.
212          * default 10000 (if r_sns = 0) as it is the recommended value by
213          * the datasheet although it can be changed by board designers.
214          */
215         unsigned int r_sns;
216
217         struct edp_client *edp_client;
218 };
219
220 #ifdef CONFIG_BATTERY_MAX17042
221 extern int maxim_get_temp(void);
222 extern void max17042_update_status(int status);
223 #else
224 static inline int maxim_get_temp(void) { return -ENODEV; }
225 static inline void max17042_update_status(int status) {}
226 #endif
227 #endif /* __MAX17042_BATTERY_H_ */