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.h>
40 #include <linux/phy/omap_control_phy.h>
41 #include <linux/of_platform.h>
43 #include "musb_core.h"
46 struct omap2430_glue
{
48 struct platform_device
*musb
;
49 enum musb_vbus_id_status status
;
50 struct work_struct omap_musb_mailbox_work
;
51 struct device
*control_otghs
;
56 #define glue_to_musb(g) platform_get_drvdata(g->musb)
58 static struct omap2430_glue
*_glue
;
60 static void omap2430_musb_set_vbus(struct musb
*musb
, int is_on
)
62 struct usb_otg
*otg
= musb
->xceiv
->otg
;
64 unsigned long timeout
= jiffies
+ msecs_to_jiffies(1000);
65 /* HDRC controls CPEN, but beware current surges during device
66 * connect. They can trigger transient overcurrent conditions
67 * that must be ignored.
70 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
73 if (musb
->xceiv
->otg
->state
== OTG_STATE_A_IDLE
) {
75 /* start the session */
76 devctl
|= MUSB_DEVCTL_SESSION
;
77 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
79 * Wait for the musb to set as A device to enable the
82 while (musb_readb(musb
->mregs
, MUSB_DEVCTL
) &
83 MUSB_DEVCTL_BDEVICE
) {
88 if (time_after(jiffies
, timeout
)
90 dev_err(musb
->controller
,
91 "configured as A device timeout");
100 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_VRISE
;
101 devctl
|= MUSB_DEVCTL_SESSION
;
107 /* NOTE: we're skipping A_WAIT_VFALL -> A_IDLE and
108 * jumping right to B_IDLE...
112 musb
->xceiv
->otg
->state
= OTG_STATE_B_IDLE
;
113 devctl
&= ~MUSB_DEVCTL_SESSION
;
117 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
119 dev_dbg(musb
->controller
, "VBUS %s, devctl %02x "
120 /* otg %3x conf %08x prcm %08x */ "\n",
121 usb_otg_state_string(musb
->xceiv
->otg
->state
),
122 musb_readb(musb
->mregs
, MUSB_DEVCTL
));
125 static inline void omap2430_low_level_exit(struct musb
*musb
)
130 l
= musb_readl(musb
->mregs
, OTG_FORCESTDBY
);
131 l
|= ENABLEFORCE
; /* enable MSTANDBY */
132 musb_writel(musb
->mregs
, OTG_FORCESTDBY
, l
);
135 static inline void omap2430_low_level_init(struct musb
*musb
)
139 l
= musb_readl(musb
->mregs
, OTG_FORCESTDBY
);
140 l
&= ~ENABLEFORCE
; /* disable MSTANDBY */
141 musb_writel(musb
->mregs
, OTG_FORCESTDBY
, l
);
145 * We can get multiple cable events so we need to keep track
146 * of the power state. Only keep power enabled if USB cable is
147 * connected and a gadget is started.
149 static void omap2430_set_power(struct musb
*musb
, bool enabled
, bool cable
)
151 struct device
*dev
= musb
->controller
;
152 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
156 if (glue
->enabled
!= enabled
)
157 glue
->enabled
= enabled
;
159 if (glue
->cable_connected
!= cable
)
160 glue
->cable_connected
= cable
;
162 power_up
= glue
->enabled
&& glue
->cable_connected
;
163 if (power_up
== glue
->powered
) {
164 dev_warn(musb
->controller
, "power state already %i\n",
169 glue
->powered
= power_up
;
172 res
= pm_runtime_get_sync(musb
->controller
);
174 dev_err(musb
->controller
, "could not enable: %i", res
);
175 glue
->powered
= false;
178 pm_runtime_mark_last_busy(musb
->controller
);
179 pm_runtime_put_autosuspend(musb
->controller
);
183 static int omap2430_musb_mailbox(enum musb_vbus_id_status status
)
185 struct omap2430_glue
*glue
= _glue
;
188 pr_err("%s: musb core is not yet initialized\n", __func__
);
189 return -EPROBE_DEFER
;
191 glue
->status
= status
;
193 if (!glue_to_musb(glue
)) {
194 pr_err("%s: musb core is not yet ready\n", __func__
);
195 return -EPROBE_DEFER
;
198 schedule_work(&glue
->omap_musb_mailbox_work
);
203 static void omap_musb_set_mailbox(struct omap2430_glue
*glue
)
205 struct musb
*musb
= glue_to_musb(glue
);
206 struct device
*dev
= musb
->controller
;
207 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(dev
);
208 struct omap_musb_board_data
*data
= pdata
->board_data
;
209 struct usb_otg
*otg
= musb
->xceiv
->otg
;
210 bool cable_connected
;
212 cable_connected
= ((glue
->status
== MUSB_ID_GROUND
) ||
213 (glue
->status
== MUSB_VBUS_VALID
));
216 omap2430_set_power(musb
, glue
->enabled
, cable_connected
);
218 switch (glue
->status
) {
220 dev_dbg(dev
, "ID GND\n");
222 otg
->default_a
= true;
223 musb
->xceiv
->otg
->state
= OTG_STATE_A_IDLE
;
224 musb
->xceiv
->last_event
= USB_EVENT_ID
;
225 if (musb
->gadget_driver
) {
226 omap_control_usb_set_mode(glue
->control_otghs
,
228 omap2430_musb_set_vbus(musb
, 1);
232 case MUSB_VBUS_VALID
:
233 dev_dbg(dev
, "VBUS Connect\n");
235 otg
->default_a
= false;
236 musb
->xceiv
->otg
->state
= OTG_STATE_B_IDLE
;
237 musb
->xceiv
->last_event
= USB_EVENT_VBUS
;
238 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_DEVICE
);
243 dev_dbg(dev
, "VBUS Disconnect\n");
245 musb
->xceiv
->last_event
= USB_EVENT_NONE
;
246 if (musb
->gadget_driver
)
247 omap2430_musb_set_vbus(musb
, 0);
249 if (data
->interface_type
== MUSB_INTERFACE_UTMI
)
250 otg_set_vbus(musb
->xceiv
->otg
, 0);
252 omap_control_usb_set_mode(glue
->control_otghs
,
253 USB_MODE_DISCONNECT
);
256 dev_dbg(dev
, "ID float\n");
259 if (!cable_connected
)
260 omap2430_set_power(musb
, glue
->enabled
, cable_connected
);
262 atomic_notifier_call_chain(&musb
->xceiv
->notifier
,
263 musb
->xceiv
->last_event
, NULL
);
267 static void omap_musb_mailbox_work(struct work_struct
*mailbox_work
)
269 struct omap2430_glue
*glue
= container_of(mailbox_work
,
270 struct omap2430_glue
, omap_musb_mailbox_work
);
272 omap_musb_set_mailbox(glue
);
275 static irqreturn_t
omap2430_musb_interrupt(int irq
, void *__hci
)
278 irqreturn_t retval
= IRQ_NONE
;
279 struct musb
*musb
= __hci
;
281 spin_lock_irqsave(&musb
->lock
, flags
);
283 musb
->int_usb
= musb_readb(musb
->mregs
, MUSB_INTRUSB
);
284 musb
->int_tx
= musb_readw(musb
->mregs
, MUSB_INTRTX
);
285 musb
->int_rx
= musb_readw(musb
->mregs
, MUSB_INTRRX
);
287 if (musb
->int_usb
|| musb
->int_tx
|| musb
->int_rx
)
288 retval
= musb_interrupt(musb
);
290 spin_unlock_irqrestore(&musb
->lock
, flags
);
295 static int omap2430_musb_init(struct musb
*musb
)
299 struct device
*dev
= musb
->controller
;
300 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
301 struct musb_hdrc_platform_data
*plat
= dev_get_platdata(dev
);
302 struct omap_musb_board_data
*data
= plat
->board_data
;
304 /* We require some kind of external transceiver, hooked
305 * up through ULPI. TWL4030-family PMICs include one,
306 * which needs a driver, drivers aren't always needed.
308 if (dev
->parent
->of_node
) {
309 musb
->phy
= devm_phy_get(dev
->parent
, "usb2-phy");
311 /* We can't totally remove musb->xceiv as of now because
312 * musb core uses xceiv.state and xceiv.otg. Once we have
313 * a separate state machine to handle otg, these can be moved
314 * out of xceiv and then we can start using the generic PHY
317 musb
->xceiv
= devm_usb_get_phy_by_phandle(dev
->parent
,
320 musb
->xceiv
= devm_usb_get_phy_dev(dev
, 0);
321 musb
->phy
= devm_phy_get(dev
, "usb");
324 if (IS_ERR(musb
->xceiv
)) {
325 status
= PTR_ERR(musb
->xceiv
);
327 if (status
== -ENXIO
)
330 pr_err("HS USB OTG: no transceiver configured\n");
331 return -EPROBE_DEFER
;
334 if (IS_ERR(musb
->phy
)) {
335 pr_err("HS USB OTG: no PHY configured\n");
336 return PTR_ERR(musb
->phy
);
338 musb
->isr
= omap2430_musb_interrupt
;
341 l
= musb_readl(musb
->mregs
, OTG_INTERFSEL
);
343 if (data
->interface_type
== MUSB_INTERFACE_UTMI
) {
344 /* OMAP4 uses Internal PHY GS70 which uses UTMI interface */
345 l
&= ~ULPI_12PIN
; /* Disable ULPI */
346 l
|= UTMI_8BIT
; /* Enable UTMI */
351 musb_writel(musb
->mregs
, OTG_INTERFSEL
, l
);
353 pr_debug("HS USB OTG: revision 0x%x, sysconfig 0x%02x, "
354 "sysstatus 0x%x, intrfsel 0x%x, simenable 0x%x\n",
355 musb_readl(musb
->mregs
, OTG_REVISION
),
356 musb_readl(musb
->mregs
, OTG_SYSCONFIG
),
357 musb_readl(musb
->mregs
, OTG_SYSSTATUS
),
358 musb_readl(musb
->mregs
, OTG_INTERFSEL
),
359 musb_readl(musb
->mregs
, OTG_SIMENABLE
));
361 if (glue
->status
!= MUSB_UNKNOWN
)
362 omap_musb_set_mailbox(glue
);
367 static void omap2430_musb_enable(struct musb
*musb
)
370 unsigned long timeout
= jiffies
+ msecs_to_jiffies(1000);
371 struct device
*dev
= musb
->controller
;
372 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
373 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(dev
);
374 struct omap_musb_board_data
*data
= pdata
->board_data
;
376 if (!WARN_ON(!musb
->phy
))
377 phy_power_on(musb
->phy
);
379 omap2430_set_power(musb
, true, glue
->cable_connected
);
381 switch (glue
->status
) {
384 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_HOST
);
385 if (data
->interface_type
!= MUSB_INTERFACE_UTMI
)
387 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
388 /* start the session */
389 devctl
|= MUSB_DEVCTL_SESSION
;
390 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, devctl
);
391 while (musb_readb(musb
->mregs
, MUSB_DEVCTL
) &
392 MUSB_DEVCTL_BDEVICE
) {
395 if (time_after(jiffies
, timeout
)) {
396 dev_err(dev
, "configured as A device timeout");
402 case MUSB_VBUS_VALID
:
403 omap_control_usb_set_mode(glue
->control_otghs
, USB_MODE_DEVICE
);
411 static void omap2430_musb_disable(struct musb
*musb
)
413 struct device
*dev
= musb
->controller
;
414 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
416 if (!WARN_ON(!musb
->phy
))
417 phy_power_off(musb
->phy
);
419 if (glue
->status
!= MUSB_UNKNOWN
)
420 omap_control_usb_set_mode(glue
->control_otghs
,
421 USB_MODE_DISCONNECT
);
423 omap2430_set_power(musb
, false, glue
->cable_connected
);
426 static int omap2430_musb_exit(struct musb
*musb
)
428 struct device
*dev
= musb
->controller
;
429 struct omap2430_glue
*glue
= dev_get_drvdata(dev
->parent
);
431 omap2430_low_level_exit(musb
);
434 cancel_work_sync(&glue
->omap_musb_mailbox_work
);
439 static const struct musb_platform_ops omap2430_ops
= {
440 .quirks
= MUSB_DMA_INVENTRA
,
441 #ifdef CONFIG_USB_INVENTRA_DMA
442 .dma_init
= musbhs_dma_controller_create
,
443 .dma_exit
= musbhs_dma_controller_destroy
,
445 .init
= omap2430_musb_init
,
446 .exit
= omap2430_musb_exit
,
448 .set_vbus
= omap2430_musb_set_vbus
,
450 .enable
= omap2430_musb_enable
,
451 .disable
= omap2430_musb_disable
,
453 .phy_callback
= omap2430_musb_mailbox
,
456 static u64 omap2430_dmamask
= DMA_BIT_MASK(32);
458 static int omap2430_probe(struct platform_device
*pdev
)
460 struct resource musb_resources
[3];
461 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
462 struct omap_musb_board_data
*data
;
463 struct platform_device
*musb
;
464 struct omap2430_glue
*glue
;
465 struct device_node
*np
= pdev
->dev
.of_node
;
466 struct musb_hdrc_config
*config
;
467 int ret
= -ENOMEM
, val
;
469 glue
= devm_kzalloc(&pdev
->dev
, sizeof(*glue
), GFP_KERNEL
);
473 musb
= platform_device_alloc("musb-hdrc", PLATFORM_DEVID_AUTO
);
475 dev_err(&pdev
->dev
, "failed to allocate musb device\n");
479 musb
->dev
.parent
= &pdev
->dev
;
480 musb
->dev
.dma_mask
= &omap2430_dmamask
;
481 musb
->dev
.coherent_dma_mask
= omap2430_dmamask
;
483 glue
->dev
= &pdev
->dev
;
485 glue
->status
= MUSB_UNKNOWN
;
486 glue
->control_otghs
= ERR_PTR(-ENODEV
);
489 struct device_node
*control_node
;
490 struct platform_device
*control_pdev
;
492 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
496 data
= devm_kzalloc(&pdev
->dev
, sizeof(*data
), GFP_KERNEL
);
500 config
= devm_kzalloc(&pdev
->dev
, sizeof(*config
), GFP_KERNEL
);
504 of_property_read_u32(np
, "mode", (u32
*)&pdata
->mode
);
505 of_property_read_u32(np
, "interface-type",
506 (u32
*)&data
->interface_type
);
507 of_property_read_u32(np
, "num-eps", (u32
*)&config
->num_eps
);
508 of_property_read_u32(np
, "ram-bits", (u32
*)&config
->ram_bits
);
509 of_property_read_u32(np
, "power", (u32
*)&pdata
->power
);
511 ret
= of_property_read_u32(np
, "multipoint", &val
);
513 config
->multipoint
= true;
515 pdata
->board_data
= data
;
516 pdata
->config
= config
;
518 control_node
= of_parse_phandle(np
, "ctrl-module", 0);
520 control_pdev
= of_find_device_by_node(control_node
);
522 dev_err(&pdev
->dev
, "Failed to get control device\n");
526 glue
->control_otghs
= &control_pdev
->dev
;
529 pdata
->platform_ops
= &omap2430_ops
;
531 platform_set_drvdata(pdev
, glue
);
534 * REVISIT if we ever have two instances of the wrapper, we will be
539 INIT_WORK(&glue
->omap_musb_mailbox_work
, omap_musb_mailbox_work
);
541 memset(musb_resources
, 0x00, sizeof(*musb_resources
) *
542 ARRAY_SIZE(musb_resources
));
544 musb_resources
[0].name
= pdev
->resource
[0].name
;
545 musb_resources
[0].start
= pdev
->resource
[0].start
;
546 musb_resources
[0].end
= pdev
->resource
[0].end
;
547 musb_resources
[0].flags
= pdev
->resource
[0].flags
;
549 musb_resources
[1].name
= pdev
->resource
[1].name
;
550 musb_resources
[1].start
= pdev
->resource
[1].start
;
551 musb_resources
[1].end
= pdev
->resource
[1].end
;
552 musb_resources
[1].flags
= pdev
->resource
[1].flags
;
554 musb_resources
[2].name
= pdev
->resource
[2].name
;
555 musb_resources
[2].start
= pdev
->resource
[2].start
;
556 musb_resources
[2].end
= pdev
->resource
[2].end
;
557 musb_resources
[2].flags
= pdev
->resource
[2].flags
;
559 ret
= platform_device_add_resources(musb
, musb_resources
,
560 ARRAY_SIZE(musb_resources
));
562 dev_err(&pdev
->dev
, "failed to add resources\n");
566 ret
= platform_device_add_data(musb
, pdata
, sizeof(*pdata
));
568 dev_err(&pdev
->dev
, "failed to add platform_data\n");
572 pm_runtime_enable(glue
->dev
);
573 pm_runtime_use_autosuspend(glue
->dev
);
574 pm_runtime_set_autosuspend_delay(glue
->dev
, 500);
576 ret
= platform_device_add(musb
);
578 dev_err(&pdev
->dev
, "failed to register musb device\n");
585 platform_device_put(musb
);
591 static int omap2430_remove(struct platform_device
*pdev
)
593 struct omap2430_glue
*glue
= platform_get_drvdata(pdev
);
594 struct musb
*musb
= glue_to_musb(glue
);
596 pm_runtime_get_sync(glue
->dev
);
597 platform_device_unregister(glue
->musb
);
598 omap2430_set_power(musb
, false, false);
599 pm_runtime_put_sync(glue
->dev
);
600 pm_runtime_dont_use_autosuspend(glue
->dev
);
601 pm_runtime_disable(glue
->dev
);
608 static int omap2430_runtime_suspend(struct device
*dev
)
610 struct omap2430_glue
*glue
= dev_get_drvdata(dev
);
611 struct musb
*musb
= glue_to_musb(glue
);
616 musb
->context
.otg_interfsel
= musb_readl(musb
->mregs
,
619 omap2430_low_level_exit(musb
);
624 static int omap2430_runtime_resume(struct device
*dev
)
626 struct omap2430_glue
*glue
= dev_get_drvdata(dev
);
627 struct musb
*musb
= glue_to_musb(glue
);
632 omap2430_low_level_init(musb
);
633 musb_writel(musb
->mregs
, OTG_INTERFSEL
,
634 musb
->context
.otg_interfsel
);
639 static struct dev_pm_ops omap2430_pm_ops
= {
640 .runtime_suspend
= omap2430_runtime_suspend
,
641 .runtime_resume
= omap2430_runtime_resume
,
644 #define DEV_PM_OPS (&omap2430_pm_ops)
646 #define DEV_PM_OPS NULL
650 static const struct of_device_id omap2430_id_table
[] = {
652 .compatible
= "ti,omap4-musb"
655 .compatible
= "ti,omap3-musb"
659 MODULE_DEVICE_TABLE(of
, omap2430_id_table
);
662 static struct platform_driver omap2430_driver
= {
663 .probe
= omap2430_probe
,
664 .remove
= omap2430_remove
,
666 .name
= "musb-omap2430",
668 .of_match_table
= of_match_ptr(omap2430_id_table
),
672 module_platform_driver(omap2430_driver
);
674 MODULE_DESCRIPTION("OMAP2PLUS MUSB Glue Layer");
675 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
676 MODULE_LICENSE("GPL v2");