1 // SPDX-License-Identifier: GPL-2.0
3 * TUSB6010 USB 2.0 OTG Dual Role controller
5 * Copyright (C) 2006 Nokia Corporation
6 * Tony Lindgren <tony@atomide.com>
9 * - Driver assumes that interface to external host (main CPU) is
10 * configured for NOR FLASH interface instead of VLYNQ serial
14 #include <linux/module.h>
15 #include <linux/kernel.h>
16 #include <linux/errno.h>
17 #include <linux/err.h>
18 #include <linux/prefetch.h>
19 #include <linux/usb.h>
20 #include <linux/irq.h>
22 #include <linux/device.h>
23 #include <linux/platform_device.h>
24 #include <linux/dma-mapping.h>
25 #include <linux/usb/usb_phy_generic.h>
27 #include "musb_core.h"
29 struct tusb6010_glue {
31 struct platform_device *musb;
32 struct platform_device *phy;
35 static void tusb_musb_set_vbus(struct musb *musb, int is_on);
37 #define TUSB_REV_MAJOR(reg_val) ((reg_val >> 4) & 0xf)
38 #define TUSB_REV_MINOR(reg_val) (reg_val & 0xf)
41 * Checks the revision. We need to use the DMA register as 3.0 does not
42 * have correct versions for TUSB_PRCM_REV or TUSB_INT_CTRL_REV.
44 static u8 tusb_get_revision(struct musb *musb)
46 void __iomem *tbase = musb->ctrl_base;
50 rev = musb_readl(tbase, TUSB_DMA_CTRL_REV) & 0xff;
51 if (TUSB_REV_MAJOR(rev) == 3) {
52 die_id = TUSB_DIDR1_HI_CHIP_REV(musb_readl(tbase,
54 if (die_id >= TUSB_DIDR1_HI_REV_31)
61 static void tusb_print_revision(struct musb *musb)
63 void __iomem *tbase = musb->ctrl_base;
66 rev = musb->tusb_revision;
68 pr_info("tusb: %s%i.%i %s%i.%i %s%i.%i %s%i.%i %s%i %s%i.%i\n",
70 TUSB_REV_MAJOR(musb_readl(tbase, TUSB_PRCM_REV)),
71 TUSB_REV_MINOR(musb_readl(tbase, TUSB_PRCM_REV)),
73 TUSB_REV_MAJOR(musb_readl(tbase, TUSB_INT_CTRL_REV)),
74 TUSB_REV_MINOR(musb_readl(tbase, TUSB_INT_CTRL_REV)),
76 TUSB_REV_MAJOR(musb_readl(tbase, TUSB_GPIO_REV)),
77 TUSB_REV_MINOR(musb_readl(tbase, TUSB_GPIO_REV)),
79 TUSB_REV_MAJOR(musb_readl(tbase, TUSB_DMA_CTRL_REV)),
80 TUSB_REV_MINOR(musb_readl(tbase, TUSB_DMA_CTRL_REV)),
82 TUSB_DIDR1_HI_CHIP_REV(musb_readl(tbase, TUSB_DIDR1_HI)),
84 TUSB_REV_MAJOR(rev), TUSB_REV_MINOR(rev));
87 #define WBUS_QUIRK_MASK (TUSB_PHY_OTG_CTRL_TESTM2 | TUSB_PHY_OTG_CTRL_TESTM1 \
88 | TUSB_PHY_OTG_CTRL_TESTM0)
91 * Workaround for spontaneous WBUS wake-up issue #2 for tusb3.0.
92 * Disables power detection in PHY for the duration of idle.
94 static void tusb_wbus_quirk(struct musb *musb, int enabled)
96 void __iomem *tbase = musb->ctrl_base;
97 static u32 phy_otg_ctrl, phy_otg_ena;
101 phy_otg_ctrl = musb_readl(tbase, TUSB_PHY_OTG_CTRL);
102 phy_otg_ena = musb_readl(tbase, TUSB_PHY_OTG_CTRL_ENABLE);
103 tmp = TUSB_PHY_OTG_CTRL_WRPROTECT
104 | phy_otg_ena | WBUS_QUIRK_MASK;
105 musb_writel(tbase, TUSB_PHY_OTG_CTRL, tmp);
106 tmp = phy_otg_ena & ~WBUS_QUIRK_MASK;
107 tmp |= TUSB_PHY_OTG_CTRL_WRPROTECT | TUSB_PHY_OTG_CTRL_TESTM2;
108 musb_writel(tbase, TUSB_PHY_OTG_CTRL_ENABLE, tmp);
109 dev_dbg(musb->controller, "Enabled tusb wbus quirk ctrl %08x ena %08x\n",
110 musb_readl(tbase, TUSB_PHY_OTG_CTRL),
111 musb_readl(tbase, TUSB_PHY_OTG_CTRL_ENABLE));
112 } else if (musb_readl(tbase, TUSB_PHY_OTG_CTRL_ENABLE)
113 & TUSB_PHY_OTG_CTRL_TESTM2) {
114 tmp = TUSB_PHY_OTG_CTRL_WRPROTECT | phy_otg_ctrl;
115 musb_writel(tbase, TUSB_PHY_OTG_CTRL, tmp);
116 tmp = TUSB_PHY_OTG_CTRL_WRPROTECT | phy_otg_ena;
117 musb_writel(tbase, TUSB_PHY_OTG_CTRL_ENABLE, tmp);
118 dev_dbg(musb->controller, "Disabled tusb wbus quirk ctrl %08x ena %08x\n",
119 musb_readl(tbase, TUSB_PHY_OTG_CTRL),
120 musb_readl(tbase, TUSB_PHY_OTG_CTRL_ENABLE));
126 static u32 tusb_fifo_offset(u8 epnum)
128 return 0x200 + (epnum * 0x20);
131 static u32 tusb_ep_offset(u8 epnum, u16 offset)
133 return 0x10 + offset;
136 /* TUSB mapping: "flat" plus ep0 special cases */
137 static void tusb_ep_select(void __iomem *mbase, u8 epnum)
139 musb_writeb(mbase, MUSB_INDEX, epnum);
143 * TUSB6010 doesn't allow 8-bit access; 16-bit access is the minimum.
145 static u8 tusb_readb(void __iomem *addr, u32 offset)
150 tmp = __raw_readw(addr + (offset & ~1));
159 static void tusb_writeb(void __iomem *addr, u32 offset, u8 data)
163 tmp = __raw_readw(addr + (offset & ~1));
165 tmp = (data << 8) | (tmp & 0xff);
167 tmp = (tmp & 0xff00) | data;
169 __raw_writew(tmp, addr + (offset & ~1));
173 * TUSB 6010 may use a parallel bus that doesn't support byte ops;
174 * so both loading and unloading FIFOs need explicit byte counts.
178 tusb_fifo_write_unaligned(void __iomem *fifo, const u8 *buf, u16 len)
184 for (i = 0; i < (len >> 2); i++) {
185 memcpy(&val, buf, 4);
186 musb_writel(fifo, 0, val);
192 /* Write the rest 1 - 3 bytes to FIFO */
194 memcpy(&val, buf, len);
195 musb_writel(fifo, 0, val);
199 static inline void tusb_fifo_read_unaligned(void __iomem *fifo,
206 for (i = 0; i < (len >> 2); i++) {
207 val = musb_readl(fifo, 0);
208 memcpy(buf, &val, 4);
214 /* Read the rest 1 - 3 bytes from FIFO */
215 val = musb_readl(fifo, 0);
216 memcpy(buf, &val, len);
220 static void tusb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *buf)
222 struct musb *musb = hw_ep->musb;
223 void __iomem *ep_conf = hw_ep->conf;
224 void __iomem *fifo = hw_ep->fifo;
225 u8 epnum = hw_ep->epnum;
229 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
230 'T', epnum, fifo, len, buf);
233 musb_writel(ep_conf, TUSB_EP_TX_OFFSET,
234 TUSB_EP_CONFIG_XFR_SIZE(len));
236 musb_writel(ep_conf, 0, TUSB_EP0_CONFIG_DIR_TX |
237 TUSB_EP0_CONFIG_XFR_SIZE(len));
239 if (likely((0x01 & (unsigned long) buf) == 0)) {
241 /* Best case is 32bit-aligned destination address */
242 if ((0x02 & (unsigned long) buf) == 0) {
244 iowrite32_rep(fifo, buf, len >> 2);
245 buf += (len & ~0x03);
253 /* Cannot use writesw, fifo is 32-bit */
254 for (i = 0; i < (len >> 2); i++) {
255 val = (u32)(*(u16 *)buf);
257 val |= (*(u16 *)buf) << 16;
259 musb_writel(fifo, 0, val);
267 tusb_fifo_write_unaligned(fifo, buf, len);
270 static void tusb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *buf)
272 struct musb *musb = hw_ep->musb;
273 void __iomem *ep_conf = hw_ep->conf;
274 void __iomem *fifo = hw_ep->fifo;
275 u8 epnum = hw_ep->epnum;
277 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
278 'R', epnum, fifo, len, buf);
281 musb_writel(ep_conf, TUSB_EP_RX_OFFSET,
282 TUSB_EP_CONFIG_XFR_SIZE(len));
284 musb_writel(ep_conf, 0, TUSB_EP0_CONFIG_XFR_SIZE(len));
286 if (likely((0x01 & (unsigned long) buf) == 0)) {
288 /* Best case is 32bit-aligned destination address */
289 if ((0x02 & (unsigned long) buf) == 0) {
291 ioread32_rep(fifo, buf, len >> 2);
292 buf += (len & ~0x03);
300 /* Cannot use readsw, fifo is 32-bit */
301 for (i = 0; i < (len >> 2); i++) {
302 val = musb_readl(fifo, 0);
303 *(u16 *)buf = (u16)(val & 0xffff);
305 *(u16 *)buf = (u16)(val >> 16);
314 tusb_fifo_read_unaligned(fifo, buf, len);
317 static struct musb *the_musb;
319 /* This is used by gadget drivers, and OTG transceiver logic, allowing
320 * at most mA current to be drawn from VBUS during a Default-B session
321 * (that is, while VBUS exceeds 4.4V). In Default-A (including pure host
322 * mode), or low power Default-B sessions, something else supplies power.
323 * Caller must take care of locking.
325 static int tusb_draw_power(struct usb_phy *x, unsigned mA)
327 struct musb *musb = the_musb;
328 void __iomem *tbase = musb->ctrl_base;
331 /* tps65030 seems to consume max 100mA, with maybe 60mA available
332 * (measured on one board) for things other than tps and tusb.
334 * Boards sharing the CPU clock with CLKIN will need to prevent
335 * certain idle sleep states while the USB link is active.
337 * REVISIT we could use VBUS to supply only _one_ of { 1.5V, 3.3V }.
338 * The actual current usage would be very board-specific. For now,
339 * it's simpler to just use an aggregate (also board-specific).
341 if (x->otg->default_a || mA < (musb->min_power << 1))
344 reg = musb_readl(tbase, TUSB_PRCM_MNGMT);
346 musb->is_bus_powered = 1;
347 reg |= TUSB_PRCM_MNGMT_15_SW_EN | TUSB_PRCM_MNGMT_33_SW_EN;
349 musb->is_bus_powered = 0;
350 reg &= ~(TUSB_PRCM_MNGMT_15_SW_EN | TUSB_PRCM_MNGMT_33_SW_EN);
352 musb_writel(tbase, TUSB_PRCM_MNGMT, reg);
354 dev_dbg(musb->controller, "draw max %d mA VBUS\n", mA);
358 /* workaround for issue 13: change clock during chip idle
359 * (to be fixed in rev3 silicon) ... symptoms include disconnect
360 * or looping suspend/resume cycles
362 static void tusb_set_clock_source(struct musb *musb, unsigned mode)
364 void __iomem *tbase = musb->ctrl_base;
367 reg = musb_readl(tbase, TUSB_PRCM_CONF);
368 reg &= ~TUSB_PRCM_CONF_SYS_CLKSEL(0x3);
370 /* 0 = refclk (clkin, XI)
371 * 1 = PHY 60 MHz (internal PLL)
376 reg |= TUSB_PRCM_CONF_SYS_CLKSEL(mode & 0x3);
378 musb_writel(tbase, TUSB_PRCM_CONF, reg);
380 /* FIXME tusb6010_platform_retime(mode == 0); */
384 * Idle TUSB6010 until next wake-up event; NOR access always wakes.
385 * Other code ensures that we idle unless we're connected _and_ the
386 * USB link is not suspended ... and tells us the relevant wakeup
387 * events. SW_EN for voltage is handled separately.
389 static void tusb_allow_idle(struct musb *musb, u32 wakeup_enables)
391 void __iomem *tbase = musb->ctrl_base;
394 if ((wakeup_enables & TUSB_PRCM_WBUS)
395 && (musb->tusb_revision == TUSB_REV_30))
396 tusb_wbus_quirk(musb, 1);
398 tusb_set_clock_source(musb, 0);
400 wakeup_enables |= TUSB_PRCM_WNORCS;
401 musb_writel(tbase, TUSB_PRCM_WAKEUP_MASK, ~wakeup_enables);
403 /* REVISIT writeup of WID implies that if WID set and ID is grounded,
404 * TUSB_PHY_OTG_CTRL.TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP must be cleared.
405 * Presumably that's mostly to save power, hence WID is immaterial ...
408 reg = musb_readl(tbase, TUSB_PRCM_MNGMT);
409 /* issue 4: when driving vbus, use hipower (vbus_det) comparator */
410 if (is_host_active(musb)) {
411 reg |= TUSB_PRCM_MNGMT_OTG_VBUS_DET_EN;
412 reg &= ~TUSB_PRCM_MNGMT_OTG_SESS_END_EN;
414 reg |= TUSB_PRCM_MNGMT_OTG_SESS_END_EN;
415 reg &= ~TUSB_PRCM_MNGMT_OTG_VBUS_DET_EN;
417 reg |= TUSB_PRCM_MNGMT_PM_IDLE | TUSB_PRCM_MNGMT_DEV_IDLE;
418 musb_writel(tbase, TUSB_PRCM_MNGMT, reg);
420 dev_dbg(musb->controller, "idle, wake on %02x\n", wakeup_enables);
424 * Updates cable VBUS status. Caller must take care of locking.
426 static int tusb_musb_vbus_status(struct musb *musb)
428 void __iomem *tbase = musb->ctrl_base;
429 u32 otg_stat, prcm_mngmt;
432 otg_stat = musb_readl(tbase, TUSB_DEV_OTG_STAT);
433 prcm_mngmt = musb_readl(tbase, TUSB_PRCM_MNGMT);
435 /* Temporarily enable VBUS detection if it was disabled for
436 * suspend mode. Unless it's enabled otg_stat and devctl will
437 * not show correct VBUS state.
439 if (!(prcm_mngmt & TUSB_PRCM_MNGMT_OTG_VBUS_DET_EN)) {
440 u32 tmp = prcm_mngmt;
441 tmp |= TUSB_PRCM_MNGMT_OTG_VBUS_DET_EN;
442 musb_writel(tbase, TUSB_PRCM_MNGMT, tmp);
443 otg_stat = musb_readl(tbase, TUSB_DEV_OTG_STAT);
444 musb_writel(tbase, TUSB_PRCM_MNGMT, prcm_mngmt);
447 if (otg_stat & TUSB_DEV_OTG_STAT_VBUS_VALID)
453 static void musb_do_idle(struct timer_list *t)
455 struct musb *musb = from_timer(musb, t, dev_timer);
458 spin_lock_irqsave(&musb->lock, flags);
460 switch (musb->xceiv->otg->state) {
461 case OTG_STATE_A_WAIT_BCON:
462 if ((musb->a_wait_bcon != 0)
463 && (musb->idle_timeout == 0
464 || time_after(jiffies, musb->idle_timeout))) {
465 dev_dbg(musb->controller, "Nothing connected %s, turning off VBUS\n",
466 usb_otg_state_string(musb->xceiv->otg->state));
469 case OTG_STATE_A_IDLE:
470 tusb_musb_set_vbus(musb, 0);
476 if (!musb->is_active) {
479 /* wait until hub_wq handles port change status */
480 if (is_host_active(musb) && (musb->port1_status >> 16))
483 if (!musb->gadget_driver) {
486 wakeups = TUSB_PRCM_WHOSTDISCON
489 wakeups |= TUSB_PRCM_WID;
491 tusb_allow_idle(musb, wakeups);
494 spin_unlock_irqrestore(&musb->lock, flags);
498 * Maybe put TUSB6010 into idle mode mode depending on USB link status,
499 * like "disconnected" or "suspended". We'll be woken out of it by
500 * connect, resume, or disconnect.
502 * Needs to be called as the last function everywhere where there is
503 * register access to TUSB6010 because of NOR flash wake-up.
504 * Caller should own controller spinlock.
506 * Delay because peripheral enables D+ pullup 3msec after SE0, and
507 * we don't want to treat that full speed J as a wakeup event.
508 * ... peripherals must draw only suspend current after 10 msec.
510 static void tusb_musb_try_idle(struct musb *musb, unsigned long timeout)
512 unsigned long default_timeout = jiffies + msecs_to_jiffies(3);
513 static unsigned long last_timer;
516 timeout = default_timeout;
518 /* Never idle if active, or when VBUS timeout is not set as host */
519 if (musb->is_active || ((musb->a_wait_bcon == 0)
520 && (musb->xceiv->otg->state == OTG_STATE_A_WAIT_BCON))) {
521 dev_dbg(musb->controller, "%s active, deleting timer\n",
522 usb_otg_state_string(musb->xceiv->otg->state));
523 del_timer(&musb->dev_timer);
524 last_timer = jiffies;
528 if (time_after(last_timer, timeout)) {
529 if (!timer_pending(&musb->dev_timer))
530 last_timer = timeout;
532 dev_dbg(musb->controller, "Longer idle timer already pending, ignoring\n");
536 last_timer = timeout;
538 dev_dbg(musb->controller, "%s inactive, for idle timer for %lu ms\n",
539 usb_otg_state_string(musb->xceiv->otg->state),
540 (unsigned long)jiffies_to_msecs(timeout - jiffies));
541 mod_timer(&musb->dev_timer, timeout);
544 /* ticks of 60 MHz clock */
545 #define DEVCLOCK 60000000
546 #define OTG_TIMER_MS(msecs) ((msecs) \
547 ? (TUSB_DEV_OTG_TIMER_VAL((DEVCLOCK/1000)*(msecs)) \
548 | TUSB_DEV_OTG_TIMER_ENABLE) \
551 static void tusb_musb_set_vbus(struct musb *musb, int is_on)
553 void __iomem *tbase = musb->ctrl_base;
554 u32 conf, prcm, timer;
556 struct usb_otg *otg = musb->xceiv->otg;
558 /* HDRC controls CPEN, but beware current surges during device
559 * connect. They can trigger transient overcurrent conditions
560 * that must be ignored.
563 prcm = musb_readl(tbase, TUSB_PRCM_MNGMT);
564 conf = musb_readl(tbase, TUSB_DEV_CONF);
565 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
568 timer = OTG_TIMER_MS(OTG_TIME_A_WAIT_VRISE);
570 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VRISE;
571 devctl |= MUSB_DEVCTL_SESSION;
573 conf |= TUSB_DEV_CONF_USB_HOST_MODE;
580 /* If ID pin is grounded, we want to be a_idle */
581 otg_stat = musb_readl(tbase, TUSB_DEV_OTG_STAT);
582 if (!(otg_stat & TUSB_DEV_OTG_STAT_ID_STATUS)) {
583 switch (musb->xceiv->otg->state) {
584 case OTG_STATE_A_WAIT_VRISE:
585 case OTG_STATE_A_WAIT_BCON:
586 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VFALL;
588 case OTG_STATE_A_WAIT_VFALL:
589 musb->xceiv->otg->state = OTG_STATE_A_IDLE;
592 musb->xceiv->otg->state = OTG_STATE_A_IDLE;
600 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
604 devctl &= ~MUSB_DEVCTL_SESSION;
605 conf &= ~TUSB_DEV_CONF_USB_HOST_MODE;
607 prcm &= ~(TUSB_PRCM_MNGMT_15_SW_EN | TUSB_PRCM_MNGMT_33_SW_EN);
609 musb_writel(tbase, TUSB_PRCM_MNGMT, prcm);
610 musb_writel(tbase, TUSB_DEV_OTG_TIMER, timer);
611 musb_writel(tbase, TUSB_DEV_CONF, conf);
612 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
614 dev_dbg(musb->controller, "VBUS %s, devctl %02x otg %3x conf %08x prcm %08x\n",
615 usb_otg_state_string(musb->xceiv->otg->state),
616 musb_readb(musb->mregs, MUSB_DEVCTL),
617 musb_readl(tbase, TUSB_DEV_OTG_STAT),
622 * Sets the mode to OTG, peripheral or host by changing the ID detection.
623 * Caller must take care of locking.
625 * Note that if a mini-A cable is plugged in the ID line will stay down as
626 * the weak ID pull-up is not able to pull the ID up.
628 static int tusb_musb_set_mode(struct musb *musb, u8 musb_mode)
630 void __iomem *tbase = musb->ctrl_base;
631 u32 otg_stat, phy_otg_ctrl, phy_otg_ena, dev_conf;
633 otg_stat = musb_readl(tbase, TUSB_DEV_OTG_STAT);
634 phy_otg_ctrl = musb_readl(tbase, TUSB_PHY_OTG_CTRL);
635 phy_otg_ena = musb_readl(tbase, TUSB_PHY_OTG_CTRL_ENABLE);
636 dev_conf = musb_readl(tbase, TUSB_DEV_CONF);
640 case MUSB_HOST: /* Disable PHY ID detect, ground ID */
641 phy_otg_ctrl &= ~TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
642 phy_otg_ena |= TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
643 dev_conf |= TUSB_DEV_CONF_ID_SEL;
644 dev_conf &= ~TUSB_DEV_CONF_SOFT_ID;
646 case MUSB_PERIPHERAL: /* Disable PHY ID detect, keep ID pull-up on */
647 phy_otg_ctrl |= TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
648 phy_otg_ena |= TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
649 dev_conf |= (TUSB_DEV_CONF_ID_SEL | TUSB_DEV_CONF_SOFT_ID);
651 case MUSB_OTG: /* Use PHY ID detection */
652 phy_otg_ctrl |= TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
653 phy_otg_ena |= TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
654 dev_conf &= ~(TUSB_DEV_CONF_ID_SEL | TUSB_DEV_CONF_SOFT_ID);
658 dev_dbg(musb->controller, "Trying to set mode %i\n", musb_mode);
662 musb_writel(tbase, TUSB_PHY_OTG_CTRL,
663 TUSB_PHY_OTG_CTRL_WRPROTECT | phy_otg_ctrl);
664 musb_writel(tbase, TUSB_PHY_OTG_CTRL_ENABLE,
665 TUSB_PHY_OTG_CTRL_WRPROTECT | phy_otg_ena);
666 musb_writel(tbase, TUSB_DEV_CONF, dev_conf);
668 otg_stat = musb_readl(tbase, TUSB_DEV_OTG_STAT);
669 if ((musb_mode == MUSB_PERIPHERAL) &&
670 !(otg_stat & TUSB_DEV_OTG_STAT_ID_STATUS))
671 INFO("Cannot be peripheral with mini-A cable "
672 "otg_stat: %08x\n", otg_stat);
677 static inline unsigned long
678 tusb_otg_ints(struct musb *musb, u32 int_src, void __iomem *tbase)
680 u32 otg_stat = musb_readl(tbase, TUSB_DEV_OTG_STAT);
681 unsigned long idle_timeout = 0;
682 struct usb_otg *otg = musb->xceiv->otg;
685 if ((int_src & TUSB_INT_SRC_ID_STATUS_CHNG)) {
688 default_a = !(otg_stat & TUSB_DEV_OTG_STAT_ID_STATUS);
689 dev_dbg(musb->controller, "Default-%c\n", default_a ? 'A' : 'B');
690 otg->default_a = default_a;
691 tusb_musb_set_vbus(musb, default_a);
693 /* Don't allow idling immediately */
695 idle_timeout = jiffies + (HZ * 3);
698 /* VBUS state change */
699 if (int_src & TUSB_INT_SRC_VBUS_SENSE_CHNG) {
701 /* B-dev state machine: no vbus ~= disconnect */
702 if (!otg->default_a) {
703 /* ? musb_root_disconnect(musb); */
704 musb->port1_status &=
705 ~(USB_PORT_STAT_CONNECTION
706 | USB_PORT_STAT_ENABLE
707 | USB_PORT_STAT_LOW_SPEED
708 | USB_PORT_STAT_HIGH_SPEED
712 if (otg_stat & TUSB_DEV_OTG_STAT_SESS_END) {
713 dev_dbg(musb->controller, "Forcing disconnect (no interrupt)\n");
714 if (musb->xceiv->otg->state != OTG_STATE_B_IDLE) {
715 /* INTR_DISCONNECT can hide... */
716 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
717 musb->int_usb |= MUSB_INTR_DISCONNECT;
721 dev_dbg(musb->controller, "vbus change, %s, otg %03x\n",
722 usb_otg_state_string(musb->xceiv->otg->state), otg_stat);
723 idle_timeout = jiffies + (1 * HZ);
724 schedule_delayed_work(&musb->irq_work, 0);
726 } else /* A-dev state machine */ {
727 dev_dbg(musb->controller, "vbus change, %s, otg %03x\n",
728 usb_otg_state_string(musb->xceiv->otg->state), otg_stat);
730 switch (musb->xceiv->otg->state) {
731 case OTG_STATE_A_IDLE:
732 dev_dbg(musb->controller, "Got SRP, turning on VBUS\n");
733 musb_platform_set_vbus(musb, 1);
735 /* CONNECT can wake if a_wait_bcon is set */
736 if (musb->a_wait_bcon != 0)
742 * OPT FS A TD.4.6 needs few seconds for
745 idle_timeout = jiffies + (2 * HZ);
748 case OTG_STATE_A_WAIT_VRISE:
749 /* ignore; A-session-valid < VBUS_VALID/2,
750 * we monitor this with the timer
753 case OTG_STATE_A_WAIT_VFALL:
754 /* REVISIT this irq triggers during short
755 * spikes caused by enumeration ...
757 if (musb->vbuserr_retry) {
758 musb->vbuserr_retry--;
759 tusb_musb_set_vbus(musb, 1);
762 = VBUSERR_RETRY_COUNT;
763 tusb_musb_set_vbus(musb, 0);
772 /* OTG timer expiration */
773 if (int_src & TUSB_INT_SRC_OTG_TIMEOUT) {
776 dev_dbg(musb->controller, "%s timer, %03x\n",
777 usb_otg_state_string(musb->xceiv->otg->state), otg_stat);
779 switch (musb->xceiv->otg->state) {
780 case OTG_STATE_A_WAIT_VRISE:
781 /* VBUS has probably been valid for a while now,
782 * but may well have bounced out of range a bit
784 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
785 if (otg_stat & TUSB_DEV_OTG_STAT_VBUS_VALID) {
786 if ((devctl & MUSB_DEVCTL_VBUS)
787 != MUSB_DEVCTL_VBUS) {
788 dev_dbg(musb->controller, "devctl %02x\n", devctl);
791 musb->xceiv->otg->state = OTG_STATE_A_WAIT_BCON;
793 idle_timeout = jiffies
794 + msecs_to_jiffies(musb->a_wait_bcon);
796 /* REVISIT report overcurrent to hub? */
797 ERR("vbus too slow, devctl %02x\n", devctl);
798 tusb_musb_set_vbus(musb, 0);
801 case OTG_STATE_A_WAIT_BCON:
802 if (musb->a_wait_bcon != 0)
803 idle_timeout = jiffies
804 + msecs_to_jiffies(musb->a_wait_bcon);
806 case OTG_STATE_A_SUSPEND:
808 case OTG_STATE_B_WAIT_ACON:
814 schedule_delayed_work(&musb->irq_work, 0);
819 static irqreturn_t tusb_musb_interrupt(int irq, void *__hci)
821 struct musb *musb = __hci;
822 void __iomem *tbase = musb->ctrl_base;
823 unsigned long flags, idle_timeout = 0;
824 u32 int_mask, int_src;
826 spin_lock_irqsave(&musb->lock, flags);
828 /* Mask all interrupts to allow using both edge and level GPIO irq */
829 int_mask = musb_readl(tbase, TUSB_INT_MASK);
830 musb_writel(tbase, TUSB_INT_MASK, ~TUSB_INT_MASK_RESERVED_BITS);
832 int_src = musb_readl(tbase, TUSB_INT_SRC) & ~TUSB_INT_SRC_RESERVED_BITS;
833 dev_dbg(musb->controller, "TUSB IRQ %08x\n", int_src);
835 musb->int_usb = (u8) int_src;
837 /* Acknowledge wake-up source interrupts */
838 if (int_src & TUSB_INT_SRC_DEV_WAKEUP) {
842 if (musb->tusb_revision == TUSB_REV_30)
843 tusb_wbus_quirk(musb, 0);
845 /* there are issues re-locking the PLL on wakeup ... */
847 /* work around issue 8 */
848 for (i = 0xf7f7f7; i > 0xf7f7f7 - 1000; i--) {
849 musb_writel(tbase, TUSB_SCRATCH_PAD, 0);
850 musb_writel(tbase, TUSB_SCRATCH_PAD, i);
851 reg = musb_readl(tbase, TUSB_SCRATCH_PAD);
854 dev_dbg(musb->controller, "TUSB NOR not ready\n");
857 /* work around issue 13 (2nd half) */
858 tusb_set_clock_source(musb, 1);
860 reg = musb_readl(tbase, TUSB_PRCM_WAKEUP_SOURCE);
861 musb_writel(tbase, TUSB_PRCM_WAKEUP_CLEAR, reg);
862 if (reg & ~TUSB_PRCM_WNORCS) {
864 schedule_delayed_work(&musb->irq_work, 0);
866 dev_dbg(musb->controller, "wake %sactive %02x\n",
867 musb->is_active ? "" : "in", reg);
869 /* REVISIT host side TUSB_PRCM_WHOSTDISCON, TUSB_PRCM_WBUS */
872 if (int_src & TUSB_INT_SRC_USB_IP_CONN)
873 del_timer(&musb->dev_timer);
875 /* OTG state change reports (annoyingly) not issued by Mentor core */
876 if (int_src & (TUSB_INT_SRC_VBUS_SENSE_CHNG
877 | TUSB_INT_SRC_OTG_TIMEOUT
878 | TUSB_INT_SRC_ID_STATUS_CHNG))
879 idle_timeout = tusb_otg_ints(musb, int_src, tbase);
882 * Just clear the DMA interrupt if it comes as the completion for both
883 * TX and RX is handled by the DMA callback in tusb6010_omap
885 if ((int_src & TUSB_INT_SRC_TXRX_DMA_DONE)) {
886 u32 dma_src = musb_readl(tbase, TUSB_DMA_INT_SRC);
888 dev_dbg(musb->controller, "DMA IRQ %08x\n", dma_src);
889 musb_writel(tbase, TUSB_DMA_INT_CLEAR, dma_src);
892 /* EP interrupts. In OCP mode tusb6010 mirrors the MUSB interrupts */
893 if (int_src & (TUSB_INT_SRC_USB_IP_TX | TUSB_INT_SRC_USB_IP_RX)) {
894 u32 musb_src = musb_readl(tbase, TUSB_USBIP_INT_SRC);
896 musb_writel(tbase, TUSB_USBIP_INT_CLEAR, musb_src);
897 musb->int_rx = (((musb_src >> 16) & 0xffff) << 1);
898 musb->int_tx = (musb_src & 0xffff);
904 if (int_src & (TUSB_INT_SRC_USB_IP_TX | TUSB_INT_SRC_USB_IP_RX | 0xff))
905 musb_interrupt(musb);
907 /* Acknowledge TUSB interrupts. Clear only non-reserved bits */
908 musb_writel(tbase, TUSB_INT_SRC_CLEAR,
909 int_src & ~TUSB_INT_MASK_RESERVED_BITS);
911 tusb_musb_try_idle(musb, idle_timeout);
913 musb_writel(tbase, TUSB_INT_MASK, int_mask);
914 spin_unlock_irqrestore(&musb->lock, flags);
922 * Enables TUSB6010. Caller must take care of locking.
924 * - Check what is unnecessary in MGC_HdrcStart()
926 static void tusb_musb_enable(struct musb *musb)
928 void __iomem *tbase = musb->ctrl_base;
930 /* Setup TUSB6010 main interrupt mask. Enable all interrupts except SOF.
931 * REVISIT: Enable and deal with TUSB_INT_SRC_USB_IP_SOF */
932 musb_writel(tbase, TUSB_INT_MASK, TUSB_INT_SRC_USB_IP_SOF);
934 /* Setup TUSB interrupt, disable DMA and GPIO interrupts */
935 musb_writel(tbase, TUSB_USBIP_INT_MASK, 0);
936 musb_writel(tbase, TUSB_DMA_INT_MASK, 0x7fffffff);
937 musb_writel(tbase, TUSB_GPIO_INT_MASK, 0x1ff);
939 /* Clear all subsystem interrups */
940 musb_writel(tbase, TUSB_USBIP_INT_CLEAR, 0x7fffffff);
941 musb_writel(tbase, TUSB_DMA_INT_CLEAR, 0x7fffffff);
942 musb_writel(tbase, TUSB_GPIO_INT_CLEAR, 0x1ff);
944 /* Acknowledge pending interrupt(s) */
945 musb_writel(tbase, TUSB_INT_SRC_CLEAR, ~TUSB_INT_MASK_RESERVED_BITS);
947 /* Only 0 clock cycles for minimum interrupt de-assertion time and
948 * interrupt polarity active low seems to work reliably here */
949 musb_writel(tbase, TUSB_INT_CTRL_CONF,
950 TUSB_INT_CTRL_CONF_INT_RELCYC(0));
952 irq_set_irq_type(musb->nIrq, IRQ_TYPE_LEVEL_LOW);
954 /* maybe force into the Default-A OTG state machine */
955 if (!(musb_readl(tbase, TUSB_DEV_OTG_STAT)
956 & TUSB_DEV_OTG_STAT_ID_STATUS))
957 musb_writel(tbase, TUSB_INT_SRC_SET,
958 TUSB_INT_SRC_ID_STATUS_CHNG);
960 if (is_dma_capable() && dma_off)
961 printk(KERN_WARNING "%s %s: dma not reactivated\n",
968 * Disables TUSB6010. Caller must take care of locking.
970 static void tusb_musb_disable(struct musb *musb)
972 void __iomem *tbase = musb->ctrl_base;
974 /* FIXME stop DMA, IRQs, timers, ... */
976 /* disable all IRQs */
977 musb_writel(tbase, TUSB_INT_MASK, ~TUSB_INT_MASK_RESERVED_BITS);
978 musb_writel(tbase, TUSB_USBIP_INT_MASK, 0x7fffffff);
979 musb_writel(tbase, TUSB_DMA_INT_MASK, 0x7fffffff);
980 musb_writel(tbase, TUSB_GPIO_INT_MASK, 0x1ff);
982 del_timer(&musb->dev_timer);
984 if (is_dma_capable() && !dma_off) {
985 printk(KERN_WARNING "%s %s: dma still active\n",
992 * Sets up TUSB6010 CPU interface specific signals and registers
993 * Note: Settings optimized for OMAP24xx
995 static void tusb_setup_cpu_interface(struct musb *musb)
997 void __iomem *tbase = musb->ctrl_base;
1000 * Disable GPIO[5:0] pullups (used as output DMA requests)
1001 * Don't disable GPIO[7:6] as they are needed for wake-up.
1003 musb_writel(tbase, TUSB_PULLUP_1_CTRL, 0x0000003F);
1005 /* Disable all pullups on NOR IF, DMAREQ0 and DMAREQ1 */
1006 musb_writel(tbase, TUSB_PULLUP_2_CTRL, 0x01FFFFFF);
1008 /* Turn GPIO[5:0] to DMAREQ[5:0] signals */
1009 musb_writel(tbase, TUSB_GPIO_CONF, TUSB_GPIO_CONF_DMAREQ(0x3f));
1011 /* Burst size 16x16 bits, all six DMA requests enabled, DMA request
1012 * de-assertion time 2 system clocks p 62 */
1013 musb_writel(tbase, TUSB_DMA_REQ_CONF,
1014 TUSB_DMA_REQ_CONF_BURST_SIZE(2) |
1015 TUSB_DMA_REQ_CONF_DMA_REQ_EN(0x3f) |
1016 TUSB_DMA_REQ_CONF_DMA_REQ_ASSER(2));
1018 /* Set 0 wait count for synchronous burst access */
1019 musb_writel(tbase, TUSB_WAIT_COUNT, 1);
1022 static int tusb_musb_start(struct musb *musb)
1024 void __iomem *tbase = musb->ctrl_base;
1026 unsigned long flags;
1029 if (musb->board_set_power)
1030 ret = musb->board_set_power(1);
1032 printk(KERN_ERR "tusb: Cannot enable TUSB6010\n");
1036 spin_lock_irqsave(&musb->lock, flags);
1038 if (musb_readl(tbase, TUSB_PROD_TEST_RESET) !=
1039 TUSB_PROD_TEST_RESET_VAL) {
1040 printk(KERN_ERR "tusb: Unable to detect TUSB6010\n");
1044 musb->tusb_revision = tusb_get_revision(musb);
1045 tusb_print_revision(musb);
1046 if (musb->tusb_revision < 2) {
1047 printk(KERN_ERR "tusb: Unsupported TUSB6010 revision %i\n",
1048 musb->tusb_revision);
1052 /* The uint bit for "USB non-PDR interrupt enable" has to be 1 when
1053 * NOR FLASH interface is used */
1054 musb_writel(tbase, TUSB_VLYNQ_CTRL, 8);
1056 /* Select PHY free running 60MHz as a system clock */
1057 tusb_set_clock_source(musb, 1);
1059 /* VBus valid timer 1us, disable DFT/Debug and VLYNQ clocks for
1060 * power saving, enable VBus detect and session end comparators,
1061 * enable IDpullup, enable VBus charging */
1062 musb_writel(tbase, TUSB_PRCM_MNGMT,
1063 TUSB_PRCM_MNGMT_VBUS_VALID_TIMER(0xa) |
1064 TUSB_PRCM_MNGMT_VBUS_VALID_FLT_EN |
1065 TUSB_PRCM_MNGMT_OTG_SESS_END_EN |
1066 TUSB_PRCM_MNGMT_OTG_VBUS_DET_EN |
1067 TUSB_PRCM_MNGMT_OTG_ID_PULLUP);
1068 tusb_setup_cpu_interface(musb);
1070 /* simplify: always sense/pullup ID pins, as if in OTG mode */
1071 reg = musb_readl(tbase, TUSB_PHY_OTG_CTRL_ENABLE);
1072 reg |= TUSB_PHY_OTG_CTRL_WRPROTECT | TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
1073 musb_writel(tbase, TUSB_PHY_OTG_CTRL_ENABLE, reg);
1075 reg = musb_readl(tbase, TUSB_PHY_OTG_CTRL);
1076 reg |= TUSB_PHY_OTG_CTRL_WRPROTECT | TUSB_PHY_OTG_CTRL_OTG_ID_PULLUP;
1077 musb_writel(tbase, TUSB_PHY_OTG_CTRL, reg);
1079 spin_unlock_irqrestore(&musb->lock, flags);
1084 spin_unlock_irqrestore(&musb->lock, flags);
1086 if (musb->board_set_power)
1087 musb->board_set_power(0);
1092 static int tusb_musb_init(struct musb *musb)
1094 struct platform_device *pdev;
1095 struct resource *mem;
1096 void __iomem *sync = NULL;
1099 musb->xceiv = usb_get_phy(USB_PHY_TYPE_USB2);
1100 if (IS_ERR_OR_NULL(musb->xceiv))
1101 return -EPROBE_DEFER;
1103 pdev = to_platform_device(musb->controller);
1105 /* dma address for async dma */
1106 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1107 musb->async = mem->start;
1109 /* dma address for sync dma */
1110 mem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
1112 pr_debug("no sync dma resource?\n");
1116 musb->sync = mem->start;
1118 sync = ioremap(mem->start, resource_size(mem));
1120 pr_debug("ioremap for sync failed\n");
1124 musb->sync_va = sync;
1126 /* Offsets from base: VLYNQ at 0x000, MUSB regs at 0x400,
1127 * FIFOs at 0x600, TUSB at 0x800
1129 musb->mregs += TUSB_BASE_OFFSET;
1131 ret = tusb_musb_start(musb);
1133 printk(KERN_ERR "Could not start tusb6010 (%d)\n",
1137 musb->isr = tusb_musb_interrupt;
1139 musb->xceiv->set_power = tusb_draw_power;
1142 timer_setup(&musb->dev_timer, musb_do_idle, 0);
1149 usb_put_phy(musb->xceiv);
1154 static int tusb_musb_exit(struct musb *musb)
1156 del_timer_sync(&musb->dev_timer);
1159 if (musb->board_set_power)
1160 musb->board_set_power(0);
1162 iounmap(musb->sync_va);
1164 usb_put_phy(musb->xceiv);
1168 static const struct musb_platform_ops tusb_ops = {
1169 .quirks = MUSB_DMA_TUSB_OMAP | MUSB_IN_TUSB |
1170 MUSB_G_NO_SKB_RESERVE,
1171 .init = tusb_musb_init,
1172 .exit = tusb_musb_exit,
1174 .ep_offset = tusb_ep_offset,
1175 .ep_select = tusb_ep_select,
1176 .fifo_offset = tusb_fifo_offset,
1177 .readb = tusb_readb,
1178 .writeb = tusb_writeb,
1179 .read_fifo = tusb_read_fifo,
1180 .write_fifo = tusb_write_fifo,
1181 #ifdef CONFIG_USB_TUSB_OMAP_DMA
1182 .dma_init = tusb_dma_controller_create,
1183 .dma_exit = tusb_dma_controller_destroy,
1185 .enable = tusb_musb_enable,
1186 .disable = tusb_musb_disable,
1188 .set_mode = tusb_musb_set_mode,
1189 .try_idle = tusb_musb_try_idle,
1191 .vbus_status = tusb_musb_vbus_status,
1192 .set_vbus = tusb_musb_set_vbus,
1195 static const struct platform_device_info tusb_dev_info = {
1196 .name = "musb-hdrc",
1197 .id = PLATFORM_DEVID_AUTO,
1198 .dma_mask = DMA_BIT_MASK(32),
1201 static int tusb_probe(struct platform_device *pdev)
1203 struct resource musb_resources[3];
1204 struct musb_hdrc_platform_data *pdata = dev_get_platdata(&pdev->dev);
1205 struct platform_device *musb;
1206 struct tusb6010_glue *glue;
1207 struct platform_device_info pinfo;
1210 glue = devm_kzalloc(&pdev->dev, sizeof(*glue), GFP_KERNEL);
1214 glue->dev = &pdev->dev;
1216 pdata->platform_ops = &tusb_ops;
1218 usb_phy_generic_register();
1219 platform_set_drvdata(pdev, glue);
1221 memset(musb_resources, 0x00, sizeof(*musb_resources) *
1222 ARRAY_SIZE(musb_resources));
1224 musb_resources[0].name = pdev->resource[0].name;
1225 musb_resources[0].start = pdev->resource[0].start;
1226 musb_resources[0].end = pdev->resource[0].end;
1227 musb_resources[0].flags = pdev->resource[0].flags;
1229 musb_resources[1].name = pdev->resource[1].name;
1230 musb_resources[1].start = pdev->resource[1].start;
1231 musb_resources[1].end = pdev->resource[1].end;
1232 musb_resources[1].flags = pdev->resource[1].flags;
1234 musb_resources[2].name = pdev->resource[2].name;
1235 musb_resources[2].start = pdev->resource[2].start;
1236 musb_resources[2].end = pdev->resource[2].end;
1237 musb_resources[2].flags = pdev->resource[2].flags;
1239 pinfo = tusb_dev_info;
1240 pinfo.parent = &pdev->dev;
1241 pinfo.res = musb_resources;
1242 pinfo.num_res = ARRAY_SIZE(musb_resources);
1244 pinfo.size_data = sizeof(*pdata);
1246 glue->musb = musb = platform_device_register_full(&pinfo);
1248 ret = PTR_ERR(musb);
1249 dev_err(&pdev->dev, "failed to register musb device: %d\n", ret);
1256 static int tusb_remove(struct platform_device *pdev)
1258 struct tusb6010_glue *glue = platform_get_drvdata(pdev);
1260 platform_device_unregister(glue->musb);
1261 usb_phy_generic_unregister(glue->phy);
1266 static struct platform_driver tusb_driver = {
1267 .probe = tusb_probe,
1268 .remove = tusb_remove,
1270 .name = "musb-tusb",
1274 MODULE_DESCRIPTION("TUSB6010 MUSB Glue Layer");
1275 MODULE_AUTHOR("Felipe Balbi <balbi@ti.com>");
1276 MODULE_LICENSE("GPL v2");
1277 module_platform_driver(tusb_driver);