Merge branch 'usb-next' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb-2.6
[linux-2.6.git] / drivers / usb / musb / musb_core.c
blob20a28731c338e8aa9dbf2bac295ce8ddda426e3a
1 /*
2 * MUSB OTG driver core code
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA
22 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
25 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Inventra (Multipoint) Dual-Role Controller Driver for Linux.
38 * This consists of a Host Controller Driver (HCD) and a peripheral
39 * controller driver implementing the "Gadget" API; OTG support is
40 * in the works. These are normal Linux-USB controller drivers which
41 * use IRQs and have no dedicated thread.
43 * This version of the driver has only been used with products from
44 * Texas Instruments. Those products integrate the Inventra logic
45 * with other DMA, IRQ, and bus modules, as well as other logic that
46 * needs to be reflected in this driver.
49 * NOTE: the original Mentor code here was pretty much a collection
50 * of mechanisms that don't seem to have been fully integrated/working
51 * for *any* Linux kernel version. This version aims at Linux 2.6.now,
52 * Key open issues include:
54 * - Lack of host-side transaction scheduling, for all transfer types.
55 * The hardware doesn't do it; instead, software must.
57 * This is not an issue for OTG devices that don't support external
58 * hubs, but for more "normal" USB hosts it's a user issue that the
59 * "multipoint" support doesn't scale in the expected ways. That
60 * includes DaVinci EVM in a common non-OTG mode.
62 * * Control and bulk use dedicated endpoints, and there's as
63 * yet no mechanism to either (a) reclaim the hardware when
64 * peripherals are NAKing, which gets complicated with bulk
65 * endpoints, or (b) use more than a single bulk endpoint in
66 * each direction.
68 * RESULT: one device may be perceived as blocking another one.
70 * * Interrupt and isochronous will dynamically allocate endpoint
71 * hardware, but (a) there's no record keeping for bandwidth;
72 * (b) in the common case that few endpoints are available, there
73 * is no mechanism to reuse endpoints to talk to multiple devices.
75 * RESULT: At one extreme, bandwidth can be overcommitted in
76 * some hardware configurations, no faults will be reported.
77 * At the other extreme, the bandwidth capabilities which do
78 * exist tend to be severely undercommitted. You can't yet hook
79 * up both a keyboard and a mouse to an external USB hub.
83 * This gets many kinds of configuration information:
84 * - Kconfig for everything user-configurable
85 * - platform_device for addressing, irq, and platform_data
86 * - platform_data is mostly for board-specific informarion
87 * (plus recentrly, SOC or family details)
89 * Most of the conditional compilation will (someday) vanish.
92 #include <linux/module.h>
93 #include <linux/kernel.h>
94 #include <linux/sched.h>
95 #include <linux/slab.h>
96 #include <linux/init.h>
97 #include <linux/list.h>
98 #include <linux/kobject.h>
99 #include <linux/prefetch.h>
100 #include <linux/platform_device.h>
101 #include <linux/io.h>
103 #include "musb_core.h"
105 #define TA_WAIT_BCON(m) max_t(int, (m)->a_wait_bcon, OTG_TIME_A_WAIT_BCON)
108 #define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
109 #define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
111 #define MUSB_VERSION "6.0"
113 #define DRIVER_INFO DRIVER_DESC ", v" MUSB_VERSION
115 #define MUSB_DRIVER_NAME "musb-hdrc"
116 const char musb_driver_name[] = MUSB_DRIVER_NAME;
118 MODULE_DESCRIPTION(DRIVER_INFO);
119 MODULE_AUTHOR(DRIVER_AUTHOR);
120 MODULE_LICENSE("GPL");
121 MODULE_ALIAS("platform:" MUSB_DRIVER_NAME);
124 /*-------------------------------------------------------------------------*/
126 static inline struct musb *dev_to_musb(struct device *dev)
128 return dev_get_drvdata(dev);
131 /*-------------------------------------------------------------------------*/
133 #ifndef CONFIG_BLACKFIN
134 static int musb_ulpi_read(struct otg_transceiver *otg, u32 offset)
136 void __iomem *addr = otg->io_priv;
137 int i = 0;
138 u8 r;
139 u8 power;
141 /* Make sure the transceiver is not in low power mode */
142 power = musb_readb(addr, MUSB_POWER);
143 power &= ~MUSB_POWER_SUSPENDM;
144 musb_writeb(addr, MUSB_POWER, power);
146 /* REVISIT: musbhdrc_ulpi_an.pdf recommends setting the
147 * ULPICarKitControlDisableUTMI after clearing POWER_SUSPENDM.
150 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
151 musb_writeb(addr, MUSB_ULPI_REG_CONTROL,
152 MUSB_ULPI_REG_REQ | MUSB_ULPI_RDN_WR);
154 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
155 & MUSB_ULPI_REG_CMPLT)) {
156 i++;
157 if (i == 10000)
158 return -ETIMEDOUT;
161 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
162 r &= ~MUSB_ULPI_REG_CMPLT;
163 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
165 return musb_readb(addr, MUSB_ULPI_REG_DATA);
168 static int musb_ulpi_write(struct otg_transceiver *otg,
169 u32 offset, u32 data)
171 void __iomem *addr = otg->io_priv;
172 int i = 0;
173 u8 r = 0;
174 u8 power;
176 /* Make sure the transceiver is not in low power mode */
177 power = musb_readb(addr, MUSB_POWER);
178 power &= ~MUSB_POWER_SUSPENDM;
179 musb_writeb(addr, MUSB_POWER, power);
181 musb_writeb(addr, MUSB_ULPI_REG_ADDR, (u8)offset);
182 musb_writeb(addr, MUSB_ULPI_REG_DATA, (u8)data);
183 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, MUSB_ULPI_REG_REQ);
185 while (!(musb_readb(addr, MUSB_ULPI_REG_CONTROL)
186 & MUSB_ULPI_REG_CMPLT)) {
187 i++;
188 if (i == 10000)
189 return -ETIMEDOUT;
192 r = musb_readb(addr, MUSB_ULPI_REG_CONTROL);
193 r &= ~MUSB_ULPI_REG_CMPLT;
194 musb_writeb(addr, MUSB_ULPI_REG_CONTROL, r);
196 return 0;
198 #else
199 #define musb_ulpi_read NULL
200 #define musb_ulpi_write NULL
201 #endif
203 static struct otg_io_access_ops musb_ulpi_access = {
204 .read = musb_ulpi_read,
205 .write = musb_ulpi_write,
208 /*-------------------------------------------------------------------------*/
210 #if !defined(CONFIG_USB_MUSB_TUSB6010) && !defined(CONFIG_USB_MUSB_BLACKFIN)
213 * Load an endpoint's FIFO
215 void musb_write_fifo(struct musb_hw_ep *hw_ep, u16 len, const u8 *src)
217 struct musb *musb = hw_ep->musb;
218 void __iomem *fifo = hw_ep->fifo;
220 prefetch((u8 *)src);
222 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
223 'T', hw_ep->epnum, fifo, len, src);
225 /* we can't assume unaligned reads work */
226 if (likely((0x01 & (unsigned long) src) == 0)) {
227 u16 index = 0;
229 /* best case is 32bit-aligned source address */
230 if ((0x02 & (unsigned long) src) == 0) {
231 if (len >= 4) {
232 writesl(fifo, src + index, len >> 2);
233 index += len & ~0x03;
235 if (len & 0x02) {
236 musb_writew(fifo, 0, *(u16 *)&src[index]);
237 index += 2;
239 } else {
240 if (len >= 2) {
241 writesw(fifo, src + index, len >> 1);
242 index += len & ~0x01;
245 if (len & 0x01)
246 musb_writeb(fifo, 0, src[index]);
247 } else {
248 /* byte aligned */
249 writesb(fifo, src, len);
253 #if !defined(CONFIG_USB_MUSB_AM35X)
255 * Unload an endpoint's FIFO
257 void musb_read_fifo(struct musb_hw_ep *hw_ep, u16 len, u8 *dst)
259 struct musb *musb = hw_ep->musb;
260 void __iomem *fifo = hw_ep->fifo;
262 dev_dbg(musb->controller, "%cX ep%d fifo %p count %d buf %p\n",
263 'R', hw_ep->epnum, fifo, len, dst);
265 /* we can't assume unaligned writes work */
266 if (likely((0x01 & (unsigned long) dst) == 0)) {
267 u16 index = 0;
269 /* best case is 32bit-aligned destination address */
270 if ((0x02 & (unsigned long) dst) == 0) {
271 if (len >= 4) {
272 readsl(fifo, dst, len >> 2);
273 index = len & ~0x03;
275 if (len & 0x02) {
276 *(u16 *)&dst[index] = musb_readw(fifo, 0);
277 index += 2;
279 } else {
280 if (len >= 2) {
281 readsw(fifo, dst, len >> 1);
282 index = len & ~0x01;
285 if (len & 0x01)
286 dst[index] = musb_readb(fifo, 0);
287 } else {
288 /* byte aligned */
289 readsb(fifo, dst, len);
292 #endif
294 #endif /* normal PIO */
297 /*-------------------------------------------------------------------------*/
299 /* for high speed test mode; see USB 2.0 spec 7.1.20 */
300 static const u8 musb_test_packet[53] = {
301 /* implicit SYNC then DATA0 to start */
303 /* JKJKJKJK x9 */
304 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
305 /* JJKKJJKK x8 */
306 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
307 /* JJJJKKKK x8 */
308 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee, 0xee,
309 /* JJJJJJJKKKKKKK x8 */
310 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
311 /* JJJJJJJK x8 */
312 0x7f, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd,
313 /* JKKKKKKK x10, JK */
314 0xfc, 0x7e, 0xbf, 0xdf, 0xef, 0xf7, 0xfb, 0xfd, 0x7e
316 /* implicit CRC16 then EOP to end */
319 void musb_load_testpacket(struct musb *musb)
321 void __iomem *regs = musb->endpoints[0].regs;
323 musb_ep_select(musb->mregs, 0);
324 musb_write_fifo(musb->control_ep,
325 sizeof(musb_test_packet), musb_test_packet);
326 musb_writew(regs, MUSB_CSR0, MUSB_CSR0_TXPKTRDY);
329 /*-------------------------------------------------------------------------*/
332 * Handles OTG hnp timeouts, such as b_ase0_brst
334 void musb_otg_timer_func(unsigned long data)
336 struct musb *musb = (struct musb *)data;
337 unsigned long flags;
339 spin_lock_irqsave(&musb->lock, flags);
340 switch (musb->xceiv->state) {
341 case OTG_STATE_B_WAIT_ACON:
342 dev_dbg(musb->controller, "HNP: b_wait_acon timeout; back to b_peripheral\n");
343 musb_g_disconnect(musb);
344 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
345 musb->is_active = 0;
346 break;
347 case OTG_STATE_A_SUSPEND:
348 case OTG_STATE_A_WAIT_BCON:
349 dev_dbg(musb->controller, "HNP: %s timeout\n",
350 otg_state_string(musb->xceiv->state));
351 musb_platform_set_vbus(musb, 0);
352 musb->xceiv->state = OTG_STATE_A_WAIT_VFALL;
353 break;
354 default:
355 dev_dbg(musb->controller, "HNP: Unhandled mode %s\n",
356 otg_state_string(musb->xceiv->state));
358 musb->ignore_disconnect = 0;
359 spin_unlock_irqrestore(&musb->lock, flags);
363 * Stops the HNP transition. Caller must take care of locking.
365 void musb_hnp_stop(struct musb *musb)
367 struct usb_hcd *hcd = musb_to_hcd(musb);
368 void __iomem *mbase = musb->mregs;
369 u8 reg;
371 dev_dbg(musb->controller, "HNP: stop from %s\n", otg_state_string(musb->xceiv->state));
373 switch (musb->xceiv->state) {
374 case OTG_STATE_A_PERIPHERAL:
375 musb_g_disconnect(musb);
376 dev_dbg(musb->controller, "HNP: back to %s\n",
377 otg_state_string(musb->xceiv->state));
378 break;
379 case OTG_STATE_B_HOST:
380 dev_dbg(musb->controller, "HNP: Disabling HR\n");
381 hcd->self.is_b_host = 0;
382 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
383 MUSB_DEV_MODE(musb);
384 reg = musb_readb(mbase, MUSB_POWER);
385 reg |= MUSB_POWER_SUSPENDM;
386 musb_writeb(mbase, MUSB_POWER, reg);
387 /* REVISIT: Start SESSION_REQUEST here? */
388 break;
389 default:
390 dev_dbg(musb->controller, "HNP: Stopping in unknown state %s\n",
391 otg_state_string(musb->xceiv->state));
395 * When returning to A state after HNP, avoid hub_port_rebounce(),
396 * which cause occasional OPT A "Did not receive reset after connect"
397 * errors.
399 musb->port1_status &= ~(USB_PORT_STAT_C_CONNECTION << 16);
403 * Interrupt Service Routine to record USB "global" interrupts.
404 * Since these do not happen often and signify things of
405 * paramount importance, it seems OK to check them individually;
406 * the order of the tests is specified in the manual
408 * @param musb instance pointer
409 * @param int_usb register contents
410 * @param devctl
411 * @param power
414 static irqreturn_t musb_stage0_irq(struct musb *musb, u8 int_usb,
415 u8 devctl, u8 power)
417 irqreturn_t handled = IRQ_NONE;
419 dev_dbg(musb->controller, "<== Power=%02x, DevCtl=%02x, int_usb=0x%x\n", power, devctl,
420 int_usb);
422 /* in host mode, the peripheral may issue remote wakeup.
423 * in peripheral mode, the host may resume the link.
424 * spurious RESUME irqs happen too, paired with SUSPEND.
426 if (int_usb & MUSB_INTR_RESUME) {
427 handled = IRQ_HANDLED;
428 dev_dbg(musb->controller, "RESUME (%s)\n", otg_state_string(musb->xceiv->state));
430 if (devctl & MUSB_DEVCTL_HM) {
431 void __iomem *mbase = musb->mregs;
433 switch (musb->xceiv->state) {
434 case OTG_STATE_A_SUSPEND:
435 /* remote wakeup? later, GetPortStatus
436 * will stop RESUME signaling
439 if (power & MUSB_POWER_SUSPENDM) {
440 /* spurious */
441 musb->int_usb &= ~MUSB_INTR_SUSPEND;
442 dev_dbg(musb->controller, "Spurious SUSPENDM\n");
443 break;
446 power &= ~MUSB_POWER_SUSPENDM;
447 musb_writeb(mbase, MUSB_POWER,
448 power | MUSB_POWER_RESUME);
450 musb->port1_status |=
451 (USB_PORT_STAT_C_SUSPEND << 16)
452 | MUSB_PORT_STAT_RESUME;
453 musb->rh_timer = jiffies
454 + msecs_to_jiffies(20);
456 musb->xceiv->state = OTG_STATE_A_HOST;
457 musb->is_active = 1;
458 usb_hcd_resume_root_hub(musb_to_hcd(musb));
459 break;
460 case OTG_STATE_B_WAIT_ACON:
461 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
462 musb->is_active = 1;
463 MUSB_DEV_MODE(musb);
464 break;
465 default:
466 WARNING("bogus %s RESUME (%s)\n",
467 "host",
468 otg_state_string(musb->xceiv->state));
470 } else {
471 switch (musb->xceiv->state) {
472 case OTG_STATE_A_SUSPEND:
473 /* possibly DISCONNECT is upcoming */
474 musb->xceiv->state = OTG_STATE_A_HOST;
475 usb_hcd_resume_root_hub(musb_to_hcd(musb));
476 break;
477 case OTG_STATE_B_WAIT_ACON:
478 case OTG_STATE_B_PERIPHERAL:
479 /* disconnect while suspended? we may
480 * not get a disconnect irq...
482 if ((devctl & MUSB_DEVCTL_VBUS)
483 != (3 << MUSB_DEVCTL_VBUS_SHIFT)
485 musb->int_usb |= MUSB_INTR_DISCONNECT;
486 musb->int_usb &= ~MUSB_INTR_SUSPEND;
487 break;
489 musb_g_resume(musb);
490 break;
491 case OTG_STATE_B_IDLE:
492 musb->int_usb &= ~MUSB_INTR_SUSPEND;
493 break;
494 default:
495 WARNING("bogus %s RESUME (%s)\n",
496 "peripheral",
497 otg_state_string(musb->xceiv->state));
502 /* see manual for the order of the tests */
503 if (int_usb & MUSB_INTR_SESSREQ) {
504 void __iomem *mbase = musb->mregs;
506 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS
507 && (devctl & MUSB_DEVCTL_BDEVICE)) {
508 dev_dbg(musb->controller, "SessReq while on B state\n");
509 return IRQ_HANDLED;
512 dev_dbg(musb->controller, "SESSION_REQUEST (%s)\n",
513 otg_state_string(musb->xceiv->state));
515 /* IRQ arrives from ID pin sense or (later, if VBUS power
516 * is removed) SRP. responses are time critical:
517 * - turn on VBUS (with silicon-specific mechanism)
518 * - go through A_WAIT_VRISE
519 * - ... to A_WAIT_BCON.
520 * a_wait_vrise_tmout triggers VBUS_ERROR transitions
522 musb_writeb(mbase, MUSB_DEVCTL, MUSB_DEVCTL_SESSION);
523 musb->ep0_stage = MUSB_EP0_START;
524 musb->xceiv->state = OTG_STATE_A_IDLE;
525 MUSB_HST_MODE(musb);
526 musb_platform_set_vbus(musb, 1);
528 handled = IRQ_HANDLED;
531 if (int_usb & MUSB_INTR_VBUSERROR) {
532 int ignore = 0;
534 /* During connection as an A-Device, we may see a short
535 * current spikes causing voltage drop, because of cable
536 * and peripheral capacitance combined with vbus draw.
537 * (So: less common with truly self-powered devices, where
538 * vbus doesn't act like a power supply.)
540 * Such spikes are short; usually less than ~500 usec, max
541 * of ~2 msec. That is, they're not sustained overcurrent
542 * errors, though they're reported using VBUSERROR irqs.
544 * Workarounds: (a) hardware: use self powered devices.
545 * (b) software: ignore non-repeated VBUS errors.
547 * REVISIT: do delays from lots of DEBUG_KERNEL checks
548 * make trouble here, keeping VBUS < 4.4V ?
550 switch (musb->xceiv->state) {
551 case OTG_STATE_A_HOST:
552 /* recovery is dicey once we've gotten past the
553 * initial stages of enumeration, but if VBUS
554 * stayed ok at the other end of the link, and
555 * another reset is due (at least for high speed,
556 * to redo the chirp etc), it might work OK...
558 case OTG_STATE_A_WAIT_BCON:
559 case OTG_STATE_A_WAIT_VRISE:
560 if (musb->vbuserr_retry) {
561 void __iomem *mbase = musb->mregs;
563 musb->vbuserr_retry--;
564 ignore = 1;
565 devctl |= MUSB_DEVCTL_SESSION;
566 musb_writeb(mbase, MUSB_DEVCTL, devctl);
567 } else {
568 musb->port1_status |=
569 USB_PORT_STAT_OVERCURRENT
570 | (USB_PORT_STAT_C_OVERCURRENT << 16);
572 break;
573 default:
574 break;
577 dev_dbg(musb->controller, "VBUS_ERROR in %s (%02x, %s), retry #%d, port1 %08x\n",
578 otg_state_string(musb->xceiv->state),
579 devctl,
580 ({ char *s;
581 switch (devctl & MUSB_DEVCTL_VBUS) {
582 case 0 << MUSB_DEVCTL_VBUS_SHIFT:
583 s = "<SessEnd"; break;
584 case 1 << MUSB_DEVCTL_VBUS_SHIFT:
585 s = "<AValid"; break;
586 case 2 << MUSB_DEVCTL_VBUS_SHIFT:
587 s = "<VBusValid"; break;
588 /* case 3 << MUSB_DEVCTL_VBUS_SHIFT: */
589 default:
590 s = "VALID"; break;
591 }; s; }),
592 VBUSERR_RETRY_COUNT - musb->vbuserr_retry,
593 musb->port1_status);
595 /* go through A_WAIT_VFALL then start a new session */
596 if (!ignore)
597 musb_platform_set_vbus(musb, 0);
598 handled = IRQ_HANDLED;
601 if (int_usb & MUSB_INTR_SUSPEND) {
602 dev_dbg(musb->controller, "SUSPEND (%s) devctl %02x power %02x\n",
603 otg_state_string(musb->xceiv->state), devctl, power);
604 handled = IRQ_HANDLED;
606 switch (musb->xceiv->state) {
607 case OTG_STATE_A_PERIPHERAL:
608 /* We also come here if the cable is removed, since
609 * this silicon doesn't report ID-no-longer-grounded.
611 * We depend on T(a_wait_bcon) to shut us down, and
612 * hope users don't do anything dicey during this
613 * undesired detour through A_WAIT_BCON.
615 musb_hnp_stop(musb);
616 usb_hcd_resume_root_hub(musb_to_hcd(musb));
617 musb_root_disconnect(musb);
618 musb_platform_try_idle(musb, jiffies
619 + msecs_to_jiffies(musb->a_wait_bcon
620 ? : OTG_TIME_A_WAIT_BCON));
622 break;
623 case OTG_STATE_B_IDLE:
624 if (!musb->is_active)
625 break;
626 case OTG_STATE_B_PERIPHERAL:
627 musb_g_suspend(musb);
628 musb->is_active = is_otg_enabled(musb)
629 && musb->xceiv->gadget->b_hnp_enable;
630 if (musb->is_active) {
631 musb->xceiv->state = OTG_STATE_B_WAIT_ACON;
632 dev_dbg(musb->controller, "HNP: Setting timer for b_ase0_brst\n");
633 mod_timer(&musb->otg_timer, jiffies
634 + msecs_to_jiffies(
635 OTG_TIME_B_ASE0_BRST));
637 break;
638 case OTG_STATE_A_WAIT_BCON:
639 if (musb->a_wait_bcon != 0)
640 musb_platform_try_idle(musb, jiffies
641 + msecs_to_jiffies(musb->a_wait_bcon));
642 break;
643 case OTG_STATE_A_HOST:
644 musb->xceiv->state = OTG_STATE_A_SUSPEND;
645 musb->is_active = is_otg_enabled(musb)
646 && musb->xceiv->host->b_hnp_enable;
647 break;
648 case OTG_STATE_B_HOST:
649 /* Transition to B_PERIPHERAL, see 6.8.2.6 p 44 */
650 dev_dbg(musb->controller, "REVISIT: SUSPEND as B_HOST\n");
651 break;
652 default:
653 /* "should not happen" */
654 musb->is_active = 0;
655 break;
659 if (int_usb & MUSB_INTR_CONNECT) {
660 struct usb_hcd *hcd = musb_to_hcd(musb);
662 handled = IRQ_HANDLED;
663 musb->is_active = 1;
664 set_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
666 musb->ep0_stage = MUSB_EP0_START;
668 /* flush endpoints when transitioning from Device Mode */
669 if (is_peripheral_active(musb)) {
670 /* REVISIT HNP; just force disconnect */
672 musb_writew(musb->mregs, MUSB_INTRTXE, musb->epmask);
673 musb_writew(musb->mregs, MUSB_INTRRXE, musb->epmask & 0xfffe);
674 musb_writeb(musb->mregs, MUSB_INTRUSBE, 0xf7);
675 musb->port1_status &= ~(USB_PORT_STAT_LOW_SPEED
676 |USB_PORT_STAT_HIGH_SPEED
677 |USB_PORT_STAT_ENABLE
679 musb->port1_status |= USB_PORT_STAT_CONNECTION
680 |(USB_PORT_STAT_C_CONNECTION << 16);
682 /* high vs full speed is just a guess until after reset */
683 if (devctl & MUSB_DEVCTL_LSDEV)
684 musb->port1_status |= USB_PORT_STAT_LOW_SPEED;
686 /* indicate new connection to OTG machine */
687 switch (musb->xceiv->state) {
688 case OTG_STATE_B_PERIPHERAL:
689 if (int_usb & MUSB_INTR_SUSPEND) {
690 dev_dbg(musb->controller, "HNP: SUSPEND+CONNECT, now b_host\n");
691 int_usb &= ~MUSB_INTR_SUSPEND;
692 goto b_host;
693 } else
694 dev_dbg(musb->controller, "CONNECT as b_peripheral???\n");
695 break;
696 case OTG_STATE_B_WAIT_ACON:
697 dev_dbg(musb->controller, "HNP: CONNECT, now b_host\n");
698 b_host:
699 musb->xceiv->state = OTG_STATE_B_HOST;
700 hcd->self.is_b_host = 1;
701 musb->ignore_disconnect = 0;
702 del_timer(&musb->otg_timer);
703 break;
704 default:
705 if ((devctl & MUSB_DEVCTL_VBUS)
706 == (3 << MUSB_DEVCTL_VBUS_SHIFT)) {
707 musb->xceiv->state = OTG_STATE_A_HOST;
708 hcd->self.is_b_host = 0;
710 break;
713 /* poke the root hub */
714 MUSB_HST_MODE(musb);
715 if (hcd->status_urb)
716 usb_hcd_poll_rh_status(hcd);
717 else
718 usb_hcd_resume_root_hub(hcd);
720 dev_dbg(musb->controller, "CONNECT (%s) devctl %02x\n",
721 otg_state_string(musb->xceiv->state), devctl);
724 if ((int_usb & MUSB_INTR_DISCONNECT) && !musb->ignore_disconnect) {
725 dev_dbg(musb->controller, "DISCONNECT (%s) as %s, devctl %02x\n",
726 otg_state_string(musb->xceiv->state),
727 MUSB_MODE(musb), devctl);
728 handled = IRQ_HANDLED;
730 switch (musb->xceiv->state) {
731 case OTG_STATE_A_HOST:
732 case OTG_STATE_A_SUSPEND:
733 usb_hcd_resume_root_hub(musb_to_hcd(musb));
734 musb_root_disconnect(musb);
735 if (musb->a_wait_bcon != 0 && is_otg_enabled(musb))
736 musb_platform_try_idle(musb, jiffies
737 + msecs_to_jiffies(musb->a_wait_bcon));
738 break;
739 case OTG_STATE_B_HOST:
740 /* REVISIT this behaves for "real disconnect"
741 * cases; make sure the other transitions from
742 * from B_HOST act right too. The B_HOST code
743 * in hnp_stop() is currently not used...
745 musb_root_disconnect(musb);
746 musb_to_hcd(musb)->self.is_b_host = 0;
747 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
748 MUSB_DEV_MODE(musb);
749 musb_g_disconnect(musb);
750 break;
751 case OTG_STATE_A_PERIPHERAL:
752 musb_hnp_stop(musb);
753 musb_root_disconnect(musb);
754 /* FALLTHROUGH */
755 case OTG_STATE_B_WAIT_ACON:
756 /* FALLTHROUGH */
757 case OTG_STATE_B_PERIPHERAL:
758 case OTG_STATE_B_IDLE:
759 musb_g_disconnect(musb);
760 break;
761 default:
762 WARNING("unhandled DISCONNECT transition (%s)\n",
763 otg_state_string(musb->xceiv->state));
764 break;
768 /* mentor saves a bit: bus reset and babble share the same irq.
769 * only host sees babble; only peripheral sees bus reset.
771 if (int_usb & MUSB_INTR_RESET) {
772 handled = IRQ_HANDLED;
773 if (is_host_capable() && (devctl & MUSB_DEVCTL_HM) != 0) {
775 * Looks like non-HS BABBLE can be ignored, but
776 * HS BABBLE is an error condition. For HS the solution
777 * is to avoid babble in the first place and fix what
778 * caused BABBLE. When HS BABBLE happens we can only
779 * stop the session.
781 if (devctl & (MUSB_DEVCTL_FSDEV | MUSB_DEVCTL_LSDEV))
782 dev_dbg(musb->controller, "BABBLE devctl: %02x\n", devctl);
783 else {
784 ERR("Stopping host session -- babble\n");
785 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
787 } else if (is_peripheral_capable()) {
788 dev_dbg(musb->controller, "BUS RESET as %s\n",
789 otg_state_string(musb->xceiv->state));
790 switch (musb->xceiv->state) {
791 case OTG_STATE_A_SUSPEND:
792 /* We need to ignore disconnect on suspend
793 * otherwise tusb 2.0 won't reconnect after a
794 * power cycle, which breaks otg compliance.
796 musb->ignore_disconnect = 1;
797 musb_g_reset(musb);
798 /* FALLTHROUGH */
799 case OTG_STATE_A_WAIT_BCON: /* OPT TD.4.7-900ms */
800 /* never use invalid T(a_wait_bcon) */
801 dev_dbg(musb->controller, "HNP: in %s, %d msec timeout\n",
802 otg_state_string(musb->xceiv->state),
803 TA_WAIT_BCON(musb));
804 mod_timer(&musb->otg_timer, jiffies
805 + msecs_to_jiffies(TA_WAIT_BCON(musb)));
806 break;
807 case OTG_STATE_A_PERIPHERAL:
808 musb->ignore_disconnect = 0;
809 del_timer(&musb->otg_timer);
810 musb_g_reset(musb);
811 break;
812 case OTG_STATE_B_WAIT_ACON:
813 dev_dbg(musb->controller, "HNP: RESET (%s), to b_peripheral\n",
814 otg_state_string(musb->xceiv->state));
815 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
816 musb_g_reset(musb);
817 break;
818 case OTG_STATE_B_IDLE:
819 musb->xceiv->state = OTG_STATE_B_PERIPHERAL;
820 /* FALLTHROUGH */
821 case OTG_STATE_B_PERIPHERAL:
822 musb_g_reset(musb);
823 break;
824 default:
825 dev_dbg(musb->controller, "Unhandled BUS RESET as %s\n",
826 otg_state_string(musb->xceiv->state));
831 #if 0
832 /* REVISIT ... this would be for multiplexing periodic endpoints, or
833 * supporting transfer phasing to prevent exceeding ISO bandwidth
834 * limits of a given frame or microframe.
836 * It's not needed for peripheral side, which dedicates endpoints;
837 * though it _might_ use SOF irqs for other purposes.
839 * And it's not currently needed for host side, which also dedicates
840 * endpoints, relies on TX/RX interval registers, and isn't claimed
841 * to support ISO transfers yet.
843 if (int_usb & MUSB_INTR_SOF) {
844 void __iomem *mbase = musb->mregs;
845 struct musb_hw_ep *ep;
846 u8 epnum;
847 u16 frame;
849 dev_dbg(musb->controller, "START_OF_FRAME\n");
850 handled = IRQ_HANDLED;
852 /* start any periodic Tx transfers waiting for current frame */
853 frame = musb_readw(mbase, MUSB_FRAME);
854 ep = musb->endpoints;
855 for (epnum = 1; (epnum < musb->nr_endpoints)
856 && (musb->epmask >= (1 << epnum));
857 epnum++, ep++) {
859 * FIXME handle framecounter wraps (12 bits)
860 * eliminate duplicated StartUrb logic
862 if (ep->dwWaitFrame >= frame) {
863 ep->dwWaitFrame = 0;
864 pr_debug("SOF --> periodic TX%s on %d\n",
865 ep->tx_channel ? " DMA" : "",
866 epnum);
867 if (!ep->tx_channel)
868 musb_h_tx_start(musb, epnum);
869 else
870 cppi_hostdma_start(musb, epnum);
872 } /* end of for loop */
874 #endif
876 schedule_work(&musb->irq_work);
878 return handled;
881 /*-------------------------------------------------------------------------*/
884 * Program the HDRC to start (enable interrupts, dma, etc.).
886 void musb_start(struct musb *musb)
888 void __iomem *regs = musb->mregs;
889 u8 devctl = musb_readb(regs, MUSB_DEVCTL);
891 dev_dbg(musb->controller, "<== devctl %02x\n", devctl);
893 /* Set INT enable registers, enable interrupts */
894 musb_writew(regs, MUSB_INTRTXE, musb->epmask);
895 musb_writew(regs, MUSB_INTRRXE, musb->epmask & 0xfffe);
896 musb_writeb(regs, MUSB_INTRUSBE, 0xf7);
898 musb_writeb(regs, MUSB_TESTMODE, 0);
900 /* put into basic highspeed mode and start session */
901 musb_writeb(regs, MUSB_POWER, MUSB_POWER_ISOUPDATE
902 | MUSB_POWER_HSENAB
903 /* ENSUSPEND wedges tusb */
904 /* | MUSB_POWER_ENSUSPEND */
907 musb->is_active = 0;
908 devctl = musb_readb(regs, MUSB_DEVCTL);
909 devctl &= ~MUSB_DEVCTL_SESSION;
911 if (is_otg_enabled(musb)) {
912 /* session started after:
913 * (a) ID-grounded irq, host mode;
914 * (b) vbus present/connect IRQ, peripheral mode;
915 * (c) peripheral initiates, using SRP
917 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
918 musb->is_active = 1;
919 else
920 devctl |= MUSB_DEVCTL_SESSION;
922 } else if (is_host_enabled(musb)) {
923 /* assume ID pin is hard-wired to ground */
924 devctl |= MUSB_DEVCTL_SESSION;
926 } else /* peripheral is enabled */ {
927 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
928 musb->is_active = 1;
930 musb_platform_enable(musb);
931 musb_writeb(regs, MUSB_DEVCTL, devctl);
935 static void musb_generic_disable(struct musb *musb)
937 void __iomem *mbase = musb->mregs;
938 u16 temp;
940 /* disable interrupts */
941 musb_writeb(mbase, MUSB_INTRUSBE, 0);
942 musb_writew(mbase, MUSB_INTRTXE, 0);
943 musb_writew(mbase, MUSB_INTRRXE, 0);
945 /* off */
946 musb_writeb(mbase, MUSB_DEVCTL, 0);
948 /* flush pending interrupts */
949 temp = musb_readb(mbase, MUSB_INTRUSB);
950 temp = musb_readw(mbase, MUSB_INTRTX);
951 temp = musb_readw(mbase, MUSB_INTRRX);
956 * Make the HDRC stop (disable interrupts, etc.);
957 * reversible by musb_start
958 * called on gadget driver unregister
959 * with controller locked, irqs blocked
960 * acts as a NOP unless some role activated the hardware
962 void musb_stop(struct musb *musb)
964 /* stop IRQs, timers, ... */
965 musb_platform_disable(musb);
966 musb_generic_disable(musb);
967 dev_dbg(musb->controller, "HDRC disabled\n");
969 /* FIXME
970 * - mark host and/or peripheral drivers unusable/inactive
971 * - disable DMA (and enable it in HdrcStart)
972 * - make sure we can musb_start() after musb_stop(); with
973 * OTG mode, gadget driver module rmmod/modprobe cycles that
974 * - ...
976 musb_platform_try_idle(musb, 0);
979 static void musb_shutdown(struct platform_device *pdev)
981 struct musb *musb = dev_to_musb(&pdev->dev);
982 unsigned long flags;
984 pm_runtime_get_sync(musb->controller);
985 spin_lock_irqsave(&musb->lock, flags);
986 musb_platform_disable(musb);
987 musb_generic_disable(musb);
988 spin_unlock_irqrestore(&musb->lock, flags);
990 if (!is_otg_enabled(musb) && is_host_enabled(musb))
991 usb_remove_hcd(musb_to_hcd(musb));
992 musb_writeb(musb->mregs, MUSB_DEVCTL, 0);
993 musb_platform_exit(musb);
995 pm_runtime_put(musb->controller);
996 /* FIXME power down */
1000 /*-------------------------------------------------------------------------*/
1003 * The silicon either has hard-wired endpoint configurations, or else
1004 * "dynamic fifo" sizing. The driver has support for both, though at this
1005 * writing only the dynamic sizing is very well tested. Since we switched
1006 * away from compile-time hardware parameters, we can no longer rely on
1007 * dead code elimination to leave only the relevant one in the object file.
1009 * We don't currently use dynamic fifo setup capability to do anything
1010 * more than selecting one of a bunch of predefined configurations.
1012 #if defined(CONFIG_USB_MUSB_TUSB6010) \
1013 || defined(CONFIG_USB_MUSB_TUSB6010_MODULE) \
1014 || defined(CONFIG_USB_MUSB_OMAP2PLUS) \
1015 || defined(CONFIG_USB_MUSB_OMAP2PLUS_MODULE) \
1016 || defined(CONFIG_USB_MUSB_AM35X) \
1017 || defined(CONFIG_USB_MUSB_AM35X_MODULE)
1018 static ushort __initdata fifo_mode = 4;
1019 #elif defined(CONFIG_USB_MUSB_UX500) \
1020 || defined(CONFIG_USB_MUSB_UX500_MODULE)
1021 static ushort __initdata fifo_mode = 5;
1022 #else
1023 static ushort __initdata fifo_mode = 2;
1024 #endif
1026 /* "modprobe ... fifo_mode=1" etc */
1027 module_param(fifo_mode, ushort, 0);
1028 MODULE_PARM_DESC(fifo_mode, "initial endpoint configuration");
1031 * tables defining fifo_mode values. define more if you like.
1032 * for host side, make sure both halves of ep1 are set up.
1035 /* mode 0 - fits in 2KB */
1036 static struct musb_fifo_cfg __initdata mode_0_cfg[] = {
1037 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1038 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1039 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, },
1040 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1041 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1044 /* mode 1 - fits in 4KB */
1045 static struct musb_fifo_cfg __initdata mode_1_cfg[] = {
1046 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1047 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1048 { .hw_ep_num = 2, .style = FIFO_RXTX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1049 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1050 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1053 /* mode 2 - fits in 4KB */
1054 static struct musb_fifo_cfg __initdata mode_2_cfg[] = {
1055 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1056 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1057 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1058 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1059 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1060 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1063 /* mode 3 - fits in 4KB */
1064 static struct musb_fifo_cfg __initdata mode_3_cfg[] = {
1065 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1066 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, .mode = BUF_DOUBLE, },
1067 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1068 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1069 { .hw_ep_num = 3, .style = FIFO_RXTX, .maxpacket = 256, },
1070 { .hw_ep_num = 4, .style = FIFO_RXTX, .maxpacket = 256, },
1073 /* mode 4 - fits in 16KB */
1074 static struct musb_fifo_cfg __initdata mode_4_cfg[] = {
1075 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1076 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1077 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1078 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1079 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1080 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1081 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1082 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1083 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1084 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1085 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 512, },
1086 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 512, },
1087 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 512, },
1088 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 512, },
1089 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 512, },
1090 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 512, },
1091 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 512, },
1092 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 512, },
1093 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 256, },
1094 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 64, },
1095 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 256, },
1096 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 64, },
1097 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 256, },
1098 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 64, },
1099 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 4096, },
1100 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1101 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1104 /* mode 5 - fits in 8KB */
1105 static struct musb_fifo_cfg __initdata mode_5_cfg[] = {
1106 { .hw_ep_num = 1, .style = FIFO_TX, .maxpacket = 512, },
1107 { .hw_ep_num = 1, .style = FIFO_RX, .maxpacket = 512, },
1108 { .hw_ep_num = 2, .style = FIFO_TX, .maxpacket = 512, },
1109 { .hw_ep_num = 2, .style = FIFO_RX, .maxpacket = 512, },
1110 { .hw_ep_num = 3, .style = FIFO_TX, .maxpacket = 512, },
1111 { .hw_ep_num = 3, .style = FIFO_RX, .maxpacket = 512, },
1112 { .hw_ep_num = 4, .style = FIFO_TX, .maxpacket = 512, },
1113 { .hw_ep_num = 4, .style = FIFO_RX, .maxpacket = 512, },
1114 { .hw_ep_num = 5, .style = FIFO_TX, .maxpacket = 512, },
1115 { .hw_ep_num = 5, .style = FIFO_RX, .maxpacket = 512, },
1116 { .hw_ep_num = 6, .style = FIFO_TX, .maxpacket = 32, },
1117 { .hw_ep_num = 6, .style = FIFO_RX, .maxpacket = 32, },
1118 { .hw_ep_num = 7, .style = FIFO_TX, .maxpacket = 32, },
1119 { .hw_ep_num = 7, .style = FIFO_RX, .maxpacket = 32, },
1120 { .hw_ep_num = 8, .style = FIFO_TX, .maxpacket = 32, },
1121 { .hw_ep_num = 8, .style = FIFO_RX, .maxpacket = 32, },
1122 { .hw_ep_num = 9, .style = FIFO_TX, .maxpacket = 32, },
1123 { .hw_ep_num = 9, .style = FIFO_RX, .maxpacket = 32, },
1124 { .hw_ep_num = 10, .style = FIFO_TX, .maxpacket = 32, },
1125 { .hw_ep_num = 10, .style = FIFO_RX, .maxpacket = 32, },
1126 { .hw_ep_num = 11, .style = FIFO_TX, .maxpacket = 32, },
1127 { .hw_ep_num = 11, .style = FIFO_RX, .maxpacket = 32, },
1128 { .hw_ep_num = 12, .style = FIFO_TX, .maxpacket = 32, },
1129 { .hw_ep_num = 12, .style = FIFO_RX, .maxpacket = 32, },
1130 { .hw_ep_num = 13, .style = FIFO_RXTX, .maxpacket = 512, },
1131 { .hw_ep_num = 14, .style = FIFO_RXTX, .maxpacket = 1024, },
1132 { .hw_ep_num = 15, .style = FIFO_RXTX, .maxpacket = 1024, },
1136 * configure a fifo; for non-shared endpoints, this may be called
1137 * once for a tx fifo and once for an rx fifo.
1139 * returns negative errno or offset for next fifo.
1141 static int __init
1142 fifo_setup(struct musb *musb, struct musb_hw_ep *hw_ep,
1143 const struct musb_fifo_cfg *cfg, u16 offset)
1145 void __iomem *mbase = musb->mregs;
1146 int size = 0;
1147 u16 maxpacket = cfg->maxpacket;
1148 u16 c_off = offset >> 3;
1149 u8 c_size;
1151 /* expect hw_ep has already been zero-initialized */
1153 size = ffs(max(maxpacket, (u16) 8)) - 1;
1154 maxpacket = 1 << size;
1156 c_size = size - 3;
1157 if (cfg->mode == BUF_DOUBLE) {
1158 if ((offset + (maxpacket << 1)) >
1159 (1 << (musb->config->ram_bits + 2)))
1160 return -EMSGSIZE;
1161 c_size |= MUSB_FIFOSZ_DPB;
1162 } else {
1163 if ((offset + maxpacket) > (1 << (musb->config->ram_bits + 2)))
1164 return -EMSGSIZE;
1167 /* configure the FIFO */
1168 musb_writeb(mbase, MUSB_INDEX, hw_ep->epnum);
1170 /* EP0 reserved endpoint for control, bidirectional;
1171 * EP1 reserved for bulk, two unidirection halves.
1173 if (hw_ep->epnum == 1)
1174 musb->bulk_ep = hw_ep;
1175 /* REVISIT error check: be sure ep0 can both rx and tx ... */
1176 switch (cfg->style) {
1177 case FIFO_TX:
1178 musb_write_txfifosz(mbase, c_size);
1179 musb_write_txfifoadd(mbase, c_off);
1180 hw_ep->tx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1181 hw_ep->max_packet_sz_tx = maxpacket;
1182 break;
1183 case FIFO_RX:
1184 musb_write_rxfifosz(mbase, c_size);
1185 musb_write_rxfifoadd(mbase, c_off);
1186 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1187 hw_ep->max_packet_sz_rx = maxpacket;
1188 break;
1189 case FIFO_RXTX:
1190 musb_write_txfifosz(mbase, c_size);
1191 musb_write_txfifoadd(mbase, c_off);
1192 hw_ep->rx_double_buffered = !!(c_size & MUSB_FIFOSZ_DPB);
1193 hw_ep->max_packet_sz_rx = maxpacket;
1195 musb_write_rxfifosz(mbase, c_size);
1196 musb_write_rxfifoadd(mbase, c_off);
1197 hw_ep->tx_double_buffered = hw_ep->rx_double_buffered;
1198 hw_ep->max_packet_sz_tx = maxpacket;
1200 hw_ep->is_shared_fifo = true;
1201 break;
1204 /* NOTE rx and tx endpoint irqs aren't managed separately,
1205 * which happens to be ok
1207 musb->epmask |= (1 << hw_ep->epnum);
1209 return offset + (maxpacket << ((c_size & MUSB_FIFOSZ_DPB) ? 1 : 0));
1212 static struct musb_fifo_cfg __initdata ep0_cfg = {
1213 .style = FIFO_RXTX, .maxpacket = 64,
1216 static int __init ep_config_from_table(struct musb *musb)
1218 const struct musb_fifo_cfg *cfg;
1219 unsigned i, n;
1220 int offset;
1221 struct musb_hw_ep *hw_ep = musb->endpoints;
1223 if (musb->config->fifo_cfg) {
1224 cfg = musb->config->fifo_cfg;
1225 n = musb->config->fifo_cfg_size;
1226 goto done;
1229 switch (fifo_mode) {
1230 default:
1231 fifo_mode = 0;
1232 /* FALLTHROUGH */
1233 case 0:
1234 cfg = mode_0_cfg;
1235 n = ARRAY_SIZE(mode_0_cfg);
1236 break;
1237 case 1:
1238 cfg = mode_1_cfg;
1239 n = ARRAY_SIZE(mode_1_cfg);
1240 break;
1241 case 2:
1242 cfg = mode_2_cfg;
1243 n = ARRAY_SIZE(mode_2_cfg);
1244 break;
1245 case 3:
1246 cfg = mode_3_cfg;
1247 n = ARRAY_SIZE(mode_3_cfg);
1248 break;
1249 case 4:
1250 cfg = mode_4_cfg;
1251 n = ARRAY_SIZE(mode_4_cfg);
1252 break;
1253 case 5:
1254 cfg = mode_5_cfg;
1255 n = ARRAY_SIZE(mode_5_cfg);
1256 break;
1259 printk(KERN_DEBUG "%s: setup fifo_mode %d\n",
1260 musb_driver_name, fifo_mode);
1263 done:
1264 offset = fifo_setup(musb, hw_ep, &ep0_cfg, 0);
1265 /* assert(offset > 0) */
1267 /* NOTE: for RTL versions >= 1.400 EPINFO and RAMINFO would
1268 * be better than static musb->config->num_eps and DYN_FIFO_SIZE...
1271 for (i = 0; i < n; i++) {
1272 u8 epn = cfg->hw_ep_num;
1274 if (epn >= musb->config->num_eps) {
1275 pr_debug("%s: invalid ep %d\n",
1276 musb_driver_name, epn);
1277 return -EINVAL;
1279 offset = fifo_setup(musb, hw_ep + epn, cfg++, offset);
1280 if (offset < 0) {
1281 pr_debug("%s: mem overrun, ep %d\n",
1282 musb_driver_name, epn);
1283 return -EINVAL;
1285 epn++;
1286 musb->nr_endpoints = max(epn, musb->nr_endpoints);
1289 printk(KERN_DEBUG "%s: %d/%d max ep, %d/%d memory\n",
1290 musb_driver_name,
1291 n + 1, musb->config->num_eps * 2 - 1,
1292 offset, (1 << (musb->config->ram_bits + 2)));
1294 if (!musb->bulk_ep) {
1295 pr_debug("%s: missing bulk\n", musb_driver_name);
1296 return -EINVAL;
1299 return 0;
1304 * ep_config_from_hw - when MUSB_C_DYNFIFO_DEF is false
1305 * @param musb the controller
1307 static int __init ep_config_from_hw(struct musb *musb)
1309 u8 epnum = 0;
1310 struct musb_hw_ep *hw_ep;
1311 void *mbase = musb->mregs;
1312 int ret = 0;
1314 dev_dbg(musb->controller, "<== static silicon ep config\n");
1316 /* FIXME pick up ep0 maxpacket size */
1318 for (epnum = 1; epnum < musb->config->num_eps; epnum++) {
1319 musb_ep_select(mbase, epnum);
1320 hw_ep = musb->endpoints + epnum;
1322 ret = musb_read_fifosize(musb, hw_ep, epnum);
1323 if (ret < 0)
1324 break;
1326 /* FIXME set up hw_ep->{rx,tx}_double_buffered */
1328 /* pick an RX/TX endpoint for bulk */
1329 if (hw_ep->max_packet_sz_tx < 512
1330 || hw_ep->max_packet_sz_rx < 512)
1331 continue;
1333 /* REVISIT: this algorithm is lazy, we should at least
1334 * try to pick a double buffered endpoint.
1336 if (musb->bulk_ep)
1337 continue;
1338 musb->bulk_ep = hw_ep;
1341 if (!musb->bulk_ep) {
1342 pr_debug("%s: missing bulk\n", musb_driver_name);
1343 return -EINVAL;
1346 return 0;
1349 enum { MUSB_CONTROLLER_MHDRC, MUSB_CONTROLLER_HDRC, };
1351 /* Initialize MUSB (M)HDRC part of the USB hardware subsystem;
1352 * configure endpoints, or take their config from silicon
1354 static int __init musb_core_init(u16 musb_type, struct musb *musb)
1356 u8 reg;
1357 char *type;
1358 char aInfo[90], aRevision[32], aDate[12];
1359 void __iomem *mbase = musb->mregs;
1360 int status = 0;
1361 int i;
1363 /* log core options (read using indexed model) */
1364 reg = musb_read_configdata(mbase);
1366 strcpy(aInfo, (reg & MUSB_CONFIGDATA_UTMIDW) ? "UTMI-16" : "UTMI-8");
1367 if (reg & MUSB_CONFIGDATA_DYNFIFO) {
1368 strcat(aInfo, ", dyn FIFOs");
1369 musb->dyn_fifo = true;
1371 if (reg & MUSB_CONFIGDATA_MPRXE) {
1372 strcat(aInfo, ", bulk combine");
1373 musb->bulk_combine = true;
1375 if (reg & MUSB_CONFIGDATA_MPTXE) {
1376 strcat(aInfo, ", bulk split");
1377 musb->bulk_split = true;
1379 if (reg & MUSB_CONFIGDATA_HBRXE) {
1380 strcat(aInfo, ", HB-ISO Rx");
1381 musb->hb_iso_rx = true;
1383 if (reg & MUSB_CONFIGDATA_HBTXE) {
1384 strcat(aInfo, ", HB-ISO Tx");
1385 musb->hb_iso_tx = true;
1387 if (reg & MUSB_CONFIGDATA_SOFTCONE)
1388 strcat(aInfo, ", SoftConn");
1390 printk(KERN_DEBUG "%s: ConfigData=0x%02x (%s)\n",
1391 musb_driver_name, reg, aInfo);
1393 aDate[0] = 0;
1394 if (MUSB_CONTROLLER_MHDRC == musb_type) {
1395 musb->is_multipoint = 1;
1396 type = "M";
1397 } else {
1398 musb->is_multipoint = 0;
1399 type = "";
1400 #ifndef CONFIG_USB_OTG_BLACKLIST_HUB
1401 printk(KERN_ERR
1402 "%s: kernel must blacklist external hubs\n",
1403 musb_driver_name);
1404 #endif
1407 /* log release info */
1408 musb->hwvers = musb_read_hwvers(mbase);
1409 snprintf(aRevision, 32, "%d.%d%s", MUSB_HWVERS_MAJOR(musb->hwvers),
1410 MUSB_HWVERS_MINOR(musb->hwvers),
1411 (musb->hwvers & MUSB_HWVERS_RC) ? "RC" : "");
1412 printk(KERN_DEBUG "%s: %sHDRC RTL version %s %s\n",
1413 musb_driver_name, type, aRevision, aDate);
1415 /* configure ep0 */
1416 musb_configure_ep0(musb);
1418 /* discover endpoint configuration */
1419 musb->nr_endpoints = 1;
1420 musb->epmask = 1;
1422 if (musb->dyn_fifo)
1423 status = ep_config_from_table(musb);
1424 else
1425 status = ep_config_from_hw(musb);
1427 if (status < 0)
1428 return status;
1430 /* finish init, and print endpoint config */
1431 for (i = 0; i < musb->nr_endpoints; i++) {
1432 struct musb_hw_ep *hw_ep = musb->endpoints + i;
1434 hw_ep->fifo = MUSB_FIFO_OFFSET(i) + mbase;
1435 #ifdef CONFIG_USB_MUSB_TUSB6010
1436 hw_ep->fifo_async = musb->async + 0x400 + MUSB_FIFO_OFFSET(i);
1437 hw_ep->fifo_sync = musb->sync + 0x400 + MUSB_FIFO_OFFSET(i);
1438 hw_ep->fifo_sync_va =
1439 musb->sync_va + 0x400 + MUSB_FIFO_OFFSET(i);
1441 if (i == 0)
1442 hw_ep->conf = mbase - 0x400 + TUSB_EP0_CONF;
1443 else
1444 hw_ep->conf = mbase + 0x400 + (((i - 1) & 0xf) << 2);
1445 #endif
1447 hw_ep->regs = MUSB_EP_OFFSET(i, 0) + mbase;
1448 hw_ep->target_regs = musb_read_target_reg_base(i, mbase);
1449 hw_ep->rx_reinit = 1;
1450 hw_ep->tx_reinit = 1;
1452 if (hw_ep->max_packet_sz_tx) {
1453 dev_dbg(musb->controller,
1454 "%s: hw_ep %d%s, %smax %d\n",
1455 musb_driver_name, i,
1456 hw_ep->is_shared_fifo ? "shared" : "tx",
1457 hw_ep->tx_double_buffered
1458 ? "doublebuffer, " : "",
1459 hw_ep->max_packet_sz_tx);
1461 if (hw_ep->max_packet_sz_rx && !hw_ep->is_shared_fifo) {
1462 dev_dbg(musb->controller,
1463 "%s: hw_ep %d%s, %smax %d\n",
1464 musb_driver_name, i,
1465 "rx",
1466 hw_ep->rx_double_buffered
1467 ? "doublebuffer, " : "",
1468 hw_ep->max_packet_sz_rx);
1470 if (!(hw_ep->max_packet_sz_tx || hw_ep->max_packet_sz_rx))
1471 dev_dbg(musb->controller, "hw_ep %d not configured\n", i);
1474 return 0;
1477 /*-------------------------------------------------------------------------*/
1479 #if defined(CONFIG_SOC_OMAP2430) || defined(CONFIG_SOC_OMAP3430) || \
1480 defined(CONFIG_ARCH_OMAP4) || defined(CONFIG_ARCH_U8500) || \
1481 defined(CONFIG_ARCH_U5500)
1483 static irqreturn_t generic_interrupt(int irq, void *__hci)
1485 unsigned long flags;
1486 irqreturn_t retval = IRQ_NONE;
1487 struct musb *musb = __hci;
1489 spin_lock_irqsave(&musb->lock, flags);
1491 musb->int_usb = musb_readb(musb->mregs, MUSB_INTRUSB);
1492 musb->int_tx = musb_readw(musb->mregs, MUSB_INTRTX);
1493 musb->int_rx = musb_readw(musb->mregs, MUSB_INTRRX);
1495 if (musb->int_usb || musb->int_tx || musb->int_rx)
1496 retval = musb_interrupt(musb);
1498 spin_unlock_irqrestore(&musb->lock, flags);
1500 return retval;
1503 #else
1504 #define generic_interrupt NULL
1505 #endif
1508 * handle all the irqs defined by the HDRC core. for now we expect: other
1509 * irq sources (phy, dma, etc) will be handled first, musb->int_* values
1510 * will be assigned, and the irq will already have been acked.
1512 * called in irq context with spinlock held, irqs blocked
1514 irqreturn_t musb_interrupt(struct musb *musb)
1516 irqreturn_t retval = IRQ_NONE;
1517 u8 devctl, power;
1518 int ep_num;
1519 u32 reg;
1521 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1522 power = musb_readb(musb->mregs, MUSB_POWER);
1524 dev_dbg(musb->controller, "** IRQ %s usb%04x tx%04x rx%04x\n",
1525 (devctl & MUSB_DEVCTL_HM) ? "host" : "peripheral",
1526 musb->int_usb, musb->int_tx, musb->int_rx);
1528 /* the core can interrupt us for multiple reasons; docs have
1529 * a generic interrupt flowchart to follow
1531 if (musb->int_usb)
1532 retval |= musb_stage0_irq(musb, musb->int_usb,
1533 devctl, power);
1535 /* "stage 1" is handling endpoint irqs */
1537 /* handle endpoint 0 first */
1538 if (musb->int_tx & 1) {
1539 if (devctl & MUSB_DEVCTL_HM)
1540 retval |= musb_h_ep0_irq(musb);
1541 else
1542 retval |= musb_g_ep0_irq(musb);
1545 /* RX on endpoints 1-15 */
1546 reg = musb->int_rx >> 1;
1547 ep_num = 1;
1548 while (reg) {
1549 if (reg & 1) {
1550 /* musb_ep_select(musb->mregs, ep_num); */
1551 /* REVISIT just retval = ep->rx_irq(...) */
1552 retval = IRQ_HANDLED;
1553 if (devctl & MUSB_DEVCTL_HM) {
1554 if (is_host_capable())
1555 musb_host_rx(musb, ep_num);
1556 } else {
1557 if (is_peripheral_capable())
1558 musb_g_rx(musb, ep_num);
1562 reg >>= 1;
1563 ep_num++;
1566 /* TX on endpoints 1-15 */
1567 reg = musb->int_tx >> 1;
1568 ep_num = 1;
1569 while (reg) {
1570 if (reg & 1) {
1571 /* musb_ep_select(musb->mregs, ep_num); */
1572 /* REVISIT just retval |= ep->tx_irq(...) */
1573 retval = IRQ_HANDLED;
1574 if (devctl & MUSB_DEVCTL_HM) {
1575 if (is_host_capable())
1576 musb_host_tx(musb, ep_num);
1577 } else {
1578 if (is_peripheral_capable())
1579 musb_g_tx(musb, ep_num);
1582 reg >>= 1;
1583 ep_num++;
1586 return retval;
1588 EXPORT_SYMBOL_GPL(musb_interrupt);
1590 #ifndef CONFIG_MUSB_PIO_ONLY
1591 static int __initdata use_dma = 1;
1593 /* "modprobe ... use_dma=0" etc */
1594 module_param(use_dma, bool, 0);
1595 MODULE_PARM_DESC(use_dma, "enable/disable use of DMA");
1597 void musb_dma_completion(struct musb *musb, u8 epnum, u8 transmit)
1599 u8 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
1601 /* called with controller lock already held */
1603 if (!epnum) {
1604 #ifndef CONFIG_USB_TUSB_OMAP_DMA
1605 if (!is_cppi_enabled()) {
1606 /* endpoint 0 */
1607 if (devctl & MUSB_DEVCTL_HM)
1608 musb_h_ep0_irq(musb);
1609 else
1610 musb_g_ep0_irq(musb);
1612 #endif
1613 } else {
1614 /* endpoints 1..15 */
1615 if (transmit) {
1616 if (devctl & MUSB_DEVCTL_HM) {
1617 if (is_host_capable())
1618 musb_host_tx(musb, epnum);
1619 } else {
1620 if (is_peripheral_capable())
1621 musb_g_tx(musb, epnum);
1623 } else {
1624 /* receive */
1625 if (devctl & MUSB_DEVCTL_HM) {
1626 if (is_host_capable())
1627 musb_host_rx(musb, epnum);
1628 } else {
1629 if (is_peripheral_capable())
1630 musb_g_rx(musb, epnum);
1636 #else
1637 #define use_dma 0
1638 #endif
1640 /*-------------------------------------------------------------------------*/
1642 #ifdef CONFIG_SYSFS
1644 static ssize_t
1645 musb_mode_show(struct device *dev, struct device_attribute *attr, char *buf)
1647 struct musb *musb = dev_to_musb(dev);
1648 unsigned long flags;
1649 int ret = -EINVAL;
1651 spin_lock_irqsave(&musb->lock, flags);
1652 ret = sprintf(buf, "%s\n", otg_state_string(musb->xceiv->state));
1653 spin_unlock_irqrestore(&musb->lock, flags);
1655 return ret;
1658 static ssize_t
1659 musb_mode_store(struct device *dev, struct device_attribute *attr,
1660 const char *buf, size_t n)
1662 struct musb *musb = dev_to_musb(dev);
1663 unsigned long flags;
1664 int status;
1666 spin_lock_irqsave(&musb->lock, flags);
1667 if (sysfs_streq(buf, "host"))
1668 status = musb_platform_set_mode(musb, MUSB_HOST);
1669 else if (sysfs_streq(buf, "peripheral"))
1670 status = musb_platform_set_mode(musb, MUSB_PERIPHERAL);
1671 else if (sysfs_streq(buf, "otg"))
1672 status = musb_platform_set_mode(musb, MUSB_OTG);
1673 else
1674 status = -EINVAL;
1675 spin_unlock_irqrestore(&musb->lock, flags);
1677 return (status == 0) ? n : status;
1679 static DEVICE_ATTR(mode, 0644, musb_mode_show, musb_mode_store);
1681 static ssize_t
1682 musb_vbus_store(struct device *dev, struct device_attribute *attr,
1683 const char *buf, size_t n)
1685 struct musb *musb = dev_to_musb(dev);
1686 unsigned long flags;
1687 unsigned long val;
1689 if (sscanf(buf, "%lu", &val) < 1) {
1690 dev_err(dev, "Invalid VBUS timeout ms value\n");
1691 return -EINVAL;
1694 spin_lock_irqsave(&musb->lock, flags);
1695 /* force T(a_wait_bcon) to be zero/unlimited *OR* valid */
1696 musb->a_wait_bcon = val ? max_t(int, val, OTG_TIME_A_WAIT_BCON) : 0 ;
1697 if (musb->xceiv->state == OTG_STATE_A_WAIT_BCON)
1698 musb->is_active = 0;
1699 musb_platform_try_idle(musb, jiffies + msecs_to_jiffies(val));
1700 spin_unlock_irqrestore(&musb->lock, flags);
1702 return n;
1705 static ssize_t
1706 musb_vbus_show(struct device *dev, struct device_attribute *attr, char *buf)
1708 struct musb *musb = dev_to_musb(dev);
1709 unsigned long flags;
1710 unsigned long val;
1711 int vbus;
1713 spin_lock_irqsave(&musb->lock, flags);
1714 val = musb->a_wait_bcon;
1715 /* FIXME get_vbus_status() is normally #defined as false...
1716 * and is effectively TUSB-specific.
1718 vbus = musb_platform_get_vbus_status(musb);
1719 spin_unlock_irqrestore(&musb->lock, flags);
1721 return sprintf(buf, "Vbus %s, timeout %lu msec\n",
1722 vbus ? "on" : "off", val);
1724 static DEVICE_ATTR(vbus, 0644, musb_vbus_show, musb_vbus_store);
1726 /* Gadget drivers can't know that a host is connected so they might want
1727 * to start SRP, but users can. This allows userspace to trigger SRP.
1729 static ssize_t
1730 musb_srp_store(struct device *dev, struct device_attribute *attr,
1731 const char *buf, size_t n)
1733 struct musb *musb = dev_to_musb(dev);
1734 unsigned short srp;
1736 if (sscanf(buf, "%hu", &srp) != 1
1737 || (srp != 1)) {
1738 dev_err(dev, "SRP: Value must be 1\n");
1739 return -EINVAL;
1742 if (srp == 1)
1743 musb_g_wakeup(musb);
1745 return n;
1747 static DEVICE_ATTR(srp, 0644, NULL, musb_srp_store);
1749 static struct attribute *musb_attributes[] = {
1750 &dev_attr_mode.attr,
1751 &dev_attr_vbus.attr,
1752 &dev_attr_srp.attr,
1753 NULL
1756 static const struct attribute_group musb_attr_group = {
1757 .attrs = musb_attributes,
1760 #endif /* sysfs */
1762 /* Only used to provide driver mode change events */
1763 static void musb_irq_work(struct work_struct *data)
1765 struct musb *musb = container_of(data, struct musb, irq_work);
1766 static int old_state;
1768 if (musb->xceiv->state != old_state) {
1769 old_state = musb->xceiv->state;
1770 sysfs_notify(&musb->controller->kobj, NULL, "mode");
1774 /* --------------------------------------------------------------------------
1775 * Init support
1778 static struct musb *__init
1779 allocate_instance(struct device *dev,
1780 struct musb_hdrc_config *config, void __iomem *mbase)
1782 struct musb *musb;
1783 struct musb_hw_ep *ep;
1784 int epnum;
1785 struct usb_hcd *hcd;
1787 hcd = usb_create_hcd(&musb_hc_driver, dev, dev_name(dev));
1788 if (!hcd)
1789 return NULL;
1790 /* usbcore sets dev->driver_data to hcd, and sometimes uses that... */
1792 musb = hcd_to_musb(hcd);
1793 INIT_LIST_HEAD(&musb->control);
1794 INIT_LIST_HEAD(&musb->in_bulk);
1795 INIT_LIST_HEAD(&musb->out_bulk);
1797 hcd->uses_new_polling = 1;
1798 hcd->has_tt = 1;
1800 musb->vbuserr_retry = VBUSERR_RETRY_COUNT;
1801 musb->a_wait_bcon = OTG_TIME_A_WAIT_BCON;
1802 dev_set_drvdata(dev, musb);
1803 musb->mregs = mbase;
1804 musb->ctrl_base = mbase;
1805 musb->nIrq = -ENODEV;
1806 musb->config = config;
1807 BUG_ON(musb->config->num_eps > MUSB_C_NUM_EPS);
1808 for (epnum = 0, ep = musb->endpoints;
1809 epnum < musb->config->num_eps;
1810 epnum++, ep++) {
1811 ep->musb = musb;
1812 ep->epnum = epnum;
1815 musb->controller = dev;
1817 return musb;
1820 static void musb_free(struct musb *musb)
1822 /* this has multiple entry modes. it handles fault cleanup after
1823 * probe(), where things may be partially set up, as well as rmmod
1824 * cleanup after everything's been de-activated.
1827 #ifdef CONFIG_SYSFS
1828 sysfs_remove_group(&musb->controller->kobj, &musb_attr_group);
1829 #endif
1831 musb_gadget_cleanup(musb);
1833 if (musb->nIrq >= 0) {
1834 if (musb->irq_wake)
1835 disable_irq_wake(musb->nIrq);
1836 free_irq(musb->nIrq, musb);
1838 if (is_dma_capable() && musb->dma_controller) {
1839 struct dma_controller *c = musb->dma_controller;
1841 (void) c->stop(c);
1842 dma_controller_destroy(c);
1845 kfree(musb);
1849 * Perform generic per-controller initialization.
1851 * @pDevice: the controller (already clocked, etc)
1852 * @nIrq: irq
1853 * @mregs: virtual address of controller registers,
1854 * not yet corrected for platform-specific offsets
1856 static int __init
1857 musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl)
1859 int status;
1860 struct musb *musb;
1861 struct musb_hdrc_platform_data *plat = dev->platform_data;
1863 /* The driver might handle more features than the board; OK.
1864 * Fail when the board needs a feature that's not enabled.
1866 if (!plat) {
1867 dev_dbg(dev, "no platform_data?\n");
1868 status = -ENODEV;
1869 goto fail0;
1872 /* allocate */
1873 musb = allocate_instance(dev, plat->config, ctrl);
1874 if (!musb) {
1875 status = -ENOMEM;
1876 goto fail0;
1879 pm_runtime_use_autosuspend(musb->controller);
1880 pm_runtime_set_autosuspend_delay(musb->controller, 200);
1881 pm_runtime_enable(musb->controller);
1883 spin_lock_init(&musb->lock);
1884 musb->board_mode = plat->mode;
1885 musb->board_set_power = plat->set_power;
1886 musb->min_power = plat->min_power;
1887 musb->ops = plat->platform_ops;
1889 /* The musb_platform_init() call:
1890 * - adjusts musb->mregs and musb->isr if needed,
1891 * - may initialize an integrated tranceiver
1892 * - initializes musb->xceiv, usually by otg_get_transceiver()
1893 * - stops powering VBUS
1895 * There are various transceiver configurations. Blackfin,
1896 * DaVinci, TUSB60x0, and others integrate them. OMAP3 uses
1897 * external/discrete ones in various flavors (twl4030 family,
1898 * isp1504, non-OTG, etc) mostly hooking up through ULPI.
1900 musb->isr = generic_interrupt;
1901 status = musb_platform_init(musb);
1902 if (status < 0)
1903 goto fail1;
1905 if (!musb->isr) {
1906 status = -ENODEV;
1907 goto fail3;
1910 if (!musb->xceiv->io_ops) {
1911 musb->xceiv->io_priv = musb->mregs;
1912 musb->xceiv->io_ops = &musb_ulpi_access;
1915 #ifndef CONFIG_MUSB_PIO_ONLY
1916 if (use_dma && dev->dma_mask) {
1917 struct dma_controller *c;
1919 c = dma_controller_create(musb, musb->mregs);
1920 musb->dma_controller = c;
1921 if (c)
1922 (void) c->start(c);
1924 #endif
1925 /* ideally this would be abstracted in platform setup */
1926 if (!is_dma_capable() || !musb->dma_controller)
1927 dev->dma_mask = NULL;
1929 /* be sure interrupts are disabled before connecting ISR */
1930 musb_platform_disable(musb);
1931 musb_generic_disable(musb);
1933 /* setup musb parts of the core (especially endpoints) */
1934 status = musb_core_init(plat->config->multipoint
1935 ? MUSB_CONTROLLER_MHDRC
1936 : MUSB_CONTROLLER_HDRC, musb);
1937 if (status < 0)
1938 goto fail3;
1940 setup_timer(&musb->otg_timer, musb_otg_timer_func, (unsigned long) musb);
1942 /* Init IRQ workqueue before request_irq */
1943 INIT_WORK(&musb->irq_work, musb_irq_work);
1945 /* attach to the IRQ */
1946 if (request_irq(nIrq, musb->isr, 0, dev_name(dev), musb)) {
1947 dev_err(dev, "request_irq %d failed!\n", nIrq);
1948 status = -ENODEV;
1949 goto fail3;
1951 musb->nIrq = nIrq;
1952 /* FIXME this handles wakeup irqs wrong */
1953 if (enable_irq_wake(nIrq) == 0) {
1954 musb->irq_wake = 1;
1955 device_init_wakeup(dev, 1);
1956 } else {
1957 musb->irq_wake = 0;
1960 /* host side needs more setup */
1961 if (is_host_enabled(musb)) {
1962 struct usb_hcd *hcd = musb_to_hcd(musb);
1964 otg_set_host(musb->xceiv, &hcd->self);
1966 if (is_otg_enabled(musb))
1967 hcd->self.otg_port = 1;
1968 musb->xceiv->host = &hcd->self;
1969 hcd->power_budget = 2 * (plat->power ? : 250);
1971 /* program PHY to use external vBus if required */
1972 if (plat->extvbus) {
1973 u8 busctl = musb_read_ulpi_buscontrol(musb->mregs);
1974 busctl |= MUSB_ULPI_USE_EXTVBUS;
1975 musb_write_ulpi_buscontrol(musb->mregs, busctl);
1979 /* For the host-only role, we can activate right away.
1980 * (We expect the ID pin to be forcibly grounded!!)
1981 * Otherwise, wait till the gadget driver hooks up.
1983 if (!is_otg_enabled(musb) && is_host_enabled(musb)) {
1984 struct usb_hcd *hcd = musb_to_hcd(musb);
1986 MUSB_HST_MODE(musb);
1987 musb->xceiv->default_a = 1;
1988 musb->xceiv->state = OTG_STATE_A_IDLE;
1990 status = usb_add_hcd(musb_to_hcd(musb), -1, 0);
1992 hcd->self.uses_pio_for_control = 1;
1993 dev_dbg(musb->controller, "%s mode, status %d, devctl %02x %c\n",
1994 "HOST", status,
1995 musb_readb(musb->mregs, MUSB_DEVCTL),
1996 (musb_readb(musb->mregs, MUSB_DEVCTL)
1997 & MUSB_DEVCTL_BDEVICE
1998 ? 'B' : 'A'));
2000 } else /* peripheral is enabled */ {
2001 MUSB_DEV_MODE(musb);
2002 musb->xceiv->default_a = 0;
2003 musb->xceiv->state = OTG_STATE_B_IDLE;
2005 status = musb_gadget_setup(musb);
2007 dev_dbg(musb->controller, "%s mode, status %d, dev%02x\n",
2008 is_otg_enabled(musb) ? "OTG" : "PERIPHERAL",
2009 status,
2010 musb_readb(musb->mregs, MUSB_DEVCTL));
2013 if (status < 0)
2014 goto fail3;
2016 pm_runtime_put(musb->controller);
2018 status = musb_init_debugfs(musb);
2019 if (status < 0)
2020 goto fail4;
2022 #ifdef CONFIG_SYSFS
2023 status = sysfs_create_group(&musb->controller->kobj, &musb_attr_group);
2024 if (status)
2025 goto fail5;
2026 #endif
2028 dev_info(dev, "USB %s mode controller at %p using %s, IRQ %d\n",
2029 ({char *s;
2030 switch (musb->board_mode) {
2031 case MUSB_HOST: s = "Host"; break;
2032 case MUSB_PERIPHERAL: s = "Peripheral"; break;
2033 default: s = "OTG"; break;
2034 }; s; }),
2035 ctrl,
2036 (is_dma_capable() && musb->dma_controller)
2037 ? "DMA" : "PIO",
2038 musb->nIrq);
2040 return 0;
2042 fail5:
2043 musb_exit_debugfs(musb);
2045 fail4:
2046 if (!is_otg_enabled(musb) && is_host_enabled(musb))
2047 usb_remove_hcd(musb_to_hcd(musb));
2048 else
2049 musb_gadget_cleanup(musb);
2051 fail3:
2052 if (musb->irq_wake)
2053 device_init_wakeup(dev, 0);
2054 musb_platform_exit(musb);
2056 fail1:
2057 dev_err(musb->controller,
2058 "musb_init_controller failed with status %d\n", status);
2060 musb_free(musb);
2062 fail0:
2064 return status;
2068 /*-------------------------------------------------------------------------*/
2070 /* all implementations (PCI bridge to FPGA, VLYNQ, etc) should just
2071 * bridge to a platform device; this driver then suffices.
2074 #ifndef CONFIG_MUSB_PIO_ONLY
2075 static u64 *orig_dma_mask;
2076 #endif
2078 static int __init musb_probe(struct platform_device *pdev)
2080 struct device *dev = &pdev->dev;
2081 int irq = platform_get_irq_byname(pdev, "mc");
2082 int status;
2083 struct resource *iomem;
2084 void __iomem *base;
2086 iomem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2087 if (!iomem || irq <= 0)
2088 return -ENODEV;
2090 base = ioremap(iomem->start, resource_size(iomem));
2091 if (!base) {
2092 dev_err(dev, "ioremap failed\n");
2093 return -ENOMEM;
2096 #ifndef CONFIG_MUSB_PIO_ONLY
2097 /* clobbered by use_dma=n */
2098 orig_dma_mask = dev->dma_mask;
2099 #endif
2100 status = musb_init_controller(dev, irq, base);
2101 if (status < 0)
2102 iounmap(base);
2104 return status;
2107 static int __exit musb_remove(struct platform_device *pdev)
2109 struct musb *musb = dev_to_musb(&pdev->dev);
2110 void __iomem *ctrl_base = musb->ctrl_base;
2112 /* this gets called on rmmod.
2113 * - Host mode: host may still be active
2114 * - Peripheral mode: peripheral is deactivated (or never-activated)
2115 * - OTG mode: both roles are deactivated (or never-activated)
2117 pm_runtime_get_sync(musb->controller);
2118 musb_exit_debugfs(musb);
2119 musb_shutdown(pdev);
2121 pm_runtime_put(musb->controller);
2122 musb_free(musb);
2123 iounmap(ctrl_base);
2124 device_init_wakeup(&pdev->dev, 0);
2125 #ifndef CONFIG_MUSB_PIO_ONLY
2126 pdev->dev.dma_mask = orig_dma_mask;
2127 #endif
2128 return 0;
2131 #ifdef CONFIG_PM
2133 static void musb_save_context(struct musb *musb)
2135 int i;
2136 void __iomem *musb_base = musb->mregs;
2137 void __iomem *epio;
2139 if (is_host_enabled(musb)) {
2140 musb->context.frame = musb_readw(musb_base, MUSB_FRAME);
2141 musb->context.testmode = musb_readb(musb_base, MUSB_TESTMODE);
2142 musb->context.busctl = musb_read_ulpi_buscontrol(musb->mregs);
2144 musb->context.power = musb_readb(musb_base, MUSB_POWER);
2145 musb->context.intrtxe = musb_readw(musb_base, MUSB_INTRTXE);
2146 musb->context.intrrxe = musb_readw(musb_base, MUSB_INTRRXE);
2147 musb->context.intrusbe = musb_readb(musb_base, MUSB_INTRUSBE);
2148 musb->context.index = musb_readb(musb_base, MUSB_INDEX);
2149 musb->context.devctl = musb_readb(musb_base, MUSB_DEVCTL);
2151 for (i = 0; i < musb->config->num_eps; ++i) {
2152 struct musb_hw_ep *hw_ep;
2154 hw_ep = &musb->endpoints[i];
2155 if (!hw_ep)
2156 continue;
2158 epio = hw_ep->regs;
2159 if (!epio)
2160 continue;
2162 musb->context.index_regs[i].txmaxp =
2163 musb_readw(epio, MUSB_TXMAXP);
2164 musb->context.index_regs[i].txcsr =
2165 musb_readw(epio, MUSB_TXCSR);
2166 musb->context.index_regs[i].rxmaxp =
2167 musb_readw(epio, MUSB_RXMAXP);
2168 musb->context.index_regs[i].rxcsr =
2169 musb_readw(epio, MUSB_RXCSR);
2171 if (musb->dyn_fifo) {
2172 musb->context.index_regs[i].txfifoadd =
2173 musb_read_txfifoadd(musb_base);
2174 musb->context.index_regs[i].rxfifoadd =
2175 musb_read_rxfifoadd(musb_base);
2176 musb->context.index_regs[i].txfifosz =
2177 musb_read_txfifosz(musb_base);
2178 musb->context.index_regs[i].rxfifosz =
2179 musb_read_rxfifosz(musb_base);
2181 if (is_host_enabled(musb)) {
2182 musb->context.index_regs[i].txtype =
2183 musb_readb(epio, MUSB_TXTYPE);
2184 musb->context.index_regs[i].txinterval =
2185 musb_readb(epio, MUSB_TXINTERVAL);
2186 musb->context.index_regs[i].rxtype =
2187 musb_readb(epio, MUSB_RXTYPE);
2188 musb->context.index_regs[i].rxinterval =
2189 musb_readb(epio, MUSB_RXINTERVAL);
2191 musb->context.index_regs[i].txfunaddr =
2192 musb_read_txfunaddr(musb_base, i);
2193 musb->context.index_regs[i].txhubaddr =
2194 musb_read_txhubaddr(musb_base, i);
2195 musb->context.index_regs[i].txhubport =
2196 musb_read_txhubport(musb_base, i);
2198 musb->context.index_regs[i].rxfunaddr =
2199 musb_read_rxfunaddr(musb_base, i);
2200 musb->context.index_regs[i].rxhubaddr =
2201 musb_read_rxhubaddr(musb_base, i);
2202 musb->context.index_regs[i].rxhubport =
2203 musb_read_rxhubport(musb_base, i);
2208 static void musb_restore_context(struct musb *musb)
2210 int i;
2211 void __iomem *musb_base = musb->mregs;
2212 void __iomem *ep_target_regs;
2213 void __iomem *epio;
2215 if (is_host_enabled(musb)) {
2216 musb_writew(musb_base, MUSB_FRAME, musb->context.frame);
2217 musb_writeb(musb_base, MUSB_TESTMODE, musb->context.testmode);
2218 musb_write_ulpi_buscontrol(musb->mregs, musb->context.busctl);
2220 musb_writeb(musb_base, MUSB_POWER, musb->context.power);
2221 musb_writew(musb_base, MUSB_INTRTXE, musb->context.intrtxe);
2222 musb_writew(musb_base, MUSB_INTRRXE, musb->context.intrrxe);
2223 musb_writeb(musb_base, MUSB_INTRUSBE, musb->context.intrusbe);
2224 musb_writeb(musb_base, MUSB_DEVCTL, musb->context.devctl);
2226 for (i = 0; i < musb->config->num_eps; ++i) {
2227 struct musb_hw_ep *hw_ep;
2229 hw_ep = &musb->endpoints[i];
2230 if (!hw_ep)
2231 continue;
2233 epio = hw_ep->regs;
2234 if (!epio)
2235 continue;
2237 musb_writew(epio, MUSB_TXMAXP,
2238 musb->context.index_regs[i].txmaxp);
2239 musb_writew(epio, MUSB_TXCSR,
2240 musb->context.index_regs[i].txcsr);
2241 musb_writew(epio, MUSB_RXMAXP,
2242 musb->context.index_regs[i].rxmaxp);
2243 musb_writew(epio, MUSB_RXCSR,
2244 musb->context.index_regs[i].rxcsr);
2246 if (musb->dyn_fifo) {
2247 musb_write_txfifosz(musb_base,
2248 musb->context.index_regs[i].txfifosz);
2249 musb_write_rxfifosz(musb_base,
2250 musb->context.index_regs[i].rxfifosz);
2251 musb_write_txfifoadd(musb_base,
2252 musb->context.index_regs[i].txfifoadd);
2253 musb_write_rxfifoadd(musb_base,
2254 musb->context.index_regs[i].rxfifoadd);
2257 if (is_host_enabled(musb)) {
2258 musb_writeb(epio, MUSB_TXTYPE,
2259 musb->context.index_regs[i].txtype);
2260 musb_writeb(epio, MUSB_TXINTERVAL,
2261 musb->context.index_regs[i].txinterval);
2262 musb_writeb(epio, MUSB_RXTYPE,
2263 musb->context.index_regs[i].rxtype);
2264 musb_writeb(epio, MUSB_RXINTERVAL,
2266 musb->context.index_regs[i].rxinterval);
2267 musb_write_txfunaddr(musb_base, i,
2268 musb->context.index_regs[i].txfunaddr);
2269 musb_write_txhubaddr(musb_base, i,
2270 musb->context.index_regs[i].txhubaddr);
2271 musb_write_txhubport(musb_base, i,
2272 musb->context.index_regs[i].txhubport);
2274 ep_target_regs =
2275 musb_read_target_reg_base(i, musb_base);
2277 musb_write_rxfunaddr(ep_target_regs,
2278 musb->context.index_regs[i].rxfunaddr);
2279 musb_write_rxhubaddr(ep_target_regs,
2280 musb->context.index_regs[i].rxhubaddr);
2281 musb_write_rxhubport(ep_target_regs,
2282 musb->context.index_regs[i].rxhubport);
2285 musb_writeb(musb_base, MUSB_INDEX, musb->context.index);
2288 static int musb_suspend(struct device *dev)
2290 struct musb *musb = dev_to_musb(dev);
2291 unsigned long flags;
2293 spin_lock_irqsave(&musb->lock, flags);
2295 if (is_peripheral_active(musb)) {
2296 /* FIXME force disconnect unless we know USB will wake
2297 * the system up quickly enough to respond ...
2299 } else if (is_host_active(musb)) {
2300 /* we know all the children are suspended; sometimes
2301 * they will even be wakeup-enabled.
2305 musb_save_context(musb);
2307 spin_unlock_irqrestore(&musb->lock, flags);
2308 return 0;
2311 static int musb_resume_noirq(struct device *dev)
2313 struct musb *musb = dev_to_musb(dev);
2315 musb_restore_context(musb);
2317 /* for static cmos like DaVinci, register values were preserved
2318 * unless for some reason the whole soc powered down or the USB
2319 * module got reset through the PSC (vs just being disabled).
2321 return 0;
2324 static int musb_runtime_suspend(struct device *dev)
2326 struct musb *musb = dev_to_musb(dev);
2328 musb_save_context(musb);
2330 return 0;
2333 static int musb_runtime_resume(struct device *dev)
2335 struct musb *musb = dev_to_musb(dev);
2336 static int first = 1;
2339 * When pm_runtime_get_sync called for the first time in driver
2340 * init, some of the structure is still not initialized which is
2341 * used in restore function. But clock needs to be
2342 * enabled before any register access, so
2343 * pm_runtime_get_sync has to be called.
2344 * Also context restore without save does not make
2345 * any sense
2347 if (!first)
2348 musb_restore_context(musb);
2349 first = 0;
2351 return 0;
2354 static const struct dev_pm_ops musb_dev_pm_ops = {
2355 .suspend = musb_suspend,
2356 .resume_noirq = musb_resume_noirq,
2357 .runtime_suspend = musb_runtime_suspend,
2358 .runtime_resume = musb_runtime_resume,
2361 #define MUSB_DEV_PM_OPS (&musb_dev_pm_ops)
2362 #else
2363 #define MUSB_DEV_PM_OPS NULL
2364 #endif
2366 static struct platform_driver musb_driver = {
2367 .driver = {
2368 .name = (char *)musb_driver_name,
2369 .bus = &platform_bus_type,
2370 .owner = THIS_MODULE,
2371 .pm = MUSB_DEV_PM_OPS,
2373 .remove = __exit_p(musb_remove),
2374 .shutdown = musb_shutdown,
2377 /*-------------------------------------------------------------------------*/
2379 static int __init musb_init(void)
2381 if (usb_disabled())
2382 return 0;
2384 pr_info("%s: version " MUSB_VERSION ", "
2385 "?dma?"
2386 ", "
2387 "otg (peripheral+host)",
2388 musb_driver_name);
2389 return platform_driver_probe(&musb_driver, musb_probe);
2392 /* make us init after usbcore and i2c (transceivers, regulators, etc)
2393 * and before usb gadget and host-side drivers start to register
2395 fs_initcall(musb_init);
2397 static void __exit musb_cleanup(void)
2399 platform_driver_unregister(&musb_driver);
2401 module_exit(musb_cleanup);