include/linux/i2c/twl4030.h

   1 /*
   2  * twl4030.h - header for TWL4030 PM and audio CODEC device
   3  *
   4  * Copyright (C) 2005-2006 Texas Instruments, Inc.
   5  *
   6  * Based on tlv320aic23.c:
   7  * Copyright (c) by Kai Svahn <kai.svahn@nokia.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  22  *
  23  */
  24
  25 #ifndef __TWL4030_H_
  26 #define __TWL4030_H_
  27
  28 /*
  29  * Using the twl4030 core we address registers using a pair
  30  *      { module id, relative register offset }
  31  * which that core then maps to the relevant
  32  *      { i2c slave, absolute register address }
  33  *
  34  * The module IDs are meaningful only to the twl4030 core code,
  35  * which uses them as array indices to look up the first register
  36  * address each module uses within a given i2c slave.
  37  */
  38
  39 /* Slave 0 (i2c address 0x48) */
  40 #define TWL4030_MODULE_USB              0x00
  41
  42 /* Slave 1 (i2c address 0x49) */
  43 #define TWL4030_MODULE_AUDIO_VOICE      0x01
  44 #define TWL4030_MODULE_GPIO             0x02
  45 #define TWL4030_MODULE_INTBR            0x03
  46 #define TWL4030_MODULE_PIH              0x04
  47 #define TWL4030_MODULE_TEST             0x05
  48
  49 /* Slave 2 (i2c address 0x4a) */
  50 #define TWL4030_MODULE_KEYPAD           0x06
  51 #define TWL4030_MODULE_MADC             0x07
  52 #define TWL4030_MODULE_INTERRUPTS       0x08
  53 #define TWL4030_MODULE_LED              0x09
  54 #define TWL4030_MODULE_MAIN_CHARGE      0x0A
  55 #define TWL4030_MODULE_PRECHARGE        0x0B
  56 #define TWL4030_MODULE_PWM0             0x0C
  57 #define TWL4030_MODULE_PWM1             0x0D
  58 #define TWL4030_MODULE_PWMA             0x0E
  59 #define TWL4030_MODULE_PWMB             0x0F
  60
  61 /* Slave 3 (i2c address 0x4b) */
  62 #define TWL4030_MODULE_BACKUP           0x10
  63 #define TWL4030_MODULE_INT              0x11
  64 #define TWL4030_MODULE_PM_MASTER        0x12
  65 #define TWL4030_MODULE_PM_RECEIVER      0x13
  66 #define TWL4030_MODULE_RTC              0x14
  67 #define TWL4030_MODULE_SECURED_REG      0x15
  68
  69 /*
  70  * Read and write single 8-bit registers
  71  */
  72 int twl4030_i2c_write_u8(u8 mod_no, u8 val, u8 reg);
  73 int twl4030_i2c_read_u8(u8 mod_no, u8 *val, u8 reg);
  74
  75 /*
  76  * Read and write several 8-bit registers at once.
  77  *
  78  * IMPORTANT:  For twl4030_i2c_write(), allocate num_bytes + 1
  79  * for the value, and populate your data starting at offset 1.
  80  */
  81 int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, u8 num_bytes);
  82 int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, u8 num_bytes);
  83
  84 /*----------------------------------------------------------------------*/
  85
  86 /*
  87  * NOTE:  at up to 1024 registers, this is a big chip.
  88  *
  89  * Avoid putting register declarations in this file, instead of into
  90  * a driver-private file, unless some of the registers in a block
  91  * need to be shared with other drivers.  One example is blocks that
  92  * have Secondary IRQ Handler (SIH) registers.
  93  */
  94
  95 #define TWL4030_SIH_CTRL_EXCLEN_MASK    BIT(0)
  96 #define TWL4030_SIH_CTRL_PENDDIS_MASK   BIT(1)
  97 #define TWL4030_SIH_CTRL_COR_MASK       BIT(2)
  98
  99 /*----------------------------------------------------------------------*/
 100
 101 /*
 102  * GPIO Block Register offsets (use TWL4030_MODULE_GPIO)
 103  */
 104
 105 #define REG_GPIODATAIN1                 0x0
 106 #define REG_GPIODATAIN2                 0x1
 107 #define REG_GPIODATAIN3                 0x2
 108 #define REG_GPIODATADIR1                0x3
 109 #define REG_GPIODATADIR2                0x4
 110 #define REG_GPIODATADIR3                0x5
 111 #define REG_GPIODATAOUT1                0x6
 112 #define REG_GPIODATAOUT2                0x7
 113 #define REG_GPIODATAOUT3                0x8
 114 #define REG_CLEARGPIODATAOUT1           0x9
 115 #define REG_CLEARGPIODATAOUT2           0xA
 116 #define REG_CLEARGPIODATAOUT3           0xB
 117 #define REG_SETGPIODATAOUT1             0xC
 118 #define REG_SETGPIODATAOUT2             0xD
 119 #define REG_SETGPIODATAOUT3             0xE
 120 #define REG_GPIO_DEBEN1                 0xF
 121 #define REG_GPIO_DEBEN2                 0x10
 122 #define REG_GPIO_DEBEN3                 0x11
 123 #define REG_GPIO_CTRL                   0x12
 124 #define REG_GPIOPUPDCTR1                0x13
 125 #define REG_GPIOPUPDCTR2                0x14
 126 #define REG_GPIOPUPDCTR3                0x15
 127 #define REG_GPIOPUPDCTR4                0x16
 128 #define REG_GPIOPUPDCTR5                0x17
 129 #define REG_GPIO_ISR1A                  0x19
 130 #define REG_GPIO_ISR2A                  0x1A
 131 #define REG_GPIO_ISR3A                  0x1B
 132 #define REG_GPIO_IMR1A                  0x1C
 133 #define REG_GPIO_IMR2A                  0x1D
 134 #define REG_GPIO_IMR3A                  0x1E
 135 #define REG_GPIO_ISR1B                  0x1F
 136 #define REG_GPIO_ISR2B                  0x20
 137 #define REG_GPIO_ISR3B                  0x21
 138 #define REG_GPIO_IMR1B                  0x22
 139 #define REG_GPIO_IMR2B                  0x23
 140 #define REG_GPIO_IMR3B                  0x24
 141 #define REG_GPIO_EDR1                   0x28
 142 #define REG_GPIO_EDR2                   0x29
 143 #define REG_GPIO_EDR3                   0x2A
 144 #define REG_GPIO_EDR4                   0x2B
 145 #define REG_GPIO_EDR5                   0x2C
 146 #define REG_GPIO_SIH_CTRL               0x2D
 147
 148 /* Up to 18 signals are available as GPIOs, when their
 149  * pins are not assigned to another use (such as ULPI/USB).
 150  */
 151 #define TWL4030_GPIO_MAX                18
 152
 153 /*----------------------------------------------------------------------*/
 154
 155 /*
 156  * Keypad register offsets (use TWL4030_MODULE_KEYPAD)
 157  * ... SIH/interrupt only
 158  */
 159
 160 #define TWL4030_KEYPAD_KEYP_ISR1        0x11
 161 #define TWL4030_KEYPAD_KEYP_IMR1        0x12
 162 #define TWL4030_KEYPAD_KEYP_ISR2        0x13
 163 #define TWL4030_KEYPAD_KEYP_IMR2        0x14
 164 #define TWL4030_KEYPAD_KEYP_SIR         0x15    /* test register */
 165 #define TWL4030_KEYPAD_KEYP_EDR         0x16
 166 #define TWL4030_KEYPAD_KEYP_SIH_CTRL    0x17
 167
 168 /*----------------------------------------------------------------------*/
 169
 170 /*
 171  * Multichannel ADC register offsets (use TWL4030_MODULE_MADC)
 172  * ... SIH/interrupt only
 173  */
 174
 175 #define TWL4030_MADC_ISR1               0x61
 176 #define TWL4030_MADC_IMR1               0x62
 177 #define TWL4030_MADC_ISR2               0x63
 178 #define TWL4030_MADC_IMR2               0x64
 179 #define TWL4030_MADC_SIR                0x65    /* test register */
 180 #define TWL4030_MADC_EDR                0x66
 181 #define TWL4030_MADC_SIH_CTRL           0x67
 182
 183 /*----------------------------------------------------------------------*/
 184
 185 /*
 186  * Battery charger register offsets (use TWL4030_MODULE_INTERRUPTS)
 187  */
 188
 189 #define TWL4030_INTERRUPTS_BCIISR1A     0x0
 190 #define TWL4030_INTERRUPTS_BCIISR2A     0x1
 191 #define TWL4030_INTERRUPTS_BCIIMR1A     0x2
 192 #define TWL4030_INTERRUPTS_BCIIMR2A     0x3
 193 #define TWL4030_INTERRUPTS_BCIISR1B     0x4
 194 #define TWL4030_INTERRUPTS_BCIISR2B     0x5
 195 #define TWL4030_INTERRUPTS_BCIIMR1B     0x6
 196 #define TWL4030_INTERRUPTS_BCIIMR2B     0x7
 197 #define TWL4030_INTERRUPTS_BCISIR1      0x8     /* test register */
 198 #define TWL4030_INTERRUPTS_BCISIR2      0x9     /* test register */
 199 #define TWL4030_INTERRUPTS_BCIEDR1      0xa
 200 #define TWL4030_INTERRUPTS_BCIEDR2      0xb
 201 #define TWL4030_INTERRUPTS_BCIEDR3      0xc
 202 #define TWL4030_INTERRUPTS_BCISIHCTRL   0xd
 203
 204 /*----------------------------------------------------------------------*/
 205
 206 /*
 207  * Power Interrupt block register offsets (use TWL4030_MODULE_INT)
 208  */
 209
 210 #define TWL4030_INT_PWR_ISR1            0x0
 211 #define TWL4030_INT_PWR_IMR1            0x1
 212 #define TWL4030_INT_PWR_ISR2            0x2
 213 #define TWL4030_INT_PWR_IMR2            0x3
 214 #define TWL4030_INT_PWR_SIR             0x4     /* test register */
 215 #define TWL4030_INT_PWR_EDR1            0x5
 216 #define TWL4030_INT_PWR_EDR2            0x6
 217 #define TWL4030_INT_PWR_SIH_CTRL        0x7
 218
 219 /*----------------------------------------------------------------------*/
 220
 221 struct twl4030_bci_platform_data {
 222         int *battery_tmp_tbl;
 223         unsigned int tblsize;
 224 };
 225
 226 /* TWL4030_GPIO_MAX (18) GPIOs, with interrupts */
 227 struct twl4030_gpio_platform_data {
 228         int             gpio_base;
 229         unsigned        irq_base, irq_end;
 230
 231         /* package the two LED signals as output-only GPIOs? */
 232         bool            use_leds;
 233
 234         /* For gpio-N, bit (1 << N) in "pullups" is set if that pullup
 235          * should be enabled.  Else, if that bit is set in "pulldowns",
 236          * that pulldown is enabled.  Don't waste power by letting any
 237          * digital inputs float...
 238          */
 239         u32             pullups;
 240         u32             pulldowns;
 241
 242         int             (*setup)(struct device *dev,
 243                                 unsigned gpio, unsigned ngpio);
 244         int             (*teardown)(struct device *dev,
 245                                 unsigned gpio, unsigned ngpio);
 246 };
 247
 248 struct twl4030_madc_platform_data {
 249         int             irq_line;
 250 };
 251
 252 struct twl4030_keypad_data {
 253         int rows;
 254         int cols;
 255         int *keymap;
 256         int irq;
 257         unsigned int keymapsize;
 258         unsigned int rep:1;
 259 };
 260
 261 enum twl4030_usb_mode {
 262         T2_USB_MODE_ULPI = 1,
 263         T2_USB_MODE_CEA2011_3PIN = 2,
 264 };
 265
 266 struct twl4030_usb_data {
 267         enum twl4030_usb_mode   usb_mode;
 268 };
 269
 270 struct twl4030_platform_data {
 271         unsigned                                irq_base, irq_end;
 272         struct twl4030_bci_platform_data        *bci;
 273         struct twl4030_gpio_platform_data       *gpio;
 274         struct twl4030_madc_platform_data       *madc;
 275         struct twl4030_keypad_data              *keypad;
 276         struct twl4030_usb_data                 *usb;
 277
 278         /* REVISIT more to come ... _nothing_ should be hard-wired */
 279 };
 280
 281 /*----------------------------------------------------------------------*/
 282
 283 int twl4030_sih_setup(int module);
 284
 285 /*
 286  * FIXME completely stop using TWL4030_IRQ_BASE ... instead, pass the
 287  * IRQ data to subsidiary devices using platform device resources.
 288  */
 289
 290 /* IRQ information-need base */
 291 #include <mach/irqs.h>
 292 /* TWL4030 interrupts */
 293
 294 /* #define TWL4030_MODIRQ_GPIO          (TWL4030_IRQ_BASE + 0) */
 295 #define TWL4030_MODIRQ_KEYPAD           (TWL4030_IRQ_BASE + 1)
 296 #define TWL4030_MODIRQ_BCI              (TWL4030_IRQ_BASE + 2)
 297 #define TWL4030_MODIRQ_MADC             (TWL4030_IRQ_BASE + 3)
 298 /* #define TWL4030_MODIRQ_USB           (TWL4030_IRQ_BASE + 4) */
 299 /* #define TWL4030_MODIRQ_PWR           (TWL4030_IRQ_BASE + 5) */
 300
 301 #define TWL4030_PWRIRQ_PWRBTN           (TWL4030_PWR_IRQ_BASE + 0)
 302 /* #define TWL4030_PWRIRQ_CHG_PRES              (TWL4030_PWR_IRQ_BASE + 1) */
 303 /* #define TWL4030_PWRIRQ_USB_PRES              (TWL4030_PWR_IRQ_BASE + 2) */
 304 /* #define TWL4030_PWRIRQ_RTC           (TWL4030_PWR_IRQ_BASE + 3) */
 305 /* #define TWL4030_PWRIRQ_HOT_DIE               (TWL4030_PWR_IRQ_BASE + 4) */
 306 /* #define TWL4030_PWRIRQ_PWROK_TIMEOUT (TWL4030_PWR_IRQ_BASE + 5) */
 307 /* #define TWL4030_PWRIRQ_MBCHG         (TWL4030_PWR_IRQ_BASE + 6) */
 308 /* #define TWL4030_PWRIRQ_SC_DETECT     (TWL4030_PWR_IRQ_BASE + 7) */
 309
 310 /* Rest are unsued currently*/
 311
 312 /* Offsets to Power Registers */
 313 #define TWL4030_VDAC_DEV_GRP            0x3B
 314 #define TWL4030_VDAC_DEDICATED          0x3E
 315 #define TWL4030_VAUX1_DEV_GRP           0x17
 316 #define TWL4030_VAUX1_DEDICATED         0x1A
 317 #define TWL4030_VAUX2_DEV_GRP           0x1B
 318 #define TWL4030_VAUX2_DEDICATED         0x1E
 319 #define TWL4030_VAUX3_DEV_GRP           0x1F
 320 #define TWL4030_VAUX3_DEDICATED         0x22
 321
 322 /* TWL4030 GPIO interrupt definitions */
 323
 324 #define TWL4030_GPIO_IRQ_NO(n)          (TWL4030_GPIO_IRQ_BASE + (n))
 325
 326 /*
 327  * Exported TWL4030 GPIO APIs
 328  *
 329  * WARNING -- use standard GPIO and IRQ calls instead; these will vanish.
 330  */
 331 int twl4030_set_gpio_debounce(int gpio, int enable);
 332
 333 #if defined(CONFIG_TWL4030_BCI_BATTERY) || \
 334         defined(CONFIG_TWL4030_BCI_BATTERY_MODULE)
 335         extern int twl4030charger_usb_en(int enable);
 336 #else
 337         static inline int twl4030charger_usb_en(int enable) { return 0; }
 338 #endif
 339
 340 #endif /* End of __TWL4030_H */