c2813d71d911bc10abbfd259584cda0699b5973b
[sitara-epos/sitara-epos-kernel.git] / drivers / usb / musb / omap2430.c
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>
38 #include "musb_core.h"
39 #include "omap2430.h"
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)
47 static struct timer_list musb_idle_timer;
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;
56         spin_lock_irqsave(&musb->lock, flags);
58         switch (musb->xceiv->state) {
59         case OTG_STATE_A_WAIT_BCON:
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 }
99 static void omap2430_musb_try_idle(struct musb *musb, unsigned long timeout)
101         unsigned long           default_timeout = jiffies + msecs_to_jiffies(3);
102         static unsigned long    last_timer;
104         if (timeout == 0)
105                 timeout = default_timeout;
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         }
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;
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);
133 static void omap2430_musb_set_vbus(struct musb *musb, int is_on)
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          */
143         devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
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) {
156                                 cpu_relax();
158                                 if (time_after(jiffies, timeout)) {
159                                         dev_err(musb->controller,
160                                         "configured as A device timeout");
161                                         ret = -EINVAL;
162                                         break;
163                                 }
164                         }
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;
178                 /* NOTE:  we're skipping A_WAIT_VFALL -> A_IDLE and
179                  * jumping right to B_IDLE...
180                  */
182                 musb->xceiv->default_a = 0;
183                 musb->xceiv->state = OTG_STATE_B_IDLE;
184                 devctl &= ~MUSB_DEVCTL_SESSION;
186                 MUSB_DEV_MODE(musb);
187         }
188         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
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));
196 static int omap2430_musb_set_mode(struct musb *musb, u8 musb_mode)
198         u8      devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
200         devctl |= MUSB_DEVCTL_SESSION;
201         musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
203         return 0;
206 static inline void omap2430_low_level_exit(struct musb *musb)
208         u32 l;
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);
216 static inline void omap2430_low_level_init(struct musb *musb)
218         u32 l;
220         l = musb_readl(musb->mregs, OTG_FORCESTDBY);
221         l &= ~ENABLEFORCE;      /* disable MSTANDBY */
222         musb_writel(musb->mregs, OTG_FORCESTDBY, l);
225 /* blocking notifier support */
226 static int musb_otg_notifications(struct notifier_block *nb,
227                 unsigned long event, void *unused)
229         struct musb     *musb = container_of(nb, struct musb, nb);
231         musb->xceiv_event = event;
232         schedule_work(&musb->otg_notifier_work);
234         return 0;
237 static void musb_otg_notifier_work(struct work_struct *data_notifier_work)
239         struct musb *musb = container_of(data_notifier_work, struct musb, otg_notifier_work);
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;
244         switch (musb->xceiv_event) {
245         case USB_EVENT_ID:
246                 dev_dbg(musb->controller, "ID GND\n");
248                 if (!is_otg_enabled(musb) || musb->gadget_driver) {
249                         pm_runtime_get_sync(musb->controller);
250                         otg_init(musb->xceiv);
251                         omap2430_musb_set_vbus(musb, 1);
252                 }
253                 break;
255         case USB_EVENT_VBUS:
256                 dev_dbg(musb->controller, "VBUS Connect\n");
258                 if (musb->gadget_driver)
259                         pm_runtime_get_sync(musb->controller);
260                 otg_init(musb->xceiv);
261                 break;
263         case USB_EVENT_NONE:
264                 dev_dbg(musb->controller, "VBUS Disconnect\n");
266                 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
267                         if (musb->gadget_driver) {
268                                 pm_runtime_mark_last_busy(musb->controller);
269                                 pm_runtime_put_autosuspend(musb->controller);
270                         }
272                 if (data->interface_type == MUSB_INTERFACE_UTMI) {
273                         if (musb->xceiv->set_vbus)
274                                 otg_set_vbus(musb->xceiv, 0);
275                 }
276                 otg_shutdown(musb->xceiv);
277                 break;
278         default:
279                 dev_dbg(musb->controller, "ID float\n");
280         }
283 static int omap2430_musb_init(struct musb *musb)
285         u32 l, status = 0;
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;
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          */
294         musb->xceiv = otg_get_transceiver();
295         if (!musb->xceiv) {
296                 pr_err("HS USB OTG: no transceiver configured\n");
297                 return -ENODEV;
298         }
300         INIT_WORK(&musb->otg_notifier_work, musb_otg_notifier_work);
302         status = pm_runtime_get_sync(dev);
303         if (status < 0) {
304                 dev_err(dev, "pm_runtime_get_sync FAILED");
305                 goto err1;
306         }
308         l = musb_readl(musb->mregs, OTG_INTERFSEL);
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         }
318         musb_writel(musb->mregs, OTG_INTERFSEL, l);
320         pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
321                         "sysstatus 0x%x, intrfsel 0x%x, simenable  0x%x\n",
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));
328         musb->nb.notifier_call = musb_otg_notifications;
329         status = otg_register_notifier(musb->xceiv, &musb->nb);
331         if (status)
332                 dev_dbg(musb->controller, "notification register failed\n");
334         setup_timer(&musb_idle_timer, musb_do_idle, (unsigned long) musb);
336         return 0;
338 err1:
339         return status;
342 static void omap2430_musb_enable(struct musb *musb)
344         u8              devctl;
345         unsigned long timeout = jiffies + msecs_to_jiffies(1000);
346         struct device *dev = musb->controller;
347         struct musb_hdrc_platform_data *pdata = dev->platform_data;
348         struct omap_musb_board_data *data = pdata->board_data;
350         switch (musb->xceiv->last_event) {
352         case USB_EVENT_ID:
353                 otg_init(musb->xceiv);
354                 if (data->interface_type != MUSB_INTERFACE_UTMI)
355                         break;
356                 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
357                 /* start the session */
358                 devctl |= MUSB_DEVCTL_SESSION;
359                 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
360                 while (musb_readb(musb->mregs, MUSB_DEVCTL) &
361                                 MUSB_DEVCTL_BDEVICE) {
362                         cpu_relax();
364                         if (time_after(jiffies, timeout)) {
365                                 dev_err(dev, "configured as A device timeout");
366                                 break;
367                         }
368                 }
369                 break;
371         case USB_EVENT_VBUS:
372                 otg_init(musb->xceiv);
373                 break;
375         default:
376                 break;
377         }
380 static void omap2430_musb_disable(struct musb *musb)
382         if (musb->xceiv->last_event)
383                 otg_shutdown(musb->xceiv);
386 static int omap2430_musb_exit(struct musb *musb)
388         del_timer_sync(&musb_idle_timer);
390         omap2430_low_level_exit(musb);
391         otg_put_transceiver(musb->xceiv);
393         return 0;
396 static const struct musb_platform_ops omap2430_ops = {
397         .fifo_mode      = 4,
398         .init           = omap2430_musb_init,
399         .exit           = omap2430_musb_exit,
401         .read_fifo      = musb_read_fifo,
402         .write_fifo     = musb_write_fifo,
404         .set_mode       = omap2430_musb_set_mode,
405         .try_idle       = omap2430_musb_try_idle,
407         .set_vbus       = omap2430_musb_set_vbus,
409         .enable         = omap2430_musb_enable,
410         .disable        = omap2430_musb_disable,
411 };
413 static u64 omap2430_dmamask = DMA_BIT_MASK(32);
415 static int __init omap2430_probe(struct platform_device *pdev)
417         struct musb_hdrc_platform_data  *pdata = pdev->dev.platform_data;
418         struct platform_device          *musb;
419         struct omap2430_glue            *glue;
420         int                             ret = -ENOMEM;
422         glue = kzalloc(sizeof(*glue), GFP_KERNEL);
423         if (!glue) {
424                 dev_err(&pdev->dev, "failed to allocate glue context\n");
425                 goto err0;
426         }
428         musb = platform_device_alloc("musb-hdrc", -1);
429         if (!musb) {
430                 dev_err(&pdev->dev, "failed to allocate musb device\n");
431                 goto err1;
432         }
434         musb->dev.parent                = &pdev->dev;
435         musb->dev.dma_mask              = &omap2430_dmamask;
436         musb->dev.coherent_dma_mask     = omap2430_dmamask;
438         glue->dev                       = &pdev->dev;
439         glue->musb                      = musb;
441         pdata->platform_ops             = &omap2430_ops;
443         platform_set_drvdata(pdev, glue);
445         ret = platform_device_add_resources(musb, pdev->resource,
446                         pdev->num_resources);
447         if (ret) {
448                 dev_err(&pdev->dev, "failed to add resources\n");
449                 goto err2;
450         }
452         ret = platform_device_add_data(musb, pdata, sizeof(*pdata));
453         if (ret) {
454                 dev_err(&pdev->dev, "failed to add platform_data\n");
455                 goto err2;
456         }
458         ret = platform_device_add(musb);
459         if (ret) {
460                 dev_err(&pdev->dev, "failed to register musb device\n");
461                 goto err2;
462         }
464         pm_runtime_enable(&pdev->dev);
466         return 0;
468 err2:
469         platform_device_put(musb);
471 err1:
472         kfree(glue);
474 err0:
475         return ret;
478 static int __exit omap2430_remove(struct platform_device *pdev)
480         struct omap2430_glue            *glue = platform_get_drvdata(pdev);
482         platform_device_del(glue->musb);
483         platform_device_put(glue->musb);
484         pm_runtime_put(&pdev->dev);
485         kfree(glue);
487         return 0;
490 #ifdef CONFIG_PM
492 static int omap2430_runtime_suspend(struct device *dev)
494         struct omap2430_glue            *glue = dev_get_drvdata(dev);
495         struct musb                     *musb = glue_to_musb(glue);
497         musb->context.otg_interfsel = musb_readl(musb->mregs,
498                                                 OTG_INTERFSEL);
500         omap2430_low_level_exit(musb);
501         otg_set_suspend(musb->xceiv, 1);
503         return 0;
506 static int omap2430_runtime_resume(struct device *dev)
508         struct omap2430_glue            *glue = dev_get_drvdata(dev);
509         struct musb                     *musb = glue_to_musb(glue);
511         omap2430_low_level_init(musb);
512         musb_writel(musb->mregs, OTG_INTERFSEL,
513                                         musb->context.otg_interfsel);
515         otg_set_suspend(musb->xceiv, 0);
517         return 0;
520 static struct dev_pm_ops omap2430_pm_ops = {
521         .runtime_suspend = omap2430_runtime_suspend,
522         .runtime_resume = omap2430_runtime_resume,
523 };
525 #define DEV_PM_OPS      (&omap2430_pm_ops)
526 #else
527 #define DEV_PM_OPS      NULL
528 #endif
530 static struct platform_driver omap2430_driver = {
531         .remove         = __exit_p(omap2430_remove),
532         .driver         = {
533                 .name   = "musb-omap2430",
534                 .pm     = DEV_PM_OPS,
535         },
536 };
538 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
539 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
540 MODULE_LICENSE("GPL v2");
542 static int __init omap2430_init(void)
544         return platform_driver_probe(&omap2430_driver, omap2430_probe);
546 subsys_initcall(omap2430_init);
548 static void __exit omap2430_exit(void)
550         platform_driver_unregister(&omap2430_driver);
552 module_exit(omap2430_exit);