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
 206 /* some fields in R_CFG_BOOT */
 207 #define HFCLK_FREQ_19p2_MHZ             (1 << 0)
 208 #define HFCLK_FREQ_26_MHZ               (2 << 0)
 209 #define HFCLK_FREQ_38p4_MHZ             (3 << 0)
 210 #define HIGH_PERF_SQ                    (1 << 3)
 211 #define CK32K_LOWPWR_EN                 (1 << 7)
 212
 213
 214 /* chip-specific feature flags, for i2c_device_id.driver_data */
 215 #define TWL4030_VAUX2           BIT(0)  /* pre-5030 voltage ranges */
 216 #define TPS_SUBSET              BIT(1)  /* tps659[23]0 have fewer LDOs */
 217 #define TWL5031                 BIT(2)  /* twl5031 has different registers */
 218 #define TWL6030_CLASS           BIT(3)  /* TWL6030 class */
 219
 220 /*----------------------------------------------------------------------*/
 221
 222 /* is driver active, bound to a chip? */
 223 static bool inuse;
 224
 225 static unsigned int twl_id;
 226 unsigned int twl_rev(void)
 227 {
 228         return twl_id;
 229 }
 230 EXPORT_SYMBOL(twl_rev);
 231
 232 /* Structure for each TWL4030/TWL6030 Slave */
 233 struct twl_client {
 234         struct i2c_client *client;
 235         u8 address;
 236
 237         /* max numb of i2c_msg required is for read =2 */
 238         struct i2c_msg xfer_msg[2];
 239
 240         /* To lock access to xfer_msg */
 241         struct mutex xfer_lock;
 242 };
 243
 244 static struct twl_client twl_modules[TWL_NUM_SLAVES];
 245
 246
 247 /* mapping the module id to slave id and base address */
 248 struct twl_mapping {
 249         unsigned char sid;      /* Slave ID */
 250         unsigned char base;     /* base address */
 251 };
 252 struct twl_mapping *twl_map;
 253
 254 static struct twl_mapping twl4030_map[TWL4030_MODULE_LAST + 1] = {
 255         /*
 256          * NOTE:  don't change this table without updating the
 257          * <linux/i2c/twl.h> defines for TWL4030_MODULE_*
 258          * so they continue to match the order in this table.
 259          */
 260
 261         { 0, TWL4030_BASEADD_USB },
 262
 263         { 1, TWL4030_BASEADD_AUDIO_VOICE },
 264         { 1, TWL4030_BASEADD_GPIO },
 265         { 1, TWL4030_BASEADD_INTBR },
 266         { 1, TWL4030_BASEADD_PIH },
 267         { 1, TWL4030_BASEADD_TEST },
 268
 269         { 2, TWL4030_BASEADD_KEYPAD },
 270         { 2, TWL4030_BASEADD_MADC },
 271         { 2, TWL4030_BASEADD_INTERRUPTS },
 272         { 2, TWL4030_BASEADD_LED },
 273         { 2, TWL4030_BASEADD_MAIN_CHARGE },
 274         { 2, TWL4030_BASEADD_PRECHARGE },
 275         { 2, TWL4030_BASEADD_PWM0 },
 276         { 2, TWL4030_BASEADD_PWM1 },
 277         { 2, TWL4030_BASEADD_PWMA },
 278         { 2, TWL4030_BASEADD_PWMB },
 279         { 2, TWL5031_BASEADD_ACCESSORY },
 280         { 2, TWL5031_BASEADD_INTERRUPTS },
 281
 282         { 3, TWL4030_BASEADD_BACKUP },
 283         { 3, TWL4030_BASEADD_INT },
 284         { 3, TWL4030_BASEADD_PM_MASTER },
 285         { 3, TWL4030_BASEADD_PM_RECEIVER },
 286         { 3, TWL4030_BASEADD_RTC },
 287         { 3, TWL4030_BASEADD_SECURED_REG },
 288 };
 289
 290 static struct twl_mapping twl6030_map[] = {
 291         /*
 292          * NOTE:  don't change this table without updating the
 293          * <linux/i2c/twl.h> defines for TWL4030_MODULE_*
 294          * so they continue to match the order in this table.
 295          */
 296         { SUB_CHIP_ID1, TWL6030_BASEADD_USB },
 297         { SUB_CHIP_ID3, TWL6030_BASEADD_AUDIO },
 298         { SUB_CHIP_ID2, TWL6030_BASEADD_DIEID },
 299         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 300         { SUB_CHIP_ID1, TWL6030_BASEADD_PIH },
 301
 302         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 303         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 304         { SUB_CHIP_ID1, TWL6030_BASEADD_GPADC_CTRL },
 305         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 306         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 307
 308         { SUB_CHIP_ID1, TWL6030_BASEADD_CHARGER },
 309         { SUB_CHIP_ID1, TWL6030_BASEADD_GASGAUGE },
 310         { SUB_CHIP_ID1, TWL6030_BASEADD_PWM },
 311         { SUB_CHIP_ID0, TWL6030_BASEADD_ZERO },
 312         { SUB_CHIP_ID1, TWL6030_BASEADD_ZERO },
 313
 314         { SUB_CHIP_ID2, TWL6030_BASEADD_ZERO },
 315         { SUB_CHIP_ID2, TWL6030_BASEADD_ZERO },
 316         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 317         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 318         { SUB_CHIP_ID2, TWL6030_BASEADD_RSV },
 319         { SUB_CHIP_ID0, TWL6030_BASEADD_PM_MASTER },
 320         { SUB_CHIP_ID0, TWL6030_BASEADD_PM_SLAVE_MISC },
 321
 322         { SUB_CHIP_ID0, TWL6030_BASEADD_RTC },
 323         { SUB_CHIP_ID0, TWL6030_BASEADD_MEM },
 324 };
 325
 326 /*----------------------------------------------------------------------*/
 327
 328 /* Exported Functions */
 329
 330 /**
 331  * twl_i2c_write - Writes a n bit register in TWL4030/TWL5030/TWL60X0
 332  * @mod_no: module number
 333  * @value: an array of num_bytes+1 containing data to write
 334  * @reg: register address (just offset will do)
 335  * @num_bytes: number of bytes to transfer
 336  *
 337  * IMPORTANT: for 'value' parameter: Allocate value num_bytes+1 and
 338  * valid data starts at Offset 1.
 339  *
 340  * Returns the result of operation - 0 is success
 341  */
 342 int twl_i2c_write(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes)
 343 {
 344         int ret;
 345         int sid;
 346         struct twl_client *twl;
 347         struct i2c_msg *msg;
 348
 349         if (unlikely(mod_no > TWL_MODULE_LAST)) {
 350                 pr_err("%s: invalid module number %d\n", DRIVER_NAME, mod_no);
 351                 return -EPERM;
 352         }
 353         sid = twl_map[mod_no].sid;
 354         twl = &twl_modules[sid];
 355
 356         if (unlikely(!inuse)) {
 357                 pr_err("%s: client %d is not initialized\n", DRIVER_NAME, sid);
 358                 return -EPERM;
 359         }
 360         mutex_lock(&twl->xfer_lock);
 361         /*
 362          * [MSG1]: fill the register address data
 363          * fill the data Tx buffer
 364          */
 365         msg = &twl->xfer_msg[0];
 366         msg->addr = twl->address;
 367         msg->len = num_bytes + 1;
 368         msg->flags = 0;
 369         msg->buf = value;
 370         /* over write the first byte of buffer with the register address */
 371         *value = twl_map[mod_no].base + reg;
 372         ret = i2c_transfer(twl->client->adapter, twl->xfer_msg, 1);
 373         mutex_unlock(&twl->xfer_lock);
 374
 375         /* i2c_transfer returns number of messages transferred */
 376         if (ret != 1) {
 377                 pr_err("%s: i2c_write failed to transfer all messages\n",
 378                         DRIVER_NAME);
 379                 if (ret < 0)
 380                         return ret;
 381                 else
 382                         return -EIO;
 383         } else {
 384                 return 0;
 385         }
 386 }
 387 EXPORT_SYMBOL(twl_i2c_write);
 388
 389 /**
 390  * twl_i2c_read - Reads a n bit register in TWL4030/TWL5030/TWL60X0
 391  * @mod_no: module number
 392  * @value: an array of num_bytes containing data to be read
 393  * @reg: register address (just offset will do)
 394  * @num_bytes: number of bytes to transfer
 395  *
 396  * Returns result of operation - num_bytes is success else failure.
 397  */
 398 int twl_i2c_read(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes)
 399 {
 400         int ret;
 401         u8 val;
 402         int sid;
 403         struct twl_client *twl;
 404         struct i2c_msg *msg;
 405
 406         if (unlikely(mod_no > TWL_MODULE_LAST)) {
 407                 pr_err("%s: invalid module number %d\n", DRIVER_NAME, mod_no);
 408                 return -EPERM;
 409         }
 410         sid = twl_map[mod_no].sid;
 411         twl = &twl_modules[sid];
 412
 413         if (unlikely(!inuse)) {
 414                 pr_err("%s: client %d is not initialized\n", DRIVER_NAME, sid);
 415                 return -EPERM;
 416         }
 417         mutex_lock(&twl->xfer_lock);
 418         /* [MSG1] fill the register address data */
 419         msg = &twl->xfer_msg[0];
 420         msg->addr = twl->address;
 421         msg->len = 1;
 422         msg->flags = 0; /* Read the register value */
 423         val = twl_map[mod_no].base + reg;
 424         msg->buf = &val;
 425         /* [MSG2] fill the data rx buffer */
 426         msg = &twl->xfer_msg[1];
 427         msg->addr = twl->address;
 428         msg->flags = I2C_M_RD;  /* Read the register value */
 429         msg->len = num_bytes;   /* only n bytes */
 430         msg->buf = value;
 431         ret = i2c_transfer(twl->client->adapter, twl->xfer_msg, 2);
 432         mutex_unlock(&twl->xfer_lock);
 433
 434         /* i2c_transfer returns number of messages transferred */
 435         if (ret != 2) {
 436                 pr_err("%s: i2c_read failed to transfer all messages\n",
 437                         DRIVER_NAME);
 438                 if (ret < 0)
 439                         return ret;
 440                 else
 441                         return -EIO;
 442         } else {
 443                 return 0;
 444         }
 445 }
 446 EXPORT_SYMBOL(twl_i2c_read);
 447
 448 /**
 449  * twl_i2c_write_u8 - Writes a 8 bit register in TWL4030/TWL5030/TWL60X0
 450  * @mod_no: module number
 451  * @value: the value to be written 8 bit
 452  * @reg: register address (just offset will do)
 453  *
 454  * Returns result of operation - 0 is success
 455  */
 456 int twl_i2c_write_u8(u8 mod_no, u8 value, u8 reg)
 457 {
 458
 459         /* 2 bytes offset 1 contains the data offset 0 is used by i2c_write */
 460         u8 temp_buffer[2] = { 0 };
 461         /* offset 1 contains the data */
 462         temp_buffer[1] = value;
 463         return twl_i2c_write(mod_no, temp_buffer, reg, 1);
 464 }
 465 EXPORT_SYMBOL(twl_i2c_write_u8);
 466
 467 /**
 468  * twl_i2c_read_u8 - Reads a 8 bit register from TWL4030/TWL5030/TWL60X0
 469  * @mod_no: module number
 470  * @value: the value read 8 bit
 471  * @reg: register address (just offset will do)
 472  *
 473  * Returns result of operation - 0 is success
 474  */
 475 int twl_i2c_read_u8(u8 mod_no, u8 *value, u8 reg)
 476 {
 477         return twl_i2c_read(mod_no, value, reg, 1);
 478 }
 479 EXPORT_SYMBOL(twl_i2c_read_u8);
 480
 481 /*----------------------------------------------------------------------*/
 482
 483 static struct device *
 484 add_numbered_child(unsigned chip, const char *name, int num,
 485                 void *pdata, unsigned pdata_len,
 486                 bool can_wakeup, int irq0, int irq1)
 487 {
 488         struct platform_device  *pdev;
 489         struct twl_client       *twl = &twl_modules[chip];
 490         int                     status;
 491
 492         pdev = platform_device_alloc(name, num);
 493         if (!pdev) {
 494                 dev_dbg(&twl->client->dev, "can't alloc dev\n");
 495                 status = -ENOMEM;
 496                 goto err;
 497         }
 498
 499         device_init_wakeup(&pdev->dev, can_wakeup);
 500         pdev->dev.parent = &twl->client->dev;
 501
 502         if (pdata) {
 503                 status = platform_device_add_data(pdev, pdata, pdata_len);
 504                 if (status < 0) {
 505                         dev_dbg(&pdev->dev, "can't add platform_data\n");
 506                         goto err;
 507                 }
 508         }
 509
 510         if (irq0) {
 511                 struct resource r[2] = {
 512                         { .start = irq0, .flags = IORESOURCE_IRQ, },
 513                         { .start = irq1, .flags = IORESOURCE_IRQ, },
 514                 };
 515
 516                 status = platform_device_add_resources(pdev, r, irq1 ? 2 : 1);
 517                 if (status < 0) {
 518                         dev_dbg(&pdev->dev, "can't add irqs\n");
 519                         goto err;
 520                 }
 521         }
 522
 523         status = platform_device_add(pdev);
 524
 525 err:
 526         if (status < 0) {
 527                 platform_device_put(pdev);
 528                 dev_err(&twl->client->dev, "can't add %s dev\n", name);
 529                 return ERR_PTR(status);
 530         }
 531         return &pdev->dev;
 532 }
 533
 534 static inline struct device *add_child(unsigned chip, const char *name,
 535                 void *pdata, unsigned pdata_len,
 536                 bool can_wakeup, int irq0, int irq1)
 537 {
 538         return add_numbered_child(chip, name, -1, pdata, pdata_len,
 539                 can_wakeup, irq0, irq1);
 540 }
 541
 542 static struct device *
 543 add_regulator_linked(int num, struct regulator_init_data *pdata,
 544                 struct regulator_consumer_supply *consumers,
 545                 unsigned num_consumers)
 546 {
 547         unsigned sub_chip_id;
 548         /* regulator framework demands init_data ... */
 549         if (!pdata)
 550                 return NULL;
 551
 552         if (consumers) {
 553                 pdata->consumer_supplies = consumers;
 554                 pdata->num_consumer_supplies = num_consumers;
 555         }
 556
 557         /* NOTE:  we currently ignore regulator IRQs, e.g. for short circuits */
 558         sub_chip_id = twl_map[TWL_MODULE_PM_MASTER].sid;
 559         return add_numbered_child(sub_chip_id, "twl_reg", num,
 560                 pdata, sizeof(*pdata), false, 0, 0);
 561 }
 562
 563 static struct device *
 564 add_regulator(int num, struct regulator_init_data *pdata)
 565 {
 566         return add_regulator_linked(num, pdata, NULL, 0);
 567 }
 568
 569 /*
 570  * NOTE:  We know the first 8 IRQs after pdata->base_irq are
 571  * for the PIH, and the next are for the PWR_INT SIH, since
 572  * that's how twl_init_irq() sets things up.
 573  */
 574
 575 static int
 576 add_children(struct twl4030_platform_data *pdata, unsigned long features)
 577 {
 578         struct device   *child;
 579         unsigned sub_chip_id;
 580
 581         if (twl_has_gpio() && pdata->gpio) {
 582                 child = add_child(SUB_CHIP_ID1, "twl4030_gpio",
 583                                 pdata->gpio, sizeof(*pdata->gpio),
 584                                 false, pdata->irq_base + GPIO_INTR_OFFSET, 0);
 585                 if (IS_ERR(child))
 586                         return PTR_ERR(child);
 587         }
 588
 589         if (twl_has_keypad() && pdata->keypad) {
 590                 child = add_child(SUB_CHIP_ID2, "twl4030_keypad",
 591                                 pdata->keypad, sizeof(*pdata->keypad),
 592                                 true, pdata->irq_base + KEYPAD_INTR_OFFSET, 0);
 593                 if (IS_ERR(child))
 594                         return PTR_ERR(child);
 595         }
 596
 597         if (twl_has_madc() && pdata->madc) {
 598                 child = add_child(2, "twl4030_madc",
 599                                 pdata->madc, sizeof(*pdata->madc),
 600                                 true, pdata->irq_base + MADC_INTR_OFFSET, 0);
 601                 if (IS_ERR(child))
 602                         return PTR_ERR(child);
 603         }
 604
 605         if (twl_has_rtc()) {
 606                 /*
 607                  * REVISIT platform_data here currently might expose the
 608                  * "msecure" line ... but for now we just expect board
 609                  * setup to tell the chip "it's always ok to SET_TIME".
 610                  * Eventually, Linux might become more aware of such
 611                  * HW security concerns, and "least privilege".
 612                  */
 613                 sub_chip_id = twl_map[TWL_MODULE_RTC].sid;
 614                 child = add_child(sub_chip_id, "twl_rtc",
 615                                 NULL, 0,
 616                                 true, pdata->irq_base + RTC_INTR_OFFSET, 0);
 617                 if (IS_ERR(child))
 618                         return PTR_ERR(child);
 619         }
 620
 621         if (twl_has_usb() && pdata->usb && twl_class_is_4030()) {
 622
 623                 static struct regulator_consumer_supply usb1v5 = {
 624                         .supply =       "usb1v5",
 625                 };
 626                 static struct regulator_consumer_supply usb1v8 = {
 627                         .supply =       "usb1v8",
 628                 };
 629                 static struct regulator_consumer_supply usb3v1 = {
 630                         .supply =       "usb3v1",
 631                 };
 632
 633         /* First add the regulators so that they can be used by transceiver */
 634                 if (twl_has_regulator()) {
 635                         /* this is a template that gets copied */
 636                         struct regulator_init_data usb_fixed = {
 637                                 .constraints.valid_modes_mask =
 638                                         REGULATOR_MODE_NORMAL
 639                                         | REGULATOR_MODE_STANDBY,
 640                                 .constraints.valid_ops_mask =
 641                                         REGULATOR_CHANGE_MODE
 642                                         | REGULATOR_CHANGE_STATUS,
 643                         };
 644
 645                         child = add_regulator_linked(TWL4030_REG_VUSB1V5,
 646                                                       &usb_fixed, &usb1v5, 1);
 647                         if (IS_ERR(child))
 648                                 return PTR_ERR(child);
 649
 650                         child = add_regulator_linked(TWL4030_REG_VUSB1V8,
 651                                                       &usb_fixed, &usb1v8, 1);
 652                         if (IS_ERR(child))
 653                                 return PTR_ERR(child);
 654
 655                         child = add_regulator_linked(TWL4030_REG_VUSB3V1,
 656                                                       &usb_fixed, &usb3v1, 1);
 657                         if (IS_ERR(child))
 658                                 return PTR_ERR(child);
 659
 660                 }
 661
 662                 child = add_child(0, "twl4030_usb",
 663                                 pdata->usb, sizeof(*pdata->usb),
 664                                 true,
 665                                 /* irq0 = USB_PRES, irq1 = USB */
 666                                 pdata->irq_base + USB_PRES_INTR_OFFSET,
 667                                 pdata->irq_base + USB_INTR_OFFSET);
 668
 669                 if (IS_ERR(child))
 670                         return PTR_ERR(child);
 671
 672                 /* we need to connect regulators to this transceiver */
 673                 if (twl_has_regulator() && child) {
 674                         usb1v5.dev = child;
 675                         usb1v8.dev = child;
 676                         usb3v1.dev = child;
 677                 }
 678         }
 679
 680         if (twl_has_watchdog()) {
 681                 child = add_child(0, "twl4030_wdt", NULL, 0, false, 0, 0);
 682                 if (IS_ERR(child))
 683                         return PTR_ERR(child);
 684         }
 685
 686         if (twl_has_pwrbutton()) {
 687                 child = add_child(1, "twl4030_pwrbutton",
 688                                 NULL, 0, true, pdata->irq_base + 8 + 0, 0);
 689                 if (IS_ERR(child))
 690                         return PTR_ERR(child);
 691         }
 692
 693         if (twl_has_codec() && pdata->codec && twl_class_is_4030()) {
 694                 sub_chip_id = twl_map[TWL_MODULE_AUDIO_VOICE].sid;
 695                 child = add_child(sub_chip_id, "twl4030-audio",
 696                                 pdata->codec, sizeof(*pdata->codec),
 697                                 false, 0, 0);
 698                 if (IS_ERR(child))
 699                         return PTR_ERR(child);
 700         }
 701
 702         /* Phoenix codec driver is probed directly atm */
 703         if (twl_has_codec() && pdata->codec && twl_class_is_6030()) {
 704                 sub_chip_id = twl_map[TWL_MODULE_AUDIO_VOICE].sid;
 705                 child = add_child(sub_chip_id, "twl6040-codec",
 706                                 pdata->codec, sizeof(*pdata->codec),
 707                                 false, 0, 0);
 708                 if (IS_ERR(child))
 709                         return PTR_ERR(child);
 710         }
 711
 712         /* twl4030 regulators */
 713         if (twl_has_regulator() && twl_class_is_4030()) {
 714                 child = add_regulator(TWL4030_REG_VPLL1, pdata->vpll1);
 715                 if (IS_ERR(child))
 716                         return PTR_ERR(child);
 717
 718                 child = add_regulator(TWL4030_REG_VIO, pdata->vio);
 719                 if (IS_ERR(child))
 720                         return PTR_ERR(child);
 721
 722                 child = add_regulator(TWL4030_REG_VDD1, pdata->vdd1);
 723                 if (IS_ERR(child))
 724                         return PTR_ERR(child);
 725
 726                 child = add_regulator(TWL4030_REG_VDD2, pdata->vdd2);
 727                 if (IS_ERR(child))
 728                         return PTR_ERR(child);
 729
 730                 child = add_regulator(TWL4030_REG_VMMC1, pdata->vmmc1);
 731                 if (IS_ERR(child))
 732                         return PTR_ERR(child);
 733
 734                 child = add_regulator(TWL4030_REG_VDAC, pdata->vdac);
 735                 if (IS_ERR(child))
 736                         return PTR_ERR(child);
 737
 738                 child = add_regulator((features & TWL4030_VAUX2)
 739                                         ? TWL4030_REG_VAUX2_4030
 740                                         : TWL4030_REG_VAUX2,
 741                                 pdata->vaux2);
 742                 if (IS_ERR(child))
 743                         return PTR_ERR(child);
 744
 745                 child = add_regulator(TWL4030_REG_VINTANA1, pdata->vintana1);
 746                 if (IS_ERR(child))
 747                         return PTR_ERR(child);
 748
 749                 child = add_regulator(TWL4030_REG_VINTANA2, pdata->vintana2);
 750                 if (IS_ERR(child))
 751                         return PTR_ERR(child);
 752
 753                 child = add_regulator(TWL4030_REG_VINTDIG, pdata->vintdig);
 754                 if (IS_ERR(child))
 755                         return PTR_ERR(child);
 756         }
 757
 758         /* maybe add LDOs that are omitted on cost-reduced parts */
 759         if (twl_has_regulator() && !(features & TPS_SUBSET)
 760           && twl_class_is_4030()) {
 761                 child = add_regulator(TWL4030_REG_VPLL2, pdata->vpll2);
 762                 if (IS_ERR(child))
 763                         return PTR_ERR(child);
 764
 765                 child = add_regulator(TWL4030_REG_VMMC2, pdata->vmmc2);
 766                 if (IS_ERR(child))
 767                         return PTR_ERR(child);
 768
 769                 child = add_regulator(TWL4030_REG_VSIM, pdata->vsim);
 770                 if (IS_ERR(child))
 771                         return PTR_ERR(child);
 772
 773                 child = add_regulator(TWL4030_REG_VAUX1, pdata->vaux1);
 774                 if (IS_ERR(child))
 775                         return PTR_ERR(child);
 776
 777                 child = add_regulator(TWL4030_REG_VAUX3, pdata->vaux3);
 778                 if (IS_ERR(child))
 779                         return PTR_ERR(child);
 780
 781                 child = add_regulator(TWL4030_REG_VAUX4, pdata->vaux4);
 782                 if (IS_ERR(child))
 783                         return PTR_ERR(child);
 784         }
 785
 786         /* twl6030 regulators */
 787         if (twl_has_regulator() && twl_class_is_6030()) {
 788                 child = add_regulator(TWL6030_REG_VMMC, pdata->vmmc);
 789                 if (IS_ERR(child))
 790                         return PTR_ERR(child);
 791
 792                 child = add_regulator(TWL6030_REG_VPP, pdata->vpp);
 793                 if (IS_ERR(child))
 794                         return PTR_ERR(child);
 795
 796                 child = add_regulator(TWL6030_REG_VUSIM, pdata->vusim);
 797                 if (IS_ERR(child))
 798                         return PTR_ERR(child);
 799
 800                 child = add_regulator(TWL6030_REG_VANA, pdata->vana);
 801                 if (IS_ERR(child))
 802                         return PTR_ERR(child);
 803
 804                 child = add_regulator(TWL6030_REG_VCXIO, pdata->vcxio);
 805                 if (IS_ERR(child))
 806                         return PTR_ERR(child);
 807
 808                 child = add_regulator(TWL6030_REG_VDAC, pdata->vdac);
 809                 if (IS_ERR(child))
 810                         return PTR_ERR(child);
 811
 812                 child = add_regulator(TWL6030_REG_VUSB, pdata->vusb);
 813                 if (IS_ERR(child))
 814                         return PTR_ERR(child);
 815
 816                 child = add_regulator(TWL6030_REG_VAUX1_6030, pdata->vaux1);
 817                 if (IS_ERR(child))
 818                         return PTR_ERR(child);
 819
 820                 child = add_regulator(TWL6030_REG_VAUX2_6030, pdata->vaux2);
 821                 if (IS_ERR(child))
 822                         return PTR_ERR(child);
 823
 824                 child = add_regulator(TWL6030_REG_VAUX3_6030, pdata->vaux3);
 825                 if (IS_ERR(child))
 826                         return PTR_ERR(child);
 827         }
 828
 829         return 0;
 830 }
 831
 832 /*----------------------------------------------------------------------*/
 833
 834 /*
 835  * These three functions initialize the on-chip clock framework,
 836  * letting it generate the right frequencies for USB, MADC, and
 837  * other purposes.
 838  */
 839 static inline int __init protect_pm_master(void)
 840 {
 841         int e = 0;
 842
 843         e = twl_i2c_write_u8(TWL4030_MODULE_PM_MASTER, 0,
 844                         TWL4030_PM_MASTER_PROTECT_KEY);
 845         return e;
 846 }
 847
 848 static inline int __init unprotect_pm_master(void)
 849 {
 850         int e = 0;
 851
 852         e |= twl_i2c_write_u8(TWL4030_MODULE_PM_MASTER,
 853                         TWL4030_PM_MASTER_KEY_CFG1,
 854                         TWL4030_PM_MASTER_PROTECT_KEY);
 855         e |= twl_i2c_write_u8(TWL4030_MODULE_PM_MASTER,
 856                         TWL4030_PM_MASTER_KEY_CFG2,
 857                         TWL4030_PM_MASTER_PROTECT_KEY);
 858
 859         return e;
 860 }
 861
 862 static void clocks_init(struct device *dev,
 863                         struct twl4030_clock_init_data *clock)
 864 {
 865         int e = 0;
 866         struct clk *osc;
 867         u32 rate;
 868         u8 ctrl = HFCLK_FREQ_26_MHZ;
 869
 870 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
 871         if (cpu_is_omap2430())
 872                 osc = clk_get(dev, "osc_ck");
 873         else
 874                 osc = clk_get(dev, "osc_sys_ck");
 875
 876         if (IS_ERR(osc)) {
 877                 printk(KERN_WARNING "Skipping twl internal clock init and "
 878                                 "using bootloader value (unknown osc rate)\n");
 879                 return;
 880         }
 881
 882         rate = clk_get_rate(osc);
 883         clk_put(osc);
 884
 885 #else
 886         /* REVISIT for non-OMAP systems, pass the clock rate from
 887          * board init code, using platform_data.
 888          */
 889         osc = ERR_PTR(-EIO);
 890
 891         printk(KERN_WARNING "Skipping twl internal clock init and "
 892                "using bootloader value (unknown osc rate)\n");
 893
 894         return;
 895 #endif
 896
 897         switch (rate) {
 898         case 19200000:
 899                 ctrl = HFCLK_FREQ_19p2_MHZ;
 900                 break;
 901         case 26000000:
 902                 ctrl = HFCLK_FREQ_26_MHZ;
 903                 break;
 904         case 38400000:
 905                 ctrl = HFCLK_FREQ_38p4_MHZ;
 906                 break;
 907         }
 908
 909         ctrl |= HIGH_PERF_SQ;
 910         if (clock && clock->ck32k_lowpwr_enable)
 911                 ctrl |= CK32K_LOWPWR_EN;
 912
 913         e |= unprotect_pm_master();
 914         /* effect->MADC+USB ck en */
 915         e |= twl_i2c_write_u8(TWL_MODULE_PM_MASTER, ctrl, R_CFG_BOOT);
 916         e |= protect_pm_master();
 917
 918         if (e < 0)
 919                 pr_err("%s: clock init err [%d]\n", DRIVER_NAME, e);
 920 }
 921
 922 /*----------------------------------------------------------------------*/
 923
 924 int twl4030_init_irq(int irq_num, unsigned irq_base, unsigned irq_end);
 925 int twl4030_exit_irq(void);
 926 int twl4030_init_chip_irq(const char *chip);
 927 int twl6030_init_irq(int irq_num, unsigned irq_base, unsigned irq_end);
 928 int twl6030_exit_irq(void);
 929
 930 static int twl_remove(struct i2c_client *client)
 931 {
 932         unsigned i;
 933         int status;
 934
 935         if (twl_class_is_4030())
 936                 status = twl4030_exit_irq();
 937         else
 938                 status = twl6030_exit_irq();
 939
 940         if (status < 0)
 941                 return status;
 942
 943         for (i = 0; i < TWL_NUM_SLAVES; i++) {
 944                 struct twl_client       *twl = &twl_modules[i];
 945
 946                 if (twl->client && twl->client != client)
 947                         i2c_unregister_device(twl->client);
 948                 twl_modules[i].client = NULL;
 949         }
 950         inuse = false;
 951         return 0;
 952 }
 953
 954 /* NOTE:  this driver only handles a single twl4030/tps659x0 chip */
 955 static int __init
 956 twl_probe(struct i2c_client *client, const struct i2c_device_id *id)
 957 {
 958         int                             status;
 959         unsigned                        i;
 960         struct twl4030_platform_data    *pdata = client->dev.platform_data;
 961         u8 temp;
 962
 963         if (!pdata) {
 964                 dev_dbg(&client->dev, "no platform data?\n");
 965                 return -EINVAL;
 966         }
 967
 968         if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C) == 0) {
 969                 dev_dbg(&client->dev, "can't talk I2C?\n");
 970                 return -EIO;
 971         }
 972
 973         if (inuse) {
 974                 dev_dbg(&client->dev, "driver is already in use\n");
 975                 return -EBUSY;
 976         }
 977
 978         for (i = 0; i < TWL_NUM_SLAVES; i++) {
 979                 struct twl_client       *twl = &twl_modules[i];
 980
 981                 twl->address = client->addr + i;
 982                 if (i == 0)
 983                         twl->client = client;
 984                 else {
 985                         twl->client = i2c_new_dummy(client->adapter,
 986                                         twl->address);
 987                         if (!twl->client) {
 988                                 dev_err(&client->dev,
 989                                         "can't attach client %d\n", i);
 990                                 status = -ENOMEM;
 991                                 goto fail;
 992                         }
 993                 }
 994                 mutex_init(&twl->xfer_lock);
 995         }
 996         inuse = true;
 997         if ((id->driver_data) & TWL6030_CLASS) {
 998                 twl_id = TWL6030_CLASS_ID;
 999                 twl_map = &twl6030_map[0];
1000         } else {
1001                 twl_id = TWL4030_CLASS_ID;
1002                 twl_map = &twl4030_map[0];
1003         }
1004
1005         /* setup clock framework */
1006         clocks_init(&client->dev, pdata->clock);
1007
1008         /* load power event scripts */
1009         if (twl_has_power() && pdata->power)
1010                 twl4030_power_init(pdata->power);
1011
1012         /* Maybe init the T2 Interrupt subsystem */
1013         if (client->irq
1014                         && pdata->irq_base
1015                         && pdata->irq_end > pdata->irq_base) {
1016                 if (twl_class_is_4030()) {
1017                         twl4030_init_chip_irq(id->name);
1018                         status = twl4030_init_irq(client->irq, pdata->irq_base,
1019                         pdata->irq_end);
1020                 } else {
1021                         status = twl6030_init_irq(client->irq, pdata->irq_base,
1022                         pdata->irq_end);
1023                 }
1024
1025                 if (status < 0)
1026                         goto fail;
1027         }
1028
1029         /* Disable TWL4030/TWL5030 I2C Pull-up on I2C1 and I2C4(SR) interface.
1030          * Program I2C_SCL_CTRL_PU(bit 0)=0, I2C_SDA_CTRL_PU (bit 2)=0,
1031          * SR_I2C_SCL_CTRL_PU(bit 4)=0 and SR_I2C_SDA_CTRL_PU(bit 6)=0.
1032          */
1033
1034         if (twl_class_is_4030()) {
1035                 twl_i2c_read_u8(TWL4030_MODULE_INTBR, &temp, REG_GPPUPDCTR1);
1036                 temp &= ~(SR_I2C_SDA_CTRL_PU | SR_I2C_SCL_CTRL_PU | \
1037                 I2C_SDA_CTRL_PU | I2C_SCL_CTRL_PU);
1038                 twl_i2c_write_u8(TWL4030_MODULE_INTBR, temp, REG_GPPUPDCTR1);
1039         }
1040
1041         status = add_children(pdata, id->driver_data);
1042 fail:
1043         if (status < 0)
1044                 twl_remove(client);
1045         return status;
1046 }
1047
1048 static const struct i2c_device_id twl_ids[] = {
1049         { "twl4030", TWL4030_VAUX2 },   /* "Triton 2" */
1050         { "twl5030", 0 },               /* T2 updated */
1051         { "twl5031", TWL5031 },         /* TWL5030 updated */
1052         { "tps65950", 0 },              /* catalog version of twl5030 */
1053         { "tps65930", TPS_SUBSET },     /* fewer LDOs and DACs; no charger */
1054         { "tps65920", TPS_SUBSET },     /* fewer LDOs; no codec or charger */
1055         { "twl6030", TWL6030_CLASS },   /* "Phoenix power chip" */
1056         { /* end of list */ },
1057 };
1058 MODULE_DEVICE_TABLE(i2c, twl_ids);
1059
1060 /* One Client Driver , 4 Clients */
1061 static struct i2c_driver twl_driver = {
1062         .driver.name    = DRIVER_NAME,
1063         .id_table       = twl_ids,
1064         .probe          = twl_probe,
1065         .remove         = twl_remove,
1066 };
1067
1068 static int __init twl_init(void)
1069 {
1070         return i2c_add_driver(&twl_driver);
1071 }
1072 subsys_initcall(twl_init);
1073
1074 static void __exit twl_exit(void)
1075 {
1076         i2c_del_driver(&twl_driver);
1077 }
1078 module_exit(twl_exit);
1079
1080 MODULE_AUTHOR("Texas Instruments, Inc.");
1081 MODULE_DESCRIPTION("I2C Core interface for TWL");
1082 MODULE_LICENSE("GPL");