drivers/usb/gadget/udc/dummy_hcd.c

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