drivers/usb/gadget/pxa25x_udc.c

   1 /*
   2  * Intel PXA25x and IXP4xx on-chip full speed USB device controllers
   3  *
   4  * Copyright (C) 2002 Intrinsyc, Inc. (Frank Becker)
   5  * Copyright (C) 2003 Robert Schwebel, Pengutronix
   6  * Copyright (C) 2003 Benedikt Spranger, Pengutronix
   7  * Copyright (C) 2003 David Brownell
   8  * Copyright (C) 2003 Joshua Wise
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  *
  24  */
  25
  26 /* #define VERBOSE_DEBUG */
  27
  28 #include <linux/device.h>
  29 #include <linux/module.h>
  30 #include <linux/kernel.h>
  31 #include <linux/ioport.h>
  32 #include <linux/types.h>
  33 #include <linux/errno.h>
  34 #include <linux/delay.h>
  35 #include <linux/slab.h>
  36 #include <linux/init.h>
  37 #include <linux/timer.h>
  38 #include <linux/list.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/mm.h>
  41 #include <linux/platform_device.h>
  42 #include <linux/dma-mapping.h>
  43 #include <linux/irq.h>
  44 #include <linux/clk.h>
  45 #include <linux/err.h>
  46 #include <linux/seq_file.h>
  47 #include <linux/debugfs.h>
  48 #include <linux/io.h>
  49
  50 #include <asm/byteorder.h>
  51 #include <asm/dma.h>
  52 #include <asm/gpio.h>
  53 #include <asm/system.h>
  54 #include <asm/mach-types.h>
  55 #include <asm/unaligned.h>
  56
  57 #include <linux/usb/ch9.h>
  58 #include <linux/usb/gadget.h>
  59 #include <linux/usb/otg.h>
  60
  61 /*
  62  * This driver is PXA25x only.  Grab the right register definitions.
  63  */
  64 #ifdef CONFIG_ARCH_PXA
  65 #include <mach/pxa25x-udc.h>
  66 #endif
  67
  68 #ifdef CONFIG_ARCH_LUBBOCK
  69 #include <mach/lubbock.h>
  70 #endif
  71
  72 #include <asm/mach/udc_pxa2xx.h>
  73
  74
  75 /*
  76  * This driver handles the USB Device Controller (UDC) in Intel's PXA 25x
  77  * series processors.  The UDC for the IXP 4xx series is very similar.
  78  * There are fifteen endpoints, in addition to ep0.
  79  *
  80  * Such controller drivers work with a gadget driver.  The gadget driver
  81  * returns descriptors, implements configuration and data protocols used
  82  * by the host to interact with this device, and allocates endpoints to
  83  * the different protocol interfaces.  The controller driver virtualizes
  84  * usb hardware so that the gadget drivers will be more portable.
  85  *
  86  * This UDC hardware wants to implement a bit too much USB protocol, so
  87  * it constrains the sorts of USB configuration change events that work.
  88  * The errata for these chips are misleading; some "fixed" bugs from
  89  * pxa250 a0/a1 b0/b1/b2 sure act like they're still there.
  90  *
  91  * Note that the UDC hardware supports DMA (except on IXP) but that's
  92  * not used here.  IN-DMA (to host) is simple enough, when the data is
  93  * suitably aligned (16 bytes) ... the network stack doesn't do that,
  94  * other software can.  OUT-DMA is buggy in most chip versions, as well
  95  * as poorly designed (data toggle not automatic).  So this driver won't
  96  * bother using DMA.  (Mostly-working IN-DMA support was available in
  97  * kernels before 2.6.23, but was never enabled or well tested.)
  98  */
  99
 100 #define DRIVER_VERSION  "30-June-2007"
 101 #define DRIVER_DESC     "PXA 25x USB Device Controller driver"
 102
 103
 104 static const char driver_name [] = "pxa25x_udc";
 105
 106 static const char ep0name [] = "ep0";
 107
 108
 109 #ifdef CONFIG_ARCH_IXP4XX
 110
 111 /* cpu-specific register addresses are compiled in to this code */
 112 #ifdef CONFIG_ARCH_PXA
 113 #error "Can't configure both IXP and PXA"
 114 #endif
 115
 116 /* IXP doesn't yet support <linux/clk.h> */
 117 #define clk_get(dev,name)       NULL
 118 #define clk_enable(clk)         do { } while (0)
 119 #define clk_disable(clk)        do { } while (0)
 120 #define clk_put(clk)            do { } while (0)
 121
 122 #endif
 123
 124 #include "pxa25x_udc.h"
 125
 126
 127 #ifdef  CONFIG_USB_PXA25X_SMALL
 128 #define SIZE_STR        " (small)"
 129 #else
 130 #define SIZE_STR        ""
 131 #endif
 132
 133 /* ---------------------------------------------------------------------------
 134  *      endpoint related parts of the api to the usb controller hardware,
 135  *      used by gadget driver; and the inner talker-to-hardware core.
 136  * ---------------------------------------------------------------------------
 137  */
 138
 139 static void pxa25x_ep_fifo_flush (struct usb_ep *ep);
 140 static void nuke (struct pxa25x_ep *, int status);
 141
 142 /* one GPIO should be used to detect VBUS from the host */
 143 static int is_vbus_present(void)
 144 {
 145         struct pxa2xx_udc_mach_info             *mach = the_controller->mach;
 146
 147         if (gpio_is_valid(mach->gpio_vbus)) {
 148                 int value = gpio_get_value(mach->gpio_vbus);
 149
 150                 if (mach->gpio_vbus_inverted)
 151                         return !value;
 152                 else
 153                         return !!value;
 154         }
 155         if (mach->udc_is_connected)
 156                 return mach->udc_is_connected();
 157         return 1;
 158 }
 159
 160 /* one GPIO should control a D+ pullup, so host sees this device (or not) */
 161 static void pullup_off(void)
 162 {
 163         struct pxa2xx_udc_mach_info             *mach = the_controller->mach;
 164         int off_level = mach->gpio_pullup_inverted;
 165
 166         if (gpio_is_valid(mach->gpio_pullup))
 167                 gpio_set_value(mach->gpio_pullup, off_level);
 168         else if (mach->udc_command)
 169                 mach->udc_command(PXA2XX_UDC_CMD_DISCONNECT);
 170 }
 171
 172 static void pullup_on(void)
 173 {
 174         struct pxa2xx_udc_mach_info             *mach = the_controller->mach;
 175         int on_level = !mach->gpio_pullup_inverted;
 176
 177         if (gpio_is_valid(mach->gpio_pullup))
 178                 gpio_set_value(mach->gpio_pullup, on_level);
 179         else if (mach->udc_command)
 180                 mach->udc_command(PXA2XX_UDC_CMD_CONNECT);
 181 }
 182
 183 static void pio_irq_enable(int bEndpointAddress)
 184 {
 185         bEndpointAddress &= 0xf;
 186         if (bEndpointAddress < 8)
 187                 UICR0 &= ~(1 << bEndpointAddress);
 188         else {
 189                 bEndpointAddress -= 8;
 190                 UICR1 &= ~(1 << bEndpointAddress);
 191         }
 192 }
 193
 194 static void pio_irq_disable(int bEndpointAddress)
 195 {
 196         bEndpointAddress &= 0xf;
 197         if (bEndpointAddress < 8)
 198                 UICR0 |= 1 << bEndpointAddress;
 199         else {
 200                 bEndpointAddress -= 8;
 201                 UICR1 |= 1 << bEndpointAddress;
 202         }
 203 }
 204
 205 /* The UDCCR reg contains mask and interrupt status bits,
 206  * so using '|=' isn't safe as it may ack an interrupt.
 207  */
 208 #define UDCCR_MASK_BITS         (UDCCR_REM | UDCCR_SRM | UDCCR_UDE)
 209
 210 static inline void udc_set_mask_UDCCR(int mask)
 211 {
 212         UDCCR = (UDCCR & UDCCR_MASK_BITS) | (mask & UDCCR_MASK_BITS);
 213 }
 214
 215 static inline void udc_clear_mask_UDCCR(int mask)
 216 {
 217         UDCCR = (UDCCR & UDCCR_MASK_BITS) & ~(mask & UDCCR_MASK_BITS);
 218 }
 219
 220 static inline void udc_ack_int_UDCCR(int mask)
 221 {
 222         /* udccr contains the bits we dont want to change */
 223         __u32 udccr = UDCCR & UDCCR_MASK_BITS;
 224
 225         UDCCR = udccr | (mask & ~UDCCR_MASK_BITS);
 226 }
 227
 228 /*
 229  * endpoint enable/disable
 230  *
 231  * we need to verify the descriptors used to enable endpoints.  since pxa25x
 232  * endpoint configurations are fixed, and are pretty much always enabled,
 233  * there's not a lot to manage here.
 234  *
 235  * because pxa25x can't selectively initialize bulk (or interrupt) endpoints,
 236  * (resetting endpoint halt and toggle), SET_INTERFACE is unusable except
 237  * for a single interface (with only the default altsetting) and for gadget
 238  * drivers that don't halt endpoints (not reset by set_interface).  that also
 239  * means that if you use ISO, you must violate the USB spec rule that all
 240  * iso endpoints must be in non-default altsettings.
 241  */
 242 static int pxa25x_ep_enable (struct usb_ep *_ep,
 243                 const struct usb_endpoint_descriptor *desc)
 244 {
 245         struct pxa25x_ep        *ep;
 246         struct pxa25x_udc       *dev;
 247
 248         ep = container_of (_ep, struct pxa25x_ep, ep);
 249         if (!_ep || !desc || ep->desc || _ep->name == ep0name
 250                         || desc->bDescriptorType != USB_DT_ENDPOINT
 251                         || ep->bEndpointAddress != desc->bEndpointAddress
 252                         || ep->fifo_size < le16_to_cpu
 253                                                 (desc->wMaxPacketSize)) {
 254                 DMSG("%s, bad ep or descriptor\n", __func__);
 255                 return -EINVAL;
 256         }
 257
 258         /* xfer types must match, except that interrupt ~= bulk */
 259         if (ep->bmAttributes != desc->bmAttributes
 260                         && ep->bmAttributes != USB_ENDPOINT_XFER_BULK
 261                         && desc->bmAttributes != USB_ENDPOINT_XFER_INT) {
 262                 DMSG("%s, %s type mismatch\n", __func__, _ep->name);
 263                 return -EINVAL;
 264         }
 265
 266         /* hardware _could_ do smaller, but driver doesn't */
 267         if ((desc->bmAttributes == USB_ENDPOINT_XFER_BULK
 268                                 && le16_to_cpu (desc->wMaxPacketSize)
 269                                                 != BULK_FIFO_SIZE)
 270                         || !desc->wMaxPacketSize) {
 271                 DMSG("%s, bad %s maxpacket\n", __func__, _ep->name);
 272                 return -ERANGE;
 273         }
 274
 275         dev = ep->dev;
 276         if (!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN) {
 277                 DMSG("%s, bogus device state\n", __func__);
 278                 return -ESHUTDOWN;
 279         }
 280
 281         ep->desc = desc;
 282         ep->stopped = 0;
 283         ep->pio_irqs = 0;
 284         ep->ep.maxpacket = le16_to_cpu (desc->wMaxPacketSize);
 285
 286         /* flush fifo (mostly for OUT buffers) */
 287         pxa25x_ep_fifo_flush (_ep);
 288
 289         /* ... reset halt state too, if we could ... */
 290
 291         DBG(DBG_VERBOSE, "enabled %s\n", _ep->name);
 292         return 0;
 293 }
 294
 295 static int pxa25x_ep_disable (struct usb_ep *_ep)
 296 {
 297         struct pxa25x_ep        *ep;
 298         unsigned long           flags;
 299
 300         ep = container_of (_ep, struct pxa25x_ep, ep);
 301         if (!_ep || !ep->desc) {
 302                 DMSG("%s, %s not enabled\n", __func__,
 303                         _ep ? ep->ep.name : NULL);
 304                 return -EINVAL;
 305         }
 306         local_irq_save(flags);
 307
 308         nuke (ep, -ESHUTDOWN);
 309
 310         /* flush fifo (mostly for IN buffers) */
 311         pxa25x_ep_fifo_flush (_ep);
 312
 313         ep->desc = NULL;
 314         ep->stopped = 1;
 315
 316         local_irq_restore(flags);
 317         DBG(DBG_VERBOSE, "%s disabled\n", _ep->name);
 318         return 0;
 319 }
 320
 321 /*-------------------------------------------------------------------------*/
 322
 323 /* for the pxa25x, these can just wrap kmalloc/kfree.  gadget drivers
 324  * must still pass correctly initialized endpoints, since other controller
 325  * drivers may care about how it's currently set up (dma issues etc).
 326  */
 327
 328 /*
 329  *      pxa25x_ep_alloc_request - allocate a request data structure
 330  */
 331 static struct usb_request *
 332 pxa25x_ep_alloc_request (struct usb_ep *_ep, gfp_t gfp_flags)
 333 {
 334         struct pxa25x_request *req;
 335
 336         req = kzalloc(sizeof(*req), gfp_flags);
 337         if (!req)
 338                 return NULL;
 339
 340         INIT_LIST_HEAD (&req->queue);
 341         return &req->req;
 342 }
 343
 344
 345 /*
 346  *      pxa25x_ep_free_request - deallocate a request data structure
 347  */
 348 static void
 349 pxa25x_ep_free_request (struct usb_ep *_ep, struct usb_request *_req)
 350 {
 351         struct pxa25x_request   *req;
 352
 353         req = container_of (_req, struct pxa25x_request, req);
 354         WARN_ON(!list_empty (&req->queue));
 355         kfree(req);
 356 }
 357
 358 /*-------------------------------------------------------------------------*/
 359
 360 /*
 361  *      done - retire a request; caller blocked irqs
 362  */
 363 static void done(struct pxa25x_ep *ep, struct pxa25x_request *req, int status)
 364 {
 365         unsigned                stopped = ep->stopped;
 366
 367         list_del_init(&req->queue);
 368
 369         if (likely (req->req.status == -EINPROGRESS))
 370                 req->req.status = status;
 371         else
 372                 status = req->req.status;
 373
 374         if (status && status != -ESHUTDOWN)
 375                 DBG(DBG_VERBOSE, "complete %s req %p stat %d len %u/%u\n",
 376                         ep->ep.name, &req->req, status,
 377                         req->req.actual, req->req.length);
 378
 379         /* don't modify queue heads during completion callback */
 380         ep->stopped = 1;
 381         req->req.complete(&ep->ep, &req->req);
 382         ep->stopped = stopped;
 383 }
 384
 385
 386 static inline void ep0_idle (struct pxa25x_udc *dev)
 387 {
 388         dev->ep0state = EP0_IDLE;
 389 }
 390
 391 static int
 392 write_packet(volatile u32 *uddr, struct pxa25x_request *req, unsigned max)
 393 {
 394         u8              *buf;
 395         unsigned        length, count;
 396
 397         buf = req->req.buf + req->req.actual;
 398         prefetch(buf);
 399
 400         /* how big will this packet be? */
 401         length = min(req->req.length - req->req.actual, max);
 402         req->req.actual += length;
 403
 404         count = length;
 405         while (likely(count--))
 406                 *uddr = *buf++;
 407
 408         return length;
 409 }
 410
 411 /*
 412  * write to an IN endpoint fifo, as many packets as possible.
 413  * irqs will use this to write the rest later.
 414  * caller guarantees at least one packet buffer is ready (or a zlp).
 415  */
 416 static int
 417 write_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
 418 {
 419         unsigned                max;
 420
 421         max = le16_to_cpu(ep->desc->wMaxPacketSize);
 422         do {
 423                 unsigned        count;
 424                 int             is_last, is_short;
 425
 426                 count = write_packet(ep->reg_uddr, req, max);
 427
 428                 /* last packet is usually short (or a zlp) */
 429                 if (unlikely (count != max))
 430                         is_last = is_short = 1;
 431                 else {
 432                         if (likely(req->req.length != req->req.actual)
 433                                         || req->req.zero)
 434                                 is_last = 0;
 435                         else
 436                                 is_last = 1;
 437                         /* interrupt/iso maxpacket may not fill the fifo */
 438                         is_short = unlikely (max < ep->fifo_size);
 439                 }
 440
 441                 DBG(DBG_VERY_NOISY, "wrote %s %d bytes%s%s %d left %p\n",
 442                         ep->ep.name, count,
 443                         is_last ? "/L" : "", is_short ? "/S" : "",
 444                         req->req.length - req->req.actual, req);
 445
 446                 /* let loose that packet. maybe try writing another one,
 447                  * double buffering might work.  TSP, TPC, and TFS
 448                  * bit values are the same for all normal IN endpoints.
 449                  */
 450                 *ep->reg_udccs = UDCCS_BI_TPC;
 451                 if (is_short)
 452                         *ep->reg_udccs = UDCCS_BI_TSP;
 453
 454                 /* requests complete when all IN data is in the FIFO */
 455                 if (is_last) {
 456                         done (ep, req, 0);
 457                         if (list_empty(&ep->queue))
 458                                 pio_irq_disable (ep->bEndpointAddress);
 459                         return 1;
 460                 }
 461
 462                 // TODO experiment: how robust can fifo mode tweaking be?
 463                 // double buffering is off in the default fifo mode, which
 464                 // prevents TFS from being set here.
 465
 466         } while (*ep->reg_udccs & UDCCS_BI_TFS);
 467         return 0;
 468 }
 469
 470 /* caller asserts req->pending (ep0 irq status nyet cleared); starts
 471  * ep0 data stage.  these chips want very simple state transitions.
 472  */
 473 static inline
 474 void ep0start(struct pxa25x_udc *dev, u32 flags, const char *tag)
 475 {
 476         UDCCS0 = flags|UDCCS0_SA|UDCCS0_OPR;
 477         USIR0 = USIR0_IR0;
 478         dev->req_pending = 0;
 479         DBG(DBG_VERY_NOISY, "%s %s, %02x/%02x\n",
 480                 __func__, tag, UDCCS0, flags);
 481 }
 482
 483 static int
 484 write_ep0_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
 485 {
 486         unsigned        count;
 487         int             is_short;
 488
 489         count = write_packet(&UDDR0, req, EP0_FIFO_SIZE);
 490         ep->dev->stats.write.bytes += count;
 491
 492         /* last packet "must be" short (or a zlp) */
 493         is_short = (count != EP0_FIFO_SIZE);
 494
 495         DBG(DBG_VERY_NOISY, "ep0in %d bytes %d left %p\n", count,
 496                 req->req.length - req->req.actual, req);
 497
 498         if (unlikely (is_short)) {
 499                 if (ep->dev->req_pending)
 500                         ep0start(ep->dev, UDCCS0_IPR, "short IN");
 501                 else
 502                         UDCCS0 = UDCCS0_IPR;
 503
 504                 count = req->req.length;
 505                 done (ep, req, 0);
 506                 ep0_idle(ep->dev);
 507 #ifndef CONFIG_ARCH_IXP4XX
 508 #if 1
 509                 /* This seems to get rid of lost status irqs in some cases:
 510                  * host responds quickly, or next request involves config
 511                  * change automagic, or should have been hidden, or ...
 512                  *
 513                  * FIXME get rid of all udelays possible...
 514                  */
 515                 if (count >= EP0_FIFO_SIZE) {
 516                         count = 100;
 517                         do {
 518                                 if ((UDCCS0 & UDCCS0_OPR) != 0) {
 519                                         /* clear OPR, generate ack */
 520                                         UDCCS0 = UDCCS0_OPR;
 521                                         break;
 522                                 }
 523                                 count--;
 524                                 udelay(1);
 525                         } while (count);
 526                 }
 527 #endif
 528 #endif
 529         } else if (ep->dev->req_pending)
 530                 ep0start(ep->dev, 0, "IN");
 531         return is_short;
 532 }
 533
 534
 535 /*
 536  * read_fifo -  unload packet(s) from the fifo we use for usb OUT
 537  * transfers and put them into the request.  caller should have made
 538  * sure there's at least one packet ready.
 539  *
 540  * returns true if the request completed because of short packet or the
 541  * request buffer having filled (and maybe overran till end-of-packet).
 542  */
 543 static int
 544 read_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
 545 {
 546         for (;;) {
 547                 u32             udccs;
 548                 u8              *buf;
 549                 unsigned        bufferspace, count, is_short;
 550
 551                 /* make sure there's a packet in the FIFO.
 552                  * UDCCS_{BO,IO}_RPC are all the same bit value.
 553                  * UDCCS_{BO,IO}_RNE are all the same bit value.
 554                  */
 555                 udccs = *ep->reg_udccs;
 556                 if (unlikely ((udccs & UDCCS_BO_RPC) == 0))
 557                         break;
 558                 buf = req->req.buf + req->req.actual;
 559                 prefetchw(buf);
 560                 bufferspace = req->req.length - req->req.actual;
 561
 562                 /* read all bytes from this packet */
 563                 if (likely (udccs & UDCCS_BO_RNE)) {
 564                         count = 1 + (0x0ff & *ep->reg_ubcr);
 565                         req->req.actual += min (count, bufferspace);
 566                 } else /* zlp */
 567                         count = 0;
 568                 is_short = (count < ep->ep.maxpacket);
 569                 DBG(DBG_VERY_NOISY, "read %s %02x, %d bytes%s req %p %d/%d\n",
 570                         ep->ep.name, udccs, count,
 571                         is_short ? "/S" : "",
 572                         req, req->req.actual, req->req.length);
 573                 while (likely (count-- != 0)) {
 574                         u8      byte = (u8) *ep->reg_uddr;
 575
 576                         if (unlikely (bufferspace == 0)) {
 577                                 /* this happens when the driver's buffer
 578                                  * is smaller than what the host sent.
 579                                  * discard the extra data.
 580                                  */
 581                                 if (req->req.status != -EOVERFLOW)
 582                                         DMSG("%s overflow %d\n",
 583                                                 ep->ep.name, count);
 584                                 req->req.status = -EOVERFLOW;
 585                         } else {
 586                                 *buf++ = byte;
 587                                 bufferspace--;
 588                         }
 589                 }
 590                 *ep->reg_udccs =  UDCCS_BO_RPC;
 591                 /* RPC/RSP/RNE could now reflect the other packet buffer */
 592
 593                 /* iso is one request per packet */
 594                 if (ep->bmAttributes == USB_ENDPOINT_XFER_ISOC) {
 595                         if (udccs & UDCCS_IO_ROF)
 596                                 req->req.status = -EHOSTUNREACH;
 597                         /* more like "is_done" */
 598                         is_short = 1;
 599                 }
 600
 601                 /* completion */
 602                 if (is_short || req->req.actual == req->req.length) {
 603                         done (ep, req, 0);
 604                         if (list_empty(&ep->queue))
 605                                 pio_irq_disable (ep->bEndpointAddress);
 606                         return 1;
 607                 }
 608
 609                 /* finished that packet.  the next one may be waiting... */
 610         }
 611         return 0;
 612 }
 613
 614 /*
 615  * special ep0 version of the above.  no UBCR0 or double buffering; status
 616  * handshaking is magic.  most device protocols don't need control-OUT.
 617  * CDC vendor commands (and RNDIS), mass storage CB/CBI, and some other
 618  * protocols do use them.
 619  */
 620 static int
 621 read_ep0_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
 622 {
 623         u8              *buf, byte;
 624         unsigned        bufferspace;
 625
 626         buf = req->req.buf + req->req.actual;
 627         bufferspace = req->req.length - req->req.actual;
 628
 629         while (UDCCS0 & UDCCS0_RNE) {
 630                 byte = (u8) UDDR0;
 631
 632                 if (unlikely (bufferspace == 0)) {
 633                         /* this happens when the driver's buffer
 634                          * is smaller than what the host sent.
 635                          * discard the extra data.
 636                          */
 637                         if (req->req.status != -EOVERFLOW)
 638                                 DMSG("%s overflow\n", ep->ep.name);
 639                         req->req.status = -EOVERFLOW;
 640                 } else {
 641                         *buf++ = byte;
 642                         req->req.actual++;
 643                         bufferspace--;
 644                 }
 645         }
 646
 647         UDCCS0 = UDCCS0_OPR | UDCCS0_IPR;
 648
 649         /* completion */
 650         if (req->req.actual >= req->req.length)
 651                 return 1;
 652
 653         /* finished that packet.  the next one may be waiting... */
 654         return 0;
 655 }
 656
 657 /*-------------------------------------------------------------------------*/
 658
 659 static int
 660 pxa25x_ep_queue(struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
 661 {
 662         struct pxa25x_request   *req;
 663         struct pxa25x_ep        *ep;
 664         struct pxa25x_udc       *dev;
 665         unsigned long           flags;
 666
 667         req = container_of(_req, struct pxa25x_request, req);
 668         if (unlikely (!_req || !_req->complete || !_req->buf
 669                         || !list_empty(&req->queue))) {
 670                 DMSG("%s, bad params\n", __func__);
 671                 return -EINVAL;
 672         }
 673
 674         ep = container_of(_ep, struct pxa25x_ep, ep);
 675         if (unlikely (!_ep || (!ep->desc && ep->ep.name != ep0name))) {
 676                 DMSG("%s, bad ep\n", __func__);
 677                 return -EINVAL;
 678         }
 679
 680         dev = ep->dev;
 681         if (unlikely (!dev->driver
 682                         || dev->gadget.speed == USB_SPEED_UNKNOWN)) {
 683                 DMSG("%s, bogus device state\n", __func__);
 684                 return -ESHUTDOWN;
 685         }
 686
 687         /* iso is always one packet per request, that's the only way
 688          * we can report per-packet status.  that also helps with dma.
 689          */
 690         if (unlikely (ep->bmAttributes == USB_ENDPOINT_XFER_ISOC
 691                         && req->req.length > le16_to_cpu
 692                                                 (ep->desc->wMaxPacketSize)))
 693                 return -EMSGSIZE;
 694
 695         DBG(DBG_NOISY, "%s queue req %p, len %d buf %p\n",
 696                 _ep->name, _req, _req->length, _req->buf);
 697
 698         local_irq_save(flags);
 699
 700         _req->status = -EINPROGRESS;
 701         _req->actual = 0;
 702
 703         /* kickstart this i/o queue? */
 704         if (list_empty(&ep->queue) && !ep->stopped) {
 705                 if (ep->desc == NULL/* ep0 */) {
 706                         unsigned        length = _req->length;
 707
 708                         switch (dev->ep0state) {
 709                         case EP0_IN_DATA_PHASE:
 710                                 dev->stats.write.ops++;
 711                                 if (write_ep0_fifo(ep, req))
 712                                         req = NULL;
 713                                 break;
 714
 715                         case EP0_OUT_DATA_PHASE:
 716                                 dev->stats.read.ops++;
 717                                 /* messy ... */
 718                                 if (dev->req_config) {
 719                                         DBG(DBG_VERBOSE, "ep0 config ack%s\n",
 720                                                 dev->has_cfr ?  "" : " raced");
 721                                         if (dev->has_cfr)
 722                                                 UDCCFR = UDCCFR_AREN|UDCCFR_ACM
 723                                                         |UDCCFR_MB1;
 724                                         done(ep, req, 0);
 725                                         dev->ep0state = EP0_END_XFER;
 726                                         local_irq_restore (flags);
 727                                         return 0;
 728                                 }
 729                                 if (dev->req_pending)
 730                                         ep0start(dev, UDCCS0_IPR, "OUT");
 731                                 if (length == 0 || ((UDCCS0 & UDCCS0_RNE) != 0
 732                                                 && read_ep0_fifo(ep, req))) {
 733                                         ep0_idle(dev);
 734                                         done(ep, req, 0);
 735                                         req = NULL;
 736                                 }
 737                                 break;
 738
 739                         default:
 740                                 DMSG("ep0 i/o, odd state %d\n", dev->ep0state);
 741                                 local_irq_restore (flags);
 742                                 return -EL2HLT;
 743                         }
 744                 /* can the FIFO can satisfy the request immediately? */
 745                 } else if ((ep->bEndpointAddress & USB_DIR_IN) != 0) {
 746                         if ((*ep->reg_udccs & UDCCS_BI_TFS) != 0
 747                                         && write_fifo(ep, req))
 748                                 req = NULL;
 749                 } else if ((*ep->reg_udccs & UDCCS_BO_RFS) != 0
 750                                 && read_fifo(ep, req)) {
 751                         req = NULL;
 752                 }
 753
 754                 if (likely (req && ep->desc))
 755                         pio_irq_enable(ep->bEndpointAddress);
 756         }
 757
 758         /* pio or dma irq handler advances the queue. */
 759         if (likely(req != NULL))
 760                 list_add_tail(&req->queue, &ep->queue);
 761         local_irq_restore(flags);
 762
 763         return 0;
 764 }
 765
 766
 767 /*
 768  *      nuke - dequeue ALL requests
 769  */
 770 static void nuke(struct pxa25x_ep *ep, int status)
 771 {
 772         struct pxa25x_request *req;
 773
 774         /* called with irqs blocked */
 775         while (!list_empty(&ep->queue)) {
 776                 req = list_entry(ep->queue.next,
 777                                 struct pxa25x_request,
 778                                 queue);
 779                 done(ep, req, status);
 780         }
 781         if (ep->desc)
 782                 pio_irq_disable (ep->bEndpointAddress);
 783 }
 784
 785
 786 /* dequeue JUST ONE request */
 787 static int pxa25x_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
 788 {
 789         struct pxa25x_ep        *ep;
 790         struct pxa25x_request   *req;
 791         unsigned long           flags;
 792
 793         ep = container_of(_ep, struct pxa25x_ep, ep);
 794         if (!_ep || ep->ep.name == ep0name)
 795                 return -EINVAL;
 796
 797         local_irq_save(flags);
 798
 799         /* make sure it's actually queued on this endpoint */
 800         list_for_each_entry (req, &ep->queue, queue) {
 801                 if (&req->req == _req)
 802                         break;
 803         }
 804         if (&req->req != _req) {
 805                 local_irq_restore(flags);
 806                 return -EINVAL;
 807         }
 808
 809         done(ep, req, -ECONNRESET);
 810
 811         local_irq_restore(flags);
 812         return 0;
 813 }
 814
 815 /*-------------------------------------------------------------------------*/
 816
 817 static int pxa25x_ep_set_halt(struct usb_ep *_ep, int value)
 818 {
 819         struct pxa25x_ep        *ep;
 820         unsigned long           flags;
 821
 822         ep = container_of(_ep, struct pxa25x_ep, ep);
 823         if (unlikely (!_ep
 824                         || (!ep->desc && ep->ep.name != ep0name))
 825                         || ep->bmAttributes == USB_ENDPOINT_XFER_ISOC) {
 826                 DMSG("%s, bad ep\n", __func__);
 827                 return -EINVAL;
 828         }
 829         if (value == 0) {
 830                 /* this path (reset toggle+halt) is needed to implement
 831                  * SET_INTERFACE on normal hardware.  but it can't be
 832                  * done from software on the PXA UDC, and the hardware
 833                  * forgets to do it as part of SET_INTERFACE automagic.
 834                  */
 835                 DMSG("only host can clear %s halt\n", _ep->name);
 836                 return -EROFS;
 837         }
 838
 839         local_irq_save(flags);
 840
 841         if ((ep->bEndpointAddress & USB_DIR_IN) != 0
 842                         && ((*ep->reg_udccs & UDCCS_BI_TFS) == 0
 843                            || !list_empty(&ep->queue))) {
 844                 local_irq_restore(flags);
 845                 return -EAGAIN;
 846         }
 847
 848         /* FST bit is the same for control, bulk in, bulk out, interrupt in */
 849         *ep->reg_udccs = UDCCS_BI_FST|UDCCS_BI_FTF;
 850
 851         /* ep0 needs special care */
 852         if (!ep->desc) {
 853                 start_watchdog(ep->dev);
 854                 ep->dev->req_pending = 0;
 855                 ep->dev->ep0state = EP0_STALL;
 856
 857         /* and bulk/intr endpoints like dropping stalls too */
 858         } else {
 859                 unsigned i;
 860                 for (i = 0; i < 1000; i += 20) {
 861                         if (*ep->reg_udccs & UDCCS_BI_SST)
 862                                 break;
 863                         udelay(20);
 864                 }
 865         }
 866         local_irq_restore(flags);
 867
 868         DBG(DBG_VERBOSE, "%s halt\n", _ep->name);
 869         return 0;
 870 }
 871
 872 static int pxa25x_ep_fifo_status(struct usb_ep *_ep)
 873 {
 874         struct pxa25x_ep        *ep;
 875
 876         ep = container_of(_ep, struct pxa25x_ep, ep);
 877         if (!_ep) {
 878                 DMSG("%s, bad ep\n", __func__);
 879                 return -ENODEV;
 880         }
 881         /* pxa can't report unclaimed bytes from IN fifos */
 882         if ((ep->bEndpointAddress & USB_DIR_IN) != 0)
 883                 return -EOPNOTSUPP;
 884         if (ep->dev->gadget.speed == USB_SPEED_UNKNOWN
 885                         || (*ep->reg_udccs & UDCCS_BO_RFS) == 0)
 886                 return 0;
 887         else
 888                 return (*ep->reg_ubcr & 0xfff) + 1;
 889 }
 890
 891 static void pxa25x_ep_fifo_flush(struct usb_ep *_ep)
 892 {
 893         struct pxa25x_ep        *ep;
 894
 895         ep = container_of(_ep, struct pxa25x_ep, ep);
 896         if (!_ep || ep->ep.name == ep0name || !list_empty(&ep->queue)) {
 897                 DMSG("%s, bad ep\n", __func__);
 898                 return;
 899         }
 900
 901         /* toggle and halt bits stay unchanged */
 902
 903         /* for OUT, just read and discard the FIFO contents. */
 904         if ((ep->bEndpointAddress & USB_DIR_IN) == 0) {
 905                 while (((*ep->reg_udccs) & UDCCS_BO_RNE) != 0)
 906                         (void) *ep->reg_uddr;
 907                 return;
 908         }
 909
 910         /* most IN status is the same, but ISO can't stall */
 911         *ep->reg_udccs = UDCCS_BI_TPC|UDCCS_BI_FTF|UDCCS_BI_TUR
 912                 | (ep->bmAttributes == USB_ENDPOINT_XFER_ISOC
 913                         ? 0 : UDCCS_BI_SST);
 914 }
 915
 916
 917 static struct usb_ep_ops pxa25x_ep_ops = {
 918         .enable         = pxa25x_ep_enable,
 919         .disable        = pxa25x_ep_disable,
 920
 921         .alloc_request  = pxa25x_ep_alloc_request,
 922         .free_request   = pxa25x_ep_free_request,
 923
 924         .queue          = pxa25x_ep_queue,
 925         .dequeue        = pxa25x_ep_dequeue,
 926
 927         .set_halt       = pxa25x_ep_set_halt,
 928         .fifo_status    = pxa25x_ep_fifo_status,
 929         .fifo_flush     = pxa25x_ep_fifo_flush,
 930 };
 931
 932
 933 /* ---------------------------------------------------------------------------
 934  *      device-scoped parts of the api to the usb controller hardware
 935  * ---------------------------------------------------------------------------
 936  */
 937
 938 static int pxa25x_udc_get_frame(struct usb_gadget *_gadget)
 939 {
 940         return ((UFNRH & 0x07) << 8) | (UFNRL & 0xff);
 941 }
 942
 943 static int pxa25x_udc_wakeup(struct usb_gadget *_gadget)
 944 {
 945         /* host may not have enabled remote wakeup */
 946         if ((UDCCS0 & UDCCS0_DRWF) == 0)
 947                 return -EHOSTUNREACH;
 948         udc_set_mask_UDCCR(UDCCR_RSM);
 949         return 0;
 950 }
 951
 952 static void stop_activity(struct pxa25x_udc *, struct usb_gadget_driver *);
 953 static void udc_enable (struct pxa25x_udc *);
 954 static void udc_disable(struct pxa25x_udc *);
 955
 956 /* We disable the UDC -- and its 48 MHz clock -- whenever it's not
 957  * in active use.
 958  */
 959 static int pullup(struct pxa25x_udc *udc)
 960 {
 961         int is_active = udc->vbus && udc->pullup && !udc->suspended;
 962         DMSG("%s\n", is_active ? "active" : "inactive");
 963         if (is_active) {
 964                 if (!udc->active) {
 965                         udc->active = 1;
 966                         /* Enable clock for USB device */
 967                         clk_enable(udc->clk);
 968                         udc_enable(udc);
 969                 }
 970         } else {
 971                 if (udc->active) {
 972                         if (udc->gadget.speed != USB_SPEED_UNKNOWN) {
 973                                 DMSG("disconnect %s\n", udc->driver
 974                                         ? udc->driver->driver.name
 975                                         : "(no driver)");
 976                                 stop_activity(udc, udc->driver);
 977                         }
 978                         udc_disable(udc);
 979                         /* Disable clock for USB device */
 980                         clk_disable(udc->clk);
 981                         udc->active = 0;
 982                 }
 983
 984         }
 985         return 0;
 986 }
 987
 988 /* VBUS reporting logically comes from a transceiver */
 989 static int pxa25x_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
 990 {
 991         struct pxa25x_udc       *udc;
 992
 993         udc = container_of(_gadget, struct pxa25x_udc, gadget);
 994         udc->vbus = is_active;
 995         DMSG("vbus %s\n", is_active ? "supplied" : "inactive");
 996         pullup(udc);
 997         return 0;
 998 }
 999
1000 /* drivers may have software control over D+ pullup */
1001 static int pxa25x_udc_pullup(struct usb_gadget *_gadget, int is_active)
1002 {
1003         struct pxa25x_udc       *udc;
1004
1005         udc = container_of(_gadget, struct pxa25x_udc, gadget);
1006
1007         /* not all boards support pullup control */
1008         if (!gpio_is_valid(udc->mach->gpio_pullup) && !udc->mach->udc_command)
1009                 return -EOPNOTSUPP;
1010
1011         udc->pullup = (is_active != 0);
1012         pullup(udc);
1013         return 0;
1014 }
1015
1016 /* boards may consume current from VBUS, up to 100-500mA based on config.
1017  * the 500uA suspend ceiling means that exclusively vbus-powered PXA designs
1018  * violate USB specs.
1019  */
1020 static int pxa25x_udc_vbus_draw(struct usb_gadget *_gadget, unsigned mA)
1021 {
1022         struct pxa25x_udc       *udc;
1023
1024         udc = container_of(_gadget, struct pxa25x_udc, gadget);
1025
1026         if (udc->transceiver)
1027                 return otg_set_power(udc->transceiver, mA);
1028         return -EOPNOTSUPP;
1029 }
1030
1031 static const struct usb_gadget_ops pxa25x_udc_ops = {
1032         .get_frame      = pxa25x_udc_get_frame,
1033         .wakeup         = pxa25x_udc_wakeup,
1034         .vbus_session   = pxa25x_udc_vbus_session,
1035         .pullup         = pxa25x_udc_pullup,
1036         .vbus_draw      = pxa25x_udc_vbus_draw,
1037 };
1038
1039 /*-------------------------------------------------------------------------*/
1040
1041 #ifdef CONFIG_USB_GADGET_DEBUG_FS
1042
1043 static int
1044 udc_seq_show(struct seq_file *m, void *_d)
1045 {
1046         struct pxa25x_udc       *dev = m->private;
1047         unsigned long           flags;
1048         int                     i;
1049         u32                     tmp;
1050
1051         local_irq_save(flags);
1052
1053         /* basic device status */
1054         seq_printf(m, DRIVER_DESC "\n"
1055                 "%s version: %s\nGadget driver: %s\nHost %s\n\n",
1056                 driver_name, DRIVER_VERSION SIZE_STR "(pio)",
1057                 dev->driver ? dev->driver->driver.name : "(none)",
1058                 is_vbus_present() ? "full speed" : "disconnected");
1059
1060         /* registers for device and ep0 */
1061         seq_printf(m,
1062                 "uicr %02X.%02X, usir %02X.%02x, ufnr %02X.%02X\n",
1063                 UICR1, UICR0, USIR1, USIR0, UFNRH, UFNRL);
1064
1065         tmp = UDCCR;
1066         seq_printf(m,
1067                 "udccr %02X =%s%s%s%s%s%s%s%s\n", tmp,
1068                 (tmp & UDCCR_REM) ? " rem" : "",
1069                 (tmp & UDCCR_RSTIR) ? " rstir" : "",
1070                 (tmp & UDCCR_SRM) ? " srm" : "",
1071                 (tmp & UDCCR_SUSIR) ? " susir" : "",
1072                 (tmp & UDCCR_RESIR) ? " resir" : "",
1073                 (tmp & UDCCR_RSM) ? " rsm" : "",
1074                 (tmp & UDCCR_UDA) ? " uda" : "",
1075                 (tmp & UDCCR_UDE) ? " ude" : "");
1076
1077         tmp = UDCCS0;
1078         seq_printf(m,
1079                 "udccs0 %02X =%s%s%s%s%s%s%s%s\n", tmp,
1080                 (tmp & UDCCS0_SA) ? " sa" : "",
1081                 (tmp & UDCCS0_RNE) ? " rne" : "",
1082                 (tmp & UDCCS0_FST) ? " fst" : "",
1083                 (tmp & UDCCS0_SST) ? " sst" : "",
1084                 (tmp & UDCCS0_DRWF) ? " dwrf" : "",
1085                 (tmp & UDCCS0_FTF) ? " ftf" : "",
1086                 (tmp & UDCCS0_IPR) ? " ipr" : "",
1087                 (tmp & UDCCS0_OPR) ? " opr" : "");
1088
1089         if (dev->has_cfr) {
1090                 tmp = UDCCFR;
1091                 seq_printf(m,
1092                         "udccfr %02X =%s%s\n", tmp,
1093                         (tmp & UDCCFR_AREN) ? " aren" : "",
1094                         (tmp & UDCCFR_ACM) ? " acm" : "");
1095         }
1096
1097         if (!is_vbus_present() || !dev->driver)
1098                 goto done;
1099
1100         seq_printf(m, "ep0 IN %lu/%lu, OUT %lu/%lu\nirqs %lu\n\n",
1101                 dev->stats.write.bytes, dev->stats.write.ops,
1102                 dev->stats.read.bytes, dev->stats.read.ops,
1103                 dev->stats.irqs);
1104
1105         /* dump endpoint queues */
1106         for (i = 0; i < PXA_UDC_NUM_ENDPOINTS; i++) {
1107                 struct pxa25x_ep        *ep = &dev->ep [i];
1108                 struct pxa25x_request   *req;
1109
1110                 if (i != 0) {
1111                         const struct usb_endpoint_descriptor    *desc;
1112
1113                         desc = ep->desc;
1114                         if (!desc)
1115                                 continue;
1116                         tmp = *dev->ep [i].reg_udccs;
1117                         seq_printf(m,
1118                                 "%s max %d %s udccs %02x irqs %lu\n",
1119                                 ep->ep.name, le16_to_cpu(desc->wMaxPacketSize),
1120                                 "pio", tmp, ep->pio_irqs);
1121                         /* TODO translate all five groups of udccs bits! */
1122
1123                 } else /* ep0 should only have one transfer queued */
1124                         seq_printf(m, "ep0 max 16 pio irqs %lu\n",
1125                                 ep->pio_irqs);
1126
1127                 if (list_empty(&ep->queue)) {
1128                         seq_printf(m, "\t(nothing queued)\n");
1129                         continue;
1130                 }
1131                 list_for_each_entry(req, &ep->queue, queue) {
1132                         seq_printf(m,
1133                                         "\treq %p len %d/%d buf %p\n",
1134                                         &req->req, req->req.actual,
1135                                         req->req.length, req->req.buf);
1136                 }
1137         }
1138
1139 done:
1140         local_irq_restore(flags);
1141         return 0;
1142 }
1143
1144 static int
1145 udc_debugfs_open(struct inode *inode, struct file *file)
1146 {
1147         return single_open(file, udc_seq_show, inode->i_private);
1148 }
1149
1150 static const struct file_operations debug_fops = {
1151         .open           = udc_debugfs_open,
1152         .read           = seq_read,
1153         .llseek         = seq_lseek,
1154         .release        = single_release,
1155         .owner          = THIS_MODULE,
1156 };
1157
1158 #define create_debug_files(dev) \
1159         do { \
1160                 dev->debugfs_udc = debugfs_create_file(dev->gadget.name, \
1161                         S_IRUGO, NULL, dev, &debug_fops); \
1162         } while (0)
1163 #define remove_debug_files(dev) \
1164         do { \
1165                 if (dev->debugfs_udc) \
1166                         debugfs_remove(dev->debugfs_udc); \
1167         } while (0)
1168
1169 #else   /* !CONFIG_USB_GADGET_DEBUG_FILES */
1170
1171 #define create_debug_files(dev) do {} while (0)
1172 #define remove_debug_files(dev) do {} while (0)
1173
1174 #endif  /* CONFIG_USB_GADGET_DEBUG_FILES */
1175
1176 /*-------------------------------------------------------------------------*/
1177
1178 /*
1179  *      udc_disable - disable USB device controller
1180  */
1181 static void udc_disable(struct pxa25x_udc *dev)
1182 {
1183         /* block all irqs */
1184         udc_set_mask_UDCCR(UDCCR_SRM|UDCCR_REM);
1185         UICR0 = UICR1 = 0xff;
1186         UFNRH = UFNRH_SIM;
1187
1188         /* if hardware supports it, disconnect from usb */
1189         pullup_off();
1190
1191         udc_clear_mask_UDCCR(UDCCR_UDE);
1192
1193         ep0_idle (dev);
1194         dev->gadget.speed = USB_SPEED_UNKNOWN;
1195 }
1196
1197
1198 /*
1199  *      udc_reinit - initialize software state
1200  */
1201 static void udc_reinit(struct pxa25x_udc *dev)
1202 {
1203         u32     i;
1204
1205         /* device/ep0 records init */
1206         INIT_LIST_HEAD (&dev->gadget.ep_list);
1207         INIT_LIST_HEAD (&dev->gadget.ep0->ep_list);
1208         dev->ep0state = EP0_IDLE;
1209
1210         /* basic endpoint records init */
1211         for (i = 0; i < PXA_UDC_NUM_ENDPOINTS; i++) {
1212                 struct pxa25x_ep *ep = &dev->ep[i];
1213
1214                 if (i != 0)
1215                         list_add_tail (&ep->ep.ep_list, &dev->gadget.ep_list);
1216
1217                 ep->desc = NULL;
1218                 ep->stopped = 0;
1219                 INIT_LIST_HEAD (&ep->queue);
1220                 ep->pio_irqs = 0;
1221         }
1222
1223         /* the rest was statically initialized, and is read-only */
1224 }
1225
1226 /* until it's enabled, this UDC should be completely invisible
1227  * to any USB host.
1228  */
1229 static void udc_enable (struct pxa25x_udc *dev)
1230 {
1231         udc_clear_mask_UDCCR(UDCCR_UDE);
1232
1233         /* try to clear these bits before we enable the udc */
1234         udc_ack_int_UDCCR(UDCCR_SUSIR|/*UDCCR_RSTIR|*/UDCCR_RESIR);
1235
1236         ep0_idle(dev);
1237         dev->gadget.speed = USB_SPEED_UNKNOWN;
1238         dev->stats.irqs = 0;
1239
1240         /*
1241          * sequence taken from chapter 12.5.10, PXA250 AppProcDevManual:
1242          * - enable UDC
1243          * - if RESET is already in progress, ack interrupt
1244          * - unmask reset interrupt
1245          */
1246         udc_set_mask_UDCCR(UDCCR_UDE);
1247         if (!(UDCCR & UDCCR_UDA))
1248                 udc_ack_int_UDCCR(UDCCR_RSTIR);
1249
1250         if (dev->has_cfr /* UDC_RES2 is defined */) {
1251                 /* pxa255 (a0+) can avoid a set_config race that could
1252                  * prevent gadget drivers from configuring correctly
1253                  */
1254                 UDCCFR = UDCCFR_ACM | UDCCFR_MB1;
1255         } else {
1256                 /* "USB test mode" for pxa250 errata 40-42 (stepping a0, a1)
1257                  * which could result in missing packets and interrupts.
1258                  * supposedly one bit per endpoint, controlling whether it
1259                  * double buffers or not; ACM/AREN bits fit into the holes.
1260                  * zero bits (like USIR0_IRx) disable double buffering.
1261                  */
1262                 UDC_RES1 = 0x00;
1263                 UDC_RES2 = 0x00;
1264         }
1265
1266         /* enable suspend/resume and reset irqs */
1267         udc_clear_mask_UDCCR(UDCCR_SRM | UDCCR_REM);
1268
1269         /* enable ep0 irqs */
1270         UICR0 &= ~UICR0_IM0;
1271
1272         /* if hardware supports it, pullup D+ and wait for reset */
1273         pullup_on();
1274 }
1275
1276
1277 /* when a driver is successfully registered, it will receive
1278  * control requests including set_configuration(), which enables
1279  * non-control requests.  then usb traffic follows until a
1280  * disconnect is reported.  then a host may connect again, or
1281  * the driver might get unbound.
1282  */
1283 int usb_gadget_probe_driver(struct usb_gadget_driver *driver,
1284                 int (*bind)(struct usb_gadget *))
1285 {
1286         struct pxa25x_udc       *dev = the_controller;
1287         int                     retval;
1288
1289         if (!driver
1290                         || driver->speed < USB_SPEED_FULL
1291                         || !bind
1292                         || !driver->disconnect
1293                         || !driver->setup)
1294                 return -EINVAL;
1295         if (!dev)
1296                 return -ENODEV;
1297         if (dev->driver)
1298                 return -EBUSY;
1299
1300         /* first hook up the driver ... */
1301         dev->driver = driver;
1302         dev->gadget.dev.driver = &driver->driver;
1303         dev->pullup = 1;
1304
1305         retval = device_add (&dev->gadget.dev);
1306         if (retval) {
1307 fail:
1308                 dev->driver = NULL;
1309                 dev->gadget.dev.driver = NULL;
1310                 return retval;
1311         }
1312         retval = bind(&dev->gadget);
1313         if (retval) {
1314                 DMSG("bind to driver %s --> error %d\n",
1315                                 driver->driver.name, retval);
1316                 device_del (&dev->gadget.dev);
1317                 goto fail;
1318         }
1319
1320         /* ... then enable host detection and ep0; and we're ready
1321          * for set_configuration as well as eventual disconnect.
1322          */
1323         DMSG("registered gadget driver '%s'\n", driver->driver.name);
1324
1325         /* connect to bus through transceiver */
1326         if (dev->transceiver) {
1327                 retval = otg_set_peripheral(dev->transceiver, &dev->gadget);
1328                 if (retval) {
1329                         DMSG("can't bind to transceiver\n");
1330                         if (driver->unbind)
1331                                 driver->unbind(&dev->gadget);
1332                         goto bind_fail;
1333                 }
1334         }
1335
1336         pullup(dev);
1337         dump_state(dev);
1338         return 0;
1339 bind_fail:
1340         return retval;
1341 }
1342 EXPORT_SYMBOL(usb_gadget_probe_driver);
1343
1344 static void
1345 stop_activity(struct pxa25x_udc *dev, struct usb_gadget_driver *driver)
1346 {
1347         int i;
1348
1349         /* don't disconnect drivers more than once */
1350         if (dev->gadget.speed == USB_SPEED_UNKNOWN)
1351                 driver = NULL;
1352         dev->gadget.speed = USB_SPEED_UNKNOWN;
1353
1354         /* prevent new request submissions, kill any outstanding requests  */
1355         for (i = 0; i < PXA_UDC_NUM_ENDPOINTS; i++) {
1356                 struct pxa25x_ep *ep = &dev->ep[i];
1357
1358                 ep->stopped = 1;
1359                 nuke(ep, -ESHUTDOWN);
1360         }
1361         del_timer_sync(&dev->timer);
1362
1363         /* report disconnect; the driver is already quiesced */
1364         if (driver)
1365                 driver->disconnect(&dev->gadget);
1366
1367         /* re-init driver-visible data structures */
1368         udc_reinit(dev);
1369 }
1370
1371 int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
1372 {
1373         struct pxa25x_udc       *dev = the_controller;
1374
1375         if (!dev)
1376                 return -ENODEV;
1377         if (!driver || driver != dev->driver || !driver->unbind)
1378                 return -EINVAL;
1379
1380         local_irq_disable();
1381         dev->pullup = 0;
1382         pullup(dev);
1383         stop_activity(dev, driver);
1384         local_irq_enable();
1385
1386         if (dev->transceiver)
1387                 (void) otg_set_peripheral(dev->transceiver, NULL);
1388
1389         driver->unbind(&dev->gadget);
1390         dev->gadget.dev.driver = NULL;
1391         dev->driver = NULL;
1392
1393         device_del (&dev->gadget.dev);
1394
1395         DMSG("unregistered gadget driver '%s'\n", driver->driver.name);
1396         dump_state(dev);
1397         return 0;
1398 }
1399 EXPORT_SYMBOL(usb_gadget_unregister_driver);
1400
1401
1402 /*-------------------------------------------------------------------------*/
1403
1404 #ifdef CONFIG_ARCH_LUBBOCK
1405
1406 /* Lubbock has separate connect and disconnect irqs.  More typical designs
1407  * use one GPIO as the VBUS IRQ, and another to control the D+ pullup.
1408  */
1409
1410 static irqreturn_t
1411 lubbock_vbus_irq(int irq, void *_dev)
1412 {
1413         struct pxa25x_udc       *dev = _dev;
1414         int                     vbus;
1415
1416         dev->stats.irqs++;
1417         switch (irq) {
1418         case LUBBOCK_USB_IRQ:
1419                 vbus = 1;
1420                 disable_irq(LUBBOCK_USB_IRQ);
1421                 enable_irq(LUBBOCK_USB_DISC_IRQ);
1422                 break;
1423         case LUBBOCK_USB_DISC_IRQ:
1424                 vbus = 0;
1425                 disable_irq(LUBBOCK_USB_DISC_IRQ);
1426                 enable_irq(LUBBOCK_USB_IRQ);
1427                 break;
1428         default:
1429                 return IRQ_NONE;
1430         }
1431
1432         pxa25x_udc_vbus_session(&dev->gadget, vbus);
1433         return IRQ_HANDLED;
1434 }
1435
1436 #endif
1437
1438 static irqreturn_t udc_vbus_irq(int irq, void *_dev)
1439 {
1440         struct pxa25x_udc       *dev = _dev;
1441
1442         pxa25x_udc_vbus_session(&dev->gadget, is_vbus_present());
1443         return IRQ_HANDLED;
1444 }
1445
1446
1447 /*-------------------------------------------------------------------------*/
1448
1449 static inline void clear_ep_state (struct pxa25x_udc *dev)
1450 {
1451         unsigned i;
1452
1453         /* hardware SET_{CONFIGURATION,INTERFACE} automagic resets endpoint
1454          * fifos, and pending transactions mustn't be continued in any case.
1455          */
1456         for (i = 1; i < PXA_UDC_NUM_ENDPOINTS; i++)
1457                 nuke(&dev->ep[i], -ECONNABORTED);
1458 }
1459
1460 static void udc_watchdog(unsigned long _dev)
1461 {
1462         struct pxa25x_udc       *dev = (void *)_dev;
1463
1464         local_irq_disable();
1465         if (dev->ep0state == EP0_STALL
1466                         && (UDCCS0 & UDCCS0_FST) == 0
1467                         && (UDCCS0 & UDCCS0_SST) == 0) {
1468                 UDCCS0 = UDCCS0_FST|UDCCS0_FTF;
1469                 DBG(DBG_VERBOSE, "ep0 re-stall\n");
1470                 start_watchdog(dev);
1471         }
1472         local_irq_enable();
1473 }
1474
1475 static void handle_ep0 (struct pxa25x_udc *dev)
1476 {
1477         u32                     udccs0 = UDCCS0;
1478         struct pxa25x_ep        *ep = &dev->ep [0];
1479         struct pxa25x_request   *req;
1480         union {
1481                 struct usb_ctrlrequest  r;
1482                 u8                      raw [8];
1483                 u32                     word [2];
1484         } u;
1485
1486         if (list_empty(&ep->queue))
1487                 req = NULL;
1488         else
1489                 req = list_entry(ep->queue.next, struct pxa25x_request, queue);
1490
1491         /* clear stall status */
1492         if (udccs0 & UDCCS0_SST) {
1493                 nuke(ep, -EPIPE);
1494                 UDCCS0 = UDCCS0_SST;
1495                 del_timer(&dev->timer);
1496                 ep0_idle(dev);
1497         }
1498
1499         /* previous request unfinished?  non-error iff back-to-back ... */
1500         if ((udccs0 & UDCCS0_SA) != 0 && dev->ep0state != EP0_IDLE) {
1501                 nuke(ep, 0);
1502                 del_timer(&dev->timer);
1503                 ep0_idle(dev);
1504         }
1505
1506         switch (dev->ep0state) {
1507         case EP0_IDLE:
1508                 /* late-breaking status? */
1509                 udccs0 = UDCCS0;
1510
1511                 /* start control request? */
1512                 if (likely((udccs0 & (UDCCS0_OPR|UDCCS0_SA|UDCCS0_RNE))
1513                                 == (UDCCS0_OPR|UDCCS0_SA|UDCCS0_RNE))) {
1514                         int i;
1515
1516                         nuke (ep, -EPROTO);
1517
1518                         /* read SETUP packet */
1519                         for (i = 0; i < 8; i++) {
1520                                 if (unlikely(!(UDCCS0 & UDCCS0_RNE))) {
1521 bad_setup:
1522                                         DMSG("SETUP %d!\n", i);
1523                                         goto stall;
1524                                 }
1525                                 u.raw [i] = (u8) UDDR0;
1526                         }
1527                         if (unlikely((UDCCS0 & UDCCS0_RNE) != 0))
1528                                 goto bad_setup;
1529
1530 got_setup:
1531                         DBG(DBG_VERBOSE, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1532                                 u.r.bRequestType, u.r.bRequest,
1533                                 le16_to_cpu(u.r.wValue),
1534                                 le16_to_cpu(u.r.wIndex),
1535                                 le16_to_cpu(u.r.wLength));
1536
1537                         /* cope with automagic for some standard requests. */
1538                         dev->req_std = (u.r.bRequestType & USB_TYPE_MASK)
1539                                                 == USB_TYPE_STANDARD;
1540                         dev->req_config = 0;
1541                         dev->req_pending = 1;
1542                         switch (u.r.bRequest) {
1543                         /* hardware restricts gadget drivers here! */
1544                         case USB_REQ_SET_CONFIGURATION:
1545                                 if (u.r.bRequestType == USB_RECIP_DEVICE) {
1546                                         /* reflect hardware's automagic
1547                                          * up to the gadget driver.
1548                                          */
1549 config_change:
1550                                         dev->req_config = 1;
1551                                         clear_ep_state(dev);
1552                                         /* if !has_cfr, there's no synch
1553                                          * else use AREN (later) not SA|OPR
1554                                          * USIR0_IR0 acts edge sensitive
1555                                          */
1556                                 }
1557                                 break;
1558                         /* ... and here, even more ... */
1559                         case USB_REQ_SET_INTERFACE:
1560                                 if (u.r.bRequestType == USB_RECIP_INTERFACE) {
1561                                         /* udc hardware is broken by design:
1562                                          *  - altsetting may only be zero;
1563                                          *  - hw resets all interfaces' eps;
1564                                          *  - ep reset doesn't include halt(?).
1565                                          */
1566                                         DMSG("broken set_interface (%d/%d)\n",
1567                                                 le16_to_cpu(u.r.wIndex),
1568                                                 le16_to_cpu(u.r.wValue));
1569                                         goto config_change;
1570                                 }
1571                                 break;
1572                         /* hardware was supposed to hide this */
1573                         case USB_REQ_SET_ADDRESS:
1574                                 if (u.r.bRequestType == USB_RECIP_DEVICE) {
1575                                         ep0start(dev, 0, "address");
1576                                         return;
1577                                 }
1578                                 break;
1579                         }
1580
1581                         if (u.r.bRequestType & USB_DIR_IN)
1582                                 dev->ep0state = EP0_IN_DATA_PHASE;
1583                         else
1584                                 dev->ep0state = EP0_OUT_DATA_PHASE;
1585
1586                         i = dev->driver->setup(&dev->gadget, &u.r);
1587                         if (i < 0) {
1588                                 /* hardware automagic preventing STALL... */
1589                                 if (dev->req_config) {
1590                                         /* hardware sometimes neglects to tell
1591                                          * tell us about config change events,
1592                                          * so later ones may fail...
1593                                          */
1594                                         WARNING("config change %02x fail %d?\n",
1595                                                 u.r.bRequest, i);
1596                                         return;
1597                                         /* TODO experiment:  if has_cfr,
1598                                          * hardware didn't ACK; maybe we
1599                                          * could actually STALL!
1600                                          */
1601                                 }
1602                                 DBG(DBG_VERBOSE, "protocol STALL, "
1603                                         "%02x err %d\n", UDCCS0, i);
1604 stall:
1605                                 /* the watchdog timer helps deal with cases
1606                                  * where udc seems to clear FST wrongly, and
1607                                  * then NAKs instead of STALLing.
1608                                  */
1609                                 ep0start(dev, UDCCS0_FST|UDCCS0_FTF, "stall");
1610                                 start_watchdog(dev);
1611                                 dev->ep0state = EP0_STALL;
1612
1613                         /* deferred i/o == no response yet */
1614                         } else if (dev->req_pending) {
1615                                 if (likely(dev->ep0state == EP0_IN_DATA_PHASE
1616                                                 || dev->req_std || u.r.wLength))
1617                                         ep0start(dev, 0, "defer");
1618                                 else
1619                                         ep0start(dev, UDCCS0_IPR, "defer/IPR");
1620                         }
1621
1622                         /* expect at least one data or status stage irq */
1623                         return;
1624
1625                 } else if (likely((udccs0 & (UDCCS0_OPR|UDCCS0_SA))
1626                                 == (UDCCS0_OPR|UDCCS0_SA))) {
1627                         unsigned i;
1628
1629                         /* pxa210/250 erratum 131 for B0/B1 says RNE lies.
1630                          * still observed on a pxa255 a0.
1631                          */
1632                         DBG(DBG_VERBOSE, "e131\n");
1633                         nuke(ep, -EPROTO);
1634
1635                         /* read SETUP data, but don't trust it too much */
1636                         for (i = 0; i < 8; i++)
1637                                 u.raw [i] = (u8) UDDR0;
1638                         if ((u.r.bRequestType & USB_RECIP_MASK)
1639                                         > USB_RECIP_OTHER)
1640                                 goto stall;
1641                         if (u.word [0] == 0 && u.word [1] == 0)
1642                                 goto stall;
1643                         goto got_setup;
1644                 } else {
1645                         /* some random early IRQ:
1646                          * - we acked FST
1647                          * - IPR cleared
1648                          * - OPR got set, without SA (likely status stage)
1649                          */
1650                         UDCCS0 = udccs0 & (UDCCS0_SA|UDCCS0_OPR);
1651                 }
1652                 break;
1653         case EP0_IN_DATA_PHASE:                 /* GET_DESCRIPTOR etc */
1654                 if (udccs0 & UDCCS0_OPR) {
1655                         UDCCS0 = UDCCS0_OPR|UDCCS0_FTF;
1656                         DBG(DBG_VERBOSE, "ep0in premature status\n");
1657                         if (req)
1658                                 done(ep, req, 0);
1659                         ep0_idle(dev);
1660                 } else /* irq was IPR clearing */ {
1661                         if (req) {
1662                                 /* this IN packet might finish the request */
1663                                 (void) write_ep0_fifo(ep, req);
1664                         } /* else IN token before response was written */
1665                 }
1666                 break;
1667         case EP0_OUT_DATA_PHASE:                /* SET_DESCRIPTOR etc */
1668                 if (udccs0 & UDCCS0_OPR) {
1669                         if (req) {
1670                                 /* this OUT packet might finish the request */
1671                                 if (read_ep0_fifo(ep, req))
1672                                         done(ep, req, 0);
1673                                 /* else more OUT packets expected */
1674                         } /* else OUT token before read was issued */
1675                 } else /* irq was IPR clearing */ {
1676                         DBG(DBG_VERBOSE, "ep0out premature status\n");
1677                         if (req)
1678                                 done(ep, req, 0);
1679                         ep0_idle(dev);
1680                 }
1681                 break;
1682         case EP0_END_XFER:
1683                 if (req)
1684                         done(ep, req, 0);
1685                 /* ack control-IN status (maybe in-zlp was skipped)
1686                  * also appears after some config change events.
1687                  */
1688                 if (udccs0 & UDCCS0_OPR)
1689                         UDCCS0 = UDCCS0_OPR;
1690                 ep0_idle(dev);
1691                 break;
1692         case EP0_STALL:
1693                 UDCCS0 = UDCCS0_FST;
1694                 break;
1695         }
1696         USIR0 = USIR0_IR0;
1697 }
1698
1699 static void handle_ep(struct pxa25x_ep *ep)
1700 {
1701         struct pxa25x_request   *req;
1702         int                     is_in = ep->bEndpointAddress & USB_DIR_IN;
1703         int                     completed;
1704         u32                     udccs, tmp;
1705
1706         do {
1707                 completed = 0;
1708                 if (likely (!list_empty(&ep->queue)))
1709                         req = list_entry(ep->queue.next,
1710                                         struct pxa25x_request, queue);
1711                 else
1712                         req = NULL;
1713
1714                 // TODO check FST handling
1715
1716                 udccs = *ep->reg_udccs;
1717                 if (unlikely(is_in)) {  /* irq from TPC, SST, or (ISO) TUR */
1718                         tmp = UDCCS_BI_TUR;
1719                         if (likely(ep->bmAttributes == USB_ENDPOINT_XFER_BULK))
1720                                 tmp |= UDCCS_BI_SST;
1721                         tmp &= udccs;
1722                         if (likely (tmp))
1723                                 *ep->reg_udccs = tmp;
1724                         if (req && likely ((udccs & UDCCS_BI_TFS) != 0))
1725                                 completed = write_fifo(ep, req);
1726
1727                 } else {        /* irq from RPC (or for ISO, ROF) */
1728                         if (likely(ep->bmAttributes == USB_ENDPOINT_XFER_BULK))
1729                                 tmp = UDCCS_BO_SST | UDCCS_BO_DME;
1730                         else
1731                                 tmp = UDCCS_IO_ROF | UDCCS_IO_DME;
1732                         tmp &= udccs;
1733                         if (likely(tmp))
1734                                 *ep->reg_udccs = tmp;
1735
1736                         /* fifos can hold packets, ready for reading... */
1737                         if (likely(req)) {
1738                                 completed = read_fifo(ep, req);
1739                         } else
1740                                 pio_irq_disable (ep->bEndpointAddress);
1741                 }
1742                 ep->pio_irqs++;
1743         } while (completed);
1744 }
1745
1746 /*
1747  *      pxa25x_udc_irq - interrupt handler
1748  *
1749  * avoid delays in ep0 processing. the control handshaking isn't always
1750  * under software control (pxa250c0 and the pxa255 are better), and delays
1751  * could cause usb protocol errors.
1752  */
1753 static irqreturn_t
1754 pxa25x_udc_irq(int irq, void *_dev)
1755 {
1756         struct pxa25x_udc       *dev = _dev;
1757         int                     handled;
1758
1759         dev->stats.irqs++;
1760         do {
1761                 u32             udccr = UDCCR;
1762
1763                 handled = 0;
1764
1765                 /* SUSpend Interrupt Request */
1766                 if (unlikely(udccr & UDCCR_SUSIR)) {
1767                         udc_ack_int_UDCCR(UDCCR_SUSIR);
1768                         handled = 1;
1769                         DBG(DBG_VERBOSE, "USB suspend%s\n", is_vbus_present()
1770                                 ? "" : "+disconnect");
1771
1772                         if (!is_vbus_present())
1773                                 stop_activity(dev, dev->driver);
1774                         else if (dev->gadget.speed != USB_SPEED_UNKNOWN
1775                                         && dev->driver
1776                                         && dev->driver->suspend)
1777                                 dev->driver->suspend(&dev->gadget);
1778                         ep0_idle (dev);
1779                 }
1780
1781                 /* RESume Interrupt Request */
1782                 if (unlikely(udccr & UDCCR_RESIR)) {
1783                         udc_ack_int_UDCCR(UDCCR_RESIR);
1784                         handled = 1;
1785                         DBG(DBG_VERBOSE, "USB resume\n");
1786
1787                         if (dev->gadget.speed != USB_SPEED_UNKNOWN
1788                                         && dev->driver
1789                                         && dev->driver->resume
1790                                         && is_vbus_present())
1791                                 dev->driver->resume(&dev->gadget);
1792                 }
1793
1794                 /* ReSeT Interrupt Request - USB reset */
1795                 if (unlikely(udccr & UDCCR_RSTIR)) {
1796                         udc_ack_int_UDCCR(UDCCR_RSTIR);
1797                         handled = 1;
1798
1799                         if ((UDCCR & UDCCR_UDA) == 0) {
1800                                 DBG(DBG_VERBOSE, "USB reset start\n");
1801
1802                                 /* reset driver and endpoints,
1803                                  * in case that's not yet done
1804                                  */
1805                                 stop_activity (dev, dev->driver);
1806
1807                         } else {
1808                                 DBG(DBG_VERBOSE, "USB reset end\n");
1809                                 dev->gadget.speed = USB_SPEED_FULL;
1810                                 memset(&dev->stats, 0, sizeof dev->stats);
1811                                 /* driver and endpoints are still reset */
1812                         }
1813
1814                 } else {
1815                         u32     usir0 = USIR0 & ~UICR0;
1816                         u32     usir1 = USIR1 & ~UICR1;
1817                         int     i;
1818
1819                         if (unlikely (!usir0 && !usir1))
1820                                 continue;
1821
1822                         DBG(DBG_VERY_NOISY, "irq %02x.%02x\n", usir1, usir0);
1823
1824                         /* control traffic */
1825                         if (usir0 & USIR0_IR0) {
1826                                 dev->ep[0].pio_irqs++;
1827                                 handle_ep0(dev);
1828                                 handled = 1;
1829                         }
1830
1831                         /* endpoint data transfers */
1832                         for (i = 0; i < 8; i++) {
1833                                 u32     tmp = 1 << i;
1834
1835                                 if (i && (usir0 & tmp)) {
1836                                         handle_ep(&dev->ep[i]);
1837                                         USIR0 |= tmp;
1838                                         handled = 1;
1839                                 }
1840 #ifndef CONFIG_USB_PXA25X_SMALL
1841                                 if (usir1 & tmp) {
1842                                         handle_ep(&dev->ep[i+8]);
1843                                         USIR1 |= tmp;
1844                                         handled = 1;
1845                                 }
1846 #endif
1847                         }
1848                 }
1849
1850                 /* we could also ask for 1 msec SOF (SIR) interrupts */
1851
1852         } while (handled);
1853         return IRQ_HANDLED;
1854 }
1855
1856 /*-------------------------------------------------------------------------*/
1857
1858 static void nop_release (struct device *dev)
1859 {
1860         DMSG("%s %s\n", __func__, dev_name(dev));
1861 }
1862
1863 /* this uses load-time allocation and initialization (instead of
1864  * doing it at run-time) to save code, eliminate fault paths, and
1865  * be more obviously correct.
1866  */
1867 static struct pxa25x_udc memory = {
1868         .gadget = {
1869                 .ops            = &pxa25x_udc_ops,
1870                 .ep0            = &memory.ep[0].ep,
1871                 .name           = driver_name,
1872                 .dev = {
1873                         .init_name      = "gadget",
1874                         .release        = nop_release,
1875                 },
1876         },
1877
1878         /* control endpoint */
1879         .ep[0] = {
1880                 .ep = {
1881                         .name           = ep0name,
1882                         .ops            = &pxa25x_ep_ops,
1883                         .maxpacket      = EP0_FIFO_SIZE,
1884                 },
1885                 .dev            = &memory,
1886                 .reg_udccs      = &UDCCS0,
1887                 .reg_uddr       = &UDDR0,
1888         },
1889
1890         /* first group of endpoints */
1891         .ep[1] = {
1892                 .ep = {
1893                         .name           = "ep1in-bulk",
1894                         .ops            = &pxa25x_ep_ops,
1895                         .maxpacket      = BULK_FIFO_SIZE,
1896                 },
1897                 .dev            = &memory,
1898                 .fifo_size      = BULK_FIFO_SIZE,
1899                 .bEndpointAddress = USB_DIR_IN | 1,
1900                 .bmAttributes   = USB_ENDPOINT_XFER_BULK,
1901                 .reg_udccs      = &UDCCS1,
1902                 .reg_uddr       = &UDDR1,
1903         },
1904         .ep[2] = {
1905                 .ep = {
1906                         .name           = "ep2out-bulk",
1907                         .ops            = &pxa25x_ep_ops,
1908                         .maxpacket      = BULK_FIFO_SIZE,
1909                 },
1910                 .dev            = &memory,
1911                 .fifo_size      = BULK_FIFO_SIZE,
1912                 .bEndpointAddress = 2,
1913                 .bmAttributes   = USB_ENDPOINT_XFER_BULK,
1914                 .reg_udccs      = &UDCCS2,
1915                 .reg_ubcr       = &UBCR2,
1916                 .reg_uddr       = &UDDR2,
1917         },
1918 #ifndef CONFIG_USB_PXA25X_SMALL
1919         .ep[3] = {
1920                 .ep = {
1921                         .name           = "ep3in-iso",
1922                         .ops            = &pxa25x_ep_ops,
1923                         .maxpacket      = ISO_FIFO_SIZE,
1924                 },
1925                 .dev            = &memory,
1926                 .fifo_size      = ISO_FIFO_SIZE,
1927                 .bEndpointAddress = USB_DIR_IN | 3,
1928                 .bmAttributes   = USB_ENDPOINT_XFER_ISOC,
1929                 .reg_udccs      = &UDCCS3,
1930                 .reg_uddr       = &UDDR3,
1931         },
1932         .ep[4] = {
1933                 .ep = {
1934                         .name           = "ep4out-iso",
1935                         .ops            = &pxa25x_ep_ops,
1936                         .maxpacket      = ISO_FIFO_SIZE,
1937                 },
1938                 .dev            = &memory,
1939                 .fifo_size      = ISO_FIFO_SIZE,
1940                 .bEndpointAddress = 4,
1941                 .bmAttributes   = USB_ENDPOINT_XFER_ISOC,
1942                 .reg_udccs      = &UDCCS4,
1943                 .reg_ubcr       = &UBCR4,
1944                 .reg_uddr       = &UDDR4,
1945         },
1946         .ep[5] = {
1947                 .ep = {
1948                         .name           = "ep5in-int",
1949                         .ops            = &pxa25x_ep_ops,
1950                         .maxpacket      = INT_FIFO_SIZE,
1951                 },
1952                 .dev            = &memory,
1953                 .fifo_size      = INT_FIFO_SIZE,
1954                 .bEndpointAddress = USB_DIR_IN | 5,
1955                 .bmAttributes   = USB_ENDPOINT_XFER_INT,
1956                 .reg_udccs      = &UDCCS5,
1957                 .reg_uddr       = &UDDR5,
1958         },
1959
1960         /* second group of endpoints */
1961         .ep[6] = {
1962                 .ep = {
1963                         .name           = "ep6in-bulk",
1964                         .ops            = &pxa25x_ep_ops,
1965                         .maxpacket      = BULK_FIFO_SIZE,
1966                 },
1967                 .dev            = &memory,
1968                 .fifo_size      = BULK_FIFO_SIZE,
1969                 .bEndpointAddress = USB_DIR_IN | 6,
1970                 .bmAttributes   = USB_ENDPOINT_XFER_BULK,
1971                 .reg_udccs      = &UDCCS6,
1972                 .reg_uddr       = &UDDR6,
1973         },
1974         .ep[7] = {
1975                 .ep = {
1976                         .name           = "ep7out-bulk",
1977                         .ops            = &pxa25x_ep_ops,
1978                         .maxpacket      = BULK_FIFO_SIZE,
1979                 },
1980                 .dev            = &memory,
1981                 .fifo_size      = BULK_FIFO_SIZE,
1982                 .bEndpointAddress = 7,
1983                 .bmAttributes   = USB_ENDPOINT_XFER_BULK,
1984                 .reg_udccs      = &UDCCS7,
1985                 .reg_ubcr       = &UBCR7,
1986                 .reg_uddr       = &UDDR7,
1987         },
1988         .ep[8] = {
1989                 .ep = {
1990                         .name           = "ep8in-iso",
1991                         .ops            = &pxa25x_ep_ops,
1992                         .maxpacket      = ISO_FIFO_SIZE,
1993                 },
1994                 .dev            = &memory,
1995                 .fifo_size      = ISO_FIFO_SIZE,
1996                 .bEndpointAddress = USB_DIR_IN | 8,
1997                 .bmAttributes   = USB_ENDPOINT_XFER_ISOC,
1998                 .reg_udccs      = &UDCCS8,
1999                 .reg_uddr       = &UDDR8,
2000         },
2001         .ep[9] = {
2002                 .ep = {
2003                         .name           = "ep9out-iso",
2004                         .ops            = &pxa25x_ep_ops,
2005                         .maxpacket      = ISO_FIFO_SIZE,
2006                 },
2007                 .dev            = &memory,
2008                 .fifo_size      = ISO_FIFO_SIZE,
2009                 .bEndpointAddress = 9,
2010                 .bmAttributes   = USB_ENDPOINT_XFER_ISOC,
2011                 .reg_udccs      = &UDCCS9,
2012                 .reg_ubcr       = &UBCR9,
2013                 .reg_uddr       = &UDDR9,
2014         },
2015         .ep[10] = {
2016                 .ep = {
2017                         .name           = "ep10in-int",
2018                         .ops            = &pxa25x_ep_ops,
2019                         .maxpacket      = INT_FIFO_SIZE,
2020                 },
2021                 .dev            = &memory,
2022                 .fifo_size      = INT_FIFO_SIZE,
2023                 .bEndpointAddress = USB_DIR_IN | 10,
2024                 .bmAttributes   = USB_ENDPOINT_XFER_INT,
2025                 .reg_udccs      = &UDCCS10,
2026                 .reg_uddr       = &UDDR10,
2027         },
2028
2029         /* third group of endpoints */
2030         .ep[11] = {
2031                 .ep = {
2032                         .name           = "ep11in-bulk",
2033                         .ops            = &pxa25x_ep_ops,
2034                         .maxpacket      = BULK_FIFO_SIZE,
2035                 },
2036                 .dev            = &memory,
2037                 .fifo_size      = BULK_FIFO_SIZE,
2038                 .bEndpointAddress = USB_DIR_IN | 11,
2039                 .bmAttributes   = USB_ENDPOINT_XFER_BULK,
2040                 .reg_udccs      = &UDCCS11,
2041                 .reg_uddr       = &UDDR11,
2042         },
2043         .ep[12] = {
2044                 .ep = {
2045                         .name           = "ep12out-bulk",
2046                         .ops            = &pxa25x_ep_ops,
2047                         .maxpacket      = BULK_FIFO_SIZE,
2048                 },
2049                 .dev            = &memory,
2050                 .fifo_size      = BULK_FIFO_SIZE,
2051                 .bEndpointAddress = 12,
2052                 .bmAttributes   = USB_ENDPOINT_XFER_BULK,
2053                 .reg_udccs      = &UDCCS12,
2054                 .reg_ubcr       = &UBCR12,
2055                 .reg_uddr       = &UDDR12,
2056         },
2057         .ep[13] = {
2058                 .ep = {
2059                         .name           = "ep13in-iso",
2060                         .ops            = &pxa25x_ep_ops,
2061                         .maxpacket      = ISO_FIFO_SIZE,
2062                 },
2063                 .dev            = &memory,
2064                 .fifo_size      = ISO_FIFO_SIZE,
2065                 .bEndpointAddress = USB_DIR_IN | 13,
2066                 .bmAttributes   = USB_ENDPOINT_XFER_ISOC,
2067                 .reg_udccs      = &UDCCS13,
2068                 .reg_uddr       = &UDDR13,
2069         },
2070         .ep[14] = {
2071                 .ep = {
2072                         .name           = "ep14out-iso",
2073                         .ops            = &pxa25x_ep_ops,
2074                         .maxpacket      = ISO_FIFO_SIZE,
2075                 },
2076                 .dev            = &memory,
2077                 .fifo_size      = ISO_FIFO_SIZE,
2078                 .bEndpointAddress = 14,
2079                 .bmAttributes   = USB_ENDPOINT_XFER_ISOC,
2080                 .reg_udccs      = &UDCCS14,
2081                 .reg_ubcr       = &UBCR14,
2082                 .reg_uddr       = &UDDR14,
2083         },
2084         .ep[15] = {
2085                 .ep = {
2086                         .name           = "ep15in-int",
2087                         .ops            = &pxa25x_ep_ops,
2088                         .maxpacket      = INT_FIFO_SIZE,
2089                 },
2090                 .dev            = &memory,
2091                 .fifo_size      = INT_FIFO_SIZE,
2092                 .bEndpointAddress = USB_DIR_IN | 15,
2093                 .bmAttributes   = USB_ENDPOINT_XFER_INT,
2094                 .reg_udccs      = &UDCCS15,
2095                 .reg_uddr       = &UDDR15,
2096         },
2097 #endif /* !CONFIG_USB_PXA25X_SMALL */
2098 };
2099
2100 #define CP15R0_VENDOR_MASK      0xffffe000
2101
2102 #if     defined(CONFIG_ARCH_PXA)
2103 #define CP15R0_XSCALE_VALUE     0x69052000      /* intel/arm/xscale */
2104
2105 #elif   defined(CONFIG_ARCH_IXP4XX)
2106 #define CP15R0_XSCALE_VALUE     0x69054000      /* intel/arm/ixp4xx */
2107
2108 #endif
2109
2110 #define CP15R0_PROD_MASK        0x000003f0
2111 #define PXA25x                  0x00000100      /* and PXA26x */
2112 #define PXA210                  0x00000120
2113
2114 #define CP15R0_REV_MASK         0x0000000f
2115
2116 #define CP15R0_PRODREV_MASK     (CP15R0_PROD_MASK | CP15R0_REV_MASK)
2117
2118 #define PXA255_A0               0x00000106      /* or PXA260_B1 */
2119 #define PXA250_C0               0x00000105      /* or PXA26x_B0 */
2120 #define PXA250_B2               0x00000104
2121 #define PXA250_B1               0x00000103      /* or PXA260_A0 */
2122 #define PXA250_B0               0x00000102
2123 #define PXA250_A1               0x00000101
2124 #define PXA250_A0               0x00000100
2125
2126 #define PXA210_C0               0x00000125
2127 #define PXA210_B2               0x00000124
2128 #define PXA210_B1               0x00000123
2129 #define PXA210_B0               0x00000122
2130 #define IXP425_A0               0x000001c1
2131 #define IXP425_B0               0x000001f1
2132 #define IXP465_AD               0x00000200
2133
2134 /*
2135  *      probe - binds to the platform device
2136  */
2137 static int __init pxa25x_udc_probe(struct platform_device *pdev)
2138 {
2139         struct pxa25x_udc *dev = &memory;
2140         int retval, vbus_irq, irq;
2141         u32 chiprev;
2142
2143         /* insist on Intel/ARM/XScale */
2144         asm("mrc%? p15, 0, %0, c0, c0" : "=r" (chiprev));
2145         if ((chiprev & CP15R0_VENDOR_MASK) != CP15R0_XSCALE_VALUE) {
2146                 pr_err("%s: not XScale!\n", driver_name);
2147                 return -ENODEV;
2148         }
2149
2150         /* trigger chiprev-specific logic */
2151         switch (chiprev & CP15R0_PRODREV_MASK) {
2152 #if     defined(CONFIG_ARCH_PXA)
2153         case PXA255_A0:
2154                 dev->has_cfr = 1;
2155                 break;
2156         case PXA250_A0:
2157         case PXA250_A1:
2158                 /* A0/A1 "not released"; ep 13, 15 unusable */
2159                 /* fall through */
2160         case PXA250_B2: case PXA210_B2:
2161         case PXA250_B1: case PXA210_B1:
2162         case PXA250_B0: case PXA210_B0:
2163                 /* OUT-DMA is broken ... */
2164                 /* fall through */
2165         case PXA250_C0: case PXA210_C0:
2166                 break;
2167 #elif   defined(CONFIG_ARCH_IXP4XX)
2168         case IXP425_A0:
2169         case IXP425_B0:
2170         case IXP465_AD:
2171                 dev->has_cfr = 1;
2172                 break;
2173 #endif
2174         default:
2175                 pr_err("%s: unrecognized processor: %08x\n",
2176                         driver_name, chiprev);
2177                 /* iop3xx, ixp4xx, ... */
2178                 return -ENODEV;
2179         }
2180
2181         irq = platform_get_irq(pdev, 0);
2182         if (irq < 0)
2183                 return -ENODEV;
2184
2185         dev->clk = clk_get(&pdev->dev, NULL);
2186         if (IS_ERR(dev->clk)) {
2187                 retval = PTR_ERR(dev->clk);
2188                 goto err_clk;
2189         }
2190
2191         pr_debug("%s: IRQ %d%s%s\n", driver_name, irq,
2192                 dev->has_cfr ? "" : " (!cfr)",
2193                 SIZE_STR "(pio)"
2194                 );
2195
2196         /* other non-static parts of init */
2197         dev->dev = &pdev->dev;
2198         dev->mach = pdev->dev.platform_data;
2199
2200         dev->transceiver = otg_get_transceiver();
2201
2202         if (gpio_is_valid(dev->mach->gpio_vbus)) {
2203                 if ((retval = gpio_request(dev->mach->gpio_vbus,
2204                                 "pxa25x_udc GPIO VBUS"))) {
2205                         dev_dbg(&pdev->dev,
2206                                 "can't get vbus gpio %d, err: %d\n",
2207                                 dev->mach->gpio_vbus, retval);
2208                         goto err_gpio_vbus;
2209                 }
2210                 gpio_direction_input(dev->mach->gpio_vbus);
2211                 vbus_irq = gpio_to_irq(dev->mach->gpio_vbus);
2212         } else
2213                 vbus_irq = 0;
2214
2215         if (gpio_is_valid(dev->mach->gpio_pullup)) {
2216                 if ((retval = gpio_request(dev->mach->gpio_pullup,
2217                                 "pca25x_udc GPIO PULLUP"))) {
2218                         dev_dbg(&pdev->dev,
2219                                 "can't get pullup gpio %d, err: %d\n",
2220                                 dev->mach->gpio_pullup, retval);
2221                         goto err_gpio_pullup;
2222                 }
2223                 gpio_direction_output(dev->mach->gpio_pullup, 0);
2224         }
2225
2226         init_timer(&dev->timer);
2227         dev->timer.function = udc_watchdog;
2228         dev->timer.data = (unsigned long) dev;
2229
2230         device_initialize(&dev->gadget.dev);
2231         dev->gadget.dev.parent = &pdev->dev;
2232         dev->gadget.dev.dma_mask = pdev->dev.dma_mask;
2233
2234         the_controller = dev;
2235         platform_set_drvdata(pdev, dev);
2236
2237         udc_disable(dev);
2238         udc_reinit(dev);
2239
2240         dev->vbus = !!is_vbus_present();
2241
2242         /* irq setup after old hardware state is cleaned up */
2243         retval = request_irq(irq, pxa25x_udc_irq,
2244                         IRQF_DISABLED, driver_name, dev);
2245         if (retval != 0) {
2246                 pr_err("%s: can't get irq %d, err %d\n",
2247                         driver_name, irq, retval);
2248                 goto err_irq1;
2249         }
2250         dev->got_irq = 1;
2251
2252 #ifdef CONFIG_ARCH_LUBBOCK
2253         if (machine_is_lubbock()) {
2254                 retval = request_irq(LUBBOCK_USB_DISC_IRQ,
2255                                 lubbock_vbus_irq,
2256                                 IRQF_DISABLED | IRQF_SAMPLE_RANDOM,
2257                                 driver_name, dev);
2258                 if (retval != 0) {
2259                         pr_err("%s: can't get irq %i, err %d\n",
2260                                 driver_name, LUBBOCK_USB_DISC_IRQ, retval);
2261 lubbock_fail0:
2262                         goto err_irq_lub;
2263                 }
2264                 retval = request_irq(LUBBOCK_USB_IRQ,
2265                                 lubbock_vbus_irq,
2266                                 IRQF_DISABLED | IRQF_SAMPLE_RANDOM,
2267                                 driver_name, dev);
2268                 if (retval != 0) {
2269                         pr_err("%s: can't get irq %i, err %d\n",
2270                                 driver_name, LUBBOCK_USB_IRQ, retval);
2271                         free_irq(LUBBOCK_USB_DISC_IRQ, dev);
2272                         goto lubbock_fail0;
2273                 }
2274         } else
2275 #endif
2276         if (vbus_irq) {
2277                 retval = request_irq(vbus_irq, udc_vbus_irq,
2278                                 IRQF_DISABLED | IRQF_SAMPLE_RANDOM |
2279                                 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
2280                                 driver_name, dev);
2281                 if (retval != 0) {
2282                         pr_err("%s: can't get irq %i, err %d\n",
2283                                 driver_name, vbus_irq, retval);
2284                         goto err_vbus_irq;
2285                 }
2286         }
2287         create_debug_files(dev);
2288
2289         return 0;
2290
2291  err_vbus_irq:
2292 #ifdef  CONFIG_ARCH_LUBBOCK
2293         free_irq(LUBBOCK_USB_DISC_IRQ, dev);
2294  err_irq_lub:
2295 #endif
2296         free_irq(irq, dev);
2297  err_irq1:
2298         if (gpio_is_valid(dev->mach->gpio_pullup))
2299                 gpio_free(dev->mach->gpio_pullup);
2300  err_gpio_pullup:
2301         if (gpio_is_valid(dev->mach->gpio_vbus))
2302                 gpio_free(dev->mach->gpio_vbus);
2303  err_gpio_vbus:
2304         if (dev->transceiver) {
2305                 otg_put_transceiver(dev->transceiver);
2306                 dev->transceiver = NULL;
2307         }
2308         clk_put(dev->clk);
2309  err_clk:
2310         return retval;
2311 }
2312
2313 static void pxa25x_udc_shutdown(struct platform_device *_dev)
2314 {
2315         pullup_off();
2316 }
2317
2318 static int __exit pxa25x_udc_remove(struct platform_device *pdev)
2319 {
2320         struct pxa25x_udc *dev = platform_get_drvdata(pdev);
2321
2322         if (dev->driver)
2323                 return -EBUSY;
2324
2325         dev->pullup = 0;
2326         pullup(dev);
2327
2328         remove_debug_files(dev);
2329
2330         if (dev->got_irq) {
2331                 free_irq(platform_get_irq(pdev, 0), dev);
2332                 dev->got_irq = 0;
2333         }
2334 #ifdef CONFIG_ARCH_LUBBOCK
2335         if (machine_is_lubbock()) {
2336                 free_irq(LUBBOCK_USB_DISC_IRQ, dev);
2337                 free_irq(LUBBOCK_USB_IRQ, dev);
2338         }
2339 #endif
2340         if (gpio_is_valid(dev->mach->gpio_vbus)) {
2341                 free_irq(gpio_to_irq(dev->mach->gpio_vbus), dev);
2342                 gpio_free(dev->mach->gpio_vbus);
2343         }
2344         if (gpio_is_valid(dev->mach->gpio_pullup))
2345                 gpio_free(dev->mach->gpio_pullup);
2346
2347         clk_put(dev->clk);
2348
2349         if (dev->transceiver) {
2350                 otg_put_transceiver(dev->transceiver);
2351                 dev->transceiver = NULL;
2352         }
2353
2354         platform_set_drvdata(pdev, NULL);
2355         the_controller = NULL;
2356         return 0;
2357 }
2358
2359 /*-------------------------------------------------------------------------*/
2360
2361 #ifdef  CONFIG_PM
2362
2363 /* USB suspend (controlled by the host) and system suspend (controlled
2364  * by the PXA) don't necessarily work well together.  If USB is active,
2365  * the 48 MHz clock is required; so the system can't enter 33 MHz idle
2366  * mode, or any deeper PM saving state.
2367  *
2368  * For now, we punt and forcibly disconnect from the USB host when PXA
2369  * enters any suspend state.  While we're disconnected, we always disable
2370  * the 48MHz USB clock ... allowing PXA sleep and/or 33 MHz idle states.
2371  * Boards without software pullup control shouldn't use those states.
2372  * VBUS IRQs should probably be ignored so that the PXA device just acts
2373  * "dead" to USB hosts until system resume.
2374  */
2375 static int pxa25x_udc_suspend(struct platform_device *dev, pm_message_t state)
2376 {
2377         struct pxa25x_udc       *udc = platform_get_drvdata(dev);
2378         unsigned long flags;
2379
2380         if (!gpio_is_valid(udc->mach->gpio_pullup) && !udc->mach->udc_command)
2381                 WARNING("USB host won't detect disconnect!\n");
2382         udc->suspended = 1;
2383
2384         local_irq_save(flags);
2385         pullup(udc);
2386         local_irq_restore(flags);
2387
2388         return 0;
2389 }
2390
2391 static int pxa25x_udc_resume(struct platform_device *dev)
2392 {
2393         struct pxa25x_udc       *udc = platform_get_drvdata(dev);
2394         unsigned long flags;
2395
2396         udc->suspended = 0;
2397         local_irq_save(flags);
2398         pullup(udc);
2399         local_irq_restore(flags);
2400
2401         return 0;
2402 }
2403
2404 #else
2405 #define pxa25x_udc_suspend      NULL
2406 #define pxa25x_udc_resume       NULL
2407 #endif
2408
2409 /*-------------------------------------------------------------------------*/
2410
2411 static struct platform_driver udc_driver = {
2412         .shutdown       = pxa25x_udc_shutdown,
2413         .remove         = __exit_p(pxa25x_udc_remove),
2414         .suspend        = pxa25x_udc_suspend,
2415         .resume         = pxa25x_udc_resume,
2416         .driver         = {
2417                 .owner  = THIS_MODULE,
2418                 .name   = "pxa25x-udc",
2419         },
2420 };
2421
2422 static int __init udc_init(void)
2423 {
2424         pr_info("%s: version %s\n", driver_name, DRIVER_VERSION);
2425         return platform_driver_probe(&udc_driver, pxa25x_udc_probe);
2426 }
2427 module_init(udc_init);
2428
2429 static void __exit udc_exit(void)
2430 {
2431         platform_driver_unregister(&udc_driver);
2432 }
2433 module_exit(udc_exit);
2434
2435 MODULE_DESCRIPTION(DRIVER_DESC);
2436 MODULE_AUTHOR("Frank Becker, Robert Schwebel, David Brownell");
2437 MODULE_LICENSE("GPL");
2438 MODULE_ALIAS("platform:pxa25x-udc");