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