Commit | Line | Data |
---|---|---|
27e34995 RV |
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 | ||
313162d0 PG |
11 | #include <linux/mutex.h> |
12 | ||
13 | struct device; | |
27e34995 RV |
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 { | |
1cda2394 | 25 | STMPE610, |
7f7f4ea1 | 26 | STMPE801, |
27e34995 RV |
27 | STMPE811, |
28 | STMPE1601, | |
29 | STMPE2401, | |
30 | STMPE2403, | |
e31f9b82 | 31 | STMPE_NBR_PARTS |
27e34995 RV |
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; | |
1a6e4b74 | 58 | struct stmpe_client_info; |
27e34995 RV |
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() | |
1a6e4b74 VK |
65 | * @client: client - i2c or spi |
66 | * @ci: client specific information | |
4dcaa6b6 | 67 | * @partnum: part number |
27e34995 RV |
68 | * @variant: the detected STMPE model number |
69 | * @regs: list of addresses of registers which are at different addresses on | |
70 | * different variants. Indexed by one of STMPE_IDX_*. | |
73de16db | 71 | * @irq: irq number for stmpe |
27e34995 RV |
72 | * @irq_base: starting IRQ number for internal IRQs |
73 | * @num_gpios: number of gpios, differs for variants | |
74 | * @ier: cache of IER registers for bus_lock | |
75 | * @oldier: cache of IER registers for bus_lock | |
76 | * @pdata: platform data | |
77 | */ | |
78 | struct stmpe { | |
79 | struct mutex lock; | |
80 | struct mutex irq_lock; | |
81 | struct device *dev; | |
1a6e4b74 VK |
82 | void *client; |
83 | struct stmpe_client_info *ci; | |
27e34995 RV |
84 | enum stmpe_partnum partnum; |
85 | struct stmpe_variant_info *variant; | |
86 | const u8 *regs; | |
87 | ||
73de16db | 88 | int irq; |
27e34995 RV |
89 | int irq_base; |
90 | int num_gpios; | |
91 | u8 ier[2]; | |
92 | u8 oldier[2]; | |
93 | struct stmpe_platform_data *pdata; | |
94 | }; | |
95 | ||
96 | extern int stmpe_reg_write(struct stmpe *stmpe, u8 reg, u8 data); | |
97 | extern int stmpe_reg_read(struct stmpe *stmpe, u8 reg); | |
98 | extern int stmpe_block_read(struct stmpe *stmpe, u8 reg, u8 length, | |
99 | u8 *values); | |
100 | extern int stmpe_block_write(struct stmpe *stmpe, u8 reg, u8 length, | |
101 | const u8 *values); | |
102 | extern int stmpe_set_bits(struct stmpe *stmpe, u8 reg, u8 mask, u8 val); | |
103 | extern int stmpe_set_altfunc(struct stmpe *stmpe, u32 pins, | |
104 | enum stmpe_block block); | |
105 | extern int stmpe_enable(struct stmpe *stmpe, unsigned int blocks); | |
106 | extern int stmpe_disable(struct stmpe *stmpe, unsigned int blocks); | |
107 | ||
108 | struct matrix_keymap_data; | |
109 | ||
110 | /** | |
111 | * struct stmpe_keypad_platform_data - STMPE keypad platform data | |
112 | * @keymap_data: key map table and size | |
113 | * @debounce_ms: debounce interval, in ms. Maximum is | |
114 | * %STMPE_KEYPAD_MAX_DEBOUNCE. | |
115 | * @scan_count: number of key scanning cycles to confirm key data. | |
116 | * Maximum is %STMPE_KEYPAD_MAX_SCAN_COUNT. | |
117 | * @no_autorepeat: disable key autorepeat | |
118 | */ | |
119 | struct stmpe_keypad_platform_data { | |
1379f49e | 120 | const struct matrix_keymap_data *keymap_data; |
27e34995 RV |
121 | unsigned int debounce_ms; |
122 | unsigned int scan_count; | |
123 | bool no_autorepeat; | |
124 | }; | |
125 | ||
b8e9cf0b WS |
126 | #define STMPE_GPIO_NOREQ_811_TOUCH (0xf0) |
127 | ||
27e34995 RV |
128 | /** |
129 | * struct stmpe_gpio_platform_data - STMPE GPIO platform data | |
130 | * @gpio_base: first gpio number assigned. A maximum of | |
131 | * %STMPE_NR_GPIOS GPIOs will be allocated. | |
b8e9cf0b WS |
132 | * @norequest_mask: bitmask specifying which GPIOs should _not_ be |
133 | * requestable due to different usage (e.g. touch, keypad) | |
134 | * STMPE_GPIO_NOREQ_* macros can be used here. | |
4dcaa6b6 OP |
135 | * @setup: board specific setup callback. |
136 | * @remove: board specific remove callback | |
27e34995 RV |
137 | */ |
138 | struct stmpe_gpio_platform_data { | |
139 | int gpio_base; | |
b8e9cf0b | 140 | unsigned norequest_mask; |
27e34995 RV |
141 | void (*setup)(struct stmpe *stmpe, unsigned gpio_base); |
142 | void (*remove)(struct stmpe *stmpe, unsigned gpio_base); | |
143 | }; | |
144 | ||
145 | /** | |
146 | * struct stmpe_ts_platform_data - stmpe811 touch screen controller platform | |
147 | * data | |
148 | * @sample_time: ADC converstion time in number of clock. | |
149 | * (0 -> 36 clocks, 1 -> 44 clocks, 2 -> 56 clocks, 3 -> 64 clocks, | |
150 | * 4 -> 80 clocks, 5 -> 96 clocks, 6 -> 144 clocks), | |
151 | * recommended is 4. | |
152 | * @mod_12b: ADC Bit mode (0 -> 10bit ADC, 1 -> 12bit ADC) | |
153 | * @ref_sel: ADC reference source | |
154 | * (0 -> internal reference, 1 -> external reference) | |
155 | * @adc_freq: ADC Clock speed | |
156 | * (0 -> 1.625 MHz, 1 -> 3.25 MHz, 2 || 3 -> 6.5 MHz) | |
157 | * @ave_ctrl: Sample average control | |
158 | * (0 -> 1 sample, 1 -> 2 samples, 2 -> 4 samples, 3 -> 8 samples) | |
159 | * @touch_det_delay: Touch detect interrupt delay | |
160 | * (0 -> 10 us, 1 -> 50 us, 2 -> 100 us, 3 -> 500 us, | |
161 | * 4-> 1 ms, 5 -> 5 ms, 6 -> 10 ms, 7 -> 50 ms) | |
162 | * recommended is 3 | |
163 | * @settling: Panel driver settling time | |
164 | * (0 -> 10 us, 1 -> 100 us, 2 -> 500 us, 3 -> 1 ms, | |
165 | * 4 -> 5 ms, 5 -> 10 ms, 6 for 50 ms, 7 -> 100 ms) | |
166 | * recommended is 2 | |
167 | * @fraction_z: Length of the fractional part in z | |
168 | * (fraction_z ([0..7]) = Count of the fractional part) | |
169 | * recommended is 7 | |
170 | * @i_drive: current limit value of the touchscreen drivers | |
171 | * (0 -> 20 mA typical 35 mA max, 1 -> 50 mA typical 80 mA max) | |
172 | * | |
173 | * */ | |
174 | struct stmpe_ts_platform_data { | |
175 | u8 sample_time; | |
176 | u8 mod_12b; | |
177 | u8 ref_sel; | |
178 | u8 adc_freq; | |
179 | u8 ave_ctrl; | |
180 | u8 touch_det_delay; | |
181 | u8 settling; | |
182 | u8 fraction_z; | |
183 | u8 i_drive; | |
184 | }; | |
185 | ||
186 | /** | |
187 | * struct stmpe_platform_data - STMPE platform data | |
188 | * @id: device id to distinguish between multiple STMPEs on the same board | |
189 | * @blocks: bitmask of blocks to enable (use STMPE_BLOCK_*) | |
190 | * @irq_trigger: IRQ trigger to use for the interrupt to the host | |
191 | * @irq_invert_polarity: IRQ line is connected with reversed polarity | |
5981f4e6 SI |
192 | * @autosleep: bool to enable/disable stmpe autosleep |
193 | * @autosleep_timeout: inactivity timeout in milliseconds for autosleep | |
27e34995 RV |
194 | * @irq_base: base IRQ number. %STMPE_NR_IRQS irqs will be used, or |
195 | * %STMPE_NR_INTERNAL_IRQS if the GPIO driver is not used. | |
73de16db VK |
196 | * @irq_over_gpio: true if gpio is used to get irq |
197 | * @irq_gpio: gpio number over which irq will be requested (significant only if | |
198 | * irq_over_gpio is true) | |
27e34995 RV |
199 | * @gpio: GPIO-specific platform data |
200 | * @keypad: keypad-specific platform data | |
201 | * @ts: touchscreen-specific platform data | |
202 | */ | |
203 | struct stmpe_platform_data { | |
204 | int id; | |
205 | unsigned int blocks; | |
206 | int irq_base; | |
207 | unsigned int irq_trigger; | |
208 | bool irq_invert_polarity; | |
5981f4e6 | 209 | bool autosleep; |
73de16db VK |
210 | bool irq_over_gpio; |
211 | int irq_gpio; | |
5981f4e6 | 212 | int autosleep_timeout; |
27e34995 RV |
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 |