drivers/usb/gadget/dummy_hcd.c

   1 /*
   2  * dummy_hcd.c -- Dummy/Loopback USB host and device emulator driver.
   3  *
   4  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
   5  *
   6  * Copyright (C) 2003 David Brownell
   7  * Copyright (C) 2003, 2004 Alan Stern
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24
  25 /*
  26  * This exposes a device side "USB gadget" API, driven by requests to a
  27  * Linux-USB host controller driver.  USB traffic is simulated; there's
  28  * no need for USB hardware.  Use this with two other drivers:
  29  *
  30  *  - Gadget driver, responding to requests (slave);
  31  *  - Host-side device driver, as already familiar in Linux.
  32  *
  33  * Having this all in one kernel can help some stages of development,
  34  * bypassing some hardware (and driver) issues.  UML could help too.
  35  */
  36
  37 #define DEBUG
  38
  39 #include <linux/config.h>
  40 #include <linux/module.h>
  41 #include <linux/kernel.h>
  42 #include <linux/delay.h>
  43 #include <linux/ioport.h>
  44 #include <linux/sched.h>
  45 #include <linux/slab.h>
  46 #include <linux/smp_lock.h>
  47 #include <linux/errno.h>
  48 #include <linux/init.h>
  49 #include <linux/timer.h>
  50 #include <linux/list.h>
  51 #include <linux/interrupt.h>
  52 #include <linux/version.h>
  53
  54 #include <linux/usb.h>
  55 #include <linux/usb_gadget.h>
  56
  57 #include <asm/byteorder.h>
  58 #include <asm/io.h>
  59 #include <asm/irq.h>
  60 #include <asm/system.h>
  61 #include <asm/unaligned.h>
  62
  63
  64 #include "../core/hcd.h"
  65
  66
  67 #define DRIVER_DESC     "USB Host+Gadget Emulator"
  68 #define DRIVER_VERSION  "14 Mar 2004"
  69
  70 static const char       driver_name [] = "dummy_hcd";
  71 static const char       driver_desc [] = "USB Host+Gadget Emulator";
  72
  73 static const char       gadget_name [] = "dummy_udc";
  74
  75 MODULE_DESCRIPTION (DRIVER_DESC);
  76 MODULE_AUTHOR ("David Brownell");
  77 MODULE_LICENSE ("GPL");
  78
  79 /*-------------------------------------------------------------------------*/
  80
  81 /* gadget side driver data structres */
  82 struct dummy_ep {
  83         struct list_head                queue;
  84         unsigned long                   last_io;        /* jiffies timestamp */
  85         struct usb_gadget               *gadget;
  86         const struct usb_endpoint_descriptor *desc;
  87         struct usb_ep                   ep;
  88         unsigned                        halted : 1;
  89         unsigned                        already_seen : 1;
  90         unsigned                        setup_stage : 1;
  91 };
  92
  93 struct dummy_request {
  94         struct list_head                queue;          /* ep's requests */
  95         struct usb_request              req;
  96 };
  97
  98 /*-------------------------------------------------------------------------*/
  99
 100 /*
 101  * Every device has ep0 for control requests, plus up to 30 more endpoints,
 102  * in one of two types:
 103  *
 104  *   - Configurable:  direction (in/out), type (bulk, iso, etc), and endpoint
 105  *     number can be changed.  Names like "ep-a" are used for this type.
 106  *
 107  *   - Fixed Function:  in other cases.  some characteristics may be mutable;
 108  *     that'd be hardware-specific.  Names like "ep12out-bulk" are used.
 109  *
 110  * Gadget drivers are responsible for not setting up conflicting endpoint
 111  * configurations, illegal or unsupported packet lengths, and so on.
 112  */
 113
 114 static const char ep0name [] = "ep0";
 115
 116 static const char *const ep_name [] = {
 117         ep0name,                                /* everyone has ep0 */
 118
 119         /* act like a net2280: high speed, six configurable endpoints */
 120         "ep-a", "ep-b", "ep-c", "ep-d", "ep-e", "ep-f",
 121
 122         /* or like pxa250: fifteen fixed function endpoints */
 123         "ep1in-bulk", "ep2out-bulk", "ep3in-iso", "ep4out-iso", "ep5in-int",
 124         "ep6in-bulk", "ep7out-bulk", "ep8in-iso", "ep9out-iso", "ep10in-int",
 125         "ep11in-bulk", "ep12out-bulk", "ep13in-iso", "ep14out-iso",
 126                 "ep15in-int",
 127
 128         /* or like sa1100: two fixed function endpoints */
 129         "ep1out-bulk", "ep2in-bulk",
 130 };
 131 #define DUMMY_ENDPOINTS (sizeof(ep_name)/sizeof(char *))
 132
 133 #define FIFO_SIZE               64
 134
 135 struct dummy {
 136         spinlock_t                      lock;
 137
 138         /*
 139          * SLAVE/GADGET side support
 140          */
 141         struct dummy_ep                 ep [DUMMY_ENDPOINTS];
 142         int                             address;
 143         struct usb_gadget               gadget;
 144         struct usb_gadget_driver        *driver;
 145         struct dummy_request            fifo_req;
 146         u8                              fifo_buf [FIFO_SIZE];
 147         u16                             devstatus;
 148
 149         struct hcd_dev                  *hdev;
 150
 151         /*
 152          * MASTER/HOST side support
 153          */
 154         struct usb_hcd                  hcd;
 155         struct platform_device          pdev;
 156         struct timer_list               timer;
 157         u32                             port_status;
 158         int                             started;
 159         struct completion               released;
 160         unsigned                        resuming:1;
 161         unsigned long                   re_timeout;
 162 };
 163
 164 static struct dummy     *the_controller;
 165
 166 static inline struct dummy *ep_to_dummy (struct dummy_ep *ep)
 167 {
 168         return container_of (ep->gadget, struct dummy, gadget);
 169 }
 170
 171 static inline struct dummy *gadget_dev_to_dummy (struct device *dev)
 172 {
 173         return container_of (dev, struct dummy, gadget.dev);
 174 }
 175
 176 /*
 177  * This "hardware" may look a bit odd in diagnostics since it's got both
 178  * host and device sides; and it binds different drivers to each side.
 179  */
 180 #define hardware        (&the_controller->pdev.dev)
 181
 182 /*-------------------------------------------------------------------------*/
 183
 184 static struct device_driver dummy_driver = {
 185         .name           = (char *) driver_name,
 186         .bus            = &platform_bus_type,
 187 };
 188
 189 /*-------------------------------------------------------------------------*/
 190
 191 /* SLAVE/GADGET SIDE DRIVER
 192  *
 193  * This only tracks gadget state.  All the work is done when the host
 194  * side tries some (emulated) i/o operation.  Real device controller
 195  * drivers would do real i/o using dma, fifos, irqs, timers, etc.
 196  */
 197
 198 #define is_enabled() \
 199         (the_controller->port_status & USB_PORT_STAT_ENABLE)
 200
 201 static int
 202 dummy_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
 203 {
 204         struct dummy            *dum;
 205         struct dummy_ep         *ep;
 206         unsigned                max;
 207         int                     retval;
 208
 209         ep = container_of (_ep, struct dummy_ep, ep);
 210         if (!_ep || !desc || ep->desc || _ep->name == ep0name
 211                         || desc->bDescriptorType != USB_DT_ENDPOINT)
 212         if (!the_controller->driver || !is_enabled ())
 213                 return -ESHUTDOWN;
 214         max = desc->wMaxPacketSize & 0x3ff;
 215
 216         /* drivers must not request bad settings, since lower levels
 217          * (hardware or its drivers) may not check.  some endpoints
 218          * can't do iso, many have maxpacket limitations, etc.
 219          *
 220          * since this "hardware" driver is here to help debugging, we
 221          * have some extra sanity checks.  (there could be more though,
 222          * especially for "ep9out" style fixed function ones.)
 223          */
 224         dum = container_of (ep->gadget, struct dummy, gadget);
 225         retval = -EINVAL;
 226         switch (desc->bmAttributes & 0x03) {
 227         case USB_ENDPOINT_XFER_BULK:
 228                 if (strstr (ep->ep.name, "-iso")
 229                                 || strstr (ep->ep.name, "-int")) {
 230                         goto done;
 231                 }
 232                 switch (dum->gadget.speed) {
 233                 case USB_SPEED_HIGH:
 234                         if (max == 512)
 235                                 break;
 236                         /* conserve return statements */
 237                 default:
 238                         switch (max) {
 239                         case 8: case 16: case 32: case 64:
 240                                 /* we'll fake any legal size */
 241                                 break;
 242                         default:
 243                 case USB_SPEED_LOW:
 244                                 goto done;
 245                         }
 246                 }
 247                 break;
 248         case USB_ENDPOINT_XFER_INT:
 249                 if (strstr (ep->ep.name, "-iso")) /* bulk is ok */
 250                         goto done;
 251                 /* real hardware might not handle all packet sizes */
 252                 switch (dum->gadget.speed) {
 253                 case USB_SPEED_HIGH:
 254                         if (max <= 1024)
 255                                 break;
 256                         /* save a return statement */
 257                 case USB_SPEED_FULL:
 258                         if (max <= 64)
 259                                 break;
 260                         /* save a return statement */
 261                 default:
 262                         if (max <= 8)
 263                                 break;
 264                         goto done;
 265                 }
 266                 break;
 267         case USB_ENDPOINT_XFER_ISOC:
 268                 if (strstr (ep->ep.name, "-bulk")
 269                                 || strstr (ep->ep.name, "-int"))
 270                         goto done;
 271                 /* real hardware might not handle all packet sizes */
 272                 switch (dum->gadget.speed) {
 273                 case USB_SPEED_HIGH:
 274                         if (max <= 1024)
 275                                 break;
 276                         /* save a return statement */
 277                 case USB_SPEED_FULL:
 278                         if (max <= 1023)
 279                                 break;
 280                         /* save a return statement */
 281                 default:
 282                         goto done;
 283                 }
 284                 break;
 285         default:
 286                 /* few chips support control except on ep0 */
 287                 goto done;
 288         }
 289
 290         _ep->maxpacket = max;
 291         ep->desc = desc;
 292
 293         dev_dbg (hardware, "enabled %s (ep%d%s-%s) maxpacket %d\n",
 294                 _ep->name,
 295                 desc->bEndpointAddress & 0x0f,
 296                 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
 297                 ({ char *val;
 298                  switch (desc->bmAttributes & 0x03) {
 299                  case USB_ENDPOINT_XFER_BULK: val = "bulk"; break;
 300                  case USB_ENDPOINT_XFER_ISOC: val = "iso"; break;
 301                  case USB_ENDPOINT_XFER_INT: val = "intr"; break;
 302                  default: val = "ctrl"; break;
 303                  }; val; }),
 304                 max);
 305
 306         /* at this point real hardware should be NAKing transfers
 307          * to that endpoint, until a buffer is queued to it.
 308          */
 309         retval = 0;
 310 done:
 311         return retval;
 312 }
 313
 314 /* called with spinlock held */
 315 static void nuke (struct dummy *dum, struct dummy_ep *ep)
 316 {
 317         while (!list_empty (&ep->queue)) {
 318                 struct dummy_request    *req;
 319
 320                 req = list_entry (ep->queue.next, struct dummy_request, queue);
 321                 list_del_init (&req->queue);
 322                 req->req.status = -ESHUTDOWN;
 323
 324                 spin_unlock (&dum->lock);
 325                 req->req.complete (&ep->ep, &req->req);
 326                 spin_lock (&dum->lock);
 327         }
 328 }
 329
 330 static int dummy_disable (struct usb_ep *_ep)
 331 {
 332         struct dummy_ep         *ep;
 333         struct dummy            *dum;
 334         unsigned long           flags;
 335         int                     retval;
 336
 337         ep = container_of (_ep, struct dummy_ep, ep);
 338         if (!_ep || !ep->desc || _ep->name == ep0name)
 339                 return -EINVAL;
 340         dum = ep_to_dummy (ep);
 341
 342         spin_lock_irqsave (&dum->lock, flags);
 343         ep->desc = 0;
 344         retval = 0;
 345         nuke (dum, ep);
 346         spin_unlock_irqrestore (&dum->lock, flags);
 347
 348         dev_dbg (hardware, "disabled %s\n", _ep->name);
 349         return retval;
 350 }
 351
 352 static struct usb_request *
 353 dummy_alloc_request (struct usb_ep *_ep, int mem_flags)
 354 {
 355         struct dummy_ep         *ep;
 356         struct dummy_request    *req;
 357
 358         ep = container_of (_ep, struct dummy_ep, ep);
 359         if (!_ep)
 360                 return 0;
 361
 362         req = kmalloc (sizeof *req, mem_flags);
 363         if (!req)
 364                 return 0;
 365         memset (req, 0, sizeof *req);
 366         INIT_LIST_HEAD (&req->queue);
 367         return &req->req;
 368 }
 369
 370 static void
 371 dummy_free_request (struct usb_ep *_ep, struct usb_request *_req)
 372 {
 373         struct dummy_ep         *ep;
 374         struct dummy_request    *req;
 375
 376         ep = container_of (_ep, struct dummy_ep, ep);
 377         if (!ep || !_req || (!ep->desc && _ep->name != ep0name))
 378                 return;
 379
 380         req = container_of (_req, struct dummy_request, req);
 381         WARN_ON (!list_empty (&req->queue));
 382         kfree (req);
 383 }
 384
 385 static void *
 386 dummy_alloc_buffer (
 387         struct usb_ep *_ep,
 388         unsigned bytes,
 389         dma_addr_t *dma,
 390         int mem_flags
 391 ) {
 392         char *retval;
 393
 394         if (!the_controller->driver)
 395                 return 0;
 396         retval = kmalloc (bytes, mem_flags);
 397         *dma = (dma_addr_t) retval;
 398         return retval;
 399 }
 400
 401 static void
 402 dummy_free_buffer (
 403         struct usb_ep *_ep,
 404         void *buf,
 405         dma_addr_t dma,
 406         unsigned bytes
 407 ) {
 408         if (bytes)
 409                 kfree (buf);
 410 }
 411
 412 static void
 413 fifo_complete (struct usb_ep *ep, struct usb_request *req)
 414 {
 415 #if 0
 416         dev_dbg (hardware, "fifo_complete: %d\n", req->status);
 417 #endif
 418 }
 419
 420 static int
 421 dummy_queue (struct usb_ep *_ep, struct usb_request *_req, int mem_flags)
 422 {
 423         struct dummy_ep         *ep;
 424         struct dummy_request    *req;
 425         struct dummy            *dum;
 426         unsigned long           flags;
 427
 428         req = container_of (_req, struct dummy_request, req);
 429         if (!_req || !list_empty (&req->queue) || !_req->complete)
 430                 return -EINVAL;
 431
 432         ep = container_of (_ep, struct dummy_ep, ep);
 433         if (!_ep || (!ep->desc && _ep->name != ep0name))
 434                 return -EINVAL;
 435
 436         if (!the_controller->driver || !is_enabled ())
 437                 return -ESHUTDOWN;
 438
 439         dum = container_of (ep->gadget, struct dummy, gadget);
 440
 441 #if 0
 442         dev_dbg (hardware, "ep %p queue req %p to %s, len %d buf %p\n",
 443                         ep, _req, _ep->name, _req->length, _req->buf);
 444 #endif
 445
 446         _req->status = -EINPROGRESS;
 447         _req->actual = 0;
 448         spin_lock_irqsave (&dum->lock, flags);
 449
 450         /* implement an emulated single-request FIFO */
 451         if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
 452                         list_empty (&dum->fifo_req.queue) &&
 453                         list_empty (&ep->queue) &&
 454                         _req->length <= FIFO_SIZE) {
 455                 req = &dum->fifo_req;
 456                 req->req = *_req;
 457                 req->req.buf = dum->fifo_buf;
 458                 memcpy (dum->fifo_buf, _req->buf, _req->length);
 459                 req->req.context = dum;
 460                 req->req.complete = fifo_complete;
 461
 462                 spin_unlock (&dum->lock);
 463                 _req->actual = _req->length;
 464                 _req->status = 0;
 465                 _req->complete (_ep, _req);
 466                 spin_lock (&dum->lock);
 467         }
 468         list_add_tail (&req->queue, &ep->queue);
 469         spin_unlock_irqrestore (&dum->lock, flags);
 470
 471         /* real hardware would likely enable transfers here, in case
 472          * it'd been left NAKing.
 473          */
 474         return 0;
 475 }
 476
 477 static int dummy_dequeue (struct usb_ep *_ep, struct usb_request *_req)
 478 {
 479         struct dummy_ep         *ep;
 480         struct dummy            *dum;
 481         int                     retval = -EINVAL;
 482         unsigned long           flags;
 483         struct dummy_request    *req = 0;
 484
 485         if (!the_controller->driver)
 486                 return -ESHUTDOWN;
 487
 488         if (!_ep || !_req)
 489                 return retval;
 490         ep = container_of (_ep, struct dummy_ep, ep);
 491         dum = container_of (ep->gadget, struct dummy, gadget);
 492
 493         spin_lock_irqsave (&dum->lock, flags);
 494         list_for_each_entry (req, &ep->queue, queue) {
 495                 if (&req->req == _req) {
 496                         list_del_init (&req->queue);
 497                         _req->status = -ECONNRESET;
 498                         retval = 0;
 499                         break;
 500                 }
 501         }
 502         spin_unlock_irqrestore (&dum->lock, flags);
 503
 504         if (retval == 0) {
 505                 dev_dbg (hardware, "dequeued req %p from %s, len %d buf %p\n",
 506                                 req, _ep->name, _req->length, _req->buf);
 507
 508                 _req->complete (_ep, _req);
 509         }
 510         return retval;
 511 }
 512
 513 static int
 514 dummy_set_halt (struct usb_ep *_ep, int value)
 515 {
 516         struct dummy_ep         *ep;
 517
 518         if (!_ep)
 519                 return -EINVAL;
 520         if (!the_controller->driver)
 521                 return -ESHUTDOWN;
 522         ep = container_of (_ep, struct dummy_ep, ep);
 523         if (!value)
 524                 ep->halted = 0;
 525         else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
 526                         !list_empty (&ep->queue))
 527                 return -EAGAIN;
 528         else
 529                 ep->halted = 1;
 530         /* FIXME clear emulated data toggle too */
 531         return 0;
 532 }
 533
 534 static const struct usb_ep_ops dummy_ep_ops = {
 535         .enable         = dummy_enable,
 536         .disable        = dummy_disable,
 537
 538         .alloc_request  = dummy_alloc_request,
 539         .free_request   = dummy_free_request,
 540
 541         .alloc_buffer   = dummy_alloc_buffer,
 542         .free_buffer    = dummy_free_buffer,
 543         /* map, unmap, ... eventually hook the "generic" dma calls */
 544
 545         .queue          = dummy_queue,
 546         .dequeue        = dummy_dequeue,
 547
 548         .set_halt       = dummy_set_halt,
 549 };
 550
 551 /*-------------------------------------------------------------------------*/
 552
 553 /* there are both host and device side versions of this call ... */
 554 static int dummy_g_get_frame (struct usb_gadget *_gadget)
 555 {
 556         struct timeval  tv;
 557
 558         do_gettimeofday (&tv);
 559         return tv.tv_usec / 1000;
 560 }
 561
 562 static int dummy_wakeup (struct usb_gadget *_gadget)
 563 {
 564         struct dummy    *dum;
 565
 566         dum = container_of (_gadget, struct dummy, gadget);
 567         if ((dum->devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) == 0
 568                         || !(dum->port_status & (1 << USB_PORT_FEAT_SUSPEND)))
 569                 return -EINVAL;
 570
 571         /* hub notices our request, issues downstream resume, etc */
 572         dum->resuming = 1;
 573         dum->port_status |= (1 << USB_PORT_FEAT_C_SUSPEND);
 574         return 0;
 575 }
 576
 577 static int dummy_set_selfpowered (struct usb_gadget *_gadget, int value)
 578 {
 579         struct dummy    *dum;
 580
 581         dum = container_of (_gadget, struct dummy, gadget);
 582         if (value)
 583                 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
 584         else
 585                 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
 586         return 0;
 587 }
 588
 589 static const struct usb_gadget_ops dummy_ops = {
 590         .get_frame      = dummy_g_get_frame,
 591         .wakeup         = dummy_wakeup,
 592         .set_selfpowered = dummy_set_selfpowered,
 593 };
 594
 595 /*-------------------------------------------------------------------------*/
 596
 597 /* "function" sysfs attribute */
 598 static ssize_t
 599 show_function (struct device *_dev, char *buf)
 600 {
 601         struct dummy    *dum = the_controller;
 602
 603         if (!dum->driver->function
 604                         || strlen (dum->driver->function) > PAGE_SIZE)
 605                 return 0;
 606         return snprintf (buf, PAGE_SIZE, "%s\n", dum->driver->function);
 607 }
 608 DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
 609
 610 /*-------------------------------------------------------------------------*/
 611
 612 /*
 613  * Driver registration/unregistration.
 614  *
 615  * This is basically hardware-specific; there's usually only one real USB
 616  * device (not host) controller since that's how USB devices are intended
 617  * to work.  So most implementations of these api calls will rely on the
 618  * fact that only one driver will ever bind to the hardware.  But curious
 619  * hardware can be built with discrete components, so the gadget API doesn't
 620  * require that assumption.
 621  *
 622  * For this emulator, it might be convenient to create a usb slave device
 623  * for each driver that registers:  just add to a big root hub.
 624  */
 625
 626 static void
 627 dummy_udc_release (struct device *dev)
 628 {
 629         struct dummy    *dum = gadget_dev_to_dummy (dev);
 630
 631         complete (&dum->released);
 632 }
 633
 634 static void
 635 dummy_hc_release (struct device *dev)
 636 {
 637         struct dummy    *dum = dev_get_drvdata (dev);
 638
 639         complete (&dum->released);
 640 }
 641
 642 static int
 643 dummy_register_udc (struct dummy *dum)
 644 {
 645         int             rc;
 646
 647         strcpy (dum->gadget.dev.bus_id, "udc");
 648         dum->gadget.dev.parent = &dum->pdev.dev;
 649         dum->gadget.dev.release = dummy_udc_release;
 650
 651         rc = device_register (&dum->gadget.dev);
 652         if (rc == 0)
 653                 device_create_file (&dum->gadget.dev, &dev_attr_function);
 654         return rc;
 655 }
 656
 657 static void
 658 dummy_unregister_udc (struct dummy *dum)
 659 {
 660         device_remove_file (&dum->gadget.dev, &dev_attr_function);
 661         init_completion (&dum->released);
 662         device_unregister (&dum->gadget.dev);
 663         wait_for_completion (&dum->released);
 664 }
 665
 666 int
 667 usb_gadget_register_driver (struct usb_gadget_driver *driver)
 668 {
 669         struct dummy    *dum = the_controller;
 670         int             retval, i;
 671
 672         if (!dum)
 673                 return -EINVAL;
 674         if (dum->driver)
 675                 return -EBUSY;
 676         if (!driver->bind || !driver->unbind || !driver->setup
 677                         || driver->speed == USB_SPEED_UNKNOWN)
 678                 return -EINVAL;
 679
 680         /*
 681          * SLAVE side init ... the layer above hardware, which
 682          * can't enumerate without help from the driver we're binding.
 683          */
 684         dum->gadget.name = gadget_name;
 685         dum->gadget.ops = &dummy_ops;
 686         dum->gadget.is_dualspeed = 1;
 687
 688         dum->devstatus = 0;
 689         dum->resuming = 0;
 690
 691         INIT_LIST_HEAD (&dum->gadget.ep_list);
 692         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
 693                 struct dummy_ep *ep = &dum->ep [i];
 694
 695                 if (!ep_name [i])
 696                         break;
 697                 ep->ep.name = ep_name [i];
 698                 ep->ep.ops = &dummy_ep_ops;
 699                 list_add_tail (&ep->ep.ep_list, &dum->gadget.ep_list);
 700                 ep->halted = ep->already_seen = ep->setup_stage = 0;
 701                 ep->ep.maxpacket = ~0;
 702                 ep->last_io = jiffies;
 703                 ep->gadget = &dum->gadget;
 704                 ep->desc = 0;
 705                 INIT_LIST_HEAD (&ep->queue);
 706         }
 707
 708         dum->gadget.ep0 = &dum->ep [0].ep;
 709         dum->ep [0].ep.maxpacket = 64;
 710         list_del_init (&dum->ep [0].ep.ep_list);
 711         INIT_LIST_HEAD(&dum->fifo_req.queue);
 712
 713         dum->driver = driver;
 714         dum->gadget.dev.driver = &driver->driver;
 715         dev_dbg (hardware, "binding gadget driver '%s'\n", driver->driver.name);
 716         if ((retval = driver->bind (&dum->gadget)) != 0) {
 717                 dum->driver = 0;
 718                 dum->gadget.dev.driver = 0;
 719                 return retval;
 720         }
 721
 722         // FIXME: Check these calls for errors and re-order
 723         driver->driver.bus = dum->pdev.dev.bus;
 724         driver_register (&driver->driver);
 725
 726         device_bind_driver (&dum->gadget.dev);
 727
 728         /* khubd will enumerate this in a while */
 729         dum->port_status |= USB_PORT_STAT_CONNECTION
 730                 | (1 << USB_PORT_FEAT_C_CONNECTION);
 731         return 0;
 732 }
 733 EXPORT_SYMBOL (usb_gadget_register_driver);
 734
 735 /* caller must hold lock */
 736 static void
 737 stop_activity (struct dummy *dum, struct usb_gadget_driver *driver)
 738 {
 739         struct dummy_ep *ep;
 740
 741         /* prevent any more requests */
 742         dum->hdev = 0;
 743         dum->address = 0;
 744
 745         /* this might not succeed ... */
 746         del_timer (&dum->timer);
 747
 748         /* nuke any pending requests first, so driver i/o is quiesced */
 749         list_for_each_entry (ep, &dum->gadget.ep_list, ep.ep_list)
 750                 nuke (dum, ep);
 751
 752         /* driver now does any non-usb quiescing necessary */
 753         if (driver) {
 754                 spin_unlock (&dum->lock);
 755                 driver->disconnect (&dum->gadget);
 756                 spin_lock (&dum->lock);
 757         }
 758 }
 759
 760 int
 761 usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
 762 {
 763         struct dummy    *dum = the_controller;
 764         unsigned long   flags;
 765
 766         if (!dum)
 767                 return -ENODEV;
 768         if (!driver || driver != dum->driver)
 769                 return -EINVAL;
 770
 771         dev_dbg (hardware, "unregister gadget driver '%s'\n",
 772                         driver->driver.name);
 773
 774         spin_lock_irqsave (&dum->lock, flags);
 775         stop_activity (dum, driver);
 776         dum->port_status &= ~USB_PORT_STAT_CONNECTION;
 777         dum->port_status |= (1 << USB_PORT_FEAT_C_CONNECTION);
 778         spin_unlock_irqrestore (&dum->lock, flags);
 779
 780         driver->unbind (&dum->gadget);
 781         dum->driver = 0;
 782
 783         device_release_driver (&dum->gadget.dev);
 784
 785         driver_unregister (&driver->driver);
 786
 787         del_timer_sync (&dum->timer);
 788         return 0;
 789 }
 790 EXPORT_SYMBOL (usb_gadget_unregister_driver);
 791
 792 #undef is_enabled
 793
 794 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
 795 {
 796         return -ENOSYS;
 797 }
 798 EXPORT_SYMBOL (net2280_set_fifo_mode);
 799
 800 /*-------------------------------------------------------------------------*/
 801
 802 /* MASTER/HOST SIDE DRIVER
 803  *
 804  * this uses the hcd framework to hook up to host side drivers.
 805  * its root hub will only have one device, otherwise it acts like
 806  * a normal host controller.
 807  *
 808  * when urbs are queued, they're just stuck on a list that we
 809  * scan in a timer callback.  that callback connects writes from
 810  * the host with reads from the device, and so on, based on the
 811  * usb 2.0 rules.
 812  */
 813
 814 static int dummy_urb_enqueue (
 815         struct usb_hcd  *hcd,
 816         struct urb      *urb,
 817         int             mem_flags
 818 ) {
 819         struct dummy    *dum;
 820         unsigned long   flags;
 821
 822         /* patch to usb_sg_init() is in 2.5.60 */
 823         BUG_ON (!urb->transfer_buffer && urb->transfer_buffer_length);
 824
 825         dum = container_of (hcd, struct dummy, hcd);
 826         spin_lock_irqsave (&dum->lock, flags);
 827
 828         if (!dum->hdev)
 829                 dum->hdev = urb->dev->hcpriv;
 830         urb->hcpriv = dum;
 831         if (usb_pipetype (urb->pipe) == PIPE_CONTROL)
 832                 urb->error_count = 1;           /* mark as a new urb */
 833
 834         /* kick the scheduler, it'll do the rest */
 835         if (!timer_pending (&dum->timer))
 836                 mod_timer (&dum->timer, jiffies + 1);
 837
 838         spin_unlock_irqrestore (&dum->lock, flags);
 839         return 0;
 840 }
 841
 842 static int dummy_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
 843 {
 844         /* giveback happens automatically in timer callback */
 845         return 0;
 846 }
 847
 848 static void maybe_set_status (struct urb *urb, int status)
 849 {
 850         spin_lock (&urb->lock);
 851         if (urb->status == -EINPROGRESS)
 852                 urb->status = status;
 853         spin_unlock (&urb->lock);
 854 }
 855
 856 /* transfer up to a frame's worth; caller must own lock */
 857 static int
 858 transfer (struct dummy *dum, struct urb *urb, struct dummy_ep *ep, int limit)
 859 {
 860         struct dummy_request    *req;
 861
 862 top:
 863         /* if there's no request queued, the device is NAKing; return */
 864         list_for_each_entry (req, &ep->queue, queue) {
 865                 unsigned        host_len, dev_len, len;
 866                 int             is_short, to_host;
 867                 int             rescan = 0;
 868
 869                 /* 1..N packets of ep->ep.maxpacket each ... the last one
 870                  * may be short (including zero length).
 871                  *
 872                  * writer can send a zlp explicitly (length 0) or implicitly
 873                  * (length mod maxpacket zero, and 'zero' flag); they always
 874                  * terminate reads.
 875                  */
 876                 host_len = urb->transfer_buffer_length - urb->actual_length;
 877                 dev_len = req->req.length - req->req.actual;
 878                 len = min (host_len, dev_len);
 879
 880                 /* FIXME update emulated data toggle too */
 881
 882                 to_host = usb_pipein (urb->pipe);
 883                 if (unlikely (len == 0))
 884                         is_short = 1;
 885                 else {
 886                         char            *ubuf, *rbuf;
 887
 888                         /* not enough bandwidth left? */
 889                         if (limit < ep->ep.maxpacket && limit < len)
 890                                 break;
 891                         len = min (len, (unsigned) limit);
 892                         if (len == 0)
 893                                 break;
 894
 895                         /* use an extra pass for the final short packet */
 896                         if (len > ep->ep.maxpacket) {
 897                                 rescan = 1;
 898                                 len -= (len % ep->ep.maxpacket);
 899                         }
 900                         is_short = (len % ep->ep.maxpacket) != 0;
 901
 902                         /* else transfer packet(s) */
 903                         ubuf = urb->transfer_buffer + urb->actual_length;
 904                         rbuf = req->req.buf + req->req.actual;
 905                         if (to_host)
 906                                 memcpy (ubuf, rbuf, len);
 907                         else
 908                                 memcpy (rbuf, ubuf, len);
 909                         ep->last_io = jiffies;
 910
 911                         limit -= len;
 912                         urb->actual_length += len;
 913                         req->req.actual += len;
 914                 }
 915
 916                 /* short packets terminate, maybe with overflow/underflow.
 917                  * it's only really an error to write too much.
 918                  *
 919                  * partially filling a buffer optionally blocks queue advances
 920                  * (so completion handlers can clean up the queue) but we don't
 921                  * need to emulate such data-in-flight.  so we only show part
 922                  * of the URB_SHORT_NOT_OK effect: completion status.
 923                  */
 924                 if (is_short) {
 925                         if (host_len == dev_len) {
 926                                 req->req.status = 0;
 927                                 maybe_set_status (urb, 0);
 928                         } else if (to_host) {
 929                                 req->req.status = 0;
 930                                 if (dev_len > host_len)
 931                                         maybe_set_status (urb, -EOVERFLOW);
 932                                 else
 933                                         maybe_set_status (urb,
 934                                                 (urb->transfer_flags
 935                                                         & URB_SHORT_NOT_OK)
 936                                                 ? -EREMOTEIO : 0);
 937                         } else if (!to_host) {
 938                                 maybe_set_status (urb, 0);
 939                                 if (host_len > dev_len)
 940                                         req->req.status = -EOVERFLOW;
 941                                 else
 942                                         req->req.status = 0;
 943                         }
 944
 945                 /* many requests terminate without a short packet */
 946                 } else {
 947                         if (req->req.length == req->req.actual
 948                                         && !req->req.zero)
 949                                 req->req.status = 0;
 950                         if (urb->transfer_buffer_length == urb->actual_length
 951                                         && !(urb->transfer_flags
 952                                                 & URB_ZERO_PACKET)) {
 953                                 maybe_set_status (urb, 0);
 954                         }
 955                 }
 956
 957                 /* device side completion --> continuable */
 958                 if (req->req.status != -EINPROGRESS) {
 959                         list_del_init (&req->queue);
 960
 961                         spin_unlock (&dum->lock);
 962                         req->req.complete (&ep->ep, &req->req);
 963                         spin_lock (&dum->lock);
 964
 965                         /* requests might have been unlinked... */
 966                         rescan = 1;
 967                 }
 968
 969                 /* host side completion --> terminate */
 970                 if (urb->status != -EINPROGRESS)
 971                         break;
 972
 973                 /* rescan to continue with any other queued i/o */
 974                 if (rescan)
 975                         goto top;
 976         }
 977         return limit;
 978 }
 979
 980 static int periodic_bytes (struct dummy *dum, struct dummy_ep *ep)
 981 {
 982         int     limit = ep->ep.maxpacket;
 983
 984         if (dum->gadget.speed == USB_SPEED_HIGH) {
 985                 int     tmp;
 986
 987                 /* high bandwidth mode */
 988                 tmp = ep->desc->wMaxPacketSize;
 989                 tmp = le16_to_cpu (tmp);
 990                 tmp = (tmp >> 11) & 0x03;
 991                 tmp *= 8 /* applies to entire frame */;
 992                 limit += limit * tmp;
 993         }
 994         return limit;
 995 }
 996
 997 static struct dummy_ep *find_endpoint (struct dummy *dum, u8 address)
 998 {
 999         int             i;
1000
1001         if ((address & ~USB_DIR_IN) == 0)
1002                 return &dum->ep [0];
1003         for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1004                 struct dummy_ep *ep = &dum->ep [i];
1005
1006                 if (!ep->desc)
1007                         continue;
1008                 if (ep->desc->bEndpointAddress == address)
1009                         return ep;
1010         }
1011         return NULL;
1012 }
1013
1014 #define Dev_Request     (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1015 #define Dev_InRequest   (Dev_Request | USB_DIR_IN)
1016 #define Intf_Request    (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1017 #define Intf_InRequest  (Intf_Request | USB_DIR_IN)
1018 #define Ep_Request      (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1019 #define Ep_InRequest    (Ep_Request | USB_DIR_IN)
1020
1021 /* drive both sides of the transfers; looks like irq handlers to
1022  * both drivers except the callbacks aren't in_irq().
1023  */
1024 static void dummy_timer (unsigned long _dum)
1025 {
1026         struct dummy            *dum = (struct dummy *) _dum;
1027         struct hcd_dev          *hdev = dum->hdev;
1028         struct list_head        *entry, *tmp;
1029         unsigned long           flags;
1030         int                     limit, total;
1031         int                     i;
1032
1033         if (!hdev) {
1034                 dev_err (hardware, "timer fired with device gone?\n");
1035                 return;
1036         }
1037
1038         /* simplistic model for one frame's bandwidth */
1039         switch (dum->gadget.speed) {
1040         case USB_SPEED_LOW:
1041                 total = 8/*bytes*/ * 12/*packets*/;
1042                 break;
1043         case USB_SPEED_FULL:
1044                 total = 64/*bytes*/ * 19/*packets*/;
1045                 break;
1046         case USB_SPEED_HIGH:
1047                 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1048                 break;
1049         default:
1050                 dev_err (hardware, "bogus device speed\n");
1051                 return;
1052         }
1053
1054         /* FIXME if HZ != 1000 this will probably misbehave ... */
1055
1056         /* look at each urb queued by the host side driver */
1057         spin_lock_irqsave (&dum->lock, flags);
1058         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1059                 if (!ep_name [i])
1060                         break;
1061                 dum->ep [i].already_seen = 0;
1062         }
1063
1064 restart:
1065         list_for_each_safe (entry, tmp, &hdev->urb_list) {
1066                 struct urb              *urb;
1067                 struct dummy_request    *req;
1068                 u8                      address;
1069                 struct dummy_ep         *ep = 0;
1070                 int                     type;
1071
1072                 urb = list_entry (entry, struct urb, urb_list);
1073                 if (urb->status != -EINPROGRESS) {
1074                         /* likely it was just unlinked */
1075                         goto return_urb;
1076                 }
1077                 type = usb_pipetype (urb->pipe);
1078
1079                 /* used up this frame's non-periodic bandwidth?
1080                  * FIXME there's infinite bandwidth for control and
1081                  * periodic transfers ... unrealistic.
1082                  */
1083                 if (total <= 0 && type == PIPE_BULK)
1084                         continue;
1085
1086                 /* find the gadget's ep for this request (if configured) */
1087                 address = usb_pipeendpoint (urb->pipe);
1088                 if (usb_pipein (urb->pipe))
1089                         address |= USB_DIR_IN;
1090                 ep = find_endpoint(dum, address);
1091                 if (!ep) {
1092                         /* set_configuration() disagreement */
1093                         dev_err (hardware,
1094                                 "no ep configured for urb %p\n",
1095                                 urb);
1096                         maybe_set_status (urb, -ETIMEDOUT);
1097                         goto return_urb;
1098                 }
1099
1100                 if (ep->already_seen)
1101                         continue;
1102                 ep->already_seen = 1;
1103                 if (ep == &dum->ep [0] && urb->error_count) {
1104                         ep->setup_stage = 1;    /* a new urb */
1105                         urb->error_count = 0;
1106                 }
1107                 if (ep->halted && !ep->setup_stage) {
1108                         /* NOTE: must not be iso! */
1109                         dev_dbg (hardware, "ep %s halted, urb %p\n",
1110                                         ep->ep.name, urb);
1111                         maybe_set_status (urb, -EPIPE);
1112                         goto return_urb;
1113                 }
1114                 /* FIXME make sure both ends agree on maxpacket */
1115
1116                 /* handle control requests */
1117                 if (ep == &dum->ep [0] && ep->setup_stage) {
1118                         struct usb_ctrlrequest          setup;
1119                         int                             value = 1;
1120                         struct dummy_ep                 *ep2;
1121
1122                         setup = *(struct usb_ctrlrequest*) urb->setup_packet;
1123                         le16_to_cpus (&setup.wIndex);
1124                         le16_to_cpus (&setup.wValue);
1125                         le16_to_cpus (&setup.wLength);
1126                         if (setup.wLength != urb->transfer_buffer_length) {
1127                                 maybe_set_status (urb, -EOVERFLOW);
1128                                 goto return_urb;
1129                         }
1130
1131                         /* paranoia, in case of stale queued data */
1132                         list_for_each_entry (req, &ep->queue, queue) {
1133                                 list_del_init (&req->queue);
1134                                 req->req.status = -EOVERFLOW;
1135                                 dev_dbg (hardware, "stale req = %p\n", req);
1136
1137                                 spin_unlock (&dum->lock);
1138                                 req->req.complete (&ep->ep, &req->req);
1139                                 spin_lock (&dum->lock);
1140                                 ep->already_seen = 0;
1141                                 goto restart;
1142                         }
1143
1144                         /* gadget driver never sees set_address or operations
1145                          * on standard feature flags.  some hardware doesn't
1146                          * even expose them.
1147                          */
1148                         ep->last_io = jiffies;
1149                         ep->setup_stage = 0;
1150                         ep->halted = 0;
1151                         switch (setup.bRequest) {
1152                         case USB_REQ_SET_ADDRESS:
1153                                 if (setup.bRequestType != Dev_Request)
1154                                         break;
1155                                 if (dum->address != 0) {
1156                                         maybe_set_status (urb, -ETIMEDOUT);
1157                                         urb->actual_length = 0;
1158                                         goto return_urb;
1159                                 }
1160                                 dum->address = setup.wValue;
1161                                 maybe_set_status (urb, 0);
1162                                 dev_dbg (hardware, "set_address = %d\n",
1163                                                 setup.wValue);
1164                                 value = 0;
1165                                 break;
1166                         case USB_REQ_SET_FEATURE:
1167                                 if (setup.bRequestType == Dev_Request) {
1168                                         value = 0;
1169                                         switch (setup.wValue) {
1170                                         case USB_DEVICE_REMOTE_WAKEUP:
1171                                                 break;
1172                                         default:
1173                                                 value = -EOPNOTSUPP;
1174                                         }
1175                                         if (value == 0) {
1176                                                 dum->devstatus |=
1177                                                         (1 << setup.wValue);
1178                                                 maybe_set_status (urb, 0);
1179                                         }
1180
1181                                 } else if (setup.bRequestType == Ep_Request) {
1182                                         // endpoint halt
1183                                         ep2 = find_endpoint (dum,
1184                                                         setup.wIndex);
1185                                         if (!ep2) {
1186                                                 value = -EOPNOTSUPP;
1187                                                 break;
1188                                         }
1189                                         ep2->halted = 1;
1190                                         value = 0;
1191                                         maybe_set_status (urb, 0);
1192                                 }
1193                                 break;
1194                         case USB_REQ_CLEAR_FEATURE:
1195                                 if (setup.bRequestType == Dev_Request) {
1196                                         switch (setup.wValue) {
1197                                         case USB_DEVICE_REMOTE_WAKEUP:
1198                                                 dum->devstatus &= ~(1 <<
1199                                                         USB_DEVICE_REMOTE_WAKEUP);
1200                                                 value = 0;
1201                                                 maybe_set_status (urb, 0);
1202                                                 break;
1203                                         default:
1204                                                 value = -EOPNOTSUPP;
1205                                                 break;
1206                                         }
1207                                 } else if (setup.bRequestType == Ep_Request) {
1208                                         // endpoint halt
1209                                         ep2 = find_endpoint (dum,
1210                                                         setup.wIndex);
1211                                         if (!ep2) {
1212                                                 value = -EOPNOTSUPP;
1213                                                 break;
1214                                         }
1215                                         ep2->halted = 0;
1216                                         value = 0;
1217                                         maybe_set_status (urb, 0);
1218                                 }
1219                                 break;
1220                         case USB_REQ_GET_STATUS:
1221                                 if (setup.bRequestType == Dev_InRequest
1222                                                 || setup.bRequestType
1223                                                         == Intf_InRequest
1224                                                 || setup.bRequestType
1225                                                         == Ep_InRequest
1226                                                 ) {
1227                                         char *buf;
1228
1229                                         // device: remote wakeup, selfpowered
1230                                         // interface: nothing
1231                                         // endpoint: halt
1232                                         buf = (char *)urb->transfer_buffer;
1233                                         if (urb->transfer_buffer_length > 0) {
1234                                                 if (setup.bRequestType ==
1235                                                                 Ep_InRequest) {
1236         ep2 = find_endpoint (dum, setup.wIndex);
1237         if (!ep2) {
1238                 value = -EOPNOTSUPP;
1239                 break;
1240         }
1241         buf [0] = ep2->halted;
1242                                                 } else if (setup.bRequestType ==
1243                                                                 Dev_InRequest) {
1244                                                         buf [0] = (u8)
1245                                                                 dum->devstatus;
1246                                                 } else
1247                                                         buf [0] = 0;
1248                                         }
1249                                         if (urb->transfer_buffer_length > 1)
1250                                                 buf [1] = 0;
1251                                         urb->actual_length = min (2,
1252                                                 urb->transfer_buffer_length);
1253                                         value = 0;
1254                                         maybe_set_status (urb, 0);
1255                                 }
1256                                 break;
1257                         }
1258
1259                         /* gadget driver handles all other requests.  block
1260                          * until setup() returns; no reentrancy issues etc.
1261                          */
1262                         if (value > 0) {
1263                                 spin_unlock (&dum->lock);
1264                                 value = dum->driver->setup (&dum->gadget,
1265                                                 &setup);
1266                                 spin_lock (&dum->lock);
1267
1268                                 if (value >= 0) {
1269                                         /* no delays (max 64KB data stage) */
1270                                         limit = 64*1024;
1271                                         goto treat_control_like_bulk;
1272                                 }
1273                                 /* error, see below */
1274                         }
1275
1276                         if (value < 0) {
1277                                 if (value != -EOPNOTSUPP)
1278                                         dev_dbg (hardware,
1279                                                 "setup --> %d\n",
1280                                                 value);
1281                                 maybe_set_status (urb, -EPIPE);
1282                                 urb->actual_length = 0;
1283                         }
1284
1285                         goto return_urb;
1286                 }
1287
1288                 /* non-control requests */
1289                 limit = total;
1290                 switch (usb_pipetype (urb->pipe)) {
1291                 case PIPE_ISOCHRONOUS:
1292                         /* FIXME is it urb->interval since the last xfer?
1293                          * use urb->iso_frame_desc[i].
1294                          * complete whether or not ep has requests queued.
1295                          * report random errors, to debug drivers.
1296                          */
1297                         limit = max (limit, periodic_bytes (dum, ep));
1298                         maybe_set_status (urb, -ENOSYS);
1299                         break;
1300
1301                 case PIPE_INTERRUPT:
1302                         /* FIXME is it urb->interval since the last xfer?
1303                          * this almost certainly polls too fast.
1304                          */
1305                         limit = max (limit, periodic_bytes (dum, ep));
1306                         /* FALLTHROUGH */
1307
1308                 // case PIPE_BULK:  case PIPE_CONTROL:
1309                 default:
1310                 treat_control_like_bulk:
1311                         ep->last_io = jiffies;
1312                         total = transfer (dum, urb, ep, limit);
1313                         break;
1314                 }
1315
1316                 /* incomplete transfer? */
1317                 if (urb->status == -EINPROGRESS)
1318                         continue;
1319
1320 return_urb:
1321                 urb->hcpriv = 0;
1322                 if (ep)
1323                         ep->already_seen = ep->setup_stage = 0;
1324
1325                 spin_unlock (&dum->lock);
1326                 usb_hcd_giveback_urb (&dum->hcd, urb, 0);
1327                 spin_lock (&dum->lock);
1328
1329                 goto restart;
1330         }
1331
1332         /* want a 1 msec delay here */
1333         if (!list_empty (&hdev->urb_list))
1334                 mod_timer (&dum->timer, jiffies + 1);
1335
1336         spin_unlock_irqrestore (&dum->lock, flags);
1337 }
1338
1339 /*-------------------------------------------------------------------------*/
1340
1341 #define PORT_C_MASK \
1342          ((1 << USB_PORT_FEAT_C_CONNECTION) \
1343         | (1 << USB_PORT_FEAT_C_ENABLE) \
1344         | (1 << USB_PORT_FEAT_C_SUSPEND) \
1345         | (1 << USB_PORT_FEAT_C_OVER_CURRENT) \
1346         | (1 << USB_PORT_FEAT_C_RESET))
1347
1348 static int dummy_hub_status (struct usb_hcd *hcd, char *buf)
1349 {
1350         struct dummy            *dum;
1351         unsigned long           flags;
1352         int                     retval;
1353
1354         dum = container_of (hcd, struct dummy, hcd);
1355
1356         spin_lock_irqsave (&dum->lock, flags);
1357         if (!(dum->port_status & PORT_C_MASK))
1358                 retval = 0;
1359         else {
1360                 *buf = (1 << 1);
1361                 dev_dbg (hardware, "port status 0x%08x has changes\n",
1362                         dum->port_status);
1363                 retval = 1;
1364         }
1365         spin_unlock_irqrestore (&dum->lock, flags);
1366         return retval;
1367 }
1368
1369 static inline void
1370 hub_descriptor (struct usb_hub_descriptor *desc)
1371 {
1372         memset (desc, 0, sizeof *desc);
1373         desc->bDescriptorType = 0x29;
1374         desc->bDescLength = 9;
1375         desc->wHubCharacteristics = __constant_cpu_to_le16 (0x0001);
1376         desc->bNbrPorts = 1;
1377         desc->bitmap [0] = 0xff;
1378         desc->bitmap [1] = 0xff;
1379 }
1380
1381 static int dummy_hub_control (
1382         struct usb_hcd  *hcd,
1383         u16             typeReq,
1384         u16             wValue,
1385         u16             wIndex,
1386         char            *buf,
1387         u16             wLength
1388 ) {
1389         struct dummy    *dum;
1390         int             retval = 0;
1391         unsigned long   flags;
1392
1393         dum = container_of (hcd, struct dummy, hcd);
1394         spin_lock_irqsave (&dum->lock, flags);
1395         switch (typeReq) {
1396         case ClearHubFeature:
1397                 break;
1398         case ClearPortFeature:
1399                 switch (wValue) {
1400                 case USB_PORT_FEAT_SUSPEND:
1401                         /* 20msec resume signaling */
1402                         dum->resuming = 1;
1403                         dum->re_timeout = jiffies + ((HZ * 20)/1000);
1404                         break;
1405                 case USB_PORT_FEAT_POWER:
1406                         dum->port_status = 0;
1407                         dum->address = 0;
1408                         dum->hdev = 0;
1409                         dum->resuming = 0;
1410                         break;
1411                 default:
1412                         dum->port_status &= ~(1 << wValue);
1413                 }
1414                 break;
1415         case GetHubDescriptor:
1416                 hub_descriptor ((struct usb_hub_descriptor *) buf);
1417                 break;
1418         case GetHubStatus:
1419                 *(u32 *) buf = __constant_cpu_to_le32 (0);
1420                 break;
1421         case GetPortStatus:
1422                 if (wIndex != 1)
1423                         retval = -EPIPE;
1424
1425                 /* whoever resets or resumes must GetPortStatus to
1426                  * complete it!!
1427                  */
1428                 if (dum->resuming && time_after (jiffies, dum->re_timeout)) {
1429                         dum->port_status |= (1 << USB_PORT_FEAT_C_SUSPEND);
1430                         dum->port_status &= ~(1 << USB_PORT_FEAT_SUSPEND);
1431                         dum->resuming = 0;
1432                         dum->re_timeout = 0;
1433                         if (dum->driver->resume) {
1434                                 spin_unlock (&dum->lock);
1435                                 dum->driver->resume (&dum->gadget);
1436                                 spin_lock (&dum->lock);
1437                         }
1438                 }
1439                 if ((dum->port_status & (1 << USB_PORT_FEAT_RESET)) != 0
1440                                 && time_after (jiffies, dum->re_timeout)) {
1441                         dum->port_status |= (1 << USB_PORT_FEAT_C_RESET);
1442                         dum->port_status &= ~(1 << USB_PORT_FEAT_RESET);
1443                         dum->re_timeout = 0;
1444                         if (dum->driver) {
1445                                 dum->port_status |= USB_PORT_STAT_ENABLE;
1446                                 /* give it the best speed we agree on */
1447                                 dum->gadget.speed = dum->driver->speed;
1448                                 dum->gadget.ep0->maxpacket = 64;
1449                                 switch (dum->gadget.speed) {
1450                                 case USB_SPEED_HIGH:
1451                                         dum->port_status |=
1452                                                 USB_PORT_STAT_HIGH_SPEED;
1453                                         break;
1454                                 case USB_SPEED_LOW:
1455                                         dum->gadget.ep0->maxpacket = 8;
1456                                         dum->port_status |=
1457                                                 USB_PORT_STAT_LOW_SPEED;
1458                                         break;
1459                                 default:
1460                                         dum->gadget.speed = USB_SPEED_FULL;
1461                                         break;
1462                                 }
1463                         }
1464                 }
1465                 ((u16 *) buf)[0] = cpu_to_le16 (dum->port_status);
1466                 ((u16 *) buf)[1] = cpu_to_le16 (dum->port_status >> 16);
1467                 break;
1468         case SetHubFeature:
1469                 retval = -EPIPE;
1470                 break;
1471         case SetPortFeature:
1472                 switch (wValue) {
1473                 case USB_PORT_FEAT_SUSPEND:
1474                         dum->port_status |= (1 << USB_PORT_FEAT_SUSPEND);
1475                         if (dum->driver->suspend) {
1476                                 spin_unlock (&dum->lock);
1477                                 dum->driver->suspend (&dum->gadget);
1478                                 spin_lock (&dum->lock);
1479                         }
1480                         break;
1481                 case USB_PORT_FEAT_RESET:
1482                         /* if it's already running, disconnect first */
1483                         if (dum->port_status & USB_PORT_STAT_ENABLE) {
1484                                 dum->port_status &= ~(USB_PORT_STAT_ENABLE
1485                                                 | USB_PORT_STAT_LOW_SPEED
1486                                                 | USB_PORT_STAT_HIGH_SPEED);
1487                                 if (dum->driver) {
1488                                         dev_dbg (hardware, "disconnect\n");
1489                                         stop_activity (dum, dum->driver);
1490                                 }
1491
1492                                 /* FIXME test that code path! */
1493                         }
1494                         /* 50msec reset signaling */
1495                         dum->re_timeout = jiffies + ((HZ * 50)/1000);
1496                         /* FALLTHROUGH */
1497                 default:
1498                         dum->port_status |= (1 << wValue);
1499                 }
1500                 break;
1501
1502         default:
1503                 dev_dbg (hardware,
1504                         "hub control req%04x v%04x i%04x l%d\n",
1505                         typeReq, wValue, wIndex, wLength);
1506
1507                 /* "protocol stall" on error */
1508                 retval = -EPIPE;
1509         }
1510         spin_unlock_irqrestore (&dum->lock, flags);
1511         return retval;
1512 }
1513
1514
1515 /*-------------------------------------------------------------------------*/
1516
1517 static struct usb_hcd *dummy_alloc (void)
1518 {
1519         struct dummy            *dum;
1520
1521         dum = kmalloc (sizeof *dum, SLAB_KERNEL);
1522         if (dum == NULL)
1523                 return 0;
1524         memset (dum, 0, sizeof *dum);
1525         return &dum->hcd;
1526 }
1527
1528 static void dummy_free (struct usb_hcd *hcd)
1529 {
1530         struct dummy            *dum;
1531
1532         dum = container_of (hcd, struct dummy, hcd);
1533         WARN_ON (dum->driver != 0);
1534         kfree (dum);
1535 }
1536
1537 /*-------------------------------------------------------------------------*/
1538
1539 static inline ssize_t
1540 show_urb (char *buf, size_t size, struct urb *urb)
1541 {
1542         int ep = usb_pipeendpoint (urb->pipe);
1543
1544         return snprintf (buf, size,
1545                 "urb/%p %s ep%d%s%s len %d/%d\n",
1546                 urb,
1547                 ({ char *s;
1548                  switch (urb->dev->speed) {
1549                  case USB_SPEED_LOW:    s = "ls"; break;
1550                  case USB_SPEED_FULL:   s = "fs"; break;
1551                  case USB_SPEED_HIGH:   s = "hs"; break;
1552                  default:               s = "?"; break;
1553                  }; s; }),
1554                 ep, ep ? (usb_pipein (urb->pipe) ? "in" : "out") : "",
1555                 ({ char *s; \
1556                  switch (usb_pipetype (urb->pipe)) { \
1557                  case PIPE_CONTROL:     s = ""; break; \
1558                  case PIPE_BULK:        s = "-bulk"; break; \
1559                  case PIPE_INTERRUPT:   s = "-int"; break; \
1560                  default:               s = "-iso"; break; \
1561                 }; s;}),
1562                 urb->actual_length, urb->transfer_buffer_length);
1563 }
1564
1565 static ssize_t
1566 show_urbs (struct device *dev, char *buf)
1567 {
1568         struct dummy            *dum = dev_get_drvdata(dev);
1569         struct urb              *urb;
1570         size_t                  size = 0;
1571         unsigned long           flags;
1572
1573         spin_lock_irqsave (&dum->lock, flags);
1574         if (dum->hdev) {
1575                 list_for_each_entry (urb, &dum->hdev->urb_list, urb_list) {
1576                         size_t          temp;
1577
1578                         temp = show_urb (buf, PAGE_SIZE - size, urb);
1579                         buf += temp;
1580                         size += temp;
1581                 }
1582         }
1583         spin_unlock_irqrestore (&dum->lock, flags);
1584
1585         return size;
1586 }
1587 static DEVICE_ATTR (urbs, S_IRUGO, show_urbs, NULL);
1588
1589
1590 static const struct hc_driver dummy_hcd;
1591
1592 static int dummy_start (struct usb_hcd *hcd)
1593 {
1594         struct dummy            *dum;
1595         struct usb_bus          *bus;
1596         struct usb_device       *root;
1597         int                     retval;
1598
1599         dum = container_of (hcd, struct dummy, hcd);
1600
1601         /*
1602          * MASTER side init ... we emulate a root hub that'll only ever
1603          * talk to one device (the slave side).  Also appears in sysfs,
1604          * just like more familiar pci-based HCDs.
1605          */
1606         spin_lock_init (&dum->lock);
1607
1608         retval = driver_register (&dummy_driver);
1609         if (retval < 0)
1610                 return retval;
1611
1612         dum->pdev.name = "hc";
1613         dum->pdev.dev.driver = &dummy_driver;
1614         dev_set_drvdata(&dum->pdev.dev, dum);
1615         dum->pdev.dev.release = dummy_hc_release;
1616         retval = platform_device_register (&dum->pdev);
1617         if (retval < 0) {
1618                 driver_unregister (&dummy_driver);
1619                 return retval;
1620         }
1621         dev_info (&dum->pdev.dev, "%s, driver " DRIVER_VERSION "\n",
1622                         driver_desc);
1623
1624         hcd->self.controller = &dum->pdev.dev;
1625
1626         /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
1627         device_create_file (hcd->self.controller, &dev_attr_urbs);
1628
1629         init_timer (&dum->timer);
1630         dum->timer.function = dummy_timer;
1631         dum->timer.data = (unsigned long) dum;
1632
1633         /* root hub will appear as another device */
1634         dum->hcd.driver = (struct hc_driver *) &dummy_hcd;
1635         dum->hcd.description = dummy_hcd.description;
1636         dum->hcd.product_desc = "Dummy host controller";
1637
1638         bus = hcd_to_bus (&dum->hcd);
1639         bus->bus_name = dum->pdev.dev.bus_id;
1640         usb_bus_init (bus);
1641         bus->op = &usb_hcd_operations;
1642         bus->hcpriv = &dum->hcd;
1643
1644         /* FIXME don't require the pci-based buffer/alloc impls;
1645          * the "generic dma" implementation still requires them,
1646          * it's not very generic yet.
1647          */
1648         if ((retval = hcd_buffer_create (&dum->hcd)) != 0) {
1649 clean0:
1650                 init_completion (&dum->released);
1651                 platform_device_unregister (&dum->pdev);
1652                 wait_for_completion (&dum->released);
1653                 driver_unregister (&dummy_driver);
1654                 return retval;
1655         }
1656
1657         INIT_LIST_HEAD (&hcd->dev_list);
1658         usb_register_bus (bus);
1659
1660         bus->root_hub = root = usb_alloc_dev (0, bus, 0);
1661         if (!root) {
1662                 retval = -ENOMEM;
1663 clean1:
1664                 hcd_buffer_destroy (&dum->hcd);
1665                 usb_deregister_bus (bus);
1666                 goto clean0;
1667         }
1668
1669         /* root hub enters addressed state... */
1670         dum->hcd.state = USB_STATE_RUNNING;
1671         root->speed = USB_SPEED_HIGH;
1672
1673         /* ...then configured, so khubd sees us. */
1674         if ((retval = hcd_register_root (&dum->hcd)) != 0) {
1675                 bus->root_hub = 0;
1676                 usb_put_dev (root);
1677 clean2:
1678                 dum->hcd.state = USB_STATE_QUIESCING;
1679                 goto clean1;
1680         }
1681
1682         dum->started = 1;
1683
1684         if ((retval = dummy_register_udc (dum)) != 0) {
1685                 dum->started = 0;
1686                 usb_disconnect (&bus->root_hub);
1687                 goto clean2;
1688         }
1689         return 0;
1690 }
1691
1692 static void dummy_stop (struct usb_hcd *hcd)
1693 {
1694         struct dummy            *dum;
1695         struct usb_bus          *bus;
1696
1697         dum = container_of (hcd, struct dummy, hcd);
1698         if (!dum->started)
1699                 return;
1700         dum->started = 0;
1701
1702         usb_gadget_unregister_driver (dum->driver);
1703         dummy_unregister_udc (dum);
1704
1705         bus = hcd_to_bus (&dum->hcd);
1706         hcd->state = USB_STATE_QUIESCING;
1707         dev_dbg (hardware, "remove root hub\n");
1708         usb_disconnect (&bus->root_hub);
1709
1710         hcd_buffer_destroy (&dum->hcd);
1711         usb_deregister_bus (bus);
1712
1713         dev_info (hardware, "stopped\n");
1714
1715         device_remove_file (hcd->self.controller, &dev_attr_urbs);
1716         init_completion (&dum->released);
1717         platform_device_unregister (&dum->pdev);
1718         wait_for_completion (&dum->released);
1719
1720         driver_unregister (&dummy_driver);
1721 }
1722
1723 /*-------------------------------------------------------------------------*/
1724
1725 static int dummy_h_get_frame (struct usb_hcd *hcd)
1726 {
1727         return dummy_g_get_frame (0);
1728 }
1729
1730 static const struct hc_driver dummy_hcd = {
1731         .description =          (char *) driver_name,
1732         .flags =                HCD_USB2,
1733
1734         .start =                dummy_start,
1735         .stop =                 dummy_stop,
1736
1737         .hcd_alloc =            dummy_alloc,
1738         .hcd_free =             dummy_free,
1739
1740         .urb_enqueue =          dummy_urb_enqueue,
1741         .urb_dequeue =          dummy_urb_dequeue,
1742
1743         .get_frame_number =     dummy_h_get_frame,
1744
1745         .hub_status_data =      dummy_hub_status,
1746         .hub_control =          dummy_hub_control,
1747 };
1748
1749 /*-------------------------------------------------------------------------*/
1750
1751 static int __init init (void)
1752 {
1753         struct usb_hcd          *hcd;
1754         int                     value;
1755
1756         if (usb_disabled ())
1757                 return -ENODEV;
1758         if ((hcd = dummy_alloc ()) == 0)
1759                 return -ENOMEM;
1760
1761         the_controller = container_of (hcd, struct dummy, hcd);
1762         value = dummy_start (hcd);
1763
1764         if (value != 0) {
1765                 dummy_free (hcd);
1766                 the_controller = 0;
1767         }
1768         return value;
1769 }
1770 module_init (init);
1771
1772 static void __exit cleanup (void)
1773 {
1774         dummy_stop (&the_controller->hcd);
1775         dummy_free (&the_controller->hcd);
1776         the_controller = 0;
1777 }
1778 module_exit (cleanup);
1779