drivers/mfd/twl-core.c

   1 /*
   2  * twl_core.c - driver for TWL4030/TWL5030/TWL60X0/TPS659x0 PM
   3  * and audio CODEC devices
   4  *
   5  * Copyright (C) 2005-2006 Texas Instruments, Inc.
   6  *
   7  * Modifications to defer interrupt handling to a kernel thread:
   8  * Copyright (C) 2006 MontaVista Software, Inc.
   9  *
  10  * Based on tlv320aic23.c:
  11  * Copyright (c) by Kai Svahn <kai.svahn@nokia.com>
  12  *
  13  * Code cleanup and modifications to IRQ handler.
  14  * by syed khasim <x0khasim@ti.com>
  15  *
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 2 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  29  */
  30
  31 #include <linux/init.h>
  32 #include <linux/mutex.h>
  33 #include <linux/platform_device.h>
  34 #include <linux/clk.h>
  35 #include <linux/err.h>
  36
  37 #include <linux/regulator/machine.h>
  38
  39 #include <linux/i2c.h>
  40 #include <linux/i2c/twl.h>
  41
  42 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
  43 #include <plat/cpu.h>
  44 #endif
  45
  46 /*
  47  * The TWL4030 "Triton 2" is one of a family of a multi-function "Power
  48  * Management and System Companion Device" chips originally designed for
  49  * use in OMAP2 and OMAP 3 based systems.  Its control interfaces use I2C,
  50  * often at around 3 Mbit/sec, including for interrupt handling.
  51  *
  52  * This driver core provides genirq support for the interrupts emitted,
  53  * by the various modules, and exports register access primitives.
  54  *
  55  * FIXME this driver currently requires use of the first interrupt line
  56  * (and associated registers).
  57  */
  58
  59 #define DRIVER_NAME                     "twl"
  60
  61 #if defined(CONFIG_KEYBOARD_TWL4030) || defined(CONFIG_KEYBOARD_TWL4030_MODULE)
  62 #define twl_has_keypad()        true
  63 #else
  64 #define twl_has_keypad()        false
  65 #endif
  66
  67 #if defined(CONFIG_GPIO_TWL4030) || defined(CONFIG_GPIO_TWL4030_MODULE)
  68 #define twl_has_gpio()  true
  69 #else
  70 #define twl_has_gpio()  false
  71 #endif
  72
  73 #if defined(CONFIG_REGULATOR_TWL4030) \
  74         || defined(CONFIG_REGULATOR_TWL4030_MODULE)
  75 #define twl_has_regulator()     true
  76 #else
  77 #define twl_has_regulator()     false
  78 #endif
  79
  80 #if defined(CONFIG_TWL4030_MADC) || defined(CONFIG_TWL4030_MADC_MODULE)
  81 #define twl_has_madc()  true
  82 #else
  83 #define twl_has_madc()  false
  84 #endif
  85
  86 #ifdef CONFIG_TWL4030_POWER
  87 #define twl_has_power()        true
  88 #else
  89 #define twl_has_power()        false
  90 #endif
  91
  92 #if defined(CONFIG_RTC_DRV_TWL4030) || defined(CONFIG_RTC_DRV_TWL4030_MODULE)
  93 #define twl_has_rtc()   true
  94 #else
  95 #define twl_has_rtc()   false
  96 #endif
  97
  98 #if defined(CONFIG_TWL4030_USB) || defined(CONFIG_TWL4030_USB_MODULE)
  99 #define twl_has_usb()   true
 100 #else
 101 #define twl_has_usb()   false
 102 #endif
 103
 104 #if defined(CONFIG_TWL4030_WATCHDOG) || \
 105         defined(CONFIG_TWL4030_WATCHDOG_MODULE)
 106 #define twl_has_watchdog()        true
 107 #else
 108 #define twl_has_watchdog()        false
 109 #endif
 110
 111 #if defined(CONFIG_TWL4030_CODEC) || defined(CONFIG_TWL4030_CODEC_MODULE) ||\
 112         defined(CONFIG_SND_SOC_TWL6040) || defined(CONFIG_SND_SOC_TWL6040_MODULE)
 113 #define twl_has_codec() true
 114 #else
 115 #define twl_has_codec() false
 116 #endif
 117
 118 /* Triton Core internal information (BEGIN) */
 119
 120 /* Last - for index max*/
 121 #define TWL4030_MODULE_LAST             TWL4030_MODULE_SECURED_REG
 122
 123 #define TWL_NUM_SLAVES          4
 124
 125 #if defined(CONFIG_INPUT_TWL4030_PWRBUTTON) \
 126         || defined(CONFIG_INPUT_TWL4030_PWRBUTTON_MODULE)
 127 #define twl_has_pwrbutton()     true
 128 #else
 129 #define twl_has_pwrbutton()     false
 130 #endif
 131
 132 #define SUB_CHIP_ID0 0
 133 #define SUB_CHIP_ID1 1
 134 #define SUB_CHIP_ID2 2
 135 #define SUB_CHIP_ID3 3
 136
 137 #define TWL_MODULE_LAST TWL4030_MODULE_LAST
 138
 139 /* Base Address defns for twl4030_map[] */
 140
 141 /* subchip/slave 0 - USB ID */
 142 #define TWL4030_BASEADD_USB             0x0000
 143
 144 /* subchip/slave 1 - AUD ID */
 145 #define TWL4030_BASEADD_AUDIO_VOICE     0x0000
 146 #define TWL4030_BASEADD_GPIO            0x0098
 147 #define TWL4030_BASEADD_INTBR           0x0085
 148 #define TWL4030_BASEADD_PIH             0x0080
 149 #define TWL4030_BASEADD_TEST            0x004C
 150
 151 /* subchip/slave 2 - AUX ID */
 152 #define TWL4030_BASEADD_INTERRUPTS      0x00B9
 153 #define TWL4030_BASEADD_LED             0x00EE
 154 #define TWL4030_BASEADD_MADC            0x0000
 155 #define TWL4030_BASEADD_MAIN_CHARGE     0x0074
 156 #define TWL4030_BASEADD_PRECHARGE       0x00AA
 157 #define TWL4030_BASEADD_PWM0            0x00F8
 158 #define TWL4030_BASEADD_PWM1            0x00FB
 159 #define TWL4030_BASEADD_PWMA            0x00EF
 160 #define TWL4030_BASEADD_PWMB            0x00F1
 161 #define TWL4030_BASEADD_KEYPAD          0x00D2
 162
 163 #define TWL5031_BASEADD_ACCESSORY       0x0074 /* Replaces Main Charge */
 164 #define TWL5031_BASEADD_INTERRUPTS      0x00B9 /* Different than TWL4030's
 165                                                   one */
 166
 167 /* subchip/slave 3 - POWER ID */
 168 #define TWL4030_BASEADD_BACKUP          0x0014
 169 #define TWL4030_BASEADD_INT             0x002E
 170 #define TWL4030_BASEADD_PM_MASTER       0x0036
 171 #define TWL4030_BASEADD_PM_RECEIVER     0x005B
 172 #define TWL4030_BASEADD_RTC             0x001C
 173 #define TWL4030_BASEADD_SECURED_REG     0x0000
 174
 175 /* Triton Core internal information (END) */
 176
 177
 178 /* subchip/slave 0 0x48 - POWER */
 179 #define TWL6030_BASEADD_RTC             0x0000
 180 #define TWL6030_BASEADD_MEM             0x0017
 181 #define TWL6030_BASEADD_PM_MASTER       0x001F
 182 #define TWL6030_BASEADD_PM_SLAVE_MISC   0x0030 /* PM_RECEIVER */
 183 #define TWL6030_BASEADD_PM_MISC         0x00E2
 184 #define TWL6030_BASEADD_PM_PUPD         0x00F0
 185
 186 /* subchip/slave 1 0x49 - FEATURE */
 187 #define TWL6030_BASEADD_USB             0x0000
 188 #define TWL6030_BASEADD_GPADC_CTRL      0x002E
 189 #define TWL6030_BASEADD_AUX             0x0090
 190 #define TWL6030_BASEADD_PWM             0x00BA
 191 #define TWL6030_BASEADD_GASGAUGE        0x00C0
 192 #define TWL6030_BASEADD_PIH             0x00D0
 193 #define TWL6030_BASEADD_CHARGER         0x00E0
 194
 195 /* subchip/slave 2 0x4A - DFT */
 196 #define TWL6030_BASEADD_DIEID           0x00C0
 197
 198 /* subchip/slave 3 0x4B - AUDIO */
 199 #define TWL6030_BASEADD_AUDIO           0x0000
 200 #define TWL6030_BASEADD_RSV             0x0000
 201 #define TWL6030_BASEADD_ZERO            0x0000
 202
 203 /* Few power values */
 204 #define R_CFG_BOOT                      0x05
 205 #define R_PROTECT_KEY                   0x0E
 206
 207 /* access control values for R_PROTECT_KEY */
 208 #define KEY_UNLOCK1                     0xce
 209 #define KEY_UNLOCK2                     0xec
 210 #define KEY_LOCK                        0x00
 211
 212 /* some fields in R_CFG_BOOT */
 213 #define HFCLK_FREQ_19p2_MHZ             (1 << 0)
 214 #define HFCLK_FREQ_26_MHZ               (2 << 0)
 215 #define HFCLK_FREQ_38p4_MHZ             (3 << 0)
 216 #define HIGH_PERF_SQ                    (1 << 3)
 217 #define CK32K_LOWPWR_EN                 (1 << 7)
 218
 219
 220 /* chip-specific feature flags, for i2c_device_id.driver_data */
 221 #define TWL4030_VAUX2           BIT(0)  /* pre-5030 voltage ranges */
 222 #define TPS_SUBSET              BIT(1)  /* tps659[23]0 have fewer LDOs */
 223 #define TWL5031                 BIT(2)  /* twl5031 has different registers */
 224 #define TWL6030_CLASS           BIT(3)  /* TWL6030 class */
 225
 226 /*----------------------------------------------------------------------*/
 227
 228 /* is driver active, bound to a chip? */
 229 static bool inuse;
 230
 231 static unsigned int twl_id;
 232 unsigned int twl_rev(void)
 233 {
 234         return twl_id;
 235 }
 236 EXPORT_SYMBOL(twl_rev);
 237
 238 /* Structure for each TWL4030/TWL6030 Slave */
 239 struct twl_client {
 240         struct i2c_client *client;
 241         u8 address;
 242
 243         /* max numb of i2c_msg required is for read =2 */
 244         struct i2c_msg xfer_msg[2];
 245
 246         /* To lock access to xfer_msg */
 247         struct mutex xfer_lock;
 248 };
 249
 250 static struct twl_client twl_modules[TWL_NUM_SLAVES];
 251
 252
 253 /* mapping the module id to slave id and base address */
 254 struct twl_mapping {
 255         unsigned char sid;      /* Slave ID */
 256         unsigned char base;     /* base address */
 257 };
 258 struct twl_mapping *twl_map;
 259
 260 static struct twl_mapping twl4030_map[TWL4030_MODULE_LAST + 1] = {
 261         /*
 262          * NOTE:  don't change this table without updating the
 263          * <linux/i2c/twl.h> defines for TWL4030_MODULE_*
 264          * so they continue to match the order in this table.
 265          */
 266
 267         { 0, TWL4030_BASEADD_USB },
 268
 269         { 1, TWL4030_BASEADD_AUDIO_VOICE },
 270         { 1, TWL4030_BASEADD_GPIO },
 271         { 1, TWL4030_BASEADD_INTBR },
 272         { 1, TWL4030_BASEADD_PIH },
 273         { 1, TWL4030_BASEADD_TEST },
 274
 275         { 2, TWL4030_BASEADD_KEYPAD },
 276         { 2, TWL4030_BASEADD_MADC },
 277         { 2, TWL4030_BASEADD_INTERRUPTS },
 278         { 2, TWL4030_BASEADD_LED },
 279         { 2, TWL4030_BASEADD_MAIN_CHARGE },
 280         { 2, TWL4030_BASEADD_PRECHARGE },
 281         { 2, TWL4030_BASEADD_PWM0 },
 282         { 2, TWL4030_BASEADD_PWM1 },
 283         { 2, TWL4030_BASEADD_PWMA },
 284         { 2, TWL4030_BASEADD_PWMB },
 285         { 2, TWL5031_BASEADD_ACCESSORY },
 286         { 2, TWL5031_BASEADD_INTERRUPTS },
 287
 288         { 3, TWL4030_BASEADD_BACKUP },
 289         { 3, TWL4030_BASEADD_INT },
 290         { 3, TWL4030_BASEADD_PM_MASTER },
 291         { 3, TWL4030_BASEADD_PM_RECEIVER },
 292         { 3, TWL4030_BASEADD_RTC },
 293         { 3, TWL4030_BASEADD_SECURED_REG },
 294 };
 295
 296 static struct twl_mapping twl6030_map[] = {
 297         /*
 298          * NOTE:  don't change this table without updating the
 299          * <linux/i2c/twl.h> defines for TWL4030_MODULE_*
 300          * so they continue to match the order in this table.
 301          */
 302         { SUB_CHIP_ID1, TWL6030_BASEADD_USB },
 303         { SUB_CHIP_ID3, TWL6030_BASEADD_AUDIO },
 304         { SUB_CHIP_ID2, TWL6030_BASEADD_DIEID },
 305         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 306         { SUB_CHIP_ID1, TWL6030_BASEADD_PIH },
 307
 308         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 309         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 310         { SUB_CHIP_ID1, TWL6030_BASEADD_GPADC_CTRL },
 311         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 312         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 313
 314         { SUB_CHIP_ID1, TWL6030_BASEADD_CHARGER },
 315         { SUB_CHIP_ID1, TWL6030_BASEADD_GASGAUGE },
 316         { SUB_CHIP_ID1, TWL6030_BASEADD_PWM },
 317         { SUB_CHIP_ID0, TWL6030_BASEADD_ZERO },
 318         { SUB_CHIP_ID1, TWL6030_BASEADD_ZERO },
 319
 320         { SUB_CHIP_ID2, TWL6030_BASEADD_ZERO },
 321         { SUB_CHIP_ID2, TWL6030_BASEADD_ZERO },
 322         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 323         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 324         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 325         { SUB_CHIP_ID0, TWL6030_BASEADD_PM_MASTER },
 326         { SUB_CHIP_ID0, TWL6030_BASEADD_PM_SLAVE_MISC },
 327
 328         { SUB_CHIP_ID0, TWL6030_BASEADD_RTC },
 329         { SUB_CHIP_ID0, TWL6030_BASEADD_MEM },
 330 };
 331
 332 /*----------------------------------------------------------------------*/
 333
 334 /* Exported Functions */
 335
 336 /**
 337  * twl_i2c_write - Writes a n bit register in TWL4030/TWL5030/TWL60X0
 338  * @mod_no: module number
 339  * @value: an array of num_bytes+1 containing data to write
 340  * @reg: register address (just offset will do)
 341  * @num_bytes: number of bytes to transfer
 342  *
 343  * IMPORTANT: for 'value' parameter: Allocate value num_bytes+1 and
 344  * valid data starts at Offset 1.
 345  *
 346  * Returns the result of operation - 0 is success
 347  */
 348 int twl_i2c_write(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes)
 349 {
 350         int ret;
 351         int sid;
 352         struct twl_client *twl;
 353         struct i2c_msg *msg;
 354
 355         if (unlikely(mod_no > TWL_MODULE_LAST)) {
 356                 pr_err("%s: invalid module number %d\n", DRIVER_NAME, mod_no);
 357                 return -EPERM;
 358         }
 359         sid = twl_map[mod_no].sid;
 360         twl = &twl_modules[sid];
 361
 362         if (unlikely(!inuse)) {
 363                 pr_err("%s: client %d is not initialized\n", DRIVER_NAME, sid);
 364                 return -EPERM;
 365         }
 366         mutex_lock(&twl->xfer_lock);
 367         /*
 368          * [MSG1]: fill the register address data
 369          * fill the data Tx buffer
 370          */
 371         msg = &twl->xfer_msg[0];
 372         msg->addr = twl->address;
 373         msg->len = num_bytes + 1;
 374         msg->flags = 0;
 375         msg->buf = value;
 376         /* over write the first byte of buffer with the register address */
 377         *value = twl_map[mod_no].base + reg;
 378         ret = i2c_transfer(twl->client->adapter, twl->xfer_msg, 1);
 379         mutex_unlock(&twl->xfer_lock);
 380
 381         /* i2c_transfer returns number of messages transferred */
 382         if (ret != 1) {
 383                 pr_err("%s: i2c_write failed to transfer all messages\n",
 384                         DRIVER_NAME);
 385                 if (ret < 0)
 386                         return ret;
 387                 else
 388                         return -EIO;
 389         } else {
 390                 return 0;
 391         }
 392 }
 393 EXPORT_SYMBOL(twl_i2c_write);
 394
 395 /**
 396  * twl_i2c_read - Reads a n bit register in TWL4030/TWL5030/TWL60X0
 397  * @mod_no: module number
 398  * @value: an array of num_bytes containing data to be read
 399  * @reg: register address (just offset will do)
 400  * @num_bytes: number of bytes to transfer
 401  *
 402  * Returns result of operation - num_bytes is success else failure.
 403  */
 404 int twl_i2c_read(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes)
 405 {
 406         int ret;
 407         u8 val;
 408         int sid;
 409         struct twl_client *twl;
 410         struct i2c_msg *msg;
 411
 412         if (unlikely(mod_no > TWL_MODULE_LAST)) {
 413                 pr_err("%s: invalid module number %d\n", DRIVER_NAME, mod_no);
 414                 return -EPERM;
 415         }
 416         sid = twl_map[mod_no].sid;
 417         twl = &twl_modules[sid];
 418
 419         if (unlikely(!inuse)) {
 420                 pr_err("%s: client %d is not initialized\n", DRIVER_NAME, sid);
 421                 return -EPERM;
 422         }
 423         mutex_lock(&twl->xfer_lock);
 424         /* [MSG1] fill the register address data */
 425         msg = &twl->xfer_msg[0];
 426         msg->addr = twl->address;
 427         msg->len = 1;
 428         msg->flags = 0; /* Read the register value */
 429         val = twl_map[mod_no].base + reg;
 430         msg->buf = &val;
 431         /* [MSG2] fill the data rx buffer */
 432         msg = &twl->xfer_msg[1];
 433         msg->addr = twl->address;
 434         msg->flags = I2C_M_RD;  /* Read the register value */
 435         msg->len = num_bytes;   /* only n bytes */
 436         msg->buf = value;
 437         ret = i2c_transfer(twl->client->adapter, twl->xfer_msg, 2);
 438         mutex_unlock(&twl->xfer_lock);
 439
 440         /* i2c_transfer returns number of messages transferred */
 441         if (ret != 2) {
 442                 pr_err("%s: i2c_read failed to transfer all messages\n",
 443                         DRIVER_NAME);
 444                 if (ret < 0)
 445                         return ret;
 446                 else
 447                         return -EIO;
 448         } else {
 449                 return 0;
 450         }
 451 }
 452 EXPORT_SYMBOL(twl_i2c_read);
 453
 454 /**
 455  * twl_i2c_write_u8 - Writes a 8 bit register in TWL4030/TWL5030/TWL60X0
 456  * @mod_no: module number
 457  * @value: the value to be written 8 bit
 458  * @reg: register address (just offset will do)
 459  *
 460  * Returns result of operation - 0 is success
 461  */
 462 int twl_i2c_write_u8(u8 mod_no, u8 value, u8 reg)
 463 {
 464
 465         /* 2 bytes offset 1 contains the data offset 0 is used by i2c_write */
 466         u8 temp_buffer[2] = { 0 };
 467         /* offset 1 contains the data */
 468         temp_buffer[1] = value;
 469         return twl_i2c_write(mod_no, temp_buffer, reg, 1);
 470 }
 471 EXPORT_SYMBOL(twl_i2c_write_u8);
 472
 473 /**
 474  * twl_i2c_read_u8 - Reads a 8 bit register from TWL4030/TWL5030/TWL60X0
 475  * @mod_no: module number
 476  * @value: the value read 8 bit
 477  * @reg: register address (just offset will do)
 478  *
 479  * Returns result of operation - 0 is success
 480  */
 481 int twl_i2c_read_u8(u8 mod_no, u8 *value, u8 reg)
 482 {
 483         return twl_i2c_read(mod_no, value, reg, 1);
 484 }
 485 EXPORT_SYMBOL(twl_i2c_read_u8);
 486
 487 /*----------------------------------------------------------------------*/
 488
 489 static struct device *
 490 add_numbered_child(unsigned chip, const char *name, int num,
 491                 void *pdata, unsigned pdata_len,
 492                 bool can_wakeup, int irq0, int irq1)
 493 {
 494         struct platform_device  *pdev;
 495         struct twl_client       *twl = &twl_modules[chip];
 496         int                     status;
 497
 498         pdev = platform_device_alloc(name, num);
 499         if (!pdev) {
 500                 dev_dbg(&twl->client->dev, "can't alloc dev\n");
 501                 status = -ENOMEM;
 502                 goto err;
 503         }
 504
 505         device_init_wakeup(&pdev->dev, can_wakeup);
 506         pdev->dev.parent = &twl->client->dev;
 507
 508         if (pdata) {
 509                 status = platform_device_add_data(pdev, pdata, pdata_len);
 510                 if (status < 0) {
 511                         dev_dbg(&pdev->dev, "can't add platform_data\n");
 512                         goto err;
 513                 }
 514         }
 515
 516         if (irq0) {
 517                 struct resource r[2] = {
 518                         { .start = irq0, .flags = IORESOURCE_IRQ, },
 519                         { .start = irq1, .flags = IORESOURCE_IRQ, },
 520                 };
 521
 522                 status = platform_device_add_resources(pdev, r, irq1 ? 2 : 1);
 523                 if (status < 0) {
 524                         dev_dbg(&pdev->dev, "can't add irqs\n");
 525                         goto err;
 526                 }
 527         }
 528
 529         status = platform_device_add(pdev);
 530
 531 err:
 532         if (status < 0) {
 533                 platform_device_put(pdev);
 534                 dev_err(&twl->client->dev, "can't add %s dev\n", name);
 535                 return ERR_PTR(status);
 536         }
 537         return &pdev->dev;
 538 }
 539
 540 static inline struct device *add_child(unsigned chip, const char *name,
 541                 void *pdata, unsigned pdata_len,
 542                 bool can_wakeup, int irq0, int irq1)
 543 {
 544         return add_numbered_child(chip, name, -1, pdata, pdata_len,
 545                 can_wakeup, irq0, irq1);
 546 }
 547
 548 static struct device *
 549 add_regulator_linked(int num, struct regulator_init_data *pdata,
 550                 struct regulator_consumer_supply *consumers,
 551                 unsigned num_consumers)
 552 {
 553         unsigned sub_chip_id;
 554         /* regulator framework demands init_data ... */
 555         if (!pdata)
 556                 return NULL;
 557
 558         if (consumers) {
 559                 pdata->consumer_supplies = consumers;
 560                 pdata->num_consumer_supplies = num_consumers;
 561         }
 562
 563         /* NOTE:  we currently ignore regulator IRQs, e.g. for short circuits */
 564         sub_chip_id = twl_map[TWL_MODULE_PM_MASTER].sid;
 565         return add_numbered_child(sub_chip_id, "twl_reg", num,
 566                 pdata, sizeof(*pdata), false, 0, 0);
 567 }
 568
 569 static struct device *
 570 add_regulator(int num, struct regulator_init_data *pdata)
 571 {
 572         return add_regulator_linked(num, pdata, NULL, 0);
 573 }
 574
 575 /*
 576  * NOTE:  We know the first 8 IRQs after pdata->base_irq are
 577  * for the PIH, and the next are for the PWR_INT SIH, since
 578  * that's how twl_init_irq() sets things up.
 579  */
 580
 581 static int
 582 add_children(struct twl4030_platform_data *pdata, unsigned long features)
 583 {
 584         struct device   *child;
 585         unsigned sub_chip_id;
 586
 587         if (twl_has_gpio() && pdata->gpio) {
 588                 child = add_child(SUB_CHIP_ID1, "twl4030_gpio",
 589                                 pdata->gpio, sizeof(*pdata->gpio),
 590                                 false, pdata->irq_base + GPIO_INTR_OFFSET, 0);
 591                 if (IS_ERR(child))
 592                         return PTR_ERR(child);
 593         }
 594
 595         if (twl_has_keypad() && pdata->keypad) {
 596                 child = add_child(SUB_CHIP_ID2, "twl4030_keypad",
 597                                 pdata->keypad, sizeof(*pdata->keypad),
 598                                 true, pdata->irq_base + KEYPAD_INTR_OFFSET, 0);
 599                 if (IS_ERR(child))
 600                         return PTR_ERR(child);
 601         }
 602
 603         if (twl_has_madc() && pdata->madc) {
 604                 child = add_child(2, "twl4030_madc",
 605                                 pdata->madc, sizeof(*pdata->madc),
 606                                 true, pdata->irq_base + MADC_INTR_OFFSET, 0);
 607                 if (IS_ERR(child))
 608                         return PTR_ERR(child);
 609         }
 610
 611         if (twl_has_rtc()) {
 612                 /*
 613                  * REVISIT platform_data here currently might expose the
 614                  * "msecure" line ... but for now we just expect board
 615                  * setup to tell the chip "it's always ok to SET_TIME".
 616                  * Eventually, Linux might become more aware of such
 617                  * HW security concerns, and "least privilege".
 618                  */
 619                 sub_chip_id = twl_map[TWL_MODULE_RTC].sid;
 620                 child = add_child(sub_chip_id, "twl_rtc",
 621                                 NULL, 0,
 622                                 true, pdata->irq_base + RTC_INTR_OFFSET, 0);
 623                 if (IS_ERR(child))
 624                         return PTR_ERR(child);
 625         }
 626
 627         if (twl_has_usb() && pdata->usb && twl_class_is_4030()) {
 628
 629                 static struct regulator_consumer_supply usb1v5 = {
 630                         .supply =       "usb1v5",
 631                 };
 632                 static struct regulator_consumer_supply usb1v8 = {
 633                         .supply =       "usb1v8",
 634                 };
 635                 static struct regulator_consumer_supply usb3v1 = {
 636                         .supply =       "usb3v1",
 637                 };
 638
 639         /* First add the regulators so that they can be used by transceiver */
 640                 if (twl_has_regulator()) {
 641                         /* this is a template that gets copied */
 642                         struct regulator_init_data usb_fixed = {
 643                                 .constraints.valid_modes_mask =
 644                                         REGULATOR_MODE_NORMAL
 645                                         | REGULATOR_MODE_STANDBY,
 646                                 .constraints.valid_ops_mask =
 647                                         REGULATOR_CHANGE_MODE
 648                                         | REGULATOR_CHANGE_STATUS,
 649                         };
 650
 651                         child = add_regulator_linked(TWL4030_REG_VUSB1V5,
 652                                                       &usb_fixed, &usb1v5, 1);
 653                         if (IS_ERR(child))
 654                                 return PTR_ERR(child);
 655
 656                         child = add_regulator_linked(TWL4030_REG_VUSB1V8,
 657                                                       &usb_fixed, &usb1v8, 1);
 658                         if (IS_ERR(child))
 659                                 return PTR_ERR(child);
 660
 661                         child = add_regulator_linked(TWL4030_REG_VUSB3V1,
 662                                                       &usb_fixed, &usb3v1, 1);
 663                         if (IS_ERR(child))
 664                                 return PTR_ERR(child);
 665
 666                 }
 667
 668                 child = add_child(0, "twl4030_usb",
 669                                 pdata->usb, sizeof(*pdata->usb),
 670                                 true,
 671                                 /* irq0 = USB_PRES, irq1 = USB */
 672                                 pdata->irq_base + USB_PRES_INTR_OFFSET,
 673                                 pdata->irq_base + USB_INTR_OFFSET);
 674
 675                 if (IS_ERR(child))
 676                         return PTR_ERR(child);
 677
 678                 /* we need to connect regulators to this transceiver */
 679                 if (twl_has_regulator() && child) {
 680                         usb1v5.dev = child;
 681                         usb1v8.dev = child;
 682                         usb3v1.dev = child;
 683                 }
 684         }
 685
 686         if (twl_has_watchdog()) {
 687                 child = add_child(0, "twl4030_wdt", NULL, 0, false, 0, 0);
 688                 if (IS_ERR(child))
 689                         return PTR_ERR(child);
 690         }
 691
 692         if (twl_has_pwrbutton()) {
 693                 child = add_child(1, "twl4030_pwrbutton",
 694                                 NULL, 0, true, pdata->irq_base + 8 + 0, 0);
 695                 if (IS_ERR(child))
 696                         return PTR_ERR(child);
 697         }
 698
 699         if (twl_has_codec() && pdata->codec && twl_class_is_4030()) {
 700                 sub_chip_id = twl_map[TWL_MODULE_AUDIO_VOICE].sid;
 701                 child = add_child(sub_chip_id, "twl4030-audio",
 702                                 pdata->codec, sizeof(*pdata->codec),
 703                                 false, 0, 0);
 704                 if (IS_ERR(child))
 705                         return PTR_ERR(child);
 706         }
 707
 708         /* Phoenix codec driver is probed directly atm */
 709         if (twl_has_codec() && pdata->codec && twl_class_is_6030()) {
 710                 sub_chip_id = twl_map[TWL_MODULE_AUDIO_VOICE].sid;
 711                 child = add_child(sub_chip_id, "twl6040-codec",
 712                                 pdata->codec, sizeof(*pdata->codec),
 713                                 false, 0, 0);
 714                 if (IS_ERR(child))
 715                         return PTR_ERR(child);
 716         }
 717
 718         /* twl4030 regulators */
 719         if (twl_has_regulator() && twl_class_is_4030()) {
 720                 child = add_regulator(TWL4030_REG_VPLL1, pdata->vpll1);
 721                 if (IS_ERR(child))
 722                         return PTR_ERR(child);
 723
 724                 child = add_regulator(TWL4030_REG_VIO, pdata->vio);
 725                 if (IS_ERR(child))
 726                         return PTR_ERR(child);
 727
 728                 child = add_regulator(TWL4030_REG_VDD1, pdata->vdd1);
 729                 if (IS_ERR(child))
 730                         return PTR_ERR(child);
 731
 732                 child = add_regulator(TWL4030_REG_VDD2, pdata->vdd2);
 733                 if (IS_ERR(child))
 734                         return PTR_ERR(child);
 735
 736                 child = add_regulator(TWL4030_REG_VMMC1, pdata->vmmc1);
 737                 if (IS_ERR(child))
 738                         return PTR_ERR(child);
 739
 740                 child = add_regulator(TWL4030_REG_VDAC, pdata->vdac);
 741                 if (IS_ERR(child))
 742                         return PTR_ERR(child);
 743
 744                 child = add_regulator((features & TWL4030_VAUX2)
 745                                         ? TWL4030_REG_VAUX2_4030
 746                                         : TWL4030_REG_VAUX2,
 747                                 pdata->vaux2);
 748                 if (IS_ERR(child))
 749                         return PTR_ERR(child);
 750
 751                 child = add_regulator(TWL4030_REG_VINTANA1, pdata->vintana1);
 752                 if (IS_ERR(child))
 753                         return PTR_ERR(child);
 754
 755                 child = add_regulator(TWL4030_REG_VINTANA2, pdata->vintana2);
 756                 if (IS_ERR(child))
 757                         return PTR_ERR(child);
 758
 759                 child = add_regulator(TWL4030_REG_VINTDIG, pdata->vintdig);
 760                 if (IS_ERR(child))
 761                         return PTR_ERR(child);
 762         }
 763
 764         /* maybe add LDOs that are omitted on cost-reduced parts */
 765         if (twl_has_regulator() && !(features & TPS_SUBSET)
 766           && twl_class_is_4030()) {
 767                 child = add_regulator(TWL4030_REG_VPLL2, pdata->vpll2);
 768                 if (IS_ERR(child))
 769                         return PTR_ERR(child);
 770
 771                 child = add_regulator(TWL4030_REG_VMMC2, pdata->vmmc2);
 772                 if (IS_ERR(child))
 773                         return PTR_ERR(child);
 774
 775                 child = add_regulator(TWL4030_REG_VSIM, pdata->vsim);
 776                 if (IS_ERR(child))
 777                         return PTR_ERR(child);
 778
 779                 child = add_regulator(TWL4030_REG_VAUX1, pdata->vaux1);
 780                 if (IS_ERR(child))
 781                         return PTR_ERR(child);
 782
 783                 child = add_regulator(TWL4030_REG_VAUX3, pdata->vaux3);
 784                 if (IS_ERR(child))
 785                         return PTR_ERR(child);
 786
 787                 child = add_regulator(TWL4030_REG_VAUX4, pdata->vaux4);
 788                 if (IS_ERR(child))
 789                         return PTR_ERR(child);
 790         }
 791
 792         /* twl6030 regulators */
 793         if (twl_has_regulator() && twl_class_is_6030()) {
 794                 child = add_regulator(TWL6030_REG_VMMC, pdata->vmmc);
 795                 if (IS_ERR(child))
 796                         return PTR_ERR(child);
 797
 798                 child = add_regulator(TWL6030_REG_VPP, pdata->vpp);
 799                 if (IS_ERR(child))
 800                         return PTR_ERR(child);
 801
 802                 child = add_regulator(TWL6030_REG_VUSIM, pdata->vusim);
 803                 if (IS_ERR(child))
 804                         return PTR_ERR(child);
 805
 806                 child = add_regulator(TWL6030_REG_VANA, pdata->vana);
 807                 if (IS_ERR(child))
 808                         return PTR_ERR(child);
 809
 810                 child = add_regulator(TWL6030_REG_VCXIO, pdata->vcxio);
 811                 if (IS_ERR(child))
 812                         return PTR_ERR(child);
 813
 814                 child = add_regulator(TWL6030_REG_VDAC, pdata->vdac);
 815                 if (IS_ERR(child))
 816                         return PTR_ERR(child);
 817
 818                 child = add_regulator(TWL6030_REG_VUSB, pdata->vusb);
 819                 if (IS_ERR(child))
 820                         return PTR_ERR(child);
 821
 822                 child = add_regulator(TWL6030_REG_VAUX1_6030, pdata->vaux1);
 823                 if (IS_ERR(child))
 824                         return PTR_ERR(child);
 825
 826                 child = add_regulator(TWL6030_REG_VAUX2_6030, pdata->vaux2);
 827                 if (IS_ERR(child))
 828                         return PTR_ERR(child);
 829
 830                 child = add_regulator(TWL6030_REG_VAUX3_6030, pdata->vaux3);
 831                 if (IS_ERR(child))
 832                         return PTR_ERR(child);
 833         }
 834
 835         return 0;
 836 }
 837
 838 /*----------------------------------------------------------------------*/
 839
 840 /*
 841  * These three functions initialize the on-chip clock framework,
 842  * letting it generate the right frequencies for USB, MADC, and
 843  * other purposes.
 844  */
 845 static inline int __init protect_pm_master(void)
 846 {
 847         int e = 0;
 848
 849         e = twl_i2c_write_u8(TWL_MODULE_PM_MASTER, KEY_LOCK,
 850                         R_PROTECT_KEY);
 851         return e;
 852 }
 853
 854 static inline int __init unprotect_pm_master(void)
 855 {
 856         int e = 0;
 857
 858         e |= twl_i2c_write_u8(TWL_MODULE_PM_MASTER, KEY_UNLOCK1,
 859                         R_PROTECT_KEY);
 860         e |= twl_i2c_write_u8(TWL_MODULE_PM_MASTER, KEY_UNLOCK2,
 861                         R_PROTECT_KEY);
 862         return e;
 863 }
 864
 865 static void clocks_init(struct device *dev,
 866                         struct twl4030_clock_init_data *clock)
 867 {
 868         int e = 0;
 869         struct clk *osc;
 870         u32 rate;
 871         u8 ctrl = HFCLK_FREQ_26_MHZ;
 872
 873 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
 874         if (cpu_is_omap2430())
 875                 osc = clk_get(dev, "osc_ck");
 876         else
 877                 osc = clk_get(dev, "osc_sys_ck");
 878
 879         if (IS_ERR(osc)) {
 880                 printk(KERN_WARNING "Skipping twl internal clock init and "
 881                                 "using bootloader value (unknown osc rate)\n");
 882                 return;
 883         }
 884
 885         rate = clk_get_rate(osc);
 886         clk_put(osc);
 887
 888 #else
 889         /* REVISIT for non-OMAP systems, pass the clock rate from
 890          * board init code, using platform_data.
 891          */
 892         osc = ERR_PTR(-EIO);
 893
 894         printk(KERN_WARNING "Skipping twl internal clock init and "
 895                "using bootloader value (unknown osc rate)\n");
 896
 897         return;
 898 #endif
 899
 900         switch (rate) {
 901         case 19200000:
 902                 ctrl = HFCLK_FREQ_19p2_MHZ;
 903                 break;
 904         case 26000000:
 905                 ctrl = HFCLK_FREQ_26_MHZ;
 906                 break;
 907         case 38400000:
 908                 ctrl = HFCLK_FREQ_38p4_MHZ;
 909                 break;
 910         }
 911
 912         ctrl |= HIGH_PERF_SQ;
 913         if (clock && clock->ck32k_lowpwr_enable)
 914                 ctrl |= CK32K_LOWPWR_EN;
 915
 916         e |= unprotect_pm_master();
 917         /* effect->MADC+USB ck en */
 918         e |= twl_i2c_write_u8(TWL_MODULE_PM_MASTER, ctrl, R_CFG_BOOT);
 919         e |= protect_pm_master();
 920
 921         if (e < 0)
 922                 pr_err("%s: clock init err [%d]\n", DRIVER_NAME, e);
 923 }
 924
 925 /*----------------------------------------------------------------------*/
 926
 927 int twl4030_init_irq(int irq_num, unsigned irq_base, unsigned irq_end);
 928 int twl4030_exit_irq(void);
 929 int twl4030_init_chip_irq(const char *chip);
 930 int twl6030_init_irq(int irq_num, unsigned irq_base, unsigned irq_end);
 931 int twl6030_exit_irq(void);
 932
 933 static int twl_remove(struct i2c_client *client)
 934 {
 935         unsigned i;
 936         int status;
 937
 938         if (twl_class_is_4030())
 939                 status = twl4030_exit_irq();
 940         else
 941                 status = twl6030_exit_irq();
 942
 943         if (status < 0)
 944                 return status;
 945
 946         for (i = 0; i < TWL_NUM_SLAVES; i++) {
 947                 struct twl_client       *twl = &twl_modules[i];
 948
 949                 if (twl->client && twl->client != client)
 950                         i2c_unregister_device(twl->client);
 951                 twl_modules[i].client = NULL;
 952         }
 953         inuse = false;
 954         return 0;
 955 }
 956
 957 /* NOTE:  this driver only handles a single twl4030/tps659x0 chip */
 958 static int __init
 959 twl_probe(struct i2c_client *client, const struct i2c_device_id *id)
 960 {
 961         int                             status;
 962         unsigned                        i;
 963         struct twl4030_platform_data    *pdata = client->dev.platform_data;
 964         u8 temp;
 965
 966         if (!pdata) {
 967                 dev_dbg(&client->dev, "no platform data?\n");
 968                 return -EINVAL;
 969         }
 970
 971         if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C) == 0) {
 972                 dev_dbg(&client->dev, "can't talk I2C?\n");
 973                 return -EIO;
 974         }
 975
 976         if (inuse) {
 977                 dev_dbg(&client->dev, "driver is already in use\n");
 978                 return -EBUSY;
 979         }
 980
 981         for (i = 0; i < TWL_NUM_SLAVES; i++) {
 982                 struct twl_client       *twl = &twl_modules[i];
 983
 984                 twl->address = client->addr + i;
 985                 if (i == 0)
 986                         twl->client = client;
 987                 else {
 988                         twl->client = i2c_new_dummy(client->adapter,
 989                                         twl->address);
 990                         if (!twl->client) {
 991                                 dev_err(&client->dev,
 992                                         "can't attach client %d\n", i);
 993                                 status = -ENOMEM;
 994                                 goto fail;
 995                         }
 996                 }
 997                 mutex_init(&twl->xfer_lock);
 998         }
 999         inuse = true;
1000         if ((id->driver_data) & TWL6030_CLASS) {
1001                 twl_id = TWL6030_CLASS_ID;
1002                 twl_map = &twl6030_map[0];
1003         } else {
1004                 twl_id = TWL4030_CLASS_ID;
1005                 twl_map = &twl4030_map[0];
1006         }
1007
1008         /* setup clock framework */
1009         clocks_init(&client->dev, pdata->clock);
1010
1011         /* load power event scripts */
1012         if (twl_has_power() && pdata->power)
1013                 twl4030_power_init(pdata->power);
1014
1015         /* Maybe init the T2 Interrupt subsystem */
1016         if (client->irq
1017                         && pdata->irq_base
1018                         && pdata->irq_end > pdata->irq_base) {
1019                 if (twl_class_is_4030()) {
1020                         twl4030_init_chip_irq(id->name);
1021                         status = twl4030_init_irq(client->irq, pdata->irq_base,
1022                         pdata->irq_end);
1023                 } else {
1024                         status = twl6030_init_irq(client->irq, pdata->irq_base,
1025                         pdata->irq_end);
1026                 }
1027
1028                 if (status < 0)
1029                         goto fail;
1030         }
1031
1032         /* Disable TWL4030/TWL5030 I2C Pull-up on I2C1 and I2C4(SR) interface.
1033          * Program I2C_SCL_CTRL_PU(bit 0)=0, I2C_SDA_CTRL_PU (bit 2)=0,
1034          * SR_I2C_SCL_CTRL_PU(bit 4)=0 and SR_I2C_SDA_CTRL_PU(bit 6)=0.
1035          */
1036
1037         if (twl_class_is_4030()) {
1038                 twl_i2c_read_u8(TWL4030_MODULE_INTBR, &temp, REG_GPPUPDCTR1);
1039                 temp &= ~(SR_I2C_SDA_CTRL_PU | SR_I2C_SCL_CTRL_PU | \
1040                 I2C_SDA_CTRL_PU | I2C_SCL_CTRL_PU);
1041                 twl_i2c_write_u8(TWL4030_MODULE_INTBR, temp, REG_GPPUPDCTR1);
1042         }
1043
1044         status = add_children(pdata, id->driver_data);
1045 fail:
1046         if (status < 0)
1047                 twl_remove(client);
1048         return status;
1049 }
1050
1051 static const struct i2c_device_id twl_ids[] = {
1052         { "twl4030", TWL4030_VAUX2 },   /* "Triton 2" */
1053         { "twl5030", 0 },               /* T2 updated */
1054         { "twl5031", TWL5031 },         /* TWL5030 updated */
1055         { "tps65950", 0 },              /* catalog version of twl5030 */
1056         { "tps65930", TPS_SUBSET },     /* fewer LDOs and DACs; no charger */
1057         { "tps65920", TPS_SUBSET },     /* fewer LDOs; no codec or charger */
1058         { "twl6030", TWL6030_CLASS },   /* "Phoenix power chip" */
1059         { /* end of list */ },
1060 };
1061 MODULE_DEVICE_TABLE(i2c, twl_ids);
1062
1063 /* One Client Driver , 4 Clients */
1064 static struct i2c_driver twl_driver = {
1065         .driver.name    = DRIVER_NAME,
1066         .id_table       = twl_ids,
1067         .probe          = twl_probe,
1068         .remove         = twl_remove,
1069 };
1070
1071 static int __init twl_init(void)
1072 {
1073         return i2c_add_driver(&twl_driver);
1074 }
1075 subsys_initcall(twl_init);
1076
1077 static void __exit twl_exit(void)
1078 {
1079         i2c_del_driver(&twl_driver);
1080 }
1081 module_exit(twl_exit);
1082
1083 MODULE_AUTHOR("Texas Instruments, Inc.");
1084 MODULE_DESCRIPTION("I2C Core interface for TWL");
1085 MODULE_LICENSE("GPL");