1/* SPDX-License-Identifier: GPL-2.0-only */
2
3#ifndef _AB8500_CHARGER_H_
4#define _AB8500_CHARGER_H_
5
6#include <linux/kernel.h>
7
8/*
9 * System control 2 register offsets.
10 * bank = 0x02
11 */
12#define AB8500_MAIN_WDOG_CTRL_REG 0x01
13#define AB8500_LOW_BAT_REG 0x03
14#define AB8500_BATT_OK_REG 0x04
15/*
16 * USB/ULPI register offsets
17 * Bank : 0x5
18 */
19#define AB8500_USB_LINE_STAT_REG 0x80
20#define AB8500_USB_LINE_CTRL2_REG 0x82
21#define AB8500_USB_LINK1_STAT_REG 0x94
22
23/*
24 * Charger / status register offfsets
25 * Bank : 0x0B
26 */
27#define AB8500_CH_STATUS1_REG 0x00
28#define AB8500_CH_STATUS2_REG 0x01
29#define AB8500_CH_USBCH_STAT1_REG 0x02
30#define AB8500_CH_USBCH_STAT2_REG 0x03
31#define AB8540_CH_USBCH_STAT3_REG 0x04
32#define AB8500_CH_STAT_REG 0x05
33
34/*
35 * Charger / control register offfsets
36 * Bank : 0x0B
37 */
38#define AB8500_CH_VOLT_LVL_REG 0x40
39#define AB8500_CH_VOLT_LVL_MAX_REG 0x41 /*Only in Cut2.0*/
40#define AB8500_CH_OPT_CRNTLVL_REG 0x42
41#define AB8500_CH_OPT_CRNTLVL_MAX_REG 0x43 /*Only in Cut2.0*/
42#define AB8500_CH_WD_TIMER_REG 0x50
43#define AB8500_CHARG_WD_CTRL 0x51
44#define AB8500_BTEMP_HIGH_TH 0x52
45#define AB8500_LED_INDICATOR_PWM_CTRL 0x53
46#define AB8500_LED_INDICATOR_PWM_DUTY 0x54
47#define AB8500_BATT_OVV 0x55
48#define AB8500_CHARGER_CTRL 0x56
49#define AB8500_BAT_CTRL_CURRENT_SOURCE 0x60 /*Only in Cut2.0*/
50
51/*
52 * Charger / main control register offsets
53 * Bank : 0x0B
54 */
55#define AB8500_MCH_CTRL1 0x80
56#define AB8500_MCH_CTRL2 0x81
57#define AB8500_MCH_IPT_CURLVL_REG 0x82
58#define AB8500_CH_WD_REG 0x83
59
60/*
61 * Charger / USB control register offsets
62 * Bank : 0x0B
63 */
64#define AB8500_USBCH_CTRL1_REG 0xC0
65#define AB8500_USBCH_CTRL2_REG 0xC1
66#define AB8500_USBCH_IPT_CRNTLVL_REG 0xC2
67#define AB8540_USB_PP_MODE_REG 0xC5
68#define AB8540_USB_PP_CHR_REG 0xC6
69
70/*
71 * Gas Gauge register offsets
72 * Bank : 0x0C
73 */
74#define AB8500_GASG_CC_CTRL_REG 0x00
75#define AB8500_GASG_CC_ACCU1_REG 0x01
76#define AB8500_GASG_CC_ACCU2_REG 0x02
77#define AB8500_GASG_CC_ACCU3_REG 0x03
78#define AB8500_GASG_CC_ACCU4_REG 0x04
79#define AB8500_GASG_CC_SMPL_CNTRL_REG 0x05
80#define AB8500_GASG_CC_SMPL_CNTRH_REG 0x06
81#define AB8500_GASG_CC_SMPL_CNVL_REG 0x07
82#define AB8500_GASG_CC_SMPL_CNVH_REG 0x08
83#define AB8500_GASG_CC_CNTR_AVGOFF_REG 0x09
84#define AB8500_GASG_CC_OFFSET_REG 0x0A
85#define AB8500_GASG_CC_NCOV_ACCU 0x10
86#define AB8500_GASG_CC_NCOV_ACCU_CTRL 0x11
87#define AB8500_GASG_CC_NCOV_ACCU_LOW 0x12
88#define AB8500_GASG_CC_NCOV_ACCU_MED 0x13
89#define AB8500_GASG_CC_NCOV_ACCU_HIGH 0x14
90
91/*
92 * Interrupt register offsets
93 * Bank : 0x0E
94 */
95#define AB8500_IT_SOURCE2_REG 0x01
96#define AB8500_IT_SOURCE21_REG 0x14
97
98/*
99 * RTC register offsets
100 * Bank: 0x0F
101 */
102#define AB8500_RTC_BACKUP_CHG_REG 0x0C
103#define AB8500_RTC_CC_CONF_REG 0x01
104#define AB8500_RTC_CTRL_REG 0x0B
105#define AB8500_RTC_CTRL1_REG 0x11
106
107/*
108 * OTP register offsets
109 * Bank : 0x15
110 */
111#define AB8500_OTP_CONF_15 0x0E
112
113/* GPADC constants from AB8500 spec, UM0836 */
114#define ADC_RESOLUTION 1024
115#define ADC_CH_MAIN_MIN 0
116#define ADC_CH_MAIN_MAX 20030
117#define ADC_CH_VBUS_MIN 0
118#define ADC_CH_VBUS_MAX 20030
119#define ADC_CH_VBAT_MIN 2300
120#define ADC_CH_VBAT_MAX 4800
121#define ADC_CH_BKBAT_MIN 0
122#define ADC_CH_BKBAT_MAX 3200
123
124/* Main charge i/p current */
125#define MAIN_CH_IP_CUR_0P9A 0x80
126#define MAIN_CH_IP_CUR_1P0A 0x90
127#define MAIN_CH_IP_CUR_1P1A 0xA0
128#define MAIN_CH_IP_CUR_1P2A 0xB0
129#define MAIN_CH_IP_CUR_1P3A 0xC0
130#define MAIN_CH_IP_CUR_1P4A 0xD0
131#define MAIN_CH_IP_CUR_1P5A 0xE0
132
133/* ChVoltLevel */
134#define CH_VOL_LVL_3P5 0x00
135#define CH_VOL_LVL_4P0 0x14
136#define CH_VOL_LVL_4P05 0x16
137#define CH_VOL_LVL_4P1 0x1B
138#define CH_VOL_LVL_4P15 0x20
139#define CH_VOL_LVL_4P2 0x25
140#define CH_VOL_LVL_4P6 0x4D
141
142/* ChOutputCurrentLevel */
143#define CH_OP_CUR_LVL_0P1 0x00
144#define CH_OP_CUR_LVL_0P2 0x01
145#define CH_OP_CUR_LVL_0P3 0x02
146#define CH_OP_CUR_LVL_0P4 0x03
147#define CH_OP_CUR_LVL_0P5 0x04
148#define CH_OP_CUR_LVL_0P6 0x05
149#define CH_OP_CUR_LVL_0P7 0x06
150#define CH_OP_CUR_LVL_0P8 0x07
151#define CH_OP_CUR_LVL_0P9 0x08
152#define CH_OP_CUR_LVL_1P4 0x0D
153#define CH_OP_CUR_LVL_1P5 0x0E
154#define CH_OP_CUR_LVL_1P6 0x0F
155#define CH_OP_CUR_LVL_2P 0x3F
156
157/* BTEMP High thermal limits */
158#define BTEMP_HIGH_TH_57_0 0x00
159#define BTEMP_HIGH_TH_52 0x01
160#define BTEMP_HIGH_TH_57_1 0x02
161#define BTEMP_HIGH_TH_62 0x03
162
163#define LOW_BAT_3P1V 0x20
164#define LOW_BAT_2P3V 0x00
165#define LOW_BAT_RESET 0x01
166#define LOW_BAT_ENABLE 0x01
167
168/* Backup battery constants */
169#define BUP_ICH_SEL_50UA 0x00
170#define BUP_ICH_SEL_150UA 0x04
171#define BUP_ICH_SEL_300UA 0x08
172#define BUP_ICH_SEL_700UA 0x0C
173
174enum bup_vch_sel {
175 BUP_VCH_SEL_2P5V,
176 BUP_VCH_SEL_2P6V,
177 BUP_VCH_SEL_2P8V,
178 BUP_VCH_SEL_3P1V,
179 /*
180 * Note that the following 5 values 2.7v, 2.9v, 3.0v, 3.2v, 3.3v
181 * are only available on ab8540. You can't choose these 5
182 * voltage on ab8500/ab8505/ab9540.
183 */
184 BUP_VCH_SEL_2P7V,
185 BUP_VCH_SEL_2P9V,
186 BUP_VCH_SEL_3P0V,
187 BUP_VCH_SEL_3P2V,
188 BUP_VCH_SEL_3P3V,
189};
190
191#define BUP_VCH_RANGE 0x02
192#define VBUP33_VRTCN 0x01
193
194/* Battery OVV constants */
195#define BATT_OVV_ENA 0x02
196#define BATT_OVV_TH_3P7 0x00
197#define BATT_OVV_TH_4P75 0x01
198
199/* A value to indicate over voltage (microvolts) */
200#define BATT_OVV_VALUE 4750000
201
202/* VBUS OVV constants */
203#define VBUS_OVV_SELECT_MASK 0x78
204#define VBUS_OVV_SELECT_5P6V 0x00
205#define VBUS_OVV_SELECT_5P7V 0x08
206#define VBUS_OVV_SELECT_5P8V 0x10
207#define VBUS_OVV_SELECT_5P9V 0x18
208#define VBUS_OVV_SELECT_6P0V 0x20
209#define VBUS_OVV_SELECT_6P1V 0x28
210#define VBUS_OVV_SELECT_6P2V 0x30
211#define VBUS_OVV_SELECT_6P3V 0x38
212
213#define VBUS_AUTO_IN_CURR_LIM_ENA 0x04
214
215/* Fuel Gauge constants */
216#define RESET_ACCU 0x02
217#define READ_REQ 0x01
218#define CC_DEEP_SLEEP_ENA 0x02
219#define CC_PWR_UP_ENA 0x01
220#define CC_SAMPLES_40 0x28
221#define RD_NCONV_ACCU_REQ 0x01
222#define CC_CALIB 0x08
223#define CC_INTAVGOFFSET_ENA 0x10
224#define CC_MUXOFFSET 0x80
225#define CC_INT_CAL_N_AVG_MASK 0x60
226#define CC_INT_CAL_SAMPLES_16 0x40
227#define CC_INT_CAL_SAMPLES_8 0x20
228#define CC_INT_CAL_SAMPLES_4 0x00
229
230/* RTC constants */
231#define RTC_BUP_CH_ENA 0x10
232
233/* BatCtrl Current Source Constants */
234#define BAT_CTRL_7U_ENA 0x01
235#define BAT_CTRL_20U_ENA 0x02
236#define BAT_CTRL_18U_ENA 0x01
237#define BAT_CTRL_16U_ENA 0x02
238#define BAT_CTRL_CMP_ENA 0x04
239#define FORCE_BAT_CTRL_CMP_HIGH 0x08
240#define BAT_CTRL_PULL_UP_ENA 0x10
241
242/* Battery type */
243#define BATTERY_UNKNOWN 00
244
245/* Registers for pcut feature in ab8505 and ab9540 */
246#define AB8505_RTC_PCUT_CTL_STATUS_REG 0x12
247#define AB8505_RTC_PCUT_TIME_REG 0x13
248#define AB8505_RTC_PCUT_MAX_TIME_REG 0x14
249#define AB8505_RTC_PCUT_FLAG_TIME_REG 0x15
250#define AB8505_RTC_PCUT_RESTART_REG 0x16
251#define AB8505_RTC_PCUT_DEBOUNCE_REG 0x17
252
253/* USB Power Path constants for ab8540 */
254#define BUS_VSYS_VOL_SELECT_MASK 0x06
255#define BUS_VSYS_VOL_SELECT_3P6V 0x00
256#define BUS_VSYS_VOL_SELECT_3P325V 0x02
257#define BUS_VSYS_VOL_SELECT_3P9V 0x04
258#define BUS_VSYS_VOL_SELECT_4P3V 0x06
259#define BUS_POWER_PATH_MODE_ENA 0x01
260#define BUS_PP_PRECHG_CURRENT_MASK 0x0E
261#define BUS_POWER_PATH_PRECHG_ENA 0x01
262
263/* Forward declaration */
264struct ab8500_fg;
265
266/**
267 * struct ab8500_fg_parameters - Fuel gauge algorithm parameters, in seconds
268 * if not specified
269 * @recovery_sleep_timer: Time between measurements while recovering
270 * @recovery_total_time: Total recovery time
271 * @init_timer: Measurement interval during startup
272 * @init_discard_time: Time we discard voltage measurement at startup
273 * @init_total_time: Total init time during startup
274 * @high_curr_time: Time current has to be high to go to recovery
275 * @accu_charging: FG accumulation time while charging
276 * @accu_high_curr_ua: FG accumulation time in high current mode
277 * @high_curr_threshold_ua: High current threshold, in uA
278 * @lowbat_threshold_uv: Low battery threshold, in uV
279 * @battok_falling_th_sel0 Threshold in mV for battOk signal sel0
280 * Resolution in 50 mV step.
281 * @battok_raising_th_sel1 Threshold in mV for battOk signal sel1
282 * Resolution in 50 mV step.
283 * @user_cap_limit Capacity reported from user must be within this
284 * limit to be considered as sane, in percentage
285 * points.
286 * @maint_thres This is the threshold where we stop reporting
287 * battery full while in maintenance, in per cent
288 * @pcut_enable: Enable power cut feature in ab8505
289 * @pcut_max_time: Max time threshold
290 * @pcut_flag_time: Flagtime threshold
291 * @pcut_max_restart: Max number of restarts
292 * @pcut_debounce_time: Sets battery debounce time
293 */
294struct ab8500_fg_parameters {
295 int recovery_sleep_timer;
296 int recovery_total_time;
297 int init_timer;
298 int init_discard_time;
299 int init_total_time;
300 int high_curr_time;
301 int accu_charging;
302 int accu_high_curr;
303 int high_curr_threshold_ua;
304 int lowbat_threshold_uv;
305 int battok_falling_th_sel0;
306 int battok_raising_th_sel1;
307 int user_cap_limit;
308 int maint_thres;
309 bool pcut_enable;
310 u8 pcut_max_time;
311 u8 pcut_flag_time;
312 u8 pcut_max_restart;
313 u8 pcut_debounce_time;
314};
315
316/**
317 * struct ab8500_charger_maximization - struct used by the board config.
318 * @use_maxi: Enable maximization for this battery type
319 * @maxi_chg_curr_ua: Maximum charger current allowed in microampere
320 * @maxi_wait_cycles: cycles to wait before setting charger current
321 * @charger_curr_step_ua: delta between two charger current settings (uA)
322 */
323struct ab8500_maxim_parameters {
324 bool ena_maxi;
325 int chg_curr_ua;
326 int wait_cycles;
327 int charger_curr_step_ua;
328};
329
330/**
331 * struct ab8500_bm_capacity_levels - ab8500 capacity level data
332 * @critical: critical capacity level in percent
333 * @low: low capacity level in percent
334 * @normal: normal capacity level in percent
335 * @high: high capacity level in percent
336 * @full: full capacity level in percent
337 */
338struct ab8500_bm_capacity_levels {
339 int critical;
340 int low;
341 int normal;
342 int high;
343 int full;
344};
345
346/**
347 * struct ab8500_bm_charger_parameters - Charger specific parameters
348 * @usb_volt_max_uv: maximum allowed USB charger voltage in uV
349 * @usb_curr_max_ua: maximum allowed USB charger current in uA
350 * @ac_volt_max_uv: maximum allowed AC charger voltage in uV
351 * @ac_curr_max_ua: maximum allowed AC charger current in uA
352 */
353struct ab8500_bm_charger_parameters {
354 int usb_volt_max_uv;
355 int usb_curr_max_ua;
356 int ac_volt_max_uv;
357 int ac_curr_max_ua;
358};
359
360/**
361 * struct ab8500_bm_data - ab8500 battery management data
362 * @bi battery info from device tree
363 * @temp_now present battery temperature
364 * @temp_interval_chg temperature measurement interval in s when charging
365 * @temp_interval_nochg temperature measurement interval in s when not charging
366 * @main_safety_tmr_h safety timer for main charger
367 * @usb_safety_tmr_h safety timer for usb charger
368 * @bkup_bat_v voltage which we charge the backup battery with
369 * @bkup_bat_i current which we charge the backup battery with
370 * @capacity_scaling indicates whether capacity scaling is to be used
371 * @chg_unknown_bat flag to enable charging of unknown batteries
372 * @enable_overshoot flag to enable VBAT overshoot control
373 * @auto_trig flag to enable auto adc trigger
374 * @fg_res resistance of FG resistor in 0.1mOhm
375 * @interval_charging charge alg cycle period time when charging (sec)
376 * @interval_not_charging charge alg cycle period time when not charging (sec)
377 * @temp_hysteresis temperature hysteresis
378 * @maxi maximization parameters
379 * @cap_levels capacity in percent for the different capacity levels
380 * @chg_params charger parameters
381 * @fg_params fuel gauge parameters
382 */
383struct ab8500_bm_data {
384 struct power_supply_battery_info *bi;
385 int temp_now;
386 int temp_interval_chg;
387 int temp_interval_nochg;
388 int main_safety_tmr_h;
389 int usb_safety_tmr_h;
390 int bkup_bat_v;
391 int bkup_bat_i;
392 bool capacity_scaling;
393 bool chg_unknown_bat;
394 bool enable_overshoot;
395 bool auto_trig;
396 int fg_res;
397 int interval_charging;
398 int interval_not_charging;
399 int temp_hysteresis;
400 const struct ab8500_maxim_parameters *maxi;
401 const struct ab8500_bm_capacity_levels *cap_levels;
402 const struct ab8500_bm_charger_parameters *chg_params;
403 const struct ab8500_fg_parameters *fg_params;
404};
405
406/* Forward declaration */
407struct ab8500_fg;
408
409extern struct ab8500_bm_data ab8500_bm_data;
410
411void ab8500_charger_usb_state_changed(u8 bm_usb_state, u16 mA);
412struct ab8500_fg *ab8500_fg_get(void);
413int ab8500_fg_inst_curr_blocking(struct ab8500_fg *dev);
414int ab8500_fg_inst_curr_start(struct ab8500_fg *di);
415int ab8500_fg_inst_curr_finalize(struct ab8500_fg *di, int *res);
416int ab8500_fg_inst_curr_started(struct ab8500_fg *di);
417int ab8500_fg_inst_curr_done(struct ab8500_fg *di);
418int ab8500_bm_of_probe(struct power_supply *psy,
419 struct ab8500_bm_data *bm);
420void ab8500_bm_of_remove(struct power_supply *psy,
421 struct ab8500_bm_data *bm);
422
423extern struct platform_driver ab8500_fg_driver;
424extern struct platform_driver ab8500_btemp_driver;
425extern struct platform_driver ab8500_chargalg_driver;
426
427#endif /* _AB8500_CHARGER_H_ */
428

source code of linux/drivers/power/supply/ab8500-bm.h