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