Merge 3.2-rc3 into usb-linus
[zen-stable.git] / drivers / usb / musb / musb_core.c
blob5495850867982370aa04854a040e96ea079f4785
1 /*
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
20 * 02110-1301 USA
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
66 * each direction.
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 informarion
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/init.h>
97 #include <linux/list.h>
98 #include <linux/kobject.h>
99 #include <linux/prefetch.h>
100 #include <linux/platform_device.h>
101 #include <linux/io.h>
103 #include "musb_core.h"
105 #define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
108 #define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
109 #define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
111 #define MUSB_VERSION "6.0"
113 #define DRIVER_INFO DRIVER_DESC ", v" MUSB_VERSION
115 #define MUSB_DRIVER_NAME "musb-hdrc"
116 const char musb_driver_name[] = MUSB_DRIVER_NAME;
118 MODULE_DESCRIPTION(DRIVER_INFO);
119 MODULE_AUTHOR(DRIVER_AUTHOR);
120 MODULE_LICENSE("GPL");
121 MODULE_ALIAS("platform:" MUSB_DRIVER_NAME);
124 /*-------------------------------------------------------------------------*/
126 static inline struct musb *dev_to_musb(struct device *dev)
128 return dev_get_drvdata(dev);
131 /*-------------------------------------------------------------------------*/
133 #ifndef CONFIG_BLACKFIN
134 static int musb_ulpi_read(struct otg_transceiver *otg, u32 offset)
136 void __iomem *addr = otg->io_priv;
137 int i = 0;
138 u8 r;
139 u8 power;
141 /* Make sure the transceiver is not in low power mode */
142 power = musb_readb(addr, MUSB_POWER);
143 power &= ~MUSB_POWER_SUSPENDM;
144 musb_writeb(addr, MUSB_POWER, power);
146 /* REVISIT: musbhdrc_ulpi_an.pdf recommends setting the
147 * ULPICarKitControlDisableUTMI after clearing POWER_SUSPENDM.
150 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
151 musb_writeb(addr, MUSB_ULPI_REG_CONTROL,
152 MUSB_ULPI_REG_REQ | MUSB_ULPI_RDN_WR);
154 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
155 & MUSB_ULPI_REG_CMPLT)) {
156 i++;
157 if (i == 10000)
158 return -ETIMEDOUT;
161 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
162 r &= ~MUSB_ULPI_REG_CMPLT;
163 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
165 return musb_readb(addr, MUSB_ULPI_REG_DATA);
168 static int musb_ulpi_write(struct otg_transceiver *otg,
169 u32 offset, u32 data)
171 void __iomem *addr = otg->io_priv;
172 int i = 0;
173 u8 r = 0;
174 u8 power;
176 /* Make sure the transceiver is not in low power mode */
177 power = musb_readb(addr, MUSB_POWER);
178 power &= ~MUSB_POWER_SUSPENDM;
179 musb_writeb(addr, MUSB_POWER, power);
181 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
182 musb_writeb(addr, MUSB_ULPI_REG_DATA, (u8)data);
183 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, MUSB_ULPI_REG_REQ);
185 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
186 & MUSB_ULPI_REG_CMPLT)) {
187 i++;
188 if (i == 10000)
189 return -ETIMEDOUT;
192 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
193 r &= ~MUSB_ULPI_REG_CMPLT;
194 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
196 return 0;
198 #else
199 #define musb_ulpi_read NULL
200 #define musb_ulpi_write NULL
201 #endif
203 static struct otg_io_access_ops musb_ulpi_access = {
204 .read = musb_ulpi_read,
205 .write = musb_ulpi_write,
208 /*-------------------------------------------------------------------------*/
210 #if !defined(CONFIG_USB_MUSB_TUSB6010) && !defined(CONFIG_USB_MUSB_BLACKFIN)
213 * Load an endpoint's FIFO
215 void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
217 struct musb *musb = hw_ep->musb;
218 void __iomem *fifo = hw_ep->fifo;
220 prefetch((u8 *)src);
222 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
223 'T', hw_ep->epnum, fifo, len, src);
225 /* we can't assume unaligned reads work */
226 if (likely((0x01 & (unsigned long) src) == 0)) {
227 u16 index = 0;
229 /* best case is 32bit-aligned source address */
230 if ((0x02 & (unsigned long) src) == 0) {
231 if (len >= 4) {
232 writesl(fifo, src + index, len >> 2);
233 index += len & ~0x03;
235 if (len & 0x02) {
236 musb_writew(fifo, 0, *(u16 *)&src[index]);
237 index += 2;
239 } else {
240 if (len >= 2) {
241 writesw(fifo, src + index, len >> 1);
242 index += len & ~0x01;
245 if (len & 0x01)
246 musb_writeb(fifo, 0, src[index]);
247 } else {
248 /* byte aligned */
249 writesb(fifo, src, len);
253 #if !defined(CONFIG_USB_MUSB_AM35X)
255 * Unload an endpoint's FIFO
257 void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
259 struct musb *musb = hw_ep->musb;
260 void __iomem *fifo = hw_ep->fifo;
262 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
263 'R', hw_ep->epnum, fifo, len, dst);
265 /* we can't assume unaligned writes work */
266 if (likely((0x01 & (unsigned long) dst) == 0)) {
267 u16 index = 0;
269 /* best case is 32bit-aligned destination address */
270 if ((0x02 & (unsigned long) dst) == 0) {
271 if (len >= 4) {
272 readsl(fifo, dst, len >> 2);
273 index = len & ~0x03;
275 if (len & 0x02) {
276 *(u16 *)&dst[index] = musb_readw(fifo, 0);
277 index += 2;
279 } else {
280 if (len >= 2) {
281 readsw(fifo, dst, len >> 1);
282 index = len & ~0x01;
285 if (len & 0x01)
286 dst[index] = musb_readb(fifo, 0);
287 } else {
288 /* byte aligned */
289 readsb(fifo, dst, len);
292 #endif
294 #endif /* normal PIO */
297 /*-------------------------------------------------------------------------*/
299 /* for high speed test mode; see USB 2.0 spec 7.1.20 */
300 static const u8 musb_test_packet[53] = {
301 /* implicit SYNC then DATA0 to start */
303 /* JKJKJKJK x9 */
304 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
305 /* JJKKJJKK x8 */
306 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
307 /* JJJJKKKK x8 */
308 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
309 /* JJJJJJJKKKKKKK x8 */
310 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
311 /* JJJJJJJK x8 */
312 0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
313 /* JKKKKKKK x10, JK */
314 0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
316 /* implicit CRC16 then EOP to end */
319 void musb_load_testpacket(struct musb *musb)
321 void __iomem *regs = musb->endpoints[0].regs;
323 musb_ep_select(musb->mregs, 0);
324 musb_write_fifo(musb->control_ep,
325 sizeof(musb_test_packet), musb_test_packet);
326 musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
329 /*-------------------------------------------------------------------------*/
332 * Handles OTG hnp timeouts, such as b_ase0_brst
334 void musb_otg_timer_func(unsigned long data)
336 struct musb *musb = (struct musb *)data;
337 unsigned long flags;
339 spin_lock_irqsave(&musb->lock, flags);
340 switch (musb->xceiv->state) {
341 case OTG_STATE_B_WAIT_ACON:
342 dev_dbg(musb->controller, "HNP: b_wait_acon timeout; back to b_peripheral\n");
343 musb_g_disconnect(musb);
344 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
345 musb->is_active = 0;
346 break;
347 case OTG_STATE_A_SUSPEND:
348 case OTG_STATE_A_WAIT_BCON:
349 dev_dbg(musb->controller, "HNP: %s timeout\n",
350 otg_state_string(musb->xceiv->state));
351 musb_platform_set_vbus(musb, 0);
352 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
353 break;
354 default:
355 dev_dbg(musb->controller, "HNP: Unhandled mode %s\n",
356 otg_state_string(musb->xceiv->state));
358 musb->ignore_disconnect = 0;
359 spin_unlock_irqrestore(&musb->lock, flags);
363 * Stops the HNP transition. Caller must take care of locking.
365 void musb_hnp_stop(struct musb *musb)
367 struct usb_hcd *hcd = musb_to_hcd(musb);
368 void __iomem *mbase = musb->mregs;
369 u8 reg;
371 dev_dbg(musb->controller, "HNP: stop from %s\n", otg_state_string(musb->xceiv->state));
373 switch (musb->xceiv->state) {
374 case OTG_STATE_A_PERIPHERAL:
375 musb_g_disconnect(musb);
376 dev_dbg(musb->controller, "HNP: back to %s\n",
377 otg_state_string(musb->xceiv->state));
378 break;
379 case OTG_STATE_B_HOST:
380 dev_dbg(musb->controller, "HNP: Disabling HR\n");
381 hcd->self.is_b_host = 0;
382 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
383 MUSB_DEV_MODE(musb);
384 reg = musb_readb(mbase, MUSB_POWER);
385 reg |= MUSB_POWER_SUSPENDM;
386 musb_writeb(mbase, MUSB_POWER, reg);
387 /* REVISIT: Start SESSION_REQUEST here? */
388 break;
389 default:
390 dev_dbg(musb->controller, "HNP: Stopping in unknown state %s\n",
391 otg_state_string(musb->xceiv->state));
395 * When returning to A state after HNP, avoid hub_port_rebounce(),
396 * which cause occasional OPT A "Did not receive reset after connect"
397 * errors.
399 musb->port1_status &= ~(USB_PORT_STAT_C_CONNECTION << 16);
403 * Interrupt Service Routine to record USB "global" interrupts.
404 * Since these do not happen often and signify things of
405 * paramount importance, it seems OK to check them individually;
406 * the order of the tests is specified in the manual
408 * @param musb instance pointer
409 * @param int_usb register contents
410 * @param devctl
411 * @param power
414 static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
415 u8 devctl, u8 power)
417 irqreturn_t handled = IRQ_NONE;
419 dev_dbg(musb->controller, "<== Power=%02x, DevCtl=%02x, int_usb=0x%x\n", power, devctl,
420 int_usb);
422 /* in host mode, the peripheral may issue remote wakeup.
423 * in peripheral mode, the host may resume the link.
424 * spurious RESUME irqs happen too, paired with SUSPEND.
426 if (int_usb & MUSB_INTR_RESUME) {
427 handled = IRQ_HANDLED;
428 dev_dbg(musb->controller, "RESUME (%s)\n", otg_state_string(musb->xceiv->state));
430 if (devctl & MUSB_DEVCTL_HM) {
431 void __iomem *mbase = musb->mregs;
433 switch (musb->xceiv->state) {
434 case OTG_STATE_A_SUSPEND:
435 /* remote wakeup? later, GetPortStatus
436 * will stop RESUME signaling
439 if (power & MUSB_POWER_SUSPENDM) {
440 /* spurious */
441 musb->int_usb &= ~MUSB_INTR_SUSPEND;
442 dev_dbg(musb->controller, "Spurious SUSPENDM\n");
443 break;
446 power &= ~MUSB_POWER_SUSPENDM;
447 musb_writeb(mbase, MUSB_POWER,
448 power | MUSB_POWER_RESUME);
450 musb->port1_status |=
451 (USB_PORT_STAT_C_SUSPEND << 16)
452 | MUSB_PORT_STAT_RESUME;
453 musb->rh_timer = jiffies
454 + msecs_to_jiffies(20);
456 musb->xceiv->state = OTG_STATE_A_HOST;
457 musb->is_active = 1;
458 usb_hcd_resume_root_hub(musb_to_hcd(musb));
459 break;
460 case OTG_STATE_B_WAIT_ACON:
461 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
462 musb->is_active = 1;
463 MUSB_DEV_MODE(musb);
464 break;
465 default:
466 WARNING("bogus %s RESUME (%s)\n",
467 "host",
468 otg_state_string(musb->xceiv->state));
470 } else {
471 switch (musb->xceiv->state) {
472 case OTG_STATE_A_SUSPEND:
473 /* possibly DISCONNECT is upcoming */
474 musb->xceiv->state = OTG_STATE_A_HOST;
475 usb_hcd_resume_root_hub(musb_to_hcd(musb));
476 break;
477 case OTG_STATE_B_WAIT_ACON:
478 case OTG_STATE_B_PERIPHERAL:
479 /* disconnect while suspended? we may
480 * not get a disconnect irq...
482 if ((devctl & MUSB_DEVCTL_VBUS)
483 != (3 << MUSB_DEVCTL_VBUS_SHIFT)
485 musb->int_usb |= MUSB_INTR_DISCONNECT;
486 musb->int_usb &= ~MUSB_INTR_SUSPEND;
487 break;
489 musb_g_resume(musb);
490 break;
491 case OTG_STATE_B_IDLE:
492 musb->int_usb &= ~MUSB_INTR_SUSPEND;
493 break;
494 default:
495 WARNING("bogus %s RESUME (%s)\n",
496 "peripheral",
497 otg_state_string(musb->xceiv->state));
502 /* see manual for the order of the tests */
503 if (int_usb & MUSB_INTR_SESSREQ) {
504 void __iomem *mbase = musb->mregs;
506 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS
507 && (devctl & MUSB_DEVCTL_BDEVICE)) {
508 dev_dbg(musb->controller, "SessReq while on B state\n");
509 return IRQ_HANDLED;
512 dev_dbg(musb->controller, "SESSION_REQUEST (%s)\n",
513 otg_state_string(musb->xceiv->state));
515 /* IRQ arrives from ID pin sense or (later, if VBUS power
516 * is removed) SRP. responses are time critical:
517 * - turn on VBUS (with silicon-specific mechanism)
518 * - go through A_WAIT_VRISE
519 * - ... to A_WAIT_BCON.
520 * a_wait_vrise_tmout triggers VBUS_ERROR transitions
522 musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
523 musb->ep0_stage = MUSB_EP0_START;
524 musb->xceiv->state = OTG_STATE_A_IDLE;
525 MUSB_HST_MODE(musb);
526 musb_platform_set_vbus(musb, 1);
528 handled = IRQ_HANDLED;
531 if (int_usb & MUSB_INTR_VBUSERROR) {
532 int ignore = 0;
534 /* During connection as an A-Device, we may see a short
535 * current spikes causing voltage drop, because of cable
536 * and peripheral capacitance combined with vbus draw.
537 * (So: less common with truly self-powered devices, where
538 * vbus doesn't act like a power supply.)
540 * Such spikes are short; usually less than ~500 usec, max
541 * of ~2 msec. That is, they're not sustained overcurrent
542 * errors, though they're reported using VBUSERROR irqs.
544 * Workarounds: (a) hardware: use self powered devices.
545 * (b) software: ignore non-repeated VBUS errors.
547 * REVISIT: do delays from lots of DEBUG_KERNEL checks
548 * make trouble here, keeping VBUS < 4.4V ?
550 switch (musb->xceiv->state) {
551 case OTG_STATE_A_HOST:
552 /* recovery is dicey once we've gotten past the
553 * initial stages of enumeration, but if VBUS
554 * stayed ok at the other end of the link, and
555 * another reset is due (at least for high speed,
556 * to redo the chirp etc), it might work OK...
558 case OTG_STATE_A_WAIT_BCON:
559 case OTG_STATE_A_WAIT_VRISE:
560 if (musb->vbuserr_retry) {
561 void __iomem *mbase = musb->mregs;
563 musb->vbuserr_retry--;
564 ignore = 1;
565 devctl |= MUSB_DEVCTL_SESSION;
566 musb_writeb(mbase, MUSB_DEVCTL, devctl);
567 } else {
568 musb->port1_status |=
569 USB_PORT_STAT_OVERCURRENT
570 | (USB_PORT_STAT_C_OVERCURRENT << 16);
572 break;
573 default:
574 break;
577 dev_dbg(musb->controller, "VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
578 otg_state_string(musb->xceiv->state),
579 devctl,
580 ({ char *s;
581 switch (devctl & MUSB_DEVCTL_VBUS) {
582 case 0 << MUSB_DEVCTL_VBUS_SHIFT:
583 s = "<SessEnd"; break;
584 case 1 << MUSB_DEVCTL_VBUS_SHIFT:
585 s = "<AValid"; break;
586 case 2 << MUSB_DEVCTL_VBUS_SHIFT:
587 s = "<VBusValid"; break;
588 /* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
589 default:
590 s = "VALID"; break;
591 }; s; }),
592 VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
593 musb->port1_status);
595 /* go through A_WAIT_VFALL then start a new session */
596 if (!ignore)
597 musb_platform_set_vbus(musb, 0);
598 handled = IRQ_HANDLED;
601 if (int_usb & MUSB_INTR_SUSPEND) {
602 dev_dbg(musb->controller, "SUSPEND (%s) devctl %02x power %02x\n",
603 otg_state_string(musb->xceiv->state), devctl, power);
604 handled = IRQ_HANDLED;
606 switch (musb->xceiv->state) {
607 case OTG_STATE_A_PERIPHERAL:
608 /* We also come here if the cable is removed, since
609 * this silicon doesn't report ID-no-longer-grounded.
611 * We depend on T(a_wait_bcon) to shut us down, and
612 * hope users don't do anything dicey during this
613 * undesired detour through A_WAIT_BCON.
615 musb_hnp_stop(musb);
616 usb_hcd_resume_root_hub(musb_to_hcd(musb));
617 musb_root_disconnect(musb);
618 musb_platform_try_idle(musb, jiffies
619 + msecs_to_jiffies(musb->a_wait_bcon
620 ? : OTG_TIME_A_WAIT_BCON));
622 break;
623 case OTG_STATE_B_IDLE:
624 if (!musb->is_active)
625 break;
626 case OTG_STATE_B_PERIPHERAL:
627 musb_g_suspend(musb);
628 musb->is_active = is_otg_enabled(musb)
629 && musb->xceiv->gadget->b_hnp_enable;
630 if (musb->is_active) {
631 musb->xceiv->state = OTG_STATE_B_WAIT_ACON;
632 dev_dbg(musb->controller, "HNP: Setting timer for b_ase0_brst\n");
633 mod_timer(&musb->otg_timer, jiffies
634 + msecs_to_jiffies(
635 OTG_TIME_B_ASE0_BRST));
637 break;
638 case OTG_STATE_A_WAIT_BCON:
639 if (musb->a_wait_bcon != 0)
640 musb_platform_try_idle(musb, jiffies
641 + msecs_to_jiffies(musb->a_wait_bcon));
642 break;
643 case OTG_STATE_A_HOST:
644 musb->xceiv->state = OTG_STATE_A_SUSPEND;
645 musb->is_active = is_otg_enabled(musb)
646 && musb->xceiv->host->b_hnp_enable;
647 break;
648 case OTG_STATE_B_HOST:
649 /* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
650 dev_dbg(musb->controller, "REVISIT: SUSPEND as B_HOST\n");
651 break;
652 default:
653 /* "should not happen" */
654 musb->is_active = 0;
655 break;
659 if (int_usb & MUSB_INTR_CONNECT) {
660 struct usb_hcd *hcd = musb_to_hcd(musb);
662 handled = IRQ_HANDLED;
663 musb->is_active = 1;
665 musb->ep0_stage = MUSB_EP0_START;
667 /* flush endpoints when transitioning from Device Mode */
668 if (is_peripheral_active(musb)) {
669 /* REVISIT HNP; just force disconnect */
671 musb_writew(musb->mregs, MUSB_INTRTXE, musb->epmask);
672 musb_writew(musb->mregs, MUSB_INTRRXE, musb->epmask & 0xfffe);
673 musb_writeb(musb->mregs, MUSB_INTRUSBE, 0xf7);
674 musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
675 |USB_PORT_STAT_HIGH_SPEED
676 |USB_PORT_STAT_ENABLE
678 musb->port1_status |= USB_PORT_STAT_CONNECTION
679 |(USB_PORT_STAT_C_CONNECTION << 16);
681 /* high vs full speed is just a guess until after reset */
682 if (devctl & MUSB_DEVCTL_LSDEV)
683 musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
685 /* indicate new connection to OTG machine */
686 switch (musb->xceiv->state) {
687 case OTG_STATE_B_PERIPHERAL:
688 if (int_usb & MUSB_INTR_SUSPEND) {
689 dev_dbg(musb->controller, "HNP: SUSPEND+CONNECT, now b_host\n");
690 int_usb &= ~MUSB_INTR_SUSPEND;
691 goto b_host;
692 } else
693 dev_dbg(musb->controller, "CONNECT as b_peripheral???\n");
694 break;
695 case OTG_STATE_B_WAIT_ACON:
696 dev_dbg(musb->controller, "HNP: CONNECT, now b_host\n");
697 b_host:
698 musb->xceiv->state = OTG_STATE_B_HOST;
699 hcd->self.is_b_host = 1;
700 musb->ignore_disconnect = 0;
701 del_timer(&musb->otg_timer);
702 break;
703 default:
704 if ((devctl & MUSB_DEVCTL_VBUS)
705 == (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
706 musb->xceiv->state = OTG_STATE_A_HOST;
707 hcd->self.is_b_host = 0;
709 break;
712 /* poke the root hub */
713 MUSB_HST_MODE(musb);
714 if (hcd->status_urb)
715 usb_hcd_poll_rh_status(hcd);
716 else
717 usb_hcd_resume_root_hub(hcd);
719 dev_dbg(musb->controller, "CONNECT (%s) devctl %02x\n",
720 otg_state_string(musb->xceiv->state), devctl);
723 if ((int_usb & MUSB_INTR_DISCONNECT) && !musb->ignore_disconnect) {
724 dev_dbg(musb->controller, "DISCONNECT (%s) as %s, devctl %02x\n",
725 otg_state_string(musb->xceiv->state),
726 MUSB_MODE(musb), devctl);
727 handled = IRQ_HANDLED;
729 switch (musb->xceiv->state) {
730 case OTG_STATE_A_HOST:
731 case OTG_STATE_A_SUSPEND:
732 usb_hcd_resume_root_hub(musb_to_hcd(musb));
733 musb_root_disconnect(musb);
734 if (musb->a_wait_bcon != 0 && is_otg_enabled(musb))
735 musb_platform_try_idle(musb, jiffies
736 + msecs_to_jiffies(musb->a_wait_bcon));
737 break;
738 case OTG_STATE_B_HOST:
739 /* REVISIT this behaves for "real disconnect"
740 * cases; make sure the other transitions from
741 * from B_HOST act right too. The B_HOST code
742 * in hnp_stop() is currently not used...
744 musb_root_disconnect(musb);
745 musb_to_hcd(musb)->self.is_b_host = 0;
746 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
747 MUSB_DEV_MODE(musb);
748 musb_g_disconnect(musb);
749 break;
750 case OTG_STATE_A_PERIPHERAL:
751 musb_hnp_stop(musb);
752 musb_root_disconnect(musb);
753 /* FALLTHROUGH */
754 case OTG_STATE_B_WAIT_ACON:
755 /* FALLTHROUGH */
756 case OTG_STATE_B_PERIPHERAL:
757 case OTG_STATE_B_IDLE:
758 musb_g_disconnect(musb);
759 break;
760 default:
761 WARNING("unhandled DISCONNECT transition (%s)\n",
762 otg_state_string(musb->xceiv->state));
763 break;
767 /* mentor saves a bit: bus reset and babble share the same irq.
768 * only host sees babble; only peripheral sees bus reset.
770 if (int_usb & MUSB_INTR_RESET) {
771 handled = IRQ_HANDLED;
772 if (is_host_capable() && (devctl & MUSB_DEVCTL_HM) != 0) {
774 * Looks like non-HS BABBLE can be ignored, but
775 * HS BABBLE is an error condition. For HS the solution
776 * is to avoid babble in the first place and fix what
777 * caused BABBLE. When HS BABBLE happens we can only
778 * stop the session.
780 if (devctl & (MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV))
781 dev_dbg(musb->controller, "BABBLE devctl: %02x\n", devctl);
782 else {
783 ERR("Stopping host session -- babble\n");
784 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
786 } else if (is_peripheral_capable()) {
787 dev_dbg(musb->controller, "BUS RESET as %s\n",
788 otg_state_string(musb->xceiv->state));
789 switch (musb->xceiv->state) {
790 case OTG_STATE_A_SUSPEND:
791 /* We need to ignore disconnect on suspend
792 * otherwise tusb 2.0 won't reconnect after a
793 * power cycle, which breaks otg compliance.
795 musb->ignore_disconnect = 1;
796 musb_g_reset(musb);
797 /* FALLTHROUGH */
798 case OTG_STATE_A_WAIT_BCON: /* OPT TD.4.7-900ms */
799 /* never use invalid T(a_wait_bcon) */
800 dev_dbg(musb->controller, "HNP: in %s, %d msec timeout\n",
801 otg_state_string(musb->xceiv->state),
802 TA_WAIT_BCON(musb));
803 mod_timer(&musb->otg_timer, jiffies
804 + msecs_to_jiffies(TA_WAIT_BCON(musb)));
805 break;
806 case OTG_STATE_A_PERIPHERAL:
807 musb->ignore_disconnect = 0;
808 del_timer(&musb->otg_timer);
809 musb_g_reset(musb);
810 break;
811 case OTG_STATE_B_WAIT_ACON:
812 dev_dbg(musb->controller, "HNP: RESET (%s), to b_peripheral\n",
813 otg_state_string(musb->xceiv->state));
814 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
815 musb_g_reset(musb);
816 break;
817 case OTG_STATE_B_IDLE:
818 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
819 /* FALLTHROUGH */
820 case OTG_STATE_B_PERIPHERAL:
821 musb_g_reset(musb);
822 break;
823 default:
824 dev_dbg(musb->controller, "Unhandled BUS RESET as %s\n",
825 otg_state_string(musb->xceiv->state));
830 #if 0
831 /* REVISIT ... this would be for multiplexing periodic endpoints, or
832 * supporting transfer phasing to prevent exceeding ISO bandwidth
833 * limits of a given frame or microframe.
835 * It's not needed for peripheral side, which dedicates endpoints;
836 * though it _might_ use SOF irqs for other purposes.
838 * And it's not currently needed for host side, which also dedicates
839 * endpoints, relies on TX/RX interval registers, and isn't claimed
840 * to support ISO transfers yet.
842 if (int_usb & MUSB_INTR_SOF) {
843 void __iomem *mbase = musb->mregs;
844 struct musb_hw_ep *ep;
845 u8 epnum;
846 u16 frame;
848 dev_dbg(musb->controller, "START_OF_FRAME\n");
849 handled = IRQ_HANDLED;
851 /* start any periodic Tx transfers waiting for current frame */
852 frame = musb_readw(mbase, MUSB_FRAME);
853 ep = musb->endpoints;
854 for (epnum = 1; (epnum < musb->nr_endpoints)
855 && (musb->epmask >= (1 << epnum));
856 epnum++, ep++) {
858 * FIXME handle framecounter wraps (12 bits)
859 * eliminate duplicated StartUrb logic
861 if (ep->dwWaitFrame >= frame) {
862 ep->dwWaitFrame = 0;
863 pr_debug("SOF --> periodic TX%s on %d\n",
864 ep->tx_channel ? " DMA" : "",
865 epnum);
866 if (!ep->tx_channel)
867 musb_h_tx_start(musb, epnum);
868 else
869 cppi_hostdma_start(musb, epnum);
871 } /* end of for loop */
873 #endif
875 schedule_work(&musb->irq_work);
877 return handled;
880 /*-------------------------------------------------------------------------*/
883 * Program the HDRC to start (enable interrupts, dma, etc.).
885 void musb_start(struct musb *musb)
887 void __iomem *regs = musb->mregs;
888 u8 devctl = musb_readb(regs, MUSB_DEVCTL);
890 dev_dbg(musb->controller, "<== devctl %02x\n", devctl);
892 /* Set INT enable registers, enable interrupts */
893 musb_writew(regs, MUSB_INTRTXE, musb->epmask);
894 musb_writew(regs, MUSB_INTRRXE, musb->epmask & 0xfffe);
895 musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
897 musb_writeb(regs, MUSB_TESTMODE, 0);
899 /* put into basic highspeed mode and start session */
900 musb_writeb(regs, MUSB_POWER, MUSB_POWER_ISOUPDATE
901 | MUSB_POWER_HSENAB
902 /* ENSUSPEND wedges tusb */
903 /* | MUSB_POWER_ENSUSPEND */
906 musb->is_active = 0;
907 devctl = musb_readb(regs, MUSB_DEVCTL);
908 devctl &= ~MUSB_DEVCTL_SESSION;
910 if (is_otg_enabled(musb)) {
911 /* session started after:
912 * (a) ID-grounded irq, host mode;
913 * (b) vbus present/connect IRQ, peripheral mode;
914 * (c) peripheral initiates, using SRP
916 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
917 musb->is_active = 1;
918 else
919 devctl |= MUSB_DEVCTL_SESSION;
921 } else if (is_host_enabled(musb)) {
922 /* assume ID pin is hard-wired to ground */
923 devctl |= MUSB_DEVCTL_SESSION;
925 } else /* peripheral is enabled */ {
926 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
927 musb->is_active = 1;
929 musb_platform_enable(musb);
930 musb_writeb(regs, MUSB_DEVCTL, devctl);
934 static void musb_generic_disable(struct musb *musb)
936 void __iomem *mbase = musb->mregs;
937 u16 temp;
939 /* disable interrupts */
940 musb_writeb(mbase, MUSB_INTRUSBE, 0);
941 musb_writew(mbase, MUSB_INTRTXE, 0);
942 musb_writew(mbase, MUSB_INTRRXE, 0);
944 /* off */
945 musb_writeb(mbase, MUSB_DEVCTL, 0);
947 /* flush pending interrupts */
948 temp = musb_readb(mbase, MUSB_INTRUSB);
949 temp = musb_readw(mbase, MUSB_INTRTX);
950 temp = musb_readw(mbase, MUSB_INTRRX);
955 * Make the HDRC stop (disable interrupts, etc.);
956 * reversible by musb_start
957 * called on gadget driver unregister
958 * with controller locked, irqs blocked
959 * acts as a NOP unless some role activated the hardware
961 void musb_stop(struct musb *musb)
963 /* stop IRQs, timers, ... */
964 musb_platform_disable(musb);
965 musb_generic_disable(musb);
966 dev_dbg(musb->controller, "HDRC disabled\n");
968 /* FIXME
969 * - mark host and/or peripheral drivers unusable/inactive
970 * - disable DMA (and enable it in HdrcStart)
971 * - make sure we can musb_start() after musb_stop(); with
972 * OTG mode, gadget driver module rmmod/modprobe cycles that
973 * - ...
975 musb_platform_try_idle(musb, 0);
978 static void musb_shutdown(struct platform_device *pdev)
980 struct musb *musb = dev_to_musb(&pdev->dev);
981 unsigned long flags;
983 pm_runtime_get_sync(musb->controller);
984 spin_lock_irqsave(&musb->lock, flags);
985 musb_platform_disable(musb);
986 musb_generic_disable(musb);
987 spin_unlock_irqrestore(&musb->lock, flags);
989 if (!is_otg_enabled(musb) && is_host_enabled(musb))
990 usb_remove_hcd(musb_to_hcd(musb));
991 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
992 musb_platform_exit(musb);
994 pm_runtime_put(musb->controller);
995 /* FIXME power down */
999 /*-------------------------------------------------------------------------*/
1002 * The silicon either has hard-wired endpoint configurations, or else
1003 * "dynamic fifo" sizing. The driver has support for both, though at this
1004 * writing only the dynamic sizing is very well tested. Since we switched
1005 * away from compile-time hardware parameters, we can no longer rely on
1006 * dead code elimination to leave only the relevant one in the object file.
1008 * We don't currently use dynamic fifo setup capability to do anything
1009 * more than selecting one of a bunch of predefined configurations.
1011 #if defined(CONFIG_USB_MUSB_TUSB6010) \
1012 || defined(CONFIG_USB_MUSB_TUSB6010_MODULE) \
1013 || defined(CONFIG_USB_MUSB_OMAP2PLUS) \
1014 || defined(CONFIG_USB_MUSB_OMAP2PLUS_MODULE) \
1015 || defined(CONFIG_USB_MUSB_AM35X) \
1016 || defined(CONFIG_USB_MUSB_AM35X_MODULE)
1017 static ushort __initdata fifo_mode = 4;
1018 #elif defined(CONFIG_USB_MUSB_UX500) \
1019 || defined(CONFIG_USB_MUSB_UX500_MODULE)
1020 static ushort __initdata fifo_mode = 5;
1021 #else
1022 static ushort __initdata fifo_mode = 2;
1023 #endif
1025 /* "modprobe ... fifo_mode=1" etc */
1026 module_param(fifo_mode, ushort, 0);
1027 MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
1030 * tables defining fifo_mode values. define more if you like.
1031 * for host side, make sure both halves of ep1 are set up.
1034 /* mode 0 - fits in 2KB */
1035 static struct musb_fifo_cfg __initdata mode_0_cfg[] = {
1036 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1037 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1038 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1039 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1040 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1043 /* mode 1 - fits in 4KB */
1044 static struct musb_fifo_cfg __initdata mode_1_cfg[] = {
1045 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1046 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1047 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1048 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1049 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1052 /* mode 2 - fits in 4KB */
1053 static struct musb_fifo_cfg __initdata mode_2_cfg[] = {
1054 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1055 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1056 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1057 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1058 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1059 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1062 /* mode 3 - fits in 4KB */
1063 static struct musb_fifo_cfg __initdata mode_3_cfg[] = {
1064 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1065 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1066 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1067 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1068 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1069 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1072 /* mode 4 - fits in 16KB */
1073 static struct musb_fifo_cfg __initdata mode_4_cfg[] = {
1074 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1075 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1076 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1077 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1078 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1079 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1080 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1081 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1082 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1083 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1084 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 512, },
1085 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 512, },
1086 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 512, },
1087 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 512, },
1088 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 512, },
1089 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 512, },
1090 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 512, },
1091 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 512, },
1092 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 256, },
1093 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 64, },
1094 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 256, },
1095 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 64, },
1096 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 256, },
1097 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 64, },
1098 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1099 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1100 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1103 /* mode 5 - fits in 8KB */
1104 static struct musb_fifo_cfg __initdata mode_5_cfg[] = {
1105 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1106 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1107 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1108 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1109 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1110 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1111 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1112 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1113 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1114 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1115 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 32, },
1116 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 32, },
1117 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 32, },
1118 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 32, },
1119 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 32, },
1120 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 32, },
1121 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 32, },
1122 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 32, },
1123 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 32, },
1124 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 32, },
1125 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 32, },
1126 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 32, },
1127 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 32, },
1128 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 32, },
1129 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1130 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1131 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1135 * configure a fifo; for non-shared endpoints, this may be called
1136 * once for a tx fifo and once for an rx fifo.
1138 * returns negative errno or offset for next fifo.
1140 static int __init
1141 fifo_setup(struct musb *musb, struct musb_hw_ep *hw_ep,
1142 const struct musb_fifo_cfg *cfg, u16 offset)
1144 void __iomem *mbase = musb->mregs;
1145 int size = 0;
1146 u16 maxpacket = cfg->maxpacket;
1147 u16 c_off = offset >> 3;
1148 u8 c_size;
1150 /* expect hw_ep has already been zero-initialized */
1152 size = ffs(max(maxpacket, (u16) 8)) - 1;
1153 maxpacket = 1 << size;
1155 c_size = size - 3;
1156 if (cfg->mode == BUF_DOUBLE) {
1157 if ((offset + (maxpacket << 1)) >
1158 (1 << (musb->config->ram_bits + 2)))
1159 return -EMSGSIZE;
1160 c_size |= MUSB_FIFOSZ_DPB;
1161 } else {
1162 if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1163 return -EMSGSIZE;
1166 /* configure the FIFO */
1167 musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1169 /* EP0 reserved endpoint for control, bidirectional;
1170 * EP1 reserved for bulk, two unidirection halves.
1172 if (hw_ep->epnum == 1)
1173 musb->bulk_ep = hw_ep;
1174 /* REVISIT error check: be sure ep0 can both rx and tx ... */
1175 switch (cfg->style) {
1176 case FIFO_TX:
1177 musb_write_txfifosz(mbase, c_size);
1178 musb_write_txfifoadd(mbase, c_off);
1179 hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1180 hw_ep->max_packet_sz_tx = maxpacket;
1181 break;
1182 case FIFO_RX:
1183 musb_write_rxfifosz(mbase, c_size);
1184 musb_write_rxfifoadd(mbase, c_off);
1185 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1186 hw_ep->max_packet_sz_rx = maxpacket;
1187 break;
1188 case FIFO_RXTX:
1189 musb_write_txfifosz(mbase, c_size);
1190 musb_write_txfifoadd(mbase, c_off);
1191 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1192 hw_ep->max_packet_sz_rx = maxpacket;
1194 musb_write_rxfifosz(mbase, c_size);
1195 musb_write_rxfifoadd(mbase, c_off);
1196 hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1197 hw_ep->max_packet_sz_tx = maxpacket;
1199 hw_ep->is_shared_fifo = true;
1200 break;
1203 /* NOTE rx and tx endpoint irqs aren't managed separately,
1204 * which happens to be ok
1206 musb->epmask |= (1 << hw_ep->epnum);
1208 return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1211 static struct musb_fifo_cfg __initdata ep0_cfg = {
1212 .style = FIFO_RXTX, .maxpacket = 64,
1215 static int __init ep_config_from_table(struct musb *musb)
1217 const struct musb_fifo_cfg *cfg;
1218 unsigned i, n;
1219 int offset;
1220 struct musb_hw_ep *hw_ep = musb->endpoints;
1222 if (musb->config->fifo_cfg) {
1223 cfg = musb->config->fifo_cfg;
1224 n = musb->config->fifo_cfg_size;
1225 goto done;
1228 switch (fifo_mode) {
1229 default:
1230 fifo_mode = 0;
1231 /* FALLTHROUGH */
1232 case 0:
1233 cfg = mode_0_cfg;
1234 n = ARRAY_SIZE(mode_0_cfg);
1235 break;
1236 case 1:
1237 cfg = mode_1_cfg;
1238 n = ARRAY_SIZE(mode_1_cfg);
1239 break;
1240 case 2:
1241 cfg = mode_2_cfg;
1242 n = ARRAY_SIZE(mode_2_cfg);
1243 break;
1244 case 3:
1245 cfg = mode_3_cfg;
1246 n = ARRAY_SIZE(mode_3_cfg);
1247 break;
1248 case 4:
1249 cfg = mode_4_cfg;
1250 n = ARRAY_SIZE(mode_4_cfg);
1251 break;
1252 case 5:
1253 cfg = mode_5_cfg;
1254 n = ARRAY_SIZE(mode_5_cfg);
1255 break;
1258 printk(KERN_DEBUG "%s: setup fifo_mode %d\n",
1259 musb_driver_name, fifo_mode);
1262 done:
1263 offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1264 /* assert(offset > 0) */
1266 /* NOTE: for RTL versions >= 1.400 EPINFO and RAMINFO would
1267 * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1270 for (i = 0; i < n; i++) {
1271 u8 epn = cfg->hw_ep_num;
1273 if (epn >= musb->config->num_eps) {
1274 pr_debug("%s: invalid ep %d\n",
1275 musb_driver_name, epn);
1276 return -EINVAL;
1278 offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1279 if (offset < 0) {
1280 pr_debug("%s: mem overrun, ep %d\n",
1281 musb_driver_name, epn);
1282 return -EINVAL;
1284 epn++;
1285 musb->nr_endpoints = max(epn, musb->nr_endpoints);
1288 printk(KERN_DEBUG "%s: %d/%d max ep, %d/%d memory\n",
1289 musb_driver_name,
1290 n + 1, musb->config->num_eps * 2 - 1,
1291 offset, (1 << (musb->config->ram_bits + 2)));
1293 if (!musb->bulk_ep) {
1294 pr_debug("%s: missing bulk\n", musb_driver_name);
1295 return -EINVAL;
1298 return 0;
1303 * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1304 * @param musb the controller
1306 static int __init ep_config_from_hw(struct musb *musb)
1308 u8 epnum = 0;
1309 struct musb_hw_ep *hw_ep;
1310 void *mbase = musb->mregs;
1311 int ret = 0;
1313 dev_dbg(musb->controller, "<== static silicon ep config\n");
1315 /* FIXME pick up ep0 maxpacket size */
1317 for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1318 musb_ep_select(mbase, epnum);
1319 hw_ep = musb->endpoints + epnum;
1321 ret = musb_read_fifosize(musb, hw_ep, epnum);
1322 if (ret < 0)
1323 break;
1325 /* FIXME set up hw_ep->{rx,tx}_double_buffered */
1327 /* pick an RX/TX endpoint for bulk */
1328 if (hw_ep->max_packet_sz_tx < 512
1329 || hw_ep->max_packet_sz_rx < 512)
1330 continue;
1332 /* REVISIT: this algorithm is lazy, we should at least
1333 * try to pick a double buffered endpoint.
1335 if (musb->bulk_ep)
1336 continue;
1337 musb->bulk_ep = hw_ep;
1340 if (!musb->bulk_ep) {
1341 pr_debug("%s: missing bulk\n", musb_driver_name);
1342 return -EINVAL;
1345 return 0;
1348 enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1350 /* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1351 * configure endpoints, or take their config from silicon
1353 static int __init musb_core_init(u16 musb_type, struct musb *musb)
1355 u8 reg;
1356 char *type;
1357 char aInfo[90], aRevision[32], aDate[12];
1358 void __iomem *mbase = musb->mregs;
1359 int status = 0;
1360 int i;
1362 /* log core options (read using indexed model) */
1363 reg = musb_read_configdata(mbase);
1365 strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1366 if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1367 strcat(aInfo, ", dyn FIFOs");
1368 musb->dyn_fifo = true;
1370 if (reg & MUSB_CONFIGDATA_MPRXE) {
1371 strcat(aInfo, ", bulk combine");
1372 musb->bulk_combine = true;
1374 if (reg & MUSB_CONFIGDATA_MPTXE) {
1375 strcat(aInfo, ", bulk split");
1376 musb->bulk_split = true;
1378 if (reg & MUSB_CONFIGDATA_HBRXE) {
1379 strcat(aInfo, ", HB-ISO Rx");
1380 musb->hb_iso_rx = true;
1382 if (reg & MUSB_CONFIGDATA_HBTXE) {
1383 strcat(aInfo, ", HB-ISO Tx");
1384 musb->hb_iso_tx = true;
1386 if (reg & MUSB_CONFIGDATA_SOFTCONE)
1387 strcat(aInfo, ", SoftConn");
1389 printk(KERN_DEBUG "%s: ConfigData=0x%02x (%s)\n",
1390 musb_driver_name, reg, aInfo);
1392 aDate[0] = 0;
1393 if (MUSB_CONTROLLER_MHDRC == musb_type) {
1394 musb->is_multipoint = 1;
1395 type = "M";
1396 } else {
1397 musb->is_multipoint = 0;
1398 type = "";
1399 #ifndef CONFIG_USB_OTG_BLACKLIST_HUB
1400 printk(KERN_ERR
1401 "%s: kernel must blacklist external hubs\n",
1402 musb_driver_name);
1403 #endif
1406 /* log release info */
1407 musb->hwvers = musb_read_hwvers(mbase);
1408 snprintf(aRevision, 32, "%d.%d%s", MUSB_HWVERS_MAJOR(musb->hwvers),
1409 MUSB_HWVERS_MINOR(musb->hwvers),
1410 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1411 printk(KERN_DEBUG "%s: %sHDRC RTL version %s %s\n",
1412 musb_driver_name, type, aRevision, aDate);
1414 /* configure ep0 */
1415 musb_configure_ep0(musb);
1417 /* discover endpoint configuration */
1418 musb->nr_endpoints = 1;
1419 musb->epmask = 1;
1421 if (musb->dyn_fifo)
1422 status = ep_config_from_table(musb);
1423 else
1424 status = ep_config_from_hw(musb);
1426 if (status < 0)
1427 return status;
1429 /* finish init, and print endpoint config */
1430 for (i = 0; i < musb->nr_endpoints; i++) {
1431 struct musb_hw_ep *hw_ep = musb->endpoints + i;
1433 hw_ep->fifo = MUSB_FIFO_OFFSET(i) + mbase;
1434 #ifdef CONFIG_USB_MUSB_TUSB6010
1435 hw_ep->fifo_async = musb->async + 0x400 + MUSB_FIFO_OFFSET(i);
1436 hw_ep->fifo_sync = musb->sync + 0x400 + MUSB_FIFO_OFFSET(i);
1437 hw_ep->fifo_sync_va =
1438 musb->sync_va + 0x400 + MUSB_FIFO_OFFSET(i);
1440 if (i == 0)
1441 hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1442 else
1443 hw_ep->conf = mbase + 0x400 + (((i - 1) & 0xf) << 2);
1444 #endif
1446 hw_ep->regs = MUSB_EP_OFFSET(i, 0) + mbase;
1447 hw_ep->target_regs = musb_read_target_reg_base(i, mbase);
1448 hw_ep->rx_reinit = 1;
1449 hw_ep->tx_reinit = 1;
1451 if (hw_ep->max_packet_sz_tx) {
1452 dev_dbg(musb->controller,
1453 "%s: hw_ep %d%s, %smax %d\n",
1454 musb_driver_name, i,
1455 hw_ep->is_shared_fifo ? "shared" : "tx",
1456 hw_ep->tx_double_buffered
1457 ? "doublebuffer, " : "",
1458 hw_ep->max_packet_sz_tx);
1460 if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1461 dev_dbg(musb->controller,
1462 "%s: hw_ep %d%s, %smax %d\n",
1463 musb_driver_name, i,
1464 "rx",
1465 hw_ep->rx_double_buffered
1466 ? "doublebuffer, " : "",
1467 hw_ep->max_packet_sz_rx);
1469 if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1470 dev_dbg(musb->controller, "hw_ep %d not configured\n", i);
1473 return 0;
1476 /*-------------------------------------------------------------------------*/
1478 #if defined(CONFIG_SOC_OMAP2430) || defined(CONFIG_SOC_OMAP3430) || \
1479 defined(CONFIG_ARCH_OMAP4) || defined(CONFIG_ARCH_U8500)
1481 static irqreturn_t generic_interrupt(int irq, void *__hci)
1483 unsigned long flags;
1484 irqreturn_t retval = IRQ_NONE;
1485 struct musb *musb = __hci;
1487 spin_lock_irqsave(&musb->lock, flags);
1489 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
1490 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
1491 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
1493 if (musb->int_usb || musb->int_tx || musb->int_rx)
1494 retval = musb_interrupt(musb);
1496 spin_unlock_irqrestore(&musb->lock, flags);
1498 return retval;
1501 #else
1502 #define generic_interrupt NULL
1503 #endif
1506 * handle all the irqs defined by the HDRC core. for now we expect: other
1507 * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1508 * will be assigned, and the irq will already have been acked.
1510 * called in irq context with spinlock held, irqs blocked
1512 irqreturn_t musb_interrupt(struct musb *musb)
1514 irqreturn_t retval = IRQ_NONE;
1515 u8 devctl, power;
1516 int ep_num;
1517 u32 reg;
1519 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1520 power = musb_readb(musb->mregs, MUSB_POWER);
1522 dev_dbg(musb->controller, "** IRQ %s usb%04x tx%04x rx%04x\n",
1523 (devctl & MUSB_DEVCTL_HM) ? "host" : "peripheral",
1524 musb->int_usb, musb->int_tx, musb->int_rx);
1526 /* the core can interrupt us for multiple reasons; docs have
1527 * a generic interrupt flowchart to follow
1529 if (musb->int_usb)
1530 retval |= musb_stage0_irq(musb, musb->int_usb,
1531 devctl, power);
1533 /* "stage 1" is handling endpoint irqs */
1535 /* handle endpoint 0 first */
1536 if (musb->int_tx & 1) {
1537 if (devctl & MUSB_DEVCTL_HM)
1538 retval |= musb_h_ep0_irq(musb);
1539 else
1540 retval |= musb_g_ep0_irq(musb);
1543 /* RX on endpoints 1-15 */
1544 reg = musb->int_rx >> 1;
1545 ep_num = 1;
1546 while (reg) {
1547 if (reg & 1) {
1548 /* musb_ep_select(musb->mregs, ep_num); */
1549 /* REVISIT just retval = ep->rx_irq(...) */
1550 retval = IRQ_HANDLED;
1551 if (devctl & MUSB_DEVCTL_HM) {
1552 if (is_host_capable())
1553 musb_host_rx(musb, ep_num);
1554 } else {
1555 if (is_peripheral_capable())
1556 musb_g_rx(musb, ep_num);
1560 reg >>= 1;
1561 ep_num++;
1564 /* TX on endpoints 1-15 */
1565 reg = musb->int_tx >> 1;
1566 ep_num = 1;
1567 while (reg) {
1568 if (reg & 1) {
1569 /* musb_ep_select(musb->mregs, ep_num); */
1570 /* REVISIT just retval |= ep->tx_irq(...) */
1571 retval = IRQ_HANDLED;
1572 if (devctl & MUSB_DEVCTL_HM) {
1573 if (is_host_capable())
1574 musb_host_tx(musb, ep_num);
1575 } else {
1576 if (is_peripheral_capable())
1577 musb_g_tx(musb, ep_num);
1580 reg >>= 1;
1581 ep_num++;
1584 return retval;
1586 EXPORT_SYMBOL_GPL(musb_interrupt);
1588 #ifndef CONFIG_MUSB_PIO_ONLY
1589 static int __initdata use_dma = 1;
1591 /* "modprobe ... use_dma=0" etc */
1592 module_param(use_dma, bool, 0);
1593 MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1595 void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1597 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1599 /* called with controller lock already held */
1601 if (!epnum) {
1602 #ifndef CONFIG_USB_TUSB_OMAP_DMA
1603 if (!is_cppi_enabled()) {
1604 /* endpoint 0 */
1605 if (devctl & MUSB_DEVCTL_HM)
1606 musb_h_ep0_irq(musb);
1607 else
1608 musb_g_ep0_irq(musb);
1610 #endif
1611 } else {
1612 /* endpoints 1..15 */
1613 if (transmit) {
1614 if (devctl & MUSB_DEVCTL_HM) {
1615 if (is_host_capable())
1616 musb_host_tx(musb, epnum);
1617 } else {
1618 if (is_peripheral_capable())
1619 musb_g_tx(musb, epnum);
1621 } else {
1622 /* receive */
1623 if (devctl & MUSB_DEVCTL_HM) {
1624 if (is_host_capable())
1625 musb_host_rx(musb, epnum);
1626 } else {
1627 if (is_peripheral_capable())
1628 musb_g_rx(musb, epnum);
1634 #else
1635 #define use_dma 0
1636 #endif
1638 /*-------------------------------------------------------------------------*/
1640 #ifdef CONFIG_SYSFS
1642 static ssize_t
1643 musb_mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1645 struct musb *musb = dev_to_musb(dev);
1646 unsigned long flags;
1647 int ret = -EINVAL;
1649 spin_lock_irqsave(&musb->lock, flags);
1650 ret = sprintf(buf, "%s\n", otg_state_string(musb->xceiv->state));
1651 spin_unlock_irqrestore(&musb->lock, flags);
1653 return ret;
1656 static ssize_t
1657 musb_mode_store(struct device *dev, struct device_attribute *attr,
1658 const char *buf, size_t n)
1660 struct musb *musb = dev_to_musb(dev);
1661 unsigned long flags;
1662 int status;
1664 spin_lock_irqsave(&musb->lock, flags);
1665 if (sysfs_streq(buf, "host"))
1666 status = musb_platform_set_mode(musb, MUSB_HOST);
1667 else if (sysfs_streq(buf, "peripheral"))
1668 status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1669 else if (sysfs_streq(buf, "otg"))
1670 status = musb_platform_set_mode(musb, MUSB_OTG);
1671 else
1672 status = -EINVAL;
1673 spin_unlock_irqrestore(&musb->lock, flags);
1675 return (status == 0) ? n : status;
1677 static DEVICE_ATTR(mode, 0644, musb_mode_show, musb_mode_store);
1679 static ssize_t
1680 musb_vbus_store(struct device *dev, struct device_attribute *attr,
1681 const char *buf, size_t n)
1683 struct musb *musb = dev_to_musb(dev);
1684 unsigned long flags;
1685 unsigned long val;
1687 if (sscanf(buf, "%lu", &val) < 1) {
1688 dev_err(dev, "Invalid VBUS timeout ms value\n");
1689 return -EINVAL;
1692 spin_lock_irqsave(&musb->lock, flags);
1693 /* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1694 musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1695 if (musb->xceiv->state == OTG_STATE_A_WAIT_BCON)
1696 musb->is_active = 0;
1697 musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1698 spin_unlock_irqrestore(&musb->lock, flags);
1700 return n;
1703 static ssize_t
1704 musb_vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1706 struct musb *musb = dev_to_musb(dev);
1707 unsigned long flags;
1708 unsigned long val;
1709 int vbus;
1711 spin_lock_irqsave(&musb->lock, flags);
1712 val = musb->a_wait_bcon;
1713 /* FIXME get_vbus_status() is normally #defined as false...
1714 * and is effectively TUSB-specific.
1716 vbus = musb_platform_get_vbus_status(musb);
1717 spin_unlock_irqrestore(&musb->lock, flags);
1719 return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1720 vbus ? "on" : "off", val);
1722 static DEVICE_ATTR(vbus, 0644, musb_vbus_show, musb_vbus_store);
1724 /* Gadget drivers can't know that a host is connected so they might want
1725 * to start SRP, but users can. This allows userspace to trigger SRP.
1727 static ssize_t
1728 musb_srp_store(struct device *dev, struct device_attribute *attr,
1729 const char *buf, size_t n)
1731 struct musb *musb = dev_to_musb(dev);
1732 unsigned short srp;
1734 if (sscanf(buf, "%hu", &srp) != 1
1735 || (srp != 1)) {
1736 dev_err(dev, "SRP: Value must be 1\n");
1737 return -EINVAL;
1740 if (srp == 1)
1741 musb_g_wakeup(musb);
1743 return n;
1745 static DEVICE_ATTR(srp, 0644, NULL, musb_srp_store);
1747 static struct attribute *musb_attributes[] = {
1748 &dev_attr_mode.attr,
1749 &dev_attr_vbus.attr,
1750 &dev_attr_srp.attr,
1751 NULL
1754 static const struct attribute_group musb_attr_group = {
1755 .attrs = musb_attributes,
1758 #endif /* sysfs */
1760 /* Only used to provide driver mode change events */
1761 static void musb_irq_work(struct work_struct *data)
1763 struct musb *musb = container_of(data, struct musb, irq_work);
1764 static int old_state;
1766 if (musb->xceiv->state != old_state) {
1767 old_state = musb->xceiv->state;
1768 sysfs_notify(&musb->controller->kobj, NULL, "mode");
1772 /* --------------------------------------------------------------------------
1773 * Init support
1776 static struct musb *__init
1777 allocate_instance(struct device *dev,
1778 struct musb_hdrc_config *config, void __iomem *mbase)
1780 struct musb *musb;
1781 struct musb_hw_ep *ep;
1782 int epnum;
1783 struct usb_hcd *hcd;
1785 hcd = usb_create_hcd(&musb_hc_driver, dev, dev_name(dev));
1786 if (!hcd)
1787 return NULL;
1788 /* usbcore sets dev->driver_data to hcd, and sometimes uses that... */
1790 musb = hcd_to_musb(hcd);
1791 INIT_LIST_HEAD(&musb->control);
1792 INIT_LIST_HEAD(&musb->in_bulk);
1793 INIT_LIST_HEAD(&musb->out_bulk);
1795 hcd->uses_new_polling = 1;
1796 hcd->has_tt = 1;
1798 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
1799 musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
1800 dev_set_drvdata(dev, musb);
1801 musb->mregs = mbase;
1802 musb->ctrl_base = mbase;
1803 musb->nIrq = -ENODEV;
1804 musb->config = config;
1805 BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
1806 for (epnum = 0, ep = musb->endpoints;
1807 epnum < musb->config->num_eps;
1808 epnum++, ep++) {
1809 ep->musb = musb;
1810 ep->epnum = epnum;
1813 musb->controller = dev;
1815 return musb;
1818 static void musb_free(struct musb *musb)
1820 /* this has multiple entry modes. it handles fault cleanup after
1821 * probe(), where things may be partially set up, as well as rmmod
1822 * cleanup after everything's been de-activated.
1825 #ifdef CONFIG_SYSFS
1826 sysfs_remove_group(&musb->controller->kobj, &musb_attr_group);
1827 #endif
1829 musb_gadget_cleanup(musb);
1831 if (musb->nIrq >= 0) {
1832 if (musb->irq_wake)
1833 disable_irq_wake(musb->nIrq);
1834 free_irq(musb->nIrq, musb);
1836 if (is_dma_capable() && musb->dma_controller) {
1837 struct dma_controller *c = musb->dma_controller;
1839 (void) c->stop(c);
1840 dma_controller_destroy(c);
1843 kfree(musb);
1847 * Perform generic per-controller initialization.
1849 * @pDevice: the controller (already clocked, etc)
1850 * @nIrq: irq
1851 * @mregs: virtual address of controller registers,
1852 * not yet corrected for platform-specific offsets
1854 static int __init
1855 musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
1857 int status;
1858 struct musb *musb;
1859 struct musb_hdrc_platform_data *plat = dev->platform_data;
1861 /* The driver might handle more features than the board; OK.
1862 * Fail when the board needs a feature that's not enabled.
1864 if (!plat) {
1865 dev_dbg(dev, "no platform_data?\n");
1866 status = -ENODEV;
1867 goto fail0;
1870 /* allocate */
1871 musb = allocate_instance(dev, plat->config, ctrl);
1872 if (!musb) {
1873 status = -ENOMEM;
1874 goto fail0;
1877 pm_runtime_use_autosuspend(musb->controller);
1878 pm_runtime_set_autosuspend_delay(musb->controller, 200);
1879 pm_runtime_enable(musb->controller);
1881 spin_lock_init(&musb->lock);
1882 musb->board_mode = plat->mode;
1883 musb->board_set_power = plat->set_power;
1884 musb->min_power = plat->min_power;
1885 musb->ops = plat->platform_ops;
1887 /* The musb_platform_init() call:
1888 * - adjusts musb->mregs and musb->isr if needed,
1889 * - may initialize an integrated tranceiver
1890 * - initializes musb->xceiv, usually by otg_get_transceiver()
1891 * - stops powering VBUS
1893 * There are various transceiver configurations. Blackfin,
1894 * DaVinci, TUSB60x0, and others integrate them. OMAP3 uses
1895 * external/discrete ones in various flavors (twl4030 family,
1896 * isp1504, non-OTG, etc) mostly hooking up through ULPI.
1898 musb->isr = generic_interrupt;
1899 status = musb_platform_init(musb);
1900 if (status < 0)
1901 goto fail1;
1903 if (!musb->isr) {
1904 status = -ENODEV;
1905 goto fail3;
1908 if (!musb->xceiv->io_ops) {
1909 musb->xceiv->io_priv = musb->mregs;
1910 musb->xceiv->io_ops = &musb_ulpi_access;
1913 #ifndef CONFIG_MUSB_PIO_ONLY
1914 if (use_dma && dev->dma_mask) {
1915 struct dma_controller *c;
1917 c = dma_controller_create(musb, musb->mregs);
1918 musb->dma_controller = c;
1919 if (c)
1920 (void) c->start(c);
1922 #endif
1923 /* ideally this would be abstracted in platform setup */
1924 if (!is_dma_capable() || !musb->dma_controller)
1925 dev->dma_mask = NULL;
1927 /* be sure interrupts are disabled before connecting ISR */
1928 musb_platform_disable(musb);
1929 musb_generic_disable(musb);
1931 /* setup musb parts of the core (especially endpoints) */
1932 status = musb_core_init(plat->config->multipoint
1933 ? MUSB_CONTROLLER_MHDRC
1934 : MUSB_CONTROLLER_HDRC, musb);
1935 if (status < 0)
1936 goto fail3;
1938 setup_timer(&musb->otg_timer, musb_otg_timer_func, (unsigned long) musb);
1940 /* Init IRQ workqueue before request_irq */
1941 INIT_WORK(&musb->irq_work, musb_irq_work);
1943 /* attach to the IRQ */
1944 if (request_irq(nIrq, musb->isr, 0, dev_name(dev), musb)) {
1945 dev_err(dev, "request_irq %d failed!\n", nIrq);
1946 status = -ENODEV;
1947 goto fail3;
1949 musb->nIrq = nIrq;
1950 /* FIXME this handles wakeup irqs wrong */
1951 if (enable_irq_wake(nIrq) == 0) {
1952 musb->irq_wake = 1;
1953 device_init_wakeup(dev, 1);
1954 } else {
1955 musb->irq_wake = 0;
1958 /* host side needs more setup */
1959 if (is_host_enabled(musb)) {
1960 struct usb_hcd *hcd = musb_to_hcd(musb);
1962 otg_set_host(musb->xceiv, &hcd->self);
1964 if (is_otg_enabled(musb))
1965 hcd->self.otg_port = 1;
1966 musb->xceiv->host = &hcd->self;
1967 hcd->power_budget = 2 * (plat->power ? : 250);
1969 /* program PHY to use external vBus if required */
1970 if (plat->extvbus) {
1971 u8 busctl = musb_read_ulpi_buscontrol(musb->mregs);
1972 busctl |= MUSB_ULPI_USE_EXTVBUS;
1973 musb_write_ulpi_buscontrol(musb->mregs, busctl);
1977 /* For the host-only role, we can activate right away.
1978 * (We expect the ID pin to be forcibly grounded!!)
1979 * Otherwise, wait till the gadget driver hooks up.
1981 if (!is_otg_enabled(musb) && is_host_enabled(musb)) {
1982 struct usb_hcd *hcd = musb_to_hcd(musb);
1984 MUSB_HST_MODE(musb);
1985 musb->xceiv->default_a = 1;
1986 musb->xceiv->state = OTG_STATE_A_IDLE;
1988 status = usb_add_hcd(musb_to_hcd(musb), -1, 0);
1990 hcd->self.uses_pio_for_control = 1;
1991 dev_dbg(musb->controller, "%s mode, status %d, devctl %02x %c\n",
1992 "HOST", status,
1993 musb_readb(musb->mregs, MUSB_DEVCTL),
1994 (musb_readb(musb->mregs, MUSB_DEVCTL)
1995 & MUSB_DEVCTL_BDEVICE
1996 ? 'B' : 'A'));
1998 } else /* peripheral is enabled */ {
1999 MUSB_DEV_MODE(musb);
2000 musb->xceiv->default_a = 0;
2001 musb->xceiv->state = OTG_STATE_B_IDLE;
2003 status = musb_gadget_setup(musb);
2005 dev_dbg(musb->controller, "%s mode, status %d, dev%02x\n",
2006 is_otg_enabled(musb) ? "OTG" : "PERIPHERAL",
2007 status,
2008 musb_readb(musb->mregs, MUSB_DEVCTL));
2011 if (status < 0)
2012 goto fail3;
2014 pm_runtime_put(musb->controller);
2016 status = musb_init_debugfs(musb);
2017 if (status < 0)
2018 goto fail4;
2020 #ifdef CONFIG_SYSFS
2021 status = sysfs_create_group(&musb->controller->kobj, &musb_attr_group);
2022 if (status)
2023 goto fail5;
2024 #endif
2026 dev_info(dev, "USB %s mode controller at %p using %s, IRQ %d\n",
2027 ({char *s;
2028 switch (musb->board_mode) {
2029 case MUSB_HOST: s = "Host"; break;
2030 case MUSB_PERIPHERAL: s = "Peripheral"; break;
2031 default: s = "OTG"; break;
2032 }; s; }),
2033 ctrl,
2034 (is_dma_capable() && musb->dma_controller)
2035 ? "DMA" : "PIO",
2036 musb->nIrq);
2038 return 0;
2040 fail5:
2041 musb_exit_debugfs(musb);
2043 fail4:
2044 if (!is_otg_enabled(musb) && is_host_enabled(musb))
2045 usb_remove_hcd(musb_to_hcd(musb));
2046 else
2047 musb_gadget_cleanup(musb);
2049 fail3:
2050 if (musb->irq_wake)
2051 device_init_wakeup(dev, 0);
2052 musb_platform_exit(musb);
2054 fail1:
2055 dev_err(musb->controller,
2056 "musb_init_controller failed with status %d\n", status);
2058 musb_free(musb);
2060 fail0:
2062 return status;
2066 /*-------------------------------------------------------------------------*/
2068 /* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2069 * bridge to a platform device; this driver then suffices.
2072 #ifndef CONFIG_MUSB_PIO_ONLY
2073 static u64 *orig_dma_mask;
2074 #endif
2076 static int __init musb_probe(struct platform_device *pdev)
2078 struct device *dev = &pdev->dev;
2079 int irq = platform_get_irq_byname(pdev, "mc");
2080 int status;
2081 struct resource *iomem;
2082 void __iomem *base;
2084 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2085 if (!iomem || irq <= 0)
2086 return -ENODEV;
2088 base = ioremap(iomem->start, resource_size(iomem));
2089 if (!base) {
2090 dev_err(dev, "ioremap failed\n");
2091 return -ENOMEM;
2094 #ifndef CONFIG_MUSB_PIO_ONLY
2095 /* clobbered by use_dma=n */
2096 orig_dma_mask = dev->dma_mask;
2097 #endif
2098 status = musb_init_controller(dev, irq, base);
2099 if (status < 0)
2100 iounmap(base);
2102 return status;
2105 static int __exit musb_remove(struct platform_device *pdev)
2107 struct musb *musb = dev_to_musb(&pdev->dev);
2108 void __iomem *ctrl_base = musb->ctrl_base;
2110 /* this gets called on rmmod.
2111 * - Host mode: host may still be active
2112 * - Peripheral mode: peripheral is deactivated (or never-activated)
2113 * - OTG mode: both roles are deactivated (or never-activated)
2115 pm_runtime_get_sync(musb->controller);
2116 musb_exit_debugfs(musb);
2117 musb_shutdown(pdev);
2119 pm_runtime_put(musb->controller);
2120 musb_free(musb);
2121 iounmap(ctrl_base);
2122 device_init_wakeup(&pdev->dev, 0);
2123 #ifndef CONFIG_MUSB_PIO_ONLY
2124 pdev->dev.dma_mask = orig_dma_mask;
2125 #endif
2126 return 0;
2129 #ifdef CONFIG_PM
2131 static void musb_save_context(struct musb *musb)
2133 int i;
2134 void __iomem *musb_base = musb->mregs;
2135 void __iomem *epio;
2137 if (is_host_enabled(musb)) {
2138 musb->context.frame = musb_readw(musb_base, MUSB_FRAME);
2139 musb->context.testmode = musb_readb(musb_base, MUSB_TESTMODE);
2140 musb->context.busctl = musb_read_ulpi_buscontrol(musb->mregs);
2142 musb->context.power = musb_readb(musb_base, MUSB_POWER);
2143 musb->context.intrtxe = musb_readw(musb_base, MUSB_INTRTXE);
2144 musb->context.intrrxe = musb_readw(musb_base, MUSB_INTRRXE);
2145 musb->context.intrusbe = musb_readb(musb_base, MUSB_INTRUSBE);
2146 musb->context.index = musb_readb(musb_base, MUSB_INDEX);
2147 musb->context.devctl = musb_readb(musb_base, MUSB_DEVCTL);
2149 for (i = 0; i < musb->config->num_eps; ++i) {
2150 struct musb_hw_ep *hw_ep;
2152 hw_ep = &musb->endpoints[i];
2153 if (!hw_ep)
2154 continue;
2156 epio = hw_ep->regs;
2157 if (!epio)
2158 continue;
2160 musb->context.index_regs[i].txmaxp =
2161 musb_readw(epio, MUSB_TXMAXP);
2162 musb->context.index_regs[i].txcsr =
2163 musb_readw(epio, MUSB_TXCSR);
2164 musb->context.index_regs[i].rxmaxp =
2165 musb_readw(epio, MUSB_RXMAXP);
2166 musb->context.index_regs[i].rxcsr =
2167 musb_readw(epio, MUSB_RXCSR);
2169 if (musb->dyn_fifo) {
2170 musb->context.index_regs[i].txfifoadd =
2171 musb_read_txfifoadd(musb_base);
2172 musb->context.index_regs[i].rxfifoadd =
2173 musb_read_rxfifoadd(musb_base);
2174 musb->context.index_regs[i].txfifosz =
2175 musb_read_txfifosz(musb_base);
2176 musb->context.index_regs[i].rxfifosz =
2177 musb_read_rxfifosz(musb_base);
2179 if (is_host_enabled(musb)) {
2180 musb->context.index_regs[i].txtype =
2181 musb_readb(epio, MUSB_TXTYPE);
2182 musb->context.index_regs[i].txinterval =
2183 musb_readb(epio, MUSB_TXINTERVAL);
2184 musb->context.index_regs[i].rxtype =
2185 musb_readb(epio, MUSB_RXTYPE);
2186 musb->context.index_regs[i].rxinterval =
2187 musb_readb(epio, MUSB_RXINTERVAL);
2189 musb->context.index_regs[i].txfunaddr =
2190 musb_read_txfunaddr(musb_base, i);
2191 musb->context.index_regs[i].txhubaddr =
2192 musb_read_txhubaddr(musb_base, i);
2193 musb->context.index_regs[i].txhubport =
2194 musb_read_txhubport(musb_base, i);
2196 musb->context.index_regs[i].rxfunaddr =
2197 musb_read_rxfunaddr(musb_base, i);
2198 musb->context.index_regs[i].rxhubaddr =
2199 musb_read_rxhubaddr(musb_base, i);
2200 musb->context.index_regs[i].rxhubport =
2201 musb_read_rxhubport(musb_base, i);
2206 static void musb_restore_context(struct musb *musb)
2208 int i;
2209 void __iomem *musb_base = musb->mregs;
2210 void __iomem *ep_target_regs;
2211 void __iomem *epio;
2213 if (is_host_enabled(musb)) {
2214 musb_writew(musb_base, MUSB_FRAME, musb->context.frame);
2215 musb_writeb(musb_base, MUSB_TESTMODE, musb->context.testmode);
2216 musb_write_ulpi_buscontrol(musb->mregs, musb->context.busctl);
2218 musb_writeb(musb_base, MUSB_POWER, musb->context.power);
2219 musb_writew(musb_base, MUSB_INTRTXE, musb->context.intrtxe);
2220 musb_writew(musb_base, MUSB_INTRRXE, musb->context.intrrxe);
2221 musb_writeb(musb_base, MUSB_INTRUSBE, musb->context.intrusbe);
2222 musb_writeb(musb_base, MUSB_DEVCTL, musb->context.devctl);
2224 for (i = 0; i < musb->config->num_eps; ++i) {
2225 struct musb_hw_ep *hw_ep;
2227 hw_ep = &musb->endpoints[i];
2228 if (!hw_ep)
2229 continue;
2231 epio = hw_ep->regs;
2232 if (!epio)
2233 continue;
2235 musb_writew(epio, MUSB_TXMAXP,
2236 musb->context.index_regs[i].txmaxp);
2237 musb_writew(epio, MUSB_TXCSR,
2238 musb->context.index_regs[i].txcsr);
2239 musb_writew(epio, MUSB_RXMAXP,
2240 musb->context.index_regs[i].rxmaxp);
2241 musb_writew(epio, MUSB_RXCSR,
2242 musb->context.index_regs[i].rxcsr);
2244 if (musb->dyn_fifo) {
2245 musb_write_txfifosz(musb_base,
2246 musb->context.index_regs[i].txfifosz);
2247 musb_write_rxfifosz(musb_base,
2248 musb->context.index_regs[i].rxfifosz);
2249 musb_write_txfifoadd(musb_base,
2250 musb->context.index_regs[i].txfifoadd);
2251 musb_write_rxfifoadd(musb_base,
2252 musb->context.index_regs[i].rxfifoadd);
2255 if (is_host_enabled(musb)) {
2256 musb_writeb(epio, MUSB_TXTYPE,
2257 musb->context.index_regs[i].txtype);
2258 musb_writeb(epio, MUSB_TXINTERVAL,
2259 musb->context.index_regs[i].txinterval);
2260 musb_writeb(epio, MUSB_RXTYPE,
2261 musb->context.index_regs[i].rxtype);
2262 musb_writeb(epio, MUSB_RXINTERVAL,
2264 musb->context.index_regs[i].rxinterval);
2265 musb_write_txfunaddr(musb_base, i,
2266 musb->context.index_regs[i].txfunaddr);
2267 musb_write_txhubaddr(musb_base, i,
2268 musb->context.index_regs[i].txhubaddr);
2269 musb_write_txhubport(musb_base, i,
2270 musb->context.index_regs[i].txhubport);
2272 ep_target_regs =
2273 musb_read_target_reg_base(i, musb_base);
2275 musb_write_rxfunaddr(ep_target_regs,
2276 musb->context.index_regs[i].rxfunaddr);
2277 musb_write_rxhubaddr(ep_target_regs,
2278 musb->context.index_regs[i].rxhubaddr);
2279 musb_write_rxhubport(ep_target_regs,
2280 musb->context.index_regs[i].rxhubport);
2283 musb_writeb(musb_base, MUSB_INDEX, musb->context.index);
2286 static int musb_suspend(struct device *dev)
2288 struct musb *musb = dev_to_musb(dev);
2289 unsigned long flags;
2291 spin_lock_irqsave(&musb->lock, flags);
2293 if (is_peripheral_active(musb)) {
2294 /* FIXME force disconnect unless we know USB will wake
2295 * the system up quickly enough to respond ...
2297 } else if (is_host_active(musb)) {
2298 /* we know all the children are suspended; sometimes
2299 * they will even be wakeup-enabled.
2303 musb_save_context(musb);
2305 spin_unlock_irqrestore(&musb->lock, flags);
2306 return 0;
2309 static int musb_resume_noirq(struct device *dev)
2311 struct musb *musb = dev_to_musb(dev);
2313 musb_restore_context(musb);
2315 /* for static cmos like DaVinci, register values were preserved
2316 * unless for some reason the whole soc powered down or the USB
2317 * module got reset through the PSC (vs just being disabled).
2319 return 0;
2322 static int musb_runtime_suspend(struct device *dev)
2324 struct musb *musb = dev_to_musb(dev);
2326 musb_save_context(musb);
2328 return 0;
2331 static int musb_runtime_resume(struct device *dev)
2333 struct musb *musb = dev_to_musb(dev);
2334 static int first = 1;
2337 * When pm_runtime_get_sync called for the first time in driver
2338 * init, some of the structure is still not initialized which is
2339 * used in restore function. But clock needs to be
2340 * enabled before any register access, so
2341 * pm_runtime_get_sync has to be called.
2342 * Also context restore without save does not make
2343 * any sense
2345 if (!first)
2346 musb_restore_context(musb);
2347 first = 0;
2349 return 0;
2352 static const struct dev_pm_ops musb_dev_pm_ops = {
2353 .suspend = musb_suspend,
2354 .resume_noirq = musb_resume_noirq,
2355 .runtime_suspend = musb_runtime_suspend,
2356 .runtime_resume = musb_runtime_resume,
2359 #define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2360 #else
2361 #define MUSB_DEV_PM_OPS NULL
2362 #endif
2364 static struct platform_driver musb_driver = {
2365 .driver = {
2366 .name = (char *)musb_driver_name,
2367 .bus = &platform_bus_type,
2368 .owner = THIS_MODULE,
2369 .pm = MUSB_DEV_PM_OPS,
2371 .remove = __exit_p(musb_remove),
2372 .shutdown = musb_shutdown,
2375 /*-------------------------------------------------------------------------*/
2377 static int __init musb_init(void)
2379 if (usb_disabled())
2380 return 0;
2382 pr_info("%s: version " MUSB_VERSION ", "
2383 "?dma?"
2384 ", "
2385 "otg (peripheral+host)",
2386 musb_driver_name);
2387 return platform_driver_probe(&musb_driver, musb_probe);
2390 /* make us init after usbcore and i2c (transceivers, regulators, etc)
2391 * and before usb gadget and host-side drivers start to register
2393 fs_initcall(musb_init);
2395 static void __exit musb_cleanup(void)
2397 platform_driver_unregister(&musb_driver);
2399 module_exit(musb_cleanup);