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