2 * MUSB OTG driver core code
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
25 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Inventra (Multipoint) Dual-Role Controller Driver for Linux.
38 * This consists of a Host Controller Driver (HCD) and a peripheral
39 * controller driver implementing the "Gadget" API; OTG support is
40 * in the works. These are normal Linux-USB controller drivers which
41 * use IRQs and have no dedicated thread.
43 * This version of the driver has only been used with products from
44 * Texas Instruments. Those products integrate the Inventra logic
45 * with other DMA, IRQ, and bus modules, as well as other logic that
46 * needs to be reflected in this driver.
49 * NOTE: the original Mentor code here was pretty much a collection
50 * of mechanisms that don't seem to have been fully integrated/working
51 * for *any* Linux kernel version. This version aims at Linux 2.6.now,
52 * Key open issues include:
54 * - Lack of host-side transaction scheduling, for all transfer types.
55 * The hardware doesn't do it; instead, software must.
57 * This is not an issue for OTG devices that don't support external
58 * hubs, but for more "normal" USB hosts it's a user issue that the
59 * "multipoint" support doesn't scale in the expected ways. That
60 * includes DaVinci EVM in a common non-OTG mode.
62 * * Control and bulk use dedicated endpoints, and there's as
63 * yet no mechanism to either (a) reclaim the hardware when
64 * peripherals are NAKing, which gets complicated with bulk
65 * endpoints, or (b) use more than a single bulk endpoint in
68 * RESULT: one device may be perceived as blocking another one.
70 * * Interrupt and isochronous will dynamically allocate endpoint
71 * hardware, but (a) there's no record keeping for bandwidth;
72 * (b) in the common case that few endpoints are available, there
73 * is no mechanism to reuse endpoints to talk to multiple devices.
75 * RESULT: At one extreme, bandwidth can be overcommitted in
76 * some hardware configurations, no faults will be reported.
77 * At the other extreme, the bandwidth capabilities which do
78 * exist tend to be severely undercommitted. You can't yet hook
79 * up both a keyboard and a mouse to an external USB hub.
83 * This gets many kinds of configuration information:
84 * - Kconfig for everything user-configurable
85 * - platform_device for addressing, irq, and platform_data
86 * - platform_data is mostly for board-specific information
87 * (plus recentrly, SOC or family details)
89 * Most of the conditional compilation will (someday) vanish.
92 #include <linux/module.h>
93 #include <linux/kernel.h>
94 #include <linux/sched.h>
95 #include <linux/slab.h>
96 #include <linux/list.h>
97 #include <linux/kobject.h>
98 #include <linux/prefetch.h>
99 #include <linux/platform_device.h>
100 #include <linux/io.h>
101 #include <linux/dma-mapping.h>
102 #include <linux/usb.h>
103 #include <linux/usb/of.h>
105 #include "musb_core.h"
106 #include "musb_trace.h"
108 #define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
111 #define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
112 #define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
114 #define MUSB_VERSION "6.0"
116 #define DRIVER_INFO DRIVER_DESC ", v" MUSB_VERSION
118 #define MUSB_DRIVER_NAME "musb-hdrc"
119 const char musb_driver_name[] = MUSB_DRIVER_NAME;
121 MODULE_DESCRIPTION(DRIVER_INFO);
122 MODULE_AUTHOR(DRIVER_AUTHOR);
123 MODULE_LICENSE("GPL");
124 MODULE_ALIAS("platform:" MUSB_DRIVER_NAME);
127 /*-------------------------------------------------------------------------*/
129 static inline struct musb *dev_to_musb(struct device *dev)
131 return dev_get_drvdata(dev);
134 enum musb_mode musb_get_mode(struct device *dev)
136 enum usb_dr_mode mode;
138 mode = usb_get_dr_mode(dev);
140 case USB_DR_MODE_HOST:
142 case USB_DR_MODE_PERIPHERAL:
143 return MUSB_PERIPHERAL;
144 case USB_DR_MODE_OTG:
145 case USB_DR_MODE_UNKNOWN:
150 EXPORT_SYMBOL_GPL(musb_get_mode);
152 /*-------------------------------------------------------------------------*/
154 #ifndef CONFIG_BLACKFIN
155 static int musb_ulpi_read(struct usb_phy *phy, u32 reg)
157 void __iomem *addr = phy->io_priv;
163 pm_runtime_get_sync(phy->io_dev);
165 /* Make sure the transceiver is not in low power mode */
166 power = musb_readb(addr, MUSB_POWER);
167 power &= ~MUSB_POWER_SUSPENDM;
168 musb_writeb(addr, MUSB_POWER, power);
170 /* REVISIT: musbhdrc_ulpi_an.pdf recommends setting the
171 * ULPICarKitControlDisableUTMI after clearing POWER_SUSPENDM.
174 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)reg);
175 musb_writeb(addr, MUSB_ULPI_REG_CONTROL,
176 MUSB_ULPI_REG_REQ | MUSB_ULPI_RDN_WR);
178 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
179 & MUSB_ULPI_REG_CMPLT)) {
187 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
188 r &= ~MUSB_ULPI_REG_CMPLT;
189 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
191 ret = musb_readb(addr, MUSB_ULPI_REG_DATA);
194 pm_runtime_put(phy->io_dev);
199 static int musb_ulpi_write(struct usb_phy *phy, u32 val, u32 reg)
201 void __iomem *addr = phy->io_priv;
207 pm_runtime_get_sync(phy->io_dev);
209 /* Make sure the transceiver is not in low power mode */
210 power = musb_readb(addr, MUSB_POWER);
211 power &= ~MUSB_POWER_SUSPENDM;
212 musb_writeb(addr, MUSB_POWER, power);
214 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)reg);
215 musb_writeb(addr, MUSB_ULPI_REG_DATA, (u8)val);
216 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, MUSB_ULPI_REG_REQ);
218 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
219 & MUSB_ULPI_REG_CMPLT)) {
227 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
228 r &= ~MUSB_ULPI_REG_CMPLT;
229 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
232 pm_runtime_put(phy->io_dev);
237 #define musb_ulpi_read NULL
238 #define musb_ulpi_write NULL
241 static struct usb_phy_io_ops musb_ulpi_access = {
242 .read = musb_ulpi_read,
243 .write = musb_ulpi_write,
246 /*-------------------------------------------------------------------------*/
248 static u32 musb_default_fifo_offset(u8 epnum)
250 return 0x20 + (epnum * 4);
253 /* "flat" mapping: each endpoint has its own i/o address */
254 static void musb_flat_ep_select(void __iomem *mbase, u8 epnum)
258 static u32 musb_flat_ep_offset(u8 epnum, u16 offset)
260 return 0x100 + (0x10 * epnum) + offset;
263 /* "indexed" mapping: INDEX register controls register bank select */
264 static void musb_indexed_ep_select(void __iomem *mbase, u8 epnum)
266 musb_writeb(mbase, MUSB_INDEX, epnum);
269 static u32 musb_indexed_ep_offset(u8 epnum, u16 offset)
271 return 0x10 + offset;
274 static u32 musb_default_busctl_offset(u8 epnum, u16 offset)
276 return 0x80 + (0x08 * epnum) + offset;
279 static u8 musb_default_readb(const void __iomem *addr, unsigned offset)
281 u8 data = __raw_readb(addr + offset);
283 trace_musb_readb(__builtin_return_address(0), addr, offset, data);
287 static void musb_default_writeb(void __iomem *addr, unsigned offset, u8 data)
289 trace_musb_writeb(__builtin_return_address(0), addr, offset, data);
290 __raw_writeb(data, addr + offset);
293 static u16 musb_default_readw(const void __iomem *addr, unsigned offset)
295 u16 data = __raw_readw(addr + offset);
297 trace_musb_readw(__builtin_return_address(0), addr, offset, data);
301 static void musb_default_writew(void __iomem *addr, unsigned offset, u16 data)
303 trace_musb_writew(__builtin_return_address(0), addr, offset, data);
304 __raw_writew(data, addr + offset);
307 static u32 musb_default_readl(const void __iomem *addr, unsigned offset)
309 u32 data = __raw_readl(addr + offset);
311 trace_musb_readl(__builtin_return_address(0), addr, offset, data);
315 static void musb_default_writel(void __iomem *addr, unsigned offset, u32 data)
317 trace_musb_writel(__builtin_return_address(0), addr, offset, data);
318 __raw_writel(data, addr + offset);
322 * Load an endpoint's FIFO
324 static void musb_default_write_fifo(struct musb_hw_ep *hw_ep, u16 len,
327 struct musb *musb = hw_ep->musb;
328 void __iomem *fifo = hw_ep->fifo;
330 if (unlikely(len == 0))
335 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
336 'T', hw_ep->epnum, fifo, len, src);
338 /* we can't assume unaligned reads work */
339 if (likely((0x01 & (unsigned long) src) == 0)) {
342 /* best case is 32bit-aligned source address */
343 if ((0x02 & (unsigned long) src) == 0) {
345 iowrite32_rep(fifo, src + index, len >> 2);
346 index += len & ~0x03;
349 __raw_writew(*(u16 *)&src[index], fifo);
354 iowrite16_rep(fifo, src + index, len >> 1);
355 index += len & ~0x01;
359 __raw_writeb(src[index], fifo);
362 iowrite8_rep(fifo, src, len);
367 * Unload an endpoint's FIFO
369 static void musb_default_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
371 struct musb *musb = hw_ep->musb;
372 void __iomem *fifo = hw_ep->fifo;
374 if (unlikely(len == 0))
377 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
378 'R', hw_ep->epnum, fifo, len, dst);
380 /* we can't assume unaligned writes work */
381 if (likely((0x01 & (unsigned long) dst) == 0)) {
384 /* best case is 32bit-aligned destination address */
385 if ((0x02 & (unsigned long) dst) == 0) {
387 ioread32_rep(fifo, dst, len >> 2);
391 *(u16 *)&dst[index] = __raw_readw(fifo);
396 ioread16_rep(fifo, dst, len >> 1);
401 dst[index] = __raw_readb(fifo);
404 ioread8_rep(fifo, dst, len);
409 * Old style IO functions
411 u8 (*musb_readb)(const void __iomem *addr, unsigned offset);
412 EXPORT_SYMBOL_GPL(musb_readb);
414 void (*musb_writeb)(void __iomem *addr, unsigned offset, u8 data);
415 EXPORT_SYMBOL_GPL(musb_writeb);
417 u16 (*musb_readw)(const void __iomem *addr, unsigned offset);
418 EXPORT_SYMBOL_GPL(musb_readw);
420 void (*musb_writew)(void __iomem *addr, unsigned offset, u16 data);
421 EXPORT_SYMBOL_GPL(musb_writew);
423 u32 (*musb_readl)(const void __iomem *addr, unsigned offset);
424 EXPORT_SYMBOL_GPL(musb_readl);
426 void (*musb_writel)(void __iomem *addr, unsigned offset, u32 data);
427 EXPORT_SYMBOL_GPL(musb_writel);
429 #ifndef CONFIG_MUSB_PIO_ONLY
430 struct dma_controller *
431 (*musb_dma_controller_create)(struct musb *musb, void __iomem *base);
432 EXPORT_SYMBOL(musb_dma_controller_create);
434 void (*musb_dma_controller_destroy)(struct dma_controller *c);
435 EXPORT_SYMBOL(musb_dma_controller_destroy);
439 * New style IO functions
441 void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
443 return hw_ep->musb->io.read_fifo(hw_ep, len, dst);
446 void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
448 return hw_ep->musb->io.write_fifo(hw_ep, len, src);
451 /*-------------------------------------------------------------------------*/
453 /* for high speed test mode; see USB 2.0 spec 7.1.20 */
454 static const u8 musb_test_packet[53] = {
455 /* implicit SYNC then DATA0 to start */
458 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
460 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
462 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
463 /* JJJJJJJKKKKKKK x8 */
464 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
466 0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
467 /* JKKKKKKK x10, JK */
468 0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
470 /* implicit CRC16 then EOP to end */
473 void musb_load_testpacket(struct musb *musb)
475 void __iomem *regs = musb->endpoints[0].regs;
477 musb_ep_select(musb->mregs, 0);
478 musb_write_fifo(musb->control_ep,
479 sizeof(musb_test_packet), musb_test_packet);
480 musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
483 /*-------------------------------------------------------------------------*/
486 * Handles OTG hnp timeouts, such as b_ase0_brst
488 static void musb_otg_timer_func(unsigned long data)
490 struct musb *musb = (struct musb *)data;
493 spin_lock_irqsave(&musb->lock, flags);
494 switch (musb->xceiv->otg->state) {
495 case OTG_STATE_B_WAIT_ACON:
497 "HNP: b_wait_acon timeout; back to b_peripheral");
498 musb_g_disconnect(musb);
499 musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
502 case OTG_STATE_A_SUSPEND:
503 case OTG_STATE_A_WAIT_BCON:
504 musb_dbg(musb, "HNP: %s timeout",
505 usb_otg_state_string(musb->xceiv->otg->state));
506 musb_platform_set_vbus(musb, 0);
507 musb->xceiv->otg->state = OTG_STATE_A_WAIT_VFALL;
510 musb_dbg(musb, "HNP: Unhandled mode %s",
511 usb_otg_state_string(musb->xceiv->otg->state));
513 spin_unlock_irqrestore(&musb->lock, flags);
517 * Stops the HNP transition. Caller must take care of locking.
519 void musb_hnp_stop(struct musb *musb)
521 struct usb_hcd *hcd = musb->hcd;
522 void __iomem *mbase = musb->mregs;
525 musb_dbg(musb, "HNP: stop from %s",
526 usb_otg_state_string(musb->xceiv->otg->state));
528 switch (musb->xceiv->otg->state) {
529 case OTG_STATE_A_PERIPHERAL:
530 musb_g_disconnect(musb);
531 musb_dbg(musb, "HNP: back to %s",
532 usb_otg_state_string(musb->xceiv->otg->state));
534 case OTG_STATE_B_HOST:
535 musb_dbg(musb, "HNP: Disabling HR");
537 hcd->self.is_b_host = 0;
538 musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
540 reg = musb_readb(mbase, MUSB_POWER);
541 reg |= MUSB_POWER_SUSPENDM;
542 musb_writeb(mbase, MUSB_POWER, reg);
543 /* REVISIT: Start SESSION_REQUEST here? */
546 musb_dbg(musb, "HNP: Stopping in unknown state %s",
547 usb_otg_state_string(musb->xceiv->otg->state));
551 * When returning to A state after HNP, avoid hub_port_rebounce(),
552 * which cause occasional OPT A "Did not receive reset after connect"
555 musb->port1_status &= ~(USB_PORT_STAT_C_CONNECTION << 16);
558 static void musb_recover_from_babble(struct musb *musb);
561 * Interrupt Service Routine to record USB "global" interrupts.
562 * Since these do not happen often and signify things of
563 * paramount importance, it seems OK to check them individually;
564 * the order of the tests is specified in the manual
566 * @param musb instance pointer
567 * @param int_usb register contents
572 static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
575 irqreturn_t handled = IRQ_NONE;
577 musb_dbg(musb, "<== DevCtl=%02x, int_usb=0x%x", devctl, int_usb);
579 /* in host mode, the peripheral may issue remote wakeup.
580 * in peripheral mode, the host may resume the link.
581 * spurious RESUME irqs happen too, paired with SUSPEND.
583 if (int_usb & MUSB_INTR_RESUME) {
584 handled = IRQ_HANDLED;
585 musb_dbg(musb, "RESUME (%s)",
586 usb_otg_state_string(musb->xceiv->otg->state));
588 if (devctl & MUSB_DEVCTL_HM) {
589 switch (musb->xceiv->otg->state) {
590 case OTG_STATE_A_SUSPEND:
592 musb->port1_status |=
593 (USB_PORT_STAT_C_SUSPEND << 16)
594 | MUSB_PORT_STAT_RESUME;
595 musb->rh_timer = jiffies
596 + msecs_to_jiffies(USB_RESUME_TIMEOUT);
597 musb->xceiv->otg->state = OTG_STATE_A_HOST;
599 musb_host_resume_root_hub(musb);
600 schedule_delayed_work(&musb->finish_resume_work,
601 msecs_to_jiffies(USB_RESUME_TIMEOUT));
603 case OTG_STATE_B_WAIT_ACON:
604 musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
609 WARNING("bogus %s RESUME (%s)\n",
611 usb_otg_state_string(musb->xceiv->otg->state));
614 switch (musb->xceiv->otg->state) {
615 case OTG_STATE_A_SUSPEND:
616 /* possibly DISCONNECT is upcoming */
617 musb->xceiv->otg->state = OTG_STATE_A_HOST;
618 musb_host_resume_root_hub(musb);
620 case OTG_STATE_B_WAIT_ACON:
621 case OTG_STATE_B_PERIPHERAL:
622 /* disconnect while suspended? we may
623 * not get a disconnect irq...
625 if ((devctl & MUSB_DEVCTL_VBUS)
626 != (3 << MUSB_DEVCTL_VBUS_SHIFT)
628 musb->int_usb |= MUSB_INTR_DISCONNECT;
629 musb->int_usb &= ~MUSB_INTR_SUSPEND;
634 case OTG_STATE_B_IDLE:
635 musb->int_usb &= ~MUSB_INTR_SUSPEND;
638 WARNING("bogus %s RESUME (%s)\n",
640 usb_otg_state_string(musb->xceiv->otg->state));
645 /* see manual for the order of the tests */
646 if (int_usb & MUSB_INTR_SESSREQ) {
647 void __iomem *mbase = musb->mregs;
649 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS
650 && (devctl & MUSB_DEVCTL_BDEVICE)) {
651 musb_dbg(musb, "SessReq while on B state");
655 musb_dbg(musb, "SESSION_REQUEST (%s)",
656 usb_otg_state_string(musb->xceiv->otg->state));
658 /* IRQ arrives from ID pin sense or (later, if VBUS power
659 * is removed) SRP. responses are time critical:
660 * - turn on VBUS (with silicon-specific mechanism)
661 * - go through A_WAIT_VRISE
662 * - ... to A_WAIT_BCON.
663 * a_wait_vrise_tmout triggers VBUS_ERROR transitions
665 musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
666 musb->ep0_stage = MUSB_EP0_START;
667 musb->xceiv->otg->state = OTG_STATE_A_IDLE;
669 musb_platform_set_vbus(musb, 1);
671 handled = IRQ_HANDLED;
674 if (int_usb & MUSB_INTR_VBUSERROR) {
677 /* During connection as an A-Device, we may see a short
678 * current spikes causing voltage drop, because of cable
679 * and peripheral capacitance combined with vbus draw.
680 * (So: less common with truly self-powered devices, where
681 * vbus doesn't act like a power supply.)
683 * Such spikes are short; usually less than ~500 usec, max
684 * of ~2 msec. That is, they're not sustained overcurrent
685 * errors, though they're reported using VBUSERROR irqs.
687 * Workarounds: (a) hardware: use self powered devices.
688 * (b) software: ignore non-repeated VBUS errors.
690 * REVISIT: do delays from lots of DEBUG_KERNEL checks
691 * make trouble here, keeping VBUS < 4.4V ?
693 switch (musb->xceiv->otg->state) {
694 case OTG_STATE_A_HOST:
695 /* recovery is dicey once we've gotten past the
696 * initial stages of enumeration, but if VBUS
697 * stayed ok at the other end of the link, and
698 * another reset is due (at least for high speed,
699 * to redo the chirp etc), it might work OK...
701 case OTG_STATE_A_WAIT_BCON:
702 case OTG_STATE_A_WAIT_VRISE:
703 if (musb->vbuserr_retry) {
704 void __iomem *mbase = musb->mregs;
706 musb->vbuserr_retry--;
708 devctl |= MUSB_DEVCTL_SESSION;
709 musb_writeb(mbase, MUSB_DEVCTL, devctl);
711 musb->port1_status |=
712 USB_PORT_STAT_OVERCURRENT
713 | (USB_PORT_STAT_C_OVERCURRENT << 16);
720 dev_printk(ignore ? KERN_DEBUG : KERN_ERR, musb->controller,
721 "VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
722 usb_otg_state_string(musb->xceiv->otg->state),
725 switch (devctl & MUSB_DEVCTL_VBUS) {
726 case 0 << MUSB_DEVCTL_VBUS_SHIFT:
727 s = "<SessEnd"; break;
728 case 1 << MUSB_DEVCTL_VBUS_SHIFT:
729 s = "<AValid"; break;
730 case 2 << MUSB_DEVCTL_VBUS_SHIFT:
731 s = "<VBusValid"; break;
732 /* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
736 VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
739 /* go through A_WAIT_VFALL then start a new session */
741 musb_platform_set_vbus(musb, 0);
742 handled = IRQ_HANDLED;
745 if (int_usb & MUSB_INTR_SUSPEND) {
746 musb_dbg(musb, "SUSPEND (%s) devctl %02x",
747 usb_otg_state_string(musb->xceiv->otg->state), devctl);
748 handled = IRQ_HANDLED;
750 switch (musb->xceiv->otg->state) {
751 case OTG_STATE_A_PERIPHERAL:
752 /* We also come here if the cable is removed, since
753 * this silicon doesn't report ID-no-longer-grounded.
755 * We depend on T(a_wait_bcon) to shut us down, and
756 * hope users don't do anything dicey during this
757 * undesired detour through A_WAIT_BCON.
760 musb_host_resume_root_hub(musb);
761 musb_root_disconnect(musb);
762 musb_platform_try_idle(musb, jiffies
763 + msecs_to_jiffies(musb->a_wait_bcon
764 ? : OTG_TIME_A_WAIT_BCON));
767 case OTG_STATE_B_IDLE:
768 if (!musb->is_active)
770 case OTG_STATE_B_PERIPHERAL:
771 musb_g_suspend(musb);
772 musb->is_active = musb->g.b_hnp_enable;
773 if (musb->is_active) {
774 musb->xceiv->otg->state = OTG_STATE_B_WAIT_ACON;
775 musb_dbg(musb, "HNP: Setting timer for b_ase0_brst");
776 mod_timer(&musb->otg_timer, jiffies
778 OTG_TIME_B_ASE0_BRST));
781 case OTG_STATE_A_WAIT_BCON:
782 if (musb->a_wait_bcon != 0)
783 musb_platform_try_idle(musb, jiffies
784 + msecs_to_jiffies(musb->a_wait_bcon));
786 case OTG_STATE_A_HOST:
787 musb->xceiv->otg->state = OTG_STATE_A_SUSPEND;
788 musb->is_active = musb->hcd->self.b_hnp_enable;
790 case OTG_STATE_B_HOST:
791 /* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
792 musb_dbg(musb, "REVISIT: SUSPEND as B_HOST");
795 /* "should not happen" */
801 if (int_usb & MUSB_INTR_CONNECT) {
802 struct usb_hcd *hcd = musb->hcd;
804 handled = IRQ_HANDLED;
807 musb->ep0_stage = MUSB_EP0_START;
809 musb->intrtxe = musb->epmask;
810 musb_writew(musb->mregs, MUSB_INTRTXE, musb->intrtxe);
811 musb->intrrxe = musb->epmask & 0xfffe;
812 musb_writew(musb->mregs, MUSB_INTRRXE, musb->intrrxe);
813 musb_writeb(musb->mregs, MUSB_INTRUSBE, 0xf7);
814 musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
815 |USB_PORT_STAT_HIGH_SPEED
816 |USB_PORT_STAT_ENABLE
818 musb->port1_status |= USB_PORT_STAT_CONNECTION
819 |(USB_PORT_STAT_C_CONNECTION << 16);
821 /* high vs full speed is just a guess until after reset */
822 if (devctl & MUSB_DEVCTL_LSDEV)
823 musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
825 /* indicate new connection to OTG machine */
826 switch (musb->xceiv->otg->state) {
827 case OTG_STATE_B_PERIPHERAL:
828 if (int_usb & MUSB_INTR_SUSPEND) {
829 musb_dbg(musb, "HNP: SUSPEND+CONNECT, now b_host");
830 int_usb &= ~MUSB_INTR_SUSPEND;
833 musb_dbg(musb, "CONNECT as b_peripheral???");
835 case OTG_STATE_B_WAIT_ACON:
836 musb_dbg(musb, "HNP: CONNECT, now b_host");
838 musb->xceiv->otg->state = OTG_STATE_B_HOST;
840 musb->hcd->self.is_b_host = 1;
841 del_timer(&musb->otg_timer);
844 if ((devctl & MUSB_DEVCTL_VBUS)
845 == (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
846 musb->xceiv->otg->state = OTG_STATE_A_HOST;
848 hcd->self.is_b_host = 0;
853 musb_host_poke_root_hub(musb);
855 musb_dbg(musb, "CONNECT (%s) devctl %02x",
856 usb_otg_state_string(musb->xceiv->otg->state), devctl);
859 if (int_usb & MUSB_INTR_DISCONNECT) {
860 musb_dbg(musb, "DISCONNECT (%s) as %s, devctl %02x",
861 usb_otg_state_string(musb->xceiv->otg->state),
862 MUSB_MODE(musb), devctl);
863 handled = IRQ_HANDLED;
865 switch (musb->xceiv->otg->state) {
866 case OTG_STATE_A_HOST:
867 case OTG_STATE_A_SUSPEND:
868 musb_host_resume_root_hub(musb);
869 musb_root_disconnect(musb);
870 if (musb->a_wait_bcon != 0)
871 musb_platform_try_idle(musb, jiffies
872 + msecs_to_jiffies(musb->a_wait_bcon));
874 case OTG_STATE_B_HOST:
875 /* REVISIT this behaves for "real disconnect"
876 * cases; make sure the other transitions from
877 * from B_HOST act right too. The B_HOST code
878 * in hnp_stop() is currently not used...
880 musb_root_disconnect(musb);
882 musb->hcd->self.is_b_host = 0;
883 musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
885 musb_g_disconnect(musb);
887 case OTG_STATE_A_PERIPHERAL:
889 musb_root_disconnect(musb);
891 case OTG_STATE_B_WAIT_ACON:
893 case OTG_STATE_B_PERIPHERAL:
894 case OTG_STATE_B_IDLE:
895 musb_g_disconnect(musb);
898 WARNING("unhandled DISCONNECT transition (%s)\n",
899 usb_otg_state_string(musb->xceiv->otg->state));
904 /* mentor saves a bit: bus reset and babble share the same irq.
905 * only host sees babble; only peripheral sees bus reset.
907 if (int_usb & MUSB_INTR_RESET) {
908 handled = IRQ_HANDLED;
909 if (devctl & MUSB_DEVCTL_HM) {
911 * When BABBLE happens what we can depends on which
912 * platform MUSB is running, because some platforms
913 * implemented proprietary means for 'recovering' from
914 * Babble conditions. One such platform is AM335x. In
915 * most cases, however, the only thing we can do is
918 dev_err(musb->controller, "Babble\n");
920 if (is_host_active(musb))
921 musb_recover_from_babble(musb);
923 musb_dbg(musb, "BUS RESET as %s",
924 usb_otg_state_string(musb->xceiv->otg->state));
925 switch (musb->xceiv->otg->state) {
926 case OTG_STATE_A_SUSPEND:
929 case OTG_STATE_A_WAIT_BCON: /* OPT TD.4.7-900ms */
930 /* never use invalid T(a_wait_bcon) */
931 musb_dbg(musb, "HNP: in %s, %d msec timeout",
932 usb_otg_state_string(musb->xceiv->otg->state),
934 mod_timer(&musb->otg_timer, jiffies
935 + msecs_to_jiffies(TA_WAIT_BCON(musb)));
937 case OTG_STATE_A_PERIPHERAL:
938 del_timer(&musb->otg_timer);
941 case OTG_STATE_B_WAIT_ACON:
942 musb_dbg(musb, "HNP: RESET (%s), to b_peripheral",
943 usb_otg_state_string(musb->xceiv->otg->state));
944 musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
947 case OTG_STATE_B_IDLE:
948 musb->xceiv->otg->state = OTG_STATE_B_PERIPHERAL;
950 case OTG_STATE_B_PERIPHERAL:
954 musb_dbg(musb, "Unhandled BUS RESET as %s",
955 usb_otg_state_string(musb->xceiv->otg->state));
961 /* REVISIT ... this would be for multiplexing periodic endpoints, or
962 * supporting transfer phasing to prevent exceeding ISO bandwidth
963 * limits of a given frame or microframe.
965 * It's not needed for peripheral side, which dedicates endpoints;
966 * though it _might_ use SOF irqs for other purposes.
968 * And it's not currently needed for host side, which also dedicates
969 * endpoints, relies on TX/RX interval registers, and isn't claimed
970 * to support ISO transfers yet.
972 if (int_usb & MUSB_INTR_SOF) {
973 void __iomem *mbase = musb->mregs;
974 struct musb_hw_ep *ep;
978 dev_dbg(musb->controller, "START_OF_FRAME\n");
979 handled = IRQ_HANDLED;
981 /* start any periodic Tx transfers waiting for current frame */
982 frame = musb_readw(mbase, MUSB_FRAME);
983 ep = musb->endpoints;
984 for (epnum = 1; (epnum < musb->nr_endpoints)
985 && (musb->epmask >= (1 << epnum));
988 * FIXME handle framecounter wraps (12 bits)
989 * eliminate duplicated StartUrb logic
991 if (ep->dwWaitFrame >= frame) {
993 pr_debug("SOF --> periodic TX%s on %d\n",
994 ep->tx_channel ? " DMA" : "",
997 musb_h_tx_start(musb, epnum);
999 cppi_hostdma_start(musb, epnum);
1001 } /* end of for loop */
1005 schedule_delayed_work(&musb->irq_work, 0);
1010 /*-------------------------------------------------------------------------*/
1012 static void musb_disable_interrupts(struct musb *musb)
1014 void __iomem *mbase = musb->mregs;
1017 /* disable interrupts */
1018 musb_writeb(mbase, MUSB_INTRUSBE, 0);
1020 musb_writew(mbase, MUSB_INTRTXE, 0);
1022 musb_writew(mbase, MUSB_INTRRXE, 0);
1024 /* flush pending interrupts */
1025 temp = musb_readb(mbase, MUSB_INTRUSB);
1026 temp = musb_readw(mbase, MUSB_INTRTX);
1027 temp = musb_readw(mbase, MUSB_INTRRX);
1030 static void musb_enable_interrupts(struct musb *musb)
1032 void __iomem *regs = musb->mregs;
1034 /* Set INT enable registers, enable interrupts */
1035 musb->intrtxe = musb->epmask;
1036 musb_writew(regs, MUSB_INTRTXE, musb->intrtxe);
1037 musb->intrrxe = musb->epmask & 0xfffe;
1038 musb_writew(regs, MUSB_INTRRXE, musb->intrrxe);
1039 musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
1044 * Program the HDRC to start (enable interrupts, dma, etc.).
1046 void musb_start(struct musb *musb)
1048 void __iomem *regs = musb->mregs;
1049 u8 devctl = musb_readb(regs, MUSB_DEVCTL);
1052 musb_dbg(musb, "<== devctl %02x", devctl);
1054 musb_enable_interrupts(musb);
1055 musb_writeb(regs, MUSB_TESTMODE, 0);
1057 power = MUSB_POWER_ISOUPDATE;
1059 * treating UNKNOWN as unspecified maximum speed, in which case
1060 * we will default to high-speed.
1062 if (musb->config->maximum_speed == USB_SPEED_HIGH ||
1063 musb->config->maximum_speed == USB_SPEED_UNKNOWN)
1064 power |= MUSB_POWER_HSENAB;
1065 musb_writeb(regs, MUSB_POWER, power);
1067 musb->is_active = 0;
1068 devctl = musb_readb(regs, MUSB_DEVCTL);
1069 devctl &= ~MUSB_DEVCTL_SESSION;
1071 /* session started after:
1072 * (a) ID-grounded irq, host mode;
1073 * (b) vbus present/connect IRQ, peripheral mode;
1074 * (c) peripheral initiates, using SRP
1076 if (musb->port_mode != MUSB_PORT_MODE_HOST &&
1077 musb->xceiv->otg->state != OTG_STATE_A_WAIT_BCON &&
1078 (devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS) {
1079 musb->is_active = 1;
1081 devctl |= MUSB_DEVCTL_SESSION;
1084 musb_platform_enable(musb);
1085 musb_writeb(regs, MUSB_DEVCTL, devctl);
1089 * Make the HDRC stop (disable interrupts, etc.);
1090 * reversible by musb_start
1091 * called on gadget driver unregister
1092 * with controller locked, irqs blocked
1093 * acts as a NOP unless some role activated the hardware
1095 void musb_stop(struct musb *musb)
1097 /* stop IRQs, timers, ... */
1098 musb_platform_disable(musb);
1099 musb_disable_interrupts(musb);
1100 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
1103 * - mark host and/or peripheral drivers unusable/inactive
1104 * - disable DMA (and enable it in HdrcStart)
1105 * - make sure we can musb_start() after musb_stop(); with
1106 * OTG mode, gadget driver module rmmod/modprobe cycles that
1109 musb_platform_try_idle(musb, 0);
1112 /*-------------------------------------------------------------------------*/
1115 * The silicon either has hard-wired endpoint configurations, or else
1116 * "dynamic fifo" sizing. The driver has support for both, though at this
1117 * writing only the dynamic sizing is very well tested. Since we switched
1118 * away from compile-time hardware parameters, we can no longer rely on
1119 * dead code elimination to leave only the relevant one in the object file.
1121 * We don't currently use dynamic fifo setup capability to do anything
1122 * more than selecting one of a bunch of predefined configurations.
1124 static ushort fifo_mode;
1126 /* "modprobe ... fifo_mode=1" etc */
1127 module_param(fifo_mode, ushort, 0);
1128 MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
1131 * tables defining fifo_mode values. define more if you like.
1132 * for host side, make sure both halves of ep1 are set up.
1135 /* mode 0 - fits in 2KB */
1136 static struct musb_fifo_cfg mode_0_cfg[] = {
1137 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1138 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1139 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1140 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1141 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1144 /* mode 1 - fits in 4KB */
1145 static struct musb_fifo_cfg mode_1_cfg[] = {
1146 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1147 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1148 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1149 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1150 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1153 /* mode 2 - fits in 4KB */
1154 static struct musb_fifo_cfg mode_2_cfg[] = {
1155 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1156 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1157 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1158 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1159 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1160 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1163 /* mode 3 - fits in 4KB */
1164 static struct musb_fifo_cfg mode_3_cfg[] = {
1165 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1166 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1167 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1168 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1169 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1170 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1173 /* mode 4 - fits in 16KB */
1174 static struct musb_fifo_cfg mode_4_cfg[] = {
1175 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1176 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1177 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1178 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1179 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1180 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1181 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1182 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1183 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1184 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1185 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 512, },
1186 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 512, },
1187 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 512, },
1188 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 512, },
1189 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 512, },
1190 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 512, },
1191 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 512, },
1192 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 512, },
1193 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 256, },
1194 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 64, },
1195 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 256, },
1196 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 64, },
1197 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 256, },
1198 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 64, },
1199 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1200 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1201 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1204 /* mode 5 - fits in 8KB */
1205 static struct musb_fifo_cfg mode_5_cfg[] = {
1206 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1207 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1208 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1209 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1210 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1211 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1212 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1213 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1214 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1215 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1216 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 32, },
1217 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 32, },
1218 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 32, },
1219 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 32, },
1220 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 32, },
1221 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 32, },
1222 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 32, },
1223 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 32, },
1224 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 32, },
1225 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 32, },
1226 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 32, },
1227 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 32, },
1228 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 32, },
1229 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 32, },
1230 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1231 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1232 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1236 * configure a fifo; for non-shared endpoints, this may be called
1237 * once for a tx fifo and once for an rx fifo.
1239 * returns negative errno or offset for next fifo.
1242 fifo_setup(struct musb *musb, struct musb_hw_ep *hw_ep,
1243 const struct musb_fifo_cfg *cfg, u16 offset)
1245 void __iomem *mbase = musb->mregs;
1247 u16 maxpacket = cfg->maxpacket;
1248 u16 c_off = offset >> 3;
1251 /* expect hw_ep has already been zero-initialized */
1253 size = ffs(max(maxpacket, (u16) 8)) - 1;
1254 maxpacket = 1 << size;
1257 if (cfg->mode == BUF_DOUBLE) {
1258 if ((offset + (maxpacket << 1)) >
1259 (1 << (musb->config->ram_bits + 2)))
1261 c_size |= MUSB_FIFOSZ_DPB;
1263 if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1267 /* configure the FIFO */
1268 musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1270 /* EP0 reserved endpoint for control, bidirectional;
1271 * EP1 reserved for bulk, two unidirectional halves.
1273 if (hw_ep->epnum == 1)
1274 musb->bulk_ep = hw_ep;
1275 /* REVISIT error check: be sure ep0 can both rx and tx ... */
1276 switch (cfg->style) {
1278 musb_write_txfifosz(mbase, c_size);
1279 musb_write_txfifoadd(mbase, c_off);
1280 hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1281 hw_ep->max_packet_sz_tx = maxpacket;
1284 musb_write_rxfifosz(mbase, c_size);
1285 musb_write_rxfifoadd(mbase, c_off);
1286 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1287 hw_ep->max_packet_sz_rx = maxpacket;
1290 musb_write_txfifosz(mbase, c_size);
1291 musb_write_txfifoadd(mbase, c_off);
1292 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1293 hw_ep->max_packet_sz_rx = maxpacket;
1295 musb_write_rxfifosz(mbase, c_size);
1296 musb_write_rxfifoadd(mbase, c_off);
1297 hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1298 hw_ep->max_packet_sz_tx = maxpacket;
1300 hw_ep->is_shared_fifo = true;
1304 /* NOTE rx and tx endpoint irqs aren't managed separately,
1305 * which happens to be ok
1307 musb->epmask |= (1 << hw_ep->epnum);
1309 return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1312 static struct musb_fifo_cfg ep0_cfg = {
1313 .style = FIFO_RXTX, .maxpacket = 64,
1316 static int ep_config_from_table(struct musb *musb)
1318 const struct musb_fifo_cfg *cfg;
1321 struct musb_hw_ep *hw_ep = musb->endpoints;
1323 if (musb->config->fifo_cfg) {
1324 cfg = musb->config->fifo_cfg;
1325 n = musb->config->fifo_cfg_size;
1329 switch (fifo_mode) {
1335 n = ARRAY_SIZE(mode_0_cfg);
1339 n = ARRAY_SIZE(mode_1_cfg);
1343 n = ARRAY_SIZE(mode_2_cfg);
1347 n = ARRAY_SIZE(mode_3_cfg);
1351 n = ARRAY_SIZE(mode_4_cfg);
1355 n = ARRAY_SIZE(mode_5_cfg);
1359 pr_debug("%s: setup fifo_mode %d\n", musb_driver_name, fifo_mode);
1363 offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1364 /* assert(offset > 0) */
1366 /* NOTE: for RTL versions >= 1.400 EPINFO and RAMINFO would
1367 * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1370 for (i = 0; i < n; i++) {
1371 u8 epn = cfg->hw_ep_num;
1373 if (epn >= musb->config->num_eps) {
1374 pr_debug("%s: invalid ep %d\n",
1375 musb_driver_name, epn);
1378 offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1380 pr_debug("%s: mem overrun, ep %d\n",
1381 musb_driver_name, epn);
1385 musb->nr_endpoints = max(epn, musb->nr_endpoints);
1388 pr_debug("%s: %d/%d max ep, %d/%d memory\n",
1390 n + 1, musb->config->num_eps * 2 - 1,
1391 offset, (1 << (musb->config->ram_bits + 2)));
1393 if (!musb->bulk_ep) {
1394 pr_debug("%s: missing bulk\n", musb_driver_name);
1403 * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1404 * @param musb the controller
1406 static int ep_config_from_hw(struct musb *musb)
1409 struct musb_hw_ep *hw_ep;
1410 void __iomem *mbase = musb->mregs;
1413 musb_dbg(musb, "<== static silicon ep config");
1415 /* FIXME pick up ep0 maxpacket size */
1417 for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1418 musb_ep_select(mbase, epnum);
1419 hw_ep = musb->endpoints + epnum;
1421 ret = musb_read_fifosize(musb, hw_ep, epnum);
1425 /* FIXME set up hw_ep->{rx,tx}_double_buffered */
1427 /* pick an RX/TX endpoint for bulk */
1428 if (hw_ep->max_packet_sz_tx < 512
1429 || hw_ep->max_packet_sz_rx < 512)
1432 /* REVISIT: this algorithm is lazy, we should at least
1433 * try to pick a double buffered endpoint.
1437 musb->bulk_ep = hw_ep;
1440 if (!musb->bulk_ep) {
1441 pr_debug("%s: missing bulk\n", musb_driver_name);
1448 enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1450 /* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1451 * configure endpoints, or take their config from silicon
1453 static int musb_core_init(u16 musb_type, struct musb *musb)
1458 void __iomem *mbase = musb->mregs;
1462 /* log core options (read using indexed model) */
1463 reg = musb_read_configdata(mbase);
1465 strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1466 if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1467 strcat(aInfo, ", dyn FIFOs");
1468 musb->dyn_fifo = true;
1470 if (reg & MUSB_CONFIGDATA_MPRXE) {
1471 strcat(aInfo, ", bulk combine");
1472 musb->bulk_combine = true;
1474 if (reg & MUSB_CONFIGDATA_MPTXE) {
1475 strcat(aInfo, ", bulk split");
1476 musb->bulk_split = true;
1478 if (reg & MUSB_CONFIGDATA_HBRXE) {
1479 strcat(aInfo, ", HB-ISO Rx");
1480 musb->hb_iso_rx = true;
1482 if (reg & MUSB_CONFIGDATA_HBTXE) {
1483 strcat(aInfo, ", HB-ISO Tx");
1484 musb->hb_iso_tx = true;
1486 if (reg & MUSB_CONFIGDATA_SOFTCONE)
1487 strcat(aInfo, ", SoftConn");
1489 pr_debug("%s: ConfigData=0x%02x (%s)\n", musb_driver_name, reg, aInfo);
1491 if (MUSB_CONTROLLER_MHDRC == musb_type) {
1492 musb->is_multipoint = 1;
1495 musb->is_multipoint = 0;
1497 #ifndef CONFIG_USB_OTG_BLACKLIST_HUB
1498 pr_err("%s: kernel must blacklist external hubs\n",
1503 /* log release info */
1504 musb->hwvers = musb_read_hwvers(mbase);
1505 pr_debug("%s: %sHDRC RTL version %d.%d%s\n",
1506 musb_driver_name, type, MUSB_HWVERS_MAJOR(musb->hwvers),
1507 MUSB_HWVERS_MINOR(musb->hwvers),
1508 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1511 musb_configure_ep0(musb);
1513 /* discover endpoint configuration */
1514 musb->nr_endpoints = 1;
1518 status = ep_config_from_table(musb);
1520 status = ep_config_from_hw(musb);
1525 /* finish init, and print endpoint config */
1526 for (i = 0; i < musb->nr_endpoints; i++) {
1527 struct musb_hw_ep *hw_ep = musb->endpoints + i;
1529 hw_ep->fifo = musb->io.fifo_offset(i) + mbase;
1530 #if IS_ENABLED(CONFIG_USB_MUSB_TUSB6010)
1531 if (musb->io.quirks & MUSB_IN_TUSB) {
1532 hw_ep->fifo_async = musb->async + 0x400 +
1533 musb->io.fifo_offset(i);
1534 hw_ep->fifo_sync = musb->sync + 0x400 +
1535 musb->io.fifo_offset(i);
1536 hw_ep->fifo_sync_va =
1537 musb->sync_va + 0x400 + musb->io.fifo_offset(i);
1540 hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1542 hw_ep->conf = mbase + 0x400 +
1543 (((i - 1) & 0xf) << 2);
1547 hw_ep->regs = musb->io.ep_offset(i, 0) + mbase;
1548 hw_ep->rx_reinit = 1;
1549 hw_ep->tx_reinit = 1;
1551 if (hw_ep->max_packet_sz_tx) {
1552 musb_dbg(musb, "%s: hw_ep %d%s, %smax %d",
1553 musb_driver_name, i,
1554 hw_ep->is_shared_fifo ? "shared" : "tx",
1555 hw_ep->tx_double_buffered
1556 ? "doublebuffer, " : "",
1557 hw_ep->max_packet_sz_tx);
1559 if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1560 musb_dbg(musb, "%s: hw_ep %d%s, %smax %d",
1561 musb_driver_name, i,
1563 hw_ep->rx_double_buffered
1564 ? "doublebuffer, " : "",
1565 hw_ep->max_packet_sz_rx);
1567 if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1568 musb_dbg(musb, "hw_ep %d not configured", i);
1574 /*-------------------------------------------------------------------------*/
1577 * handle all the irqs defined by the HDRC core. for now we expect: other
1578 * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1579 * will be assigned, and the irq will already have been acked.
1581 * called in irq context with spinlock held, irqs blocked
1583 irqreturn_t musb_interrupt(struct musb *musb)
1585 irqreturn_t retval = IRQ_NONE;
1586 unsigned long status;
1587 unsigned long epnum;
1590 if (!musb->int_usb && !musb->int_tx && !musb->int_rx)
1593 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1595 trace_musb_isr(musb);
1598 * According to Mentor Graphics' documentation, flowchart on page 98,
1599 * IRQ should be handled as follows:
1602 * . Session Request IRQ
1607 * . Reset/Babble IRQ
1608 * . SOF IRQ (we're not using this one)
1613 * We will be following that flowchart in order to avoid any problems
1614 * that might arise with internal Finite State Machine.
1618 retval |= musb_stage0_irq(musb, musb->int_usb, devctl);
1620 if (musb->int_tx & 1) {
1621 if (is_host_active(musb))
1622 retval |= musb_h_ep0_irq(musb);
1624 retval |= musb_g_ep0_irq(musb);
1626 /* we have just handled endpoint 0 IRQ, clear it */
1627 musb->int_tx &= ~BIT(0);
1630 status = musb->int_tx;
1632 for_each_set_bit(epnum, &status, 16) {
1633 retval = IRQ_HANDLED;
1634 if (is_host_active(musb))
1635 musb_host_tx(musb, epnum);
1637 musb_g_tx(musb, epnum);
1640 status = musb->int_rx;
1642 for_each_set_bit(epnum, &status, 16) {
1643 retval = IRQ_HANDLED;
1644 if (is_host_active(musb))
1645 musb_host_rx(musb, epnum);
1647 musb_g_rx(musb, epnum);
1652 EXPORT_SYMBOL_GPL(musb_interrupt);
1654 #ifndef CONFIG_MUSB_PIO_ONLY
1655 static bool use_dma = 1;
1657 /* "modprobe ... use_dma=0" etc */
1658 module_param(use_dma, bool, 0644);
1659 MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1661 void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1663 /* called with controller lock already held */
1666 if (!is_cppi_enabled(musb)) {
1668 if (is_host_active(musb))
1669 musb_h_ep0_irq(musb);
1671 musb_g_ep0_irq(musb);
1674 /* endpoints 1..15 */
1676 if (is_host_active(musb))
1677 musb_host_tx(musb, epnum);
1679 musb_g_tx(musb, epnum);
1682 if (is_host_active(musb))
1683 musb_host_rx(musb, epnum);
1685 musb_g_rx(musb, epnum);
1689 EXPORT_SYMBOL_GPL(musb_dma_completion);
1695 static int (*musb_phy_callback)(enum musb_vbus_id_status status);
1698 * musb_mailbox - optional phy notifier function
1699 * @status phy state change
1701 * Optionally gets called from the USB PHY. Note that the USB PHY must be
1702 * disabled at the point the phy_callback is registered or unregistered.
1704 int musb_mailbox(enum musb_vbus_id_status status)
1706 if (musb_phy_callback)
1707 return musb_phy_callback(status);
1711 EXPORT_SYMBOL_GPL(musb_mailbox);
1713 /*-------------------------------------------------------------------------*/
1716 musb_mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1718 struct musb *musb = dev_to_musb(dev);
1719 unsigned long flags;
1722 spin_lock_irqsave(&musb->lock, flags);
1723 ret = sprintf(buf, "%s\n", usb_otg_state_string(musb->xceiv->otg->state));
1724 spin_unlock_irqrestore(&musb->lock, flags);
1730 musb_mode_store(struct device *dev, struct device_attribute *attr,
1731 const char *buf, size_t n)
1733 struct musb *musb = dev_to_musb(dev);
1734 unsigned long flags;
1737 spin_lock_irqsave(&musb->lock, flags);
1738 if (sysfs_streq(buf, "host"))
1739 status = musb_platform_set_mode(musb, MUSB_HOST);
1740 else if (sysfs_streq(buf, "peripheral"))
1741 status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1742 else if (sysfs_streq(buf, "otg"))
1743 status = musb_platform_set_mode(musb, MUSB_OTG);
1746 spin_unlock_irqrestore(&musb->lock, flags);
1748 return (status == 0) ? n : status;
1750 static DEVICE_ATTR(mode, 0644, musb_mode_show, musb_mode_store);
1753 musb_vbus_store(struct device *dev, struct device_attribute *attr,
1754 const char *buf, size_t n)
1756 struct musb *musb = dev_to_musb(dev);
1757 unsigned long flags;
1760 if (sscanf(buf, "%lu", &val) < 1) {
1761 dev_err(dev, "Invalid VBUS timeout ms value\n");
1765 spin_lock_irqsave(&musb->lock, flags);
1766 /* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1767 musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1768 if (musb->xceiv->otg->state == OTG_STATE_A_WAIT_BCON)
1769 musb->is_active = 0;
1770 musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1771 spin_unlock_irqrestore(&musb->lock, flags);
1777 musb_vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1779 struct musb *musb = dev_to_musb(dev);
1780 unsigned long flags;
1785 spin_lock_irqsave(&musb->lock, flags);
1786 val = musb->a_wait_bcon;
1787 vbus = musb_platform_get_vbus_status(musb);
1789 /* Use default MUSB method by means of DEVCTL register */
1790 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1791 if ((devctl & MUSB_DEVCTL_VBUS)
1792 == (3 << MUSB_DEVCTL_VBUS_SHIFT))
1797 spin_unlock_irqrestore(&musb->lock, flags);
1799 return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1800 vbus ? "on" : "off", val);
1802 static DEVICE_ATTR(vbus, 0644, musb_vbus_show, musb_vbus_store);
1804 /* Gadget drivers can't know that a host is connected so they might want
1805 * to start SRP, but users can. This allows userspace to trigger SRP.
1808 musb_srp_store(struct device *dev, struct device_attribute *attr,
1809 const char *buf, size_t n)
1811 struct musb *musb = dev_to_musb(dev);
1814 if (sscanf(buf, "%hu", &srp) != 1
1816 dev_err(dev, "SRP: Value must be 1\n");
1821 musb_g_wakeup(musb);
1825 static DEVICE_ATTR(srp, 0644, NULL, musb_srp_store);
1827 static struct attribute *musb_attributes[] = {
1828 &dev_attr_mode.attr,
1829 &dev_attr_vbus.attr,
1834 static const struct attribute_group musb_attr_group = {
1835 .attrs = musb_attributes,
1838 #define MUSB_QUIRK_B_INVALID_VBUS_91 (MUSB_DEVCTL_BDEVICE | \
1839 (2 << MUSB_DEVCTL_VBUS_SHIFT) | \
1840 MUSB_DEVCTL_SESSION)
1841 #define MUSB_QUIRK_A_DISCONNECT_19 ((3 << MUSB_DEVCTL_VBUS_SHIFT) | \
1842 MUSB_DEVCTL_SESSION)
1845 * Check the musb devctl session bit to determine if we want to
1846 * allow PM runtime for the device. In general, we want to keep things
1847 * active when the session bit is set except after host disconnect.
1849 * Only called from musb_irq_work. If this ever needs to get called
1850 * elsewhere, proper locking must be implemented for musb->session.
1852 static void musb_pm_runtime_check_session(struct musb *musb)
1857 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1859 /* Handle session status quirks first */
1860 s = MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV |
1862 switch (devctl & ~s) {
1863 case MUSB_QUIRK_B_INVALID_VBUS_91:
1864 if (musb->quirk_retries--) {
1866 "Poll devctl on invalid vbus, assume no session");
1867 schedule_delayed_work(&musb->irq_work,
1868 msecs_to_jiffies(1000));
1873 case MUSB_QUIRK_A_DISCONNECT_19:
1874 if (musb->quirk_retries--) {
1876 "Poll devctl on possible host mode disconnect");
1877 schedule_delayed_work(&musb->irq_work,
1878 msecs_to_jiffies(1000));
1884 musb_dbg(musb, "Allow PM on possible host mode disconnect");
1885 pm_runtime_mark_last_busy(musb->controller);
1886 pm_runtime_put_autosuspend(musb->controller);
1887 musb->session = false;
1893 /* No need to do anything if session has not changed */
1894 s = devctl & MUSB_DEVCTL_SESSION;
1895 if (s == musb->session)
1898 /* Block PM or allow PM? */
1900 musb_dbg(musb, "Block PM on active session: %02x", devctl);
1901 error = pm_runtime_get_sync(musb->controller);
1903 dev_err(musb->controller, "Could not enable: %i\n",
1905 musb->quirk_retries = 3;
1907 musb_dbg(musb, "Allow PM with no session: %02x", devctl);
1908 pm_runtime_mark_last_busy(musb->controller);
1909 pm_runtime_put_autosuspend(musb->controller);
1915 /* Only used to provide driver mode change events */
1916 static void musb_irq_work(struct work_struct *data)
1918 struct musb *musb = container_of(data, struct musb, irq_work.work);
1921 error = pm_runtime_get_sync(musb->controller);
1923 dev_err(musb->controller, "Could not enable: %i\n", error);
1928 musb_pm_runtime_check_session(musb);
1930 if (musb->xceiv->otg->state != musb->xceiv_old_state) {
1931 musb->xceiv_old_state = musb->xceiv->otg->state;
1932 sysfs_notify(&musb->controller->kobj, NULL, "mode");
1935 pm_runtime_mark_last_busy(musb->controller);
1936 pm_runtime_put_autosuspend(musb->controller);
1939 static void musb_recover_from_babble(struct musb *musb)
1944 musb_disable_interrupts(musb);
1947 * wait at least 320 cycles of 60MHz clock. That's 5.3us, we will give
1948 * it some slack and wait for 10us.
1952 ret = musb_platform_recover(musb);
1954 musb_enable_interrupts(musb);
1958 /* drop session bit */
1959 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1960 devctl &= ~MUSB_DEVCTL_SESSION;
1961 musb_writeb(musb->mregs, MUSB_DEVCTL, devctl);
1963 /* tell usbcore about it */
1964 musb_root_disconnect(musb);
1967 * When a babble condition occurs, the musb controller
1968 * removes the session bit and the endpoint config is lost.
1971 ret = ep_config_from_table(musb);
1973 ret = ep_config_from_hw(musb);
1975 /* restart session */
1980 /* --------------------------------------------------------------------------
1984 static struct musb *allocate_instance(struct device *dev,
1985 const struct musb_hdrc_config *config, void __iomem *mbase)
1988 struct musb_hw_ep *ep;
1992 musb = devm_kzalloc(dev, sizeof(*musb), GFP_KERNEL);
1996 INIT_LIST_HEAD(&musb->control);
1997 INIT_LIST_HEAD(&musb->in_bulk);
1998 INIT_LIST_HEAD(&musb->out_bulk);
1999 INIT_LIST_HEAD(&musb->pending_list);
2001 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
2002 musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
2003 musb->mregs = mbase;
2004 musb->ctrl_base = mbase;
2005 musb->nIrq = -ENODEV;
2006 musb->config = config;
2007 BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
2008 for (epnum = 0, ep = musb->endpoints;
2009 epnum < musb->config->num_eps;
2015 musb->controller = dev;
2017 ret = musb_host_alloc(musb);
2021 dev_set_drvdata(dev, musb);
2029 static void musb_free(struct musb *musb)
2031 /* this has multiple entry modes. it handles fault cleanup after
2032 * probe(), where things may be partially set up, as well as rmmod
2033 * cleanup after everything's been de-activated.
2037 sysfs_remove_group(&musb->controller->kobj, &musb_attr_group);
2040 if (musb->nIrq >= 0) {
2042 disable_irq_wake(musb->nIrq);
2043 free_irq(musb->nIrq, musb);
2046 musb_host_free(musb);
2049 struct musb_pending_work {
2050 int (*callback)(struct musb *musb, void *data);
2052 struct list_head node;
2057 * Called from musb_runtime_resume(), musb_resume(), and
2058 * musb_queue_resume_work(). Callers must take musb->lock.
2060 static int musb_run_resume_work(struct musb *musb)
2062 struct musb_pending_work *w, *_w;
2063 unsigned long flags;
2066 spin_lock_irqsave(&musb->list_lock, flags);
2067 list_for_each_entry_safe(w, _w, &musb->pending_list, node) {
2069 error = w->callback(musb, w->data);
2071 dev_err(musb->controller,
2072 "resume callback %p failed: %i\n",
2073 w->callback, error);
2077 devm_kfree(musb->controller, w);
2079 spin_unlock_irqrestore(&musb->list_lock, flags);
2086 * Called to run work if device is active or else queue the work to happen
2087 * on resume. Caller must take musb->lock and must hold an RPM reference.
2089 * Note that we cowardly refuse queuing work after musb PM runtime
2090 * resume is done calling musb_run_resume_work() and return -EINPROGRESS
2093 int musb_queue_resume_work(struct musb *musb,
2094 int (*callback)(struct musb *musb, void *data),
2097 struct musb_pending_work *w;
2098 unsigned long flags;
2101 if (WARN_ON(!callback))
2104 if (pm_runtime_active(musb->controller))
2105 return callback(musb, data);
2107 w = devm_kzalloc(musb->controller, sizeof(*w), GFP_ATOMIC);
2111 w->callback = callback;
2113 spin_lock_irqsave(&musb->list_lock, flags);
2114 if (musb->is_runtime_suspended) {
2115 list_add_tail(&w->node, &musb->pending_list);
2118 dev_err(musb->controller, "could not add resume work %p\n",
2120 devm_kfree(musb->controller, w);
2121 error = -EINPROGRESS;
2123 spin_unlock_irqrestore(&musb->list_lock, flags);
2127 EXPORT_SYMBOL_GPL(musb_queue_resume_work);
2129 static void musb_deassert_reset(struct work_struct *work)
2132 unsigned long flags;
2134 musb = container_of(work, struct musb, deassert_reset_work.work);
2136 spin_lock_irqsave(&musb->lock, flags);
2138 if (musb->port1_status & USB_PORT_STAT_RESET)
2139 musb_port_reset(musb, false);
2141 spin_unlock_irqrestore(&musb->lock, flags);
2145 * Perform generic per-controller initialization.
2147 * @dev: the controller (already clocked, etc)
2149 * @ctrl: virtual address of controller registers,
2150 * not yet corrected for platform-specific offsets
2153 musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
2157 struct musb_hdrc_platform_data *plat = dev_get_platdata(dev);
2159 /* The driver might handle more features than the board; OK.
2160 * Fail when the board needs a feature that's not enabled.
2163 dev_err(dev, "no platform_data?\n");
2169 musb = allocate_instance(dev, plat->config, ctrl);
2175 spin_lock_init(&musb->lock);
2176 spin_lock_init(&musb->list_lock);
2177 musb->board_set_power = plat->set_power;
2178 musb->min_power = plat->min_power;
2179 musb->ops = plat->platform_ops;
2180 musb->port_mode = plat->mode;
2183 * Initialize the default IO functions. At least omap2430 needs
2184 * these early. We initialize the platform specific IO functions
2187 musb_readb = musb_default_readb;
2188 musb_writeb = musb_default_writeb;
2189 musb_readw = musb_default_readw;
2190 musb_writew = musb_default_writew;
2191 musb_readl = musb_default_readl;
2192 musb_writel = musb_default_writel;
2194 /* The musb_platform_init() call:
2195 * - adjusts musb->mregs
2196 * - sets the musb->isr
2197 * - may initialize an integrated transceiver
2198 * - initializes musb->xceiv, usually by otg_get_phy()
2199 * - stops powering VBUS
2201 * There are various transceiver configurations. Blackfin,
2202 * DaVinci, TUSB60x0, and others integrate them. OMAP3 uses
2203 * external/discrete ones in various flavors (twl4030 family,
2204 * isp1504, non-OTG, etc) mostly hooking up through ULPI.
2206 status = musb_platform_init(musb);
2215 if (musb->ops->quirks)
2216 musb->io.quirks = musb->ops->quirks;
2218 /* Most devices use indexed offset or flat offset */
2219 if (musb->io.quirks & MUSB_INDEXED_EP) {
2220 musb->io.ep_offset = musb_indexed_ep_offset;
2221 musb->io.ep_select = musb_indexed_ep_select;
2223 musb->io.ep_offset = musb_flat_ep_offset;
2224 musb->io.ep_select = musb_flat_ep_select;
2227 /* At least tusb6010 has its own offsets */
2228 if (musb->ops->ep_offset)
2229 musb->io.ep_offset = musb->ops->ep_offset;
2230 if (musb->ops->ep_select)
2231 musb->io.ep_select = musb->ops->ep_select;
2233 if (musb->ops->fifo_mode)
2234 fifo_mode = musb->ops->fifo_mode;
2238 if (musb->ops->fifo_offset)
2239 musb->io.fifo_offset = musb->ops->fifo_offset;
2241 musb->io.fifo_offset = musb_default_fifo_offset;
2243 if (musb->ops->busctl_offset)
2244 musb->io.busctl_offset = musb->ops->busctl_offset;
2246 musb->io.busctl_offset = musb_default_busctl_offset;
2248 if (musb->ops->readb)
2249 musb_readb = musb->ops->readb;
2250 if (musb->ops->writeb)
2251 musb_writeb = musb->ops->writeb;
2252 if (musb->ops->readw)
2253 musb_readw = musb->ops->readw;
2254 if (musb->ops->writew)
2255 musb_writew = musb->ops->writew;
2256 if (musb->ops->readl)
2257 musb_readl = musb->ops->readl;
2258 if (musb->ops->writel)
2259 musb_writel = musb->ops->writel;
2261 #ifndef CONFIG_MUSB_PIO_ONLY
2262 if (!musb->ops->dma_init || !musb->ops->dma_exit) {
2263 dev_err(dev, "DMA controller not set\n");
2267 musb_dma_controller_create = musb->ops->dma_init;
2268 musb_dma_controller_destroy = musb->ops->dma_exit;
2271 if (musb->ops->read_fifo)
2272 musb->io.read_fifo = musb->ops->read_fifo;
2274 musb->io.read_fifo = musb_default_read_fifo;
2276 if (musb->ops->write_fifo)
2277 musb->io.write_fifo = musb->ops->write_fifo;
2279 musb->io.write_fifo = musb_default_write_fifo;
2281 if (!musb->xceiv->io_ops) {
2282 musb->xceiv->io_dev = musb->controller;
2283 musb->xceiv->io_priv = musb->mregs;
2284 musb->xceiv->io_ops = &musb_ulpi_access;
2287 if (musb->ops->phy_callback)
2288 musb_phy_callback = musb->ops->phy_callback;
2291 * We need musb_read/write functions initialized for PM.
2292 * Note that at least 2430 glue needs autosuspend delay
2293 * somewhere above 300 ms for the hardware to idle properly
2294 * after disconnecting the cable in host mode. Let's use
2295 * 500 ms for some margin.
2297 pm_runtime_use_autosuspend(musb->controller);
2298 pm_runtime_set_autosuspend_delay(musb->controller, 500);
2299 pm_runtime_enable(musb->controller);
2300 pm_runtime_get_sync(musb->controller);
2302 status = usb_phy_init(musb->xceiv);
2304 goto err_usb_phy_init;
2306 if (use_dma && dev->dma_mask) {
2307 musb->dma_controller =
2308 musb_dma_controller_create(musb, musb->mregs);
2309 if (IS_ERR(musb->dma_controller)) {
2310 status = PTR_ERR(musb->dma_controller);
2315 /* be sure interrupts are disabled before connecting ISR */
2316 musb_platform_disable(musb);
2317 musb_disable_interrupts(musb);
2318 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2320 /* Init IRQ workqueue before request_irq */
2321 INIT_DELAYED_WORK(&musb->irq_work, musb_irq_work);
2322 INIT_DELAYED_WORK(&musb->deassert_reset_work, musb_deassert_reset);
2323 INIT_DELAYED_WORK(&musb->finish_resume_work, musb_host_finish_resume);
2325 /* setup musb parts of the core (especially endpoints) */
2326 status = musb_core_init(plat->config->multipoint
2327 ? MUSB_CONTROLLER_MHDRC
2328 : MUSB_CONTROLLER_HDRC, musb);
2332 setup_timer(&musb->otg_timer, musb_otg_timer_func, (unsigned long) musb);
2334 /* attach to the IRQ */
2335 if (request_irq(nIrq, musb->isr, 0, dev_name(dev), musb)) {
2336 dev_err(dev, "request_irq %d failed!\n", nIrq);
2341 /* FIXME this handles wakeup irqs wrong */
2342 if (enable_irq_wake(nIrq) == 0) {
2344 device_init_wakeup(dev, 1);
2349 /* program PHY to use external vBus if required */
2350 if (plat->extvbus) {
2351 u8 busctl = musb_read_ulpi_buscontrol(musb->mregs);
2352 busctl |= MUSB_ULPI_USE_EXTVBUS;
2353 musb_write_ulpi_buscontrol(musb->mregs, busctl);
2356 if (musb->xceiv->otg->default_a) {
2357 MUSB_HST_MODE(musb);
2358 musb->xceiv->otg->state = OTG_STATE_A_IDLE;
2360 MUSB_DEV_MODE(musb);
2361 musb->xceiv->otg->state = OTG_STATE_B_IDLE;
2364 switch (musb->port_mode) {
2365 case MUSB_PORT_MODE_HOST:
2366 status = musb_host_setup(musb, plat->power);
2369 status = musb_platform_set_mode(musb, MUSB_HOST);
2371 case MUSB_PORT_MODE_GADGET:
2372 status = musb_gadget_setup(musb);
2375 status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
2377 case MUSB_PORT_MODE_DUAL_ROLE:
2378 status = musb_host_setup(musb, plat->power);
2381 status = musb_gadget_setup(musb);
2383 musb_host_cleanup(musb);
2386 status = musb_platform_set_mode(musb, MUSB_OTG);
2389 dev_err(dev, "unsupported port mode %d\n", musb->port_mode);
2396 status = musb_init_debugfs(musb);
2400 status = sysfs_create_group(&musb->controller->kobj, &musb_attr_group);
2404 musb->is_initialized = 1;
2405 pm_runtime_mark_last_busy(musb->controller);
2406 pm_runtime_put_autosuspend(musb->controller);
2411 musb_exit_debugfs(musb);
2414 musb_gadget_cleanup(musb);
2415 musb_host_cleanup(musb);
2418 cancel_delayed_work_sync(&musb->irq_work);
2419 cancel_delayed_work_sync(&musb->finish_resume_work);
2420 cancel_delayed_work_sync(&musb->deassert_reset_work);
2421 if (musb->dma_controller)
2422 musb_dma_controller_destroy(musb->dma_controller);
2425 usb_phy_shutdown(musb->xceiv);
2428 pm_runtime_dont_use_autosuspend(musb->controller);
2429 pm_runtime_put_sync(musb->controller);
2430 pm_runtime_disable(musb->controller);
2434 device_init_wakeup(dev, 0);
2435 musb_platform_exit(musb);
2438 if (status != -EPROBE_DEFER)
2439 dev_err(musb->controller,
2440 "%s failed with status %d\n", __func__, status);
2450 /*-------------------------------------------------------------------------*/
2452 /* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2453 * bridge to a platform device; this driver then suffices.
2455 static int musb_probe(struct platform_device *pdev)
2457 struct device *dev = &pdev->dev;
2458 int irq = platform_get_irq_byname(pdev, "mc");
2459 struct resource *iomem;
2465 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2466 base = devm_ioremap_resource(dev, iomem);
2468 return PTR_ERR(base);
2470 return musb_init_controller(dev, irq, base);
2473 static int musb_remove(struct platform_device *pdev)
2475 struct device *dev = &pdev->dev;
2476 struct musb *musb = dev_to_musb(dev);
2477 unsigned long flags;
2479 /* this gets called on rmmod.
2480 * - Host mode: host may still be active
2481 * - Peripheral mode: peripheral is deactivated (or never-activated)
2482 * - OTG mode: both roles are deactivated (or never-activated)
2484 musb_exit_debugfs(musb);
2486 cancel_delayed_work_sync(&musb->irq_work);
2487 cancel_delayed_work_sync(&musb->finish_resume_work);
2488 cancel_delayed_work_sync(&musb->deassert_reset_work);
2489 pm_runtime_get_sync(musb->controller);
2490 musb_host_cleanup(musb);
2491 musb_gadget_cleanup(musb);
2493 musb_platform_disable(musb);
2494 spin_lock_irqsave(&musb->lock, flags);
2495 musb_disable_interrupts(musb);
2496 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2497 spin_unlock_irqrestore(&musb->lock, flags);
2499 pm_runtime_dont_use_autosuspend(musb->controller);
2500 pm_runtime_put_sync(musb->controller);
2501 pm_runtime_disable(musb->controller);
2502 musb_platform_exit(musb);
2503 musb_phy_callback = NULL;
2504 if (musb->dma_controller)
2505 musb_dma_controller_destroy(musb->dma_controller);
2506 usb_phy_shutdown(musb->xceiv);
2508 device_init_wakeup(dev, 0);
2514 static void musb_save_context(struct musb *musb)
2517 void __iomem *musb_base = musb->mregs;
2520 musb->context.frame = musb_readw(musb_base, MUSB_FRAME);
2521 musb->context.testmode = musb_readb(musb_base, MUSB_TESTMODE);
2522 musb->context.busctl = musb_read_ulpi_buscontrol(musb->mregs);
2523 musb->context.power = musb_readb(musb_base, MUSB_POWER);
2524 musb->context.intrusbe = musb_readb(musb_base, MUSB_INTRUSBE);
2525 musb->context.index = musb_readb(musb_base, MUSB_INDEX);
2526 musb->context.devctl = musb_readb(musb_base, MUSB_DEVCTL);
2528 for (i = 0; i < musb->config->num_eps; ++i) {
2529 struct musb_hw_ep *hw_ep;
2531 hw_ep = &musb->endpoints[i];
2539 musb_writeb(musb_base, MUSB_INDEX, i);
2540 musb->context.index_regs[i].txmaxp =
2541 musb_readw(epio, MUSB_TXMAXP);
2542 musb->context.index_regs[i].txcsr =
2543 musb_readw(epio, MUSB_TXCSR);
2544 musb->context.index_regs[i].rxmaxp =
2545 musb_readw(epio, MUSB_RXMAXP);
2546 musb->context.index_regs[i].rxcsr =
2547 musb_readw(epio, MUSB_RXCSR);
2549 if (musb->dyn_fifo) {
2550 musb->context.index_regs[i].txfifoadd =
2551 musb_read_txfifoadd(musb_base);
2552 musb->context.index_regs[i].rxfifoadd =
2553 musb_read_rxfifoadd(musb_base);
2554 musb->context.index_regs[i].txfifosz =
2555 musb_read_txfifosz(musb_base);
2556 musb->context.index_regs[i].rxfifosz =
2557 musb_read_rxfifosz(musb_base);
2560 musb->context.index_regs[i].txtype =
2561 musb_readb(epio, MUSB_TXTYPE);
2562 musb->context.index_regs[i].txinterval =
2563 musb_readb(epio, MUSB_TXINTERVAL);
2564 musb->context.index_regs[i].rxtype =
2565 musb_readb(epio, MUSB_RXTYPE);
2566 musb->context.index_regs[i].rxinterval =
2567 musb_readb(epio, MUSB_RXINTERVAL);
2569 musb->context.index_regs[i].txfunaddr =
2570 musb_read_txfunaddr(musb, i);
2571 musb->context.index_regs[i].txhubaddr =
2572 musb_read_txhubaddr(musb, i);
2573 musb->context.index_regs[i].txhubport =
2574 musb_read_txhubport(musb, i);
2576 musb->context.index_regs[i].rxfunaddr =
2577 musb_read_rxfunaddr(musb, i);
2578 musb->context.index_regs[i].rxhubaddr =
2579 musb_read_rxhubaddr(musb, i);
2580 musb->context.index_regs[i].rxhubport =
2581 musb_read_rxhubport(musb, i);
2585 static void musb_restore_context(struct musb *musb)
2588 void __iomem *musb_base = musb->mregs;
2592 musb_writew(musb_base, MUSB_FRAME, musb->context.frame);
2593 musb_writeb(musb_base, MUSB_TESTMODE, musb->context.testmode);
2594 musb_write_ulpi_buscontrol(musb->mregs, musb->context.busctl);
2596 /* Don't affect SUSPENDM/RESUME bits in POWER reg */
2597 power = musb_readb(musb_base, MUSB_POWER);
2598 power &= MUSB_POWER_SUSPENDM | MUSB_POWER_RESUME;
2599 musb->context.power &= ~(MUSB_POWER_SUSPENDM | MUSB_POWER_RESUME);
2600 power |= musb->context.power;
2601 musb_writeb(musb_base, MUSB_POWER, power);
2603 musb_writew(musb_base, MUSB_INTRTXE, musb->intrtxe);
2604 musb_writew(musb_base, MUSB_INTRRXE, musb->intrrxe);
2605 musb_writeb(musb_base, MUSB_INTRUSBE, musb->context.intrusbe);
2606 if (musb->context.devctl & MUSB_DEVCTL_SESSION)
2607 musb_writeb(musb_base, MUSB_DEVCTL, musb->context.devctl);
2609 for (i = 0; i < musb->config->num_eps; ++i) {
2610 struct musb_hw_ep *hw_ep;
2612 hw_ep = &musb->endpoints[i];
2620 musb_writeb(musb_base, MUSB_INDEX, i);
2621 musb_writew(epio, MUSB_TXMAXP,
2622 musb->context.index_regs[i].txmaxp);
2623 musb_writew(epio, MUSB_TXCSR,
2624 musb->context.index_regs[i].txcsr);
2625 musb_writew(epio, MUSB_RXMAXP,
2626 musb->context.index_regs[i].rxmaxp);
2627 musb_writew(epio, MUSB_RXCSR,
2628 musb->context.index_regs[i].rxcsr);
2630 if (musb->dyn_fifo) {
2631 musb_write_txfifosz(musb_base,
2632 musb->context.index_regs[i].txfifosz);
2633 musb_write_rxfifosz(musb_base,
2634 musb->context.index_regs[i].rxfifosz);
2635 musb_write_txfifoadd(musb_base,
2636 musb->context.index_regs[i].txfifoadd);
2637 musb_write_rxfifoadd(musb_base,
2638 musb->context.index_regs[i].rxfifoadd);
2641 musb_writeb(epio, MUSB_TXTYPE,
2642 musb->context.index_regs[i].txtype);
2643 musb_writeb(epio, MUSB_TXINTERVAL,
2644 musb->context.index_regs[i].txinterval);
2645 musb_writeb(epio, MUSB_RXTYPE,
2646 musb->context.index_regs[i].rxtype);
2647 musb_writeb(epio, MUSB_RXINTERVAL,
2649 musb->context.index_regs[i].rxinterval);
2650 musb_write_txfunaddr(musb, i,
2651 musb->context.index_regs[i].txfunaddr);
2652 musb_write_txhubaddr(musb, i,
2653 musb->context.index_regs[i].txhubaddr);
2654 musb_write_txhubport(musb, i,
2655 musb->context.index_regs[i].txhubport);
2657 musb_write_rxfunaddr(musb, i,
2658 musb->context.index_regs[i].rxfunaddr);
2659 musb_write_rxhubaddr(musb, i,
2660 musb->context.index_regs[i].rxhubaddr);
2661 musb_write_rxhubport(musb, i,
2662 musb->context.index_regs[i].rxhubport);
2664 musb_writeb(musb_base, MUSB_INDEX, musb->context.index);
2667 static int musb_suspend(struct device *dev)
2669 struct musb *musb = dev_to_musb(dev);
2670 unsigned long flags;
2672 musb_platform_disable(musb);
2673 musb_disable_interrupts(musb);
2674 if (!(musb->io.quirks & MUSB_PRESERVE_SESSION))
2675 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
2676 WARN_ON(!list_empty(&musb->pending_list));
2678 spin_lock_irqsave(&musb->lock, flags);
2680 if (is_peripheral_active(musb)) {
2681 /* FIXME force disconnect unless we know USB will wake
2682 * the system up quickly enough to respond ...
2684 } else if (is_host_active(musb)) {
2685 /* we know all the children are suspended; sometimes
2686 * they will even be wakeup-enabled.
2690 musb_save_context(musb);
2692 spin_unlock_irqrestore(&musb->lock, flags);
2696 static int musb_resume(struct device *dev)
2698 struct musb *musb = dev_to_musb(dev);
2699 unsigned long flags;
2705 * For static cmos like DaVinci, register values were preserved
2706 * unless for some reason the whole soc powered down or the USB
2707 * module got reset through the PSC (vs just being disabled).
2709 * For the DSPS glue layer though, a full register restore has to
2710 * be done. As it shouldn't harm other platforms, we do it
2714 musb_restore_context(musb);
2716 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
2717 mask = MUSB_DEVCTL_BDEVICE | MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV;
2718 if ((devctl & mask) != (musb->context.devctl & mask))
2719 musb->port1_status = 0;
2722 * The USB HUB code expects the device to be in RPM_ACTIVE once it came
2725 pm_runtime_disable(dev);
2726 pm_runtime_set_active(dev);
2727 pm_runtime_enable(dev);
2731 spin_lock_irqsave(&musb->lock, flags);
2732 error = musb_run_resume_work(musb);
2734 dev_err(musb->controller, "resume work failed with %i\n",
2736 spin_unlock_irqrestore(&musb->lock, flags);
2741 static int musb_runtime_suspend(struct device *dev)
2743 struct musb *musb = dev_to_musb(dev);
2745 musb_save_context(musb);
2746 musb->is_runtime_suspended = 1;
2751 static int musb_runtime_resume(struct device *dev)
2753 struct musb *musb = dev_to_musb(dev);
2754 unsigned long flags;
2758 * When pm_runtime_get_sync called for the first time in driver
2759 * init, some of the structure is still not initialized which is
2760 * used in restore function. But clock needs to be
2761 * enabled before any register access, so
2762 * pm_runtime_get_sync has to be called.
2763 * Also context restore without save does not make
2766 if (!musb->is_initialized)
2769 musb_restore_context(musb);
2771 spin_lock_irqsave(&musb->lock, flags);
2772 error = musb_run_resume_work(musb);
2774 dev_err(musb->controller, "resume work failed with %i\n",
2776 musb->is_runtime_suspended = 0;
2777 spin_unlock_irqrestore(&musb->lock, flags);
2782 static const struct dev_pm_ops musb_dev_pm_ops = {
2783 .suspend = musb_suspend,
2784 .resume = musb_resume,
2785 .runtime_suspend = musb_runtime_suspend,
2786 .runtime_resume = musb_runtime_resume,
2789 #define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2791 #define MUSB_DEV_PM_OPS NULL
2794 static struct platform_driver musb_driver = {
2796 .name = (char *)musb_driver_name,
2797 .bus = &platform_bus_type,
2798 .pm = MUSB_DEV_PM_OPS,
2800 .probe = musb_probe,
2801 .remove = musb_remove,
2804 module_platform_driver(musb_driver);