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 33static int vhci_hub_status(struct usb_hcd *hcd, char *buff); 34static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, 35 u16 wIndex, char *buff, u16 wLength); 36static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, 37 gfp_t mem_flags); 38static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status); 39static int vhci_start(struct usb_hcd *vhci_hcd); 40static void vhci_stop(struct usb_hcd *hcd); 41static int vhci_get_frame_number(struct usb_hcd *hcd); 42 43static const char driver_name[] = "vhci_hcd"; 44static const char driver_desc[] = "USB/IP Virtual Host Controller"; 45 46int vhci_num_controllers = VHCI_NR_HCS; 47struct vhci *vhcis; 48 49static 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 84static 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 119static 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 153void 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 187static 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 */ 228static 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 259done: 260 spin_unlock_irqrestore(&vhci->lock, flags); 261 return changed ? retval : 0; 262} 263 264/* usb 3.0 root hub device descriptor */ 265static 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 285static inline void 286ss_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 298static 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 315static 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 if (wValue >= 32) 400 goto error; 401 vhci_hcd->port_status[rhport] &= ~(1 << wValue); 402 break; 403 } 404 break; 405 case GetHubDescriptor: 406 usbip_dbg_vhci_rh(" GetHubDescriptor\n"); 407 if (hcd->speed == HCD_USB3 && 408 (wLength < USB_DT_SS_HUB_SIZE || 409 wValue != (USB_DT_SS_HUB << 8))) { 410 pr_err("Wrong hub descriptor type for USB 3.0 roothub.\n"); 411 goto error; 412 } 413 if (hcd->speed == HCD_USB3) 414 ss_hub_descriptor((struct usb_hub_descriptor *) buf); 415 else 416 hub_descriptor((struct usb_hub_descriptor *) buf); 417 break; 418 case DeviceRequest | USB_REQ_GET_DESCRIPTOR: 419 if (hcd->speed != HCD_USB3) 420 goto error; 421 422 if ((wValue >> 8) != USB_DT_BOS) 423 goto error; 424 425 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc)); 426 retval = sizeof(usb3_bos_desc); 427 break; 428 case GetHubStatus: 429 usbip_dbg_vhci_rh(" GetHubStatus\n"); 430 *(__le32 *) buf = cpu_to_le32(0); 431 break; 432 case GetPortStatus: 433 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex); 434 if (invalid_rhport) { 435 pr_err("invalid port number %d\n", wIndex); 436 retval = -EPIPE; 437 goto error; 438 } 439 440 /* we do not care about resume. */ 441 442 /* whoever resets or resumes must GetPortStatus to 443 * complete it!! 444 */ 445 if (vhci_hcd->resuming && time_after(jiffies, vhci_hcd->re_timeout)) { 446 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_SUSPEND); 447 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_SUSPEND); 448 vhci_hcd->resuming = 0; 449 vhci_hcd->re_timeout = 0; 450 } 451 452 if ((vhci_hcd->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) != 453 0 && time_after(jiffies, vhci_hcd->re_timeout)) { 454 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_RESET); 455 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_RESET); 456 vhci_hcd->re_timeout = 0; 457 458 /* 459 * A few drivers do usb reset during probe when 460 * the device could be in VDEV_ST_USED state 461 */ 462 if (vhci_hcd->vdev[rhport].ud.status == 463 VDEV_ST_NOTASSIGNED || 464 vhci_hcd->vdev[rhport].ud.status == 465 VDEV_ST_USED) { 466 usbip_dbg_vhci_rh( 467 " enable rhport %d (status %u)\n", 468 rhport, 469 vhci_hcd->vdev[rhport].ud.status); 470 vhci_hcd->port_status[rhport] |= 471 USB_PORT_STAT_ENABLE; 472 } 473 474 if (hcd->speed < HCD_USB3) { 475 switch (vhci_hcd->vdev[rhport].speed) { 476 case USB_SPEED_HIGH: 477 vhci_hcd->port_status[rhport] |= 478 USB_PORT_STAT_HIGH_SPEED; 479 break; 480 case USB_SPEED_LOW: 481 vhci_hcd->port_status[rhport] |= 482 USB_PORT_STAT_LOW_SPEED; 483 break; 484 default: 485 pr_err("vhci_device speed not set\n"); 486 break; 487 } 488 } 489 } 490 ((__le16 *) buf)[0] = cpu_to_le16(vhci_hcd->port_status[rhport]); 491 ((__le16 *) buf)[1] = 492 cpu_to_le16(vhci_hcd->port_status[rhport] >> 16); 493 494 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0], 495 ((u16 *)buf)[1]); 496 break; 497 case SetHubFeature: 498 usbip_dbg_vhci_rh(" SetHubFeature\n"); 499 retval = -EPIPE; 500 break; 501 case SetPortFeature: 502 switch (wValue) { 503 case USB_PORT_FEAT_LINK_STATE: 504 usbip_dbg_vhci_rh( 505 " SetPortFeature: USB_PORT_FEAT_LINK_STATE\n"); 506 if (hcd->speed != HCD_USB3) { 507 pr_err("USB_PORT_FEAT_LINK_STATE req not " 508 "supported for USB 2.0 roothub\n"); 509 goto error; 510 } 511 /* 512 * Since this is dummy we don't have an actual link so 513 * there is nothing to do for the SET_LINK_STATE cmd 514 */ 515 break; 516 case USB_PORT_FEAT_U1_TIMEOUT: 517 usbip_dbg_vhci_rh( 518 " SetPortFeature: USB_PORT_FEAT_U1_TIMEOUT\n"); 519 fallthrough; 520 case USB_PORT_FEAT_U2_TIMEOUT: 521 usbip_dbg_vhci_rh( 522 " SetPortFeature: USB_PORT_FEAT_U2_TIMEOUT\n"); 523 /* TODO: add suspend/resume support! */ 524 if (hcd->speed != HCD_USB3) { 525 pr_err("USB_PORT_FEAT_U1/2_TIMEOUT req not " 526 "supported for USB 2.0 roothub\n"); 527 goto error; 528 } 529 break; 530 case USB_PORT_FEAT_SUSPEND: 531 usbip_dbg_vhci_rh( 532 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n"); 533 /* Applicable only for USB2.0 hub */ 534 if (hcd->speed == HCD_USB3) { 535 pr_err("USB_PORT_FEAT_SUSPEND req not " 536 "supported for USB 3.0 roothub\n"); 537 goto error; 538 } 539 540 if (invalid_rhport) { 541 pr_err("invalid port number %d\n", wIndex); 542 goto error; 543 } 544 545 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_SUSPEND; 546 break; 547 case USB_PORT_FEAT_POWER: 548 usbip_dbg_vhci_rh( 549 " SetPortFeature: USB_PORT_FEAT_POWER\n"); 550 if (invalid_rhport) { 551 pr_err("invalid port number %d\n", wIndex); 552 goto error; 553 } 554 if (hcd->speed == HCD_USB3) 555 vhci_hcd->port_status[rhport] |= USB_SS_PORT_STAT_POWER; 556 else 557 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_POWER; 558 break; 559 case USB_PORT_FEAT_BH_PORT_RESET: 560 usbip_dbg_vhci_rh( 561 " SetPortFeature: USB_PORT_FEAT_BH_PORT_RESET\n"); 562 if (invalid_rhport) { 563 pr_err("invalid port number %d\n", wIndex); 564 goto error; 565 } 566 /* Applicable only for USB3.0 hub */ 567 if (hcd->speed != HCD_USB3) { 568 pr_err("USB_PORT_FEAT_BH_PORT_RESET req not " 569 "supported for USB 2.0 roothub\n"); 570 goto error; 571 } 572 fallthrough; 573 case USB_PORT_FEAT_RESET: 574 usbip_dbg_vhci_rh( 575 " SetPortFeature: USB_PORT_FEAT_RESET\n"); 576 if (invalid_rhport) { 577 pr_err("invalid port number %d\n", wIndex); 578 goto error; 579 } 580 /* if it's already enabled, disable */ 581 if (hcd->speed == HCD_USB3) { 582 vhci_hcd->port_status[rhport] = 0; 583 vhci_hcd->port_status[rhport] = 584 (USB_SS_PORT_STAT_POWER | 585 USB_PORT_STAT_CONNECTION | 586 USB_PORT_STAT_RESET); 587 } else if (vhci_hcd->port_status[rhport] & USB_PORT_STAT_ENABLE) { 588 vhci_hcd->port_status[rhport] &= ~(USB_PORT_STAT_ENABLE 589 | USB_PORT_STAT_LOW_SPEED 590 | USB_PORT_STAT_HIGH_SPEED); 591 } 592 593 /* 50msec reset signaling */ 594 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(50); 595 fallthrough; 596 default: 597 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n", 598 wValue); 599 if (invalid_rhport) { 600 pr_err("invalid port number %d\n", wIndex); 601 goto error; 602 } 603 if (wValue >= 32) 604 goto error; 605 if (hcd->speed == HCD_USB3) { 606 if ((vhci_hcd->port_status[rhport] & 607 USB_SS_PORT_STAT_POWER) != 0) { 608 vhci_hcd->port_status[rhport] |= (1 << wValue); 609 } 610 } else 611 if ((vhci_hcd->port_status[rhport] & 612 USB_PORT_STAT_POWER) != 0) { 613 vhci_hcd->port_status[rhport] |= (1 << wValue); 614 } 615 } 616 break; 617 case GetPortErrorCount: 618 usbip_dbg_vhci_rh(" GetPortErrorCount\n"); 619 if (hcd->speed != HCD_USB3) { 620 pr_err("GetPortErrorCount req not " 621 "supported for USB 2.0 roothub\n"); 622 goto error; 623 } 624 /* We'll always return 0 since this is a dummy hub */ 625 *(__le32 *) buf = cpu_to_le32(0); 626 break; 627 case SetHubDepth: 628 usbip_dbg_vhci_rh(" SetHubDepth\n"); 629 if (hcd->speed != HCD_USB3) { 630 pr_err("SetHubDepth req not supported for " 631 "USB 2.0 roothub\n"); 632 goto error; 633 } 634 break; 635 default: 636 pr_err("default hub control req: %04x v%04x i%04x l%d\n", 637 typeReq, wValue, wIndex, wLength); 638error: 639 /* "protocol stall" on error */ 640 retval = -EPIPE; 641 } 642 643 if (usbip_dbg_flag_vhci_rh) { 644 pr_debug("port %d\n", rhport); 645 /* Only dump valid port status */ 646 if (!invalid_rhport) { 647 dump_port_status_diff(prev_port_status[rhport], 648 vhci_hcd->port_status[rhport], 649 hcd->speed == HCD_USB3); 650 } 651 } 652 usbip_dbg_vhci_rh(" bye\n"); 653 654 spin_unlock_irqrestore(&vhci->lock, flags); 655 656 if (!invalid_rhport && 657 (vhci_hcd->port_status[rhport] & PORT_C_MASK) != 0) { 658 usb_hcd_poll_rh_status(hcd); 659 } 660 661 return retval; 662} 663 664static void vhci_tx_urb(struct urb *urb, struct vhci_device *vdev) 665{ 666 struct vhci_priv *priv; 667 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev); 668 unsigned long flags; 669 670 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC); 671 if (!priv) { 672 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC); 673 return; 674 } 675 676 spin_lock_irqsave(&vdev->priv_lock, flags); 677 678 priv->seqnum = atomic_inc_return(&vhci_hcd->seqnum); 679 if (priv->seqnum == 0xffff) 680 dev_info(&urb->dev->dev, "seqnum max\n"); 681 682 priv->vdev = vdev; 683 priv->urb = urb; 684 685 urb->hcpriv = (void *) priv; 686 687 list_add_tail(&priv->list, &vdev->priv_tx); 688 689 wake_up(&vdev->waitq_tx); 690 spin_unlock_irqrestore(&vdev->priv_lock, flags); 691} 692 693static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags) 694{ 695 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 696 struct vhci *vhci = vhci_hcd->vhci; 697 struct device *dev = &urb->dev->dev; 698 u8 portnum = urb->dev->portnum; 699 int ret = 0; 700 struct vhci_device *vdev; 701 unsigned long flags; 702 703 if (portnum > VHCI_HC_PORTS) { 704 pr_err("invalid port number %d\n", portnum); 705 return -ENODEV; 706 } 707 vdev = &vhci_hcd->vdev[portnum-1]; 708 709 if (!urb->transfer_buffer && !urb->num_sgs && 710 urb->transfer_buffer_length) { 711 dev_dbg(dev, "Null URB transfer buffer\n"); 712 return -EINVAL; 713 } 714 715 spin_lock_irqsave(&vhci->lock, flags); 716 717 if (urb->status != -EINPROGRESS) { 718 dev_err(dev, "URB already unlinked!, status %d\n", urb->status); 719 spin_unlock_irqrestore(&vhci->lock, flags); 720 return urb->status; 721 } 722 723 /* refuse enqueue for dead connection */ 724 spin_lock(&vdev->ud.lock); 725 if (vdev->ud.status == VDEV_ST_NULL || 726 vdev->ud.status == VDEV_ST_ERROR) { 727 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport); 728 spin_unlock(&vdev->ud.lock); 729 spin_unlock_irqrestore(&vhci->lock, flags); 730 return -ENODEV; 731 } 732 spin_unlock(&vdev->ud.lock); 733 734 ret = usb_hcd_link_urb_to_ep(hcd, urb); 735 if (ret) 736 goto no_need_unlink; 737 738 /* 739 * The enumeration process is as follows; 740 * 741 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0) 742 * to get max packet length of default pipe 743 * 744 * 2. Set_Address request to DevAddr(0) EndPoint(0) 745 * 746 */ 747 if (usb_pipedevice(urb->pipe) == 0) { 748 struct usb_device *old; 749 __u8 type = usb_pipetype(urb->pipe); 750 struct usb_ctrlrequest *ctrlreq = 751 (struct usb_ctrlrequest *) urb->setup_packet; 752 753 if (type != PIPE_CONTROL || !ctrlreq) { 754 dev_err(dev, "invalid request to devnum 0\n"); 755 ret = -EINVAL; 756 goto no_need_xmit; 757 } 758 759 old = vdev->udev; 760 switch (ctrlreq->bRequest) { 761 case USB_REQ_SET_ADDRESS: 762 /* set_address may come when a device is reset */ 763 dev_info(dev, "SetAddress Request (%d) to port %d\n", 764 ctrlreq->wValue, vdev->rhport); 765 766 vdev->udev = usb_get_dev(urb->dev); 767 usb_put_dev(old); 768 769 spin_lock(&vdev->ud.lock); 770 vdev->ud.status = VDEV_ST_USED; 771 spin_unlock(&vdev->ud.lock); 772 773 if (urb->status == -EINPROGRESS) { 774 /* This request is successfully completed. */ 775 /* If not -EINPROGRESS, possibly unlinked. */ 776 urb->status = 0; 777 } 778 779 goto no_need_xmit; 780 781 case USB_REQ_GET_DESCRIPTOR: 782 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8)) 783 usbip_dbg_vhci_hc( 784 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n"); 785 786 vdev->udev = usb_get_dev(urb->dev); 787 usb_put_dev(old); 788 goto out; 789 790 default: 791 /* NOT REACHED */ 792 dev_err(dev, 793 "invalid request to devnum 0 bRequest %u, wValue %u\n", 794 ctrlreq->bRequest, 795 ctrlreq->wValue); 796 ret = -EINVAL; 797 goto no_need_xmit; 798 } 799 800 } 801 802out: 803 vhci_tx_urb(urb, vdev); 804 spin_unlock_irqrestore(&vhci->lock, flags); 805 806 return 0; 807 808no_need_xmit: 809 usb_hcd_unlink_urb_from_ep(hcd, urb); 810no_need_unlink: 811 spin_unlock_irqrestore(&vhci->lock, flags); 812 if (!ret) { 813 /* usb_hcd_giveback_urb() should be called with 814 * irqs disabled 815 */ 816 local_irq_disable(); 817 usb_hcd_giveback_urb(hcd, urb, urb->status); 818 local_irq_enable(); 819 } 820 return ret; 821} 822 823/* 824 * vhci_rx gives back the urb after receiving the reply of the urb. If an 825 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives 826 * back its urb. For the driver unlinking the urb, the content of the urb is 827 * not important, but the calling to its completion handler is important; the 828 * completion of unlinking is notified by the completion handler. 829 * 830 * 831 * CLIENT SIDE 832 * 833 * - When vhci_hcd receives RET_SUBMIT, 834 * 835 * - case 1a). the urb of the pdu is not unlinking. 836 * - normal case 837 * => just give back the urb 838 * 839 * - case 1b). the urb of the pdu is unlinking. 840 * - usbip.ko will return a reply of the unlinking request. 841 * => give back the urb now and go to case 2b). 842 * 843 * - When vhci_hcd receives RET_UNLINK, 844 * 845 * - case 2a). a submit request is still pending in vhci_hcd. 846 * - urb was really pending in usbip.ko and urb_unlink_urb() was 847 * completed there. 848 * => free a pending submit request 849 * => notify unlink completeness by giving back the urb 850 * 851 * - case 2b). a submit request is *not* pending in vhci_hcd. 852 * - urb was already given back to the core driver. 853 * => do not give back the urb 854 * 855 * 856 * SERVER SIDE 857 * 858 * - When usbip receives CMD_UNLINK, 859 * 860 * - case 3a). the urb of the unlink request is now in submission. 861 * => do usb_unlink_urb(). 862 * => after the unlink is completed, send RET_UNLINK. 863 * 864 * - case 3b). the urb of the unlink request is not in submission. 865 * - may be already completed or never be received 866 * => send RET_UNLINK 867 * 868 */ 869static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status) 870{ 871 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 872 struct vhci *vhci = vhci_hcd->vhci; 873 struct vhci_priv *priv; 874 struct vhci_device *vdev; 875 unsigned long flags; 876 877 spin_lock_irqsave(&vhci->lock, flags); 878 879 priv = urb->hcpriv; 880 if (!priv) { 881 /* URB was never linked! or will be soon given back by 882 * vhci_rx. */ 883 spin_unlock_irqrestore(&vhci->lock, flags); 884 return -EIDRM; 885 } 886 887 { 888 int ret = 0; 889 890 ret = usb_hcd_check_unlink_urb(hcd, urb, status); 891 if (ret) { 892 spin_unlock_irqrestore(&vhci->lock, flags); 893 return ret; 894 } 895 } 896 897 /* send unlink request here? */ 898 vdev = priv->vdev; 899 900 if (!vdev->ud.tcp_socket) { 901 /* tcp connection is closed */ 902 spin_lock(&vdev->priv_lock); 903 904 list_del(&priv->list); 905 kfree(priv); 906 urb->hcpriv = NULL; 907 908 spin_unlock(&vdev->priv_lock); 909 910 /* 911 * If tcp connection is alive, we have sent CMD_UNLINK. 912 * vhci_rx will receive RET_UNLINK and give back the URB. 913 * Otherwise, we give back it here. 914 */ 915 usb_hcd_unlink_urb_from_ep(hcd, urb); 916 917 spin_unlock_irqrestore(&vhci->lock, flags); 918 usb_hcd_giveback_urb(hcd, urb, urb->status); 919 spin_lock_irqsave(&vhci->lock, flags); 920 921 } else { 922 /* tcp connection is alive */ 923 struct vhci_unlink *unlink; 924 925 spin_lock(&vdev->priv_lock); 926 927 /* setup CMD_UNLINK pdu */ 928 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC); 929 if (!unlink) { 930 spin_unlock(&vdev->priv_lock); 931 spin_unlock_irqrestore(&vhci->lock, flags); 932 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC); 933 return -ENOMEM; 934 } 935 936 unlink->seqnum = atomic_inc_return(&vhci_hcd->seqnum); 937 if (unlink->seqnum == 0xffff) 938 pr_info("seqnum max\n"); 939 940 unlink->unlink_seqnum = priv->seqnum; 941 942 /* send cmd_unlink and try to cancel the pending URB in the 943 * peer */ 944 list_add_tail(&unlink->list, &vdev->unlink_tx); 945 wake_up(&vdev->waitq_tx); 946 947 spin_unlock(&vdev->priv_lock); 948 } 949 950 spin_unlock_irqrestore(&vhci->lock, flags); 951 952 usbip_dbg_vhci_hc("leave\n"); 953 return 0; 954} 955 956static void vhci_device_unlink_cleanup(struct vhci_device *vdev) 957{ 958 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev); 959 struct usb_hcd *hcd = vhci_hcd_to_hcd(vhci_hcd); 960 struct vhci *vhci = vhci_hcd->vhci; 961 struct vhci_unlink *unlink, *tmp; 962 unsigned long flags; 963 964 spin_lock_irqsave(&vhci->lock, flags); 965 spin_lock(&vdev->priv_lock); 966 967 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) { 968 struct urb *urb; 969 970 /* give back urb of unsent unlink request */ 971 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum); 972 973 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum); 974 if (!urb) { 975 list_del(&unlink->list); 976 kfree(unlink); 977 continue; 978 } 979 980 urb->status = -ENODEV; 981 982 usb_hcd_unlink_urb_from_ep(hcd, urb); 983 984 list_del(&unlink->list); 985 986 spin_unlock(&vdev->priv_lock); 987 spin_unlock_irqrestore(&vhci->lock, flags); 988 989 usb_hcd_giveback_urb(hcd, urb, urb->status); 990 991 spin_lock_irqsave(&vhci->lock, flags); 992 spin_lock(&vdev->priv_lock); 993 994 kfree(unlink); 995 } 996 997 while (!list_empty(&vdev->unlink_rx)) { 998 struct urb *urb; 999 1000 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink, 1001 list); 1002 1003 /* give back URB of unanswered unlink request */ 1004 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum); 1005 1006 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum); 1007 if (!urb) { 1008 pr_info("the urb (seqnum %lu) was already given back\n", 1009 unlink->unlink_seqnum); 1010 list_del(&unlink->list); 1011 kfree(unlink); 1012 continue; 1013 } 1014 1015 urb->status = -ENODEV; 1016 1017 usb_hcd_unlink_urb_from_ep(hcd, urb); 1018 1019 list_del(&unlink->list); 1020 1021 spin_unlock(&vdev->priv_lock); 1022 spin_unlock_irqrestore(&vhci->lock, flags); 1023 1024 usb_hcd_giveback_urb(hcd, urb, urb->status); 1025 1026 spin_lock_irqsave(&vhci->lock, flags); 1027 spin_lock(&vdev->priv_lock); 1028 1029 kfree(unlink); 1030 } 1031 1032 spin_unlock(&vdev->priv_lock); 1033 spin_unlock_irqrestore(&vhci->lock, flags); 1034} 1035 1036/* 1037 * The important thing is that only one context begins cleanup. 1038 * This is why error handling and cleanup become simple. 1039 * We do not want to consider race condition as possible. 1040 */ 1041static void vhci_shutdown_connection(struct usbip_device *ud) 1042{ 1043 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud); 1044 1045 /* need this? see stub_dev.c */ 1046 if (ud->tcp_socket) { 1047 pr_debug("shutdown tcp_socket %d\n", ud->sockfd); 1048 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR); 1049 } 1050 1051 /* kill threads related to this sdev */ 1052 if (vdev->ud.tcp_rx) { 1053 kthread_stop_put(vdev->ud.tcp_rx); 1054 vdev->ud.tcp_rx = NULL; 1055 } 1056 if (vdev->ud.tcp_tx) { 1057 kthread_stop_put(vdev->ud.tcp_tx); 1058 vdev->ud.tcp_tx = NULL; 1059 } 1060 pr_info("stop threads\n"); 1061 1062 /* active connection is closed */ 1063 if (vdev->ud.tcp_socket) { 1064 sockfd_put(vdev->ud.tcp_socket); 1065 vdev->ud.tcp_socket = NULL; 1066 vdev->ud.sockfd = -1; 1067 } 1068 pr_info("release socket\n"); 1069 1070 vhci_device_unlink_cleanup(vdev); 1071 1072 /* 1073 * rh_port_disconnect() is a trigger of ... 1074 * usb_disable_device(): 1075 * disable all the endpoints for a USB device. 1076 * usb_disable_endpoint(): 1077 * disable endpoints. pending urbs are unlinked(dequeued). 1078 * 1079 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a 1080 * detached device should release used urbs in a cleanup function (i.e. 1081 * xxx_disconnect()). Therefore, vhci_hcd does not need to release 1082 * pushed urbs and their private data in this function. 1083 * 1084 * NOTE: vhci_dequeue() must be considered carefully. When shutting down 1085 * a connection, vhci_shutdown_connection() expects vhci_dequeue() 1086 * gives back pushed urbs and frees their private data by request of 1087 * the cleanup function of a USB driver. When unlinking a urb with an 1088 * active connection, vhci_dequeue() does not give back the urb which 1089 * is actually given back by vhci_rx after receiving its return pdu. 1090 * 1091 */ 1092 rh_port_disconnect(vdev); 1093 1094 pr_info("disconnect device\n"); 1095} 1096 1097static void vhci_device_reset(struct usbip_device *ud) 1098{ 1099 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud); 1100 struct usb_device *old = vdev->udev; 1101 unsigned long flags; 1102 1103 spin_lock_irqsave(&ud->lock, flags); 1104 1105 vdev->speed = 0; 1106 vdev->devid = 0; 1107 1108 vdev->udev = NULL; 1109 usb_put_dev(old); 1110 1111 if (ud->tcp_socket) { 1112 sockfd_put(ud->tcp_socket); 1113 ud->tcp_socket = NULL; 1114 ud->sockfd = -1; 1115 } 1116 ud->status = VDEV_ST_NULL; 1117 1118 spin_unlock_irqrestore(&ud->lock, flags); 1119} 1120 1121static void vhci_device_unusable(struct usbip_device *ud) 1122{ 1123 unsigned long flags; 1124 1125 spin_lock_irqsave(&ud->lock, flags); 1126 ud->status = VDEV_ST_ERROR; 1127 spin_unlock_irqrestore(&ud->lock, flags); 1128} 1129 1130static void vhci_device_init(struct vhci_device *vdev) 1131{ 1132 memset(vdev, 0, sizeof(struct vhci_device)); 1133 1134 vdev->ud.side = USBIP_VHCI; 1135 vdev->ud.status = VDEV_ST_NULL; 1136 spin_lock_init(&vdev->ud.lock); 1137 mutex_init(&vdev->ud.sysfs_lock); 1138 1139 INIT_LIST_HEAD(&vdev->priv_rx); 1140 INIT_LIST_HEAD(&vdev->priv_tx); 1141 INIT_LIST_HEAD(&vdev->unlink_tx); 1142 INIT_LIST_HEAD(&vdev->unlink_rx); 1143 spin_lock_init(&vdev->priv_lock); 1144 1145 init_waitqueue_head(&vdev->waitq_tx); 1146 1147 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection; 1148 vdev->ud.eh_ops.reset = vhci_device_reset; 1149 vdev->ud.eh_ops.unusable = vhci_device_unusable; 1150 1151 usbip_start_eh(&vdev->ud); 1152} 1153 1154static int hcd_name_to_id(const char *name) 1155{ 1156 char *c; 1157 long val; 1158 int ret; 1159 1160 c = strchr(name, '.'); 1161 if (c == NULL) 1162 return 0; 1163 1164 ret = kstrtol(c+1, 10, &val); 1165 if (ret < 0) 1166 return ret; 1167 1168 return val; 1169} 1170 1171static int vhci_setup(struct usb_hcd *hcd) 1172{ 1173 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1174 if (usb_hcd_is_primary_hcd(hcd)) { 1175 vhci->vhci_hcd_hs = hcd_to_vhci_hcd(hcd); 1176 vhci->vhci_hcd_hs->vhci = vhci; 1177 /* 1178 * Mark the first roothub as being USB 2.0. 1179 * The USB 3.0 roothub will be registered later by 1180 * vhci_hcd_probe() 1181 */ 1182 hcd->speed = HCD_USB2; 1183 hcd->self.root_hub->speed = USB_SPEED_HIGH; 1184 } else { 1185 vhci->vhci_hcd_ss = hcd_to_vhci_hcd(hcd); 1186 vhci->vhci_hcd_ss->vhci = vhci; 1187 hcd->speed = HCD_USB3; 1188 hcd->self.root_hub->speed = USB_SPEED_SUPER; 1189 } 1190 1191 /* 1192 * Support SG. 1193 * sg_tablesize is an arbitrary value to alleviate memory pressure 1194 * on the host. 1195 */ 1196 hcd->self.sg_tablesize = 32; 1197 hcd->self.no_sg_constraint = 1; 1198 1199 return 0; 1200} 1201 1202static int vhci_start(struct usb_hcd *hcd) 1203{ 1204 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 1205 int id, rhport; 1206 int err; 1207 1208 usbip_dbg_vhci_hc("enter vhci_start\n"); 1209 1210 if (usb_hcd_is_primary_hcd(hcd)) 1211 spin_lock_init(&vhci_hcd->vhci->lock); 1212 1213 /* initialize private data of usb_hcd */ 1214 1215 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) { 1216 struct vhci_device *vdev = &vhci_hcd->vdev[rhport]; 1217 1218 vhci_device_init(vdev); 1219 vdev->rhport = rhport; 1220 } 1221 1222 atomic_set(&vhci_hcd->seqnum, 0); 1223 1224 hcd->power_budget = 0; /* no limit */ 1225 hcd->uses_new_polling = 1; 1226 1227#ifdef CONFIG_USB_OTG 1228 hcd->self.otg_port = 1; 1229#endif 1230 1231 id = hcd_name_to_id(hcd_name(hcd)); 1232 if (id < 0) { 1233 pr_err("invalid vhci name %s\n", hcd_name(hcd)); 1234 return -EINVAL; 1235 } 1236 1237 /* vhci_hcd is now ready to be controlled through sysfs */ 1238 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) { 1239 err = vhci_init_attr_group(); 1240 if (err) { 1241 dev_err(hcd_dev(hcd), "init attr group failed, err = %d\n", err); 1242 return err; 1243 } 1244 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group); 1245 if (err) { 1246 dev_err(hcd_dev(hcd), "create sysfs files failed, err = %d\n", err); 1247 vhci_finish_attr_group(); 1248 return err; 1249 } 1250 pr_info("created sysfs %s\n", hcd_name(hcd)); 1251 } 1252 1253 return 0; 1254} 1255 1256static void vhci_stop(struct usb_hcd *hcd) 1257{ 1258 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd); 1259 int id, rhport; 1260 1261 usbip_dbg_vhci_hc("stop VHCI controller\n"); 1262 1263 /* 1. remove the userland interface of vhci_hcd */ 1264 id = hcd_name_to_id(hcd_name(hcd)); 1265 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) { 1266 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group); 1267 vhci_finish_attr_group(); 1268 } 1269 1270 /* 2. shutdown all the ports of vhci_hcd */ 1271 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) { 1272 struct vhci_device *vdev = &vhci_hcd->vdev[rhport]; 1273 1274 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED); 1275 usbip_stop_eh(&vdev->ud); 1276 } 1277} 1278 1279static int vhci_get_frame_number(struct usb_hcd *hcd) 1280{ 1281 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n"); 1282 return 0; 1283} 1284 1285#ifdef CONFIG_PM 1286 1287/* FIXME: suspend/resume */ 1288static int vhci_bus_suspend(struct usb_hcd *hcd) 1289{ 1290 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1291 unsigned long flags; 1292 1293 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__); 1294 1295 spin_lock_irqsave(&vhci->lock, flags); 1296 hcd->state = HC_STATE_SUSPENDED; 1297 spin_unlock_irqrestore(&vhci->lock, flags); 1298 1299 return 0; 1300} 1301 1302static int vhci_bus_resume(struct usb_hcd *hcd) 1303{ 1304 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1305 int rc = 0; 1306 unsigned long flags; 1307 1308 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__); 1309 1310 spin_lock_irqsave(&vhci->lock, flags); 1311 if (!HCD_HW_ACCESSIBLE(hcd)) 1312 rc = -ESHUTDOWN; 1313 else 1314 hcd->state = HC_STATE_RUNNING; 1315 spin_unlock_irqrestore(&vhci->lock, flags); 1316 1317 return rc; 1318} 1319 1320#else 1321 1322#define vhci_bus_suspend NULL 1323#define vhci_bus_resume NULL 1324#endif 1325 1326/* Change a group of bulk endpoints to support multiple stream IDs */ 1327static int vhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev, 1328 struct usb_host_endpoint **eps, unsigned int num_eps, 1329 unsigned int num_streams, gfp_t mem_flags) 1330{ 1331 dev_dbg(&hcd->self.root_hub->dev, "vhci_alloc_streams not implemented\n"); 1332 return 0; 1333} 1334 1335/* Reverts a group of bulk endpoints back to not using stream IDs. */ 1336static int vhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev, 1337 struct usb_host_endpoint **eps, unsigned int num_eps, 1338 gfp_t mem_flags) 1339{ 1340 dev_dbg(&hcd->self.root_hub->dev, "vhci_free_streams not implemented\n"); 1341 return 0; 1342} 1343 1344static const struct hc_driver vhci_hc_driver = { 1345 .description = driver_name, 1346 .product_desc = driver_desc, 1347 .hcd_priv_size = sizeof(struct vhci_hcd), 1348 1349 .flags = HCD_USB3 | HCD_SHARED, 1350 1351 .reset = vhci_setup, 1352 .start = vhci_start, 1353 .stop = vhci_stop, 1354 1355 .urb_enqueue = vhci_urb_enqueue, 1356 .urb_dequeue = vhci_urb_dequeue, 1357 1358 .get_frame_number = vhci_get_frame_number, 1359 1360 .hub_status_data = vhci_hub_status, 1361 .hub_control = vhci_hub_control, 1362 .bus_suspend = vhci_bus_suspend, 1363 .bus_resume = vhci_bus_resume, 1364 1365 .alloc_streams = vhci_alloc_streams, 1366 .free_streams = vhci_free_streams, 1367}; 1368 1369static int vhci_hcd_probe(struct platform_device *pdev) 1370{ 1371 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev)); 1372 struct usb_hcd *hcd_hs; 1373 struct usb_hcd *hcd_ss; 1374 int ret; 1375 1376 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id); 1377 1378 /* 1379 * Allocate and initialize hcd. 1380 * Our private data is also allocated automatically. 1381 */ 1382 hcd_hs = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev)); 1383 if (!hcd_hs) { 1384 pr_err("create primary hcd failed\n"); 1385 return -ENOMEM; 1386 } 1387 hcd_hs->has_tt = 1; 1388 1389 /* 1390 * Finish generic HCD structure initialization and register. 1391 * Call the driver's reset() and start() routines. 1392 */ 1393 ret = usb_add_hcd(hcd_hs, 0, 0); 1394 if (ret != 0) { 1395 pr_err("usb_add_hcd hs failed %d\n", ret); 1396 goto put_usb2_hcd; 1397 } 1398 1399 hcd_ss = usb_create_shared_hcd(&vhci_hc_driver, &pdev->dev, 1400 dev_name(&pdev->dev), hcd_hs); 1401 if (!hcd_ss) { 1402 ret = -ENOMEM; 1403 pr_err("create shared hcd failed\n"); 1404 goto remove_usb2_hcd; 1405 } 1406 1407 ret = usb_add_hcd(hcd_ss, 0, 0); 1408 if (ret) { 1409 pr_err("usb_add_hcd ss failed %d\n", ret); 1410 goto put_usb3_hcd; 1411 } 1412 1413 usbip_dbg_vhci_hc("bye\n"); 1414 return 0; 1415 1416put_usb3_hcd: 1417 usb_put_hcd(hcd_ss); 1418remove_usb2_hcd: 1419 usb_remove_hcd(hcd_hs); 1420put_usb2_hcd: 1421 usb_put_hcd(hcd_hs); 1422 vhci->vhci_hcd_hs = NULL; 1423 vhci->vhci_hcd_ss = NULL; 1424 return ret; 1425} 1426 1427static int vhci_hcd_remove(struct platform_device *pdev) 1428{ 1429 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev)); 1430 1431 /* 1432 * Disconnects the root hub, 1433 * then reverses the effects of usb_add_hcd(), 1434 * invoking the HCD's stop() methods. 1435 */ 1436 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss)); 1437 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss)); 1438 1439 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs)); 1440 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs)); 1441 1442 vhci->vhci_hcd_hs = NULL; 1443 vhci->vhci_hcd_ss = NULL; 1444 1445 return 0; 1446} 1447 1448#ifdef CONFIG_PM 1449 1450/* what should happen for USB/IP under suspend/resume? */ 1451static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state) 1452{ 1453 struct usb_hcd *hcd; 1454 struct vhci *vhci; 1455 int rhport; 1456 int connected = 0; 1457 int ret = 0; 1458 unsigned long flags; 1459 1460 dev_dbg(&pdev->dev, "%s\n", __func__); 1461 1462 hcd = platform_get_drvdata(pdev); 1463 if (!hcd) 1464 return 0; 1465 1466 vhci = *((void **)dev_get_platdata(hcd->self.controller)); 1467 1468 spin_lock_irqsave(&vhci->lock, flags); 1469 1470 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) { 1471 if (vhci->vhci_hcd_hs->port_status[rhport] & 1472 USB_PORT_STAT_CONNECTION) 1473 connected += 1; 1474 1475 if (vhci->vhci_hcd_ss->port_status[rhport] & 1476 USB_PORT_STAT_CONNECTION) 1477 connected += 1; 1478 } 1479 1480 spin_unlock_irqrestore(&vhci->lock, flags); 1481 1482 if (connected > 0) { 1483 dev_info(&pdev->dev, 1484 "We have %d active connection%s. Do not suspend.\n", 1485 connected, (connected == 1 ? "" : "s")); 1486 ret = -EBUSY; 1487 } else { 1488 dev_info(&pdev->dev, "suspend vhci_hcd"); 1489 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags); 1490 } 1491 1492 return ret; 1493} 1494 1495static int vhci_hcd_resume(struct platform_device *pdev) 1496{ 1497 struct usb_hcd *hcd; 1498 1499 dev_dbg(&pdev->dev, "%s\n", __func__); 1500 1501 hcd = platform_get_drvdata(pdev); 1502 if (!hcd) 1503 return 0; 1504 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags); 1505 usb_hcd_poll_rh_status(hcd); 1506 1507 return 0; 1508} 1509 1510#else 1511 1512#define vhci_hcd_suspend NULL 1513#define vhci_hcd_resume NULL 1514 1515#endif 1516 1517static struct platform_driver vhci_driver = { 1518 .probe = vhci_hcd_probe, 1519 .remove = vhci_hcd_remove, 1520 .suspend = vhci_hcd_suspend, 1521 .resume = vhci_hcd_resume, 1522 .driver = { 1523 .name = driver_name, 1524 }, 1525}; 1526 1527static void del_platform_devices(void) 1528{ 1529 struct platform_device *pdev; 1530 int i; 1531 1532 for (i = 0; i < vhci_num_controllers; i++) { 1533 pdev = vhcis[i].pdev; 1534 if (pdev != NULL) 1535 platform_device_unregister(pdev); 1536 vhcis[i].pdev = NULL; 1537 } 1538 sysfs_remove_link(&platform_bus.kobj, driver_name); 1539} 1540 1541static int __init vhci_hcd_init(void) 1542{ 1543 int i, ret; 1544 1545 if (usb_disabled()) 1546 return -ENODEV; 1547 1548 if (vhci_num_controllers < 1) 1549 vhci_num_controllers = 1; 1550 1551 vhcis = kcalloc(vhci_num_controllers, sizeof(struct vhci), GFP_KERNEL); 1552 if (vhcis == NULL) 1553 return -ENOMEM; 1554 1555 for (i = 0; i < vhci_num_controllers; i++) { 1556 vhcis[i].pdev = platform_device_alloc(driver_name, i); 1557 if (!vhcis[i].pdev) { 1558 i--; 1559 while (i >= 0) 1560 platform_device_put(vhcis[i--].pdev); 1561 ret = -ENOMEM; 1562 goto err_device_alloc; 1563 } 1564 } 1565 for (i = 0; i < vhci_num_controllers; i++) { 1566 void *vhci = &vhcis[i]; 1567 ret = platform_device_add_data(vhcis[i].pdev, &vhci, sizeof(void *)); 1568 if (ret) 1569 goto err_driver_register; 1570 } 1571 1572 ret = platform_driver_register(&vhci_driver); 1573 if (ret) 1574 goto err_driver_register; 1575 1576 for (i = 0; i < vhci_num_controllers; i++) { 1577 ret = platform_device_add(vhcis[i].pdev); 1578 if (ret < 0) { 1579 i--; 1580 while (i >= 0) 1581 platform_device_del(vhcis[i--].pdev); 1582 goto err_add_hcd; 1583 } 1584 } 1585 1586 return ret; 1587 1588err_add_hcd: 1589 platform_driver_unregister(&vhci_driver); 1590err_driver_register: 1591 for (i = 0; i < vhci_num_controllers; i++) 1592 platform_device_put(vhcis[i].pdev); 1593err_device_alloc: 1594 kfree(vhcis); 1595 return ret; 1596} 1597 1598static void __exit vhci_hcd_exit(void) 1599{ 1600 del_platform_devices(); 1601 platform_driver_unregister(&vhci_driver); 1602 kfree(vhcis); 1603} 1604 1605module_init(vhci_hcd_init); 1606module_exit(vhci_hcd_exit); 1607 1608MODULE_AUTHOR(DRIVER_AUTHOR); 1609MODULE_DESCRIPTION(DRIVER_DESC); 1610MODULE_LICENSE("GPL"); 1611