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>
8 * This file is part of the Inventra Controller Driver for Linux.
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
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.
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
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>
34 #include <linux/platform_device.h>
35 #include <linux/dma-mapping.h>
36 #include <linux/pm_runtime.h>
37 #include <linux/err.h>
38 #include <linux/delay.h>
39 #include <linux/usb/musb-omap.h>
40 #include <linux/usb/omap_control_usb.h>
42 #include "musb_core.h"
45 struct omap2430_glue
{
47 struct platform_device
*musb
;
48 enum omap_musb_vbus_id_status status
;
49 struct work_struct omap_musb_mailbox_work
;
50 struct device
*control_otghs
;
52 #define glue_to_musb(g) platform_get_drvdata(g->musb)
54 static struct omap2430_glue
*_glue
;
56 static struct timer_list musb_idle_timer
;
58 static void musb_do_idle(unsigned long _musb
)
60 struct musb
*musb
= (void *)_musb
;
65 spin_lock_irqsave(&musb
->lock
, flags
);
67 switch (musb
->xceiv
->state
) {
68 case OTG_STATE_A_WAIT_BCON
:
70 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
71 if (devctl
& MUSB_DEVCTL_BDEVICE
) {
72 musb
->xceiv
->state
= OTG_STATE_B_IDLE
;
75 musb
->xceiv
->state
= OTG_STATE_A_IDLE
;
79 case OTG_STATE_A_SUSPEND
:
80 /* finish RESUME signaling? */
81 if (musb
->port1_status
& MUSB_PORT_STAT_RESUME
) {
82 power
= musb_readb(musb
->mregs
, MUSB_POWER
);
83 power
&= ~MUSB_POWER_RESUME
;
84 dev_dbg(musb
->controller
, "root port resume stopped, power %02x\n", power
);
85 musb_writeb(musb
->mregs
, MUSB_POWER
, power
);
87 musb
->port1_status
&= ~(USB_PORT_STAT_SUSPEND
88 | MUSB_PORT_STAT_RESUME
);
89 musb
->port1_status
|= USB_PORT_STAT_C_SUSPEND
<< 16;
90 usb_hcd_poll_rh_status(musb_to_hcd(musb
));
91 /* NOTE: it might really be A_WAIT_BCON ... */
92 musb
->xceiv
->state
= OTG_STATE_A_HOST
;
95 case OTG_STATE_A_HOST
:
96 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
97 if (devctl
& MUSB_DEVCTL_BDEVICE
)
98 musb
->xceiv
->state
= OTG_STATE_B_IDLE
;
100 musb
->xceiv
->state
= OTG_STATE_A_WAIT_BCON
;
104 spin_unlock_irqrestore(&musb
->lock
, flags
);
108 static void omap2430_musb_try_idle(struct musb
*musb
, unsigned long timeout
)
110 unsigned long default_timeout
= jiffies
+ msecs_to_jiffies(3);
111 static unsigned long last_timer
;
114 timeout
= default_timeout
;
116 /* Never idle if active, or when VBUS timeout is not set as host */
117 if (musb
->is_active
|| ((musb
->a_wait_bcon
== 0)
118 && (musb
->xceiv
->state
== OTG_STATE_A_WAIT_BCON
))) {
119 dev_dbg(musb
->controller
, "%s active, deleting timer\n",
120 otg_state_string(musb
->xceiv
->state
));
121 del_timer(&musb_idle_timer
);
122 last_timer
= jiffies
;
126 if (time_after(last_timer
, timeout
)) {
127 if (!timer_pending(&musb_idle_timer
))
128 last_timer
= timeout
;
130 dev_dbg(musb
->controller
, "Longer idle timer already pending, ignoring\n");
134 last_timer
= timeout
;
136 dev_dbg(musb
->controller
, "%s inactive, for idle timer for %lu ms\n",
137 otg_state_string(musb
->xceiv
->state
),
138 (unsigned long)jiffies_to_msecs(timeout
- jiffies
));
139 mod_timer(&musb_idle_timer
, timeout
);
142 static void omap2430_musb_set_vbus(struct musb
*musb
, int is_on
)
144 struct usb_otg
*otg
= musb
->xceiv
->otg
;
146 unsigned long timeout
= jiffies
+ msecs_to_jiffies(1000);
147 /* HDRC controls CPEN, but beware current surges during device
148 * connect. They can trigger transient overcurrent conditions
149 * that must be ignored.
152 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
155 if (musb
->xceiv
->state
== OTG_STATE_A_IDLE
) {
157 /* start the session */
158 devctl
|= MUSB_DEVCTL_SESSION
;
159 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
161 * Wait for the musb to set as A device to enable the
164 while (musb_readb(musb
->mregs
, MUSB_DEVCTL
) & 0x80) {
169 if (time_after(jiffies
, timeout
)
171 dev_err(musb
->controller
,
172 "configured as A device timeout");
178 otg_set_vbus(otg
, 1);
182 musb
->xceiv
->state
= OTG_STATE_A_WAIT_VRISE
;
183 devctl
|= MUSB_DEVCTL_SESSION
;
189 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
190 * jumping right to B_IDLE...
194 musb
->xceiv
->state
= OTG_STATE_B_IDLE
;
195 devctl
&= ~MUSB_DEVCTL_SESSION
;
199 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
201 dev_dbg(musb
->controller
, "VBUS %s, devctl %02x "
202 /* otg %3x conf %08x prcm %08x */ "\n",
203 otg_state_string(musb
->xceiv
->state
),
204 musb_readb(musb
->mregs
, MUSB_DEVCTL
));
207 static int omap2430_musb_set_mode(struct musb
*musb
, u8 musb_mode
)
209 u8 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
211 devctl
|= MUSB_DEVCTL_SESSION
;
212 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
217 static inline void omap2430_low_level_exit(struct musb
*musb
)
222 l
= musb_readl(musb
->mregs
, OTG_FORCESTDBY
);
223 l
|= ENABLEFORCE
; /* enable MSTANDBY */
224 musb_writel(musb
->mregs
, OTG_FORCESTDBY
, l
);
227 static inline void omap2430_low_level_init(struct musb
*musb
)
231 l
= musb_readl(musb
->mregs
, OTG_FORCESTDBY
);
232 l
&= ~ENABLEFORCE
; /* disable MSTANDBY */
233 musb_writel(musb
->mregs
, OTG_FORCESTDBY
, l
);
236 void omap_musb_mailbox(enum omap_musb_vbus_id_status status
)
238 struct omap2430_glue
*glue
= _glue
;
241 pr_err("%s: musb core is not yet initialized\n", __func__
);
244 glue
->status
= status
;
246 if (!glue_to_musb(glue
)) {
247 pr_err("%s: musb core is not yet ready\n", __func__
);
251 schedule_work(&glue
->omap_musb_mailbox_work
);
253 EXPORT_SYMBOL_GPL(omap_musb_mailbox
);
255 static void omap_musb_set_mailbox(struct omap2430_glue
*glue
)
257 struct musb
*musb
= glue_to_musb(glue
);
258 struct device
*dev
= musb
->controller
;
259 struct musb_hdrc_platform_data
*pdata
= dev
->platform_data
;
260 struct omap_musb_board_data
*data
= pdata
->board_data
;
261 struct usb_otg
*otg
= musb
->xceiv
->otg
;
263 switch (glue
->status
) {
264 case OMAP_MUSB_ID_GROUND
:
265 dev_dbg(dev
, "ID GND\n");
267 otg
->default_a
= true;
268 musb
->xceiv
->state
= OTG_STATE_A_IDLE
;
269 musb
->xceiv
->last_event
= USB_EVENT_ID
;
270 if (musb
->gadget_driver
) {
271 pm_runtime_get_sync(dev
);
272 omap_control_usb_set_mode(glue
->control_otghs
,
274 omap2430_musb_set_vbus(musb
, 1);
278 case OMAP_MUSB_VBUS_VALID
:
279 dev_dbg(dev
, "VBUS Connect\n");
281 otg
->default_a
= false;
282 musb
->xceiv
->state
= OTG_STATE_B_IDLE
;
283 musb
->xceiv
->last_event
= USB_EVENT_VBUS
;
284 if (musb
->gadget_driver
)
285 pm_runtime_get_sync(dev
);
286 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_DEVICE
);
289 case OMAP_MUSB_ID_FLOAT
:
290 case OMAP_MUSB_VBUS_OFF
:
291 dev_dbg(dev
, "VBUS Disconnect\n");
293 musb
->xceiv
->last_event
= USB_EVENT_NONE
;
294 if (musb
->gadget_driver
) {
295 pm_runtime_mark_last_busy(dev
);
296 pm_runtime_put_autosuspend(dev
);
299 if (data
->interface_type
== MUSB_INTERFACE_UTMI
) {
300 if (musb
->xceiv
->otg
->set_vbus
)
301 otg_set_vbus(musb
->xceiv
->otg
, 0);
303 omap_control_usb_set_mode(glue
->control_otghs
,
304 USB_MODE_DISCONNECT
);
307 dev_dbg(dev
, "ID float\n");
312 static void omap_musb_mailbox_work(struct work_struct
*mailbox_work
)
314 struct omap2430_glue
*glue
= container_of(mailbox_work
,
315 struct omap2430_glue
, omap_musb_mailbox_work
);
316 omap_musb_set_mailbox(glue
);
319 static irqreturn_t
omap2430_musb_interrupt(int irq
, void *__hci
)
322 irqreturn_t retval
= IRQ_NONE
;
323 struct musb
*musb
= __hci
;
325 spin_lock_irqsave(&musb
->lock
, flags
);
327 musb
->int_usb
= musb_readb(musb
->mregs
, MUSB_INTRUSB
);
328 musb
->int_tx
= musb_readw(musb
->mregs
, MUSB_INTRTX
);
329 musb
->int_rx
= musb_readw(musb
->mregs
, MUSB_INTRRX
);
331 if (musb
->int_usb
|| musb
->int_tx
|| musb
->int_rx
)
332 retval
= musb_interrupt(musb
);
334 spin_unlock_irqrestore(&musb
->lock
, flags
);
339 static int omap2430_musb_init(struct musb
*musb
)
343 struct device
*dev
= musb
->controller
;
344 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
345 struct musb_hdrc_platform_data
*plat
= dev
->platform_data
;
346 struct omap_musb_board_data
*data
= plat
->board_data
;
348 /* We require some kind of external transceiver, hooked
349 * up through ULPI. TWL4030-family PMICs include one,
350 * which needs a driver, drivers aren't always needed.
352 if (dev
->parent
->of_node
)
353 musb
->xceiv
= devm_usb_get_phy_by_phandle(dev
->parent
,
356 musb
->xceiv
= devm_usb_get_phy_dev(dev
, 0);
358 if (IS_ERR_OR_NULL(musb
->xceiv
)) {
359 pr_err("HS USB OTG: no transceiver configured\n");
360 return -EPROBE_DEFER
;
363 musb
->isr
= omap2430_musb_interrupt
;
365 status
= pm_runtime_get_sync(dev
);
367 dev_err(dev
, "pm_runtime_get_sync FAILED %d\n", status
);
371 l
= musb_readl(musb
->mregs
, OTG_INTERFSEL
);
373 if (data
->interface_type
== MUSB_INTERFACE_UTMI
) {
374 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
375 l
&= ~ULPI_12PIN
; /* Disable ULPI */
376 l
|= UTMI_8BIT
; /* Enable UTMI */
381 musb_writel(musb
->mregs
, OTG_INTERFSEL
, l
);
383 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
384 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
385 musb_readl(musb
->mregs
, OTG_REVISION
),
386 musb_readl(musb
->mregs
, OTG_SYSCONFIG
),
387 musb_readl(musb
->mregs
, OTG_SYSSTATUS
),
388 musb_readl(musb
->mregs
, OTG_INTERFSEL
),
389 musb_readl(musb
->mregs
, OTG_SIMENABLE
));
391 setup_timer(&musb_idle_timer
, musb_do_idle
, (unsigned long) musb
);
393 if (glue
->status
!= OMAP_MUSB_UNKNOWN
)
394 omap_musb_set_mailbox(glue
);
396 pm_runtime_put_noidle(musb
->controller
);
403 static void omap2430_musb_enable(struct musb
*musb
)
406 unsigned long timeout
= jiffies
+ msecs_to_jiffies(1000);
407 struct device
*dev
= musb
->controller
;
408 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
409 struct musb_hdrc_platform_data
*pdata
= dev
->platform_data
;
410 struct omap_musb_board_data
*data
= pdata
->board_data
;
412 switch (glue
->status
) {
414 case OMAP_MUSB_ID_GROUND
:
415 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_HOST
);
416 if (data
->interface_type
!= MUSB_INTERFACE_UTMI
)
418 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
419 /* start the session */
420 devctl
|= MUSB_DEVCTL_SESSION
;
421 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
422 while (musb_readb(musb
->mregs
, MUSB_DEVCTL
) &
423 MUSB_DEVCTL_BDEVICE
) {
426 if (time_after(jiffies
, timeout
)) {
427 dev_err(dev
, "configured as A device timeout");
433 case OMAP_MUSB_VBUS_VALID
:
434 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_DEVICE
);
442 static void omap2430_musb_disable(struct musb
*musb
)
444 struct device
*dev
= musb
->controller
;
445 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
447 if (glue
->status
!= OMAP_MUSB_UNKNOWN
)
448 omap_control_usb_set_mode(glue
->control_otghs
,
449 USB_MODE_DISCONNECT
);
452 static int omap2430_musb_exit(struct musb
*musb
)
454 del_timer_sync(&musb_idle_timer
);
456 omap2430_low_level_exit(musb
);
461 static const struct musb_platform_ops omap2430_ops
= {
462 .init
= omap2430_musb_init
,
463 .exit
= omap2430_musb_exit
,
465 .set_mode
= omap2430_musb_set_mode
,
466 .try_idle
= omap2430_musb_try_idle
,
468 .set_vbus
= omap2430_musb_set_vbus
,
470 .enable
= omap2430_musb_enable
,
471 .disable
= omap2430_musb_disable
,
474 static u64 omap2430_dmamask
= DMA_BIT_MASK(32);
476 static int omap2430_probe(struct platform_device
*pdev
)
478 struct musb_hdrc_platform_data
*pdata
= pdev
->dev
.platform_data
;
479 struct omap_musb_board_data
*data
;
480 struct platform_device
*musb
;
481 struct omap2430_glue
*glue
;
482 struct device_node
*np
= pdev
->dev
.of_node
;
483 struct musb_hdrc_config
*config
;
486 glue
= devm_kzalloc(&pdev
->dev
, sizeof(*glue
), GFP_KERNEL
);
488 dev_err(&pdev
->dev
, "failed to allocate glue context\n");
492 musb
= platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO
);
494 dev_err(&pdev
->dev
, "failed to allocate musb device\n");
498 musb
->dev
.parent
= &pdev
->dev
;
499 musb
->dev
.dma_mask
= &omap2430_dmamask
;
500 musb
->dev
.coherent_dma_mask
= omap2430_dmamask
;
502 glue
->dev
= &pdev
->dev
;
504 glue
->status
= OMAP_MUSB_UNKNOWN
;
507 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
510 "failed to allocate musb platfrom data\n");
514 data
= devm_kzalloc(&pdev
->dev
, sizeof(*data
), GFP_KERNEL
);
517 "failed to allocate musb board data\n");
521 config
= devm_kzalloc(&pdev
->dev
, sizeof(*config
), GFP_KERNEL
);
524 "failed to allocate musb hdrc config\n");
528 of_property_read_u32(np
, "mode", (u32
*)&pdata
->mode
);
529 of_property_read_u32(np
, "interface_type",
530 (u32
*)&data
->interface_type
);
531 of_property_read_u32(np
, "num_eps", (u32
*)&config
->num_eps
);
532 of_property_read_u32(np
, "ram_bits", (u32
*)&config
->ram_bits
);
533 of_property_read_u32(np
, "power", (u32
*)&pdata
->power
);
534 config
->multipoint
= of_property_read_bool(np
, "multipoint");
535 pdata
->has_mailbox
= of_property_read_bool(np
,
538 pdata
->board_data
= data
;
539 pdata
->config
= config
;
542 if (pdata
->has_mailbox
) {
543 glue
->control_otghs
= omap_get_control_dev();
544 if (IS_ERR(glue
->control_otghs
)) {
545 dev_vdbg(&pdev
->dev
, "Failed to get control device\n");
549 glue
->control_otghs
= ERR_PTR(-ENODEV
);
551 pdata
->platform_ops
= &omap2430_ops
;
553 platform_set_drvdata(pdev
, glue
);
556 * REVISIT if we ever have two instances of the wrapper, we will be
561 INIT_WORK(&glue
->omap_musb_mailbox_work
, omap_musb_mailbox_work
);
563 ret
= platform_device_add_resources(musb
, pdev
->resource
,
564 pdev
->num_resources
);
566 dev_err(&pdev
->dev
, "failed to add resources\n");
570 ret
= platform_device_add_data(musb
, pdata
, sizeof(*pdata
));
572 dev_err(&pdev
->dev
, "failed to add platform_data\n");
576 pm_runtime_enable(&pdev
->dev
);
578 ret
= platform_device_add(musb
);
580 dev_err(&pdev
->dev
, "failed to register musb device\n");
587 platform_device_put(musb
);
593 static int omap2430_remove(struct platform_device
*pdev
)
595 struct omap2430_glue
*glue
= platform_get_drvdata(pdev
);
597 cancel_work_sync(&glue
->omap_musb_mailbox_work
);
598 platform_device_unregister(glue
->musb
);
605 static int omap2430_runtime_suspend(struct device
*dev
)
607 struct omap2430_glue
*glue
= dev_get_drvdata(dev
);
608 struct musb
*musb
= glue_to_musb(glue
);
611 musb
->context
.otg_interfsel
= musb_readl(musb
->mregs
,
614 omap2430_low_level_exit(musb
);
615 usb_phy_set_suspend(musb
->xceiv
, 1);
621 static int omap2430_runtime_resume(struct device
*dev
)
623 struct omap2430_glue
*glue
= dev_get_drvdata(dev
);
624 struct musb
*musb
= glue_to_musb(glue
);
627 omap2430_low_level_init(musb
);
628 musb_writel(musb
->mregs
, OTG_INTERFSEL
,
629 musb
->context
.otg_interfsel
);
631 usb_phy_set_suspend(musb
->xceiv
, 0);
637 static struct dev_pm_ops omap2430_pm_ops
= {
638 .runtime_suspend
= omap2430_runtime_suspend
,
639 .runtime_resume
= omap2430_runtime_resume
,
642 #define DEV_PM_OPS (&omap2430_pm_ops)
644 #define DEV_PM_OPS NULL
648 static const struct of_device_id omap2430_id_table
[] = {
650 .compatible
= "ti,omap4-musb"
653 .compatible
= "ti,omap3-musb"
657 MODULE_DEVICE_TABLE(of
, omap2430_id_table
);
660 static struct platform_driver omap2430_driver
= {
661 .probe
= omap2430_probe
,
662 .remove
= omap2430_remove
,
664 .name
= "musb-omap2430",
666 .of_match_table
= of_match_ptr(omap2430_id_table
),
670 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
671 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
672 MODULE_LICENSE("GPL v2");
674 static int __init
omap2430_init(void)
676 return platform_driver_register(&omap2430_driver
);
678 subsys_initcall(omap2430_init
);
680 static void __exit
omap2430_exit(void)
682 platform_driver_unregister(&omap2430_driver
);
684 module_exit(omap2430_exit
);