4 * Copyright 2012 Texas Instruments
6 * Author: Milo(Woogyom) Kim <milo.kim@ti.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
14 #ifndef __MFD_LP8788_H__
15 #define __MFD_LP8788_H__
17 #include <linux/gpio.h>
18 #include <linux/irqdomain.h>
19 #include <linux/regmap.h>
21 #define LP8788_DEV_BUCK "lp8788-buck"
22 #define LP8788_DEV_DLDO "lp8788-dldo"
23 #define LP8788_DEV_ALDO "lp8788-aldo"
24 #define LP8788_DEV_CHARGER "lp8788-charger"
25 #define LP8788_DEV_RTC "lp8788-rtc"
26 #define LP8788_DEV_BACKLIGHT "lp8788-backlight"
27 #define LP8788_DEV_VIBRATOR "lp8788-vibrator"
28 #define LP8788_DEV_KEYLED "lp8788-keyled"
29 #define LP8788_DEV_ADC "lp8788-adc"
31 #define LP8788_NUM_BUCKS 4
32 #define LP8788_NUM_DLDOS 12
33 #define LP8788_NUM_ALDOS 10
34 #define LP8788_NUM_BUCK2_DVS 2
36 #define LP8788_CHG_IRQ "CHG_IRQ"
37 #define LP8788_PRSW_IRQ "PRSW_IRQ"
38 #define LP8788_BATT_IRQ "BATT_IRQ"
39 #define LP8788_ALM_IRQ "ALARM_IRQ"
42 /* interrup register 1 : Addr 00h */
47 LP8788_INT_PWRON_TIME,
52 /* interrupt register 2 : Addr 01h */
53 LP8788_INT_CHG_INPUT_STATE,
56 LP8788_INT_CHG_RESTART,
57 LP8788_INT_RESTART_TIMEOUT,
58 LP8788_INT_FULLCHG_TIMEOUT,
59 LP8788_INT_PRECHG_TIMEOUT,
61 /* interrupt register 3 : Addr 02h */
62 LP8788_INT_RTC_ALARM1 = 17,
63 LP8788_INT_RTC_ALARM2,
64 LP8788_INT_ENTER_SYS_SUPPORT,
65 LP8788_INT_EXIT_SYS_SUPPORT,
79 enum lp8788_ext_ldo_en_id {
89 enum lp8788_charger_event {
94 enum lp8788_bl_ctrl_mode {
95 LP8788_BL_REGISTER_ONLY,
96 LP8788_BL_COMB_PWM_BASED, /* PWM + I2C, changed by PWM input */
97 LP8788_BL_COMB_REGISTER_BASED, /* PWM + I2C, changed by I2C */
100 enum lp8788_bl_dim_mode {
101 LP8788_DIM_EXPONENTIAL,
105 enum lp8788_bl_full_scale_current {
106 LP8788_FULLSCALE_5000uA,
107 LP8788_FULLSCALE_8500uA,
108 LP8788_FULLSCALE_1200uA,
109 LP8788_FULLSCALE_1550uA,
110 LP8788_FULLSCALE_1900uA,
111 LP8788_FULLSCALE_2250uA,
112 LP8788_FULLSCALE_2600uA,
113 LP8788_FULLSCALE_2950uA,
116 enum lp8788_bl_ramp_step {
127 enum lp8788_bl_pwm_polarity {
128 LP8788_PWM_ACTIVE_HIGH,
129 LP8788_PWM_ACTIVE_LOW,
132 enum lp8788_isink_scale {
133 LP8788_ISINK_SCALE_100mA,
134 LP8788_ISINK_SCALE_120mA,
137 enum lp8788_isink_number {
143 enum lp8788_alarm_sel {
170 * @gpio : gpio pin number for dvs control
171 * @vsel : dvs selector for buck v1 register
173 struct lp8788_buck1_dvs {
175 enum lp8788_dvs_sel vsel;
180 * @gpio : two gpio pin numbers are used for dvs
181 * @vsel : dvs selector for buck v2 register
183 struct lp8788_buck2_dvs {
184 int gpio[LP8788_NUM_BUCK2_DVS];
185 enum lp8788_dvs_sel vsel;
189 * struct lp8788_ldo_enable_pin
191 * Basically, all LDOs are enabled through the I2C commands.
192 * But ALDO 1 ~ 5, 7, DLDO 7, 9, 11 can be enabled by external gpio pins.
194 * @gpio : gpio number which is used for enabling ldos
195 * @init_state : initial gpio state (ex. GPIOF_OUT_INIT_LOW)
197 struct lp8788_ldo_enable_pin {
203 * struct lp8788_chg_param
204 * @addr : charging control register address (range : 0x11 ~ 0x1C)
205 * @val : charging parameter value
207 struct lp8788_chg_param {
213 * struct lp8788_charger_platform_data
214 * @adc_vbatt : adc channel name for battery voltage
215 * @adc_batt_temp : adc channel name for battery temperature
216 * @max_vbatt_mv : used for calculating battery capacity
217 * @chg_params : initial charging parameters
218 * @num_chg_params : numbers of charging parameters
219 * @charger_event : the charger event can be reported to the platform side
221 struct lp8788_charger_platform_data {
222 const char *adc_vbatt;
223 const char *adc_batt_temp;
224 unsigned int max_vbatt_mv;
225 struct lp8788_chg_param *chg_params;
227 void (*charger_event) (struct lp8788 *lp,
228 enum lp8788_charger_event event);
232 * struct lp8788_bl_pwm_data
233 * @pwm_set_intensity : set duty of pwm
234 * @pwm_get_intensity : get current duty of pwm
236 struct lp8788_bl_pwm_data {
237 void (*pwm_set_intensity) (int brightness, int max_brightness);
238 int (*pwm_get_intensity) (int max_brightness);
242 * struct lp8788_backlight_platform_data
243 * @name : backlight driver name. (default: "lcd-backlight")
244 * @initial_brightness : initial value of backlight brightness
245 * @bl_mode : brightness control by pwm or lp8788 register
246 * @dim_mode : dimming mode selection
247 * @full_scale : full scale current setting
248 * @rise_time : brightness ramp up step time
249 * @fall_time : brightness ramp down step time
250 * @pwm_pol : pwm polarity setting when bl_mode is pwm based
251 * @pwm_data : platform specific pwm generation functions
252 * only valid when bl_mode is pwm based
254 struct lp8788_backlight_platform_data {
256 int initial_brightness;
257 enum lp8788_bl_ctrl_mode bl_mode;
258 enum lp8788_bl_dim_mode dim_mode;
259 enum lp8788_bl_full_scale_current full_scale;
260 enum lp8788_bl_ramp_step rise_time;
261 enum lp8788_bl_ramp_step fall_time;
262 enum lp8788_bl_pwm_polarity pwm_pol;
263 struct lp8788_bl_pwm_data pwm_data;
267 * struct lp8788_led_platform_data
268 * @name : led driver name. (default: "keyboard-backlight")
269 * @scale : current scale
270 * @num : current sink number
271 * @iout_code : current output value (Addr 9Ah ~ 9Bh)
273 struct lp8788_led_platform_data {
275 enum lp8788_isink_scale scale;
276 enum lp8788_isink_number num;
281 * struct lp8788_vib_platform_data
282 * @name : vibrator driver name
283 * @scale : current scale
284 * @num : current sink number
285 * @iout_code : current output value (Addr 9Ah ~ 9Bh)
286 * @pwm_code : PWM code value (Addr 9Ch ~ 9Eh)
288 struct lp8788_vib_platform_data {
290 enum lp8788_isink_scale scale;
291 enum lp8788_isink_number num;
297 * struct lp8788_platform_data
298 * @init_func : used for initializing registers
299 * before mfd driver is registered
300 * @buck_data : regulator initial data for buck
301 * @dldo_data : regulator initial data for digital ldo
302 * @aldo_data : regulator initial data for analog ldo
303 * @buck1_dvs : gpio configurations for buck1 dvs
304 * @buck2_dvs : gpio configurations for buck2 dvs
305 * @ldo_pin : gpio configurations for enabling LDOs
306 * @chg_pdata : platform data for charger driver
307 * @alarm_sel : rtc alarm selection (1 or 2)
308 * @bl_pdata : configurable data for backlight driver
309 * @led_pdata : configurable data for led driver
310 * @vib_pdata : configurable data for vibrator driver
311 * @adc_pdata : iio map data for adc driver
313 struct lp8788_platform_data {
314 /* general system information */
315 int (*init_func) (struct lp8788 *lp);
318 struct regulator_init_data *buck_data[LP8788_NUM_BUCKS];
319 struct regulator_init_data *dldo_data[LP8788_NUM_DLDOS];
320 struct regulator_init_data *aldo_data[LP8788_NUM_ALDOS];
321 struct lp8788_buck1_dvs *buck1_dvs;
322 struct lp8788_buck2_dvs *buck2_dvs;
323 struct lp8788_ldo_enable_pin *ldo_pin[EN_LDOS_MAX];
326 struct lp8788_charger_platform_data *chg_pdata;
329 enum lp8788_alarm_sel alarm_sel;
332 struct lp8788_backlight_platform_data *bl_pdata;
335 struct lp8788_led_platform_data *led_pdata;
336 struct lp8788_vib_platform_data *vib_pdata;
338 /* adc iio map data */
339 struct iio_map *adc_pdata;
344 * @dev : parent device pointer
345 * @regmap : used for i2c communcation on accessing registers
346 * @irqdm : interrupt domain for handling nested interrupt
347 * @irq : pin number of IRQ_N
348 * @pdata : lp8788 platform specific data
352 struct regmap *regmap;
353 struct irq_domain *irqdm;
355 struct lp8788_platform_data *pdata;
358 int lp8788_irq_init(struct lp8788 *lp, int chip_irq);
359 void lp8788_irq_exit(struct lp8788 *lp);
360 int lp8788_read_byte(struct lp8788 *lp, u8 reg, u8 *data);
361 int lp8788_read_multi_bytes(struct lp8788 *lp, u8 reg, u8 *data, size_t count);
362 int lp8788_write_byte(struct lp8788 *lp, u8 reg, u8 data);
363 int lp8788_update_bits(struct lp8788 *lp, u8 reg, u8 mask, u8 data);