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
->hcd
);
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 usb_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 usb_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");
177 otg_set_vbus(otg
, 1);
181 musb
->xceiv
->state
= OTG_STATE_A_WAIT_VRISE
;
182 devctl
|= MUSB_DEVCTL_SESSION
;
188 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
189 * jumping right to B_IDLE...
193 musb
->xceiv
->state
= OTG_STATE_B_IDLE
;
194 devctl
&= ~MUSB_DEVCTL_SESSION
;
198 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
200 dev_dbg(musb
->controller
, "VBUS %s, devctl %02x "
201 /* otg %3x conf %08x prcm %08x */ "\n",
202 usb_otg_state_string(musb
->xceiv
->state
),
203 musb_readb(musb
->mregs
, MUSB_DEVCTL
));
206 static int omap2430_musb_set_mode(struct musb
*musb
, u8 musb_mode
)
208 u8 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
210 devctl
|= MUSB_DEVCTL_SESSION
;
211 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
216 static inline void omap2430_low_level_exit(struct musb
*musb
)
221 l
= musb_readl(musb
->mregs
, OTG_FORCESTDBY
);
222 l
|= ENABLEFORCE
; /* enable MSTANDBY */
223 musb_writel(musb
->mregs
, OTG_FORCESTDBY
, l
);
226 static inline void omap2430_low_level_init(struct musb
*musb
)
230 l
= musb_readl(musb
->mregs
, OTG_FORCESTDBY
);
231 l
&= ~ENABLEFORCE
; /* disable MSTANDBY */
232 musb_writel(musb
->mregs
, OTG_FORCESTDBY
, l
);
235 void omap_musb_mailbox(enum omap_musb_vbus_id_status status
)
237 struct omap2430_glue
*glue
= _glue
;
240 pr_err("%s: musb core is not yet initialized\n", __func__
);
243 glue
->status
= status
;
245 if (!glue_to_musb(glue
)) {
246 pr_err("%s: musb core is not yet ready\n", __func__
);
250 schedule_work(&glue
->omap_musb_mailbox_work
);
252 EXPORT_SYMBOL_GPL(omap_musb_mailbox
);
254 static void omap_musb_set_mailbox(struct omap2430_glue
*glue
)
256 struct musb
*musb
= glue_to_musb(glue
);
257 struct device
*dev
= musb
->controller
;
258 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(dev
);
259 struct omap_musb_board_data
*data
= pdata
->board_data
;
260 struct usb_otg
*otg
= musb
->xceiv
->otg
;
262 switch (glue
->status
) {
263 case OMAP_MUSB_ID_GROUND
:
264 dev_dbg(dev
, "ID GND\n");
266 otg
->default_a
= true;
267 musb
->xceiv
->state
= OTG_STATE_A_IDLE
;
268 musb
->xceiv
->last_event
= USB_EVENT_ID
;
269 if (musb
->gadget_driver
) {
270 pm_runtime_get_sync(dev
);
271 omap_control_usb_set_mode(glue
->control_otghs
,
273 omap2430_musb_set_vbus(musb
, 1);
277 case OMAP_MUSB_VBUS_VALID
:
278 dev_dbg(dev
, "VBUS Connect\n");
280 otg
->default_a
= false;
281 musb
->xceiv
->state
= OTG_STATE_B_IDLE
;
282 musb
->xceiv
->last_event
= USB_EVENT_VBUS
;
283 if (musb
->gadget_driver
)
284 pm_runtime_get_sync(dev
);
285 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_DEVICE
);
288 case OMAP_MUSB_ID_FLOAT
:
289 case OMAP_MUSB_VBUS_OFF
:
290 dev_dbg(dev
, "VBUS Disconnect\n");
292 musb
->xceiv
->last_event
= USB_EVENT_NONE
;
293 if (musb
->gadget_driver
) {
294 omap2430_musb_set_vbus(musb
, 0);
295 pm_runtime_mark_last_busy(dev
);
296 pm_runtime_put_autosuspend(dev
);
299 if (data
->interface_type
== MUSB_INTERFACE_UTMI
)
300 otg_set_vbus(musb
->xceiv
->otg
, 0);
302 omap_control_usb_set_mode(glue
->control_otghs
,
303 USB_MODE_DISCONNECT
);
306 dev_dbg(dev
, "ID float\n");
311 static void omap_musb_mailbox_work(struct work_struct
*mailbox_work
)
313 struct omap2430_glue
*glue
= container_of(mailbox_work
,
314 struct omap2430_glue
, omap_musb_mailbox_work
);
315 omap_musb_set_mailbox(glue
);
318 static irqreturn_t
omap2430_musb_interrupt(int irq
, void *__hci
)
321 irqreturn_t retval
= IRQ_NONE
;
322 struct musb
*musb
= __hci
;
324 spin_lock_irqsave(&musb
->lock
, flags
);
326 musb
->int_usb
= musb_readb(musb
->mregs
, MUSB_INTRUSB
);
327 musb
->int_tx
= musb_readw(musb
->mregs
, MUSB_INTRTX
);
328 musb
->int_rx
= musb_readw(musb
->mregs
, MUSB_INTRRX
);
330 if (musb
->int_usb
|| musb
->int_tx
|| musb
->int_rx
)
331 retval
= musb_interrupt(musb
);
333 spin_unlock_irqrestore(&musb
->lock
, flags
);
338 static int omap2430_musb_init(struct musb
*musb
)
342 struct device
*dev
= musb
->controller
;
343 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
344 struct musb_hdrc_platform_data
*plat
= dev_get_platdata(dev
);
345 struct omap_musb_board_data
*data
= plat
->board_data
;
347 /* We require some kind of external transceiver, hooked
348 * up through ULPI. TWL4030-family PMICs include one,
349 * which needs a driver, drivers aren't always needed.
351 if (dev
->parent
->of_node
)
352 musb
->xceiv
= devm_usb_get_phy_by_phandle(dev
->parent
,
355 musb
->xceiv
= devm_usb_get_phy_dev(dev
, 0);
357 if (IS_ERR(musb
->xceiv
)) {
358 status
= PTR_ERR(musb
->xceiv
);
360 if (status
== -ENXIO
)
363 pr_err("HS USB OTG: no transceiver configured\n");
364 return -EPROBE_DEFER
;
367 musb
->isr
= omap2430_musb_interrupt
;
369 status
= pm_runtime_get_sync(dev
);
371 dev_err(dev
, "pm_runtime_get_sync FAILED %d\n", status
);
375 l
= musb_readl(musb
->mregs
, OTG_INTERFSEL
);
377 if (data
->interface_type
== MUSB_INTERFACE_UTMI
) {
378 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
379 l
&= ~ULPI_12PIN
; /* Disable ULPI */
380 l
|= UTMI_8BIT
; /* Enable UTMI */
385 musb_writel(musb
->mregs
, OTG_INTERFSEL
, l
);
387 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
388 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
389 musb_readl(musb
->mregs
, OTG_REVISION
),
390 musb_readl(musb
->mregs
, OTG_SYSCONFIG
),
391 musb_readl(musb
->mregs
, OTG_SYSSTATUS
),
392 musb_readl(musb
->mregs
, OTG_INTERFSEL
),
393 musb_readl(musb
->mregs
, OTG_SIMENABLE
));
395 setup_timer(&musb_idle_timer
, musb_do_idle
, (unsigned long) musb
);
397 if (glue
->status
!= OMAP_MUSB_UNKNOWN
)
398 omap_musb_set_mailbox(glue
);
400 usb_phy_init(musb
->xceiv
);
402 pm_runtime_put_noidle(musb
->controller
);
409 static void omap2430_musb_enable(struct musb
*musb
)
412 unsigned long timeout
= jiffies
+ msecs_to_jiffies(1000);
413 struct device
*dev
= musb
->controller
;
414 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
415 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(dev
);
416 struct omap_musb_board_data
*data
= pdata
->board_data
;
418 switch (glue
->status
) {
420 case OMAP_MUSB_ID_GROUND
:
421 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_HOST
);
422 if (data
->interface_type
!= MUSB_INTERFACE_UTMI
)
424 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
425 /* start the session */
426 devctl
|= MUSB_DEVCTL_SESSION
;
427 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
428 while (musb_readb(musb
->mregs
, MUSB_DEVCTL
) &
429 MUSB_DEVCTL_BDEVICE
) {
432 if (time_after(jiffies
, timeout
)) {
433 dev_err(dev
, "configured as A device timeout");
439 case OMAP_MUSB_VBUS_VALID
:
440 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_DEVICE
);
448 static void omap2430_musb_disable(struct musb
*musb
)
450 struct device
*dev
= musb
->controller
;
451 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
453 if (glue
->status
!= OMAP_MUSB_UNKNOWN
)
454 omap_control_usb_set_mode(glue
->control_otghs
,
455 USB_MODE_DISCONNECT
);
458 static int omap2430_musb_exit(struct musb
*musb
)
460 del_timer_sync(&musb_idle_timer
);
462 omap2430_low_level_exit(musb
);
467 static const struct musb_platform_ops omap2430_ops
= {
468 .init
= omap2430_musb_init
,
469 .exit
= omap2430_musb_exit
,
471 .set_mode
= omap2430_musb_set_mode
,
472 .try_idle
= omap2430_musb_try_idle
,
474 .set_vbus
= omap2430_musb_set_vbus
,
476 .enable
= omap2430_musb_enable
,
477 .disable
= omap2430_musb_disable
,
480 static u64 omap2430_dmamask
= DMA_BIT_MASK(32);
482 static int omap2430_probe(struct platform_device
*pdev
)
484 struct resource musb_resources
[3];
485 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
486 struct omap_musb_board_data
*data
;
487 struct platform_device
*musb
;
488 struct omap2430_glue
*glue
;
489 struct device_node
*np
= pdev
->dev
.of_node
;
490 struct musb_hdrc_config
*config
;
493 glue
= devm_kzalloc(&pdev
->dev
, sizeof(*glue
), GFP_KERNEL
);
495 dev_err(&pdev
->dev
, "failed to allocate glue context\n");
499 musb
= platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO
);
501 dev_err(&pdev
->dev
, "failed to allocate musb device\n");
505 musb
->dev
.parent
= &pdev
->dev
;
506 musb
->dev
.dma_mask
= &omap2430_dmamask
;
507 musb
->dev
.coherent_dma_mask
= omap2430_dmamask
;
509 glue
->dev
= &pdev
->dev
;
511 glue
->status
= OMAP_MUSB_UNKNOWN
;
514 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
517 "failed to allocate musb platform data\n");
521 data
= devm_kzalloc(&pdev
->dev
, sizeof(*data
), GFP_KERNEL
);
524 "failed to allocate musb board data\n");
528 config
= devm_kzalloc(&pdev
->dev
, sizeof(*config
), GFP_KERNEL
);
531 "failed to allocate musb hdrc config\n");
535 of_property_read_u32(np
, "mode", (u32
*)&pdata
->mode
);
536 of_property_read_u32(np
, "interface-type",
537 (u32
*)&data
->interface_type
);
538 of_property_read_u32(np
, "num-eps", (u32
*)&config
->num_eps
);
539 of_property_read_u32(np
, "ram-bits", (u32
*)&config
->ram_bits
);
540 of_property_read_u32(np
, "power", (u32
*)&pdata
->power
);
541 config
->multipoint
= of_property_read_bool(np
, "multipoint");
542 pdata
->has_mailbox
= of_property_read_bool(np
,
545 pdata
->board_data
= data
;
546 pdata
->config
= config
;
549 if (pdata
->has_mailbox
) {
550 glue
->control_otghs
= omap_get_control_dev();
551 if (IS_ERR(glue
->control_otghs
)) {
552 dev_vdbg(&pdev
->dev
, "Failed to get control device\n");
553 ret
= PTR_ERR(glue
->control_otghs
);
557 glue
->control_otghs
= ERR_PTR(-ENODEV
);
559 pdata
->platform_ops
= &omap2430_ops
;
561 platform_set_drvdata(pdev
, glue
);
564 * REVISIT if we ever have two instances of the wrapper, we will be
569 INIT_WORK(&glue
->omap_musb_mailbox_work
, omap_musb_mailbox_work
);
571 memset(musb_resources
, 0x00, sizeof(*musb_resources
) *
572 ARRAY_SIZE(musb_resources
));
574 musb_resources
[0].name
= pdev
->resource
[0].name
;
575 musb_resources
[0].start
= pdev
->resource
[0].start
;
576 musb_resources
[0].end
= pdev
->resource
[0].end
;
577 musb_resources
[0].flags
= pdev
->resource
[0].flags
;
579 musb_resources
[1].name
= pdev
->resource
[1].name
;
580 musb_resources
[1].start
= pdev
->resource
[1].start
;
581 musb_resources
[1].end
= pdev
->resource
[1].end
;
582 musb_resources
[1].flags
= pdev
->resource
[1].flags
;
584 musb_resources
[2].name
= pdev
->resource
[2].name
;
585 musb_resources
[2].start
= pdev
->resource
[2].start
;
586 musb_resources
[2].end
= pdev
->resource
[2].end
;
587 musb_resources
[2].flags
= pdev
->resource
[2].flags
;
589 ret
= platform_device_add_resources(musb
, musb_resources
,
590 ARRAY_SIZE(musb_resources
));
592 dev_err(&pdev
->dev
, "failed to add resources\n");
596 ret
= platform_device_add_data(musb
, pdata
, sizeof(*pdata
));
598 dev_err(&pdev
->dev
, "failed to add platform_data\n");
602 pm_runtime_enable(&pdev
->dev
);
604 ret
= platform_device_add(musb
);
606 dev_err(&pdev
->dev
, "failed to register musb device\n");
613 platform_device_put(musb
);
619 static int omap2430_remove(struct platform_device
*pdev
)
621 struct omap2430_glue
*glue
= platform_get_drvdata(pdev
);
623 cancel_work_sync(&glue
->omap_musb_mailbox_work
);
624 platform_device_unregister(glue
->musb
);
631 static int omap2430_runtime_suspend(struct device
*dev
)
633 struct omap2430_glue
*glue
= dev_get_drvdata(dev
);
634 struct musb
*musb
= glue_to_musb(glue
);
637 musb
->context
.otg_interfsel
= musb_readl(musb
->mregs
,
640 omap2430_low_level_exit(musb
);
641 usb_phy_set_suspend(musb
->xceiv
, 1);
647 static int omap2430_runtime_resume(struct device
*dev
)
649 struct omap2430_glue
*glue
= dev_get_drvdata(dev
);
650 struct musb
*musb
= glue_to_musb(glue
);
653 omap2430_low_level_init(musb
);
654 musb_writel(musb
->mregs
, OTG_INTERFSEL
,
655 musb
->context
.otg_interfsel
);
657 usb_phy_set_suspend(musb
->xceiv
, 0);
663 static struct dev_pm_ops omap2430_pm_ops
= {
664 .runtime_suspend
= omap2430_runtime_suspend
,
665 .runtime_resume
= omap2430_runtime_resume
,
668 #define DEV_PM_OPS (&omap2430_pm_ops)
670 #define DEV_PM_OPS NULL
674 static const struct of_device_id omap2430_id_table
[] = {
676 .compatible
= "ti,omap4-musb"
679 .compatible
= "ti,omap3-musb"
683 MODULE_DEVICE_TABLE(of
, omap2430_id_table
);
686 static struct platform_driver omap2430_driver
= {
687 .probe
= omap2430_probe
,
688 .remove
= omap2430_remove
,
690 .name
= "musb-omap2430",
692 .of_match_table
= of_match_ptr(omap2430_id_table
),
696 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
697 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
698 MODULE_LICENSE("GPL v2");
700 static int __init
omap2430_init(void)
702 return platform_driver_register(&omap2430_driver
);
704 subsys_initcall(omap2430_init
);
706 static void __exit
omap2430_exit(void)
708 platform_driver_unregister(&omap2430_driver
);
710 module_exit(omap2430_exit
);