drivers/usb/gadget/udc/dummy_hcd.c

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