1 /*
2 * twl6030_usb - TWL6030 USB transceiver, talking to OMAP OTG driver.
3 *
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.
9 *
10 * Author: Hema HK <hemahk@ti.com>
11 *
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.
16 *
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.
20 *
21 */
22
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/interrupt.h>
26 #include <linux/platform_device.h>
27 #include <linux/io.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>
35
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
55
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
65
66 /* to be moved to LDO */
67 #define TWL6030_MISC2 0xE5
68 #define TWL6030_CFG_LDO_PD2 0xF5
69 #define TWL6030_BACKUP_REG 0xFA
70
71 #define STS_HW_CONDITIONS 0x21
72
73 /* In module TWL6030_MODULE_PM_MASTER */
74 #define STS_HW_CONDITIONS 0x21
75 #define STS_USB_ID BIT(2)
76
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
81
82 /* in module TWL6030_MODULE_MAIN_CHARGE */
83
84 #define CHARGERUSB_CTRL1 0x8
85
86 #define CONTROLLER_STAT1 0x03
87 #define VBUS_DET BIT(2)
88
89 struct twl6030_usb {
90 struct usb_phy phy;
91 struct device *dev;
92
93 /* for vbus reporting with irqs disabled */
94 spinlock_t lock;
95
96 struct regulator *usb3v3;
97
98 /* used to set vbus, in atomic path */
99 struct work_struct set_vbus_work;
100
101 int irq1;
102 int irq2;
103 u8 linkstat;
104 u8 asleep;
105 bool irq_enabled;
106 bool vbus_enable;
107 unsigned long features;
108 };
109
110 #define phy_to_twl(x) container_of((x), struct twl6030_usb, phy)
111
112 /*-------------------------------------------------------------------------*/
113
twl6030_writeb(struct twl6030_usb * twl,u8 module,u8 data,u8 address)114 static inline int twl6030_writeb(struct twl6030_usb *twl, u8 module,
115 u8 data, u8 address)
116 {
117 int ret = 0;
118
119 ret = twl_i2c_write_u8(module, data, address);
120 if (ret < 0)
121 dev_err(twl->dev,
122 "Write[0x%x] Error %d\n", address, ret);
123 return ret;
124 }
125
twl6030_readb(struct twl6030_usb * twl,u8 module,u8 address)126 static inline u8 twl6030_readb(struct twl6030_usb *twl, u8 module, u8 address)
127 {
128 u8 data, ret = 0;
129
130 ret = twl_i2c_read_u8(module, &data, address);
131 if (ret >= 0)
132 ret = data;
133 else
134 dev_err(twl->dev,
135 "readb[0x%x,0x%x] Error %d\n",
136 module, address, ret);
137 return ret;
138 }
139
twl6030_phy_init(struct usb_phy * x)140 static int twl6030_phy_init(struct usb_phy *x)
141 {
142 struct twl6030_usb *twl;
143 struct device *dev;
144 struct twl4030_usb_data *pdata;
145
146 twl = phy_to_twl(x);
147 dev = twl->dev;
148 pdata = dev->platform_data;
149
150 if (twl->linkstat == USB_EVENT_ID)
151 pdata->phy_power(twl->dev, 1, 1);
152 else
153 pdata->phy_power(twl->dev, 0, 1);
154
155 return 0;
156 }
157
twl6030_phy_shutdown(struct usb_phy * x)158 static void twl6030_phy_shutdown(struct usb_phy *x)
159 {
160 struct twl6030_usb *twl;
161 struct device *dev;
162 struct twl4030_usb_data *pdata;
163
164 twl = phy_to_twl(x);
165 dev = twl->dev;
166 pdata = dev->platform_data;
167 pdata->phy_power(twl->dev, 0, 0);
168 }
169
twl6030_phy_suspend(struct usb_phy * x,int suspend)170 static int twl6030_phy_suspend(struct usb_phy *x, int suspend)
171 {
172 struct twl6030_usb *twl = phy_to_twl(x);
173 struct device *dev = twl->dev;
174 struct twl4030_usb_data *pdata = dev->platform_data;
175
176 pdata->phy_suspend(dev, suspend);
177
178 return 0;
179 }
180
twl6030_start_srp(struct usb_otg * otg)181 static int twl6030_start_srp(struct usb_otg *otg)
182 {
183 struct twl6030_usb *twl = phy_to_twl(otg->phy);
184
185 twl6030_writeb(twl, TWL_MODULE_USB, 0x24, USB_VBUS_CTRL_SET);
186 twl6030_writeb(twl, TWL_MODULE_USB, 0x84, USB_VBUS_CTRL_SET);
187
188 mdelay(100);
189 twl6030_writeb(twl, TWL_MODULE_USB, 0xa0, USB_VBUS_CTRL_CLR);
190
191 return 0;
192 }
193
twl6030_usb_ldo_init(struct twl6030_usb * twl)194 static int twl6030_usb_ldo_init(struct twl6030_usb *twl)
195 {
196 char *regulator_name;
197
198 if (twl->features & TWL6025_SUBCLASS)
199 regulator_name = "ldousb";
200 else
201 regulator_name = "vusb";
202
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);
205
206 /* Program CFG_LDO_PD2 register and set VUSB bit */
207 twl6030_writeb(twl, TWL6030_MODULE_ID0 , 0x1, TWL6030_CFG_LDO_PD2);
208
209 /* Program MISC2 register and set bit VUSB_IN_VBAT */
210 twl6030_writeb(twl, TWL6030_MODULE_ID0 , 0x10, TWL6030_MISC2);
211
212 twl->usb3v3 = regulator_get(twl->dev, regulator_name);
213 if (IS_ERR(twl->usb3v3))
214 return -ENODEV;
215
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);
218
219 /*
220 * Program the USB_ID_CTRL_SET register to enable GND drive
221 * and the ID comparators
222 */
223 twl6030_writeb(twl, TWL_MODULE_USB, 0x14, USB_ID_CTRL_SET);
224
225 return 0;
226 }
227
twl6030_usb_vbus_show(struct device * dev,struct device_attribute * attr,char * buf)228 static ssize_t twl6030_usb_vbus_show(struct device *dev,
229 struct device_attribute *attr, char *buf)
230 {
231 struct twl6030_usb *twl = dev_get_drvdata(dev);
232 unsigned long flags;
233 int ret = -EINVAL;
234
235 spin_lock_irqsave(&twl->lock, flags);
236
237 switch (twl->linkstat) {
238 case USB_EVENT_VBUS:
239 ret = snprintf(buf, PAGE_SIZE, "vbus\n");
240 break;
241 case USB_EVENT_ID:
242 ret = snprintf(buf, PAGE_SIZE, "id\n");
243 break;
244 case USB_EVENT_NONE:
245 ret = snprintf(buf, PAGE_SIZE, "none\n");
246 break;
247 default:
248 ret = snprintf(buf, PAGE_SIZE, "UNKNOWN\n");
249 }
250 spin_unlock_irqrestore(&twl->lock, flags);
251
252 return ret;
253 }
254 static DEVICE_ATTR(vbus, 0444, twl6030_usb_vbus_show, NULL);
255
twl6030_usb_irq(int irq,void * _twl)256 static irqreturn_t twl6030_usb_irq(int irq, void *_twl)
257 {
258 struct twl6030_usb *twl = _twl;
259 struct usb_otg *otg = twl->phy.otg;
260 int status;
261 u8 vbus_state, hw_state;
262
263 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS);
264
265 vbus_state = twl6030_readb(twl, TWL_MODULE_MAIN_CHARGE,
266 CONTROLLER_STAT1);
267 if (!(hw_state & STS_USB_ID)) {
268 if (vbus_state & VBUS_DET) {
269 regulator_enable(twl->usb3v3);
270 twl->asleep = 1;
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);
278 } else {
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);
284 if (twl->asleep) {
285 regulator_disable(twl->usb3v3);
286 twl->asleep = 0;
287 }
288 }
289 }
290 sysfs_notify(&twl->dev->kobj, NULL, "vbus");
291
292 return IRQ_HANDLED;
293 }
294
twl6030_usbotg_irq(int irq,void * _twl)295 static irqreturn_t twl6030_usbotg_irq(int irq, void *_twl)
296 {
297 struct twl6030_usb *twl = _twl;
298 struct usb_otg *otg = twl->phy.otg;
299 int status = USB_EVENT_NONE;
300 u8 hw_state;
301
302 hw_state = twl6030_readb(twl, TWL6030_MODULE_ID0, STS_HW_CONDITIONS);
303
304 if (hw_state & STS_USB_ID) {
305
306 regulator_enable(twl->usb3v3);
307 twl->asleep = 1;
308 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_CLR, 0x1);
309 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_SET,
310 0x10);
311 status = USB_EVENT_ID;
312 otg->default_a = true;
313 twl->phy.state = OTG_STATE_A_IDLE;
314 twl->linkstat = status;
315 twl->phy.last_event = status;
316 atomic_notifier_call_chain(&twl->phy.notifier, status,
317 otg->gadget);
318 } else {
319 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_CLR,
320 0x10);
321 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_SET,
322 0x1);
323 }
324 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_LATCH_CLR, status);
325
326 return IRQ_HANDLED;
327 }
328
twl6030_set_peripheral(struct usb_otg * otg,struct usb_gadget * gadget)329 static int twl6030_set_peripheral(struct usb_otg *otg,
330 struct usb_gadget *gadget)
331 {
332 if (!otg)
333 return -ENODEV;
334
335 otg->gadget = gadget;
336 if (!gadget)
337 otg->phy->state = OTG_STATE_UNDEFINED;
338
339 return 0;
340 }
341
twl6030_enable_irq(struct usb_phy * x)342 static int twl6030_enable_irq(struct usb_phy *x)
343 {
344 struct twl6030_usb *twl = phy_to_twl(x);
345
346 twl6030_writeb(twl, TWL_MODULE_USB, USB_ID_INT_EN_HI_SET, 0x1);
347 twl6030_interrupt_unmask(0x05, REG_INT_MSK_LINE_C);
348 twl6030_interrupt_unmask(0x05, REG_INT_MSK_STS_C);
349
350 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK,
351 REG_INT_MSK_LINE_C);
352 twl6030_interrupt_unmask(TWL6030_CHARGER_CTRL_INT_MASK,
353 REG_INT_MSK_STS_C);
354 twl6030_usb_irq(twl->irq2, twl);
355 twl6030_usbotg_irq(twl->irq1, twl);
356
357 return 0;
358 }
359
otg_set_vbus_work(struct work_struct * data)360 static void otg_set_vbus_work(struct work_struct *data)
361 {
362 struct twl6030_usb *twl = container_of(data, struct twl6030_usb,
363 set_vbus_work);
364
365 /*
366 * Start driving VBUS. Set OPA_MODE bit in CHARGERUSB_CTRL1
367 * register. This enables boost mode.
368 */
369
370 if (twl->vbus_enable)
371 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE , 0x40,
372 CHARGERUSB_CTRL1);
373 else
374 twl6030_writeb(twl, TWL_MODULE_MAIN_CHARGE , 0x00,
375 CHARGERUSB_CTRL1);
376 }
377
twl6030_set_vbus(struct usb_otg * otg,bool enabled)378 static int twl6030_set_vbus(struct usb_otg *otg, bool enabled)
379 {
380 struct twl6030_usb *twl = phy_to_twl(otg->phy);
381
382 twl->vbus_enable = enabled;
383 schedule_work(&twl->set_vbus_work);
384
385 return 0;
386 }
387
twl6030_set_host(struct usb_otg * otg,struct usb_bus * host)388 static int twl6030_set_host(struct usb_otg *otg, struct usb_bus *host)
389 {
390 if (!otg)
391 return -ENODEV;
392
393 otg->host = host;
394 if (!host)
395 otg->phy->state = OTG_STATE_UNDEFINED;
396 return 0;
397 }
398
twl6030_usb_probe(struct platform_device * pdev)399 static int __devinit twl6030_usb_probe(struct platform_device *pdev)
400 {
401 struct twl6030_usb *twl;
402 int status, err;
403 struct twl4030_usb_data *pdata;
404 struct usb_otg *otg;
405 struct device *dev = &pdev->dev;
406 pdata = dev->platform_data;
407
408 twl = kzalloc(sizeof *twl, GFP_KERNEL);
409 if (!twl)
410 return -ENOMEM;
411
412 otg = kzalloc(sizeof *otg, GFP_KERNEL);
413 if (!otg) {
414 kfree(twl);
415 return -ENOMEM;
416 }
417
418 twl->dev = &pdev->dev;
419 twl->irq1 = platform_get_irq(pdev, 0);
420 twl->irq2 = platform_get_irq(pdev, 1);
421 twl->features = pdata->features;
422
423 twl->phy.dev = twl->dev;
424 twl->phy.label = "twl6030";
425 twl->phy.otg = otg;
426 twl->phy.init = twl6030_phy_init;
427 twl->phy.shutdown = twl6030_phy_shutdown;
428 twl->phy.set_suspend = twl6030_phy_suspend;
429
430 otg->phy = &twl->phy;
431 otg->set_host = twl6030_set_host;
432 otg->set_peripheral = twl6030_set_peripheral;
433 otg->set_vbus = twl6030_set_vbus;
434 otg->start_srp = twl6030_start_srp;
435
436 /* init spinlock for workqueue */
437 spin_lock_init(&twl->lock);
438
439 err = twl6030_usb_ldo_init(twl);
440 if (err) {
441 dev_err(&pdev->dev, "ldo init failed\n");
442 kfree(otg);
443 kfree(twl);
444 return err;
445 }
446 usb_set_transceiver(&twl->phy);
447
448 platform_set_drvdata(pdev, twl);
449 if (device_create_file(&pdev->dev, &dev_attr_vbus))
450 dev_warn(&pdev->dev, "could not create sysfs file\n");
451
452 ATOMIC_INIT_NOTIFIER_HEAD(&twl->phy.notifier);
453
454 INIT_WORK(&twl->set_vbus_work, otg_set_vbus_work);
455
456 twl->irq_enabled = true;
457 status = request_threaded_irq(twl->irq1, NULL, twl6030_usbotg_irq,
458 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING,
459 "twl6030_usb", twl);
460 if (status < 0) {
461 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
462 twl->irq1, status);
463 device_remove_file(twl->dev, &dev_attr_vbus);
464 kfree(otg);
465 kfree(twl);
466 return status;
467 }
468
469 status = request_threaded_irq(twl->irq2, NULL, twl6030_usb_irq,
470 IRQF_TRIGGER_FALLING | IRQF_TRIGGER_RISING,
471 "twl6030_usb", twl);
472 if (status < 0) {
473 dev_err(&pdev->dev, "can't get IRQ %d, err %d\n",
474 twl->irq2, status);
475 free_irq(twl->irq1, twl);
476 device_remove_file(twl->dev, &dev_attr_vbus);
477 kfree(otg);
478 kfree(twl);
479 return status;
480 }
481
482 twl->asleep = 0;
483 pdata->phy_init(dev);
484 twl6030_phy_suspend(&twl->phy, 0);
485 twl6030_enable_irq(&twl->phy);
486 dev_info(&pdev->dev, "Initialized TWL6030 USB module\n");
487
488 return 0;
489 }
490
twl6030_usb_remove(struct platform_device * pdev)491 static int __exit twl6030_usb_remove(struct platform_device *pdev)
492 {
493 struct twl6030_usb *twl = platform_get_drvdata(pdev);
494
495 struct twl4030_usb_data *pdata;
496 struct device *dev = &pdev->dev;
497 pdata = dev->platform_data;
498
499 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK,
500 REG_INT_MSK_LINE_C);
501 twl6030_interrupt_mask(TWL6030_USBOTG_INT_MASK,
502 REG_INT_MSK_STS_C);
503 free_irq(twl->irq1, twl);
504 free_irq(twl->irq2, twl);
505 regulator_put(twl->usb3v3);
506 pdata->phy_exit(twl->dev);
507 device_remove_file(twl->dev, &dev_attr_vbus);
508 cancel_work_sync(&twl->set_vbus_work);
509 kfree(twl->phy.otg);
510 kfree(twl);
511
512 return 0;
513 }
514
515 static struct platform_driver twl6030_usb_driver = {
516 .probe = twl6030_usb_probe,
517 .remove = __exit_p(twl6030_usb_remove),
518 .driver = {
519 .name = "twl6030_usb",
520 .owner = THIS_MODULE,
521 },
522 };
523
twl6030_usb_init(void)524 static int __init twl6030_usb_init(void)
525 {
526 return platform_driver_register(&twl6030_usb_driver);
527 }
528 subsys_initcall(twl6030_usb_init);
529
twl6030_usb_exit(void)530 static void __exit twl6030_usb_exit(void)
531 {
532 platform_driver_unregister(&twl6030_usb_driver);
533 }
534 module_exit(twl6030_usb_exit);
535
536 MODULE_ALIAS("platform:twl6030_usb");
537 MODULE_AUTHOR("Hema HK <hemahk@ti.com>");
538 MODULE_DESCRIPTION("TWL6030 USB transceiver driver");
539 MODULE_LICENSE("GPL");
540