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