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