2 * Driver for the PLX NET2280 USB device controller.
3 * Specs and errata are available from <http://www.plxtech.com>.
5 * PLX Technology Inc. (formerly NetChip Technology) supported the
6 * development of this driver.
9 * CODE STATUS HIGHLIGHTS
11 * This driver should work well with most "gadget" drivers, including
12 * the File Storage, Serial, and Ethernet/RNDIS gadget drivers
13 * as well as Gadget Zero and Gadgetfs.
15 * DMA is enabled by default. Drivers using transfer queues might use
16 * DMA chaining to remove IRQ latencies between transfers. (Except when
17 * short OUT transfers happen.) Drivers can use the req->no_interrupt
18 * hint to completely eliminate some IRQs, if a later IRQ is guaranteed
19 * and DMA chaining is enabled.
21 * Note that almost all the errata workarounds here are only needed for
22 * rev1 chips. Rev1a silicon (0110) fixes almost all of them.
26 * Copyright (C) 2003 David Brownell
27 * Copyright (C) 2003-2005 PLX Technology, Inc.
29 * Modified Seth Levy 2005 PLX Technology, Inc. to provide compatibility
32 * This program is free software; you can redistribute it and/or modify
33 * it under the terms of the GNU General Public License as published by
34 * the Free Software Foundation; either version 2 of the License, or
35 * (at your option) any later version.
37 * This program is distributed in the hope that it will be useful,
38 * but WITHOUT ANY WARRANTY; without even the implied warranty of
39 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
40 * GNU General Public License for more details.
42 * You should have received a copy of the GNU General Public License
43 * along with this program; if not, write to the Free Software
44 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
47 #undef DEBUG /* messages on error and most fault paths */
48 #undef VERBOSE /* extra debug messages (success too) */
50 #include <linux/module.h>
51 #include <linux/pci.h>
52 #include <linux/dma-mapping.h>
53 #include <linux/kernel.h>
54 #include <linux/delay.h>
55 #include <linux/ioport.h>
56 #include <linux/slab.h>
57 #include <linux/smp_lock.h>
58 #include <linux/errno.h>
59 #include <linux/init.h>
60 #include <linux/timer.h>
61 #include <linux/list.h>
62 #include <linux/interrupt.h>
63 #include <linux/moduleparam.h>
64 #include <linux/device.h>
65 #include <linux/usb/ch9.h>
66 #include <linux/usb_gadget.h>
68 #include <asm/byteorder.h>
71 #include <asm/system.h>
72 #include <asm/unaligned.h>
75 #define DRIVER_DESC "PLX NET228x USB Peripheral Controller"
76 #define DRIVER_VERSION "2005 Sept 27"
78 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
79 #define EP_DONTUSE 13 /* nonzero */
81 #define USE_RDK_LEDS /* GPIO pins control three LEDs */
84 static const char driver_name [] = "net2280";
85 static const char driver_desc [] = DRIVER_DESC;
87 static const char ep0name [] = "ep0";
88 static const char *const ep_name [] = {
90 "ep-a", "ep-b", "ep-c", "ep-d",
94 /* use_dma -- general goodness, fewer interrupts, less cpu load (vs PIO)
95 * use_dma_chaining -- dma descriptor queueing gives even more irq reduction
97 * The net2280 DMA engines are not tightly integrated with their FIFOs;
98 * not all cases are (yet) handled well in this driver or the silicon.
99 * Some gadget drivers work better with the dma support here than others.
100 * These two parameters let you use PIO or more aggressive DMA.
102 static int use_dma = 1;
103 static int use_dma_chaining = 0;
105 /* "modprobe net2280 use_dma=n" etc */
106 module_param (use_dma, bool, S_IRUGO);
107 module_param (use_dma_chaining, bool, S_IRUGO);
110 /* mode 0 == ep-{a,b,c,d} 1K fifo each
111 * mode 1 == ep-{a,b} 2K fifo each, ep-{c,d} unavailable
112 * mode 2 == ep-a 2K fifo, ep-{b,c} 1K each, ep-d unavailable
114 static ushort fifo_mode = 0;
116 /* "modprobe net2280 fifo_mode=1" etc */
117 module_param (fifo_mode, ushort, 0644);
119 /* enable_suspend -- When enabled, the driver will respond to
120 * USB suspend requests by powering down the NET2280. Otherwise,
121 * USB suspend requests will be ignored. This is acceptible for
122 * self-powered devices
124 static int enable_suspend = 0;
126 /* "modprobe net2280 enable_suspend=1" etc */
127 module_param (enable_suspend, bool, S_IRUGO);
130 #define DIR_STRING(bAddress) (((bAddress) & USB_DIR_IN) ? "in" : "out")
132 #if defined(CONFIG_USB_GADGET_DEBUG_FILES) || defined (DEBUG)
133 static char *type_string (u8 bmAttributes)
135 switch ((bmAttributes) & USB_ENDPOINT_XFERTYPE_MASK) {
136 case USB_ENDPOINT_XFER_BULK: return "bulk";
137 case USB_ENDPOINT_XFER_ISOC: return "iso";
138 case USB_ENDPOINT_XFER_INT: return "intr";
146 #define valid_bit __constant_cpu_to_le32 (1 << VALID_BIT)
147 #define dma_done_ie __constant_cpu_to_le32 (1 << DMA_DONE_INTERRUPT_ENABLE)
149 /*-------------------------------------------------------------------------*/
152 net2280_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
155 struct net2280_ep *ep;
159 ep = container_of (_ep, struct net2280_ep, ep);
160 if (!_ep || !desc || ep->desc || _ep->name == ep0name
161 || desc->bDescriptorType != USB_DT_ENDPOINT)
164 if (!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN)
167 /* erratum 0119 workaround ties up an endpoint number */
168 if ((desc->bEndpointAddress & 0x0f) == EP_DONTUSE)
171 /* sanity check ep-e/ep-f since their fifos are small */
172 max = le16_to_cpu (desc->wMaxPacketSize) & 0x1fff;
173 if (ep->num > 4 && max > 64)
176 spin_lock_irqsave (&dev->lock, flags);
177 _ep->maxpacket = max & 0x7ff;
180 /* ep_reset() has already been called */
182 ep->out_overflow = 0;
184 /* set speed-dependent max packet; may kick in high bandwidth */
185 set_idx_reg (dev->regs, REG_EP_MAXPKT (dev, ep->num), max);
187 /* FIFO lines can't go to different packets. PIO is ok, so
188 * use it instead of troublesome (non-bulk) multi-packet DMA.
190 if (ep->dma && (max % 4) != 0 && use_dma_chaining) {
191 DEBUG (ep->dev, "%s, no dma for maxpacket %d\n",
192 ep->ep.name, ep->ep.maxpacket);
196 /* set type, direction, address; reset fifo counters */
197 writel ((1 << FIFO_FLUSH), &ep->regs->ep_stat);
198 tmp = (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
199 if (tmp == USB_ENDPOINT_XFER_INT) {
200 /* erratum 0105 workaround prevents hs NYET */
201 if (dev->chiprev == 0100
202 && dev->gadget.speed == USB_SPEED_HIGH
203 && !(desc->bEndpointAddress & USB_DIR_IN))
204 writel ((1 << CLEAR_NAK_OUT_PACKETS_MODE),
206 } else if (tmp == USB_ENDPOINT_XFER_BULK) {
207 /* catch some particularly blatant driver bugs */
208 if ((dev->gadget.speed == USB_SPEED_HIGH
210 || (dev->gadget.speed == USB_SPEED_FULL
212 spin_unlock_irqrestore (&dev->lock, flags);
216 ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC) ? 1 : 0;
217 tmp <<= ENDPOINT_TYPE;
218 tmp |= desc->bEndpointAddress;
219 tmp |= (4 << ENDPOINT_BYTE_COUNT); /* default full fifo lines */
220 tmp |= 1 << ENDPOINT_ENABLE;
223 /* for OUT transfers, block the rx fifo until a read is posted */
224 ep->is_in = (tmp & USB_DIR_IN) != 0;
226 writel ((1 << SET_NAK_OUT_PACKETS), &ep->regs->ep_rsp);
227 else if (dev->pdev->device != 0x2280) {
228 /* Added for 2282, Don't use nak packets on an in endpoint,
229 * this was ignored on 2280
231 writel ((1 << CLEAR_NAK_OUT_PACKETS)
232 | (1 << CLEAR_NAK_OUT_PACKETS_MODE), &ep->regs->ep_rsp);
235 writel (tmp, &ep->regs->ep_cfg);
238 if (!ep->dma) { /* pio, per-packet */
239 tmp = (1 << ep->num) | readl (&dev->regs->pciirqenb0);
240 writel (tmp, &dev->regs->pciirqenb0);
242 tmp = (1 << DATA_PACKET_RECEIVED_INTERRUPT_ENABLE)
243 | (1 << DATA_PACKET_TRANSMITTED_INTERRUPT_ENABLE);
244 if (dev->pdev->device == 0x2280)
245 tmp |= readl (&ep->regs->ep_irqenb);
246 writel (tmp, &ep->regs->ep_irqenb);
247 } else { /* dma, per-request */
248 tmp = (1 << (8 + ep->num)); /* completion */
249 tmp |= readl (&dev->regs->pciirqenb1);
250 writel (tmp, &dev->regs->pciirqenb1);
252 /* for short OUT transfers, dma completions can't
253 * advance the queue; do it pio-style, by hand.
254 * NOTE erratum 0112 workaround #2
256 if ((desc->bEndpointAddress & USB_DIR_IN) == 0) {
257 tmp = (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT_ENABLE);
258 writel (tmp, &ep->regs->ep_irqenb);
260 tmp = (1 << ep->num) | readl (&dev->regs->pciirqenb0);
261 writel (tmp, &dev->regs->pciirqenb0);
265 tmp = desc->bEndpointAddress;
266 DEBUG (dev, "enabled %s (ep%d%s-%s) %s max %04x\n",
267 _ep->name, tmp & 0x0f, DIR_STRING (tmp),
268 type_string (desc->bmAttributes),
269 ep->dma ? "dma" : "pio", max);
271 /* pci writes may still be posted */
272 spin_unlock_irqrestore (&dev->lock, flags);
276 static int handshake (u32 __iomem *ptr, u32 mask, u32 done, int usec)
281 result = readl (ptr);
282 if (result == ~(u32)0) /* "device unplugged" */
293 static const struct usb_ep_ops net2280_ep_ops;
295 static void ep_reset (struct net2280_regs __iomem *regs, struct net2280_ep *ep)
300 INIT_LIST_HEAD (&ep->queue);
302 ep->ep.maxpacket = ~0;
303 ep->ep.ops = &net2280_ep_ops;
305 /* disable the dma, irqs, endpoint... */
307 writel (0, &ep->dma->dmactl);
308 writel ( (1 << DMA_SCATTER_GATHER_DONE_INTERRUPT)
309 | (1 << DMA_TRANSACTION_DONE_INTERRUPT)
311 , &ep->dma->dmastat);
313 tmp = readl (®s->pciirqenb0);
314 tmp &= ~(1 << ep->num);
315 writel (tmp, ®s->pciirqenb0);
317 tmp = readl (®s->pciirqenb1);
318 tmp &= ~(1 << (8 + ep->num)); /* completion */
319 writel (tmp, ®s->pciirqenb1);
321 writel (0, &ep->regs->ep_irqenb);
323 /* init to our chosen defaults, notably so that we NAK OUT
324 * packets until the driver queues a read (+note erratum 0112)
326 if (!ep->is_in || ep->dev->pdev->device == 0x2280) {
327 tmp = (1 << SET_NAK_OUT_PACKETS_MODE)
328 | (1 << SET_NAK_OUT_PACKETS)
329 | (1 << CLEAR_EP_HIDE_STATUS_PHASE)
330 | (1 << CLEAR_INTERRUPT_MODE);
333 tmp = (1 << CLEAR_NAK_OUT_PACKETS_MODE)
334 | (1 << CLEAR_NAK_OUT_PACKETS)
335 | (1 << CLEAR_EP_HIDE_STATUS_PHASE)
336 | (1 << CLEAR_INTERRUPT_MODE);
340 tmp |= (1 << CLEAR_ENDPOINT_TOGGLE)
341 | (1 << CLEAR_ENDPOINT_HALT);
343 writel (tmp, &ep->regs->ep_rsp);
345 /* scrub most status bits, and flush any fifo state */
346 if (ep->dev->pdev->device == 0x2280)
347 tmp = (1 << FIFO_OVERFLOW)
348 | (1 << FIFO_UNDERFLOW);
352 writel (tmp | (1 << TIMEOUT)
353 | (1 << USB_STALL_SENT)
354 | (1 << USB_IN_NAK_SENT)
355 | (1 << USB_IN_ACK_RCVD)
356 | (1 << USB_OUT_PING_NAK_SENT)
357 | (1 << USB_OUT_ACK_SENT)
359 | (1 << SHORT_PACKET_OUT_DONE_INTERRUPT)
360 | (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT)
361 | (1 << DATA_PACKET_RECEIVED_INTERRUPT)
362 | (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)
363 | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
364 | (1 << DATA_IN_TOKEN_INTERRUPT)
365 , &ep->regs->ep_stat);
367 /* fifo size is handled separately */
370 static void nuke (struct net2280_ep *);
372 static int net2280_disable (struct usb_ep *_ep)
374 struct net2280_ep *ep;
377 ep = container_of (_ep, struct net2280_ep, ep);
378 if (!_ep || !ep->desc || _ep->name == ep0name)
381 spin_lock_irqsave (&ep->dev->lock, flags);
383 ep_reset (ep->dev->regs, ep);
385 VDEBUG (ep->dev, "disabled %s %s\n",
386 ep->dma ? "dma" : "pio", _ep->name);
388 /* synch memory views with the device */
389 (void) readl (&ep->regs->ep_cfg);
391 if (use_dma && !ep->dma && ep->num >= 1 && ep->num <= 4)
392 ep->dma = &ep->dev->dma [ep->num - 1];
394 spin_unlock_irqrestore (&ep->dev->lock, flags);
398 /*-------------------------------------------------------------------------*/
400 static struct usb_request *
401 net2280_alloc_request (struct usb_ep *_ep, gfp_t gfp_flags)
403 struct net2280_ep *ep;
404 struct net2280_request *req;
408 ep = container_of (_ep, struct net2280_ep, ep);
410 req = kzalloc(sizeof(*req), gfp_flags);
414 req->req.dma = DMA_ADDR_INVALID;
415 INIT_LIST_HEAD (&req->queue);
417 /* this dma descriptor may be swapped with the previous dummy */
419 struct net2280_dma *td;
421 td = pci_pool_alloc (ep->dev->requests, gfp_flags,
427 td->dmacount = 0; /* not VALID */
428 td->dmaaddr = __constant_cpu_to_le32 (DMA_ADDR_INVALID);
429 td->dmadesc = td->dmaaddr;
436 net2280_free_request (struct usb_ep *_ep, struct usb_request *_req)
438 struct net2280_ep *ep;
439 struct net2280_request *req;
441 ep = container_of (_ep, struct net2280_ep, ep);
445 req = container_of (_req, struct net2280_request, req);
446 WARN_ON (!list_empty (&req->queue));
448 pci_pool_free (ep->dev->requests, req->td, req->td_dma);
452 /*-------------------------------------------------------------------------*/
455 * dma-coherent memory allocation (for dma-capable endpoints)
457 * NOTE: the dma_*_coherent() API calls suck. Most implementations are
458 * (a) page-oriented, so small buffers lose big; and (b) asymmetric with
459 * respect to calls with irqs disabled: alloc is safe, free is not.
460 * We currently work around (b), but not (a).
464 net2280_alloc_buffer (
472 struct net2280_ep *ep;
474 ep = container_of (_ep, struct net2280_ep, ep);
477 *dma = DMA_ADDR_INVALID;
480 retval = dma_alloc_coherent(&ep->dev->pdev->dev,
481 bytes, dma, gfp_flags);
483 retval = kmalloc(bytes, gfp_flags);
487 static DEFINE_SPINLOCK(buflock);
488 static LIST_HEAD(buffers);
491 struct list_head list;
497 static void do_free(unsigned long ignored)
499 spin_lock_irq(&buflock);
500 while (!list_empty(&buffers)) {
501 struct free_record *buf;
503 buf = list_entry(buffers.next, struct free_record, list);
504 list_del(&buf->list);
505 spin_unlock_irq(&buflock);
507 dma_free_coherent(buf->dev, buf->bytes, buf, buf->dma);
509 spin_lock_irq(&buflock);
511 spin_unlock_irq(&buflock);
514 static DECLARE_TASKLET(deferred_free, do_free, 0);
517 net2280_free_buffer (
523 /* free memory into the right allocator */
524 if (dma != DMA_ADDR_INVALID) {
525 struct net2280_ep *ep;
526 struct free_record *buf = address;
529 ep = container_of(_ep, struct net2280_ep, ep);
533 ep = container_of (_ep, struct net2280_ep, ep);
534 buf->dev = &ep->dev->pdev->dev;
538 spin_lock_irqsave(&buflock, flags);
539 list_add_tail(&buf->list, &buffers);
540 tasklet_schedule(&deferred_free);
541 spin_unlock_irqrestore(&buflock, flags);
546 /*-------------------------------------------------------------------------*/
548 /* load a packet into the fifo we use for usb IN transfers.
549 * works for all endpoints.
551 * NOTE: pio with ep-a..ep-d could stuff multiple packets into the fifo
552 * at a time, but this code is simpler because it knows it only writes
553 * one packet. ep-a..ep-d should use dma instead.
556 write_fifo (struct net2280_ep *ep, struct usb_request *req)
558 struct net2280_ep_regs __iomem *regs = ep->regs;
561 unsigned count, total;
563 /* INVARIANT: fifo is currently empty. (testable) */
566 buf = req->buf + req->actual;
568 total = req->length - req->actual;
574 /* write just one packet at a time */
575 count = ep->ep.maxpacket;
576 if (count > total) /* min() cannot be used on a bitfield */
579 VDEBUG (ep->dev, "write %s fifo (IN) %d bytes%s req %p\n",
581 (count != ep->ep.maxpacket) ? " (short)" : "",
584 /* NOTE be careful if you try to align these. fifo lines
585 * should normally be full (4 bytes) and successive partial
586 * lines are ok only in certain cases.
588 tmp = get_unaligned ((u32 *)buf);
590 writel (tmp, ®s->ep_data);
595 /* last fifo entry is "short" unless we wrote a full packet.
596 * also explicitly validate last word in (periodic) transfers
597 * when maxpacket is not a multiple of 4 bytes.
599 if (count || total < ep->ep.maxpacket) {
600 tmp = count ? get_unaligned ((u32 *)buf) : count;
602 set_fifo_bytecount (ep, count & 0x03);
603 writel (tmp, ®s->ep_data);
606 /* pci writes may still be posted */
609 /* work around erratum 0106: PCI and USB race over the OUT fifo.
610 * caller guarantees chiprev 0100, out endpoint is NAKing, and
611 * there's no real data in the fifo.
613 * NOTE: also used in cases where that erratum doesn't apply:
614 * where the host wrote "too much" data to us.
616 static void out_flush (struct net2280_ep *ep)
621 ASSERT_OUT_NAKING (ep);
623 statp = &ep->regs->ep_stat;
624 writel ( (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
625 | (1 << DATA_PACKET_RECEIVED_INTERRUPT)
627 writel ((1 << FIFO_FLUSH), statp);
630 if (tmp & (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
631 /* high speed did bulk NYET; fifo isn't filling */
632 && ep->dev->gadget.speed == USB_SPEED_FULL) {
635 usec = 50; /* 64 byte bulk/interrupt */
636 handshake (statp, (1 << USB_OUT_PING_NAK_SENT),
637 (1 << USB_OUT_PING_NAK_SENT), usec);
638 /* NAK done; now CLEAR_NAK_OUT_PACKETS is safe */
642 /* unload packet(s) from the fifo we use for usb OUT transfers.
643 * returns true iff the request completed, because of short packet
644 * or the request buffer having filled with full packets.
646 * for ep-a..ep-d this will read multiple packets out when they
647 * have been accepted.
650 read_fifo (struct net2280_ep *ep, struct net2280_request *req)
652 struct net2280_ep_regs __iomem *regs = ep->regs;
653 u8 *buf = req->req.buf + req->req.actual;
654 unsigned count, tmp, is_short;
655 unsigned cleanup = 0, prevent = 0;
657 /* erratum 0106 ... packets coming in during fifo reads might
658 * be incompletely rejected. not all cases have workarounds.
660 if (ep->dev->chiprev == 0x0100
661 && ep->dev->gadget.speed == USB_SPEED_FULL) {
663 tmp = readl (&ep->regs->ep_stat);
664 if ((tmp & (1 << NAK_OUT_PACKETS)))
666 else if ((tmp & (1 << FIFO_FULL))) {
667 start_out_naking (ep);
670 /* else: hope we don't see the problem */
673 /* never overflow the rx buffer. the fifo reads packets until
674 * it sees a short one; we might not be ready for them all.
677 count = readl (®s->ep_avail);
678 if (unlikely (count == 0)) {
680 tmp = readl (&ep->regs->ep_stat);
681 count = readl (®s->ep_avail);
682 /* handled that data already? */
683 if (count == 0 && (tmp & (1 << NAK_OUT_PACKETS)) == 0)
687 tmp = req->req.length - req->req.actual;
689 /* as with DMA, data overflow gets flushed */
690 if ((tmp % ep->ep.maxpacket) != 0) {
692 "%s out fifo %d bytes, expected %d\n",
693 ep->ep.name, count, tmp);
694 req->req.status = -EOVERFLOW;
696 /* NAK_OUT_PACKETS will be set, so flushing is safe;
697 * the next read will start with the next packet
699 } /* else it's a ZLP, no worries */
702 req->req.actual += count;
704 is_short = (count == 0) || ((count % ep->ep.maxpacket) != 0);
706 VDEBUG (ep->dev, "read %s fifo (OUT) %d bytes%s%s%s req %p %d/%d\n",
707 ep->ep.name, count, is_short ? " (short)" : "",
708 cleanup ? " flush" : "", prevent ? " nak" : "",
709 req, req->req.actual, req->req.length);
712 tmp = readl (®s->ep_data);
714 put_unaligned (tmp, (u32 *)buf);
719 tmp = readl (®s->ep_data);
720 /* LE conversion is implicit here: */
729 writel ((1 << CLEAR_NAK_OUT_PACKETS), &ep->regs->ep_rsp);
730 (void) readl (&ep->regs->ep_rsp);
733 return is_short || ((req->req.actual == req->req.length)
737 /* fill out dma descriptor to match a given request */
739 fill_dma_desc (struct net2280_ep *ep, struct net2280_request *req, int valid)
741 struct net2280_dma *td = req->td;
742 u32 dmacount = req->req.length;
744 /* don't let DMA continue after a short OUT packet,
745 * so overruns can't affect the next transfer.
746 * in case of overruns on max-size packets, we can't
747 * stop the fifo from filling but we can flush it.
750 dmacount |= (1 << DMA_DIRECTION);
751 if ((!ep->is_in && (dmacount % ep->ep.maxpacket) != 0)
752 || ep->dev->pdev->device != 0x2280)
753 dmacount |= (1 << END_OF_CHAIN);
757 dmacount |= (1 << VALID_BIT);
758 if (likely(!req->req.no_interrupt || !use_dma_chaining))
759 dmacount |= (1 << DMA_DONE_INTERRUPT_ENABLE);
761 /* td->dmadesc = previously set by caller */
762 td->dmaaddr = cpu_to_le32 (req->req.dma);
764 /* 2280 may be polling VALID_BIT through ep->dma->dmadesc */
766 td->dmacount = cpu_to_le32p (&dmacount);
769 static const u32 dmactl_default =
770 (1 << DMA_SCATTER_GATHER_DONE_INTERRUPT)
771 | (1 << DMA_CLEAR_COUNT_ENABLE)
772 /* erratum 0116 workaround part 1 (use POLLING) */
773 | (POLL_100_USEC << DESCRIPTOR_POLLING_RATE)
774 | (1 << DMA_VALID_BIT_POLLING_ENABLE)
775 | (1 << DMA_VALID_BIT_ENABLE)
776 | (1 << DMA_SCATTER_GATHER_ENABLE)
777 /* erratum 0116 workaround part 2 (no AUTOSTART) */
780 static inline void spin_stop_dma (struct net2280_dma_regs __iomem *dma)
782 handshake (&dma->dmactl, (1 << DMA_ENABLE), 0, 50);
785 static inline void stop_dma (struct net2280_dma_regs __iomem *dma)
787 writel (readl (&dma->dmactl) & ~(1 << DMA_ENABLE), &dma->dmactl);
791 static void start_queue (struct net2280_ep *ep, u32 dmactl, u32 td_dma)
793 struct net2280_dma_regs __iomem *dma = ep->dma;
794 unsigned int tmp = (1 << VALID_BIT) | (ep->is_in << DMA_DIRECTION);
796 if (ep->dev->pdev->device != 0x2280)
797 tmp |= (1 << END_OF_CHAIN);
799 writel (tmp, &dma->dmacount);
800 writel (readl (&dma->dmastat), &dma->dmastat);
802 writel (td_dma, &dma->dmadesc);
803 writel (dmactl, &dma->dmactl);
805 /* erratum 0116 workaround part 3: pci arbiter away from net2280 */
806 (void) readl (&ep->dev->pci->pcimstctl);
808 writel ((1 << DMA_START), &dma->dmastat);
811 stop_out_naking (ep);
814 static void start_dma (struct net2280_ep *ep, struct net2280_request *req)
817 struct net2280_dma_regs __iomem *dma = ep->dma;
819 /* FIXME can't use DMA for ZLPs */
821 /* on this path we "know" there's no dma active (yet) */
822 WARN_ON (readl (&dma->dmactl) & (1 << DMA_ENABLE));
823 writel (0, &ep->dma->dmactl);
825 /* previous OUT packet might have been short */
826 if (!ep->is_in && ((tmp = readl (&ep->regs->ep_stat))
827 & (1 << NAK_OUT_PACKETS)) != 0) {
828 writel ((1 << SHORT_PACKET_TRANSFERRED_INTERRUPT),
831 tmp = readl (&ep->regs->ep_avail);
833 writel (readl (&dma->dmastat), &dma->dmastat);
835 /* transfer all/some fifo data */
836 writel (req->req.dma, &dma->dmaaddr);
837 tmp = min (tmp, req->req.length);
839 /* dma irq, faking scatterlist status */
840 req->td->dmacount = cpu_to_le32 (req->req.length - tmp);
841 writel ((1 << DMA_DONE_INTERRUPT_ENABLE)
842 | tmp, &dma->dmacount);
843 req->td->dmadesc = 0;
846 writel ((1 << DMA_ENABLE), &dma->dmactl);
847 writel ((1 << DMA_START), &dma->dmastat);
852 tmp = dmactl_default;
854 /* force packet boundaries between dma requests, but prevent the
855 * controller from automagically writing a last "short" packet
856 * (zero length) unless the driver explicitly said to do that.
859 if (likely ((req->req.length % ep->ep.maxpacket) != 0
861 tmp |= (1 << DMA_FIFO_VALIDATE);
862 ep->in_fifo_validate = 1;
864 ep->in_fifo_validate = 0;
867 /* init req->td, pointing to the current dummy */
868 req->td->dmadesc = cpu_to_le32 (ep->td_dma);
869 fill_dma_desc (ep, req, 1);
871 if (!use_dma_chaining)
872 req->td->dmacount |= __constant_cpu_to_le32 (1 << END_OF_CHAIN);
874 start_queue (ep, tmp, req->td_dma);
878 queue_dma (struct net2280_ep *ep, struct net2280_request *req, int valid)
880 struct net2280_dma *end;
883 /* swap new dummy for old, link; fill and maybe activate */
889 ep->td_dma = req->td_dma;
892 end->dmadesc = cpu_to_le32 (ep->td_dma);
894 fill_dma_desc (ep, req, valid);
898 done (struct net2280_ep *ep, struct net2280_request *req, int status)
901 unsigned stopped = ep->stopped;
903 list_del_init (&req->queue);
905 if (req->req.status == -EINPROGRESS)
906 req->req.status = status;
908 status = req->req.status;
912 pci_unmap_single (dev->pdev, req->req.dma, req->req.length,
913 ep->is_in ? PCI_DMA_TODEVICE : PCI_DMA_FROMDEVICE);
914 req->req.dma = DMA_ADDR_INVALID;
918 if (status && status != -ESHUTDOWN)
919 VDEBUG (dev, "complete %s req %p stat %d len %u/%u\n",
920 ep->ep.name, &req->req, status,
921 req->req.actual, req->req.length);
923 /* don't modify queue heads during completion callback */
925 spin_unlock (&dev->lock);
926 req->req.complete (&ep->ep, &req->req);
927 spin_lock (&dev->lock);
928 ep->stopped = stopped;
931 /*-------------------------------------------------------------------------*/
934 net2280_queue (struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
936 struct net2280_request *req;
937 struct net2280_ep *ep;
941 /* we always require a cpu-view buffer, so that we can
942 * always use pio (as fallback or whatever).
944 req = container_of (_req, struct net2280_request, req);
945 if (!_req || !_req->complete || !_req->buf
946 || !list_empty (&req->queue))
948 if (_req->length > (~0 & DMA_BYTE_COUNT_MASK))
950 ep = container_of (_ep, struct net2280_ep, ep);
951 if (!_ep || (!ep->desc && ep->num != 0))
954 if (!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN)
957 /* FIXME implement PIO fallback for ZLPs with DMA */
958 if (ep->dma && _req->length == 0)
961 /* set up dma mapping in case the caller didn't */
962 if (ep->dma && _req->dma == DMA_ADDR_INVALID) {
963 _req->dma = pci_map_single (dev->pdev, _req->buf, _req->length,
964 ep->is_in ? PCI_DMA_TODEVICE : PCI_DMA_FROMDEVICE);
969 VDEBUG (dev, "%s queue req %p, len %d buf %p\n",
970 _ep->name, _req, _req->length, _req->buf);
973 spin_lock_irqsave (&dev->lock, flags);
975 _req->status = -EINPROGRESS;
978 /* kickstart this i/o queue? */
979 if (list_empty (&ep->queue) && !ep->stopped) {
980 /* use DMA if the endpoint supports it, else pio */
984 /* maybe there's no control data, just status ack */
985 if (ep->num == 0 && _req->length == 0) {
988 VDEBUG (dev, "%s status ack\n", ep->ep.name);
992 /* PIO ... stuff the fifo, or unblock it. */
994 write_fifo (ep, _req);
995 else if (list_empty (&ep->queue)) {
998 /* OUT FIFO might have packet(s) buffered */
999 s = readl (&ep->regs->ep_stat);
1000 if ((s & (1 << FIFO_EMPTY)) == 0) {
1001 /* note: _req->short_not_ok is
1002 * ignored here since PIO _always_
1003 * stops queue advance here, and
1004 * _req->status doesn't change for
1005 * short reads (only _req->actual)
1007 if (read_fifo (ep, req)) {
1011 /* don't queue it */
1014 s = readl (&ep->regs->ep_stat);
1017 /* don't NAK, let the fifo fill */
1018 if (req && (s & (1 << NAK_OUT_PACKETS)))
1019 writel ((1 << CLEAR_NAK_OUT_PACKETS),
1024 } else if (ep->dma) {
1030 /* preventing magic zlps is per-engine state, not
1031 * per-transfer; irq logic must recover hiccups.
1033 expect = likely (req->req.zero
1034 || (req->req.length % ep->ep.maxpacket) != 0);
1035 if (expect != ep->in_fifo_validate)
1038 queue_dma (ep, req, valid);
1040 } /* else the irq handler advances the queue. */
1044 list_add_tail (&req->queue, &ep->queue);
1046 spin_unlock_irqrestore (&dev->lock, flags);
1048 /* pci writes may still be posted */
1054 struct net2280_ep *ep,
1055 struct net2280_request *req,
1060 req->req.actual = req->req.length - (DMA_BYTE_COUNT_MASK & dmacount);
1061 done (ep, req, status);
1064 static void restart_dma (struct net2280_ep *ep);
1066 static void scan_dma_completions (struct net2280_ep *ep)
1068 /* only look at descriptors that were "naturally" retired,
1069 * so fifo and list head state won't matter
1071 while (!list_empty (&ep->queue)) {
1072 struct net2280_request *req;
1075 req = list_entry (ep->queue.next,
1076 struct net2280_request, queue);
1080 tmp = le32_to_cpup (&req->td->dmacount);
1081 if ((tmp & (1 << VALID_BIT)) != 0)
1084 /* SHORT_PACKET_TRANSFERRED_INTERRUPT handles "usb-short"
1085 * cases where DMA must be aborted; this code handles
1086 * all non-abort DMA completions.
1088 if (unlikely (req->td->dmadesc == 0)) {
1090 tmp = readl (&ep->dma->dmacount);
1091 if (tmp & DMA_BYTE_COUNT_MASK)
1093 /* single transfer mode */
1094 dma_done (ep, req, tmp, 0);
1096 } else if (!ep->is_in
1097 && (req->req.length % ep->ep.maxpacket) != 0) {
1098 tmp = readl (&ep->regs->ep_stat);
1100 /* AVOID TROUBLE HERE by not issuing short reads from
1101 * your gadget driver. That helps avoids errata 0121,
1102 * 0122, and 0124; not all cases trigger the warning.
1104 if ((tmp & (1 << NAK_OUT_PACKETS)) == 0) {
1105 WARN (ep->dev, "%s lost packet sync!\n",
1107 req->req.status = -EOVERFLOW;
1108 } else if ((tmp = readl (&ep->regs->ep_avail)) != 0) {
1109 /* fifo gets flushed later */
1110 ep->out_overflow = 1;
1111 DEBUG (ep->dev, "%s dma, discard %d len %d\n",
1114 req->req.status = -EOVERFLOW;
1117 dma_done (ep, req, tmp, 0);
1121 static void restart_dma (struct net2280_ep *ep)
1123 struct net2280_request *req;
1124 u32 dmactl = dmactl_default;
1128 req = list_entry (ep->queue.next, struct net2280_request, queue);
1130 if (!use_dma_chaining) {
1131 start_dma (ep, req);
1135 /* the 2280 will be processing the queue unless queue hiccups after
1136 * the previous transfer:
1137 * IN: wanted automagic zlp, head doesn't (or vice versa)
1138 * DMA_FIFO_VALIDATE doesn't init from dma descriptors.
1139 * OUT: was "usb-short", we must restart.
1141 if (ep->is_in && !req->valid) {
1142 struct net2280_request *entry, *prev = NULL;
1143 int reqmode, done = 0;
1145 DEBUG (ep->dev, "%s dma hiccup td %p\n", ep->ep.name, req->td);
1146 ep->in_fifo_validate = likely (req->req.zero
1147 || (req->req.length % ep->ep.maxpacket) != 0);
1148 if (ep->in_fifo_validate)
1149 dmactl |= (1 << DMA_FIFO_VALIDATE);
1150 list_for_each_entry (entry, &ep->queue, queue) {
1155 dmacount = entry->td->dmacount;
1157 reqmode = likely (entry->req.zero
1158 || (entry->req.length
1159 % ep->ep.maxpacket) != 0);
1160 if (reqmode == ep->in_fifo_validate) {
1162 dmacount |= valid_bit;
1163 entry->td->dmacount = dmacount;
1167 /* force a hiccup */
1168 prev->td->dmacount |= dma_done_ie;
1173 /* walk the rest of the queue so unlinks behave */
1175 dmacount &= ~valid_bit;
1176 entry->td->dmacount = dmacount;
1181 writel (0, &ep->dma->dmactl);
1182 start_queue (ep, dmactl, req->td_dma);
1185 static void abort_dma (struct net2280_ep *ep)
1187 /* abort the current transfer */
1188 if (likely (!list_empty (&ep->queue))) {
1189 /* FIXME work around errata 0121, 0122, 0124 */
1190 writel ((1 << DMA_ABORT), &ep->dma->dmastat);
1191 spin_stop_dma (ep->dma);
1194 scan_dma_completions (ep);
1197 /* dequeue ALL requests */
1198 static void nuke (struct net2280_ep *ep)
1200 struct net2280_request *req;
1202 /* called with spinlock held */
1206 while (!list_empty (&ep->queue)) {
1207 req = list_entry (ep->queue.next,
1208 struct net2280_request,
1210 done (ep, req, -ESHUTDOWN);
1214 /* dequeue JUST ONE request */
1215 static int net2280_dequeue (struct usb_ep *_ep, struct usb_request *_req)
1217 struct net2280_ep *ep;
1218 struct net2280_request *req;
1219 unsigned long flags;
1223 ep = container_of (_ep, struct net2280_ep, ep);
1224 if (!_ep || (!ep->desc && ep->num != 0) || !_req)
1227 spin_lock_irqsave (&ep->dev->lock, flags);
1228 stopped = ep->stopped;
1230 /* quiesce dma while we patch the queue */
1234 dmactl = readl (&ep->dma->dmactl);
1235 /* WARNING erratum 0127 may kick in ... */
1237 scan_dma_completions (ep);
1240 /* make sure it's still queued on this endpoint */
1241 list_for_each_entry (req, &ep->queue, queue) {
1242 if (&req->req == _req)
1245 if (&req->req != _req) {
1246 spin_unlock_irqrestore (&ep->dev->lock, flags);
1250 /* queue head may be partially complete. */
1251 if (ep->queue.next == &req->queue) {
1253 DEBUG (ep->dev, "unlink (%s) dma\n", _ep->name);
1254 _req->status = -ECONNRESET;
1256 if (likely (ep->queue.next == &req->queue)) {
1257 // NOTE: misreports single-transfer mode
1258 req->td->dmacount = 0; /* invalidate */
1260 readl (&ep->dma->dmacount),
1264 DEBUG (ep->dev, "unlink (%s) pio\n", _ep->name);
1265 done (ep, req, -ECONNRESET);
1269 /* patch up hardware chaining data */
1270 } else if (ep->dma && use_dma_chaining) {
1271 if (req->queue.prev == ep->queue.next) {
1272 writel (le32_to_cpu (req->td->dmadesc),
1274 if (req->td->dmacount & dma_done_ie)
1275 writel (readl (&ep->dma->dmacount)
1276 | le32_to_cpu(dma_done_ie),
1277 &ep->dma->dmacount);
1279 struct net2280_request *prev;
1281 prev = list_entry (req->queue.prev,
1282 struct net2280_request, queue);
1283 prev->td->dmadesc = req->td->dmadesc;
1284 if (req->td->dmacount & dma_done_ie)
1285 prev->td->dmacount |= dma_done_ie;
1290 done (ep, req, -ECONNRESET);
1291 ep->stopped = stopped;
1294 /* turn off dma on inactive queues */
1295 if (list_empty (&ep->queue))
1297 else if (!ep->stopped) {
1298 /* resume current request, or start new one */
1300 writel (dmactl, &ep->dma->dmactl);
1302 start_dma (ep, list_entry (ep->queue.next,
1303 struct net2280_request, queue));
1307 spin_unlock_irqrestore (&ep->dev->lock, flags);
1311 /*-------------------------------------------------------------------------*/
1313 static int net2280_fifo_status (struct usb_ep *_ep);
1316 net2280_set_halt (struct usb_ep *_ep, int value)
1318 struct net2280_ep *ep;
1319 unsigned long flags;
1322 ep = container_of (_ep, struct net2280_ep, ep);
1323 if (!_ep || (!ep->desc && ep->num != 0))
1325 if (!ep->dev->driver || ep->dev->gadget.speed == USB_SPEED_UNKNOWN)
1327 if (ep->desc /* not ep0 */ && (ep->desc->bmAttributes & 0x03)
1328 == USB_ENDPOINT_XFER_ISOC)
1331 spin_lock_irqsave (&ep->dev->lock, flags);
1332 if (!list_empty (&ep->queue))
1334 else if (ep->is_in && value && net2280_fifo_status (_ep) != 0)
1337 VDEBUG (ep->dev, "%s %s halt\n", _ep->name,
1338 value ? "set" : "clear");
1339 /* set/clear, then synch memory views with the device */
1342 ep->dev->protocol_stall = 1;
1347 (void) readl (&ep->regs->ep_rsp);
1349 spin_unlock_irqrestore (&ep->dev->lock, flags);
1355 net2280_fifo_status (struct usb_ep *_ep)
1357 struct net2280_ep *ep;
1360 ep = container_of (_ep, struct net2280_ep, ep);
1361 if (!_ep || (!ep->desc && ep->num != 0))
1363 if (!ep->dev->driver || ep->dev->gadget.speed == USB_SPEED_UNKNOWN)
1366 avail = readl (&ep->regs->ep_avail) & ((1 << 12) - 1);
1367 if (avail > ep->fifo_size)
1370 avail = ep->fifo_size - avail;
1375 net2280_fifo_flush (struct usb_ep *_ep)
1377 struct net2280_ep *ep;
1379 ep = container_of (_ep, struct net2280_ep, ep);
1380 if (!_ep || (!ep->desc && ep->num != 0))
1382 if (!ep->dev->driver || ep->dev->gadget.speed == USB_SPEED_UNKNOWN)
1385 writel ((1 << FIFO_FLUSH), &ep->regs->ep_stat);
1386 (void) readl (&ep->regs->ep_rsp);
1389 static const struct usb_ep_ops net2280_ep_ops = {
1390 .enable = net2280_enable,
1391 .disable = net2280_disable,
1393 .alloc_request = net2280_alloc_request,
1394 .free_request = net2280_free_request,
1396 .alloc_buffer = net2280_alloc_buffer,
1397 .free_buffer = net2280_free_buffer,
1399 .queue = net2280_queue,
1400 .dequeue = net2280_dequeue,
1402 .set_halt = net2280_set_halt,
1403 .fifo_status = net2280_fifo_status,
1404 .fifo_flush = net2280_fifo_flush,
1407 /*-------------------------------------------------------------------------*/
1409 static int net2280_get_frame (struct usb_gadget *_gadget)
1411 struct net2280 *dev;
1412 unsigned long flags;
1417 dev = container_of (_gadget, struct net2280, gadget);
1418 spin_lock_irqsave (&dev->lock, flags);
1419 retval = get_idx_reg (dev->regs, REG_FRAME) & 0x03ff;
1420 spin_unlock_irqrestore (&dev->lock, flags);
1424 static int net2280_wakeup (struct usb_gadget *_gadget)
1426 struct net2280 *dev;
1428 unsigned long flags;
1432 dev = container_of (_gadget, struct net2280, gadget);
1434 spin_lock_irqsave (&dev->lock, flags);
1435 tmp = readl (&dev->usb->usbctl);
1436 if (tmp & (1 << DEVICE_REMOTE_WAKEUP_ENABLE))
1437 writel (1 << GENERATE_RESUME, &dev->usb->usbstat);
1438 spin_unlock_irqrestore (&dev->lock, flags);
1440 /* pci writes may still be posted */
1444 static int net2280_set_selfpowered (struct usb_gadget *_gadget, int value)
1446 struct net2280 *dev;
1448 unsigned long flags;
1452 dev = container_of (_gadget, struct net2280, gadget);
1454 spin_lock_irqsave (&dev->lock, flags);
1455 tmp = readl (&dev->usb->usbctl);
1457 tmp |= (1 << SELF_POWERED_STATUS);
1459 tmp &= ~(1 << SELF_POWERED_STATUS);
1460 writel (tmp, &dev->usb->usbctl);
1461 spin_unlock_irqrestore (&dev->lock, flags);
1466 static int net2280_pullup(struct usb_gadget *_gadget, int is_on)
1468 struct net2280 *dev;
1470 unsigned long flags;
1474 dev = container_of (_gadget, struct net2280, gadget);
1476 spin_lock_irqsave (&dev->lock, flags);
1477 tmp = readl (&dev->usb->usbctl);
1478 dev->softconnect = (is_on != 0);
1480 tmp |= (1 << USB_DETECT_ENABLE);
1482 tmp &= ~(1 << USB_DETECT_ENABLE);
1483 writel (tmp, &dev->usb->usbctl);
1484 spin_unlock_irqrestore (&dev->lock, flags);
1489 static const struct usb_gadget_ops net2280_ops = {
1490 .get_frame = net2280_get_frame,
1491 .wakeup = net2280_wakeup,
1492 .set_selfpowered = net2280_set_selfpowered,
1493 .pullup = net2280_pullup,
1496 /*-------------------------------------------------------------------------*/
1498 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
1500 /* FIXME move these into procfs, and use seq_file.
1501 * Sysfs _still_ doesn't behave for arbitrarily sized files,
1502 * and also doesn't help products using this with 2.4 kernels.
1505 /* "function" sysfs attribute */
1507 show_function (struct device *_dev, struct device_attribute *attr, char *buf)
1509 struct net2280 *dev = dev_get_drvdata (_dev);
1512 || !dev->driver->function
1513 || strlen (dev->driver->function) > PAGE_SIZE)
1515 return scnprintf (buf, PAGE_SIZE, "%s\n", dev->driver->function);
1517 static DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
1520 show_registers (struct device *_dev, struct device_attribute *attr, char *buf)
1522 struct net2280 *dev;
1525 unsigned long flags;
1530 dev = dev_get_drvdata (_dev);
1533 spin_lock_irqsave (&dev->lock, flags);
1536 s = dev->driver->driver.name;
1540 /* Main Control Registers */
1541 t = scnprintf (next, size, "%s version " DRIVER_VERSION
1542 ", chiprev %04x, dma %s\n\n"
1543 "devinit %03x fifoctl %08x gadget '%s'\n"
1544 "pci irqenb0 %02x irqenb1 %08x "
1545 "irqstat0 %04x irqstat1 %08x\n",
1546 driver_name, dev->chiprev,
1548 ? (use_dma_chaining ? "chaining" : "enabled")
1550 readl (&dev->regs->devinit),
1551 readl (&dev->regs->fifoctl),
1553 readl (&dev->regs->pciirqenb0),
1554 readl (&dev->regs->pciirqenb1),
1555 readl (&dev->regs->irqstat0),
1556 readl (&dev->regs->irqstat1));
1560 /* USB Control Registers */
1561 t1 = readl (&dev->usb->usbctl);
1562 t2 = readl (&dev->usb->usbstat);
1563 if (t1 & (1 << VBUS_PIN)) {
1564 if (t2 & (1 << HIGH_SPEED))
1566 else if (dev->gadget.speed == USB_SPEED_UNKNOWN)
1570 /* full speed bit (6) not working?? */
1573 t = scnprintf (next, size,
1574 "stdrsp %08x usbctl %08x usbstat %08x "
1575 "addr 0x%02x (%s)\n",
1576 readl (&dev->usb->stdrsp), t1, t2,
1577 readl (&dev->usb->ouraddr), s);
1581 /* PCI Master Control Registers */
1583 /* DMA Control Registers */
1585 /* Configurable EP Control Registers */
1586 for (i = 0; i < 7; i++) {
1587 struct net2280_ep *ep;
1593 t1 = readl (&ep->regs->ep_cfg);
1594 t2 = readl (&ep->regs->ep_rsp) & 0xff;
1595 t = scnprintf (next, size,
1596 "\n%s\tcfg %05x rsp (%02x) %s%s%s%s%s%s%s%s"
1598 ep->ep.name, t1, t2,
1599 (t2 & (1 << CLEAR_NAK_OUT_PACKETS))
1601 (t2 & (1 << CLEAR_EP_HIDE_STATUS_PHASE))
1603 (t2 & (1 << CLEAR_EP_FORCE_CRC_ERROR))
1605 (t2 & (1 << CLEAR_INTERRUPT_MODE))
1606 ? "interrupt " : "",
1607 (t2 & (1<<CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE))
1609 (t2 & (1 << CLEAR_NAK_OUT_PACKETS_MODE))
1611 (t2 & (1 << CLEAR_ENDPOINT_TOGGLE))
1612 ? "DATA1 " : "DATA0 ",
1613 (t2 & (1 << CLEAR_ENDPOINT_HALT))
1615 readl (&ep->regs->ep_irqenb));
1619 t = scnprintf (next, size,
1620 "\tstat %08x avail %04x "
1622 readl (&ep->regs->ep_stat),
1623 readl (&ep->regs->ep_avail),
1624 t1 & 0x0f, DIR_STRING (t1),
1625 type_string (t1 >> 8),
1626 ep->stopped ? "*" : "");
1633 t = scnprintf (next, size,
1634 " dma\tctl %08x stat %08x count %08x\n"
1635 "\taddr %08x desc %08x\n",
1636 readl (&ep->dma->dmactl),
1637 readl (&ep->dma->dmastat),
1638 readl (&ep->dma->dmacount),
1639 readl (&ep->dma->dmaaddr),
1640 readl (&ep->dma->dmadesc));
1646 /* Indexed Registers */
1650 t = scnprintf (next, size, "\nirqs: ");
1653 for (i = 0; i < 7; i++) {
1654 struct net2280_ep *ep;
1659 t = scnprintf (next, size, " %s/%lu", ep->ep.name, ep->irqs);
1664 t = scnprintf (next, size, "\n");
1668 spin_unlock_irqrestore (&dev->lock, flags);
1670 return PAGE_SIZE - size;
1672 static DEVICE_ATTR (registers, S_IRUGO, show_registers, NULL);
1675 show_queues (struct device *_dev, struct device_attribute *attr, char *buf)
1677 struct net2280 *dev;
1680 unsigned long flags;
1683 dev = dev_get_drvdata (_dev);
1686 spin_lock_irqsave (&dev->lock, flags);
1688 for (i = 0; i < 7; i++) {
1689 struct net2280_ep *ep = &dev->ep [i];
1690 struct net2280_request *req;
1694 const struct usb_endpoint_descriptor *d;
1699 t = d->bEndpointAddress;
1700 t = scnprintf (next, size,
1701 "\n%s (ep%d%s-%s) max %04x %s fifo %d\n",
1702 ep->ep.name, t & USB_ENDPOINT_NUMBER_MASK,
1703 (t & USB_DIR_IN) ? "in" : "out",
1705 switch (d->bmAttributes & 0x03) {
1706 case USB_ENDPOINT_XFER_BULK:
1707 val = "bulk"; break;
1708 case USB_ENDPOINT_XFER_INT:
1709 val = "intr"; break;
1713 le16_to_cpu (d->wMaxPacketSize) & 0x1fff,
1714 ep->dma ? "dma" : "pio", ep->fifo_size
1716 } else /* ep0 should only have one transfer queued */
1717 t = scnprintf (next, size, "ep0 max 64 pio %s\n",
1718 ep->is_in ? "in" : "out");
1719 if (t <= 0 || t > size)
1724 if (list_empty (&ep->queue)) {
1725 t = scnprintf (next, size, "\t(nothing queued)\n");
1726 if (t <= 0 || t > size)
1732 list_for_each_entry (req, &ep->queue, queue) {
1733 if (ep->dma && req->td_dma == readl (&ep->dma->dmadesc))
1734 t = scnprintf (next, size,
1735 "\treq %p len %d/%d "
1736 "buf %p (dmacount %08x)\n",
1737 &req->req, req->req.actual,
1738 req->req.length, req->req.buf,
1739 readl (&ep->dma->dmacount));
1741 t = scnprintf (next, size,
1742 "\treq %p len %d/%d buf %p\n",
1743 &req->req, req->req.actual,
1744 req->req.length, req->req.buf);
1745 if (t <= 0 || t > size)
1751 struct net2280_dma *td;
1754 t = scnprintf (next, size, "\t td %08x "
1755 " count %08x buf %08x desc %08x\n",
1757 le32_to_cpu (td->dmacount),
1758 le32_to_cpu (td->dmaaddr),
1759 le32_to_cpu (td->dmadesc));
1760 if (t <= 0 || t > size)
1769 spin_unlock_irqrestore (&dev->lock, flags);
1770 return PAGE_SIZE - size;
1772 static DEVICE_ATTR (queues, S_IRUGO, show_queues, NULL);
1777 #define device_create_file(a,b) (0)
1778 #define device_remove_file(a,b) do { } while (0)
1782 /*-------------------------------------------------------------------------*/
1784 /* another driver-specific mode might be a request type doing dma
1785 * to/from another device fifo instead of to/from memory.
1788 static void set_fifo_mode (struct net2280 *dev, int mode)
1790 /* keeping high bits preserves BAR2 */
1791 writel ((0xffff << PCI_BASE2_RANGE) | mode, &dev->regs->fifoctl);
1793 /* always ep-{a,b,e,f} ... maybe not ep-c or ep-d */
1794 INIT_LIST_HEAD (&dev->gadget.ep_list);
1795 list_add_tail (&dev->ep [1].ep.ep_list, &dev->gadget.ep_list);
1796 list_add_tail (&dev->ep [2].ep.ep_list, &dev->gadget.ep_list);
1799 list_add_tail (&dev->ep [3].ep.ep_list, &dev->gadget.ep_list);
1800 list_add_tail (&dev->ep [4].ep.ep_list, &dev->gadget.ep_list);
1801 dev->ep [1].fifo_size = dev->ep [2].fifo_size = 1024;
1804 dev->ep [1].fifo_size = dev->ep [2].fifo_size = 2048;
1807 list_add_tail (&dev->ep [3].ep.ep_list, &dev->gadget.ep_list);
1808 dev->ep [1].fifo_size = 2048;
1809 dev->ep [2].fifo_size = 1024;
1812 /* fifo sizes for ep0, ep-c, ep-d, ep-e, and ep-f never change */
1813 list_add_tail (&dev->ep [5].ep.ep_list, &dev->gadget.ep_list);
1814 list_add_tail (&dev->ep [6].ep.ep_list, &dev->gadget.ep_list);
1817 /* just declare this in any driver that really need it */
1818 extern int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode);
1821 * net2280_set_fifo_mode - change allocation of fifo buffers
1822 * @gadget: access to the net2280 device that will be updated
1823 * @mode: 0 for default, four 1kB buffers (ep-a through ep-d);
1824 * 1 for two 2kB buffers (ep-a and ep-b only);
1825 * 2 for one 2kB buffer (ep-a) and two 1kB ones (ep-b, ep-c).
1827 * returns zero on success, else negative errno. when this succeeds,
1828 * the contents of gadget->ep_list may have changed.
1830 * you may only call this function when endpoints a-d are all disabled.
1831 * use it whenever extra hardware buffering can help performance, such
1832 * as before enabling "high bandwidth" interrupt endpoints that use
1833 * maxpacket bigger than 512 (when double buffering would otherwise
1836 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
1839 struct net2280 *dev;
1841 unsigned long flags;
1845 dev = container_of (gadget, struct net2280, gadget);
1847 spin_lock_irqsave (&dev->lock, flags);
1849 for (i = 1; i <= 4; i++)
1850 if (dev->ep [i].desc) {
1854 if (mode < 0 || mode > 2)
1857 set_fifo_mode (dev, mode);
1858 spin_unlock_irqrestore (&dev->lock, flags);
1862 DEBUG (dev, "fifo: ep-a 2K, ep-b 2K\n");
1864 DEBUG (dev, "fifo: ep-a 2K, ep-b 1K, ep-c 1K\n");
1865 /* else all are 1K */
1869 EXPORT_SYMBOL (net2280_set_fifo_mode);
1871 /*-------------------------------------------------------------------------*/
1873 /* keeping it simple:
1874 * - one bus driver, initted first;
1875 * - one function driver, initted second
1877 * most of the work to support multiple net2280 controllers would
1878 * be to associate this gadget driver (yes?) with all of them, or
1879 * perhaps to bind specific drivers to specific devices.
1882 static struct net2280 *the_controller;
1884 static void usb_reset (struct net2280 *dev)
1888 dev->gadget.speed = USB_SPEED_UNKNOWN;
1889 (void) readl (&dev->usb->usbctl);
1891 net2280_led_init (dev);
1893 /* disable automatic responses, and irqs */
1894 writel (0, &dev->usb->stdrsp);
1895 writel (0, &dev->regs->pciirqenb0);
1896 writel (0, &dev->regs->pciirqenb1);
1898 /* clear old dma and irq state */
1899 for (tmp = 0; tmp < 4; tmp++) {
1900 struct net2280_ep *ep = &dev->ep [tmp + 1];
1905 writel (~0, &dev->regs->irqstat0),
1906 writel (~(1 << SUSPEND_REQUEST_INTERRUPT), &dev->regs->irqstat1),
1908 /* reset, and enable pci */
1909 tmp = readl (&dev->regs->devinit)
1911 | (1 << FIFO_SOFT_RESET)
1912 | (1 << USB_SOFT_RESET)
1913 | (1 << M8051_RESET);
1914 writel (tmp, &dev->regs->devinit);
1916 /* standard fifo and endpoint allocations */
1917 set_fifo_mode (dev, (fifo_mode <= 2) ? fifo_mode : 0);
1920 static void usb_reinit (struct net2280 *dev)
1925 /* use_dma changes are ignored till next device re-init */
1928 /* basic endpoint init */
1929 for (tmp = 0; tmp < 7; tmp++) {
1930 struct net2280_ep *ep = &dev->ep [tmp];
1932 ep->ep.name = ep_name [tmp];
1936 if (tmp > 0 && tmp <= 4) {
1937 ep->fifo_size = 1024;
1939 ep->dma = &dev->dma [tmp - 1];
1942 ep->regs = &dev->epregs [tmp];
1943 ep_reset (dev->regs, ep);
1945 dev->ep [0].ep.maxpacket = 64;
1946 dev->ep [5].ep.maxpacket = 64;
1947 dev->ep [6].ep.maxpacket = 64;
1949 dev->gadget.ep0 = &dev->ep [0].ep;
1950 dev->ep [0].stopped = 0;
1951 INIT_LIST_HEAD (&dev->gadget.ep0->ep_list);
1953 /* we want to prevent lowlevel/insecure access from the USB host,
1954 * but erratum 0119 means this enable bit is ignored
1956 for (tmp = 0; tmp < 5; tmp++)
1957 writel (EP_DONTUSE, &dev->dep [tmp].dep_cfg);
1960 static void ep0_start (struct net2280 *dev)
1962 writel ( (1 << CLEAR_EP_HIDE_STATUS_PHASE)
1963 | (1 << CLEAR_NAK_OUT_PACKETS)
1964 | (1 << CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE)
1965 , &dev->epregs [0].ep_rsp);
1968 * hardware optionally handles a bunch of standard requests
1969 * that the API hides from drivers anyway. have it do so.
1970 * endpoint status/features are handled in software, to
1971 * help pass tests for some dubious behavior.
1973 writel ( (1 << SET_TEST_MODE)
1974 | (1 << SET_ADDRESS)
1975 | (1 << DEVICE_SET_CLEAR_DEVICE_REMOTE_WAKEUP)
1976 | (1 << GET_DEVICE_STATUS)
1977 | (1 << GET_INTERFACE_STATUS)
1978 , &dev->usb->stdrsp);
1979 writel ( (1 << USB_ROOT_PORT_WAKEUP_ENABLE)
1980 | (1 << SELF_POWERED_USB_DEVICE)
1981 | (1 << REMOTE_WAKEUP_SUPPORT)
1982 | (dev->softconnect << USB_DETECT_ENABLE)
1983 | (1 << SELF_POWERED_STATUS)
1984 , &dev->usb->usbctl);
1986 /* enable irqs so we can see ep0 and general operation */
1987 writel ( (1 << SETUP_PACKET_INTERRUPT_ENABLE)
1988 | (1 << ENDPOINT_0_INTERRUPT_ENABLE)
1989 , &dev->regs->pciirqenb0);
1990 writel ( (1 << PCI_INTERRUPT_ENABLE)
1991 | (1 << PCI_MASTER_ABORT_RECEIVED_INTERRUPT_ENABLE)
1992 | (1 << PCI_TARGET_ABORT_RECEIVED_INTERRUPT_ENABLE)
1993 | (1 << PCI_RETRY_ABORT_INTERRUPT_ENABLE)
1994 | (1 << VBUS_INTERRUPT_ENABLE)
1995 | (1 << ROOT_PORT_RESET_INTERRUPT_ENABLE)
1996 | (1 << SUSPEND_REQUEST_CHANGE_INTERRUPT_ENABLE)
1997 , &dev->regs->pciirqenb1);
1999 /* don't leave any writes posted */
2000 (void) readl (&dev->usb->usbctl);
2003 /* when a driver is successfully registered, it will receive
2004 * control requests including set_configuration(), which enables
2005 * non-control requests. then usb traffic follows until a
2006 * disconnect is reported. then a host may connect again, or
2007 * the driver might get unbound.
2009 int usb_gadget_register_driver (struct usb_gadget_driver *driver)
2011 struct net2280 *dev = the_controller;
2015 /* insist on high speed support from the driver, since
2016 * (dev->usb->xcvrdiag & FORCE_FULL_SPEED_MODE)
2017 * "must not be used in normal operation"
2020 || driver->speed != USB_SPEED_HIGH
2029 for (i = 0; i < 7; i++)
2030 dev->ep [i].irqs = 0;
2032 /* hook up the driver ... */
2033 dev->softconnect = 1;
2034 driver->driver.bus = NULL;
2035 dev->driver = driver;
2036 dev->gadget.dev.driver = &driver->driver;
2037 retval = driver->bind (&dev->gadget);
2039 DEBUG (dev, "bind to driver %s --> %d\n",
2040 driver->driver.name, retval);
2042 dev->gadget.dev.driver = NULL;
2046 retval = device_create_file (&dev->pdev->dev, &dev_attr_function);
2047 if (retval) goto err_unbind;
2048 retval = device_create_file (&dev->pdev->dev, &dev_attr_queues);
2049 if (retval) goto err_func;
2051 /* ... then enable host detection and ep0; and we're ready
2052 * for set_configuration as well as eventual disconnect.
2054 net2280_led_active (dev, 1);
2057 DEBUG (dev, "%s ready, usbctl %08x stdrsp %08x\n",
2058 driver->driver.name,
2059 readl (&dev->usb->usbctl),
2060 readl (&dev->usb->stdrsp));
2062 /* pci writes may still be posted */
2066 device_remove_file (&dev->pdev->dev, &dev_attr_function);
2068 driver->unbind (&dev->gadget);
2069 dev->gadget.dev.driver = NULL;
2073 EXPORT_SYMBOL (usb_gadget_register_driver);
2076 stop_activity (struct net2280 *dev, struct usb_gadget_driver *driver)
2080 /* don't disconnect if it's not connected */
2081 if (dev->gadget.speed == USB_SPEED_UNKNOWN)
2084 /* stop hardware; prevent new request submissions;
2085 * and kill any outstanding requests.
2088 for (i = 0; i < 7; i++)
2089 nuke (&dev->ep [i]);
2091 /* report disconnect; the driver is already quiesced */
2093 spin_unlock (&dev->lock);
2094 driver->disconnect (&dev->gadget);
2095 spin_lock (&dev->lock);
2101 int usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
2103 struct net2280 *dev = the_controller;
2104 unsigned long flags;
2108 if (!driver || driver != dev->driver || !driver->unbind)
2111 spin_lock_irqsave (&dev->lock, flags);
2112 stop_activity (dev, driver);
2113 spin_unlock_irqrestore (&dev->lock, flags);
2115 net2280_pullup (&dev->gadget, 0);
2117 driver->unbind (&dev->gadget);
2118 dev->gadget.dev.driver = NULL;
2121 net2280_led_active (dev, 0);
2122 device_remove_file (&dev->pdev->dev, &dev_attr_function);
2123 device_remove_file (&dev->pdev->dev, &dev_attr_queues);
2125 DEBUG (dev, "unregistered driver '%s'\n", driver->driver.name);
2128 EXPORT_SYMBOL (usb_gadget_unregister_driver);
2131 /*-------------------------------------------------------------------------*/
2133 /* handle ep0, ep-e, ep-f with 64 byte packets: packet per irq.
2134 * also works for dma-capable endpoints, in pio mode or just
2135 * to manually advance the queue after short OUT transfers.
2137 static void handle_ep_small (struct net2280_ep *ep)
2139 struct net2280_request *req;
2141 /* 0 error, 1 mid-data, 2 done */
2144 if (!list_empty (&ep->queue))
2145 req = list_entry (ep->queue.next,
2146 struct net2280_request, queue);
2150 /* ack all, and handle what we care about */
2151 t = readl (&ep->regs->ep_stat);
2154 VDEBUG (ep->dev, "%s ack ep_stat %08x, req %p\n",
2155 ep->ep.name, t, req ? &req->req : 0);
2157 if (!ep->is_in || ep->dev->pdev->device == 0x2280)
2158 writel (t & ~(1 << NAK_OUT_PACKETS), &ep->regs->ep_stat);
2160 /* Added for 2282 */
2161 writel (t, &ep->regs->ep_stat);
2163 /* for ep0, monitor token irqs to catch data stage length errors
2164 * and to synchronize on status.
2166 * also, to defer reporting of protocol stalls ... here's where
2167 * data or status first appears, handling stalls here should never
2168 * cause trouble on the host side..
2170 * control requests could be slightly faster without token synch for
2171 * status, but status can jam up that way.
2173 if (unlikely (ep->num == 0)) {
2175 /* status; stop NAKing */
2176 if (t & (1 << DATA_OUT_PING_TOKEN_INTERRUPT)) {
2177 if (ep->dev->protocol_stall) {
2184 /* reply to extra IN data tokens with a zlp */
2185 } else if (t & (1 << DATA_IN_TOKEN_INTERRUPT)) {
2186 if (ep->dev->protocol_stall) {
2190 } else if (ep->responded &&
2191 !req && !ep->stopped)
2192 write_fifo (ep, NULL);
2195 /* status; stop NAKing */
2196 if (t & (1 << DATA_IN_TOKEN_INTERRUPT)) {
2197 if (ep->dev->protocol_stall) {
2202 /* an extra OUT token is an error */
2203 } else if (((t & (1 << DATA_OUT_PING_TOKEN_INTERRUPT))
2205 && req->req.actual == req->req.length)
2206 || (ep->responded && !req)) {
2207 ep->dev->protocol_stall = 1;
2211 done (ep, req, -EOVERFLOW);
2217 if (unlikely (!req))
2220 /* manual DMA queue advance after short OUT */
2221 if (likely (ep->dma != 0)) {
2222 if (t & (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT)) {
2224 int stopped = ep->stopped;
2226 /* TRANSFERRED works around OUT_DONE erratum 0112.
2227 * we expect (N <= maxpacket) bytes; host wrote M.
2228 * iff (M < N) we won't ever see a DMA interrupt.
2231 for (count = 0; ; t = readl (&ep->regs->ep_stat)) {
2233 /* any preceding dma transfers must finish.
2234 * dma handles (M >= N), may empty the queue
2236 scan_dma_completions (ep);
2237 if (unlikely (list_empty (&ep->queue)
2238 || ep->out_overflow)) {
2242 req = list_entry (ep->queue.next,
2243 struct net2280_request, queue);
2245 /* here either (M < N), a "real" short rx;
2246 * or (M == N) and the queue didn't empty
2248 if (likely (t & (1 << FIFO_EMPTY))) {
2249 count = readl (&ep->dma->dmacount);
2250 count &= DMA_BYTE_COUNT_MASK;
2251 if (readl (&ep->dma->dmadesc)
2259 /* stop DMA, leave ep NAKing */
2260 writel ((1 << DMA_ABORT), &ep->dma->dmastat);
2261 spin_stop_dma (ep->dma);
2264 req->td->dmacount = 0;
2265 t = readl (&ep->regs->ep_avail);
2266 dma_done (ep, req, count,
2267 (ep->out_overflow || t)
2271 /* also flush to prevent erratum 0106 trouble */
2272 if (unlikely (ep->out_overflow
2273 || (ep->dev->chiprev == 0x0100
2274 && ep->dev->gadget.speed
2275 == USB_SPEED_FULL))) {
2277 ep->out_overflow = 0;
2280 /* (re)start dma if needed, stop NAKing */
2281 ep->stopped = stopped;
2282 if (!list_empty (&ep->queue))
2285 DEBUG (ep->dev, "%s dma ep_stat %08x ??\n",
2289 /* data packet(s) received (in the fifo, OUT) */
2290 } else if (t & (1 << DATA_PACKET_RECEIVED_INTERRUPT)) {
2291 if (read_fifo (ep, req) && ep->num != 0)
2294 /* data packet(s) transmitted (IN) */
2295 } else if (t & (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)) {
2298 len = req->req.length - req->req.actual;
2299 if (len > ep->ep.maxpacket)
2300 len = ep->ep.maxpacket;
2301 req->req.actual += len;
2303 /* if we wrote it all, we're usually done */
2304 if (req->req.actual == req->req.length) {
2306 /* send zlps until the status stage */
2307 } else if (!req->req.zero || len != ep->ep.maxpacket)
2311 /* there was nothing to do ... */
2312 } else if (mode == 1)
2317 /* stream endpoints often resubmit/unlink in completion */
2320 /* maybe advance queue to next request */
2322 /* NOTE: net2280 could let gadget driver start the
2323 * status stage later. since not all controllers let
2324 * them control that, the api doesn't (yet) allow it.
2330 if (!list_empty (&ep->queue) && !ep->stopped)
2331 req = list_entry (ep->queue.next,
2332 struct net2280_request, queue);
2335 if (req && !ep->is_in)
2336 stop_out_naking (ep);
2340 /* is there a buffer for the next packet?
2341 * for best streaming performance, make sure there is one.
2343 if (req && !ep->stopped) {
2345 /* load IN fifo with next packet (may be zlp) */
2346 if (t & (1 << DATA_PACKET_TRANSMITTED_INTERRUPT))
2347 write_fifo (ep, &req->req);
2351 static struct net2280_ep *
2352 get_ep_by_addr (struct net2280 *dev, u16 wIndex)
2354 struct net2280_ep *ep;
2356 if ((wIndex & USB_ENDPOINT_NUMBER_MASK) == 0)
2357 return &dev->ep [0];
2358 list_for_each_entry (ep, &dev->gadget.ep_list, ep.ep_list) {
2359 u8 bEndpointAddress;
2363 bEndpointAddress = ep->desc->bEndpointAddress;
2364 if ((wIndex ^ bEndpointAddress) & USB_DIR_IN)
2366 if ((wIndex & 0x0f) == (bEndpointAddress & 0x0f))
2372 static void handle_stat0_irqs (struct net2280 *dev, u32 stat)
2374 struct net2280_ep *ep;
2377 /* most of these don't need individual acks */
2378 stat &= ~(1 << INTA_ASSERTED);
2381 // DEBUG (dev, "irqstat0 %04x\n", stat);
2383 /* starting a control request? */
2384 if (unlikely (stat & (1 << SETUP_PACKET_INTERRUPT))) {
2387 struct usb_ctrlrequest r;
2390 struct net2280_request *req;
2392 if (dev->gadget.speed == USB_SPEED_UNKNOWN) {
2393 if (readl (&dev->usb->usbstat) & (1 << HIGH_SPEED))
2394 dev->gadget.speed = USB_SPEED_HIGH;
2396 dev->gadget.speed = USB_SPEED_FULL;
2397 net2280_led_speed (dev, dev->gadget.speed);
2398 DEBUG (dev, "%s speed\n",
2399 (dev->gadget.speed == USB_SPEED_HIGH)
2406 /* make sure any leftover request state is cleared */
2407 stat &= ~(1 << ENDPOINT_0_INTERRUPT);
2408 while (!list_empty (&ep->queue)) {
2409 req = list_entry (ep->queue.next,
2410 struct net2280_request, queue);
2411 done (ep, req, (req->req.actual == req->req.length)
2415 dev->protocol_stall = 0;
2417 if (ep->dev->pdev->device == 0x2280)
2418 tmp = (1 << FIFO_OVERFLOW)
2419 | (1 << FIFO_UNDERFLOW);
2423 writel (tmp | (1 << TIMEOUT)
2424 | (1 << USB_STALL_SENT)
2425 | (1 << USB_IN_NAK_SENT)
2426 | (1 << USB_IN_ACK_RCVD)
2427 | (1 << USB_OUT_PING_NAK_SENT)
2428 | (1 << USB_OUT_ACK_SENT)
2429 | (1 << SHORT_PACKET_OUT_DONE_INTERRUPT)
2430 | (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT)
2431 | (1 << DATA_PACKET_RECEIVED_INTERRUPT)
2432 | (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)
2433 | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
2434 | (1 << DATA_IN_TOKEN_INTERRUPT)
2435 , &ep->regs->ep_stat);
2436 u.raw [0] = readl (&dev->usb->setup0123);
2437 u.raw [1] = readl (&dev->usb->setup4567);
2439 cpu_to_le32s (&u.raw [0]);
2440 cpu_to_le32s (&u.raw [1]);
2444 #define w_value le16_to_cpup (&u.r.wValue)
2445 #define w_index le16_to_cpup (&u.r.wIndex)
2446 #define w_length le16_to_cpup (&u.r.wLength)
2449 writel (1 << SETUP_PACKET_INTERRUPT, &dev->regs->irqstat0);
2450 stat ^= (1 << SETUP_PACKET_INTERRUPT);
2452 /* watch control traffic at the token level, and force
2453 * synchronization before letting the status stage happen.
2454 * FIXME ignore tokens we'll NAK, until driver responds.
2455 * that'll mean a lot less irqs for some drivers.
2457 ep->is_in = (u.r.bRequestType & USB_DIR_IN) != 0;
2459 scratch = (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)
2460 | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
2461 | (1 << DATA_IN_TOKEN_INTERRUPT);
2462 stop_out_naking (ep);
2464 scratch = (1 << DATA_PACKET_RECEIVED_INTERRUPT)
2465 | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
2466 | (1 << DATA_IN_TOKEN_INTERRUPT);
2467 writel (scratch, &dev->epregs [0].ep_irqenb);
2469 /* we made the hardware handle most lowlevel requests;
2470 * everything else goes uplevel to the gadget code.
2473 switch (u.r.bRequest) {
2474 case USB_REQ_GET_STATUS: {
2475 struct net2280_ep *e;
2478 /* hw handles device and interface status */
2479 if (u.r.bRequestType != (USB_DIR_IN|USB_RECIP_ENDPOINT))
2481 if ((e = get_ep_by_addr (dev, w_index)) == 0
2485 if (readl (&e->regs->ep_rsp)
2486 & (1 << SET_ENDPOINT_HALT))
2487 status = __constant_cpu_to_le32 (1);
2489 status = __constant_cpu_to_le32 (0);
2491 /* don't bother with a request object! */
2492 writel (0, &dev->epregs [0].ep_irqenb);
2493 set_fifo_bytecount (ep, w_length);
2494 writel ((__force u32)status, &dev->epregs [0].ep_data);
2496 VDEBUG (dev, "%s stat %02x\n", ep->ep.name, status);
2497 goto next_endpoints;
2500 case USB_REQ_CLEAR_FEATURE: {
2501 struct net2280_ep *e;
2503 /* hw handles device features */
2504 if (u.r.bRequestType != USB_RECIP_ENDPOINT)
2506 if (w_value != USB_ENDPOINT_HALT
2509 if ((e = get_ep_by_addr (dev, w_index)) == 0)
2513 VDEBUG (dev, "%s clear halt\n", ep->ep.name);
2514 goto next_endpoints;
2517 case USB_REQ_SET_FEATURE: {
2518 struct net2280_ep *e;
2520 /* hw handles device features */
2521 if (u.r.bRequestType != USB_RECIP_ENDPOINT)
2523 if (w_value != USB_ENDPOINT_HALT
2526 if ((e = get_ep_by_addr (dev, w_index)) == 0)
2530 VDEBUG (dev, "%s set halt\n", ep->ep.name);
2531 goto next_endpoints;
2536 VDEBUG (dev, "setup %02x.%02x v%04x i%04x l%04x"
2538 u.r.bRequestType, u.r.bRequest,
2539 w_value, w_index, w_length,
2540 readl (&ep->regs->ep_cfg));
2542 spin_unlock (&dev->lock);
2543 tmp = dev->driver->setup (&dev->gadget, &u.r);
2544 spin_lock (&dev->lock);
2547 /* stall ep0 on error */
2550 VDEBUG (dev, "req %02x.%02x protocol STALL; stat %d\n",
2551 u.r.bRequestType, u.r.bRequest, tmp);
2552 dev->protocol_stall = 1;
2555 /* some in/out token irq should follow; maybe stall then.
2556 * driver must queue a request (even zlp) or halt ep0
2557 * before the host times out.
2566 /* endpoint data irq ? */
2567 scratch = stat & 0x7f;
2569 for (num = 0; scratch; num++) {
2572 /* do this endpoint's FIFO and queue need tending? */
2574 if ((scratch & t) == 0)
2578 ep = &dev->ep [num];
2579 handle_ep_small (ep);
2583 DEBUG (dev, "unhandled irqstat0 %08x\n", stat);
2586 #define DMA_INTERRUPTS ( \
2587 (1 << DMA_D_INTERRUPT) \
2588 | (1 << DMA_C_INTERRUPT) \
2589 | (1 << DMA_B_INTERRUPT) \
2590 | (1 << DMA_A_INTERRUPT))
2591 #define PCI_ERROR_INTERRUPTS ( \
2592 (1 << PCI_MASTER_ABORT_RECEIVED_INTERRUPT) \
2593 | (1 << PCI_TARGET_ABORT_RECEIVED_INTERRUPT) \
2594 | (1 << PCI_RETRY_ABORT_INTERRUPT))
2596 static void handle_stat1_irqs (struct net2280 *dev, u32 stat)
2598 struct net2280_ep *ep;
2599 u32 tmp, num, mask, scratch;
2601 /* after disconnect there's nothing else to do! */
2602 tmp = (1 << VBUS_INTERRUPT) | (1 << ROOT_PORT_RESET_INTERRUPT);
2603 mask = (1 << HIGH_SPEED) | (1 << FULL_SPEED);
2605 /* VBUS disconnect is indicated by VBUS_PIN and VBUS_INTERRUPT set.
2606 * Root Port Reset is indicated by ROOT_PORT_RESET_INTERRRUPT set and
2607 * both HIGH_SPEED and FULL_SPEED clear (as ROOT_PORT_RESET_INTERRUPT
2608 * only indicates a change in the reset state).
2611 writel (tmp, &dev->regs->irqstat1);
2612 if ((((stat & (1 << ROOT_PORT_RESET_INTERRUPT))
2613 && ((readl (&dev->usb->usbstat) & mask)
2615 || ((readl (&dev->usb->usbctl)
2616 & (1 << VBUS_PIN)) == 0)
2617 ) && ( dev->gadget.speed != USB_SPEED_UNKNOWN)) {
2618 DEBUG (dev, "disconnect %s\n",
2619 dev->driver->driver.name);
2620 stop_activity (dev, dev->driver);
2626 /* vBUS can bounce ... one of many reasons to ignore the
2627 * notion of hotplug events on bus connect/disconnect!
2633 /* NOTE: chip stays in PCI D0 state for now, but it could
2634 * enter D1 to save more power
2636 tmp = (1 << SUSPEND_REQUEST_CHANGE_INTERRUPT);
2638 writel (tmp, &dev->regs->irqstat1);
2639 if (stat & (1 << SUSPEND_REQUEST_INTERRUPT)) {
2640 if (dev->driver->suspend)
2641 dev->driver->suspend (&dev->gadget);
2642 if (!enable_suspend)
2643 stat &= ~(1 << SUSPEND_REQUEST_INTERRUPT);
2645 if (dev->driver->resume)
2646 dev->driver->resume (&dev->gadget);
2647 /* at high speed, note erratum 0133 */
2652 /* clear any other status/irqs */
2654 writel (stat, &dev->regs->irqstat1);
2656 /* some status we can just ignore */
2657 if (dev->pdev->device == 0x2280)
2658 stat &= ~((1 << CONTROL_STATUS_INTERRUPT)
2659 | (1 << SUSPEND_REQUEST_INTERRUPT)
2660 | (1 << RESUME_INTERRUPT)
2661 | (1 << SOF_INTERRUPT));
2663 stat &= ~((1 << CONTROL_STATUS_INTERRUPT)
2664 | (1 << RESUME_INTERRUPT)
2665 | (1 << SOF_DOWN_INTERRUPT)
2666 | (1 << SOF_INTERRUPT));
2670 // DEBUG (dev, "irqstat1 %08x\n", stat);
2672 /* DMA status, for ep-{a,b,c,d} */
2673 scratch = stat & DMA_INTERRUPTS;
2674 stat &= ~DMA_INTERRUPTS;
2676 for (num = 0; scratch; num++) {
2677 struct net2280_dma_regs __iomem *dma;
2680 if ((tmp & scratch) == 0)
2684 ep = &dev->ep [num + 1];
2690 /* clear ep's dma status */
2691 tmp = readl (&dma->dmastat);
2692 writel (tmp, &dma->dmastat);
2694 /* chaining should stop on abort, short OUT from fifo,
2695 * or (stat0 codepath) short OUT transfer.
2697 if (!use_dma_chaining) {
2698 if ((tmp & (1 << DMA_TRANSACTION_DONE_INTERRUPT))
2700 DEBUG (ep->dev, "%s no xact done? %08x\n",
2707 /* OUT transfers terminate when the data from the
2708 * host is in our memory. Process whatever's done.
2709 * On this path, we know transfer's last packet wasn't
2710 * less than req->length. NAK_OUT_PACKETS may be set,
2711 * or the FIFO may already be holding new packets.
2713 * IN transfers can linger in the FIFO for a very
2714 * long time ... we ignore that for now, accounting
2715 * precisely (like PIO does) needs per-packet irqs
2717 scan_dma_completions (ep);
2719 /* disable dma on inactive queues; else maybe restart */
2720 if (list_empty (&ep->queue)) {
2721 if (use_dma_chaining)
2724 tmp = readl (&dma->dmactl);
2725 if (!use_dma_chaining
2726 || (tmp & (1 << DMA_ENABLE)) == 0)
2728 else if (ep->is_in && use_dma_chaining) {
2729 struct net2280_request *req;
2732 /* the descriptor at the head of the chain
2733 * may still have VALID_BIT clear; that's
2734 * used to trigger changing DMA_FIFO_VALIDATE
2735 * (affects automagic zlp writes).
2737 req = list_entry (ep->queue.next,
2738 struct net2280_request, queue);
2739 dmacount = req->td->dmacount;
2740 dmacount &= __constant_cpu_to_le32 (
2742 | DMA_BYTE_COUNT_MASK);
2743 if (dmacount && (dmacount & valid_bit) == 0)
2750 /* NOTE: there are other PCI errors we might usefully notice.
2751 * if they appear very often, here's where to try recovering.
2753 if (stat & PCI_ERROR_INTERRUPTS) {
2754 ERROR (dev, "pci dma error; stat %08x\n", stat);
2755 stat &= ~PCI_ERROR_INTERRUPTS;
2756 /* these are fatal errors, but "maybe" they won't
2759 stop_activity (dev, dev->driver);
2765 DEBUG (dev, "unhandled irqstat1 %08x\n", stat);
2768 static irqreturn_t net2280_irq (int irq, void *_dev)
2770 struct net2280 *dev = _dev;
2772 /* shared interrupt, not ours */
2773 if (!(readl(&dev->regs->irqstat0) & (1 << INTA_ASSERTED)))
2776 spin_lock (&dev->lock);
2778 /* handle disconnect, dma, and more */
2779 handle_stat1_irqs (dev, readl (&dev->regs->irqstat1));
2781 /* control requests and PIO */
2782 handle_stat0_irqs (dev, readl (&dev->regs->irqstat0));
2784 spin_unlock (&dev->lock);
2789 /*-------------------------------------------------------------------------*/
2791 static void gadget_release (struct device *_dev)
2793 struct net2280 *dev = dev_get_drvdata (_dev);
2798 /* tear down the binding between this driver and the pci device */
2800 static void net2280_remove (struct pci_dev *pdev)
2802 struct net2280 *dev = pci_get_drvdata (pdev);
2804 BUG_ON(dev->driver);
2806 /* then clean up the resources we allocated during probe() */
2807 net2280_led_shutdown (dev);
2808 if (dev->requests) {
2810 for (i = 1; i < 5; i++) {
2811 if (!dev->ep [i].dummy)
2813 pci_pool_free (dev->requests, dev->ep [i].dummy,
2814 dev->ep [i].td_dma);
2816 pci_pool_destroy (dev->requests);
2819 free_irq (pdev->irq, dev);
2821 iounmap (dev->regs);
2823 release_mem_region (pci_resource_start (pdev, 0),
2824 pci_resource_len (pdev, 0));
2826 pci_disable_device (pdev);
2827 device_unregister (&dev->gadget.dev);
2828 device_remove_file (&pdev->dev, &dev_attr_registers);
2829 pci_set_drvdata (pdev, NULL);
2831 INFO (dev, "unbind\n");
2833 the_controller = NULL;
2836 /* wrap this driver around the specified device, but
2837 * don't respond over USB until a gadget driver binds to us.
2840 static int net2280_probe (struct pci_dev *pdev, const struct pci_device_id *id)
2842 struct net2280 *dev;
2843 unsigned long resource, len;
2844 void __iomem *base = NULL;
2847 /* if you want to support more than one controller in a system,
2848 * usb_gadget_driver_{register,unregister}() must change.
2850 if (the_controller) {
2851 dev_warn (&pdev->dev, "ignoring\n");
2855 /* alloc, and start init */
2856 dev = kzalloc (sizeof *dev, GFP_KERNEL);
2862 pci_set_drvdata (pdev, dev);
2863 spin_lock_init (&dev->lock);
2865 dev->gadget.ops = &net2280_ops;
2866 dev->gadget.is_dualspeed = 1;
2868 /* the "gadget" abstracts/virtualizes the controller */
2869 strcpy (dev->gadget.dev.bus_id, "gadget");
2870 dev->gadget.dev.parent = &pdev->dev;
2871 dev->gadget.dev.dma_mask = pdev->dev.dma_mask;
2872 dev->gadget.dev.release = gadget_release;
2873 dev->gadget.name = driver_name;
2875 /* now all the pci goodies ... */
2876 if (pci_enable_device (pdev) < 0) {
2882 /* BAR 0 holds all the registers
2883 * BAR 1 is 8051 memory; unused here (note erratum 0103)
2884 * BAR 2 is fifo memory; unused here
2886 resource = pci_resource_start (pdev, 0);
2887 len = pci_resource_len (pdev, 0);
2888 if (!request_mem_region (resource, len, driver_name)) {
2889 DEBUG (dev, "controller already in use\n");
2895 /* FIXME provide firmware download interface to put
2896 * 8051 code into the chip, e.g. to turn on PCI PM.
2899 base = ioremap_nocache (resource, len);
2901 DEBUG (dev, "can't map memory\n");
2905 dev->regs = (struct net2280_regs __iomem *) base;
2906 dev->usb = (struct net2280_usb_regs __iomem *) (base + 0x0080);
2907 dev->pci = (struct net2280_pci_regs __iomem *) (base + 0x0100);
2908 dev->dma = (struct net2280_dma_regs __iomem *) (base + 0x0180);
2909 dev->dep = (struct net2280_dep_regs __iomem *) (base + 0x0200);
2910 dev->epregs = (struct net2280_ep_regs __iomem *) (base + 0x0300);
2912 /* put into initial config, link up all endpoints */
2913 writel (0, &dev->usb->usbctl);
2917 /* irq setup after old hardware is cleaned up */
2919 ERROR (dev, "No IRQ. Check PCI setup!\n");
2924 if (request_irq (pdev->irq, net2280_irq, IRQF_SHARED, driver_name, dev)
2926 ERROR (dev, "request interrupt %d failed\n", pdev->irq);
2933 /* NOTE: we know only the 32 LSBs of dma addresses may be nonzero */
2934 dev->requests = pci_pool_create ("requests", pdev,
2935 sizeof (struct net2280_dma),
2936 0 /* no alignment requirements */,
2937 0 /* or page-crossing issues */);
2938 if (!dev->requests) {
2939 DEBUG (dev, "can't get request pool\n");
2943 for (i = 1; i < 5; i++) {
2944 struct net2280_dma *td;
2946 td = pci_pool_alloc (dev->requests, GFP_KERNEL,
2947 &dev->ep [i].td_dma);
2949 DEBUG (dev, "can't get dummy %d\n", i);
2953 td->dmacount = 0; /* not VALID */
2954 td->dmaaddr = __constant_cpu_to_le32 (DMA_ADDR_INVALID);
2955 td->dmadesc = td->dmaaddr;
2956 dev->ep [i].dummy = td;
2959 /* enable lower-overhead pci memory bursts during DMA */
2960 writel ( (1 << DMA_MEMORY_WRITE_AND_INVALIDATE_ENABLE)
2961 // 256 write retries may not be enough...
2962 // | (1 << PCI_RETRY_ABORT_ENABLE)
2963 | (1 << DMA_READ_MULTIPLE_ENABLE)
2964 | (1 << DMA_READ_LINE_ENABLE)
2965 , &dev->pci->pcimstctl);
2966 /* erratum 0115 shouldn't appear: Linux inits PCI_LATENCY_TIMER */
2967 pci_set_master (pdev);
2970 /* ... also flushes any posted pci writes */
2971 dev->chiprev = get_idx_reg (dev->regs, REG_CHIPREV) & 0xffff;
2974 INFO (dev, "%s\n", driver_desc);
2975 INFO (dev, "irq %d, pci mem %p, chip rev %04x\n",
2976 pdev->irq, base, dev->chiprev);
2977 INFO (dev, "version: " DRIVER_VERSION "; dma %s\n",
2979 ? (use_dma_chaining ? "chaining" : "enabled")
2981 the_controller = dev;
2983 retval = device_register (&dev->gadget.dev);
2984 if (retval) goto done;
2985 retval = device_create_file (&pdev->dev, &dev_attr_registers);
2986 if (retval) goto done;
2992 net2280_remove (pdev);
2996 /* make sure the board is quiescent; otherwise it will continue
2997 * generating IRQs across the upcoming reboot.
3000 static void net2280_shutdown (struct pci_dev *pdev)
3002 struct net2280 *dev = pci_get_drvdata (pdev);
3005 writel (0, &dev->regs->pciirqenb0);
3006 writel (0, &dev->regs->pciirqenb1);
3008 /* disable the pullup so the host will think we're gone */
3009 writel (0, &dev->usb->usbctl);
3013 /*-------------------------------------------------------------------------*/
3015 static const struct pci_device_id pci_ids [] = { {
3016 .class = ((PCI_CLASS_SERIAL_USB << 8) | 0xfe),
3020 .subvendor = PCI_ANY_ID,
3021 .subdevice = PCI_ANY_ID,
3023 .class = ((PCI_CLASS_SERIAL_USB << 8) | 0xfe),
3027 .subvendor = PCI_ANY_ID,
3028 .subdevice = PCI_ANY_ID,
3030 }, { /* end: all zeroes */ }
3032 MODULE_DEVICE_TABLE (pci, pci_ids);
3034 /* pci driver glue; this is a "new style" PCI driver module */
3035 static struct pci_driver net2280_pci_driver = {
3036 .name = (char *) driver_name,
3037 .id_table = pci_ids,
3039 .probe = net2280_probe,
3040 .remove = net2280_remove,
3041 .shutdown = net2280_shutdown,
3043 /* FIXME add power management support */
3046 MODULE_DESCRIPTION (DRIVER_DESC);
3047 MODULE_AUTHOR ("David Brownell");
3048 MODULE_LICENSE ("GPL");
3050 static int __init init (void)
3053 use_dma_chaining = 0;
3054 return pci_register_driver (&net2280_pci_driver);
3058 static void __exit cleanup (void)
3060 pci_unregister_driver (&net2280_pci_driver);
3062 module_exit (cleanup);