drivers/usb/gadget/udc/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-2005 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
  15
  16 /*
  17  * This exposes a device side "USB gadget" API, driven by requests to a
  18  * Linux-USB host controller driver.  USB traffic is simulated; there's
  19  * no need for USB hardware.  Use this with two other drivers:
  20  *
  21  *  - Gadget driver, responding to requests (slave);
  22  *  - Host-side device driver, as already familiar in Linux.
  23  *
  24  * Having this all in one kernel can help some stages of development,
  25  * bypassing some hardware (and driver) issues.  UML could help too.
  26  */
  27
  28 #include <linux/module.h>
  29 #include <linux/kernel.h>
  30 #include <linux/delay.h>
  31 #include <linux/ioport.h>
  32 #include <linux/slab.h>
  33 #include <linux/errno.h>
  34 #include <linux/init.h>
  35 #include <linux/timer.h>
  36 #include <linux/list.h>
  37 #include <linux/interrupt.h>
  38 #include <linux/platform_device.h>
  39 #include <linux/usb.h>
  40 #include <linux/usb/gadget.h>
  41 #include <linux/usb/hcd.h>
  42 #include <linux/scatterlist.h>
  43
  44 #include <asm/byteorder.h>
  45 #include <linux/io.h>
  46 #include <asm/irq.h>
  47 #include <asm/unaligned.h>
  48
  49 #define DRIVER_DESC     "USB Host+Gadget Emulator"
  50 #define DRIVER_VERSION  "02 May 2005"
  51
  52 #define POWER_BUDGET    500     /* in mA; use 8 for low-power port testing */
  53
  54 static const char       driver_name[] = "dummy_hcd";
  55 static const char       driver_desc[] = "USB Host+Gadget Emulator";
  56
  57 static const char       gadget_name[] = "dummy_udc";
  58
  59 MODULE_DESCRIPTION(DRIVER_DESC);
  60 MODULE_AUTHOR("David Brownell");
  61 MODULE_LICENSE("GPL");
  62
  63 struct dummy_hcd_module_parameters {
  64         bool is_super_speed;
  65         bool is_high_speed;
  66         unsigned int num;
  67 };
  68
  69 static struct dummy_hcd_module_parameters mod_data = {
  70         .is_super_speed = false,
  71         .is_high_speed = true,
  72         .num = 1,
  73 };
  74 module_param_named(is_super_speed, mod_data.is_super_speed, bool, S_IRUGO);
  75 MODULE_PARM_DESC(is_super_speed, "true to simulate SuperSpeed connection");
  76 module_param_named(is_high_speed, mod_data.is_high_speed, bool, S_IRUGO);
  77 MODULE_PARM_DESC(is_high_speed, "true to simulate HighSpeed connection");
  78 module_param_named(num, mod_data.num, uint, S_IRUGO);
  79 MODULE_PARM_DESC(num, "number of emulated controllers");
  80 /*-------------------------------------------------------------------------*/
  81
  82 /* gadget side driver data structres */
  83 struct dummy_ep {
  84         struct list_head                queue;
  85         unsigned long                   last_io;        /* jiffies timestamp */
  86         struct usb_gadget               *gadget;
  87         const struct usb_endpoint_descriptor *desc;
  88         struct usb_ep                   ep;
  89         unsigned                        halted:1;
  90         unsigned                        wedged:1;
  91         unsigned                        already_seen:1;
  92         unsigned                        setup_stage:1;
  93         unsigned                        stream_en:1;
  94 };
  95
  96 struct dummy_request {
  97         struct list_head                queue;          /* ep's requests */
  98         struct usb_request              req;
  99 };
 100
 101 static inline struct dummy_ep *usb_ep_to_dummy_ep(struct usb_ep *_ep)
 102 {
 103         return container_of(_ep, struct dummy_ep, ep);
 104 }
 105
 106 static inline struct dummy_request *usb_request_to_dummy_request
 107                 (struct usb_request *_req)
 108 {
 109         return container_of(_req, struct dummy_request, req);
 110 }
 111
 112 /*-------------------------------------------------------------------------*/
 113
 114 /*
 115  * Every device has ep0 for control requests, plus up to 30 more endpoints,
 116  * in one of two types:
 117  *
 118  *   - Configurable:  direction (in/out), type (bulk, iso, etc), and endpoint
 119  *     number can be changed.  Names like "ep-a" are used for this type.
 120  *
 121  *   - Fixed Function:  in other cases.  some characteristics may be mutable;
 122  *     that'd be hardware-specific.  Names like "ep12out-bulk" are used.
 123  *
 124  * Gadget drivers are responsible for not setting up conflicting endpoint
 125  * configurations, illegal or unsupported packet lengths, and so on.
 126  */
 127
 128 static const char ep0name[] = "ep0";
 129
 130 static const struct {
 131         const char *name;
 132         const struct usb_ep_caps caps;
 133 } ep_info[] = {
 134 #define EP_INFO(_name, _caps) \
 135         { \
 136                 .name = _name, \
 137                 .caps = _caps, \
 138         }
 139
 140         /* everyone has ep0 */
 141         EP_INFO(ep0name,
 142                 USB_EP_CAPS(USB_EP_CAPS_TYPE_CONTROL, USB_EP_CAPS_DIR_ALL)),
 143         /* act like a pxa250: fifteen fixed function endpoints */
 144         EP_INFO("ep1in-bulk",
 145                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
 146         EP_INFO("ep2out-bulk",
 147                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
 148         EP_INFO("ep3in-iso",
 149                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
 150         EP_INFO("ep4out-iso",
 151                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
 152         EP_INFO("ep5in-int",
 153                 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
 154         EP_INFO("ep6in-bulk",
 155                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
 156         EP_INFO("ep7out-bulk",
 157                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
 158         EP_INFO("ep8in-iso",
 159                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
 160         EP_INFO("ep9out-iso",
 161                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
 162         EP_INFO("ep10in-int",
 163                 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
 164         EP_INFO("ep11in-bulk",
 165                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
 166         EP_INFO("ep12out-bulk",
 167                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
 168         EP_INFO("ep13in-iso",
 169                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
 170         EP_INFO("ep14out-iso",
 171                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
 172         EP_INFO("ep15in-int",
 173                 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
 174         /* or like sa1100: two fixed function endpoints */
 175         EP_INFO("ep1out-bulk",
 176                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
 177         EP_INFO("ep2in-bulk",
 178                 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
 179         /* and now some generic EPs so we have enough in multi config */
 180         EP_INFO("ep3out",
 181                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 182         EP_INFO("ep4in",
 183                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
 184         EP_INFO("ep5out",
 185                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 186         EP_INFO("ep6out",
 187                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 188         EP_INFO("ep7in",
 189                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
 190         EP_INFO("ep8out",
 191                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 192         EP_INFO("ep9in",
 193                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
 194         EP_INFO("ep10out",
 195                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 196         EP_INFO("ep11out",
 197                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 198         EP_INFO("ep12in",
 199                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
 200         EP_INFO("ep13out",
 201                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 202         EP_INFO("ep14in",
 203                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
 204         EP_INFO("ep15out",
 205                 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
 206
 207 #undef EP_INFO
 208 };
 209
 210 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_info)
 211
 212 /*-------------------------------------------------------------------------*/
 213
 214 #define FIFO_SIZE               64
 215
 216 struct urbp {
 217         struct urb              *urb;
 218         struct list_head        urbp_list;
 219         struct sg_mapping_iter  miter;
 220         u32                     miter_started;
 221 };
 222
 223
 224 enum dummy_rh_state {
 225         DUMMY_RH_RESET,
 226         DUMMY_RH_SUSPENDED,
 227         DUMMY_RH_RUNNING
 228 };
 229
 230 struct dummy_hcd {
 231         struct dummy                    *dum;
 232         enum dummy_rh_state             rh_state;
 233         struct timer_list               timer;
 234         u32                             port_status;
 235         u32                             old_status;
 236         unsigned long                   re_timeout;
 237
 238         struct usb_device               *udev;
 239         struct list_head                urbp_list;
 240         u32                             stream_en_ep;
 241         u8                              num_stream[30 / 2];
 242
 243         unsigned                        active:1;
 244         unsigned                        old_active:1;
 245         unsigned                        resuming:1;
 246 };
 247
 248 struct dummy {
 249         spinlock_t                      lock;
 250
 251         /*
 252          * SLAVE/GADGET side support
 253          */
 254         struct dummy_ep                 ep[DUMMY_ENDPOINTS];
 255         int                             address;
 256         struct usb_gadget               gadget;
 257         struct usb_gadget_driver        *driver;
 258         struct dummy_request            fifo_req;
 259         u8                              fifo_buf[FIFO_SIZE];
 260         u16                             devstatus;
 261         unsigned                        udc_suspended:1;
 262         unsigned                        pullup:1;
 263
 264         /*
 265          * MASTER/HOST side support
 266          */
 267         struct dummy_hcd                *hs_hcd;
 268         struct dummy_hcd                *ss_hcd;
 269 };
 270
 271 static inline struct dummy_hcd *hcd_to_dummy_hcd(struct usb_hcd *hcd)
 272 {
 273         return (struct dummy_hcd *) (hcd->hcd_priv);
 274 }
 275
 276 static inline struct usb_hcd *dummy_hcd_to_hcd(struct dummy_hcd *dum)
 277 {
 278         return container_of((void *) dum, struct usb_hcd, hcd_priv);
 279 }
 280
 281 static inline struct device *dummy_dev(struct dummy_hcd *dum)
 282 {
 283         return dummy_hcd_to_hcd(dum)->self.controller;
 284 }
 285
 286 static inline struct device *udc_dev(struct dummy *dum)
 287 {
 288         return dum->gadget.dev.parent;
 289 }
 290
 291 static inline struct dummy *ep_to_dummy(struct dummy_ep *ep)
 292 {
 293         return container_of(ep->gadget, struct dummy, gadget);
 294 }
 295
 296 static inline struct dummy_hcd *gadget_to_dummy_hcd(struct usb_gadget *gadget)
 297 {
 298         struct dummy *dum = container_of(gadget, struct dummy, gadget);
 299         if (dum->gadget.speed == USB_SPEED_SUPER)
 300                 return dum->ss_hcd;
 301         else
 302                 return dum->hs_hcd;
 303 }
 304
 305 static inline struct dummy *gadget_dev_to_dummy(struct device *dev)
 306 {
 307         return container_of(dev, struct dummy, gadget.dev);
 308 }
 309
 310 /*-------------------------------------------------------------------------*/
 311
 312 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
 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                 usb_gadget_giveback_request(&ep->ep, &req->req);
 326                 spin_lock(&dum->lock);
 327         }
 328 }
 329
 330 /* caller must hold lock */
 331 static void stop_activity(struct dummy *dum)
 332 {
 333         struct dummy_ep *ep;
 334
 335         /* prevent any more requests */
 336         dum->address = 0;
 337
 338         /* The timer is left running so that outstanding URBs can fail */
 339
 340         /* nuke any pending requests first, so driver i/o is quiesced */
 341         list_for_each_entry(ep, &dum->gadget.ep_list, ep.ep_list)
 342                 nuke(dum, ep);
 343
 344         /* driver now does any non-usb quiescing necessary */
 345 }
 346
 347 /**
 348  * set_link_state_by_speed() - Sets the current state of the link according to
 349  *      the hcd speed
 350  * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
 351  *
 352  * This function updates the port_status according to the link state and the
 353  * speed of the hcd.
 354  */
 355 static void set_link_state_by_speed(struct dummy_hcd *dum_hcd)
 356 {
 357         struct dummy *dum = dum_hcd->dum;
 358
 359         if (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3) {
 360                 if ((dum_hcd->port_status & USB_SS_PORT_STAT_POWER) == 0) {
 361                         dum_hcd->port_status = 0;
 362                 } else if (!dum->pullup || dum->udc_suspended) {
 363                         /* UDC suspend must cause a disconnect */
 364                         dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
 365                                                 USB_PORT_STAT_ENABLE);
 366                         if ((dum_hcd->old_status &
 367                              USB_PORT_STAT_CONNECTION) != 0)
 368                                 dum_hcd->port_status |=
 369                                         (USB_PORT_STAT_C_CONNECTION << 16);
 370                 } else {
 371                         /* device is connected and not suspended */
 372                         dum_hcd->port_status |= (USB_PORT_STAT_CONNECTION |
 373                                                  USB_PORT_STAT_SPEED_5GBPS) ;
 374                         if ((dum_hcd->old_status &
 375                              USB_PORT_STAT_CONNECTION) == 0)
 376                                 dum_hcd->port_status |=
 377                                         (USB_PORT_STAT_C_CONNECTION << 16);
 378                         if ((dum_hcd->port_status &
 379                              USB_PORT_STAT_ENABLE) == 1 &&
 380                                 (dum_hcd->port_status &
 381                                  USB_SS_PORT_LS_U0) == 1 &&
 382                                 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
 383                                 dum_hcd->active = 1;
 384                 }
 385         } else {
 386                 if ((dum_hcd->port_status & USB_PORT_STAT_POWER) == 0) {
 387                         dum_hcd->port_status = 0;
 388                 } else if (!dum->pullup || dum->udc_suspended) {
 389                         /* UDC suspend must cause a disconnect */
 390                         dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
 391                                                 USB_PORT_STAT_ENABLE |
 392                                                 USB_PORT_STAT_LOW_SPEED |
 393                                                 USB_PORT_STAT_HIGH_SPEED |
 394                                                 USB_PORT_STAT_SUSPEND);
 395                         if ((dum_hcd->old_status &
 396                              USB_PORT_STAT_CONNECTION) != 0)
 397                                 dum_hcd->port_status |=
 398                                         (USB_PORT_STAT_C_CONNECTION << 16);
 399                 } else {
 400                         dum_hcd->port_status |= USB_PORT_STAT_CONNECTION;
 401                         if ((dum_hcd->old_status &
 402                              USB_PORT_STAT_CONNECTION) == 0)
 403                                 dum_hcd->port_status |=
 404                                         (USB_PORT_STAT_C_CONNECTION << 16);
 405                         if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0)
 406                                 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
 407                         else if ((dum_hcd->port_status &
 408                                   USB_PORT_STAT_SUSPEND) == 0 &&
 409                                         dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
 410                                 dum_hcd->active = 1;
 411                 }
 412         }
 413 }
 414
 415 /* caller must hold lock */
 416 static void set_link_state(struct dummy_hcd *dum_hcd)
 417 {
 418         struct dummy *dum = dum_hcd->dum;
 419
 420         dum_hcd->active = 0;
 421         if (dum->pullup)
 422                 if ((dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 &&
 423                      dum->gadget.speed != USB_SPEED_SUPER) ||
 424                     (dummy_hcd_to_hcd(dum_hcd)->speed != HCD_USB3 &&
 425                      dum->gadget.speed == USB_SPEED_SUPER))
 426                         return;
 427
 428         set_link_state_by_speed(dum_hcd);
 429
 430         if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0 ||
 431              dum_hcd->active)
 432                 dum_hcd->resuming = 0;
 433
 434         /* Currently !connected or in reset */
 435         if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0 ||
 436                         (dum_hcd->port_status & USB_PORT_STAT_RESET) != 0) {
 437                 unsigned disconnect = USB_PORT_STAT_CONNECTION &
 438                                 dum_hcd->old_status & (~dum_hcd->port_status);
 439                 unsigned reset = USB_PORT_STAT_RESET &
 440                                 (~dum_hcd->old_status) & dum_hcd->port_status;
 441
 442                 /* Report reset and disconnect events to the driver */
 443                 if (dum->driver && (disconnect || reset)) {
 444                         stop_activity(dum);
 445                         spin_unlock(&dum->lock);
 446                         if (reset)
 447                                 usb_gadget_udc_reset(&dum->gadget, dum->driver);
 448                         else
 449                                 dum->driver->disconnect(&dum->gadget);
 450                         spin_lock(&dum->lock);
 451                 }
 452         } else if (dum_hcd->active != dum_hcd->old_active) {
 453                 if (dum_hcd->old_active && dum->driver->suspend) {
 454                         spin_unlock(&dum->lock);
 455                         dum->driver->suspend(&dum->gadget);
 456                         spin_lock(&dum->lock);
 457                 } else if (!dum_hcd->old_active &&  dum->driver->resume) {
 458                         spin_unlock(&dum->lock);
 459                         dum->driver->resume(&dum->gadget);
 460                         spin_lock(&dum->lock);
 461                 }
 462         }
 463
 464         dum_hcd->old_status = dum_hcd->port_status;
 465         dum_hcd->old_active = dum_hcd->active;
 466 }
 467
 468 /*-------------------------------------------------------------------------*/
 469
 470 /* SLAVE/GADGET SIDE DRIVER
 471  *
 472  * This only tracks gadget state.  All the work is done when the host
 473  * side tries some (emulated) i/o operation.  Real device controller
 474  * drivers would do real i/o using dma, fifos, irqs, timers, etc.
 475  */
 476
 477 #define is_enabled(dum) \
 478         (dum->port_status & USB_PORT_STAT_ENABLE)
 479
 480 static int dummy_enable(struct usb_ep *_ep,
 481                 const struct usb_endpoint_descriptor *desc)
 482 {
 483         struct dummy            *dum;
 484         struct dummy_hcd        *dum_hcd;
 485         struct dummy_ep         *ep;
 486         unsigned                max;
 487         int                     retval;
 488
 489         ep = usb_ep_to_dummy_ep(_ep);
 490         if (!_ep || !desc || ep->desc || _ep->name == ep0name
 491                         || desc->bDescriptorType != USB_DT_ENDPOINT)
 492                 return -EINVAL;
 493         dum = ep_to_dummy(ep);
 494         if (!dum->driver)
 495                 return -ESHUTDOWN;
 496
 497         dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
 498         if (!is_enabled(dum_hcd))
 499                 return -ESHUTDOWN;
 500
 501         /*
 502          * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
 503          * maximum packet size.
 504          * For SS devices the wMaxPacketSize is limited by 1024.
 505          */
 506         max = usb_endpoint_maxp(desc) & 0x7ff;
 507
 508         /* drivers must not request bad settings, since lower levels
 509          * (hardware or its drivers) may not check.  some endpoints
 510          * can't do iso, many have maxpacket limitations, etc.
 511          *
 512          * since this "hardware" driver is here to help debugging, we
 513          * have some extra sanity checks.  (there could be more though,
 514          * especially for "ep9out" style fixed function ones.)
 515          */
 516         retval = -EINVAL;
 517         switch (usb_endpoint_type(desc)) {
 518         case USB_ENDPOINT_XFER_BULK:
 519                 if (strstr(ep->ep.name, "-iso")
 520                                 || strstr(ep->ep.name, "-int")) {
 521                         goto done;
 522                 }
 523                 switch (dum->gadget.speed) {
 524                 case USB_SPEED_SUPER:
 525                         if (max == 1024)
 526                                 break;
 527                         goto done;
 528                 case USB_SPEED_HIGH:
 529                         if (max == 512)
 530                                 break;
 531                         goto done;
 532                 case USB_SPEED_FULL:
 533                         if (max == 8 || max == 16 || max == 32 || max == 64)
 534                                 /* we'll fake any legal size */
 535                                 break;
 536                         /* save a return statement */
 537                 default:
 538                         goto done;
 539                 }
 540                 break;
 541         case USB_ENDPOINT_XFER_INT:
 542                 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
 543                         goto done;
 544                 /* real hardware might not handle all packet sizes */
 545                 switch (dum->gadget.speed) {
 546                 case USB_SPEED_SUPER:
 547                 case USB_SPEED_HIGH:
 548                         if (max <= 1024)
 549                                 break;
 550                         /* save a return statement */
 551                 case USB_SPEED_FULL:
 552                         if (max <= 64)
 553                                 break;
 554                         /* save a return statement */
 555                 default:
 556                         if (max <= 8)
 557                                 break;
 558                         goto done;
 559                 }
 560                 break;
 561         case USB_ENDPOINT_XFER_ISOC:
 562                 if (strstr(ep->ep.name, "-bulk")
 563                                 || strstr(ep->ep.name, "-int"))
 564                         goto done;
 565                 /* real hardware might not handle all packet sizes */
 566                 switch (dum->gadget.speed) {
 567                 case USB_SPEED_SUPER:
 568                 case USB_SPEED_HIGH:
 569                         if (max <= 1024)
 570                                 break;
 571                         /* save a return statement */
 572                 case USB_SPEED_FULL:
 573                         if (max <= 1023)
 574                                 break;
 575                         /* save a return statement */
 576                 default:
 577                         goto done;
 578                 }
 579                 break;
 580         default:
 581                 /* few chips support control except on ep0 */
 582                 goto done;
 583         }
 584
 585         _ep->maxpacket = max;
 586         if (usb_ss_max_streams(_ep->comp_desc)) {
 587                 if (!usb_endpoint_xfer_bulk(desc)) {
 588                         dev_err(udc_dev(dum), "Can't enable stream support on "
 589                                         "non-bulk ep %s\n", _ep->name);
 590                         return -EINVAL;
 591                 }
 592                 ep->stream_en = 1;
 593         }
 594         ep->desc = desc;
 595
 596         dev_dbg(udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
 597                 _ep->name,
 598                 desc->bEndpointAddress & 0x0f,
 599                 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
 600                 ({ char *val;
 601                  switch (usb_endpoint_type(desc)) {
 602                  case USB_ENDPOINT_XFER_BULK:
 603                          val = "bulk";
 604                          break;
 605                  case USB_ENDPOINT_XFER_ISOC:
 606                          val = "iso";
 607                          break;
 608                  case USB_ENDPOINT_XFER_INT:
 609                          val = "intr";
 610                          break;
 611                  default:
 612                          val = "ctrl";
 613                          break;
 614                  } val; }),
 615                 max, ep->stream_en ? "enabled" : "disabled");
 616
 617         /* at this point real hardware should be NAKing transfers
 618          * to that endpoint, until a buffer is queued to it.
 619          */
 620         ep->halted = ep->wedged = 0;
 621         retval = 0;
 622 done:
 623         return retval;
 624 }
 625
 626 static int dummy_disable(struct usb_ep *_ep)
 627 {
 628         struct dummy_ep         *ep;
 629         struct dummy            *dum;
 630         unsigned long           flags;
 631
 632         ep = usb_ep_to_dummy_ep(_ep);
 633         if (!_ep || !ep->desc || _ep->name == ep0name)
 634                 return -EINVAL;
 635         dum = ep_to_dummy(ep);
 636
 637         spin_lock_irqsave(&dum->lock, flags);
 638         ep->desc = NULL;
 639         ep->stream_en = 0;
 640         nuke(dum, ep);
 641         spin_unlock_irqrestore(&dum->lock, flags);
 642
 643         dev_dbg(udc_dev(dum), "disabled %s\n", _ep->name);
 644         return 0;
 645 }
 646
 647 static struct usb_request *dummy_alloc_request(struct usb_ep *_ep,
 648                 gfp_t mem_flags)
 649 {
 650         struct dummy_request    *req;
 651
 652         if (!_ep)
 653                 return NULL;
 654
 655         req = kzalloc(sizeof(*req), mem_flags);
 656         if (!req)
 657                 return NULL;
 658         INIT_LIST_HEAD(&req->queue);
 659         return &req->req;
 660 }
 661
 662 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
 663 {
 664         struct dummy_request    *req;
 665
 666         if (!_ep || !_req) {
 667                 WARN_ON(1);
 668                 return;
 669         }
 670
 671         req = usb_request_to_dummy_request(_req);
 672         WARN_ON(!list_empty(&req->queue));
 673         kfree(req);
 674 }
 675
 676 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
 677 {
 678 }
 679
 680 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
 681                 gfp_t mem_flags)
 682 {
 683         struct dummy_ep         *ep;
 684         struct dummy_request    *req;
 685         struct dummy            *dum;
 686         struct dummy_hcd        *dum_hcd;
 687         unsigned long           flags;
 688
 689         req = usb_request_to_dummy_request(_req);
 690         if (!_req || !list_empty(&req->queue) || !_req->complete)
 691                 return -EINVAL;
 692
 693         ep = usb_ep_to_dummy_ep(_ep);
 694         if (!_ep || (!ep->desc && _ep->name != ep0name))
 695                 return -EINVAL;
 696
 697         dum = ep_to_dummy(ep);
 698         dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
 699         if (!dum->driver || !is_enabled(dum_hcd))
 700                 return -ESHUTDOWN;
 701
 702 #if 0
 703         dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
 704                         ep, _req, _ep->name, _req->length, _req->buf);
 705 #endif
 706         _req->status = -EINPROGRESS;
 707         _req->actual = 0;
 708         spin_lock_irqsave(&dum->lock, flags);
 709
 710         /* implement an emulated single-request FIFO */
 711         if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
 712                         list_empty(&dum->fifo_req.queue) &&
 713                         list_empty(&ep->queue) &&
 714                         _req->length <= FIFO_SIZE) {
 715                 req = &dum->fifo_req;
 716                 req->req = *_req;
 717                 req->req.buf = dum->fifo_buf;
 718                 memcpy(dum->fifo_buf, _req->buf, _req->length);
 719                 req->req.context = dum;
 720                 req->req.complete = fifo_complete;
 721
 722                 list_add_tail(&req->queue, &ep->queue);
 723                 spin_unlock(&dum->lock);
 724                 _req->actual = _req->length;
 725                 _req->status = 0;
 726                 usb_gadget_giveback_request(_ep, _req);
 727                 spin_lock(&dum->lock);
 728         }  else
 729                 list_add_tail(&req->queue, &ep->queue);
 730         spin_unlock_irqrestore(&dum->lock, flags);
 731
 732         /* real hardware would likely enable transfers here, in case
 733          * it'd been left NAKing.
 734          */
 735         return 0;
 736 }
 737
 738 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
 739 {
 740         struct dummy_ep         *ep;
 741         struct dummy            *dum;
 742         int                     retval = -EINVAL;
 743         unsigned long           flags;
 744         struct dummy_request    *req = NULL;
 745
 746         if (!_ep || !_req)
 747                 return retval;
 748         ep = usb_ep_to_dummy_ep(_ep);
 749         dum = ep_to_dummy(ep);
 750
 751         if (!dum->driver)
 752                 return -ESHUTDOWN;
 753
 754         local_irq_save(flags);
 755         spin_lock(&dum->lock);
 756         list_for_each_entry(req, &ep->queue, queue) {
 757                 if (&req->req == _req) {
 758                         list_del_init(&req->queue);
 759                         _req->status = -ECONNRESET;
 760                         retval = 0;
 761                         break;
 762                 }
 763         }
 764         spin_unlock(&dum->lock);
 765
 766         if (retval == 0) {
 767                 dev_dbg(udc_dev(dum),
 768                                 "dequeued req %p from %s, len %d buf %p\n",
 769                                 req, _ep->name, _req->length, _req->buf);
 770                 usb_gadget_giveback_request(_ep, _req);
 771         }
 772         local_irq_restore(flags);
 773         return retval;
 774 }
 775
 776 static int
 777 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
 778 {
 779         struct dummy_ep         *ep;
 780         struct dummy            *dum;
 781
 782         if (!_ep)
 783                 return -EINVAL;
 784         ep = usb_ep_to_dummy_ep(_ep);
 785         dum = ep_to_dummy(ep);
 786         if (!dum->driver)
 787                 return -ESHUTDOWN;
 788         if (!value)
 789                 ep->halted = ep->wedged = 0;
 790         else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
 791                         !list_empty(&ep->queue))
 792                 return -EAGAIN;
 793         else {
 794                 ep->halted = 1;
 795                 if (wedged)
 796                         ep->wedged = 1;
 797         }
 798         /* FIXME clear emulated data toggle too */
 799         return 0;
 800 }
 801
 802 static int
 803 dummy_set_halt(struct usb_ep *_ep, int value)
 804 {
 805         return dummy_set_halt_and_wedge(_ep, value, 0);
 806 }
 807
 808 static int dummy_set_wedge(struct usb_ep *_ep)
 809 {
 810         if (!_ep || _ep->name == ep0name)
 811                 return -EINVAL;
 812         return dummy_set_halt_and_wedge(_ep, 1, 1);
 813 }
 814
 815 static const struct usb_ep_ops dummy_ep_ops = {
 816         .enable         = dummy_enable,
 817         .disable        = dummy_disable,
 818
 819         .alloc_request  = dummy_alloc_request,
 820         .free_request   = dummy_free_request,
 821
 822         .queue          = dummy_queue,
 823         .dequeue        = dummy_dequeue,
 824
 825         .set_halt       = dummy_set_halt,
 826         .set_wedge      = dummy_set_wedge,
 827 };
 828
 829 /*-------------------------------------------------------------------------*/
 830
 831 /* there are both host and device side versions of this call ... */
 832 static int dummy_g_get_frame(struct usb_gadget *_gadget)
 833 {
 834         struct timespec64 ts64;
 835
 836         ktime_get_ts64(&ts64);
 837         return ts64.tv_nsec / NSEC_PER_MSEC;
 838 }
 839
 840 static int dummy_wakeup(struct usb_gadget *_gadget)
 841 {
 842         struct dummy_hcd *dum_hcd;
 843
 844         dum_hcd = gadget_to_dummy_hcd(_gadget);
 845         if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
 846                                 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
 847                 return -EINVAL;
 848         if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
 849                 return -ENOLINK;
 850         if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
 851                          dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
 852                 return -EIO;
 853
 854         /* FIXME: What if the root hub is suspended but the port isn't? */
 855
 856         /* hub notices our request, issues downstream resume, etc */
 857         dum_hcd->resuming = 1;
 858         dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
 859         mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
 860         return 0;
 861 }
 862
 863 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
 864 {
 865         struct dummy    *dum;
 866
 867         _gadget->is_selfpowered = (value != 0);
 868         dum = gadget_to_dummy_hcd(_gadget)->dum;
 869         if (value)
 870                 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
 871         else
 872                 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
 873         return 0;
 874 }
 875
 876 static void dummy_udc_update_ep0(struct dummy *dum)
 877 {
 878         if (dum->gadget.speed == USB_SPEED_SUPER)
 879                 dum->ep[0].ep.maxpacket = 9;
 880         else
 881                 dum->ep[0].ep.maxpacket = 64;
 882 }
 883
 884 static int dummy_pullup(struct usb_gadget *_gadget, int value)
 885 {
 886         struct dummy_hcd *dum_hcd;
 887         struct dummy    *dum;
 888         unsigned long   flags;
 889
 890         dum = gadget_dev_to_dummy(&_gadget->dev);
 891
 892         if (value && dum->driver) {
 893                 if (mod_data.is_super_speed)
 894                         dum->gadget.speed = dum->driver->max_speed;
 895                 else if (mod_data.is_high_speed)
 896                         dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
 897                                         dum->driver->max_speed);
 898                 else
 899                         dum->gadget.speed = USB_SPEED_FULL;
 900                 dummy_udc_update_ep0(dum);
 901
 902                 if (dum->gadget.speed < dum->driver->max_speed)
 903                         dev_dbg(udc_dev(dum), "This device can perform faster"
 904                                 " if you connect it to a %s port...\n",
 905                                 usb_speed_string(dum->driver->max_speed));
 906         }
 907         dum_hcd = gadget_to_dummy_hcd(_gadget);
 908
 909         spin_lock_irqsave(&dum->lock, flags);
 910         dum->pullup = (value != 0);
 911         set_link_state(dum_hcd);
 912         spin_unlock_irqrestore(&dum->lock, flags);
 913
 914         usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
 915         return 0;
 916 }
 917
 918 static int dummy_udc_start(struct usb_gadget *g,
 919                 struct usb_gadget_driver *driver);
 920 static int dummy_udc_stop(struct usb_gadget *g);
 921
 922 static const struct usb_gadget_ops dummy_ops = {
 923         .get_frame      = dummy_g_get_frame,
 924         .wakeup         = dummy_wakeup,
 925         .set_selfpowered = dummy_set_selfpowered,
 926         .pullup         = dummy_pullup,
 927         .udc_start      = dummy_udc_start,
 928         .udc_stop       = dummy_udc_stop,
 929 };
 930
 931 /*-------------------------------------------------------------------------*/
 932
 933 /* "function" sysfs attribute */
 934 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
 935                 char *buf)
 936 {
 937         struct dummy    *dum = gadget_dev_to_dummy(dev);
 938
 939         if (!dum->driver || !dum->driver->function)
 940                 return 0;
 941         return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
 942 }
 943 static DEVICE_ATTR_RO(function);
 944
 945 /*-------------------------------------------------------------------------*/
 946
 947 /*
 948  * Driver registration/unregistration.
 949  *
 950  * This is basically hardware-specific; there's usually only one real USB
 951  * device (not host) controller since that's how USB devices are intended
 952  * to work.  So most implementations of these api calls will rely on the
 953  * fact that only one driver will ever bind to the hardware.  But curious
 954  * hardware can be built with discrete components, so the gadget API doesn't
 955  * require that assumption.
 956  *
 957  * For this emulator, it might be convenient to create a usb slave device
 958  * for each driver that registers:  just add to a big root hub.
 959  */
 960
 961 static int dummy_udc_start(struct usb_gadget *g,
 962                 struct usb_gadget_driver *driver)
 963 {
 964         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(g);
 965         struct dummy            *dum = dum_hcd->dum;
 966
 967         if (driver->max_speed == USB_SPEED_UNKNOWN)
 968                 return -EINVAL;
 969
 970         /*
 971          * SLAVE side init ... the layer above hardware, which
 972          * can't enumerate without help from the driver we're binding.
 973          */
 974
 975         dum->devstatus = 0;
 976         dum->driver = driver;
 977
 978         return 0;
 979 }
 980
 981 static int dummy_udc_stop(struct usb_gadget *g)
 982 {
 983         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(g);
 984         struct dummy            *dum = dum_hcd->dum;
 985
 986         dum->driver = NULL;
 987
 988         return 0;
 989 }
 990
 991 #undef is_enabled
 992
 993 /* The gadget structure is stored inside the hcd structure and will be
 994  * released along with it. */
 995 static void init_dummy_udc_hw(struct dummy *dum)
 996 {
 997         int i;
 998
 999         INIT_LIST_HEAD(&dum->gadget.ep_list);
1000         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1001                 struct dummy_ep *ep = &dum->ep[i];
1002
1003                 if (!ep_info[i].name)
1004                         break;
1005                 ep->ep.name = ep_info[i].name;
1006                 ep->ep.caps = ep_info[i].caps;
1007                 ep->ep.ops = &dummy_ep_ops;
1008                 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1009                 ep->halted = ep->wedged = ep->already_seen =
1010                                 ep->setup_stage = 0;
1011                 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1012                 ep->ep.max_streams = 16;
1013                 ep->last_io = jiffies;
1014                 ep->gadget = &dum->gadget;
1015                 ep->desc = NULL;
1016                 INIT_LIST_HEAD(&ep->queue);
1017         }
1018
1019         dum->gadget.ep0 = &dum->ep[0].ep;
1020         list_del_init(&dum->ep[0].ep.ep_list);
1021         INIT_LIST_HEAD(&dum->fifo_req.queue);
1022
1023 #ifdef CONFIG_USB_OTG
1024         dum->gadget.is_otg = 1;
1025 #endif
1026 }
1027
1028 static int dummy_udc_probe(struct platform_device *pdev)
1029 {
1030         struct dummy    *dum;
1031         int             rc;
1032
1033         dum = *((void **)dev_get_platdata(&pdev->dev));
1034         dum->gadget.name = gadget_name;
1035         dum->gadget.ops = &dummy_ops;
1036         dum->gadget.max_speed = USB_SPEED_SUPER;
1037
1038         dum->gadget.dev.parent = &pdev->dev;
1039         init_dummy_udc_hw(dum);
1040
1041         rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1042         if (rc < 0)
1043                 goto err_udc;
1044
1045         rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1046         if (rc < 0)
1047                 goto err_dev;
1048         platform_set_drvdata(pdev, dum);
1049         return rc;
1050
1051 err_dev:
1052         usb_del_gadget_udc(&dum->gadget);
1053 err_udc:
1054         return rc;
1055 }
1056
1057 static int dummy_udc_remove(struct platform_device *pdev)
1058 {
1059         struct dummy    *dum = platform_get_drvdata(pdev);
1060
1061         device_remove_file(&dum->gadget.dev, &dev_attr_function);
1062         usb_del_gadget_udc(&dum->gadget);
1063         return 0;
1064 }
1065
1066 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1067                 int suspend)
1068 {
1069         spin_lock_irq(&dum->lock);
1070         dum->udc_suspended = suspend;
1071         set_link_state(dum_hcd);
1072         spin_unlock_irq(&dum->lock);
1073 }
1074
1075 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1076 {
1077         struct dummy            *dum = platform_get_drvdata(pdev);
1078         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1079
1080         dev_dbg(&pdev->dev, "%s\n", __func__);
1081         dummy_udc_pm(dum, dum_hcd, 1);
1082         usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1083         return 0;
1084 }
1085
1086 static int dummy_udc_resume(struct platform_device *pdev)
1087 {
1088         struct dummy            *dum = platform_get_drvdata(pdev);
1089         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1090
1091         dev_dbg(&pdev->dev, "%s\n", __func__);
1092         dummy_udc_pm(dum, dum_hcd, 0);
1093         usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1094         return 0;
1095 }
1096
1097 static struct platform_driver dummy_udc_driver = {
1098         .probe          = dummy_udc_probe,
1099         .remove         = dummy_udc_remove,
1100         .suspend        = dummy_udc_suspend,
1101         .resume         = dummy_udc_resume,
1102         .driver         = {
1103                 .name   = (char *) gadget_name,
1104         },
1105 };
1106
1107 /*-------------------------------------------------------------------------*/
1108
1109 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1110 {
1111         unsigned int index;
1112
1113         index = usb_endpoint_num(desc) << 1;
1114         if (usb_endpoint_dir_in(desc))
1115                 index |= 1;
1116         return index;
1117 }
1118
1119 /* MASTER/HOST SIDE DRIVER
1120  *
1121  * this uses the hcd framework to hook up to host side drivers.
1122  * its root hub will only have one device, otherwise it acts like
1123  * a normal host controller.
1124  *
1125  * when urbs are queued, they're just stuck on a list that we
1126  * scan in a timer callback.  that callback connects writes from
1127  * the host with reads from the device, and so on, based on the
1128  * usb 2.0 rules.
1129  */
1130
1131 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1132 {
1133         const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1134         u32 index;
1135
1136         if (!usb_endpoint_xfer_bulk(desc))
1137                 return 0;
1138
1139         index = dummy_get_ep_idx(desc);
1140         return (1 << index) & dum_hcd->stream_en_ep;
1141 }
1142
1143 /*
1144  * The max stream number is saved as a nibble so for the 30 possible endpoints
1145  * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1146  * means we use only 1 stream). The maximum according to the spec is 16bit so
1147  * if the 16 stream limit is about to go, the array size should be incremented
1148  * to 30 elements of type u16.
1149  */
1150 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1151                 unsigned int pipe)
1152 {
1153         int max_streams;
1154
1155         max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1156         if (usb_pipeout(pipe))
1157                 max_streams >>= 4;
1158         else
1159                 max_streams &= 0xf;
1160         max_streams++;
1161         return max_streams;
1162 }
1163
1164 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1165                 unsigned int pipe, unsigned int streams)
1166 {
1167         int max_streams;
1168
1169         streams--;
1170         max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1171         if (usb_pipeout(pipe)) {
1172                 streams <<= 4;
1173                 max_streams &= 0xf;
1174         } else {
1175                 max_streams &= 0xf0;
1176         }
1177         max_streams |= streams;
1178         dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1179 }
1180
1181 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1182 {
1183         unsigned int max_streams;
1184         int enabled;
1185
1186         enabled = dummy_ep_stream_en(dum_hcd, urb);
1187         if (!urb->stream_id) {
1188                 if (enabled)
1189                         return -EINVAL;
1190                 return 0;
1191         }
1192         if (!enabled)
1193                 return -EINVAL;
1194
1195         max_streams = get_max_streams_for_pipe(dum_hcd,
1196                         usb_pipeendpoint(urb->pipe));
1197         if (urb->stream_id > max_streams) {
1198                 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1199                                 urb->stream_id);
1200                 BUG();
1201                 return -EINVAL;
1202         }
1203         return 0;
1204 }
1205
1206 static int dummy_urb_enqueue(
1207         struct usb_hcd                  *hcd,
1208         struct urb                      *urb,
1209         gfp_t                           mem_flags
1210 ) {
1211         struct dummy_hcd *dum_hcd;
1212         struct urbp     *urbp;
1213         unsigned long   flags;
1214         int             rc;
1215
1216         urbp = kmalloc(sizeof *urbp, mem_flags);
1217         if (!urbp)
1218                 return -ENOMEM;
1219         urbp->urb = urb;
1220         urbp->miter_started = 0;
1221
1222         dum_hcd = hcd_to_dummy_hcd(hcd);
1223         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1224
1225         rc = dummy_validate_stream(dum_hcd, urb);
1226         if (rc) {
1227                 kfree(urbp);
1228                 goto done;
1229         }
1230
1231         rc = usb_hcd_link_urb_to_ep(hcd, urb);
1232         if (rc) {
1233                 kfree(urbp);
1234                 goto done;
1235         }
1236
1237         if (!dum_hcd->udev) {
1238                 dum_hcd->udev = urb->dev;
1239                 usb_get_dev(dum_hcd->udev);
1240         } else if (unlikely(dum_hcd->udev != urb->dev))
1241                 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1242
1243         list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1244         urb->hcpriv = urbp;
1245         if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1246                 urb->error_count = 1;           /* mark as a new urb */
1247
1248         /* kick the scheduler, it'll do the rest */
1249         if (!timer_pending(&dum_hcd->timer))
1250                 mod_timer(&dum_hcd->timer, jiffies + 1);
1251
1252  done:
1253         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1254         return rc;
1255 }
1256
1257 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1258 {
1259         struct dummy_hcd *dum_hcd;
1260         unsigned long   flags;
1261         int             rc;
1262
1263         /* giveback happens automatically in timer callback,
1264          * so make sure the callback happens */
1265         dum_hcd = hcd_to_dummy_hcd(hcd);
1266         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1267
1268         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1269         if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1270                         !list_empty(&dum_hcd->urbp_list))
1271                 mod_timer(&dum_hcd->timer, jiffies);
1272
1273         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1274         return rc;
1275 }
1276
1277 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1278                 u32 len)
1279 {
1280         void *ubuf, *rbuf;
1281         struct urbp *urbp = urb->hcpriv;
1282         int to_host;
1283         struct sg_mapping_iter *miter = &urbp->miter;
1284         u32 trans = 0;
1285         u32 this_sg;
1286         bool next_sg;
1287
1288         to_host = usb_pipein(urb->pipe);
1289         rbuf = req->req.buf + req->req.actual;
1290
1291         if (!urb->num_sgs) {
1292                 ubuf = urb->transfer_buffer + urb->actual_length;
1293                 if (to_host)
1294                         memcpy(ubuf, rbuf, len);
1295                 else
1296                         memcpy(rbuf, ubuf, len);
1297                 return len;
1298         }
1299
1300         if (!urbp->miter_started) {
1301                 u32 flags = SG_MITER_ATOMIC;
1302
1303                 if (to_host)
1304                         flags |= SG_MITER_TO_SG;
1305                 else
1306                         flags |= SG_MITER_FROM_SG;
1307
1308                 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1309                 urbp->miter_started = 1;
1310         }
1311         next_sg = sg_miter_next(miter);
1312         if (next_sg == false) {
1313                 WARN_ON_ONCE(1);
1314                 return -EINVAL;
1315         }
1316         do {
1317                 ubuf = miter->addr;
1318                 this_sg = min_t(u32, len, miter->length);
1319                 miter->consumed = this_sg;
1320                 trans += this_sg;
1321
1322                 if (to_host)
1323                         memcpy(ubuf, rbuf, this_sg);
1324                 else
1325                         memcpy(rbuf, ubuf, this_sg);
1326                 len -= this_sg;
1327
1328                 if (!len)
1329                         break;
1330                 next_sg = sg_miter_next(miter);
1331                 if (next_sg == false) {
1332                         WARN_ON_ONCE(1);
1333                         return -EINVAL;
1334                 }
1335
1336                 rbuf += this_sg;
1337         } while (1);
1338
1339         sg_miter_stop(miter);
1340         return trans;
1341 }
1342
1343 /* transfer up to a frame's worth; caller must own lock */
1344 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1345                 struct dummy_ep *ep, int limit, int *status)
1346 {
1347         struct dummy            *dum = dum_hcd->dum;
1348         struct dummy_request    *req;
1349         int                     sent = 0;
1350
1351 top:
1352         /* if there's no request queued, the device is NAKing; return */
1353         list_for_each_entry(req, &ep->queue, queue) {
1354                 unsigned        host_len, dev_len, len;
1355                 int             is_short, to_host;
1356                 int             rescan = 0;
1357
1358                 if (dummy_ep_stream_en(dum_hcd, urb)) {
1359                         if ((urb->stream_id != req->req.stream_id))
1360                                 continue;
1361                 }
1362
1363                 /* 1..N packets of ep->ep.maxpacket each ... the last one
1364                  * may be short (including zero length).
1365                  *
1366                  * writer can send a zlp explicitly (length 0) or implicitly
1367                  * (length mod maxpacket zero, and 'zero' flag); they always
1368                  * terminate reads.
1369                  */
1370                 host_len = urb->transfer_buffer_length - urb->actual_length;
1371                 dev_len = req->req.length - req->req.actual;
1372                 len = min(host_len, dev_len);
1373
1374                 /* FIXME update emulated data toggle too */
1375
1376                 to_host = usb_pipein(urb->pipe);
1377                 if (unlikely(len == 0))
1378                         is_short = 1;
1379                 else {
1380                         /* not enough bandwidth left? */
1381                         if (limit < ep->ep.maxpacket && limit < len)
1382                                 break;
1383                         len = min_t(unsigned, len, limit);
1384                         if (len == 0)
1385                                 break;
1386
1387                         /* send multiple of maxpacket first, then remainder */
1388                         if (len >= ep->ep.maxpacket) {
1389                                 is_short = 0;
1390                                 if (len % ep->ep.maxpacket)
1391                                         rescan = 1;
1392                                 len -= len % ep->ep.maxpacket;
1393                         } else {
1394                                 is_short = 1;
1395                         }
1396
1397                         len = dummy_perform_transfer(urb, req, len);
1398
1399                         ep->last_io = jiffies;
1400                         if ((int)len < 0) {
1401                                 req->req.status = len;
1402                         } else {
1403                                 limit -= len;
1404                                 sent += len;
1405                                 urb->actual_length += len;
1406                                 req->req.actual += len;
1407                         }
1408                 }
1409
1410                 /* short packets terminate, maybe with overflow/underflow.
1411                  * it's only really an error to write too much.
1412                  *
1413                  * partially filling a buffer optionally blocks queue advances
1414                  * (so completion handlers can clean up the queue) but we don't
1415                  * need to emulate such data-in-flight.
1416                  */
1417                 if (is_short) {
1418                         if (host_len == dev_len) {
1419                                 req->req.status = 0;
1420                                 *status = 0;
1421                         } else if (to_host) {
1422                                 req->req.status = 0;
1423                                 if (dev_len > host_len)
1424                                         *status = -EOVERFLOW;
1425                                 else
1426                                         *status = 0;
1427                         } else {
1428                                 *status = 0;
1429                                 if (host_len > dev_len)
1430                                         req->req.status = -EOVERFLOW;
1431                                 else
1432                                         req->req.status = 0;
1433                         }
1434
1435                 /*
1436                  * many requests terminate without a short packet.
1437                  * send a zlp if demanded by flags.
1438                  */
1439                 } else {
1440                         if (req->req.length == req->req.actual) {
1441                                 if (req->req.zero && to_host)
1442                                         rescan = 1;
1443                                 else
1444                                         req->req.status = 0;
1445                         }
1446                         if (urb->transfer_buffer_length == urb->actual_length) {
1447                                 if (urb->transfer_flags & URB_ZERO_PACKET &&
1448                                     !to_host)
1449                                         rescan = 1;
1450                                 else
1451                                         *status = 0;
1452                         }
1453                 }
1454
1455                 /* device side completion --> continuable */
1456                 if (req->req.status != -EINPROGRESS) {
1457                         list_del_init(&req->queue);
1458
1459                         spin_unlock(&dum->lock);
1460                         usb_gadget_giveback_request(&ep->ep, &req->req);
1461                         spin_lock(&dum->lock);
1462
1463                         /* requests might have been unlinked... */
1464                         rescan = 1;
1465                 }
1466
1467                 /* host side completion --> terminate */
1468                 if (*status != -EINPROGRESS)
1469                         break;
1470
1471                 /* rescan to continue with any other queued i/o */
1472                 if (rescan)
1473                         goto top;
1474         }
1475         return sent;
1476 }
1477
1478 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1479 {
1480         int     limit = ep->ep.maxpacket;
1481
1482         if (dum->gadget.speed == USB_SPEED_HIGH) {
1483                 int     tmp;
1484
1485                 /* high bandwidth mode */
1486                 tmp = usb_endpoint_maxp(ep->desc);
1487                 tmp = (tmp >> 11) & 0x03;
1488                 tmp *= 8 /* applies to entire frame */;
1489                 limit += limit * tmp;
1490         }
1491         if (dum->gadget.speed == USB_SPEED_SUPER) {
1492                 switch (usb_endpoint_type(ep->desc)) {
1493                 case USB_ENDPOINT_XFER_ISOC:
1494                         /* Sec. 4.4.8.2 USB3.0 Spec */
1495                         limit = 3 * 16 * 1024 * 8;
1496                         break;
1497                 case USB_ENDPOINT_XFER_INT:
1498                         /* Sec. 4.4.7.2 USB3.0 Spec */
1499                         limit = 3 * 1024 * 8;
1500                         break;
1501                 case USB_ENDPOINT_XFER_BULK:
1502                 default:
1503                         break;
1504                 }
1505         }
1506         return limit;
1507 }
1508
1509 #define is_active(dum_hcd)      ((dum_hcd->port_status & \
1510                 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1511                         USB_PORT_STAT_SUSPEND)) \
1512                 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1513
1514 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1515 {
1516         int             i;
1517
1518         if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1519                         dum->ss_hcd : dum->hs_hcd)))
1520                 return NULL;
1521         if ((address & ~USB_DIR_IN) == 0)
1522                 return &dum->ep[0];
1523         for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1524                 struct dummy_ep *ep = &dum->ep[i];
1525
1526                 if (!ep->desc)
1527                         continue;
1528                 if (ep->desc->bEndpointAddress == address)
1529                         return ep;
1530         }
1531         return NULL;
1532 }
1533
1534 #undef is_active
1535
1536 #define Dev_Request     (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1537 #define Dev_InRequest   (Dev_Request | USB_DIR_IN)
1538 #define Intf_Request    (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1539 #define Intf_InRequest  (Intf_Request | USB_DIR_IN)
1540 #define Ep_Request      (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1541 #define Ep_InRequest    (Ep_Request | USB_DIR_IN)
1542
1543
1544 /**
1545  * handle_control_request() - handles all control transfers
1546  * @dum: pointer to dummy (the_controller)
1547  * @urb: the urb request to handle
1548  * @setup: pointer to the setup data for a USB device control
1549  *       request
1550  * @status: pointer to request handling status
1551  *
1552  * Return 0 - if the request was handled
1553  *        1 - if the request wasn't handles
1554  *        error code on error
1555  */
1556 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1557                                   struct usb_ctrlrequest *setup,
1558                                   int *status)
1559 {
1560         struct dummy_ep         *ep2;
1561         struct dummy            *dum = dum_hcd->dum;
1562         int                     ret_val = 1;
1563         unsigned        w_index;
1564         unsigned        w_value;
1565
1566         w_index = le16_to_cpu(setup->wIndex);
1567         w_value = le16_to_cpu(setup->wValue);
1568         switch (setup->bRequest) {
1569         case USB_REQ_SET_ADDRESS:
1570                 if (setup->bRequestType != Dev_Request)
1571                         break;
1572                 dum->address = w_value;
1573                 *status = 0;
1574                 dev_dbg(udc_dev(dum), "set_address = %d\n",
1575                                 w_value);
1576                 ret_val = 0;
1577                 break;
1578         case USB_REQ_SET_FEATURE:
1579                 if (setup->bRequestType == Dev_Request) {
1580                         ret_val = 0;
1581                         switch (w_value) {
1582                         case USB_DEVICE_REMOTE_WAKEUP:
1583                                 break;
1584                         case USB_DEVICE_B_HNP_ENABLE:
1585                                 dum->gadget.b_hnp_enable = 1;
1586                                 break;
1587                         case USB_DEVICE_A_HNP_SUPPORT:
1588                                 dum->gadget.a_hnp_support = 1;
1589                                 break;
1590                         case USB_DEVICE_A_ALT_HNP_SUPPORT:
1591                                 dum->gadget.a_alt_hnp_support = 1;
1592                                 break;
1593                         case USB_DEVICE_U1_ENABLE:
1594                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1595                                     HCD_USB3)
1596                                         w_value = USB_DEV_STAT_U1_ENABLED;
1597                                 else
1598                                         ret_val = -EOPNOTSUPP;
1599                                 break;
1600                         case USB_DEVICE_U2_ENABLE:
1601                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1602                                     HCD_USB3)
1603                                         w_value = USB_DEV_STAT_U2_ENABLED;
1604                                 else
1605                                         ret_val = -EOPNOTSUPP;
1606                                 break;
1607                         case USB_DEVICE_LTM_ENABLE:
1608                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1609                                     HCD_USB3)
1610                                         w_value = USB_DEV_STAT_LTM_ENABLED;
1611                                 else
1612                                         ret_val = -EOPNOTSUPP;
1613                                 break;
1614                         default:
1615                                 ret_val = -EOPNOTSUPP;
1616                         }
1617                         if (ret_val == 0) {
1618                                 dum->devstatus |= (1 << w_value);
1619                                 *status = 0;
1620                         }
1621                 } else if (setup->bRequestType == Ep_Request) {
1622                         /* endpoint halt */
1623                         ep2 = find_endpoint(dum, w_index);
1624                         if (!ep2 || ep2->ep.name == ep0name) {
1625                                 ret_val = -EOPNOTSUPP;
1626                                 break;
1627                         }
1628                         ep2->halted = 1;
1629                         ret_val = 0;
1630                         *status = 0;
1631                 }
1632                 break;
1633         case USB_REQ_CLEAR_FEATURE:
1634                 if (setup->bRequestType == Dev_Request) {
1635                         ret_val = 0;
1636                         switch (w_value) {
1637                         case USB_DEVICE_REMOTE_WAKEUP:
1638                                 w_value = USB_DEVICE_REMOTE_WAKEUP;
1639                                 break;
1640                         case USB_DEVICE_U1_ENABLE:
1641                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1642                                     HCD_USB3)
1643                                         w_value = USB_DEV_STAT_U1_ENABLED;
1644                                 else
1645                                         ret_val = -EOPNOTSUPP;
1646                                 break;
1647                         case USB_DEVICE_U2_ENABLE:
1648                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1649                                     HCD_USB3)
1650                                         w_value = USB_DEV_STAT_U2_ENABLED;
1651                                 else
1652                                         ret_val = -EOPNOTSUPP;
1653                                 break;
1654                         case USB_DEVICE_LTM_ENABLE:
1655                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1656                                     HCD_USB3)
1657                                         w_value = USB_DEV_STAT_LTM_ENABLED;
1658                                 else
1659                                         ret_val = -EOPNOTSUPP;
1660                                 break;
1661                         default:
1662                                 ret_val = -EOPNOTSUPP;
1663                                 break;
1664                         }
1665                         if (ret_val == 0) {
1666                                 dum->devstatus &= ~(1 << w_value);
1667                                 *status = 0;
1668                         }
1669                 } else if (setup->bRequestType == Ep_Request) {
1670                         /* endpoint halt */
1671                         ep2 = find_endpoint(dum, w_index);
1672                         if (!ep2) {
1673                                 ret_val = -EOPNOTSUPP;
1674                                 break;
1675                         }
1676                         if (!ep2->wedged)
1677                                 ep2->halted = 0;
1678                         ret_val = 0;
1679                         *status = 0;
1680                 }
1681                 break;
1682         case USB_REQ_GET_STATUS:
1683                 if (setup->bRequestType == Dev_InRequest
1684                                 || setup->bRequestType == Intf_InRequest
1685                                 || setup->bRequestType == Ep_InRequest) {
1686                         char *buf;
1687                         /*
1688                          * device: remote wakeup, selfpowered
1689                          * interface: nothing
1690                          * endpoint: halt
1691                          */
1692                         buf = (char *)urb->transfer_buffer;
1693                         if (urb->transfer_buffer_length > 0) {
1694                                 if (setup->bRequestType == Ep_InRequest) {
1695                                         ep2 = find_endpoint(dum, w_index);
1696                                         if (!ep2) {
1697                                                 ret_val = -EOPNOTSUPP;
1698                                                 break;
1699                                         }
1700                                         buf[0] = ep2->halted;
1701                                 } else if (setup->bRequestType ==
1702                                            Dev_InRequest) {
1703                                         buf[0] = (u8)dum->devstatus;
1704                                 } else
1705                                         buf[0] = 0;
1706                         }
1707                         if (urb->transfer_buffer_length > 1)
1708                                 buf[1] = 0;
1709                         urb->actual_length = min_t(u32, 2,
1710                                 urb->transfer_buffer_length);
1711                         ret_val = 0;
1712                         *status = 0;
1713                 }
1714                 break;
1715         }
1716         return ret_val;
1717 }
1718
1719 /* drive both sides of the transfers; looks like irq handlers to
1720  * both drivers except the callbacks aren't in_irq().
1721  */
1722 static void dummy_timer(unsigned long _dum_hcd)
1723 {
1724         struct dummy_hcd        *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1725         struct dummy            *dum = dum_hcd->dum;
1726         struct urbp             *urbp, *tmp;
1727         unsigned long           flags;
1728         int                     limit, total;
1729         int                     i;
1730
1731         /* simplistic model for one frame's bandwidth */
1732         switch (dum->gadget.speed) {
1733         case USB_SPEED_LOW:
1734                 total = 8/*bytes*/ * 12/*packets*/;
1735                 break;
1736         case USB_SPEED_FULL:
1737                 total = 64/*bytes*/ * 19/*packets*/;
1738                 break;
1739         case USB_SPEED_HIGH:
1740                 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1741                 break;
1742         case USB_SPEED_SUPER:
1743                 /* Bus speed is 500000 bytes/ms, so use a little less */
1744                 total = 490000;
1745                 break;
1746         default:
1747                 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1748                 return;
1749         }
1750
1751         /* FIXME if HZ != 1000 this will probably misbehave ... */
1752
1753         /* look at each urb queued by the host side driver */
1754         spin_lock_irqsave(&dum->lock, flags);
1755
1756         if (!dum_hcd->udev) {
1757                 dev_err(dummy_dev(dum_hcd),
1758                                 "timer fired with no URBs pending?\n");
1759                 spin_unlock_irqrestore(&dum->lock, flags);
1760                 return;
1761         }
1762
1763         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1764                 if (!ep_info[i].name)
1765                         break;
1766                 dum->ep[i].already_seen = 0;
1767         }
1768
1769 restart:
1770         list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1771                 struct urb              *urb;
1772                 struct dummy_request    *req;
1773                 u8                      address;
1774                 struct dummy_ep         *ep = NULL;
1775                 int                     type;
1776                 int                     status = -EINPROGRESS;
1777
1778                 urb = urbp->urb;
1779                 if (urb->unlinked)
1780                         goto return_urb;
1781                 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1782                         continue;
1783                 type = usb_pipetype(urb->pipe);
1784
1785                 /* used up this frame's non-periodic bandwidth?
1786                  * FIXME there's infinite bandwidth for control and
1787                  * periodic transfers ... unrealistic.
1788                  */
1789                 if (total <= 0 && type == PIPE_BULK)
1790                         continue;
1791
1792                 /* find the gadget's ep for this request (if configured) */
1793                 address = usb_pipeendpoint (urb->pipe);
1794                 if (usb_pipein(urb->pipe))
1795                         address |= USB_DIR_IN;
1796                 ep = find_endpoint(dum, address);
1797                 if (!ep) {
1798                         /* set_configuration() disagreement */
1799                         dev_dbg(dummy_dev(dum_hcd),
1800                                 "no ep configured for urb %p\n",
1801                                 urb);
1802                         status = -EPROTO;
1803                         goto return_urb;
1804                 }
1805
1806                 if (ep->already_seen)
1807                         continue;
1808                 ep->already_seen = 1;
1809                 if (ep == &dum->ep[0] && urb->error_count) {
1810                         ep->setup_stage = 1;    /* a new urb */
1811                         urb->error_count = 0;
1812                 }
1813                 if (ep->halted && !ep->setup_stage) {
1814                         /* NOTE: must not be iso! */
1815                         dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1816                                         ep->ep.name, urb);
1817                         status = -EPIPE;
1818                         goto return_urb;
1819                 }
1820                 /* FIXME make sure both ends agree on maxpacket */
1821
1822                 /* handle control requests */
1823                 if (ep == &dum->ep[0] && ep->setup_stage) {
1824                         struct usb_ctrlrequest          setup;
1825                         int                             value = 1;
1826
1827                         setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1828                         /* paranoia, in case of stale queued data */
1829                         list_for_each_entry(req, &ep->queue, queue) {
1830                                 list_del_init(&req->queue);
1831                                 req->req.status = -EOVERFLOW;
1832                                 dev_dbg(udc_dev(dum), "stale req = %p\n",
1833                                                 req);
1834
1835                                 spin_unlock(&dum->lock);
1836                                 usb_gadget_giveback_request(&ep->ep, &req->req);
1837                                 spin_lock(&dum->lock);
1838                                 ep->already_seen = 0;
1839                                 goto restart;
1840                         }
1841
1842                         /* gadget driver never sees set_address or operations
1843                          * on standard feature flags.  some hardware doesn't
1844                          * even expose them.
1845                          */
1846                         ep->last_io = jiffies;
1847                         ep->setup_stage = 0;
1848                         ep->halted = 0;
1849
1850                         value = handle_control_request(dum_hcd, urb, &setup,
1851                                                        &status);
1852
1853                         /* gadget driver handles all other requests.  block
1854                          * until setup() returns; no reentrancy issues etc.
1855                          */
1856                         if (value > 0) {
1857                                 spin_unlock(&dum->lock);
1858                                 value = dum->driver->setup(&dum->gadget,
1859                                                 &setup);
1860                                 spin_lock(&dum->lock);
1861
1862                                 if (value >= 0) {
1863                                         /* no delays (max 64KB data stage) */
1864                                         limit = 64*1024;
1865                                         goto treat_control_like_bulk;
1866                                 }
1867                                 /* error, see below */
1868                         }
1869
1870                         if (value < 0) {
1871                                 if (value != -EOPNOTSUPP)
1872                                         dev_dbg(udc_dev(dum),
1873                                                 "setup --> %d\n",
1874                                                 value);
1875                                 status = -EPIPE;
1876                                 urb->actual_length = 0;
1877                         }
1878
1879                         goto return_urb;
1880                 }
1881
1882                 /* non-control requests */
1883                 limit = total;
1884                 switch (usb_pipetype(urb->pipe)) {
1885                 case PIPE_ISOCHRONOUS:
1886                         /* FIXME is it urb->interval since the last xfer?
1887                          * use urb->iso_frame_desc[i].
1888                          * complete whether or not ep has requests queued.
1889                          * report random errors, to debug drivers.
1890                          */
1891                         limit = max(limit, periodic_bytes(dum, ep));
1892                         status = -ENOSYS;
1893                         break;
1894
1895                 case PIPE_INTERRUPT:
1896                         /* FIXME is it urb->interval since the last xfer?
1897                          * this almost certainly polls too fast.
1898                          */
1899                         limit = max(limit, periodic_bytes(dum, ep));
1900                         /* FALLTHROUGH */
1901
1902                 default:
1903 treat_control_like_bulk:
1904                         ep->last_io = jiffies;
1905                         total -= transfer(dum_hcd, urb, ep, limit, &status);
1906                         break;
1907                 }
1908
1909                 /* incomplete transfer? */
1910                 if (status == -EINPROGRESS)
1911                         continue;
1912
1913 return_urb:
1914                 list_del(&urbp->urbp_list);
1915                 kfree(urbp);
1916                 if (ep)
1917                         ep->already_seen = ep->setup_stage = 0;
1918
1919                 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1920                 spin_unlock(&dum->lock);
1921                 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1922                 spin_lock(&dum->lock);
1923
1924                 goto restart;
1925         }
1926
1927         if (list_empty(&dum_hcd->urbp_list)) {
1928                 usb_put_dev(dum_hcd->udev);
1929                 dum_hcd->udev = NULL;
1930         } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1931                 /* want a 1 msec delay here */
1932                 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1933         }
1934
1935         spin_unlock_irqrestore(&dum->lock, flags);
1936 }
1937
1938 /*-------------------------------------------------------------------------*/
1939
1940 #define PORT_C_MASK \
1941         ((USB_PORT_STAT_C_CONNECTION \
1942         | USB_PORT_STAT_C_ENABLE \
1943         | USB_PORT_STAT_C_SUSPEND \
1944         | USB_PORT_STAT_C_OVERCURRENT \
1945         | USB_PORT_STAT_C_RESET) << 16)
1946
1947 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1948 {
1949         struct dummy_hcd        *dum_hcd;
1950         unsigned long           flags;
1951         int                     retval = 0;
1952
1953         dum_hcd = hcd_to_dummy_hcd(hcd);
1954
1955         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1956         if (!HCD_HW_ACCESSIBLE(hcd))
1957                 goto done;
1958
1959         if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
1960                 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1961                 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
1962                 set_link_state(dum_hcd);
1963         }
1964
1965         if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
1966                 *buf = (1 << 1);
1967                 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
1968                                 dum_hcd->port_status);
1969                 retval = 1;
1970                 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
1971                         usb_hcd_resume_root_hub(hcd);
1972         }
1973 done:
1974         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1975         return retval;
1976 }
1977
1978 /* usb 3.0 root hub device descriptor */
1979 static struct {
1980         struct usb_bos_descriptor bos;
1981         struct usb_ss_cap_descriptor ss_cap;
1982 } __packed usb3_bos_desc = {
1983
1984         .bos = {
1985                 .bLength                = USB_DT_BOS_SIZE,
1986                 .bDescriptorType        = USB_DT_BOS,
1987                 .wTotalLength           = cpu_to_le16(sizeof(usb3_bos_desc)),
1988                 .bNumDeviceCaps         = 1,
1989         },
1990         .ss_cap = {
1991                 .bLength                = USB_DT_USB_SS_CAP_SIZE,
1992                 .bDescriptorType        = USB_DT_DEVICE_CAPABILITY,
1993                 .bDevCapabilityType     = USB_SS_CAP_TYPE,
1994                 .wSpeedSupported        = cpu_to_le16(USB_5GBPS_OPERATION),
1995                 .bFunctionalitySupport  = ilog2(USB_5GBPS_OPERATION),
1996         },
1997 };
1998
1999 static inline void
2000 ss_hub_descriptor(struct usb_hub_descriptor *desc)
2001 {
2002         memset(desc, 0, sizeof *desc);
2003         desc->bDescriptorType = USB_DT_SS_HUB;
2004         desc->bDescLength = 12;
2005         desc->wHubCharacteristics = cpu_to_le16(
2006                         HUB_CHAR_INDV_PORT_LPSM |
2007                         HUB_CHAR_COMMON_OCPM);
2008         desc->bNbrPorts = 1;
2009         desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2010         desc->u.ss.DeviceRemovable = 0xffff;
2011 }
2012
2013 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2014 {
2015         memset(desc, 0, sizeof *desc);
2016         desc->bDescriptorType = USB_DT_HUB;
2017         desc->bDescLength = 9;
2018         desc->wHubCharacteristics = cpu_to_le16(
2019                         HUB_CHAR_INDV_PORT_LPSM |
2020                         HUB_CHAR_COMMON_OCPM);
2021         desc->bNbrPorts = 1;
2022         desc->u.hs.DeviceRemovable[0] = 0xff;
2023         desc->u.hs.DeviceRemovable[1] = 0xff;
2024 }
2025
2026 static int dummy_hub_control(
2027         struct usb_hcd  *hcd,
2028         u16             typeReq,
2029         u16             wValue,
2030         u16             wIndex,
2031         char            *buf,
2032         u16             wLength
2033 ) {
2034         struct dummy_hcd *dum_hcd;
2035         int             retval = 0;
2036         unsigned long   flags;
2037
2038         if (!HCD_HW_ACCESSIBLE(hcd))
2039                 return -ETIMEDOUT;
2040
2041         dum_hcd = hcd_to_dummy_hcd(hcd);
2042
2043         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2044         switch (typeReq) {
2045         case ClearHubFeature:
2046                 break;
2047         case ClearPortFeature:
2048                 switch (wValue) {
2049                 case USB_PORT_FEAT_SUSPEND:
2050                         if (hcd->speed == HCD_USB3) {
2051                                 dev_dbg(dummy_dev(dum_hcd),
2052                                          "USB_PORT_FEAT_SUSPEND req not "
2053                                          "supported for USB 3.0 roothub\n");
2054                                 goto error;
2055                         }
2056                         if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2057                                 /* 20msec resume signaling */
2058                                 dum_hcd->resuming = 1;
2059                                 dum_hcd->re_timeout = jiffies +
2060                                                 msecs_to_jiffies(20);
2061                         }
2062                         break;
2063                 case USB_PORT_FEAT_POWER:
2064                         if (hcd->speed == HCD_USB3) {
2065                                 if (dum_hcd->port_status & USB_PORT_STAT_POWER)
2066                                         dev_dbg(dummy_dev(dum_hcd),
2067                                                 "power-off\n");
2068                         } else
2069                                 if (dum_hcd->port_status &
2070                                                         USB_SS_PORT_STAT_POWER)
2071                                         dev_dbg(dummy_dev(dum_hcd),
2072                                                 "power-off\n");
2073                         /* FALLS THROUGH */
2074                 default:
2075                         dum_hcd->port_status &= ~(1 << wValue);
2076                         set_link_state(dum_hcd);
2077                 }
2078                 break;
2079         case GetHubDescriptor:
2080                 if (hcd->speed == HCD_USB3 &&
2081                                 (wLength < USB_DT_SS_HUB_SIZE ||
2082                                  wValue != (USB_DT_SS_HUB << 8))) {
2083                         dev_dbg(dummy_dev(dum_hcd),
2084                                 "Wrong hub descriptor type for "
2085                                 "USB 3.0 roothub.\n");
2086                         goto error;
2087                 }
2088                 if (hcd->speed == HCD_USB3)
2089                         ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2090                 else
2091                         hub_descriptor((struct usb_hub_descriptor *) buf);
2092                 break;
2093
2094         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2095                 if (hcd->speed != HCD_USB3)
2096                         goto error;
2097
2098                 if ((wValue >> 8) != USB_DT_BOS)
2099                         goto error;
2100
2101                 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2102                 retval = sizeof(usb3_bos_desc);
2103                 break;
2104
2105         case GetHubStatus:
2106                 *(__le32 *) buf = cpu_to_le32(0);
2107                 break;
2108         case GetPortStatus:
2109                 if (wIndex != 1)
2110                         retval = -EPIPE;
2111
2112                 /* whoever resets or resumes must GetPortStatus to
2113                  * complete it!!
2114                  */
2115                 if (dum_hcd->resuming &&
2116                                 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2117                         dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2118                         dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2119                 }
2120                 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2121                                 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2122                         dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2123                         dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2124                         if (dum_hcd->dum->pullup) {
2125                                 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2126
2127                                 if (hcd->speed < HCD_USB3) {
2128                                         switch (dum_hcd->dum->gadget.speed) {
2129                                         case USB_SPEED_HIGH:
2130                                                 dum_hcd->port_status |=
2131                                                       USB_PORT_STAT_HIGH_SPEED;
2132                                                 break;
2133                                         case USB_SPEED_LOW:
2134                                                 dum_hcd->dum->gadget.ep0->
2135                                                         maxpacket = 8;
2136                                                 dum_hcd->port_status |=
2137                                                         USB_PORT_STAT_LOW_SPEED;
2138                                                 break;
2139                                         default:
2140                                                 dum_hcd->dum->gadget.speed =
2141                                                         USB_SPEED_FULL;
2142                                                 break;
2143                                         }
2144                                 }
2145                         }
2146                 }
2147                 set_link_state(dum_hcd);
2148                 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2149                 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2150                 break;
2151         case SetHubFeature:
2152                 retval = -EPIPE;
2153                 break;
2154         case SetPortFeature:
2155                 switch (wValue) {
2156                 case USB_PORT_FEAT_LINK_STATE:
2157                         if (hcd->speed != HCD_USB3) {
2158                                 dev_dbg(dummy_dev(dum_hcd),
2159                                          "USB_PORT_FEAT_LINK_STATE req not "
2160                                          "supported for USB 2.0 roothub\n");
2161                                 goto error;
2162                         }
2163                         /*
2164                          * Since this is dummy we don't have an actual link so
2165                          * there is nothing to do for the SET_LINK_STATE cmd
2166                          */
2167                         break;
2168                 case USB_PORT_FEAT_U1_TIMEOUT:
2169                 case USB_PORT_FEAT_U2_TIMEOUT:
2170                         /* TODO: add suspend/resume support! */
2171                         if (hcd->speed != HCD_USB3) {
2172                                 dev_dbg(dummy_dev(dum_hcd),
2173                                          "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2174                                          "supported for USB 2.0 roothub\n");
2175                                 goto error;
2176                         }
2177                         break;
2178                 case USB_PORT_FEAT_SUSPEND:
2179                         /* Applicable only for USB2.0 hub */
2180                         if (hcd->speed == HCD_USB3) {
2181                                 dev_dbg(dummy_dev(dum_hcd),
2182                                          "USB_PORT_FEAT_SUSPEND req not "
2183                                          "supported for USB 3.0 roothub\n");
2184                                 goto error;
2185                         }
2186                         if (dum_hcd->active) {
2187                                 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2188
2189                                 /* HNP would happen here; for now we
2190                                  * assume b_bus_req is always true.
2191                                  */
2192                                 set_link_state(dum_hcd);
2193                                 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2194                                                 & dum_hcd->dum->devstatus) != 0)
2195                                         dev_dbg(dummy_dev(dum_hcd),
2196                                                         "no HNP yet!\n");
2197                         }
2198                         break;
2199                 case USB_PORT_FEAT_POWER:
2200                         if (hcd->speed == HCD_USB3)
2201                                 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2202                         else
2203                                 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2204                         set_link_state(dum_hcd);
2205                         break;
2206                 case USB_PORT_FEAT_BH_PORT_RESET:
2207                         /* Applicable only for USB3.0 hub */
2208                         if (hcd->speed != HCD_USB3) {
2209                                 dev_dbg(dummy_dev(dum_hcd),
2210                                          "USB_PORT_FEAT_BH_PORT_RESET req not "
2211                                          "supported for USB 2.0 roothub\n");
2212                                 goto error;
2213                         }
2214                         /* FALLS THROUGH */
2215                 case USB_PORT_FEAT_RESET:
2216                         /* if it's already enabled, disable */
2217                         if (hcd->speed == HCD_USB3) {
2218                                 dum_hcd->port_status = 0;
2219                                 dum_hcd->port_status =
2220                                         (USB_SS_PORT_STAT_POWER |
2221                                          USB_PORT_STAT_CONNECTION |
2222                                          USB_PORT_STAT_RESET);
2223                         } else
2224                                 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2225                                         | USB_PORT_STAT_LOW_SPEED
2226                                         | USB_PORT_STAT_HIGH_SPEED);
2227                         /*
2228                          * We want to reset device status. All but the
2229                          * Self powered feature
2230                          */
2231                         dum_hcd->dum->devstatus &=
2232                                 (1 << USB_DEVICE_SELF_POWERED);
2233                         /*
2234                          * FIXME USB3.0: what is the correct reset signaling
2235                          * interval? Is it still 50msec as for HS?
2236                          */
2237                         dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2238                         /* FALLS THROUGH */
2239                 default:
2240                         if (hcd->speed == HCD_USB3) {
2241                                 if ((dum_hcd->port_status &
2242                                      USB_SS_PORT_STAT_POWER) != 0) {
2243                                         dum_hcd->port_status |= (1 << wValue);
2244                                         set_link_state(dum_hcd);
2245                                 }
2246                         } else
2247                                 if ((dum_hcd->port_status &
2248                                      USB_PORT_STAT_POWER) != 0) {
2249                                         dum_hcd->port_status |= (1 << wValue);
2250                                         set_link_state(dum_hcd);
2251                                 }
2252                 }
2253                 break;
2254         case GetPortErrorCount:
2255                 if (hcd->speed != HCD_USB3) {
2256                         dev_dbg(dummy_dev(dum_hcd),
2257                                  "GetPortErrorCount req not "
2258                                  "supported for USB 2.0 roothub\n");
2259                         goto error;
2260                 }
2261                 /* We'll always return 0 since this is a dummy hub */
2262                 *(__le32 *) buf = cpu_to_le32(0);
2263                 break;
2264         case SetHubDepth:
2265                 if (hcd->speed != HCD_USB3) {
2266                         dev_dbg(dummy_dev(dum_hcd),
2267                                  "SetHubDepth req not supported for "
2268                                  "USB 2.0 roothub\n");
2269                         goto error;
2270                 }
2271                 break;
2272         default:
2273                 dev_dbg(dummy_dev(dum_hcd),
2274                         "hub control req%04x v%04x i%04x l%d\n",
2275                         typeReq, wValue, wIndex, wLength);
2276 error:
2277                 /* "protocol stall" on error */
2278                 retval = -EPIPE;
2279         }
2280         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2281
2282         if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2283                 usb_hcd_poll_rh_status(hcd);
2284         return retval;
2285 }
2286
2287 static int dummy_bus_suspend(struct usb_hcd *hcd)
2288 {
2289         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2290
2291         dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2292
2293         spin_lock_irq(&dum_hcd->dum->lock);
2294         dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2295         set_link_state(dum_hcd);
2296         hcd->state = HC_STATE_SUSPENDED;
2297         spin_unlock_irq(&dum_hcd->dum->lock);
2298         return 0;
2299 }
2300
2301 static int dummy_bus_resume(struct usb_hcd *hcd)
2302 {
2303         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2304         int rc = 0;
2305
2306         dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2307
2308         spin_lock_irq(&dum_hcd->dum->lock);
2309         if (!HCD_HW_ACCESSIBLE(hcd)) {
2310                 rc = -ESHUTDOWN;
2311         } else {
2312                 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2313                 set_link_state(dum_hcd);
2314                 if (!list_empty(&dum_hcd->urbp_list))
2315                         mod_timer(&dum_hcd->timer, jiffies);
2316                 hcd->state = HC_STATE_RUNNING;
2317         }
2318         spin_unlock_irq(&dum_hcd->dum->lock);
2319         return rc;
2320 }
2321
2322 /*-------------------------------------------------------------------------*/
2323
2324 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2325 {
2326         int ep = usb_pipeendpoint(urb->pipe);
2327
2328         return snprintf(buf, size,
2329                 "urb/%p %s ep%d%s%s len %d/%d\n",
2330                 urb,
2331                 ({ char *s;
2332                 switch (urb->dev->speed) {
2333                 case USB_SPEED_LOW:
2334                         s = "ls";
2335                         break;
2336                 case USB_SPEED_FULL:
2337                         s = "fs";
2338                         break;
2339                 case USB_SPEED_HIGH:
2340                         s = "hs";
2341                         break;
2342                 case USB_SPEED_SUPER:
2343                         s = "ss";
2344                         break;
2345                 default:
2346                         s = "?";
2347                         break;
2348                  } s; }),
2349                 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2350                 ({ char *s; \
2351                 switch (usb_pipetype(urb->pipe)) { \
2352                 case PIPE_CONTROL: \
2353                         s = ""; \
2354                         break; \
2355                 case PIPE_BULK: \
2356                         s = "-bulk"; \
2357                         break; \
2358                 case PIPE_INTERRUPT: \
2359                         s = "-int"; \
2360                         break; \
2361                 default: \
2362                         s = "-iso"; \
2363                         break; \
2364                 } s; }),
2365                 urb->actual_length, urb->transfer_buffer_length);
2366 }
2367
2368 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2369                 char *buf)
2370 {
2371         struct usb_hcd          *hcd = dev_get_drvdata(dev);
2372         struct dummy_hcd        *dum_hcd = hcd_to_dummy_hcd(hcd);
2373         struct urbp             *urbp;
2374         size_t                  size = 0;
2375         unsigned long           flags;
2376
2377         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2378         list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2379                 size_t          temp;
2380
2381                 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2382                 buf += temp;
2383                 size += temp;
2384         }
2385         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2386
2387         return size;
2388 }
2389 static DEVICE_ATTR_RO(urbs);
2390
2391 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2392 {
2393         init_timer(&dum_hcd->timer);
2394         dum_hcd->timer.function = dummy_timer;
2395         dum_hcd->timer.data = (unsigned long)dum_hcd;
2396         dum_hcd->rh_state = DUMMY_RH_RUNNING;
2397         dum_hcd->stream_en_ep = 0;
2398         INIT_LIST_HEAD(&dum_hcd->urbp_list);
2399         dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET;
2400         dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2401         dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2402 #ifdef CONFIG_USB_OTG
2403         dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2404 #endif
2405         return 0;
2406
2407         /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2408         return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2409 }
2410
2411 static int dummy_start(struct usb_hcd *hcd)
2412 {
2413         struct dummy_hcd        *dum_hcd = hcd_to_dummy_hcd(hcd);
2414
2415         /*
2416          * MASTER side init ... we emulate a root hub that'll only ever
2417          * talk to one device (the slave side).  Also appears in sysfs,
2418          * just like more familiar pci-based HCDs.
2419          */
2420         if (!usb_hcd_is_primary_hcd(hcd))
2421                 return dummy_start_ss(dum_hcd);
2422
2423         spin_lock_init(&dum_hcd->dum->lock);
2424         init_timer(&dum_hcd->timer);
2425         dum_hcd->timer.function = dummy_timer;
2426         dum_hcd->timer.data = (unsigned long)dum_hcd;
2427         dum_hcd->rh_state = DUMMY_RH_RUNNING;
2428
2429         INIT_LIST_HEAD(&dum_hcd->urbp_list);
2430
2431         hcd->power_budget = POWER_BUDGET;
2432         hcd->state = HC_STATE_RUNNING;
2433         hcd->uses_new_polling = 1;
2434
2435 #ifdef CONFIG_USB_OTG
2436         hcd->self.otg_port = 1;
2437 #endif
2438
2439         /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2440         return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2441 }
2442
2443 static void dummy_stop(struct usb_hcd *hcd)
2444 {
2445         device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2446         dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2447 }
2448
2449 /*-------------------------------------------------------------------------*/
2450
2451 static int dummy_h_get_frame(struct usb_hcd *hcd)
2452 {
2453         return dummy_g_get_frame(NULL);
2454 }
2455
2456 static int dummy_setup(struct usb_hcd *hcd)
2457 {
2458         struct dummy *dum;
2459
2460         dum = *((void **)dev_get_platdata(hcd->self.controller));
2461         hcd->self.sg_tablesize = ~0;
2462         if (usb_hcd_is_primary_hcd(hcd)) {
2463                 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2464                 dum->hs_hcd->dum = dum;
2465                 /*
2466                  * Mark the first roothub as being USB 2.0.
2467                  * The USB 3.0 roothub will be registered later by
2468                  * dummy_hcd_probe()
2469                  */
2470                 hcd->speed = HCD_USB2;
2471                 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2472         } else {
2473                 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2474                 dum->ss_hcd->dum = dum;
2475                 hcd->speed = HCD_USB3;
2476                 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2477         }
2478         return 0;
2479 }
2480
2481 /* Change a group of bulk endpoints to support multiple stream IDs */
2482 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2483         struct usb_host_endpoint **eps, unsigned int num_eps,
2484         unsigned int num_streams, gfp_t mem_flags)
2485 {
2486         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2487         unsigned long flags;
2488         int max_stream;
2489         int ret_streams = num_streams;
2490         unsigned int index;
2491         unsigned int i;
2492
2493         if (!num_eps)
2494                 return -EINVAL;
2495
2496         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2497         for (i = 0; i < num_eps; i++) {
2498                 index = dummy_get_ep_idx(&eps[i]->desc);
2499                 if ((1 << index) & dum_hcd->stream_en_ep) {
2500                         ret_streams = -EINVAL;
2501                         goto out;
2502                 }
2503                 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2504                 if (!max_stream) {
2505                         ret_streams = -EINVAL;
2506                         goto out;
2507                 }
2508                 if (max_stream < ret_streams) {
2509                         dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2510                                         "stream IDs.\n",
2511                                         eps[i]->desc.bEndpointAddress,
2512                                         max_stream);
2513                         ret_streams = max_stream;
2514                 }
2515         }
2516
2517         for (i = 0; i < num_eps; i++) {
2518                 index = dummy_get_ep_idx(&eps[i]->desc);
2519                 dum_hcd->stream_en_ep |= 1 << index;
2520                 set_max_streams_for_pipe(dum_hcd,
2521                                 usb_endpoint_num(&eps[i]->desc), ret_streams);
2522         }
2523 out:
2524         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2525         return ret_streams;
2526 }
2527
2528 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2529 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2530         struct usb_host_endpoint **eps, unsigned int num_eps,
2531         gfp_t mem_flags)
2532 {
2533         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2534         unsigned long flags;
2535         int ret;
2536         unsigned int index;
2537         unsigned int i;
2538
2539         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2540         for (i = 0; i < num_eps; i++) {
2541                 index = dummy_get_ep_idx(&eps[i]->desc);
2542                 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2543                         ret = -EINVAL;
2544                         goto out;
2545                 }
2546         }
2547
2548         for (i = 0; i < num_eps; i++) {
2549                 index = dummy_get_ep_idx(&eps[i]->desc);
2550                 dum_hcd->stream_en_ep &= ~(1 << index);
2551                 set_max_streams_for_pipe(dum_hcd,
2552                                 usb_endpoint_num(&eps[i]->desc), 0);
2553         }
2554         ret = 0;
2555 out:
2556         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2557         return ret;
2558 }
2559
2560 static struct hc_driver dummy_hcd = {
2561         .description =          (char *) driver_name,
2562         .product_desc =         "Dummy host controller",
2563         .hcd_priv_size =        sizeof(struct dummy_hcd),
2564
2565         .flags =                HCD_USB3 | HCD_SHARED,
2566
2567         .reset =                dummy_setup,
2568         .start =                dummy_start,
2569         .stop =                 dummy_stop,
2570
2571         .urb_enqueue =          dummy_urb_enqueue,
2572         .urb_dequeue =          dummy_urb_dequeue,
2573
2574         .get_frame_number =     dummy_h_get_frame,
2575
2576         .hub_status_data =      dummy_hub_status,
2577         .hub_control =          dummy_hub_control,
2578         .bus_suspend =          dummy_bus_suspend,
2579         .bus_resume =           dummy_bus_resume,
2580
2581         .alloc_streams =        dummy_alloc_streams,
2582         .free_streams =         dummy_free_streams,
2583 };
2584
2585 static int dummy_hcd_probe(struct platform_device *pdev)
2586 {
2587         struct dummy            *dum;
2588         struct usb_hcd          *hs_hcd;
2589         struct usb_hcd          *ss_hcd;
2590         int                     retval;
2591
2592         dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2593         dum = *((void **)dev_get_platdata(&pdev->dev));
2594
2595         if (!mod_data.is_super_speed)
2596                 dummy_hcd.flags = HCD_USB2;
2597         hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2598         if (!hs_hcd)
2599                 return -ENOMEM;
2600         hs_hcd->has_tt = 1;
2601
2602         retval = usb_add_hcd(hs_hcd, 0, 0);
2603         if (retval)
2604                 goto put_usb2_hcd;
2605
2606         if (mod_data.is_super_speed) {
2607                 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2608                                         dev_name(&pdev->dev), hs_hcd);
2609                 if (!ss_hcd) {
2610                         retval = -ENOMEM;
2611                         goto dealloc_usb2_hcd;
2612                 }
2613
2614                 retval = usb_add_hcd(ss_hcd, 0, 0);
2615                 if (retval)
2616                         goto put_usb3_hcd;
2617         }
2618         return 0;
2619
2620 put_usb3_hcd:
2621         usb_put_hcd(ss_hcd);
2622 dealloc_usb2_hcd:
2623         usb_remove_hcd(hs_hcd);
2624 put_usb2_hcd:
2625         usb_put_hcd(hs_hcd);
2626         dum->hs_hcd = dum->ss_hcd = NULL;
2627         return retval;
2628 }
2629
2630 static int dummy_hcd_remove(struct platform_device *pdev)
2631 {
2632         struct dummy            *dum;
2633
2634         dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2635
2636         if (dum->ss_hcd) {
2637                 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2638                 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2639         }
2640
2641         usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2642         usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2643
2644         dum->hs_hcd = NULL;
2645         dum->ss_hcd = NULL;
2646
2647         return 0;
2648 }
2649
2650 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2651 {
2652         struct usb_hcd          *hcd;
2653         struct dummy_hcd        *dum_hcd;
2654         int                     rc = 0;
2655
2656         dev_dbg(&pdev->dev, "%s\n", __func__);
2657
2658         hcd = platform_get_drvdata(pdev);
2659         dum_hcd = hcd_to_dummy_hcd(hcd);
2660         if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2661                 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2662                 rc = -EBUSY;
2663         } else
2664                 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2665         return rc;
2666 }
2667
2668 static int dummy_hcd_resume(struct platform_device *pdev)
2669 {
2670         struct usb_hcd          *hcd;
2671
2672         dev_dbg(&pdev->dev, "%s\n", __func__);
2673
2674         hcd = platform_get_drvdata(pdev);
2675         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2676         usb_hcd_poll_rh_status(hcd);
2677         return 0;
2678 }
2679
2680 static struct platform_driver dummy_hcd_driver = {
2681         .probe          = dummy_hcd_probe,
2682         .remove         = dummy_hcd_remove,
2683         .suspend        = dummy_hcd_suspend,
2684         .resume         = dummy_hcd_resume,
2685         .driver         = {
2686                 .name   = (char *) driver_name,
2687         },
2688 };
2689
2690 /*-------------------------------------------------------------------------*/
2691 #define MAX_NUM_UDC     2
2692 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2693 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2694
2695 static int __init init(void)
2696 {
2697         int     retval = -ENOMEM;
2698         int     i;
2699         struct  dummy *dum[MAX_NUM_UDC];
2700
2701         if (usb_disabled())
2702                 return -ENODEV;
2703
2704         if (!mod_data.is_high_speed && mod_data.is_super_speed)
2705                 return -EINVAL;
2706
2707         if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2708                 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2709                                 MAX_NUM_UDC);
2710                 return -EINVAL;
2711         }
2712
2713         for (i = 0; i < mod_data.num; i++) {
2714                 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2715                 if (!the_hcd_pdev[i]) {
2716                         i--;
2717                         while (i >= 0)
2718                                 platform_device_put(the_hcd_pdev[i--]);
2719                         return retval;
2720                 }
2721         }
2722         for (i = 0; i < mod_data.num; i++) {
2723                 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2724                 if (!the_udc_pdev[i]) {
2725                         i--;
2726                         while (i >= 0)
2727                                 platform_device_put(the_udc_pdev[i--]);
2728                         goto err_alloc_udc;
2729                 }
2730         }
2731         for (i = 0; i < mod_data.num; i++) {
2732                 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2733                 if (!dum[i]) {
2734                         retval = -ENOMEM;
2735                         goto err_add_pdata;
2736                 }
2737                 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2738                                 sizeof(void *));
2739                 if (retval)
2740                         goto err_add_pdata;
2741                 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2742                                 sizeof(void *));
2743                 if (retval)
2744                         goto err_add_pdata;
2745         }
2746
2747         retval = platform_driver_register(&dummy_hcd_driver);
2748         if (retval < 0)
2749                 goto err_add_pdata;
2750         retval = platform_driver_register(&dummy_udc_driver);
2751         if (retval < 0)
2752                 goto err_register_udc_driver;
2753
2754         for (i = 0; i < mod_data.num; i++) {
2755                 retval = platform_device_add(the_hcd_pdev[i]);
2756                 if (retval < 0) {
2757                         i--;
2758                         while (i >= 0)
2759                                 platform_device_del(the_hcd_pdev[i--]);
2760                         goto err_add_hcd;
2761                 }
2762         }
2763         for (i = 0; i < mod_data.num; i++) {
2764                 if (!dum[i]->hs_hcd ||
2765                                 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2766                         /*
2767                          * The hcd was added successfully but its probe
2768                          * function failed for some reason.
2769                          */
2770                         retval = -EINVAL;
2771                         goto err_add_udc;
2772                 }
2773         }
2774
2775         for (i = 0; i < mod_data.num; i++) {
2776                 retval = platform_device_add(the_udc_pdev[i]);
2777                 if (retval < 0) {
2778                         i--;
2779                         while (i >= 0)
2780                                 platform_device_del(the_udc_pdev[i]);
2781                         goto err_add_udc;
2782                 }
2783         }
2784
2785         for (i = 0; i < mod_data.num; i++) {
2786                 if (!platform_get_drvdata(the_udc_pdev[i])) {
2787                         /*
2788                          * The udc was added successfully but its probe
2789                          * function failed for some reason.
2790                          */
2791                         retval = -EINVAL;
2792                         goto err_probe_udc;
2793                 }
2794         }
2795         return retval;
2796
2797 err_probe_udc:
2798         for (i = 0; i < mod_data.num; i++)
2799                 platform_device_del(the_udc_pdev[i]);
2800 err_add_udc:
2801         for (i = 0; i < mod_data.num; i++)
2802                 platform_device_del(the_hcd_pdev[i]);
2803 err_add_hcd:
2804         platform_driver_unregister(&dummy_udc_driver);
2805 err_register_udc_driver:
2806         platform_driver_unregister(&dummy_hcd_driver);
2807 err_add_pdata:
2808         for (i = 0; i < mod_data.num; i++)
2809                 kfree(dum[i]);
2810         for (i = 0; i < mod_data.num; i++)
2811                 platform_device_put(the_udc_pdev[i]);
2812 err_alloc_udc:
2813         for (i = 0; i < mod_data.num; i++)
2814                 platform_device_put(the_hcd_pdev[i]);
2815         return retval;
2816 }
2817 module_init(init);
2818
2819 static void __exit cleanup(void)
2820 {
2821         int i;
2822
2823         for (i = 0; i < mod_data.num; i++) {
2824                 struct dummy *dum;
2825
2826                 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2827
2828                 platform_device_unregister(the_udc_pdev[i]);
2829                 platform_device_unregister(the_hcd_pdev[i]);
2830                 kfree(dum);
2831         }
2832         platform_driver_unregister(&dummy_udc_driver);
2833         platform_driver_unregister(&dummy_hcd_driver);
2834 }
2835 module_exit(cleanup);