1 /*
2  * Definitions and platform data for Analog Devices
3  * Backlight drivers ADP8860
4  *
5  * Copyright 2009-2010 Analog Devices Inc.
6  *
7  * Licensed under the GPL-2 or later.
8  */
9 
10 #ifndef __LINUX_I2C_ADP8860_H
11 #define __LINUX_I2C_ADP8860_H
12 
13 #include <linux/leds.h>
14 #include <linux/types.h>
15 
16 #define ID_ADP8860		8860
17 
18 #define ADP8860_MAX_BRIGHTNESS	0x7F
19 #define FLAG_OFFT_SHIFT 8
20 
21 /*
22  * LEDs subdevice platform data
23  */
24 
25 #define ADP8860_LED_DIS_BLINK	(0 << FLAG_OFFT_SHIFT)
26 #define ADP8860_LED_OFFT_600ms	(1 << FLAG_OFFT_SHIFT)
27 #define ADP8860_LED_OFFT_1200ms	(2 << FLAG_OFFT_SHIFT)
28 #define ADP8860_LED_OFFT_1800ms	(3 << FLAG_OFFT_SHIFT)
29 
30 #define ADP8860_LED_ONT_200ms	0
31 #define ADP8860_LED_ONT_600ms	1
32 #define ADP8860_LED_ONT_800ms	2
33 #define ADP8860_LED_ONT_1200ms	3
34 
35 #define ADP8860_LED_D7		(7)
36 #define ADP8860_LED_D6		(6)
37 #define ADP8860_LED_D5		(5)
38 #define ADP8860_LED_D4		(4)
39 #define ADP8860_LED_D3		(3)
40 #define ADP8860_LED_D2		(2)
41 #define ADP8860_LED_D1		(1)
42 
43 /*
44  * Backlight subdevice platform data
45  */
46 
47 #define ADP8860_BL_D7		(1 << 6)
48 #define ADP8860_BL_D6		(1 << 5)
49 #define ADP8860_BL_D5		(1 << 4)
50 #define ADP8860_BL_D4		(1 << 3)
51 #define ADP8860_BL_D3		(1 << 2)
52 #define ADP8860_BL_D2		(1 << 1)
53 #define ADP8860_BL_D1		(1 << 0)
54 
55 #define ADP8860_FADE_T_DIS	0	/* Fade Timer Disabled */
56 #define ADP8860_FADE_T_300ms	1	/* 0.3 Sec */
57 #define ADP8860_FADE_T_600ms	2
58 #define ADP8860_FADE_T_900ms	3
59 #define ADP8860_FADE_T_1200ms	4
60 #define ADP8860_FADE_T_1500ms	5
61 #define ADP8860_FADE_T_1800ms	6
62 #define ADP8860_FADE_T_2100ms	7
63 #define ADP8860_FADE_T_2400ms	8
64 #define ADP8860_FADE_T_2700ms	9
65 #define ADP8860_FADE_T_3000ms	10
66 #define ADP8860_FADE_T_3500ms	11
67 #define ADP8860_FADE_T_4000ms	12
68 #define ADP8860_FADE_T_4500ms	13
69 #define ADP8860_FADE_T_5000ms	14
70 #define ADP8860_FADE_T_5500ms	15	/* 5.5 Sec */
71 
72 #define ADP8860_FADE_LAW_LINEAR	0
73 #define ADP8860_FADE_LAW_SQUARE	1
74 #define ADP8860_FADE_LAW_CUBIC1	2
75 #define ADP8860_FADE_LAW_CUBIC2	3
76 
77 #define ADP8860_BL_AMBL_FILT_80ms	0	/* Light sensor filter time */
78 #define ADP8860_BL_AMBL_FILT_160ms	1
79 #define ADP8860_BL_AMBL_FILT_320ms	2
80 #define ADP8860_BL_AMBL_FILT_640ms	3
81 #define ADP8860_BL_AMBL_FILT_1280ms	4
82 #define ADP8860_BL_AMBL_FILT_2560ms	5
83 #define ADP8860_BL_AMBL_FILT_5120ms	6
84 #define ADP8860_BL_AMBL_FILT_10240ms	7	/* 10.24 sec */
85 
86 /*
87  * Blacklight current 0..30mA
88  */
89 #define ADP8860_BL_CUR_mA(I)		((I * 127) / 30)
90 
91 /*
92  * L2 comparator current 0..1106uA
93  */
94 #define ADP8860_L2_COMP_CURR_uA(I)	((I * 255) / 1106)
95 
96 /*
97  * L3 comparator current 0..138uA
98  */
99 #define ADP8860_L3_COMP_CURR_uA(I)	((I * 255) / 138)
100 
101 struct adp8860_backlight_platform_data {
102 	u8 bl_led_assign;	/* 1 = Backlight 0 = Individual LED */
103 
104 	u8 bl_fade_in;		/* Backlight Fade-In Timer */
105 	u8 bl_fade_out;		/* Backlight Fade-Out Timer */
106 	u8 bl_fade_law;		/* fade-on/fade-off transfer characteristic */
107 
108 	u8 en_ambl_sens;	/* 1 = enable ambient light sensor */
109 	u8 abml_filt;		/* Light sensor filter time */
110 
111 	u8 l1_daylight_max;	/* use BL_CUR_mA(I) 0 <= I <= 30 mA */
112 	u8 l1_daylight_dim;	/* typ = 0, use BL_CUR_mA(I) 0 <= I <= 30 mA */
113 	u8 l2_office_max;	/* use BL_CUR_mA(I) 0 <= I <= 30 mA */
114 	u8 l2_office_dim;	/* typ = 0, use BL_CUR_mA(I) 0 <= I <= 30 mA */
115 	u8 l3_dark_max;		/* use BL_CUR_mA(I) 0 <= I <= 30 mA */
116 	u8 l3_dark_dim;		/* typ = 0, use BL_CUR_mA(I) 0 <= I <= 30 mA */
117 
118 	u8 l2_trip;		/* use L2_COMP_CURR_uA(I) 0 <= I <= 1106 uA */
119 	u8 l2_hyst;		/* use L2_COMP_CURR_uA(I) 0 <= I <= 1106 uA */
120 	u8 l3_trip;		/* use L3_COMP_CURR_uA(I) 0 <= I <= 551 uA */
121 	u8 l3_hyst;		/* use L3_COMP_CURR_uA(I) 0 <= I <= 551 uA */
122 
123 	/**
124 	 * Independent Current Sinks / LEDS
125 	 * Sinks not assigned to the Backlight can be exposed to
126 	 * user space using the LEDS CLASS interface
127 	 */
128 
129 	int num_leds;
130 	struct led_info	*leds;
131 	u8 led_fade_in;		/* LED Fade-In Timer */
132 	u8 led_fade_out;	/* LED Fade-Out Timer */
133 	u8 led_fade_law;	/* fade-on/fade-off transfer characteristic */
134 	u8 led_on_time;
135 
136 	/**
137 	 * Gain down disable. Setting this option does not allow the
138 	 * charge pump to switch to lower gains. NOT AVAILABLE on ADP8860
139 	 * 1 = the charge pump doesn't switch down in gain until all LEDs are 0.
140 	 *  The charge pump switches up in gain as needed. This feature is
141 	 *  useful if the ADP8863 charge pump is used to drive an external load.
142 	 *  This feature must be used when utilizing small fly capacitors
143 	 *  (0402 or smaller).
144 	 * 0 = the charge pump automatically switches up and down in gain.
145 	 *  This provides optimal efficiency, but is not suitable for driving
146 	 *  loads that are not connected through the ADP8863 diode drivers.
147 	 *  Additionally, the charge pump fly capacitors should be low ESR
148 	 * and sized 0603 or greater.
149 	 */
150 
151 	u8 gdwn_dis;
152 };
153 
154 #endif /* __LINUX_I2C_ADP8860_H */
155