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