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