drivers/usb/gadget/net2280.c

   1 /*
   2  * Driver for the PLX NET2280 USB device controller.
   3  * Specs and errata are available from <http://www.plxtech.com>.
   4  *
   5  * PLX Technology Inc. (formerly NetChip Technology) supported the
   6  * development of this driver.
   7  *
   8  *
   9  * CODE STATUS HIGHLIGHTS
  10  *
  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.
  14  *
  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.
  20  *
  21  * Note that almost all the errata workarounds here are only needed for
  22  * rev1 chips.  Rev1a silicon (0110) fixes almost all of them.
  23  */
  24
  25 /*
  26  * Copyright (C) 2003 David Brownell
  27  * Copyright (C) 2003-2005 PLX Technology, Inc.
  28  *
  29  * Modified Seth Levy 2005 PLX Technology, Inc. to provide compatibility
  30  *      with 2282 chip
  31  *
  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.
  36  *
  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.
  41  *
  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
  45  */
  46
  47 #undef  DEBUG           /* messages on error and most fault paths */
  48 #undef  VERBOSE         /* extra debug messages (success too) */
  49
  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/sched.h>
  57 #include <linux/slab.h>
  58 #include <linux/smp_lock.h>
  59 #include <linux/errno.h>
  60 #include <linux/init.h>
  61 #include <linux/timer.h>
  62 #include <linux/list.h>
  63 #include <linux/interrupt.h>
  64 #include <linux/moduleparam.h>
  65 #include <linux/device.h>
  66 #include <linux/usb_ch9.h>
  67 #include <linux/usb_gadget.h>
  68
  69 #include <asm/byteorder.h>
  70 #include <asm/io.h>
  71 #include <asm/irq.h>
  72 #include <asm/system.h>
  73 #include <asm/unaligned.h>
  74
  75
  76 #define DRIVER_DESC             "PLX NET228x USB Peripheral Controller"
  77 #define DRIVER_VERSION          "2005 Sept 27"
  78
  79 #define DMA_ADDR_INVALID        (~(dma_addr_t)0)
  80 #define EP_DONTUSE              13      /* nonzero */
  81
  82 #define USE_RDK_LEDS            /* GPIO pins control three LEDs */
  83
  84
  85 static const char driver_name [] = "net2280";
  86 static const char driver_desc [] = DRIVER_DESC;
  87
  88 static const char ep0name [] = "ep0";
  89 static const char *const ep_name [] = {
  90         ep0name,
  91         "ep-a", "ep-b", "ep-c", "ep-d",
  92         "ep-e", "ep-f",
  93 };
  94
  95 /* use_dma -- general goodness, fewer interrupts, less cpu load (vs PIO)
  96  * use_dma_chaining -- dma descriptor queueing gives even more irq reduction
  97  *
  98  * The net2280 DMA engines are not tightly integrated with their FIFOs;
  99  * not all cases are (yet) handled well in this driver or the silicon.
 100  * Some gadget drivers work better with the dma support here than others.
 101  * These two parameters let you use PIO or more aggressive DMA.
 102  */
 103 static int use_dma = 1;
 104 static int use_dma_chaining = 0;
 105
 106 /* "modprobe net2280 use_dma=n" etc */
 107 module_param (use_dma, bool, S_IRUGO);
 108 module_param (use_dma_chaining, bool, S_IRUGO);
 109
 110
 111 /* mode 0 == ep-{a,b,c,d} 1K fifo each
 112  * mode 1 == ep-{a,b} 2K fifo each, ep-{c,d} unavailable
 113  * mode 2 == ep-a 2K fifo, ep-{b,c} 1K each, ep-d unavailable
 114  */
 115 static ushort fifo_mode = 0;
 116
 117 /* "modprobe net2280 fifo_mode=1" etc */
 118 module_param (fifo_mode, ushort, 0644);
 119
 120 /* enable_suspend -- When enabled, the driver will respond to
 121  * USB suspend requests by powering down the NET2280.  Otherwise,
 122  * USB suspend requests will be ignored.  This is acceptible for
 123  * self-powered devices
 124  */
 125 static int enable_suspend = 0;
 126
 127 /* "modprobe net2280 enable_suspend=1" etc */
 128 module_param (enable_suspend, bool, S_IRUGO);
 129
 130
 131 #define DIR_STRING(bAddress) (((bAddress) & USB_DIR_IN) ? "in" : "out")
 132
 133 #if defined(CONFIG_USB_GADGET_DEBUG_FILES) || defined (DEBUG)
 134 static char *type_string (u8 bmAttributes)
 135 {
 136         switch ((bmAttributes) & USB_ENDPOINT_XFERTYPE_MASK) {
 137         case USB_ENDPOINT_XFER_BULK:    return "bulk";
 138         case USB_ENDPOINT_XFER_ISOC:    return "iso";
 139         case USB_ENDPOINT_XFER_INT:     return "intr";
 140         };
 141         return "control";
 142 }
 143 #endif
 144
 145 #include "net2280.h"
 146
 147 #define valid_bit       __constant_cpu_to_le32 (1 << VALID_BIT)
 148 #define dma_done_ie     __constant_cpu_to_le32 (1 << DMA_DONE_INTERRUPT_ENABLE)
 149
 150 /*-------------------------------------------------------------------------*/
 151
 152 static int
 153 net2280_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
 154 {
 155         struct net2280          *dev;
 156         struct net2280_ep       *ep;
 157         u32                     max, tmp;
 158         unsigned long           flags;
 159
 160         ep = container_of (_ep, struct net2280_ep, ep);
 161         if (!_ep || !desc || ep->desc || _ep->name == ep0name
 162                         || desc->bDescriptorType != USB_DT_ENDPOINT)
 163                 return -EINVAL;
 164         dev = ep->dev;
 165         if (!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN)
 166                 return -ESHUTDOWN;
 167
 168         /* erratum 0119 workaround ties up an endpoint number */
 169         if ((desc->bEndpointAddress & 0x0f) == EP_DONTUSE)
 170                 return -EDOM;
 171
 172         /* sanity check ep-e/ep-f since their fifos are small */
 173         max = le16_to_cpu (desc->wMaxPacketSize) & 0x1fff;
 174         if (ep->num > 4 && max > 64)
 175                 return -ERANGE;
 176
 177         spin_lock_irqsave (&dev->lock, flags);
 178         _ep->maxpacket = max & 0x7ff;
 179         ep->desc = desc;
 180
 181         /* ep_reset() has already been called */
 182         ep->stopped = 0;
 183         ep->out_overflow = 0;
 184
 185         /* set speed-dependent max packet; may kick in high bandwidth */
 186         set_idx_reg (dev->regs, REG_EP_MAXPKT (dev, ep->num), max);
 187
 188         /* FIFO lines can't go to different packets.  PIO is ok, so
 189          * use it instead of troublesome (non-bulk) multi-packet DMA.
 190          */
 191         if (ep->dma && (max % 4) != 0 && use_dma_chaining) {
 192                 DEBUG (ep->dev, "%s, no dma for maxpacket %d\n",
 193                         ep->ep.name, ep->ep.maxpacket);
 194                 ep->dma = NULL;
 195         }
 196
 197         /* set type, direction, address; reset fifo counters */
 198         writel ((1 << FIFO_FLUSH), &ep->regs->ep_stat);
 199         tmp = (desc->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK);
 200         if (tmp == USB_ENDPOINT_XFER_INT) {
 201                 /* erratum 0105 workaround prevents hs NYET */
 202                 if (dev->chiprev == 0100
 203                                 && dev->gadget.speed == USB_SPEED_HIGH
 204                                 && !(desc->bEndpointAddress & USB_DIR_IN))
 205                         writel ((1 << CLEAR_NAK_OUT_PACKETS_MODE),
 206                                 &ep->regs->ep_rsp);
 207         } else if (tmp == USB_ENDPOINT_XFER_BULK) {
 208                 /* catch some particularly blatant driver bugs */
 209                 if ((dev->gadget.speed == USB_SPEED_HIGH
 210                                         && max != 512)
 211                                 || (dev->gadget.speed == USB_SPEED_FULL
 212                                         && max > 64)) {
 213                         spin_unlock_irqrestore (&dev->lock, flags);
 214                         return -ERANGE;
 215                 }
 216         }
 217         ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC) ? 1 : 0;
 218         tmp <<= ENDPOINT_TYPE;
 219         tmp |= desc->bEndpointAddress;
 220         tmp |= (4 << ENDPOINT_BYTE_COUNT);      /* default full fifo lines */
 221         tmp |= 1 << ENDPOINT_ENABLE;
 222         wmb ();
 223
 224         /* for OUT transfers, block the rx fifo until a read is posted */
 225         ep->is_in = (tmp & USB_DIR_IN) != 0;
 226         if (!ep->is_in)
 227                 writel ((1 << SET_NAK_OUT_PACKETS), &ep->regs->ep_rsp);
 228         else if (dev->pdev->device != 0x2280) {
 229                 /* Added for 2282, Don't use nak packets on an in endpoint,
 230                  * this was ignored on 2280
 231                  */
 232                 writel ((1 << CLEAR_NAK_OUT_PACKETS)
 233                         | (1 << CLEAR_NAK_OUT_PACKETS_MODE), &ep->regs->ep_rsp);
 234         }
 235
 236         writel (tmp, &ep->regs->ep_cfg);
 237
 238         /* enable irqs */
 239         if (!ep->dma) {                         /* pio, per-packet */
 240                 tmp = (1 << ep->num) | readl (&dev->regs->pciirqenb0);
 241                 writel (tmp, &dev->regs->pciirqenb0);
 242
 243                 tmp = (1 << DATA_PACKET_RECEIVED_INTERRUPT_ENABLE)
 244                         | (1 << DATA_PACKET_TRANSMITTED_INTERRUPT_ENABLE);
 245                 if (dev->pdev->device == 0x2280)
 246                         tmp |= readl (&ep->regs->ep_irqenb);
 247                 writel (tmp, &ep->regs->ep_irqenb);
 248         } else {                                /* dma, per-request */
 249                 tmp = (1 << (8 + ep->num));     /* completion */
 250                 tmp |= readl (&dev->regs->pciirqenb1);
 251                 writel (tmp, &dev->regs->pciirqenb1);
 252
 253                 /* for short OUT transfers, dma completions can't
 254                  * advance the queue; do it pio-style, by hand.
 255                  * NOTE erratum 0112 workaround #2
 256                  */
 257                 if ((desc->bEndpointAddress & USB_DIR_IN) == 0) {
 258                         tmp = (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT_ENABLE);
 259                         writel (tmp, &ep->regs->ep_irqenb);
 260
 261                         tmp = (1 << ep->num) | readl (&dev->regs->pciirqenb0);
 262                         writel (tmp, &dev->regs->pciirqenb0);
 263                 }
 264         }
 265
 266         tmp = desc->bEndpointAddress;
 267         DEBUG (dev, "enabled %s (ep%d%s-%s) %s max %04x\n",
 268                 _ep->name, tmp & 0x0f, DIR_STRING (tmp),
 269                 type_string (desc->bmAttributes),
 270                 ep->dma ? "dma" : "pio", max);
 271
 272         /* pci writes may still be posted */
 273         spin_unlock_irqrestore (&dev->lock, flags);
 274         return 0;
 275 }
 276
 277 static int handshake (u32 __iomem *ptr, u32 mask, u32 done, int usec)
 278 {
 279         u32     result;
 280
 281         do {
 282                 result = readl (ptr);
 283                 if (result == ~(u32)0)          /* "device unplugged" */
 284                         return -ENODEV;
 285                 result &= mask;
 286                 if (result == done)
 287                         return 0;
 288                 udelay (1);
 289                 usec--;
 290         } while (usec > 0);
 291         return -ETIMEDOUT;
 292 }
 293
 294 static const struct usb_ep_ops net2280_ep_ops;
 295
 296 static void ep_reset (struct net2280_regs __iomem *regs, struct net2280_ep *ep)
 297 {
 298         u32             tmp;
 299
 300         ep->desc = NULL;
 301         INIT_LIST_HEAD (&ep->queue);
 302
 303         ep->ep.maxpacket = ~0;
 304         ep->ep.ops = &net2280_ep_ops;
 305
 306         /* disable the dma, irqs, endpoint... */
 307         if (ep->dma) {
 308                 writel (0, &ep->dma->dmactl);
 309                 writel (  (1 << DMA_SCATTER_GATHER_DONE_INTERRUPT)
 310                         | (1 << DMA_TRANSACTION_DONE_INTERRUPT)
 311                         | (1 << DMA_ABORT)
 312                         , &ep->dma->dmastat);
 313
 314                 tmp = readl (&regs->pciirqenb0);
 315                 tmp &= ~(1 << ep->num);
 316                 writel (tmp, &regs->pciirqenb0);
 317         } else {
 318                 tmp = readl (&regs->pciirqenb1);
 319                 tmp &= ~(1 << (8 + ep->num));   /* completion */
 320                 writel (tmp, &regs->pciirqenb1);
 321         }
 322         writel (0, &ep->regs->ep_irqenb);
 323
 324         /* init to our chosen defaults, notably so that we NAK OUT
 325          * packets until the driver queues a read (+note erratum 0112)
 326          */
 327         if (!ep->is_in || ep->dev->pdev->device == 0x2280) {
 328                 tmp = (1 << SET_NAK_OUT_PACKETS_MODE)
 329                 | (1 << SET_NAK_OUT_PACKETS)
 330                 | (1 << CLEAR_EP_HIDE_STATUS_PHASE)
 331                 | (1 << CLEAR_INTERRUPT_MODE);
 332         } else {
 333                 /* added for 2282 */
 334                 tmp = (1 << CLEAR_NAK_OUT_PACKETS_MODE)
 335                 | (1 << CLEAR_NAK_OUT_PACKETS)
 336                 | (1 << CLEAR_EP_HIDE_STATUS_PHASE)
 337                 | (1 << CLEAR_INTERRUPT_MODE);
 338         }
 339
 340         if (ep->num != 0) {
 341                 tmp |= (1 << CLEAR_ENDPOINT_TOGGLE)
 342                         | (1 << CLEAR_ENDPOINT_HALT);
 343         }
 344         writel (tmp, &ep->regs->ep_rsp);
 345
 346         /* scrub most status bits, and flush any fifo state */
 347         if (ep->dev->pdev->device == 0x2280)
 348                 tmp = (1 << FIFO_OVERFLOW)
 349                         | (1 << FIFO_UNDERFLOW);
 350         else
 351                 tmp = 0;
 352
 353         writel (tmp | (1 << TIMEOUT)
 354                 | (1 << USB_STALL_SENT)
 355                 | (1 << USB_IN_NAK_SENT)
 356                 | (1 << USB_IN_ACK_RCVD)
 357                 | (1 << USB_OUT_PING_NAK_SENT)
 358                 | (1 << USB_OUT_ACK_SENT)
 359                 | (1 << FIFO_FLUSH)
 360                 | (1 << SHORT_PACKET_OUT_DONE_INTERRUPT)
 361                 | (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT)
 362                 | (1 << DATA_PACKET_RECEIVED_INTERRUPT)
 363                 | (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)
 364                 | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
 365                 | (1 << DATA_IN_TOKEN_INTERRUPT)
 366                 , &ep->regs->ep_stat);
 367
 368         /* fifo size is handled separately */
 369 }
 370
 371 static void nuke (struct net2280_ep *);
 372
 373 static int net2280_disable (struct usb_ep *_ep)
 374 {
 375         struct net2280_ep       *ep;
 376         unsigned long           flags;
 377
 378         ep = container_of (_ep, struct net2280_ep, ep);
 379         if (!_ep || !ep->desc || _ep->name == ep0name)
 380                 return -EINVAL;
 381
 382         spin_lock_irqsave (&ep->dev->lock, flags);
 383         nuke (ep);
 384         ep_reset (ep->dev->regs, ep);
 385
 386         VDEBUG (ep->dev, "disabled %s %s\n",
 387                         ep->dma ? "dma" : "pio", _ep->name);
 388
 389         /* synch memory views with the device */
 390         (void) readl (&ep->regs->ep_cfg);
 391
 392         if (use_dma && !ep->dma && ep->num >= 1 && ep->num <= 4)
 393                 ep->dma = &ep->dev->dma [ep->num - 1];
 394
 395         spin_unlock_irqrestore (&ep->dev->lock, flags);
 396         return 0;
 397 }
 398
 399 /*-------------------------------------------------------------------------*/
 400
 401 static struct usb_request *
 402 net2280_alloc_request (struct usb_ep *_ep, gfp_t gfp_flags)
 403 {
 404         struct net2280_ep       *ep;
 405         struct net2280_request  *req;
 406
 407         if (!_ep)
 408                 return NULL;
 409         ep = container_of (_ep, struct net2280_ep, ep);
 410
 411         req = kzalloc(sizeof(*req), gfp_flags);
 412         if (!req)
 413                 return NULL;
 414
 415         req->req.dma = DMA_ADDR_INVALID;
 416         INIT_LIST_HEAD (&req->queue);
 417
 418         /* this dma descriptor may be swapped with the previous dummy */
 419         if (ep->dma) {
 420                 struct net2280_dma      *td;
 421
 422                 td = pci_pool_alloc (ep->dev->requests, gfp_flags,
 423                                 &req->td_dma);
 424                 if (!td) {
 425                         kfree (req);
 426                         return NULL;
 427                 }
 428                 td->dmacount = 0;       /* not VALID */
 429                 td->dmaaddr = __constant_cpu_to_le32 (DMA_ADDR_INVALID);
 430                 td->dmadesc = td->dmaaddr;
 431                 req->td = td;
 432         }
 433         return &req->req;
 434 }
 435
 436 static void
 437 net2280_free_request (struct usb_ep *_ep, struct usb_request *_req)
 438 {
 439         struct net2280_ep       *ep;
 440         struct net2280_request  *req;
 441
 442         ep = container_of (_ep, struct net2280_ep, ep);
 443         if (!_ep || !_req)
 444                 return;
 445
 446         req = container_of (_req, struct net2280_request, req);
 447         WARN_ON (!list_empty (&req->queue));
 448         if (req->td)
 449                 pci_pool_free (ep->dev->requests, req->td, req->td_dma);
 450         kfree (req);
 451 }
 452
 453 /*-------------------------------------------------------------------------*/
 454
 455 /*
 456  * dma-coherent memory allocation (for dma-capable endpoints)
 457  *
 458  * NOTE: the dma_*_coherent() API calls suck.  Most implementations are
 459  * (a) page-oriented, so small buffers lose big; and (b) asymmetric with
 460  * respect to calls with irqs disabled:  alloc is safe, free is not.
 461  * We currently work around (b), but not (a).
 462  */
 463
 464 static void *
 465 net2280_alloc_buffer (
 466         struct usb_ep           *_ep,
 467         unsigned                bytes,
 468         dma_addr_t              *dma,
 469         gfp_t                   gfp_flags
 470 )
 471 {
 472         void                    *retval;
 473         struct net2280_ep       *ep;
 474
 475         ep = container_of (_ep, struct net2280_ep, ep);
 476         if (!_ep)
 477                 return NULL;
 478         *dma = DMA_ADDR_INVALID;
 479
 480         if (ep->dma)
 481                 retval = dma_alloc_coherent(&ep->dev->pdev->dev,
 482                                 bytes, dma, gfp_flags);
 483         else
 484                 retval = kmalloc(bytes, gfp_flags);
 485         return retval;
 486 }
 487
 488 static DEFINE_SPINLOCK(buflock);
 489 static LIST_HEAD(buffers);
 490
 491 struct free_record {
 492         struct list_head        list;
 493         struct device           *dev;
 494         unsigned                bytes;
 495         dma_addr_t              dma;
 496 };
 497
 498 static void do_free(unsigned long ignored)
 499 {
 500         spin_lock_irq(&buflock);
 501         while (!list_empty(&buffers)) {
 502                 struct free_record      *buf;
 503
 504                 buf = list_entry(buffers.next, struct free_record, list);
 505                 list_del(&buf->list);
 506                 spin_unlock_irq(&buflock);
 507
 508                 dma_free_coherent(buf->dev, buf->bytes, buf, buf->dma);
 509
 510                 spin_lock_irq(&buflock);
 511         }
 512         spin_unlock_irq(&buflock);
 513 }
 514
 515 static DECLARE_TASKLET(deferred_free, do_free, 0);
 516
 517 static void
 518 net2280_free_buffer (
 519         struct usb_ep *_ep,
 520         void *address,
 521         dma_addr_t dma,
 522         unsigned bytes
 523 ) {
 524         /* free memory into the right allocator */
 525         if (dma != DMA_ADDR_INVALID) {
 526                 struct net2280_ep       *ep;
 527                 struct free_record      *buf = address;
 528                 unsigned long           flags;
 529
 530                 ep = container_of(_ep, struct net2280_ep, ep);
 531                 if (!_ep)
 532                         return;
 533
 534                 ep = container_of (_ep, struct net2280_ep, ep);
 535                 buf->dev = &ep->dev->pdev->dev;
 536                 buf->bytes = bytes;
 537                 buf->dma = dma;
 538
 539                 spin_lock_irqsave(&buflock, flags);
 540                 list_add_tail(&buf->list, &buffers);
 541                 tasklet_schedule(&deferred_free);
 542                 spin_unlock_irqrestore(&buflock, flags);
 543         } else
 544                 kfree (address);
 545 }
 546
 547 /*-------------------------------------------------------------------------*/
 548
 549 /* load a packet into the fifo we use for usb IN transfers.
 550  * works for all endpoints.
 551  *
 552  * NOTE: pio with ep-a..ep-d could stuff multiple packets into the fifo
 553  * at a time, but this code is simpler because it knows it only writes
 554  * one packet.  ep-a..ep-d should use dma instead.
 555  */
 556 static void
 557 write_fifo (struct net2280_ep *ep, struct usb_request *req)
 558 {
 559         struct net2280_ep_regs  __iomem *regs = ep->regs;
 560         u8                      *buf;
 561         u32                     tmp;
 562         unsigned                count, total;
 563
 564         /* INVARIANT:  fifo is currently empty. (testable) */
 565
 566         if (req) {
 567                 buf = req->buf + req->actual;
 568                 prefetch (buf);
 569                 total = req->length - req->actual;
 570         } else {
 571                 total = 0;
 572                 buf = NULL;
 573         }
 574
 575         /* write just one packet at a time */
 576         count = ep->ep.maxpacket;
 577         if (count > total)      /* min() cannot be used on a bitfield */
 578                 count = total;
 579
 580         VDEBUG (ep->dev, "write %s fifo (IN) %d bytes%s req %p\n",
 581                         ep->ep.name, count,
 582                         (count != ep->ep.maxpacket) ? " (short)" : "",
 583                         req);
 584         while (count >= 4) {
 585                 /* NOTE be careful if you try to align these. fifo lines
 586                  * should normally be full (4 bytes) and successive partial
 587                  * lines are ok only in certain cases.
 588                  */
 589                 tmp = get_unaligned ((u32 *)buf);
 590                 cpu_to_le32s (&tmp);
 591                 writel (tmp, &regs->ep_data);
 592                 buf += 4;
 593                 count -= 4;
 594         }
 595
 596         /* last fifo entry is "short" unless we wrote a full packet.
 597          * also explicitly validate last word in (periodic) transfers
 598          * when maxpacket is not a multiple of 4 bytes.
 599          */
 600         if (count || total < ep->ep.maxpacket) {
 601                 tmp = count ? get_unaligned ((u32 *)buf) : count;
 602                 cpu_to_le32s (&tmp);
 603                 set_fifo_bytecount (ep, count & 0x03);
 604                 writel (tmp, &regs->ep_data);
 605         }
 606
 607         /* pci writes may still be posted */
 608 }
 609
 610 /* work around erratum 0106: PCI and USB race over the OUT fifo.
 611  * caller guarantees chiprev 0100, out endpoint is NAKing, and
 612  * there's no real data in the fifo.
 613  *
 614  * NOTE:  also used in cases where that erratum doesn't apply:
 615  * where the host wrote "too much" data to us.
 616  */
 617 static void out_flush (struct net2280_ep *ep)
 618 {
 619         u32     __iomem *statp;
 620         u32     tmp;
 621
 622         ASSERT_OUT_NAKING (ep);
 623
 624         statp = &ep->regs->ep_stat;
 625         writel (  (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
 626                 | (1 << DATA_PACKET_RECEIVED_INTERRUPT)
 627                 , statp);
 628         writel ((1 << FIFO_FLUSH), statp);
 629         mb ();
 630         tmp = readl (statp);
 631         if (tmp & (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
 632                         /* high speed did bulk NYET; fifo isn't filling */
 633                         && ep->dev->gadget.speed == USB_SPEED_FULL) {
 634                 unsigned        usec;
 635
 636                 usec = 50;              /* 64 byte bulk/interrupt */
 637                 handshake (statp, (1 << USB_OUT_PING_NAK_SENT),
 638                                 (1 << USB_OUT_PING_NAK_SENT), usec);
 639                 /* NAK done; now CLEAR_NAK_OUT_PACKETS is safe */
 640         }
 641 }
 642
 643 /* unload packet(s) from the fifo we use for usb OUT transfers.
 644  * returns true iff the request completed, because of short packet
 645  * or the request buffer having filled with full packets.
 646  *
 647  * for ep-a..ep-d this will read multiple packets out when they
 648  * have been accepted.
 649  */
 650 static int
 651 read_fifo (struct net2280_ep *ep, struct net2280_request *req)
 652 {
 653         struct net2280_ep_regs  __iomem *regs = ep->regs;
 654         u8                      *buf = req->req.buf + req->req.actual;
 655         unsigned                count, tmp, is_short;
 656         unsigned                cleanup = 0, prevent = 0;
 657
 658         /* erratum 0106 ... packets coming in during fifo reads might
 659          * be incompletely rejected.  not all cases have workarounds.
 660          */
 661         if (ep->dev->chiprev == 0x0100
 662                         && ep->dev->gadget.speed == USB_SPEED_FULL) {
 663                 udelay (1);
 664                 tmp = readl (&ep->regs->ep_stat);
 665                 if ((tmp & (1 << NAK_OUT_PACKETS)))
 666                         cleanup = 1;
 667                 else if ((tmp & (1 << FIFO_FULL))) {
 668                         start_out_naking (ep);
 669                         prevent = 1;
 670                 }
 671                 /* else: hope we don't see the problem */
 672         }
 673
 674         /* never overflow the rx buffer. the fifo reads packets until
 675          * it sees a short one; we might not be ready for them all.
 676          */
 677         prefetchw (buf);
 678         count = readl (&regs->ep_avail);
 679         if (unlikely (count == 0)) {
 680                 udelay (1);
 681                 tmp = readl (&ep->regs->ep_stat);
 682                 count = readl (&regs->ep_avail);
 683                 /* handled that data already? */
 684                 if (count == 0 && (tmp & (1 << NAK_OUT_PACKETS)) == 0)
 685                         return 0;
 686         }
 687
 688         tmp = req->req.length - req->req.actual;
 689         if (count > tmp) {
 690                 /* as with DMA, data overflow gets flushed */
 691                 if ((tmp % ep->ep.maxpacket) != 0) {
 692                         ERROR (ep->dev,
 693                                 "%s out fifo %d bytes, expected %d\n",
 694                                 ep->ep.name, count, tmp);
 695                         req->req.status = -EOVERFLOW;
 696                         cleanup = 1;
 697                         /* NAK_OUT_PACKETS will be set, so flushing is safe;
 698                          * the next read will start with the next packet
 699                          */
 700                 } /* else it's a ZLP, no worries */
 701                 count = tmp;
 702         }
 703         req->req.actual += count;
 704
 705         is_short = (count == 0) || ((count % ep->ep.maxpacket) != 0);
 706
 707         VDEBUG (ep->dev, "read %s fifo (OUT) %d bytes%s%s%s req %p %d/%d\n",
 708                         ep->ep.name, count, is_short ? " (short)" : "",
 709                         cleanup ? " flush" : "", prevent ? " nak" : "",
 710                         req, req->req.actual, req->req.length);
 711
 712         while (count >= 4) {
 713                 tmp = readl (&regs->ep_data);
 714                 cpu_to_le32s (&tmp);
 715                 put_unaligned (tmp, (u32 *)buf);
 716                 buf += 4;
 717                 count -= 4;
 718         }
 719         if (count) {
 720                 tmp = readl (&regs->ep_data);
 721                 /* LE conversion is implicit here: */
 722                 do {
 723                         *buf++ = (u8) tmp;
 724                         tmp >>= 8;
 725                 } while (--count);
 726         }
 727         if (cleanup)
 728                 out_flush (ep);
 729         if (prevent) {
 730                 writel ((1 << CLEAR_NAK_OUT_PACKETS), &ep->regs->ep_rsp);
 731                 (void) readl (&ep->regs->ep_rsp);
 732         }
 733
 734         return is_short || ((req->req.actual == req->req.length)
 735                                 && !req->req.zero);
 736 }
 737
 738 /* fill out dma descriptor to match a given request */
 739 static void
 740 fill_dma_desc (struct net2280_ep *ep, struct net2280_request *req, int valid)
 741 {
 742         struct net2280_dma      *td = req->td;
 743         u32                     dmacount = req->req.length;
 744
 745         /* don't let DMA continue after a short OUT packet,
 746          * so overruns can't affect the next transfer.
 747          * in case of overruns on max-size packets, we can't
 748          * stop the fifo from filling but we can flush it.
 749          */
 750         if (ep->is_in)
 751                 dmacount |= (1 << DMA_DIRECTION);
 752         if ((!ep->is_in && (dmacount % ep->ep.maxpacket) != 0)
 753                         || ep->dev->pdev->device != 0x2280)
 754                 dmacount |= (1 << END_OF_CHAIN);
 755
 756         req->valid = valid;
 757         if (valid)
 758                 dmacount |= (1 << VALID_BIT);
 759         if (likely(!req->req.no_interrupt || !use_dma_chaining))
 760                 dmacount |= (1 << DMA_DONE_INTERRUPT_ENABLE);
 761
 762         /* td->dmadesc = previously set by caller */
 763         td->dmaaddr = cpu_to_le32 (req->req.dma);
 764
 765         /* 2280 may be polling VALID_BIT through ep->dma->dmadesc */
 766         wmb ();
 767         td->dmacount = cpu_to_le32p (&dmacount);
 768 }
 769
 770 static const u32 dmactl_default =
 771                   (1 << DMA_SCATTER_GATHER_DONE_INTERRUPT)
 772                 | (1 << DMA_CLEAR_COUNT_ENABLE)
 773                 /* erratum 0116 workaround part 1 (use POLLING) */
 774                 | (POLL_100_USEC << DESCRIPTOR_POLLING_RATE)
 775                 | (1 << DMA_VALID_BIT_POLLING_ENABLE)
 776                 | (1 << DMA_VALID_BIT_ENABLE)
 777                 | (1 << DMA_SCATTER_GATHER_ENABLE)
 778                 /* erratum 0116 workaround part 2 (no AUTOSTART) */
 779                 | (1 << DMA_ENABLE);
 780
 781 static inline void spin_stop_dma (struct net2280_dma_regs __iomem *dma)
 782 {
 783         handshake (&dma->dmactl, (1 << DMA_ENABLE), 0, 50);
 784 }
 785
 786 static inline void stop_dma (struct net2280_dma_regs __iomem *dma)
 787 {
 788         writel (readl (&dma->dmactl) & ~(1 << DMA_ENABLE), &dma->dmactl);
 789         spin_stop_dma (dma);
 790 }
 791
 792 static void start_queue (struct net2280_ep *ep, u32 dmactl, u32 td_dma)
 793 {
 794         struct net2280_dma_regs __iomem *dma = ep->dma;
 795         unsigned int tmp = (1 << VALID_BIT) | (ep->is_in << DMA_DIRECTION);
 796
 797         if (ep->dev->pdev->device != 0x2280)
 798                 tmp |= (1 << END_OF_CHAIN);
 799
 800         writel (tmp, &dma->dmacount);
 801         writel (readl (&dma->dmastat), &dma->dmastat);
 802
 803         writel (td_dma, &dma->dmadesc);
 804         writel (dmactl, &dma->dmactl);
 805
 806         /* erratum 0116 workaround part 3:  pci arbiter away from net2280 */
 807         (void) readl (&ep->dev->pci->pcimstctl);
 808
 809         writel ((1 << DMA_START), &dma->dmastat);
 810
 811         if (!ep->is_in)
 812                 stop_out_naking (ep);
 813 }
 814
 815 static void start_dma (struct net2280_ep *ep, struct net2280_request *req)
 816 {
 817         u32                     tmp;
 818         struct net2280_dma_regs __iomem *dma = ep->dma;
 819
 820         /* FIXME can't use DMA for ZLPs */
 821
 822         /* on this path we "know" there's no dma active (yet) */
 823         WARN_ON (readl (&dma->dmactl) & (1 << DMA_ENABLE));
 824         writel (0, &ep->dma->dmactl);
 825
 826         /* previous OUT packet might have been short */
 827         if (!ep->is_in && ((tmp = readl (&ep->regs->ep_stat))
 828                                 & (1 << NAK_OUT_PACKETS)) != 0) {
 829                 writel ((1 << SHORT_PACKET_TRANSFERRED_INTERRUPT),
 830                         &ep->regs->ep_stat);
 831
 832                 tmp = readl (&ep->regs->ep_avail);
 833                 if (tmp) {
 834                         writel (readl (&dma->dmastat), &dma->dmastat);
 835
 836                         /* transfer all/some fifo data */
 837                         writel (req->req.dma, &dma->dmaaddr);
 838                         tmp = min (tmp, req->req.length);
 839
 840                         /* dma irq, faking scatterlist status */
 841                         req->td->dmacount = cpu_to_le32 (req->req.length - tmp);
 842                         writel ((1 << DMA_DONE_INTERRUPT_ENABLE)
 843                                 | tmp, &dma->dmacount);
 844                         req->td->dmadesc = 0;
 845                         req->valid = 1;
 846
 847                         writel ((1 << DMA_ENABLE), &dma->dmactl);
 848                         writel ((1 << DMA_START), &dma->dmastat);
 849                         return;
 850                 }
 851         }
 852
 853         tmp = dmactl_default;
 854
 855         /* force packet boundaries between dma requests, but prevent the
 856          * controller from automagically writing a last "short" packet
 857          * (zero length) unless the driver explicitly said to do that.
 858          */
 859         if (ep->is_in) {
 860                 if (likely ((req->req.length % ep->ep.maxpacket) != 0
 861                                 || req->req.zero)) {
 862                         tmp |= (1 << DMA_FIFO_VALIDATE);
 863                         ep->in_fifo_validate = 1;
 864                 } else
 865                         ep->in_fifo_validate = 0;
 866         }
 867
 868         /* init req->td, pointing to the current dummy */
 869         req->td->dmadesc = cpu_to_le32 (ep->td_dma);
 870         fill_dma_desc (ep, req, 1);
 871
 872         if (!use_dma_chaining)
 873                 req->td->dmacount |= __constant_cpu_to_le32 (1 << END_OF_CHAIN);
 874
 875         start_queue (ep, tmp, req->td_dma);
 876 }
 877
 878 static inline void
 879 queue_dma (struct net2280_ep *ep, struct net2280_request *req, int valid)
 880 {
 881         struct net2280_dma      *end;
 882         dma_addr_t              tmp;
 883
 884         /* swap new dummy for old, link; fill and maybe activate */
 885         end = ep->dummy;
 886         ep->dummy = req->td;
 887         req->td = end;
 888
 889         tmp = ep->td_dma;
 890         ep->td_dma = req->td_dma;
 891         req->td_dma = tmp;
 892
 893         end->dmadesc = cpu_to_le32 (ep->td_dma);
 894
 895         fill_dma_desc (ep, req, valid);
 896 }
 897
 898 static void
 899 done (struct net2280_ep *ep, struct net2280_request *req, int status)
 900 {
 901         struct net2280          *dev;
 902         unsigned                stopped = ep->stopped;
 903
 904         list_del_init (&req->queue);
 905
 906         if (req->req.status == -EINPROGRESS)
 907                 req->req.status = status;
 908         else
 909                 status = req->req.status;
 910
 911         dev = ep->dev;
 912         if (req->mapped) {
 913                 pci_unmap_single (dev->pdev, req->req.dma, req->req.length,
 914                         ep->is_in ? PCI_DMA_TODEVICE : PCI_DMA_FROMDEVICE);
 915                 req->req.dma = DMA_ADDR_INVALID;
 916                 req->mapped = 0;
 917         }
 918
 919         if (status && status != -ESHUTDOWN)
 920                 VDEBUG (dev, "complete %s req %p stat %d len %u/%u\n",
 921                         ep->ep.name, &req->req, status,
 922                         req->req.actual, req->req.length);
 923
 924         /* don't modify queue heads during completion callback */
 925         ep->stopped = 1;
 926         spin_unlock (&dev->lock);
 927         req->req.complete (&ep->ep, &req->req);
 928         spin_lock (&dev->lock);
 929         ep->stopped = stopped;
 930 }
 931
 932 /*-------------------------------------------------------------------------*/
 933
 934 static int
 935 net2280_queue (struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
 936 {
 937         struct net2280_request  *req;
 938         struct net2280_ep       *ep;
 939         struct net2280          *dev;
 940         unsigned long           flags;
 941
 942         /* we always require a cpu-view buffer, so that we can
 943          * always use pio (as fallback or whatever).
 944          */
 945         req = container_of (_req, struct net2280_request, req);
 946         if (!_req || !_req->complete || !_req->buf
 947                         || !list_empty (&req->queue))
 948                 return -EINVAL;
 949         if (_req->length > (~0 & DMA_BYTE_COUNT_MASK))
 950                 return -EDOM;
 951         ep = container_of (_ep, struct net2280_ep, ep);
 952         if (!_ep || (!ep->desc && ep->num != 0))
 953                 return -EINVAL;
 954         dev = ep->dev;
 955         if (!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN)
 956                 return -ESHUTDOWN;
 957
 958         /* FIXME implement PIO fallback for ZLPs with DMA */
 959         if (ep->dma && _req->length == 0)
 960                 return -EOPNOTSUPP;
 961
 962         /* set up dma mapping in case the caller didn't */
 963         if (ep->dma && _req->dma == DMA_ADDR_INVALID) {
 964                 _req->dma = pci_map_single (dev->pdev, _req->buf, _req->length,
 965                         ep->is_in ? PCI_DMA_TODEVICE : PCI_DMA_FROMDEVICE);
 966                 req->mapped = 1;
 967         }
 968
 969 #if 0
 970         VDEBUG (dev, "%s queue req %p, len %d buf %p\n",
 971                         _ep->name, _req, _req->length, _req->buf);
 972 #endif
 973
 974         spin_lock_irqsave (&dev->lock, flags);
 975
 976         _req->status = -EINPROGRESS;
 977         _req->actual = 0;
 978
 979         /* kickstart this i/o queue? */
 980         if (list_empty (&ep->queue) && !ep->stopped) {
 981                 /* use DMA if the endpoint supports it, else pio */
 982                 if (ep->dma)
 983                         start_dma (ep, req);
 984                 else {
 985                         /* maybe there's no control data, just status ack */
 986                         if (ep->num == 0 && _req->length == 0) {
 987                                 allow_status (ep);
 988                                 done (ep, req, 0);
 989                                 VDEBUG (dev, "%s status ack\n", ep->ep.name);
 990                                 goto done;
 991                         }
 992
 993                         /* PIO ... stuff the fifo, or unblock it.  */
 994                         if (ep->is_in)
 995                                 write_fifo (ep, _req);
 996                         else if (list_empty (&ep->queue)) {
 997                                 u32     s;
 998
 999                                 /* OUT FIFO might have packet(s) buffered */
1000                                 s = readl (&ep->regs->ep_stat);
1001                                 if ((s & (1 << FIFO_EMPTY)) == 0) {
1002                                         /* note:  _req->short_not_ok is
1003                                          * ignored here since PIO _always_
1004                                          * stops queue advance here, and
1005                                          * _req->status doesn't change for
1006                                          * short reads (only _req->actual)
1007                                          */
1008                                         if (read_fifo (ep, req)) {
1009                                                 done (ep, req, 0);
1010                                                 if (ep->num == 0)
1011                                                         allow_status (ep);
1012                                                 /* don't queue it */
1013                                                 req = NULL;
1014                                         } else
1015                                                 s = readl (&ep->regs->ep_stat);
1016                                 }
1017
1018                                 /* don't NAK, let the fifo fill */
1019                                 if (req && (s & (1 << NAK_OUT_PACKETS)))
1020                                         writel ((1 << CLEAR_NAK_OUT_PACKETS),
1021                                                         &ep->regs->ep_rsp);
1022                         }
1023                 }
1024
1025         } else if (ep->dma) {
1026                 int     valid = 1;
1027
1028                 if (ep->is_in) {
1029                         int     expect;
1030
1031                         /* preventing magic zlps is per-engine state, not
1032                          * per-transfer; irq logic must recover hiccups.
1033                          */
1034                         expect = likely (req->req.zero
1035                                 || (req->req.length % ep->ep.maxpacket) != 0);
1036                         if (expect != ep->in_fifo_validate)
1037                                 valid = 0;
1038                 }
1039                 queue_dma (ep, req, valid);
1040
1041         } /* else the irq handler advances the queue. */
1042
1043         if (req)
1044                 list_add_tail (&req->queue, &ep->queue);
1045 done:
1046         spin_unlock_irqrestore (&dev->lock, flags);
1047
1048         /* pci writes may still be posted */
1049         return 0;
1050 }
1051
1052 static inline void
1053 dma_done (
1054         struct net2280_ep *ep,
1055         struct net2280_request *req,
1056         u32 dmacount,
1057         int status
1058 )
1059 {
1060         req->req.actual = req->req.length - (DMA_BYTE_COUNT_MASK & dmacount);
1061         done (ep, req, status);
1062 }
1063
1064 static void restart_dma (struct net2280_ep *ep);
1065
1066 static void scan_dma_completions (struct net2280_ep *ep)
1067 {
1068         /* only look at descriptors that were "naturally" retired,
1069          * so fifo and list head state won't matter
1070          */
1071         while (!list_empty (&ep->queue)) {
1072                 struct net2280_request  *req;
1073                 u32                     tmp;
1074
1075                 req = list_entry (ep->queue.next,
1076                                 struct net2280_request, queue);
1077                 if (!req->valid)
1078                         break;
1079                 rmb ();
1080                 tmp = le32_to_cpup (&req->td->dmacount);
1081                 if ((tmp & (1 << VALID_BIT)) != 0)
1082                         break;
1083
1084                 /* SHORT_PACKET_TRANSFERRED_INTERRUPT handles "usb-short"
1085                  * cases where DMA must be aborted; this code handles
1086                  * all non-abort DMA completions.
1087                  */
1088                 if (unlikely (req->td->dmadesc == 0)) {
1089                         /* paranoia */
1090                         tmp = readl (&ep->dma->dmacount);
1091                         if (tmp & DMA_BYTE_COUNT_MASK)
1092                                 break;
1093                         /* single transfer mode */
1094                         dma_done (ep, req, tmp, 0);
1095                         break;
1096                 } else if (!ep->is_in
1097                                 && (req->req.length % ep->ep.maxpacket) != 0) {
1098                         tmp = readl (&ep->regs->ep_stat);
1099
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.
1103                          */
1104                         if ((tmp & (1 << NAK_OUT_PACKETS)) == 0) {
1105                                 WARN (ep->dev, "%s lost packet sync!\n",
1106                                                 ep->ep.name);
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",
1112                                                 ep->ep.name, tmp,
1113                                                 req->req.length);
1114                                 req->req.status = -EOVERFLOW;
1115                         }
1116                 }
1117                 dma_done (ep, req, tmp, 0);
1118         }
1119 }
1120
1121 static void restart_dma (struct net2280_ep *ep)
1122 {
1123         struct net2280_request  *req;
1124         u32                     dmactl = dmactl_default;
1125
1126         if (ep->stopped)
1127                 return;
1128         req = list_entry (ep->queue.next, struct net2280_request, queue);
1129
1130         if (!use_dma_chaining) {
1131                 start_dma (ep, req);
1132                 return;
1133         }
1134
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.
1140          */
1141         if (ep->is_in && !req->valid) {
1142                 struct net2280_request  *entry, *prev = NULL;
1143                 int                     reqmode, done = 0;
1144
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) {
1151                         __le32          dmacount;
1152
1153                         if (entry == req)
1154                                 continue;
1155                         dmacount = entry->td->dmacount;
1156                         if (!done) {
1157                                 reqmode = likely (entry->req.zero
1158                                         || (entry->req.length
1159                                                 % ep->ep.maxpacket) != 0);
1160                                 if (reqmode == ep->in_fifo_validate) {
1161                                         entry->valid = 1;
1162                                         dmacount |= valid_bit;
1163                                         entry->td->dmacount = dmacount;
1164                                         prev = entry;
1165                                         continue;
1166                                 } else {
1167                                         /* force a hiccup */
1168                                         prev->td->dmacount |= dma_done_ie;
1169                                         done = 1;
1170                                 }
1171                         }
1172
1173                         /* walk the rest of the queue so unlinks behave */
1174                         entry->valid = 0;
1175                         dmacount &= ~valid_bit;
1176                         entry->td->dmacount = dmacount;
1177                         prev = entry;
1178                 }
1179         }
1180
1181         writel (0, &ep->dma->dmactl);
1182         start_queue (ep, dmactl, req->td_dma);
1183 }
1184
1185 static void abort_dma (struct net2280_ep *ep)
1186 {
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);
1192         } else
1193                 stop_dma (ep->dma);
1194         scan_dma_completions (ep);
1195 }
1196
1197 /* dequeue ALL requests */
1198 static void nuke (struct net2280_ep *ep)
1199 {
1200         struct net2280_request  *req;
1201
1202         /* called with spinlock held */
1203         ep->stopped = 1;
1204         if (ep->dma)
1205                 abort_dma (ep);
1206         while (!list_empty (&ep->queue)) {
1207                 req = list_entry (ep->queue.next,
1208                                 struct net2280_request,
1209                                 queue);
1210                 done (ep, req, -ESHUTDOWN);
1211         }
1212 }
1213
1214 /* dequeue JUST ONE request */
1215 static int net2280_dequeue (struct usb_ep *_ep, struct usb_request *_req)
1216 {
1217         struct net2280_ep       *ep;
1218         struct net2280_request  *req;
1219         unsigned long           flags;
1220         u32                     dmactl;
1221         int                     stopped;
1222
1223         ep = container_of (_ep, struct net2280_ep, ep);
1224         if (!_ep || (!ep->desc && ep->num != 0) || !_req)
1225                 return -EINVAL;
1226
1227         spin_lock_irqsave (&ep->dev->lock, flags);
1228         stopped = ep->stopped;
1229
1230         /* quiesce dma while we patch the queue */
1231         dmactl = 0;
1232         ep->stopped = 1;
1233         if (ep->dma) {
1234                 dmactl = readl (&ep->dma->dmactl);
1235                 /* WARNING erratum 0127 may kick in ... */
1236                 stop_dma (ep->dma);
1237                 scan_dma_completions (ep);
1238         }
1239
1240         /* make sure it's still queued on this endpoint */
1241         list_for_each_entry (req, &ep->queue, queue) {
1242                 if (&req->req == _req)
1243                         break;
1244         }
1245         if (&req->req != _req) {
1246                 spin_unlock_irqrestore (&ep->dev->lock, flags);
1247                 return -EINVAL;
1248         }
1249
1250         /* queue head may be partially complete. */
1251         if (ep->queue.next == &req->queue) {
1252                 if (ep->dma) {
1253                         DEBUG (ep->dev, "unlink (%s) dma\n", _ep->name);
1254                         _req->status = -ECONNRESET;
1255                         abort_dma (ep);
1256                         if (likely (ep->queue.next == &req->queue)) {
1257                                 // NOTE: misreports single-transfer mode
1258                                 req->td->dmacount = 0;  /* invalidate */
1259                                 dma_done (ep, req,
1260                                         readl (&ep->dma->dmacount),
1261                                         -ECONNRESET);
1262                         }
1263                 } else {
1264                         DEBUG (ep->dev, "unlink (%s) pio\n", _ep->name);
1265                         done (ep, req, -ECONNRESET);
1266                 }
1267                 req = NULL;
1268
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),
1273                                 &ep->dma->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);
1278                 } else {
1279                         struct net2280_request  *prev;
1280
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;
1286                 }
1287         }
1288
1289         if (req)
1290                 done (ep, req, -ECONNRESET);
1291         ep->stopped = stopped;
1292
1293         if (ep->dma) {
1294                 /* turn off dma on inactive queues */
1295                 if (list_empty (&ep->queue))
1296                         stop_dma (ep->dma);
1297                 else if (!ep->stopped) {
1298                         /* resume current request, or start new one */
1299                         if (req)
1300                                 writel (dmactl, &ep->dma->dmactl);
1301                         else
1302                                 start_dma (ep, list_entry (ep->queue.next,
1303                                         struct net2280_request, queue));
1304                 }
1305         }
1306
1307         spin_unlock_irqrestore (&ep->dev->lock, flags);
1308         return 0;
1309 }
1310
1311 /*-------------------------------------------------------------------------*/
1312
1313 static int net2280_fifo_status (struct usb_ep *_ep);
1314
1315 static int
1316 net2280_set_halt (struct usb_ep *_ep, int value)
1317 {
1318         struct net2280_ep       *ep;
1319         unsigned long           flags;
1320         int                     retval = 0;
1321
1322         ep = container_of (_ep, struct net2280_ep, ep);
1323         if (!_ep || (!ep->desc && ep->num != 0))
1324                 return -EINVAL;
1325         if (!ep->dev->driver || ep->dev->gadget.speed == USB_SPEED_UNKNOWN)
1326                 return -ESHUTDOWN;
1327         if (ep->desc /* not ep0 */ && (ep->desc->bmAttributes & 0x03)
1328                                                 == USB_ENDPOINT_XFER_ISOC)
1329                 return -EINVAL;
1330
1331         spin_lock_irqsave (&ep->dev->lock, flags);
1332         if (!list_empty (&ep->queue))
1333                 retval = -EAGAIN;
1334         else if (ep->is_in && value && net2280_fifo_status (_ep) != 0)
1335                 retval = -EAGAIN;
1336         else {
1337                 VDEBUG (ep->dev, "%s %s halt\n", _ep->name,
1338                                 value ? "set" : "clear");
1339                 /* set/clear, then synch memory views with the device */
1340                 if (value) {
1341                         if (ep->num == 0)
1342                                 ep->dev->protocol_stall = 1;
1343                         else
1344                                 set_halt (ep);
1345                 } else
1346                         clear_halt (ep);
1347                 (void) readl (&ep->regs->ep_rsp);
1348         }
1349         spin_unlock_irqrestore (&ep->dev->lock, flags);
1350
1351         return retval;
1352 }
1353
1354 static int
1355 net2280_fifo_status (struct usb_ep *_ep)
1356 {
1357         struct net2280_ep       *ep;
1358         u32                     avail;
1359
1360         ep = container_of (_ep, struct net2280_ep, ep);
1361         if (!_ep || (!ep->desc && ep->num != 0))
1362                 return -ENODEV;
1363         if (!ep->dev->driver || ep->dev->gadget.speed == USB_SPEED_UNKNOWN)
1364                 return -ESHUTDOWN;
1365
1366         avail = readl (&ep->regs->ep_avail) & ((1 << 12) - 1);
1367         if (avail > ep->fifo_size)
1368                 return -EOVERFLOW;
1369         if (ep->is_in)
1370                 avail = ep->fifo_size - avail;
1371         return avail;
1372 }
1373
1374 static void
1375 net2280_fifo_flush (struct usb_ep *_ep)
1376 {
1377         struct net2280_ep       *ep;
1378
1379         ep = container_of (_ep, struct net2280_ep, ep);
1380         if (!_ep || (!ep->desc && ep->num != 0))
1381                 return;
1382         if (!ep->dev->driver || ep->dev->gadget.speed == USB_SPEED_UNKNOWN)
1383                 return;
1384
1385         writel ((1 << FIFO_FLUSH), &ep->regs->ep_stat);
1386         (void) readl (&ep->regs->ep_rsp);
1387 }
1388
1389 static const struct usb_ep_ops net2280_ep_ops = {
1390         .enable         = net2280_enable,
1391         .disable        = net2280_disable,
1392
1393         .alloc_request  = net2280_alloc_request,
1394         .free_request   = net2280_free_request,
1395
1396         .alloc_buffer   = net2280_alloc_buffer,
1397         .free_buffer    = net2280_free_buffer,
1398
1399         .queue          = net2280_queue,
1400         .dequeue        = net2280_dequeue,
1401
1402         .set_halt       = net2280_set_halt,
1403         .fifo_status    = net2280_fifo_status,
1404         .fifo_flush     = net2280_fifo_flush,
1405 };
1406
1407 /*-------------------------------------------------------------------------*/
1408
1409 static int net2280_get_frame (struct usb_gadget *_gadget)
1410 {
1411         struct net2280          *dev;
1412         unsigned long           flags;
1413         u16                     retval;
1414
1415         if (!_gadget)
1416                 return -ENODEV;
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);
1421         return retval;
1422 }
1423
1424 static int net2280_wakeup (struct usb_gadget *_gadget)
1425 {
1426         struct net2280          *dev;
1427         u32                     tmp;
1428         unsigned long           flags;
1429
1430         if (!_gadget)
1431                 return 0;
1432         dev = container_of (_gadget, struct net2280, gadget);
1433
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);
1439
1440         /* pci writes may still be posted */
1441         return 0;
1442 }
1443
1444 static int net2280_set_selfpowered (struct usb_gadget *_gadget, int value)
1445 {
1446         struct net2280          *dev;
1447         u32                     tmp;
1448         unsigned long           flags;
1449
1450         if (!_gadget)
1451                 return 0;
1452         dev = container_of (_gadget, struct net2280, gadget);
1453
1454         spin_lock_irqsave (&dev->lock, flags);
1455         tmp = readl (&dev->usb->usbctl);
1456         if (value)
1457                 tmp |= (1 << SELF_POWERED_STATUS);
1458         else
1459                 tmp &= ~(1 << SELF_POWERED_STATUS);
1460         writel (tmp, &dev->usb->usbctl);
1461         spin_unlock_irqrestore (&dev->lock, flags);
1462
1463         return 0;
1464 }
1465
1466 static int net2280_pullup(struct usb_gadget *_gadget, int is_on)
1467 {
1468         struct net2280  *dev;
1469         u32             tmp;
1470         unsigned long   flags;
1471
1472         if (!_gadget)
1473                 return -ENODEV;
1474         dev = container_of (_gadget, struct net2280, gadget);
1475
1476         spin_lock_irqsave (&dev->lock, flags);
1477         tmp = readl (&dev->usb->usbctl);
1478         dev->softconnect = (is_on != 0);
1479         if (is_on)
1480                 tmp |= (1 << USB_DETECT_ENABLE);
1481         else
1482                 tmp &= ~(1 << USB_DETECT_ENABLE);
1483         writel (tmp, &dev->usb->usbctl);
1484         spin_unlock_irqrestore (&dev->lock, flags);
1485
1486         return 0;
1487 }
1488
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,
1494 };
1495
1496 /*-------------------------------------------------------------------------*/
1497
1498 #ifdef  CONFIG_USB_GADGET_DEBUG_FILES
1499
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.
1503  */
1504
1505 /* "function" sysfs attribute */
1506 static ssize_t
1507 show_function (struct device *_dev, struct device_attribute *attr, char *buf)
1508 {
1509         struct net2280  *dev = dev_get_drvdata (_dev);
1510
1511         if (!dev->driver
1512                         || !dev->driver->function
1513                         || strlen (dev->driver->function) > PAGE_SIZE)
1514                 return 0;
1515         return scnprintf (buf, PAGE_SIZE, "%s\n", dev->driver->function);
1516 }
1517 static DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
1518
1519 static ssize_t
1520 show_registers (struct device *_dev, struct device_attribute *attr, char *buf)
1521 {
1522         struct net2280          *dev;
1523         char                    *next;
1524         unsigned                size, t;
1525         unsigned long           flags;
1526         int                     i;
1527         u32                     t1, t2;
1528         const char              *s;
1529
1530         dev = dev_get_drvdata (_dev);
1531         next = buf;
1532         size = PAGE_SIZE;
1533         spin_lock_irqsave (&dev->lock, flags);
1534
1535         if (dev->driver)
1536                 s = dev->driver->driver.name;
1537         else
1538                 s = "(none)";
1539
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,
1547                         use_dma
1548                                 ? (use_dma_chaining ? "chaining" : "enabled")
1549                                 : "disabled",
1550                         readl (&dev->regs->devinit),
1551                         readl (&dev->regs->fifoctl),
1552                         s,
1553                         readl (&dev->regs->pciirqenb0),
1554                         readl (&dev->regs->pciirqenb1),
1555                         readl (&dev->regs->irqstat0),
1556                         readl (&dev->regs->irqstat1));
1557         size -= t;
1558         next += t;
1559
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))
1565                         s = "high speed";
1566                 else if (dev->gadget.speed == USB_SPEED_UNKNOWN)
1567                         s = "powered";
1568                 else
1569                         s = "full speed";
1570                 /* full speed bit (6) not working?? */
1571         } else
1572                         s = "not attached";
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);
1578         size -= t;
1579         next += t;
1580
1581         /* PCI Master Control Registers */
1582
1583         /* DMA Control Registers */
1584
1585         /* Configurable EP Control Registers */
1586         for (i = 0; i < 7; i++) {
1587                 struct net2280_ep       *ep;
1588
1589                 ep = &dev->ep [i];
1590                 if (i && !ep->desc)
1591                         continue;
1592
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"
1597                                         "irqenb %02x\n",
1598                                 ep->ep.name, t1, t2,
1599                                 (t2 & (1 << CLEAR_NAK_OUT_PACKETS))
1600                                         ? "NAK " : "",
1601                                 (t2 & (1 << CLEAR_EP_HIDE_STATUS_PHASE))
1602                                         ? "hide " : "",
1603                                 (t2 & (1 << CLEAR_EP_FORCE_CRC_ERROR))
1604                                         ? "CRC " : "",
1605                                 (t2 & (1 << CLEAR_INTERRUPT_MODE))
1606                                         ? "interrupt " : "",
1607                                 (t2 & (1<<CLEAR_CONTROL_STATUS_PHASE_HANDSHAKE))
1608                                         ? "status " : "",
1609                                 (t2 & (1 << CLEAR_NAK_OUT_PACKETS_MODE))
1610                                         ? "NAKmode " : "",
1611                                 (t2 & (1 << CLEAR_ENDPOINT_TOGGLE))
1612                                         ? "DATA1 " : "DATA0 ",
1613                                 (t2 & (1 << CLEAR_ENDPOINT_HALT))
1614                                         ? "HALT " : "",
1615                                 readl (&ep->regs->ep_irqenb));
1616                 size -= t;
1617                 next += t;
1618
1619                 t = scnprintf (next, size,
1620                                 "\tstat %08x avail %04x "
1621                                 "(ep%d%s-%s)%s\n",
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 ? "*" : "");
1627                 size -= t;
1628                 next += t;
1629
1630                 if (!ep->dma)
1631                         continue;
1632
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));
1641                 size -= t;
1642                 next += t;
1643
1644         }
1645
1646         /* Indexed Registers */
1647                 // none yet
1648
1649         /* Statistics */
1650         t = scnprintf (next, size, "\nirqs:  ");
1651         size -= t;
1652         next += t;
1653         for (i = 0; i < 7; i++) {
1654                 struct net2280_ep       *ep;
1655
1656                 ep = &dev->ep [i];
1657                 if (i && !ep->irqs)
1658                         continue;
1659                 t = scnprintf (next, size, " %s/%lu", ep->ep.name, ep->irqs);
1660                 size -= t;
1661                 next += t;
1662
1663         }
1664         t = scnprintf (next, size, "\n");
1665         size -= t;
1666         next += t;
1667
1668         spin_unlock_irqrestore (&dev->lock, flags);
1669
1670         return PAGE_SIZE - size;
1671 }
1672 static DEVICE_ATTR (registers, S_IRUGO, show_registers, NULL);
1673
1674 static ssize_t
1675 show_queues (struct device *_dev, struct device_attribute *attr, char *buf)
1676 {
1677         struct net2280          *dev;
1678         char                    *next;
1679         unsigned                size;
1680         unsigned long           flags;
1681         int                     i;
1682
1683         dev = dev_get_drvdata (_dev);
1684         next = buf;
1685         size = PAGE_SIZE;
1686         spin_lock_irqsave (&dev->lock, flags);
1687
1688         for (i = 0; i < 7; i++) {
1689                 struct net2280_ep               *ep = &dev->ep [i];
1690                 struct net2280_request          *req;
1691                 int                             t;
1692
1693                 if (i != 0) {
1694                         const struct usb_endpoint_descriptor    *d;
1695
1696                         d = ep->desc;
1697                         if (!d)
1698                                 continue;
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",
1704                                 ({ char *val;
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;
1710                                  default:
1711                                         val = "iso"; break;
1712                                  }; val; }),
1713                                 le16_to_cpu (d->wMaxPacketSize) & 0x1fff,
1714                                 ep->dma ? "dma" : "pio", ep->fifo_size
1715                                 );
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)
1720                         goto done;
1721                 size -= t;
1722                 next += t;
1723
1724                 if (list_empty (&ep->queue)) {
1725                         t = scnprintf (next, size, "\t(nothing queued)\n");
1726                         if (t <= 0 || t > size)
1727                                 goto done;
1728                         size -= t;
1729                         next += t;
1730                         continue;
1731                 }
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));
1740                         else
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)
1746                                 goto done;
1747                         size -= t;
1748                         next += t;
1749
1750                         if (ep->dma) {
1751                                 struct net2280_dma      *td;
1752
1753                                 td = req->td;
1754                                 t = scnprintf (next, size, "\t    td %08x "
1755                                         " count %08x buf %08x desc %08x\n",
1756                                         (u32) req->td_dma,
1757                                         le32_to_cpu (td->dmacount),
1758                                         le32_to_cpu (td->dmaaddr),
1759                                         le32_to_cpu (td->dmadesc));
1760                                 if (t <= 0 || t > size)
1761                                         goto done;
1762                                 size -= t;
1763                                 next += t;
1764                         }
1765                 }
1766         }
1767
1768 done:
1769         spin_unlock_irqrestore (&dev->lock, flags);
1770         return PAGE_SIZE - size;
1771 }
1772 static DEVICE_ATTR (queues, S_IRUGO, show_queues, NULL);
1773
1774
1775 #else
1776
1777 #define device_create_file(a,b) do {} while (0)
1778 #define device_remove_file      device_create_file
1779
1780 #endif
1781
1782 /*-------------------------------------------------------------------------*/
1783
1784 /* another driver-specific mode might be a request type doing dma
1785  * to/from another device fifo instead of to/from memory.
1786  */
1787
1788 static void set_fifo_mode (struct net2280 *dev, int mode)
1789 {
1790         /* keeping high bits preserves BAR2 */
1791         writel ((0xffff << PCI_BASE2_RANGE) | mode, &dev->regs->fifoctl);
1792
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);
1797         switch (mode) {
1798         case 0:
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;
1802                 break;
1803         case 1:
1804                 dev->ep [1].fifo_size = dev->ep [2].fifo_size = 2048;
1805                 break;
1806         case 2:
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;
1810                 break;
1811         }
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);
1815 }
1816
1817 /* just declare this in any driver that really need it */
1818 extern int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode);
1819
1820 /**
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).
1826  *
1827  * returns zero on success, else negative errno.  when this succeeds,
1828  * the contents of gadget->ep_list may have changed.
1829  *
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
1834  * be unavailable).
1835  */
1836 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
1837 {
1838         int                     i;
1839         struct net2280          *dev;
1840         int                     status = 0;
1841         unsigned long           flags;
1842
1843         if (!gadget)
1844                 return -ENODEV;
1845         dev = container_of (gadget, struct net2280, gadget);
1846
1847         spin_lock_irqsave (&dev->lock, flags);
1848
1849         for (i = 1; i <= 4; i++)
1850                 if (dev->ep [i].desc) {
1851                         status = -EINVAL;
1852                         break;
1853                 }
1854         if (mode < 0 || mode > 2)
1855                 status = -EINVAL;
1856         if (status == 0)
1857                 set_fifo_mode (dev, mode);
1858         spin_unlock_irqrestore (&dev->lock, flags);
1859
1860         if (status == 0) {
1861                 if (mode == 1)
1862                         DEBUG (dev, "fifo:  ep-a 2K, ep-b 2K\n");
1863                 else if (mode == 2)
1864                         DEBUG (dev, "fifo:  ep-a 2K, ep-b 1K, ep-c 1K\n");
1865                 /* else all are 1K */
1866         }
1867         return status;
1868 }
1869 EXPORT_SYMBOL (net2280_set_fifo_mode);
1870
1871 /*-------------------------------------------------------------------------*/
1872
1873 /* keeping it simple:
1874  * - one bus driver, initted first;
1875  * - one function driver, initted second
1876  *
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.
1880  */
1881
1882 static struct net2280   *the_controller;
1883
1884 static void usb_reset (struct net2280 *dev)
1885 {
1886         u32     tmp;
1887
1888         dev->gadget.speed = USB_SPEED_UNKNOWN;
1889         (void) readl (&dev->usb->usbctl);
1890
1891         net2280_led_init (dev);
1892
1893         /* disable automatic responses, and irqs */
1894         writel (0, &dev->usb->stdrsp);
1895         writel (0, &dev->regs->pciirqenb0);
1896         writel (0, &dev->regs->pciirqenb1);
1897
1898         /* clear old dma and irq state */
1899         for (tmp = 0; tmp < 4; tmp++) {
1900                 struct net2280_ep       *ep = &dev->ep [tmp + 1];
1901
1902                 if (ep->dma)
1903                         abort_dma (ep);
1904         }
1905         writel (~0, &dev->regs->irqstat0),
1906         writel (~(1 << SUSPEND_REQUEST_INTERRUPT), &dev->regs->irqstat1),
1907
1908         /* reset, and enable pci */
1909         tmp = readl (&dev->regs->devinit)
1910                 | (1 << PCI_ENABLE)
1911                 | (1 << FIFO_SOFT_RESET)
1912                 | (1 << USB_SOFT_RESET)
1913                 | (1 << M8051_RESET);
1914         writel (tmp, &dev->regs->devinit);
1915
1916         /* standard fifo and endpoint allocations */
1917         set_fifo_mode (dev, (fifo_mode <= 2) ? fifo_mode : 0);
1918 }
1919
1920 static void usb_reinit (struct net2280 *dev)
1921 {
1922         u32     tmp;
1923         int     init_dma;
1924
1925         /* use_dma changes are ignored till next device re-init */
1926         init_dma = use_dma;
1927
1928         /* basic endpoint init */
1929         for (tmp = 0; tmp < 7; tmp++) {
1930                 struct net2280_ep       *ep = &dev->ep [tmp];
1931
1932                 ep->ep.name = ep_name [tmp];
1933                 ep->dev = dev;
1934                 ep->num = tmp;
1935
1936                 if (tmp > 0 && tmp <= 4) {
1937                         ep->fifo_size = 1024;
1938                         if (init_dma)
1939                                 ep->dma = &dev->dma [tmp - 1];
1940                 } else
1941                         ep->fifo_size = 64;
1942                 ep->regs = &dev->epregs [tmp];
1943                 ep_reset (dev->regs, ep);
1944         }
1945         dev->ep [0].ep.maxpacket = 64;
1946         dev->ep [5].ep.maxpacket = 64;
1947         dev->ep [6].ep.maxpacket = 64;
1948
1949         dev->gadget.ep0 = &dev->ep [0].ep;
1950         dev->ep [0].stopped = 0;
1951         INIT_LIST_HEAD (&dev->gadget.ep0->ep_list);
1952
1953         /* we want to prevent lowlevel/insecure access from the USB host,
1954          * but erratum 0119 means this enable bit is ignored
1955          */
1956         for (tmp = 0; tmp < 5; tmp++)
1957                 writel (EP_DONTUSE, &dev->dep [tmp].dep_cfg);
1958 }
1959
1960 static void ep0_start (struct net2280 *dev)
1961 {
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);
1966
1967         /*
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.
1972          */
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);
1985
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);
1998
1999         /* don't leave any writes posted */
2000         (void) readl (&dev->usb->usbctl);
2001 }
2002
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.
2008  */
2009 int usb_gadget_register_driver (struct usb_gadget_driver *driver)
2010 {
2011         struct net2280          *dev = the_controller;
2012         int                     retval;
2013         unsigned                i;
2014
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"
2018          */
2019         if (!driver
2020                         || driver->speed != USB_SPEED_HIGH
2021                         || !driver->bind
2022                         || !driver->unbind
2023                         || !driver->setup)
2024                 return -EINVAL;
2025         if (!dev)
2026                 return -ENODEV;
2027         if (dev->driver)
2028                 return -EBUSY;
2029
2030         for (i = 0; i < 7; i++)
2031                 dev->ep [i].irqs = 0;
2032
2033         /* hook up the driver ... */
2034         dev->softconnect = 1;
2035         driver->driver.bus = NULL;
2036         dev->driver = driver;
2037         dev->gadget.dev.driver = &driver->driver;
2038         retval = driver->bind (&dev->gadget);
2039         if (retval) {
2040                 DEBUG (dev, "bind to driver %s --> %d\n",
2041                                 driver->driver.name, retval);
2042                 dev->driver = NULL;
2043                 dev->gadget.dev.driver = NULL;
2044                 return retval;
2045         }
2046
2047         device_create_file (&dev->pdev->dev, &dev_attr_function);
2048         device_create_file (&dev->pdev->dev, &dev_attr_queues);
2049
2050         /* ... then enable host detection and ep0; and we're ready
2051          * for set_configuration as well as eventual disconnect.
2052          */
2053         net2280_led_active (dev, 1);
2054         ep0_start (dev);
2055
2056         DEBUG (dev, "%s ready, usbctl %08x stdrsp %08x\n",
2057                         driver->driver.name,
2058                         readl (&dev->usb->usbctl),
2059                         readl (&dev->usb->stdrsp));
2060
2061         /* pci writes may still be posted */
2062         return 0;
2063 }
2064 EXPORT_SYMBOL (usb_gadget_register_driver);
2065
2066 static void
2067 stop_activity (struct net2280 *dev, struct usb_gadget_driver *driver)
2068 {
2069         int                     i;
2070
2071         /* don't disconnect if it's not connected */
2072         if (dev->gadget.speed == USB_SPEED_UNKNOWN)
2073                 driver = NULL;
2074
2075         /* stop hardware; prevent new request submissions;
2076          * and kill any outstanding requests.
2077          */
2078         usb_reset (dev);
2079         for (i = 0; i < 7; i++)
2080                 nuke (&dev->ep [i]);
2081
2082         /* report disconnect; the driver is already quiesced */
2083         if (driver) {
2084                 spin_unlock (&dev->lock);
2085                 driver->disconnect (&dev->gadget);
2086                 spin_lock (&dev->lock);
2087         }
2088
2089         usb_reinit (dev);
2090 }
2091
2092 int usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
2093 {
2094         struct net2280  *dev = the_controller;
2095         unsigned long   flags;
2096
2097         if (!dev)
2098                 return -ENODEV;
2099         if (!driver || driver != dev->driver)
2100                 return -EINVAL;
2101
2102         spin_lock_irqsave (&dev->lock, flags);
2103         stop_activity (dev, driver);
2104         spin_unlock_irqrestore (&dev->lock, flags);
2105
2106         net2280_pullup (&dev->gadget, 0);
2107
2108         driver->unbind (&dev->gadget);
2109         dev->gadget.dev.driver = NULL;
2110         dev->driver = NULL;
2111
2112         net2280_led_active (dev, 0);
2113         device_remove_file (&dev->pdev->dev, &dev_attr_function);
2114         device_remove_file (&dev->pdev->dev, &dev_attr_queues);
2115
2116         DEBUG (dev, "unregistered driver '%s'\n", driver->driver.name);
2117         return 0;
2118 }
2119 EXPORT_SYMBOL (usb_gadget_unregister_driver);
2120
2121
2122 /*-------------------------------------------------------------------------*/
2123
2124 /* handle ep0, ep-e, ep-f with 64 byte packets: packet per irq.
2125  * also works for dma-capable endpoints, in pio mode or just
2126  * to manually advance the queue after short OUT transfers.
2127  */
2128 static void handle_ep_small (struct net2280_ep *ep)
2129 {
2130         struct net2280_request  *req;
2131         u32                     t;
2132         /* 0 error, 1 mid-data, 2 done */
2133         int                     mode = 1;
2134
2135         if (!list_empty (&ep->queue))
2136                 req = list_entry (ep->queue.next,
2137                         struct net2280_request, queue);
2138         else
2139                 req = NULL;
2140
2141         /* ack all, and handle what we care about */
2142         t = readl (&ep->regs->ep_stat);
2143         ep->irqs++;
2144 #if 0
2145         VDEBUG (ep->dev, "%s ack ep_stat %08x, req %p\n",
2146                         ep->ep.name, t, req ? &req->req : 0);
2147 #endif
2148         if (!ep->is_in || ep->dev->pdev->device == 0x2280)
2149                 writel (t & ~(1 << NAK_OUT_PACKETS), &ep->regs->ep_stat);
2150         else
2151                 /* Added for 2282 */
2152                 writel (t, &ep->regs->ep_stat);
2153
2154         /* for ep0, monitor token irqs to catch data stage length errors
2155          * and to synchronize on status.
2156          *
2157          * also, to defer reporting of protocol stalls ... here's where
2158          * data or status first appears, handling stalls here should never
2159          * cause trouble on the host side..
2160          *
2161          * control requests could be slightly faster without token synch for
2162          * status, but status can jam up that way.
2163          */
2164         if (unlikely (ep->num == 0)) {
2165                 if (ep->is_in) {
2166                         /* status; stop NAKing */
2167                         if (t & (1 << DATA_OUT_PING_TOKEN_INTERRUPT)) {
2168                                 if (ep->dev->protocol_stall) {
2169                                         ep->stopped = 1;
2170                                         set_halt (ep);
2171                                 }
2172                                 if (!req)
2173                                         allow_status (ep);
2174                                 mode = 2;
2175                         /* reply to extra IN data tokens with a zlp */
2176                         } else if (t & (1 << DATA_IN_TOKEN_INTERRUPT)) {
2177                                 if (ep->dev->protocol_stall) {
2178                                         ep->stopped = 1;
2179                                         set_halt (ep);
2180                                         mode = 2;
2181                                 } else if (!req && !ep->stopped)
2182                                         write_fifo (ep, NULL);
2183                         }
2184                 } else {
2185                         /* status; stop NAKing */
2186                         if (t & (1 << DATA_IN_TOKEN_INTERRUPT)) {
2187                                 if (ep->dev->protocol_stall) {
2188                                         ep->stopped = 1;
2189                                         set_halt (ep);
2190                                 }
2191                                 mode = 2;
2192                         /* an extra OUT token is an error */
2193                         } else if (((t & (1 << DATA_OUT_PING_TOKEN_INTERRUPT))
2194                                         && req
2195                                         && req->req.actual == req->req.length)
2196                                         || !req) {
2197                                 ep->dev->protocol_stall = 1;
2198                                 set_halt (ep);
2199                                 ep->stopped = 1;
2200                                 if (req)
2201                                         done (ep, req, -EOVERFLOW);
2202                                 req = NULL;
2203                         }
2204                 }
2205         }
2206
2207         if (unlikely (!req))
2208                 return;
2209
2210         /* manual DMA queue advance after short OUT */
2211         if (likely (ep->dma != 0)) {
2212                 if (t & (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT)) {
2213                         u32     count;
2214                         int     stopped = ep->stopped;
2215
2216                         /* TRANSFERRED works around OUT_DONE erratum 0112.
2217                          * we expect (N <= maxpacket) bytes; host wrote M.
2218                          * iff (M < N) we won't ever see a DMA interrupt.
2219                          */
2220                         ep->stopped = 1;
2221                         for (count = 0; ; t = readl (&ep->regs->ep_stat)) {
2222
2223                                 /* any preceding dma transfers must finish.
2224                                  * dma handles (M >= N), may empty the queue
2225                                  */
2226                                 scan_dma_completions (ep);
2227                                 if (unlikely (list_empty (&ep->queue)
2228                                                 || ep->out_overflow)) {
2229                                         req = NULL;
2230                                         break;
2231                                 }
2232                                 req = list_entry (ep->queue.next,
2233                                         struct net2280_request, queue);
2234
2235                                 /* here either (M < N), a "real" short rx;
2236                                  * or (M == N) and the queue didn't empty
2237                                  */
2238                                 if (likely (t & (1 << FIFO_EMPTY))) {
2239                                         count = readl (&ep->dma->dmacount);
2240                                         count &= DMA_BYTE_COUNT_MASK;
2241                                         if (readl (&ep->dma->dmadesc)
2242                                                         != req->td_dma)
2243                                                 req = NULL;
2244                                         break;
2245                                 }
2246                                 udelay(1);
2247                         }
2248
2249                         /* stop DMA, leave ep NAKing */
2250                         writel ((1 << DMA_ABORT), &ep->dma->dmastat);
2251                         spin_stop_dma (ep->dma);
2252
2253                         if (likely (req)) {
2254                                 req->td->dmacount = 0;
2255                                 t = readl (&ep->regs->ep_avail);
2256                                 dma_done (ep, req, count,
2257                                         (ep->out_overflow || t)
2258                                                 ? -EOVERFLOW : 0);
2259                         }
2260
2261                         /* also flush to prevent erratum 0106 trouble */
2262                         if (unlikely (ep->out_overflow
2263                                         || (ep->dev->chiprev == 0x0100
2264                                                 && ep->dev->gadget.speed
2265                                                         == USB_SPEED_FULL))) {
2266                                 out_flush (ep);
2267                                 ep->out_overflow = 0;
2268                         }
2269
2270                         /* (re)start dma if needed, stop NAKing */
2271                         ep->stopped = stopped;
2272                         if (!list_empty (&ep->queue))
2273                                 restart_dma (ep);
2274                 } else
2275                         DEBUG (ep->dev, "%s dma ep_stat %08x ??\n",
2276                                         ep->ep.name, t);
2277                 return;
2278
2279         /* data packet(s) received (in the fifo, OUT) */
2280         } else if (t & (1 << DATA_PACKET_RECEIVED_INTERRUPT)) {
2281                 if (read_fifo (ep, req) && ep->num != 0)
2282                         mode = 2;
2283
2284         /* data packet(s) transmitted (IN) */
2285         } else if (t & (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)) {
2286                 unsigned        len;
2287
2288                 len = req->req.length - req->req.actual;
2289                 if (len > ep->ep.maxpacket)
2290                         len = ep->ep.maxpacket;
2291                 req->req.actual += len;
2292
2293                 /* if we wrote it all, we're usually done */
2294                 if (req->req.actual == req->req.length) {
2295                         if (ep->num == 0) {
2296                                 /* send zlps until the status stage */
2297                         } else if (!req->req.zero || len != ep->ep.maxpacket)
2298                                 mode = 2;
2299                 }
2300
2301         /* there was nothing to do ...  */
2302         } else if (mode == 1)
2303                 return;
2304
2305         /* done */
2306         if (mode == 2) {
2307                 /* stream endpoints often resubmit/unlink in completion */
2308                 done (ep, req, 0);
2309
2310                 /* maybe advance queue to next request */
2311                 if (ep->num == 0) {
2312                         /* NOTE:  net2280 could let gadget driver start the
2313                          * status stage later. since not all controllers let
2314                          * them control that, the api doesn't (yet) allow it.
2315                          */
2316                         if (!ep->stopped)
2317                                 allow_status (ep);
2318                         req = NULL;
2319                 } else {
2320                         if (!list_empty (&ep->queue) && !ep->stopped)
2321                                 req = list_entry (ep->queue.next,
2322                                         struct net2280_request, queue);
2323                         else
2324                                 req = NULL;
2325                         if (req && !ep->is_in)
2326                                 stop_out_naking (ep);
2327                 }
2328         }
2329
2330         /* is there a buffer for the next packet?
2331          * for best streaming performance, make sure there is one.
2332          */
2333         if (req && !ep->stopped) {
2334
2335                 /* load IN fifo with next packet (may be zlp) */
2336                 if (t & (1 << DATA_PACKET_TRANSMITTED_INTERRUPT))
2337                         write_fifo (ep, &req->req);
2338         }
2339 }
2340
2341 static struct net2280_ep *
2342 get_ep_by_addr (struct net2280 *dev, u16 wIndex)
2343 {
2344         struct net2280_ep       *ep;
2345
2346         if ((wIndex & USB_ENDPOINT_NUMBER_MASK) == 0)
2347                 return &dev->ep [0];
2348         list_for_each_entry (ep, &dev->gadget.ep_list, ep.ep_list) {
2349                 u8      bEndpointAddress;
2350
2351                 if (!ep->desc)
2352                         continue;
2353                 bEndpointAddress = ep->desc->bEndpointAddress;
2354                 if ((wIndex ^ bEndpointAddress) & USB_DIR_IN)
2355                         continue;
2356                 if ((wIndex & 0x0f) == (bEndpointAddress & 0x0f))
2357                         return ep;
2358         }
2359         return NULL;
2360 }
2361
2362 static void handle_stat0_irqs (struct net2280 *dev, u32 stat)
2363 {
2364         struct net2280_ep       *ep;
2365         u32                     num, scratch;
2366
2367         /* most of these don't need individual acks */
2368         stat &= ~(1 << INTA_ASSERTED);
2369         if (!stat)
2370                 return;
2371         // DEBUG (dev, "irqstat0 %04x\n", stat);
2372
2373         /* starting a control request? */
2374         if (unlikely (stat & (1 << SETUP_PACKET_INTERRUPT))) {
2375                 union {
2376                         u32                     raw [2];
2377                         struct usb_ctrlrequest  r;
2378                 } u;
2379                 int                             tmp;
2380                 struct net2280_request          *req;
2381
2382                 if (dev->gadget.speed == USB_SPEED_UNKNOWN) {
2383                         if (readl (&dev->usb->usbstat) & (1 << HIGH_SPEED))
2384                                 dev->gadget.speed = USB_SPEED_HIGH;
2385                         else
2386                                 dev->gadget.speed = USB_SPEED_FULL;
2387                         net2280_led_speed (dev, dev->gadget.speed);
2388                         DEBUG (dev, "%s speed\n",
2389                                 (dev->gadget.speed == USB_SPEED_HIGH)
2390                                         ? "high" : "full");
2391                 }
2392
2393                 ep = &dev->ep [0];
2394                 ep->irqs++;
2395
2396                 /* make sure any leftover request state is cleared */
2397                 stat &= ~(1 << ENDPOINT_0_INTERRUPT);
2398                 while (!list_empty (&ep->queue)) {
2399                         req = list_entry (ep->queue.next,
2400                                         struct net2280_request, queue);
2401                         done (ep, req, (req->req.actual == req->req.length)
2402                                                 ? 0 : -EPROTO);
2403                 }
2404                 ep->stopped = 0;
2405                 dev->protocol_stall = 0;
2406
2407                 if (ep->dev->pdev->device == 0x2280)
2408                         tmp = (1 << FIFO_OVERFLOW)
2409                                 | (1 << FIFO_UNDERFLOW);
2410                 else
2411                         tmp = 0;
2412
2413                 writel (tmp | (1 << TIMEOUT)
2414                         | (1 << USB_STALL_SENT)
2415                         | (1 << USB_IN_NAK_SENT)
2416                         | (1 << USB_IN_ACK_RCVD)
2417                         | (1 << USB_OUT_PING_NAK_SENT)
2418                         | (1 << USB_OUT_ACK_SENT)
2419                         | (1 << SHORT_PACKET_OUT_DONE_INTERRUPT)
2420                         | (1 << SHORT_PACKET_TRANSFERRED_INTERRUPT)
2421                         | (1 << DATA_PACKET_RECEIVED_INTERRUPT)
2422                         | (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)
2423                         | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
2424                         | (1 << DATA_IN_TOKEN_INTERRUPT)
2425                         , &ep->regs->ep_stat);
2426                 u.raw [0] = readl (&dev->usb->setup0123);
2427                 u.raw [1] = readl (&dev->usb->setup4567);
2428
2429                 cpu_to_le32s (&u.raw [0]);
2430                 cpu_to_le32s (&u.raw [1]);
2431
2432                 tmp = 0;
2433
2434 #define w_value         le16_to_cpup (&u.r.wValue)
2435 #define w_index         le16_to_cpup (&u.r.wIndex)
2436 #define w_length        le16_to_cpup (&u.r.wLength)
2437
2438                 /* ack the irq */
2439                 writel (1 << SETUP_PACKET_INTERRUPT, &dev->regs->irqstat0);
2440                 stat ^= (1 << SETUP_PACKET_INTERRUPT);
2441
2442                 /* watch control traffic at the token level, and force
2443                  * synchronization before letting the status stage happen.
2444                  * FIXME ignore tokens we'll NAK, until driver responds.
2445                  * that'll mean a lot less irqs for some drivers.
2446                  */
2447                 ep->is_in = (u.r.bRequestType & USB_DIR_IN) != 0;
2448                 if (ep->is_in) {
2449                         scratch = (1 << DATA_PACKET_TRANSMITTED_INTERRUPT)
2450                                 | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
2451                                 | (1 << DATA_IN_TOKEN_INTERRUPT);
2452                         stop_out_naking (ep);
2453                 } else
2454                         scratch = (1 << DATA_PACKET_RECEIVED_INTERRUPT)
2455                                 | (1 << DATA_OUT_PING_TOKEN_INTERRUPT)
2456                                 | (1 << DATA_IN_TOKEN_INTERRUPT);
2457                 writel (scratch, &dev->epregs [0].ep_irqenb);
2458
2459                 /* we made the hardware handle most lowlevel requests;
2460                  * everything else goes uplevel to the gadget code.
2461                  */
2462                 switch (u.r.bRequest) {
2463                 case USB_REQ_GET_STATUS: {
2464                         struct net2280_ep       *e;
2465                         __le32                  status;
2466
2467                         /* hw handles device and interface status */
2468                         if (u.r.bRequestType != (USB_DIR_IN|USB_RECIP_ENDPOINT))
2469                                 goto delegate;
2470                         if ((e = get_ep_by_addr (dev, w_index)) == 0
2471                                         || w_length > 2)
2472                                 goto do_stall;
2473
2474                         if (readl (&e->regs->ep_rsp)
2475                                         & (1 << SET_ENDPOINT_HALT))
2476                                 status = __constant_cpu_to_le32 (1);
2477                         else
2478                                 status = __constant_cpu_to_le32 (0);
2479
2480                         /* don't bother with a request object! */
2481                         writel (0, &dev->epregs [0].ep_irqenb);
2482                         set_fifo_bytecount (ep, w_length);
2483                         writel ((__force u32)status, &dev->epregs [0].ep_data);
2484                         allow_status (ep);
2485                         VDEBUG (dev, "%s stat %02x\n", ep->ep.name, status);
2486                         goto next_endpoints;
2487                         }
2488                         break;
2489                 case USB_REQ_CLEAR_FEATURE: {
2490                         struct net2280_ep       *e;
2491
2492                         /* hw handles device features */
2493                         if (u.r.bRequestType != USB_RECIP_ENDPOINT)
2494                                 goto delegate;
2495                         if (w_value != USB_ENDPOINT_HALT
2496                                         || w_length != 0)
2497                                 goto do_stall;
2498                         if ((e = get_ep_by_addr (dev, w_index)) == 0)
2499                                 goto do_stall;
2500                         clear_halt (e);
2501                         allow_status (ep);
2502                         VDEBUG (dev, "%s clear halt\n", ep->ep.name);
2503                         goto next_endpoints;
2504                         }
2505                         break;
2506                 case USB_REQ_SET_FEATURE: {
2507                         struct net2280_ep       *e;
2508
2509                         /* hw handles device features */
2510                         if (u.r.bRequestType != USB_RECIP_ENDPOINT)
2511                                 goto delegate;
2512                         if (w_value != USB_ENDPOINT_HALT
2513                                         || w_length != 0)
2514                                 goto do_stall;
2515                         if ((e = get_ep_by_addr (dev, w_index)) == 0)
2516                                 goto do_stall;
2517                         set_halt (e);
2518                         allow_status (ep);
2519                         VDEBUG (dev, "%s set halt\n", ep->ep.name);
2520                         goto next_endpoints;
2521                         }
2522                         break;
2523                 default:
2524 delegate:
2525                         VDEBUG (dev, "setup %02x.%02x v%04x i%04x l%04x"
2526                                 "ep_cfg %08x\n",
2527                                 u.r.bRequestType, u.r.bRequest,
2528                                 w_value, w_index, w_length,
2529                                 readl (&ep->regs->ep_cfg));
2530                         spin_unlock (&dev->lock);
2531                         tmp = dev->driver->setup (&dev->gadget, &u.r);
2532                         spin_lock (&dev->lock);
2533                 }
2534
2535                 /* stall ep0 on error */
2536                 if (tmp < 0) {
2537 do_stall:
2538                         VDEBUG (dev, "req %02x.%02x protocol STALL; stat %d\n",
2539                                         u.r.bRequestType, u.r.bRequest, tmp);
2540                         dev->protocol_stall = 1;
2541                 }
2542
2543                 /* some in/out token irq should follow; maybe stall then.
2544                  * driver must queue a request (even zlp) or halt ep0
2545                  * before the host times out.
2546                  */
2547         }
2548
2549 #undef  w_value
2550 #undef  w_index
2551 #undef  w_length
2552
2553 next_endpoints:
2554         /* endpoint data irq ? */
2555         scratch = stat & 0x7f;
2556         stat &= ~0x7f;
2557         for (num = 0; scratch; num++) {
2558                 u32             t;
2559
2560                 /* do this endpoint's FIFO and queue need tending? */
2561                 t = 1 << num;
2562                 if ((scratch & t) == 0)
2563                         continue;
2564                 scratch ^= t;
2565
2566                 ep = &dev->ep [num];
2567                 handle_ep_small (ep);
2568         }
2569
2570         if (stat)
2571                 DEBUG (dev, "unhandled irqstat0 %08x\n", stat);
2572 }
2573
2574 #define DMA_INTERRUPTS ( \
2575                   (1 << DMA_D_INTERRUPT) \
2576                 | (1 << DMA_C_INTERRUPT) \
2577                 | (1 << DMA_B_INTERRUPT) \
2578                 | (1 << DMA_A_INTERRUPT))
2579 #define PCI_ERROR_INTERRUPTS ( \
2580                   (1 << PCI_MASTER_ABORT_RECEIVED_INTERRUPT) \
2581                 | (1 << PCI_TARGET_ABORT_RECEIVED_INTERRUPT) \
2582                 | (1 << PCI_RETRY_ABORT_INTERRUPT))
2583
2584 static void handle_stat1_irqs (struct net2280 *dev, u32 stat)
2585 {
2586         struct net2280_ep       *ep;
2587         u32                     tmp, num, mask, scratch;
2588
2589         /* after disconnect there's nothing else to do! */
2590         tmp = (1 << VBUS_INTERRUPT) | (1 << ROOT_PORT_RESET_INTERRUPT);
2591         mask = (1 << HIGH_SPEED) | (1 << FULL_SPEED);
2592
2593         /* VBUS disconnect is indicated by VBUS_PIN and VBUS_INTERRUPT set.
2594          * Root Port Reset is indicated by ROOT_PORT_RESET_INTERRRUPT set and
2595          * both HIGH_SPEED and FULL_SPEED clear (as ROOT_PORT_RESET_INTERRUPT
2596          * only indicates a change in the reset state).
2597          */
2598         if (stat & tmp) {
2599                 writel (tmp, &dev->regs->irqstat1);
2600                 if ((((stat & (1 << ROOT_PORT_RESET_INTERRUPT))
2601                                         && ((readl (&dev->usb->usbstat) & mask)
2602                                                         == 0))
2603                                 || ((readl (&dev->usb->usbctl)
2604                                         & (1 << VBUS_PIN)) == 0)
2605                             ) && ( dev->gadget.speed != USB_SPEED_UNKNOWN)) {
2606                         DEBUG (dev, "disconnect %s\n",
2607                                         dev->driver->driver.name);
2608                         stop_activity (dev, dev->driver);
2609                         ep0_start (dev);
2610                         return;
2611                 }
2612                 stat &= ~tmp;
2613
2614                 /* vBUS can bounce ... one of many reasons to ignore the
2615                  * notion of hotplug events on bus connect/disconnect!
2616                  */
2617                 if (!stat)
2618                         return;
2619         }
2620
2621         /* NOTE: chip stays in PCI D0 state for now, but it could
2622          * enter D1 to save more power
2623          */
2624         tmp = (1 << SUSPEND_REQUEST_CHANGE_INTERRUPT);
2625         if (stat & tmp) {
2626                 writel (tmp, &dev->regs->irqstat1);
2627                 if (stat & (1 << SUSPEND_REQUEST_INTERRUPT)) {
2628                         if (dev->driver->suspend)
2629                                 dev->driver->suspend (&dev->gadget);
2630                         if (!enable_suspend)
2631                                 stat &= ~(1 << SUSPEND_REQUEST_INTERRUPT);
2632                 } else {
2633                         if (dev->driver->resume)
2634                                 dev->driver->resume (&dev->gadget);
2635                         /* at high speed, note erratum 0133 */
2636                 }
2637                 stat &= ~tmp;
2638         }
2639
2640         /* clear any other status/irqs */
2641         if (stat)
2642                 writel (stat, &dev->regs->irqstat1);
2643
2644         /* some status we can just ignore */
2645         if (dev->pdev->device == 0x2280)
2646                 stat &= ~((1 << CONTROL_STATUS_INTERRUPT)
2647                           | (1 << SUSPEND_REQUEST_INTERRUPT)
2648                           | (1 << RESUME_INTERRUPT)
2649                           | (1 << SOF_INTERRUPT));
2650         else
2651                 stat &= ~((1 << CONTROL_STATUS_INTERRUPT)
2652                           | (1 << RESUME_INTERRUPT)
2653                           | (1 << SOF_DOWN_INTERRUPT)
2654                           | (1 << SOF_INTERRUPT));
2655
2656         if (!stat)
2657                 return;
2658         // DEBUG (dev, "irqstat1 %08x\n", stat);
2659
2660         /* DMA status, for ep-{a,b,c,d} */
2661         scratch = stat & DMA_INTERRUPTS;
2662         stat &= ~DMA_INTERRUPTS;
2663         scratch >>= 9;
2664         for (num = 0; scratch; num++) {
2665                 struct net2280_dma_regs __iomem *dma;
2666
2667                 tmp = 1 << num;
2668                 if ((tmp & scratch) == 0)
2669                         continue;
2670                 scratch ^= tmp;
2671
2672                 ep = &dev->ep [num + 1];
2673                 dma = ep->dma;
2674
2675                 if (!dma)
2676                         continue;
2677
2678                 /* clear ep's dma status */
2679                 tmp = readl (&dma->dmastat);
2680                 writel (tmp, &dma->dmastat);
2681
2682                 /* chaining should stop on abort, short OUT from fifo,
2683                  * or (stat0 codepath) short OUT transfer.
2684                  */
2685                 if (!use_dma_chaining) {
2686                         if ((tmp & (1 << DMA_TRANSACTION_DONE_INTERRUPT))
2687                                         == 0) {
2688                                 DEBUG (ep->dev, "%s no xact done? %08x\n",
2689                                         ep->ep.name, tmp);
2690                                 continue;
2691                         }
2692                         stop_dma (ep->dma);
2693                 }
2694
2695                 /* OUT transfers terminate when the data from the
2696                  * host is in our memory.  Process whatever's done.
2697                  * On this path, we know transfer's last packet wasn't
2698                  * less than req->length. NAK_OUT_PACKETS may be set,
2699                  * or the FIFO may already be holding new packets.
2700                  *
2701                  * IN transfers can linger in the FIFO for a very
2702                  * long time ... we ignore that for now, accounting
2703                  * precisely (like PIO does) needs per-packet irqs
2704                  */
2705                 scan_dma_completions (ep);
2706
2707                 /* disable dma on inactive queues; else maybe restart */
2708                 if (list_empty (&ep->queue)) {
2709                         if (use_dma_chaining)
2710                                 stop_dma (ep->dma);
2711                 } else {
2712                         tmp = readl (&dma->dmactl);
2713                         if (!use_dma_chaining
2714                                         || (tmp & (1 << DMA_ENABLE)) == 0)
2715                                 restart_dma (ep);
2716                         else if (ep->is_in && use_dma_chaining) {
2717                                 struct net2280_request  *req;
2718                                 __le32                  dmacount;
2719
2720                                 /* the descriptor at the head of the chain
2721                                  * may still have VALID_BIT clear; that's
2722                                  * used to trigger changing DMA_FIFO_VALIDATE
2723                                  * (affects automagic zlp writes).
2724                                  */
2725                                 req = list_entry (ep->queue.next,
2726                                                 struct net2280_request, queue);
2727                                 dmacount = req->td->dmacount;
2728                                 dmacount &= __constant_cpu_to_le32 (
2729                                                 (1 << VALID_BIT)
2730                                                 | DMA_BYTE_COUNT_MASK);
2731                                 if (dmacount && (dmacount & valid_bit) == 0)
2732                                         restart_dma (ep);
2733                         }
2734                 }
2735                 ep->irqs++;
2736         }
2737
2738         /* NOTE:  there are other PCI errors we might usefully notice.
2739          * if they appear very often, here's where to try recovering.
2740          */
2741         if (stat & PCI_ERROR_INTERRUPTS) {
2742                 ERROR (dev, "pci dma error; stat %08x\n", stat);
2743                 stat &= ~PCI_ERROR_INTERRUPTS;
2744                 /* these are fatal errors, but "maybe" they won't
2745                  * happen again ...
2746                  */
2747                 stop_activity (dev, dev->driver);
2748                 ep0_start (dev);
2749                 stat = 0;
2750         }
2751
2752         if (stat)
2753                 DEBUG (dev, "unhandled irqstat1 %08x\n", stat);
2754 }
2755
2756 static irqreturn_t net2280_irq (int irq, void *_dev)
2757 {
2758         struct net2280          *dev = _dev;
2759
2760         /* shared interrupt, not ours */
2761         if (!(readl(&dev->regs->irqstat0) & (1 << INTA_ASSERTED)))
2762                 return IRQ_NONE;
2763
2764         spin_lock (&dev->lock);
2765
2766         /* handle disconnect, dma, and more */
2767         handle_stat1_irqs (dev, readl (&dev->regs->irqstat1));
2768
2769         /* control requests and PIO */
2770         handle_stat0_irqs (dev, readl (&dev->regs->irqstat0));
2771
2772         spin_unlock (&dev->lock);
2773
2774         return IRQ_HANDLED;
2775 }
2776
2777 /*-------------------------------------------------------------------------*/
2778
2779 static void gadget_release (struct device *_dev)
2780 {
2781         struct net2280  *dev = dev_get_drvdata (_dev);
2782
2783         kfree (dev);
2784 }
2785
2786 /* tear down the binding between this driver and the pci device */
2787
2788 static void net2280_remove (struct pci_dev *pdev)
2789 {
2790         struct net2280          *dev = pci_get_drvdata (pdev);
2791
2792         /* start with the driver above us */
2793         if (dev->driver) {
2794                 /* should have been done already by driver model core */
2795                 WARN (dev, "pci remove, driver '%s' is still registered\n",
2796                                 dev->driver->driver.name);
2797                 usb_gadget_unregister_driver (dev->driver);
2798         }
2799
2800         /* then clean up the resources we allocated during probe() */
2801         net2280_led_shutdown (dev);
2802         if (dev->requests) {
2803                 int             i;
2804                 for (i = 1; i < 5; i++) {
2805                         if (!dev->ep [i].dummy)
2806                                 continue;
2807                         pci_pool_free (dev->requests, dev->ep [i].dummy,
2808                                         dev->ep [i].td_dma);
2809                 }
2810                 pci_pool_destroy (dev->requests);
2811         }
2812         if (dev->got_irq)
2813                 free_irq (pdev->irq, dev);
2814         if (dev->regs)
2815                 iounmap (dev->regs);
2816         if (dev->region)
2817                 release_mem_region (pci_resource_start (pdev, 0),
2818                                 pci_resource_len (pdev, 0));
2819         if (dev->enabled)
2820                 pci_disable_device (pdev);
2821         device_unregister (&dev->gadget.dev);
2822         device_remove_file (&pdev->dev, &dev_attr_registers);
2823         pci_set_drvdata (pdev, NULL);
2824
2825         INFO (dev, "unbind\n");
2826
2827         the_controller = NULL;
2828 }
2829
2830 /* wrap this driver around the specified device, but
2831  * don't respond over USB until a gadget driver binds to us.
2832  */
2833
2834 static int net2280_probe (struct pci_dev *pdev, const struct pci_device_id *id)
2835 {
2836         struct net2280          *dev;
2837         unsigned long           resource, len;
2838         void                    __iomem *base = NULL;
2839         int                     retval, i;
2840
2841         /* if you want to support more than one controller in a system,
2842          * usb_gadget_driver_{register,unregister}() must change.
2843          */
2844         if (the_controller) {
2845                 dev_warn (&pdev->dev, "ignoring\n");
2846                 return -EBUSY;
2847         }
2848
2849         /* alloc, and start init */
2850         dev = kzalloc (sizeof *dev, SLAB_KERNEL);
2851         if (dev == NULL){
2852                 retval = -ENOMEM;
2853                 goto done;
2854         }
2855
2856         pci_set_drvdata (pdev, dev);
2857         spin_lock_init (&dev->lock);
2858         dev->pdev = pdev;
2859         dev->gadget.ops = &net2280_ops;
2860         dev->gadget.is_dualspeed = 1;
2861
2862         /* the "gadget" abstracts/virtualizes the controller */
2863         strcpy (dev->gadget.dev.bus_id, "gadget");
2864         dev->gadget.dev.parent = &pdev->dev;
2865         dev->gadget.dev.dma_mask = pdev->dev.dma_mask;
2866         dev->gadget.dev.release = gadget_release;
2867         dev->gadget.name = driver_name;
2868
2869         /* now all the pci goodies ... */
2870         if (pci_enable_device (pdev) < 0) {
2871                 retval = -ENODEV;
2872                 goto done;
2873         }
2874         dev->enabled = 1;
2875
2876         /* BAR 0 holds all the registers
2877          * BAR 1 is 8051 memory; unused here (note erratum 0103)
2878          * BAR 2 is fifo memory; unused here
2879          */
2880         resource = pci_resource_start (pdev, 0);
2881         len = pci_resource_len (pdev, 0);
2882         if (!request_mem_region (resource, len, driver_name)) {
2883                 DEBUG (dev, "controller already in use\n");
2884                 retval = -EBUSY;
2885                 goto done;
2886         }
2887         dev->region = 1;
2888
2889         /* FIXME provide firmware download interface to put
2890          * 8051 code into the chip, e.g. to turn on PCI PM.
2891          */
2892
2893         base = ioremap_nocache (resource, len);
2894         if (base == NULL) {
2895                 DEBUG (dev, "can't map memory\n");
2896                 retval = -EFAULT;
2897                 goto done;
2898         }
2899         dev->regs = (struct net2280_regs __iomem *) base;
2900         dev->usb = (struct net2280_usb_regs __iomem *) (base + 0x0080);
2901         dev->pci = (struct net2280_pci_regs __iomem *) (base + 0x0100);
2902         dev->dma = (struct net2280_dma_regs __iomem *) (base + 0x0180);
2903         dev->dep = (struct net2280_dep_regs __iomem *) (base + 0x0200);
2904         dev->epregs = (struct net2280_ep_regs __iomem *) (base + 0x0300);
2905
2906         /* put into initial config, link up all endpoints */
2907         writel (0, &dev->usb->usbctl);
2908         usb_reset (dev);
2909         usb_reinit (dev);
2910
2911         /* irq setup after old hardware is cleaned up */
2912         if (!pdev->irq) {
2913                 ERROR (dev, "No IRQ.  Check PCI setup!\n");
2914                 retval = -ENODEV;
2915                 goto done;
2916         }
2917
2918         if (request_irq (pdev->irq, net2280_irq, IRQF_SHARED, driver_name, dev)
2919                         != 0) {
2920                 ERROR (dev, "request interrupt %d failed\n", pdev->irq);
2921                 retval = -EBUSY;
2922                 goto done;
2923         }
2924         dev->got_irq = 1;
2925
2926         /* DMA setup */
2927         /* NOTE:  we know only the 32 LSBs of dma addresses may be nonzero */
2928         dev->requests = pci_pool_create ("requests", pdev,
2929                 sizeof (struct net2280_dma),
2930                 0 /* no alignment requirements */,
2931                 0 /* or page-crossing issues */);
2932         if (!dev->requests) {
2933                 DEBUG (dev, "can't get request pool\n");
2934                 retval = -ENOMEM;
2935                 goto done;
2936         }
2937         for (i = 1; i < 5; i++) {
2938                 struct net2280_dma      *td;
2939
2940                 td = pci_pool_alloc (dev->requests, GFP_KERNEL,
2941                                 &dev->ep [i].td_dma);
2942                 if (!td) {
2943                         DEBUG (dev, "can't get dummy %d\n", i);
2944                         retval = -ENOMEM;
2945                         goto done;
2946                 }
2947                 td->dmacount = 0;       /* not VALID */
2948                 td->dmaaddr = __constant_cpu_to_le32 (DMA_ADDR_INVALID);
2949                 td->dmadesc = td->dmaaddr;
2950                 dev->ep [i].dummy = td;
2951         }
2952
2953         /* enable lower-overhead pci memory bursts during DMA */
2954         writel ( (1 << DMA_MEMORY_WRITE_AND_INVALIDATE_ENABLE)
2955                         // 256 write retries may not be enough...
2956                         // | (1 << PCI_RETRY_ABORT_ENABLE)
2957                         | (1 << DMA_READ_MULTIPLE_ENABLE)
2958                         | (1 << DMA_READ_LINE_ENABLE)
2959                         , &dev->pci->pcimstctl);
2960         /* erratum 0115 shouldn't appear: Linux inits PCI_LATENCY_TIMER */
2961         pci_set_master (pdev);
2962         pci_set_mwi (pdev);
2963
2964         /* ... also flushes any posted pci writes */
2965         dev->chiprev = get_idx_reg (dev->regs, REG_CHIPREV) & 0xffff;
2966
2967         /* done */
2968         INFO (dev, "%s\n", driver_desc);
2969         INFO (dev, "irq %d, pci mem %p, chip rev %04x\n",
2970                         pdev->irq, base, dev->chiprev);
2971         INFO (dev, "version: " DRIVER_VERSION "; dma %s\n",
2972                         use_dma
2973                                 ? (use_dma_chaining ? "chaining" : "enabled")
2974                                 : "disabled");
2975         the_controller = dev;
2976
2977         device_register (&dev->gadget.dev);
2978         device_create_file (&pdev->dev, &dev_attr_registers);
2979
2980         return 0;
2981
2982 done:
2983         if (dev)
2984                 net2280_remove (pdev);
2985         return retval;
2986 }
2987
2988 /* make sure the board is quiescent; otherwise it will continue
2989  * generating IRQs across the upcoming reboot.
2990  */
2991
2992 static void net2280_shutdown (struct pci_dev *pdev)
2993 {
2994         struct net2280          *dev = pci_get_drvdata (pdev);
2995
2996         /* disable IRQs */
2997         writel (0, &dev->regs->pciirqenb0);
2998         writel (0, &dev->regs->pciirqenb1);
2999
3000         /* disable the pullup so the host will think we're gone */
3001         writel (0, &dev->usb->usbctl);
3002 }
3003
3004
3005 /*-------------------------------------------------------------------------*/
3006
3007 static const struct pci_device_id pci_ids [] = { {
3008         .class =        ((PCI_CLASS_SERIAL_USB << 8) | 0xfe),
3009         .class_mask =   ~0,
3010         .vendor =       0x17cc,
3011         .device =       0x2280,
3012         .subvendor =    PCI_ANY_ID,
3013         .subdevice =    PCI_ANY_ID,
3014 }, {
3015         .class =        ((PCI_CLASS_SERIAL_USB << 8) | 0xfe),
3016         .class_mask =   ~0,
3017         .vendor =       0x17cc,
3018         .device =       0x2282,
3019         .subvendor =    PCI_ANY_ID,
3020         .subdevice =    PCI_ANY_ID,
3021
3022 }, { /* end: all zeroes */ }
3023 };
3024 MODULE_DEVICE_TABLE (pci, pci_ids);
3025
3026 /* pci driver glue; this is a "new style" PCI driver module */
3027 static struct pci_driver net2280_pci_driver = {
3028         .name =         (char *) driver_name,
3029         .id_table =     pci_ids,
3030
3031         .probe =        net2280_probe,
3032         .remove =       net2280_remove,
3033         .shutdown =     net2280_shutdown,
3034
3035         /* FIXME add power management support */
3036 };
3037
3038 MODULE_DESCRIPTION (DRIVER_DESC);
3039 MODULE_AUTHOR ("David Brownell");
3040 MODULE_LICENSE ("GPL");
3041
3042 static int __init init (void)
3043 {
3044         if (!use_dma)
3045                 use_dma_chaining = 0;
3046         return pci_register_driver (&net2280_pci_driver);
3047 }
3048 module_init (init);
3049
3050 static void __exit cleanup (void)
3051 {
3052         pci_unregister_driver (&net2280_pci_driver);
3053 }
3054 module_exit (cleanup);