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