sfc: Don't use enums as a bitmask.
[zen-stable.git] / drivers / usb / musb / musb_core.c
blob630ae7f3cd4cf1ff9288f38cbca245b504d38629
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/platform_device.h>
100 #include <linux/io.h>
102 #include "musb_core.h"
104 #define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
107 unsigned musb_debug;
108 module_param_named(debug, musb_debug, uint, S_IRUGO | S_IWUSR);
109 MODULE_PARM_DESC(debug, "Debug message level. Default = 0");
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 /*-------------------------------------------------------------------------*/
136 #ifndef CONFIG_BLACKFIN
137 static int musb_ulpi_read(struct otg_transceiver *otg, u32 offset)
139 void __iomem *addr = otg->io_priv;
140 int i = 0;
141 u8 r;
142 u8 power;
144 /* Make sure the transceiver is not in low power mode */
145 power = musb_readb(addr, MUSB_POWER);
146 power &= ~MUSB_POWER_SUSPENDM;
147 musb_writeb(addr, MUSB_POWER, power);
149 /* REVISIT: musbhdrc_ulpi_an.pdf recommends setting the
150 * ULPICarKitControlDisableUTMI after clearing POWER_SUSPENDM.
153 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
154 musb_writeb(addr, MUSB_ULPI_REG_CONTROL,
155 MUSB_ULPI_REG_REQ | MUSB_ULPI_RDN_WR);
157 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
158 & MUSB_ULPI_REG_CMPLT)) {
159 i++;
160 if (i == 10000) {
161 DBG(3, "ULPI read timed out\n");
162 return -ETIMEDOUT;
166 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
167 r &= ~MUSB_ULPI_REG_CMPLT;
168 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
170 return musb_readb(addr, MUSB_ULPI_REG_DATA);
173 static int musb_ulpi_write(struct otg_transceiver *otg,
174 u32 offset, u32 data)
176 void __iomem *addr = otg->io_priv;
177 int i = 0;
178 u8 r = 0;
179 u8 power;
181 /* Make sure the transceiver is not in low power mode */
182 power = musb_readb(addr, MUSB_POWER);
183 power &= ~MUSB_POWER_SUSPENDM;
184 musb_writeb(addr, MUSB_POWER, power);
186 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
187 musb_writeb(addr, MUSB_ULPI_REG_DATA, (u8)data);
188 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, MUSB_ULPI_REG_REQ);
190 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
191 & MUSB_ULPI_REG_CMPLT)) {
192 i++;
193 if (i == 10000) {
194 DBG(3, "ULPI write timed out\n");
195 return -ETIMEDOUT;
199 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
200 r &= ~MUSB_ULPI_REG_CMPLT;
201 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
203 return 0;
205 #else
206 #define musb_ulpi_read NULL
207 #define musb_ulpi_write NULL
208 #endif
210 static struct otg_io_access_ops musb_ulpi_access = {
211 .read = musb_ulpi_read,
212 .write = musb_ulpi_write,
215 /*-------------------------------------------------------------------------*/
217 #if !defined(CONFIG_USB_MUSB_TUSB6010) && !defined(CONFIG_USB_MUSB_BLACKFIN)
220 * Load an endpoint's FIFO
222 void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
224 void __iomem *fifo = hw_ep->fifo;
226 prefetch((u8 *)src);
228 DBG(4, "%cX ep%d fifo %p count %d buf %p\n",
229 'T', hw_ep->epnum, fifo, len, src);
231 /* we can't assume unaligned reads work */
232 if (likely((0x01 & (unsigned long) src) == 0)) {
233 u16 index = 0;
235 /* best case is 32bit-aligned source address */
236 if ((0x02 & (unsigned long) src) == 0) {
237 if (len >= 4) {
238 writesl(fifo, src + index, len >> 2);
239 index += len & ~0x03;
241 if (len & 0x02) {
242 musb_writew(fifo, 0, *(u16 *)&src[index]);
243 index += 2;
245 } else {
246 if (len >= 2) {
247 writesw(fifo, src + index, len >> 1);
248 index += len & ~0x01;
251 if (len & 0x01)
252 musb_writeb(fifo, 0, src[index]);
253 } else {
254 /* byte aligned */
255 writesb(fifo, src, len);
259 #if !defined(CONFIG_USB_MUSB_AM35X)
261 * Unload an endpoint's FIFO
263 void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
265 void __iomem *fifo = hw_ep->fifo;
267 DBG(4, "%cX ep%d fifo %p count %d buf %p\n",
268 'R', hw_ep->epnum, fifo, len, dst);
270 /* we can't assume unaligned writes work */
271 if (likely((0x01 & (unsigned long) dst) == 0)) {
272 u16 index = 0;
274 /* best case is 32bit-aligned destination address */
275 if ((0x02 & (unsigned long) dst) == 0) {
276 if (len >= 4) {
277 readsl(fifo, dst, len >> 2);
278 index = len & ~0x03;
280 if (len & 0x02) {
281 *(u16 *)&dst[index] = musb_readw(fifo, 0);
282 index += 2;
284 } else {
285 if (len >= 2) {
286 readsw(fifo, dst, len >> 1);
287 index = len & ~0x01;
290 if (len & 0x01)
291 dst[index] = musb_readb(fifo, 0);
292 } else {
293 /* byte aligned */
294 readsb(fifo, dst, len);
297 #endif
299 #endif /* normal PIO */
302 /*-------------------------------------------------------------------------*/
304 /* for high speed test mode; see USB 2.0 spec 7.1.20 */
305 static const u8 musb_test_packet[53] = {
306 /* implicit SYNC then DATA0 to start */
308 /* JKJKJKJK x9 */
309 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
310 /* JJKKJJKK x8 */
311 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
312 /* JJJJKKKK x8 */
313 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
314 /* JJJJJJJKKKKKKK x8 */
315 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
316 /* JJJJJJJK x8 */
317 0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
318 /* JKKKKKKK x10, JK */
319 0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
321 /* implicit CRC16 then EOP to end */
324 void musb_load_testpacket(struct musb *musb)
326 void __iomem *regs = musb->endpoints[0].regs;
328 musb_ep_select(musb->mregs, 0);
329 musb_write_fifo(musb->control_ep,
330 sizeof(musb_test_packet), musb_test_packet);
331 musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
334 /*-------------------------------------------------------------------------*/
336 const char *otg_state_string(struct musb *musb)
338 switch (musb->xceiv->state) {
339 case OTG_STATE_A_IDLE: return "a_idle";
340 case OTG_STATE_A_WAIT_VRISE: return "a_wait_vrise";
341 case OTG_STATE_A_WAIT_BCON: return "a_wait_bcon";
342 case OTG_STATE_A_HOST: return "a_host";
343 case OTG_STATE_A_SUSPEND: return "a_suspend";
344 case OTG_STATE_A_PERIPHERAL: return "a_peripheral";
345 case OTG_STATE_A_WAIT_VFALL: return "a_wait_vfall";
346 case OTG_STATE_A_VBUS_ERR: return "a_vbus_err";
347 case OTG_STATE_B_IDLE: return "b_idle";
348 case OTG_STATE_B_SRP_INIT: return "b_srp_init";
349 case OTG_STATE_B_PERIPHERAL: return "b_peripheral";
350 case OTG_STATE_B_WAIT_ACON: return "b_wait_acon";
351 case OTG_STATE_B_HOST: return "b_host";
352 default: return "UNDEFINED";
356 #ifdef CONFIG_USB_MUSB_OTG
359 * Handles OTG hnp timeouts, such as b_ase0_brst
361 void musb_otg_timer_func(unsigned long data)
363 struct musb *musb = (struct musb *)data;
364 unsigned long flags;
366 spin_lock_irqsave(&musb->lock, flags);
367 switch (musb->xceiv->state) {
368 case OTG_STATE_B_WAIT_ACON:
369 DBG(1, "HNP: b_wait_acon timeout; back to b_peripheral\n");
370 musb_g_disconnect(musb);
371 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
372 musb->is_active = 0;
373 break;
374 case OTG_STATE_A_SUSPEND:
375 case OTG_STATE_A_WAIT_BCON:
376 DBG(1, "HNP: %s timeout\n", otg_state_string(musb));
377 musb_platform_set_vbus(musb, 0);
378 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
379 break;
380 default:
381 DBG(1, "HNP: Unhandled mode %s\n", otg_state_string(musb));
383 musb->ignore_disconnect = 0;
384 spin_unlock_irqrestore(&musb->lock, flags);
388 * Stops the HNP transition. Caller must take care of locking.
390 void musb_hnp_stop(struct musb *musb)
392 struct usb_hcd *hcd = musb_to_hcd(musb);
393 void __iomem *mbase = musb->mregs;
394 u8 reg;
396 DBG(1, "HNP: stop from %s\n", otg_state_string(musb));
398 switch (musb->xceiv->state) {
399 case OTG_STATE_A_PERIPHERAL:
400 musb_g_disconnect(musb);
401 DBG(1, "HNP: back to %s\n", otg_state_string(musb));
402 break;
403 case OTG_STATE_B_HOST:
404 DBG(1, "HNP: Disabling HR\n");
405 hcd->self.is_b_host = 0;
406 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
407 MUSB_DEV_MODE(musb);
408 reg = musb_readb(mbase, MUSB_POWER);
409 reg |= MUSB_POWER_SUSPENDM;
410 musb_writeb(mbase, MUSB_POWER, reg);
411 /* REVISIT: Start SESSION_REQUEST here? */
412 break;
413 default:
414 DBG(1, "HNP: Stopping in unknown state %s\n",
415 otg_state_string(musb));
419 * When returning to A state after HNP, avoid hub_port_rebounce(),
420 * which cause occasional OPT A "Did not receive reset after connect"
421 * errors.
423 musb->port1_status &= ~(USB_PORT_STAT_C_CONNECTION << 16);
426 #endif
429 * Interrupt Service Routine to record USB "global" interrupts.
430 * Since these do not happen often and signify things of
431 * paramount importance, it seems OK to check them individually;
432 * the order of the tests is specified in the manual
434 * @param musb instance pointer
435 * @param int_usb register contents
436 * @param devctl
437 * @param power
440 static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
441 u8 devctl, u8 power)
443 irqreturn_t handled = IRQ_NONE;
445 DBG(3, "<== Power=%02x, DevCtl=%02x, int_usb=0x%x\n", power, devctl,
446 int_usb);
448 /* in host mode, the peripheral may issue remote wakeup.
449 * in peripheral mode, the host may resume the link.
450 * spurious RESUME irqs happen too, paired with SUSPEND.
452 if (int_usb & MUSB_INTR_RESUME) {
453 handled = IRQ_HANDLED;
454 DBG(3, "RESUME (%s)\n", otg_state_string(musb));
456 if (devctl & MUSB_DEVCTL_HM) {
457 #ifdef CONFIG_USB_MUSB_HDRC_HCD
458 void __iomem *mbase = musb->mregs;
460 switch (musb->xceiv->state) {
461 case OTG_STATE_A_SUSPEND:
462 /* remote wakeup? later, GetPortStatus
463 * will stop RESUME signaling
466 if (power & MUSB_POWER_SUSPENDM) {
467 /* spurious */
468 musb->int_usb &= ~MUSB_INTR_SUSPEND;
469 DBG(2, "Spurious SUSPENDM\n");
470 break;
473 power &= ~MUSB_POWER_SUSPENDM;
474 musb_writeb(mbase, MUSB_POWER,
475 power | MUSB_POWER_RESUME);
477 musb->port1_status |=
478 (USB_PORT_STAT_C_SUSPEND << 16)
479 | MUSB_PORT_STAT_RESUME;
480 musb->rh_timer = jiffies
481 + msecs_to_jiffies(20);
483 musb->xceiv->state = OTG_STATE_A_HOST;
484 musb->is_active = 1;
485 usb_hcd_resume_root_hub(musb_to_hcd(musb));
486 break;
487 case OTG_STATE_B_WAIT_ACON:
488 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
489 musb->is_active = 1;
490 MUSB_DEV_MODE(musb);
491 break;
492 default:
493 WARNING("bogus %s RESUME (%s)\n",
494 "host",
495 otg_state_string(musb));
497 #endif
498 } else {
499 switch (musb->xceiv->state) {
500 #ifdef CONFIG_USB_MUSB_HDRC_HCD
501 case OTG_STATE_A_SUSPEND:
502 /* possibly DISCONNECT is upcoming */
503 musb->xceiv->state = OTG_STATE_A_HOST;
504 usb_hcd_resume_root_hub(musb_to_hcd(musb));
505 break;
506 #endif
507 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
508 case OTG_STATE_B_WAIT_ACON:
509 case OTG_STATE_B_PERIPHERAL:
510 /* disconnect while suspended? we may
511 * not get a disconnect irq...
513 if ((devctl & MUSB_DEVCTL_VBUS)
514 != (3 << MUSB_DEVCTL_VBUS_SHIFT)
516 musb->int_usb |= MUSB_INTR_DISCONNECT;
517 musb->int_usb &= ~MUSB_INTR_SUSPEND;
518 break;
520 musb_g_resume(musb);
521 break;
522 case OTG_STATE_B_IDLE:
523 musb->int_usb &= ~MUSB_INTR_SUSPEND;
524 break;
525 #endif
526 default:
527 WARNING("bogus %s RESUME (%s)\n",
528 "peripheral",
529 otg_state_string(musb));
534 #ifdef CONFIG_USB_MUSB_HDRC_HCD
535 /* see manual for the order of the tests */
536 if (int_usb & MUSB_INTR_SESSREQ) {
537 void __iomem *mbase = musb->mregs;
539 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS
540 && (devctl & MUSB_DEVCTL_BDEVICE)) {
541 DBG(3, "SessReq while on B state\n");
542 return IRQ_HANDLED;
545 DBG(1, "SESSION_REQUEST (%s)\n", otg_state_string(musb));
547 /* IRQ arrives from ID pin sense or (later, if VBUS power
548 * is removed) SRP. responses are time critical:
549 * - turn on VBUS (with silicon-specific mechanism)
550 * - go through A_WAIT_VRISE
551 * - ... to A_WAIT_BCON.
552 * a_wait_vrise_tmout triggers VBUS_ERROR transitions
554 musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
555 musb->ep0_stage = MUSB_EP0_START;
556 musb->xceiv->state = OTG_STATE_A_IDLE;
557 MUSB_HST_MODE(musb);
558 musb_platform_set_vbus(musb, 1);
560 handled = IRQ_HANDLED;
563 if (int_usb & MUSB_INTR_VBUSERROR) {
564 int ignore = 0;
566 /* During connection as an A-Device, we may see a short
567 * current spikes causing voltage drop, because of cable
568 * and peripheral capacitance combined with vbus draw.
569 * (So: less common with truly self-powered devices, where
570 * vbus doesn't act like a power supply.)
572 * Such spikes are short; usually less than ~500 usec, max
573 * of ~2 msec. That is, they're not sustained overcurrent
574 * errors, though they're reported using VBUSERROR irqs.
576 * Workarounds: (a) hardware: use self powered devices.
577 * (b) software: ignore non-repeated VBUS errors.
579 * REVISIT: do delays from lots of DEBUG_KERNEL checks
580 * make trouble here, keeping VBUS < 4.4V ?
582 switch (musb->xceiv->state) {
583 case OTG_STATE_A_HOST:
584 /* recovery is dicey once we've gotten past the
585 * initial stages of enumeration, but if VBUS
586 * stayed ok at the other end of the link, and
587 * another reset is due (at least for high speed,
588 * to redo the chirp etc), it might work OK...
590 case OTG_STATE_A_WAIT_BCON:
591 case OTG_STATE_A_WAIT_VRISE:
592 if (musb->vbuserr_retry) {
593 void __iomem *mbase = musb->mregs;
595 musb->vbuserr_retry--;
596 ignore = 1;
597 devctl |= MUSB_DEVCTL_SESSION;
598 musb_writeb(mbase, MUSB_DEVCTL, devctl);
599 } else {
600 musb->port1_status |=
601 USB_PORT_STAT_OVERCURRENT
602 | (USB_PORT_STAT_C_OVERCURRENT << 16);
604 break;
605 default:
606 break;
609 DBG(1, "VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
610 otg_state_string(musb),
611 devctl,
612 ({ char *s;
613 switch (devctl & MUSB_DEVCTL_VBUS) {
614 case 0 << MUSB_DEVCTL_VBUS_SHIFT:
615 s = "<SessEnd"; break;
616 case 1 << MUSB_DEVCTL_VBUS_SHIFT:
617 s = "<AValid"; break;
618 case 2 << MUSB_DEVCTL_VBUS_SHIFT:
619 s = "<VBusValid"; break;
620 /* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
621 default:
622 s = "VALID"; break;
623 }; s; }),
624 VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
625 musb->port1_status);
627 /* go through A_WAIT_VFALL then start a new session */
628 if (!ignore)
629 musb_platform_set_vbus(musb, 0);
630 handled = IRQ_HANDLED;
633 #endif
634 if (int_usb & MUSB_INTR_SUSPEND) {
635 DBG(1, "SUSPEND (%s) devctl %02x power %02x\n",
636 otg_state_string(musb), devctl, power);
637 handled = IRQ_HANDLED;
639 switch (musb->xceiv->state) {
640 #ifdef CONFIG_USB_MUSB_OTG
641 case OTG_STATE_A_PERIPHERAL:
642 /* We also come here if the cable is removed, since
643 * this silicon doesn't report ID-no-longer-grounded.
645 * We depend on T(a_wait_bcon) to shut us down, and
646 * hope users don't do anything dicey during this
647 * undesired detour through A_WAIT_BCON.
649 musb_hnp_stop(musb);
650 usb_hcd_resume_root_hub(musb_to_hcd(musb));
651 musb_root_disconnect(musb);
652 musb_platform_try_idle(musb, jiffies
653 + msecs_to_jiffies(musb->a_wait_bcon
654 ? : OTG_TIME_A_WAIT_BCON));
656 break;
657 #endif
658 case OTG_STATE_B_IDLE:
659 if (!musb->is_active)
660 break;
661 case OTG_STATE_B_PERIPHERAL:
662 musb_g_suspend(musb);
663 musb->is_active = is_otg_enabled(musb)
664 && musb->xceiv->gadget->b_hnp_enable;
665 if (musb->is_active) {
666 #ifdef CONFIG_USB_MUSB_OTG
667 musb->xceiv->state = OTG_STATE_B_WAIT_ACON;
668 DBG(1, "HNP: Setting timer for b_ase0_brst\n");
669 mod_timer(&musb->otg_timer, jiffies
670 + msecs_to_jiffies(
671 OTG_TIME_B_ASE0_BRST));
672 #endif
674 break;
675 case OTG_STATE_A_WAIT_BCON:
676 if (musb->a_wait_bcon != 0)
677 musb_platform_try_idle(musb, jiffies
678 + msecs_to_jiffies(musb->a_wait_bcon));
679 break;
680 case OTG_STATE_A_HOST:
681 musb->xceiv->state = OTG_STATE_A_SUSPEND;
682 musb->is_active = is_otg_enabled(musb)
683 && musb->xceiv->host->b_hnp_enable;
684 break;
685 case OTG_STATE_B_HOST:
686 /* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
687 DBG(1, "REVISIT: SUSPEND as B_HOST\n");
688 break;
689 default:
690 /* "should not happen" */
691 musb->is_active = 0;
692 break;
696 #ifdef CONFIG_USB_MUSB_HDRC_HCD
697 if (int_usb & MUSB_INTR_CONNECT) {
698 struct usb_hcd *hcd = musb_to_hcd(musb);
700 handled = IRQ_HANDLED;
701 musb->is_active = 1;
702 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
704 musb->ep0_stage = MUSB_EP0_START;
706 #ifdef CONFIG_USB_MUSB_OTG
707 /* flush endpoints when transitioning from Device Mode */
708 if (is_peripheral_active(musb)) {
709 /* REVISIT HNP; just force disconnect */
711 musb_writew(musb->mregs, MUSB_INTRTXE, musb->epmask);
712 musb_writew(musb->mregs, MUSB_INTRRXE, musb->epmask & 0xfffe);
713 musb_writeb(musb->mregs, MUSB_INTRUSBE, 0xf7);
714 #endif
715 musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
716 |USB_PORT_STAT_HIGH_SPEED
717 |USB_PORT_STAT_ENABLE
719 musb->port1_status |= USB_PORT_STAT_CONNECTION
720 |(USB_PORT_STAT_C_CONNECTION << 16);
722 /* high vs full speed is just a guess until after reset */
723 if (devctl & MUSB_DEVCTL_LSDEV)
724 musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
726 /* indicate new connection to OTG machine */
727 switch (musb->xceiv->state) {
728 case OTG_STATE_B_PERIPHERAL:
729 if (int_usb & MUSB_INTR_SUSPEND) {
730 DBG(1, "HNP: SUSPEND+CONNECT, now b_host\n");
731 int_usb &= ~MUSB_INTR_SUSPEND;
732 goto b_host;
733 } else
734 DBG(1, "CONNECT as b_peripheral???\n");
735 break;
736 case OTG_STATE_B_WAIT_ACON:
737 DBG(1, "HNP: CONNECT, now b_host\n");
738 b_host:
739 musb->xceiv->state = OTG_STATE_B_HOST;
740 hcd->self.is_b_host = 1;
741 musb->ignore_disconnect = 0;
742 del_timer(&musb->otg_timer);
743 break;
744 default:
745 if ((devctl & MUSB_DEVCTL_VBUS)
746 == (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
747 musb->xceiv->state = OTG_STATE_A_HOST;
748 hcd->self.is_b_host = 0;
750 break;
753 /* poke the root hub */
754 MUSB_HST_MODE(musb);
755 if (hcd->status_urb)
756 usb_hcd_poll_rh_status(hcd);
757 else
758 usb_hcd_resume_root_hub(hcd);
760 DBG(1, "CONNECT (%s) devctl %02x\n",
761 otg_state_string(musb), devctl);
763 #endif /* CONFIG_USB_MUSB_HDRC_HCD */
765 if ((int_usb & MUSB_INTR_DISCONNECT) && !musb->ignore_disconnect) {
766 DBG(1, "DISCONNECT (%s) as %s, devctl %02x\n",
767 otg_state_string(musb),
768 MUSB_MODE(musb), devctl);
769 handled = IRQ_HANDLED;
771 switch (musb->xceiv->state) {
772 #ifdef CONFIG_USB_MUSB_HDRC_HCD
773 case OTG_STATE_A_HOST:
774 case OTG_STATE_A_SUSPEND:
775 usb_hcd_resume_root_hub(musb_to_hcd(musb));
776 musb_root_disconnect(musb);
777 if (musb->a_wait_bcon != 0 && is_otg_enabled(musb))
778 musb_platform_try_idle(musb, jiffies
779 + msecs_to_jiffies(musb->a_wait_bcon));
780 break;
781 #endif /* HOST */
782 #ifdef CONFIG_USB_MUSB_OTG
783 case OTG_STATE_B_HOST:
784 /* REVISIT this behaves for "real disconnect"
785 * cases; make sure the other transitions from
786 * from B_HOST act right too. The B_HOST code
787 * in hnp_stop() is currently not used...
789 musb_root_disconnect(musb);
790 musb_to_hcd(musb)->self.is_b_host = 0;
791 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
792 MUSB_DEV_MODE(musb);
793 musb_g_disconnect(musb);
794 break;
795 case OTG_STATE_A_PERIPHERAL:
796 musb_hnp_stop(musb);
797 musb_root_disconnect(musb);
798 /* FALLTHROUGH */
799 case OTG_STATE_B_WAIT_ACON:
800 /* FALLTHROUGH */
801 #endif /* OTG */
802 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
803 case OTG_STATE_B_PERIPHERAL:
804 case OTG_STATE_B_IDLE:
805 musb_g_disconnect(musb);
806 break;
807 #endif /* GADGET */
808 default:
809 WARNING("unhandled DISCONNECT transition (%s)\n",
810 otg_state_string(musb));
811 break;
815 /* mentor saves a bit: bus reset and babble share the same irq.
816 * only host sees babble; only peripheral sees bus reset.
818 if (int_usb & MUSB_INTR_RESET) {
819 handled = IRQ_HANDLED;
820 if (is_host_capable() && (devctl & MUSB_DEVCTL_HM) != 0) {
822 * Looks like non-HS BABBLE can be ignored, but
823 * HS BABBLE is an error condition. For HS the solution
824 * is to avoid babble in the first place and fix what
825 * caused BABBLE. When HS BABBLE happens we can only
826 * stop the session.
828 if (devctl & (MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV))
829 DBG(1, "BABBLE devctl: %02x\n", devctl);
830 else {
831 ERR("Stopping host session -- babble\n");
832 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
834 } else if (is_peripheral_capable()) {
835 DBG(1, "BUS RESET as %s\n", otg_state_string(musb));
836 switch (musb->xceiv->state) {
837 #ifdef CONFIG_USB_OTG
838 case OTG_STATE_A_SUSPEND:
839 /* We need to ignore disconnect on suspend
840 * otherwise tusb 2.0 won't reconnect after a
841 * power cycle, which breaks otg compliance.
843 musb->ignore_disconnect = 1;
844 musb_g_reset(musb);
845 /* FALLTHROUGH */
846 case OTG_STATE_A_WAIT_BCON: /* OPT TD.4.7-900ms */
847 /* never use invalid T(a_wait_bcon) */
848 DBG(1, "HNP: in %s, %d msec timeout\n",
849 otg_state_string(musb),
850 TA_WAIT_BCON(musb));
851 mod_timer(&musb->otg_timer, jiffies
852 + msecs_to_jiffies(TA_WAIT_BCON(musb)));
853 break;
854 case OTG_STATE_A_PERIPHERAL:
855 musb->ignore_disconnect = 0;
856 del_timer(&musb->otg_timer);
857 musb_g_reset(musb);
858 break;
859 case OTG_STATE_B_WAIT_ACON:
860 DBG(1, "HNP: RESET (%s), to b_peripheral\n",
861 otg_state_string(musb));
862 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
863 musb_g_reset(musb);
864 break;
865 #endif
866 case OTG_STATE_B_IDLE:
867 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
868 /* FALLTHROUGH */
869 case OTG_STATE_B_PERIPHERAL:
870 musb_g_reset(musb);
871 break;
872 default:
873 DBG(1, "Unhandled BUS RESET as %s\n",
874 otg_state_string(musb));
879 #if 0
880 /* REVISIT ... this would be for multiplexing periodic endpoints, or
881 * supporting transfer phasing to prevent exceeding ISO bandwidth
882 * limits of a given frame or microframe.
884 * It's not needed for peripheral side, which dedicates endpoints;
885 * though it _might_ use SOF irqs for other purposes.
887 * And it's not currently needed for host side, which also dedicates
888 * endpoints, relies on TX/RX interval registers, and isn't claimed
889 * to support ISO transfers yet.
891 if (int_usb & MUSB_INTR_SOF) {
892 void __iomem *mbase = musb->mregs;
893 struct musb_hw_ep *ep;
894 u8 epnum;
895 u16 frame;
897 DBG(6, "START_OF_FRAME\n");
898 handled = IRQ_HANDLED;
900 /* start any periodic Tx transfers waiting for current frame */
901 frame = musb_readw(mbase, MUSB_FRAME);
902 ep = musb->endpoints;
903 for (epnum = 1; (epnum < musb->nr_endpoints)
904 && (musb->epmask >= (1 << epnum));
905 epnum++, ep++) {
907 * FIXME handle framecounter wraps (12 bits)
908 * eliminate duplicated StartUrb logic
910 if (ep->dwWaitFrame >= frame) {
911 ep->dwWaitFrame = 0;
912 pr_debug("SOF --> periodic TX%s on %d\n",
913 ep->tx_channel ? " DMA" : "",
914 epnum);
915 if (!ep->tx_channel)
916 musb_h_tx_start(musb, epnum);
917 else
918 cppi_hostdma_start(musb, epnum);
920 } /* end of for loop */
922 #endif
924 schedule_work(&musb->irq_work);
926 return handled;
929 /*-------------------------------------------------------------------------*/
932 * Program the HDRC to start (enable interrupts, dma, etc.).
934 void musb_start(struct musb *musb)
936 void __iomem *regs = musb->mregs;
937 u8 devctl = musb_readb(regs, MUSB_DEVCTL);
939 DBG(2, "<== devctl %02x\n", devctl);
941 /* Set INT enable registers, enable interrupts */
942 musb_writew(regs, MUSB_INTRTXE, musb->epmask);
943 musb_writew(regs, MUSB_INTRRXE, musb->epmask & 0xfffe);
944 musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
946 musb_writeb(regs, MUSB_TESTMODE, 0);
948 /* put into basic highspeed mode and start session */
949 musb_writeb(regs, MUSB_POWER, MUSB_POWER_ISOUPDATE
950 | MUSB_POWER_SOFTCONN
951 | MUSB_POWER_HSENAB
952 /* ENSUSPEND wedges tusb */
953 /* | MUSB_POWER_ENSUSPEND */
956 musb->is_active = 0;
957 devctl = musb_readb(regs, MUSB_DEVCTL);
958 devctl &= ~MUSB_DEVCTL_SESSION;
960 if (is_otg_enabled(musb)) {
961 /* session started after:
962 * (a) ID-grounded irq, host mode;
963 * (b) vbus present/connect IRQ, peripheral mode;
964 * (c) peripheral initiates, using SRP
966 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
967 musb->is_active = 1;
968 else
969 devctl |= MUSB_DEVCTL_SESSION;
971 } else if (is_host_enabled(musb)) {
972 /* assume ID pin is hard-wired to ground */
973 devctl |= MUSB_DEVCTL_SESSION;
975 } else /* peripheral is enabled */ {
976 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
977 musb->is_active = 1;
979 musb_platform_enable(musb);
980 musb_writeb(regs, MUSB_DEVCTL, devctl);
984 static void musb_generic_disable(struct musb *musb)
986 void __iomem *mbase = musb->mregs;
987 u16 temp;
989 /* disable interrupts */
990 musb_writeb(mbase, MUSB_INTRUSBE, 0);
991 musb_writew(mbase, MUSB_INTRTXE, 0);
992 musb_writew(mbase, MUSB_INTRRXE, 0);
994 /* off */
995 musb_writeb(mbase, MUSB_DEVCTL, 0);
997 /* flush pending interrupts */
998 temp = musb_readb(mbase, MUSB_INTRUSB);
999 temp = musb_readw(mbase, MUSB_INTRTX);
1000 temp = musb_readw(mbase, MUSB_INTRRX);
1005 * Make the HDRC stop (disable interrupts, etc.);
1006 * reversible by musb_start
1007 * called on gadget driver unregister
1008 * with controller locked, irqs blocked
1009 * acts as a NOP unless some role activated the hardware
1011 void musb_stop(struct musb *musb)
1013 /* stop IRQs, timers, ... */
1014 musb_platform_disable(musb);
1015 musb_generic_disable(musb);
1016 DBG(3, "HDRC disabled\n");
1018 /* FIXME
1019 * - mark host and/or peripheral drivers unusable/inactive
1020 * - disable DMA (and enable it in HdrcStart)
1021 * - make sure we can musb_start() after musb_stop(); with
1022 * OTG mode, gadget driver module rmmod/modprobe cycles that
1023 * - ...
1025 musb_platform_try_idle(musb, 0);
1028 static void musb_shutdown(struct platform_device *pdev)
1030 struct musb *musb = dev_to_musb(&pdev->dev);
1031 unsigned long flags;
1033 spin_lock_irqsave(&musb->lock, flags);
1034 musb_platform_disable(musb);
1035 musb_generic_disable(musb);
1036 spin_unlock_irqrestore(&musb->lock, flags);
1038 if (!is_otg_enabled(musb) && is_host_enabled(musb))
1039 usb_remove_hcd(musb_to_hcd(musb));
1040 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
1041 musb_platform_exit(musb);
1043 /* FIXME power down */
1047 /*-------------------------------------------------------------------------*/
1050 * The silicon either has hard-wired endpoint configurations, or else
1051 * "dynamic fifo" sizing. The driver has support for both, though at this
1052 * writing only the dynamic sizing is very well tested. Since we switched
1053 * away from compile-time hardware parameters, we can no longer rely on
1054 * dead code elimination to leave only the relevant one in the object file.
1056 * We don't currently use dynamic fifo setup capability to do anything
1057 * more than selecting one of a bunch of predefined configurations.
1059 #if defined(CONFIG_USB_MUSB_TUSB6010) || defined(CONFIG_USB_MUSB_OMAP2PLUS) \
1060 || defined(CONFIG_USB_MUSB_AM35X)
1061 static ushort __initdata fifo_mode = 4;
1062 #elif defined(CONFIG_USB_MUSB_UX500)
1063 static ushort __initdata fifo_mode = 5;
1064 #else
1065 static ushort __initdata fifo_mode = 2;
1066 #endif
1068 /* "modprobe ... fifo_mode=1" etc */
1069 module_param(fifo_mode, ushort, 0);
1070 MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
1073 * tables defining fifo_mode values. define more if you like.
1074 * for host side, make sure both halves of ep1 are set up.
1077 /* mode 0 - fits in 2KB */
1078 static struct musb_fifo_cfg __initdata mode_0_cfg[] = {
1079 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1080 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1081 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1082 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1083 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1086 /* mode 1 - fits in 4KB */
1087 static struct musb_fifo_cfg __initdata mode_1_cfg[] = {
1088 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1089 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1090 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1091 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1092 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1095 /* mode 2 - fits in 4KB */
1096 static struct musb_fifo_cfg __initdata mode_2_cfg[] = {
1097 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1098 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1099 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1100 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1101 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1102 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1105 /* mode 3 - fits in 4KB */
1106 static struct musb_fifo_cfg __initdata mode_3_cfg[] = {
1107 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1108 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1109 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1110 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1111 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1112 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1115 /* mode 4 - fits in 16KB */
1116 static struct musb_fifo_cfg __initdata mode_4_cfg[] = {
1117 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1118 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1119 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1120 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1121 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1122 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1123 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1124 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1125 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1126 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1127 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 512, },
1128 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 512, },
1129 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 512, },
1130 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 512, },
1131 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 512, },
1132 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 512, },
1133 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 512, },
1134 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 512, },
1135 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 256, },
1136 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 64, },
1137 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 256, },
1138 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 64, },
1139 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 256, },
1140 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 64, },
1141 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1142 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1143 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1146 /* mode 5 - fits in 8KB */
1147 static struct musb_fifo_cfg __initdata mode_5_cfg[] = {
1148 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1149 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1150 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1151 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1152 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1153 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1154 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1155 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1156 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1157 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1158 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 32, },
1159 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 32, },
1160 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 32, },
1161 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 32, },
1162 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 32, },
1163 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 32, },
1164 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 32, },
1165 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 32, },
1166 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 32, },
1167 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 32, },
1168 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 32, },
1169 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 32, },
1170 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 32, },
1171 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 32, },
1172 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1173 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1174 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1178 * configure a fifo; for non-shared endpoints, this may be called
1179 * once for a tx fifo and once for an rx fifo.
1181 * returns negative errno or offset for next fifo.
1183 static int __init
1184 fifo_setup(struct musb *musb, struct musb_hw_ep *hw_ep,
1185 const struct musb_fifo_cfg *cfg, u16 offset)
1187 void __iomem *mbase = musb->mregs;
1188 int size = 0;
1189 u16 maxpacket = cfg->maxpacket;
1190 u16 c_off = offset >> 3;
1191 u8 c_size;
1193 /* expect hw_ep has already been zero-initialized */
1195 size = ffs(max(maxpacket, (u16) 8)) - 1;
1196 maxpacket = 1 << size;
1198 c_size = size - 3;
1199 if (cfg->mode == BUF_DOUBLE) {
1200 if ((offset + (maxpacket << 1)) >
1201 (1 << (musb->config->ram_bits + 2)))
1202 return -EMSGSIZE;
1203 c_size |= MUSB_FIFOSZ_DPB;
1204 } else {
1205 if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1206 return -EMSGSIZE;
1209 /* configure the FIFO */
1210 musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1212 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1213 /* EP0 reserved endpoint for control, bidirectional;
1214 * EP1 reserved for bulk, two unidirection halves.
1216 if (hw_ep->epnum == 1)
1217 musb->bulk_ep = hw_ep;
1218 /* REVISIT error check: be sure ep0 can both rx and tx ... */
1219 #endif
1220 switch (cfg->style) {
1221 case FIFO_TX:
1222 musb_write_txfifosz(mbase, c_size);
1223 musb_write_txfifoadd(mbase, c_off);
1224 hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1225 hw_ep->max_packet_sz_tx = maxpacket;
1226 break;
1227 case FIFO_RX:
1228 musb_write_rxfifosz(mbase, c_size);
1229 musb_write_rxfifoadd(mbase, c_off);
1230 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1231 hw_ep->max_packet_sz_rx = maxpacket;
1232 break;
1233 case FIFO_RXTX:
1234 musb_write_txfifosz(mbase, c_size);
1235 musb_write_txfifoadd(mbase, c_off);
1236 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1237 hw_ep->max_packet_sz_rx = maxpacket;
1239 musb_write_rxfifosz(mbase, c_size);
1240 musb_write_rxfifoadd(mbase, c_off);
1241 hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1242 hw_ep->max_packet_sz_tx = maxpacket;
1244 hw_ep->is_shared_fifo = true;
1245 break;
1248 /* NOTE rx and tx endpoint irqs aren't managed separately,
1249 * which happens to be ok
1251 musb->epmask |= (1 << hw_ep->epnum);
1253 return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1256 static struct musb_fifo_cfg __initdata ep0_cfg = {
1257 .style = FIFO_RXTX, .maxpacket = 64,
1260 static int __init ep_config_from_table(struct musb *musb)
1262 const struct musb_fifo_cfg *cfg;
1263 unsigned i, n;
1264 int offset;
1265 struct musb_hw_ep *hw_ep = musb->endpoints;
1267 if (musb->config->fifo_cfg) {
1268 cfg = musb->config->fifo_cfg;
1269 n = musb->config->fifo_cfg_size;
1270 goto done;
1273 switch (fifo_mode) {
1274 default:
1275 fifo_mode = 0;
1276 /* FALLTHROUGH */
1277 case 0:
1278 cfg = mode_0_cfg;
1279 n = ARRAY_SIZE(mode_0_cfg);
1280 break;
1281 case 1:
1282 cfg = mode_1_cfg;
1283 n = ARRAY_SIZE(mode_1_cfg);
1284 break;
1285 case 2:
1286 cfg = mode_2_cfg;
1287 n = ARRAY_SIZE(mode_2_cfg);
1288 break;
1289 case 3:
1290 cfg = mode_3_cfg;
1291 n = ARRAY_SIZE(mode_3_cfg);
1292 break;
1293 case 4:
1294 cfg = mode_4_cfg;
1295 n = ARRAY_SIZE(mode_4_cfg);
1296 break;
1297 case 5:
1298 cfg = mode_5_cfg;
1299 n = ARRAY_SIZE(mode_5_cfg);
1300 break;
1303 printk(KERN_DEBUG "%s: setup fifo_mode %d\n",
1304 musb_driver_name, fifo_mode);
1307 done:
1308 offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1309 /* assert(offset > 0) */
1311 /* NOTE: for RTL versions >= 1.400 EPINFO and RAMINFO would
1312 * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1315 for (i = 0; i < n; i++) {
1316 u8 epn = cfg->hw_ep_num;
1318 if (epn >= musb->config->num_eps) {
1319 pr_debug("%s: invalid ep %d\n",
1320 musb_driver_name, epn);
1321 return -EINVAL;
1323 offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1324 if (offset < 0) {
1325 pr_debug("%s: mem overrun, ep %d\n",
1326 musb_driver_name, epn);
1327 return -EINVAL;
1329 epn++;
1330 musb->nr_endpoints = max(epn, musb->nr_endpoints);
1333 printk(KERN_DEBUG "%s: %d/%d max ep, %d/%d memory\n",
1334 musb_driver_name,
1335 n + 1, musb->config->num_eps * 2 - 1,
1336 offset, (1 << (musb->config->ram_bits + 2)));
1338 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1339 if (!musb->bulk_ep) {
1340 pr_debug("%s: missing bulk\n", musb_driver_name);
1341 return -EINVAL;
1343 #endif
1345 return 0;
1350 * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1351 * @param musb the controller
1353 static int __init ep_config_from_hw(struct musb *musb)
1355 u8 epnum = 0;
1356 struct musb_hw_ep *hw_ep;
1357 void *mbase = musb->mregs;
1358 int ret = 0;
1360 DBG(2, "<== static silicon ep config\n");
1362 /* FIXME pick up ep0 maxpacket size */
1364 for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1365 musb_ep_select(mbase, epnum);
1366 hw_ep = musb->endpoints + epnum;
1368 ret = musb_read_fifosize(musb, hw_ep, epnum);
1369 if (ret < 0)
1370 break;
1372 /* FIXME set up hw_ep->{rx,tx}_double_buffered */
1374 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1375 /* pick an RX/TX endpoint for bulk */
1376 if (hw_ep->max_packet_sz_tx < 512
1377 || hw_ep->max_packet_sz_rx < 512)
1378 continue;
1380 /* REVISIT: this algorithm is lazy, we should at least
1381 * try to pick a double buffered endpoint.
1383 if (musb->bulk_ep)
1384 continue;
1385 musb->bulk_ep = hw_ep;
1386 #endif
1389 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1390 if (!musb->bulk_ep) {
1391 pr_debug("%s: missing bulk\n", musb_driver_name);
1392 return -EINVAL;
1394 #endif
1396 return 0;
1399 enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1401 /* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1402 * configure endpoints, or take their config from silicon
1404 static int __init musb_core_init(u16 musb_type, struct musb *musb)
1406 u8 reg;
1407 char *type;
1408 char aInfo[90], aRevision[32], aDate[12];
1409 void __iomem *mbase = musb->mregs;
1410 int status = 0;
1411 int i;
1413 /* log core options (read using indexed model) */
1414 reg = musb_read_configdata(mbase);
1416 strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1417 if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1418 strcat(aInfo, ", dyn FIFOs");
1419 musb->dyn_fifo = true;
1421 if (reg & MUSB_CONFIGDATA_MPRXE) {
1422 strcat(aInfo, ", bulk combine");
1423 musb->bulk_combine = true;
1425 if (reg & MUSB_CONFIGDATA_MPTXE) {
1426 strcat(aInfo, ", bulk split");
1427 musb->bulk_split = true;
1429 if (reg & MUSB_CONFIGDATA_HBRXE) {
1430 strcat(aInfo, ", HB-ISO Rx");
1431 musb->hb_iso_rx = true;
1433 if (reg & MUSB_CONFIGDATA_HBTXE) {
1434 strcat(aInfo, ", HB-ISO Tx");
1435 musb->hb_iso_tx = true;
1437 if (reg & MUSB_CONFIGDATA_SOFTCONE)
1438 strcat(aInfo, ", SoftConn");
1440 printk(KERN_DEBUG "%s: ConfigData=0x%02x (%s)\n",
1441 musb_driver_name, reg, aInfo);
1443 aDate[0] = 0;
1444 if (MUSB_CONTROLLER_MHDRC == musb_type) {
1445 musb->is_multipoint = 1;
1446 type = "M";
1447 } else {
1448 musb->is_multipoint = 0;
1449 type = "";
1450 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1451 #ifndef CONFIG_USB_OTG_BLACKLIST_HUB
1452 printk(KERN_ERR
1453 "%s: kernel must blacklist external hubs\n",
1454 musb_driver_name);
1455 #endif
1456 #endif
1459 /* log release info */
1460 musb->hwvers = musb_read_hwvers(mbase);
1461 snprintf(aRevision, 32, "%d.%d%s", MUSB_HWVERS_MAJOR(musb->hwvers),
1462 MUSB_HWVERS_MINOR(musb->hwvers),
1463 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1464 printk(KERN_DEBUG "%s: %sHDRC RTL version %s %s\n",
1465 musb_driver_name, type, aRevision, aDate);
1467 /* configure ep0 */
1468 musb_configure_ep0(musb);
1470 /* discover endpoint configuration */
1471 musb->nr_endpoints = 1;
1472 musb->epmask = 1;
1474 if (musb->dyn_fifo)
1475 status = ep_config_from_table(musb);
1476 else
1477 status = ep_config_from_hw(musb);
1479 if (status < 0)
1480 return status;
1482 /* finish init, and print endpoint config */
1483 for (i = 0; i < musb->nr_endpoints; i++) {
1484 struct musb_hw_ep *hw_ep = musb->endpoints + i;
1486 hw_ep->fifo = MUSB_FIFO_OFFSET(i) + mbase;
1487 #ifdef CONFIG_USB_MUSB_TUSB6010
1488 hw_ep->fifo_async = musb->async + 0x400 + MUSB_FIFO_OFFSET(i);
1489 hw_ep->fifo_sync = musb->sync + 0x400 + MUSB_FIFO_OFFSET(i);
1490 hw_ep->fifo_sync_va =
1491 musb->sync_va + 0x400 + MUSB_FIFO_OFFSET(i);
1493 if (i == 0)
1494 hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1495 else
1496 hw_ep->conf = mbase + 0x400 + (((i - 1) & 0xf) << 2);
1497 #endif
1499 hw_ep->regs = MUSB_EP_OFFSET(i, 0) + mbase;
1500 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1501 hw_ep->target_regs = musb_read_target_reg_base(i, mbase);
1502 hw_ep->rx_reinit = 1;
1503 hw_ep->tx_reinit = 1;
1504 #endif
1506 if (hw_ep->max_packet_sz_tx) {
1507 DBG(1,
1508 "%s: hw_ep %d%s, %smax %d\n",
1509 musb_driver_name, i,
1510 hw_ep->is_shared_fifo ? "shared" : "tx",
1511 hw_ep->tx_double_buffered
1512 ? "doublebuffer, " : "",
1513 hw_ep->max_packet_sz_tx);
1515 if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1516 DBG(1,
1517 "%s: hw_ep %d%s, %smax %d\n",
1518 musb_driver_name, i,
1519 "rx",
1520 hw_ep->rx_double_buffered
1521 ? "doublebuffer, " : "",
1522 hw_ep->max_packet_sz_rx);
1524 if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1525 DBG(1, "hw_ep %d not configured\n", i);
1528 return 0;
1531 /*-------------------------------------------------------------------------*/
1533 #if defined(CONFIG_SOC_OMAP2430) || defined(CONFIG_SOC_OMAP3430) || \
1534 defined(CONFIG_ARCH_OMAP4) || defined(CONFIG_ARCH_U8500) || \
1535 defined(CONFIG_ARCH_U5500)
1537 static irqreturn_t generic_interrupt(int irq, void *__hci)
1539 unsigned long flags;
1540 irqreturn_t retval = IRQ_NONE;
1541 struct musb *musb = __hci;
1543 spin_lock_irqsave(&musb->lock, flags);
1545 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
1546 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
1547 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
1549 if (musb->int_usb || musb->int_tx || musb->int_rx)
1550 retval = musb_interrupt(musb);
1552 spin_unlock_irqrestore(&musb->lock, flags);
1554 return retval;
1557 #else
1558 #define generic_interrupt NULL
1559 #endif
1562 * handle all the irqs defined by the HDRC core. for now we expect: other
1563 * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1564 * will be assigned, and the irq will already have been acked.
1566 * called in irq context with spinlock held, irqs blocked
1568 irqreturn_t musb_interrupt(struct musb *musb)
1570 irqreturn_t retval = IRQ_NONE;
1571 u8 devctl, power;
1572 int ep_num;
1573 u32 reg;
1575 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1576 power = musb_readb(musb->mregs, MUSB_POWER);
1578 DBG(4, "** IRQ %s usb%04x tx%04x rx%04x\n",
1579 (devctl & MUSB_DEVCTL_HM) ? "host" : "peripheral",
1580 musb->int_usb, musb->int_tx, musb->int_rx);
1582 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1583 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
1584 if (!musb->gadget_driver) {
1585 DBG(5, "No gadget driver loaded\n");
1586 return IRQ_HANDLED;
1588 #endif
1590 /* the core can interrupt us for multiple reasons; docs have
1591 * a generic interrupt flowchart to follow
1593 if (musb->int_usb)
1594 retval |= musb_stage0_irq(musb, musb->int_usb,
1595 devctl, power);
1597 /* "stage 1" is handling endpoint irqs */
1599 /* handle endpoint 0 first */
1600 if (musb->int_tx & 1) {
1601 if (devctl & MUSB_DEVCTL_HM)
1602 retval |= musb_h_ep0_irq(musb);
1603 else
1604 retval |= musb_g_ep0_irq(musb);
1607 /* RX on endpoints 1-15 */
1608 reg = musb->int_rx >> 1;
1609 ep_num = 1;
1610 while (reg) {
1611 if (reg & 1) {
1612 /* musb_ep_select(musb->mregs, ep_num); */
1613 /* REVISIT just retval = ep->rx_irq(...) */
1614 retval = IRQ_HANDLED;
1615 if (devctl & MUSB_DEVCTL_HM) {
1616 if (is_host_capable())
1617 musb_host_rx(musb, ep_num);
1618 } else {
1619 if (is_peripheral_capable())
1620 musb_g_rx(musb, ep_num);
1624 reg >>= 1;
1625 ep_num++;
1628 /* TX on endpoints 1-15 */
1629 reg = musb->int_tx >> 1;
1630 ep_num = 1;
1631 while (reg) {
1632 if (reg & 1) {
1633 /* musb_ep_select(musb->mregs, ep_num); */
1634 /* REVISIT just retval |= ep->tx_irq(...) */
1635 retval = IRQ_HANDLED;
1636 if (devctl & MUSB_DEVCTL_HM) {
1637 if (is_host_capable())
1638 musb_host_tx(musb, ep_num);
1639 } else {
1640 if (is_peripheral_capable())
1641 musb_g_tx(musb, ep_num);
1644 reg >>= 1;
1645 ep_num++;
1648 return retval;
1652 #ifndef CONFIG_MUSB_PIO_ONLY
1653 static int __initdata use_dma = 1;
1655 /* "modprobe ... use_dma=0" etc */
1656 module_param(use_dma, bool, 0);
1657 MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1659 void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1661 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1663 /* called with controller lock already held */
1665 if (!epnum) {
1666 #ifndef CONFIG_USB_TUSB_OMAP_DMA
1667 if (!is_cppi_enabled()) {
1668 /* endpoint 0 */
1669 if (devctl & MUSB_DEVCTL_HM)
1670 musb_h_ep0_irq(musb);
1671 else
1672 musb_g_ep0_irq(musb);
1674 #endif
1675 } else {
1676 /* endpoints 1..15 */
1677 if (transmit) {
1678 if (devctl & MUSB_DEVCTL_HM) {
1679 if (is_host_capable())
1680 musb_host_tx(musb, epnum);
1681 } else {
1682 if (is_peripheral_capable())
1683 musb_g_tx(musb, epnum);
1685 } else {
1686 /* receive */
1687 if (devctl & MUSB_DEVCTL_HM) {
1688 if (is_host_capable())
1689 musb_host_rx(musb, epnum);
1690 } else {
1691 if (is_peripheral_capable())
1692 musb_g_rx(musb, epnum);
1698 #else
1699 #define use_dma 0
1700 #endif
1702 /*-------------------------------------------------------------------------*/
1704 #ifdef CONFIG_SYSFS
1706 static ssize_t
1707 musb_mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1709 struct musb *musb = dev_to_musb(dev);
1710 unsigned long flags;
1711 int ret = -EINVAL;
1713 spin_lock_irqsave(&musb->lock, flags);
1714 ret = sprintf(buf, "%s\n", otg_state_string(musb));
1715 spin_unlock_irqrestore(&musb->lock, flags);
1717 return ret;
1720 static ssize_t
1721 musb_mode_store(struct device *dev, struct device_attribute *attr,
1722 const char *buf, size_t n)
1724 struct musb *musb = dev_to_musb(dev);
1725 unsigned long flags;
1726 int status;
1728 spin_lock_irqsave(&musb->lock, flags);
1729 if (sysfs_streq(buf, "host"))
1730 status = musb_platform_set_mode(musb, MUSB_HOST);
1731 else if (sysfs_streq(buf, "peripheral"))
1732 status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1733 else if (sysfs_streq(buf, "otg"))
1734 status = musb_platform_set_mode(musb, MUSB_OTG);
1735 else
1736 status = -EINVAL;
1737 spin_unlock_irqrestore(&musb->lock, flags);
1739 return (status == 0) ? n : status;
1741 static DEVICE_ATTR(mode, 0644, musb_mode_show, musb_mode_store);
1743 static ssize_t
1744 musb_vbus_store(struct device *dev, struct device_attribute *attr,
1745 const char *buf, size_t n)
1747 struct musb *musb = dev_to_musb(dev);
1748 unsigned long flags;
1749 unsigned long val;
1751 if (sscanf(buf, "%lu", &val) < 1) {
1752 dev_err(dev, "Invalid VBUS timeout ms value\n");
1753 return -EINVAL;
1756 spin_lock_irqsave(&musb->lock, flags);
1757 /* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1758 musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1759 if (musb->xceiv->state == OTG_STATE_A_WAIT_BCON)
1760 musb->is_active = 0;
1761 musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1762 spin_unlock_irqrestore(&musb->lock, flags);
1764 return n;
1767 static ssize_t
1768 musb_vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1770 struct musb *musb = dev_to_musb(dev);
1771 unsigned long flags;
1772 unsigned long val;
1773 int vbus;
1775 spin_lock_irqsave(&musb->lock, flags);
1776 val = musb->a_wait_bcon;
1777 /* FIXME get_vbus_status() is normally #defined as false...
1778 * and is effectively TUSB-specific.
1780 vbus = musb_platform_get_vbus_status(musb);
1781 spin_unlock_irqrestore(&musb->lock, flags);
1783 return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1784 vbus ? "on" : "off", val);
1786 static DEVICE_ATTR(vbus, 0644, musb_vbus_show, musb_vbus_store);
1788 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1790 /* Gadget drivers can't know that a host is connected so they might want
1791 * to start SRP, but users can. This allows userspace to trigger SRP.
1793 static ssize_t
1794 musb_srp_store(struct device *dev, struct device_attribute *attr,
1795 const char *buf, size_t n)
1797 struct musb *musb = dev_to_musb(dev);
1798 unsigned short srp;
1800 if (sscanf(buf, "%hu", &srp) != 1
1801 || (srp != 1)) {
1802 dev_err(dev, "SRP: Value must be 1\n");
1803 return -EINVAL;
1806 if (srp == 1)
1807 musb_g_wakeup(musb);
1809 return n;
1811 static DEVICE_ATTR(srp, 0644, NULL, musb_srp_store);
1813 #endif /* CONFIG_USB_GADGET_MUSB_HDRC */
1815 static struct attribute *musb_attributes[] = {
1816 &dev_attr_mode.attr,
1817 &dev_attr_vbus.attr,
1818 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1819 &dev_attr_srp.attr,
1820 #endif
1821 NULL
1824 static const struct attribute_group musb_attr_group = {
1825 .attrs = musb_attributes,
1828 #endif /* sysfs */
1830 /* Only used to provide driver mode change events */
1831 static void musb_irq_work(struct work_struct *data)
1833 struct musb *musb = container_of(data, struct musb, irq_work);
1834 static int old_state;
1836 if (musb->xceiv->state != old_state) {
1837 old_state = musb->xceiv->state;
1838 sysfs_notify(&musb->controller->kobj, NULL, "mode");
1842 /* --------------------------------------------------------------------------
1843 * Init support
1846 static struct musb *__init
1847 allocate_instance(struct device *dev,
1848 struct musb_hdrc_config *config, void __iomem *mbase)
1850 struct musb *musb;
1851 struct musb_hw_ep *ep;
1852 int epnum;
1853 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1854 struct usb_hcd *hcd;
1856 hcd = usb_create_hcd(&musb_hc_driver, dev, dev_name(dev));
1857 if (!hcd)
1858 return NULL;
1859 /* usbcore sets dev->driver_data to hcd, and sometimes uses that... */
1861 musb = hcd_to_musb(hcd);
1862 INIT_LIST_HEAD(&musb->control);
1863 INIT_LIST_HEAD(&musb->in_bulk);
1864 INIT_LIST_HEAD(&musb->out_bulk);
1866 hcd->uses_new_polling = 1;
1867 hcd->has_tt = 1;
1869 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
1870 musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
1871 #else
1872 musb = kzalloc(sizeof *musb, GFP_KERNEL);
1873 if (!musb)
1874 return NULL;
1876 #endif
1877 dev_set_drvdata(dev, musb);
1878 musb->mregs = mbase;
1879 musb->ctrl_base = mbase;
1880 musb->nIrq = -ENODEV;
1881 musb->config = config;
1882 BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
1883 for (epnum = 0, ep = musb->endpoints;
1884 epnum < musb->config->num_eps;
1885 epnum++, ep++) {
1886 ep->musb = musb;
1887 ep->epnum = epnum;
1890 musb->controller = dev;
1892 return musb;
1895 static void musb_free(struct musb *musb)
1897 /* this has multiple entry modes. it handles fault cleanup after
1898 * probe(), where things may be partially set up, as well as rmmod
1899 * cleanup after everything's been de-activated.
1902 #ifdef CONFIG_SYSFS
1903 sysfs_remove_group(&musb->controller->kobj, &musb_attr_group);
1904 #endif
1906 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1907 musb_gadget_cleanup(musb);
1908 #endif
1910 if (musb->nIrq >= 0) {
1911 if (musb->irq_wake)
1912 disable_irq_wake(musb->nIrq);
1913 free_irq(musb->nIrq, musb);
1915 if (is_dma_capable() && musb->dma_controller) {
1916 struct dma_controller *c = musb->dma_controller;
1918 (void) c->stop(c);
1919 dma_controller_destroy(c);
1922 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1923 usb_put_hcd(musb_to_hcd(musb));
1924 #else
1925 kfree(musb);
1926 #endif
1930 * Perform generic per-controller initialization.
1932 * @pDevice: the controller (already clocked, etc)
1933 * @nIrq: irq
1934 * @mregs: virtual address of controller registers,
1935 * not yet corrected for platform-specific offsets
1937 static int __init
1938 musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
1940 int status;
1941 struct musb *musb;
1942 struct musb_hdrc_platform_data *plat = dev->platform_data;
1944 /* The driver might handle more features than the board; OK.
1945 * Fail when the board needs a feature that's not enabled.
1947 if (!plat) {
1948 dev_dbg(dev, "no platform_data?\n");
1949 status = -ENODEV;
1950 goto fail0;
1953 /* allocate */
1954 musb = allocate_instance(dev, plat->config, ctrl);
1955 if (!musb) {
1956 status = -ENOMEM;
1957 goto fail0;
1960 pm_runtime_use_autosuspend(musb->controller);
1961 pm_runtime_set_autosuspend_delay(musb->controller, 200);
1962 pm_runtime_enable(musb->controller);
1964 spin_lock_init(&musb->lock);
1965 musb->board_mode = plat->mode;
1966 musb->board_set_power = plat->set_power;
1967 musb->min_power = plat->min_power;
1968 musb->ops = plat->platform_ops;
1970 /* The musb_platform_init() call:
1971 * - adjusts musb->mregs and musb->isr if needed,
1972 * - may initialize an integrated tranceiver
1973 * - initializes musb->xceiv, usually by otg_get_transceiver()
1974 * - stops powering VBUS
1976 * There are various transciever configurations. Blackfin,
1977 * DaVinci, TUSB60x0, and others integrate them. OMAP3 uses
1978 * external/discrete ones in various flavors (twl4030 family,
1979 * isp1504, non-OTG, etc) mostly hooking up through ULPI.
1981 musb->isr = generic_interrupt;
1982 status = musb_platform_init(musb);
1983 if (status < 0)
1984 goto fail1;
1986 if (!musb->isr) {
1987 status = -ENODEV;
1988 goto fail3;
1991 if (!musb->xceiv->io_ops) {
1992 musb->xceiv->io_priv = musb->mregs;
1993 musb->xceiv->io_ops = &musb_ulpi_access;
1996 #ifndef CONFIG_MUSB_PIO_ONLY
1997 if (use_dma && dev->dma_mask) {
1998 struct dma_controller *c;
2000 c = dma_controller_create(musb, musb->mregs);
2001 musb->dma_controller = c;
2002 if (c)
2003 (void) c->start(c);
2005 #endif
2006 /* ideally this would be abstracted in platform setup */
2007 if (!is_dma_capable() || !musb->dma_controller)
2008 dev->dma_mask = NULL;
2010 /* be sure interrupts are disabled before connecting ISR */
2011 musb_platform_disable(musb);
2012 musb_generic_disable(musb);
2014 /* setup musb parts of the core (especially endpoints) */
2015 status = musb_core_init(plat->config->multipoint
2016 ? MUSB_CONTROLLER_MHDRC
2017 : MUSB_CONTROLLER_HDRC, musb);
2018 if (status < 0)
2019 goto fail3;
2021 #ifdef CONFIG_USB_MUSB_OTG
2022 setup_timer(&musb->otg_timer, musb_otg_timer_func, (unsigned long) musb);
2023 #endif
2025 /* Init IRQ workqueue before request_irq */
2026 INIT_WORK(&musb->irq_work, musb_irq_work);
2028 /* attach to the IRQ */
2029 if (request_irq(nIrq, musb->isr, 0, dev_name(dev), musb)) {
2030 dev_err(dev, "request_irq %d failed!\n", nIrq);
2031 status = -ENODEV;
2032 goto fail3;
2034 musb->nIrq = nIrq;
2035 /* FIXME this handles wakeup irqs wrong */
2036 if (enable_irq_wake(nIrq) == 0) {
2037 musb->irq_wake = 1;
2038 device_init_wakeup(dev, 1);
2039 } else {
2040 musb->irq_wake = 0;
2043 /* host side needs more setup */
2044 if (is_host_enabled(musb)) {
2045 struct usb_hcd *hcd = musb_to_hcd(musb);
2047 otg_set_host(musb->xceiv, &hcd->self);
2049 if (is_otg_enabled(musb))
2050 hcd->self.otg_port = 1;
2051 musb->xceiv->host = &hcd->self;
2052 hcd->power_budget = 2 * (plat->power ? : 250);
2054 /* program PHY to use external vBus if required */
2055 if (plat->extvbus) {
2056 u8 busctl = musb_read_ulpi_buscontrol(musb->mregs);
2057 busctl |= MUSB_ULPI_USE_EXTVBUS;
2058 musb_write_ulpi_buscontrol(musb->mregs, busctl);
2062 /* For the host-only role, we can activate right away.
2063 * (We expect the ID pin to be forcibly grounded!!)
2064 * Otherwise, wait till the gadget driver hooks up.
2066 if (!is_otg_enabled(musb) && is_host_enabled(musb)) {
2067 struct usb_hcd *hcd = musb_to_hcd(musb);
2069 MUSB_HST_MODE(musb);
2070 musb->xceiv->default_a = 1;
2071 musb->xceiv->state = OTG_STATE_A_IDLE;
2073 status = usb_add_hcd(musb_to_hcd(musb), -1, 0);
2075 hcd->self.uses_pio_for_control = 1;
2076 DBG(1, "%s mode, status %d, devctl %02x %c\n",
2077 "HOST", status,
2078 musb_readb(musb->mregs, MUSB_DEVCTL),
2079 (musb_readb(musb->mregs, MUSB_DEVCTL)
2080 & MUSB_DEVCTL_BDEVICE
2081 ? 'B' : 'A'));
2083 } else /* peripheral is enabled */ {
2084 MUSB_DEV_MODE(musb);
2085 musb->xceiv->default_a = 0;
2086 musb->xceiv->state = OTG_STATE_B_IDLE;
2088 status = musb_gadget_setup(musb);
2090 DBG(1, "%s mode, status %d, dev%02x\n",
2091 is_otg_enabled(musb) ? "OTG" : "PERIPHERAL",
2092 status,
2093 musb_readb(musb->mregs, MUSB_DEVCTL));
2096 if (status < 0)
2097 goto fail3;
2099 pm_runtime_put(musb->controller);
2101 status = musb_init_debugfs(musb);
2102 if (status < 0)
2103 goto fail4;
2105 #ifdef CONFIG_SYSFS
2106 status = sysfs_create_group(&musb->controller->kobj, &musb_attr_group);
2107 if (status)
2108 goto fail5;
2109 #endif
2111 dev_info(dev, "USB %s mode controller at %p using %s, IRQ %d\n",
2112 ({char *s;
2113 switch (musb->board_mode) {
2114 case MUSB_HOST: s = "Host"; break;
2115 case MUSB_PERIPHERAL: s = "Peripheral"; break;
2116 default: s = "OTG"; break;
2117 }; s; }),
2118 ctrl,
2119 (is_dma_capable() && musb->dma_controller)
2120 ? "DMA" : "PIO",
2121 musb->nIrq);
2123 return 0;
2125 fail5:
2126 musb_exit_debugfs(musb);
2128 fail4:
2129 if (!is_otg_enabled(musb) && is_host_enabled(musb))
2130 usb_remove_hcd(musb_to_hcd(musb));
2131 else
2132 musb_gadget_cleanup(musb);
2134 fail3:
2135 if (musb->irq_wake)
2136 device_init_wakeup(dev, 0);
2137 musb_platform_exit(musb);
2139 fail1:
2140 dev_err(musb->controller,
2141 "musb_init_controller failed with status %d\n", status);
2143 musb_free(musb);
2145 fail0:
2147 return status;
2151 /*-------------------------------------------------------------------------*/
2153 /* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2154 * bridge to a platform device; this driver then suffices.
2157 #ifndef CONFIG_MUSB_PIO_ONLY
2158 static u64 *orig_dma_mask;
2159 #endif
2161 static int __init musb_probe(struct platform_device *pdev)
2163 struct device *dev = &pdev->dev;
2164 int irq = platform_get_irq_byname(pdev, "mc");
2165 int status;
2166 struct resource *iomem;
2167 void __iomem *base;
2169 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2170 if (!iomem || irq <= 0)
2171 return -ENODEV;
2173 base = ioremap(iomem->start, resource_size(iomem));
2174 if (!base) {
2175 dev_err(dev, "ioremap failed\n");
2176 return -ENOMEM;
2179 #ifndef CONFIG_MUSB_PIO_ONLY
2180 /* clobbered by use_dma=n */
2181 orig_dma_mask = dev->dma_mask;
2182 #endif
2183 status = musb_init_controller(dev, irq, base);
2184 if (status < 0)
2185 iounmap(base);
2187 return status;
2190 static int __exit musb_remove(struct platform_device *pdev)
2192 struct musb *musb = dev_to_musb(&pdev->dev);
2193 void __iomem *ctrl_base = musb->ctrl_base;
2195 /* this gets called on rmmod.
2196 * - Host mode: host may still be active
2197 * - Peripheral mode: peripheral is deactivated (or never-activated)
2198 * - OTG mode: both roles are deactivated (or never-activated)
2200 pm_runtime_get_sync(musb->controller);
2201 musb_exit_debugfs(musb);
2202 musb_shutdown(pdev);
2204 pm_runtime_put(musb->controller);
2205 musb_free(musb);
2206 iounmap(ctrl_base);
2207 device_init_wakeup(&pdev->dev, 0);
2208 #ifndef CONFIG_MUSB_PIO_ONLY
2209 pdev->dev.dma_mask = orig_dma_mask;
2210 #endif
2211 return 0;
2214 #ifdef CONFIG_PM
2216 static void musb_save_context(struct musb *musb)
2218 int i;
2219 void __iomem *musb_base = musb->mregs;
2220 void __iomem *epio;
2222 if (is_host_enabled(musb)) {
2223 musb->context.frame = musb_readw(musb_base, MUSB_FRAME);
2224 musb->context.testmode = musb_readb(musb_base, MUSB_TESTMODE);
2225 musb->context.busctl = musb_read_ulpi_buscontrol(musb->mregs);
2227 musb->context.power = musb_readb(musb_base, MUSB_POWER);
2228 musb->context.intrtxe = musb_readw(musb_base, MUSB_INTRTXE);
2229 musb->context.intrrxe = musb_readw(musb_base, MUSB_INTRRXE);
2230 musb->context.intrusbe = musb_readb(musb_base, MUSB_INTRUSBE);
2231 musb->context.index = musb_readb(musb_base, MUSB_INDEX);
2232 musb->context.devctl = musb_readb(musb_base, MUSB_DEVCTL);
2234 for (i = 0; i < musb->config->num_eps; ++i) {
2235 epio = musb->endpoints[i].regs;
2236 musb->context.index_regs[i].txmaxp =
2237 musb_readw(epio, MUSB_TXMAXP);
2238 musb->context.index_regs[i].txcsr =
2239 musb_readw(epio, MUSB_TXCSR);
2240 musb->context.index_regs[i].rxmaxp =
2241 musb_readw(epio, MUSB_RXMAXP);
2242 musb->context.index_regs[i].rxcsr =
2243 musb_readw(epio, MUSB_RXCSR);
2245 if (musb->dyn_fifo) {
2246 musb->context.index_regs[i].txfifoadd =
2247 musb_read_txfifoadd(musb_base);
2248 musb->context.index_regs[i].rxfifoadd =
2249 musb_read_rxfifoadd(musb_base);
2250 musb->context.index_regs[i].txfifosz =
2251 musb_read_txfifosz(musb_base);
2252 musb->context.index_regs[i].rxfifosz =
2253 musb_read_rxfifosz(musb_base);
2255 if (is_host_enabled(musb)) {
2256 musb->context.index_regs[i].txtype =
2257 musb_readb(epio, MUSB_TXTYPE);
2258 musb->context.index_regs[i].txinterval =
2259 musb_readb(epio, MUSB_TXINTERVAL);
2260 musb->context.index_regs[i].rxtype =
2261 musb_readb(epio, MUSB_RXTYPE);
2262 musb->context.index_regs[i].rxinterval =
2263 musb_readb(epio, MUSB_RXINTERVAL);
2265 musb->context.index_regs[i].txfunaddr =
2266 musb_read_txfunaddr(musb_base, i);
2267 musb->context.index_regs[i].txhubaddr =
2268 musb_read_txhubaddr(musb_base, i);
2269 musb->context.index_regs[i].txhubport =
2270 musb_read_txhubport(musb_base, i);
2272 musb->context.index_regs[i].rxfunaddr =
2273 musb_read_rxfunaddr(musb_base, i);
2274 musb->context.index_regs[i].rxhubaddr =
2275 musb_read_rxhubaddr(musb_base, i);
2276 musb->context.index_regs[i].rxhubport =
2277 musb_read_rxhubport(musb_base, i);
2282 static void musb_restore_context(struct musb *musb)
2284 int i;
2285 void __iomem *musb_base = musb->mregs;
2286 void __iomem *ep_target_regs;
2287 void __iomem *epio;
2289 if (is_host_enabled(musb)) {
2290 musb_writew(musb_base, MUSB_FRAME, musb->context.frame);
2291 musb_writeb(musb_base, MUSB_TESTMODE, musb->context.testmode);
2292 musb_write_ulpi_buscontrol(musb->mregs, musb->context.busctl);
2294 musb_writeb(musb_base, MUSB_POWER, musb->context.power);
2295 musb_writew(musb_base, MUSB_INTRTXE, musb->context.intrtxe);
2296 musb_writew(musb_base, MUSB_INTRRXE, musb->context.intrrxe);
2297 musb_writeb(musb_base, MUSB_INTRUSBE, musb->context.intrusbe);
2298 musb_writeb(musb_base, MUSB_DEVCTL, musb->context.devctl);
2300 for (i = 0; i < musb->config->num_eps; ++i) {
2301 epio = musb->endpoints[i].regs;
2302 musb_writew(epio, MUSB_TXMAXP,
2303 musb->context.index_regs[i].txmaxp);
2304 musb_writew(epio, MUSB_TXCSR,
2305 musb->context.index_regs[i].txcsr);
2306 musb_writew(epio, MUSB_RXMAXP,
2307 musb->context.index_regs[i].rxmaxp);
2308 musb_writew(epio, MUSB_RXCSR,
2309 musb->context.index_regs[i].rxcsr);
2311 if (musb->dyn_fifo) {
2312 musb_write_txfifosz(musb_base,
2313 musb->context.index_regs[i].txfifosz);
2314 musb_write_rxfifosz(musb_base,
2315 musb->context.index_regs[i].rxfifosz);
2316 musb_write_txfifoadd(musb_base,
2317 musb->context.index_regs[i].txfifoadd);
2318 musb_write_rxfifoadd(musb_base,
2319 musb->context.index_regs[i].rxfifoadd);
2322 if (is_host_enabled(musb)) {
2323 musb_writeb(epio, MUSB_TXTYPE,
2324 musb->context.index_regs[i].txtype);
2325 musb_writeb(epio, MUSB_TXINTERVAL,
2326 musb->context.index_regs[i].txinterval);
2327 musb_writeb(epio, MUSB_RXTYPE,
2328 musb->context.index_regs[i].rxtype);
2329 musb_writeb(epio, MUSB_RXINTERVAL,
2331 musb->context.index_regs[i].rxinterval);
2332 musb_write_txfunaddr(musb_base, i,
2333 musb->context.index_regs[i].txfunaddr);
2334 musb_write_txhubaddr(musb_base, i,
2335 musb->context.index_regs[i].txhubaddr);
2336 musb_write_txhubport(musb_base, i,
2337 musb->context.index_regs[i].txhubport);
2339 ep_target_regs =
2340 musb_read_target_reg_base(i, musb_base);
2342 musb_write_rxfunaddr(ep_target_regs,
2343 musb->context.index_regs[i].rxfunaddr);
2344 musb_write_rxhubaddr(ep_target_regs,
2345 musb->context.index_regs[i].rxhubaddr);
2346 musb_write_rxhubport(ep_target_regs,
2347 musb->context.index_regs[i].rxhubport);
2352 static int musb_suspend(struct device *dev)
2354 struct platform_device *pdev = to_platform_device(dev);
2355 unsigned long flags;
2356 struct musb *musb = dev_to_musb(&pdev->dev);
2358 spin_lock_irqsave(&musb->lock, flags);
2360 if (is_peripheral_active(musb)) {
2361 /* FIXME force disconnect unless we know USB will wake
2362 * the system up quickly enough to respond ...
2364 } else if (is_host_active(musb)) {
2365 /* we know all the children are suspended; sometimes
2366 * they will even be wakeup-enabled.
2370 musb_save_context(musb);
2372 spin_unlock_irqrestore(&musb->lock, flags);
2373 return 0;
2376 static int musb_resume_noirq(struct device *dev)
2378 struct platform_device *pdev = to_platform_device(dev);
2379 struct musb *musb = dev_to_musb(&pdev->dev);
2381 musb_restore_context(musb);
2383 /* for static cmos like DaVinci, register values were preserved
2384 * unless for some reason the whole soc powered down or the USB
2385 * module got reset through the PSC (vs just being disabled).
2387 return 0;
2390 static int musb_runtime_suspend(struct device *dev)
2392 struct musb *musb = dev_to_musb(dev);
2394 musb_save_context(musb);
2396 return 0;
2399 static int musb_runtime_resume(struct device *dev)
2401 struct musb *musb = dev_to_musb(dev);
2402 static int first = 1;
2405 * When pm_runtime_get_sync called for the first time in driver
2406 * init, some of the structure is still not initialized which is
2407 * used in restore function. But clock needs to be
2408 * enabled before any register access, so
2409 * pm_runtime_get_sync has to be called.
2410 * Also context restore without save does not make
2411 * any sense
2413 if (!first)
2414 musb_restore_context(musb);
2415 first = 0;
2417 return 0;
2420 static const struct dev_pm_ops musb_dev_pm_ops = {
2421 .suspend = musb_suspend,
2422 .resume_noirq = musb_resume_noirq,
2423 .runtime_suspend = musb_runtime_suspend,
2424 .runtime_resume = musb_runtime_resume,
2427 #define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2428 #else
2429 #define MUSB_DEV_PM_OPS NULL
2430 #endif
2432 static struct platform_driver musb_driver = {
2433 .driver = {
2434 .name = (char *)musb_driver_name,
2435 .bus = &platform_bus_type,
2436 .owner = THIS_MODULE,
2437 .pm = MUSB_DEV_PM_OPS,
2439 .remove = __exit_p(musb_remove),
2440 .shutdown = musb_shutdown,
2443 /*-------------------------------------------------------------------------*/
2445 static int __init musb_init(void)
2447 #ifdef CONFIG_USB_MUSB_HDRC_HCD
2448 if (usb_disabled())
2449 return 0;
2450 #endif
2452 pr_info("%s: version " MUSB_VERSION ", "
2453 #ifdef CONFIG_MUSB_PIO_ONLY
2454 "pio"
2455 #elif defined(CONFIG_USB_TI_CPPI_DMA)
2456 "cppi-dma"
2457 #elif defined(CONFIG_USB_INVENTRA_DMA)
2458 "musb-dma"
2459 #elif defined(CONFIG_USB_TUSB_OMAP_DMA)
2460 "tusb-omap-dma"
2461 #else
2462 "?dma?"
2463 #endif
2464 ", "
2465 #ifdef CONFIG_USB_MUSB_OTG
2466 "otg (peripheral+host)"
2467 #elif defined(CONFIG_USB_GADGET_MUSB_HDRC)
2468 "peripheral"
2469 #elif defined(CONFIG_USB_MUSB_HDRC_HCD)
2470 "host"
2471 #endif
2472 ", debug=%d\n",
2473 musb_driver_name, musb_debug);
2474 return platform_driver_probe(&musb_driver, musb_probe);
2477 /* make us init after usbcore and i2c (transceivers, regulators, etc)
2478 * and before usb gadget and host-side drivers start to register
2480 fs_initcall(musb_init);
2482 static void __exit musb_cleanup(void)
2484 platform_driver_unregister(&musb_driver);
2486 module_exit(musb_cleanup);