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