1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Copyright (C) 2003-2008 Takahiro Hirofuchi 4 * Copyright (C) 2015-2016 Nobuo Iwata 5 */ 6 7 #include <linux/init.h> 8 #include <linux/file.h> 9 #include <linux/kernel.h> 10 #include <linux/kthread.h> 11 #include <linux/module.h> 12 #include <linux/platform_device.h> 13 #include <linux/slab.h> 14 15 #include "usbip_common.h" 16 #include "vhci.h" 17 18 #define DRIVER_AUTHOR "Takahiro Hirofuchi" 19 #define DRIVER_DESC "USB/IP 'Virtual' Host Controller (VHCI) Driver" 20 21 /* 22 * TODO 23 * - update root hub emulation 24 * - move the emulation code to userland ? 25 * porting to other operating systems 26 * minimize kernel code 27 * - add suspend/resume code 28 * - clean up everything 29 */ 30 31 /* See usb gadget dummy hcd */ 32 33 static int vhci_hub_status(struct usb_hcd *hcd, char *buff); 34 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, 35 u16 wIndex, char *buff, u16 wLength); 36 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, 37 gfp_t mem_flags); 38 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status); 39 static int vhci_start(struct usb_hcd *vhci_hcd); 40 static void vhci_stop(struct usb_hcd *hcd); 41 static int vhci_get_frame_number(struct usb_hcd *hcd); 42 43 static const char driver_name[] = "vhci_hcd"; 44 static const char driver_desc[] = "USB/IP Virtual Host Controller"; 45 46 int vhci_num_controllers = VHCI_NR_HCS; 47 struct vhci *vhcis; 48 49 static const char * const bit_desc[] = { 50 "CONNECTION", /*0*/ 51 "ENABLE", /*1*/ 52 "SUSPEND", /*2*/ 53 "OVER_CURRENT", /*3*/ 54 "RESET", /*4*/ 55 "L1", /*5*/ 56 "R6", /*6*/ 57 "R7", /*7*/ 58 "POWER", /*8*/ 59 "LOWSPEED", /*9*/ 60 "HIGHSPEED", /*10*/ 61 "PORT_TEST", /*11*/ 62 "INDICATOR", /*12*/ 63 "R13", /*13*/ 64 "R14", /*14*/ 65 "R15", /*15*/ 66 "C_CONNECTION", /*16*/ 67 "C_ENABLE", /*17*/ 68 "C_SUSPEND", /*18*/ 69 "C_OVER_CURRENT", /*19*/ 70 "C_RESET", /*20*/ 71 "C_L1", /*21*/ 72 "R22", /*22*/ 73 "R23", /*23*/ 74 "R24", /*24*/ 75 "R25", /*25*/ 76 "R26", /*26*/ 77 "R27", /*27*/ 78 "R28", /*28*/ 79 "R29", /*29*/ 80 "R30", /*30*/ 81 "R31", /*31*/ 82 }; 83 84 static const char * const bit_desc_ss[] = { 85 "CONNECTION", /*0*/ 86 "ENABLE", /*1*/ 87 "SUSPEND", /*2*/ 88 "OVER_CURRENT", /*3*/ 89 "RESET", /*4*/ 90 "L1", /*5*/ 91 "R6", /*6*/ 92 "R7", /*7*/ 93 "R8", /*8*/ 94 "POWER", /*9*/ 95 "HIGHSPEED", /*10*/ 96 "PORT_TEST", /*11*/ 97 "INDICATOR", /*12*/ 98 "R13", /*13*/ 99 "R14", /*14*/ 100 "R15", /*15*/ 101 "C_CONNECTION", /*16*/ 102 "C_ENABLE", /*17*/ 103 "C_SUSPEND", /*18*/ 104 "C_OVER_CURRENT", /*19*/ 105 "C_RESET", /*20*/ 106 "C_BH_RESET", /*21*/ 107 "C_LINK_STATE", /*22*/ 108 "C_CONFIG_ERROR", /*23*/ 109 "R24", /*24*/ 110 "R25", /*25*/ 111 "R26", /*26*/ 112 "R27", /*27*/ 113 "R28", /*28*/ 114 "R29", /*29*/ 115 "R30", /*30*/ 116 "R31", /*31*/ 117 }; 118 119 static void dump_port_status_diff(u32 prev_status, u32 new_status, bool usb3) 120 { 121 int i = 0; 122 u32 bit = 1; 123 const char * const *desc = bit_desc; 124 125 if (usb3) 126 desc = bit_desc_ss; 127 128 pr_debug("status prev -> new: %08x -> %08x\n", prev_status, new_status); 129 while (bit) { 130 u32 prev = prev_status & bit; 131 u32 new = new_status & bit; 132 char change; 133 134 if (!prev && new) 135 change = '+'; 136 else if (prev && !new) 137 change = '-'; 138 else 139 change = ' '; 140 141 if (prev || new) { 142 pr_debug(" %c%s\n", change, desc[i]); 143 144 if (bit == 1) /* USB_PORT_STAT_CONNECTION */ 145 pr_debug(" %c%s\n", change, "USB_PORT_STAT_SPEED_5GBPS"); 146 } 147 bit <<= 1; 148 i++; 149 } 150 pr_debug("\n"); 151 } 152 153 void rh_port_connect(struct vhci_device *vdev, enum usb_device_speed speed) 154 { 155 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev); 156 struct vhci *vhci = vhci_hcd->vhci; 157 int rhport = vdev->rhport; 158 u32 status; 159 unsigned long flags; 160 161 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport); 162 163 spin_lock_irqsave(&vhci->lock, flags); 164 165 status = vhci_hcd->port_status[rhport]; 166 167 status |= USB_PORT_STAT_CONNECTION | (1 << USB_PORT_FEAT_C_CONNECTION); 168 169 switch (speed) { 170 case USB_SPEED_HIGH: 171 status |= USB_PORT_STAT_HIGH_SPEED; 172 break; 173 case USB_SPEED_LOW: 174 status |= USB_PORT_STAT_LOW_SPEED; 175 break; 176 default: 177 break; 178 } 179 180 vhci_hcd->port_status[rhport] = status; 181 182 spin_unlock_irqrestore(&vhci->lock, flags); 183 184 usb_hcd_poll_rh_status(vhci_hcd_to_hcd(vhci_hcd)); 185 } 186 187 static void rh_port_disconnect(struct vhci_device *vdev) 188 { 189 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev); 190 struct vhci *vhci = vhci_hcd->vhci; 191 int rhport = vdev->rhport; 192 u32 status; 193 unsigned long flags; 194 195 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport); 196 197 spin_lock_irqsave(&vhci->lock, flags); 198 199 status = vhci_hcd->port_status[rhport]; 200 201 status &= ~USB_PORT_STAT_CONNECTION; 202 status |= (1 << USB_PORT_FEAT_C_CONNECTION); 203 204 vhci_hcd->port_status[rhport] = status; 205 206 spin_unlock_irqrestore(&vhci->lock, flags); 207 usb_hcd_poll_rh_status(vhci_hcd_to_hcd(vhci_hcd)); 208 } 209 210 #define PORT_C_MASK \ 211 ((USB_PORT_STAT_C_CONNECTION \ 212 | USB_PORT_STAT_C_ENABLE \ 213 | USB_PORT_STAT_C_SUSPEND \ 214 | USB_PORT_STAT_C_OVERCURRENT \ 215 | USB_PORT_STAT_C_RESET) << 16) 216 217 /* 218 * Returns 0 if the status hasn't changed, or the number of bytes in buf. 219 * Ports are 0-indexed from the HCD point of view, 220 * and 1-indexed from the USB core pointer of view. 221 * 222 * @buf: a bitmap to show which port status has been changed. 223 * bit 0: reserved 224 * bit 1: the status of port 0 has been changed. 225 * bit 2: the status of port 1 has been changed. 226 * ... 227 */ 228 static int vhci_hub_status(struct usb_hcd *hcd, char *buf) 229 { 230 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 231 struct vhci *vhci = vhci_hcd->vhci; 232 int retval = DIV_ROUND_UP(VHCI_HC_PORTS + 1, 8); 233 int rhport; 234 int changed = 0; 235 unsigned long flags; 236 237 memset(buf, 0, retval); 238 239 spin_lock_irqsave(&vhci->lock, flags); 240 if (!HCD_HW_ACCESSIBLE(hcd)) { 241 usbip_dbg_vhci_rh("hw accessible flag not on?\n"); 242 goto done; 243 } 244 245 /* check pseudo status register for each port */ 246 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) { 247 if ((vhci_hcd->port_status[rhport] & PORT_C_MASK)) { 248 /* The status of a port has been changed, */ 249 usbip_dbg_vhci_rh("port %d status changed\n", rhport); 250 251 buf[(rhport + 1) / 8] |= 1 << (rhport + 1) % 8; 252 changed = 1; 253 } 254 } 255 256 if ((hcd->state == HC_STATE_SUSPENDED) && (changed == 1)) 257 usb_hcd_resume_root_hub(hcd); 258 259 done: 260 spin_unlock_irqrestore(&vhci->lock, flags); 261 return changed ? retval : 0; 262 } 263 264 /* usb 3.0 root hub device descriptor */ 265 static struct { 266 struct usb_bos_descriptor bos; 267 struct usb_ss_cap_descriptor ss_cap; 268 } __packed usb3_bos_desc = { 269 270 .bos = { 271 .bLength = USB_DT_BOS_SIZE, 272 .bDescriptorType = USB_DT_BOS, 273 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)), 274 .bNumDeviceCaps = 1, 275 }, 276 .ss_cap = { 277 .bLength = USB_DT_USB_SS_CAP_SIZE, 278 .bDescriptorType = USB_DT_DEVICE_CAPABILITY, 279 .bDevCapabilityType = USB_SS_CAP_TYPE, 280 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION), 281 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION), 282 }, 283 }; 284 285 static inline void 286 ss_hub_descriptor(struct usb_hub_descriptor *desc) 287 { 288 memset(desc, 0, sizeof *desc); 289 desc->bDescriptorType = USB_DT_SS_HUB; 290 desc->bDescLength = 12; 291 desc->wHubCharacteristics = cpu_to_le16( 292 HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_COMMON_OCPM); 293 desc->bNbrPorts = VHCI_HC_PORTS; 294 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/ 295 desc->u.ss.DeviceRemovable = 0xffff; 296 } 297 298 static inline void hub_descriptor(struct usb_hub_descriptor *desc) 299 { 300 int width; 301 302 memset(desc, 0, sizeof(*desc)); 303 desc->bDescriptorType = USB_DT_HUB; 304 desc->wHubCharacteristics = cpu_to_le16( 305 HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_COMMON_OCPM); 306 307 desc->bNbrPorts = VHCI_HC_PORTS; 308 BUILD_BUG_ON(VHCI_HC_PORTS > USB_MAXCHILDREN); 309 width = desc->bNbrPorts / 8 + 1; 310 desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * width; 311 memset(&desc->u.hs.DeviceRemovable[0], 0, width); 312 memset(&desc->u.hs.DeviceRemovable[width], 0xff, width); 313 } 314 315 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, 316 u16 wIndex, char *buf, u16 wLength) 317 { 318 struct vhci_hcd *vhci_hcd; 319 struct vhci *vhci; 320 int retval = 0; 321 int rhport = -1; 322 unsigned long flags; 323 bool invalid_rhport = false; 324 325 u32 prev_port_status[VHCI_HC_PORTS]; 326 327 if (!HCD_HW_ACCESSIBLE(hcd)) 328 return -ETIMEDOUT; 329 330 /* 331 * NOTE: 332 * wIndex (bits 0-7) shows the port number and begins from 1? 333 */ 334 wIndex = ((__u8)(wIndex & 0x00ff)); 335 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue, 336 wIndex); 337 338 /* 339 * wIndex can be 0 for some request types (typeReq). rhport is 340 * in valid range when wIndex >= 1 and < VHCI_HC_PORTS. 341 * 342 * Reference port_status[] only with valid rhport when 343 * invalid_rhport is false. 344 */ 345 if (wIndex < 1 || wIndex > VHCI_HC_PORTS) { 346 invalid_rhport = true; 347 if (wIndex > VHCI_HC_PORTS) 348 pr_err("invalid port number %d\n", wIndex); 349 } else 350 rhport = wIndex - 1; 351 352 vhci_hcd = hcd_to_vhci_hcd(hcd); 353 vhci = vhci_hcd->vhci; 354 355 spin_lock_irqsave(&vhci->lock, flags); 356 357 /* store old status and compare now and old later */ 358 if (usbip_dbg_flag_vhci_rh) { 359 if (!invalid_rhport) 360 memcpy(prev_port_status, vhci_hcd->port_status, 361 sizeof(prev_port_status)); 362 } 363 364 switch (typeReq) { 365 case ClearHubFeature: 366 usbip_dbg_vhci_rh(" ClearHubFeature\n"); 367 break; 368 case ClearPortFeature: 369 if (invalid_rhport) { 370 pr_err("invalid port number %d\n", wIndex); 371 goto error; 372 } 373 switch (wValue) { 374 case USB_PORT_FEAT_SUSPEND: 375 if (hcd->speed == HCD_USB3) { 376 pr_err(" ClearPortFeature: USB_PORT_FEAT_SUSPEND req not " 377 "supported for USB 3.0 roothub\n"); 378 goto error; 379 } 380 usbip_dbg_vhci_rh( 381 " ClearPortFeature: USB_PORT_FEAT_SUSPEND\n"); 382 if (vhci_hcd->port_status[rhport] & USB_PORT_STAT_SUSPEND) { 383 /* 20msec signaling */ 384 vhci_hcd->resuming = 1; 385 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(20); 386 } 387 break; 388 case USB_PORT_FEAT_POWER: 389 usbip_dbg_vhci_rh( 390 " ClearPortFeature: USB_PORT_FEAT_POWER\n"); 391 if (hcd->speed == HCD_USB3) 392 vhci_hcd->port_status[rhport] &= ~USB_SS_PORT_STAT_POWER; 393 else 394 vhci_hcd->port_status[rhport] &= ~USB_PORT_STAT_POWER; 395 break; 396 default: 397 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n", 398 wValue); 399 vhci_hcd->port_status[rhport] &= ~(1 << wValue); 400 break; 401 } 402 break; 403 case GetHubDescriptor: 404 usbip_dbg_vhci_rh(" GetHubDescriptor\n"); 405 if (hcd->speed == HCD_USB3 && 406 (wLength < USB_DT_SS_HUB_SIZE || 407 wValue != (USB_DT_SS_HUB << 8))) { 408 pr_err("Wrong hub descriptor type for USB 3.0 roothub.\n"); 409 goto error; 410 } 411 if (hcd->speed == HCD_USB3) 412 ss_hub_descriptor((struct usb_hub_descriptor *) buf); 413 else 414 hub_descriptor((struct usb_hub_descriptor *) buf); 415 break; 416 case DeviceRequest | USB_REQ_GET_DESCRIPTOR: 417 if (hcd->speed != HCD_USB3) 418 goto error; 419 420 if ((wValue >> 8) != USB_DT_BOS) 421 goto error; 422 423 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc)); 424 retval = sizeof(usb3_bos_desc); 425 break; 426 case GetHubStatus: 427 usbip_dbg_vhci_rh(" GetHubStatus\n"); 428 *(__le32 *) buf = cpu_to_le32(0); 429 break; 430 case GetPortStatus: 431 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex); 432 if (invalid_rhport) { 433 pr_err("invalid port number %d\n", wIndex); 434 retval = -EPIPE; 435 goto error; 436 } 437 438 /* we do not care about resume. */ 439 440 /* whoever resets or resumes must GetPortStatus to 441 * complete it!! 442 */ 443 if (vhci_hcd->resuming && time_after(jiffies, vhci_hcd->re_timeout)) { 444 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_SUSPEND); 445 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_SUSPEND); 446 vhci_hcd->resuming = 0; 447 vhci_hcd->re_timeout = 0; 448 } 449 450 if ((vhci_hcd->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) != 451 0 && time_after(jiffies, vhci_hcd->re_timeout)) { 452 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_RESET); 453 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_RESET); 454 vhci_hcd->re_timeout = 0; 455 456 if (vhci_hcd->vdev[rhport].ud.status == 457 VDEV_ST_NOTASSIGNED) { 458 usbip_dbg_vhci_rh( 459 " enable rhport %d (status %u)\n", 460 rhport, 461 vhci_hcd->vdev[rhport].ud.status); 462 vhci_hcd->port_status[rhport] |= 463 USB_PORT_STAT_ENABLE; 464 } 465 466 if (hcd->speed < HCD_USB3) { 467 switch (vhci_hcd->vdev[rhport].speed) { 468 case USB_SPEED_HIGH: 469 vhci_hcd->port_status[rhport] |= 470 USB_PORT_STAT_HIGH_SPEED; 471 break; 472 case USB_SPEED_LOW: 473 vhci_hcd->port_status[rhport] |= 474 USB_PORT_STAT_LOW_SPEED; 475 break; 476 default: 477 pr_err("vhci_device speed not set\n"); 478 break; 479 } 480 } 481 } 482 ((__le16 *) buf)[0] = cpu_to_le16(vhci_hcd->port_status[rhport]); 483 ((__le16 *) buf)[1] = 484 cpu_to_le16(vhci_hcd->port_status[rhport] >> 16); 485 486 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0], 487 ((u16 *)buf)[1]); 488 break; 489 case SetHubFeature: 490 usbip_dbg_vhci_rh(" SetHubFeature\n"); 491 retval = -EPIPE; 492 break; 493 case SetPortFeature: 494 switch (wValue) { 495 case USB_PORT_FEAT_LINK_STATE: 496 usbip_dbg_vhci_rh( 497 " SetPortFeature: USB_PORT_FEAT_LINK_STATE\n"); 498 if (hcd->speed != HCD_USB3) { 499 pr_err("USB_PORT_FEAT_LINK_STATE req not " 500 "supported for USB 2.0 roothub\n"); 501 goto error; 502 } 503 /* 504 * Since this is dummy we don't have an actual link so 505 * there is nothing to do for the SET_LINK_STATE cmd 506 */ 507 break; 508 case USB_PORT_FEAT_U1_TIMEOUT: 509 usbip_dbg_vhci_rh( 510 " SetPortFeature: USB_PORT_FEAT_U1_TIMEOUT\n"); 511 /* Fall through */ 512 case USB_PORT_FEAT_U2_TIMEOUT: 513 usbip_dbg_vhci_rh( 514 " SetPortFeature: USB_PORT_FEAT_U2_TIMEOUT\n"); 515 /* TODO: add suspend/resume support! */ 516 if (hcd->speed != HCD_USB3) { 517 pr_err("USB_PORT_FEAT_U1/2_TIMEOUT req not " 518 "supported for USB 2.0 roothub\n"); 519 goto error; 520 } 521 break; 522 case USB_PORT_FEAT_SUSPEND: 523 usbip_dbg_vhci_rh( 524 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n"); 525 /* Applicable only for USB2.0 hub */ 526 if (hcd->speed == HCD_USB3) { 527 pr_err("USB_PORT_FEAT_SUSPEND req not " 528 "supported for USB 3.0 roothub\n"); 529 goto error; 530 } 531 532 if (invalid_rhport) { 533 pr_err("invalid port number %d\n", wIndex); 534 goto error; 535 } 536 537 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_SUSPEND; 538 break; 539 case USB_PORT_FEAT_POWER: 540 usbip_dbg_vhci_rh( 541 " SetPortFeature: USB_PORT_FEAT_POWER\n"); 542 if (invalid_rhport) { 543 pr_err("invalid port number %d\n", wIndex); 544 goto error; 545 } 546 if (hcd->speed == HCD_USB3) 547 vhci_hcd->port_status[rhport] |= USB_SS_PORT_STAT_POWER; 548 else 549 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_POWER; 550 break; 551 case USB_PORT_FEAT_BH_PORT_RESET: 552 usbip_dbg_vhci_rh( 553 " SetPortFeature: USB_PORT_FEAT_BH_PORT_RESET\n"); 554 if (invalid_rhport) { 555 pr_err("invalid port number %d\n", wIndex); 556 goto error; 557 } 558 /* Applicable only for USB3.0 hub */ 559 if (hcd->speed != HCD_USB3) { 560 pr_err("USB_PORT_FEAT_BH_PORT_RESET req not " 561 "supported for USB 2.0 roothub\n"); 562 goto error; 563 } 564 /* FALLS THROUGH */ 565 case USB_PORT_FEAT_RESET: 566 usbip_dbg_vhci_rh( 567 " SetPortFeature: USB_PORT_FEAT_RESET\n"); 568 if (invalid_rhport) { 569 pr_err("invalid port number %d\n", wIndex); 570 goto error; 571 } 572 /* if it's already enabled, disable */ 573 if (hcd->speed == HCD_USB3) { 574 vhci_hcd->port_status[rhport] = 0; 575 vhci_hcd->port_status[rhport] = 576 (USB_SS_PORT_STAT_POWER | 577 USB_PORT_STAT_CONNECTION | 578 USB_PORT_STAT_RESET); 579 } else if (vhci_hcd->port_status[rhport] & USB_PORT_STAT_ENABLE) { 580 vhci_hcd->port_status[rhport] &= ~(USB_PORT_STAT_ENABLE 581 | USB_PORT_STAT_LOW_SPEED 582 | USB_PORT_STAT_HIGH_SPEED); 583 } 584 585 /* 50msec reset signaling */ 586 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(50); 587 588 /* FALLS THROUGH */ 589 default: 590 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n", 591 wValue); 592 if (invalid_rhport) { 593 pr_err("invalid port number %d\n", wIndex); 594 goto error; 595 } 596 if (hcd->speed == HCD_USB3) { 597 if ((vhci_hcd->port_status[rhport] & 598 USB_SS_PORT_STAT_POWER) != 0) { 599 vhci_hcd->port_status[rhport] |= (1 << wValue); 600 } 601 } else 602 if ((vhci_hcd->port_status[rhport] & 603 USB_PORT_STAT_POWER) != 0) { 604 vhci_hcd->port_status[rhport] |= (1 << wValue); 605 } 606 } 607 break; 608 case GetPortErrorCount: 609 usbip_dbg_vhci_rh(" GetPortErrorCount\n"); 610 if (hcd->speed != HCD_USB3) { 611 pr_err("GetPortErrorCount req not " 612 "supported for USB 2.0 roothub\n"); 613 goto error; 614 } 615 /* We'll always return 0 since this is a dummy hub */ 616 *(__le32 *) buf = cpu_to_le32(0); 617 break; 618 case SetHubDepth: 619 usbip_dbg_vhci_rh(" SetHubDepth\n"); 620 if (hcd->speed != HCD_USB3) { 621 pr_err("SetHubDepth req not supported for " 622 "USB 2.0 roothub\n"); 623 goto error; 624 } 625 break; 626 default: 627 pr_err("default hub control req: %04x v%04x i%04x l%d\n", 628 typeReq, wValue, wIndex, wLength); 629 error: 630 /* "protocol stall" on error */ 631 retval = -EPIPE; 632 } 633 634 if (usbip_dbg_flag_vhci_rh) { 635 pr_debug("port %d\n", rhport); 636 /* Only dump valid port status */ 637 if (!invalid_rhport) { 638 dump_port_status_diff(prev_port_status[rhport], 639 vhci_hcd->port_status[rhport], 640 hcd->speed == HCD_USB3); 641 } 642 } 643 usbip_dbg_vhci_rh(" bye\n"); 644 645 spin_unlock_irqrestore(&vhci->lock, flags); 646 647 if (!invalid_rhport && 648 (vhci_hcd->port_status[rhport] & PORT_C_MASK) != 0) { 649 usb_hcd_poll_rh_status(hcd); 650 } 651 652 return retval; 653 } 654 655 static void vhci_tx_urb(struct urb *urb, struct vhci_device *vdev) 656 { 657 struct vhci_priv *priv; 658 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev); 659 unsigned long flags; 660 661 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC); 662 if (!priv) { 663 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC); 664 return; 665 } 666 667 spin_lock_irqsave(&vdev->priv_lock, flags); 668 669 priv->seqnum = atomic_inc_return(&vhci_hcd->seqnum); 670 if (priv->seqnum == 0xffff) 671 dev_info(&urb->dev->dev, "seqnum max\n"); 672 673 priv->vdev = vdev; 674 priv->urb = urb; 675 676 urb->hcpriv = (void *) priv; 677 678 list_add_tail(&priv->list, &vdev->priv_tx); 679 680 wake_up(&vdev->waitq_tx); 681 spin_unlock_irqrestore(&vdev->priv_lock, flags); 682 } 683 684 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags) 685 { 686 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 687 struct vhci *vhci = vhci_hcd->vhci; 688 struct device *dev = &urb->dev->dev; 689 u8 portnum = urb->dev->portnum; 690 int ret = 0; 691 struct vhci_device *vdev; 692 unsigned long flags; 693 694 if (portnum > VHCI_HC_PORTS) { 695 pr_err("invalid port number %d\n", portnum); 696 return -ENODEV; 697 } 698 vdev = &vhci_hcd->vdev[portnum-1]; 699 700 if (!urb->transfer_buffer && urb->transfer_buffer_length) { 701 dev_dbg(dev, "Null URB transfer buffer\n"); 702 return -EINVAL; 703 } 704 705 spin_lock_irqsave(&vhci->lock, flags); 706 707 if (urb->status != -EINPROGRESS) { 708 dev_err(dev, "URB already unlinked!, status %d\n", urb->status); 709 spin_unlock_irqrestore(&vhci->lock, flags); 710 return urb->status; 711 } 712 713 /* refuse enqueue for dead connection */ 714 spin_lock(&vdev->ud.lock); 715 if (vdev->ud.status == VDEV_ST_NULL || 716 vdev->ud.status == VDEV_ST_ERROR) { 717 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport); 718 spin_unlock(&vdev->ud.lock); 719 spin_unlock_irqrestore(&vhci->lock, flags); 720 return -ENODEV; 721 } 722 spin_unlock(&vdev->ud.lock); 723 724 ret = usb_hcd_link_urb_to_ep(hcd, urb); 725 if (ret) 726 goto no_need_unlink; 727 728 /* 729 * The enumeration process is as follows; 730 * 731 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0) 732 * to get max packet length of default pipe 733 * 734 * 2. Set_Address request to DevAddr(0) EndPoint(0) 735 * 736 */ 737 if (usb_pipedevice(urb->pipe) == 0) { 738 __u8 type = usb_pipetype(urb->pipe); 739 struct usb_ctrlrequest *ctrlreq = 740 (struct usb_ctrlrequest *) urb->setup_packet; 741 742 if (type != PIPE_CONTROL || !ctrlreq) { 743 dev_err(dev, "invalid request to devnum 0\n"); 744 ret = -EINVAL; 745 goto no_need_xmit; 746 } 747 748 switch (ctrlreq->bRequest) { 749 case USB_REQ_SET_ADDRESS: 750 /* set_address may come when a device is reset */ 751 dev_info(dev, "SetAddress Request (%d) to port %d\n", 752 ctrlreq->wValue, vdev->rhport); 753 754 usb_put_dev(vdev->udev); 755 vdev->udev = usb_get_dev(urb->dev); 756 757 spin_lock(&vdev->ud.lock); 758 vdev->ud.status = VDEV_ST_USED; 759 spin_unlock(&vdev->ud.lock); 760 761 if (urb->status == -EINPROGRESS) { 762 /* This request is successfully completed. */ 763 /* If not -EINPROGRESS, possibly unlinked. */ 764 urb->status = 0; 765 } 766 767 goto no_need_xmit; 768 769 case USB_REQ_GET_DESCRIPTOR: 770 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8)) 771 usbip_dbg_vhci_hc( 772 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n"); 773 774 usb_put_dev(vdev->udev); 775 vdev->udev = usb_get_dev(urb->dev); 776 goto out; 777 778 default: 779 /* NOT REACHED */ 780 dev_err(dev, 781 "invalid request to devnum 0 bRequest %u, wValue %u\n", 782 ctrlreq->bRequest, 783 ctrlreq->wValue); 784 ret = -EINVAL; 785 goto no_need_xmit; 786 } 787 788 } 789 790 out: 791 vhci_tx_urb(urb, vdev); 792 spin_unlock_irqrestore(&vhci->lock, flags); 793 794 return 0; 795 796 no_need_xmit: 797 usb_hcd_unlink_urb_from_ep(hcd, urb); 798 no_need_unlink: 799 spin_unlock_irqrestore(&vhci->lock, flags); 800 if (!ret) 801 usb_hcd_giveback_urb(hcd, urb, urb->status); 802 return ret; 803 } 804 805 /* 806 * vhci_rx gives back the urb after receiving the reply of the urb. If an 807 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives 808 * back its urb. For the driver unlinking the urb, the content of the urb is 809 * not important, but the calling to its completion handler is important; the 810 * completion of unlinking is notified by the completion handler. 811 * 812 * 813 * CLIENT SIDE 814 * 815 * - When vhci_hcd receives RET_SUBMIT, 816 * 817 * - case 1a). the urb of the pdu is not unlinking. 818 * - normal case 819 * => just give back the urb 820 * 821 * - case 1b). the urb of the pdu is unlinking. 822 * - usbip.ko will return a reply of the unlinking request. 823 * => give back the urb now and go to case 2b). 824 * 825 * - When vhci_hcd receives RET_UNLINK, 826 * 827 * - case 2a). a submit request is still pending in vhci_hcd. 828 * - urb was really pending in usbip.ko and urb_unlink_urb() was 829 * completed there. 830 * => free a pending submit request 831 * => notify unlink completeness by giving back the urb 832 * 833 * - case 2b). a submit request is *not* pending in vhci_hcd. 834 * - urb was already given back to the core driver. 835 * => do not give back the urb 836 * 837 * 838 * SERVER SIDE 839 * 840 * - When usbip receives CMD_UNLINK, 841 * 842 * - case 3a). the urb of the unlink request is now in submission. 843 * => do usb_unlink_urb(). 844 * => after the unlink is completed, send RET_UNLINK. 845 * 846 * - case 3b). the urb of the unlink request is not in submission. 847 * - may be already completed or never be received 848 * => send RET_UNLINK 849 * 850 */ 851 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status) 852 { 853 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 854 struct vhci *vhci = vhci_hcd->vhci; 855 struct vhci_priv *priv; 856 struct vhci_device *vdev; 857 unsigned long flags; 858 859 spin_lock_irqsave(&vhci->lock, flags); 860 861 priv = urb->hcpriv; 862 if (!priv) { 863 /* URB was never linked! or will be soon given back by 864 * vhci_rx. */ 865 spin_unlock_irqrestore(&vhci->lock, flags); 866 return -EIDRM; 867 } 868 869 { 870 int ret = 0; 871 872 ret = usb_hcd_check_unlink_urb(hcd, urb, status); 873 if (ret) { 874 spin_unlock_irqrestore(&vhci->lock, flags); 875 return ret; 876 } 877 } 878 879 /* send unlink request here? */ 880 vdev = priv->vdev; 881 882 if (!vdev->ud.tcp_socket) { 883 /* tcp connection is closed */ 884 spin_lock(&vdev->priv_lock); 885 886 list_del(&priv->list); 887 kfree(priv); 888 urb->hcpriv = NULL; 889 890 spin_unlock(&vdev->priv_lock); 891 892 /* 893 * If tcp connection is alive, we have sent CMD_UNLINK. 894 * vhci_rx will receive RET_UNLINK and give back the URB. 895 * Otherwise, we give back it here. 896 */ 897 usb_hcd_unlink_urb_from_ep(hcd, urb); 898 899 spin_unlock_irqrestore(&vhci->lock, flags); 900 usb_hcd_giveback_urb(hcd, urb, urb->status); 901 spin_lock_irqsave(&vhci->lock, flags); 902 903 } else { 904 /* tcp connection is alive */ 905 struct vhci_unlink *unlink; 906 907 spin_lock(&vdev->priv_lock); 908 909 /* setup CMD_UNLINK pdu */ 910 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC); 911 if (!unlink) { 912 spin_unlock(&vdev->priv_lock); 913 spin_unlock_irqrestore(&vhci->lock, flags); 914 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC); 915 return -ENOMEM; 916 } 917 918 unlink->seqnum = atomic_inc_return(&vhci_hcd->seqnum); 919 if (unlink->seqnum == 0xffff) 920 pr_info("seqnum max\n"); 921 922 unlink->unlink_seqnum = priv->seqnum; 923 924 /* send cmd_unlink and try to cancel the pending URB in the 925 * peer */ 926 list_add_tail(&unlink->list, &vdev->unlink_tx); 927 wake_up(&vdev->waitq_tx); 928 929 spin_unlock(&vdev->priv_lock); 930 } 931 932 spin_unlock_irqrestore(&vhci->lock, flags); 933 934 usbip_dbg_vhci_hc("leave\n"); 935 return 0; 936 } 937 938 static void vhci_device_unlink_cleanup(struct vhci_device *vdev) 939 { 940 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev); 941 struct usb_hcd *hcd = vhci_hcd_to_hcd(vhci_hcd); 942 struct vhci *vhci = vhci_hcd->vhci; 943 struct vhci_unlink *unlink, *tmp; 944 unsigned long flags; 945 946 spin_lock_irqsave(&vhci->lock, flags); 947 spin_lock(&vdev->priv_lock); 948 949 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) { 950 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum); 951 list_del(&unlink->list); 952 kfree(unlink); 953 } 954 955 while (!list_empty(&vdev->unlink_rx)) { 956 struct urb *urb; 957 958 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink, 959 list); 960 961 /* give back URB of unanswered unlink request */ 962 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum); 963 964 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum); 965 if (!urb) { 966 pr_info("the urb (seqnum %lu) was already given back\n", 967 unlink->unlink_seqnum); 968 list_del(&unlink->list); 969 kfree(unlink); 970 continue; 971 } 972 973 urb->status = -ENODEV; 974 975 usb_hcd_unlink_urb_from_ep(hcd, urb); 976 977 list_del(&unlink->list); 978 979 spin_unlock(&vdev->priv_lock); 980 spin_unlock_irqrestore(&vhci->lock, flags); 981 982 usb_hcd_giveback_urb(hcd, urb, urb->status); 983 984 spin_lock_irqsave(&vhci->lock, flags); 985 spin_lock(&vdev->priv_lock); 986 987 kfree(unlink); 988 } 989 990 spin_unlock(&vdev->priv_lock); 991 spin_unlock_irqrestore(&vhci->lock, flags); 992 } 993 994 /* 995 * The important thing is that only one context begins cleanup. 996 * This is why error handling and cleanup become simple. 997 * We do not want to consider race condition as possible. 998 */ 999 static void vhci_shutdown_connection(struct usbip_device *ud) 1000 { 1001 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud); 1002 1003 /* need this? see stub_dev.c */ 1004 if (ud->tcp_socket) { 1005 pr_debug("shutdown tcp_socket %d\n", ud->sockfd); 1006 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR); 1007 } 1008 1009 /* kill threads related to this sdev */ 1010 if (vdev->ud.tcp_rx) { 1011 kthread_stop_put(vdev->ud.tcp_rx); 1012 vdev->ud.tcp_rx = NULL; 1013 } 1014 if (vdev->ud.tcp_tx) { 1015 kthread_stop_put(vdev->ud.tcp_tx); 1016 vdev->ud.tcp_tx = NULL; 1017 } 1018 pr_info("stop threads\n"); 1019 1020 /* active connection is closed */ 1021 if (vdev->ud.tcp_socket) { 1022 sockfd_put(vdev->ud.tcp_socket); 1023 vdev->ud.tcp_socket = NULL; 1024 vdev->ud.sockfd = -1; 1025 } 1026 pr_info("release socket\n"); 1027 1028 vhci_device_unlink_cleanup(vdev); 1029 1030 /* 1031 * rh_port_disconnect() is a trigger of ... 1032 * usb_disable_device(): 1033 * disable all the endpoints for a USB device. 1034 * usb_disable_endpoint(): 1035 * disable endpoints. pending urbs are unlinked(dequeued). 1036 * 1037 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a 1038 * detached device should release used urbs in a cleanup function (i.e. 1039 * xxx_disconnect()). Therefore, vhci_hcd does not need to release 1040 * pushed urbs and their private data in this function. 1041 * 1042 * NOTE: vhci_dequeue() must be considered carefully. When shutting down 1043 * a connection, vhci_shutdown_connection() expects vhci_dequeue() 1044 * gives back pushed urbs and frees their private data by request of 1045 * the cleanup function of a USB driver. When unlinking a urb with an 1046 * active connection, vhci_dequeue() does not give back the urb which 1047 * is actually given back by vhci_rx after receiving its return pdu. 1048 * 1049 */ 1050 rh_port_disconnect(vdev); 1051 1052 pr_info("disconnect device\n"); 1053 } 1054 1055 static void vhci_device_reset(struct usbip_device *ud) 1056 { 1057 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud); 1058 unsigned long flags; 1059 1060 spin_lock_irqsave(&ud->lock, flags); 1061 1062 vdev->speed = 0; 1063 vdev->devid = 0; 1064 1065 usb_put_dev(vdev->udev); 1066 vdev->udev = NULL; 1067 1068 if (ud->tcp_socket) { 1069 sockfd_put(ud->tcp_socket); 1070 ud->tcp_socket = NULL; 1071 ud->sockfd = -1; 1072 } 1073 ud->status = VDEV_ST_NULL; 1074 1075 spin_unlock_irqrestore(&ud->lock, flags); 1076 } 1077 1078 static void vhci_device_unusable(struct usbip_device *ud) 1079 { 1080 unsigned long flags; 1081 1082 spin_lock_irqsave(&ud->lock, flags); 1083 ud->status = VDEV_ST_ERROR; 1084 spin_unlock_irqrestore(&ud->lock, flags); 1085 } 1086 1087 static void vhci_device_init(struct vhci_device *vdev) 1088 { 1089 memset(vdev, 0, sizeof(struct vhci_device)); 1090 1091 vdev->ud.side = USBIP_VHCI; 1092 vdev->ud.status = VDEV_ST_NULL; 1093 spin_lock_init(&vdev->ud.lock); 1094 1095 INIT_LIST_HEAD(&vdev->priv_rx); 1096 INIT_LIST_HEAD(&vdev->priv_tx); 1097 INIT_LIST_HEAD(&vdev->unlink_tx); 1098 INIT_LIST_HEAD(&vdev->unlink_rx); 1099 spin_lock_init(&vdev->priv_lock); 1100 1101 init_waitqueue_head(&vdev->waitq_tx); 1102 1103 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection; 1104 vdev->ud.eh_ops.reset = vhci_device_reset; 1105 vdev->ud.eh_ops.unusable = vhci_device_unusable; 1106 1107 usbip_start_eh(&vdev->ud); 1108 } 1109 1110 static int hcd_name_to_id(const char *name) 1111 { 1112 char *c; 1113 long val; 1114 int ret; 1115 1116 c = strchr(name, '.'); 1117 if (c == NULL) 1118 return 0; 1119 1120 ret = kstrtol(c+1, 10, &val); 1121 if (ret < 0) 1122 return ret; 1123 1124 return val; 1125 } 1126 1127 static int vhci_setup(struct usb_hcd *hcd) 1128 { 1129 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1130 if (usb_hcd_is_primary_hcd(hcd)) { 1131 vhci->vhci_hcd_hs = hcd_to_vhci_hcd(hcd); 1132 vhci->vhci_hcd_hs->vhci = vhci; 1133 /* 1134 * Mark the first roothub as being USB 2.0. 1135 * The USB 3.0 roothub will be registered later by 1136 * vhci_hcd_probe() 1137 */ 1138 hcd->speed = HCD_USB2; 1139 hcd->self.root_hub->speed = USB_SPEED_HIGH; 1140 } else { 1141 vhci->vhci_hcd_ss = hcd_to_vhci_hcd(hcd); 1142 vhci->vhci_hcd_ss->vhci = vhci; 1143 hcd->speed = HCD_USB3; 1144 hcd->self.root_hub->speed = USB_SPEED_SUPER; 1145 } 1146 return 0; 1147 } 1148 1149 static int vhci_start(struct usb_hcd *hcd) 1150 { 1151 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 1152 int id, rhport; 1153 int err; 1154 1155 usbip_dbg_vhci_hc("enter vhci_start\n"); 1156 1157 if (usb_hcd_is_primary_hcd(hcd)) 1158 spin_lock_init(&vhci_hcd->vhci->lock); 1159 1160 /* initialize private data of usb_hcd */ 1161 1162 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) { 1163 struct vhci_device *vdev = &vhci_hcd->vdev[rhport]; 1164 1165 vhci_device_init(vdev); 1166 vdev->rhport = rhport; 1167 } 1168 1169 atomic_set(&vhci_hcd->seqnum, 0); 1170 1171 hcd->power_budget = 0; /* no limit */ 1172 hcd->uses_new_polling = 1; 1173 1174 #ifdef CONFIG_USB_OTG 1175 hcd->self.otg_port = 1; 1176 #endif 1177 1178 id = hcd_name_to_id(hcd_name(hcd)); 1179 if (id < 0) { 1180 pr_err("invalid vhci name %s\n", hcd_name(hcd)); 1181 return -EINVAL; 1182 } 1183 1184 /* vhci_hcd is now ready to be controlled through sysfs */ 1185 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) { 1186 err = vhci_init_attr_group(); 1187 if (err) { 1188 pr_err("init attr group\n"); 1189 return err; 1190 } 1191 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group); 1192 if (err) { 1193 pr_err("create sysfs files\n"); 1194 vhci_finish_attr_group(); 1195 return err; 1196 } 1197 pr_info("created sysfs %s\n", hcd_name(hcd)); 1198 } 1199 1200 return 0; 1201 } 1202 1203 static void vhci_stop(struct usb_hcd *hcd) 1204 { 1205 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 1206 int id, rhport; 1207 1208 usbip_dbg_vhci_hc("stop VHCI controller\n"); 1209 1210 /* 1. remove the userland interface of vhci_hcd */ 1211 id = hcd_name_to_id(hcd_name(hcd)); 1212 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) { 1213 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group); 1214 vhci_finish_attr_group(); 1215 } 1216 1217 /* 2. shutdown all the ports of vhci_hcd */ 1218 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) { 1219 struct vhci_device *vdev = &vhci_hcd->vdev[rhport]; 1220 1221 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED); 1222 usbip_stop_eh(&vdev->ud); 1223 } 1224 } 1225 1226 static int vhci_get_frame_number(struct usb_hcd *hcd) 1227 { 1228 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n"); 1229 return 0; 1230 } 1231 1232 #ifdef CONFIG_PM 1233 1234 /* FIXME: suspend/resume */ 1235 static int vhci_bus_suspend(struct usb_hcd *hcd) 1236 { 1237 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1238 unsigned long flags; 1239 1240 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__); 1241 1242 spin_lock_irqsave(&vhci->lock, flags); 1243 hcd->state = HC_STATE_SUSPENDED; 1244 spin_unlock_irqrestore(&vhci->lock, flags); 1245 1246 return 0; 1247 } 1248 1249 static int vhci_bus_resume(struct usb_hcd *hcd) 1250 { 1251 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1252 int rc = 0; 1253 unsigned long flags; 1254 1255 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__); 1256 1257 spin_lock_irqsave(&vhci->lock, flags); 1258 if (!HCD_HW_ACCESSIBLE(hcd)) 1259 rc = -ESHUTDOWN; 1260 else 1261 hcd->state = HC_STATE_RUNNING; 1262 spin_unlock_irqrestore(&vhci->lock, flags); 1263 1264 return rc; 1265 } 1266 1267 #else 1268 1269 #define vhci_bus_suspend NULL 1270 #define vhci_bus_resume NULL 1271 #endif 1272 1273 /* Change a group of bulk endpoints to support multiple stream IDs */ 1274 static int vhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev, 1275 struct usb_host_endpoint **eps, unsigned int num_eps, 1276 unsigned int num_streams, gfp_t mem_flags) 1277 { 1278 dev_dbg(&hcd->self.root_hub->dev, "vhci_alloc_streams not implemented\n"); 1279 return 0; 1280 } 1281 1282 /* Reverts a group of bulk endpoints back to not using stream IDs. */ 1283 static int vhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev, 1284 struct usb_host_endpoint **eps, unsigned int num_eps, 1285 gfp_t mem_flags) 1286 { 1287 dev_dbg(&hcd->self.root_hub->dev, "vhci_free_streams not implemented\n"); 1288 return 0; 1289 } 1290 1291 static const struct hc_driver vhci_hc_driver = { 1292 .description = driver_name, 1293 .product_desc = driver_desc, 1294 .hcd_priv_size = sizeof(struct vhci_hcd), 1295 1296 .flags = HCD_USB3 | HCD_SHARED, 1297 1298 .reset = vhci_setup, 1299 .start = vhci_start, 1300 .stop = vhci_stop, 1301 1302 .urb_enqueue = vhci_urb_enqueue, 1303 .urb_dequeue = vhci_urb_dequeue, 1304 1305 .get_frame_number = vhci_get_frame_number, 1306 1307 .hub_status_data = vhci_hub_status, 1308 .hub_control = vhci_hub_control, 1309 .bus_suspend = vhci_bus_suspend, 1310 .bus_resume = vhci_bus_resume, 1311 1312 .alloc_streams = vhci_alloc_streams, 1313 .free_streams = vhci_free_streams, 1314 }; 1315 1316 static int vhci_hcd_probe(struct platform_device *pdev) 1317 { 1318 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev)); 1319 struct usb_hcd *hcd_hs; 1320 struct usb_hcd *hcd_ss; 1321 int ret; 1322 1323 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id); 1324 1325 /* 1326 * Allocate and initialize hcd. 1327 * Our private data is also allocated automatically. 1328 */ 1329 hcd_hs = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev)); 1330 if (!hcd_hs) { 1331 pr_err("create primary hcd failed\n"); 1332 return -ENOMEM; 1333 } 1334 hcd_hs->has_tt = 1; 1335 1336 /* 1337 * Finish generic HCD structure initialization and register. 1338 * Call the driver's reset() and start() routines. 1339 */ 1340 ret = usb_add_hcd(hcd_hs, 0, 0); 1341 if (ret != 0) { 1342 pr_err("usb_add_hcd hs failed %d\n", ret); 1343 goto put_usb2_hcd; 1344 } 1345 1346 hcd_ss = usb_create_shared_hcd(&vhci_hc_driver, &pdev->dev, 1347 dev_name(&pdev->dev), hcd_hs); 1348 if (!hcd_ss) { 1349 ret = -ENOMEM; 1350 pr_err("create shared hcd failed\n"); 1351 goto remove_usb2_hcd; 1352 } 1353 1354 ret = usb_add_hcd(hcd_ss, 0, 0); 1355 if (ret) { 1356 pr_err("usb_add_hcd ss failed %d\n", ret); 1357 goto put_usb3_hcd; 1358 } 1359 1360 usbip_dbg_vhci_hc("bye\n"); 1361 return 0; 1362 1363 put_usb3_hcd: 1364 usb_put_hcd(hcd_ss); 1365 remove_usb2_hcd: 1366 usb_remove_hcd(hcd_hs); 1367 put_usb2_hcd: 1368 usb_put_hcd(hcd_hs); 1369 vhci->vhci_hcd_hs = NULL; 1370 vhci->vhci_hcd_ss = NULL; 1371 return ret; 1372 } 1373 1374 static int vhci_hcd_remove(struct platform_device *pdev) 1375 { 1376 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev)); 1377 1378 /* 1379 * Disconnects the root hub, 1380 * then reverses the effects of usb_add_hcd(), 1381 * invoking the HCD's stop() methods. 1382 */ 1383 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss)); 1384 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss)); 1385 1386 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs)); 1387 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs)); 1388 1389 vhci->vhci_hcd_hs = NULL; 1390 vhci->vhci_hcd_ss = NULL; 1391 1392 return 0; 1393 } 1394 1395 #ifdef CONFIG_PM 1396 1397 /* what should happen for USB/IP under suspend/resume? */ 1398 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state) 1399 { 1400 struct usb_hcd *hcd; 1401 struct vhci *vhci; 1402 int rhport; 1403 int connected = 0; 1404 int ret = 0; 1405 unsigned long flags; 1406 1407 dev_dbg(&pdev->dev, "%s\n", __func__); 1408 1409 hcd = platform_get_drvdata(pdev); 1410 if (!hcd) 1411 return 0; 1412 1413 vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1414 1415 spin_lock_irqsave(&vhci->lock, flags); 1416 1417 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) { 1418 if (vhci->vhci_hcd_hs->port_status[rhport] & 1419 USB_PORT_STAT_CONNECTION) 1420 connected += 1; 1421 1422 if (vhci->vhci_hcd_ss->port_status[rhport] & 1423 USB_PORT_STAT_CONNECTION) 1424 connected += 1; 1425 } 1426 1427 spin_unlock_irqrestore(&vhci->lock, flags); 1428 1429 if (connected > 0) { 1430 dev_info(&pdev->dev, 1431 "We have %d active connection%s. Do not suspend.\n", 1432 connected, (connected == 1 ? "" : "s")); 1433 ret = -EBUSY; 1434 } else { 1435 dev_info(&pdev->dev, "suspend vhci_hcd"); 1436 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags); 1437 } 1438 1439 return ret; 1440 } 1441 1442 static int vhci_hcd_resume(struct platform_device *pdev) 1443 { 1444 struct usb_hcd *hcd; 1445 1446 dev_dbg(&pdev->dev, "%s\n", __func__); 1447 1448 hcd = platform_get_drvdata(pdev); 1449 if (!hcd) 1450 return 0; 1451 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags); 1452 usb_hcd_poll_rh_status(hcd); 1453 1454 return 0; 1455 } 1456 1457 #else 1458 1459 #define vhci_hcd_suspend NULL 1460 #define vhci_hcd_resume NULL 1461 1462 #endif 1463 1464 static struct platform_driver vhci_driver = { 1465 .probe = vhci_hcd_probe, 1466 .remove = vhci_hcd_remove, 1467 .suspend = vhci_hcd_suspend, 1468 .resume = vhci_hcd_resume, 1469 .driver = { 1470 .name = driver_name, 1471 }, 1472 }; 1473 1474 static void del_platform_devices(void) 1475 { 1476 struct platform_device *pdev; 1477 int i; 1478 1479 for (i = 0; i < vhci_num_controllers; i++) { 1480 pdev = vhcis[i].pdev; 1481 if (pdev != NULL) 1482 platform_device_unregister(pdev); 1483 vhcis[i].pdev = NULL; 1484 } 1485 sysfs_remove_link(&platform_bus.kobj, driver_name); 1486 } 1487 1488 static int __init vhci_hcd_init(void) 1489 { 1490 int i, ret; 1491 1492 if (usb_disabled()) 1493 return -ENODEV; 1494 1495 if (vhci_num_controllers < 1) 1496 vhci_num_controllers = 1; 1497 1498 vhcis = kcalloc(vhci_num_controllers, sizeof(struct vhci), GFP_KERNEL); 1499 if (vhcis == NULL) 1500 return -ENOMEM; 1501 1502 for (i = 0; i < vhci_num_controllers; i++) { 1503 vhcis[i].pdev = platform_device_alloc(driver_name, i); 1504 if (!vhcis[i].pdev) { 1505 i--; 1506 while (i >= 0) 1507 platform_device_put(vhcis[i--].pdev); 1508 ret = -ENOMEM; 1509 goto err_device_alloc; 1510 } 1511 } 1512 for (i = 0; i < vhci_num_controllers; i++) { 1513 void *vhci = &vhcis[i]; 1514 ret = platform_device_add_data(vhcis[i].pdev, &vhci, sizeof(void *)); 1515 if (ret) 1516 goto err_driver_register; 1517 } 1518 1519 ret = platform_driver_register(&vhci_driver); 1520 if (ret) 1521 goto err_driver_register; 1522 1523 for (i = 0; i < vhci_num_controllers; i++) { 1524 ret = platform_device_add(vhcis[i].pdev); 1525 if (ret < 0) { 1526 i--; 1527 while (i >= 0) 1528 platform_device_del(vhcis[i--].pdev); 1529 goto err_add_hcd; 1530 } 1531 } 1532 1533 return ret; 1534 1535 err_add_hcd: 1536 platform_driver_unregister(&vhci_driver); 1537 err_driver_register: 1538 for (i = 0; i < vhci_num_controllers; i++) 1539 platform_device_put(vhcis[i].pdev); 1540 err_device_alloc: 1541 kfree(vhcis); 1542 return ret; 1543 } 1544 1545 static void __exit vhci_hcd_exit(void) 1546 { 1547 del_platform_devices(); 1548 platform_driver_unregister(&vhci_driver); 1549 kfree(vhcis); 1550 } 1551 1552 module_init(vhci_hcd_init); 1553 module_exit(vhci_hcd_exit); 1554 1555 MODULE_AUTHOR(DRIVER_AUTHOR); 1556 MODULE_DESCRIPTION(DRIVER_DESC); 1557 MODULE_LICENSE("GPL"); 1558