1 /*
2  * LP855x Backlight Driver
3  *
4  *			Copyright (C) 2011 Texas Instruments
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  *
10  */
11 
12 #ifndef _LP855X_H
13 #define _LP855X_H
14 
15 #define BL_CTL_SHFT	(0)
16 #define BRT_MODE_SHFT	(1)
17 #define BRT_MODE_MASK	(0x06)
18 
19 /* Enable backlight. Only valid when BRT_MODE=10(I2C only) */
20 #define ENABLE_BL	(1)
21 #define DISABLE_BL	(0)
22 
23 #define I2C_CONFIG(id)	id ## _I2C_CONFIG
24 #define PWM_CONFIG(id)	id ## _PWM_CONFIG
25 
26 /* DEVICE CONTROL register - LP8550 */
27 #define LP8550_PWM_CONFIG	(LP8550_PWM_ONLY << BRT_MODE_SHFT)
28 #define LP8550_I2C_CONFIG	((ENABLE_BL << BL_CTL_SHFT) | \
29 				(LP8550_I2C_ONLY << BRT_MODE_SHFT))
30 
31 /* DEVICE CONTROL register - LP8551 */
32 #define LP8551_PWM_CONFIG	LP8550_PWM_CONFIG
33 #define LP8551_I2C_CONFIG	LP8550_I2C_CONFIG
34 
35 /* DEVICE CONTROL register - LP8552 */
36 #define LP8552_PWM_CONFIG	LP8550_PWM_CONFIG
37 #define LP8552_I2C_CONFIG	LP8550_I2C_CONFIG
38 
39 /* DEVICE CONTROL register - LP8553 */
40 #define LP8553_PWM_CONFIG	LP8550_PWM_CONFIG
41 #define LP8553_I2C_CONFIG	LP8550_I2C_CONFIG
42 
43 /* DEVICE CONTROL register - LP8556 */
44 #define LP8556_PWM_CONFIG	(LP8556_PWM_ONLY << BRT_MODE_SHFT)
45 #define LP8556_COMB1_CONFIG	(LP8556_COMBINED1 << BRT_MODE_SHFT)
46 #define LP8556_I2C_CONFIG	((ENABLE_BL << BL_CTL_SHFT) | \
47 				(LP8556_I2C_ONLY << BRT_MODE_SHFT))
48 #define LP8556_COMB2_CONFIG	(LP8556_COMBINED2 << BRT_MODE_SHFT)
49 #define LP8556_FAST_CONFIG	BIT(7) /* use it if EPROMs should be maintained
50 					  when exiting the low power mode */
51 
52 enum lp855x_chip_id {
53 	LP8550,
54 	LP8551,
55 	LP8552,
56 	LP8553,
57 	LP8556,
58 };
59 
60 enum lp855x_brightness_ctrl_mode {
61 	PWM_BASED = 1,
62 	REGISTER_BASED,
63 };
64 
65 enum lp8550_brighntess_source {
66 	LP8550_PWM_ONLY,
67 	LP8550_I2C_ONLY = 2,
68 };
69 
70 enum lp8551_brighntess_source {
71 	LP8551_PWM_ONLY = LP8550_PWM_ONLY,
72 	LP8551_I2C_ONLY = LP8550_I2C_ONLY,
73 };
74 
75 enum lp8552_brighntess_source {
76 	LP8552_PWM_ONLY = LP8550_PWM_ONLY,
77 	LP8552_I2C_ONLY = LP8550_I2C_ONLY,
78 };
79 
80 enum lp8553_brighntess_source {
81 	LP8553_PWM_ONLY = LP8550_PWM_ONLY,
82 	LP8553_I2C_ONLY = LP8550_I2C_ONLY,
83 };
84 
85 enum lp8556_brightness_source {
86 	LP8556_PWM_ONLY,
87 	LP8556_COMBINED1,	/* pwm + i2c before the shaper block */
88 	LP8556_I2C_ONLY,
89 	LP8556_COMBINED2,	/* pwm + i2c after the shaper block */
90 };
91 
92 struct lp855x_rom_data {
93 	u8 addr;
94 	u8 val;
95 };
96 
97 /**
98  * struct lp855x_platform_data
99  * @name : Backlight driver name. If it is not defined, default name is set.
100  * @mode : brightness control by pwm or lp855x register
101  * @device_control : value of DEVICE CONTROL register
102  * @initial_brightness : initial value of backlight brightness
103  * @period_ns : platform specific pwm period value. unit is nano.
104 		Only valid when mode is PWM_BASED.
105  * @load_new_rom_data :
106 	0 : use default configuration data
107 	1 : update values of eeprom or eprom registers on loading driver
108  * @size_program : total size of lp855x_rom_data
109  * @rom_data : list of new eeprom/eprom registers
110  */
111 struct lp855x_platform_data {
112 	char *name;
113 	enum lp855x_brightness_ctrl_mode mode;
114 	u8 device_control;
115 	int initial_brightness;
116 	unsigned int period_ns;
117 	u8 load_new_rom_data;
118 	int size_program;
119 	struct lp855x_rom_data *rom_data;
120 };
121 
122 #endif
123