usb: musb: handle irqs in the order dictated by programming guide
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / usb / musb / musb_core.c
blobbd14e816df9341903bf455994719578b03a11f78
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 #ifdef CONFIG_ARM
103 #include <mach/hardware.h>
104 #include <mach/memory.h>
105 #include <asm/mach-types.h>
106 #endif
108 #include "musb_core.h"
111 #ifdef CONFIG_ARCH_DAVINCI
112 #include "davinci.h"
113 #endif
115 #define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
118 unsigned musb_debug;
119 module_param_named(debug, musb_debug, uint, S_IRUGO | S_IWUSR);
120 MODULE_PARM_DESC(debug, "Debug message level. Default = 0");
122 #define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
123 #define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
125 #define MUSB_VERSION "6.0"
127 #define DRIVER_INFO DRIVER_DESC ", v" MUSB_VERSION
129 #define MUSB_DRIVER_NAME "musb_hdrc"
130 const char musb_driver_name[] = MUSB_DRIVER_NAME;
132 MODULE_DESCRIPTION(DRIVER_INFO);
133 MODULE_AUTHOR(DRIVER_AUTHOR);
134 MODULE_LICENSE("GPL");
135 MODULE_ALIAS("platform:" MUSB_DRIVER_NAME);
138 /*-------------------------------------------------------------------------*/
140 static inline struct musb *dev_to_musb(struct device *dev)
142 #ifdef CONFIG_USB_MUSB_HDRC_HCD
143 /* usbcore insists dev->driver_data is a "struct hcd *" */
144 return hcd_to_musb(dev_get_drvdata(dev));
145 #else
146 return dev_get_drvdata(dev);
147 #endif
150 /*-------------------------------------------------------------------------*/
152 #if !defined(CONFIG_USB_TUSB6010) && !defined(CONFIG_BLACKFIN)
155 * Load an endpoint's FIFO
157 void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
159 void __iomem *fifo = hw_ep->fifo;
161 prefetch((u8 *)src);
163 DBG(4, "%cX ep%d fifo %p count %d buf %p\n",
164 'T', hw_ep->epnum, fifo, len, src);
166 /* we can't assume unaligned reads work */
167 if (likely((0x01 & (unsigned long) src) == 0)) {
168 u16 index = 0;
170 /* best case is 32bit-aligned source address */
171 if ((0x02 & (unsigned long) src) == 0) {
172 if (len >= 4) {
173 writesl(fifo, src + index, len >> 2);
174 index += len & ~0x03;
176 if (len & 0x02) {
177 musb_writew(fifo, 0, *(u16 *)&src[index]);
178 index += 2;
180 } else {
181 if (len >= 2) {
182 writesw(fifo, src + index, len >> 1);
183 index += len & ~0x01;
186 if (len & 0x01)
187 musb_writeb(fifo, 0, src[index]);
188 } else {
189 /* byte aligned */
190 writesb(fifo, src, len);
195 * Unload an endpoint's FIFO
197 void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
199 void __iomem *fifo = hw_ep->fifo;
201 DBG(4, "%cX ep%d fifo %p count %d buf %p\n",
202 'R', hw_ep->epnum, fifo, len, dst);
204 /* we can't assume unaligned writes work */
205 if (likely((0x01 & (unsigned long) dst) == 0)) {
206 u16 index = 0;
208 /* best case is 32bit-aligned destination address */
209 if ((0x02 & (unsigned long) dst) == 0) {
210 if (len >= 4) {
211 readsl(fifo, dst, len >> 2);
212 index = len & ~0x03;
214 if (len & 0x02) {
215 *(u16 *)&dst[index] = musb_readw(fifo, 0);
216 index += 2;
218 } else {
219 if (len >= 2) {
220 readsw(fifo, dst, len >> 1);
221 index = len & ~0x01;
224 if (len & 0x01)
225 dst[index] = musb_readb(fifo, 0);
226 } else {
227 /* byte aligned */
228 readsb(fifo, dst, len);
232 #endif /* normal PIO */
235 /*-------------------------------------------------------------------------*/
237 /* for high speed test mode; see USB 2.0 spec 7.1.20 */
238 static const u8 musb_test_packet[53] = {
239 /* implicit SYNC then DATA0 to start */
241 /* JKJKJKJK x9 */
242 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
243 /* JJKKJJKK x8 */
244 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
245 /* JJJJKKKK x8 */
246 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
247 /* JJJJJJJKKKKKKK x8 */
248 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
249 /* JJJJJJJK x8 */
250 0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
251 /* JKKKKKKK x10, JK */
252 0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
254 /* implicit CRC16 then EOP to end */
257 void musb_load_testpacket(struct musb *musb)
259 void __iomem *regs = musb->endpoints[0].regs;
261 musb_ep_select(musb->mregs, 0);
262 musb_write_fifo(musb->control_ep,
263 sizeof(musb_test_packet), musb_test_packet);
264 musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
267 /*-------------------------------------------------------------------------*/
269 const char *otg_state_string(struct musb *musb)
271 switch (musb->xceiv->state) {
272 case OTG_STATE_A_IDLE: return "a_idle";
273 case OTG_STATE_A_WAIT_VRISE: return "a_wait_vrise";
274 case OTG_STATE_A_WAIT_BCON: return "a_wait_bcon";
275 case OTG_STATE_A_HOST: return "a_host";
276 case OTG_STATE_A_SUSPEND: return "a_suspend";
277 case OTG_STATE_A_PERIPHERAL: return "a_peripheral";
278 case OTG_STATE_A_WAIT_VFALL: return "a_wait_vfall";
279 case OTG_STATE_A_VBUS_ERR: return "a_vbus_err";
280 case OTG_STATE_B_IDLE: return "b_idle";
281 case OTG_STATE_B_SRP_INIT: return "b_srp_init";
282 case OTG_STATE_B_PERIPHERAL: return "b_peripheral";
283 case OTG_STATE_B_WAIT_ACON: return "b_wait_acon";
284 case OTG_STATE_B_HOST: return "b_host";
285 default: return "UNDEFINED";
289 #ifdef CONFIG_USB_MUSB_OTG
292 * Handles OTG hnp timeouts, such as b_ase0_brst
294 void musb_otg_timer_func(unsigned long data)
296 struct musb *musb = (struct musb *)data;
297 unsigned long flags;
299 spin_lock_irqsave(&musb->lock, flags);
300 switch (musb->xceiv->state) {
301 case OTG_STATE_B_WAIT_ACON:
302 DBG(1, "HNP: b_wait_acon timeout; back to b_peripheral\n");
303 musb_g_disconnect(musb);
304 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
305 musb->is_active = 0;
306 break;
307 case OTG_STATE_A_SUSPEND:
308 case OTG_STATE_A_WAIT_BCON:
309 DBG(1, "HNP: %s timeout\n", otg_state_string(musb));
310 musb_set_vbus(musb, 0);
311 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
312 break;
313 default:
314 DBG(1, "HNP: Unhandled mode %s\n", otg_state_string(musb));
316 musb->ignore_disconnect = 0;
317 spin_unlock_irqrestore(&musb->lock, flags);
321 * Stops the HNP transition. Caller must take care of locking.
323 void musb_hnp_stop(struct musb *musb)
325 struct usb_hcd *hcd = musb_to_hcd(musb);
326 void __iomem *mbase = musb->mregs;
327 u8 reg;
329 DBG(1, "HNP: stop from %s\n", otg_state_string(musb));
331 switch (musb->xceiv->state) {
332 case OTG_STATE_A_PERIPHERAL:
333 musb_g_disconnect(musb);
334 DBG(1, "HNP: back to %s\n", otg_state_string(musb));
335 break;
336 case OTG_STATE_B_HOST:
337 DBG(1, "HNP: Disabling HR\n");
338 hcd->self.is_b_host = 0;
339 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
340 MUSB_DEV_MODE(musb);
341 reg = musb_readb(mbase, MUSB_POWER);
342 reg |= MUSB_POWER_SUSPENDM;
343 musb_writeb(mbase, MUSB_POWER, reg);
344 /* REVISIT: Start SESSION_REQUEST here? */
345 break;
346 default:
347 DBG(1, "HNP: Stopping in unknown state %s\n",
348 otg_state_string(musb));
352 * When returning to A state after HNP, avoid hub_port_rebounce(),
353 * which cause occasional OPT A "Did not receive reset after connect"
354 * errors.
356 musb->port1_status &=
357 ~(1 << USB_PORT_FEAT_C_CONNECTION);
360 #endif
363 * Interrupt Service Routine to record USB "global" interrupts.
364 * Since these do not happen often and signify things of
365 * paramount importance, it seems OK to check them individually;
366 * the order of the tests is specified in the manual
368 * @param musb instance pointer
369 * @param int_usb register contents
370 * @param devctl
371 * @param power
374 #define STAGE0_MASK (MUSB_INTR_RESUME | MUSB_INTR_SESSREQ \
375 | MUSB_INTR_VBUSERROR | MUSB_INTR_CONNECT \
376 | MUSB_INTR_RESET)
378 static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
379 u8 devctl, u8 power)
381 irqreturn_t handled = IRQ_NONE;
382 void __iomem *mbase = musb->mregs;
384 DBG(3, "<== Power=%02x, DevCtl=%02x, int_usb=0x%x\n", power, devctl,
385 int_usb);
387 /* in host mode, the peripheral may issue remote wakeup.
388 * in peripheral mode, the host may resume the link.
389 * spurious RESUME irqs happen too, paired with SUSPEND.
391 if (int_usb & MUSB_INTR_RESUME) {
392 handled = IRQ_HANDLED;
393 DBG(3, "RESUME (%s)\n", otg_state_string(musb));
395 if (devctl & MUSB_DEVCTL_HM) {
396 #ifdef CONFIG_USB_MUSB_HDRC_HCD
397 switch (musb->xceiv->state) {
398 case OTG_STATE_A_SUSPEND:
399 /* remote wakeup? later, GetPortStatus
400 * will stop RESUME signaling
403 if (power & MUSB_POWER_SUSPENDM) {
404 /* spurious */
405 musb->int_usb &= ~MUSB_INTR_SUSPEND;
406 DBG(2, "Spurious SUSPENDM\n");
407 break;
410 power &= ~MUSB_POWER_SUSPENDM;
411 musb_writeb(mbase, MUSB_POWER,
412 power | MUSB_POWER_RESUME);
414 musb->port1_status |=
415 (USB_PORT_STAT_C_SUSPEND << 16)
416 | MUSB_PORT_STAT_RESUME;
417 musb->rh_timer = jiffies
418 + msecs_to_jiffies(20);
420 musb->xceiv->state = OTG_STATE_A_HOST;
421 musb->is_active = 1;
422 usb_hcd_resume_root_hub(musb_to_hcd(musb));
423 break;
424 case OTG_STATE_B_WAIT_ACON:
425 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
426 musb->is_active = 1;
427 MUSB_DEV_MODE(musb);
428 break;
429 default:
430 WARNING("bogus %s RESUME (%s)\n",
431 "host",
432 otg_state_string(musb));
434 #endif
435 } else {
436 switch (musb->xceiv->state) {
437 #ifdef CONFIG_USB_MUSB_HDRC_HCD
438 case OTG_STATE_A_SUSPEND:
439 /* possibly DISCONNECT is upcoming */
440 musb->xceiv->state = OTG_STATE_A_HOST;
441 usb_hcd_resume_root_hub(musb_to_hcd(musb));
442 break;
443 #endif
444 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
445 case OTG_STATE_B_WAIT_ACON:
446 case OTG_STATE_B_PERIPHERAL:
447 /* disconnect while suspended? we may
448 * not get a disconnect irq...
450 if ((devctl & MUSB_DEVCTL_VBUS)
451 != (3 << MUSB_DEVCTL_VBUS_SHIFT)
453 musb->int_usb |= MUSB_INTR_DISCONNECT;
454 musb->int_usb &= ~MUSB_INTR_SUSPEND;
455 break;
457 musb_g_resume(musb);
458 break;
459 case OTG_STATE_B_IDLE:
460 musb->int_usb &= ~MUSB_INTR_SUSPEND;
461 break;
462 #endif
463 default:
464 WARNING("bogus %s RESUME (%s)\n",
465 "peripheral",
466 otg_state_string(musb));
471 #ifdef CONFIG_USB_MUSB_HDRC_HCD
472 /* see manual for the order of the tests */
473 if (int_usb & MUSB_INTR_SESSREQ) {
474 DBG(1, "SESSION_REQUEST (%s)\n", otg_state_string(musb));
476 /* IRQ arrives from ID pin sense or (later, if VBUS power
477 * is removed) SRP. responses are time critical:
478 * - turn on VBUS (with silicon-specific mechanism)
479 * - go through A_WAIT_VRISE
480 * - ... to A_WAIT_BCON.
481 * a_wait_vrise_tmout triggers VBUS_ERROR transitions
483 musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
484 musb->ep0_stage = MUSB_EP0_START;
485 musb->xceiv->state = OTG_STATE_A_IDLE;
486 MUSB_HST_MODE(musb);
487 musb_set_vbus(musb, 1);
489 handled = IRQ_HANDLED;
492 if (int_usb & MUSB_INTR_VBUSERROR) {
493 int ignore = 0;
495 /* During connection as an A-Device, we may see a short
496 * current spikes causing voltage drop, because of cable
497 * and peripheral capacitance combined with vbus draw.
498 * (So: less common with truly self-powered devices, where
499 * vbus doesn't act like a power supply.)
501 * Such spikes are short; usually less than ~500 usec, max
502 * of ~2 msec. That is, they're not sustained overcurrent
503 * errors, though they're reported using VBUSERROR irqs.
505 * Workarounds: (a) hardware: use self powered devices.
506 * (b) software: ignore non-repeated VBUS errors.
508 * REVISIT: do delays from lots of DEBUG_KERNEL checks
509 * make trouble here, keeping VBUS < 4.4V ?
511 switch (musb->xceiv->state) {
512 case OTG_STATE_A_HOST:
513 /* recovery is dicey once we've gotten past the
514 * initial stages of enumeration, but if VBUS
515 * stayed ok at the other end of the link, and
516 * another reset is due (at least for high speed,
517 * to redo the chirp etc), it might work OK...
519 case OTG_STATE_A_WAIT_BCON:
520 case OTG_STATE_A_WAIT_VRISE:
521 if (musb->vbuserr_retry) {
522 musb->vbuserr_retry--;
523 ignore = 1;
524 devctl |= MUSB_DEVCTL_SESSION;
525 musb_writeb(mbase, MUSB_DEVCTL, devctl);
526 } else {
527 musb->port1_status |=
528 (1 << USB_PORT_FEAT_OVER_CURRENT)
529 | (1 << USB_PORT_FEAT_C_OVER_CURRENT);
531 break;
532 default:
533 break;
536 DBG(1, "VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
537 otg_state_string(musb),
538 devctl,
539 ({ char *s;
540 switch (devctl & MUSB_DEVCTL_VBUS) {
541 case 0 << MUSB_DEVCTL_VBUS_SHIFT:
542 s = "<SessEnd"; break;
543 case 1 << MUSB_DEVCTL_VBUS_SHIFT:
544 s = "<AValid"; break;
545 case 2 << MUSB_DEVCTL_VBUS_SHIFT:
546 s = "<VBusValid"; break;
547 /* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
548 default:
549 s = "VALID"; break;
550 }; s; }),
551 VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
552 musb->port1_status);
554 /* go through A_WAIT_VFALL then start a new session */
555 if (!ignore)
556 musb_set_vbus(musb, 0);
557 handled = IRQ_HANDLED;
561 if (int_usb & MUSB_INTR_SUSPEND) {
562 DBG(1, "SUSPEND (%s) devctl %02x power %02x\n",
563 otg_state_string(musb), devctl, power);
564 handled = IRQ_HANDLED;
566 switch (musb->xceiv->state) {
567 #ifdef CONFIG_USB_MUSB_OTG
568 case OTG_STATE_A_PERIPHERAL:
569 /* We also come here if the cable is removed, since
570 * this silicon doesn't report ID-no-longer-grounded.
572 * We depend on T(a_wait_bcon) to shut us down, and
573 * hope users don't do anything dicey during this
574 * undesired detour through A_WAIT_BCON.
576 musb_hnp_stop(musb);
577 usb_hcd_resume_root_hub(musb_to_hcd(musb));
578 musb_root_disconnect(musb);
579 musb_platform_try_idle(musb, jiffies
580 + msecs_to_jiffies(musb->a_wait_bcon
581 ? : OTG_TIME_A_WAIT_BCON));
583 break;
584 #endif
585 case OTG_STATE_B_IDLE:
586 if (!musb->is_active)
587 break;
588 case OTG_STATE_B_PERIPHERAL:
589 musb_g_suspend(musb);
590 musb->is_active = is_otg_enabled(musb)
591 && musb->xceiv->gadget->b_hnp_enable;
592 if (musb->is_active) {
593 #ifdef CONFIG_USB_MUSB_OTG
594 musb->xceiv->state = OTG_STATE_B_WAIT_ACON;
595 DBG(1, "HNP: Setting timer for b_ase0_brst\n");
596 mod_timer(&musb->otg_timer, jiffies
597 + msecs_to_jiffies(
598 OTG_TIME_B_ASE0_BRST));
599 #endif
601 break;
602 case OTG_STATE_A_WAIT_BCON:
603 if (musb->a_wait_bcon != 0)
604 musb_platform_try_idle(musb, jiffies
605 + msecs_to_jiffies(musb->a_wait_bcon));
606 break;
607 case OTG_STATE_A_HOST:
608 musb->xceiv->state = OTG_STATE_A_SUSPEND;
609 musb->is_active = is_otg_enabled(musb)
610 && musb->xceiv->host->b_hnp_enable;
611 break;
612 case OTG_STATE_B_HOST:
613 /* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
614 DBG(1, "REVISIT: SUSPEND as B_HOST\n");
615 break;
616 default:
617 /* "should not happen" */
618 musb->is_active = 0;
619 break;
623 if (int_usb & MUSB_INTR_CONNECT) {
624 struct usb_hcd *hcd = musb_to_hcd(musb);
626 handled = IRQ_HANDLED;
627 musb->is_active = 1;
628 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
630 musb->ep0_stage = MUSB_EP0_START;
632 #ifdef CONFIG_USB_MUSB_OTG
633 /* flush endpoints when transitioning from Device Mode */
634 if (is_peripheral_active(musb)) {
635 /* REVISIT HNP; just force disconnect */
637 musb_writew(mbase, MUSB_INTRTXE, musb->epmask);
638 musb_writew(mbase, MUSB_INTRRXE, musb->epmask & 0xfffe);
639 musb_writeb(mbase, MUSB_INTRUSBE, 0xf7);
640 #endif
641 musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
642 |USB_PORT_STAT_HIGH_SPEED
643 |USB_PORT_STAT_ENABLE
645 musb->port1_status |= USB_PORT_STAT_CONNECTION
646 |(USB_PORT_STAT_C_CONNECTION << 16);
648 /* high vs full speed is just a guess until after reset */
649 if (devctl & MUSB_DEVCTL_LSDEV)
650 musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
652 /* indicate new connection to OTG machine */
653 switch (musb->xceiv->state) {
654 case OTG_STATE_B_PERIPHERAL:
655 if (int_usb & MUSB_INTR_SUSPEND) {
656 DBG(1, "HNP: SUSPEND+CONNECT, now b_host\n");
657 int_usb &= ~MUSB_INTR_SUSPEND;
658 goto b_host;
659 } else
660 DBG(1, "CONNECT as b_peripheral???\n");
661 break;
662 case OTG_STATE_B_WAIT_ACON:
663 DBG(1, "HNP: CONNECT, now b_host\n");
664 b_host:
665 musb->xceiv->state = OTG_STATE_B_HOST;
666 hcd->self.is_b_host = 1;
667 musb->ignore_disconnect = 0;
668 del_timer(&musb->otg_timer);
669 break;
670 default:
671 if ((devctl & MUSB_DEVCTL_VBUS)
672 == (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
673 musb->xceiv->state = OTG_STATE_A_HOST;
674 hcd->self.is_b_host = 0;
676 break;
679 /* poke the root hub */
680 MUSB_HST_MODE(musb);
681 if (hcd->status_urb)
682 usb_hcd_poll_rh_status(hcd);
683 else
684 usb_hcd_resume_root_hub(hcd);
686 DBG(1, "CONNECT (%s) devctl %02x\n",
687 otg_state_string(musb), devctl);
689 #endif /* CONFIG_USB_MUSB_HDRC_HCD */
691 if ((int_usb & MUSB_INTR_DISCONNECT) && !musb->ignore_disconnect) {
692 DBG(1, "DISCONNECT (%s) as %s, devctl %02x\n",
693 otg_state_string(musb),
694 MUSB_MODE(musb), devctl);
695 handled = IRQ_HANDLED;
697 switch (musb->xceiv->state) {
698 #ifdef CONFIG_USB_MUSB_HDRC_HCD
699 case OTG_STATE_A_HOST:
700 case OTG_STATE_A_SUSPEND:
701 usb_hcd_resume_root_hub(musb_to_hcd(musb));
702 musb_root_disconnect(musb);
703 if (musb->a_wait_bcon != 0 && is_otg_enabled(musb))
704 musb_platform_try_idle(musb, jiffies
705 + msecs_to_jiffies(musb->a_wait_bcon));
706 break;
707 #endif /* HOST */
708 #ifdef CONFIG_USB_MUSB_OTG
709 case OTG_STATE_B_HOST:
710 /* REVISIT this behaves for "real disconnect"
711 * cases; make sure the other transitions from
712 * from B_HOST act right too. The B_HOST code
713 * in hnp_stop() is currently not used...
715 musb_root_disconnect(musb);
716 musb_to_hcd(musb)->self.is_b_host = 0;
717 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
718 MUSB_DEV_MODE(musb);
719 musb_g_disconnect(musb);
720 break;
721 case OTG_STATE_A_PERIPHERAL:
722 musb_hnp_stop(musb);
723 musb_root_disconnect(musb);
724 /* FALLTHROUGH */
725 case OTG_STATE_B_WAIT_ACON:
726 /* FALLTHROUGH */
727 #endif /* OTG */
728 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
729 case OTG_STATE_B_PERIPHERAL:
730 case OTG_STATE_B_IDLE:
731 musb_g_disconnect(musb);
732 break;
733 #endif /* GADGET */
734 default:
735 WARNING("unhandled DISCONNECT transition (%s)\n",
736 otg_state_string(musb));
737 break;
741 /* mentor saves a bit: bus reset and babble share the same irq.
742 * only host sees babble; only peripheral sees bus reset.
744 if (int_usb & MUSB_INTR_RESET) {
745 handled = IRQ_HANDLED;
746 if (is_host_capable() && (devctl & MUSB_DEVCTL_HM) != 0) {
748 * Looks like non-HS BABBLE can be ignored, but
749 * HS BABBLE is an error condition. For HS the solution
750 * is to avoid babble in the first place and fix what
751 * caused BABBLE. When HS BABBLE happens we can only
752 * stop the session.
754 if (devctl & (MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV))
755 DBG(1, "BABBLE devctl: %02x\n", devctl);
756 else {
757 ERR("Stopping host session -- babble\n");
758 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
760 } else if (is_peripheral_capable()) {
761 DBG(1, "BUS RESET as %s\n", otg_state_string(musb));
762 switch (musb->xceiv->state) {
763 #ifdef CONFIG_USB_OTG
764 case OTG_STATE_A_SUSPEND:
765 /* We need to ignore disconnect on suspend
766 * otherwise tusb 2.0 won't reconnect after a
767 * power cycle, which breaks otg compliance.
769 musb->ignore_disconnect = 1;
770 musb_g_reset(musb);
771 /* FALLTHROUGH */
772 case OTG_STATE_A_WAIT_BCON: /* OPT TD.4.7-900ms */
773 /* never use invalid T(a_wait_bcon) */
774 DBG(1, "HNP: in %s, %d msec timeout\n",
775 otg_state_string(musb),
776 TA_WAIT_BCON(musb));
777 mod_timer(&musb->otg_timer, jiffies
778 + msecs_to_jiffies(TA_WAIT_BCON(musb)));
779 break;
780 case OTG_STATE_A_PERIPHERAL:
781 musb->ignore_disconnect = 0;
782 del_timer(&musb->otg_timer);
783 musb_g_reset(musb);
784 break;
785 case OTG_STATE_B_WAIT_ACON:
786 DBG(1, "HNP: RESET (%s), to b_peripheral\n",
787 otg_state_string(musb));
788 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
789 musb_g_reset(musb);
790 break;
791 #endif
792 case OTG_STATE_B_IDLE:
793 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
794 /* FALLTHROUGH */
795 case OTG_STATE_B_PERIPHERAL:
796 musb_g_reset(musb);
797 break;
798 default:
799 DBG(1, "Unhandled BUS RESET as %s\n",
800 otg_state_string(musb));
805 #if 0
806 /* REVISIT ... this would be for multiplexing periodic endpoints, or
807 * supporting transfer phasing to prevent exceeding ISO bandwidth
808 * limits of a given frame or microframe.
810 * It's not needed for peripheral side, which dedicates endpoints;
811 * though it _might_ use SOF irqs for other purposes.
813 * And it's not currently needed for host side, which also dedicates
814 * endpoints, relies on TX/RX interval registers, and isn't claimed
815 * to support ISO transfers yet.
817 if (int_usb & MUSB_INTR_SOF) {
818 void __iomem *mbase = musb->mregs;
819 struct musb_hw_ep *ep;
820 u8 epnum;
821 u16 frame;
823 DBG(6, "START_OF_FRAME\n");
824 handled = IRQ_HANDLED;
826 /* start any periodic Tx transfers waiting for current frame */
827 frame = musb_readw(mbase, MUSB_FRAME);
828 ep = musb->endpoints;
829 for (epnum = 1; (epnum < musb->nr_endpoints)
830 && (musb->epmask >= (1 << epnum));
831 epnum++, ep++) {
833 * FIXME handle framecounter wraps (12 bits)
834 * eliminate duplicated StartUrb logic
836 if (ep->dwWaitFrame >= frame) {
837 ep->dwWaitFrame = 0;
838 pr_debug("SOF --> periodic TX%s on %d\n",
839 ep->tx_channel ? " DMA" : "",
840 epnum);
841 if (!ep->tx_channel)
842 musb_h_tx_start(musb, epnum);
843 else
844 cppi_hostdma_start(musb, epnum);
846 } /* end of for loop */
848 #endif
850 schedule_work(&musb->irq_work);
852 return handled;
855 /*-------------------------------------------------------------------------*/
858 * Program the HDRC to start (enable interrupts, dma, etc.).
860 void musb_start(struct musb *musb)
862 void __iomem *regs = musb->mregs;
863 u8 devctl = musb_readb(regs, MUSB_DEVCTL);
865 DBG(2, "<== devctl %02x\n", devctl);
867 /* Set INT enable registers, enable interrupts */
868 musb_writew(regs, MUSB_INTRTXE, musb->epmask);
869 musb_writew(regs, MUSB_INTRRXE, musb->epmask & 0xfffe);
870 musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
872 musb_writeb(regs, MUSB_TESTMODE, 0);
874 /* put into basic highspeed mode and start session */
875 musb_writeb(regs, MUSB_POWER, MUSB_POWER_ISOUPDATE
876 | MUSB_POWER_SOFTCONN
877 | MUSB_POWER_HSENAB
878 /* ENSUSPEND wedges tusb */
879 /* | MUSB_POWER_ENSUSPEND */
882 musb->is_active = 0;
883 devctl = musb_readb(regs, MUSB_DEVCTL);
884 devctl &= ~MUSB_DEVCTL_SESSION;
886 if (is_otg_enabled(musb)) {
887 /* session started after:
888 * (a) ID-grounded irq, host mode;
889 * (b) vbus present/connect IRQ, peripheral mode;
890 * (c) peripheral initiates, using SRP
892 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
893 musb->is_active = 1;
894 else
895 devctl |= MUSB_DEVCTL_SESSION;
897 } else if (is_host_enabled(musb)) {
898 /* assume ID pin is hard-wired to ground */
899 devctl |= MUSB_DEVCTL_SESSION;
901 } else /* peripheral is enabled */ {
902 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
903 musb->is_active = 1;
905 musb_platform_enable(musb);
906 musb_writeb(regs, MUSB_DEVCTL, devctl);
910 static void musb_generic_disable(struct musb *musb)
912 void __iomem *mbase = musb->mregs;
913 u16 temp;
915 /* disable interrupts */
916 musb_writeb(mbase, MUSB_INTRUSBE, 0);
917 musb_writew(mbase, MUSB_INTRTXE, 0);
918 musb_writew(mbase, MUSB_INTRRXE, 0);
920 /* off */
921 musb_writeb(mbase, MUSB_DEVCTL, 0);
923 /* flush pending interrupts */
924 temp = musb_readb(mbase, MUSB_INTRUSB);
925 temp = musb_readw(mbase, MUSB_INTRTX);
926 temp = musb_readw(mbase, MUSB_INTRRX);
931 * Make the HDRC stop (disable interrupts, etc.);
932 * reversible by musb_start
933 * called on gadget driver unregister
934 * with controller locked, irqs blocked
935 * acts as a NOP unless some role activated the hardware
937 void musb_stop(struct musb *musb)
939 /* stop IRQs, timers, ... */
940 musb_platform_disable(musb);
941 musb_generic_disable(musb);
942 DBG(3, "HDRC disabled\n");
944 /* FIXME
945 * - mark host and/or peripheral drivers unusable/inactive
946 * - disable DMA (and enable it in HdrcStart)
947 * - make sure we can musb_start() after musb_stop(); with
948 * OTG mode, gadget driver module rmmod/modprobe cycles that
949 * - ...
951 musb_platform_try_idle(musb, 0);
954 static void musb_shutdown(struct platform_device *pdev)
956 struct musb *musb = dev_to_musb(&pdev->dev);
957 unsigned long flags;
959 spin_lock_irqsave(&musb->lock, flags);
960 musb_platform_disable(musb);
961 musb_generic_disable(musb);
962 if (musb->clock) {
963 clk_put(musb->clock);
964 musb->clock = NULL;
966 spin_unlock_irqrestore(&musb->lock, flags);
968 /* FIXME power down */
972 /*-------------------------------------------------------------------------*/
975 * The silicon either has hard-wired endpoint configurations, or else
976 * "dynamic fifo" sizing. The driver has support for both, though at this
977 * writing only the dynamic sizing is very well tested. Since we switched
978 * away from compile-time hardware parameters, we can no longer rely on
979 * dead code elimination to leave only the relevant one in the object file.
981 * We don't currently use dynamic fifo setup capability to do anything
982 * more than selecting one of a bunch of predefined configurations.
984 #if defined(CONFIG_USB_TUSB6010) || \
985 defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP34XX)
986 static ushort __initdata fifo_mode = 4;
987 #else
988 static ushort __initdata fifo_mode = 2;
989 #endif
991 /* "modprobe ... fifo_mode=1" etc */
992 module_param(fifo_mode, ushort, 0);
993 MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
996 enum fifo_style { FIFO_RXTX, FIFO_TX, FIFO_RX } __attribute__ ((packed));
997 enum buf_mode { BUF_SINGLE, BUF_DOUBLE } __attribute__ ((packed));
999 struct fifo_cfg {
1000 u8 hw_ep_num;
1001 enum fifo_style style;
1002 enum buf_mode mode;
1003 u16 maxpacket;
1007 * tables defining fifo_mode values. define more if you like.
1008 * for host side, make sure both halves of ep1 are set up.
1011 /* mode 0 - fits in 2KB */
1012 static struct fifo_cfg __initdata mode_0_cfg[] = {
1013 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1014 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1015 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1016 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1017 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1020 /* mode 1 - fits in 4KB */
1021 static struct fifo_cfg __initdata mode_1_cfg[] = {
1022 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1023 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1024 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1025 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1026 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1029 /* mode 2 - fits in 4KB */
1030 static struct fifo_cfg __initdata mode_2_cfg[] = {
1031 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1032 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1033 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1034 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1035 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1036 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1039 /* mode 3 - fits in 4KB */
1040 static struct fifo_cfg __initdata mode_3_cfg[] = {
1041 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1042 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1043 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1044 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1045 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1046 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1049 /* mode 4 - fits in 16KB */
1050 static struct fifo_cfg __initdata mode_4_cfg[] = {
1051 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1052 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1053 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1054 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1055 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1056 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1057 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1058 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1059 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1060 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1061 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 512, },
1062 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 512, },
1063 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 512, },
1064 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 512, },
1065 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 512, },
1066 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 512, },
1067 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 512, },
1068 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 512, },
1069 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 256, },
1070 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 64, },
1071 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 256, },
1072 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 64, },
1073 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 256, },
1074 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 64, },
1075 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1076 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1077 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1080 /* mode 5 - fits in 8KB */
1081 static struct fifo_cfg __initdata mode_5_cfg[] = {
1082 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1083 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1084 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1085 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1086 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1087 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1088 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1089 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1090 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1091 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1092 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 32, },
1093 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 32, },
1094 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 32, },
1095 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 32, },
1096 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 32, },
1097 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 32, },
1098 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 32, },
1099 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 32, },
1100 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 32, },
1101 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 32, },
1102 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 32, },
1103 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 32, },
1104 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 32, },
1105 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 32, },
1106 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1107 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1108 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1112 * configure a fifo; for non-shared endpoints, this may be called
1113 * once for a tx fifo and once for an rx fifo.
1115 * returns negative errno or offset for next fifo.
1117 static int __init
1118 fifo_setup(struct musb *musb, struct musb_hw_ep *hw_ep,
1119 const struct fifo_cfg *cfg, u16 offset)
1121 void __iomem *mbase = musb->mregs;
1122 int size = 0;
1123 u16 maxpacket = cfg->maxpacket;
1124 u16 c_off = offset >> 3;
1125 u8 c_size;
1127 /* expect hw_ep has already been zero-initialized */
1129 size = ffs(max(maxpacket, (u16) 8)) - 1;
1130 maxpacket = 1 << size;
1132 c_size = size - 3;
1133 if (cfg->mode == BUF_DOUBLE) {
1134 if ((offset + (maxpacket << 1)) >
1135 (1 << (musb->config->ram_bits + 2)))
1136 return -EMSGSIZE;
1137 c_size |= MUSB_FIFOSZ_DPB;
1138 } else {
1139 if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1140 return -EMSGSIZE;
1143 /* configure the FIFO */
1144 musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1146 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1147 /* EP0 reserved endpoint for control, bidirectional;
1148 * EP1 reserved for bulk, two unidirection halves.
1150 if (hw_ep->epnum == 1)
1151 musb->bulk_ep = hw_ep;
1152 /* REVISIT error check: be sure ep0 can both rx and tx ... */
1153 #endif
1154 switch (cfg->style) {
1155 case FIFO_TX:
1156 musb_write_txfifosz(mbase, c_size);
1157 musb_write_txfifoadd(mbase, c_off);
1158 hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1159 hw_ep->max_packet_sz_tx = maxpacket;
1160 break;
1161 case FIFO_RX:
1162 musb_write_rxfifosz(mbase, c_size);
1163 musb_write_rxfifoadd(mbase, c_off);
1164 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1165 hw_ep->max_packet_sz_rx = maxpacket;
1166 break;
1167 case FIFO_RXTX:
1168 musb_write_txfifosz(mbase, c_size);
1169 musb_write_txfifoadd(mbase, c_off);
1170 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1171 hw_ep->max_packet_sz_rx = maxpacket;
1173 musb_write_rxfifosz(mbase, c_size);
1174 musb_write_rxfifoadd(mbase, c_off);
1175 hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1176 hw_ep->max_packet_sz_tx = maxpacket;
1178 hw_ep->is_shared_fifo = true;
1179 break;
1182 /* NOTE rx and tx endpoint irqs aren't managed separately,
1183 * which happens to be ok
1185 musb->epmask |= (1 << hw_ep->epnum);
1187 return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1190 static struct fifo_cfg __initdata ep0_cfg = {
1191 .style = FIFO_RXTX, .maxpacket = 64,
1194 static int __init ep_config_from_table(struct musb *musb)
1196 const struct fifo_cfg *cfg;
1197 unsigned i, n;
1198 int offset;
1199 struct musb_hw_ep *hw_ep = musb->endpoints;
1201 switch (fifo_mode) {
1202 default:
1203 fifo_mode = 0;
1204 /* FALLTHROUGH */
1205 case 0:
1206 cfg = mode_0_cfg;
1207 n = ARRAY_SIZE(mode_0_cfg);
1208 break;
1209 case 1:
1210 cfg = mode_1_cfg;
1211 n = ARRAY_SIZE(mode_1_cfg);
1212 break;
1213 case 2:
1214 cfg = mode_2_cfg;
1215 n = ARRAY_SIZE(mode_2_cfg);
1216 break;
1217 case 3:
1218 cfg = mode_3_cfg;
1219 n = ARRAY_SIZE(mode_3_cfg);
1220 break;
1221 case 4:
1222 cfg = mode_4_cfg;
1223 n = ARRAY_SIZE(mode_4_cfg);
1224 break;
1225 case 5:
1226 cfg = mode_5_cfg;
1227 n = ARRAY_SIZE(mode_5_cfg);
1228 break;
1231 printk(KERN_DEBUG "%s: setup fifo_mode %d\n",
1232 musb_driver_name, fifo_mode);
1235 offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1236 /* assert(offset > 0) */
1238 /* NOTE: for RTL versions >= 1.400 EPINFO and RAMINFO would
1239 * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1242 for (i = 0; i < n; i++) {
1243 u8 epn = cfg->hw_ep_num;
1245 if (epn >= musb->config->num_eps) {
1246 pr_debug("%s: invalid ep %d\n",
1247 musb_driver_name, epn);
1248 return -EINVAL;
1250 offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1251 if (offset < 0) {
1252 pr_debug("%s: mem overrun, ep %d\n",
1253 musb_driver_name, epn);
1254 return -EINVAL;
1256 epn++;
1257 musb->nr_endpoints = max(epn, musb->nr_endpoints);
1260 printk(KERN_DEBUG "%s: %d/%d max ep, %d/%d memory\n",
1261 musb_driver_name,
1262 n + 1, musb->config->num_eps * 2 - 1,
1263 offset, (1 << (musb->config->ram_bits + 2)));
1265 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1266 if (!musb->bulk_ep) {
1267 pr_debug("%s: missing bulk\n", musb_driver_name);
1268 return -EINVAL;
1270 #endif
1272 return 0;
1277 * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1278 * @param musb the controller
1280 static int __init ep_config_from_hw(struct musb *musb)
1282 u8 epnum = 0;
1283 struct musb_hw_ep *hw_ep;
1284 void *mbase = musb->mregs;
1285 int ret = 0;
1287 DBG(2, "<== static silicon ep config\n");
1289 /* FIXME pick up ep0 maxpacket size */
1291 for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1292 musb_ep_select(mbase, epnum);
1293 hw_ep = musb->endpoints + epnum;
1295 ret = musb_read_fifosize(musb, hw_ep, epnum);
1296 if (ret < 0)
1297 break;
1299 /* FIXME set up hw_ep->{rx,tx}_double_buffered */
1301 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1302 /* pick an RX/TX endpoint for bulk */
1303 if (hw_ep->max_packet_sz_tx < 512
1304 || hw_ep->max_packet_sz_rx < 512)
1305 continue;
1307 /* REVISIT: this algorithm is lazy, we should at least
1308 * try to pick a double buffered endpoint.
1310 if (musb->bulk_ep)
1311 continue;
1312 musb->bulk_ep = hw_ep;
1313 #endif
1316 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1317 if (!musb->bulk_ep) {
1318 pr_debug("%s: missing bulk\n", musb_driver_name);
1319 return -EINVAL;
1321 #endif
1323 return 0;
1326 enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1328 /* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1329 * configure endpoints, or take their config from silicon
1331 static int __init musb_core_init(u16 musb_type, struct musb *musb)
1333 u8 reg;
1334 char *type;
1335 char aInfo[90], aRevision[32], aDate[12];
1336 void __iomem *mbase = musb->mregs;
1337 int status = 0;
1338 int i;
1340 /* log core options (read using indexed model) */
1341 reg = musb_read_configdata(mbase);
1343 strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1344 if (reg & MUSB_CONFIGDATA_DYNFIFO)
1345 strcat(aInfo, ", dyn FIFOs");
1346 if (reg & MUSB_CONFIGDATA_MPRXE) {
1347 strcat(aInfo, ", bulk combine");
1348 musb->bulk_combine = true;
1350 if (reg & MUSB_CONFIGDATA_MPTXE) {
1351 strcat(aInfo, ", bulk split");
1352 musb->bulk_split = true;
1354 if (reg & MUSB_CONFIGDATA_HBRXE) {
1355 strcat(aInfo, ", HB-ISO Rx");
1356 musb->hb_iso_rx = true;
1358 if (reg & MUSB_CONFIGDATA_HBTXE) {
1359 strcat(aInfo, ", HB-ISO Tx");
1360 musb->hb_iso_tx = true;
1362 if (reg & MUSB_CONFIGDATA_SOFTCONE)
1363 strcat(aInfo, ", SoftConn");
1365 printk(KERN_DEBUG "%s: ConfigData=0x%02x (%s)\n",
1366 musb_driver_name, reg, aInfo);
1368 aDate[0] = 0;
1369 if (MUSB_CONTROLLER_MHDRC == musb_type) {
1370 musb->is_multipoint = 1;
1371 type = "M";
1372 } else {
1373 musb->is_multipoint = 0;
1374 type = "";
1375 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1376 #ifndef CONFIG_USB_OTG_BLACKLIST_HUB
1377 printk(KERN_ERR
1378 "%s: kernel must blacklist external hubs\n",
1379 musb_driver_name);
1380 #endif
1381 #endif
1384 /* log release info */
1385 musb->hwvers = musb_read_hwvers(mbase);
1386 snprintf(aRevision, 32, "%d.%d%s", MUSB_HWVERS_MAJOR(musb->hwvers),
1387 MUSB_HWVERS_MINOR(musb->hwvers),
1388 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1389 printk(KERN_DEBUG "%s: %sHDRC RTL version %s %s\n",
1390 musb_driver_name, type, aRevision, aDate);
1392 /* configure ep0 */
1393 musb_configure_ep0(musb);
1395 /* discover endpoint configuration */
1396 musb->nr_endpoints = 1;
1397 musb->epmask = 1;
1399 if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1400 if (musb->config->dyn_fifo)
1401 status = ep_config_from_table(musb);
1402 else {
1403 ERR("reconfigure software for Dynamic FIFOs\n");
1404 status = -ENODEV;
1406 } else {
1407 if (!musb->config->dyn_fifo)
1408 status = ep_config_from_hw(musb);
1409 else {
1410 ERR("reconfigure software for static FIFOs\n");
1411 return -ENODEV;
1415 if (status < 0)
1416 return status;
1418 /* finish init, and print endpoint config */
1419 for (i = 0; i < musb->nr_endpoints; i++) {
1420 struct musb_hw_ep *hw_ep = musb->endpoints + i;
1422 hw_ep->fifo = MUSB_FIFO_OFFSET(i) + mbase;
1423 #ifdef CONFIG_USB_TUSB6010
1424 hw_ep->fifo_async = musb->async + 0x400 + MUSB_FIFO_OFFSET(i);
1425 hw_ep->fifo_sync = musb->sync + 0x400 + MUSB_FIFO_OFFSET(i);
1426 hw_ep->fifo_sync_va =
1427 musb->sync_va + 0x400 + MUSB_FIFO_OFFSET(i);
1429 if (i == 0)
1430 hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1431 else
1432 hw_ep->conf = mbase + 0x400 + (((i - 1) & 0xf) << 2);
1433 #endif
1435 hw_ep->regs = MUSB_EP_OFFSET(i, 0) + mbase;
1436 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1437 hw_ep->target_regs = musb_read_target_reg_base(i, mbase);
1438 hw_ep->rx_reinit = 1;
1439 hw_ep->tx_reinit = 1;
1440 #endif
1442 if (hw_ep->max_packet_sz_tx) {
1443 DBG(1,
1444 "%s: hw_ep %d%s, %smax %d\n",
1445 musb_driver_name, i,
1446 hw_ep->is_shared_fifo ? "shared" : "tx",
1447 hw_ep->tx_double_buffered
1448 ? "doublebuffer, " : "",
1449 hw_ep->max_packet_sz_tx);
1451 if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1452 DBG(1,
1453 "%s: hw_ep %d%s, %smax %d\n",
1454 musb_driver_name, i,
1455 "rx",
1456 hw_ep->rx_double_buffered
1457 ? "doublebuffer, " : "",
1458 hw_ep->max_packet_sz_rx);
1460 if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1461 DBG(1, "hw_ep %d not configured\n", i);
1464 return 0;
1467 /*-------------------------------------------------------------------------*/
1469 #if defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP3430)
1471 static irqreturn_t generic_interrupt(int irq, void *__hci)
1473 unsigned long flags;
1474 irqreturn_t retval = IRQ_NONE;
1475 struct musb *musb = __hci;
1477 spin_lock_irqsave(&musb->lock, flags);
1479 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
1480 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
1481 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
1483 if (musb->int_usb || musb->int_tx || musb->int_rx)
1484 retval = musb_interrupt(musb);
1486 spin_unlock_irqrestore(&musb->lock, flags);
1488 return retval;
1491 #else
1492 #define generic_interrupt NULL
1493 #endif
1496 * handle all the irqs defined by the HDRC core. for now we expect: other
1497 * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1498 * will be assigned, and the irq will already have been acked.
1500 * called in irq context with spinlock held, irqs blocked
1502 irqreturn_t musb_interrupt(struct musb *musb)
1504 irqreturn_t retval = IRQ_NONE;
1505 u8 devctl, power;
1506 int ep_num;
1507 u32 reg;
1509 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1510 power = musb_readb(musb->mregs, MUSB_POWER);
1512 DBG(4, "** IRQ %s usb%04x tx%04x rx%04x\n",
1513 (devctl & MUSB_DEVCTL_HM) ? "host" : "peripheral",
1514 musb->int_usb, musb->int_tx, musb->int_rx);
1516 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1517 if (is_otg_enabled(musb) || is_peripheral_enabled(musb))
1518 if (!musb->gadget_driver) {
1519 DBG(5, "No gadget driver loaded\n");
1520 return IRQ_HANDLED;
1522 #endif
1524 /* the core can interrupt us for multiple reasons; docs have
1525 * a generic interrupt flowchart to follow
1527 if (musb->int_usb & STAGE0_MASK)
1528 retval |= musb_stage0_irq(musb, musb->int_usb,
1529 devctl, power);
1531 /* "stage 1" is handling endpoint irqs */
1533 /* handle endpoint 0 first */
1534 if (musb->int_tx & 1) {
1535 if (devctl & MUSB_DEVCTL_HM)
1536 retval |= musb_h_ep0_irq(musb);
1537 else
1538 retval |= musb_g_ep0_irq(musb);
1541 /* RX on endpoints 1-15 */
1542 reg = musb->int_rx >> 1;
1543 ep_num = 1;
1544 while (reg) {
1545 if (reg & 1) {
1546 /* musb_ep_select(musb->mregs, ep_num); */
1547 /* REVISIT just retval = ep->rx_irq(...) */
1548 retval = IRQ_HANDLED;
1549 if (devctl & MUSB_DEVCTL_HM) {
1550 if (is_host_capable())
1551 musb_host_rx(musb, ep_num);
1552 } else {
1553 if (is_peripheral_capable())
1554 musb_g_rx(musb, ep_num);
1558 reg >>= 1;
1559 ep_num++;
1562 /* TX on endpoints 1-15 */
1563 reg = musb->int_tx >> 1;
1564 ep_num = 1;
1565 while (reg) {
1566 if (reg & 1) {
1567 /* musb_ep_select(musb->mregs, ep_num); */
1568 /* REVISIT just retval |= ep->tx_irq(...) */
1569 retval = IRQ_HANDLED;
1570 if (devctl & MUSB_DEVCTL_HM) {
1571 if (is_host_capable())
1572 musb_host_tx(musb, ep_num);
1573 } else {
1574 if (is_peripheral_capable())
1575 musb_g_tx(musb, ep_num);
1578 reg >>= 1;
1579 ep_num++;
1582 return retval;
1586 #ifndef CONFIG_MUSB_PIO_ONLY
1587 static int __initdata use_dma = 1;
1589 /* "modprobe ... use_dma=0" etc */
1590 module_param(use_dma, bool, 0);
1591 MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1593 void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1595 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1597 /* called with controller lock already held */
1599 if (!epnum) {
1600 #ifndef CONFIG_USB_TUSB_OMAP_DMA
1601 if (!is_cppi_enabled()) {
1602 /* endpoint 0 */
1603 if (devctl & MUSB_DEVCTL_HM)
1604 musb_h_ep0_irq(musb);
1605 else
1606 musb_g_ep0_irq(musb);
1608 #endif
1609 } else {
1610 /* endpoints 1..15 */
1611 if (transmit) {
1612 if (devctl & MUSB_DEVCTL_HM) {
1613 if (is_host_capable())
1614 musb_host_tx(musb, epnum);
1615 } else {
1616 if (is_peripheral_capable())
1617 musb_g_tx(musb, epnum);
1619 } else {
1620 /* receive */
1621 if (devctl & MUSB_DEVCTL_HM) {
1622 if (is_host_capable())
1623 musb_host_rx(musb, epnum);
1624 } else {
1625 if (is_peripheral_capable())
1626 musb_g_rx(musb, epnum);
1632 #else
1633 #define use_dma 0
1634 #endif
1636 /*-------------------------------------------------------------------------*/
1638 #ifdef CONFIG_SYSFS
1640 static ssize_t
1641 musb_mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1643 struct musb *musb = dev_to_musb(dev);
1644 unsigned long flags;
1645 int ret = -EINVAL;
1647 spin_lock_irqsave(&musb->lock, flags);
1648 ret = sprintf(buf, "%s\n", otg_state_string(musb));
1649 spin_unlock_irqrestore(&musb->lock, flags);
1651 return ret;
1654 static ssize_t
1655 musb_mode_store(struct device *dev, struct device_attribute *attr,
1656 const char *buf, size_t n)
1658 struct musb *musb = dev_to_musb(dev);
1659 unsigned long flags;
1660 int status;
1662 spin_lock_irqsave(&musb->lock, flags);
1663 if (sysfs_streq(buf, "host"))
1664 status = musb_platform_set_mode(musb, MUSB_HOST);
1665 else if (sysfs_streq(buf, "peripheral"))
1666 status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1667 else if (sysfs_streq(buf, "otg"))
1668 status = musb_platform_set_mode(musb, MUSB_OTG);
1669 else
1670 status = -EINVAL;
1671 spin_unlock_irqrestore(&musb->lock, flags);
1673 return (status == 0) ? n : status;
1675 static DEVICE_ATTR(mode, 0644, musb_mode_show, musb_mode_store);
1677 static ssize_t
1678 musb_vbus_store(struct device *dev, struct device_attribute *attr,
1679 const char *buf, size_t n)
1681 struct musb *musb = dev_to_musb(dev);
1682 unsigned long flags;
1683 unsigned long val;
1685 if (sscanf(buf, "%lu", &val) < 1) {
1686 dev_err(dev, "Invalid VBUS timeout ms value\n");
1687 return -EINVAL;
1690 spin_lock_irqsave(&musb->lock, flags);
1691 /* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1692 musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1693 if (musb->xceiv->state == OTG_STATE_A_WAIT_BCON)
1694 musb->is_active = 0;
1695 musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1696 spin_unlock_irqrestore(&musb->lock, flags);
1698 return n;
1701 static ssize_t
1702 musb_vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1704 struct musb *musb = dev_to_musb(dev);
1705 unsigned long flags;
1706 unsigned long val;
1707 int vbus;
1709 spin_lock_irqsave(&musb->lock, flags);
1710 val = musb->a_wait_bcon;
1711 /* FIXME get_vbus_status() is normally #defined as false...
1712 * and is effectively TUSB-specific.
1714 vbus = musb_platform_get_vbus_status(musb);
1715 spin_unlock_irqrestore(&musb->lock, flags);
1717 return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1718 vbus ? "on" : "off", val);
1720 static DEVICE_ATTR(vbus, 0644, musb_vbus_show, musb_vbus_store);
1722 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
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 #endif /* CONFIG_USB_GADGET_MUSB_HDRC */
1749 static struct attribute *musb_attributes[] = {
1750 &dev_attr_mode.attr,
1751 &dev_attr_vbus.attr,
1752 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1753 &dev_attr_srp.attr,
1754 #endif
1755 NULL
1758 static const struct attribute_group musb_attr_group = {
1759 .attrs = musb_attributes,
1762 #endif /* sysfs */
1764 /* Only used to provide driver mode change events */
1765 static void musb_irq_work(struct work_struct *data)
1767 struct musb *musb = container_of(data, struct musb, irq_work);
1768 static int old_state;
1770 if (musb->xceiv->state != old_state) {
1771 old_state = musb->xceiv->state;
1772 sysfs_notify(&musb->controller->kobj, NULL, "mode");
1776 /* --------------------------------------------------------------------------
1777 * Init support
1780 static struct musb *__init
1781 allocate_instance(struct device *dev,
1782 struct musb_hdrc_config *config, void __iomem *mbase)
1784 struct musb *musb;
1785 struct musb_hw_ep *ep;
1786 int epnum;
1787 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1788 struct usb_hcd *hcd;
1790 hcd = usb_create_hcd(&musb_hc_driver, dev, dev_name(dev));
1791 if (!hcd)
1792 return NULL;
1793 /* usbcore sets dev->driver_data to hcd, and sometimes uses that... */
1795 musb = hcd_to_musb(hcd);
1796 INIT_LIST_HEAD(&musb->control);
1797 INIT_LIST_HEAD(&musb->in_bulk);
1798 INIT_LIST_HEAD(&musb->out_bulk);
1800 hcd->uses_new_polling = 1;
1802 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
1803 musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
1804 #else
1805 musb = kzalloc(sizeof *musb, GFP_KERNEL);
1806 if (!musb)
1807 return NULL;
1808 dev_set_drvdata(dev, musb);
1810 #endif
1812 musb->mregs = mbase;
1813 musb->ctrl_base = mbase;
1814 musb->nIrq = -ENODEV;
1815 musb->config = config;
1816 BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
1817 for (epnum = 0, ep = musb->endpoints;
1818 epnum < musb->config->num_eps;
1819 epnum++, ep++) {
1820 ep->musb = musb;
1821 ep->epnum = epnum;
1824 musb->controller = dev;
1825 return musb;
1828 static void musb_free(struct musb *musb)
1830 /* this has multiple entry modes. it handles fault cleanup after
1831 * probe(), where things may be partially set up, as well as rmmod
1832 * cleanup after everything's been de-activated.
1835 #ifdef CONFIG_SYSFS
1836 sysfs_remove_group(&musb->controller->kobj, &musb_attr_group);
1837 #endif
1839 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1840 musb_gadget_cleanup(musb);
1841 #endif
1843 if (musb->nIrq >= 0) {
1844 if (musb->irq_wake)
1845 disable_irq_wake(musb->nIrq);
1846 free_irq(musb->nIrq, musb);
1848 if (is_dma_capable() && musb->dma_controller) {
1849 struct dma_controller *c = musb->dma_controller;
1851 (void) c->stop(c);
1852 dma_controller_destroy(c);
1855 #ifdef CONFIG_USB_MUSB_OTG
1856 put_device(musb->xceiv->dev);
1857 #endif
1859 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
1860 musb_platform_exit(musb);
1861 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
1863 if (musb->clock) {
1864 clk_disable(musb->clock);
1865 clk_put(musb->clock);
1868 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1869 usb_put_hcd(musb_to_hcd(musb));
1870 #else
1871 kfree(musb);
1872 #endif
1876 * Perform generic per-controller initialization.
1878 * @pDevice: the controller (already clocked, etc)
1879 * @nIrq: irq
1880 * @mregs: virtual address of controller registers,
1881 * not yet corrected for platform-specific offsets
1883 static int __init
1884 musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
1886 int status;
1887 struct musb *musb;
1888 struct musb_hdrc_platform_data *plat = dev->platform_data;
1890 /* The driver might handle more features than the board; OK.
1891 * Fail when the board needs a feature that's not enabled.
1893 if (!plat) {
1894 dev_dbg(dev, "no platform_data?\n");
1895 return -ENODEV;
1897 switch (plat->mode) {
1898 case MUSB_HOST:
1899 #ifdef CONFIG_USB_MUSB_HDRC_HCD
1900 break;
1901 #else
1902 goto bad_config;
1903 #endif
1904 case MUSB_PERIPHERAL:
1905 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
1906 break;
1907 #else
1908 goto bad_config;
1909 #endif
1910 case MUSB_OTG:
1911 #ifdef CONFIG_USB_MUSB_OTG
1912 break;
1913 #else
1914 bad_config:
1915 #endif
1916 default:
1917 dev_err(dev, "incompatible Kconfig role setting\n");
1918 return -EINVAL;
1921 /* allocate */
1922 musb = allocate_instance(dev, plat->config, ctrl);
1923 if (!musb)
1924 return -ENOMEM;
1926 spin_lock_init(&musb->lock);
1927 musb->board_mode = plat->mode;
1928 musb->board_set_power = plat->set_power;
1929 musb->set_clock = plat->set_clock;
1930 musb->min_power = plat->min_power;
1932 /* Clock usage is chip-specific ... functional clock (DaVinci,
1933 * OMAP2430), or PHY ref (some TUSB6010 boards). All this core
1934 * code does is make sure a clock handle is available; platform
1935 * code manages it during start/stop and suspend/resume.
1937 if (plat->clock) {
1938 musb->clock = clk_get(dev, plat->clock);
1939 if (IS_ERR(musb->clock)) {
1940 status = PTR_ERR(musb->clock);
1941 musb->clock = NULL;
1942 goto fail;
1946 /* The musb_platform_init() call:
1947 * - adjusts musb->mregs and musb->isr if needed,
1948 * - may initialize an integrated tranceiver
1949 * - initializes musb->xceiv, usually by otg_get_transceiver()
1950 * - activates clocks.
1951 * - stops powering VBUS
1952 * - assigns musb->board_set_vbus if host mode is enabled
1954 * There are various transciever configurations. Blackfin,
1955 * DaVinci, TUSB60x0, and others integrate them. OMAP3 uses
1956 * external/discrete ones in various flavors (twl4030 family,
1957 * isp1504, non-OTG, etc) mostly hooking up through ULPI.
1959 musb->isr = generic_interrupt;
1960 status = musb_platform_init(musb);
1962 if (status < 0)
1963 goto fail;
1964 if (!musb->isr) {
1965 status = -ENODEV;
1966 goto fail2;
1969 #ifndef CONFIG_MUSB_PIO_ONLY
1970 if (use_dma && dev->dma_mask) {
1971 struct dma_controller *c;
1973 c = dma_controller_create(musb, musb->mregs);
1974 musb->dma_controller = c;
1975 if (c)
1976 (void) c->start(c);
1978 #endif
1979 /* ideally this would be abstracted in platform setup */
1980 if (!is_dma_capable() || !musb->dma_controller)
1981 dev->dma_mask = NULL;
1983 /* be sure interrupts are disabled before connecting ISR */
1984 musb_platform_disable(musb);
1985 musb_generic_disable(musb);
1987 /* setup musb parts of the core (especially endpoints) */
1988 status = musb_core_init(plat->config->multipoint
1989 ? MUSB_CONTROLLER_MHDRC
1990 : MUSB_CONTROLLER_HDRC, musb);
1991 if (status < 0)
1992 goto fail2;
1994 #ifdef CONFIG_USB_MUSB_OTG
1995 setup_timer(&musb->otg_timer, musb_otg_timer_func, (unsigned long) musb);
1996 #endif
1998 /* Init IRQ workqueue before request_irq */
1999 INIT_WORK(&musb->irq_work, musb_irq_work);
2001 /* attach to the IRQ */
2002 if (request_irq(nIrq, musb->isr, 0, dev_name(dev), musb)) {
2003 dev_err(dev, "request_irq %d failed!\n", nIrq);
2004 status = -ENODEV;
2005 goto fail2;
2007 musb->nIrq = nIrq;
2008 /* FIXME this handles wakeup irqs wrong */
2009 if (enable_irq_wake(nIrq) == 0) {
2010 musb->irq_wake = 1;
2011 device_init_wakeup(dev, 1);
2012 } else {
2013 musb->irq_wake = 0;
2016 pr_info("%s: USB %s mode controller at %p using %s, IRQ %d\n",
2017 musb_driver_name,
2018 ({char *s;
2019 switch (musb->board_mode) {
2020 case MUSB_HOST: s = "Host"; break;
2021 case MUSB_PERIPHERAL: s = "Peripheral"; break;
2022 default: s = "OTG"; break;
2023 }; s; }),
2024 ctrl,
2025 (is_dma_capable() && musb->dma_controller)
2026 ? "DMA" : "PIO",
2027 musb->nIrq);
2029 /* host side needs more setup */
2030 if (is_host_enabled(musb)) {
2031 struct usb_hcd *hcd = musb_to_hcd(musb);
2033 otg_set_host(musb->xceiv, &hcd->self);
2035 if (is_otg_enabled(musb))
2036 hcd->self.otg_port = 1;
2037 musb->xceiv->host = &hcd->self;
2038 hcd->power_budget = 2 * (plat->power ? : 250);
2041 /* For the host-only role, we can activate right away.
2042 * (We expect the ID pin to be forcibly grounded!!)
2043 * Otherwise, wait till the gadget driver hooks up.
2045 if (!is_otg_enabled(musb) && is_host_enabled(musb)) {
2046 MUSB_HST_MODE(musb);
2047 musb->xceiv->default_a = 1;
2048 musb->xceiv->state = OTG_STATE_A_IDLE;
2050 status = usb_add_hcd(musb_to_hcd(musb), -1, 0);
2051 if (status)
2052 goto fail;
2054 DBG(1, "%s mode, status %d, devctl %02x %c\n",
2055 "HOST", status,
2056 musb_readb(musb->mregs, MUSB_DEVCTL),
2057 (musb_readb(musb->mregs, MUSB_DEVCTL)
2058 & MUSB_DEVCTL_BDEVICE
2059 ? 'B' : 'A'));
2061 } else /* peripheral is enabled */ {
2062 MUSB_DEV_MODE(musb);
2063 musb->xceiv->default_a = 0;
2064 musb->xceiv->state = OTG_STATE_B_IDLE;
2066 status = musb_gadget_setup(musb);
2067 if (status)
2068 goto fail;
2070 DBG(1, "%s mode, status %d, dev%02x\n",
2071 is_otg_enabled(musb) ? "OTG" : "PERIPHERAL",
2072 status,
2073 musb_readb(musb->mregs, MUSB_DEVCTL));
2077 #ifdef CONFIG_SYSFS
2078 status = sysfs_create_group(&musb->controller->kobj, &musb_attr_group);
2079 #endif
2080 if (status)
2081 goto fail2;
2083 return 0;
2085 fail2:
2086 musb_platform_exit(musb);
2087 fail:
2088 dev_err(musb->controller,
2089 "musb_init_controller failed with status %d\n", status);
2091 if (musb->clock)
2092 clk_put(musb->clock);
2093 device_init_wakeup(dev, 0);
2094 musb_free(musb);
2096 return status;
2100 /*-------------------------------------------------------------------------*/
2102 /* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2103 * bridge to a platform device; this driver then suffices.
2106 #ifndef CONFIG_MUSB_PIO_ONLY
2107 static u64 *orig_dma_mask;
2108 #endif
2110 static int __init musb_probe(struct platform_device *pdev)
2112 struct device *dev = &pdev->dev;
2113 int irq = platform_get_irq(pdev, 0);
2114 struct resource *iomem;
2115 void __iomem *base;
2117 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2118 if (!iomem || irq == 0)
2119 return -ENODEV;
2121 base = ioremap(iomem->start, resource_size(iomem));
2122 if (!base) {
2123 dev_err(dev, "ioremap failed\n");
2124 return -ENOMEM;
2127 #ifndef CONFIG_MUSB_PIO_ONLY
2128 /* clobbered by use_dma=n */
2129 orig_dma_mask = dev->dma_mask;
2130 #endif
2131 return musb_init_controller(dev, irq, base);
2134 static int __exit musb_remove(struct platform_device *pdev)
2136 struct musb *musb = dev_to_musb(&pdev->dev);
2137 void __iomem *ctrl_base = musb->ctrl_base;
2139 /* this gets called on rmmod.
2140 * - Host mode: host may still be active
2141 * - Peripheral mode: peripheral is deactivated (or never-activated)
2142 * - OTG mode: both roles are deactivated (or never-activated)
2144 musb_shutdown(pdev);
2145 #ifdef CONFIG_USB_MUSB_HDRC_HCD
2146 if (musb->board_mode == MUSB_HOST)
2147 usb_remove_hcd(musb_to_hcd(musb));
2148 #endif
2149 musb_free(musb);
2150 iounmap(ctrl_base);
2151 device_init_wakeup(&pdev->dev, 0);
2152 #ifndef CONFIG_MUSB_PIO_ONLY
2153 pdev->dev.dma_mask = orig_dma_mask;
2154 #endif
2155 return 0;
2158 #ifdef CONFIG_PM
2160 static int musb_suspend(struct device *dev)
2162 struct platform_device *pdev = to_platform_device(dev);
2163 unsigned long flags;
2164 struct musb *musb = dev_to_musb(&pdev->dev);
2166 if (!musb->clock)
2167 return 0;
2169 spin_lock_irqsave(&musb->lock, flags);
2171 if (is_peripheral_active(musb)) {
2172 /* FIXME force disconnect unless we know USB will wake
2173 * the system up quickly enough to respond ...
2175 } else if (is_host_active(musb)) {
2176 /* we know all the children are suspended; sometimes
2177 * they will even be wakeup-enabled.
2181 if (musb->set_clock)
2182 musb->set_clock(musb->clock, 0);
2183 else
2184 clk_disable(musb->clock);
2185 spin_unlock_irqrestore(&musb->lock, flags);
2186 return 0;
2189 static int musb_resume_noirq(struct device *dev)
2191 struct platform_device *pdev = to_platform_device(dev);
2192 struct musb *musb = dev_to_musb(&pdev->dev);
2194 if (!musb->clock)
2195 return 0;
2197 if (musb->set_clock)
2198 musb->set_clock(musb->clock, 1);
2199 else
2200 clk_enable(musb->clock);
2202 /* for static cmos like DaVinci, register values were preserved
2203 * unless for some reason the whole soc powered down or the USB
2204 * module got reset through the PSC (vs just being disabled).
2206 return 0;
2209 static const struct dev_pm_ops musb_dev_pm_ops = {
2210 .suspend = musb_suspend,
2211 .resume_noirq = musb_resume_noirq,
2214 #define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2215 #else
2216 #define MUSB_DEV_PM_OPS NULL
2217 #endif
2219 static struct platform_driver musb_driver = {
2220 .driver = {
2221 .name = (char *)musb_driver_name,
2222 .bus = &platform_bus_type,
2223 .owner = THIS_MODULE,
2224 .pm = MUSB_DEV_PM_OPS,
2226 .remove = __exit_p(musb_remove),
2227 .shutdown = musb_shutdown,
2230 /*-------------------------------------------------------------------------*/
2232 static int __init musb_init(void)
2234 #ifdef CONFIG_USB_MUSB_HDRC_HCD
2235 if (usb_disabled())
2236 return 0;
2237 #endif
2239 pr_info("%s: version " MUSB_VERSION ", "
2240 #ifdef CONFIG_MUSB_PIO_ONLY
2241 "pio"
2242 #elif defined(CONFIG_USB_TI_CPPI_DMA)
2243 "cppi-dma"
2244 #elif defined(CONFIG_USB_INVENTRA_DMA)
2245 "musb-dma"
2246 #elif defined(CONFIG_USB_TUSB_OMAP_DMA)
2247 "tusb-omap-dma"
2248 #else
2249 "?dma?"
2250 #endif
2251 ", "
2252 #ifdef CONFIG_USB_MUSB_OTG
2253 "otg (peripheral+host)"
2254 #elif defined(CONFIG_USB_GADGET_MUSB_HDRC)
2255 "peripheral"
2256 #elif defined(CONFIG_USB_MUSB_HDRC_HCD)
2257 "host"
2258 #endif
2259 ", debug=%d\n",
2260 musb_driver_name, musb_debug);
2261 return platform_driver_probe(&musb_driver, musb_probe);
2264 /* make us init after usbcore and i2c (transceivers, regulators, etc)
2265 * and before usb gadget and host-side drivers start to register
2267 fs_initcall(musb_init);
2269 static void __exit musb_cleanup(void)
2271 platform_driver_unregister(&musb_driver);
2273 module_exit(musb_cleanup);