2 * twl6030_usb - TWL6030 USB transceiver, talking to OMAP OTG driver.
4 * Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * Author: Hema HK <hemahk@ti.com>
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/interrupt.h>
26 #include <linux/platform_device.h>
28 #include <linux/usb/otg.h>
29 #include <linux/i2c/twl.h>
30 #include <linux/regulator/consumer.h>
31 #include <linux/err.h>
32 #include <linux/notifier.h>
33 #include <linux/slab.h>
34 #include <linux/delay.h>
36 /* usb register definitions */
37 #define USB_VENDOR_ID_LSB 0x00
38 #define USB_VENDOR_ID_MSB 0x01
39 #define USB_PRODUCT_ID_LSB 0x02
40 #define USB_PRODUCT_ID_MSB 0x03
41 #define USB_VBUS_CTRL_SET 0x04
42 #define USB_VBUS_CTRL_CLR 0x05
43 #define USB_ID_CTRL_SET 0x06
44 #define USB_ID_CTRL_CLR 0x07
45 #define USB_VBUS_INT_SRC 0x08
46 #define USB_VBUS_INT_LATCH_SET 0x09
47 #define USB_VBUS_INT_LATCH_CLR 0x0A
48 #define USB_VBUS_INT_EN_LO_SET 0x0B
49 #define USB_VBUS_INT_EN_LO_CLR 0x0C
50 #define USB_VBUS_INT_EN_HI_SET 0x0D
51 #define USB_VBUS_INT_EN_HI_CLR 0x0E
52 #define USB_ID_INT_SRC 0x0F
53 #define USB_ID_INT_LATCH_SET 0x10
54 #define USB_ID_INT_LATCH_CLR 0x11
56 #define USB_ID_INT_EN_LO_SET 0x12
57 #define USB_ID_INT_EN_LO_CLR 0x13
58 #define USB_ID_INT_EN_HI_SET 0x14
59 #define USB_ID_INT_EN_HI_CLR 0x15
60 #define USB_OTG_ADP_CTRL 0x16
61 #define USB_OTG_ADP_HIGH 0x17
62 #define USB_OTG_ADP_LOW 0x18
63 #define USB_OTG_ADP_RISE 0x19
64 #define USB_OTG_REVISION 0x1A
66 /* to be moved to LDO */
67 #define TWL6030_MISC2 0xE5
68 #define TWL6030_CFG_LDO_PD2 0xF5
69 #define TWL6030_BACKUP_REG 0xFA
71 #define STS_HW_CONDITIONS 0x21
73 /* In module TWL6030_MODULE_PM_MASTER */
74 #define STS_HW_CONDITIONS 0x21
75 #define STS_USB_ID BIT(2)
77 /* In module TWL6030_MODULE_PM_RECEIVER */
78 #define VUSB_CFG_TRANS 0x71
79 #define VUSB_CFG_STATE 0x72
80 #define VUSB_CFG_VOLTAGE 0x73
82 /* in module TWL6030_MODULE_MAIN_CHARGE */
84 #define CHARGERUSB_CTRL1 0x8
86 #define CONTROLLER_STAT1 0x03
87 #define VBUS_DET BIT(2)
93 /* for vbus reporting with irqs disabled */
96 struct regulator
*usb3v3
;
98 /* used to set vbus, in atomic path */
99 struct work_struct set_vbus_work
;
107 unsigned long features
;
110 #define phy_to_twl(x) container_of((x), struct twl6030_usb, phy)
112 /*-------------------------------------------------------------------------*/
114 static inline int twl6030_writeb(struct twl6030_usb
*twl
, u8 module
,
119 ret
= twl_i2c_write_u8(module
, data
, address
);
122 "Write[0x%x] Error %d\n", address
, ret
);
126 static inline u8
twl6030_readb(struct twl6030_usb
*twl
, u8 module
, u8 address
)
130 ret
= twl_i2c_read_u8(module
, &data
, address
);
135 "readb[0x%x,0x%x] Error %d\n",
136 module
, address
, ret
);
140 static int twl6030_phy_init(struct usb_phy
*x
)
142 struct twl6030_usb
*twl
;
144 struct twl4030_usb_data
*pdata
;
148 pdata
= dev
->platform_data
;
150 if (twl
->linkstat
== USB_EVENT_ID
)
151 pdata
->phy_power(twl
->dev
, 1, 1);
153 pdata
->phy_power(twl
->dev
, 0, 1);
158 static void twl6030_phy_shutdown(struct usb_phy
*x
)
160 struct twl6030_usb
*twl
;
162 struct twl4030_usb_data
*pdata
;
166 pdata
= dev
->platform_data
;
167 pdata
->phy_power(twl
->dev
, 0, 0);
170 static int twl6030_phy_suspend(struct usb_phy
*x
, int suspend
)
172 struct twl6030_usb
*twl
= phy_to_twl(x
);
173 struct device
*dev
= twl
->dev
;
174 struct twl4030_usb_data
*pdata
= dev
->platform_data
;
176 pdata
->phy_suspend(dev
, suspend
);
181 static int twl6030_start_srp(struct usb_otg
*otg
)
183 struct twl6030_usb
*twl
= phy_to_twl(otg
->phy
);
185 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x24, USB_VBUS_CTRL_SET
);
186 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x84, USB_VBUS_CTRL_SET
);
189 twl6030_writeb(twl
, TWL_MODULE_USB
, 0xa0, USB_VBUS_CTRL_CLR
);
194 static int twl6030_usb_ldo_init(struct twl6030_usb
*twl
)
196 char *regulator_name
;
198 if (twl
->features
& TWL6025_SUBCLASS
)
199 regulator_name
= "ldousb";
201 regulator_name
= "vusb";
203 /* Set to OTG_REV 1.3 and turn on the ID_WAKEUP_COMP */
204 twl6030_writeb(twl
, TWL6030_MODULE_ID0
, 0x1, TWL6030_BACKUP_REG
);
206 /* Program CFG_LDO_PD2 register and set VUSB bit */
207 twl6030_writeb(twl
, TWL6030_MODULE_ID0
, 0x1, TWL6030_CFG_LDO_PD2
);
209 /* Program MISC2 register and set bit VUSB_IN_VBAT */
210 twl6030_writeb(twl
, TWL6030_MODULE_ID0
, 0x10, TWL6030_MISC2
);
212 twl
->usb3v3
= regulator_get(twl
->dev
, regulator_name
);
213 if (IS_ERR(twl
->usb3v3
))
216 /* Program the USB_VBUS_CTRL_SET and set VBUS_ACT_COMP bit */
217 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x4, USB_VBUS_CTRL_SET
);
220 * Program the USB_ID_CTRL_SET register to enable GND drive
221 * and the ID comparators
223 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x14, USB_ID_CTRL_SET
);
228 static ssize_t
twl6030_usb_vbus_show(struct device
*dev
,
229 struct device_attribute
*attr
, char *buf
)
231 struct twl6030_usb
*twl
= dev_get_drvdata(dev
);
235 spin_lock_irqsave(&twl
->lock
, flags
);
237 switch (twl
->linkstat
) {
239 ret
= snprintf(buf
, PAGE_SIZE
, "vbus\n");
242 ret
= snprintf(buf
, PAGE_SIZE
, "id\n");
245 ret
= snprintf(buf
, PAGE_SIZE
, "none\n");
248 ret
= snprintf(buf
, PAGE_SIZE
, "UNKNOWN\n");
250 spin_unlock_irqrestore(&twl
->lock
, flags
);
254 static DEVICE_ATTR(vbus
, 0444, twl6030_usb_vbus_show
, NULL
);
256 static irqreturn_t
twl6030_usb_irq(int irq
, void *_twl
)
258 struct twl6030_usb
*twl
= _twl
;
259 struct usb_otg
*otg
= twl
->phy
.otg
;
261 u8 vbus_state
, hw_state
;
263 hw_state
= twl6030_readb(twl
, TWL6030_MODULE_ID0
, STS_HW_CONDITIONS
);
265 vbus_state
= twl6030_readb(twl
, TWL_MODULE_MAIN_CHARGE
,
267 if (!(hw_state
& STS_USB_ID
)) {
268 if (vbus_state
& VBUS_DET
) {
269 regulator_enable(twl
->usb3v3
);
271 status
= USB_EVENT_VBUS
;
272 otg
->default_a
= false;
273 twl
->phy
.state
= OTG_STATE_B_IDLE
;
274 twl
->linkstat
= status
;
275 twl
->phy
.last_event
= status
;
276 atomic_notifier_call_chain(&twl
->phy
.notifier
,
277 status
, otg
->gadget
);
279 status
= USB_EVENT_NONE
;
280 twl
->linkstat
= status
;
281 twl
->phy
.last_event
= status
;
282 atomic_notifier_call_chain(&twl
->phy
.notifier
,
283 status
, otg
->gadget
);
285 regulator_disable(twl
->usb3v3
);
290 sysfs_notify(&twl
->dev
->kobj
, NULL
, "vbus");
295 static irqreturn_t
twl6030_usbotg_irq(int irq
, void *_twl
)
297 struct twl6030_usb
*twl
= _twl
;
298 struct usb_otg
*otg
= twl
->phy
.otg
;
299 int status
= USB_EVENT_NONE
;
302 hw_state
= twl6030_readb(twl
, TWL6030_MODULE_ID0
, STS_HW_CONDITIONS
);
304 if (hw_state
& STS_USB_ID
) {
306 regulator_enable(twl
->usb3v3
);
308 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x1, USB_ID_INT_EN_HI_CLR
);
309 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x10, USB_ID_INT_EN_HI_SET
);
310 status
= USB_EVENT_ID
;
311 otg
->default_a
= true;
312 twl
->phy
.state
= OTG_STATE_A_IDLE
;
313 twl
->linkstat
= status
;
314 twl
->phy
.last_event
= status
;
315 atomic_notifier_call_chain(&twl
->phy
.notifier
, status
,
318 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x10, USB_ID_INT_EN_HI_CLR
);
319 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x1, USB_ID_INT_EN_HI_SET
);
321 twl6030_writeb(twl
, TWL_MODULE_USB
, status
, USB_ID_INT_LATCH_CLR
);
326 static int twl6030_set_peripheral(struct usb_otg
*otg
,
327 struct usb_gadget
*gadget
)
332 otg
->gadget
= gadget
;
334 otg
->phy
->state
= OTG_STATE_UNDEFINED
;
339 static int twl6030_enable_irq(struct usb_phy
*x
)
341 struct twl6030_usb
*twl
= phy_to_twl(x
);
343 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x1, USB_ID_INT_EN_HI_SET
);
344 twl6030_interrupt_unmask(0x05, REG_INT_MSK_LINE_C
);
345 twl6030_interrupt_unmask(0x05, REG_INT_MSK_STS_C
);
347 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK
,
349 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK
,
351 twl6030_usb_irq(twl
->irq2
, twl
);
352 twl6030_usbotg_irq(twl
->irq1
, twl
);
357 static void otg_set_vbus_work(struct work_struct
*data
)
359 struct twl6030_usb
*twl
= container_of(data
, struct twl6030_usb
,
363 * Start driving VBUS. Set OPA_MODE bit in CHARGERUSB_CTRL1
364 * register. This enables boost mode.
367 if (twl
->vbus_enable
)
368 twl6030_writeb(twl
, TWL_MODULE_MAIN_CHARGE
, 0x40,
371 twl6030_writeb(twl
, TWL_MODULE_MAIN_CHARGE
, 0x00,
375 static int twl6030_set_vbus(struct usb_otg
*otg
, bool enabled
)
377 struct twl6030_usb
*twl
= phy_to_twl(otg
->phy
);
379 twl
->vbus_enable
= enabled
;
380 schedule_work(&twl
->set_vbus_work
);
385 static int twl6030_set_host(struct usb_otg
*otg
, struct usb_bus
*host
)
392 otg
->phy
->state
= OTG_STATE_UNDEFINED
;
396 static int __devinit
twl6030_usb_probe(struct platform_device
*pdev
)
398 struct twl6030_usb
*twl
;
400 struct twl4030_usb_data
*pdata
;
402 struct device
*dev
= &pdev
->dev
;
403 pdata
= dev
->platform_data
;
405 twl
= kzalloc(sizeof *twl
, GFP_KERNEL
);
409 otg
= kzalloc(sizeof *otg
, GFP_KERNEL
);
415 twl
->dev
= &pdev
->dev
;
416 twl
->irq1
= platform_get_irq(pdev
, 0);
417 twl
->irq2
= platform_get_irq(pdev
, 1);
418 twl
->features
= pdata
->features
;
420 twl
->phy
.dev
= twl
->dev
;
421 twl
->phy
.label
= "twl6030";
423 twl
->phy
.init
= twl6030_phy_init
;
424 twl
->phy
.shutdown
= twl6030_phy_shutdown
;
425 twl
->phy
.set_suspend
= twl6030_phy_suspend
;
427 otg
->phy
= &twl
->phy
;
428 otg
->set_host
= twl6030_set_host
;
429 otg
->set_peripheral
= twl6030_set_peripheral
;
430 otg
->set_vbus
= twl6030_set_vbus
;
431 otg
->start_srp
= twl6030_start_srp
;
433 /* init spinlock for workqueue */
434 spin_lock_init(&twl
->lock
);
436 err
= twl6030_usb_ldo_init(twl
);
438 dev_err(&pdev
->dev
, "ldo init failed\n");
443 usb_set_transceiver(&twl
->phy
);
445 platform_set_drvdata(pdev
, twl
);
446 if (device_create_file(&pdev
->dev
, &dev_attr_vbus
))
447 dev_warn(&pdev
->dev
, "could not create sysfs file\n");
449 ATOMIC_INIT_NOTIFIER_HEAD(&twl
->phy
.notifier
);
451 INIT_WORK(&twl
->set_vbus_work
, otg_set_vbus_work
);
453 twl
->irq_enabled
= true;
454 status
= request_threaded_irq(twl
->irq1
, NULL
, twl6030_usbotg_irq
,
455 IRQF_TRIGGER_FALLING
| IRQF_TRIGGER_RISING
| IRQF_ONESHOT
,
458 dev_err(&pdev
->dev
, "can't get IRQ %d, err %d\n",
460 device_remove_file(twl
->dev
, &dev_attr_vbus
);
466 status
= request_threaded_irq(twl
->irq2
, NULL
, twl6030_usb_irq
,
467 IRQF_TRIGGER_FALLING
| IRQF_TRIGGER_RISING
| IRQF_ONESHOT
,
470 dev_err(&pdev
->dev
, "can't get IRQ %d, err %d\n",
472 free_irq(twl
->irq1
, twl
);
473 device_remove_file(twl
->dev
, &dev_attr_vbus
);
480 pdata
->phy_init(dev
);
481 twl6030_phy_suspend(&twl
->phy
, 0);
482 twl6030_enable_irq(&twl
->phy
);
483 dev_info(&pdev
->dev
, "Initialized TWL6030 USB module\n");
488 static int __exit
twl6030_usb_remove(struct platform_device
*pdev
)
490 struct twl6030_usb
*twl
= platform_get_drvdata(pdev
);
492 struct twl4030_usb_data
*pdata
;
493 struct device
*dev
= &pdev
->dev
;
494 pdata
= dev
->platform_data
;
496 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK
,
498 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK
,
500 free_irq(twl
->irq1
, twl
);
501 free_irq(twl
->irq2
, twl
);
502 regulator_put(twl
->usb3v3
);
503 pdata
->phy_exit(twl
->dev
);
504 device_remove_file(twl
->dev
, &dev_attr_vbus
);
505 cancel_work_sync(&twl
->set_vbus_work
);
512 static struct platform_driver twl6030_usb_driver
= {
513 .probe
= twl6030_usb_probe
,
514 .remove
= __exit_p(twl6030_usb_remove
),
516 .name
= "twl6030_usb",
517 .owner
= THIS_MODULE
,
521 static int __init
twl6030_usb_init(void)
523 return platform_driver_register(&twl6030_usb_driver
);
525 subsys_initcall(twl6030_usb_init
);
527 static void __exit
twl6030_usb_exit(void)
529 platform_driver_unregister(&twl6030_usb_driver
);
531 module_exit(twl6030_usb_exit
);
533 MODULE_ALIAS("platform:twl6030_usb");
534 MODULE_AUTHOR("Hema HK <hemahk@ti.com>");
535 MODULE_DESCRIPTION("TWL6030 USB transceiver driver");
536 MODULE_LICENSE("GPL");