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/musb-omap.h>
29 #include <linux/usb/phy_companion.h>
30 #include <linux/usb/omap_usb.h>
31 #include <linux/i2c/twl.h>
32 #include <linux/regulator/consumer.h>
33 #include <linux/err.h>
34 #include <linux/slab.h>
35 #include <linux/delay.h>
38 /* usb register definitions */
39 #define USB_VENDOR_ID_LSB 0x00
40 #define USB_VENDOR_ID_MSB 0x01
41 #define USB_PRODUCT_ID_LSB 0x02
42 #define USB_PRODUCT_ID_MSB 0x03
43 #define USB_VBUS_CTRL_SET 0x04
44 #define USB_VBUS_CTRL_CLR 0x05
45 #define USB_ID_CTRL_SET 0x06
46 #define USB_ID_CTRL_CLR 0x07
47 #define USB_VBUS_INT_SRC 0x08
48 #define USB_VBUS_INT_LATCH_SET 0x09
49 #define USB_VBUS_INT_LATCH_CLR 0x0A
50 #define USB_VBUS_INT_EN_LO_SET 0x0B
51 #define USB_VBUS_INT_EN_LO_CLR 0x0C
52 #define USB_VBUS_INT_EN_HI_SET 0x0D
53 #define USB_VBUS_INT_EN_HI_CLR 0x0E
54 #define USB_ID_INT_SRC 0x0F
55 #define USB_ID_INT_LATCH_SET 0x10
56 #define USB_ID_INT_LATCH_CLR 0x11
58 #define USB_ID_INT_EN_LO_SET 0x12
59 #define USB_ID_INT_EN_LO_CLR 0x13
60 #define USB_ID_INT_EN_HI_SET 0x14
61 #define USB_ID_INT_EN_HI_CLR 0x15
62 #define USB_OTG_ADP_CTRL 0x16
63 #define USB_OTG_ADP_HIGH 0x17
64 #define USB_OTG_ADP_LOW 0x18
65 #define USB_OTG_ADP_RISE 0x19
66 #define USB_OTG_REVISION 0x1A
68 /* to be moved to LDO */
69 #define TWL6030_MISC2 0xE5
70 #define TWL6030_CFG_LDO_PD2 0xF5
71 #define TWL6030_BACKUP_REG 0xFA
73 #define STS_HW_CONDITIONS 0x21
75 /* In module TWL6030_MODULE_PM_MASTER */
76 #define STS_HW_CONDITIONS 0x21
77 #define STS_USB_ID BIT(2)
79 /* In module TWL6030_MODULE_PM_RECEIVER */
80 #define VUSB_CFG_TRANS 0x71
81 #define VUSB_CFG_STATE 0x72
82 #define VUSB_CFG_VOLTAGE 0x73
84 /* in module TWL6030_MODULE_MAIN_CHARGE */
86 #define CHARGERUSB_CTRL1 0x8
88 #define CONTROLLER_STAT1 0x03
89 #define VBUS_DET BIT(2)
92 struct phy_companion comparator
;
95 /* for vbus reporting with irqs disabled */
98 struct regulator
*usb3v3
;
100 /* used to set vbus, in atomic path */
101 struct work_struct set_vbus_work
;
105 enum omap_musb_vbus_id_status linkstat
;
109 const char *regulator
;
112 #define comparator_to_twl(x) container_of((x), struct twl6030_usb, comparator)
114 /*-------------------------------------------------------------------------*/
116 static inline int twl6030_writeb(struct twl6030_usb
*twl
, u8 module
,
121 ret
= twl_i2c_write_u8(module
, data
, address
);
124 "Write[0x%x] Error %d\n", address
, ret
);
128 static inline u8
twl6030_readb(struct twl6030_usb
*twl
, u8 module
, u8 address
)
133 ret
= twl_i2c_read_u8(module
, &data
, address
);
138 "readb[0x%x,0x%x] Error %d\n",
139 module
, address
, ret
);
143 static int twl6030_start_srp(struct phy_companion
*comparator
)
145 struct twl6030_usb
*twl
= comparator_to_twl(comparator
);
147 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x24, USB_VBUS_CTRL_SET
);
148 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x84, USB_VBUS_CTRL_SET
);
151 twl6030_writeb(twl
, TWL_MODULE_USB
, 0xa0, USB_VBUS_CTRL_CLR
);
156 static int twl6030_usb_ldo_init(struct twl6030_usb
*twl
)
158 /* Set to OTG_REV 1.3 and turn on the ID_WAKEUP_COMP */
159 twl6030_writeb(twl
, TWL6030_MODULE_ID0
, 0x1, TWL6030_BACKUP_REG
);
161 /* Program CFG_LDO_PD2 register and set VUSB bit */
162 twl6030_writeb(twl
, TWL6030_MODULE_ID0
, 0x1, TWL6030_CFG_LDO_PD2
);
164 /* Program MISC2 register and set bit VUSB_IN_VBAT */
165 twl6030_writeb(twl
, TWL6030_MODULE_ID0
, 0x10, TWL6030_MISC2
);
167 twl
->usb3v3
= regulator_get(twl
->dev
, twl
->regulator
);
168 if (IS_ERR(twl
->usb3v3
))
171 /* Program the USB_VBUS_CTRL_SET and set VBUS_ACT_COMP bit */
172 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x4, USB_VBUS_CTRL_SET
);
175 * Program the USB_ID_CTRL_SET register to enable GND drive
176 * and the ID comparators
178 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x14, USB_ID_CTRL_SET
);
183 static ssize_t
twl6030_usb_vbus_show(struct device
*dev
,
184 struct device_attribute
*attr
, char *buf
)
186 struct twl6030_usb
*twl
= dev_get_drvdata(dev
);
190 spin_lock_irqsave(&twl
->lock
, flags
);
192 switch (twl
->linkstat
) {
193 case OMAP_MUSB_VBUS_VALID
:
194 ret
= snprintf(buf
, PAGE_SIZE
, "vbus\n");
196 case OMAP_MUSB_ID_GROUND
:
197 ret
= snprintf(buf
, PAGE_SIZE
, "id\n");
199 case OMAP_MUSB_VBUS_OFF
:
200 ret
= snprintf(buf
, PAGE_SIZE
, "none\n");
203 ret
= snprintf(buf
, PAGE_SIZE
, "UNKNOWN\n");
205 spin_unlock_irqrestore(&twl
->lock
, flags
);
209 static DEVICE_ATTR(vbus
, 0444, twl6030_usb_vbus_show
, NULL
);
211 static irqreturn_t
twl6030_usb_irq(int irq
, void *_twl
)
213 struct twl6030_usb
*twl
= _twl
;
214 enum omap_musb_vbus_id_status status
= OMAP_MUSB_UNKNOWN
;
215 u8 vbus_state
, hw_state
;
218 hw_state
= twl6030_readb(twl
, TWL6030_MODULE_ID0
, STS_HW_CONDITIONS
);
220 vbus_state
= twl6030_readb(twl
, TWL_MODULE_MAIN_CHARGE
,
222 if (!(hw_state
& STS_USB_ID
)) {
223 if (vbus_state
& VBUS_DET
) {
224 ret
= regulator_enable(twl
->usb3v3
);
226 dev_err(twl
->dev
, "Failed to enable usb3v3\n");
229 status
= OMAP_MUSB_VBUS_VALID
;
230 twl
->linkstat
= status
;
231 omap_musb_mailbox(status
);
233 if (twl
->linkstat
!= OMAP_MUSB_UNKNOWN
) {
234 status
= OMAP_MUSB_VBUS_OFF
;
235 twl
->linkstat
= status
;
236 omap_musb_mailbox(status
);
238 regulator_disable(twl
->usb3v3
);
244 sysfs_notify(&twl
->dev
->kobj
, NULL
, "vbus");
249 static irqreturn_t
twl6030_usbotg_irq(int irq
, void *_twl
)
251 struct twl6030_usb
*twl
= _twl
;
252 enum omap_musb_vbus_id_status status
= OMAP_MUSB_UNKNOWN
;
256 hw_state
= twl6030_readb(twl
, TWL6030_MODULE_ID0
, STS_HW_CONDITIONS
);
258 if (hw_state
& STS_USB_ID
) {
259 ret
= regulator_enable(twl
->usb3v3
);
261 dev_err(twl
->dev
, "Failed to enable usb3v3\n");
264 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x1, USB_ID_INT_EN_HI_CLR
);
265 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x10, USB_ID_INT_EN_HI_SET
);
266 status
= OMAP_MUSB_ID_GROUND
;
267 twl
->linkstat
= status
;
268 omap_musb_mailbox(status
);
270 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x10, USB_ID_INT_EN_HI_CLR
);
271 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x1, USB_ID_INT_EN_HI_SET
);
273 twl6030_writeb(twl
, TWL_MODULE_USB
, status
, USB_ID_INT_LATCH_CLR
);
278 static int twl6030_enable_irq(struct twl6030_usb
*twl
)
280 twl6030_writeb(twl
, TWL_MODULE_USB
, 0x1, USB_ID_INT_EN_HI_SET
);
281 twl6030_interrupt_unmask(0x05, REG_INT_MSK_LINE_C
);
282 twl6030_interrupt_unmask(0x05, REG_INT_MSK_STS_C
);
284 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK
,
286 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK
,
288 twl6030_usb_irq(twl
->irq2
, twl
);
289 twl6030_usbotg_irq(twl
->irq1
, twl
);
294 static void otg_set_vbus_work(struct work_struct
*data
)
296 struct twl6030_usb
*twl
= container_of(data
, struct twl6030_usb
,
300 * Start driving VBUS. Set OPA_MODE bit in CHARGERUSB_CTRL1
301 * register. This enables boost mode.
304 if (twl
->vbus_enable
)
305 twl6030_writeb(twl
, TWL_MODULE_MAIN_CHARGE
, 0x40,
308 twl6030_writeb(twl
, TWL_MODULE_MAIN_CHARGE
, 0x00,
312 static int twl6030_set_vbus(struct phy_companion
*comparator
, bool enabled
)
314 struct twl6030_usb
*twl
= comparator_to_twl(comparator
);
316 twl
->vbus_enable
= enabled
;
317 schedule_work(&twl
->set_vbus_work
);
322 static int twl6030_usb_probe(struct platform_device
*pdev
)
325 struct twl6030_usb
*twl
;
327 struct device_node
*np
= pdev
->dev
.of_node
;
328 struct device
*dev
= &pdev
->dev
;
329 struct twl4030_usb_data
*pdata
= dev_get_platdata(dev
);
331 twl
= devm_kzalloc(dev
, sizeof(*twl
), GFP_KERNEL
);
335 twl
->dev
= &pdev
->dev
;
336 twl
->irq1
= platform_get_irq(pdev
, 0);
337 twl
->irq2
= platform_get_irq(pdev
, 1);
338 twl
->linkstat
= OMAP_MUSB_UNKNOWN
;
340 twl
->comparator
.set_vbus
= twl6030_set_vbus
;
341 twl
->comparator
.start_srp
= twl6030_start_srp
;
343 ret
= omap_usb2_set_comparator(&twl
->comparator
);
344 if (ret
== -ENODEV
) {
345 dev_info(&pdev
->dev
, "phy not ready, deferring probe");
346 return -EPROBE_DEFER
;
350 twl
->regulator
= "usb";
352 if (pdata
->features
& TWL6032_SUBCLASS
)
353 twl
->regulator
= "ldousb";
355 twl
->regulator
= "vusb";
357 dev_err(&pdev
->dev
, "twl6030 initialized without pdata\n");
361 /* init spinlock for workqueue */
362 spin_lock_init(&twl
->lock
);
364 err
= twl6030_usb_ldo_init(twl
);
366 dev_err(&pdev
->dev
, "ldo init failed\n");
370 platform_set_drvdata(pdev
, twl
);
371 if (device_create_file(&pdev
->dev
, &dev_attr_vbus
))
372 dev_warn(&pdev
->dev
, "could not create sysfs file\n");
374 INIT_WORK(&twl
->set_vbus_work
, otg_set_vbus_work
);
376 twl
->irq_enabled
= true;
377 status
= request_threaded_irq(twl
->irq1
, NULL
, twl6030_usbotg_irq
,
378 IRQF_TRIGGER_FALLING
| IRQF_TRIGGER_RISING
| IRQF_ONESHOT
,
381 dev_err(&pdev
->dev
, "can't get IRQ %d, err %d\n",
383 device_remove_file(twl
->dev
, &dev_attr_vbus
);
387 status
= request_threaded_irq(twl
->irq2
, NULL
, twl6030_usb_irq
,
388 IRQF_TRIGGER_FALLING
| IRQF_TRIGGER_RISING
| IRQF_ONESHOT
,
391 dev_err(&pdev
->dev
, "can't get IRQ %d, err %d\n",
393 free_irq(twl
->irq1
, twl
);
394 device_remove_file(twl
->dev
, &dev_attr_vbus
);
399 twl6030_enable_irq(twl
);
400 dev_info(&pdev
->dev
, "Initialized TWL6030 USB module\n");
405 static int twl6030_usb_remove(struct platform_device
*pdev
)
407 struct twl6030_usb
*twl
= platform_get_drvdata(pdev
);
409 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK
,
411 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK
,
413 free_irq(twl
->irq1
, twl
);
414 free_irq(twl
->irq2
, twl
);
415 regulator_put(twl
->usb3v3
);
416 device_remove_file(twl
->dev
, &dev_attr_vbus
);
417 cancel_work_sync(&twl
->set_vbus_work
);
423 static const struct of_device_id twl6030_usb_id_table
[] = {
424 { .compatible
= "ti,twl6030-usb" },
427 MODULE_DEVICE_TABLE(of
, twl6030_usb_id_table
);
430 static struct platform_driver twl6030_usb_driver
= {
431 .probe
= twl6030_usb_probe
,
432 .remove
= twl6030_usb_remove
,
434 .name
= "twl6030_usb",
435 .owner
= THIS_MODULE
,
436 .of_match_table
= of_match_ptr(twl6030_usb_id_table
),
440 static int __init
twl6030_usb_init(void)
442 return platform_driver_register(&twl6030_usb_driver
);
444 subsys_initcall(twl6030_usb_init
);
446 static void __exit
twl6030_usb_exit(void)
448 platform_driver_unregister(&twl6030_usb_driver
);
450 module_exit(twl6030_usb_exit
);
452 MODULE_ALIAS("platform:twl6030_usb");
453 MODULE_AUTHOR("Hema HK <hemahk@ti.com>");
454 MODULE_DESCRIPTION("TWL6030 USB transceiver driver");
455 MODULE_LICENSE("GPL");