drivers/usb/gadget/udc/dummy_hcd.c

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