1 /*
2 * Copyright (C) 2005-2007 by Texas Instruments
3 * Some code has been taken from tusb6010.c
4 * Copyrights for that are attributable to:
5 * Copyright (C) 2006 Nokia Corporation
6 * Tony Lindgren <tony@atomide.com>
7 *
8 * This file is part of the Inventra Controller Driver for Linux.
9 *
10 * The Inventra Controller Driver for Linux is free software; you
11 * can redistribute it and/or modify it under the terms of the GNU
12 * General Public License version 2 as published by the Free Software
13 * Foundation.
14 *
15 * The Inventra Controller Driver for Linux is distributed in
16 * the hope that it will be useful, but WITHOUT ANY WARRANTY;
17 * without even the implied warranty of MERCHANTABILITY or
18 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
19 * License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with The Inventra Controller Driver for Linux ; if not,
23 * write to the Free Software Foundation, Inc., 59 Temple Place,
24 * Suite 330, Boston, MA 02111-1307 USA
25 *
26 */
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/sched.h>
30 #include <linux/init.h>
31 #include <linux/list.h>
32 #include <linux/io.h>
33 #include <linux/platform_device.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/pm_runtime.h>
36 #include <linux/err.h>
37
38 #include "musb_core.h"
39 #include "omap2430.h"
40
41 struct omap2430_glue {
42 struct device *dev;
43 struct platform_device *musb;
44 };
45 #define glue_to_musb(g) platform_get_drvdata(g->musb)
46
47 static struct timer_list musb_idle_timer;
48
musb_do_idle(unsigned long _musb)49 static void musb_do_idle(unsigned long _musb)
50 {
51 struct musb *musb = (void *)_musb;
52 unsigned long flags;
53 u8 power;
54 u8 devctl;
55
56 spin_lock_irqsave(&musb->lock, flags);
57
58 switch (musb->xceiv->state) {
59 case OTG_STATE_A_WAIT_BCON:
60
61 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
62 if (devctl & MUSB_DEVCTL_BDEVICE) {
63 musb->xceiv->state = OTG_STATE_B_IDLE;
64 MUSB_DEV_MODE(musb);
65 } else {
66 musb->xceiv->state = OTG_STATE_A_IDLE;
67 MUSB_HST_MODE(musb);
68 }
69 break;
70 case OTG_STATE_A_SUSPEND:
71 /* finish RESUME signaling? */
72 if (musb->port1_status & MUSB_PORT_STAT_RESUME) {
73 power = musb_readb(musb->mregs, MUSB_POWER);
74 power &= ~MUSB_POWER_RESUME;
75 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
76 musb_writeb(musb->mregs, MUSB_POWER, power);
77 musb->is_active = 1;
78 musb->port1_status &= ~(USB_PORT_STAT_SUSPEND
79 | MUSB_PORT_STAT_RESUME);
80 musb->port1_status |= USB_PORT_STAT_C_SUSPEND << 16;
81 usb_hcd_poll_rh_status(musb_to_hcd(musb));
82 /* NOTE: it might really be A_WAIT_BCON ... */
83 musb->xceiv->state = OTG_STATE_A_HOST;
84 }
85 break;
86 case OTG_STATE_A_HOST:
87 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
88 if (devctl & MUSB_DEVCTL_BDEVICE)
89 musb->xceiv->state = OTG_STATE_B_IDLE;
90 else
91 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
92 default:
93 break;
94 }
95 spin_unlock_irqrestore(&musb->lock, flags);
96 }
97
98
omap2430_musb_try_idle(struct musb * musb,unsigned long timeout)99 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
100 {
101 unsigned long default_timeout = jiffies + msecs_to_jiffies(3);
102 static unsigned long last_timer;
103
104 if (timeout == 0)
105 timeout = default_timeout;
106
107 /* Never idle if active, or when VBUS timeout is not set as host */
108 if (musb->is_active || ((musb->a_wait_bcon == 0)
109 && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
110 dev_dbg(musb->controller, "%s active, deleting timer\n",
111 otg_state_string(musb->xceiv->state));
112 del_timer(&musb_idle_timer);
113 last_timer = jiffies;
114 return;
115 }
116
117 if (time_after(last_timer, timeout)) {
118 if (!timer_pending(&musb_idle_timer))
119 last_timer = timeout;
120 else {
121 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
122 return;
123 }
124 }
125 last_timer = timeout;
126
127 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
128 otg_state_string(musb->xceiv->state),
129 (unsigned long)jiffies_to_msecs(timeout - jiffies));
130 mod_timer(&musb_idle_timer, timeout);
131 }
132
omap2430_musb_set_vbus(struct musb * musb,int is_on)133 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
134 {
135 u8 devctl;
136 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
137 int ret = 1;
138 /* HDRC controls CPEN, but beware current surges during device
139 * connect. They can trigger transient overcurrent conditions
140 * that must be ignored.
141 */
142
143 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
144
145 if (is_on) {
146 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
147 /* start the session */
148 devctl |= MUSB_DEVCTL_SESSION;
149 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
150 /*
151 * Wait for the musb to set as A device to enable the
152 * VBUS
153 */
154 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
155
156 cpu_relax();
157
158 if (time_after(jiffies, timeout)) {
159 dev_err(musb->controller,
160 "configured as A device timeout");
161 ret = -EINVAL;
162 break;
163 }
164 }
165
166 if (ret && musb->xceiv->set_vbus)
167 otg_set_vbus(musb->xceiv, 1);
168 } else {
169 musb->is_active = 1;
170 musb->xceiv->default_a = 1;
171 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
172 devctl |= MUSB_DEVCTL_SESSION;
173 MUSB_HST_MODE(musb);
174 }
175 } else {
176 musb->is_active = 0;
177
178 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
179 * jumping right to B_IDLE...
180 */
181
182 musb->xceiv->default_a = 0;
183 musb->xceiv->state = OTG_STATE_B_IDLE;
184 devctl &= ~MUSB_DEVCTL_SESSION;
185
186 MUSB_DEV_MODE(musb);
187 }
188 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
189
190 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
191 /* otg %3x conf %08x prcm %08x */ "\n",
192 otg_state_string(musb->xceiv->state),
193 musb_readb(musb->mregs, MUSB_DEVCTL));
194 }
195
omap2430_musb_set_mode(struct musb * musb,u8 musb_mode)196 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
197 {
198 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
199
200 devctl |= MUSB_DEVCTL_SESSION;
201 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
202
203 return 0;
204 }
205
omap2430_low_level_exit(struct musb * musb)206 static inline void omap2430_low_level_exit(struct musb *musb)
207 {
208 u32 l;
209
210 /* in any role */
211 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
212 l |= ENABLEFORCE; /* enable MSTANDBY */
213 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
214 }
215
omap2430_low_level_init(struct musb * musb)216 static inline void omap2430_low_level_init(struct musb *musb)
217 {
218 u32 l;
219
220 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
221 l &= ~ENABLEFORCE; /* disable MSTANDBY */
222 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
223 }
224
musb_otg_notifications(struct notifier_block * nb,unsigned long event,void * unused)225 static int musb_otg_notifications(struct notifier_block *nb,
226 unsigned long event, void *unused)
227 {
228 struct musb *musb = container_of(nb, struct musb, nb);
229
230 musb->xceiv_event = event;
231 schedule_work(&musb->otg_notifier_work);
232
233 return NOTIFY_OK;
234 }
235
musb_otg_notifier_work(struct work_struct * data_notifier_work)236 static void musb_otg_notifier_work(struct work_struct *data_notifier_work)
237 {
238 struct musb *musb = container_of(data_notifier_work, struct musb, otg_notifier_work);
239 struct device *dev = musb->controller;
240 struct musb_hdrc_platform_data *pdata = dev->platform_data;
241 struct omap_musb_board_data *data = pdata->board_data;
242
243 switch (musb->xceiv_event) {
244 case USB_EVENT_ID:
245 dev_dbg(musb->controller, "ID GND\n");
246
247 if (!is_otg_enabled(musb) || musb->gadget_driver) {
248 pm_runtime_get_sync(musb->controller);
249 otg_init(musb->xceiv);
250 omap2430_musb_set_vbus(musb, 1);
251 }
252 break;
253
254 case USB_EVENT_VBUS:
255 dev_dbg(musb->controller, "VBUS Connect\n");
256
257 if (musb->gadget_driver)
258 pm_runtime_get_sync(musb->controller);
259 otg_init(musb->xceiv);
260 break;
261
262 case USB_EVENT_NONE:
263 dev_dbg(musb->controller, "VBUS Disconnect\n");
264
265 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
266 if (musb->gadget_driver) {
267 pm_runtime_mark_last_busy(musb->controller);
268 pm_runtime_put_autosuspend(musb->controller);
269 }
270
271 if (data->interface_type == MUSB_INTERFACE_UTMI) {
272 if (musb->xceiv->set_vbus)
273 otg_set_vbus(musb->xceiv, 0);
274 }
275 otg_shutdown(musb->xceiv);
276 break;
277 default:
278 dev_dbg(musb->controller, "ID float\n");
279 }
280 }
281
omap2430_musb_init(struct musb * musb)282 static int omap2430_musb_init(struct musb *musb)
283 {
284 u32 l, status = 0;
285 struct device *dev = musb->controller;
286 struct musb_hdrc_platform_data *plat = dev->platform_data;
287 struct omap_musb_board_data *data = plat->board_data;
288
289 /* We require some kind of external transceiver, hooked
290 * up through ULPI. TWL4030-family PMICs include one,
291 * which needs a driver, drivers aren't always needed.
292 */
293 musb->xceiv = otg_get_transceiver();
294 if (!musb->xceiv) {
295 pr_err("HS USB OTG: no transceiver configured\n");
296 return -ENODEV;
297 }
298
299 INIT_WORK(&musb->otg_notifier_work, musb_otg_notifier_work);
300
301 status = pm_runtime_get_sync(dev);
302 if (status < 0) {
303 dev_err(dev, "pm_runtime_get_sync FAILED");
304 goto err1;
305 }
306
307 l = musb_readl(musb->mregs, OTG_INTERFSEL);
308
309 if (data->interface_type == MUSB_INTERFACE_UTMI) {
310 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
311 l &= ~ULPI_12PIN; /* Disable ULPI */
312 l |= UTMI_8BIT; /* Enable UTMI */
313 } else {
314 l |= ULPI_12PIN;
315 }
316
317 musb_writel(musb->mregs, OTG_INTERFSEL, l);
318
319 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
320 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
321 musb_readl(musb->mregs, OTG_REVISION),
322 musb_readl(musb->mregs, OTG_SYSCONFIG),
323 musb_readl(musb->mregs, OTG_SYSSTATUS),
324 musb_readl(musb->mregs, OTG_INTERFSEL),
325 musb_readl(musb->mregs, OTG_SIMENABLE));
326
327 musb->nb.notifier_call = musb_otg_notifications;
328 status = otg_register_notifier(musb->xceiv, &musb->nb);
329
330 if (status)
331 dev_dbg(musb->controller, "notification register failed\n");
332
333 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
334
335 return 0;
336
337 err1:
338 return status;
339 }
340
omap2430_musb_enable(struct musb * musb)341 static void omap2430_musb_enable(struct musb *musb)
342 {
343 u8 devctl;
344 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
345 struct device *dev = musb->controller;
346 struct musb_hdrc_platform_data *pdata = dev->platform_data;
347 struct omap_musb_board_data *data = pdata->board_data;
348
349 switch (musb->xceiv->last_event) {
350
351 case USB_EVENT_ID:
352 otg_init(musb->xceiv);
353 if (data->interface_type != MUSB_INTERFACE_UTMI)
354 break;
355 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
356 /* start the session */
357 devctl |= MUSB_DEVCTL_SESSION;
358 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
359 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
360 MUSB_DEVCTL_BDEVICE) {
361 cpu_relax();
362
363 if (time_after(jiffies, timeout)) {
364 dev_err(dev, "configured as A device timeout");
365 break;
366 }
367 }
368 break;
369
370 case USB_EVENT_VBUS:
371 otg_init(musb->xceiv);
372 break;
373
374 default:
375 break;
376 }
377 }
378
omap2430_musb_disable(struct musb * musb)379 static void omap2430_musb_disable(struct musb *musb)
380 {
381 if (musb->xceiv->last_event)
382 otg_shutdown(musb->xceiv);
383 }
384
omap2430_musb_exit(struct musb * musb)385 static int omap2430_musb_exit(struct musb *musb)
386 {
387 del_timer_sync(&musb_idle_timer);
388 cancel_work_sync(&musb->otg_notifier_work);
389
390 omap2430_low_level_exit(musb);
391 otg_put_transceiver(musb->xceiv);
392
393 return 0;
394 }
395
396 static const struct musb_platform_ops omap2430_ops = {
397 .init = omap2430_musb_init,
398 .exit = omap2430_musb_exit,
399
400 .set_mode = omap2430_musb_set_mode,
401 .try_idle = omap2430_musb_try_idle,
402
403 .set_vbus = omap2430_musb_set_vbus,
404
405 .enable = omap2430_musb_enable,
406 .disable = omap2430_musb_disable,
407 };
408
409 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
410
omap2430_probe(struct platform_device * pdev)411 static int __init omap2430_probe(struct platform_device *pdev)
412 {
413 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
414 struct platform_device *musb;
415 struct omap2430_glue *glue;
416 int ret = -ENOMEM;
417
418 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
419 if (!glue) {
420 dev_err(&pdev->dev, "failed to allocate glue context\n");
421 goto err0;
422 }
423
424 musb = platform_device_alloc("musb-hdrc", -1);
425 if (!musb) {
426 dev_err(&pdev->dev, "failed to allocate musb device\n");
427 goto err1;
428 }
429
430 musb->dev.parent = &pdev->dev;
431 musb->dev.dma_mask = &omap2430_dmamask;
432 musb->dev.coherent_dma_mask = omap2430_dmamask;
433
434 glue->dev = &pdev->dev;
435 glue->musb = musb;
436
437 pdata->platform_ops = &omap2430_ops;
438
439 platform_set_drvdata(pdev, glue);
440
441 ret = platform_device_add_resources(musb, pdev->resource,
442 pdev->num_resources);
443 if (ret) {
444 dev_err(&pdev->dev, "failed to add resources\n");
445 goto err2;
446 }
447
448 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
449 if (ret) {
450 dev_err(&pdev->dev, "failed to add platform_data\n");
451 goto err2;
452 }
453
454 ret = platform_device_add(musb);
455 if (ret) {
456 dev_err(&pdev->dev, "failed to register musb device\n");
457 goto err2;
458 }
459
460 pm_runtime_enable(&pdev->dev);
461
462 return 0;
463
464 err2:
465 platform_device_put(musb);
466
467 err1:
468 kfree(glue);
469
470 err0:
471 return ret;
472 }
473
omap2430_remove(struct platform_device * pdev)474 static int __exit omap2430_remove(struct platform_device *pdev)
475 {
476 struct omap2430_glue *glue = platform_get_drvdata(pdev);
477
478 platform_device_del(glue->musb);
479 platform_device_put(glue->musb);
480 pm_runtime_put(&pdev->dev);
481 kfree(glue);
482
483 return 0;
484 }
485
486 #ifdef CONFIG_PM
487
omap2430_runtime_suspend(struct device * dev)488 static int omap2430_runtime_suspend(struct device *dev)
489 {
490 struct omap2430_glue *glue = dev_get_drvdata(dev);
491 struct musb *musb = glue_to_musb(glue);
492
493 musb->context.otg_interfsel = musb_readl(musb->mregs,
494 OTG_INTERFSEL);
495
496 omap2430_low_level_exit(musb);
497 otg_set_suspend(musb->xceiv, 1);
498
499 return 0;
500 }
501
omap2430_runtime_resume(struct device * dev)502 static int omap2430_runtime_resume(struct device *dev)
503 {
504 struct omap2430_glue *glue = dev_get_drvdata(dev);
505 struct musb *musb = glue_to_musb(glue);
506
507 omap2430_low_level_init(musb);
508 musb_writel(musb->mregs, OTG_INTERFSEL,
509 musb->context.otg_interfsel);
510
511 otg_set_suspend(musb->xceiv, 0);
512
513 return 0;
514 }
515
516 static struct dev_pm_ops omap2430_pm_ops = {
517 .runtime_suspend = omap2430_runtime_suspend,
518 .runtime_resume = omap2430_runtime_resume,
519 };
520
521 #define DEV_PM_OPS (&omap2430_pm_ops)
522 #else
523 #define DEV_PM_OPS NULL
524 #endif
525
526 static struct platform_driver omap2430_driver = {
527 .remove = __exit_p(omap2430_remove),
528 .driver = {
529 .name = "musb-omap2430",
530 .pm = DEV_PM_OPS,
531 },
532 };
533
534 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
535 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
536 MODULE_LICENSE("GPL v2");
537
omap2430_init(void)538 static int __init omap2430_init(void)
539 {
540 return platform_driver_probe(&omap2430_driver, omap2430_probe);
541 }
542 subsys_initcall(omap2430_init);
543
omap2430_exit(void)544 static void __exit omap2430_exit(void)
545 {
546 platform_driver_unregister(&omap2430_driver);
547 }
548 module_exit(omap2430_exit);
549