usb: musb: fix some runtime_pm issues
[linux-2.6-block.git] / drivers / usb / musb / omap2430.c
CommitLineData
550a7375
FB
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
550a7375
FB
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>
550a7375
FB
30#include <linux/init.h>
31#include <linux/list.h>
550a7375 32#include <linux/io.h>
dc09886b
FB
33#include <linux/platform_device.h>
34#include <linux/dma-mapping.h>
207b0e1f
HH
35#include <linux/pm_runtime.h>
36#include <linux/err.h>
550a7375 37
550a7375
FB
38#include "musb_core.h"
39#include "omap2430.h"
40
a3cee12a
FB
41struct omap2430_glue {
42 struct device *dev;
43 struct platform_device *musb;
44};
c20aebb9 45#define glue_to_musb(g) platform_get_drvdata(g->musb)
a3cee12a 46
550a7375
FB
47static struct timer_list musb_idle_timer;
48
49static 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
550a7375
FB
56 spin_lock_irqsave(&musb->lock, flags);
57
84e250ff 58 switch (musb->xceiv->state) {
550a7375 59 case OTG_STATE_A_WAIT_BCON:
550a7375
FB
60
61 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
62 if (devctl & MUSB_DEVCTL_BDEVICE) {
84e250ff 63 musb->xceiv->state = OTG_STATE_B_IDLE;
550a7375
FB
64 MUSB_DEV_MODE(musb);
65 } else {
84e250ff 66 musb->xceiv->state = OTG_STATE_A_IDLE;
550a7375
FB
67 MUSB_HST_MODE(musb);
68 }
69 break;
550a7375
FB
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;
5c8a86e1 75 dev_dbg(musb->controller, "root port resume stopped, power %02x\n", power);
550a7375
FB
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 ... */
84e250ff 83 musb->xceiv->state = OTG_STATE_A_HOST;
550a7375
FB
84 }
85 break;
550a7375
FB
86 case OTG_STATE_A_HOST:
87 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
88 if (devctl & MUSB_DEVCTL_BDEVICE)
84e250ff 89 musb->xceiv->state = OTG_STATE_B_IDLE;
550a7375 90 else
84e250ff 91 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
550a7375
FB
92 default:
93 break;
94 }
95 spin_unlock_irqrestore(&musb->lock, flags);
96}
97
98
743411b3 99static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
550a7375
FB
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)
84e250ff 109 && (musb->xceiv->state == OTG_STATE_A_WAIT_BCON))) {
5c8a86e1 110 dev_dbg(musb->controller, "%s active, deleting timer\n",
3df00453 111 otg_state_string(musb->xceiv->state));
550a7375
FB
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 {
5c8a86e1 121 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
550a7375
FB
122 return;
123 }
124 }
125 last_timer = timeout;
126
5c8a86e1 127 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
3df00453 128 otg_state_string(musb->xceiv->state),
550a7375
FB
129 (unsigned long)jiffies_to_msecs(timeout - jiffies));
130 mod_timer(&musb_idle_timer, timeout);
131}
132
743411b3 133static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
550a7375 134{
d445b6da 135 struct usb_otg *otg = musb->xceiv->otg;
550a7375 136 u8 devctl;
594632ef
HH
137 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
138 int ret = 1;
550a7375
FB
139 /* HDRC controls CPEN, but beware current surges during device
140 * connect. They can trigger transient overcurrent conditions
141 * that must be ignored.
142 */
143
144 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
145
146 if (is_on) {
594632ef
HH
147 if (musb->xceiv->state == OTG_STATE_A_IDLE) {
148 /* start the session */
149 devctl |= MUSB_DEVCTL_SESSION;
150 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
151 /*
152 * Wait for the musb to set as A device to enable the
153 * VBUS
154 */
155 while (musb_readb(musb->mregs, MUSB_DEVCTL) & 0x80) {
156
157 cpu_relax();
158
159 if (time_after(jiffies, timeout)) {
160 dev_err(musb->controller,
161 "configured as A device timeout");
162 ret = -EINVAL;
163 break;
164 }
165 }
166
6e13c650
HK
167 if (ret && otg->set_vbus)
168 otg_set_vbus(otg, 1);
594632ef
HH
169 } else {
170 musb->is_active = 1;
d445b6da 171 otg->default_a = 1;
594632ef
HH
172 musb->xceiv->state = OTG_STATE_A_WAIT_VRISE;
173 devctl |= MUSB_DEVCTL_SESSION;
174 MUSB_HST_MODE(musb);
175 }
550a7375
FB
176 } else {
177 musb->is_active = 0;
178
179 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
180 * jumping right to B_IDLE...
181 */
182
d445b6da 183 otg->default_a = 0;
84e250ff 184 musb->xceiv->state = OTG_STATE_B_IDLE;
550a7375
FB
185 devctl &= ~MUSB_DEVCTL_SESSION;
186
187 MUSB_DEV_MODE(musb);
188 }
189 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
190
5c8a86e1 191 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
550a7375 192 /* otg %3x conf %08x prcm %08x */ "\n",
3df00453 193 otg_state_string(musb->xceiv->state),
550a7375
FB
194 musb_readb(musb->mregs, MUSB_DEVCTL));
195}
550a7375 196
743411b3 197static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
550a7375
FB
198{
199 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
200
201 devctl |= MUSB_DEVCTL_SESSION;
202 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
203
96a274d1 204 return 0;
550a7375
FB
205}
206
c20aebb9
FB
207static inline void omap2430_low_level_exit(struct musb *musb)
208{
209 u32 l;
210
211 /* in any role */
212 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
213 l |= ENABLEFORCE; /* enable MSTANDBY */
214 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
c20aebb9
FB
215}
216
217static inline void omap2430_low_level_init(struct musb *musb)
218{
219 u32 l;
220
c20aebb9
FB
221 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
222 l &= ~ENABLEFORCE; /* disable MSTANDBY */
223 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
224}
225
594632ef
HH
226static int musb_otg_notifications(struct notifier_block *nb,
227 unsigned long event, void *unused)
228{
229 struct musb *musb = container_of(nb, struct musb, nb);
712d8efa
VP
230
231 musb->xceiv_event = event;
232 schedule_work(&musb->otg_notifier_work);
233
b30b3c60 234 return NOTIFY_OK;
712d8efa
VP
235}
236
237static void musb_otg_notifier_work(struct work_struct *data_notifier_work)
238{
239 struct musb *musb = container_of(data_notifier_work, struct musb, otg_notifier_work);
594632ef
HH
240 struct device *dev = musb->controller;
241 struct musb_hdrc_platform_data *pdata = dev->platform_data;
242 struct omap_musb_board_data *data = pdata->board_data;
243
712d8efa 244 switch (musb->xceiv_event) {
594632ef 245 case USB_EVENT_ID:
5c8a86e1 246 dev_dbg(musb->controller, "ID GND\n");
594632ef 247
b3314d9a 248 if (!is_otg_enabled(musb) || musb->gadget_driver) {
7acc6197 249 pm_runtime_get_sync(musb->controller);
b96d3b08 250 usb_phy_init(musb->xceiv);
70045c57 251 omap2430_musb_set_vbus(musb, 1);
594632ef
HH
252 }
253 break;
254
255 case USB_EVENT_VBUS:
5c8a86e1 256 dev_dbg(musb->controller, "VBUS Connect\n");
594632ef 257
7acc6197
HH
258 if (musb->gadget_driver)
259 pm_runtime_get_sync(musb->controller);
b96d3b08 260 usb_phy_init(musb->xceiv);
594632ef
HH
261 break;
262
263 case USB_EVENT_NONE:
5c8a86e1 264 dev_dbg(musb->controller, "VBUS Disconnect\n");
594632ef 265
383cf4e8 266 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
62285963 267 if (musb->gadget_driver) {
7acc6197
HH
268 pm_runtime_mark_last_busy(musb->controller);
269 pm_runtime_put_autosuspend(musb->controller);
270 }
271
594632ef 272 if (data->interface_type == MUSB_INTERFACE_UTMI) {
6e13c650
HK
273 if (musb->xceiv->otg->set_vbus)
274 otg_set_vbus(musb->xceiv->otg, 0);
594632ef 275 }
b96d3b08 276 usb_phy_shutdown(musb->xceiv);
594632ef
HH
277 break;
278 default:
5c8a86e1 279 dev_dbg(musb->controller, "ID float\n");
594632ef 280 }
594632ef
HH
281}
282
743411b3 283static int omap2430_musb_init(struct musb *musb)
550a7375 284{
594632ef 285 u32 l, status = 0;
ea65df57
HK
286 struct device *dev = musb->controller;
287 struct musb_hdrc_platform_data *plat = dev->platform_data;
288 struct omap_musb_board_data *data = plat->board_data;
550a7375 289
84e250ff
DB
290 /* We require some kind of external transceiver, hooked
291 * up through ULPI. TWL4030-family PMICs include one,
292 * which needs a driver, drivers aren't always needed.
293 */
b96d3b08 294 musb->xceiv = usb_get_transceiver();
84e250ff
DB
295 if (!musb->xceiv) {
296 pr_err("HS USB OTG: no transceiver configured\n");
297 return -ENODEV;
298 }
299
712d8efa
VP
300 INIT_WORK(&musb->otg_notifier_work, musb_otg_notifier_work);
301
7acc6197
HH
302 status = pm_runtime_get_sync(dev);
303 if (status < 0) {
304 dev_err(dev, "pm_runtime_get_sync FAILED");
305 goto err1;
306 }
550a7375 307
8573e6a6 308 l = musb_readl(musb->mregs, OTG_INTERFSEL);
de2e1b0c
MM
309
310 if (data->interface_type == MUSB_INTERFACE_UTMI) {
311 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
312 l &= ~ULPI_12PIN; /* Disable ULPI */
313 l |= UTMI_8BIT; /* Enable UTMI */
314 } else {
315 l |= ULPI_12PIN;
316 }
317
8573e6a6 318 musb_writel(musb->mregs, OTG_INTERFSEL, l);
550a7375
FB
319
320 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
321 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
8573e6a6
FB
322 musb_readl(musb->mregs, OTG_REVISION),
323 musb_readl(musb->mregs, OTG_SYSCONFIG),
324 musb_readl(musb->mregs, OTG_SYSSTATUS),
325 musb_readl(musb->mregs, OTG_INTERFSEL),
326 musb_readl(musb->mregs, OTG_SIMENABLE));
550a7375 327
594632ef 328 musb->nb.notifier_call = musb_otg_notifications;
b96d3b08 329 status = usb_register_notifier(musb->xceiv, &musb->nb);
594632ef
HH
330
331 if (status)
5c8a86e1 332 dev_dbg(musb->controller, "notification register failed\n");
594632ef 333
550a7375
FB
334 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
335
c04352a5 336 pm_runtime_put_noidle(musb->controller);
550a7375 337 return 0;
7acc6197
HH
338
339err1:
7acc6197 340 return status;
550a7375
FB
341}
342
002eda13
HH
343static void omap2430_musb_enable(struct musb *musb)
344{
345 u8 devctl;
346 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
347 struct device *dev = musb->controller;
348 struct musb_hdrc_platform_data *pdata = dev->platform_data;
349 struct omap_musb_board_data *data = pdata->board_data;
350
351 switch (musb->xceiv->last_event) {
352
353 case USB_EVENT_ID:
b96d3b08 354 usb_phy_init(musb->xceiv);
08dec56e
FC
355 if (data->interface_type != MUSB_INTERFACE_UTMI)
356 break;
357 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
358 /* start the session */
359 devctl |= MUSB_DEVCTL_SESSION;
360 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
361 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
362 MUSB_DEVCTL_BDEVICE) {
363 cpu_relax();
364
365 if (time_after(jiffies, timeout)) {
366 dev_err(dev, "configured as A device timeout");
367 break;
002eda13
HH
368 }
369 }
370 break;
371
372 case USB_EVENT_VBUS:
b96d3b08 373 usb_phy_init(musb->xceiv);
002eda13
HH
374 break;
375
376 default:
377 break;
378 }
379}
380
381static void omap2430_musb_disable(struct musb *musb)
382{
383 if (musb->xceiv->last_event)
b96d3b08 384 usb_phy_shutdown(musb->xceiv);
550a7375
FB
385}
386
743411b3 387static int omap2430_musb_exit(struct musb *musb)
550a7375 388{
19b9a83e 389 del_timer_sync(&musb_idle_timer);
b30b3c60 390 cancel_work_sync(&musb->otg_notifier_work);
550a7375 391
c20aebb9 392 omap2430_low_level_exit(musb);
b96d3b08 393 usb_put_transceiver(musb->xceiv);
c20aebb9 394
550a7375
FB
395 return 0;
396}
743411b3 397
f7ec9437 398static const struct musb_platform_ops omap2430_ops = {
743411b3
FB
399 .init = omap2430_musb_init,
400 .exit = omap2430_musb_exit,
401
743411b3
FB
402 .set_mode = omap2430_musb_set_mode,
403 .try_idle = omap2430_musb_try_idle,
404
405 .set_vbus = omap2430_musb_set_vbus,
002eda13
HH
406
407 .enable = omap2430_musb_enable,
408 .disable = omap2430_musb_disable,
743411b3 409};
dc09886b
FB
410
411static u64 omap2430_dmamask = DMA_BIT_MASK(32);
412
e9e8c85e 413static int __devinit omap2430_probe(struct platform_device *pdev)
dc09886b
FB
414{
415 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
416 struct platform_device *musb;
a3cee12a 417 struct omap2430_glue *glue;
dc09886b
FB
418 int ret = -ENOMEM;
419
a3cee12a
FB
420 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
421 if (!glue) {
422 dev_err(&pdev->dev, "failed to allocate glue context\n");
423 goto err0;
424 }
425
dc09886b
FB
426 musb = platform_device_alloc("musb-hdrc", -1);
427 if (!musb) {
428 dev_err(&pdev->dev, "failed to allocate musb device\n");
a3cee12a 429 goto err1;
dc09886b
FB
430 }
431
432 musb->dev.parent = &pdev->dev;
433 musb->dev.dma_mask = &omap2430_dmamask;
434 musb->dev.coherent_dma_mask = omap2430_dmamask;
435
a3cee12a
FB
436 glue->dev = &pdev->dev;
437 glue->musb = musb;
438
f7ec9437
FB
439 pdata->platform_ops = &omap2430_ops;
440
a3cee12a 441 platform_set_drvdata(pdev, glue);
dc09886b
FB
442
443 ret = platform_device_add_resources(musb, pdev->resource,
444 pdev->num_resources);
445 if (ret) {
446 dev_err(&pdev->dev, "failed to add resources\n");
207b0e1f 447 goto err2;
dc09886b
FB
448 }
449
450 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
451 if (ret) {
452 dev_err(&pdev->dev, "failed to add platform_data\n");
207b0e1f 453 goto err2;
dc09886b
FB
454 }
455
456 ret = platform_device_add(musb);
457 if (ret) {
458 dev_err(&pdev->dev, "failed to register musb device\n");
207b0e1f 459 goto err2;
dc09886b
FB
460 }
461
207b0e1f 462 pm_runtime_enable(&pdev->dev);
03491761 463
207b0e1f 464 return 0;
03491761 465
a3cee12a 466err2:
dc09886b
FB
467 platform_device_put(musb);
468
a3cee12a
FB
469err1:
470 kfree(glue);
471
dc09886b
FB
472err0:
473 return ret;
474}
475
e9e8c85e 476static int __devexit omap2430_remove(struct platform_device *pdev)
dc09886b 477{
a3cee12a 478 struct omap2430_glue *glue = platform_get_drvdata(pdev);
dc09886b 479
a3cee12a
FB
480 platform_device_del(glue->musb);
481 platform_device_put(glue->musb);
482 kfree(glue);
dc09886b
FB
483
484 return 0;
485}
486
c20aebb9 487#ifdef CONFIG_PM
c20aebb9 488
7acc6197 489static int omap2430_runtime_suspend(struct device *dev)
c20aebb9
FB
490{
491 struct omap2430_glue *glue = dev_get_drvdata(dev);
492 struct musb *musb = glue_to_musb(glue);
493
afb76df1
VZ
494 if (musb) {
495 musb->context.otg_interfsel = musb_readl(musb->mregs,
496 OTG_INTERFSEL);
e25bec16 497
afb76df1
VZ
498 omap2430_low_level_exit(musb);
499 usb_phy_set_suspend(musb->xceiv, 1);
500 }
c20aebb9
FB
501
502 return 0;
503}
504
7acc6197 505static int omap2430_runtime_resume(struct device *dev)
c20aebb9
FB
506{
507 struct omap2430_glue *glue = dev_get_drvdata(dev);
508 struct musb *musb = glue_to_musb(glue);
c20aebb9 509
afb76df1
VZ
510 if (musb) {
511 omap2430_low_level_init(musb);
512 musb_writel(musb->mregs, OTG_INTERFSEL,
513 musb->context.otg_interfsel);
e25bec16 514
afb76df1
VZ
515 usb_phy_set_suspend(musb->xceiv, 0);
516 }
c20aebb9
FB
517
518 return 0;
519}
520
521static struct dev_pm_ops omap2430_pm_ops = {
7acc6197
HH
522 .runtime_suspend = omap2430_runtime_suspend,
523 .runtime_resume = omap2430_runtime_resume,
c20aebb9
FB
524};
525
526#define DEV_PM_OPS (&omap2430_pm_ops)
527#else
528#define DEV_PM_OPS NULL
529#endif
530
dc09886b 531static struct platform_driver omap2430_driver = {
e9e8c85e
FB
532 .probe = omap2430_probe,
533 .remove = __devexit_p(omap2430_remove),
dc09886b
FB
534 .driver = {
535 .name = "musb-omap2430",
c20aebb9 536 .pm = DEV_PM_OPS,
dc09886b
FB
537 },
538};
539
540MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
541MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
542MODULE_LICENSE("GPL v2");
543
544static int __init omap2430_init(void)
545{
e9e8c85e 546 return platform_driver_register(&omap2430_driver);
dc09886b 547}
e9e8c85e 548module_init(omap2430_init);
dc09886b
FB
549
550static void __exit omap2430_exit(void)
551{
552 platform_driver_unregister(&omap2430_driver);
553}
554module_exit(omap2430_exit);