usb: musb: fix pm_runtime mismatch
[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
FB
134{
135 u8 devctl;
594632ef
HH
136 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
137 int ret = 1;
550a7375
FB
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) {
594632ef
HH
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 }
550a7375
FB
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
84e250ff
DB
182 musb->xceiv->default_a = 0;
183 musb->xceiv->state = OTG_STATE_B_IDLE;
550a7375
FB
184 devctl &= ~MUSB_DEVCTL_SESSION;
185
186 MUSB_DEV_MODE(musb);
187 }
188 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
189
5c8a86e1 190 dev_dbg(musb->controller, "VBUS %s, devctl %02x "
550a7375 191 /* otg %3x conf %08x prcm %08x */ "\n",
3df00453 192 otg_state_string(musb->xceiv->state),
550a7375
FB
193 musb_readb(musb->mregs, MUSB_DEVCTL));
194}
550a7375 195
743411b3 196static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
550a7375
FB
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
96a274d1 203 return 0;
550a7375
FB
204}
205
c20aebb9
FB
206static 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);
c20aebb9
FB
214}
215
216static inline void omap2430_low_level_init(struct musb *musb)
217{
218 u32 l;
219
c20aebb9
FB
220 l = musb_readl(musb->mregs, OTG_FORCESTDBY);
221 l &= ~ENABLEFORCE; /* disable MSTANDBY */
222 musb_writel(musb->mregs, OTG_FORCESTDBY, l);
223}
224
594632ef
HH
225/* blocking notifier support */
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
234 return 0;
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
HH
247
248 if (is_otg_enabled(musb)) {
594632ef 249 if (musb->gadget_driver) {
7acc6197 250 pm_runtime_get_sync(musb->controller);
594632ef 251 otg_init(musb->xceiv);
70045c57 252 omap2430_musb_set_vbus(musb, 1);
594632ef 253 }
594632ef 254 } else {
7acc6197 255 pm_runtime_get_sync(musb->controller);
594632ef 256 otg_init(musb->xceiv);
70045c57 257 omap2430_musb_set_vbus(musb, 1);
594632ef
HH
258 }
259 break;
260
261 case USB_EVENT_VBUS:
5c8a86e1 262 dev_dbg(musb->controller, "VBUS Connect\n");
594632ef 263
7acc6197
HH
264 if (musb->gadget_driver)
265 pm_runtime_get_sync(musb->controller);
594632ef
HH
266 otg_init(musb->xceiv);
267 break;
268
269 case USB_EVENT_NONE:
5c8a86e1 270 dev_dbg(musb->controller, "VBUS Disconnect\n");
594632ef 271
383cf4e8 272 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
62285963 273 if (musb->gadget_driver) {
7acc6197
HH
274 pm_runtime_mark_last_busy(musb->controller);
275 pm_runtime_put_autosuspend(musb->controller);
276 }
277
594632ef
HH
278 if (data->interface_type == MUSB_INTERFACE_UTMI) {
279 if (musb->xceiv->set_vbus)
280 otg_set_vbus(musb->xceiv, 0);
281 }
282 otg_shutdown(musb->xceiv);
283 break;
284 default:
5c8a86e1 285 dev_dbg(musb->controller, "ID float\n");
594632ef 286 }
594632ef
HH
287}
288
743411b3 289static int omap2430_musb_init(struct musb *musb)
550a7375 290{
594632ef 291 u32 l, status = 0;
ea65df57
HK
292 struct device *dev = musb->controller;
293 struct musb_hdrc_platform_data *plat = dev->platform_data;
294 struct omap_musb_board_data *data = plat->board_data;
550a7375 295
84e250ff
DB
296 /* We require some kind of external transceiver, hooked
297 * up through ULPI. TWL4030-family PMICs include one,
298 * which needs a driver, drivers aren't always needed.
299 */
300 musb->xceiv = otg_get_transceiver();
301 if (!musb->xceiv) {
302 pr_err("HS USB OTG: no transceiver configured\n");
303 return -ENODEV;
304 }
305
712d8efa
VP
306 INIT_WORK(&musb->otg_notifier_work, musb_otg_notifier_work);
307
7acc6197
HH
308 status = pm_runtime_get_sync(dev);
309 if (status < 0) {
310 dev_err(dev, "pm_runtime_get_sync FAILED");
311 goto err1;
312 }
550a7375 313
8573e6a6 314 l = musb_readl(musb->mregs, OTG_INTERFSEL);
de2e1b0c
MM
315
316 if (data->interface_type == MUSB_INTERFACE_UTMI) {
317 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
318 l &= ~ULPI_12PIN; /* Disable ULPI */
319 l |= UTMI_8BIT; /* Enable UTMI */
320 } else {
321 l |= ULPI_12PIN;
322 }
323
8573e6a6 324 musb_writel(musb->mregs, OTG_INTERFSEL, l);
550a7375
FB
325
326 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
327 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
8573e6a6
FB
328 musb_readl(musb->mregs, OTG_REVISION),
329 musb_readl(musb->mregs, OTG_SYSCONFIG),
330 musb_readl(musb->mregs, OTG_SYSSTATUS),
331 musb_readl(musb->mregs, OTG_INTERFSEL),
332 musb_readl(musb->mregs, OTG_SIMENABLE));
550a7375 333
594632ef
HH
334 musb->nb.notifier_call = musb_otg_notifications;
335 status = otg_register_notifier(musb->xceiv, &musb->nb);
336
337 if (status)
5c8a86e1 338 dev_dbg(musb->controller, "notification register failed\n");
594632ef 339
550a7375
FB
340 setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
341
342 return 0;
7acc6197
HH
343
344err1:
345 pm_runtime_disable(dev);
346 return status;
550a7375
FB
347}
348
002eda13
HH
349static void omap2430_musb_enable(struct musb *musb)
350{
351 u8 devctl;
352 unsigned long timeout = jiffies + msecs_to_jiffies(1000);
353 struct device *dev = musb->controller;
354 struct musb_hdrc_platform_data *pdata = dev->platform_data;
355 struct omap_musb_board_data *data = pdata->board_data;
356
357 switch (musb->xceiv->last_event) {
358
359 case USB_EVENT_ID:
360 otg_init(musb->xceiv);
361 if (data->interface_type == MUSB_INTERFACE_UTMI) {
362 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
363 /* start the session */
364 devctl |= MUSB_DEVCTL_SESSION;
365 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
366 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
367 MUSB_DEVCTL_BDEVICE) {
368 cpu_relax();
369
370 if (time_after(jiffies, timeout)) {
371 dev_err(musb->controller,
372 "configured as A device timeout");
373 break;
374 }
375 }
376 }
377 break;
378
379 case USB_EVENT_VBUS:
380 otg_init(musb->xceiv);
381 break;
382
383 default:
384 break;
385 }
386}
387
388static void omap2430_musb_disable(struct musb *musb)
389{
390 if (musb->xceiv->last_event)
391 otg_shutdown(musb->xceiv);
550a7375
FB
392}
393
743411b3 394static int omap2430_musb_exit(struct musb *musb)
550a7375 395{
19b9a83e 396 del_timer_sync(&musb_idle_timer);
550a7375 397
c20aebb9 398 omap2430_low_level_exit(musb);
f4053874 399 otg_put_transceiver(musb->xceiv);
c20aebb9 400
550a7375
FB
401 return 0;
402}
743411b3 403
f7ec9437 404static const struct musb_platform_ops omap2430_ops = {
743411b3
FB
405 .init = omap2430_musb_init,
406 .exit = omap2430_musb_exit,
407
743411b3
FB
408 .set_mode = omap2430_musb_set_mode,
409 .try_idle = omap2430_musb_try_idle,
410
411 .set_vbus = omap2430_musb_set_vbus,
002eda13
HH
412
413 .enable = omap2430_musb_enable,
414 .disable = omap2430_musb_disable,
743411b3 415};
dc09886b
FB
416
417static u64 omap2430_dmamask = DMA_BIT_MASK(32);
418
419static int __init omap2430_probe(struct platform_device *pdev)
420{
421 struct musb_hdrc_platform_data *pdata = pdev->dev.platform_data;
422 struct platform_device *musb;
a3cee12a 423 struct omap2430_glue *glue;
dc09886b
FB
424 int ret = -ENOMEM;
425
a3cee12a
FB
426 glue = kzalloc(sizeof(*glue), GFP_KERNEL);
427 if (!glue) {
428 dev_err(&pdev->dev, "failed to allocate glue context\n");
429 goto err0;
430 }
431
dc09886b
FB
432 musb = platform_device_alloc("musb-hdrc", -1);
433 if (!musb) {
434 dev_err(&pdev->dev, "failed to allocate musb device\n");
a3cee12a 435 goto err1;
dc09886b
FB
436 }
437
438 musb->dev.parent = &pdev->dev;
439 musb->dev.dma_mask = &omap2430_dmamask;
440 musb->dev.coherent_dma_mask = omap2430_dmamask;
441
a3cee12a
FB
442 glue->dev = &pdev->dev;
443 glue->musb = musb;
444
f7ec9437
FB
445 pdata->platform_ops = &omap2430_ops;
446
a3cee12a 447 platform_set_drvdata(pdev, glue);
dc09886b
FB
448
449 ret = platform_device_add_resources(musb, pdev->resource,
450 pdev->num_resources);
451 if (ret) {
452 dev_err(&pdev->dev, "failed to add resources\n");
207b0e1f 453 goto err2;
dc09886b
FB
454 }
455
456 ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
457 if (ret) {
458 dev_err(&pdev->dev, "failed to add platform_data\n");
207b0e1f 459 goto err2;
dc09886b
FB
460 }
461
462 ret = platform_device_add(musb);
463 if (ret) {
464 dev_err(&pdev->dev, "failed to register musb device\n");
207b0e1f 465 goto err2;
dc09886b
FB
466 }
467
207b0e1f 468 pm_runtime_enable(&pdev->dev);
03491761 469
207b0e1f 470 return 0;
03491761 471
a3cee12a 472err2:
dc09886b
FB
473 platform_device_put(musb);
474
a3cee12a
FB
475err1:
476 kfree(glue);
477
dc09886b
FB
478err0:
479 return ret;
480}
481
482static int __exit omap2430_remove(struct platform_device *pdev)
483{
a3cee12a 484 struct omap2430_glue *glue = platform_get_drvdata(pdev);
dc09886b 485
a3cee12a
FB
486 platform_device_del(glue->musb);
487 platform_device_put(glue->musb);
207b0e1f
HH
488 pm_runtime_put(&pdev->dev);
489 pm_runtime_disable(&pdev->dev);
a3cee12a 490 kfree(glue);
dc09886b
FB
491
492 return 0;
493}
494
c20aebb9 495#ifdef CONFIG_PM
c20aebb9 496
7acc6197 497static int omap2430_runtime_suspend(struct device *dev)
c20aebb9
FB
498{
499 struct omap2430_glue *glue = dev_get_drvdata(dev);
500 struct musb *musb = glue_to_musb(glue);
501
e25bec16
HH
502 musb->context.otg_interfsel = musb_readl(musb->mregs,
503 OTG_INTERFSEL);
504
c20aebb9
FB
505 omap2430_low_level_exit(musb);
506 otg_set_suspend(musb->xceiv, 1);
c20aebb9
FB
507
508 return 0;
509}
510
7acc6197 511static int omap2430_runtime_resume(struct device *dev)
c20aebb9
FB
512{
513 struct omap2430_glue *glue = dev_get_drvdata(dev);
514 struct musb *musb = glue_to_musb(glue);
c20aebb9
FB
515
516 omap2430_low_level_init(musb);
e25bec16
HH
517 musb_writel(musb->mregs, OTG_INTERFSEL,
518 musb->context.otg_interfsel);
519
c20aebb9
FB
520 otg_set_suspend(musb->xceiv, 0);
521
522 return 0;
523}
524
525static struct dev_pm_ops omap2430_pm_ops = {
7acc6197
HH
526 .runtime_suspend = omap2430_runtime_suspend,
527 .runtime_resume = omap2430_runtime_resume,
c20aebb9
FB
528};
529
530#define DEV_PM_OPS (&omap2430_pm_ops)
531#else
532#define DEV_PM_OPS NULL
533#endif
534
dc09886b
FB
535static struct platform_driver omap2430_driver = {
536 .remove = __exit_p(omap2430_remove),
537 .driver = {
538 .name = "musb-omap2430",
c20aebb9 539 .pm = DEV_PM_OPS,
dc09886b
FB
540 },
541};
542
543MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
544MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
545MODULE_LICENSE("GPL v2");
546
547static int __init omap2430_init(void)
548{
549 return platform_driver_probe(&omap2430_driver, omap2430_probe);
550}
551subsys_initcall(omap2430_init);
552
553static void __exit omap2430_exit(void)
554{
555 platform_driver_unregister(&omap2430_driver);
556}
557module_exit(omap2430_exit);