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