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 xceiv_to_twl(x) container_of((x), struct twl6030_usb, otg)
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;
146 twl = xceiv_to_twl(x);
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;
164 twl = xceiv_to_twl(x);
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 = xceiv_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_phy *x)
183 struct twl6030_usb *twl = xceiv_to_twl(x);
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;
260 u8 vbus_state, hw_state;
262 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS);
264 vbus_state = twl6030_readb(twl, TWL_MODULE_MAIN_CHARGE,
266 if (!(hw_state & STS_USB_ID)) {
267 if (vbus_state & VBUS_DET) {
268 regulator_enable(twl->usb3v3);
270 status = USB_EVENT_VBUS;
271 twl->otg.default_a = false;
272 twl->otg.state = OTG_STATE_B_IDLE;
273 twl->linkstat = status;
274 twl->otg.last_event = status;
275 atomic_notifier_call_chain(&twl->otg.notifier,
276 status, twl->otg.gadget);
278 status = USB_EVENT_NONE;
279 twl->linkstat = status;
280 twl->otg.last_event = status;
281 atomic_notifier_call_chain(&twl->otg.notifier,
282 status, twl->otg.gadget);
284 regulator_disable(twl->usb3v3);
289 sysfs_notify(&twl->dev->kobj, NULL, "vbus");
294 static irqreturn_t twl6030_usbotg_irq(int irq, void *_twl)
296 struct twl6030_usb *twl = _twl;
297 int status = USB_EVENT_NONE;
300 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS);
302 if (hw_state & STS_USB_ID) {
304 regulator_enable(twl->usb3v3);
306 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_CLR, 0x1);
307 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_SET,
309 status = USB_EVENT_ID;
310 twl->otg.default_a = true;
311 twl->otg.state = OTG_STATE_A_IDLE;
312 twl->linkstat = status;
313 twl->otg.last_event = status;
314 atomic_notifier_call_chain(&twl->otg.notifier, status,
317 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_CLR,
319 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_SET,
322 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_LATCH_CLR, status);
327 static int twl6030_set_peripheral(struct usb_phy *x,
328 struct usb_gadget *gadget)
330 struct twl6030_usb *twl;
335 twl = xceiv_to_twl(x);
336 twl->otg.gadget = gadget;
338 twl->otg.state = OTG_STATE_UNDEFINED;
343 static int twl6030_enable_irq(struct usb_phy *x)
345 struct twl6030_usb *twl = xceiv_to_twl(x);
347 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_SET, 0x1);
348 twl6030_interrupt_unmask(0x05, REG_INT_MSK_LINE_C);
349 twl6030_interrupt_unmask(0x05, REG_INT_MSK_STS_C);
351 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK,
353 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK,
355 twl6030_usb_irq(twl->irq2, twl);
356 twl6030_usbotg_irq(twl->irq1, twl);
361 static void otg_set_vbus_work(struct work_struct *data)
363 struct twl6030_usb *twl = container_of(data, struct twl6030_usb,
367 * Start driving VBUS. Set OPA_MODE bit in CHARGERUSB_CTRL1
368 * register. This enables boost mode.
371 if (twl->vbus_enable)
372 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE , 0x40,
375 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE , 0x00,
379 static int twl6030_set_vbus(struct usb_phy *x, bool enabled)
381 struct twl6030_usb *twl = xceiv_to_twl(x);
383 twl->vbus_enable = enabled;
384 schedule_work(&twl->set_vbus_work);
389 static int twl6030_set_host(struct usb_phy *x, struct usb_bus *host)
391 struct twl6030_usb *twl;
396 twl = xceiv_to_twl(x);
397 twl->otg.host = host;
399 twl->otg.state = OTG_STATE_UNDEFINED;
403 static int __devinit twl6030_usb_probe(struct platform_device *pdev)
405 struct twl6030_usb *twl;
407 struct twl4030_usb_data *pdata;
408 struct device *dev = &pdev->dev;
409 pdata = dev->platform_data;
411 twl = kzalloc(sizeof *twl, 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;
419 twl->otg.dev = twl->dev;
420 twl->otg.label = "twl6030";
421 twl->otg.set_host = twl6030_set_host;
422 twl->otg.set_peripheral = twl6030_set_peripheral;
423 twl->otg.set_vbus = twl6030_set_vbus;
424 twl->otg.init = twl6030_phy_init;
425 twl->otg.shutdown = twl6030_phy_shutdown;
426 twl->otg.set_suspend = twl6030_phy_suspend;
427 twl->otg.start_srp = twl6030_start_srp;
429 /* init spinlock for workqueue */
430 spin_lock_init(&twl->lock);
432 err = twl6030_usb_ldo_init(twl);
434 dev_err(&pdev->dev, "ldo init failed\n");
438 otg_set_transceiver(&twl->otg);
440 platform_set_drvdata(pdev, twl);
441 if (device_create_file(&pdev->dev, &dev_attr_vbus))
442 dev_warn(&pdev->dev, "could not create sysfs file\n");
444 ATOMIC_INIT_NOTIFIER_HEAD(&twl->otg.notifier);
446 INIT_WORK(&twl->set_vbus_work, otg_set_vbus_work);
448 twl->irq_enabled = true;
449 status = request_threaded_irq(twl->irq1, NULL, twl6030_usbotg_irq,
450 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING,
453 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
455 device_remove_file(twl->dev, &dev_attr_vbus);
460 status = request_threaded_irq(twl->irq2, NULL, twl6030_usb_irq,
461 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING,
464 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
466 free_irq(twl->irq1, twl);
467 device_remove_file(twl->dev, &dev_attr_vbus);
473 pdata->phy_init(dev);
474 twl6030_phy_suspend(&twl->otg, 0);
475 twl6030_enable_irq(&twl->otg);
476 dev_info(&pdev->dev, "Initialized TWL6030 USB module\n");
481 static int __exit twl6030_usb_remove(struct platform_device *pdev)
483 struct twl6030_usb *twl = platform_get_drvdata(pdev);
485 struct twl4030_usb_data *pdata;
486 struct device *dev = &pdev->dev;
487 pdata = dev->platform_data;
489 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK,
491 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK,
493 free_irq(twl->irq1, twl);
494 free_irq(twl->irq2, twl);
495 regulator_put(twl->usb3v3);
496 pdata->phy_exit(twl->dev);
497 device_remove_file(twl->dev, &dev_attr_vbus);
498 cancel_work_sync(&twl->set_vbus_work);
504 static struct platform_driver twl6030_usb_driver = {
505 .probe = twl6030_usb_probe,
506 .remove = __exit_p(twl6030_usb_remove),
508 .name = "twl6030_usb",
509 .owner = THIS_MODULE,
513 static int __init twl6030_usb_init(void)
515 return platform_driver_register(&twl6030_usb_driver);
517 subsys_initcall(twl6030_usb_init);
519 static void __exit twl6030_usb_exit(void)
521 platform_driver_unregister(&twl6030_usb_driver);
523 module_exit(twl6030_usb_exit);
525 MODULE_ALIAS("platform:twl6030_usb");
526 MODULE_AUTHOR("Hema HK <hemahk@ti.com>");
527 MODULE_DESCRIPTION("TWL6030 USB transceiver driver");
528 MODULE_LICENSE("GPL");