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 struct regulator; 15 16 enum 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 25 enum 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 */ 40 enum { 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 63 struct stmpe_variant_info; 64 struct 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 */ 86 struct 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 106 extern int stmpe_reg_write(struct stmpe *stmpe, u8 reg, u8 data); 107 extern int stmpe_reg_read(struct stmpe *stmpe, u8 reg); 108 extern int stmpe_block_read(struct stmpe *stmpe, u8 reg, u8 length, 109 u8 *values); 110 extern int stmpe_block_write(struct stmpe *stmpe, u8 reg, u8 length, 111 const u8 *values); 112 extern int stmpe_set_bits(struct stmpe *stmpe, u8 reg, u8 mask, u8 val); 113 extern int stmpe_set_altfunc(struct stmpe *stmpe, u32 pins, 114 enum stmpe_block block); 115 extern int stmpe_enable(struct stmpe *stmpe, unsigned int blocks); 116 extern int stmpe_disable(struct stmpe *stmpe, unsigned int blocks); 117 118 #define STMPE_GPIO_NOREQ_811_TOUCH (0xf0) 119 120 /** 121 * struct stmpe_platform_data - STMPE platform data 122 * @id: device id to distinguish between multiple STMPEs on the same board 123 * @blocks: bitmask of blocks to enable (use STMPE_BLOCK_*) 124 * @irq_trigger: IRQ trigger to use for the interrupt to the host 125 * @autosleep: bool to enable/disable stmpe autosleep 126 * @autosleep_timeout: inactivity timeout in milliseconds for autosleep 127 * @irq_over_gpio: true if gpio is used to get irq 128 * @irq_gpio: gpio number over which irq will be requested (significant only if 129 * irq_over_gpio is true) 130 */ 131 struct stmpe_platform_data { 132 int id; 133 unsigned int blocks; 134 unsigned int irq_trigger; 135 bool autosleep; 136 bool irq_over_gpio; 137 int irq_gpio; 138 int autosleep_timeout; 139 }; 140 141 #endif 142