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         int i;
 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         for (i = 0; i < DUMMY_ENDPOINTS; ++i)
 342                 nuke(dum, &dum->ep[i]);
 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_ep         *ep;
 651         struct dummy_request    *req;
 652
 653         if (!_ep)
 654                 return NULL;
 655         ep = usb_ep_to_dummy_ep(_ep);
 656
 657         req = kzalloc(sizeof(*req), mem_flags);
 658         if (!req)
 659                 return NULL;
 660         INIT_LIST_HEAD(&req->queue);
 661         return &req->req;
 662 }
 663
 664 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
 665 {
 666         struct dummy_request    *req;
 667
 668         if (!_ep || !_req) {
 669                 WARN_ON(1);
 670                 return;
 671         }
 672
 673         req = usb_request_to_dummy_request(_req);
 674         WARN_ON(!list_empty(&req->queue));
 675         kfree(req);
 676 }
 677
 678 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
 679 {
 680 }
 681
 682 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
 683                 gfp_t mem_flags)
 684 {
 685         struct dummy_ep         *ep;
 686         struct dummy_request    *req;
 687         struct dummy            *dum;
 688         struct dummy_hcd        *dum_hcd;
 689         unsigned long           flags;
 690
 691         req = usb_request_to_dummy_request(_req);
 692         if (!_req || !list_empty(&req->queue) || !_req->complete)
 693                 return -EINVAL;
 694
 695         ep = usb_ep_to_dummy_ep(_ep);
 696         if (!_ep || (!ep->desc && _ep->name != ep0name))
 697                 return -EINVAL;
 698
 699         dum = ep_to_dummy(ep);
 700         dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
 701         if (!dum->driver || !is_enabled(dum_hcd))
 702                 return -ESHUTDOWN;
 703
 704 #if 0
 705         dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
 706                         ep, _req, _ep->name, _req->length, _req->buf);
 707 #endif
 708         _req->status = -EINPROGRESS;
 709         _req->actual = 0;
 710         spin_lock_irqsave(&dum->lock, flags);
 711
 712         /* implement an emulated single-request FIFO */
 713         if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
 714                         list_empty(&dum->fifo_req.queue) &&
 715                         list_empty(&ep->queue) &&
 716                         _req->length <= FIFO_SIZE) {
 717                 req = &dum->fifo_req;
 718                 req->req = *_req;
 719                 req->req.buf = dum->fifo_buf;
 720                 memcpy(dum->fifo_buf, _req->buf, _req->length);
 721                 req->req.context = dum;
 722                 req->req.complete = fifo_complete;
 723
 724                 list_add_tail(&req->queue, &ep->queue);
 725                 spin_unlock(&dum->lock);
 726                 _req->actual = _req->length;
 727                 _req->status = 0;
 728                 usb_gadget_giveback_request(_ep, _req);
 729                 spin_lock(&dum->lock);
 730         }  else
 731                 list_add_tail(&req->queue, &ep->queue);
 732         spin_unlock_irqrestore(&dum->lock, flags);
 733
 734         /* real hardware would likely enable transfers here, in case
 735          * it'd been left NAKing.
 736          */
 737         return 0;
 738 }
 739
 740 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
 741 {
 742         struct dummy_ep         *ep;
 743         struct dummy            *dum;
 744         int                     retval = -EINVAL;
 745         unsigned long           flags;
 746         struct dummy_request    *req = NULL;
 747
 748         if (!_ep || !_req)
 749                 return retval;
 750         ep = usb_ep_to_dummy_ep(_ep);
 751         dum = ep_to_dummy(ep);
 752
 753         if (!dum->driver)
 754                 return -ESHUTDOWN;
 755
 756         local_irq_save(flags);
 757         spin_lock(&dum->lock);
 758         list_for_each_entry(req, &ep->queue, queue) {
 759                 if (&req->req == _req) {
 760                         list_del_init(&req->queue);
 761                         _req->status = -ECONNRESET;
 762                         retval = 0;
 763                         break;
 764                 }
 765         }
 766         spin_unlock(&dum->lock);
 767
 768         if (retval == 0) {
 769                 dev_dbg(udc_dev(dum),
 770                                 "dequeued req %p from %s, len %d buf %p\n",
 771                                 req, _ep->name, _req->length, _req->buf);
 772                 usb_gadget_giveback_request(_ep, _req);
 773         }
 774         local_irq_restore(flags);
 775         return retval;
 776 }
 777
 778 static int
 779 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
 780 {
 781         struct dummy_ep         *ep;
 782         struct dummy            *dum;
 783
 784         if (!_ep)
 785                 return -EINVAL;
 786         ep = usb_ep_to_dummy_ep(_ep);
 787         dum = ep_to_dummy(ep);
 788         if (!dum->driver)
 789                 return -ESHUTDOWN;
 790         if (!value)
 791                 ep->halted = ep->wedged = 0;
 792         else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
 793                         !list_empty(&ep->queue))
 794                 return -EAGAIN;
 795         else {
 796                 ep->halted = 1;
 797                 if (wedged)
 798                         ep->wedged = 1;
 799         }
 800         /* FIXME clear emulated data toggle too */
 801         return 0;
 802 }
 803
 804 static int
 805 dummy_set_halt(struct usb_ep *_ep, int value)
 806 {
 807         return dummy_set_halt_and_wedge(_ep, value, 0);
 808 }
 809
 810 static int dummy_set_wedge(struct usb_ep *_ep)
 811 {
 812         if (!_ep || _ep->name == ep0name)
 813                 return -EINVAL;
 814         return dummy_set_halt_and_wedge(_ep, 1, 1);
 815 }
 816
 817 static const struct usb_ep_ops dummy_ep_ops = {
 818         .enable         = dummy_enable,
 819         .disable        = dummy_disable,
 820
 821         .alloc_request  = dummy_alloc_request,
 822         .free_request   = dummy_free_request,
 823
 824         .queue          = dummy_queue,
 825         .dequeue        = dummy_dequeue,
 826
 827         .set_halt       = dummy_set_halt,
 828         .set_wedge      = dummy_set_wedge,
 829 };
 830
 831 /*-------------------------------------------------------------------------*/
 832
 833 /* there are both host and device side versions of this call ... */
 834 static int dummy_g_get_frame(struct usb_gadget *_gadget)
 835 {
 836         struct timespec64 ts64;
 837
 838         ktime_get_ts64(&ts64);
 839         return ts64.tv_nsec / NSEC_PER_MSEC;
 840 }
 841
 842 static int dummy_wakeup(struct usb_gadget *_gadget)
 843 {
 844         struct dummy_hcd *dum_hcd;
 845
 846         dum_hcd = gadget_to_dummy_hcd(_gadget);
 847         if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
 848                                 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
 849                 return -EINVAL;
 850         if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
 851                 return -ENOLINK;
 852         if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
 853                          dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
 854                 return -EIO;
 855
 856         /* FIXME: What if the root hub is suspended but the port isn't? */
 857
 858         /* hub notices our request, issues downstream resume, etc */
 859         dum_hcd->resuming = 1;
 860         dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
 861         mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
 862         return 0;
 863 }
 864
 865 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
 866 {
 867         struct dummy    *dum;
 868
 869         _gadget->is_selfpowered = (value != 0);
 870         dum = gadget_to_dummy_hcd(_gadget)->dum;
 871         if (value)
 872                 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
 873         else
 874                 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
 875         return 0;
 876 }
 877
 878 static void dummy_udc_update_ep0(struct dummy *dum)
 879 {
 880         if (dum->gadget.speed == USB_SPEED_SUPER)
 881                 dum->ep[0].ep.maxpacket = 9;
 882         else
 883                 dum->ep[0].ep.maxpacket = 64;
 884 }
 885
 886 static int dummy_pullup(struct usb_gadget *_gadget, int value)
 887 {
 888         struct dummy_hcd *dum_hcd;
 889         struct dummy    *dum;
 890         unsigned long   flags;
 891
 892         dum = gadget_dev_to_dummy(&_gadget->dev);
 893
 894         if (value && dum->driver) {
 895                 if (mod_data.is_super_speed)
 896                         dum->gadget.speed = dum->driver->max_speed;
 897                 else if (mod_data.is_high_speed)
 898                         dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
 899                                         dum->driver->max_speed);
 900                 else
 901                         dum->gadget.speed = USB_SPEED_FULL;
 902                 dummy_udc_update_ep0(dum);
 903
 904                 if (dum->gadget.speed < dum->driver->max_speed)
 905                         dev_dbg(udc_dev(dum), "This device can perform faster"
 906                                 " if you connect it to a %s port...\n",
 907                                 usb_speed_string(dum->driver->max_speed));
 908         }
 909         dum_hcd = gadget_to_dummy_hcd(_gadget);
 910
 911         spin_lock_irqsave(&dum->lock, flags);
 912         dum->pullup = (value != 0);
 913         set_link_state(dum_hcd);
 914         spin_unlock_irqrestore(&dum->lock, flags);
 915
 916         usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
 917         return 0;
 918 }
 919
 920 static int dummy_udc_start(struct usb_gadget *g,
 921                 struct usb_gadget_driver *driver);
 922 static int dummy_udc_stop(struct usb_gadget *g);
 923
 924 static const struct usb_gadget_ops dummy_ops = {
 925         .get_frame      = dummy_g_get_frame,
 926         .wakeup         = dummy_wakeup,
 927         .set_selfpowered = dummy_set_selfpowered,
 928         .pullup         = dummy_pullup,
 929         .udc_start      = dummy_udc_start,
 930         .udc_stop       = dummy_udc_stop,
 931 };
 932
 933 /*-------------------------------------------------------------------------*/
 934
 935 /* "function" sysfs attribute */
 936 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
 937                 char *buf)
 938 {
 939         struct dummy    *dum = gadget_dev_to_dummy(dev);
 940
 941         if (!dum->driver || !dum->driver->function)
 942                 return 0;
 943         return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
 944 }
 945 static DEVICE_ATTR_RO(function);
 946
 947 /*-------------------------------------------------------------------------*/
 948
 949 /*
 950  * Driver registration/unregistration.
 951  *
 952  * This is basically hardware-specific; there's usually only one real USB
 953  * device (not host) controller since that's how USB devices are intended
 954  * to work.  So most implementations of these api calls will rely on the
 955  * fact that only one driver will ever bind to the hardware.  But curious
 956  * hardware can be built with discrete components, so the gadget API doesn't
 957  * require that assumption.
 958  *
 959  * For this emulator, it might be convenient to create a usb slave device
 960  * for each driver that registers:  just add to a big root hub.
 961  */
 962
 963 static int dummy_udc_start(struct usb_gadget *g,
 964                 struct usb_gadget_driver *driver)
 965 {
 966         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(g);
 967         struct dummy            *dum = dum_hcd->dum;
 968
 969         if (driver->max_speed == USB_SPEED_UNKNOWN)
 970                 return -EINVAL;
 971
 972         /*
 973          * SLAVE side init ... the layer above hardware, which
 974          * can't enumerate without help from the driver we're binding.
 975          */
 976
 977         dum->devstatus = 0;
 978         dum->driver = driver;
 979
 980         return 0;
 981 }
 982
 983 static int dummy_udc_stop(struct usb_gadget *g)
 984 {
 985         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(g);
 986         struct dummy            *dum = dum_hcd->dum;
 987
 988         dum->driver = NULL;
 989
 990         return 0;
 991 }
 992
 993 #undef is_enabled
 994
 995 /* The gadget structure is stored inside the hcd structure and will be
 996  * released along with it. */
 997 static void init_dummy_udc_hw(struct dummy *dum)
 998 {
 999         int i;
1000
1001         INIT_LIST_HEAD(&dum->gadget.ep_list);
1002         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1003                 struct dummy_ep *ep = &dum->ep[i];
1004
1005                 if (!ep_info[i].name)
1006                         break;
1007                 ep->ep.name = ep_info[i].name;
1008                 ep->ep.caps = ep_info[i].caps;
1009                 ep->ep.ops = &dummy_ep_ops;
1010                 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1011                 ep->halted = ep->wedged = ep->already_seen =
1012                                 ep->setup_stage = 0;
1013                 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1014                 ep->ep.max_streams = 16;
1015                 ep->last_io = jiffies;
1016                 ep->gadget = &dum->gadget;
1017                 ep->desc = NULL;
1018                 INIT_LIST_HEAD(&ep->queue);
1019         }
1020
1021         dum->gadget.ep0 = &dum->ep[0].ep;
1022         list_del_init(&dum->ep[0].ep.ep_list);
1023         INIT_LIST_HEAD(&dum->fifo_req.queue);
1024
1025 #ifdef CONFIG_USB_OTG
1026         dum->gadget.is_otg = 1;
1027 #endif
1028 }
1029
1030 static int dummy_udc_probe(struct platform_device *pdev)
1031 {
1032         struct dummy    *dum;
1033         int             rc;
1034
1035         dum = *((void **)dev_get_platdata(&pdev->dev));
1036         /* Clear usb_gadget region for new registration to udc-core */
1037         memzero_explicit(&dum->gadget, sizeof(struct usb_gadget));
1038         dum->gadget.name = gadget_name;
1039         dum->gadget.ops = &dummy_ops;
1040         dum->gadget.max_speed = USB_SPEED_SUPER;
1041
1042         dum->gadget.dev.parent = &pdev->dev;
1043         init_dummy_udc_hw(dum);
1044
1045         rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1046         if (rc < 0)
1047                 goto err_udc;
1048
1049         rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1050         if (rc < 0)
1051                 goto err_dev;
1052         platform_set_drvdata(pdev, dum);
1053         return rc;
1054
1055 err_dev:
1056         usb_del_gadget_udc(&dum->gadget);
1057 err_udc:
1058         return rc;
1059 }
1060
1061 static int dummy_udc_remove(struct platform_device *pdev)
1062 {
1063         struct dummy    *dum = platform_get_drvdata(pdev);
1064
1065         device_remove_file(&dum->gadget.dev, &dev_attr_function);
1066         usb_del_gadget_udc(&dum->gadget);
1067         return 0;
1068 }
1069
1070 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1071                 int suspend)
1072 {
1073         spin_lock_irq(&dum->lock);
1074         dum->udc_suspended = suspend;
1075         set_link_state(dum_hcd);
1076         spin_unlock_irq(&dum->lock);
1077 }
1078
1079 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1080 {
1081         struct dummy            *dum = platform_get_drvdata(pdev);
1082         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1083
1084         dev_dbg(&pdev->dev, "%s\n", __func__);
1085         dummy_udc_pm(dum, dum_hcd, 1);
1086         usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1087         return 0;
1088 }
1089
1090 static int dummy_udc_resume(struct platform_device *pdev)
1091 {
1092         struct dummy            *dum = platform_get_drvdata(pdev);
1093         struct dummy_hcd        *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1094
1095         dev_dbg(&pdev->dev, "%s\n", __func__);
1096         dummy_udc_pm(dum, dum_hcd, 0);
1097         usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1098         return 0;
1099 }
1100
1101 static struct platform_driver dummy_udc_driver = {
1102         .probe          = dummy_udc_probe,
1103         .remove         = dummy_udc_remove,
1104         .suspend        = dummy_udc_suspend,
1105         .resume         = dummy_udc_resume,
1106         .driver         = {
1107                 .name   = (char *) gadget_name,
1108         },
1109 };
1110
1111 /*-------------------------------------------------------------------------*/
1112
1113 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1114 {
1115         unsigned int index;
1116
1117         index = usb_endpoint_num(desc) << 1;
1118         if (usb_endpoint_dir_in(desc))
1119                 index |= 1;
1120         return index;
1121 }
1122
1123 /* MASTER/HOST SIDE DRIVER
1124  *
1125  * this uses the hcd framework to hook up to host side drivers.
1126  * its root hub will only have one device, otherwise it acts like
1127  * a normal host controller.
1128  *
1129  * when urbs are queued, they're just stuck on a list that we
1130  * scan in a timer callback.  that callback connects writes from
1131  * the host with reads from the device, and so on, based on the
1132  * usb 2.0 rules.
1133  */
1134
1135 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1136 {
1137         const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1138         u32 index;
1139
1140         if (!usb_endpoint_xfer_bulk(desc))
1141                 return 0;
1142
1143         index = dummy_get_ep_idx(desc);
1144         return (1 << index) & dum_hcd->stream_en_ep;
1145 }
1146
1147 /*
1148  * The max stream number is saved as a nibble so for the 30 possible endpoints
1149  * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1150  * means we use only 1 stream). The maximum according to the spec is 16bit so
1151  * if the 16 stream limit is about to go, the array size should be incremented
1152  * to 30 elements of type u16.
1153  */
1154 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1155                 unsigned int pipe)
1156 {
1157         int max_streams;
1158
1159         max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1160         if (usb_pipeout(pipe))
1161                 max_streams >>= 4;
1162         else
1163                 max_streams &= 0xf;
1164         max_streams++;
1165         return max_streams;
1166 }
1167
1168 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1169                 unsigned int pipe, unsigned int streams)
1170 {
1171         int max_streams;
1172
1173         streams--;
1174         max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1175         if (usb_pipeout(pipe)) {
1176                 streams <<= 4;
1177                 max_streams &= 0xf;
1178         } else {
1179                 max_streams &= 0xf0;
1180         }
1181         max_streams |= streams;
1182         dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1183 }
1184
1185 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1186 {
1187         unsigned int max_streams;
1188         int enabled;
1189
1190         enabled = dummy_ep_stream_en(dum_hcd, urb);
1191         if (!urb->stream_id) {
1192                 if (enabled)
1193                         return -EINVAL;
1194                 return 0;
1195         }
1196         if (!enabled)
1197                 return -EINVAL;
1198
1199         max_streams = get_max_streams_for_pipe(dum_hcd,
1200                         usb_pipeendpoint(urb->pipe));
1201         if (urb->stream_id > max_streams) {
1202                 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1203                                 urb->stream_id);
1204                 BUG();
1205                 return -EINVAL;
1206         }
1207         return 0;
1208 }
1209
1210 static int dummy_urb_enqueue(
1211         struct usb_hcd                  *hcd,
1212         struct urb                      *urb,
1213         gfp_t                           mem_flags
1214 ) {
1215         struct dummy_hcd *dum_hcd;
1216         struct urbp     *urbp;
1217         unsigned long   flags;
1218         int             rc;
1219
1220         urbp = kmalloc(sizeof *urbp, mem_flags);
1221         if (!urbp)
1222                 return -ENOMEM;
1223         urbp->urb = urb;
1224         urbp->miter_started = 0;
1225
1226         dum_hcd = hcd_to_dummy_hcd(hcd);
1227         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1228
1229         rc = dummy_validate_stream(dum_hcd, urb);
1230         if (rc) {
1231                 kfree(urbp);
1232                 goto done;
1233         }
1234
1235         rc = usb_hcd_link_urb_to_ep(hcd, urb);
1236         if (rc) {
1237                 kfree(urbp);
1238                 goto done;
1239         }
1240
1241         if (!dum_hcd->udev) {
1242                 dum_hcd->udev = urb->dev;
1243                 usb_get_dev(dum_hcd->udev);
1244         } else if (unlikely(dum_hcd->udev != urb->dev))
1245                 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1246
1247         list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1248         urb->hcpriv = urbp;
1249         if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1250                 urb->error_count = 1;           /* mark as a new urb */
1251
1252         /* kick the scheduler, it'll do the rest */
1253         if (!timer_pending(&dum_hcd->timer))
1254                 mod_timer(&dum_hcd->timer, jiffies + 1);
1255
1256  done:
1257         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1258         return rc;
1259 }
1260
1261 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1262 {
1263         struct dummy_hcd *dum_hcd;
1264         unsigned long   flags;
1265         int             rc;
1266
1267         /* giveback happens automatically in timer callback,
1268          * so make sure the callback happens */
1269         dum_hcd = hcd_to_dummy_hcd(hcd);
1270         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1271
1272         rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1273         if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1274                         !list_empty(&dum_hcd->urbp_list))
1275                 mod_timer(&dum_hcd->timer, jiffies);
1276
1277         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1278         return rc;
1279 }
1280
1281 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1282                 u32 len)
1283 {
1284         void *ubuf, *rbuf;
1285         struct urbp *urbp = urb->hcpriv;
1286         int to_host;
1287         struct sg_mapping_iter *miter = &urbp->miter;
1288         u32 trans = 0;
1289         u32 this_sg;
1290         bool next_sg;
1291
1292         to_host = usb_pipein(urb->pipe);
1293         rbuf = req->req.buf + req->req.actual;
1294
1295         if (!urb->num_sgs) {
1296                 ubuf = urb->transfer_buffer + urb->actual_length;
1297                 if (to_host)
1298                         memcpy(ubuf, rbuf, len);
1299                 else
1300                         memcpy(rbuf, ubuf, len);
1301                 return len;
1302         }
1303
1304         if (!urbp->miter_started) {
1305                 u32 flags = SG_MITER_ATOMIC;
1306
1307                 if (to_host)
1308                         flags |= SG_MITER_TO_SG;
1309                 else
1310                         flags |= SG_MITER_FROM_SG;
1311
1312                 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1313                 urbp->miter_started = 1;
1314         }
1315         next_sg = sg_miter_next(miter);
1316         if (next_sg == false) {
1317                 WARN_ON_ONCE(1);
1318                 return -EINVAL;
1319         }
1320         do {
1321                 ubuf = miter->addr;
1322                 this_sg = min_t(u32, len, miter->length);
1323                 miter->consumed = this_sg;
1324                 trans += this_sg;
1325
1326                 if (to_host)
1327                         memcpy(ubuf, rbuf, this_sg);
1328                 else
1329                         memcpy(rbuf, ubuf, this_sg);
1330                 len -= this_sg;
1331
1332                 if (!len)
1333                         break;
1334                 next_sg = sg_miter_next(miter);
1335                 if (next_sg == false) {
1336                         WARN_ON_ONCE(1);
1337                         return -EINVAL;
1338                 }
1339
1340                 rbuf += this_sg;
1341         } while (1);
1342
1343         sg_miter_stop(miter);
1344         return trans;
1345 }
1346
1347 /* transfer up to a frame's worth; caller must own lock */
1348 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1349                 struct dummy_ep *ep, int limit, int *status)
1350 {
1351         struct dummy            *dum = dum_hcd->dum;
1352         struct dummy_request    *req;
1353         int                     sent = 0;
1354
1355 top:
1356         /* if there's no request queued, the device is NAKing; return */
1357         list_for_each_entry(req, &ep->queue, queue) {
1358                 unsigned        host_len, dev_len, len;
1359                 int             is_short, to_host;
1360                 int             rescan = 0;
1361
1362                 if (dummy_ep_stream_en(dum_hcd, urb)) {
1363                         if ((urb->stream_id != req->req.stream_id))
1364                                 continue;
1365                 }
1366
1367                 /* 1..N packets of ep->ep.maxpacket each ... the last one
1368                  * may be short (including zero length).
1369                  *
1370                  * writer can send a zlp explicitly (length 0) or implicitly
1371                  * (length mod maxpacket zero, and 'zero' flag); they always
1372                  * terminate reads.
1373                  */
1374                 host_len = urb->transfer_buffer_length - urb->actual_length;
1375                 dev_len = req->req.length - req->req.actual;
1376                 len = min(host_len, dev_len);
1377
1378                 /* FIXME update emulated data toggle too */
1379
1380                 to_host = usb_pipein(urb->pipe);
1381                 if (unlikely(len == 0))
1382                         is_short = 1;
1383                 else {
1384                         /* not enough bandwidth left? */
1385                         if (limit < ep->ep.maxpacket && limit < len)
1386                                 break;
1387                         len = min_t(unsigned, len, limit);
1388                         if (len == 0)
1389                                 break;
1390
1391                         /* send multiple of maxpacket first, then remainder */
1392                         if (len >= ep->ep.maxpacket) {
1393                                 is_short = 0;
1394                                 if (len % ep->ep.maxpacket)
1395                                         rescan = 1;
1396                                 len -= len % ep->ep.maxpacket;
1397                         } else {
1398                                 is_short = 1;
1399                         }
1400
1401                         len = dummy_perform_transfer(urb, req, len);
1402
1403                         ep->last_io = jiffies;
1404                         if ((int)len < 0) {
1405                                 req->req.status = len;
1406                         } else {
1407                                 limit -= len;
1408                                 sent += len;
1409                                 urb->actual_length += len;
1410                                 req->req.actual += len;
1411                         }
1412                 }
1413
1414                 /* short packets terminate, maybe with overflow/underflow.
1415                  * it's only really an error to write too much.
1416                  *
1417                  * partially filling a buffer optionally blocks queue advances
1418                  * (so completion handlers can clean up the queue) but we don't
1419                  * need to emulate such data-in-flight.
1420                  */
1421                 if (is_short) {
1422                         if (host_len == dev_len) {
1423                                 req->req.status = 0;
1424                                 *status = 0;
1425                         } else if (to_host) {
1426                                 req->req.status = 0;
1427                                 if (dev_len > host_len)
1428                                         *status = -EOVERFLOW;
1429                                 else
1430                                         *status = 0;
1431                         } else {
1432                                 *status = 0;
1433                                 if (host_len > dev_len)
1434                                         req->req.status = -EOVERFLOW;
1435                                 else
1436                                         req->req.status = 0;
1437                         }
1438
1439                 /*
1440                  * many requests terminate without a short packet.
1441                  * send a zlp if demanded by flags.
1442                  */
1443                 } else {
1444                         if (req->req.length == req->req.actual) {
1445                                 if (req->req.zero && to_host)
1446                                         rescan = 1;
1447                                 else
1448                                         req->req.status = 0;
1449                         }
1450                         if (urb->transfer_buffer_length == urb->actual_length) {
1451                                 if (urb->transfer_flags & URB_ZERO_PACKET &&
1452                                     !to_host)
1453                                         rescan = 1;
1454                                 else
1455                                         *status = 0;
1456                         }
1457                 }
1458
1459                 /* device side completion --> continuable */
1460                 if (req->req.status != -EINPROGRESS) {
1461                         list_del_init(&req->queue);
1462
1463                         spin_unlock(&dum->lock);
1464                         usb_gadget_giveback_request(&ep->ep, &req->req);
1465                         spin_lock(&dum->lock);
1466
1467                         /* requests might have been unlinked... */
1468                         rescan = 1;
1469                 }
1470
1471                 /* host side completion --> terminate */
1472                 if (*status != -EINPROGRESS)
1473                         break;
1474
1475                 /* rescan to continue with any other queued i/o */
1476                 if (rescan)
1477                         goto top;
1478         }
1479         return sent;
1480 }
1481
1482 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1483 {
1484         int     limit = ep->ep.maxpacket;
1485
1486         if (dum->gadget.speed == USB_SPEED_HIGH) {
1487                 int     tmp;
1488
1489                 /* high bandwidth mode */
1490                 tmp = usb_endpoint_maxp(ep->desc);
1491                 tmp = (tmp >> 11) & 0x03;
1492                 tmp *= 8 /* applies to entire frame */;
1493                 limit += limit * tmp;
1494         }
1495         if (dum->gadget.speed == USB_SPEED_SUPER) {
1496                 switch (usb_endpoint_type(ep->desc)) {
1497                 case USB_ENDPOINT_XFER_ISOC:
1498                         /* Sec. 4.4.8.2 USB3.0 Spec */
1499                         limit = 3 * 16 * 1024 * 8;
1500                         break;
1501                 case USB_ENDPOINT_XFER_INT:
1502                         /* Sec. 4.4.7.2 USB3.0 Spec */
1503                         limit = 3 * 1024 * 8;
1504                         break;
1505                 case USB_ENDPOINT_XFER_BULK:
1506                 default:
1507                         break;
1508                 }
1509         }
1510         return limit;
1511 }
1512
1513 #define is_active(dum_hcd)      ((dum_hcd->port_status & \
1514                 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1515                         USB_PORT_STAT_SUSPEND)) \
1516                 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1517
1518 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1519 {
1520         int             i;
1521
1522         if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1523                         dum->ss_hcd : dum->hs_hcd)))
1524                 return NULL;
1525         if ((address & ~USB_DIR_IN) == 0)
1526                 return &dum->ep[0];
1527         for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1528                 struct dummy_ep *ep = &dum->ep[i];
1529
1530                 if (!ep->desc)
1531                         continue;
1532                 if (ep->desc->bEndpointAddress == address)
1533                         return ep;
1534         }
1535         return NULL;
1536 }
1537
1538 #undef is_active
1539
1540 #define Dev_Request     (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1541 #define Dev_InRequest   (Dev_Request | USB_DIR_IN)
1542 #define Intf_Request    (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1543 #define Intf_InRequest  (Intf_Request | USB_DIR_IN)
1544 #define Ep_Request      (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1545 #define Ep_InRequest    (Ep_Request | USB_DIR_IN)
1546
1547
1548 /**
1549  * handle_control_request() - handles all control transfers
1550  * @dum: pointer to dummy (the_controller)
1551  * @urb: the urb request to handle
1552  * @setup: pointer to the setup data for a USB device control
1553  *       request
1554  * @status: pointer to request handling status
1555  *
1556  * Return 0 - if the request was handled
1557  *        1 - if the request wasn't handles
1558  *        error code on error
1559  */
1560 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1561                                   struct usb_ctrlrequest *setup,
1562                                   int *status)
1563 {
1564         struct dummy_ep         *ep2;
1565         struct dummy            *dum = dum_hcd->dum;
1566         int                     ret_val = 1;
1567         unsigned        w_index;
1568         unsigned        w_value;
1569
1570         w_index = le16_to_cpu(setup->wIndex);
1571         w_value = le16_to_cpu(setup->wValue);
1572         switch (setup->bRequest) {
1573         case USB_REQ_SET_ADDRESS:
1574                 if (setup->bRequestType != Dev_Request)
1575                         break;
1576                 dum->address = w_value;
1577                 *status = 0;
1578                 dev_dbg(udc_dev(dum), "set_address = %d\n",
1579                                 w_value);
1580                 ret_val = 0;
1581                 break;
1582         case USB_REQ_SET_FEATURE:
1583                 if (setup->bRequestType == Dev_Request) {
1584                         ret_val = 0;
1585                         switch (w_value) {
1586                         case USB_DEVICE_REMOTE_WAKEUP:
1587                                 break;
1588                         case USB_DEVICE_B_HNP_ENABLE:
1589                                 dum->gadget.b_hnp_enable = 1;
1590                                 break;
1591                         case USB_DEVICE_A_HNP_SUPPORT:
1592                                 dum->gadget.a_hnp_support = 1;
1593                                 break;
1594                         case USB_DEVICE_A_ALT_HNP_SUPPORT:
1595                                 dum->gadget.a_alt_hnp_support = 1;
1596                                 break;
1597                         case USB_DEVICE_U1_ENABLE:
1598                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1599                                     HCD_USB3)
1600                                         w_value = USB_DEV_STAT_U1_ENABLED;
1601                                 else
1602                                         ret_val = -EOPNOTSUPP;
1603                                 break;
1604                         case USB_DEVICE_U2_ENABLE:
1605                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1606                                     HCD_USB3)
1607                                         w_value = USB_DEV_STAT_U2_ENABLED;
1608                                 else
1609                                         ret_val = -EOPNOTSUPP;
1610                                 break;
1611                         case USB_DEVICE_LTM_ENABLE:
1612                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1613                                     HCD_USB3)
1614                                         w_value = USB_DEV_STAT_LTM_ENABLED;
1615                                 else
1616                                         ret_val = -EOPNOTSUPP;
1617                                 break;
1618                         default:
1619                                 ret_val = -EOPNOTSUPP;
1620                         }
1621                         if (ret_val == 0) {
1622                                 dum->devstatus |= (1 << w_value);
1623                                 *status = 0;
1624                         }
1625                 } else if (setup->bRequestType == Ep_Request) {
1626                         /* endpoint halt */
1627                         ep2 = find_endpoint(dum, w_index);
1628                         if (!ep2 || ep2->ep.name == ep0name) {
1629                                 ret_val = -EOPNOTSUPP;
1630                                 break;
1631                         }
1632                         ep2->halted = 1;
1633                         ret_val = 0;
1634                         *status = 0;
1635                 }
1636                 break;
1637         case USB_REQ_CLEAR_FEATURE:
1638                 if (setup->bRequestType == Dev_Request) {
1639                         ret_val = 0;
1640                         switch (w_value) {
1641                         case USB_DEVICE_REMOTE_WAKEUP:
1642                                 w_value = USB_DEVICE_REMOTE_WAKEUP;
1643                                 break;
1644                         case USB_DEVICE_U1_ENABLE:
1645                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1646                                     HCD_USB3)
1647                                         w_value = USB_DEV_STAT_U1_ENABLED;
1648                                 else
1649                                         ret_val = -EOPNOTSUPP;
1650                                 break;
1651                         case USB_DEVICE_U2_ENABLE:
1652                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1653                                     HCD_USB3)
1654                                         w_value = USB_DEV_STAT_U2_ENABLED;
1655                                 else
1656                                         ret_val = -EOPNOTSUPP;
1657                                 break;
1658                         case USB_DEVICE_LTM_ENABLE:
1659                                 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1660                                     HCD_USB3)
1661                                         w_value = USB_DEV_STAT_LTM_ENABLED;
1662                                 else
1663                                         ret_val = -EOPNOTSUPP;
1664                                 break;
1665                         default:
1666                                 ret_val = -EOPNOTSUPP;
1667                                 break;
1668                         }
1669                         if (ret_val == 0) {
1670                                 dum->devstatus &= ~(1 << w_value);
1671                                 *status = 0;
1672                         }
1673                 } else if (setup->bRequestType == Ep_Request) {
1674                         /* endpoint halt */
1675                         ep2 = find_endpoint(dum, w_index);
1676                         if (!ep2) {
1677                                 ret_val = -EOPNOTSUPP;
1678                                 break;
1679                         }
1680                         if (!ep2->wedged)
1681                                 ep2->halted = 0;
1682                         ret_val = 0;
1683                         *status = 0;
1684                 }
1685                 break;
1686         case USB_REQ_GET_STATUS:
1687                 if (setup->bRequestType == Dev_InRequest
1688                                 || setup->bRequestType == Intf_InRequest
1689                                 || setup->bRequestType == Ep_InRequest) {
1690                         char *buf;
1691                         /*
1692                          * device: remote wakeup, selfpowered
1693                          * interface: nothing
1694                          * endpoint: halt
1695                          */
1696                         buf = (char *)urb->transfer_buffer;
1697                         if (urb->transfer_buffer_length > 0) {
1698                                 if (setup->bRequestType == Ep_InRequest) {
1699                                         ep2 = find_endpoint(dum, w_index);
1700                                         if (!ep2) {
1701                                                 ret_val = -EOPNOTSUPP;
1702                                                 break;
1703                                         }
1704                                         buf[0] = ep2->halted;
1705                                 } else if (setup->bRequestType ==
1706                                            Dev_InRequest) {
1707                                         buf[0] = (u8)dum->devstatus;
1708                                 } else
1709                                         buf[0] = 0;
1710                         }
1711                         if (urb->transfer_buffer_length > 1)
1712                                 buf[1] = 0;
1713                         urb->actual_length = min_t(u32, 2,
1714                                 urb->transfer_buffer_length);
1715                         ret_val = 0;
1716                         *status = 0;
1717                 }
1718                 break;
1719         }
1720         return ret_val;
1721 }
1722
1723 /* drive both sides of the transfers; looks like irq handlers to
1724  * both drivers except the callbacks aren't in_irq().
1725  */
1726 static void dummy_timer(unsigned long _dum_hcd)
1727 {
1728         struct dummy_hcd        *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1729         struct dummy            *dum = dum_hcd->dum;
1730         struct urbp             *urbp, *tmp;
1731         unsigned long           flags;
1732         int                     limit, total;
1733         int                     i;
1734
1735         /* simplistic model for one frame's bandwidth */
1736         switch (dum->gadget.speed) {
1737         case USB_SPEED_LOW:
1738                 total = 8/*bytes*/ * 12/*packets*/;
1739                 break;
1740         case USB_SPEED_FULL:
1741                 total = 64/*bytes*/ * 19/*packets*/;
1742                 break;
1743         case USB_SPEED_HIGH:
1744                 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1745                 break;
1746         case USB_SPEED_SUPER:
1747                 /* Bus speed is 500000 bytes/ms, so use a little less */
1748                 total = 490000;
1749                 break;
1750         default:
1751                 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1752                 return;
1753         }
1754
1755         /* FIXME if HZ != 1000 this will probably misbehave ... */
1756
1757         /* look at each urb queued by the host side driver */
1758         spin_lock_irqsave(&dum->lock, flags);
1759
1760         if (!dum_hcd->udev) {
1761                 dev_err(dummy_dev(dum_hcd),
1762                                 "timer fired with no URBs pending?\n");
1763                 spin_unlock_irqrestore(&dum->lock, flags);
1764                 return;
1765         }
1766
1767         for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1768                 if (!ep_info[i].name)
1769                         break;
1770                 dum->ep[i].already_seen = 0;
1771         }
1772
1773 restart:
1774         list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1775                 struct urb              *urb;
1776                 struct dummy_request    *req;
1777                 u8                      address;
1778                 struct dummy_ep         *ep = NULL;
1779                 int                     type;
1780                 int                     status = -EINPROGRESS;
1781
1782                 urb = urbp->urb;
1783                 if (urb->unlinked)
1784                         goto return_urb;
1785                 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1786                         continue;
1787                 type = usb_pipetype(urb->pipe);
1788
1789                 /* used up this frame's non-periodic bandwidth?
1790                  * FIXME there's infinite bandwidth for control and
1791                  * periodic transfers ... unrealistic.
1792                  */
1793                 if (total <= 0 && type == PIPE_BULK)
1794                         continue;
1795
1796                 /* find the gadget's ep for this request (if configured) */
1797                 address = usb_pipeendpoint (urb->pipe);
1798                 if (usb_pipein(urb->pipe))
1799                         address |= USB_DIR_IN;
1800                 ep = find_endpoint(dum, address);
1801                 if (!ep) {
1802                         /* set_configuration() disagreement */
1803                         dev_dbg(dummy_dev(dum_hcd),
1804                                 "no ep configured for urb %p\n",
1805                                 urb);
1806                         status = -EPROTO;
1807                         goto return_urb;
1808                 }
1809
1810                 if (ep->already_seen)
1811                         continue;
1812                 ep->already_seen = 1;
1813                 if (ep == &dum->ep[0] && urb->error_count) {
1814                         ep->setup_stage = 1;    /* a new urb */
1815                         urb->error_count = 0;
1816                 }
1817                 if (ep->halted && !ep->setup_stage) {
1818                         /* NOTE: must not be iso! */
1819                         dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1820                                         ep->ep.name, urb);
1821                         status = -EPIPE;
1822                         goto return_urb;
1823                 }
1824                 /* FIXME make sure both ends agree on maxpacket */
1825
1826                 /* handle control requests */
1827                 if (ep == &dum->ep[0] && ep->setup_stage) {
1828                         struct usb_ctrlrequest          setup;
1829                         int                             value = 1;
1830
1831                         setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1832                         /* paranoia, in case of stale queued data */
1833                         list_for_each_entry(req, &ep->queue, queue) {
1834                                 list_del_init(&req->queue);
1835                                 req->req.status = -EOVERFLOW;
1836                                 dev_dbg(udc_dev(dum), "stale req = %p\n",
1837                                                 req);
1838
1839                                 spin_unlock(&dum->lock);
1840                                 usb_gadget_giveback_request(&ep->ep, &req->req);
1841                                 spin_lock(&dum->lock);
1842                                 ep->already_seen = 0;
1843                                 goto restart;
1844                         }
1845
1846                         /* gadget driver never sees set_address or operations
1847                          * on standard feature flags.  some hardware doesn't
1848                          * even expose them.
1849                          */
1850                         ep->last_io = jiffies;
1851                         ep->setup_stage = 0;
1852                         ep->halted = 0;
1853
1854                         value = handle_control_request(dum_hcd, urb, &setup,
1855                                                        &status);
1856
1857                         /* gadget driver handles all other requests.  block
1858                          * until setup() returns; no reentrancy issues etc.
1859                          */
1860                         if (value > 0) {
1861                                 spin_unlock(&dum->lock);
1862                                 value = dum->driver->setup(&dum->gadget,
1863                                                 &setup);
1864                                 spin_lock(&dum->lock);
1865
1866                                 if (value >= 0) {
1867                                         /* no delays (max 64KB data stage) */
1868                                         limit = 64*1024;
1869                                         goto treat_control_like_bulk;
1870                                 }
1871                                 /* error, see below */
1872                         }
1873
1874                         if (value < 0) {
1875                                 if (value != -EOPNOTSUPP)
1876                                         dev_dbg(udc_dev(dum),
1877                                                 "setup --> %d\n",
1878                                                 value);
1879                                 status = -EPIPE;
1880                                 urb->actual_length = 0;
1881                         }
1882
1883                         goto return_urb;
1884                 }
1885
1886                 /* non-control requests */
1887                 limit = total;
1888                 switch (usb_pipetype(urb->pipe)) {
1889                 case PIPE_ISOCHRONOUS:
1890                         /* FIXME is it urb->interval since the last xfer?
1891                          * use urb->iso_frame_desc[i].
1892                          * complete whether or not ep has requests queued.
1893                          * report random errors, to debug drivers.
1894                          */
1895                         limit = max(limit, periodic_bytes(dum, ep));
1896                         status = -ENOSYS;
1897                         break;
1898
1899                 case PIPE_INTERRUPT:
1900                         /* FIXME is it urb->interval since the last xfer?
1901                          * this almost certainly polls too fast.
1902                          */
1903                         limit = max(limit, periodic_bytes(dum, ep));
1904                         /* FALLTHROUGH */
1905
1906                 default:
1907 treat_control_like_bulk:
1908                         ep->last_io = jiffies;
1909                         total -= transfer(dum_hcd, urb, ep, limit, &status);
1910                         break;
1911                 }
1912
1913                 /* incomplete transfer? */
1914                 if (status == -EINPROGRESS)
1915                         continue;
1916
1917 return_urb:
1918                 list_del(&urbp->urbp_list);
1919                 kfree(urbp);
1920                 if (ep)
1921                         ep->already_seen = ep->setup_stage = 0;
1922
1923                 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1924                 spin_unlock(&dum->lock);
1925                 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1926                 spin_lock(&dum->lock);
1927
1928                 goto restart;
1929         }
1930
1931         if (list_empty(&dum_hcd->urbp_list)) {
1932                 usb_put_dev(dum_hcd->udev);
1933                 dum_hcd->udev = NULL;
1934         } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1935                 /* want a 1 msec delay here */
1936                 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1937         }
1938
1939         spin_unlock_irqrestore(&dum->lock, flags);
1940 }
1941
1942 /*-------------------------------------------------------------------------*/
1943
1944 #define PORT_C_MASK \
1945         ((USB_PORT_STAT_C_CONNECTION \
1946         | USB_PORT_STAT_C_ENABLE \
1947         | USB_PORT_STAT_C_SUSPEND \
1948         | USB_PORT_STAT_C_OVERCURRENT \
1949         | USB_PORT_STAT_C_RESET) << 16)
1950
1951 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1952 {
1953         struct dummy_hcd        *dum_hcd;
1954         unsigned long           flags;
1955         int                     retval = 0;
1956
1957         dum_hcd = hcd_to_dummy_hcd(hcd);
1958
1959         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1960         if (!HCD_HW_ACCESSIBLE(hcd))
1961                 goto done;
1962
1963         if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
1964                 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1965                 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
1966                 set_link_state(dum_hcd);
1967         }
1968
1969         if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
1970                 *buf = (1 << 1);
1971                 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
1972                                 dum_hcd->port_status);
1973                 retval = 1;
1974                 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
1975                         usb_hcd_resume_root_hub(hcd);
1976         }
1977 done:
1978         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1979         return retval;
1980 }
1981
1982 /* usb 3.0 root hub device descriptor */
1983 static struct {
1984         struct usb_bos_descriptor bos;
1985         struct usb_ss_cap_descriptor ss_cap;
1986 } __packed usb3_bos_desc = {
1987
1988         .bos = {
1989                 .bLength                = USB_DT_BOS_SIZE,
1990                 .bDescriptorType        = USB_DT_BOS,
1991                 .wTotalLength           = cpu_to_le16(sizeof(usb3_bos_desc)),
1992                 .bNumDeviceCaps         = 1,
1993         },
1994         .ss_cap = {
1995                 .bLength                = USB_DT_USB_SS_CAP_SIZE,
1996                 .bDescriptorType        = USB_DT_DEVICE_CAPABILITY,
1997                 .bDevCapabilityType     = USB_SS_CAP_TYPE,
1998                 .wSpeedSupported        = cpu_to_le16(USB_5GBPS_OPERATION),
1999                 .bFunctionalitySupport  = ilog2(USB_5GBPS_OPERATION),
2000         },
2001 };
2002
2003 static inline void
2004 ss_hub_descriptor(struct usb_hub_descriptor *desc)
2005 {
2006         memset(desc, 0, sizeof *desc);
2007         desc->bDescriptorType = USB_DT_SS_HUB;
2008         desc->bDescLength = 12;
2009         desc->wHubCharacteristics = cpu_to_le16(
2010                         HUB_CHAR_INDV_PORT_LPSM |
2011                         HUB_CHAR_COMMON_OCPM);
2012         desc->bNbrPorts = 1;
2013         desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2014         desc->u.ss.DeviceRemovable = 0xffff;
2015 }
2016
2017 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2018 {
2019         memset(desc, 0, sizeof *desc);
2020         desc->bDescriptorType = USB_DT_HUB;
2021         desc->bDescLength = 9;
2022         desc->wHubCharacteristics = cpu_to_le16(
2023                         HUB_CHAR_INDV_PORT_LPSM |
2024                         HUB_CHAR_COMMON_OCPM);
2025         desc->bNbrPorts = 1;
2026         desc->u.hs.DeviceRemovable[0] = 0xff;
2027         desc->u.hs.DeviceRemovable[1] = 0xff;
2028 }
2029
2030 static int dummy_hub_control(
2031         struct usb_hcd  *hcd,
2032         u16             typeReq,
2033         u16             wValue,
2034         u16             wIndex,
2035         char            *buf,
2036         u16             wLength
2037 ) {
2038         struct dummy_hcd *dum_hcd;
2039         int             retval = 0;
2040         unsigned long   flags;
2041
2042         if (!HCD_HW_ACCESSIBLE(hcd))
2043                 return -ETIMEDOUT;
2044
2045         dum_hcd = hcd_to_dummy_hcd(hcd);
2046
2047         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2048         switch (typeReq) {
2049         case ClearHubFeature:
2050                 break;
2051         case ClearPortFeature:
2052                 switch (wValue) {
2053                 case USB_PORT_FEAT_SUSPEND:
2054                         if (hcd->speed == HCD_USB3) {
2055                                 dev_dbg(dummy_dev(dum_hcd),
2056                                          "USB_PORT_FEAT_SUSPEND req not "
2057                                          "supported for USB 3.0 roothub\n");
2058                                 goto error;
2059                         }
2060                         if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2061                                 /* 20msec resume signaling */
2062                                 dum_hcd->resuming = 1;
2063                                 dum_hcd->re_timeout = jiffies +
2064                                                 msecs_to_jiffies(20);
2065                         }
2066                         break;
2067                 case USB_PORT_FEAT_POWER:
2068                         if (hcd->speed == HCD_USB3) {
2069                                 if (dum_hcd->port_status & USB_PORT_STAT_POWER)
2070                                         dev_dbg(dummy_dev(dum_hcd),
2071                                                 "power-off\n");
2072                         } else
2073                                 if (dum_hcd->port_status &
2074                                                         USB_SS_PORT_STAT_POWER)
2075                                         dev_dbg(dummy_dev(dum_hcd),
2076                                                 "power-off\n");
2077                         /* FALLS THROUGH */
2078                 default:
2079                         dum_hcd->port_status &= ~(1 << wValue);
2080                         set_link_state(dum_hcd);
2081                 }
2082                 break;
2083         case GetHubDescriptor:
2084                 if (hcd->speed == HCD_USB3 &&
2085                                 (wLength < USB_DT_SS_HUB_SIZE ||
2086                                  wValue != (USB_DT_SS_HUB << 8))) {
2087                         dev_dbg(dummy_dev(dum_hcd),
2088                                 "Wrong hub descriptor type for "
2089                                 "USB 3.0 roothub.\n");
2090                         goto error;
2091                 }
2092                 if (hcd->speed == HCD_USB3)
2093                         ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2094                 else
2095                         hub_descriptor((struct usb_hub_descriptor *) buf);
2096                 break;
2097
2098         case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2099                 if (hcd->speed != HCD_USB3)
2100                         goto error;
2101
2102                 if ((wValue >> 8) != USB_DT_BOS)
2103                         goto error;
2104
2105                 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2106                 retval = sizeof(usb3_bos_desc);
2107                 break;
2108
2109         case GetHubStatus:
2110                 *(__le32 *) buf = cpu_to_le32(0);
2111                 break;
2112         case GetPortStatus:
2113                 if (wIndex != 1)
2114                         retval = -EPIPE;
2115
2116                 /* whoever resets or resumes must GetPortStatus to
2117                  * complete it!!
2118                  */
2119                 if (dum_hcd->resuming &&
2120                                 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2121                         dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2122                         dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2123                 }
2124                 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2125                                 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2126                         dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2127                         dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2128                         if (dum_hcd->dum->pullup) {
2129                                 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2130
2131                                 if (hcd->speed < HCD_USB3) {
2132                                         switch (dum_hcd->dum->gadget.speed) {
2133                                         case USB_SPEED_HIGH:
2134                                                 dum_hcd->port_status |=
2135                                                       USB_PORT_STAT_HIGH_SPEED;
2136                                                 break;
2137                                         case USB_SPEED_LOW:
2138                                                 dum_hcd->dum->gadget.ep0->
2139                                                         maxpacket = 8;
2140                                                 dum_hcd->port_status |=
2141                                                         USB_PORT_STAT_LOW_SPEED;
2142                                                 break;
2143                                         default:
2144                                                 dum_hcd->dum->gadget.speed =
2145                                                         USB_SPEED_FULL;
2146                                                 break;
2147                                         }
2148                                 }
2149                         }
2150                 }
2151                 set_link_state(dum_hcd);
2152                 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2153                 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2154                 break;
2155         case SetHubFeature:
2156                 retval = -EPIPE;
2157                 break;
2158         case SetPortFeature:
2159                 switch (wValue) {
2160                 case USB_PORT_FEAT_LINK_STATE:
2161                         if (hcd->speed != HCD_USB3) {
2162                                 dev_dbg(dummy_dev(dum_hcd),
2163                                          "USB_PORT_FEAT_LINK_STATE req not "
2164                                          "supported for USB 2.0 roothub\n");
2165                                 goto error;
2166                         }
2167                         /*
2168                          * Since this is dummy we don't have an actual link so
2169                          * there is nothing to do for the SET_LINK_STATE cmd
2170                          */
2171                         break;
2172                 case USB_PORT_FEAT_U1_TIMEOUT:
2173                 case USB_PORT_FEAT_U2_TIMEOUT:
2174                         /* TODO: add suspend/resume support! */
2175                         if (hcd->speed != HCD_USB3) {
2176                                 dev_dbg(dummy_dev(dum_hcd),
2177                                          "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2178                                          "supported for USB 2.0 roothub\n");
2179                                 goto error;
2180                         }
2181                         break;
2182                 case USB_PORT_FEAT_SUSPEND:
2183                         /* Applicable only for USB2.0 hub */
2184                         if (hcd->speed == HCD_USB3) {
2185                                 dev_dbg(dummy_dev(dum_hcd),
2186                                          "USB_PORT_FEAT_SUSPEND req not "
2187                                          "supported for USB 3.0 roothub\n");
2188                                 goto error;
2189                         }
2190                         if (dum_hcd->active) {
2191                                 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2192
2193                                 /* HNP would happen here; for now we
2194                                  * assume b_bus_req is always true.
2195                                  */
2196                                 set_link_state(dum_hcd);
2197                                 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2198                                                 & dum_hcd->dum->devstatus) != 0)
2199                                         dev_dbg(dummy_dev(dum_hcd),
2200                                                         "no HNP yet!\n");
2201                         }
2202                         break;
2203                 case USB_PORT_FEAT_POWER:
2204                         if (hcd->speed == HCD_USB3)
2205                                 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2206                         else
2207                                 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2208                         set_link_state(dum_hcd);
2209                         break;
2210                 case USB_PORT_FEAT_BH_PORT_RESET:
2211                         /* Applicable only for USB3.0 hub */
2212                         if (hcd->speed != HCD_USB3) {
2213                                 dev_dbg(dummy_dev(dum_hcd),
2214                                          "USB_PORT_FEAT_BH_PORT_RESET req not "
2215                                          "supported for USB 2.0 roothub\n");
2216                                 goto error;
2217                         }
2218                         /* FALLS THROUGH */
2219                 case USB_PORT_FEAT_RESET:
2220                         /* if it's already enabled, disable */
2221                         if (hcd->speed == HCD_USB3) {
2222                                 dum_hcd->port_status = 0;
2223                                 dum_hcd->port_status =
2224                                         (USB_SS_PORT_STAT_POWER |
2225                                          USB_PORT_STAT_CONNECTION |
2226                                          USB_PORT_STAT_RESET);
2227                         } else
2228                                 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2229                                         | USB_PORT_STAT_LOW_SPEED
2230                                         | USB_PORT_STAT_HIGH_SPEED);
2231                         /*
2232                          * We want to reset device status. All but the
2233                          * Self powered feature
2234                          */
2235                         dum_hcd->dum->devstatus &=
2236                                 (1 << USB_DEVICE_SELF_POWERED);
2237                         /*
2238                          * FIXME USB3.0: what is the correct reset signaling
2239                          * interval? Is it still 50msec as for HS?
2240                          */
2241                         dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2242                         /* FALLS THROUGH */
2243                 default:
2244                         if (hcd->speed == HCD_USB3) {
2245                                 if ((dum_hcd->port_status &
2246                                      USB_SS_PORT_STAT_POWER) != 0) {
2247                                         dum_hcd->port_status |= (1 << wValue);
2248                                         set_link_state(dum_hcd);
2249                                 }
2250                         } else
2251                                 if ((dum_hcd->port_status &
2252                                      USB_PORT_STAT_POWER) != 0) {
2253                                         dum_hcd->port_status |= (1 << wValue);
2254                                         set_link_state(dum_hcd);
2255                                 }
2256                 }
2257                 break;
2258         case GetPortErrorCount:
2259                 if (hcd->speed != HCD_USB3) {
2260                         dev_dbg(dummy_dev(dum_hcd),
2261                                  "GetPortErrorCount req not "
2262                                  "supported for USB 2.0 roothub\n");
2263                         goto error;
2264                 }
2265                 /* We'll always return 0 since this is a dummy hub */
2266                 *(__le32 *) buf = cpu_to_le32(0);
2267                 break;
2268         case SetHubDepth:
2269                 if (hcd->speed != HCD_USB3) {
2270                         dev_dbg(dummy_dev(dum_hcd),
2271                                  "SetHubDepth req not supported for "
2272                                  "USB 2.0 roothub\n");
2273                         goto error;
2274                 }
2275                 break;
2276         default:
2277                 dev_dbg(dummy_dev(dum_hcd),
2278                         "hub control req%04x v%04x i%04x l%d\n",
2279                         typeReq, wValue, wIndex, wLength);
2280 error:
2281                 /* "protocol stall" on error */
2282                 retval = -EPIPE;
2283         }
2284         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2285
2286         if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2287                 usb_hcd_poll_rh_status(hcd);
2288         return retval;
2289 }
2290
2291 static int dummy_bus_suspend(struct usb_hcd *hcd)
2292 {
2293         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2294
2295         dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2296
2297         spin_lock_irq(&dum_hcd->dum->lock);
2298         dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2299         set_link_state(dum_hcd);
2300         hcd->state = HC_STATE_SUSPENDED;
2301         spin_unlock_irq(&dum_hcd->dum->lock);
2302         return 0;
2303 }
2304
2305 static int dummy_bus_resume(struct usb_hcd *hcd)
2306 {
2307         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2308         int rc = 0;
2309
2310         dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2311
2312         spin_lock_irq(&dum_hcd->dum->lock);
2313         if (!HCD_HW_ACCESSIBLE(hcd)) {
2314                 rc = -ESHUTDOWN;
2315         } else {
2316                 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2317                 set_link_state(dum_hcd);
2318                 if (!list_empty(&dum_hcd->urbp_list))
2319                         mod_timer(&dum_hcd->timer, jiffies);
2320                 hcd->state = HC_STATE_RUNNING;
2321         }
2322         spin_unlock_irq(&dum_hcd->dum->lock);
2323         return rc;
2324 }
2325
2326 /*-------------------------------------------------------------------------*/
2327
2328 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2329 {
2330         int ep = usb_pipeendpoint(urb->pipe);
2331
2332         return snprintf(buf, size,
2333                 "urb/%p %s ep%d%s%s len %d/%d\n",
2334                 urb,
2335                 ({ char *s;
2336                 switch (urb->dev->speed) {
2337                 case USB_SPEED_LOW:
2338                         s = "ls";
2339                         break;
2340                 case USB_SPEED_FULL:
2341                         s = "fs";
2342                         break;
2343                 case USB_SPEED_HIGH:
2344                         s = "hs";
2345                         break;
2346                 case USB_SPEED_SUPER:
2347                         s = "ss";
2348                         break;
2349                 default:
2350                         s = "?";
2351                         break;
2352                  } s; }),
2353                 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2354                 ({ char *s; \
2355                 switch (usb_pipetype(urb->pipe)) { \
2356                 case PIPE_CONTROL: \
2357                         s = ""; \
2358                         break; \
2359                 case PIPE_BULK: \
2360                         s = "-bulk"; \
2361                         break; \
2362                 case PIPE_INTERRUPT: \
2363                         s = "-int"; \
2364                         break; \
2365                 default: \
2366                         s = "-iso"; \
2367                         break; \
2368                 } s; }),
2369                 urb->actual_length, urb->transfer_buffer_length);
2370 }
2371
2372 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2373                 char *buf)
2374 {
2375         struct usb_hcd          *hcd = dev_get_drvdata(dev);
2376         struct dummy_hcd        *dum_hcd = hcd_to_dummy_hcd(hcd);
2377         struct urbp             *urbp;
2378         size_t                  size = 0;
2379         unsigned long           flags;
2380
2381         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2382         list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2383                 size_t          temp;
2384
2385                 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2386                 buf += temp;
2387                 size += temp;
2388         }
2389         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2390
2391         return size;
2392 }
2393 static DEVICE_ATTR_RO(urbs);
2394
2395 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2396 {
2397         init_timer(&dum_hcd->timer);
2398         dum_hcd->timer.function = dummy_timer;
2399         dum_hcd->timer.data = (unsigned long)dum_hcd;
2400         dum_hcd->rh_state = DUMMY_RH_RUNNING;
2401         dum_hcd->stream_en_ep = 0;
2402         INIT_LIST_HEAD(&dum_hcd->urbp_list);
2403         dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET;
2404         dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2405         dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2406 #ifdef CONFIG_USB_OTG
2407         dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2408 #endif
2409         return 0;
2410
2411         /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2412         return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2413 }
2414
2415 static int dummy_start(struct usb_hcd *hcd)
2416 {
2417         struct dummy_hcd        *dum_hcd = hcd_to_dummy_hcd(hcd);
2418
2419         /*
2420          * MASTER side init ... we emulate a root hub that'll only ever
2421          * talk to one device (the slave side).  Also appears in sysfs,
2422          * just like more familiar pci-based HCDs.
2423          */
2424         if (!usb_hcd_is_primary_hcd(hcd))
2425                 return dummy_start_ss(dum_hcd);
2426
2427         spin_lock_init(&dum_hcd->dum->lock);
2428         init_timer(&dum_hcd->timer);
2429         dum_hcd->timer.function = dummy_timer;
2430         dum_hcd->timer.data = (unsigned long)dum_hcd;
2431         dum_hcd->rh_state = DUMMY_RH_RUNNING;
2432
2433         INIT_LIST_HEAD(&dum_hcd->urbp_list);
2434
2435         hcd->power_budget = POWER_BUDGET;
2436         hcd->state = HC_STATE_RUNNING;
2437         hcd->uses_new_polling = 1;
2438
2439 #ifdef CONFIG_USB_OTG
2440         hcd->self.otg_port = 1;
2441 #endif
2442
2443         /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2444         return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2445 }
2446
2447 static void dummy_stop(struct usb_hcd *hcd)
2448 {
2449         struct dummy            *dum;
2450
2451         dum = hcd_to_dummy_hcd(hcd)->dum;
2452         device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2453         dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2454 }
2455
2456 /*-------------------------------------------------------------------------*/
2457
2458 static int dummy_h_get_frame(struct usb_hcd *hcd)
2459 {
2460         return dummy_g_get_frame(NULL);
2461 }
2462
2463 static int dummy_setup(struct usb_hcd *hcd)
2464 {
2465         struct dummy *dum;
2466
2467         dum = *((void **)dev_get_platdata(hcd->self.controller));
2468         hcd->self.sg_tablesize = ~0;
2469         if (usb_hcd_is_primary_hcd(hcd)) {
2470                 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2471                 dum->hs_hcd->dum = dum;
2472                 /*
2473                  * Mark the first roothub as being USB 2.0.
2474                  * The USB 3.0 roothub will be registered later by
2475                  * dummy_hcd_probe()
2476                  */
2477                 hcd->speed = HCD_USB2;
2478                 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2479         } else {
2480                 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2481                 dum->ss_hcd->dum = dum;
2482                 hcd->speed = HCD_USB3;
2483                 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2484         }
2485         return 0;
2486 }
2487
2488 /* Change a group of bulk endpoints to support multiple stream IDs */
2489 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2490         struct usb_host_endpoint **eps, unsigned int num_eps,
2491         unsigned int num_streams, gfp_t mem_flags)
2492 {
2493         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2494         unsigned long flags;
2495         int max_stream;
2496         int ret_streams = num_streams;
2497         unsigned int index;
2498         unsigned int i;
2499
2500         if (!num_eps)
2501                 return -EINVAL;
2502
2503         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2504         for (i = 0; i < num_eps; i++) {
2505                 index = dummy_get_ep_idx(&eps[i]->desc);
2506                 if ((1 << index) & dum_hcd->stream_en_ep) {
2507                         ret_streams = -EINVAL;
2508                         goto out;
2509                 }
2510                 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2511                 if (!max_stream) {
2512                         ret_streams = -EINVAL;
2513                         goto out;
2514                 }
2515                 if (max_stream < ret_streams) {
2516                         dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2517                                         "stream IDs.\n",
2518                                         eps[i]->desc.bEndpointAddress,
2519                                         max_stream);
2520                         ret_streams = max_stream;
2521                 }
2522         }
2523
2524         for (i = 0; i < num_eps; i++) {
2525                 index = dummy_get_ep_idx(&eps[i]->desc);
2526                 dum_hcd->stream_en_ep |= 1 << index;
2527                 set_max_streams_for_pipe(dum_hcd,
2528                                 usb_endpoint_num(&eps[i]->desc), ret_streams);
2529         }
2530 out:
2531         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2532         return ret_streams;
2533 }
2534
2535 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2536 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2537         struct usb_host_endpoint **eps, unsigned int num_eps,
2538         gfp_t mem_flags)
2539 {
2540         struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2541         unsigned long flags;
2542         int ret;
2543         unsigned int index;
2544         unsigned int i;
2545
2546         spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2547         for (i = 0; i < num_eps; i++) {
2548                 index = dummy_get_ep_idx(&eps[i]->desc);
2549                 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2550                         ret = -EINVAL;
2551                         goto out;
2552                 }
2553         }
2554
2555         for (i = 0; i < num_eps; i++) {
2556                 index = dummy_get_ep_idx(&eps[i]->desc);
2557                 dum_hcd->stream_en_ep &= ~(1 << index);
2558                 set_max_streams_for_pipe(dum_hcd,
2559                                 usb_endpoint_num(&eps[i]->desc), 0);
2560         }
2561         ret = 0;
2562 out:
2563         spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2564         return ret;
2565 }
2566
2567 static struct hc_driver dummy_hcd = {
2568         .description =          (char *) driver_name,
2569         .product_desc =         "Dummy host controller",
2570         .hcd_priv_size =        sizeof(struct dummy_hcd),
2571
2572         .flags =                HCD_USB3 | HCD_SHARED,
2573
2574         .reset =                dummy_setup,
2575         .start =                dummy_start,
2576         .stop =                 dummy_stop,
2577
2578         .urb_enqueue =          dummy_urb_enqueue,
2579         .urb_dequeue =          dummy_urb_dequeue,
2580
2581         .get_frame_number =     dummy_h_get_frame,
2582
2583         .hub_status_data =      dummy_hub_status,
2584         .hub_control =          dummy_hub_control,
2585         .bus_suspend =          dummy_bus_suspend,
2586         .bus_resume =           dummy_bus_resume,
2587
2588         .alloc_streams =        dummy_alloc_streams,
2589         .free_streams =         dummy_free_streams,
2590 };
2591
2592 static int dummy_hcd_probe(struct platform_device *pdev)
2593 {
2594         struct dummy            *dum;
2595         struct usb_hcd          *hs_hcd;
2596         struct usb_hcd          *ss_hcd;
2597         int                     retval;
2598
2599         dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2600         dum = *((void **)dev_get_platdata(&pdev->dev));
2601
2602         if (!mod_data.is_super_speed)
2603                 dummy_hcd.flags = HCD_USB2;
2604         hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2605         if (!hs_hcd)
2606                 return -ENOMEM;
2607         hs_hcd->has_tt = 1;
2608
2609         retval = usb_add_hcd(hs_hcd, 0, 0);
2610         if (retval)
2611                 goto put_usb2_hcd;
2612
2613         if (mod_data.is_super_speed) {
2614                 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2615                                         dev_name(&pdev->dev), hs_hcd);
2616                 if (!ss_hcd) {
2617                         retval = -ENOMEM;
2618                         goto dealloc_usb2_hcd;
2619                 }
2620
2621                 retval = usb_add_hcd(ss_hcd, 0, 0);
2622                 if (retval)
2623                         goto put_usb3_hcd;
2624         }
2625         return 0;
2626
2627 put_usb3_hcd:
2628         usb_put_hcd(ss_hcd);
2629 dealloc_usb2_hcd:
2630         usb_remove_hcd(hs_hcd);
2631 put_usb2_hcd:
2632         usb_put_hcd(hs_hcd);
2633         dum->hs_hcd = dum->ss_hcd = NULL;
2634         return retval;
2635 }
2636
2637 static int dummy_hcd_remove(struct platform_device *pdev)
2638 {
2639         struct dummy            *dum;
2640
2641         dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2642
2643         if (dum->ss_hcd) {
2644                 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2645                 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2646         }
2647
2648         usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2649         usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2650
2651         dum->hs_hcd = NULL;
2652         dum->ss_hcd = NULL;
2653
2654         return 0;
2655 }
2656
2657 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2658 {
2659         struct usb_hcd          *hcd;
2660         struct dummy_hcd        *dum_hcd;
2661         int                     rc = 0;
2662
2663         dev_dbg(&pdev->dev, "%s\n", __func__);
2664
2665         hcd = platform_get_drvdata(pdev);
2666         dum_hcd = hcd_to_dummy_hcd(hcd);
2667         if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2668                 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2669                 rc = -EBUSY;
2670         } else
2671                 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2672         return rc;
2673 }
2674
2675 static int dummy_hcd_resume(struct platform_device *pdev)
2676 {
2677         struct usb_hcd          *hcd;
2678
2679         dev_dbg(&pdev->dev, "%s\n", __func__);
2680
2681         hcd = platform_get_drvdata(pdev);
2682         set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2683         usb_hcd_poll_rh_status(hcd);
2684         return 0;
2685 }
2686
2687 static struct platform_driver dummy_hcd_driver = {
2688         .probe          = dummy_hcd_probe,
2689         .remove         = dummy_hcd_remove,
2690         .suspend        = dummy_hcd_suspend,
2691         .resume         = dummy_hcd_resume,
2692         .driver         = {
2693                 .name   = (char *) driver_name,
2694         },
2695 };
2696
2697 /*-------------------------------------------------------------------------*/
2698 #define MAX_NUM_UDC     2
2699 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2700 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2701
2702 static int __init init(void)
2703 {
2704         int     retval = -ENOMEM;
2705         int     i;
2706         struct  dummy *dum[MAX_NUM_UDC];
2707
2708         if (usb_disabled())
2709                 return -ENODEV;
2710
2711         if (!mod_data.is_high_speed && mod_data.is_super_speed)
2712                 return -EINVAL;
2713
2714         if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2715                 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2716                                 MAX_NUM_UDC);
2717                 return -EINVAL;
2718         }
2719
2720         for (i = 0; i < mod_data.num; i++) {
2721                 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2722                 if (!the_hcd_pdev[i]) {
2723                         i--;
2724                         while (i >= 0)
2725                                 platform_device_put(the_hcd_pdev[i--]);
2726                         return retval;
2727                 }
2728         }
2729         for (i = 0; i < mod_data.num; i++) {
2730                 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2731                 if (!the_udc_pdev[i]) {
2732                         i--;
2733                         while (i >= 0)
2734                                 platform_device_put(the_udc_pdev[i--]);
2735                         goto err_alloc_udc;
2736                 }
2737         }
2738         for (i = 0; i < mod_data.num; i++) {
2739                 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2740                 if (!dum[i]) {
2741                         retval = -ENOMEM;
2742                         goto err_add_pdata;
2743                 }
2744                 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2745                                 sizeof(void *));
2746                 if (retval)
2747                         goto err_add_pdata;
2748                 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2749                                 sizeof(void *));
2750                 if (retval)
2751                         goto err_add_pdata;
2752         }
2753
2754         retval = platform_driver_register(&dummy_hcd_driver);
2755         if (retval < 0)
2756                 goto err_add_pdata;
2757         retval = platform_driver_register(&dummy_udc_driver);
2758         if (retval < 0)
2759                 goto err_register_udc_driver;
2760
2761         for (i = 0; i < mod_data.num; i++) {
2762                 retval = platform_device_add(the_hcd_pdev[i]);
2763                 if (retval < 0) {
2764                         i--;
2765                         while (i >= 0)
2766                                 platform_device_del(the_hcd_pdev[i--]);
2767                         goto err_add_hcd;
2768                 }
2769         }
2770         for (i = 0; i < mod_data.num; i++) {
2771                 if (!dum[i]->hs_hcd ||
2772                                 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2773                         /*
2774                          * The hcd was added successfully but its probe
2775                          * function failed for some reason.
2776                          */
2777                         retval = -EINVAL;
2778                         goto err_add_udc;
2779                 }
2780         }
2781
2782         for (i = 0; i < mod_data.num; i++) {
2783                 retval = platform_device_add(the_udc_pdev[i]);
2784                 if (retval < 0) {
2785                         i--;
2786                         while (i >= 0)
2787                                 platform_device_del(the_udc_pdev[i]);
2788                         goto err_add_udc;
2789                 }
2790         }
2791
2792         for (i = 0; i < mod_data.num; i++) {
2793                 if (!platform_get_drvdata(the_udc_pdev[i])) {
2794                         /*
2795                          * The udc was added successfully but its probe
2796                          * function failed for some reason.
2797                          */
2798                         retval = -EINVAL;
2799                         goto err_probe_udc;
2800                 }
2801         }
2802         return retval;
2803
2804 err_probe_udc:
2805         for (i = 0; i < mod_data.num; i++)
2806                 platform_device_del(the_udc_pdev[i]);
2807 err_add_udc:
2808         for (i = 0; i < mod_data.num; i++)
2809                 platform_device_del(the_hcd_pdev[i]);
2810 err_add_hcd:
2811         platform_driver_unregister(&dummy_udc_driver);
2812 err_register_udc_driver:
2813         platform_driver_unregister(&dummy_hcd_driver);
2814 err_add_pdata:
2815         for (i = 0; i < mod_data.num; i++)
2816                 kfree(dum[i]);
2817         for (i = 0; i < mod_data.num; i++)
2818                 platform_device_put(the_udc_pdev[i]);
2819 err_alloc_udc:
2820         for (i = 0; i < mod_data.num; i++)
2821                 platform_device_put(the_hcd_pdev[i]);
2822         return retval;
2823 }
2824 module_init(init);
2825
2826 static void __exit cleanup(void)
2827 {
2828         int i;
2829
2830         for (i = 0; i < mod_data.num; i++) {
2831                 struct dummy *dum;
2832
2833                 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2834
2835                 platform_device_unregister(the_udc_pdev[i]);
2836                 platform_device_unregister(the_hcd_pdev[i]);
2837                 kfree(dum);
2838         }
2839         platform_driver_unregister(&dummy_udc_driver);
2840         platform_driver_unregister(&dummy_hcd_driver);
2841 }
2842 module_exit(cleanup);