xref: /linux/include/linux/mfd/stmpe.h (revision b889fcf63cb62e7fdb7816565e28f44dbe4a76a5)
1 /*
2  * Copyright (C) ST-Ericsson SA 2010
3  *
4  * License Terms: GNU General Public License, version 2
5  * Author: Rabin Vincent <rabin.vincent@stericsson.com> for ST-Ericsson
6  */
7 
8 #ifndef __LINUX_MFD_STMPE_H
9 #define __LINUX_MFD_STMPE_H
10 
11 #include <linux/mutex.h>
12 
13 struct device;
14 
15 enum stmpe_block {
16 	STMPE_BLOCK_GPIO	= 1 << 0,
17 	STMPE_BLOCK_KEYPAD	= 1 << 1,
18 	STMPE_BLOCK_TOUCHSCREEN	= 1 << 2,
19 	STMPE_BLOCK_ADC		= 1 << 3,
20 	STMPE_BLOCK_PWM		= 1 << 4,
21 	STMPE_BLOCK_ROTATOR	= 1 << 5,
22 };
23 
24 enum stmpe_partnum {
25 	STMPE610,
26 	STMPE801,
27 	STMPE811,
28 	STMPE1601,
29 	STMPE2401,
30 	STMPE2403,
31 	STMPE_NBR_PARTS
32 };
33 
34 /*
35  * For registers whose locations differ on variants,  the correct address is
36  * obtained by indexing stmpe->regs with one of the following.
37  */
38 enum {
39 	STMPE_IDX_CHIP_ID,
40 	STMPE_IDX_ICR_LSB,
41 	STMPE_IDX_IER_LSB,
42 	STMPE_IDX_ISR_MSB,
43 	STMPE_IDX_GPMR_LSB,
44 	STMPE_IDX_GPSR_LSB,
45 	STMPE_IDX_GPCR_LSB,
46 	STMPE_IDX_GPDR_LSB,
47 	STMPE_IDX_GPEDR_MSB,
48 	STMPE_IDX_GPRER_LSB,
49 	STMPE_IDX_GPFER_LSB,
50 	STMPE_IDX_GPAFR_U_MSB,
51 	STMPE_IDX_IEGPIOR_LSB,
52 	STMPE_IDX_ISGPIOR_MSB,
53 	STMPE_IDX_MAX,
54 };
55 
56 
57 struct stmpe_variant_info;
58 struct stmpe_client_info;
59 
60 /**
61  * struct stmpe - STMPE MFD structure
62  * @lock: lock protecting I/O operations
63  * @irq_lock: IRQ bus lock
64  * @dev: device, mostly for dev_dbg()
65  * @irq_domain: IRQ domain
66  * @client: client - i2c or spi
67  * @ci: client specific information
68  * @partnum: part number
69  * @variant: the detected STMPE model number
70  * @regs: list of addresses of registers which are at different addresses on
71  *	  different variants.  Indexed by one of STMPE_IDX_*.
72  * @irq: irq number for stmpe
73  * @irq_base: starting IRQ number for internal IRQs
74  * @num_gpios: number of gpios, differs for variants
75  * @ier: cache of IER registers for bus_lock
76  * @oldier: cache of IER registers for bus_lock
77  * @pdata: platform data
78  */
79 struct stmpe {
80 	struct mutex lock;
81 	struct mutex irq_lock;
82 	struct device *dev;
83 	struct irq_domain *domain;
84 	void *client;
85 	struct stmpe_client_info *ci;
86 	enum stmpe_partnum partnum;
87 	struct stmpe_variant_info *variant;
88 	const u8 *regs;
89 
90 	int irq;
91 	int irq_base;
92 	int num_gpios;
93 	u8 ier[2];
94 	u8 oldier[2];
95 	struct stmpe_platform_data *pdata;
96 };
97 
98 extern int stmpe_reg_write(struct stmpe *stmpe, u8 reg, u8 data);
99 extern int stmpe_reg_read(struct stmpe *stmpe, u8 reg);
100 extern int stmpe_block_read(struct stmpe *stmpe, u8 reg, u8 length,
101 			    u8 *values);
102 extern int stmpe_block_write(struct stmpe *stmpe, u8 reg, u8 length,
103 			     const u8 *values);
104 extern int stmpe_set_bits(struct stmpe *stmpe, u8 reg, u8 mask, u8 val);
105 extern int stmpe_set_altfunc(struct stmpe *stmpe, u32 pins,
106 			     enum stmpe_block block);
107 extern int stmpe_enable(struct stmpe *stmpe, unsigned int blocks);
108 extern int stmpe_disable(struct stmpe *stmpe, unsigned int blocks);
109 
110 struct matrix_keymap_data;
111 
112 /**
113  * struct stmpe_keypad_platform_data - STMPE keypad platform data
114  * @keymap_data: key map table and size
115  * @debounce_ms: debounce interval, in ms.  Maximum is
116  *		 %STMPE_KEYPAD_MAX_DEBOUNCE.
117  * @scan_count: number of key scanning cycles to confirm key data.
118  *		Maximum is %STMPE_KEYPAD_MAX_SCAN_COUNT.
119  * @no_autorepeat: disable key autorepeat
120  */
121 struct stmpe_keypad_platform_data {
122 	const struct matrix_keymap_data *keymap_data;
123 	unsigned int debounce_ms;
124 	unsigned int scan_count;
125 	bool no_autorepeat;
126 };
127 
128 #define STMPE_GPIO_NOREQ_811_TOUCH	(0xf0)
129 
130 /**
131  * struct stmpe_gpio_platform_data - STMPE GPIO platform data
132  * @gpio_base: first gpio number assigned.  A maximum of
133  *	       %STMPE_NR_GPIOS GPIOs will be allocated.
134  * @norequest_mask: bitmask specifying which GPIOs should _not_ be
135  *		    requestable due to different usage (e.g. touch, keypad)
136  *		    STMPE_GPIO_NOREQ_* macros can be used here.
137  * @setup: board specific setup callback.
138  * @remove: board specific remove callback
139  */
140 struct stmpe_gpio_platform_data {
141 	int gpio_base;
142 	unsigned norequest_mask;
143 	void (*setup)(struct stmpe *stmpe, unsigned gpio_base);
144 	void (*remove)(struct stmpe *stmpe, unsigned gpio_base);
145 };
146 
147 /**
148  * struct stmpe_ts_platform_data - stmpe811 touch screen controller platform
149  * data
150  * @sample_time: ADC converstion time in number of clock.
151  * (0 -> 36 clocks, 1 -> 44 clocks, 2 -> 56 clocks, 3 -> 64 clocks,
152  * 4 -> 80 clocks, 5 -> 96 clocks, 6 -> 144 clocks),
153  * recommended is 4.
154  * @mod_12b: ADC Bit mode (0 -> 10bit ADC, 1 -> 12bit ADC)
155  * @ref_sel: ADC reference source
156  * (0 -> internal reference, 1 -> external reference)
157  * @adc_freq: ADC Clock speed
158  * (0 -> 1.625 MHz, 1 -> 3.25 MHz, 2 || 3 -> 6.5 MHz)
159  * @ave_ctrl: Sample average control
160  * (0 -> 1 sample, 1 -> 2 samples, 2 -> 4 samples, 3 -> 8 samples)
161  * @touch_det_delay: Touch detect interrupt delay
162  * (0 -> 10 us, 1 -> 50 us, 2 -> 100 us, 3 -> 500 us,
163  * 4-> 1 ms, 5 -> 5 ms, 6 -> 10 ms, 7 -> 50 ms)
164  * recommended is 3
165  * @settling: Panel driver settling time
166  * (0 -> 10 us, 1 -> 100 us, 2 -> 500 us, 3 -> 1 ms,
167  * 4 -> 5 ms, 5 -> 10 ms, 6 for 50 ms, 7 -> 100 ms)
168  * recommended is 2
169  * @fraction_z: Length of the fractional part in z
170  * (fraction_z ([0..7]) = Count of the fractional part)
171  * recommended is 7
172  * @i_drive: current limit value of the touchscreen drivers
173  * (0 -> 20 mA typical 35 mA max, 1 -> 50 mA typical 80 mA max)
174  *
175  * */
176 struct stmpe_ts_platform_data {
177        u8 sample_time;
178        u8 mod_12b;
179        u8 ref_sel;
180        u8 adc_freq;
181        u8 ave_ctrl;
182        u8 touch_det_delay;
183        u8 settling;
184        u8 fraction_z;
185        u8 i_drive;
186 };
187 
188 /**
189  * struct stmpe_platform_data - STMPE platform data
190  * @id: device id to distinguish between multiple STMPEs on the same board
191  * @blocks: bitmask of blocks to enable (use STMPE_BLOCK_*)
192  * @irq_trigger: IRQ trigger to use for the interrupt to the host
193  * @autosleep: bool to enable/disable stmpe autosleep
194  * @autosleep_timeout: inactivity timeout in milliseconds for autosleep
195  * @irq_base: base IRQ number.  %STMPE_NR_IRQS irqs will be used, or
196  *	      %STMPE_NR_INTERNAL_IRQS if the GPIO driver is not used.
197  * @irq_over_gpio: true if gpio is used to get irq
198  * @irq_gpio: gpio number over which irq will be requested (significant only if
199  *	      irq_over_gpio is true)
200  * @gpio: GPIO-specific platform data
201  * @keypad: keypad-specific platform data
202  * @ts: touchscreen-specific platform data
203  */
204 struct stmpe_platform_data {
205 	int id;
206 	unsigned int blocks;
207 	int irq_base;
208 	unsigned int irq_trigger;
209 	bool autosleep;
210 	bool irq_over_gpio;
211 	int irq_gpio;
212 	int autosleep_timeout;
213 
214 	struct stmpe_gpio_platform_data *gpio;
215 	struct stmpe_keypad_platform_data *keypad;
216 	struct stmpe_ts_platform_data *ts;
217 };
218 
219 #define STMPE_NR_INTERNAL_IRQS	9
220 #define STMPE_INT_GPIO(x)	(STMPE_NR_INTERNAL_IRQS + (x))
221 
222 #define STMPE_NR_GPIOS		24
223 #define STMPE_NR_IRQS		STMPE_INT_GPIO(STMPE_NR_GPIOS)
224 
225 #endif
226