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 /* CONFIG register - LP8557 */
53 #define LP8557_PWM_STANDBY	BIT(7)
54 #define LP8557_PWM_FILTER	BIT(6)
55 #define LP8557_RELOAD_EPROM	BIT(3)	/* use it if EPROMs should be reset
56 					   when the backlight turns on */
57 #define LP8557_OFF_OPENLEDS	BIT(2)
58 #define LP8557_PWM_CONFIG	LP8557_PWM_ONLY
59 #define LP8557_I2C_CONFIG	LP8557_I2C_ONLY
60 #define LP8557_COMB1_CONFIG	LP8557_COMBINED1
61 #define LP8557_COMB2_CONFIG	LP8557_COMBINED2
62 
63 enum lp855x_chip_id {
64 	LP8550,
65 	LP8551,
66 	LP8552,
67 	LP8553,
68 	LP8556,
69 	LP8557,
70 };
71 
72 enum lp855x_brightness_ctrl_mode {
73 	PWM_BASED = 1,
74 	REGISTER_BASED,
75 };
76 
77 enum lp8550_brighntess_source {
78 	LP8550_PWM_ONLY,
79 	LP8550_I2C_ONLY = 2,
80 };
81 
82 enum lp8551_brighntess_source {
83 	LP8551_PWM_ONLY = LP8550_PWM_ONLY,
84 	LP8551_I2C_ONLY = LP8550_I2C_ONLY,
85 };
86 
87 enum lp8552_brighntess_source {
88 	LP8552_PWM_ONLY = LP8550_PWM_ONLY,
89 	LP8552_I2C_ONLY = LP8550_I2C_ONLY,
90 };
91 
92 enum lp8553_brighntess_source {
93 	LP8553_PWM_ONLY = LP8550_PWM_ONLY,
94 	LP8553_I2C_ONLY = LP8550_I2C_ONLY,
95 };
96 
97 enum lp8556_brightness_source {
98 	LP8556_PWM_ONLY,
99 	LP8556_COMBINED1,	/* pwm + i2c before the shaper block */
100 	LP8556_I2C_ONLY,
101 	LP8556_COMBINED2,	/* pwm + i2c after the shaper block */
102 };
103 
104 enum lp8557_brightness_source {
105 	LP8557_PWM_ONLY,
106 	LP8557_I2C_ONLY,
107 	LP8557_COMBINED1,	/* pwm + i2c after the shaper block */
108 	LP8557_COMBINED2,	/* pwm + i2c before the shaper block */
109 };
110 
111 struct lp855x_rom_data {
112 	u8 addr;
113 	u8 val;
114 };
115 
116 /**
117  * struct lp855x_platform_data
118  * @name : Backlight driver name. If it is not defined, default name is set.
119  * @mode : brightness control by pwm or lp855x register
120  * @device_control : value of DEVICE CONTROL register
121  * @initial_brightness : initial value of backlight brightness
122  * @period_ns : platform specific pwm period value. unit is nano.
123 		Only valid when mode is PWM_BASED.
124  * @load_new_rom_data :
125 	0 : use default configuration data
126 	1 : update values of eeprom or eprom registers on loading driver
127  * @size_program : total size of lp855x_rom_data
128  * @rom_data : list of new eeprom/eprom registers
129  */
130 struct lp855x_platform_data {
131 	char *name;
132 	enum lp855x_brightness_ctrl_mode mode;
133 	u8 device_control;
134 	int initial_brightness;
135 	unsigned int period_ns;
136 	u8 load_new_rom_data;
137 	int size_program;
138 	struct lp855x_rom_data *rom_data;
139 };
140 
141 #endif
142