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, unsigned num_bytes);
  82 int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, unsigned 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 /* Power bus message definitions */
 222
 223 #define DEV_GRP_NULL            0x0
 224 #define DEV_GRP_P1              0x1
 225 #define DEV_GRP_P2              0x2
 226 #define DEV_GRP_P3              0x4
 227
 228 #define RES_GRP_RES             0x0
 229 #define RES_GRP_PP              0x1
 230 #define RES_GRP_RC              0x2
 231 #define RES_GRP_PP_RC           0x3
 232 #define RES_GRP_PR              0x4
 233 #define RES_GRP_PP_PR           0x5
 234 #define RES_GRP_RC_PR           0x6
 235 #define RES_GRP_ALL             0x7
 236
 237 #define RES_TYPE2_R0            0x0
 238
 239 #define RES_TYPE_ALL            0x7
 240
 241 #define RES_STATE_WRST          0xF
 242 #define RES_STATE_ACTIVE        0xE
 243 #define RES_STATE_SLEEP         0x8
 244 #define RES_STATE_OFF           0x0
 245
 246 /* Power resources */
 247
 248 #define RES_VAUX1               1
 249 #define RES_VAUX2               2
 250 #define RES_VAUX3               3
 251 #define RES_VAUX4               4
 252 #define RES_VMMC1               5
 253 #define RES_VMMC2               6
 254 #define RES_VPLL1               7
 255 #define RES_VPLL2               8
 256 #define RES_VSIM                9
 257 #define RES_VDAC                10
 258 #define RES_VINTANA1            11
 259 #define RES_VINTANA2            12
 260 #define RES_VINTDIG             13
 261 #define RES_VIO                 14
 262 #define RES_VDD1                15
 263 #define RES_VDD2                16
 264 #define RES_VUSB_1V5            17
 265 #define RES_VUSB_1V8            18
 266 #define RES_VUSB_3V1            19
 267 #define RES_VUSBCP              20
 268 #define RES_REGEN               21
 269 #define RES_NRES_PWRON          22
 270 #define RES_CLKEN               23
 271 #define RES_SYSEN               24
 272 #define RES_HFCLKOUT            25
 273 #define RES_32KCLKOUT           26
 274 #define RES_RESET               27
 275 #define RES_Main_Ref            28
 276
 277 /*
 278  * Power Bus Message Format ... these can be sent individually by Linux,
 279  * but are usually part of downloaded scripts that are run when various
 280  * power events are triggered.
 281  *
 282  *  Broadcast Message (16 Bits):
 283  *    DEV_GRP[15:13] MT[12]  RES_GRP[11:9]  RES_TYPE2[8:7] RES_TYPE[6:4]
 284  *    RES_STATE[3:0]
 285  *
 286  *  Singular Message (16 Bits):
 287  *    DEV_GRP[15:13] MT[12]  RES_ID[11:4]  RES_STATE[3:0]
 288  */
 289
 290 #define MSG_BROADCAST(devgrp, grp, type, type2, state) \
 291         ( (devgrp) << 13 | 1 << 12 | (grp) << 9 | (type2) << 7 \
 292         | (type) << 4 | (state))
 293
 294 #define MSG_SINGULAR(devgrp, id, state) \
 295         ((devgrp) << 13 | 0 << 12 | (id) << 4 | (state))
 296
 297 /*----------------------------------------------------------------------*/
 298
 299 struct twl4030_bci_platform_data {
 300         int *battery_tmp_tbl;
 301         unsigned int tblsize;
 302 };
 303
 304 /* TWL4030_GPIO_MAX (18) GPIOs, with interrupts */
 305 struct twl4030_gpio_platform_data {
 306         int             gpio_base;
 307         unsigned        irq_base, irq_end;
 308
 309         /* package the two LED signals as output-only GPIOs? */
 310         bool            use_leds;
 311
 312         /* gpio-n should control VMMC(n+1) if BIT(n) in mmc_cd is set */
 313         u8              mmc_cd;
 314
 315         /* if BIT(N) is set, or VMMC(n+1) is linked, debounce GPIO-N */
 316         u32             debounce;
 317
 318         /* For gpio-N, bit (1 << N) in "pullups" is set if that pullup
 319          * should be enabled.  Else, if that bit is set in "pulldowns",
 320          * that pulldown is enabled.  Don't waste power by letting any
 321          * digital inputs float...
 322          */
 323         u32             pullups;
 324         u32             pulldowns;
 325
 326         int             (*setup)(struct device *dev,
 327                                 unsigned gpio, unsigned ngpio);
 328         int             (*teardown)(struct device *dev,
 329                                 unsigned gpio, unsigned ngpio);
 330 };
 331
 332 struct twl4030_madc_platform_data {
 333         int             irq_line;
 334 };
 335
 336 /* Boards have uniqe mappings of {col, row} --> keycode.
 337  * Column and row are 4 bits, but range only from 0..7;
 338  * a PERSISTENT_KEY is "always on" and never reported.
 339  */
 340 #define KEY_PERSISTENT          0x00800000
 341 #define KEY(col, row, keycode)  (((col) << 28) | ((row) << 24) | (keycode))
 342 #define PERSISTENT_KEY(c, r)    KEY(c, r, KEY_PERSISTENT)
 343
 344 struct twl4030_keypad_data {
 345         unsigned rows;
 346         unsigned cols;
 347         unsigned *keymap;
 348         unsigned short keymapsize;
 349         unsigned int rep:1;
 350 };
 351
 352 enum twl4030_usb_mode {
 353         T2_USB_MODE_ULPI = 1,
 354         T2_USB_MODE_CEA2011_3PIN = 2,
 355 };
 356
 357 struct twl4030_usb_data {
 358         enum twl4030_usb_mode   usb_mode;
 359 };
 360
 361 struct twl4030_ins {
 362         u16 pmb_message;
 363         u8 delay;
 364 };
 365
 366 struct twl4030_script {
 367         struct twl4030_ins *script;
 368         unsigned size;
 369         u8 flags;
 370 #define TRITON_WRST_SCRIPT      (1<<0)
 371 #define TRITON_WAKEUP12_SCRIPT  (1<<1)
 372 #define TRITON_WAKEUP3_SCRIPT   (1<<2)
 373 #define TRITON_SLEEP_SCRIPT     (1<<3)
 374 };
 375
 376 struct twl4030_resconfig {
 377         u8 resource;
 378         u8 devgroup;
 379         u8 type;
 380         u8 type2;
 381 };
 382
 383 struct twl4030_power_data {
 384         struct twl4030_script **scripts;
 385         unsigned size;
 386         const struct twl4030_resconfig *resource_config;
 387 };
 388
 389 struct twl4030_platform_data {
 390         unsigned                                irq_base, irq_end;
 391         struct twl4030_bci_platform_data        *bci;
 392         struct twl4030_gpio_platform_data       *gpio;
 393         struct twl4030_madc_platform_data       *madc;
 394         struct twl4030_keypad_data              *keypad;
 395         struct twl4030_usb_data                 *usb;
 396         struct twl4030_power_data               *power;
 397
 398         /* LDO regulators */
 399         struct regulator_init_data              *vdac;
 400         struct regulator_init_data              *vpll1;
 401         struct regulator_init_data              *vpll2;
 402         struct regulator_init_data              *vmmc1;
 403         struct regulator_init_data              *vmmc2;
 404         struct regulator_init_data              *vsim;
 405         struct regulator_init_data              *vaux1;
 406         struct regulator_init_data              *vaux2;
 407         struct regulator_init_data              *vaux3;
 408         struct regulator_init_data              *vaux4;
 409
 410         /* REVISIT more to come ... _nothing_ should be hard-wired */
 411 };
 412
 413 /*----------------------------------------------------------------------*/
 414
 415 int twl4030_sih_setup(int module);
 416
 417 /* Offsets to Power Registers */
 418 #define TWL4030_VDAC_DEV_GRP            0x3B
 419 #define TWL4030_VDAC_DEDICATED          0x3E
 420 #define TWL4030_VAUX1_DEV_GRP           0x17
 421 #define TWL4030_VAUX1_DEDICATED         0x1A
 422 #define TWL4030_VAUX2_DEV_GRP           0x1B
 423 #define TWL4030_VAUX2_DEDICATED         0x1E
 424 #define TWL4030_VAUX3_DEV_GRP           0x1F
 425 #define TWL4030_VAUX3_DEDICATED         0x22
 426
 427 #if defined(CONFIG_TWL4030_BCI_BATTERY) || \
 428         defined(CONFIG_TWL4030_BCI_BATTERY_MODULE)
 429         extern int twl4030charger_usb_en(int enable);
 430 #else
 431         static inline int twl4030charger_usb_en(int enable) { return 0; }
 432 #endif
 433
 434 /*----------------------------------------------------------------------*/
 435
 436 /* Linux-specific regulator identifiers ... for now, we only support
 437  * the LDOs, and leave the three buck converters alone.  VDD1 and VDD2
 438  * need to tie into hardware based voltage scaling (cpufreq etc), while
 439  * VIO is generally fixed.
 440  */
 441
 442 /* EXTERNAL dc-to-dc buck converters */
 443 #define TWL4030_REG_VDD1        0
 444 #define TWL4030_REG_VDD2        1
 445 #define TWL4030_REG_VIO         2
 446
 447 /* EXTERNAL LDOs */
 448 #define TWL4030_REG_VDAC        3
 449 #define TWL4030_REG_VPLL1       4
 450 #define TWL4030_REG_VPLL2       5       /* not on all chips */
 451 #define TWL4030_REG_VMMC1       6
 452 #define TWL4030_REG_VMMC2       7       /* not on all chips */
 453 #define TWL4030_REG_VSIM        8       /* not on all chips */
 454 #define TWL4030_REG_VAUX1       9       /* not on all chips */
 455 #define TWL4030_REG_VAUX2_4030  10      /* (twl4030-specific) */
 456 #define TWL4030_REG_VAUX2       11      /* (twl5030 and newer) */
 457 #define TWL4030_REG_VAUX3       12      /* not on all chips */
 458 #define TWL4030_REG_VAUX4       13      /* not on all chips */
 459
 460 /* INTERNAL LDOs */
 461 #define TWL4030_REG_VINTANA1    14
 462 #define TWL4030_REG_VINTANA2    15
 463 #define TWL4030_REG_VINTDIG     16
 464 #define TWL4030_REG_VUSB1V5     17
 465 #define TWL4030_REG_VUSB1V8     18
 466 #define TWL4030_REG_VUSB3V1     19
 467
 468 #endif /* End of __TWL4030_H */