2 * Copyright (C) 2003-2008 Takahiro Hirofuchi
3 * Copyright (C) 2015-2016 Nobuo Iwata
5 * This is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
21 #include <linux/init.h>
22 #include <linux/file.h>
23 #include <linux/kernel.h>
24 #include <linux/kthread.h>
25 #include <linux/module.h>
26 #include <linux/platform_device.h>
27 #include <linux/slab.h>
29 #include "usbip_common.h"
32 #define DRIVER_AUTHOR "Takahiro Hirofuchi"
33 #define DRIVER_DESC "USB/IP 'Virtual' Host Controller (VHCI) Driver"
37 * - update root hub emulation
38 * - move the emulation code to userland ?
39 * porting to other operating systems
40 * minimize kernel code
41 * - add suspend/resume code
42 * - clean up everything
45 /* See usb gadget dummy hcd */
47 static int vhci_hub_status(struct usb_hcd *hcd, char *buff);
48 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
49 u16 wIndex, char *buff, u16 wLength);
50 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
52 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
53 static int vhci_start(struct usb_hcd *vhci_hcd);
54 static void vhci_stop(struct usb_hcd *hcd);
55 static int vhci_get_frame_number(struct usb_hcd *hcd);
57 static const char driver_name[] = "vhci_hcd";
58 static const char driver_desc[] = "USB/IP Virtual Host Controller";
60 int vhci_num_controllers = VHCI_NR_HCS;
62 struct platform_device **vhci_pdevs;
64 static const char * const bit_desc[] = {
81 "C_CONNECTION", /*16*/
84 "C_OVER_CURRENT", /*19*/
99 static void dump_port_status_diff(u32 prev_status, u32 new_status)
104 pr_debug("status prev -> new: %08x -> %08x\n", prev_status, new_status);
106 u32 prev = prev_status & bit;
107 u32 new = new_status & bit;
112 else if (prev && !new)
118 pr_debug(" %c%s\n", change, bit_desc[i]);
125 void rh_port_connect(struct vhci_device *vdev, enum usb_device_speed speed)
127 struct vhci_hcd *vhci = vdev_to_vhci(vdev);
128 int rhport = vdev->rhport;
132 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
134 spin_lock_irqsave(&vhci->lock, flags);
136 status = vhci->port_status[rhport];
138 status |= USB_PORT_STAT_CONNECTION | (1 << USB_PORT_FEAT_C_CONNECTION);
142 status |= USB_PORT_STAT_HIGH_SPEED;
145 status |= USB_PORT_STAT_LOW_SPEED;
151 vhci->port_status[rhport] = status;
153 spin_unlock_irqrestore(&vhci->lock, flags);
155 usb_hcd_poll_rh_status(vhci_to_hcd(vhci));
158 static void rh_port_disconnect(struct vhci_device *vdev)
160 struct vhci_hcd *vhci = vdev_to_vhci(vdev);
161 int rhport = vdev->rhport;
165 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
167 spin_lock_irqsave(&vhci->lock, flags);
169 status = vhci->port_status[rhport];
171 status &= ~USB_PORT_STAT_CONNECTION;
172 status |= (1 << USB_PORT_FEAT_C_CONNECTION);
174 vhci->port_status[rhport] = status;
176 spin_unlock_irqrestore(&vhci->lock, flags);
177 usb_hcd_poll_rh_status(vhci_to_hcd(vhci));
180 #define PORT_C_MASK \
181 ((USB_PORT_STAT_C_CONNECTION \
182 | USB_PORT_STAT_C_ENABLE \
183 | USB_PORT_STAT_C_SUSPEND \
184 | USB_PORT_STAT_C_OVERCURRENT \
185 | USB_PORT_STAT_C_RESET) << 16)
188 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
189 * Ports are 0-indexed from the HCD point of view,
190 * and 1-indexed from the USB core pointer of view.
192 * @buf: a bitmap to show which port status has been changed.
194 * bit 1: the status of port 0 has been changed.
195 * bit 2: the status of port 1 has been changed.
198 static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
200 struct vhci_hcd *vhci;
206 retval = DIV_ROUND_UP(VHCI_HC_PORTS + 1, 8);
207 memset(buf, 0, retval);
209 vhci = hcd_to_vhci(hcd);
211 spin_lock_irqsave(&vhci->lock, flags);
212 if (!HCD_HW_ACCESSIBLE(hcd)) {
213 usbip_dbg_vhci_rh("hw accessible flag not on?\n");
217 /* check pseudo status register for each port */
218 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
219 if ((vhci->port_status[rhport] & PORT_C_MASK)) {
220 /* The status of a port has been changed, */
221 usbip_dbg_vhci_rh("port %d status changed\n", rhport);
223 buf[(rhport + 1) / 8] |= 1 << (rhport + 1) % 8;
228 if ((hcd->state == HC_STATE_SUSPENDED) && (changed == 1))
229 usb_hcd_resume_root_hub(hcd);
232 spin_unlock_irqrestore(&vhci->lock, flags);
233 return changed ? retval : 0;
236 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
240 memset(desc, 0, sizeof(*desc));
241 desc->bDescriptorType = USB_DT_HUB;
242 desc->wHubCharacteristics = cpu_to_le16(
243 HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_COMMON_OCPM);
245 desc->bNbrPorts = VHCI_HC_PORTS;
246 BUILD_BUG_ON(VHCI_HC_PORTS > USB_MAXCHILDREN);
247 width = desc->bNbrPorts / 8 + 1;
248 desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * width;
249 memset(&desc->u.hs.DeviceRemovable[0], 0, width);
250 memset(&desc->u.hs.DeviceRemovable[width], 0xff, width);
253 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
254 u16 wIndex, char *buf, u16 wLength)
256 struct vhci_hcd *dum;
261 u32 prev_port_status[VHCI_HC_PORTS];
263 if (!HCD_HW_ACCESSIBLE(hcd))
268 * wIndex shows the port number and begins from 1.
270 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
272 if (wIndex > VHCI_HC_PORTS)
273 pr_err("invalid port number %d\n", wIndex);
274 rhport = ((__u8)(wIndex & 0x00ff)) - 1;
276 dum = hcd_to_vhci(hcd);
278 spin_lock_irqsave(&dum->lock, flags);
280 /* store old status and compare now and old later */
281 if (usbip_dbg_flag_vhci_rh) {
282 memcpy(prev_port_status, dum->port_status,
283 sizeof(prev_port_status));
287 case ClearHubFeature:
288 usbip_dbg_vhci_rh(" ClearHubFeature\n");
290 case ClearPortFeature:
292 case USB_PORT_FEAT_SUSPEND:
293 if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
294 /* 20msec signaling */
297 jiffies + msecs_to_jiffies(20);
300 case USB_PORT_FEAT_POWER:
302 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
303 dum->port_status[rhport] &= ~USB_PORT_STAT_POWER;
306 case USB_PORT_FEAT_C_RESET:
308 " ClearPortFeature: USB_PORT_FEAT_C_RESET\n");
309 switch (dum->vdev[rhport].speed) {
311 dum->port_status[rhport] |=
312 USB_PORT_STAT_HIGH_SPEED;
315 dum->port_status[rhport] |=
316 USB_PORT_STAT_LOW_SPEED;
323 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
325 dum->port_status[rhport] &= ~(1 << wValue);
329 case GetHubDescriptor:
330 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
331 hub_descriptor((struct usb_hub_descriptor *) buf);
334 usbip_dbg_vhci_rh(" GetHubStatus\n");
335 *(__le32 *) buf = cpu_to_le32(0);
338 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
339 if (wIndex > VHCI_HC_PORTS || wIndex < 1) {
340 pr_err("invalid port number %d\n", wIndex);
344 /* we do not care about resume. */
346 /* whoever resets or resumes must GetPortStatus to
349 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
350 dum->port_status[rhport] |=
351 (1 << USB_PORT_FEAT_C_SUSPEND);
352 dum->port_status[rhport] &=
353 ~(1 << USB_PORT_FEAT_SUSPEND);
358 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
359 0 && time_after(jiffies, dum->re_timeout)) {
360 dum->port_status[rhport] |=
361 (1 << USB_PORT_FEAT_C_RESET);
362 dum->port_status[rhport] &=
363 ~(1 << USB_PORT_FEAT_RESET);
366 if (dum->vdev[rhport].ud.status ==
367 VDEV_ST_NOTASSIGNED) {
369 " enable rhport %d (status %u)\n",
371 dum->vdev[rhport].ud.status);
372 dum->port_status[rhport] |=
373 USB_PORT_STAT_ENABLE;
376 ((__le16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
377 ((__le16 *) buf)[1] =
378 cpu_to_le16(dum->port_status[rhport] >> 16);
380 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
384 usbip_dbg_vhci_rh(" SetHubFeature\n");
389 case USB_PORT_FEAT_SUSPEND:
391 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
393 case USB_PORT_FEAT_RESET:
395 " SetPortFeature: USB_PORT_FEAT_RESET\n");
396 /* if it's already running, disconnect first */
397 if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
398 dum->port_status[rhport] &=
399 ~(USB_PORT_STAT_ENABLE |
400 USB_PORT_STAT_LOW_SPEED |
401 USB_PORT_STAT_HIGH_SPEED);
402 /* FIXME test that code path! */
404 /* 50msec reset signaling */
405 dum->re_timeout = jiffies + msecs_to_jiffies(50);
409 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
411 dum->port_status[rhport] |= (1 << wValue);
417 pr_err("default: no such request\n");
419 /* "protocol stall" on error */
423 if (usbip_dbg_flag_vhci_rh) {
424 pr_debug("port %d\n", rhport);
425 /* Only dump valid port status */
427 dump_port_status_diff(prev_port_status[rhport],
428 dum->port_status[rhport]);
431 usbip_dbg_vhci_rh(" bye\n");
433 spin_unlock_irqrestore(&dum->lock, flags);
438 static struct vhci_device *get_vdev(struct usb_device *udev)
440 struct platform_device *pdev;
442 struct vhci_hcd *vhci;
448 for (pdev_nr = 0; pdev_nr < vhci_num_controllers; pdev_nr++) {
449 pdev = *(vhci_pdevs + pdev_nr);
452 hcd = platform_get_drvdata(pdev);
455 vhci = hcd_to_vhci(hcd);
456 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
457 if (vhci->vdev[rhport].udev == udev)
458 return &vhci->vdev[rhport];
465 static void vhci_tx_urb(struct urb *urb)
467 struct vhci_device *vdev = get_vdev(urb->dev);
468 struct vhci_priv *priv;
469 struct vhci_hcd *vhci;
473 pr_err("could not get virtual device");
476 vhci = vdev_to_vhci(vdev);
478 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
480 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
484 spin_lock_irqsave(&vdev->priv_lock, flags);
486 priv->seqnum = atomic_inc_return(&vhci->seqnum);
487 if (priv->seqnum == 0xffff)
488 dev_info(&urb->dev->dev, "seqnum max\n");
493 urb->hcpriv = (void *) priv;
495 list_add_tail(&priv->list, &vdev->priv_tx);
497 wake_up(&vdev->waitq_tx);
498 spin_unlock_irqrestore(&vdev->priv_lock, flags);
501 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
504 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
505 struct device *dev = &urb->dev->dev;
506 u8 portnum = urb->dev->portnum;
508 struct vhci_device *vdev;
511 if (portnum > VHCI_HC_PORTS) {
512 pr_err("invalid port number %d\n", portnum);
515 vdev = &vhci->vdev[portnum-1];
517 if (!urb->transfer_buffer && urb->transfer_buffer_length) {
518 dev_dbg(dev, "Null URB transfer buffer\n");
522 spin_lock_irqsave(&vhci->lock, flags);
524 if (urb->status != -EINPROGRESS) {
525 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
526 spin_unlock_irqrestore(&vhci->lock, flags);
530 /* refuse enqueue for dead connection */
531 spin_lock(&vdev->ud.lock);
532 if (vdev->ud.status == VDEV_ST_NULL ||
533 vdev->ud.status == VDEV_ST_ERROR) {
534 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
535 spin_unlock(&vdev->ud.lock);
536 spin_unlock_irqrestore(&vhci->lock, flags);
539 spin_unlock(&vdev->ud.lock);
541 ret = usb_hcd_link_urb_to_ep(hcd, urb);
546 * The enumeration process is as follows;
548 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
549 * to get max packet length of default pipe
551 * 2. Set_Address request to DevAddr(0) EndPoint(0)
554 if (usb_pipedevice(urb->pipe) == 0) {
555 __u8 type = usb_pipetype(urb->pipe);
556 struct usb_ctrlrequest *ctrlreq =
557 (struct usb_ctrlrequest *) urb->setup_packet;
559 if (type != PIPE_CONTROL || !ctrlreq) {
560 dev_err(dev, "invalid request to devnum 0\n");
565 switch (ctrlreq->bRequest) {
566 case USB_REQ_SET_ADDRESS:
567 /* set_address may come when a device is reset */
568 dev_info(dev, "SetAddress Request (%d) to port %d\n",
569 ctrlreq->wValue, vdev->rhport);
571 usb_put_dev(vdev->udev);
572 vdev->udev = usb_get_dev(urb->dev);
574 spin_lock(&vdev->ud.lock);
575 vdev->ud.status = VDEV_ST_USED;
576 spin_unlock(&vdev->ud.lock);
578 if (urb->status == -EINPROGRESS) {
579 /* This request is successfully completed. */
580 /* If not -EINPROGRESS, possibly unlinked. */
586 case USB_REQ_GET_DESCRIPTOR:
587 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
589 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
591 usb_put_dev(vdev->udev);
592 vdev->udev = usb_get_dev(urb->dev);
598 "invalid request to devnum 0 bRequest %u, wValue %u\n",
609 spin_unlock_irqrestore(&vhci->lock, flags);
614 usb_hcd_unlink_urb_from_ep(hcd, urb);
616 spin_unlock_irqrestore(&vhci->lock, flags);
618 usb_hcd_giveback_urb(hcd, urb, urb->status);
623 * vhci_rx gives back the urb after receiving the reply of the urb. If an
624 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
625 * back its urb. For the driver unlinking the urb, the content of the urb is
626 * not important, but the calling to its completion handler is important; the
627 * completion of unlinking is notified by the completion handler.
632 * - When vhci_hcd receives RET_SUBMIT,
634 * - case 1a). the urb of the pdu is not unlinking.
636 * => just give back the urb
638 * - case 1b). the urb of the pdu is unlinking.
639 * - usbip.ko will return a reply of the unlinking request.
640 * => give back the urb now and go to case 2b).
642 * - When vhci_hcd receives RET_UNLINK,
644 * - case 2a). a submit request is still pending in vhci_hcd.
645 * - urb was really pending in usbip.ko and urb_unlink_urb() was
647 * => free a pending submit request
648 * => notify unlink completeness by giving back the urb
650 * - case 2b). a submit request is *not* pending in vhci_hcd.
651 * - urb was already given back to the core driver.
652 * => do not give back the urb
657 * - When usbip receives CMD_UNLINK,
659 * - case 3a). the urb of the unlink request is now in submission.
660 * => do usb_unlink_urb().
661 * => after the unlink is completed, send RET_UNLINK.
663 * - case 3b). the urb of the unlink request is not in submission.
664 * - may be already completed or never be received
668 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
670 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
671 struct vhci_priv *priv;
672 struct vhci_device *vdev;
675 spin_lock_irqsave(&vhci->lock, flags);
679 /* URB was never linked! or will be soon given back by
681 spin_unlock_irqrestore(&vhci->lock, flags);
688 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
690 spin_unlock_irqrestore(&vhci->lock, flags);
695 /* send unlink request here? */
698 if (!vdev->ud.tcp_socket) {
699 /* tcp connection is closed */
700 spin_lock(&vdev->priv_lock);
702 list_del(&priv->list);
706 spin_unlock(&vdev->priv_lock);
709 * If tcp connection is alive, we have sent CMD_UNLINK.
710 * vhci_rx will receive RET_UNLINK and give back the URB.
711 * Otherwise, we give back it here.
713 usb_hcd_unlink_urb_from_ep(hcd, urb);
715 spin_unlock_irqrestore(&vhci->lock, flags);
716 usb_hcd_giveback_urb(vhci_to_hcd(vhci), urb, urb->status);
717 spin_lock_irqsave(&vhci->lock, flags);
720 /* tcp connection is alive */
721 struct vhci_unlink *unlink;
723 spin_lock(&vdev->priv_lock);
725 /* setup CMD_UNLINK pdu */
726 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
728 spin_unlock(&vdev->priv_lock);
729 spin_unlock_irqrestore(&vhci->lock, flags);
730 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
734 unlink->seqnum = atomic_inc_return(&vhci->seqnum);
735 if (unlink->seqnum == 0xffff)
736 pr_info("seqnum max\n");
738 unlink->unlink_seqnum = priv->seqnum;
740 /* send cmd_unlink and try to cancel the pending URB in the
742 list_add_tail(&unlink->list, &vdev->unlink_tx);
743 wake_up(&vdev->waitq_tx);
745 spin_unlock(&vdev->priv_lock);
748 spin_unlock_irqrestore(&vhci->lock, flags);
750 usbip_dbg_vhci_hc("leave\n");
754 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
756 struct vhci_hcd *vhci = vdev_to_vhci(vdev);
757 struct usb_hcd *hcd = vhci_to_hcd(vhci);
758 struct vhci_unlink *unlink, *tmp;
761 spin_lock_irqsave(&vhci->lock, flags);
762 spin_lock(&vdev->priv_lock);
764 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
767 /* give back urb of unsent unlink request */
768 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
770 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
772 list_del(&unlink->list);
777 urb->status = -ENODEV;
779 usb_hcd_unlink_urb_from_ep(hcd, urb);
781 list_del(&unlink->list);
783 spin_unlock(&vdev->priv_lock);
784 spin_unlock_irqrestore(&vhci->lock, flags);
786 usb_hcd_giveback_urb(hcd, urb, urb->status);
788 spin_lock_irqsave(&vhci->lock, flags);
789 spin_lock(&vdev->priv_lock);
794 while (!list_empty(&vdev->unlink_rx)) {
797 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
800 /* give back URB of unanswered unlink request */
801 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
803 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
805 pr_info("the urb (seqnum %lu) was already given back\n",
806 unlink->unlink_seqnum);
807 list_del(&unlink->list);
812 urb->status = -ENODEV;
814 usb_hcd_unlink_urb_from_ep(hcd, urb);
816 list_del(&unlink->list);
818 spin_unlock(&vdev->priv_lock);
819 spin_unlock_irqrestore(&vhci->lock, flags);
821 usb_hcd_giveback_urb(hcd, urb, urb->status);
823 spin_lock_irqsave(&vhci->lock, flags);
824 spin_lock(&vdev->priv_lock);
829 spin_unlock(&vdev->priv_lock);
830 spin_unlock_irqrestore(&vhci->lock, flags);
834 * The important thing is that only one context begins cleanup.
835 * This is why error handling and cleanup become simple.
836 * We do not want to consider race condition as possible.
838 static void vhci_shutdown_connection(struct usbip_device *ud)
840 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
842 /* need this? see stub_dev.c */
843 if (ud->tcp_socket) {
844 pr_debug("shutdown tcp_socket\n");
845 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
848 /* kill threads related to this sdev */
849 if (vdev->ud.tcp_rx) {
850 kthread_stop_put(vdev->ud.tcp_rx);
851 vdev->ud.tcp_rx = NULL;
853 if (vdev->ud.tcp_tx) {
854 kthread_stop_put(vdev->ud.tcp_tx);
855 vdev->ud.tcp_tx = NULL;
857 pr_info("stop threads\n");
859 /* active connection is closed */
860 if (vdev->ud.tcp_socket) {
861 sockfd_put(vdev->ud.tcp_socket);
862 vdev->ud.tcp_socket = NULL;
863 vdev->ud.sockfd = -1;
865 pr_info("release socket\n");
867 vhci_device_unlink_cleanup(vdev);
870 * rh_port_disconnect() is a trigger of ...
871 * usb_disable_device():
872 * disable all the endpoints for a USB device.
873 * usb_disable_endpoint():
874 * disable endpoints. pending urbs are unlinked(dequeued).
876 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
877 * detached device should release used urbs in a cleanup function (i.e.
878 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
879 * pushed urbs and their private data in this function.
881 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
882 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
883 * gives back pushed urbs and frees their private data by request of
884 * the cleanup function of a USB driver. When unlinking a urb with an
885 * active connection, vhci_dequeue() does not give back the urb which
886 * is actually given back by vhci_rx after receiving its return pdu.
889 rh_port_disconnect(vdev);
891 pr_info("disconnect device\n");
895 static void vhci_device_reset(struct usbip_device *ud)
897 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
900 spin_lock_irqsave(&ud->lock, flags);
905 usb_put_dev(vdev->udev);
908 if (ud->tcp_socket) {
909 sockfd_put(ud->tcp_socket);
910 ud->tcp_socket = NULL;
913 ud->status = VDEV_ST_NULL;
915 spin_unlock_irqrestore(&ud->lock, flags);
918 static void vhci_device_unusable(struct usbip_device *ud)
922 spin_lock_irqsave(&ud->lock, flags);
923 ud->status = VDEV_ST_ERROR;
924 spin_unlock_irqrestore(&ud->lock, flags);
927 static void vhci_device_init(struct vhci_device *vdev)
929 memset(vdev, 0, sizeof(struct vhci_device));
931 vdev->ud.side = USBIP_VHCI;
932 vdev->ud.status = VDEV_ST_NULL;
933 spin_lock_init(&vdev->ud.lock);
934 mutex_init(&vdev->ud.sysfs_lock);
936 INIT_LIST_HEAD(&vdev->priv_rx);
937 INIT_LIST_HEAD(&vdev->priv_tx);
938 INIT_LIST_HEAD(&vdev->unlink_tx);
939 INIT_LIST_HEAD(&vdev->unlink_rx);
940 spin_lock_init(&vdev->priv_lock);
942 init_waitqueue_head(&vdev->waitq_tx);
944 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
945 vdev->ud.eh_ops.reset = vhci_device_reset;
946 vdev->ud.eh_ops.unusable = vhci_device_unusable;
948 usbip_start_eh(&vdev->ud);
951 static int hcd_name_to_id(const char *name)
957 c = strchr(name, '.');
961 ret = kstrtol(c+1, 10, &val);
968 static int vhci_start(struct usb_hcd *hcd)
970 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
974 usbip_dbg_vhci_hc("enter vhci_start\n");
976 /* initialize private data of usb_hcd */
978 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
979 struct vhci_device *vdev = &vhci->vdev[rhport];
981 vhci_device_init(vdev);
982 vdev->rhport = rhport;
985 atomic_set(&vhci->seqnum, 0);
986 spin_lock_init(&vhci->lock);
988 hcd->power_budget = 0; /* no limit */
989 hcd->uses_new_polling = 1;
991 id = hcd_name_to_id(hcd_name(hcd));
993 pr_err("invalid vhci name %s\n", hcd_name(hcd));
997 /* vhci_hcd is now ready to be controlled through sysfs */
999 err = vhci_init_attr_group();
1001 pr_err("init attr group\n");
1004 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1006 pr_err("create sysfs files\n");
1007 vhci_finish_attr_group();
1010 pr_info("created sysfs %s\n", hcd_name(hcd));
1016 static void vhci_stop(struct usb_hcd *hcd)
1018 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1021 usbip_dbg_vhci_hc("stop VHCI controller\n");
1023 /* 1. remove the userland interface of vhci_hcd */
1024 id = hcd_name_to_id(hcd_name(hcd));
1026 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1027 vhci_finish_attr_group();
1030 /* 2. shutdown all the ports of vhci_hcd */
1031 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1032 struct vhci_device *vdev = &vhci->vdev[rhport];
1034 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1035 usbip_stop_eh(&vdev->ud);
1039 static int vhci_get_frame_number(struct usb_hcd *hcd)
1041 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n");
1047 /* FIXME: suspend/resume */
1048 static int vhci_bus_suspend(struct usb_hcd *hcd)
1050 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1051 unsigned long flags;
1053 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1055 spin_lock_irqsave(&vhci->lock, flags);
1056 hcd->state = HC_STATE_SUSPENDED;
1057 spin_unlock_irqrestore(&vhci->lock, flags);
1062 static int vhci_bus_resume(struct usb_hcd *hcd)
1064 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1066 unsigned long flags;
1068 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1070 spin_lock_irqsave(&vhci->lock, flags);
1071 if (!HCD_HW_ACCESSIBLE(hcd))
1074 hcd->state = HC_STATE_RUNNING;
1075 spin_unlock_irqrestore(&vhci->lock, flags);
1082 #define vhci_bus_suspend NULL
1083 #define vhci_bus_resume NULL
1086 static struct hc_driver vhci_hc_driver = {
1087 .description = driver_name,
1088 .product_desc = driver_desc,
1089 .hcd_priv_size = sizeof(struct vhci_hcd),
1093 .start = vhci_start,
1096 .urb_enqueue = vhci_urb_enqueue,
1097 .urb_dequeue = vhci_urb_dequeue,
1099 .get_frame_number = vhci_get_frame_number,
1101 .hub_status_data = vhci_hub_status,
1102 .hub_control = vhci_hub_control,
1103 .bus_suspend = vhci_bus_suspend,
1104 .bus_resume = vhci_bus_resume,
1107 static int vhci_hcd_probe(struct platform_device *pdev)
1109 struct usb_hcd *hcd;
1112 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1115 * Allocate and initialize hcd.
1116 * Our private data is also allocated automatically.
1118 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1120 pr_err("create hcd failed\n");
1126 * Finish generic HCD structure initialization and register.
1127 * Call the driver's reset() and start() routines.
1129 ret = usb_add_hcd(hcd, 0, 0);
1131 pr_err("usb_add_hcd failed %d\n", ret);
1136 usbip_dbg_vhci_hc("bye\n");
1140 static int vhci_hcd_remove(struct platform_device *pdev)
1142 struct usb_hcd *hcd;
1144 hcd = platform_get_drvdata(pdev);
1149 * Disconnects the root hub,
1150 * then reverses the effects of usb_add_hcd(),
1151 * invoking the HCD's stop() methods.
1153 usb_remove_hcd(hcd);
1161 /* what should happen for USB/IP under suspend/resume? */
1162 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1164 struct usb_hcd *hcd;
1165 struct vhci_hcd *vhci;
1169 unsigned long flags;
1171 hcd = platform_get_drvdata(pdev);
1174 vhci = hcd_to_vhci(hcd);
1176 spin_lock_irqsave(&vhci->lock, flags);
1178 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++)
1179 if (vhci->port_status[rhport] & USB_PORT_STAT_CONNECTION)
1182 spin_unlock_irqrestore(&vhci->lock, flags);
1184 if (connected > 0) {
1185 dev_info(&pdev->dev,
1186 "We have %d active connection%s. Do not suspend.\n",
1187 connected, (connected == 1 ? "" : "s"));
1190 dev_info(&pdev->dev, "suspend vhci_hcd");
1191 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1197 static int vhci_hcd_resume(struct platform_device *pdev)
1199 struct usb_hcd *hcd;
1201 dev_dbg(&pdev->dev, "%s\n", __func__);
1203 hcd = platform_get_drvdata(pdev);
1206 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1207 usb_hcd_poll_rh_status(hcd);
1214 #define vhci_hcd_suspend NULL
1215 #define vhci_hcd_resume NULL
1219 static struct platform_driver vhci_driver = {
1220 .probe = vhci_hcd_probe,
1221 .remove = vhci_hcd_remove,
1222 .suspend = vhci_hcd_suspend,
1223 .resume = vhci_hcd_resume,
1225 .name = driver_name,
1229 static int add_platform_device(int id)
1231 struct platform_device *pdev;
1239 pdev = platform_device_register_simple(driver_name, dev_nr, NULL, 0);
1241 return PTR_ERR(pdev);
1243 *(vhci_pdevs + id) = pdev;
1247 static void del_platform_devices(void)
1249 struct platform_device *pdev;
1252 for (i = 0; i < vhci_num_controllers; i++) {
1253 pdev = *(vhci_pdevs + i);
1255 platform_device_unregister(pdev);
1256 *(vhci_pdevs + i) = NULL;
1258 sysfs_remove_link(&platform_bus.kobj, driver_name);
1261 static int __init vhci_hcd_init(void)
1268 if (vhci_num_controllers < 1)
1269 vhci_num_controllers = 1;
1271 vhci_pdevs = kcalloc(vhci_num_controllers, sizeof(void *), GFP_KERNEL);
1272 if (vhci_pdevs == NULL)
1275 ret = platform_driver_register(&vhci_driver);
1277 goto err_driver_register;
1279 for (i = 0; i < vhci_num_controllers; i++) {
1280 ret = add_platform_device(i);
1282 goto err_platform_device_register;
1285 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
1288 err_platform_device_register:
1289 del_platform_devices();
1290 platform_driver_unregister(&vhci_driver);
1291 err_driver_register:
1296 static void __exit vhci_hcd_exit(void)
1298 del_platform_devices();
1299 platform_driver_unregister(&vhci_driver);
1303 module_init(vhci_hcd_init);
1304 module_exit(vhci_hcd_exit);
1306 MODULE_AUTHOR(DRIVER_AUTHOR);
1307 MODULE_DESCRIPTION(DRIVER_DESC);
1308 MODULE_LICENSE("GPL");
1309 MODULE_VERSION(USBIP_VERSION);