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
7 * Copyright (C) 2008-2009 MontaVista Software, Inc. <source@mvista.com>
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * version 2 as published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
23 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
26 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
29 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 #include <linux/module.h>
37 #include <linux/kernel.h>
38 #include <linux/delay.h>
39 #include <linux/sched.h>
40 #include <linux/slab.h>
41 #include <linux/errno.h>
42 #include <linux/init.h>
43 #include <linux/list.h>
44 #include <linux/dma-mapping.h>
46 #include "musb_core.h"
47 #include "musb_host.h"
50 /* MUSB HOST status 22-mar-2006
52 * - There's still lots of partial code duplication for fault paths, so
53 * they aren't handled as consistently as they need to be.
55 * - PIO mostly behaved when last tested.
56 * + including ep0, with all usbtest cases 9, 10
57 * + usbtest 14 (ep0out) doesn't seem to run at all
58 * + double buffered OUT/TX endpoints saw stalls(!) with certain usbtest
59 * configurations, but otherwise double buffering passes basic tests.
60 * + for 2.6.N, for N > ~10, needs API changes for hcd framework.
62 * - DMA (CPPI) ... partially behaves, not currently recommended
63 * + about 1/15 the speed of typical EHCI implementations (PCI)
64 * + RX, all too often reqpkt seems to misbehave after tx
65 * + TX, no known issues (other than evident silicon issue)
67 * - DMA (Mentor/OMAP) ...has at least toggle update problems
69 * - [23-feb-2009] minimal traffic scheduling to avoid bulk RX packet
70 * starvation ... nothing yet for TX, interrupt, or bulk.
72 * - Not tested with HNP, but some SRP paths seem to behave.
74 * NOTE 24-August-2006:
76 * - Bulk traffic finally uses both sides of hardware ep1, freeing up an
77 * extra endpoint for periodic use enabling hub + keybd + mouse. That
78 * mostly works, except that with "usbnet" it's easy to trigger cases
79 * with "ping" where RX loses. (a) ping to davinci, even "ping -f",
80 * fine; but (b) ping _from_ davinci, even "ping -c 1", ICMP RX loses
81 * although ARP RX wins. (That test was done with a full speed link.)
86 * NOTE on endpoint usage:
88 * CONTROL transfers all go through ep0. BULK ones go through dedicated IN
89 * and OUT endpoints ... hardware is dedicated for those "async" queue(s).
90 * (Yes, bulk _could_ use more of the endpoints than that, and would even
93 * INTERUPPT and ISOCHRONOUS transfers are scheduled to the other endpoints.
94 * So far that scheduling is both dumb and optimistic: the endpoint will be
95 * "claimed" until its software queue is no longer refilled. No multiplexing
96 * of transfers between endpoints, or anything clever.
100 static void musb_ep_program(struct musb *musb, u8 epnum,
101 struct urb *urb, int is_out,
102 u8 *buf, u32 offset, u32 len);
105 * Clear TX fifo. Needed to avoid BABBLE errors.
107 static void musb_h_tx_flush_fifo(struct musb_hw_ep *ep)
109 struct musb *musb = ep->musb;
110 void __iomem *epio = ep->regs;
115 csr = musb_readw(epio, MUSB_TXCSR);
116 while (csr & MUSB_TXCSR_FIFONOTEMPTY) {
118 dev_dbg(musb->controller, "Host TX FIFONOTEMPTY csr: %02x\n", csr);
120 csr |= MUSB_TXCSR_FLUSHFIFO;
121 musb_writew(epio, MUSB_TXCSR, csr);
122 csr = musb_readw(epio, MUSB_TXCSR);
123 if (WARN(retries-- < 1,
124 "Could not flush host TX%d fifo: csr: %04x\n",
131 static void musb_h_ep0_flush_fifo(struct musb_hw_ep *ep)
133 void __iomem *epio = ep->regs;
137 /* scrub any data left in the fifo */
139 csr = musb_readw(epio, MUSB_TXCSR);
140 if (!(csr & (MUSB_CSR0_TXPKTRDY | MUSB_CSR0_RXPKTRDY)))
142 musb_writew(epio, MUSB_TXCSR, MUSB_CSR0_FLUSHFIFO);
143 csr = musb_readw(epio, MUSB_TXCSR);
147 WARN(!retries, "Could not flush host TX%d fifo: csr: %04x\n",
150 /* and reset for the next transfer */
151 musb_writew(epio, MUSB_TXCSR, 0);
155 * Start transmit. Caller is responsible for locking shared resources.
156 * musb must be locked.
158 static inline void musb_h_tx_start(struct musb_hw_ep *ep)
162 /* NOTE: no locks here; caller should lock and select EP */
164 txcsr = musb_readw(ep->regs, MUSB_TXCSR);
165 txcsr |= MUSB_TXCSR_TXPKTRDY | MUSB_TXCSR_H_WZC_BITS;
166 musb_writew(ep->regs, MUSB_TXCSR, txcsr);
168 txcsr = MUSB_CSR0_H_SETUPPKT | MUSB_CSR0_TXPKTRDY;
169 musb_writew(ep->regs, MUSB_CSR0, txcsr);
174 static inline void musb_h_tx_dma_start(struct musb_hw_ep *ep)
178 /* NOTE: no locks here; caller should lock and select EP */
179 txcsr = musb_readw(ep->regs, MUSB_TXCSR);
180 txcsr |= MUSB_TXCSR_DMAENAB | MUSB_TXCSR_H_WZC_BITS;
181 if (is_cppi_enabled())
182 txcsr |= MUSB_TXCSR_DMAMODE;
183 musb_writew(ep->regs, MUSB_TXCSR, txcsr);
186 static void musb_ep_set_qh(struct musb_hw_ep *ep, int is_in, struct musb_qh *qh)
188 if (is_in != 0 || ep->is_shared_fifo)
190 if (is_in == 0 || ep->is_shared_fifo)
194 static struct musb_qh *musb_ep_get_qh(struct musb_hw_ep *ep, int is_in)
196 return is_in ? ep->in_qh : ep->out_qh;
200 * Start the URB at the front of an endpoint's queue
201 * end must be claimed from the caller.
203 * Context: controller locked, irqs blocked
206 musb_start_urb(struct musb *musb, int is_in, struct musb_qh *qh)
210 void __iomem *mbase = musb->mregs;
211 struct urb *urb = next_urb(qh);
212 void *buf = urb->transfer_buffer;
214 struct musb_hw_ep *hw_ep = qh->hw_ep;
215 unsigned pipe = urb->pipe;
216 u8 address = usb_pipedevice(pipe);
217 int epnum = hw_ep->epnum;
219 /* initialize software qh state */
223 /* gather right source of data */
225 case USB_ENDPOINT_XFER_CONTROL:
226 /* control transfers always start with SETUP */
228 musb->ep0_stage = MUSB_EP0_START;
229 buf = urb->setup_packet;
232 case USB_ENDPOINT_XFER_ISOC:
235 offset = urb->iso_frame_desc[0].offset;
236 len = urb->iso_frame_desc[0].length;
238 default: /* bulk, interrupt */
239 /* actual_length may be nonzero on retry paths */
240 buf = urb->transfer_buffer + urb->actual_length;
241 len = urb->transfer_buffer_length - urb->actual_length;
244 dev_dbg(musb->controller, "qh %p urb %p dev%d ep%d%s%s, hw_ep %d, %p/%d\n",
245 qh, urb, address, qh->epnum,
246 is_in ? "in" : "out",
247 ({char *s; switch (qh->type) {
248 case USB_ENDPOINT_XFER_CONTROL: s = ""; break;
249 case USB_ENDPOINT_XFER_BULK: s = "-bulk"; break;
250 case USB_ENDPOINT_XFER_ISOC: s = "-iso"; break;
251 default: s = "-intr"; break;
253 epnum, buf + offset, len);
255 /* Configure endpoint */
256 musb_ep_set_qh(hw_ep, is_in, qh);
257 musb_ep_program(musb, epnum, urb, !is_in, buf, offset, len);
259 /* transmit may have more work: start it when it is time */
263 /* determine if the time is right for a periodic transfer */
265 case USB_ENDPOINT_XFER_ISOC:
266 case USB_ENDPOINT_XFER_INT:
267 dev_dbg(musb->controller, "check whether there's still time for periodic Tx\n");
268 frame = musb_readw(mbase, MUSB_FRAME);
269 /* FIXME this doesn't implement that scheduling policy ...
270 * or handle framecounter wrapping
272 if ((urb->transfer_flags & URB_ISO_ASAP)
273 || (frame >= urb->start_frame)) {
274 /* REVISIT the SOF irq handler shouldn't duplicate
275 * this code; and we don't init urb->start_frame...
280 qh->frame = urb->start_frame;
281 /* enable SOF interrupt so we can count down */
282 dev_dbg(musb->controller, "SOF for %d\n", epnum);
283 #if 1 /* ifndef CONFIG_ARCH_DAVINCI */
284 musb_writeb(mbase, MUSB_INTRUSBE, 0xff);
290 dev_dbg(musb->controller, "Start TX%d %s\n", epnum,
291 hw_ep->tx_channel ? "dma" : "pio");
293 if (!hw_ep->tx_channel)
294 musb_h_tx_start(hw_ep);
295 else if (is_cppi_enabled() || tusb_dma_omap())
296 musb_h_tx_dma_start(hw_ep);
300 /* Context: caller owns controller lock, IRQs are blocked */
301 static void musb_giveback(struct musb *musb, struct urb *urb, int status)
302 __releases(musb->lock)
303 __acquires(musb->lock)
305 dev_dbg(musb->controller,
306 "complete %p %pF (%d), dev%d ep%d%s, %d/%d\n",
307 urb, urb->complete, status,
308 usb_pipedevice(urb->pipe),
309 usb_pipeendpoint(urb->pipe),
310 usb_pipein(urb->pipe) ? "in" : "out",
311 urb->actual_length, urb->transfer_buffer_length
314 usb_hcd_unlink_urb_from_ep(musb_to_hcd(musb), urb);
315 spin_unlock(&musb->lock);
316 usb_hcd_giveback_urb(musb_to_hcd(musb), urb, status);
317 spin_lock(&musb->lock);
320 /* For bulk/interrupt endpoints only */
321 static inline void musb_save_toggle(struct musb_qh *qh, int is_in,
324 void __iomem *epio = qh->hw_ep->regs;
328 * FIXME: the current Mentor DMA code seems to have
329 * problems getting toggle correct.
333 csr = musb_readw(epio, MUSB_RXCSR) & MUSB_RXCSR_H_DATATOGGLE;
335 csr = musb_readw(epio, MUSB_TXCSR) & MUSB_TXCSR_H_DATATOGGLE;
337 usb_settoggle(urb->dev, qh->epnum, !is_in, csr ? 1 : 0);
341 * Advance this hardware endpoint's queue, completing the specified URB and
342 * advancing to either the next URB queued to that qh, or else invalidating
343 * that qh and advancing to the next qh scheduled after the current one.
345 * Context: caller owns controller lock, IRQs are blocked
347 static void musb_advance_schedule(struct musb *musb, struct urb *urb,
348 struct musb_hw_ep *hw_ep, int is_in)
350 struct musb_qh *qh = musb_ep_get_qh(hw_ep, is_in);
351 struct musb_hw_ep *ep = qh->hw_ep;
352 int ready = qh->is_ready;
355 status = (urb->status == -EINPROGRESS) ? 0 : urb->status;
357 /* save toggle eagerly, for paranoia */
359 case USB_ENDPOINT_XFER_BULK:
360 case USB_ENDPOINT_XFER_INT:
361 musb_save_toggle(qh, is_in, urb);
363 case USB_ENDPOINT_XFER_ISOC:
364 if (status == 0 && urb->error_count)
370 musb_giveback(musb, urb, status);
371 qh->is_ready = ready;
373 /* reclaim resources (and bandwidth) ASAP; deschedule it, and
374 * invalidate qh as soon as list_empty(&hep->urb_list)
376 if (list_empty(&qh->hep->urb_list)) {
377 struct list_head *head;
378 struct dma_controller *dma = musb->dma_controller;
382 if (ep->rx_channel) {
383 dma->channel_release(ep->rx_channel);
384 ep->rx_channel = NULL;
388 if (ep->tx_channel) {
389 dma->channel_release(ep->tx_channel);
390 ep->tx_channel = NULL;
394 /* Clobber old pointers to this qh */
395 musb_ep_set_qh(ep, is_in, NULL);
396 qh->hep->hcpriv = NULL;
400 case USB_ENDPOINT_XFER_CONTROL:
401 case USB_ENDPOINT_XFER_BULK:
402 /* fifo policy for these lists, except that NAKing
403 * should rotate a qh to the end (for fairness).
406 head = qh->ring.prev;
413 case USB_ENDPOINT_XFER_ISOC:
414 case USB_ENDPOINT_XFER_INT:
415 /* this is where periodic bandwidth should be
416 * de-allocated if it's tracked and allocated;
417 * and where we'd update the schedule tree...
425 if (qh != NULL && qh->is_ready) {
426 dev_dbg(musb->controller, "... next ep%d %cX urb %p\n",
427 hw_ep->epnum, is_in ? 'R' : 'T', next_urb(qh));
428 musb_start_urb(musb, is_in, qh);
432 static u16 musb_h_flush_rxfifo(struct musb_hw_ep *hw_ep, u16 csr)
434 /* we don't want fifo to fill itself again;
435 * ignore dma (various models),
436 * leave toggle alone (may not have been saved yet)
438 csr |= MUSB_RXCSR_FLUSHFIFO | MUSB_RXCSR_RXPKTRDY;
439 csr &= ~(MUSB_RXCSR_H_REQPKT
440 | MUSB_RXCSR_H_AUTOREQ
441 | MUSB_RXCSR_AUTOCLEAR);
443 /* write 2x to allow double buffering */
444 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
445 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
447 /* flush writebuffer */
448 return musb_readw(hw_ep->regs, MUSB_RXCSR);
452 * PIO RX for a packet (or part of it).
455 musb_host_packet_rx(struct musb *musb, struct urb *urb, u8 epnum, u8 iso_err)
463 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
464 void __iomem *epio = hw_ep->regs;
465 struct musb_qh *qh = hw_ep->in_qh;
466 int pipe = urb->pipe;
467 void *buffer = urb->transfer_buffer;
469 /* musb_ep_select(mbase, epnum); */
470 rx_count = musb_readw(epio, MUSB_RXCOUNT);
471 dev_dbg(musb->controller, "RX%d count %d, buffer %p len %d/%d\n", epnum, rx_count,
472 urb->transfer_buffer, qh->offset,
473 urb->transfer_buffer_length);
476 if (usb_pipeisoc(pipe)) {
478 struct usb_iso_packet_descriptor *d;
485 d = urb->iso_frame_desc + qh->iso_idx;
486 buf = buffer + d->offset;
488 if (rx_count > length) {
493 dev_dbg(musb->controller, "** OVERFLOW %d into %d\n", rx_count, length);
497 urb->actual_length += length;
498 d->actual_length = length;
502 /* see if we are done */
503 done = (++qh->iso_idx >= urb->number_of_packets);
506 buf = buffer + qh->offset;
507 length = urb->transfer_buffer_length - qh->offset;
508 if (rx_count > length) {
509 if (urb->status == -EINPROGRESS)
510 urb->status = -EOVERFLOW;
511 dev_dbg(musb->controller, "** OVERFLOW %d into %d\n", rx_count, length);
515 urb->actual_length += length;
516 qh->offset += length;
518 /* see if we are done */
519 done = (urb->actual_length == urb->transfer_buffer_length)
520 || (rx_count < qh->maxpacket)
521 || (urb->status != -EINPROGRESS);
523 && (urb->status == -EINPROGRESS)
524 && (urb->transfer_flags & URB_SHORT_NOT_OK)
525 && (urb->actual_length
526 < urb->transfer_buffer_length))
527 urb->status = -EREMOTEIO;
530 musb_read_fifo(hw_ep, length, buf);
532 csr = musb_readw(epio, MUSB_RXCSR);
533 csr |= MUSB_RXCSR_H_WZC_BITS;
534 if (unlikely(do_flush))
535 musb_h_flush_rxfifo(hw_ep, csr);
537 /* REVISIT this assumes AUTOCLEAR is never set */
538 csr &= ~(MUSB_RXCSR_RXPKTRDY | MUSB_RXCSR_H_REQPKT);
540 csr |= MUSB_RXCSR_H_REQPKT;
541 musb_writew(epio, MUSB_RXCSR, csr);
547 /* we don't always need to reinit a given side of an endpoint...
548 * when we do, use tx/rx reinit routine and then construct a new CSR
549 * to address data toggle, NYET, and DMA or PIO.
551 * it's possible that driver bugs (especially for DMA) or aborting a
552 * transfer might have left the endpoint busier than it should be.
553 * the busy/not-empty tests are basically paranoia.
556 musb_rx_reinit(struct musb *musb, struct musb_qh *qh, struct musb_hw_ep *ep)
560 /* NOTE: we know the "rx" fifo reinit never triggers for ep0.
561 * That always uses tx_reinit since ep0 repurposes TX register
562 * offsets; the initial SETUP packet is also a kind of OUT.
565 /* if programmed for Tx, put it in RX mode */
566 if (ep->is_shared_fifo) {
567 csr = musb_readw(ep->regs, MUSB_TXCSR);
568 if (csr & MUSB_TXCSR_MODE) {
569 musb_h_tx_flush_fifo(ep);
570 csr = musb_readw(ep->regs, MUSB_TXCSR);
571 musb_writew(ep->regs, MUSB_TXCSR,
572 csr | MUSB_TXCSR_FRCDATATOG);
576 * Clear the MODE bit (and everything else) to enable Rx.
577 * NOTE: we mustn't clear the DMAMODE bit before DMAENAB.
579 if (csr & MUSB_TXCSR_DMAMODE)
580 musb_writew(ep->regs, MUSB_TXCSR, MUSB_TXCSR_DMAMODE);
581 musb_writew(ep->regs, MUSB_TXCSR, 0);
583 /* scrub all previous state, clearing toggle */
585 csr = musb_readw(ep->regs, MUSB_RXCSR);
586 if (csr & MUSB_RXCSR_RXPKTRDY)
587 WARNING("rx%d, packet/%d ready?\n", ep->epnum,
588 musb_readw(ep->regs, MUSB_RXCOUNT));
590 musb_h_flush_rxfifo(ep, MUSB_RXCSR_CLRDATATOG);
593 /* target addr and (for multipoint) hub addr/port */
594 if (musb->is_multipoint) {
595 musb_write_rxfunaddr(ep->target_regs, qh->addr_reg);
596 musb_write_rxhubaddr(ep->target_regs, qh->h_addr_reg);
597 musb_write_rxhubport(ep->target_regs, qh->h_port_reg);
600 musb_writeb(musb->mregs, MUSB_FADDR, qh->addr_reg);
602 /* protocol/endpoint, interval/NAKlimit, i/o size */
603 musb_writeb(ep->regs, MUSB_RXTYPE, qh->type_reg);
604 musb_writeb(ep->regs, MUSB_RXINTERVAL, qh->intv_reg);
605 /* NOTE: bulk combining rewrites high bits of maxpacket */
606 /* Set RXMAXP with the FIFO size of the endpoint
607 * to disable double buffer mode.
609 if (musb->double_buffer_not_ok)
610 musb_writew(ep->regs, MUSB_RXMAXP, ep->max_packet_sz_rx);
612 musb_writew(ep->regs, MUSB_RXMAXP,
613 qh->maxpacket | ((qh->hb_mult - 1) << 11));
618 static bool musb_tx_dma_program(struct dma_controller *dma,
619 struct musb_hw_ep *hw_ep, struct musb_qh *qh,
620 struct urb *urb, u32 offset, u32 length)
622 struct dma_channel *channel = hw_ep->tx_channel;
623 void __iomem *epio = hw_ep->regs;
624 u16 pkt_size = qh->maxpacket;
628 #ifdef CONFIG_USB_INVENTRA_DMA
629 if (length > channel->max_len)
630 length = channel->max_len;
632 csr = musb_readw(epio, MUSB_TXCSR);
633 if (length > pkt_size) {
635 csr |= MUSB_TXCSR_DMAMODE | MUSB_TXCSR_DMAENAB;
636 /* autoset shouldn't be set in high bandwidth */
638 * Enable Autoset according to table
640 * bulk_split hb_mult Autoset_Enable
642 * 0 >1 No(High BW ISO)
646 if (qh->hb_mult == 1 || (qh->hb_mult > 1 &&
647 can_bulk_split(hw_ep->musb, qh->type)))
648 csr |= MUSB_TXCSR_AUTOSET;
651 csr &= ~(MUSB_TXCSR_AUTOSET | MUSB_TXCSR_DMAMODE);
652 csr |= MUSB_TXCSR_DMAENAB; /* against programmer's guide */
654 channel->desired_mode = mode;
655 musb_writew(epio, MUSB_TXCSR, csr);
657 if (!is_cppi_enabled() && !tusb_dma_omap())
660 channel->actual_len = 0;
663 * TX uses "RNDIS" mode automatically but needs help
664 * to identify the zero-length-final-packet case.
666 mode = (urb->transfer_flags & URB_ZERO_PACKET) ? 1 : 0;
669 qh->segsize = length;
672 * Ensure the data reaches to main memory before starting
677 if (!dma->channel_program(channel, pkt_size, mode,
678 urb->transfer_dma + offset, length)) {
679 dma->channel_release(channel);
680 hw_ep->tx_channel = NULL;
682 csr = musb_readw(epio, MUSB_TXCSR);
683 csr &= ~(MUSB_TXCSR_AUTOSET | MUSB_TXCSR_DMAENAB);
684 musb_writew(epio, MUSB_TXCSR, csr | MUSB_TXCSR_H_WZC_BITS);
691 * Program an HDRC endpoint as per the given URB
692 * Context: irqs blocked, controller lock held
694 static void musb_ep_program(struct musb *musb, u8 epnum,
695 struct urb *urb, int is_out,
696 u8 *buf, u32 offset, u32 len)
698 struct dma_controller *dma_controller;
699 struct dma_channel *dma_channel;
701 void __iomem *mbase = musb->mregs;
702 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
703 void __iomem *epio = hw_ep->regs;
704 struct musb_qh *qh = musb_ep_get_qh(hw_ep, !is_out);
705 u16 packet_sz = qh->maxpacket;
709 dev_dbg(musb->controller, "%s hw%d urb %p spd%d dev%d ep%d%s "
710 "h_addr%02x h_port%02x bytes %d\n",
711 is_out ? "-->" : "<--",
712 epnum, urb, urb->dev->speed,
713 qh->addr_reg, qh->epnum, is_out ? "out" : "in",
714 qh->h_addr_reg, qh->h_port_reg,
717 musb_ep_select(mbase, epnum);
719 if (is_out && !len) {
721 csr = musb_readw(epio, MUSB_TXCSR);
722 csr &= ~MUSB_TXCSR_DMAENAB;
723 musb_writew(epio, MUSB_TXCSR, csr);
724 hw_ep->tx_channel = NULL;
727 /* candidate for DMA? */
728 dma_controller = musb->dma_controller;
729 if (use_dma && is_dma_capable() && epnum && dma_controller) {
730 dma_channel = is_out ? hw_ep->tx_channel : hw_ep->rx_channel;
732 dma_channel = dma_controller->channel_alloc(
733 dma_controller, hw_ep, is_out);
735 hw_ep->tx_channel = dma_channel;
737 hw_ep->rx_channel = dma_channel;
742 /* make sure we clear DMAEnab, autoSet bits from previous run */
744 /* OUT/transmit/EP0 or IN/receive? */
750 csr = musb_readw(epio, MUSB_TXCSR);
752 /* disable interrupt in case we flush */
753 int_txe = musb->intrtxe;
754 musb_writew(mbase, MUSB_INTRTXE, int_txe & ~(1 << epnum));
756 /* general endpoint setup */
758 /* flush all old state, set default */
760 * We could be flushing valid
761 * packets in double buffering
764 if (!hw_ep->tx_double_buffered)
765 musb_h_tx_flush_fifo(hw_ep);
768 * We must not clear the DMAMODE bit before or in
769 * the same cycle with the DMAENAB bit, so we clear
770 * the latter first...
772 csr &= ~(MUSB_TXCSR_H_NAKTIMEOUT
775 | MUSB_TXCSR_FRCDATATOG
776 | MUSB_TXCSR_H_RXSTALL
778 | MUSB_TXCSR_TXPKTRDY
780 csr |= MUSB_TXCSR_MODE;
782 if (!hw_ep->tx_double_buffered) {
783 if (usb_gettoggle(urb->dev, qh->epnum, 1))
784 csr |= MUSB_TXCSR_H_WR_DATATOGGLE
785 | MUSB_TXCSR_H_DATATOGGLE;
787 csr |= MUSB_TXCSR_CLRDATATOG;
790 musb_writew(epio, MUSB_TXCSR, csr);
791 /* REVISIT may need to clear FLUSHFIFO ... */
792 csr &= ~MUSB_TXCSR_DMAMODE;
793 musb_writew(epio, MUSB_TXCSR, csr);
794 csr = musb_readw(epio, MUSB_TXCSR);
796 /* endpoint 0: just flush */
797 musb_h_ep0_flush_fifo(hw_ep);
800 /* target addr and (for multipoint) hub addr/port */
801 if (musb->is_multipoint) {
802 musb_write_txfunaddr(mbase, epnum, qh->addr_reg);
803 musb_write_txhubaddr(mbase, epnum, qh->h_addr_reg);
804 musb_write_txhubport(mbase, epnum, qh->h_port_reg);
805 /* FIXME if !epnum, do the same for RX ... */
807 musb_writeb(mbase, MUSB_FADDR, qh->addr_reg);
809 /* protocol/endpoint/interval/NAKlimit */
811 musb_writeb(epio, MUSB_TXTYPE, qh->type_reg);
812 if (musb->double_buffer_not_ok) {
813 musb_writew(epio, MUSB_TXMAXP,
814 hw_ep->max_packet_sz_tx);
815 } else if (can_bulk_split(musb, qh->type)) {
816 qh->hb_mult = hw_ep->max_packet_sz_tx
818 musb_writew(epio, MUSB_TXMAXP, packet_sz
819 | ((qh->hb_mult) - 1) << 11);
821 musb_writew(epio, MUSB_TXMAXP,
823 ((qh->hb_mult - 1) << 11));
825 musb_writeb(epio, MUSB_TXINTERVAL, qh->intv_reg);
827 musb_writeb(epio, MUSB_NAKLIMIT0, qh->intv_reg);
828 if (musb->is_multipoint)
829 musb_writeb(epio, MUSB_TYPE0,
833 if (can_bulk_split(musb, qh->type))
834 load_count = min((u32) hw_ep->max_packet_sz_tx,
837 load_count = min((u32) packet_sz, len);
839 if (dma_channel && musb_tx_dma_program(dma_controller,
840 hw_ep, qh, urb, offset, len))
844 /* PIO to load FIFO */
845 qh->segsize = load_count;
847 sg_miter_start(&qh->sg_miter, urb->sg, 1,
850 if (!sg_miter_next(&qh->sg_miter)) {
851 dev_err(musb->controller,
854 sg_miter_stop(&qh->sg_miter);
857 buf = qh->sg_miter.addr + urb->sg->offset +
859 load_count = min_t(u32, load_count,
860 qh->sg_miter.length);
861 musb_write_fifo(hw_ep, load_count, buf);
862 qh->sg_miter.consumed = load_count;
863 sg_miter_stop(&qh->sg_miter);
865 musb_write_fifo(hw_ep, load_count, buf);
868 /* re-enable interrupt */
869 musb_writew(mbase, MUSB_INTRTXE, int_txe);
875 if (hw_ep->rx_reinit) {
876 musb_rx_reinit(musb, qh, hw_ep);
878 /* init new state: toggle and NYET, maybe DMA later */
879 if (usb_gettoggle(urb->dev, qh->epnum, 0))
880 csr = MUSB_RXCSR_H_WR_DATATOGGLE
881 | MUSB_RXCSR_H_DATATOGGLE;
884 if (qh->type == USB_ENDPOINT_XFER_INT)
885 csr |= MUSB_RXCSR_DISNYET;
888 csr = musb_readw(hw_ep->regs, MUSB_RXCSR);
890 if (csr & (MUSB_RXCSR_RXPKTRDY
892 | MUSB_RXCSR_H_REQPKT))
893 ERR("broken !rx_reinit, ep%d csr %04x\n",
896 /* scrub any stale state, leaving toggle alone */
897 csr &= MUSB_RXCSR_DISNYET;
900 /* kick things off */
902 if ((is_cppi_enabled() || tusb_dma_omap()) && dma_channel) {
903 /* Candidate for DMA */
904 dma_channel->actual_len = 0L;
907 /* AUTOREQ is in a DMA register */
908 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
909 csr = musb_readw(hw_ep->regs, MUSB_RXCSR);
912 * Unless caller treats short RX transfers as
913 * errors, we dare not queue multiple transfers.
915 dma_ok = dma_controller->channel_program(dma_channel,
916 packet_sz, !(urb->transfer_flags &
918 urb->transfer_dma + offset,
921 dma_controller->channel_release(dma_channel);
922 hw_ep->rx_channel = dma_channel = NULL;
924 csr |= MUSB_RXCSR_DMAENAB;
927 csr |= MUSB_RXCSR_H_REQPKT;
928 dev_dbg(musb->controller, "RXCSR%d := %04x\n", epnum, csr);
929 musb_writew(hw_ep->regs, MUSB_RXCSR, csr);
930 csr = musb_readw(hw_ep->regs, MUSB_RXCSR);
934 /* Schedule next QH from musb->in_bulk/out_bulk and move the current qh to
935 * the end; avoids starvation for other endpoints.
937 static void musb_bulk_nak_timeout(struct musb *musb, struct musb_hw_ep *ep,
940 struct dma_channel *dma;
942 void __iomem *mbase = musb->mregs;
943 void __iomem *epio = ep->regs;
944 struct musb_qh *cur_qh, *next_qh;
947 musb_ep_select(mbase, ep->epnum);
949 dma = is_dma_capable() ? ep->rx_channel : NULL;
951 /* clear nak timeout bit */
952 rx_csr = musb_readw(epio, MUSB_RXCSR);
953 rx_csr |= MUSB_RXCSR_H_WZC_BITS;
954 rx_csr &= ~MUSB_RXCSR_DATAERROR;
955 musb_writew(epio, MUSB_RXCSR, rx_csr);
957 cur_qh = first_qh(&musb->in_bulk);
959 dma = is_dma_capable() ? ep->tx_channel : NULL;
961 /* clear nak timeout bit */
962 tx_csr = musb_readw(epio, MUSB_TXCSR);
963 tx_csr |= MUSB_TXCSR_H_WZC_BITS;
964 tx_csr &= ~MUSB_TXCSR_H_NAKTIMEOUT;
965 musb_writew(epio, MUSB_TXCSR, tx_csr);
967 cur_qh = first_qh(&musb->out_bulk);
970 urb = next_urb(cur_qh);
971 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
972 dma->status = MUSB_DMA_STATUS_CORE_ABORT;
973 musb->dma_controller->channel_abort(dma);
974 urb->actual_length += dma->actual_len;
975 dma->actual_len = 0L;
977 musb_save_toggle(cur_qh, is_in, urb);
980 /* move cur_qh to end of queue */
981 list_move_tail(&cur_qh->ring, &musb->in_bulk);
983 /* get the next qh from musb->in_bulk */
984 next_qh = first_qh(&musb->in_bulk);
986 /* set rx_reinit and schedule the next qh */
989 /* move cur_qh to end of queue */
990 list_move_tail(&cur_qh->ring, &musb->out_bulk);
992 /* get the next qh from musb->out_bulk */
993 next_qh = first_qh(&musb->out_bulk);
995 /* set tx_reinit and schedule the next qh */
998 musb_start_urb(musb, is_in, next_qh);
1003 * Service the default endpoint (ep0) as host.
1004 * Return true until it's time to start the status stage.
1006 static bool musb_h_ep0_continue(struct musb *musb, u16 len, struct urb *urb)
1009 u8 *fifo_dest = NULL;
1011 struct musb_hw_ep *hw_ep = musb->control_ep;
1012 struct musb_qh *qh = hw_ep->in_qh;
1013 struct usb_ctrlrequest *request;
1015 switch (musb->ep0_stage) {
1017 fifo_dest = urb->transfer_buffer + urb->actual_length;
1018 fifo_count = min_t(size_t, len, urb->transfer_buffer_length -
1019 urb->actual_length);
1020 if (fifo_count < len)
1021 urb->status = -EOVERFLOW;
1023 musb_read_fifo(hw_ep, fifo_count, fifo_dest);
1025 urb->actual_length += fifo_count;
1026 if (len < qh->maxpacket) {
1027 /* always terminate on short read; it's
1028 * rarely reported as an error.
1030 } else if (urb->actual_length <
1031 urb->transfer_buffer_length)
1034 case MUSB_EP0_START:
1035 request = (struct usb_ctrlrequest *) urb->setup_packet;
1037 if (!request->wLength) {
1038 dev_dbg(musb->controller, "start no-DATA\n");
1040 } else if (request->bRequestType & USB_DIR_IN) {
1041 dev_dbg(musb->controller, "start IN-DATA\n");
1042 musb->ep0_stage = MUSB_EP0_IN;
1046 dev_dbg(musb->controller, "start OUT-DATA\n");
1047 musb->ep0_stage = MUSB_EP0_OUT;
1052 fifo_count = min_t(size_t, qh->maxpacket,
1053 urb->transfer_buffer_length -
1054 urb->actual_length);
1056 fifo_dest = (u8 *) (urb->transfer_buffer
1057 + urb->actual_length);
1058 dev_dbg(musb->controller, "Sending %d byte%s to ep0 fifo %p\n",
1060 (fifo_count == 1) ? "" : "s",
1062 musb_write_fifo(hw_ep, fifo_count, fifo_dest);
1064 urb->actual_length += fifo_count;
1069 ERR("bogus ep0 stage %d\n", musb->ep0_stage);
1077 * Handle default endpoint interrupt as host. Only called in IRQ time
1078 * from musb_interrupt().
1080 * called with controller irqlocked
1082 irqreturn_t musb_h_ep0_irq(struct musb *musb)
1087 void __iomem *mbase = musb->mregs;
1088 struct musb_hw_ep *hw_ep = musb->control_ep;
1089 void __iomem *epio = hw_ep->regs;
1090 struct musb_qh *qh = hw_ep->in_qh;
1091 bool complete = false;
1092 irqreturn_t retval = IRQ_NONE;
1094 /* ep0 only has one queue, "in" */
1097 musb_ep_select(mbase, 0);
1098 csr = musb_readw(epio, MUSB_CSR0);
1099 len = (csr & MUSB_CSR0_RXPKTRDY)
1100 ? musb_readb(epio, MUSB_COUNT0)
1103 dev_dbg(musb->controller, "<== csr0 %04x, qh %p, count %d, urb %p, stage %d\n",
1104 csr, qh, len, urb, musb->ep0_stage);
1106 /* if we just did status stage, we are done */
1107 if (MUSB_EP0_STATUS == musb->ep0_stage) {
1108 retval = IRQ_HANDLED;
1112 /* prepare status */
1113 if (csr & MUSB_CSR0_H_RXSTALL) {
1114 dev_dbg(musb->controller, "STALLING ENDPOINT\n");
1117 } else if (csr & MUSB_CSR0_H_ERROR) {
1118 dev_dbg(musb->controller, "no response, csr0 %04x\n", csr);
1121 } else if (csr & MUSB_CSR0_H_NAKTIMEOUT) {
1122 dev_dbg(musb->controller, "control NAK timeout\n");
1124 /* NOTE: this code path would be a good place to PAUSE a
1125 * control transfer, if another one is queued, so that
1126 * ep0 is more likely to stay busy. That's already done
1127 * for bulk RX transfers.
1129 * if (qh->ring.next != &musb->control), then
1130 * we have a candidate... NAKing is *NOT* an error
1132 musb_writew(epio, MUSB_CSR0, 0);
1133 retval = IRQ_HANDLED;
1137 dev_dbg(musb->controller, "aborting\n");
1138 retval = IRQ_HANDLED;
1140 urb->status = status;
1143 /* use the proper sequence to abort the transfer */
1144 if (csr & MUSB_CSR0_H_REQPKT) {
1145 csr &= ~MUSB_CSR0_H_REQPKT;
1146 musb_writew(epio, MUSB_CSR0, csr);
1147 csr &= ~MUSB_CSR0_H_NAKTIMEOUT;
1148 musb_writew(epio, MUSB_CSR0, csr);
1150 musb_h_ep0_flush_fifo(hw_ep);
1153 musb_writeb(epio, MUSB_NAKLIMIT0, 0);
1156 musb_writew(epio, MUSB_CSR0, 0);
1159 if (unlikely(!urb)) {
1160 /* stop endpoint since we have no place for its data, this
1161 * SHOULD NEVER HAPPEN! */
1162 ERR("no URB for end 0\n");
1164 musb_h_ep0_flush_fifo(hw_ep);
1169 /* call common logic and prepare response */
1170 if (musb_h_ep0_continue(musb, len, urb)) {
1171 /* more packets required */
1172 csr = (MUSB_EP0_IN == musb->ep0_stage)
1173 ? MUSB_CSR0_H_REQPKT : MUSB_CSR0_TXPKTRDY;
1175 /* data transfer complete; perform status phase */
1176 if (usb_pipeout(urb->pipe)
1177 || !urb->transfer_buffer_length)
1178 csr = MUSB_CSR0_H_STATUSPKT
1179 | MUSB_CSR0_H_REQPKT;
1181 csr = MUSB_CSR0_H_STATUSPKT
1182 | MUSB_CSR0_TXPKTRDY;
1184 /* flag status stage */
1185 musb->ep0_stage = MUSB_EP0_STATUS;
1187 dev_dbg(musb->controller, "ep0 STATUS, csr %04x\n", csr);
1190 musb_writew(epio, MUSB_CSR0, csr);
1191 retval = IRQ_HANDLED;
1193 musb->ep0_stage = MUSB_EP0_IDLE;
1195 /* call completion handler if done */
1197 musb_advance_schedule(musb, urb, hw_ep, 1);
1203 #ifdef CONFIG_USB_INVENTRA_DMA
1205 /* Host side TX (OUT) using Mentor DMA works as follows:
1207 - if queue was empty, Program Endpoint
1208 - ... which starts DMA to fifo in mode 1 or 0
1210 DMA Isr (transfer complete) -> TxAvail()
1211 - Stop DMA (~DmaEnab) (<--- Alert ... currently happens
1212 only in musb_cleanup_urb)
1213 - TxPktRdy has to be set in mode 0 or for
1214 short packets in mode 1.
1219 /* Service a Tx-Available or dma completion irq for the endpoint */
1220 void musb_host_tx(struct musb *musb, u8 epnum)
1227 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
1228 void __iomem *epio = hw_ep->regs;
1229 struct musb_qh *qh = hw_ep->out_qh;
1230 struct urb *urb = next_urb(qh);
1232 void __iomem *mbase = musb->mregs;
1233 struct dma_channel *dma;
1234 bool transfer_pending = false;
1236 musb_ep_select(mbase, epnum);
1237 tx_csr = musb_readw(epio, MUSB_TXCSR);
1239 /* with CPPI, DMA sometimes triggers "extra" irqs */
1241 dev_dbg(musb->controller, "extra TX%d ready, csr %04x\n", epnum, tx_csr);
1246 dma = is_dma_capable() ? hw_ep->tx_channel : NULL;
1247 dev_dbg(musb->controller, "OUT/TX%d end, csr %04x%s\n", epnum, tx_csr,
1248 dma ? ", dma" : "");
1250 /* check for errors */
1251 if (tx_csr & MUSB_TXCSR_H_RXSTALL) {
1252 /* dma was disabled, fifo flushed */
1253 dev_dbg(musb->controller, "TX end %d stall\n", epnum);
1255 /* stall; record URB status */
1258 } else if (tx_csr & MUSB_TXCSR_H_ERROR) {
1259 /* (NON-ISO) dma was disabled, fifo flushed */
1260 dev_dbg(musb->controller, "TX 3strikes on ep=%d\n", epnum);
1262 status = -ETIMEDOUT;
1264 } else if (tx_csr & MUSB_TXCSR_H_NAKTIMEOUT) {
1265 if (USB_ENDPOINT_XFER_BULK == qh->type && qh->mux == 1
1266 && !list_is_singular(&musb->out_bulk)) {
1267 dev_dbg(musb->controller,
1268 "NAK timeout on TX%d ep\n", epnum);
1269 musb_bulk_nak_timeout(musb, hw_ep, 0);
1271 dev_dbg(musb->controller,
1272 "TX end=%d device not responding\n", epnum);
1273 /* NOTE: this code path would be a good place to PAUSE a
1274 * transfer, if there's some other (nonperiodic) tx urb
1275 * that could use this fifo. (dma complicates it...)
1276 * That's already done for bulk RX transfers.
1278 * if (bulk && qh->ring.next != &musb->out_bulk), then
1279 * we have a candidate... NAKing is *NOT* an error
1281 musb_ep_select(mbase, epnum);
1282 musb_writew(epio, MUSB_TXCSR,
1283 MUSB_TXCSR_H_WZC_BITS
1284 | MUSB_TXCSR_TXPKTRDY);
1291 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1292 dma->status = MUSB_DMA_STATUS_CORE_ABORT;
1293 (void) musb->dma_controller->channel_abort(dma);
1296 /* do the proper sequence to abort the transfer in the
1297 * usb core; the dma engine should already be stopped.
1299 musb_h_tx_flush_fifo(hw_ep);
1300 tx_csr &= ~(MUSB_TXCSR_AUTOSET
1301 | MUSB_TXCSR_DMAENAB
1302 | MUSB_TXCSR_H_ERROR
1303 | MUSB_TXCSR_H_RXSTALL
1304 | MUSB_TXCSR_H_NAKTIMEOUT
1307 musb_ep_select(mbase, epnum);
1308 musb_writew(epio, MUSB_TXCSR, tx_csr);
1309 /* REVISIT may need to clear FLUSHFIFO ... */
1310 musb_writew(epio, MUSB_TXCSR, tx_csr);
1311 musb_writeb(epio, MUSB_TXINTERVAL, 0);
1316 /* second cppi case */
1317 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1318 dev_dbg(musb->controller, "extra TX%d ready, csr %04x\n", epnum, tx_csr);
1322 if (is_dma_capable() && dma && !status) {
1324 * DMA has completed. But if we're using DMA mode 1 (multi
1325 * packet DMA), we need a terminal TXPKTRDY interrupt before
1326 * we can consider this transfer completed, lest we trash
1327 * its last packet when writing the next URB's data. So we
1328 * switch back to mode 0 to get that interrupt; we'll come
1329 * back here once it happens.
1331 if (tx_csr & MUSB_TXCSR_DMAMODE) {
1333 * We shouldn't clear DMAMODE with DMAENAB set; so
1334 * clear them in a safe order. That should be OK
1335 * once TXPKTRDY has been set (and I've never seen
1336 * it being 0 at this moment -- DMA interrupt latency
1337 * is significant) but if it hasn't been then we have
1338 * no choice but to stop being polite and ignore the
1339 * programmer's guide... :-)
1341 * Note that we must write TXCSR with TXPKTRDY cleared
1342 * in order not to re-trigger the packet send (this bit
1343 * can't be cleared by CPU), and there's another caveat:
1344 * TXPKTRDY may be set shortly and then cleared in the
1345 * double-buffered FIFO mode, so we do an extra TXCSR
1346 * read for debouncing...
1348 tx_csr &= musb_readw(epio, MUSB_TXCSR);
1349 if (tx_csr & MUSB_TXCSR_TXPKTRDY) {
1350 tx_csr &= ~(MUSB_TXCSR_DMAENAB |
1351 MUSB_TXCSR_TXPKTRDY);
1352 musb_writew(epio, MUSB_TXCSR,
1353 tx_csr | MUSB_TXCSR_H_WZC_BITS);
1355 tx_csr &= ~(MUSB_TXCSR_DMAMODE |
1356 MUSB_TXCSR_TXPKTRDY);
1357 musb_writew(epio, MUSB_TXCSR,
1358 tx_csr | MUSB_TXCSR_H_WZC_BITS);
1361 * There is no guarantee that we'll get an interrupt
1362 * after clearing DMAMODE as we might have done this
1363 * too late (after TXPKTRDY was cleared by controller).
1364 * Re-read TXCSR as we have spoiled its previous value.
1366 tx_csr = musb_readw(epio, MUSB_TXCSR);
1370 * We may get here from a DMA completion or TXPKTRDY interrupt.
1371 * In any case, we must check the FIFO status here and bail out
1372 * only if the FIFO still has data -- that should prevent the
1373 * "missed" TXPKTRDY interrupts and deal with double-buffered
1376 if (tx_csr & (MUSB_TXCSR_FIFONOTEMPTY | MUSB_TXCSR_TXPKTRDY)) {
1377 dev_dbg(musb->controller, "DMA complete but packet still in FIFO, "
1378 "CSR %04x\n", tx_csr);
1383 if (!status || dma || usb_pipeisoc(pipe)) {
1385 length = dma->actual_len;
1387 length = qh->segsize;
1388 qh->offset += length;
1390 if (usb_pipeisoc(pipe)) {
1391 struct usb_iso_packet_descriptor *d;
1393 d = urb->iso_frame_desc + qh->iso_idx;
1394 d->actual_length = length;
1396 if (++qh->iso_idx >= urb->number_of_packets) {
1403 } else if (dma && urb->transfer_buffer_length == qh->offset) {
1406 /* see if we need to send more data, or ZLP */
1407 if (qh->segsize < qh->maxpacket)
1409 else if (qh->offset == urb->transfer_buffer_length
1410 && !(urb->transfer_flags
1414 offset = qh->offset;
1415 length = urb->transfer_buffer_length - offset;
1416 transfer_pending = true;
1421 /* urb->status != -EINPROGRESS means request has been faulted,
1422 * so we must abort this transfer after cleanup
1424 if (urb->status != -EINPROGRESS) {
1427 status = urb->status;
1432 urb->status = status;
1433 urb->actual_length = qh->offset;
1434 musb_advance_schedule(musb, urb, hw_ep, USB_DIR_OUT);
1436 } else if ((usb_pipeisoc(pipe) || transfer_pending) && dma) {
1437 if (musb_tx_dma_program(musb->dma_controller, hw_ep, qh, urb,
1439 if (is_cppi_enabled() || tusb_dma_omap())
1440 musb_h_tx_dma_start(hw_ep);
1443 } else if (tx_csr & MUSB_TXCSR_DMAENAB) {
1444 dev_dbg(musb->controller, "not complete, but DMA enabled?\n");
1449 * PIO: start next packet in this URB.
1451 * REVISIT: some docs say that when hw_ep->tx_double_buffered,
1452 * (and presumably, FIFO is not half-full) we should write *two*
1453 * packets before updating TXCSR; other docs disagree...
1455 if (length > qh->maxpacket)
1456 length = qh->maxpacket;
1457 /* Unmap the buffer so that CPU can use it */
1458 usb_hcd_unmap_urb_for_dma(musb_to_hcd(musb), urb);
1461 * We need to map sg if the transfer_buffer is
1464 if (!urb->transfer_buffer)
1468 /* sg_miter_start is already done in musb_ep_program */
1469 if (!sg_miter_next(&qh->sg_miter)) {
1470 dev_err(musb->controller, "error: sg list empty\n");
1471 sg_miter_stop(&qh->sg_miter);
1475 urb->transfer_buffer = qh->sg_miter.addr;
1476 length = min_t(u32, length, qh->sg_miter.length);
1477 musb_write_fifo(hw_ep, length, urb->transfer_buffer);
1478 qh->sg_miter.consumed = length;
1479 sg_miter_stop(&qh->sg_miter);
1481 musb_write_fifo(hw_ep, length, urb->transfer_buffer + offset);
1484 qh->segsize = length;
1487 if (offset + length >= urb->transfer_buffer_length)
1491 musb_ep_select(mbase, epnum);
1492 musb_writew(epio, MUSB_TXCSR,
1493 MUSB_TXCSR_H_WZC_BITS | MUSB_TXCSR_TXPKTRDY);
1497 #ifdef CONFIG_USB_INVENTRA_DMA
1499 /* Host side RX (IN) using Mentor DMA works as follows:
1501 - if queue was empty, ProgramEndpoint
1502 - first IN token is sent out (by setting ReqPkt)
1503 LinuxIsr -> RxReady()
1504 /\ => first packet is received
1505 | - Set in mode 0 (DmaEnab, ~ReqPkt)
1506 | -> DMA Isr (transfer complete) -> RxReady()
1507 | - Ack receive (~RxPktRdy), turn off DMA (~DmaEnab)
1508 | - if urb not complete, send next IN token (ReqPkt)
1509 | | else complete urb.
1511 ---------------------------
1513 * Nuances of mode 1:
1514 * For short packets, no ack (+RxPktRdy) is sent automatically
1515 * (even if AutoClear is ON)
1516 * For full packets, ack (~RxPktRdy) and next IN token (+ReqPkt) is sent
1517 * automatically => major problem, as collecting the next packet becomes
1518 * difficult. Hence mode 1 is not used.
1521 * All we care about at this driver level is that
1522 * (a) all URBs terminate with REQPKT cleared and fifo(s) empty;
1523 * (b) termination conditions are: short RX, or buffer full;
1524 * (c) fault modes include
1525 * - iff URB_SHORT_NOT_OK, short RX status is -EREMOTEIO.
1526 * (and that endpoint's dma queue stops immediately)
1527 * - overflow (full, PLUS more bytes in the terminal packet)
1529 * So for example, usb-storage sets URB_SHORT_NOT_OK, and would
1530 * thus be a great candidate for using mode 1 ... for all but the
1531 * last packet of one URB's transfer.
1537 * Service an RX interrupt for the given IN endpoint; docs cover bulk, iso,
1538 * and high-bandwidth IN transfer cases.
1540 void musb_host_rx(struct musb *musb, u8 epnum)
1543 struct musb_hw_ep *hw_ep = musb->endpoints + epnum;
1544 void __iomem *epio = hw_ep->regs;
1545 struct musb_qh *qh = hw_ep->in_qh;
1547 void __iomem *mbase = musb->mregs;
1550 bool iso_err = false;
1553 struct dma_channel *dma;
1554 unsigned int sg_flags = SG_MITER_ATOMIC | SG_MITER_TO_SG;
1556 musb_ep_select(mbase, epnum);
1559 dma = is_dma_capable() ? hw_ep->rx_channel : NULL;
1563 rx_csr = musb_readw(epio, MUSB_RXCSR);
1566 if (unlikely(!urb)) {
1567 /* REVISIT -- THIS SHOULD NEVER HAPPEN ... but, at least
1568 * usbtest #11 (unlinks) triggers it regularly, sometimes
1569 * with fifo full. (Only with DMA??)
1571 dev_dbg(musb->controller, "BOGUS RX%d ready, csr %04x, count %d\n", epnum, val,
1572 musb_readw(epio, MUSB_RXCOUNT));
1573 musb_h_flush_rxfifo(hw_ep, MUSB_RXCSR_CLRDATATOG);
1579 dev_dbg(musb->controller, "<== hw %d rxcsr %04x, urb actual %d (+dma %zu)\n",
1580 epnum, rx_csr, urb->actual_length,
1581 dma ? dma->actual_len : 0);
1583 /* check for errors, concurrent stall & unlink is not really
1585 if (rx_csr & MUSB_RXCSR_H_RXSTALL) {
1586 dev_dbg(musb->controller, "RX end %d STALL\n", epnum);
1588 /* stall; record URB status */
1591 } else if (rx_csr & MUSB_RXCSR_H_ERROR) {
1592 dev_dbg(musb->controller, "end %d RX proto error\n", epnum);
1595 musb_writeb(epio, MUSB_RXINTERVAL, 0);
1597 } else if (rx_csr & MUSB_RXCSR_DATAERROR) {
1599 if (USB_ENDPOINT_XFER_ISOC != qh->type) {
1600 dev_dbg(musb->controller, "RX end %d NAK timeout\n", epnum);
1602 /* NOTE: NAKing is *NOT* an error, so we want to
1603 * continue. Except ... if there's a request for
1604 * another QH, use that instead of starving it.
1606 * Devices like Ethernet and serial adapters keep
1607 * reads posted at all times, which will starve
1608 * other devices without this logic.
1610 if (usb_pipebulk(urb->pipe)
1612 && !list_is_singular(&musb->in_bulk)) {
1613 musb_bulk_nak_timeout(musb, hw_ep, 1);
1616 musb_ep_select(mbase, epnum);
1617 rx_csr |= MUSB_RXCSR_H_WZC_BITS;
1618 rx_csr &= ~MUSB_RXCSR_DATAERROR;
1619 musb_writew(epio, MUSB_RXCSR, rx_csr);
1623 dev_dbg(musb->controller, "RX end %d ISO data error\n", epnum);
1624 /* packet error reported later */
1627 } else if (rx_csr & MUSB_RXCSR_INCOMPRX) {
1628 dev_dbg(musb->controller, "end %d high bandwidth incomplete ISO packet RX\n",
1633 /* faults abort the transfer */
1635 /* clean up dma and collect transfer count */
1636 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1637 dma->status = MUSB_DMA_STATUS_CORE_ABORT;
1638 (void) musb->dma_controller->channel_abort(dma);
1639 xfer_len = dma->actual_len;
1641 musb_h_flush_rxfifo(hw_ep, MUSB_RXCSR_CLRDATATOG);
1642 musb_writeb(epio, MUSB_RXINTERVAL, 0);
1647 if (unlikely(dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY)) {
1648 /* SHOULD NEVER HAPPEN ... but at least DaVinci has done it */
1649 ERR("RX%d dma busy, csr %04x\n", epnum, rx_csr);
1653 /* thorough shutdown for now ... given more precise fault handling
1654 * and better queueing support, we might keep a DMA pipeline going
1655 * while processing this irq for earlier completions.
1658 /* FIXME this is _way_ too much in-line logic for Mentor DMA */
1660 #ifndef CONFIG_USB_INVENTRA_DMA
1661 if (rx_csr & MUSB_RXCSR_H_REQPKT) {
1662 /* REVISIT this happened for a while on some short reads...
1663 * the cleanup still needs investigation... looks bad...
1664 * and also duplicates dma cleanup code above ... plus,
1665 * shouldn't this be the "half full" double buffer case?
1667 if (dma_channel_status(dma) == MUSB_DMA_STATUS_BUSY) {
1668 dma->status = MUSB_DMA_STATUS_CORE_ABORT;
1669 (void) musb->dma_controller->channel_abort(dma);
1670 xfer_len = dma->actual_len;
1674 dev_dbg(musb->controller, "RXCSR%d %04x, reqpkt, len %zu%s\n", epnum, rx_csr,
1675 xfer_len, dma ? ", dma" : "");
1676 rx_csr &= ~MUSB_RXCSR_H_REQPKT;
1678 musb_ep_select(mbase, epnum);
1679 musb_writew(epio, MUSB_RXCSR,
1680 MUSB_RXCSR_H_WZC_BITS | rx_csr);
1683 if (dma && (rx_csr & MUSB_RXCSR_DMAENAB)) {
1684 xfer_len = dma->actual_len;
1686 val &= ~(MUSB_RXCSR_DMAENAB
1687 | MUSB_RXCSR_H_AUTOREQ
1688 | MUSB_RXCSR_AUTOCLEAR
1689 | MUSB_RXCSR_RXPKTRDY);
1690 musb_writew(hw_ep->regs, MUSB_RXCSR, val);
1692 #ifdef CONFIG_USB_INVENTRA_DMA
1693 if (usb_pipeisoc(pipe)) {
1694 struct usb_iso_packet_descriptor *d;
1696 d = urb->iso_frame_desc + qh->iso_idx;
1697 d->actual_length = xfer_len;
1699 /* even if there was an error, we did the dma
1700 * for iso_frame_desc->length
1702 if (d->status != -EILSEQ && d->status != -EOVERFLOW)
1705 if (++qh->iso_idx >= urb->number_of_packets)
1711 /* done if urb buffer is full or short packet is recd */
1712 done = (urb->actual_length + xfer_len >=
1713 urb->transfer_buffer_length
1714 || dma->actual_len < qh->maxpacket);
1717 /* send IN token for next packet, without AUTOREQ */
1719 val |= MUSB_RXCSR_H_REQPKT;
1720 musb_writew(epio, MUSB_RXCSR,
1721 MUSB_RXCSR_H_WZC_BITS | val);
1724 dev_dbg(musb->controller, "ep %d dma %s, rxcsr %04x, rxcount %d\n", epnum,
1725 done ? "off" : "reset",
1726 musb_readw(epio, MUSB_RXCSR),
1727 musb_readw(epio, MUSB_RXCOUNT));
1731 } else if (urb->status == -EINPROGRESS) {
1732 /* if no errors, be sure a packet is ready for unloading */
1733 if (unlikely(!(rx_csr & MUSB_RXCSR_RXPKTRDY))) {
1735 ERR("Rx interrupt with no errors or packet!\n");
1737 /* FIXME this is another "SHOULD NEVER HAPPEN" */
1740 /* do the proper sequence to abort the transfer */
1741 musb_ep_select(mbase, epnum);
1742 val &= ~MUSB_RXCSR_H_REQPKT;
1743 musb_writew(epio, MUSB_RXCSR, val);
1747 /* we are expecting IN packets */
1748 #ifdef CONFIG_USB_INVENTRA_DMA
1750 struct dma_controller *c;
1755 rx_count = musb_readw(epio, MUSB_RXCOUNT);
1757 dev_dbg(musb->controller, "RX%d count %d, buffer 0x%x len %d/%d\n",
1760 + urb->actual_length,
1762 urb->transfer_buffer_length);
1764 c = musb->dma_controller;
1766 if (usb_pipeisoc(pipe)) {
1768 struct usb_iso_packet_descriptor *d;
1770 d = urb->iso_frame_desc + qh->iso_idx;
1776 if (rx_count > d->length) {
1777 if (d_status == 0) {
1778 d_status = -EOVERFLOW;
1781 dev_dbg(musb->controller, "** OVERFLOW %d into %d\n",\
1782 rx_count, d->length);
1787 d->status = d_status;
1788 buf = urb->transfer_dma + d->offset;
1791 buf = urb->transfer_dma +
1795 dma->desired_mode = 0;
1797 /* because of the issue below, mode 1 will
1798 * only rarely behave with correct semantics.
1800 if ((urb->transfer_flags &
1802 && (urb->transfer_buffer_length -
1805 dma->desired_mode = 1;
1806 if (rx_count < hw_ep->max_packet_sz_rx) {
1808 dma->desired_mode = 0;
1810 length = urb->transfer_buffer_length;
1814 /* Disadvantage of using mode 1:
1815 * It's basically usable only for mass storage class; essentially all
1816 * other protocols also terminate transfers on short packets.
1819 * An extra IN token is sent at the end of the transfer (due to AUTOREQ)
1820 * If you try to use mode 1 for (transfer_buffer_length - 512), and try
1821 * to use the extra IN token to grab the last packet using mode 0, then
1822 * the problem is that you cannot be sure when the device will send the
1823 * last packet and RxPktRdy set. Sometimes the packet is recd too soon
1824 * such that it gets lost when RxCSR is re-set at the end of the mode 1
1825 * transfer, while sometimes it is recd just a little late so that if you
1826 * try to configure for mode 0 soon after the mode 1 transfer is
1827 * completed, you will find rxcount 0. Okay, so you might think why not
1828 * wait for an interrupt when the pkt is recd. Well, you won't get any!
1831 val = musb_readw(epio, MUSB_RXCSR);
1832 val &= ~MUSB_RXCSR_H_REQPKT;
1834 if (dma->desired_mode == 0)
1835 val &= ~MUSB_RXCSR_H_AUTOREQ;
1837 val |= MUSB_RXCSR_H_AUTOREQ;
1838 val |= MUSB_RXCSR_DMAENAB;
1840 /* autoclear shouldn't be set in high bandwidth */
1841 if (qh->hb_mult == 1)
1842 val |= MUSB_RXCSR_AUTOCLEAR;
1844 musb_writew(epio, MUSB_RXCSR,
1845 MUSB_RXCSR_H_WZC_BITS | val);
1847 /* REVISIT if when actual_length != 0,
1848 * transfer_buffer_length needs to be
1851 ret = c->channel_program(
1853 dma->desired_mode, buf, length);
1856 c->channel_release(dma);
1857 hw_ep->rx_channel = NULL;
1859 val = musb_readw(epio, MUSB_RXCSR);
1860 val &= ~(MUSB_RXCSR_DMAENAB
1861 | MUSB_RXCSR_H_AUTOREQ
1862 | MUSB_RXCSR_AUTOCLEAR);
1863 musb_writew(epio, MUSB_RXCSR, val);
1866 #endif /* Mentor DMA */
1869 unsigned int received_len;
1871 /* Unmap the buffer so that CPU can use it */
1872 usb_hcd_unmap_urb_for_dma(musb_to_hcd(musb), urb);
1875 * We need to map sg if the transfer_buffer is
1878 if (!urb->transfer_buffer) {
1880 sg_miter_start(&qh->sg_miter, urb->sg, 1,
1885 if (!sg_miter_next(&qh->sg_miter)) {
1886 dev_err(musb->controller, "error: sg list empty\n");
1887 sg_miter_stop(&qh->sg_miter);
1892 urb->transfer_buffer = qh->sg_miter.addr;
1893 received_len = urb->actual_length;
1895 done = musb_host_packet_rx(musb, urb, epnum,
1897 /* Calculate the number of bytes received */
1898 received_len = urb->actual_length -
1900 qh->sg_miter.consumed = received_len;
1901 sg_miter_stop(&qh->sg_miter);
1903 done = musb_host_packet_rx(musb, urb,
1906 dev_dbg(musb->controller, "read %spacket\n", done ? "last " : "");
1911 urb->actual_length += xfer_len;
1912 qh->offset += xfer_len;
1917 if (urb->status == -EINPROGRESS)
1918 urb->status = status;
1919 musb_advance_schedule(musb, urb, hw_ep, USB_DIR_IN);
1923 /* schedule nodes correspond to peripheral endpoints, like an OHCI QH.
1924 * the software schedule associates multiple such nodes with a given
1925 * host side hardware endpoint + direction; scheduling may activate
1926 * that hardware endpoint.
1928 static int musb_schedule(
1935 int best_end, epnum;
1936 struct musb_hw_ep *hw_ep = NULL;
1937 struct list_head *head = NULL;
1940 struct urb *urb = next_urb(qh);
1942 /* use fixed hardware for control and bulk */
1943 if (qh->type == USB_ENDPOINT_XFER_CONTROL) {
1944 head = &musb->control;
1945 hw_ep = musb->control_ep;
1949 /* else, periodic transfers get muxed to other endpoints */
1952 * We know this qh hasn't been scheduled, so all we need to do
1953 * is choose which hardware endpoint to put it on ...
1955 * REVISIT what we really want here is a regular schedule tree
1956 * like e.g. OHCI uses.
1961 for (epnum = 1, hw_ep = musb->endpoints + 1;
1962 epnum < musb->nr_endpoints;
1966 if (musb_ep_get_qh(hw_ep, is_in) != NULL)
1969 if (hw_ep == musb->bulk_ep)
1973 diff = hw_ep->max_packet_sz_rx;
1975 diff = hw_ep->max_packet_sz_tx;
1976 diff -= (qh->maxpacket * qh->hb_mult);
1978 if (diff >= 0 && best_diff > diff) {
1981 * Mentor controller has a bug in that if we schedule
1982 * a BULK Tx transfer on an endpoint that had earlier
1983 * handled ISOC then the BULK transfer has to start on
1984 * a zero toggle. If the BULK transfer starts on a 1
1985 * toggle then this transfer will fail as the mentor
1986 * controller starts the Bulk transfer on a 0 toggle
1987 * irrespective of the programming of the toggle bits
1988 * in the TXCSR register. Check for this condition
1989 * while allocating the EP for a Tx Bulk transfer. If
1992 hw_ep = musb->endpoints + epnum;
1993 toggle = usb_gettoggle(urb->dev, qh->epnum, !is_in);
1994 txtype = (musb_readb(hw_ep->regs, MUSB_TXTYPE)
1996 if (!is_in && (qh->type == USB_ENDPOINT_XFER_BULK) &&
1997 toggle && (txtype == USB_ENDPOINT_XFER_ISOC))
2004 /* use bulk reserved ep1 if no other ep is free */
2005 if (best_end < 0 && qh->type == USB_ENDPOINT_XFER_BULK) {
2006 hw_ep = musb->bulk_ep;
2008 head = &musb->in_bulk;
2010 head = &musb->out_bulk;
2012 /* Enable bulk RX/TX NAK timeout scheme when bulk requests are
2013 * multiplexed. This scheme doen't work in high speed to full
2014 * speed scenario as NAK interrupts are not coming from a
2015 * full speed device connected to a high speed device.
2016 * NAK timeout interval is 8 (128 uframe or 16ms) for HS and
2017 * 4 (8 frame or 8ms) for FS device.
2021 (USB_SPEED_HIGH == qh->dev->speed) ? 8 : 4;
2023 } else if (best_end < 0) {
2029 hw_ep = musb->endpoints + best_end;
2030 dev_dbg(musb->controller, "qh %p periodic slot %d\n", qh, best_end);
2033 idle = list_empty(head);
2034 list_add_tail(&qh->ring, head);
2038 qh->hep->hcpriv = qh;
2040 musb_start_urb(musb, is_in, qh);
2044 static int musb_urb_enqueue(
2045 struct usb_hcd *hcd,
2049 unsigned long flags;
2050 struct musb *musb = hcd_to_musb(hcd);
2051 struct usb_host_endpoint *hep = urb->ep;
2053 struct usb_endpoint_descriptor *epd = &hep->desc;
2058 /* host role must be active */
2059 if (!is_host_active(musb) || !musb->is_active)
2062 spin_lock_irqsave(&musb->lock, flags);
2063 ret = usb_hcd_link_urb_to_ep(hcd, urb);
2064 qh = ret ? NULL : hep->hcpriv;
2067 spin_unlock_irqrestore(&musb->lock, flags);
2069 /* DMA mapping was already done, if needed, and this urb is on
2070 * hep->urb_list now ... so we're done, unless hep wasn't yet
2071 * scheduled onto a live qh.
2073 * REVISIT best to keep hep->hcpriv valid until the endpoint gets
2074 * disabled, testing for empty qh->ring and avoiding qh setup costs
2075 * except for the first urb queued after a config change.
2080 /* Allocate and initialize qh, minimizing the work done each time
2081 * hw_ep gets reprogrammed, or with irqs blocked. Then schedule it.
2083 * REVISIT consider a dedicated qh kmem_cache, so it's harder
2084 * for bugs in other kernel code to break this driver...
2086 qh = kzalloc(sizeof *qh, mem_flags);
2088 spin_lock_irqsave(&musb->lock, flags);
2089 usb_hcd_unlink_urb_from_ep(hcd, urb);
2090 spin_unlock_irqrestore(&musb->lock, flags);
2096 INIT_LIST_HEAD(&qh->ring);
2099 qh->maxpacket = usb_endpoint_maxp(epd);
2100 qh->type = usb_endpoint_type(epd);
2102 /* Bits 11 & 12 of wMaxPacketSize encode high bandwidth multiplier.
2103 * Some musb cores don't support high bandwidth ISO transfers; and
2104 * we don't (yet!) support high bandwidth interrupt transfers.
2106 qh->hb_mult = 1 + ((qh->maxpacket >> 11) & 0x03);
2107 if (qh->hb_mult > 1) {
2108 int ok = (qh->type == USB_ENDPOINT_XFER_ISOC);
2111 ok = (usb_pipein(urb->pipe) && musb->hb_iso_rx)
2112 || (usb_pipeout(urb->pipe) && musb->hb_iso_tx);
2117 qh->maxpacket &= 0x7ff;
2120 qh->epnum = usb_endpoint_num(epd);
2122 /* NOTE: urb->dev->devnum is wrong during SET_ADDRESS */
2123 qh->addr_reg = (u8) usb_pipedevice(urb->pipe);
2125 /* precompute rxtype/txtype/type0 register */
2126 type_reg = (qh->type << 4) | qh->epnum;
2127 switch (urb->dev->speed) {
2131 case USB_SPEED_FULL:
2137 qh->type_reg = type_reg;
2139 /* Precompute RXINTERVAL/TXINTERVAL register */
2141 case USB_ENDPOINT_XFER_INT:
2143 * Full/low speeds use the linear encoding,
2144 * high speed uses the logarithmic encoding.
2146 if (urb->dev->speed <= USB_SPEED_FULL) {
2147 interval = max_t(u8, epd->bInterval, 1);
2151 case USB_ENDPOINT_XFER_ISOC:
2152 /* ISO always uses logarithmic encoding */
2153 interval = min_t(u8, epd->bInterval, 16);
2156 /* REVISIT we actually want to use NAK limits, hinting to the
2157 * transfer scheduling logic to try some other qh, e.g. try
2160 * interval = (USB_SPEED_HIGH == urb->dev->speed) ? 16 : 2;
2162 * The downside of disabling this is that transfer scheduling
2163 * gets VERY unfair for nonperiodic transfers; a misbehaving
2164 * peripheral could make that hurt. That's perfectly normal
2165 * for reads from network or serial adapters ... so we have
2166 * partial NAKlimit support for bulk RX.
2168 * The upside of disabling it is simpler transfer scheduling.
2172 qh->intv_reg = interval;
2174 /* precompute addressing for external hub/tt ports */
2175 if (musb->is_multipoint) {
2176 struct usb_device *parent = urb->dev->parent;
2178 if (parent != hcd->self.root_hub) {
2179 qh->h_addr_reg = (u8) parent->devnum;
2181 /* set up tt info if needed */
2183 qh->h_port_reg = (u8) urb->dev->ttport;
2184 if (urb->dev->tt->hub)
2186 (u8) urb->dev->tt->hub->devnum;
2187 if (urb->dev->tt->multi)
2188 qh->h_addr_reg |= 0x80;
2193 /* invariant: hep->hcpriv is null OR the qh that's already scheduled.
2194 * until we get real dma queues (with an entry for each urb/buffer),
2195 * we only have work to do in the former case.
2197 spin_lock_irqsave(&musb->lock, flags);
2198 if (hep->hcpriv || !next_urb(qh)) {
2199 /* some concurrent activity submitted another urb to hep...
2200 * odd, rare, error prone, but legal.
2206 ret = musb_schedule(musb, qh,
2207 epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK);
2211 /* FIXME set urb->start_frame for iso/intr, it's tested in
2212 * musb_start_urb(), but otherwise only konicawc cares ...
2215 spin_unlock_irqrestore(&musb->lock, flags);
2219 spin_lock_irqsave(&musb->lock, flags);
2220 usb_hcd_unlink_urb_from_ep(hcd, urb);
2221 spin_unlock_irqrestore(&musb->lock, flags);
2229 * abort a transfer that's at the head of a hardware queue.
2230 * called with controller locked, irqs blocked
2231 * that hardware queue advances to the next transfer, unless prevented
2233 static int musb_cleanup_urb(struct urb *urb, struct musb_qh *qh)
2235 struct musb_hw_ep *ep = qh->hw_ep;
2236 struct musb *musb = ep->musb;
2237 void __iomem *epio = ep->regs;
2238 unsigned hw_end = ep->epnum;
2239 void __iomem *regs = ep->musb->mregs;
2240 int is_in = usb_pipein(urb->pipe);
2244 musb_ep_select(regs, hw_end);
2246 if (is_dma_capable()) {
2247 struct dma_channel *dma;
2249 dma = is_in ? ep->rx_channel : ep->tx_channel;
2251 status = ep->musb->dma_controller->channel_abort(dma);
2252 dev_dbg(musb->controller,
2253 "abort %cX%d DMA for urb %p --> %d\n",
2254 is_in ? 'R' : 'T', ep->epnum,
2256 urb->actual_length += dma->actual_len;
2260 /* turn off DMA requests, discard state, stop polling ... */
2261 if (ep->epnum && is_in) {
2262 /* giveback saves bulk toggle */
2263 csr = musb_h_flush_rxfifo(ep, 0);
2265 /* REVISIT we still get an irq; should likely clear the
2266 * endpoint's irq status here to avoid bogus irqs.
2267 * clearing that status is platform-specific...
2269 } else if (ep->epnum) {
2270 musb_h_tx_flush_fifo(ep);
2271 csr = musb_readw(epio, MUSB_TXCSR);
2272 csr &= ~(MUSB_TXCSR_AUTOSET
2273 | MUSB_TXCSR_DMAENAB
2274 | MUSB_TXCSR_H_RXSTALL
2275 | MUSB_TXCSR_H_NAKTIMEOUT
2276 | MUSB_TXCSR_H_ERROR
2277 | MUSB_TXCSR_TXPKTRDY);
2278 musb_writew(epio, MUSB_TXCSR, csr);
2279 /* REVISIT may need to clear FLUSHFIFO ... */
2280 musb_writew(epio, MUSB_TXCSR, csr);
2281 /* flush cpu writebuffer */
2282 csr = musb_readw(epio, MUSB_TXCSR);
2284 musb_h_ep0_flush_fifo(ep);
2287 musb_advance_schedule(ep->musb, urb, ep, is_in);
2291 static int musb_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
2293 struct musb *musb = hcd_to_musb(hcd);
2295 unsigned long flags;
2296 int is_in = usb_pipein(urb->pipe);
2299 dev_dbg(musb->controller, "urb=%p, dev%d ep%d%s\n", urb,
2300 usb_pipedevice(urb->pipe),
2301 usb_pipeendpoint(urb->pipe),
2302 is_in ? "in" : "out");
2304 spin_lock_irqsave(&musb->lock, flags);
2305 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
2314 * Any URB not actively programmed into endpoint hardware can be
2315 * immediately given back; that's any URB not at the head of an
2316 * endpoint queue, unless someday we get real DMA queues. And even
2317 * if it's at the head, it might not be known to the hardware...
2319 * Otherwise abort current transfer, pending DMA, etc.; urb->status
2320 * has already been updated. This is a synchronous abort; it'd be
2321 * OK to hold off until after some IRQ, though.
2323 * NOTE: qh is invalid unless !list_empty(&hep->urb_list)
2326 || urb->urb_list.prev != &qh->hep->urb_list
2327 || musb_ep_get_qh(qh->hw_ep, is_in) != qh) {
2328 int ready = qh->is_ready;
2331 musb_giveback(musb, urb, 0);
2332 qh->is_ready = ready;
2334 /* If nothing else (usually musb_giveback) is using it
2335 * and its URB list has emptied, recycle this qh.
2337 if (ready && list_empty(&qh->hep->urb_list)) {
2338 qh->hep->hcpriv = NULL;
2339 list_del(&qh->ring);
2343 ret = musb_cleanup_urb(urb, qh);
2345 spin_unlock_irqrestore(&musb->lock, flags);
2349 /* disable an endpoint */
2351 musb_h_disable(struct usb_hcd *hcd, struct usb_host_endpoint *hep)
2353 u8 is_in = hep->desc.bEndpointAddress & USB_DIR_IN;
2354 unsigned long flags;
2355 struct musb *musb = hcd_to_musb(hcd);
2359 spin_lock_irqsave(&musb->lock, flags);
2365 /* NOTE: qh is invalid unless !list_empty(&hep->urb_list) */
2367 /* Kick the first URB off the hardware, if needed */
2369 if (musb_ep_get_qh(qh->hw_ep, is_in) == qh) {
2372 /* make software (then hardware) stop ASAP */
2374 urb->status = -ESHUTDOWN;
2377 musb_cleanup_urb(urb, qh);
2379 /* Then nuke all the others ... and advance the
2380 * queue on hw_ep (e.g. bulk ring) when we're done.
2382 while (!list_empty(&hep->urb_list)) {
2384 urb->status = -ESHUTDOWN;
2385 musb_advance_schedule(musb, urb, qh->hw_ep, is_in);
2388 /* Just empty the queue; the hardware is busy with
2389 * other transfers, and since !qh->is_ready nothing
2390 * will activate any of these as it advances.
2392 while (!list_empty(&hep->urb_list))
2393 musb_giveback(musb, next_urb(qh), -ESHUTDOWN);
2396 list_del(&qh->ring);
2400 spin_unlock_irqrestore(&musb->lock, flags);
2403 static int musb_h_get_frame_number(struct usb_hcd *hcd)
2405 struct musb *musb = hcd_to_musb(hcd);
2407 return musb_readw(musb->mregs, MUSB_FRAME);
2410 static int musb_h_start(struct usb_hcd *hcd)
2412 struct musb *musb = hcd_to_musb(hcd);
2414 /* NOTE: musb_start() is called when the hub driver turns
2415 * on port power, or when (OTG) peripheral starts.
2417 hcd->state = HC_STATE_RUNNING;
2418 musb->port1_status = 0;
2422 static void musb_h_stop(struct usb_hcd *hcd)
2424 musb_stop(hcd_to_musb(hcd));
2425 hcd->state = HC_STATE_HALT;
2428 static int musb_bus_suspend(struct usb_hcd *hcd)
2430 struct musb *musb = hcd_to_musb(hcd);
2433 if (!is_host_active(musb))
2436 switch (musb->xceiv->state) {
2437 case OTG_STATE_A_SUSPEND:
2439 case OTG_STATE_A_WAIT_VRISE:
2440 /* ID could be grounded even if there's no device
2441 * on the other end of the cable. NOTE that the
2442 * A_WAIT_VRISE timers are messy with MUSB...
2444 devctl = musb_readb(musb->mregs, MUSB_DEVCTL);
2445 if ((devctl & MUSB_DEVCTL_VBUS) == MUSB_DEVCTL_VBUS)
2446 musb->xceiv->state = OTG_STATE_A_WAIT_BCON;
2452 if (musb->is_active) {
2453 WARNING("trying to suspend as %s while active\n",
2454 usb_otg_state_string(musb->xceiv->state));
2460 static int musb_bus_resume(struct usb_hcd *hcd)
2462 /* resuming child port does the work */
2467 #ifndef CONFIG_MUSB_PIO_ONLY
2469 #define MUSB_USB_DMA_ALIGN 4
2471 struct musb_temp_buffer {
2473 void *old_xfer_buffer;
2477 static void musb_free_temp_buffer(struct urb *urb)
2479 enum dma_data_direction dir;
2480 struct musb_temp_buffer *temp;
2482 if (!(urb->transfer_flags & URB_ALIGNED_TEMP_BUFFER))
2485 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
2487 temp = container_of(urb->transfer_buffer, struct musb_temp_buffer,
2490 if (dir == DMA_FROM_DEVICE) {
2491 memcpy(temp->old_xfer_buffer, temp->data,
2492 urb->transfer_buffer_length);
2494 urb->transfer_buffer = temp->old_xfer_buffer;
2495 kfree(temp->kmalloc_ptr);
2497 urb->transfer_flags &= ~URB_ALIGNED_TEMP_BUFFER;
2500 static int musb_alloc_temp_buffer(struct urb *urb, gfp_t mem_flags)
2502 enum dma_data_direction dir;
2503 struct musb_temp_buffer *temp;
2505 size_t kmalloc_size;
2507 if (urb->num_sgs || urb->sg ||
2508 urb->transfer_buffer_length == 0 ||
2509 !((uintptr_t)urb->transfer_buffer & (MUSB_USB_DMA_ALIGN - 1)))
2512 dir = usb_urb_dir_in(urb) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
2514 /* Allocate a buffer with enough padding for alignment */
2515 kmalloc_size = urb->transfer_buffer_length +
2516 sizeof(struct musb_temp_buffer) + MUSB_USB_DMA_ALIGN - 1;
2518 kmalloc_ptr = kmalloc(kmalloc_size, mem_flags);
2522 /* Position our struct temp_buffer such that data is aligned */
2523 temp = PTR_ALIGN(kmalloc_ptr, MUSB_USB_DMA_ALIGN);
2526 temp->kmalloc_ptr = kmalloc_ptr;
2527 temp->old_xfer_buffer = urb->transfer_buffer;
2528 if (dir == DMA_TO_DEVICE)
2529 memcpy(temp->data, urb->transfer_buffer,
2530 urb->transfer_buffer_length);
2531 urb->transfer_buffer = temp->data;
2533 urb->transfer_flags |= URB_ALIGNED_TEMP_BUFFER;
2538 static int musb_map_urb_for_dma(struct usb_hcd *hcd, struct urb *urb,
2541 struct musb *musb = hcd_to_musb(hcd);
2545 * The DMA engine in RTL1.8 and above cannot handle
2546 * DMA addresses that are not aligned to a 4 byte boundary.
2547 * For such engine implemented (un)map_urb_for_dma hooks.
2548 * Do not use these hooks for RTL<1.8
2550 if (musb->hwvers < MUSB_HWVERS_1800)
2551 return usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
2553 ret = musb_alloc_temp_buffer(urb, mem_flags);
2557 ret = usb_hcd_map_urb_for_dma(hcd, urb, mem_flags);
2559 musb_free_temp_buffer(urb);
2564 static void musb_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
2566 struct musb *musb = hcd_to_musb(hcd);
2568 usb_hcd_unmap_urb_for_dma(hcd, urb);
2570 /* Do not use this hook for RTL<1.8 (see description above) */
2571 if (musb->hwvers < MUSB_HWVERS_1800)
2574 musb_free_temp_buffer(urb);
2576 #endif /* !CONFIG_MUSB_PIO_ONLY */
2578 const struct hc_driver musb_hc_driver = {
2579 .description = "musb-hcd",
2580 .product_desc = "MUSB HDRC host driver",
2581 .hcd_priv_size = sizeof(struct musb),
2582 .flags = HCD_USB2 | HCD_MEMORY,
2584 /* not using irq handler or reset hooks from usbcore, since
2585 * those must be shared with peripheral code for OTG configs
2588 .start = musb_h_start,
2589 .stop = musb_h_stop,
2591 .get_frame_number = musb_h_get_frame_number,
2593 .urb_enqueue = musb_urb_enqueue,
2594 .urb_dequeue = musb_urb_dequeue,
2595 .endpoint_disable = musb_h_disable,
2597 #ifndef CONFIG_MUSB_PIO_ONLY
2598 .map_urb_for_dma = musb_map_urb_for_dma,
2599 .unmap_urb_for_dma = musb_unmap_urb_for_dma,
2602 .hub_status_data = musb_hub_status_data,
2603 .hub_control = musb_hub_control,
2604 .bus_suspend = musb_bus_suspend,
2605 .bus_resume = musb_bus_resume,
2606 /* .start_port_reset = NULL, */
2607 /* .hub_irq_enable = NULL, */