2 * twl4030_core.c - driver for TWL4030/TPS659x0 PM and audio CODEC devices
4 * Copyright (C) 2005-2006 Texas Instruments, Inc.
6 * Modifications to defer interrupt handling to a kernel thread:
7 * Copyright (C) 2006 MontaVista Software, Inc.
9 * Based on tlv320aic23.c:
10 * Copyright (c) by Kai Svahn <kai.svahn@nokia.com>
12 * Code cleanup and modifications to IRQ handler.
13 * by syed khasim <x0khasim@ti.com>
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation; either version 2 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software
27 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <linux/init.h>
31 #include <linux/mutex.h>
32 #include <linux/platform_device.h>
33 #include <linux/clk.h>
34 #include <linux/err.h>
36 #include <linux/i2c.h>
37 #include <linux/i2c/twl4030.h>
41 * The TWL4030 "Triton 2" is one of a family of a multi-function "Power
42 * Management and System Companion Device" chips originally designed for
43 * use in OMAP2 and OMAP 3 based systems. Its control interfaces use I2C,
44 * often at around 3 Mbit/sec, including for interrupt handling.
46 * This driver core provides genirq support for the interrupts emitted,
47 * by the various modules, and exports register access primitives.
49 * FIXME this driver currently requires use of the first interrupt line
50 * (and associated registers).
53 #define DRIVER_NAME "twl4030"
55 #if defined(CONFIG_TWL4030_BCI_BATTERY) || \
56 defined(CONFIG_TWL4030_BCI_BATTERY_MODULE)
57 #define twl_has_bci() true
59 #define twl_has_bci() false
62 #if defined(CONFIG_KEYBOARD_TWL4030) || defined(CONFIG_KEYBOARD_TWL4030_MODULE)
63 #define twl_has_keypad() true
65 #define twl_has_keypad() false
68 #if defined(CONFIG_GPIO_TWL4030) || defined(CONFIG_GPIO_TWL4030_MODULE)
69 #define twl_has_gpio() true
71 #define twl_has_gpio() false
74 #if defined(CONFIG_TWL4030_MADC) || defined(CONFIG_TWL4030_MADC_MODULE)
75 #define twl_has_madc() true
77 #define twl_has_madc() false
80 #ifdef CONFIG_TWL4030_POWER
81 #define twl_has_power() true
83 #define twl_has_power() false
86 #if defined(CONFIG_RTC_DRV_TWL4030) || defined(CONFIG_RTC_DRV_TWL4030_MODULE)
87 #define twl_has_rtc() true
89 #define twl_has_rtc() false
92 #if defined(CONFIG_TWL4030_USB) || defined(CONFIG_TWL4030_USB_MODULE)
93 #define twl_has_usb() true
95 #define twl_has_usb() false
99 /* Triton Core internal information (BEGIN) */
101 /* Last - for index max*/
102 #define TWL4030_MODULE_LAST TWL4030_MODULE_SECURED_REG
104 #define TWL4030_NUM_SLAVES 4
107 /* Base Address defns for twl4030_map[] */
109 /* subchip/slave 0 - USB ID */
110 #define TWL4030_BASEADD_USB 0x0000
112 /* subchip/slave 1 - AUD ID */
113 #define TWL4030_BASEADD_AUDIO_VOICE 0x0000
114 #define TWL4030_BASEADD_GPIO 0x0098
115 #define TWL4030_BASEADD_INTBR 0x0085
116 #define TWL4030_BASEADD_PIH 0x0080
117 #define TWL4030_BASEADD_TEST 0x004C
119 /* subchip/slave 2 - AUX ID */
120 #define TWL4030_BASEADD_INTERRUPTS 0x00B9
121 #define TWL4030_BASEADD_LED 0x00EE
122 #define TWL4030_BASEADD_MADC 0x0000
123 #define TWL4030_BASEADD_MAIN_CHARGE 0x0074
124 #define TWL4030_BASEADD_PRECHARGE 0x00AA
125 #define TWL4030_BASEADD_PWM0 0x00F8
126 #define TWL4030_BASEADD_PWM1 0x00FB
127 #define TWL4030_BASEADD_PWMA 0x00EF
128 #define TWL4030_BASEADD_PWMB 0x00F1
129 #define TWL4030_BASEADD_KEYPAD 0x00D2
131 /* subchip/slave 3 - POWER ID */
132 #define TWL4030_BASEADD_BACKUP 0x0014
133 #define TWL4030_BASEADD_INT 0x002E
134 #define TWL4030_BASEADD_PM_MASTER 0x0036
135 #define TWL4030_BASEADD_PM_RECEIVER 0x005B
136 #define TWL4030_BASEADD_RTC 0x001C
137 #define TWL4030_BASEADD_SECURED_REG 0x0000
139 /* Triton Core internal information (END) */
142 /* Few power values */
143 #define R_CFG_BOOT 0x05
144 #define R_PROTECT_KEY 0x0E
146 /* access control values for R_PROTECT_KEY */
147 #define KEY_UNLOCK1 0xce
148 #define KEY_UNLOCK2 0xec
149 #define KEY_LOCK 0x00
151 /* some fields in R_CFG_BOOT */
152 #define HFCLK_FREQ_19p2_MHZ (1 << 0)
153 #define HFCLK_FREQ_26_MHZ (2 << 0)
154 #define HFCLK_FREQ_38p4_MHZ (3 << 0)
155 #define HIGH_PERF_SQ (1 << 3)
158 /*----------------------------------------------------------------------*/
160 /* is driver active, bound to a chip? */
163 /* Structure for each TWL4030 Slave */
164 struct twl4030_client {
165 struct i2c_client *client;
168 /* max numb of i2c_msg required is for read =2 */
169 struct i2c_msg xfer_msg[2];
171 /* To lock access to xfer_msg */
172 struct mutex xfer_lock;
175 static struct twl4030_client twl4030_modules[TWL4030_NUM_SLAVES];
178 /* mapping the module id to slave id and base address */
179 struct twl4030mapping {
180 unsigned char sid; /* Slave ID */
181 unsigned char base; /* base address */
184 static struct twl4030mapping twl4030_map[TWL4030_MODULE_LAST + 1] = {
186 * NOTE: don't change this table without updating the
187 * <linux/i2c/twl4030.h> defines for TWL4030_MODULE_*
188 * so they continue to match the order in this table.
191 { 0, TWL4030_BASEADD_USB },
193 { 1, TWL4030_BASEADD_AUDIO_VOICE },
194 { 1, TWL4030_BASEADD_GPIO },
195 { 1, TWL4030_BASEADD_INTBR },
196 { 1, TWL4030_BASEADD_PIH },
197 { 1, TWL4030_BASEADD_TEST },
199 { 2, TWL4030_BASEADD_KEYPAD },
200 { 2, TWL4030_BASEADD_MADC },
201 { 2, TWL4030_BASEADD_INTERRUPTS },
202 { 2, TWL4030_BASEADD_LED },
203 { 2, TWL4030_BASEADD_MAIN_CHARGE },
204 { 2, TWL4030_BASEADD_PRECHARGE },
205 { 2, TWL4030_BASEADD_PWM0 },
206 { 2, TWL4030_BASEADD_PWM1 },
207 { 2, TWL4030_BASEADD_PWMA },
208 { 2, TWL4030_BASEADD_PWMB },
210 { 3, TWL4030_BASEADD_BACKUP },
211 { 3, TWL4030_BASEADD_INT },
212 { 3, TWL4030_BASEADD_PM_MASTER },
213 { 3, TWL4030_BASEADD_PM_RECEIVER },
214 { 3, TWL4030_BASEADD_RTC },
215 { 3, TWL4030_BASEADD_SECURED_REG },
218 extern void twl4030_power_init(struct twl4030_power_data *triton2_scripts);
220 /*----------------------------------------------------------------------*/
222 /* Exported Functions */
225 * twl4030_i2c_write - Writes a n bit register in TWL4030
226 * @mod_no: module number
227 * @value: an array of num_bytes+1 containing data to write
228 * @reg: register address (just offset will do)
229 * @num_bytes: number of bytes to transfer
231 * IMPORTANT: for 'value' parameter: Allocate value num_bytes+1 and
232 * valid data starts at Offset 1.
234 * Returns the result of operation - 0 is success
236 int twl4030_i2c_write(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes)
240 struct twl4030_client *twl;
243 if (unlikely(mod_no > TWL4030_MODULE_LAST)) {
244 pr_err("%s: invalid module number %d\n", DRIVER_NAME, mod_no);
247 sid = twl4030_map[mod_no].sid;
248 twl = &twl4030_modules[sid];
250 if (unlikely(!inuse)) {
251 pr_err("%s: client %d is not initialized\n", DRIVER_NAME, sid);
254 mutex_lock(&twl->xfer_lock);
256 * [MSG1]: fill the register address data
257 * fill the data Tx buffer
259 msg = &twl->xfer_msg[0];
260 msg->addr = twl->address;
261 msg->len = num_bytes + 1;
264 /* over write the first byte of buffer with the register address */
265 *value = twl4030_map[mod_no].base + reg;
266 ret = i2c_transfer(twl->client->adapter, twl->xfer_msg, 1);
267 mutex_unlock(&twl->xfer_lock);
269 /* i2cTransfer returns num messages.translate it pls.. */
274 EXPORT_SYMBOL(twl4030_i2c_write);
277 * twl4030_i2c_read - Reads a n bit register in TWL4030
278 * @mod_no: module number
279 * @value: an array of num_bytes containing data to be read
280 * @reg: register address (just offset will do)
281 * @num_bytes: number of bytes to transfer
283 * Returns result of operation - num_bytes is success else failure.
285 int twl4030_i2c_read(u8 mod_no, u8 *value, u8 reg, unsigned num_bytes)
290 struct twl4030_client *twl;
293 if (unlikely(mod_no > TWL4030_MODULE_LAST)) {
294 pr_err("%s: invalid module number %d\n", DRIVER_NAME, mod_no);
297 sid = twl4030_map[mod_no].sid;
298 twl = &twl4030_modules[sid];
300 if (unlikely(!inuse)) {
301 pr_err("%s: client %d is not initialized\n", DRIVER_NAME, sid);
304 mutex_lock(&twl->xfer_lock);
305 /* [MSG1] fill the register address data */
306 msg = &twl->xfer_msg[0];
307 msg->addr = twl->address;
309 msg->flags = 0; /* Read the register value */
310 val = twl4030_map[mod_no].base + reg;
312 /* [MSG2] fill the data rx buffer */
313 msg = &twl->xfer_msg[1];
314 msg->addr = twl->address;
315 msg->flags = I2C_M_RD; /* Read the register value */
316 msg->len = num_bytes; /* only n bytes */
318 ret = i2c_transfer(twl->client->adapter, twl->xfer_msg, 2);
319 mutex_unlock(&twl->xfer_lock);
321 /* i2cTransfer returns num messages.translate it pls.. */
326 EXPORT_SYMBOL(twl4030_i2c_read);
329 * twl4030_i2c_write_u8 - Writes a 8 bit register in TWL4030
330 * @mod_no: module number
331 * @value: the value to be written 8 bit
332 * @reg: register address (just offset will do)
334 * Returns result of operation - 0 is success
336 int twl4030_i2c_write_u8(u8 mod_no, u8 value, u8 reg)
339 /* 2 bytes offset 1 contains the data offset 0 is used by i2c_write */
340 u8 temp_buffer[2] = { 0 };
341 /* offset 1 contains the data */
342 temp_buffer[1] = value;
343 return twl4030_i2c_write(mod_no, temp_buffer, reg, 1);
345 EXPORT_SYMBOL(twl4030_i2c_write_u8);
348 * twl4030_i2c_read_u8 - Reads a 8 bit register from TWL4030
349 * @mod_no: module number
350 * @value: the value read 8 bit
351 * @reg: register address (just offset will do)
353 * Returns result of operation - 0 is success
355 int twl4030_i2c_read_u8(u8 mod_no, u8 *value, u8 reg)
357 return twl4030_i2c_read(mod_no, value, reg, 1);
359 EXPORT_SYMBOL(twl4030_i2c_read_u8);
361 /*----------------------------------------------------------------------*/
364 * NOTE: We know the first 8 IRQs after pdata->base_irq are
365 * for the PIH, and the next are for the PWR_INT SIH, since
366 * that's how twl_init_irq() sets things up.
369 static int add_children(struct twl4030_platform_data *pdata)
371 struct platform_device *pdev = NULL;
372 struct twl4030_client *twl = NULL;
375 if (twl_has_bci() && pdata->bci) {
376 twl = &twl4030_modules[3];
378 pdev = platform_device_alloc("twl4030_bci", -1);
380 pr_debug("%s: can't alloc bci dev\n", DRIVER_NAME);
386 pdev->dev.parent = &twl->client->dev;
387 status = platform_device_add_data(pdev, pdata->bci,
388 sizeof(*pdata->bci));
390 dev_dbg(&twl->client->dev,
391 "can't add bci data, %d\n",
398 struct resource r = {
399 .start = pdata->irq_base + 8 + 1,
400 .flags = IORESOURCE_IRQ,
403 status = platform_device_add_resources(pdev, &r, 1);
407 status = platform_device_add(pdev);
410 platform_device_put(pdev);
411 dev_dbg(&twl->client->dev,
412 "can't create bci dev, %d\n",
418 if (twl_has_gpio() && pdata->gpio) {
419 twl = &twl4030_modules[1];
421 pdev = platform_device_alloc("twl4030_gpio", -1);
423 pr_debug("%s: can't alloc gpio dev\n", DRIVER_NAME);
428 /* more driver model init */
430 pdev->dev.parent = &twl->client->dev;
431 /* device_init_wakeup(&pdev->dev, 1); */
433 status = platform_device_add_data(pdev, pdata->gpio,
434 sizeof(*pdata->gpio));
436 dev_dbg(&twl->client->dev,
437 "can't add gpio data, %d\n",
443 /* GPIO module IRQ */
445 struct resource r = {
446 .start = pdata->irq_base + 0,
447 .flags = IORESOURCE_IRQ,
450 status = platform_device_add_resources(pdev, &r, 1);
454 status = platform_device_add(pdev);
457 platform_device_put(pdev);
458 dev_dbg(&twl->client->dev,
459 "can't create gpio dev, %d\n",
465 if (twl_has_keypad() && pdata->keypad) {
466 pdev = platform_device_alloc("twl4030_keypad", -1);
468 twl = &twl4030_modules[2];
469 pdev->dev.parent = &twl->client->dev;
470 device_init_wakeup(&pdev->dev, 1);
471 status = platform_device_add_data(pdev, pdata->keypad,
472 sizeof(*pdata->keypad));
474 dev_dbg(&twl->client->dev,
475 "can't add keypad data, %d\n",
477 platform_device_put(pdev);
480 status = platform_device_add(pdev);
482 platform_device_put(pdev);
483 dev_dbg(&twl->client->dev,
484 "can't create keypad dev, %d\n",
489 pr_debug("%s: can't alloc keypad dev\n", DRIVER_NAME);
495 if (twl_has_madc() && pdata->madc) {
496 pdev = platform_device_alloc("twl4030_madc", -1);
498 twl = &twl4030_modules[2];
499 pdev->dev.parent = &twl->client->dev;
500 device_init_wakeup(&pdev->dev, 1);
501 status = platform_device_add_data(pdev, pdata->madc,
502 sizeof(*pdata->madc));
504 platform_device_put(pdev);
505 dev_dbg(&twl->client->dev,
506 "can't add madc data, %d\n",
510 status = platform_device_add(pdev);
512 platform_device_put(pdev);
513 dev_dbg(&twl->client->dev,
514 "can't create madc dev, %d\n",
519 pr_debug("%s: can't alloc madc dev\n", DRIVER_NAME);
525 if (twl_has_power() && pdata->power)
526 twl4030_power_init(pdata->power);
529 twl = &twl4030_modules[3];
531 pdev = platform_device_alloc("twl4030_rtc", -1);
533 pr_debug("%s: can't alloc rtc dev\n", DRIVER_NAME);
536 pdev->dev.parent = &twl->client->dev;
537 device_init_wakeup(&pdev->dev, 1);
541 * REVISIT platform_data here currently might use of
542 * "msecure" line ... but for now we just expect board
543 * setup to tell the chip "we are secure" at all times.
544 * Eventually, Linux might become more aware of such
545 * HW security concerns, and "least privilege".
550 struct resource r = {
551 .start = pdata->irq_base + 8 + 3,
552 .flags = IORESOURCE_IRQ,
555 status = platform_device_add_resources(pdev, &r, 1);
559 status = platform_device_add(pdev);
562 platform_device_put(pdev);
563 dev_dbg(&twl->client->dev,
564 "can't create rtc dev, %d\n",
570 if (twl_has_usb() && pdata->usb) {
571 twl = &twl4030_modules[0];
573 pdev = platform_device_alloc("twl4030_usb", -1);
575 pr_debug("%s: can't alloc usb dev\n", DRIVER_NAME);
581 pdev->dev.parent = &twl->client->dev;
582 device_init_wakeup(&pdev->dev, 1);
583 status = platform_device_add_data(pdev, pdata->usb,
584 sizeof(*pdata->usb));
586 platform_device_put(pdev);
587 dev_dbg(&twl->client->dev,
588 "can't add usb data, %d\n",
595 struct resource r = {
596 .start = pdata->irq_base + 8 + 2,
597 .flags = IORESOURCE_IRQ,
600 status = platform_device_add_resources(pdev, &r, 1);
604 status = platform_device_add(pdev);
607 platform_device_put(pdev);
608 dev_dbg(&twl->client->dev,
609 "can't create usb dev, %d\n",
616 pr_err("failed to add twl4030's children (status %d)\n", status);
620 /*----------------------------------------------------------------------*/
623 * These three functions initialize the on-chip clock framework,
624 * letting it generate the right frequencies for USB, MADC, and
627 static inline int __init protect_pm_master(void)
631 e = twl4030_i2c_write_u8(TWL4030_MODULE_PM_MASTER, KEY_LOCK,
636 static inline int __init unprotect_pm_master(void)
640 e |= twl4030_i2c_write_u8(TWL4030_MODULE_PM_MASTER, KEY_UNLOCK1,
642 e |= twl4030_i2c_write_u8(TWL4030_MODULE_PM_MASTER, KEY_UNLOCK2,
647 static void __init clocks_init(void)
652 u8 ctrl = HFCLK_FREQ_26_MHZ;
654 #if defined(CONFIG_ARCH_OMAP2) || defined(CONFIG_ARCH_OMAP3)
655 if (cpu_is_omap2430())
656 osc = clk_get(NULL, "osc_ck");
658 osc = clk_get(NULL, "osc_sys_ck");
660 /* REVISIT for non-OMAP systems, pass the clock rate from
661 * board init code, using platform_data.
666 printk(KERN_WARNING "Skipping twl4030 internal clock init and "
667 "using bootloader value (unknown osc rate)\n");
671 rate = clk_get_rate(osc);
676 ctrl = HFCLK_FREQ_19p2_MHZ;
679 ctrl = HFCLK_FREQ_26_MHZ;
682 ctrl = HFCLK_FREQ_38p4_MHZ;
686 ctrl |= HIGH_PERF_SQ;
687 e |= unprotect_pm_master();
688 /* effect->MADC+USB ck en */
689 e |= twl4030_i2c_write_u8(TWL4030_MODULE_PM_MASTER, ctrl, R_CFG_BOOT);
690 e |= protect_pm_master();
693 pr_err("%s: clock init err [%d]\n", DRIVER_NAME, e);
696 /*----------------------------------------------------------------------*/
698 int twl_init_irq(int irq_num, unsigned irq_base, unsigned irq_end);
699 int twl_exit_irq(void);
701 static int twl4030_remove(struct i2c_client *client)
706 status = twl_exit_irq();
710 for (i = 0; i < TWL4030_NUM_SLAVES; i++) {
711 struct twl4030_client *twl = &twl4030_modules[i];
713 if (twl->client && twl->client != client)
714 i2c_unregister_device(twl->client);
715 twl4030_modules[i].client = NULL;
721 /* NOTE: this driver only handles a single twl4030/tps659x0 chip */
723 twl4030_probe(struct i2c_client *client, const struct i2c_device_id *id)
727 struct twl4030_platform_data *pdata = client->dev.platform_data;
730 dev_dbg(&client->dev, "no platform data?\n");
734 if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C) == 0) {
735 dev_dbg(&client->dev, "can't talk I2C?\n");
740 dev_dbg(&client->dev, "driver is already in use\n");
744 for (i = 0; i < TWL4030_NUM_SLAVES; i++) {
745 struct twl4030_client *twl = &twl4030_modules[i];
747 twl->address = client->addr + i;
749 twl->client = client;
751 twl->client = i2c_new_dummy(client->adapter,
754 dev_err(&twl->client->dev,
755 "can't attach client %d\n", i);
759 strlcpy(twl->client->name, id->name,
760 sizeof(twl->client->name));
762 mutex_init(&twl->xfer_lock);
766 /* setup clock framework */
769 /* Maybe init the T2 Interrupt subsystem */
772 && pdata->irq_end > pdata->irq_base) {
773 status = twl_init_irq(client->irq, pdata->irq_base, pdata->irq_end);
778 status = add_children(pdata);
781 twl4030_remove(client);
785 static const struct i2c_device_id twl4030_ids[] = {
786 { "twl4030", 0 }, /* "Triton 2" */
787 { "tps65950", 0 }, /* catalog version of twl4030 */
788 { "tps65930", 0 }, /* fewer LDOs and DACs; no charger */
789 { "tps65920", 0 }, /* fewer LDOs; no codec or charger */
790 { "twl5030", 0 }, /* T2 updated */
791 { /* end of list */ },
793 MODULE_DEVICE_TABLE(i2c, twl4030_ids);
795 /* One Client Driver , 4 Clients */
796 static struct i2c_driver twl4030_driver = {
797 .driver.name = DRIVER_NAME,
798 .id_table = twl4030_ids,
799 .probe = twl4030_probe,
800 .remove = twl4030_remove,
803 static int __init twl4030_init(void)
805 return i2c_add_driver(&twl4030_driver);
807 subsys_initcall(twl4030_init);
809 static void __exit twl4030_exit(void)
811 i2c_del_driver(&twl4030_driver);
813 module_exit(twl4030_exit);
815 MODULE_AUTHOR("Texas Instruments, Inc.");
816 MODULE_DESCRIPTION("I2C Core interface for TWL4030");
817 MODULE_LICENSE("GPL");