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