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
13struct device;
14struct regulator;
15
16enum stmpe_block {
17	STMPE_BLOCK_GPIO	= 1 << 0,
18	STMPE_BLOCK_KEYPAD	= 1 << 1,
19	STMPE_BLOCK_TOUCHSCREEN	= 1 << 2,
20	STMPE_BLOCK_ADC		= 1 << 3,
21	STMPE_BLOCK_PWM		= 1 << 4,
22	STMPE_BLOCK_ROTATOR	= 1 << 5,
23};
24
25enum stmpe_partnum {
26	STMPE610,
27	STMPE801,
28	STMPE811,
29	STMPE1601,
30	STMPE1801,
31	STMPE2401,
32	STMPE2403,
33	STMPE_NBR_PARTS
34};
35
36/*
37 * For registers whose locations differ on variants,  the correct address is
38 * obtained by indexing stmpe->regs with one of the following.
39 */
40enum {
41	STMPE_IDX_CHIP_ID,
42	STMPE_IDX_ICR_LSB,
43	STMPE_IDX_IER_LSB,
44	STMPE_IDX_ISR_LSB,
45	STMPE_IDX_ISR_MSB,
46	STMPE_IDX_GPMR_LSB,
47	STMPE_IDX_GPSR_LSB,
48	STMPE_IDX_GPCR_LSB,
49	STMPE_IDX_GPDR_LSB,
50	STMPE_IDX_GPEDR_MSB,
51	STMPE_IDX_GPRER_LSB,
52	STMPE_IDX_GPFER_LSB,
53	STMPE_IDX_GPPUR_LSB,
54	STMPE_IDX_GPPDR_LSB,
55	STMPE_IDX_GPAFR_U_MSB,
56	STMPE_IDX_IEGPIOR_LSB,
57	STMPE_IDX_ISGPIOR_LSB,
58	STMPE_IDX_ISGPIOR_MSB,
59	STMPE_IDX_MAX,
60};
61
62
63struct stmpe_variant_info;
64struct stmpe_client_info;
65
66/**
67 * struct stmpe - STMPE MFD structure
68 * @vcc: optional VCC regulator
69 * @vio: optional VIO regulator
70 * @lock: lock protecting I/O operations
71 * @irq_lock: IRQ bus lock
72 * @dev: device, mostly for dev_dbg()
73 * @irq_domain: IRQ domain
74 * @client: client - i2c or spi
75 * @ci: client specific information
76 * @partnum: part number
77 * @variant: the detected STMPE model number
78 * @regs: list of addresses of registers which are at different addresses on
79 *	  different variants.  Indexed by one of STMPE_IDX_*.
80 * @irq: irq number for stmpe
81 * @num_gpios: number of gpios, differs for variants
82 * @ier: cache of IER registers for bus_lock
83 * @oldier: cache of IER registers for bus_lock
84 * @pdata: platform data
85 */
86struct stmpe {
87	struct regulator *vcc;
88	struct regulator *vio;
89	struct mutex lock;
90	struct mutex irq_lock;
91	struct device *dev;
92	struct irq_domain *domain;
93	void *client;
94	struct stmpe_client_info *ci;
95	enum stmpe_partnum partnum;
96	struct stmpe_variant_info *variant;
97	const u8 *regs;
98
99	int irq;
100	int num_gpios;
101	u8 ier[2];
102	u8 oldier[2];
103	struct stmpe_platform_data *pdata;
104};
105
106extern int stmpe_reg_write(struct stmpe *stmpe, u8 reg, u8 data);
107extern int stmpe_reg_read(struct stmpe *stmpe, u8 reg);
108extern int stmpe_block_read(struct stmpe *stmpe, u8 reg, u8 length,
109			    u8 *values);
110extern int stmpe_block_write(struct stmpe *stmpe, u8 reg, u8 length,
111			     const u8 *values);
112extern int stmpe_set_bits(struct stmpe *stmpe, u8 reg, u8 mask, u8 val);
113extern int stmpe_set_altfunc(struct stmpe *stmpe, u32 pins,
114			     enum stmpe_block block);
115extern int stmpe_enable(struct stmpe *stmpe, unsigned int blocks);
116extern int stmpe_disable(struct stmpe *stmpe, unsigned int blocks);
117
118#define STMPE_GPIO_NOREQ_811_TOUCH	(0xf0)
119
120/**
121 * struct stmpe_ts_platform_data - stmpe811 touch screen controller platform
122 * data
123 * @sample_time: ADC converstion time in number of clock.
124 * (0 -> 36 clocks, 1 -> 44 clocks, 2 -> 56 clocks, 3 -> 64 clocks,
125 * 4 -> 80 clocks, 5 -> 96 clocks, 6 -> 144 clocks),
126 * recommended is 4.
127 * @mod_12b: ADC Bit mode (0 -> 10bit ADC, 1 -> 12bit ADC)
128 * @ref_sel: ADC reference source
129 * (0 -> internal reference, 1 -> external reference)
130 * @adc_freq: ADC Clock speed
131 * (0 -> 1.625 MHz, 1 -> 3.25 MHz, 2 || 3 -> 6.5 MHz)
132 * @ave_ctrl: Sample average control
133 * (0 -> 1 sample, 1 -> 2 samples, 2 -> 4 samples, 3 -> 8 samples)
134 * @touch_det_delay: Touch detect interrupt delay
135 * (0 -> 10 us, 1 -> 50 us, 2 -> 100 us, 3 -> 500 us,
136 * 4-> 1 ms, 5 -> 5 ms, 6 -> 10 ms, 7 -> 50 ms)
137 * recommended is 3
138 * @settling: Panel driver settling time
139 * (0 -> 10 us, 1 -> 100 us, 2 -> 500 us, 3 -> 1 ms,
140 * 4 -> 5 ms, 5 -> 10 ms, 6 for 50 ms, 7 -> 100 ms)
141 * recommended is 2
142 * @fraction_z: Length of the fractional part in z
143 * (fraction_z ([0..7]) = Count of the fractional part)
144 * recommended is 7
145 * @i_drive: current limit value of the touchscreen drivers
146 * (0 -> 20 mA typical 35 mA max, 1 -> 50 mA typical 80 mA max)
147 *
148 * */
149struct stmpe_ts_platform_data {
150       u8 sample_time;
151       u8 mod_12b;
152       u8 ref_sel;
153       u8 adc_freq;
154       u8 ave_ctrl;
155       u8 touch_det_delay;
156       u8 settling;
157       u8 fraction_z;
158       u8 i_drive;
159};
160
161/**
162 * struct stmpe_platform_data - STMPE platform data
163 * @id: device id to distinguish between multiple STMPEs on the same board
164 * @blocks: bitmask of blocks to enable (use STMPE_BLOCK_*)
165 * @irq_trigger: IRQ trigger to use for the interrupt to the host
166 * @autosleep: bool to enable/disable stmpe autosleep
167 * @autosleep_timeout: inactivity timeout in milliseconds for autosleep
168 * @irq_over_gpio: true if gpio is used to get irq
169 * @irq_gpio: gpio number over which irq will be requested (significant only if
170 *	      irq_over_gpio is true)
171 * @ts: touchscreen-specific platform data
172 */
173struct stmpe_platform_data {
174	int id;
175	unsigned int blocks;
176	unsigned int irq_trigger;
177	bool autosleep;
178	bool irq_over_gpio;
179	int irq_gpio;
180	int autosleep_timeout;
181
182	struct stmpe_ts_platform_data *ts;
183};
184
185#endif
186