2 * Copyright (C) 2005-2006 by Texas Instruments
4 * This file is part of the Inventra Controller Driver for Linux.
6 * The Inventra Controller Driver for Linux is free software; you
7 * can redistribute it and/or modify it under the terms of the GNU
8 * General Public License version 2 as published by the Free Software
11 * The Inventra Controller Driver for Linux is distributed in
12 * the hope that it will be useful, but WITHOUT ANY WARRANTY;
13 * without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
15 * License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with The Inventra Controller Driver for Linux ; if not,
19 * write to the Free Software Foundation, Inc., 59 Temple Place,
20 * Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/sched.h>
27 #include <linux/list.h>
28 #include <linux/delay.h>
29 #include <linux/clk.h>
30 #include <linux/err.h>
32 #include <linux/gpio.h>
33 #include <linux/platform_device.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/usb/usb_phy_generic.h>
37 #include <mach/cputype.h>
38 #include <mach/hardware.h>
40 #include <asm/mach-types.h>
42 #include "musb_core.h"
44 #ifdef CONFIG_MACH_DAVINCI_EVM
45 #define GPIO_nVBUS_DRV 160
52 #define USB_PHY_CTRL IO_ADDRESS(USBPHY_CTL_PADDR)
53 #define DM355_DEEPSLEEP IO_ADDRESS(DM355_DEEPSLEEP_PADDR)
57 struct platform_device
*musb
;
61 /* REVISIT (PM) we should be able to keep the PHY in low power mode most
62 * of the time (24 MHZ oscillator and PLL off, etc) by setting POWER.D0
63 * and, when in host mode, autosuspending idle root ports... PHYPLLON
64 * (overriding SUSPENDM?) then likely needs to stay off.
67 static inline void phy_on(void)
69 u32 phy_ctrl
= __raw_readl(USB_PHY_CTRL
);
71 /* power everything up; start the on-chip PHY and its PLL */
72 phy_ctrl
&= ~(USBPHY_OSCPDWN
| USBPHY_OTGPDWN
| USBPHY_PHYPDWN
);
73 phy_ctrl
|= USBPHY_SESNDEN
| USBPHY_VBDTCTEN
| USBPHY_PHYPLLON
;
74 __raw_writel(phy_ctrl
, USB_PHY_CTRL
);
76 /* wait for PLL to lock before proceeding */
77 while ((__raw_readl(USB_PHY_CTRL
) & USBPHY_PHYCLKGD
) == 0)
81 static inline void phy_off(void)
83 u32 phy_ctrl
= __raw_readl(USB_PHY_CTRL
);
85 /* powerdown the on-chip PHY, its PLL, and the OTG block */
86 phy_ctrl
&= ~(USBPHY_SESNDEN
| USBPHY_VBDTCTEN
| USBPHY_PHYPLLON
);
87 phy_ctrl
|= USBPHY_OSCPDWN
| USBPHY_OTGPDWN
| USBPHY_PHYPDWN
;
88 __raw_writel(phy_ctrl
, USB_PHY_CTRL
);
91 static int dma_off
= 1;
93 static void davinci_musb_enable(struct musb
*musb
)
97 /* workaround: setup irqs through both register sets */
98 tmp
= (musb
->epmask
& DAVINCI_USB_TX_ENDPTS_MASK
)
99 << DAVINCI_USB_TXINT_SHIFT
;
100 musb_writel(musb
->ctrl_base
, DAVINCI_USB_INT_MASK_SET_REG
, tmp
);
102 tmp
= (musb
->epmask
& (0xfffe & DAVINCI_USB_RX_ENDPTS_MASK
))
103 << DAVINCI_USB_RXINT_SHIFT
;
104 musb_writel(musb
->ctrl_base
, DAVINCI_USB_INT_MASK_SET_REG
, tmp
);
107 val
= ~MUSB_INTR_SOF
;
108 tmp
|= ((val
& 0x01ff) << DAVINCI_USB_USBINT_SHIFT
);
109 musb_writel(musb
->ctrl_base
, DAVINCI_USB_INT_MASK_SET_REG
, tmp
);
111 if (is_dma_capable() && !dma_off
)
112 printk(KERN_WARNING
"%s %s: dma not reactivated\n",
117 /* force a DRVVBUS irq so we can start polling for ID change */
118 musb_writel(musb
->ctrl_base
, DAVINCI_USB_INT_SET_REG
,
119 DAVINCI_INTR_DRVVBUS
<< DAVINCI_USB_USBINT_SHIFT
);
123 * Disable the HDRC and flush interrupts
125 static void davinci_musb_disable(struct musb
*musb
)
127 /* because we don't set CTRLR.UINT, "important" to:
128 * - not read/write INTRUSB/INTRUSBE
129 * - (except during initial setup, as workaround)
130 * - use INTSETR/INTCLRR instead
132 musb_writel(musb
->ctrl_base
, DAVINCI_USB_INT_MASK_CLR_REG
,
133 DAVINCI_USB_USBINT_MASK
134 | DAVINCI_USB_TXINT_MASK
135 | DAVINCI_USB_RXINT_MASK
);
136 musb_writeb(musb
->mregs
, MUSB_DEVCTL
, 0);
137 musb_writel(musb
->ctrl_base
, DAVINCI_USB_EOI_REG
, 0);
139 if (is_dma_capable() && !dma_off
)
140 WARNING("dma still active\n");
144 #define portstate(stmt) stmt
147 * VBUS SWITCHING IS BOARD-SPECIFIC ... at least for the DM6446 EVM,
148 * which doesn't wire DRVVBUS to the FET that switches it. Unclear
149 * if that's a problem with the DM6446 chip or just with that board.
151 * In either case, the DM355 EVM automates DRVVBUS the normal way,
152 * when J10 is out, and TI documents it as handling OTG.
155 #ifdef CONFIG_MACH_DAVINCI_EVM
157 static int vbus_state
= -1;
159 /* I2C operations are always synchronous, and require a task context.
160 * With unloaded systems, using the shared workqueue seems to suffice
161 * to satisfy the 100msec A_WAIT_VRISE timeout...
163 static void evm_deferred_drvvbus(struct work_struct
*ignored
)
165 gpio_set_value_cansleep(GPIO_nVBUS_DRV
, vbus_state
);
166 vbus_state
= !vbus_state
;
171 static void davinci_musb_source_power(struct musb
*musb
, int is_on
, int immediate
)
173 #ifdef CONFIG_MACH_DAVINCI_EVM
177 if (vbus_state
== is_on
)
179 vbus_state
= !is_on
; /* 0/1 vs "-1 == unknown/init" */
181 if (machine_is_davinci_evm()) {
182 static DECLARE_WORK(evm_vbus_work
, evm_deferred_drvvbus
);
185 gpio_set_value_cansleep(GPIO_nVBUS_DRV
, vbus_state
);
187 schedule_work(&evm_vbus_work
);
194 static void davinci_musb_set_vbus(struct musb
*musb
, int is_on
)
196 WARN_ON(is_on
&& is_peripheral_active(musb
));
197 davinci_musb_source_power(musb
, is_on
, 0);
201 #define POLL_SECONDS 2
203 static struct timer_list otg_workaround
;
205 static void otg_timer(unsigned long _musb
)
207 struct musb
*musb
= (void *)_musb
;
208 void __iomem
*mregs
= musb
->mregs
;
212 /* We poll because DaVinci's won't expose several OTG-critical
213 * status change events (from the transceiver) otherwise.
215 devctl
= musb_readb(mregs
, MUSB_DEVCTL
);
216 dev_dbg(musb
->controller
, "poll devctl %02x (%s)\n", devctl
,
217 usb_otg_state_string(musb
->xceiv
->otg
->state
));
219 spin_lock_irqsave(&musb
->lock
, flags
);
220 switch (musb
->xceiv
->otg
->state
) {
221 case OTG_STATE_A_WAIT_VFALL
:
222 /* Wait till VBUS falls below SessionEnd (~0.2V); the 1.3 RTL
223 * seems to mis-handle session "start" otherwise (or in our
224 * case "recover"), in routine "VBUS was valid by the time
225 * VBUSERR got reported during enumeration" cases.
227 if (devctl
& MUSB_DEVCTL_VBUS
) {
228 mod_timer(&otg_workaround
, jiffies
+ POLL_SECONDS
* HZ
);
231 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_VRISE
;
232 musb_writel(musb
->ctrl_base
, DAVINCI_USB_INT_SET_REG
,
233 MUSB_INTR_VBUSERROR
<< DAVINCI_USB_USBINT_SHIFT
);
235 case OTG_STATE_B_IDLE
:
237 * There's no ID-changed IRQ, so we have no good way to tell
238 * when to switch to the A-Default state machine (by setting
239 * the DEVCTL.SESSION flag).
241 * Workaround: whenever we're in B_IDLE, try setting the
242 * session flag every few seconds. If it works, ID was
243 * grounded and we're now in the A-Default state machine.
245 * NOTE setting the session flag is _supposed_ to trigger
246 * SRP, but clearly it doesn't.
248 musb_writeb(mregs
, MUSB_DEVCTL
,
249 devctl
| MUSB_DEVCTL_SESSION
);
250 devctl
= musb_readb(mregs
, MUSB_DEVCTL
);
251 if (devctl
& MUSB_DEVCTL_BDEVICE
)
252 mod_timer(&otg_workaround
, jiffies
+ POLL_SECONDS
* HZ
);
254 musb
->xceiv
->otg
->state
= OTG_STATE_A_IDLE
;
259 spin_unlock_irqrestore(&musb
->lock
, flags
);
262 static irqreturn_t
davinci_musb_interrupt(int irq
, void *__hci
)
265 irqreturn_t retval
= IRQ_NONE
;
266 struct musb
*musb
= __hci
;
267 struct usb_otg
*otg
= musb
->xceiv
->otg
;
268 void __iomem
*tibase
= musb
->ctrl_base
;
272 spin_lock_irqsave(&musb
->lock
, flags
);
274 /* NOTE: DaVinci shadows the Mentor IRQs. Don't manage them through
275 * the Mentor registers (except for setup), use the TI ones and EOI.
277 * Docs describe irq "vector" registers associated with the CPPI and
278 * USB EOI registers. These hold a bitmask corresponding to the
279 * current IRQ, not an irq handler address. Would using those bits
280 * resolve some of the races observed in this dispatch code??
283 /* CPPI interrupts share the same IRQ line, but have their own
284 * mask, state, "vector", and EOI registers.
286 cppi
= container_of(musb
->dma_controller
, struct cppi
, controller
);
287 if (is_cppi_enabled(musb
) && musb
->dma_controller
&& !cppi
->irq
)
288 retval
= cppi_interrupt(irq
, __hci
);
290 /* ack and handle non-CPPI interrupts */
291 tmp
= musb_readl(tibase
, DAVINCI_USB_INT_SRC_MASKED_REG
);
292 musb_writel(tibase
, DAVINCI_USB_INT_SRC_CLR_REG
, tmp
);
293 dev_dbg(musb
->controller
, "IRQ %08x\n", tmp
);
295 musb
->int_rx
= (tmp
& DAVINCI_USB_RXINT_MASK
)
296 >> DAVINCI_USB_RXINT_SHIFT
;
297 musb
->int_tx
= (tmp
& DAVINCI_USB_TXINT_MASK
)
298 >> DAVINCI_USB_TXINT_SHIFT
;
299 musb
->int_usb
= (tmp
& DAVINCI_USB_USBINT_MASK
)
300 >> DAVINCI_USB_USBINT_SHIFT
;
302 /* DRVVBUS irqs are the only proxy we have (a very poor one!) for
303 * DaVinci's missing ID change IRQ. We need an ID change IRQ to
304 * switch appropriately between halves of the OTG state machine.
305 * Managing DEVCTL.SESSION per Mentor docs requires we know its
306 * value, but DEVCTL.BDEVICE is invalid without DEVCTL.SESSION set.
307 * Also, DRVVBUS pulses for SRP (but not at 5V) ...
309 if (tmp
& (DAVINCI_INTR_DRVVBUS
<< DAVINCI_USB_USBINT_SHIFT
)) {
310 int drvvbus
= musb_readl(tibase
, DAVINCI_USB_STAT_REG
);
311 void __iomem
*mregs
= musb
->mregs
;
312 u8 devctl
= musb_readb(mregs
, MUSB_DEVCTL
);
313 int err
= musb
->int_usb
& MUSB_INTR_VBUSERROR
;
315 err
= musb
->int_usb
& MUSB_INTR_VBUSERROR
;
317 /* The Mentor core doesn't debounce VBUS as needed
318 * to cope with device connect current spikes. This
319 * means it's not uncommon for bus-powered devices
320 * to get VBUS errors during enumeration.
322 * This is a workaround, but newer RTL from Mentor
323 * seems to allow a better one: "re"starting sessions
324 * without waiting (on EVM, a **long** time) for VBUS
325 * to stop registering in devctl.
327 musb
->int_usb
&= ~MUSB_INTR_VBUSERROR
;
328 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_VFALL
;
329 mod_timer(&otg_workaround
, jiffies
+ POLL_SECONDS
* HZ
);
330 WARNING("VBUS error workaround (delay coming)\n");
331 } else if (drvvbus
) {
334 musb
->xceiv
->otg
->state
= OTG_STATE_A_WAIT_VRISE
;
335 portstate(musb
->port1_status
|= USB_PORT_STAT_POWER
);
336 del_timer(&otg_workaround
);
341 musb
->xceiv
->otg
->state
= OTG_STATE_B_IDLE
;
342 portstate(musb
->port1_status
&= ~USB_PORT_STAT_POWER
);
345 /* NOTE: this must complete poweron within 100 msec
346 * (OTG_TIME_A_WAIT_VRISE) but we don't check for that.
348 davinci_musb_source_power(musb
, drvvbus
, 0);
349 dev_dbg(musb
->controller
, "VBUS %s (%s)%s, devctl %02x\n",
350 drvvbus
? "on" : "off",
351 usb_otg_state_string(musb
->xceiv
->otg
->state
),
354 retval
= IRQ_HANDLED
;
357 if (musb
->int_tx
|| musb
->int_rx
|| musb
->int_usb
)
358 retval
|= musb_interrupt(musb
);
360 /* irq stays asserted until EOI is written */
361 musb_writel(tibase
, DAVINCI_USB_EOI_REG
, 0);
363 /* poll for ID change */
364 if (musb
->xceiv
->otg
->state
== OTG_STATE_B_IDLE
)
365 mod_timer(&otg_workaround
, jiffies
+ POLL_SECONDS
* HZ
);
367 spin_unlock_irqrestore(&musb
->lock
, flags
);
372 static int davinci_musb_set_mode(struct musb
*musb
, u8 mode
)
374 /* EVM can't do this (right?) */
378 static int davinci_musb_init(struct musb
*musb
)
380 void __iomem
*tibase
= musb
->ctrl_base
;
384 musb
->xceiv
= usb_get_phy(USB_PHY_TYPE_USB2
);
385 if (IS_ERR_OR_NULL(musb
->xceiv
)) {
390 musb
->mregs
+= DAVINCI_BASE_OFFSET
;
392 /* returns zero if e.g. not clocked */
393 revision
= musb_readl(tibase
, DAVINCI_USB_VERSION_REG
);
397 setup_timer(&otg_workaround
, otg_timer
, (unsigned long) musb
);
399 davinci_musb_source_power(musb
, 0, 1);
401 /* dm355 EVM swaps D+/D- for signal integrity, and
402 * is clocked from the main 24 MHz crystal.
404 if (machine_is_davinci_dm355_evm()) {
405 u32 phy_ctrl
= __raw_readl(USB_PHY_CTRL
);
407 phy_ctrl
&= ~(3 << 9);
408 phy_ctrl
|= USBPHY_DATAPOL
;
409 __raw_writel(phy_ctrl
, USB_PHY_CTRL
);
412 /* On dm355, the default-A state machine needs DRVVBUS control.
413 * If we won't be a host, there's no need to turn it on.
415 if (cpu_is_davinci_dm355()) {
416 u32 deepsleep
= __raw_readl(DM355_DEEPSLEEP
);
418 deepsleep
&= ~DRVVBUS_FORCE
;
419 __raw_writel(deepsleep
, DM355_DEEPSLEEP
);
422 /* reset the controller */
423 musb_writel(tibase
, DAVINCI_USB_CTRL_REG
, 0x1);
425 /* start the on-chip PHY and its PLL */
430 /* NOTE: irqs are in mixed mode, not bypass to pure-musb */
431 pr_debug("DaVinci OTG revision %08x phy %03x control %02x\n",
432 revision
, __raw_readl(USB_PHY_CTRL
),
433 musb_readb(tibase
, DAVINCI_USB_CTRL_REG
));
435 musb
->isr
= davinci_musb_interrupt
;
439 usb_put_phy(musb
->xceiv
);
441 usb_phy_generic_unregister();
445 static int davinci_musb_exit(struct musb
*musb
)
447 del_timer_sync(&otg_workaround
);
450 if (cpu_is_davinci_dm355()) {
451 u32 deepsleep
= __raw_readl(DM355_DEEPSLEEP
);
453 deepsleep
&= ~DRVVBUS_FORCE
;
454 deepsleep
|= DRVVBUS_OVERRIDE
;
455 __raw_writel(deepsleep
, DM355_DEEPSLEEP
);
458 davinci_musb_source_power(musb
, 0 /*off*/, 1);
460 /* delay, to avoid problems with module reload */
461 if (musb
->xceiv
->otg
->default_a
) {
465 /* if there's no peripheral connected, this can take a
466 * long time to fall, especially on EVM with huge C133.
469 devctl
= musb_readb(musb
->mregs
, MUSB_DEVCTL
);
470 if (!(devctl
& MUSB_DEVCTL_VBUS
))
472 if ((devctl
& MUSB_DEVCTL_VBUS
) != warn
) {
473 warn
= devctl
& MUSB_DEVCTL_VBUS
;
474 dev_dbg(musb
->controller
, "VBUS %d\n",
475 warn
>> MUSB_DEVCTL_VBUS_SHIFT
);
479 } while (maxdelay
> 0);
481 /* in OTG mode, another host might be connected */
482 if (devctl
& MUSB_DEVCTL_VBUS
)
483 dev_dbg(musb
->controller
, "VBUS off timeout (devctl %02x)\n", devctl
);
488 usb_put_phy(musb
->xceiv
);
493 static const struct musb_platform_ops davinci_ops
= {
494 .quirks
= MUSB_DMA_CPPI
,
495 .init
= davinci_musb_init
,
496 .exit
= davinci_musb_exit
,
498 #ifdef CONFIG_USB_TI_CPPI_DMA
499 .dma_init
= cppi_dma_controller_create
,
500 .dma_exit
= cppi_dma_controller_destroy
,
502 .enable
= davinci_musb_enable
,
503 .disable
= davinci_musb_disable
,
505 .set_mode
= davinci_musb_set_mode
,
507 .set_vbus
= davinci_musb_set_vbus
,
510 static const struct platform_device_info davinci_dev_info
= {
512 .id
= PLATFORM_DEVID_AUTO
,
513 .dma_mask
= DMA_BIT_MASK(32),
516 static int davinci_probe(struct platform_device
*pdev
)
518 struct resource musb_resources
[3];
519 struct musb_hdrc_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
520 struct platform_device
*musb
;
521 struct davinci_glue
*glue
;
522 struct platform_device_info pinfo
;
527 glue
= devm_kzalloc(&pdev
->dev
, sizeof(*glue
), GFP_KERNEL
);
531 clk
= devm_clk_get(&pdev
->dev
, "usb");
533 dev_err(&pdev
->dev
, "failed to get clock\n");
538 ret
= clk_enable(clk
);
540 dev_err(&pdev
->dev
, "failed to enable clock\n");
544 glue
->dev
= &pdev
->dev
;
547 pdata
->platform_ops
= &davinci_ops
;
549 usb_phy_generic_register();
550 platform_set_drvdata(pdev
, glue
);
552 memset(musb_resources
, 0x00, sizeof(*musb_resources
) *
553 ARRAY_SIZE(musb_resources
));
555 musb_resources
[0].name
= pdev
->resource
[0].name
;
556 musb_resources
[0].start
= pdev
->resource
[0].start
;
557 musb_resources
[0].end
= pdev
->resource
[0].end
;
558 musb_resources
[0].flags
= pdev
->resource
[0].flags
;
560 musb_resources
[1].name
= pdev
->resource
[1].name
;
561 musb_resources
[1].start
= pdev
->resource
[1].start
;
562 musb_resources
[1].end
= pdev
->resource
[1].end
;
563 musb_resources
[1].flags
= pdev
->resource
[1].flags
;
566 * For DM6467 3 resources are passed. A placeholder for the 3rd
567 * resource is always there, so it's safe to always copy it...
569 musb_resources
[2].name
= pdev
->resource
[2].name
;
570 musb_resources
[2].start
= pdev
->resource
[2].start
;
571 musb_resources
[2].end
= pdev
->resource
[2].end
;
572 musb_resources
[2].flags
= pdev
->resource
[2].flags
;
574 pinfo
= davinci_dev_info
;
575 pinfo
.parent
= &pdev
->dev
;
576 pinfo
.res
= musb_resources
;
577 pinfo
.num_res
= ARRAY_SIZE(musb_resources
);
579 pinfo
.size_data
= sizeof(*pdata
);
581 glue
->musb
= musb
= platform_device_register_full(&pinfo
);
584 dev_err(&pdev
->dev
, "failed to register musb device: %d\n", ret
);
597 static int davinci_remove(struct platform_device
*pdev
)
599 struct davinci_glue
*glue
= platform_get_drvdata(pdev
);
601 platform_device_unregister(glue
->musb
);
602 usb_phy_generic_unregister();
603 clk_disable(glue
->clk
);
608 static struct platform_driver davinci_driver
= {
609 .probe
= davinci_probe
,
610 .remove
= davinci_remove
,
612 .name
= "musb-davinci",
616 MODULE_DESCRIPTION("DaVinci MUSB Glue Layer");
617 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
618 MODULE_LICENSE("GPL v2");
619 module_platform_driver(davinci_driver
);