2 * MUSB OTG driver host support
4 * Copyright 2005 Mentor Graphics Corporation
5 * Copyright (C) 2005-2006 by Texas Instruments
6 * Copyright (C) 2006-2007 Nokia Corporation
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
25 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
28 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
29 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <linux/module.h>
36 #include <linux/kernel.h>
37 #include <linux/delay.h>
38 #include <linux/sched.h>
39 #include <linux/slab.h>
40 #include <linux/errno.h>
41 #include <linux/init.h>
42 #include <linux/list.h>
44 #include "musb_core.h"
45 #include "musb_host.h"
48 /* MUSB HOST status 22-mar-2006
50 * - There's still lots of partial code duplication for fault paths, so
51 * they aren't handled as consistently as they need to be.
53 * - PIO mostly behaved when last tested.
54 * + including ep0, with all usbtest cases 9, 10
55 * + usbtest 14 (ep0out) doesn't seem to run at all
56 * + double buffered OUT/TX endpoints saw stalls(!) with certain usbtest
57 * configurations, but otherwise double buffering passes basic tests.
58 * + for 2.6.N, for N > ~10, needs API changes for hcd framework.
60 * - DMA (CPPI) ... partially behaves, not currently recommended
61 * + about 1/15 the speed of typical EHCI implementations (PCI)
62 * + RX, all too often reqpkt seems to misbehave after tx
63 * + TX, no known issues (other than evident silicon issue)
65 * - DMA (Mentor/OMAP) ...has at least toggle update problems
67 * - Still no traffic scheduling code to make NAKing for bulk or control
68 * transfers unable to starve other requests; or to make efficient use
69 * of hardware with periodic transfers. (Note that network drivers
70 * commonly post bulk reads that stay pending for a long time; these
71 * would make very visible trouble.)
73 * - Not tested with HNP, but some SRP paths seem to behave.
75 * NOTE 24-August-2006:
77 * - Bulk traffic finally uses both sides of hardware ep1, freeing up an
78 * extra endpoint for periodic use enabling hub + keybd + mouse. That
79 * mostly works, except that with "usbnet" it's easy to trigger cases
80 * with "ping" where RX loses. (a) ping to davinci, even "ping -f",
81 * fine; but (b) ping _from_ davinci, even "ping -c 1", ICMP RX loses
82 * although ARP RX wins. (That test was done with a full speed link.)
87 * NOTE on endpoint usage:
89 * CONTROL transfers all go through ep0. BULK ones go through dedicated IN
90 * and OUT endpoints ... hardware is dedicated for those "async" queue(s).
92 * (Yes, bulk _could_ use more of the endpoints than that, and would even
93 * benefit from it ... one remote device may easily be NAKing while others
94 * need to perform transfers in that same direction. The same thing could
95 * be done in software though, assuming dma cooperates.)
97 * INTERUPPT and ISOCHRONOUS transfers are scheduled to the other endpoints.
98 * So far that scheduling is both dumb and optimistic: the endpoint will be
99 * "claimed" until its software queue is no longer refilled. No multiplexing
100 * of transfers between endpoints, or anything clever.
104 static void musb_ep_program(struct musb *musb, u8 epnum,
105 struct urb *urb, unsigned int nOut,
109 * Clear TX fifo. Needed to avoid BABBLE errors.
111 static void musb_h_tx_flush_fifo(struct musb_hw_ep *ep)
113 void __iomem *epio = ep->regs;
118 csr = musb_readw(epio, MUSB_TXCSR);
119 while (csr & MUSB_TXCSR_FIFONOTEMPTY) {
121 DBG(3, "Host TX FIFONOTEMPTY csr: %02x\n", csr);
123 csr |= MUSB_TXCSR_FLUSHFIFO;
124 musb_writew(epio, MUSB_TXCSR, csr);
125 csr = musb_readw(epio, MUSB_TXCSR);
126 if (WARN(retries-- < 1,
127 "Could not flush host TX%d fifo: csr: %04x\n",
135 * Start transmit. Caller is responsible for locking shared resources.
136 * musb must be locked.
138 static inline void musb_h_tx_start(struct musb_hw_ep *ep)
142 /* NOTE: no locks here; caller should lock and select EP */
144 txcsr = musb_readw(ep->regs, MUSB_TXCSR);
145 txcsr |= MUSB_TXCSR_TXPKTRDY | MUSB_TXCSR_H_WZC_BITS;
146 musb_writew(ep->regs, MUSB_TXCSR, txcsr);
148 txcsr = MUSB_CSR0_H_SETUPPKT | MUSB_CSR0_TXPKTRDY;
149 musb_writew(ep->regs, MUSB_CSR0, txcsr);
154 static inline void cppi_host_txdma_start(struct musb_hw_ep *ep)
158 /* NOTE: no locks here; caller should lock and select EP */
159 txcsr = musb_readw(ep->regs, MUSB_TXCSR);
160 txcsr |= MUSB_TXCSR_DMAENAB | MUSB_TXCSR_H_WZC_BITS;
161 musb_writew(ep->regs, MUSB_TXCSR, txcsr);
165 * Start the URB at the front of an endpoint's queue
166 * end must be claimed from the caller.
168 * Context: controller locked, irqs blocked
171 musb_start_urb(struct musb *musb, int is_in, struct musb_qh *qh)
176 void __iomem *mbase = musb->mregs;
177 struct urb *urb = next_urb(qh);
178 struct musb_hw_ep *hw_ep = qh->hw_ep;
179 unsigned pipe = urb->pipe;
180 u8 address = usb_pipedevice(pipe);
181 int epnum = hw_ep->epnum;
183 /* initialize software qh state */
187 /* gather right source of data */
189 case USB_ENDPOINT_XFER_CONTROL:
190 /* control transfers always start with SETUP */
193 musb->ep0_stage = MUSB_EP0_START;
194 buf = urb->setup_packet;
197 case USB_ENDPOINT_XFER_ISOC:
200 buf = urb->transfer_buffer + urb->iso_frame_desc[0].offset;
201 len = urb->iso_frame_desc[0].length;
203 default: /* bulk, interrupt */
204 buf = urb->transfer_buffer;
205 len = urb->transfer_buffer_length;
208 DBG(4, "qh %p urb %p dev%d ep%d%s%s, hw_ep %d, %p/%d\n",
209 qh, urb, address, qh->epnum,
210 is_in ? "in" : "out",
211 ({char *s; switch (qh->type) {
212 case USB_ENDPOINT_XFER_CONTROL: s = ""; break;
213 case USB_ENDPOINT_XFER_BULK: s = "-bulk"; break;
214 case USB_ENDPOINT_XFER_ISOC: s = "-iso"; break;
215 default: s = "-intr"; break;
219 /* Configure endpoint */
220 if (is_in || hw_ep->is_shared_fifo)
224 musb_ep_program(musb, epnum, urb, !is_in, buf, len);
226 /* transmit may have more work: start it when it is time */
230 /* determine if the time is right for a periodic transfer */
232 case USB_ENDPOINT_XFER_ISOC:
233 case USB_ENDPOINT_XFER_INT:
234 DBG(3, "check whether there's still time for periodic Tx\n");
236 frame = musb_readw(mbase, MUSB_FRAME);
237 /* FIXME this doesn't implement that scheduling policy ...
238 * or handle framecounter wrapping
240 if ((urb->transfer_flags & URB_ISO_ASAP)
241 || (frame >= urb->start_frame)) {
242 /* REVISIT the SOF irq handler shouldn't duplicate
243 * this code; and we don't init urb->start_frame...
248 qh->frame = urb->start_frame;
249 /* enable SOF interrupt so we can count down */
250 DBG(1, "SOF for %d\n", epnum);
251 #if 1 /* ifndef CONFIG_ARCH_DAVINCI */
252 musb_writeb(mbase, MUSB_INTRUSBE, 0xff);
258 DBG(4, "Start TX%d %s\n", epnum,
259 hw_ep->tx_channel ? "dma" : "pio");
261 if (!hw_ep->tx_channel)
262 musb_h_tx_start(hw_ep);
263 else if (is_cppi_enabled() || tusb_dma_omap())
264 cppi_host_txdma_start(hw_ep);
268 /* caller owns controller lock, irqs are blocked */
270 __musb_giveback(struct musb *musb, struct urb *urb, int status)
271 __releases(musb->lock)
272 __acquires(musb->lock)
274 DBG(({ int level; switch (status) {
278 /* common/boring faults */
289 "complete %p %pF (%d), dev%d ep%d%s, %d/%d\n",
290 urb, urb->complete, status,
291 usb_pipedevice(urb->pipe),
292 usb_pipeendpoint(urb->pipe),
293 usb_pipein(urb->pipe) ? "in" : "out",
294 urb->actual_length, urb->transfer_buffer_length
297 usb_hcd_unlink_urb_from_ep(musb_to_hcd(musb), urb);
298 spin_unlock(&musb->lock);
299 usb_hcd_giveback_urb(musb_to_hcd(musb), urb, status);
300 spin_lock(&musb->lock);
303 /* for bulk/interrupt endpoints only */
305 musb_save_toggle(struct musb_hw_ep *ep, int is_in, struct urb *urb)
307 struct usb_device *udev = urb->dev;
309 void __iomem *epio = ep->regs;
312 /* FIXME: the current Mentor DMA code seems to have
313 * problems getting toggle correct.
316 if (is_in || ep->is_shared_fifo)
322 csr = musb_readw(epio, MUSB_TXCSR);
323 usb_settoggle(udev, qh->epnum, 1,
324 (csr & MUSB_TXCSR_H_DATATOGGLE)
327 csr = musb_readw(epio, MUSB_RXCSR);
328 usb_settoggle(udev, qh->epnum, 0,
329 (csr & MUSB_RXCSR_H_DATATOGGLE)
334 /* caller owns controller lock, irqs are blocked */
335 static struct musb_qh *
336 musb_giveback(struct musb_qh *qh, struct urb *urb, int status)
339 struct musb_hw_ep *ep = qh->hw_ep;
340 struct musb *musb = ep->musb;
341 int ready = qh->is_ready;
343 if (ep->is_shared_fifo)
346 is_in = usb_pipein(urb->pipe);
348 /* save toggle eagerly, for paranoia */
350 case USB_ENDPOINT_XFER_BULK:
351 case USB_ENDPOINT_XFER_INT:
352 musb_save_toggle(ep, is_in, urb);
354 case USB_ENDPOINT_XFER_ISOC:
355 if (status == 0 && urb->error_count)
361 __musb_giveback(musb, urb, status);
362 qh->is_ready = ready;
364 /* reclaim resources (and bandwidth) ASAP; deschedule it, and
365 * invalidate qh as soon as list_empty(&hep->urb_list)
367 if (list_empty(&qh->hep->urb_list)) {
368 struct list_head *head;
375 /* clobber old pointers to this qh */
376 if (is_in || ep->is_shared_fifo)
380 qh->hep->hcpriv = NULL;
384 case USB_ENDPOINT_XFER_CONTROL:
385 case USB_ENDPOINT_XFER_BULK:
386 /* fifo policy for these lists, except that NAKing
387 * should rotate a qh to the end (for fairness).
390 head = qh->ring.prev;
397 case USB_ENDPOINT_XFER_ISOC:
398 case USB_ENDPOINT_XFER_INT:
399 /* this is where periodic bandwidth should be
400 * de-allocated if it's tracked and allocated;
401 * and where we'd update the schedule tree...
403 musb->periodic[ep->epnum] = NULL;
413 * Advance this hardware endpoint's queue, completing the specified urb and
414 * advancing to either the next urb queued to that qh, or else invalidating
415 * that qh and advancing to the next qh scheduled after the current one.
417 * Context: caller owns controller lock, irqs are blocked
420 musb_advance_schedule(struct musb *musb, struct urb *urb,
421 struct musb_hw_ep *hw_ep, int is_in)
425 if (is_in || hw_ep->is_shared_fifo)
430 if (urb->status == -EINPROGRESS)
431 qh = musb_giveback(qh, urb, 0);
433 qh = musb_giveback(qh, urb, urb->status);
435 if (qh && qh->is_ready && !list_empty(&qh->hep->urb_list)) {
436 DBG(4, "... next ep%d %cX urb %p\n",
437 hw_ep->epnum, is_in ? 'R' : 'T',
439 musb_start_urb(musb, is_in, qh);
443 static u16 musb_h_flush_rxfifo(struct musb_hw_ep *hw_ep, u16 csr)
445 /* we don't want fifo to fill itself again;
446 * ignore dma (various models),
447 * leave toggle alone (may not have been saved yet)
449 csr |= MUSB_RXCSR_FLUSHFIFO | MUSB_RXCSR_RXPKTRDY;
450 csr &= ~(MUSB_RXCSR_H_REQPKT
451 | MUSB_RXCSR_H_AUTOREQ
452 | MUSB_RXCSR_AUTOCLEAR);
454 /* write 2x to allow double buffering */
455 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
456 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
458 /* flush writebuffer */
459 return musb_readw(hw_ep->regs, MUSB_RXCSR);
463 * PIO RX for a packet (or part of it).
466 musb_host_packet_rx(struct musb *musb, struct urb *urb, u8 epnum, u8 iso_err)
474 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
475 void __iomem *epio = hw_ep->regs;
476 struct musb_qh *qh = hw_ep->in_qh;
477 int pipe = urb->pipe;
478 void *buffer = urb->transfer_buffer;
480 /* musb_ep_select(mbase, epnum); */
481 rx_count = musb_readw(epio, MUSB_RXCOUNT);
482 DBG(3, "RX%d count %d, buffer %p len %d/%d\n", epnum, rx_count,
483 urb->transfer_buffer, qh->offset,
484 urb->transfer_buffer_length);
487 if (usb_pipeisoc(pipe)) {
489 struct usb_iso_packet_descriptor *d;
496 d = urb->iso_frame_desc + qh->iso_idx;
497 buf = buffer + d->offset;
499 if (rx_count > length) {
504 DBG(2, "** OVERFLOW %d into %d\n", rx_count, length);
508 urb->actual_length += length;
509 d->actual_length = length;
513 /* see if we are done */
514 done = (++qh->iso_idx >= urb->number_of_packets);
517 buf = buffer + qh->offset;
518 length = urb->transfer_buffer_length - qh->offset;
519 if (rx_count > length) {
520 if (urb->status == -EINPROGRESS)
521 urb->status = -EOVERFLOW;
522 DBG(2, "** OVERFLOW %d into %d\n", rx_count, length);
526 urb->actual_length += length;
527 qh->offset += length;
529 /* see if we are done */
530 done = (urb->actual_length == urb->transfer_buffer_length)
531 || (rx_count < qh->maxpacket)
532 || (urb->status != -EINPROGRESS);
534 && (urb->status == -EINPROGRESS)
535 && (urb->transfer_flags & URB_SHORT_NOT_OK)
536 && (urb->actual_length
537 < urb->transfer_buffer_length))
538 urb->status = -EREMOTEIO;
541 musb_read_fifo(hw_ep, length, buf);
543 csr = musb_readw(epio, MUSB_RXCSR);
544 csr |= MUSB_RXCSR_H_WZC_BITS;
545 if (unlikely(do_flush))
546 musb_h_flush_rxfifo(hw_ep, csr);
548 /* REVISIT this assumes AUTOCLEAR is never set */
549 csr &= ~(MUSB_RXCSR_RXPKTRDY | MUSB_RXCSR_H_REQPKT);
551 csr |= MUSB_RXCSR_H_REQPKT;
552 musb_writew(epio, MUSB_RXCSR, csr);
558 /* we don't always need to reinit a given side of an endpoint...
559 * when we do, use tx/rx reinit routine and then construct a new CSR
560 * to address data toggle, NYET, and DMA or PIO.
562 * it's possible that driver bugs (especially for DMA) or aborting a
563 * transfer might have left the endpoint busier than it should be.
564 * the busy/not-empty tests are basically paranoia.
567 musb_rx_reinit(struct musb *musb, struct musb_qh *qh, struct musb_hw_ep *ep)
571 /* NOTE: we know the "rx" fifo reinit never triggers for ep0.
572 * That always uses tx_reinit since ep0 repurposes TX register
573 * offsets; the initial SETUP packet is also a kind of OUT.
576 /* if programmed for Tx, put it in RX mode */
577 if (ep->is_shared_fifo) {
578 csr = musb_readw(ep->regs, MUSB_TXCSR);
579 if (csr & MUSB_TXCSR_MODE) {
580 musb_h_tx_flush_fifo(ep);
581 musb_writew(ep->regs, MUSB_TXCSR,
582 MUSB_TXCSR_FRCDATATOG);
584 /* clear mode (and everything else) to enable Rx */
585 musb_writew(ep->regs, MUSB_TXCSR, 0);
587 /* scrub all previous state, clearing toggle */
589 csr = musb_readw(ep->regs, MUSB_RXCSR);
590 if (csr & MUSB_RXCSR_RXPKTRDY)
591 WARNING("rx%d, packet/%d ready?\n", ep->epnum,
592 musb_readw(ep->regs, MUSB_RXCOUNT));
594 musb_h_flush_rxfifo(ep, MUSB_RXCSR_CLRDATATOG);
597 /* target addr and (for multipoint) hub addr/port */
598 if (musb->is_multipoint) {
599 musb_write_rxfunaddr(ep->target_regs, qh->addr_reg);
600 musb_write_rxhubaddr(ep->target_regs, qh->h_addr_reg);
601 musb_write_rxhubport(ep->target_regs, qh->h_port_reg);
604 musb_writeb(musb->mregs, MUSB_FADDR, qh->addr_reg);
606 /* protocol/endpoint, interval/NAKlimit, i/o size */
607 musb_writeb(ep->regs, MUSB_RXTYPE, qh->type_reg);
608 musb_writeb(ep->regs, MUSB_RXINTERVAL, qh->intv_reg);
609 /* NOTE: bulk combining rewrites high bits of maxpacket */
610 musb_writew(ep->regs, MUSB_RXMAXP, qh->maxpacket);
617 * Program an HDRC endpoint as per the given URB
618 * Context: irqs blocked, controller lock held
620 static void musb_ep_program(struct musb *musb, u8 epnum,
621 struct urb *urb, unsigned int is_out,
624 struct dma_controller *dma_controller;
625 struct dma_channel *dma_channel;
627 void __iomem *mbase = musb->mregs;
628 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
629 void __iomem *epio = hw_ep->regs;
633 if (!is_out || hw_ep->is_shared_fifo)
638 packet_sz = qh->maxpacket;
640 DBG(3, "%s hw%d urb %p spd%d dev%d ep%d%s "
641 "h_addr%02x h_port%02x bytes %d\n",
642 is_out ? "-->" : "<--",
643 epnum, urb, urb->dev->speed,
644 qh->addr_reg, qh->epnum, is_out ? "out" : "in",
645 qh->h_addr_reg, qh->h_port_reg,
648 musb_ep_select(mbase, epnum);
650 /* candidate for DMA? */
651 dma_controller = musb->dma_controller;
652 if (is_dma_capable() && epnum && dma_controller) {
653 dma_channel = is_out ? hw_ep->tx_channel : hw_ep->rx_channel;
655 dma_channel = dma_controller->channel_alloc(
656 dma_controller, hw_ep, is_out);
658 hw_ep->tx_channel = dma_channel;
660 hw_ep->rx_channel = dma_channel;
665 /* make sure we clear DMAEnab, autoSet bits from previous run */
667 /* OUT/transmit/EP0 or IN/receive? */
673 csr = musb_readw(epio, MUSB_TXCSR);
675 /* disable interrupt in case we flush */
676 int_txe = musb_readw(mbase, MUSB_INTRTXE);
677 musb_writew(mbase, MUSB_INTRTXE, int_txe & ~(1 << epnum));
679 /* general endpoint setup */
681 /* ASSERT: TXCSR_DMAENAB was already cleared */
683 /* flush all old state, set default */
684 musb_h_tx_flush_fifo(hw_ep);
685 csr &= ~(MUSB_TXCSR_H_NAKTIMEOUT
687 | MUSB_TXCSR_FRCDATATOG
688 | MUSB_TXCSR_H_RXSTALL
690 | MUSB_TXCSR_TXPKTRDY
692 csr |= MUSB_TXCSR_MODE;
694 if (usb_gettoggle(urb->dev,
696 csr |= MUSB_TXCSR_H_WR_DATATOGGLE
697 | MUSB_TXCSR_H_DATATOGGLE;
699 csr |= MUSB_TXCSR_CLRDATATOG;
701 /* twice in case of double packet buffering */
702 musb_writew(epio, MUSB_TXCSR, csr);
703 /* REVISIT may need to clear FLUSHFIFO ... */
704 musb_writew(epio, MUSB_TXCSR, csr);
705 csr = musb_readw(epio, MUSB_TXCSR);
707 /* endpoint 0: just flush */
708 musb_writew(epio, MUSB_CSR0,
709 csr | MUSB_CSR0_FLUSHFIFO);
710 musb_writew(epio, MUSB_CSR0,
711 csr | MUSB_CSR0_FLUSHFIFO);
714 /* target addr and (for multipoint) hub addr/port */
715 if (musb->is_multipoint) {
716 musb_write_txfunaddr(mbase, epnum, qh->addr_reg);
717 musb_write_txhubaddr(mbase, epnum, qh->h_addr_reg);
718 musb_write_txhubport(mbase, epnum, qh->h_port_reg);
719 /* FIXME if !epnum, do the same for RX ... */
721 musb_writeb(mbase, MUSB_FADDR, qh->addr_reg);
723 /* protocol/endpoint/interval/NAKlimit */
725 musb_writeb(epio, MUSB_TXTYPE, qh->type_reg);
726 if (can_bulk_split(musb, qh->type))
727 musb_writew(epio, MUSB_TXMAXP,
729 | ((hw_ep->max_packet_sz_tx /
730 packet_sz) - 1) << 11);
732 musb_writew(epio, MUSB_TXMAXP,
734 musb_writeb(epio, MUSB_TXINTERVAL, qh->intv_reg);
736 musb_writeb(epio, MUSB_NAKLIMIT0, qh->intv_reg);
737 if (musb->is_multipoint)
738 musb_writeb(epio, MUSB_TYPE0,
742 if (can_bulk_split(musb, qh->type))
743 load_count = min((u32) hw_ep->max_packet_sz_tx,
746 load_count = min((u32) packet_sz, len);
748 #ifdef CONFIG_USB_INVENTRA_DMA
751 /* clear previous state */
752 csr = musb_readw(epio, MUSB_TXCSR);
753 csr &= ~(MUSB_TXCSR_AUTOSET
755 | MUSB_TXCSR_DMAENAB);
756 csr |= MUSB_TXCSR_MODE;
757 musb_writew(epio, MUSB_TXCSR,
758 csr | MUSB_TXCSR_MODE);
760 qh->segsize = min(len, dma_channel->max_len);
762 if (qh->segsize <= packet_sz)
763 dma_channel->desired_mode = 0;
765 dma_channel->desired_mode = 1;
768 if (dma_channel->desired_mode == 0) {
769 csr &= ~(MUSB_TXCSR_AUTOSET
770 | MUSB_TXCSR_DMAMODE);
771 csr |= (MUSB_TXCSR_DMAENAB);
772 /* against programming guide */
774 csr |= (MUSB_TXCSR_AUTOSET
776 | MUSB_TXCSR_DMAMODE);
778 musb_writew(epio, MUSB_TXCSR, csr);
780 dma_ok = dma_controller->channel_program(
781 dma_channel, packet_sz,
782 dma_channel->desired_mode,
788 dma_controller->channel_release(dma_channel);
790 hw_ep->tx_channel = NULL;
792 hw_ep->rx_channel = NULL;
798 /* candidate for DMA */
799 if ((is_cppi_enabled() || tusb_dma_omap()) && dma_channel) {
801 /* program endpoint CSRs first, then setup DMA.
802 * assume CPPI setup succeeds.
803 * defer enabling dma.
805 csr = musb_readw(epio, MUSB_TXCSR);
806 csr &= ~(MUSB_TXCSR_AUTOSET
808 | MUSB_TXCSR_DMAENAB);
809 csr |= MUSB_TXCSR_MODE;
810 musb_writew(epio, MUSB_TXCSR,
811 csr | MUSB_TXCSR_MODE);
813 dma_channel->actual_len = 0L;
816 /* TX uses "rndis" mode automatically, but needs help
817 * to identify the zero-length-final-packet case.
819 dma_ok = dma_controller->channel_program(
820 dma_channel, packet_sz,
829 dma_controller->channel_release(dma_channel);
830 hw_ep->tx_channel = NULL;
833 /* REVISIT there's an error path here that
834 * needs handling: can't do dma, but
835 * there's no pio buffer address...
841 /* ASSERT: TXCSR_DMAENAB was already cleared */
843 /* PIO to load FIFO */
844 qh->segsize = load_count;
845 musb_write_fifo(hw_ep, load_count, buf);
846 csr = musb_readw(epio, MUSB_TXCSR);
847 csr &= ~(MUSB_TXCSR_DMAENAB
849 | MUSB_TXCSR_AUTOSET);
851 csr |= MUSB_TXCSR_MODE;
854 musb_writew(epio, MUSB_TXCSR, csr);
857 /* re-enable interrupt */
858 musb_writew(mbase, MUSB_INTRTXE, int_txe);
864 if (hw_ep->rx_reinit) {
865 musb_rx_reinit(musb, qh, hw_ep);
867 /* init new state: toggle and NYET, maybe DMA later */
868 if (usb_gettoggle(urb->dev, qh->epnum, 0))
869 csr = MUSB_RXCSR_H_WR_DATATOGGLE
870 | MUSB_RXCSR_H_DATATOGGLE;
873 if (qh->type == USB_ENDPOINT_XFER_INT)
874 csr |= MUSB_RXCSR_DISNYET;
877 csr = musb_readw(hw_ep->regs, MUSB_RXCSR);
879 if (csr & (MUSB_RXCSR_RXPKTRDY
881 | MUSB_RXCSR_H_REQPKT))
882 ERR("broken !rx_reinit, ep%d csr %04x\n",
885 /* scrub any stale state, leaving toggle alone */
886 csr &= MUSB_RXCSR_DISNYET;
889 /* kick things off */
891 if ((is_cppi_enabled() || tusb_dma_omap()) && dma_channel) {
892 /* candidate for DMA */
894 dma_channel->actual_len = 0L;
897 /* AUTOREQ is in a DMA register */
898 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
899 csr = musb_readw(hw_ep->regs,
902 /* unless caller treats short rx transfers as
903 * errors, we dare not queue multiple transfers.
905 dma_ok = dma_controller->channel_program(
906 dma_channel, packet_sz,
907 !(urb->transfer_flags
912 dma_controller->channel_release(
914 hw_ep->rx_channel = NULL;
917 csr |= MUSB_RXCSR_DMAENAB;
921 csr |= MUSB_RXCSR_H_REQPKT;
922 DBG(7, "RXCSR%d := %04x\n", epnum, csr);
923 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
924 csr = musb_readw(hw_ep->regs, MUSB_RXCSR);
930 * Service the default endpoint (ep0) as host.
931 * Return true until it's time to start the status stage.
933 static bool musb_h_ep0_continue(struct musb *musb, u16 len, struct urb *urb)
936 u8 *fifo_dest = NULL;
938 struct musb_hw_ep *hw_ep = musb->control_ep;
939 struct musb_qh *qh = hw_ep->in_qh;
940 struct usb_ctrlrequest *request;
942 switch (musb->ep0_stage) {
944 fifo_dest = urb->transfer_buffer + urb->actual_length;
945 fifo_count = min(len, ((u16) (urb->transfer_buffer_length
946 - urb->actual_length)));
947 if (fifo_count < len)
948 urb->status = -EOVERFLOW;
950 musb_read_fifo(hw_ep, fifo_count, fifo_dest);
952 urb->actual_length += fifo_count;
953 if (len < qh->maxpacket) {
954 /* always terminate on short read; it's
955 * rarely reported as an error.
957 } else if (urb->actual_length <
958 urb->transfer_buffer_length)
962 request = (struct usb_ctrlrequest *) urb->setup_packet;
964 if (!request->wLength) {
965 DBG(4, "start no-DATA\n");
967 } else if (request->bRequestType & USB_DIR_IN) {
968 DBG(4, "start IN-DATA\n");
969 musb->ep0_stage = MUSB_EP0_IN;
973 DBG(4, "start OUT-DATA\n");
974 musb->ep0_stage = MUSB_EP0_OUT;
979 fifo_count = min(qh->maxpacket, ((u16)
980 (urb->transfer_buffer_length
981 - urb->actual_length)));
984 fifo_dest = (u8 *) (urb->transfer_buffer
985 + urb->actual_length);
986 DBG(3, "Sending %d byte%s to ep0 fifo %p\n",
988 (fifo_count == 1) ? "" : "s",
990 musb_write_fifo(hw_ep, fifo_count, fifo_dest);
992 urb->actual_length += fifo_count;
997 ERR("bogus ep0 stage %d\n", musb->ep0_stage);
1005 * Handle default endpoint interrupt as host. Only called in IRQ time
1006 * from musb_interrupt().
1008 * called with controller irqlocked
1010 irqreturn_t musb_h_ep0_irq(struct musb *musb)
1015 void __iomem *mbase = musb->mregs;
1016 struct musb_hw_ep *hw_ep = musb->control_ep;
1017 void __iomem *epio = hw_ep->regs;
1018 struct musb_qh *qh = hw_ep->in_qh;
1019 bool complete = false;
1020 irqreturn_t retval = IRQ_NONE;
1022 /* ep0 only has one queue, "in" */
1025 musb_ep_select(mbase, 0);
1026 csr = musb_readw(epio, MUSB_CSR0);
1027 len = (csr & MUSB_CSR0_RXPKTRDY)
1028 ? musb_readb(epio, MUSB_COUNT0)
1031 DBG(4, "<== csr0 %04x, qh %p, count %d, urb %p, stage %d\n",
1032 csr, qh, len, urb, musb->ep0_stage);
1034 /* if we just did status stage, we are done */
1035 if (MUSB_EP0_STATUS == musb->ep0_stage) {
1036 retval = IRQ_HANDLED;
1040 /* prepare status */
1041 if (csr & MUSB_CSR0_H_RXSTALL) {
1042 DBG(6, "STALLING ENDPOINT\n");
1045 } else if (csr & MUSB_CSR0_H_ERROR) {
1046 DBG(2, "no response, csr0 %04x\n", csr);
1049 } else if (csr & MUSB_CSR0_H_NAKTIMEOUT) {
1050 DBG(2, "control NAK timeout\n");
1052 /* NOTE: this code path would be a good place to PAUSE a
1053 * control transfer, if another one is queued, so that
1054 * ep0 is more likely to stay busy.
1056 * if (qh->ring.next != &musb->control), then
1057 * we have a candidate... NAKing is *NOT* an error
1059 musb_writew(epio, MUSB_CSR0, 0);
1060 retval = IRQ_HANDLED;
1064 DBG(6, "aborting\n");
1065 retval = IRQ_HANDLED;
1067 urb->status = status;
1070 /* use the proper sequence to abort the transfer */
1071 if (csr & MUSB_CSR0_H_REQPKT) {
1072 csr &= ~MUSB_CSR0_H_REQPKT;
1073 musb_writew(epio, MUSB_CSR0, csr);
1074 csr &= ~MUSB_CSR0_H_NAKTIMEOUT;
1075 musb_writew(epio, MUSB_CSR0, csr);
1077 csr |= MUSB_CSR0_FLUSHFIFO;
1078 musb_writew(epio, MUSB_CSR0, csr);
1079 musb_writew(epio, MUSB_CSR0, csr);
1080 csr &= ~MUSB_CSR0_H_NAKTIMEOUT;
1081 musb_writew(epio, MUSB_CSR0, csr);
1084 musb_writeb(epio, MUSB_NAKLIMIT0, 0);
1087 musb_writew(epio, MUSB_CSR0, 0);
1090 if (unlikely(!urb)) {
1091 /* stop endpoint since we have no place for its data, this
1092 * SHOULD NEVER HAPPEN! */
1093 ERR("no URB for end 0\n");
1095 musb_writew(epio, MUSB_CSR0, MUSB_CSR0_FLUSHFIFO);
1096 musb_writew(epio, MUSB_CSR0, MUSB_CSR0_FLUSHFIFO);
1097 musb_writew(epio, MUSB_CSR0, 0);
1103 /* call common logic and prepare response */
1104 if (musb_h_ep0_continue(musb, len, urb)) {
1105 /* more packets required */
1106 csr = (MUSB_EP0_IN == musb->ep0_stage)
1107 ? MUSB_CSR0_H_REQPKT : MUSB_CSR0_TXPKTRDY;
1109 /* data transfer complete; perform status phase */
1110 if (usb_pipeout(urb->pipe)
1111 || !urb->transfer_buffer_length)
1112 csr = MUSB_CSR0_H_STATUSPKT
1113 | MUSB_CSR0_H_REQPKT;
1115 csr = MUSB_CSR0_H_STATUSPKT
1116 | MUSB_CSR0_TXPKTRDY;
1118 /* flag status stage */
1119 musb->ep0_stage = MUSB_EP0_STATUS;
1121 DBG(5, "ep0 STATUS, csr %04x\n", csr);
1124 musb_writew(epio, MUSB_CSR0, csr);
1125 retval = IRQ_HANDLED;
1127 musb->ep0_stage = MUSB_EP0_IDLE;
1129 /* call completion handler if done */
1131 musb_advance_schedule(musb, urb, hw_ep, 1);
1137 #ifdef CONFIG_USB_INVENTRA_DMA
1139 /* Host side TX (OUT) using Mentor DMA works as follows:
1141 - if queue was empty, Program Endpoint
1142 - ... which starts DMA to fifo in mode 1 or 0
1144 DMA Isr (transfer complete) -> TxAvail()
1145 - Stop DMA (~DmaEnab) (<--- Alert ... currently happens
1146 only in musb_cleanup_urb)
1147 - TxPktRdy has to be set in mode 0 or for
1148 short packets in mode 1.
1153 /* Service a Tx-Available or dma completion irq for the endpoint */
1154 void musb_host_tx(struct musb *musb, u8 epnum)
1162 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
1163 void __iomem *epio = hw_ep->regs;
1164 struct musb_qh *qh = hw_ep->out_qh;
1166 void __iomem *mbase = musb->mregs;
1167 struct dma_channel *dma;
1171 musb_ep_select(mbase, epnum);
1172 tx_csr = musb_readw(epio, MUSB_TXCSR);
1174 /* with CPPI, DMA sometimes triggers "extra" irqs */
1176 DBG(4, "extra TX%d ready, csr %04x\n", epnum, tx_csr);
1181 dma = is_dma_capable() ? hw_ep->tx_channel : NULL;
1182 DBG(4, "OUT/TX%d end, csr %04x%s\n", epnum, tx_csr,
1183 dma ? ", dma" : "");
1185 /* check for errors */
1186 if (tx_csr & MUSB_TXCSR_H_RXSTALL) {
1187 /* dma was disabled, fifo flushed */
1188 DBG(3, "TX end %d stall\n", epnum);
1190 /* stall; record URB status */
1193 } else if (tx_csr & MUSB_TXCSR_H_ERROR) {
1194 /* (NON-ISO) dma was disabled, fifo flushed */
1195 DBG(3, "TX 3strikes on ep=%d\n", epnum);
1197 status = -ETIMEDOUT;
1199 } else if (tx_csr & MUSB_TXCSR_H_NAKTIMEOUT) {
1200 DBG(6, "TX end=%d device not responding\n", epnum);
1202 /* NOTE: this code path would be a good place to PAUSE a
1203 * transfer, if there's some other (nonperiodic) tx urb
1204 * that could use this fifo. (dma complicates it...)
1206 * if (bulk && qh->ring.next != &musb->out_bulk), then
1207 * we have a candidate... NAKing is *NOT* an error
1209 musb_ep_select(mbase, epnum);
1210 musb_writew(epio, MUSB_TXCSR,
1211 MUSB_TXCSR_H_WZC_BITS
1212 | MUSB_TXCSR_TXPKTRDY);
1217 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1218 dma->status = MUSB_DMA_STATUS_CORE_ABORT;
1219 (void) musb->dma_controller->channel_abort(dma);
1222 /* do the proper sequence to abort the transfer in the
1223 * usb core; the dma engine should already be stopped.
1225 musb_h_tx_flush_fifo(hw_ep);
1226 tx_csr &= ~(MUSB_TXCSR_AUTOSET
1227 | MUSB_TXCSR_DMAENAB
1228 | MUSB_TXCSR_H_ERROR
1229 | MUSB_TXCSR_H_RXSTALL
1230 | MUSB_TXCSR_H_NAKTIMEOUT
1233 musb_ep_select(mbase, epnum);
1234 musb_writew(epio, MUSB_TXCSR, tx_csr);
1235 /* REVISIT may need to clear FLUSHFIFO ... */
1236 musb_writew(epio, MUSB_TXCSR, tx_csr);
1237 musb_writeb(epio, MUSB_TXINTERVAL, 0);
1242 /* second cppi case */
1243 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1244 DBG(4, "extra TX%d ready, csr %04x\n", epnum, tx_csr);
1249 /* REVISIT this looks wrong... */
1250 if (!status || dma || usb_pipeisoc(pipe)) {
1252 wLength = dma->actual_len;
1254 wLength = qh->segsize;
1255 qh->offset += wLength;
1257 if (usb_pipeisoc(pipe)) {
1258 struct usb_iso_packet_descriptor *d;
1260 d = urb->iso_frame_desc + qh->iso_idx;
1261 d->actual_length = qh->segsize;
1262 if (++qh->iso_idx >= urb->number_of_packets) {
1266 buf = urb->transfer_buffer + d->offset;
1267 wLength = d->length;
1272 /* see if we need to send more data, or ZLP */
1273 if (qh->segsize < qh->maxpacket)
1275 else if (qh->offset == urb->transfer_buffer_length
1276 && !(urb->transfer_flags
1280 buf = urb->transfer_buffer
1282 wLength = urb->transfer_buffer_length
1288 /* urb->status != -EINPROGRESS means request has been faulted,
1289 * so we must abort this transfer after cleanup
1291 if (urb->status != -EINPROGRESS) {
1294 status = urb->status;
1299 urb->status = status;
1300 urb->actual_length = qh->offset;
1301 musb_advance_schedule(musb, urb, hw_ep, USB_DIR_OUT);
1303 } else if (!(tx_csr & MUSB_TXCSR_DMAENAB)) {
1304 /* WARN_ON(!buf); */
1306 /* REVISIT: some docs say that when hw_ep->tx_double_buffered,
1307 * (and presumably, fifo is not half-full) we should write TWO
1308 * packets before updating TXCSR ... other docs disagree ...
1310 /* PIO: start next packet in this URB */
1311 wLength = min(qh->maxpacket, (u16) wLength);
1312 musb_write_fifo(hw_ep, wLength, buf);
1313 qh->segsize = wLength;
1315 musb_ep_select(mbase, epnum);
1316 musb_writew(epio, MUSB_TXCSR,
1317 MUSB_TXCSR_H_WZC_BITS | MUSB_TXCSR_TXPKTRDY);
1319 DBG(1, "not complete, but dma enabled?\n");
1326 #ifdef CONFIG_USB_INVENTRA_DMA
1328 /* Host side RX (IN) using Mentor DMA works as follows:
1330 - if queue was empty, ProgramEndpoint
1331 - first IN token is sent out (by setting ReqPkt)
1332 LinuxIsr -> RxReady()
1333 /\ => first packet is received
1334 | - Set in mode 0 (DmaEnab, ~ReqPkt)
1335 | -> DMA Isr (transfer complete) -> RxReady()
1336 | - Ack receive (~RxPktRdy), turn off DMA (~DmaEnab)
1337 | - if urb not complete, send next IN token (ReqPkt)
1338 | | else complete urb.
1340 ---------------------------
1342 * Nuances of mode 1:
1343 * For short packets, no ack (+RxPktRdy) is sent automatically
1344 * (even if AutoClear is ON)
1345 * For full packets, ack (~RxPktRdy) and next IN token (+ReqPkt) is sent
1346 * automatically => major problem, as collecting the next packet becomes
1347 * difficult. Hence mode 1 is not used.
1350 * All we care about at this driver level is that
1351 * (a) all URBs terminate with REQPKT cleared and fifo(s) empty;
1352 * (b) termination conditions are: short RX, or buffer full;
1353 * (c) fault modes include
1354 * - iff URB_SHORT_NOT_OK, short RX status is -EREMOTEIO.
1355 * (and that endpoint's dma queue stops immediately)
1356 * - overflow (full, PLUS more bytes in the terminal packet)
1358 * So for example, usb-storage sets URB_SHORT_NOT_OK, and would
1359 * thus be a great candidate for using mode 1 ... for all but the
1360 * last packet of one URB's transfer.
1366 * Service an RX interrupt for the given IN endpoint; docs cover bulk, iso,
1367 * and high-bandwidth IN transfer cases.
1369 void musb_host_rx(struct musb *musb, u8 epnum)
1372 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
1373 void __iomem *epio = hw_ep->regs;
1374 struct musb_qh *qh = hw_ep->in_qh;
1376 void __iomem *mbase = musb->mregs;
1379 bool iso_err = false;
1382 struct dma_channel *dma;
1384 musb_ep_select(mbase, epnum);
1387 dma = is_dma_capable() ? hw_ep->rx_channel : NULL;
1391 rx_csr = musb_readw(epio, MUSB_RXCSR);
1394 if (unlikely(!urb)) {
1395 /* REVISIT -- THIS SHOULD NEVER HAPPEN ... but, at least
1396 * usbtest #11 (unlinks) triggers it regularly, sometimes
1397 * with fifo full. (Only with DMA??)
1399 DBG(3, "BOGUS RX%d ready, csr %04x, count %d\n", epnum, val,
1400 musb_readw(epio, MUSB_RXCOUNT));
1401 musb_h_flush_rxfifo(hw_ep, MUSB_RXCSR_CLRDATATOG);
1407 DBG(5, "<== hw %d rxcsr %04x, urb actual %d (+dma %zu)\n",
1408 epnum, rx_csr, urb->actual_length,
1409 dma ? dma->actual_len : 0);
1411 /* check for errors, concurrent stall & unlink is not really
1413 if (rx_csr & MUSB_RXCSR_H_RXSTALL) {
1414 DBG(3, "RX end %d STALL\n", epnum);
1416 /* stall; record URB status */
1419 } else if (rx_csr & MUSB_RXCSR_H_ERROR) {
1420 DBG(3, "end %d RX proto error\n", epnum);
1423 musb_writeb(epio, MUSB_RXINTERVAL, 0);
1425 } else if (rx_csr & MUSB_RXCSR_DATAERROR) {
1427 if (USB_ENDPOINT_XFER_ISOC != qh->type) {
1428 /* NOTE this code path would be a good place to PAUSE a
1429 * transfer, if there's some other (nonperiodic) rx urb
1430 * that could use this fifo. (dma complicates it...)
1432 * if (bulk && qh->ring.next != &musb->in_bulk), then
1433 * we have a candidate... NAKing is *NOT* an error
1435 DBG(6, "RX end %d NAK timeout\n", epnum);
1436 musb_ep_select(mbase, epnum);
1437 musb_writew(epio, MUSB_RXCSR,
1438 MUSB_RXCSR_H_WZC_BITS
1439 | MUSB_RXCSR_H_REQPKT);
1443 DBG(4, "RX end %d ISO data error\n", epnum);
1444 /* packet error reported later */
1449 /* faults abort the transfer */
1451 /* clean up dma and collect transfer count */
1452 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1453 dma->status = MUSB_DMA_STATUS_CORE_ABORT;
1454 (void) musb->dma_controller->channel_abort(dma);
1455 xfer_len = dma->actual_len;
1457 musb_h_flush_rxfifo(hw_ep, MUSB_RXCSR_CLRDATATOG);
1458 musb_writeb(epio, MUSB_RXINTERVAL, 0);
1463 if (unlikely(dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY)) {
1464 /* SHOULD NEVER HAPPEN ... but at least DaVinci has done it */
1465 ERR("RX%d dma busy, csr %04x\n", epnum, rx_csr);
1469 /* thorough shutdown for now ... given more precise fault handling
1470 * and better queueing support, we might keep a DMA pipeline going
1471 * while processing this irq for earlier completions.
1474 /* FIXME this is _way_ too much in-line logic for Mentor DMA */
1476 #ifndef CONFIG_USB_INVENTRA_DMA
1477 if (rx_csr & MUSB_RXCSR_H_REQPKT) {
1478 /* REVISIT this happened for a while on some short reads...
1479 * the cleanup still needs investigation... looks bad...
1480 * and also duplicates dma cleanup code above ... plus,
1481 * shouldn't this be the "half full" double buffer case?
1483 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1484 dma->status = MUSB_DMA_STATUS_CORE_ABORT;
1485 (void) musb->dma_controller->channel_abort(dma);
1486 xfer_len = dma->actual_len;
1490 DBG(2, "RXCSR%d %04x, reqpkt, len %zu%s\n", epnum, rx_csr,
1491 xfer_len, dma ? ", dma" : "");
1492 rx_csr &= ~MUSB_RXCSR_H_REQPKT;
1494 musb_ep_select(mbase, epnum);
1495 musb_writew(epio, MUSB_RXCSR,
1496 MUSB_RXCSR_H_WZC_BITS | rx_csr);
1499 if (dma && (rx_csr & MUSB_RXCSR_DMAENAB)) {
1500 xfer_len = dma->actual_len;
1502 val &= ~(MUSB_RXCSR_DMAENAB
1503 | MUSB_RXCSR_H_AUTOREQ
1504 | MUSB_RXCSR_AUTOCLEAR
1505 | MUSB_RXCSR_RXPKTRDY);
1506 musb_writew(hw_ep->regs, MUSB_RXCSR, val);
1508 #ifdef CONFIG_USB_INVENTRA_DMA
1509 if (usb_pipeisoc(pipe)) {
1510 struct usb_iso_packet_descriptor *d;
1512 d = urb->iso_frame_desc + qh->iso_idx;
1513 d->actual_length = xfer_len;
1515 /* even if there was an error, we did the dma
1516 * for iso_frame_desc->length
1518 if (d->status != EILSEQ && d->status != -EOVERFLOW)
1521 if (++qh->iso_idx >= urb->number_of_packets)
1527 /* done if urb buffer is full or short packet is recd */
1528 done = (urb->actual_length + xfer_len >=
1529 urb->transfer_buffer_length
1530 || dma->actual_len < qh->maxpacket);
1533 /* send IN token for next packet, without AUTOREQ */
1535 val |= MUSB_RXCSR_H_REQPKT;
1536 musb_writew(epio, MUSB_RXCSR,
1537 MUSB_RXCSR_H_WZC_BITS | val);
1540 DBG(4, "ep %d dma %s, rxcsr %04x, rxcount %d\n", epnum,
1541 done ? "off" : "reset",
1542 musb_readw(epio, MUSB_RXCSR),
1543 musb_readw(epio, MUSB_RXCOUNT));
1547 } else if (urb->status == -EINPROGRESS) {
1548 /* if no errors, be sure a packet is ready for unloading */
1549 if (unlikely(!(rx_csr & MUSB_RXCSR_RXPKTRDY))) {
1551 ERR("Rx interrupt with no errors or packet!\n");
1553 /* FIXME this is another "SHOULD NEVER HAPPEN" */
1556 /* do the proper sequence to abort the transfer */
1557 musb_ep_select(mbase, epnum);
1558 val &= ~MUSB_RXCSR_H_REQPKT;
1559 musb_writew(epio, MUSB_RXCSR, val);
1563 /* we are expecting IN packets */
1564 #ifdef CONFIG_USB_INVENTRA_DMA
1566 struct dma_controller *c;
1571 rx_count = musb_readw(epio, MUSB_RXCOUNT);
1573 DBG(2, "RX%d count %d, buffer 0x%x len %d/%d\n",
1576 + urb->actual_length,
1578 urb->transfer_buffer_length);
1580 c = musb->dma_controller;
1582 if (usb_pipeisoc(pipe)) {
1584 struct usb_iso_packet_descriptor *d;
1586 d = urb->iso_frame_desc + qh->iso_idx;
1592 if (rx_count > d->length) {
1594 status = -EOVERFLOW;
1597 DBG(2, "** OVERFLOW %d into %d\n",\
1598 rx_count, d->length);
1604 buf = urb->transfer_dma + d->offset;
1607 buf = urb->transfer_dma +
1611 dma->desired_mode = 0;
1613 /* because of the issue below, mode 1 will
1614 * only rarely behave with correct semantics.
1616 if ((urb->transfer_flags &
1618 && (urb->transfer_buffer_length -
1621 dma->desired_mode = 1;
1622 if (rx_count < hw_ep->max_packet_sz_rx) {
1624 dma->bDesiredMode = 0;
1626 length = urb->transfer_buffer_length;
1630 /* Disadvantage of using mode 1:
1631 * It's basically usable only for mass storage class; essentially all
1632 * other protocols also terminate transfers on short packets.
1635 * An extra IN token is sent at the end of the transfer (due to AUTOREQ)
1636 * If you try to use mode 1 for (transfer_buffer_length - 512), and try
1637 * to use the extra IN token to grab the last packet using mode 0, then
1638 * the problem is that you cannot be sure when the device will send the
1639 * last packet and RxPktRdy set. Sometimes the packet is recd too soon
1640 * such that it gets lost when RxCSR is re-set at the end of the mode 1
1641 * transfer, while sometimes it is recd just a little late so that if you
1642 * try to configure for mode 0 soon after the mode 1 transfer is
1643 * completed, you will find rxcount 0. Okay, so you might think why not
1644 * wait for an interrupt when the pkt is recd. Well, you won't get any!
1647 val = musb_readw(epio, MUSB_RXCSR);
1648 val &= ~MUSB_RXCSR_H_REQPKT;
1650 if (dma->desired_mode == 0)
1651 val &= ~MUSB_RXCSR_H_AUTOREQ;
1653 val |= MUSB_RXCSR_H_AUTOREQ;
1654 val |= MUSB_RXCSR_AUTOCLEAR | MUSB_RXCSR_DMAENAB;
1656 musb_writew(epio, MUSB_RXCSR,
1657 MUSB_RXCSR_H_WZC_BITS | val);
1659 /* REVISIT if when actual_length != 0,
1660 * transfer_buffer_length needs to be
1663 ret = c->channel_program(
1665 dma->desired_mode, buf, length);
1668 c->channel_release(dma);
1669 hw_ep->rx_channel = NULL;
1671 /* REVISIT reset CSR */
1674 #endif /* Mentor DMA */
1677 done = musb_host_packet_rx(musb, urb,
1679 DBG(6, "read %spacket\n", done ? "last " : "");
1684 urb->actual_length += xfer_len;
1685 qh->offset += xfer_len;
1687 if (urb->status == -EINPROGRESS)
1688 urb->status = status;
1689 musb_advance_schedule(musb, urb, hw_ep, USB_DIR_IN);
1693 /* schedule nodes correspond to peripheral endpoints, like an OHCI QH.
1694 * the software schedule associates multiple such nodes with a given
1695 * host side hardware endpoint + direction; scheduling may activate
1696 * that hardware endpoint.
1698 static int musb_schedule(
1705 int best_end, epnum;
1706 struct musb_hw_ep *hw_ep = NULL;
1707 struct list_head *head = NULL;
1709 /* use fixed hardware for control and bulk */
1710 if (qh->type == USB_ENDPOINT_XFER_CONTROL) {
1711 head = &musb->control;
1712 hw_ep = musb->control_ep;
1716 /* else, periodic transfers get muxed to other endpoints */
1718 /* FIXME this doesn't consider direction, so it can only
1719 * work for one half of the endpoint hardware, and assumes
1720 * the previous cases handled all non-shared endpoints...
1723 /* we know this qh hasn't been scheduled, so all we need to do
1724 * is choose which hardware endpoint to put it on ...
1726 * REVISIT what we really want here is a regular schedule tree
1727 * like e.g. OHCI uses, but for now musb->periodic is just an
1728 * array of the _single_ logical endpoint associated with a
1729 * given physical one (identity mapping logical->physical).
1731 * that simplistic approach makes TT scheduling a lot simpler;
1732 * there is none, and thus none of its complexity...
1737 for (epnum = 1; epnum < musb->nr_endpoints; epnum++) {
1740 if (musb->periodic[epnum])
1742 hw_ep = &musb->endpoints[epnum];
1743 if (hw_ep == musb->bulk_ep)
1747 diff = hw_ep->max_packet_sz_rx - qh->maxpacket;
1749 diff = hw_ep->max_packet_sz_tx - qh->maxpacket;
1751 if (diff >= 0 && best_diff > diff) {
1756 /* use bulk reserved ep1 if no other ep is free */
1757 if (best_end < 0 && qh->type == USB_ENDPOINT_XFER_BULK) {
1758 hw_ep = musb->bulk_ep;
1760 head = &musb->in_bulk;
1762 head = &musb->out_bulk;
1764 } else if (best_end < 0) {
1770 hw_ep = musb->endpoints + best_end;
1771 musb->periodic[best_end] = qh;
1772 DBG(4, "qh %p periodic slot %d\n", qh, best_end);
1775 idle = list_empty(head);
1776 list_add_tail(&qh->ring, head);
1780 qh->hep->hcpriv = qh;
1782 musb_start_urb(musb, is_in, qh);
1786 static int musb_urb_enqueue(
1787 struct usb_hcd *hcd,
1791 unsigned long flags;
1792 struct musb *musb = hcd_to_musb(hcd);
1793 struct usb_host_endpoint *hep = urb->ep;
1794 struct musb_qh *qh = hep->hcpriv;
1795 struct usb_endpoint_descriptor *epd = &hep->desc;
1800 /* host role must be active */
1801 if (!is_host_active(musb) || !musb->is_active)
1804 spin_lock_irqsave(&musb->lock, flags);
1805 ret = usb_hcd_link_urb_to_ep(hcd, urb);
1806 spin_unlock_irqrestore(&musb->lock, flags);
1810 /* DMA mapping was already done, if needed, and this urb is on
1811 * hep->urb_list ... so there's little to do unless hep wasn't
1812 * yet scheduled onto a live qh.
1814 * REVISIT best to keep hep->hcpriv valid until the endpoint gets
1815 * disabled, testing for empty qh->ring and avoiding qh setup costs
1816 * except for the first urb queued after a config change.
1823 /* Allocate and initialize qh, minimizing the work done each time
1824 * hw_ep gets reprogrammed, or with irqs blocked. Then schedule it.
1826 * REVISIT consider a dedicated qh kmem_cache, so it's harder
1827 * for bugs in other kernel code to break this driver...
1829 qh = kzalloc(sizeof *qh, mem_flags);
1831 spin_lock_irqsave(&musb->lock, flags);
1832 usb_hcd_unlink_urb_from_ep(hcd, urb);
1833 spin_unlock_irqrestore(&musb->lock, flags);
1839 INIT_LIST_HEAD(&qh->ring);
1842 qh->maxpacket = le16_to_cpu(epd->wMaxPacketSize);
1844 /* no high bandwidth support yet */
1845 if (qh->maxpacket & ~0x7ff) {
1850 qh->epnum = epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
1851 qh->type = epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
1853 /* NOTE: urb->dev->devnum is wrong during SET_ADDRESS */
1854 qh->addr_reg = (u8) usb_pipedevice(urb->pipe);
1856 /* precompute rxtype/txtype/type0 register */
1857 type_reg = (qh->type << 4) | qh->epnum;
1858 switch (urb->dev->speed) {
1862 case USB_SPEED_FULL:
1868 qh->type_reg = type_reg;
1870 /* precompute rxinterval/txinterval register */
1871 interval = min((u8)16, epd->bInterval); /* log encoding */
1873 case USB_ENDPOINT_XFER_INT:
1874 /* fullspeed uses linear encoding */
1875 if (USB_SPEED_FULL == urb->dev->speed) {
1876 interval = epd->bInterval;
1881 case USB_ENDPOINT_XFER_ISOC:
1882 /* iso always uses log encoding */
1885 /* REVISIT we actually want to use NAK limits, hinting to the
1886 * transfer scheduling logic to try some other qh, e.g. try
1889 * interval = (USB_SPEED_HIGH == urb->dev->speed) ? 16 : 2;
1891 * The downside of disabling this is that transfer scheduling
1892 * gets VERY unfair for nonperiodic transfers; a misbehaving
1893 * peripheral could make that hurt. Or for reads, one that's
1894 * perfectly normal: network and other drivers keep reads
1895 * posted at all times, having one pending for a week should
1896 * be perfectly safe.
1898 * The upside of disabling it is avoidng transfer scheduling
1899 * code to put this aside for while.
1903 qh->intv_reg = interval;
1905 /* precompute addressing for external hub/tt ports */
1906 if (musb->is_multipoint) {
1907 struct usb_device *parent = urb->dev->parent;
1909 if (parent != hcd->self.root_hub) {
1910 qh->h_addr_reg = (u8) parent->devnum;
1912 /* set up tt info if needed */
1914 qh->h_port_reg = (u8) urb->dev->ttport;
1915 if (urb->dev->tt->hub)
1917 (u8) urb->dev->tt->hub->devnum;
1918 if (urb->dev->tt->multi)
1919 qh->h_addr_reg |= 0x80;
1924 /* invariant: hep->hcpriv is null OR the qh that's already scheduled.
1925 * until we get real dma queues (with an entry for each urb/buffer),
1926 * we only have work to do in the former case.
1928 spin_lock_irqsave(&musb->lock, flags);
1930 /* some concurrent activity submitted another urb to hep...
1931 * odd, rare, error prone, but legal.
1936 ret = musb_schedule(musb, qh,
1937 epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK);
1941 /* FIXME set urb->start_frame for iso/intr, it's tested in
1942 * musb_start_urb(), but otherwise only konicawc cares ...
1945 spin_unlock_irqrestore(&musb->lock, flags);
1949 spin_lock_irqsave(&musb->lock, flags);
1950 usb_hcd_unlink_urb_from_ep(hcd, urb);
1951 spin_unlock_irqrestore(&musb->lock, flags);
1959 * abort a transfer that's at the head of a hardware queue.
1960 * called with controller locked, irqs blocked
1961 * that hardware queue advances to the next transfer, unless prevented
1963 static int musb_cleanup_urb(struct urb *urb, struct musb_qh *qh, int is_in)
1965 struct musb_hw_ep *ep = qh->hw_ep;
1966 void __iomem *epio = ep->regs;
1967 unsigned hw_end = ep->epnum;
1968 void __iomem *regs = ep->musb->mregs;
1972 musb_ep_select(regs, hw_end);
1974 if (is_dma_capable()) {
1975 struct dma_channel *dma;
1977 dma = is_in ? ep->rx_channel : ep->tx_channel;
1979 status = ep->musb->dma_controller->channel_abort(dma);
1981 "abort %cX%d DMA for urb %p --> %d\n",
1982 is_in ? 'R' : 'T', ep->epnum,
1984 urb->actual_length += dma->actual_len;
1988 /* turn off DMA requests, discard state, stop polling ... */
1990 /* giveback saves bulk toggle */
1991 csr = musb_h_flush_rxfifo(ep, 0);
1993 /* REVISIT we still get an irq; should likely clear the
1994 * endpoint's irq status here to avoid bogus irqs.
1995 * clearing that status is platform-specific...
1998 musb_h_tx_flush_fifo(ep);
1999 csr = musb_readw(epio, MUSB_TXCSR);
2000 csr &= ~(MUSB_TXCSR_AUTOSET
2001 | MUSB_TXCSR_DMAENAB
2002 | MUSB_TXCSR_H_RXSTALL
2003 | MUSB_TXCSR_H_NAKTIMEOUT
2004 | MUSB_TXCSR_H_ERROR
2005 | MUSB_TXCSR_TXPKTRDY);
2006 musb_writew(epio, MUSB_TXCSR, csr);
2007 /* REVISIT may need to clear FLUSHFIFO ... */
2008 musb_writew(epio, MUSB_TXCSR, csr);
2009 /* flush cpu writebuffer */
2010 csr = musb_readw(epio, MUSB_TXCSR);
2013 musb_advance_schedule(ep->musb, urb, ep, is_in);
2017 static int musb_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
2019 struct musb *musb = hcd_to_musb(hcd);
2021 struct list_head *sched;
2022 unsigned long flags;
2025 DBG(4, "urb=%p, dev%d ep%d%s\n", urb,
2026 usb_pipedevice(urb->pipe),
2027 usb_pipeendpoint(urb->pipe),
2028 usb_pipein(urb->pipe) ? "in" : "out");
2030 spin_lock_irqsave(&musb->lock, flags);
2031 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
2039 /* Any URB not actively programmed into endpoint hardware can be
2040 * immediately given back. Such an URB must be at the head of its
2041 * endpoint queue, unless someday we get real DMA queues. And even
2042 * then, it might not be known to the hardware...
2044 * Otherwise abort current transfer, pending dma, etc.; urb->status
2045 * has already been updated. This is a synchronous abort; it'd be
2046 * OK to hold off until after some IRQ, though.
2048 if (!qh->is_ready || urb->urb_list.prev != &qh->hep->urb_list)
2052 case USB_ENDPOINT_XFER_CONTROL:
2053 sched = &musb->control;
2055 case USB_ENDPOINT_XFER_BULK:
2057 if (usb_pipein(urb->pipe))
2058 sched = &musb->in_bulk;
2060 sched = &musb->out_bulk;
2064 /* REVISIT when we get a schedule tree, periodic
2065 * transfers won't always be at the head of a
2066 * singleton queue...
2073 /* NOTE: qh is invalid unless !list_empty(&hep->urb_list) */
2074 if (ret < 0 || (sched && qh != first_qh(sched))) {
2075 int ready = qh->is_ready;
2079 __musb_giveback(musb, urb, 0);
2080 qh->is_ready = ready;
2082 ret = musb_cleanup_urb(urb, qh, urb->pipe & USB_DIR_IN);
2084 spin_unlock_irqrestore(&musb->lock, flags);
2088 /* disable an endpoint */
2090 musb_h_disable(struct usb_hcd *hcd, struct usb_host_endpoint *hep)
2092 u8 epnum = hep->desc.bEndpointAddress;
2093 unsigned long flags;
2094 struct musb *musb = hcd_to_musb(hcd);
2095 u8 is_in = epnum & USB_DIR_IN;
2096 struct musb_qh *qh = hep->hcpriv;
2097 struct urb *urb, *tmp;
2098 struct list_head *sched;
2103 spin_lock_irqsave(&musb->lock, flags);
2106 case USB_ENDPOINT_XFER_CONTROL:
2107 sched = &musb->control;
2109 case USB_ENDPOINT_XFER_BULK:
2112 sched = &musb->in_bulk;
2114 sched = &musb->out_bulk;
2118 /* REVISIT when we get a schedule tree, periodic transfers
2119 * won't always be at the head of a singleton queue...
2125 /* NOTE: qh is invalid unless !list_empty(&hep->urb_list) */
2127 /* kick first urb off the hardware, if needed */
2129 if (!sched || qh == first_qh(sched)) {
2132 /* make software (then hardware) stop ASAP */
2134 urb->status = -ESHUTDOWN;
2137 musb_cleanup_urb(urb, qh, urb->pipe & USB_DIR_IN);
2141 /* then just nuke all the others */
2142 list_for_each_entry_safe_from(urb, tmp, &hep->urb_list, urb_list)
2143 musb_giveback(qh, urb, -ESHUTDOWN);
2145 spin_unlock_irqrestore(&musb->lock, flags);
2148 static int musb_h_get_frame_number(struct usb_hcd *hcd)
2150 struct musb *musb = hcd_to_musb(hcd);
2152 return musb_readw(musb->mregs, MUSB_FRAME);
2155 static int musb_h_start(struct usb_hcd *hcd)
2157 struct musb *musb = hcd_to_musb(hcd);
2159 /* NOTE: musb_start() is called when the hub driver turns
2160 * on port power, or when (OTG) peripheral starts.
2162 hcd->state = HC_STATE_RUNNING;
2163 musb->port1_status = 0;
2167 static void musb_h_stop(struct usb_hcd *hcd)
2169 musb_stop(hcd_to_musb(hcd));
2170 hcd->state = HC_STATE_HALT;
2173 static int musb_bus_suspend(struct usb_hcd *hcd)
2175 struct musb *musb = hcd_to_musb(hcd);
2177 if (musb->xceiv.state == OTG_STATE_A_SUSPEND)
2180 if (is_host_active(musb) && musb->is_active) {
2181 WARNING("trying to suspend as %s is_active=%i\n",
2182 otg_state_string(musb), musb->is_active);
2188 static int musb_bus_resume(struct usb_hcd *hcd)
2190 /* resuming child port does the work */
2194 const struct hc_driver musb_hc_driver = {
2195 .description = "musb-hcd",
2196 .product_desc = "MUSB HDRC host driver",
2197 .hcd_priv_size = sizeof(struct musb),
2198 .flags = HCD_USB2 | HCD_MEMORY,
2200 /* not using irq handler or reset hooks from usbcore, since
2201 * those must be shared with peripheral code for OTG configs
2204 .start = musb_h_start,
2205 .stop = musb_h_stop,
2207 .get_frame_number = musb_h_get_frame_number,
2209 .urb_enqueue = musb_urb_enqueue,
2210 .urb_dequeue = musb_urb_dequeue,
2211 .endpoint_disable = musb_h_disable,
2213 .hub_status_data = musb_hub_status_data,
2214 .hub_control = musb_hub_control,
2215 .bus_suspend = musb_bus_suspend,
2216 .bus_resume = musb_bus_resume,
2217 /* .start_port_reset = NULL, */
2218 /* .hub_irq_enable = NULL, */