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)
238 memset(desc, 0, sizeof(*desc));
239 desc->bDescriptorType = USB_DT_HUB;
240 desc->bDescLength = 9;
241 desc->wHubCharacteristics = cpu_to_le16(
242 HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_COMMON_OCPM);
243 desc->bNbrPorts = VHCI_HC_PORTS;
244 desc->u.hs.DeviceRemovable[0] = 0xff;
245 desc->u.hs.DeviceRemovable[1] = 0xff;
248 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
249 u16 wIndex, char *buf, u16 wLength)
251 struct vhci_hcd *dum;
256 u32 prev_port_status[VHCI_HC_PORTS];
258 if (!HCD_HW_ACCESSIBLE(hcd))
263 * wIndex shows the port number and begins from 1.
265 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
267 if (wIndex > VHCI_HC_PORTS)
268 pr_err("invalid port number %d\n", wIndex);
269 rhport = ((__u8)(wIndex & 0x00ff)) - 1;
271 dum = hcd_to_vhci(hcd);
273 spin_lock_irqsave(&dum->lock, flags);
275 /* store old status and compare now and old later */
276 if (usbip_dbg_flag_vhci_rh) {
277 memcpy(prev_port_status, dum->port_status,
278 sizeof(prev_port_status));
282 case ClearHubFeature:
283 usbip_dbg_vhci_rh(" ClearHubFeature\n");
285 case ClearPortFeature:
287 case USB_PORT_FEAT_SUSPEND:
288 if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
289 /* 20msec signaling */
292 jiffies + msecs_to_jiffies(20);
295 case USB_PORT_FEAT_POWER:
297 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
298 dum->port_status[rhport] = 0;
301 case USB_PORT_FEAT_C_RESET:
303 " ClearPortFeature: USB_PORT_FEAT_C_RESET\n");
304 switch (dum->vdev[rhport].speed) {
306 dum->port_status[rhport] |=
307 USB_PORT_STAT_HIGH_SPEED;
310 dum->port_status[rhport] |=
311 USB_PORT_STAT_LOW_SPEED;
317 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
319 dum->port_status[rhport] &= ~(1 << wValue);
323 case GetHubDescriptor:
324 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
325 hub_descriptor((struct usb_hub_descriptor *) buf);
328 usbip_dbg_vhci_rh(" GetHubStatus\n");
329 *(__le32 *) buf = cpu_to_le32(0);
332 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
333 if (wIndex > VHCI_HC_PORTS || wIndex < 1) {
334 pr_err("invalid port number %d\n", wIndex);
338 /* we do not care about resume. */
340 /* whoever resets or resumes must GetPortStatus to
343 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
344 dum->port_status[rhport] |=
345 (1 << USB_PORT_FEAT_C_SUSPEND);
346 dum->port_status[rhport] &=
347 ~(1 << USB_PORT_FEAT_SUSPEND);
352 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
353 0 && time_after(jiffies, dum->re_timeout)) {
354 dum->port_status[rhport] |=
355 (1 << USB_PORT_FEAT_C_RESET);
356 dum->port_status[rhport] &=
357 ~(1 << USB_PORT_FEAT_RESET);
360 if (dum->vdev[rhport].ud.status ==
361 VDEV_ST_NOTASSIGNED) {
363 " enable rhport %d (status %u)\n",
365 dum->vdev[rhport].ud.status);
366 dum->port_status[rhport] |=
367 USB_PORT_STAT_ENABLE;
370 ((__le16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
371 ((__le16 *) buf)[1] =
372 cpu_to_le16(dum->port_status[rhport] >> 16);
374 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
378 usbip_dbg_vhci_rh(" SetHubFeature\n");
383 case USB_PORT_FEAT_SUSPEND:
385 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
387 case USB_PORT_FEAT_RESET:
389 " SetPortFeature: USB_PORT_FEAT_RESET\n");
390 /* if it's already running, disconnect first */
391 if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
392 dum->port_status[rhport] &=
393 ~(USB_PORT_STAT_ENABLE |
394 USB_PORT_STAT_LOW_SPEED |
395 USB_PORT_STAT_HIGH_SPEED);
396 /* FIXME test that code path! */
398 /* 50msec reset signaling */
399 dum->re_timeout = jiffies + msecs_to_jiffies(50);
403 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
405 dum->port_status[rhport] |= (1 << wValue);
411 pr_err("default: no such request\n");
413 /* "protocol stall" on error */
417 if (usbip_dbg_flag_vhci_rh) {
418 pr_debug("port %d\n", rhport);
419 /* Only dump valid port status */
421 dump_port_status_diff(prev_port_status[rhport],
422 dum->port_status[rhport]);
425 usbip_dbg_vhci_rh(" bye\n");
427 spin_unlock_irqrestore(&dum->lock, flags);
432 static struct vhci_device *get_vdev(struct usb_device *udev)
434 struct platform_device *pdev;
436 struct vhci_hcd *vhci;
442 for (pdev_nr = 0; pdev_nr < vhci_num_controllers; pdev_nr++) {
443 pdev = *(vhci_pdevs + pdev_nr);
446 hcd = platform_get_drvdata(pdev);
449 vhci = hcd_to_vhci(hcd);
450 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
451 if (vhci->vdev[rhport].udev == udev)
452 return &vhci->vdev[rhport];
459 static void vhci_tx_urb(struct urb *urb)
461 struct vhci_device *vdev = get_vdev(urb->dev);
462 struct vhci_priv *priv;
463 struct vhci_hcd *vhci;
467 pr_err("could not get virtual device");
470 vhci = vdev_to_vhci(vdev);
472 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
474 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
478 spin_lock_irqsave(&vdev->priv_lock, flags);
480 priv->seqnum = atomic_inc_return(&vhci->seqnum);
481 if (priv->seqnum == 0xffff)
482 dev_info(&urb->dev->dev, "seqnum max\n");
487 urb->hcpriv = (void *) priv;
489 list_add_tail(&priv->list, &vdev->priv_tx);
491 wake_up(&vdev->waitq_tx);
492 spin_unlock_irqrestore(&vdev->priv_lock, flags);
495 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
498 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
499 struct device *dev = &urb->dev->dev;
500 u8 portnum = urb->dev->portnum;
502 struct vhci_device *vdev;
505 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
506 hcd, urb, mem_flags);
508 if (portnum > VHCI_HC_PORTS) {
509 pr_err("invalid port number %d\n", portnum);
512 vdev = &vhci->vdev[portnum-1];
514 /* patch to usb_sg_init() is in 2.5.60 */
515 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
517 spin_lock_irqsave(&vhci->lock, flags);
519 if (urb->status != -EINPROGRESS) {
520 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
521 spin_unlock_irqrestore(&vhci->lock, flags);
525 /* refuse enqueue for dead connection */
526 spin_lock(&vdev->ud.lock);
527 if (vdev->ud.status == VDEV_ST_NULL ||
528 vdev->ud.status == VDEV_ST_ERROR) {
529 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
530 spin_unlock(&vdev->ud.lock);
531 spin_unlock_irqrestore(&vhci->lock, flags);
534 spin_unlock(&vdev->ud.lock);
536 ret = usb_hcd_link_urb_to_ep(hcd, urb);
541 * The enumeration process is as follows;
543 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
544 * to get max packet length of default pipe
546 * 2. Set_Address request to DevAddr(0) EndPoint(0)
549 if (usb_pipedevice(urb->pipe) == 0) {
550 __u8 type = usb_pipetype(urb->pipe);
551 struct usb_ctrlrequest *ctrlreq =
552 (struct usb_ctrlrequest *) urb->setup_packet;
554 if (type != PIPE_CONTROL || !ctrlreq) {
555 dev_err(dev, "invalid request to devnum 0\n");
560 switch (ctrlreq->bRequest) {
561 case USB_REQ_SET_ADDRESS:
562 /* set_address may come when a device is reset */
563 dev_info(dev, "SetAddress Request (%d) to port %d\n",
564 ctrlreq->wValue, vdev->rhport);
566 usb_put_dev(vdev->udev);
567 vdev->udev = usb_get_dev(urb->dev);
569 spin_lock(&vdev->ud.lock);
570 vdev->ud.status = VDEV_ST_USED;
571 spin_unlock(&vdev->ud.lock);
573 if (urb->status == -EINPROGRESS) {
574 /* This request is successfully completed. */
575 /* If not -EINPROGRESS, possibly unlinked. */
581 case USB_REQ_GET_DESCRIPTOR:
582 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
584 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
586 usb_put_dev(vdev->udev);
587 vdev->udev = usb_get_dev(urb->dev);
593 "invalid request to devnum 0 bRequest %u, wValue %u\n",
604 spin_unlock_irqrestore(&vhci->lock, flags);
609 usb_hcd_unlink_urb_from_ep(hcd, urb);
611 spin_unlock_irqrestore(&vhci->lock, flags);
613 usb_hcd_giveback_urb(hcd, urb, urb->status);
618 * vhci_rx gives back the urb after receiving the reply of the urb. If an
619 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
620 * back its urb. For the driver unlinking the urb, the content of the urb is
621 * not important, but the calling to its completion handler is important; the
622 * completion of unlinking is notified by the completion handler.
627 * - When vhci_hcd receives RET_SUBMIT,
629 * - case 1a). the urb of the pdu is not unlinking.
631 * => just give back the urb
633 * - case 1b). the urb of the pdu is unlinking.
634 * - usbip.ko will return a reply of the unlinking request.
635 * => give back the urb now and go to case 2b).
637 * - When vhci_hcd receives RET_UNLINK,
639 * - case 2a). a submit request is still pending in vhci_hcd.
640 * - urb was really pending in usbip.ko and urb_unlink_urb() was
642 * => free a pending submit request
643 * => notify unlink completeness by giving back the urb
645 * - case 2b). a submit request is *not* pending in vhci_hcd.
646 * - urb was already given back to the core driver.
647 * => do not give back the urb
652 * - When usbip receives CMD_UNLINK,
654 * - case 3a). the urb of the unlink request is now in submission.
655 * => do usb_unlink_urb().
656 * => after the unlink is completed, send RET_UNLINK.
658 * - case 3b). the urb of the unlink request is not in submission.
659 * - may be already completed or never be received
663 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
665 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
666 struct vhci_priv *priv;
667 struct vhci_device *vdev;
670 pr_info("dequeue a urb %p\n", urb);
672 spin_lock_irqsave(&vhci->lock, flags);
676 /* URB was never linked! or will be soon given back by
678 spin_unlock_irqrestore(&vhci->lock, flags);
685 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
687 spin_unlock_irqrestore(&vhci->lock, flags);
692 /* send unlink request here? */
695 if (!vdev->ud.tcp_socket) {
696 /* tcp connection is closed */
697 spin_lock(&vdev->priv_lock);
699 pr_info("device %p seems to be disconnected\n", vdev);
700 list_del(&priv->list);
704 spin_unlock(&vdev->priv_lock);
707 * If tcp connection is alive, we have sent CMD_UNLINK.
708 * vhci_rx will receive RET_UNLINK and give back the URB.
709 * Otherwise, we give back it here.
711 pr_info("gives back urb %p\n", urb);
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 pr_info("device %p seems to be still connected\n", vdev);
742 /* send cmd_unlink and try to cancel the pending URB in the
744 list_add_tail(&unlink->list, &vdev->unlink_tx);
745 wake_up(&vdev->waitq_tx);
747 spin_unlock(&vdev->priv_lock);
750 spin_unlock_irqrestore(&vhci->lock, flags);
752 usbip_dbg_vhci_hc("leave\n");
756 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
758 struct vhci_hcd *vhci = vdev_to_vhci(vdev);
759 struct usb_hcd *hcd = vhci_to_hcd(vhci);
760 struct vhci_unlink *unlink, *tmp;
763 spin_lock_irqsave(&vhci->lock, flags);
764 spin_lock(&vdev->priv_lock);
766 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
767 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
768 list_del(&unlink->list);
772 while (!list_empty(&vdev->unlink_rx)) {
775 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
778 /* give back URB of unanswered unlink request */
779 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
781 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
783 pr_info("the urb (seqnum %lu) was already given back\n",
784 unlink->unlink_seqnum);
785 list_del(&unlink->list);
790 urb->status = -ENODEV;
792 usb_hcd_unlink_urb_from_ep(hcd, urb);
794 list_del(&unlink->list);
796 spin_unlock(&vdev->priv_lock);
797 spin_unlock_irqrestore(&vhci->lock, flags);
799 usb_hcd_giveback_urb(hcd, urb, urb->status);
801 spin_lock_irqsave(&vhci->lock, flags);
802 spin_lock(&vdev->priv_lock);
807 spin_unlock(&vdev->priv_lock);
808 spin_unlock_irqrestore(&vhci->lock, flags);
812 * The important thing is that only one context begins cleanup.
813 * This is why error handling and cleanup become simple.
814 * We do not want to consider race condition as possible.
816 static void vhci_shutdown_connection(struct usbip_device *ud)
818 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
820 /* need this? see stub_dev.c */
821 if (ud->tcp_socket) {
822 pr_debug("shutdown tcp_socket %p\n", ud->tcp_socket);
823 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
826 /* kill threads related to this sdev */
827 if (vdev->ud.tcp_rx) {
828 kthread_stop_put(vdev->ud.tcp_rx);
829 vdev->ud.tcp_rx = NULL;
831 if (vdev->ud.tcp_tx) {
832 kthread_stop_put(vdev->ud.tcp_tx);
833 vdev->ud.tcp_tx = NULL;
835 pr_info("stop threads\n");
837 /* active connection is closed */
838 if (vdev->ud.tcp_socket) {
839 sockfd_put(vdev->ud.tcp_socket);
840 vdev->ud.tcp_socket = NULL;
842 pr_info("release socket\n");
844 vhci_device_unlink_cleanup(vdev);
847 * rh_port_disconnect() is a trigger of ...
848 * usb_disable_device():
849 * disable all the endpoints for a USB device.
850 * usb_disable_endpoint():
851 * disable endpoints. pending urbs are unlinked(dequeued).
853 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
854 * detached device should release used urbs in a cleanup function (i.e.
855 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
856 * pushed urbs and their private data in this function.
858 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
859 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
860 * gives back pushed urbs and frees their private data by request of
861 * the cleanup function of a USB driver. When unlinking a urb with an
862 * active connection, vhci_dequeue() does not give back the urb which
863 * is actually given back by vhci_rx after receiving its return pdu.
866 rh_port_disconnect(vdev);
868 pr_info("disconnect device\n");
872 static void vhci_device_reset(struct usbip_device *ud)
874 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
877 spin_lock_irqsave(&ud->lock, flags);
882 usb_put_dev(vdev->udev);
885 if (ud->tcp_socket) {
886 sockfd_put(ud->tcp_socket);
887 ud->tcp_socket = NULL;
889 ud->status = VDEV_ST_NULL;
891 spin_unlock_irqrestore(&ud->lock, flags);
894 static void vhci_device_unusable(struct usbip_device *ud)
898 spin_lock_irqsave(&ud->lock, flags);
899 ud->status = VDEV_ST_ERROR;
900 spin_unlock_irqrestore(&ud->lock, flags);
903 static void vhci_device_init(struct vhci_device *vdev)
905 memset(vdev, 0, sizeof(struct vhci_device));
907 vdev->ud.side = USBIP_VHCI;
908 vdev->ud.status = VDEV_ST_NULL;
909 spin_lock_init(&vdev->ud.lock);
911 INIT_LIST_HEAD(&vdev->priv_rx);
912 INIT_LIST_HEAD(&vdev->priv_tx);
913 INIT_LIST_HEAD(&vdev->unlink_tx);
914 INIT_LIST_HEAD(&vdev->unlink_rx);
915 spin_lock_init(&vdev->priv_lock);
917 init_waitqueue_head(&vdev->waitq_tx);
919 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
920 vdev->ud.eh_ops.reset = vhci_device_reset;
921 vdev->ud.eh_ops.unusable = vhci_device_unusable;
923 usbip_start_eh(&vdev->ud);
926 static int hcd_name_to_id(const char *name)
932 c = strchr(name, '.');
936 ret = kstrtol(c+1, 10, &val);
943 static int vhci_start(struct usb_hcd *hcd)
945 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
949 usbip_dbg_vhci_hc("enter vhci_start\n");
951 /* initialize private data of usb_hcd */
953 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
954 struct vhci_device *vdev = &vhci->vdev[rhport];
956 vhci_device_init(vdev);
957 vdev->rhport = rhport;
960 atomic_set(&vhci->seqnum, 0);
961 spin_lock_init(&vhci->lock);
963 hcd->power_budget = 0; /* no limit */
964 hcd->uses_new_polling = 1;
966 id = hcd_name_to_id(hcd_name(hcd));
968 pr_err("invalid vhci name %s\n", hcd_name(hcd));
972 /* vhci_hcd is now ready to be controlled through sysfs */
974 err = vhci_init_attr_group();
976 pr_err("init attr group\n");
979 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
981 pr_err("create sysfs files\n");
982 vhci_finish_attr_group();
985 pr_info("created sysfs %s\n", hcd_name(hcd));
991 static void vhci_stop(struct usb_hcd *hcd)
993 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
996 usbip_dbg_vhci_hc("stop VHCI controller\n");
998 /* 1. remove the userland interface of vhci_hcd */
999 id = hcd_name_to_id(hcd_name(hcd));
1001 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1002 vhci_finish_attr_group();
1005 /* 2. shutdown all the ports of vhci_hcd */
1006 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1007 struct vhci_device *vdev = &vhci->vdev[rhport];
1009 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1010 usbip_stop_eh(&vdev->ud);
1014 static int vhci_get_frame_number(struct usb_hcd *hcd)
1016 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n");
1022 /* FIXME: suspend/resume */
1023 static int vhci_bus_suspend(struct usb_hcd *hcd)
1025 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1026 unsigned long flags;
1028 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1030 spin_lock_irqsave(&vhci->lock, flags);
1031 hcd->state = HC_STATE_SUSPENDED;
1032 spin_unlock_irqrestore(&vhci->lock, flags);
1037 static int vhci_bus_resume(struct usb_hcd *hcd)
1039 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1041 unsigned long flags;
1043 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1045 spin_lock_irqsave(&vhci->lock, flags);
1046 if (!HCD_HW_ACCESSIBLE(hcd))
1049 hcd->state = HC_STATE_RUNNING;
1050 spin_unlock_irqrestore(&vhci->lock, flags);
1057 #define vhci_bus_suspend NULL
1058 #define vhci_bus_resume NULL
1061 static struct hc_driver vhci_hc_driver = {
1062 .description = driver_name,
1063 .product_desc = driver_desc,
1064 .hcd_priv_size = sizeof(struct vhci_hcd),
1068 .start = vhci_start,
1071 .urb_enqueue = vhci_urb_enqueue,
1072 .urb_dequeue = vhci_urb_dequeue,
1074 .get_frame_number = vhci_get_frame_number,
1076 .hub_status_data = vhci_hub_status,
1077 .hub_control = vhci_hub_control,
1078 .bus_suspend = vhci_bus_suspend,
1079 .bus_resume = vhci_bus_resume,
1082 static int vhci_hcd_probe(struct platform_device *pdev)
1084 struct usb_hcd *hcd;
1087 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1090 * Allocate and initialize hcd.
1091 * Our private data is also allocated automatically.
1093 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1095 pr_err("create hcd failed\n");
1101 * Finish generic HCD structure initialization and register.
1102 * Call the driver's reset() and start() routines.
1104 ret = usb_add_hcd(hcd, 0, 0);
1106 pr_err("usb_add_hcd failed %d\n", ret);
1111 usbip_dbg_vhci_hc("bye\n");
1115 static int vhci_hcd_remove(struct platform_device *pdev)
1117 struct usb_hcd *hcd;
1119 hcd = platform_get_drvdata(pdev);
1124 * Disconnects the root hub,
1125 * then reverses the effects of usb_add_hcd(),
1126 * invoking the HCD's stop() methods.
1128 usb_remove_hcd(hcd);
1136 /* what should happen for USB/IP under suspend/resume? */
1137 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1139 struct usb_hcd *hcd;
1140 struct vhci_hcd *vhci;
1144 unsigned long flags;
1146 hcd = platform_get_drvdata(pdev);
1149 vhci = hcd_to_vhci(hcd);
1151 spin_lock_irqsave(&vhci->lock, flags);
1153 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++)
1154 if (vhci->port_status[rhport] & USB_PORT_STAT_CONNECTION)
1157 spin_unlock_irqrestore(&vhci->lock, flags);
1159 if (connected > 0) {
1160 dev_info(&pdev->dev,
1161 "We have %d active connection%s. Do not suspend.\n",
1162 connected, (connected == 1 ? "" : "s"));
1165 dev_info(&pdev->dev, "suspend vhci_hcd");
1166 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1172 static int vhci_hcd_resume(struct platform_device *pdev)
1174 struct usb_hcd *hcd;
1176 dev_dbg(&pdev->dev, "%s\n", __func__);
1178 hcd = platform_get_drvdata(pdev);
1181 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1182 usb_hcd_poll_rh_status(hcd);
1189 #define vhci_hcd_suspend NULL
1190 #define vhci_hcd_resume NULL
1194 static struct platform_driver vhci_driver = {
1195 .probe = vhci_hcd_probe,
1196 .remove = vhci_hcd_remove,
1197 .suspend = vhci_hcd_suspend,
1198 .resume = vhci_hcd_resume,
1200 .name = driver_name,
1204 static int add_platform_device(int id)
1206 struct platform_device *pdev;
1214 pdev = platform_device_register_simple(driver_name, dev_nr, NULL, 0);
1216 return PTR_ERR(pdev);
1218 *(vhci_pdevs + id) = pdev;
1222 static void del_platform_devices(void)
1224 struct platform_device *pdev;
1227 for (i = 0; i < vhci_num_controllers; i++) {
1228 pdev = *(vhci_pdevs + i);
1230 platform_device_unregister(pdev);
1231 *(vhci_pdevs + i) = NULL;
1233 sysfs_remove_link(&platform_bus.kobj, driver_name);
1236 static int __init vhci_hcd_init(void)
1243 if (vhci_num_controllers < 1)
1244 vhci_num_controllers = 1;
1246 vhci_pdevs = kcalloc(vhci_num_controllers, sizeof(void *), GFP_KERNEL);
1247 if (vhci_pdevs == NULL)
1250 ret = platform_driver_register(&vhci_driver);
1252 goto err_driver_register;
1254 for (i = 0; i < vhci_num_controllers; i++) {
1255 ret = add_platform_device(i);
1257 goto err_platform_device_register;
1260 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
1263 err_platform_device_register:
1264 del_platform_devices();
1265 platform_driver_unregister(&vhci_driver);
1266 err_driver_register:
1271 static void __exit vhci_hcd_exit(void)
1273 del_platform_devices();
1274 platform_driver_unregister(&vhci_driver);
1278 module_init(vhci_hcd_init);
1279 module_exit(vhci_hcd_exit);
1281 MODULE_AUTHOR(DRIVER_AUTHOR);
1282 MODULE_DESCRIPTION(DRIVER_DESC);
1283 MODULE_LICENSE("GPL");
1284 MODULE_VERSION(USBIP_VERSION);