drivers/usb/usbip/vhci_hcd.c

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