1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2003-2008 Takahiro Hirofuchi
4 * Copyright (C) 2015-2016 Nobuo Iwata
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>
15 #include "usbip_common.h"
18 #define DRIVER_AUTHOR "Takahiro Hirofuchi"
19 #define DRIVER_DESC "USB/IP 'Virtual' Host Controller (VHCI) Driver"
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
31 /* See usb gadget dummy hcd */
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,
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);
43 static const char driver_name[] = "vhci_hcd";
44 static const char driver_desc[] = "USB/IP Virtual Host Controller";
46 int vhci_num_controllers = VHCI_NR_HCS;
49 static const char * const bit_desc[] = {
66 "C_CONNECTION", /*16*/
69 "C_OVER_CURRENT", /*19*/
84 static const char * const bit_desc_ss[] = {
101 "C_CONNECTION", /*16*/
104 "C_OVER_CURRENT", /*19*/
107 "C_LINK_STATE", /*22*/
108 "C_CONFIG_ERROR", /*23*/
119 static void dump_port_status_diff(u32 prev_status, u32 new_status, bool usb3)
123 const char * const *desc = bit_desc;
128 pr_debug("status prev -> new: %08x -> %08x\n", prev_status, new_status);
130 u32 prev = prev_status & bit;
131 u32 new = new_status & bit;
136 else if (prev && !new)
142 pr_debug(" %c%s\n", change, desc[i]);
144 if (bit == 1) /* USB_PORT_STAT_CONNECTION */
145 pr_debug(" %c%s\n", change, "USB_PORT_STAT_SPEED_5GBPS");
153 void rh_port_connect(struct vhci_device *vdev, enum usb_device_speed speed)
155 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
156 struct vhci *vhci = vhci_hcd->vhci;
157 int rhport = vdev->rhport;
161 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
163 spin_lock_irqsave(&vhci->lock, flags);
165 status = vhci_hcd->port_status[rhport];
167 status |= USB_PORT_STAT_CONNECTION | (1 << USB_PORT_FEAT_C_CONNECTION);
171 status |= USB_PORT_STAT_HIGH_SPEED;
174 status |= USB_PORT_STAT_LOW_SPEED;
180 vhci_hcd->port_status[rhport] = status;
182 spin_unlock_irqrestore(&vhci->lock, flags);
184 usb_hcd_poll_rh_status(vhci_hcd_to_hcd(vhci_hcd));
187 static void rh_port_disconnect(struct vhci_device *vdev)
189 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
190 struct vhci *vhci = vhci_hcd->vhci;
191 int rhport = vdev->rhport;
195 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
197 spin_lock_irqsave(&vhci->lock, flags);
199 status = vhci_hcd->port_status[rhport];
201 status &= ~USB_PORT_STAT_CONNECTION;
202 status |= (1 << USB_PORT_FEAT_C_CONNECTION);
204 vhci_hcd->port_status[rhport] = status;
206 spin_unlock_irqrestore(&vhci->lock, flags);
207 usb_hcd_poll_rh_status(vhci_hcd_to_hcd(vhci_hcd));
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)
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.
222 * @buf: a bitmap to show which port status has been changed.
224 * bit 1: the status of port 0 has been changed.
225 * bit 2: the status of port 1 has been changed.
228 static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
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);
237 memset(buf, 0, retval);
239 spin_lock_irqsave(&vhci->lock, flags);
240 if (!HCD_HW_ACCESSIBLE(hcd)) {
241 usbip_dbg_vhci_rh("hw accessible flag not on?\n");
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);
251 buf[(rhport + 1) / 8] |= 1 << (rhport + 1) % 8;
256 if ((hcd->state == HC_STATE_SUSPENDED) && (changed == 1))
257 usb_hcd_resume_root_hub(hcd);
260 spin_unlock_irqrestore(&vhci->lock, flags);
261 return changed ? retval : 0;
264 /* usb 3.0 root hub device descriptor */
266 struct usb_bos_descriptor bos;
267 struct usb_ss_cap_descriptor ss_cap;
268 } __packed usb3_bos_desc = {
271 .bLength = USB_DT_BOS_SIZE,
272 .bDescriptorType = USB_DT_BOS,
273 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
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),
286 ss_hub_descriptor(struct usb_hub_descriptor *desc)
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;
298 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
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);
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);
315 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
316 u16 wIndex, char *buf, u16 wLength)
318 struct vhci_hcd *vhci_hcd;
323 bool invalid_rhport = false;
325 u32 prev_port_status[VHCI_HC_PORTS];
327 if (!HCD_HW_ACCESSIBLE(hcd))
332 * wIndex (bits 0-7) shows the port number and begins from 1?
334 wIndex = ((__u8)(wIndex & 0x00ff));
335 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
339 * wIndex can be 0 for some request types (typeReq). rhport is
340 * in valid range when wIndex >= 1 and < VHCI_HC_PORTS.
342 * Reference port_status[] only with valid rhport when
343 * invalid_rhport is false.
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);
352 vhci_hcd = hcd_to_vhci_hcd(hcd);
353 vhci = vhci_hcd->vhci;
355 spin_lock_irqsave(&vhci->lock, flags);
357 /* store old status and compare now and old later */
358 if (usbip_dbg_flag_vhci_rh) {
360 memcpy(prev_port_status, vhci_hcd->port_status,
361 sizeof(prev_port_status));
365 case ClearHubFeature:
366 usbip_dbg_vhci_rh(" ClearHubFeature\n");
368 case ClearPortFeature:
369 if (invalid_rhport) {
370 pr_err("invalid port number %d\n", wIndex);
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");
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);
388 case USB_PORT_FEAT_POWER:
390 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
391 if (hcd->speed == HCD_USB3)
392 vhci_hcd->port_status[rhport] &= ~USB_SS_PORT_STAT_POWER;
394 vhci_hcd->port_status[rhport] &= ~USB_PORT_STAT_POWER;
397 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
401 vhci_hcd->port_status[rhport] &= ~(1 << wValue);
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");
413 if (hcd->speed == HCD_USB3)
414 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
416 hub_descriptor((struct usb_hub_descriptor *) buf);
418 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
419 if (hcd->speed != HCD_USB3)
422 if ((wValue >> 8) != USB_DT_BOS)
425 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
426 retval = sizeof(usb3_bos_desc);
429 usbip_dbg_vhci_rh(" GetHubStatus\n");
430 *(__le32 *) buf = cpu_to_le32(0);
433 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
434 if (invalid_rhport) {
435 pr_err("invalid port number %d\n", wIndex);
440 /* we do not care about resume. */
442 /* whoever resets or resumes must GetPortStatus to
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;
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;
459 * A few drivers do usb reset during probe when
460 * the device could be in VDEV_ST_USED state
462 if (vhci_hcd->vdev[rhport].ud.status ==
463 VDEV_ST_NOTASSIGNED ||
464 vhci_hcd->vdev[rhport].ud.status ==
467 " enable rhport %d (status %u)\n",
469 vhci_hcd->vdev[rhport].ud.status);
470 vhci_hcd->port_status[rhport] |=
471 USB_PORT_STAT_ENABLE;
474 if (hcd->speed < HCD_USB3) {
475 switch (vhci_hcd->vdev[rhport].speed) {
477 vhci_hcd->port_status[rhport] |=
478 USB_PORT_STAT_HIGH_SPEED;
481 vhci_hcd->port_status[rhport] |=
482 USB_PORT_STAT_LOW_SPEED;
485 pr_err("vhci_device speed not set\n");
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);
494 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
498 usbip_dbg_vhci_rh(" SetHubFeature\n");
503 case USB_PORT_FEAT_LINK_STATE:
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");
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
516 case USB_PORT_FEAT_U1_TIMEOUT:
518 " SetPortFeature: USB_PORT_FEAT_U1_TIMEOUT\n");
520 case USB_PORT_FEAT_U2_TIMEOUT:
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");
530 case USB_PORT_FEAT_SUSPEND:
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");
540 if (invalid_rhport) {
541 pr_err("invalid port number %d\n", wIndex);
545 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_SUSPEND;
547 case USB_PORT_FEAT_POWER:
549 " SetPortFeature: USB_PORT_FEAT_POWER\n");
550 if (invalid_rhport) {
551 pr_err("invalid port number %d\n", wIndex);
554 if (hcd->speed == HCD_USB3)
555 vhci_hcd->port_status[rhport] |= USB_SS_PORT_STAT_POWER;
557 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_POWER;
559 case USB_PORT_FEAT_BH_PORT_RESET:
561 " SetPortFeature: USB_PORT_FEAT_BH_PORT_RESET\n");
562 if (invalid_rhport) {
563 pr_err("invalid port number %d\n", wIndex);
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");
573 case USB_PORT_FEAT_RESET:
575 " SetPortFeature: USB_PORT_FEAT_RESET\n");
576 if (invalid_rhport) {
577 pr_err("invalid port number %d\n", wIndex);
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);
593 /* 50msec reset signaling */
594 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
597 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
599 if (invalid_rhport) {
600 pr_err("invalid port number %d\n", wIndex);
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);
611 if ((vhci_hcd->port_status[rhport] &
612 USB_PORT_STAT_POWER) != 0) {
613 vhci_hcd->port_status[rhport] |= (1 << wValue);
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");
624 /* We'll always return 0 since this is a dummy hub */
625 *(__le32 *) buf = cpu_to_le32(0);
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");
636 pr_err("default hub control req: %04x v%04x i%04x l%d\n",
637 typeReq, wValue, wIndex, wLength);
639 /* "protocol stall" on error */
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);
652 usbip_dbg_vhci_rh(" bye\n");
654 spin_unlock_irqrestore(&vhci->lock, flags);
656 if (!invalid_rhport &&
657 (vhci_hcd->port_status[rhport] & PORT_C_MASK) != 0) {
658 usb_hcd_poll_rh_status(hcd);
664 static void vhci_tx_urb(struct urb *urb, struct vhci_device *vdev)
666 struct vhci_priv *priv;
667 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
670 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
672 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
676 spin_lock_irqsave(&vdev->priv_lock, flags);
678 priv->seqnum = atomic_inc_return(&vhci_hcd->seqnum);
679 if (priv->seqnum == 0xffff)
680 dev_info(&urb->dev->dev, "seqnum max\n");
685 urb->hcpriv = (void *) priv;
687 list_add_tail(&priv->list, &vdev->priv_tx);
689 wake_up(&vdev->waitq_tx);
690 spin_unlock_irqrestore(&vdev->priv_lock, flags);
693 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags)
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;
700 struct vhci_device *vdev;
703 if (portnum > VHCI_HC_PORTS) {
704 pr_err("invalid port number %d\n", portnum);
707 vdev = &vhci_hcd->vdev[portnum-1];
709 if (!urb->transfer_buffer && !urb->num_sgs &&
710 urb->transfer_buffer_length) {
711 dev_dbg(dev, "Null URB transfer buffer\n");
715 spin_lock_irqsave(&vhci->lock, flags);
717 if (urb->status != -EINPROGRESS) {
718 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
719 spin_unlock_irqrestore(&vhci->lock, flags);
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);
732 spin_unlock(&vdev->ud.lock);
734 ret = usb_hcd_link_urb_to_ep(hcd, urb);
739 * The enumeration process is as follows;
741 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
742 * to get max packet length of default pipe
744 * 2. Set_Address request to DevAddr(0) EndPoint(0)
747 if (usb_pipedevice(urb->pipe) == 0) {
748 __u8 type = usb_pipetype(urb->pipe);
749 struct usb_ctrlrequest *ctrlreq =
750 (struct usb_ctrlrequest *) urb->setup_packet;
752 if (type != PIPE_CONTROL || !ctrlreq) {
753 dev_err(dev, "invalid request to devnum 0\n");
758 switch (ctrlreq->bRequest) {
759 case USB_REQ_SET_ADDRESS:
760 /* set_address may come when a device is reset */
761 dev_info(dev, "SetAddress Request (%d) to port %d\n",
762 ctrlreq->wValue, vdev->rhport);
764 usb_put_dev(vdev->udev);
765 vdev->udev = usb_get_dev(urb->dev);
767 spin_lock(&vdev->ud.lock);
768 vdev->ud.status = VDEV_ST_USED;
769 spin_unlock(&vdev->ud.lock);
771 if (urb->status == -EINPROGRESS) {
772 /* This request is successfully completed. */
773 /* If not -EINPROGRESS, possibly unlinked. */
779 case USB_REQ_GET_DESCRIPTOR:
780 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
782 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
784 usb_put_dev(vdev->udev);
785 vdev->udev = usb_get_dev(urb->dev);
791 "invalid request to devnum 0 bRequest %u, wValue %u\n",
801 vhci_tx_urb(urb, vdev);
802 spin_unlock_irqrestore(&vhci->lock, flags);
807 usb_hcd_unlink_urb_from_ep(hcd, urb);
809 spin_unlock_irqrestore(&vhci->lock, flags);
811 /* usb_hcd_giveback_urb() should be called with
815 usb_hcd_giveback_urb(hcd, urb, urb->status);
822 * vhci_rx gives back the urb after receiving the reply of the urb. If an
823 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
824 * back its urb. For the driver unlinking the urb, the content of the urb is
825 * not important, but the calling to its completion handler is important; the
826 * completion of unlinking is notified by the completion handler.
831 * - When vhci_hcd receives RET_SUBMIT,
833 * - case 1a). the urb of the pdu is not unlinking.
835 * => just give back the urb
837 * - case 1b). the urb of the pdu is unlinking.
838 * - usbip.ko will return a reply of the unlinking request.
839 * => give back the urb now and go to case 2b).
841 * - When vhci_hcd receives RET_UNLINK,
843 * - case 2a). a submit request is still pending in vhci_hcd.
844 * - urb was really pending in usbip.ko and urb_unlink_urb() was
846 * => free a pending submit request
847 * => notify unlink completeness by giving back the urb
849 * - case 2b). a submit request is *not* pending in vhci_hcd.
850 * - urb was already given back to the core driver.
851 * => do not give back the urb
856 * - When usbip receives CMD_UNLINK,
858 * - case 3a). the urb of the unlink request is now in submission.
859 * => do usb_unlink_urb().
860 * => after the unlink is completed, send RET_UNLINK.
862 * - case 3b). the urb of the unlink request is not in submission.
863 * - may be already completed or never be received
867 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
869 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
870 struct vhci *vhci = vhci_hcd->vhci;
871 struct vhci_priv *priv;
872 struct vhci_device *vdev;
875 spin_lock_irqsave(&vhci->lock, flags);
879 /* URB was never linked! or will be soon given back by
881 spin_unlock_irqrestore(&vhci->lock, flags);
888 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
890 spin_unlock_irqrestore(&vhci->lock, flags);
895 /* send unlink request here? */
898 if (!vdev->ud.tcp_socket) {
899 /* tcp connection is closed */
900 spin_lock(&vdev->priv_lock);
902 list_del(&priv->list);
906 spin_unlock(&vdev->priv_lock);
909 * If tcp connection is alive, we have sent CMD_UNLINK.
910 * vhci_rx will receive RET_UNLINK and give back the URB.
911 * Otherwise, we give back it here.
913 usb_hcd_unlink_urb_from_ep(hcd, urb);
915 spin_unlock_irqrestore(&vhci->lock, flags);
916 usb_hcd_giveback_urb(hcd, urb, urb->status);
917 spin_lock_irqsave(&vhci->lock, flags);
920 /* tcp connection is alive */
921 struct vhci_unlink *unlink;
923 spin_lock(&vdev->priv_lock);
925 /* setup CMD_UNLINK pdu */
926 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
928 spin_unlock(&vdev->priv_lock);
929 spin_unlock_irqrestore(&vhci->lock, flags);
930 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
934 unlink->seqnum = atomic_inc_return(&vhci_hcd->seqnum);
935 if (unlink->seqnum == 0xffff)
936 pr_info("seqnum max\n");
938 unlink->unlink_seqnum = priv->seqnum;
940 /* send cmd_unlink and try to cancel the pending URB in the
942 list_add_tail(&unlink->list, &vdev->unlink_tx);
943 wake_up(&vdev->waitq_tx);
945 spin_unlock(&vdev->priv_lock);
948 spin_unlock_irqrestore(&vhci->lock, flags);
950 usbip_dbg_vhci_hc("leave\n");
954 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
956 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
957 struct usb_hcd *hcd = vhci_hcd_to_hcd(vhci_hcd);
958 struct vhci *vhci = vhci_hcd->vhci;
959 struct vhci_unlink *unlink, *tmp;
962 spin_lock_irqsave(&vhci->lock, flags);
963 spin_lock(&vdev->priv_lock);
965 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
968 /* give back urb of unsent unlink request */
969 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
971 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
973 list_del(&unlink->list);
978 urb->status = -ENODEV;
980 usb_hcd_unlink_urb_from_ep(hcd, urb);
982 list_del(&unlink->list);
984 spin_unlock(&vdev->priv_lock);
985 spin_unlock_irqrestore(&vhci->lock, flags);
987 usb_hcd_giveback_urb(hcd, urb, urb->status);
989 spin_lock_irqsave(&vhci->lock, flags);
990 spin_lock(&vdev->priv_lock);
995 while (!list_empty(&vdev->unlink_rx)) {
998 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
1001 /* give back URB of unanswered unlink request */
1002 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
1004 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
1006 pr_info("the urb (seqnum %lu) was already given back\n",
1007 unlink->unlink_seqnum);
1008 list_del(&unlink->list);
1013 urb->status = -ENODEV;
1015 usb_hcd_unlink_urb_from_ep(hcd, urb);
1017 list_del(&unlink->list);
1019 spin_unlock(&vdev->priv_lock);
1020 spin_unlock_irqrestore(&vhci->lock, flags);
1022 usb_hcd_giveback_urb(hcd, urb, urb->status);
1024 spin_lock_irqsave(&vhci->lock, flags);
1025 spin_lock(&vdev->priv_lock);
1030 spin_unlock(&vdev->priv_lock);
1031 spin_unlock_irqrestore(&vhci->lock, flags);
1035 * The important thing is that only one context begins cleanup.
1036 * This is why error handling and cleanup become simple.
1037 * We do not want to consider race condition as possible.
1039 static void vhci_shutdown_connection(struct usbip_device *ud)
1041 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
1043 /* need this? see stub_dev.c */
1044 if (ud->tcp_socket) {
1045 pr_debug("shutdown tcp_socket %d\n", ud->sockfd);
1046 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
1049 /* kill threads related to this sdev */
1050 if (vdev->ud.tcp_rx) {
1051 kthread_stop_put(vdev->ud.tcp_rx);
1052 vdev->ud.tcp_rx = NULL;
1054 if (vdev->ud.tcp_tx) {
1055 kthread_stop_put(vdev->ud.tcp_tx);
1056 vdev->ud.tcp_tx = NULL;
1058 pr_info("stop threads\n");
1060 /* active connection is closed */
1061 if (vdev->ud.tcp_socket) {
1062 sockfd_put(vdev->ud.tcp_socket);
1063 vdev->ud.tcp_socket = NULL;
1064 vdev->ud.sockfd = -1;
1066 pr_info("release socket\n");
1068 vhci_device_unlink_cleanup(vdev);
1071 * rh_port_disconnect() is a trigger of ...
1072 * usb_disable_device():
1073 * disable all the endpoints for a USB device.
1074 * usb_disable_endpoint():
1075 * disable endpoints. pending urbs are unlinked(dequeued).
1077 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
1078 * detached device should release used urbs in a cleanup function (i.e.
1079 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
1080 * pushed urbs and their private data in this function.
1082 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
1083 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
1084 * gives back pushed urbs and frees their private data by request of
1085 * the cleanup function of a USB driver. When unlinking a urb with an
1086 * active connection, vhci_dequeue() does not give back the urb which
1087 * is actually given back by vhci_rx after receiving its return pdu.
1090 rh_port_disconnect(vdev);
1092 pr_info("disconnect device\n");
1095 static void vhci_device_reset(struct usbip_device *ud)
1097 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
1098 unsigned long flags;
1100 spin_lock_irqsave(&ud->lock, flags);
1105 usb_put_dev(vdev->udev);
1108 if (ud->tcp_socket) {
1109 sockfd_put(ud->tcp_socket);
1110 ud->tcp_socket = NULL;
1113 ud->status = VDEV_ST_NULL;
1115 spin_unlock_irqrestore(&ud->lock, flags);
1118 static void vhci_device_unusable(struct usbip_device *ud)
1120 unsigned long flags;
1122 spin_lock_irqsave(&ud->lock, flags);
1123 ud->status = VDEV_ST_ERROR;
1124 spin_unlock_irqrestore(&ud->lock, flags);
1127 static void vhci_device_init(struct vhci_device *vdev)
1129 memset(vdev, 0, sizeof(struct vhci_device));
1131 vdev->ud.side = USBIP_VHCI;
1132 vdev->ud.status = VDEV_ST_NULL;
1133 spin_lock_init(&vdev->ud.lock);
1134 mutex_init(&vdev->ud.sysfs_lock);
1136 INIT_LIST_HEAD(&vdev->priv_rx);
1137 INIT_LIST_HEAD(&vdev->priv_tx);
1138 INIT_LIST_HEAD(&vdev->unlink_tx);
1139 INIT_LIST_HEAD(&vdev->unlink_rx);
1140 spin_lock_init(&vdev->priv_lock);
1142 init_waitqueue_head(&vdev->waitq_tx);
1144 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
1145 vdev->ud.eh_ops.reset = vhci_device_reset;
1146 vdev->ud.eh_ops.unusable = vhci_device_unusable;
1148 usbip_start_eh(&vdev->ud);
1151 static int hcd_name_to_id(const char *name)
1157 c = strchr(name, '.');
1161 ret = kstrtol(c+1, 10, &val);
1168 static int vhci_setup(struct usb_hcd *hcd)
1170 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1171 if (usb_hcd_is_primary_hcd(hcd)) {
1172 vhci->vhci_hcd_hs = hcd_to_vhci_hcd(hcd);
1173 vhci->vhci_hcd_hs->vhci = vhci;
1175 * Mark the first roothub as being USB 2.0.
1176 * The USB 3.0 roothub will be registered later by
1179 hcd->speed = HCD_USB2;
1180 hcd->self.root_hub->speed = USB_SPEED_HIGH;
1182 vhci->vhci_hcd_ss = hcd_to_vhci_hcd(hcd);
1183 vhci->vhci_hcd_ss->vhci = vhci;
1184 hcd->speed = HCD_USB3;
1185 hcd->self.root_hub->speed = USB_SPEED_SUPER;
1190 * sg_tablesize is an arbitrary value to alleviate memory pressure
1193 hcd->self.sg_tablesize = 32;
1194 hcd->self.no_sg_constraint = 1;
1199 static int vhci_start(struct usb_hcd *hcd)
1201 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1205 usbip_dbg_vhci_hc("enter vhci_start\n");
1207 if (usb_hcd_is_primary_hcd(hcd))
1208 spin_lock_init(&vhci_hcd->vhci->lock);
1210 /* initialize private data of usb_hcd */
1212 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1213 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1215 vhci_device_init(vdev);
1216 vdev->rhport = rhport;
1219 atomic_set(&vhci_hcd->seqnum, 0);
1221 hcd->power_budget = 0; /* no limit */
1222 hcd->uses_new_polling = 1;
1224 #ifdef CONFIG_USB_OTG
1225 hcd->self.otg_port = 1;
1228 id = hcd_name_to_id(hcd_name(hcd));
1230 pr_err("invalid vhci name %s\n", hcd_name(hcd));
1234 /* vhci_hcd is now ready to be controlled through sysfs */
1235 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1236 err = vhci_init_attr_group();
1238 dev_err(hcd_dev(hcd), "init attr group failed, err = %d\n", err);
1241 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1243 dev_err(hcd_dev(hcd), "create sysfs files failed, err = %d\n", err);
1244 vhci_finish_attr_group();
1247 pr_info("created sysfs %s\n", hcd_name(hcd));
1253 static void vhci_stop(struct usb_hcd *hcd)
1255 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1258 usbip_dbg_vhci_hc("stop VHCI controller\n");
1260 /* 1. remove the userland interface of vhci_hcd */
1261 id = hcd_name_to_id(hcd_name(hcd));
1262 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1263 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1264 vhci_finish_attr_group();
1267 /* 2. shutdown all the ports of vhci_hcd */
1268 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1269 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1271 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1272 usbip_stop_eh(&vdev->ud);
1276 static int vhci_get_frame_number(struct usb_hcd *hcd)
1278 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n");
1284 /* FIXME: suspend/resume */
1285 static int vhci_bus_suspend(struct usb_hcd *hcd)
1287 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1288 unsigned long flags;
1290 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1292 spin_lock_irqsave(&vhci->lock, flags);
1293 hcd->state = HC_STATE_SUSPENDED;
1294 spin_unlock_irqrestore(&vhci->lock, flags);
1299 static int vhci_bus_resume(struct usb_hcd *hcd)
1301 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1303 unsigned long flags;
1305 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1307 spin_lock_irqsave(&vhci->lock, flags);
1308 if (!HCD_HW_ACCESSIBLE(hcd))
1311 hcd->state = HC_STATE_RUNNING;
1312 spin_unlock_irqrestore(&vhci->lock, flags);
1319 #define vhci_bus_suspend NULL
1320 #define vhci_bus_resume NULL
1323 /* Change a group of bulk endpoints to support multiple stream IDs */
1324 static int vhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1325 struct usb_host_endpoint **eps, unsigned int num_eps,
1326 unsigned int num_streams, gfp_t mem_flags)
1328 dev_dbg(&hcd->self.root_hub->dev, "vhci_alloc_streams not implemented\n");
1332 /* Reverts a group of bulk endpoints back to not using stream IDs. */
1333 static int vhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1334 struct usb_host_endpoint **eps, unsigned int num_eps,
1337 dev_dbg(&hcd->self.root_hub->dev, "vhci_free_streams not implemented\n");
1341 static const struct hc_driver vhci_hc_driver = {
1342 .description = driver_name,
1343 .product_desc = driver_desc,
1344 .hcd_priv_size = sizeof(struct vhci_hcd),
1346 .flags = HCD_USB3 | HCD_SHARED,
1348 .reset = vhci_setup,
1349 .start = vhci_start,
1352 .urb_enqueue = vhci_urb_enqueue,
1353 .urb_dequeue = vhci_urb_dequeue,
1355 .get_frame_number = vhci_get_frame_number,
1357 .hub_status_data = vhci_hub_status,
1358 .hub_control = vhci_hub_control,
1359 .bus_suspend = vhci_bus_suspend,
1360 .bus_resume = vhci_bus_resume,
1362 .alloc_streams = vhci_alloc_streams,
1363 .free_streams = vhci_free_streams,
1366 static int vhci_hcd_probe(struct platform_device *pdev)
1368 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1369 struct usb_hcd *hcd_hs;
1370 struct usb_hcd *hcd_ss;
1373 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1376 * Allocate and initialize hcd.
1377 * Our private data is also allocated automatically.
1379 hcd_hs = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1381 pr_err("create primary hcd failed\n");
1387 * Finish generic HCD structure initialization and register.
1388 * Call the driver's reset() and start() routines.
1390 ret = usb_add_hcd(hcd_hs, 0, 0);
1392 pr_err("usb_add_hcd hs failed %d\n", ret);
1396 hcd_ss = usb_create_shared_hcd(&vhci_hc_driver, &pdev->dev,
1397 dev_name(&pdev->dev), hcd_hs);
1400 pr_err("create shared hcd failed\n");
1401 goto remove_usb2_hcd;
1404 ret = usb_add_hcd(hcd_ss, 0, 0);
1406 pr_err("usb_add_hcd ss failed %d\n", ret);
1410 usbip_dbg_vhci_hc("bye\n");
1414 usb_put_hcd(hcd_ss);
1416 usb_remove_hcd(hcd_hs);
1418 usb_put_hcd(hcd_hs);
1419 vhci->vhci_hcd_hs = NULL;
1420 vhci->vhci_hcd_ss = NULL;
1424 static int vhci_hcd_remove(struct platform_device *pdev)
1426 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1429 * Disconnects the root hub,
1430 * then reverses the effects of usb_add_hcd(),
1431 * invoking the HCD's stop() methods.
1433 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1434 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1436 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1437 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1439 vhci->vhci_hcd_hs = NULL;
1440 vhci->vhci_hcd_ss = NULL;
1447 /* what should happen for USB/IP under suspend/resume? */
1448 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1450 struct usb_hcd *hcd;
1455 unsigned long flags;
1457 dev_dbg(&pdev->dev, "%s\n", __func__);
1459 hcd = platform_get_drvdata(pdev);
1463 vhci = *((void **)dev_get_platdata(hcd->self.controller));
1465 spin_lock_irqsave(&vhci->lock, flags);
1467 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1468 if (vhci->vhci_hcd_hs->port_status[rhport] &
1469 USB_PORT_STAT_CONNECTION)
1472 if (vhci->vhci_hcd_ss->port_status[rhport] &
1473 USB_PORT_STAT_CONNECTION)
1477 spin_unlock_irqrestore(&vhci->lock, flags);
1479 if (connected > 0) {
1480 dev_info(&pdev->dev,
1481 "We have %d active connection%s. Do not suspend.\n",
1482 connected, (connected == 1 ? "" : "s"));
1485 dev_info(&pdev->dev, "suspend vhci_hcd");
1486 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1492 static int vhci_hcd_resume(struct platform_device *pdev)
1494 struct usb_hcd *hcd;
1496 dev_dbg(&pdev->dev, "%s\n", __func__);
1498 hcd = platform_get_drvdata(pdev);
1501 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1502 usb_hcd_poll_rh_status(hcd);
1509 #define vhci_hcd_suspend NULL
1510 #define vhci_hcd_resume NULL
1514 static struct platform_driver vhci_driver = {
1515 .probe = vhci_hcd_probe,
1516 .remove = vhci_hcd_remove,
1517 .suspend = vhci_hcd_suspend,
1518 .resume = vhci_hcd_resume,
1520 .name = driver_name,
1524 static void del_platform_devices(void)
1526 struct platform_device *pdev;
1529 for (i = 0; i < vhci_num_controllers; i++) {
1530 pdev = vhcis[i].pdev;
1532 platform_device_unregister(pdev);
1533 vhcis[i].pdev = NULL;
1535 sysfs_remove_link(&platform_bus.kobj, driver_name);
1538 static int __init vhci_hcd_init(void)
1545 if (vhci_num_controllers < 1)
1546 vhci_num_controllers = 1;
1548 vhcis = kcalloc(vhci_num_controllers, sizeof(struct vhci), GFP_KERNEL);
1552 for (i = 0; i < vhci_num_controllers; i++) {
1553 vhcis[i].pdev = platform_device_alloc(driver_name, i);
1554 if (!vhcis[i].pdev) {
1557 platform_device_put(vhcis[i--].pdev);
1559 goto err_device_alloc;
1562 for (i = 0; i < vhci_num_controllers; i++) {
1563 void *vhci = &vhcis[i];
1564 ret = platform_device_add_data(vhcis[i].pdev, &vhci, sizeof(void *));
1566 goto err_driver_register;
1569 ret = platform_driver_register(&vhci_driver);
1571 goto err_driver_register;
1573 for (i = 0; i < vhci_num_controllers; i++) {
1574 ret = platform_device_add(vhcis[i].pdev);
1578 platform_device_del(vhcis[i--].pdev);
1586 platform_driver_unregister(&vhci_driver);
1587 err_driver_register:
1588 for (i = 0; i < vhci_num_controllers; i++)
1589 platform_device_put(vhcis[i].pdev);
1595 static void __exit vhci_hcd_exit(void)
1597 del_platform_devices();
1598 platform_driver_unregister(&vhci_driver);
1602 module_init(vhci_hcd_init);
1603 module_exit(vhci_hcd_exit);
1605 MODULE_AUTHOR(DRIVER_AUTHOR);
1606 MODULE_DESCRIPTION(DRIVER_DESC);
1607 MODULE_LICENSE("GPL");