blob: e01b167e66f068223f86321109b77687ce5ef50c [file] [log] [blame]
MyungJoo Ham359ab9f2011-01-14 14:46:11 +09001/*
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
Donggeun Kim086ef502011-06-30 18:07:41 +090026#define MAX17042_STATUS_BattAbsent (1 << 3)
27#define MAX17042_BATTERY_FULL (100)
28#define MAX17042_DEFAULT_SNS_RESISTOR (10000)
29
Ramakrishna Pallalaf3a71a62012-03-13 22:03:52 +040030#define MAX17042_CHARACTERIZATION_DATA_SIZE 48
31
Donggeun Kim086ef502011-06-30 18:07:41 +090032enum max17042_register {
33 MAX17042_STATUS = 0x00,
34 MAX17042_VALRT_Th = 0x01,
35 MAX17042_TALRT_Th = 0x02,
36 MAX17042_SALRT_Th = 0x03,
37 MAX17042_AtRate = 0x04,
38 MAX17042_RepCap = 0x05,
39 MAX17042_RepSOC = 0x06,
40 MAX17042_Age = 0x07,
41 MAX17042_TEMP = 0x08,
42 MAX17042_VCELL = 0x09,
43 MAX17042_Current = 0x0A,
44 MAX17042_AvgCurrent = 0x0B,
Dirk Brandewief42c2b42012-01-24 09:26:04 -080045
Donggeun Kim086ef502011-06-30 18:07:41 +090046 MAX17042_SOC = 0x0D,
47 MAX17042_AvSOC = 0x0E,
48 MAX17042_RemCap = 0x0F,
Dirk Brandewief42c2b42012-01-24 09:26:04 -080049 MAX17042_FullCAP = 0x10,
Donggeun Kim086ef502011-06-30 18:07:41 +090050 MAX17042_TTE = 0x11,
51 MAX17042_V_empty = 0x12,
52
53 MAX17042_RSLOW = 0x14,
54
55 MAX17042_AvgTA = 0x16,
56 MAX17042_Cycles = 0x17,
57 MAX17042_DesignCap = 0x18,
58 MAX17042_AvgVCELL = 0x19,
59 MAX17042_MinMaxTemp = 0x1A,
60 MAX17042_MinMaxVolt = 0x1B,
61 MAX17042_MinMaxCurr = 0x1C,
62 MAX17042_CONFIG = 0x1D,
63 MAX17042_ICHGTerm = 0x1E,
64 MAX17042_AvCap = 0x1F,
65 MAX17042_ManName = 0x20,
66 MAX17042_DevName = 0x21,
Donggeun Kim086ef502011-06-30 18:07:41 +090067
Dirk Brandewief42c2b42012-01-24 09:26:04 -080068 MAX17042_FullCAPNom = 0x23,
Donggeun Kim086ef502011-06-30 18:07:41 +090069 MAX17042_TempNom = 0x24,
Dirk Brandewief42c2b42012-01-24 09:26:04 -080070 MAX17042_TempLim = 0x25,
Donggeun Kim086ef502011-06-30 18:07:41 +090071 MAX17042_TempHot = 0x26,
72 MAX17042_AIN = 0x27,
73 MAX17042_LearnCFG = 0x28,
Dirk Brandewief42c2b42012-01-24 09:26:04 -080074 MAX17042_FilterCFG = 0x29,
Donggeun Kim086ef502011-06-30 18:07:41 +090075 MAX17042_RelaxCFG = 0x2A,
76 MAX17042_MiscCFG = 0x2B,
77 MAX17042_TGAIN = 0x2C,
78 MAx17042_TOFF = 0x2D,
79 MAX17042_CGAIN = 0x2E,
80 MAX17042_COFF = 0x2F,
81
Dirk Brandewief42c2b42012-01-24 09:26:04 -080082 MAX17042_MaskSOC = 0x32,
83 MAX17042_SOC_empty = 0x33,
Donggeun Kim086ef502011-06-30 18:07:41 +090084 MAX17042_T_empty = 0x34,
85
Dirk Brandewief42c2b42012-01-24 09:26:04 -080086 MAX17042_FullCAP0 = 0x35,
87 MAX17042_LAvg_empty = 0x36,
88 MAX17042_FCTC = 0x37,
Donggeun Kim086ef502011-06-30 18:07:41 +090089 MAX17042_RCOMP0 = 0x38,
90 MAX17042_TempCo = 0x39,
Dirk Brandewief42c2b42012-01-24 09:26:04 -080091 MAX17042_EmptyTempCo = 0x3A,
92 MAX17042_K_empty0 = 0x3B,
Donggeun Kim086ef502011-06-30 18:07:41 +090093 MAX17042_TaskPeriod = 0x3C,
94 MAX17042_FSTAT = 0x3D,
95
96 MAX17042_SHDNTIMER = 0x3F,
97
Dirk Brandewief42c2b42012-01-24 09:26:04 -080098 MAX17042_dQacc = 0x45,
99 MAX17042_dPacc = 0x46,
100
101 MAX17042_VFSOC0 = 0x48,
Donggeun Kim086ef502011-06-30 18:07:41 +0900102
103 MAX17042_QH = 0x4D,
104 MAX17042_QL = 0x4E,
Dirk Brandewief42c2b42012-01-24 09:26:04 -0800105
106 MAX17042_VFSOC0Enable = 0x60,
107 MAX17042_MLOCKReg1 = 0x62,
108 MAX17042_MLOCKReg2 = 0x63,
109
110 MAX17042_MODELChrTbl = 0x80,
111
112 MAX17042_OCV = 0xEE,
113
114 MAX17042_OCVInternal = 0xFB,
115
116 MAX17042_VFSOC = 0xFF,
Donggeun Kim086ef502011-06-30 18:07:41 +0900117};
118
119/*
120 * used for setting a register to a desired value
121 * addr : address for a register
122 * data : setting value for the register
123 */
124struct max17042_reg_data {
125 u8 addr;
126 u16 data;
127};
128
Ramakrishna Pallalaf3a71a62012-03-13 22:03:52 +0400129struct max17042_config_data {
130 /* External current sense resistor value in milli-ohms */
131 u32 cur_sense_val;
132
133 /* A/D measurement */
134 u16 tgain; /* 0x2C */
135 u16 toff; /* 0x2D */
136 u16 cgain; /* 0x2E */
137 u16 coff; /* 0x2F */
138
139 /* Alert / Status */
140 u16 valrt_thresh; /* 0x01 */
141 u16 talrt_thresh; /* 0x02 */
142 u16 soc_alrt_thresh; /* 0x03 */
143 u16 config; /* 0x01D */
144 u16 shdntimer; /* 0x03F */
145
146 /* App data */
147 u16 design_cap; /* 0x18 */
148 u16 ichgt_term; /* 0x1E */
149
150 /* MG3 config */
151 u16 at_rate; /* 0x04 */
152 u16 learn_cfg; /* 0x28 */
153 u16 filter_cfg; /* 0x29 */
154 u16 relax_cfg; /* 0x2A */
155 u16 misc_cfg; /* 0x2B */
156 u16 masksoc; /* 0x32 */
157
158 /* MG3 save and restore */
159 u16 fullcap; /* 0x10 */
160 u16 fullcapnom; /* 0x23 */
161 u16 socempty; /* 0x33 */
162 u16 lavg_empty; /* 0x36 */
163 u16 dqacc; /* 0x45 */
164 u16 dpacc; /* 0x46 */
165
166 /* Cell technology from power_supply.h */
167 u16 cell_technology;
168
169 /* Cell Data */
170 u16 vempty; /* 0x12 */
171 u16 temp_nom; /* 0x24 */
172 u16 temp_lim; /* 0x25 */
173 u16 fctc; /* 0x37 */
174 u16 rcomp0; /* 0x38 */
175 u16 tcompc0; /* 0x39 */
176 u16 empty_tempco; /* 0x3A */
177 u16 kempty0; /* 0x3B */
178 u16 cell_char_tbl[MAX17042_CHARACTERIZATION_DATA_SIZE];
179} __packed;
180
MyungJoo Ham359ab9f2011-01-14 14:46:11 +0900181struct max17042_platform_data {
Donggeun Kim086ef502011-06-30 18:07:41 +0900182 struct max17042_reg_data *init_data;
Ramakrishna Pallalaf3a71a62012-03-13 22:03:52 +0400183 struct max17042_config_data *config_data;
Donggeun Kim086ef502011-06-30 18:07:41 +0900184 int num_init_data; /* Number of enties in init_data array */
MyungJoo Ham359ab9f2011-01-14 14:46:11 +0900185 bool enable_current_sense;
Ramakrishna Pallalaf3a71a62012-03-13 22:03:52 +0400186 bool enable_por_init; /* Use POR init from Maxim appnote */
Donggeun Kim086ef502011-06-30 18:07:41 +0900187
188 /*
189 * R_sns in micro-ohms.
190 * default 10000 (if r_sns = 0) as it is the recommended value by
191 * the datasheet although it can be changed by board designers.
192 */
193 unsigned int r_sns;
MyungJoo Ham359ab9f2011-01-14 14:46:11 +0900194};
195
196#endif /* __MAX17042_BATTERY_H_ */