2 * Copyright (C) 2003-2008 Takahiro Hirofuchi
4 * This is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
20 #include <linux/init.h>
21 #include <linux/kernel.h>
22 #include <linux/kthread.h>
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/slab.h>
27 #include "usbip_common.h"
30 #define DRIVER_AUTHOR "Takahiro Hirofuchi"
31 #define DRIVER_DESC "USB/IP 'Virtual' Host Controller (VHCI) Driver"
35 * - update root hub emulation
36 * - move the emulation code to userland ?
37 * porting to other operating systems
38 * minimize kernel code
39 * - add suspend/resume code
40 * - clean up everything
43 /* See usb gadget dummy hcd */
45 static int vhci_hub_status(struct usb_hcd *hcd, char *buff);
46 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
47 u16 wIndex, char *buff, u16 wLength);
48 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
50 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
51 static int vhci_start(struct usb_hcd *vhci_hcd);
52 static void vhci_stop(struct usb_hcd *hcd);
53 static int vhci_get_frame_number(struct usb_hcd *hcd);
55 static const char driver_name[] = "vhci_hcd";
56 static const char driver_desc[] = "USB/IP Virtual Host Controller";
58 struct vhci_hcd *the_controller;
60 static const char * const bit_desc[] = {
77 "C_CONNECTION", /*16*/
80 "C_OVER_CURRENT", /*19*/
95 static void dump_port_status_diff(u32 prev_status, u32 new_status)
100 pr_debug("status prev -> new: %08x -> %08x\n", prev_status, new_status);
102 u32 prev = prev_status & bit;
103 u32 new = new_status & bit;
108 else if (prev && !new)
114 pr_debug(" %c%s\n", change, bit_desc[i]);
121 void rh_port_connect(int rhport, enum usb_device_speed speed)
125 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
127 spin_lock_irqsave(&the_controller->lock, flags);
129 the_controller->port_status[rhport] |= USB_PORT_STAT_CONNECTION
130 | (1 << USB_PORT_FEAT_C_CONNECTION);
134 the_controller->port_status[rhport] |= USB_PORT_STAT_HIGH_SPEED;
137 the_controller->port_status[rhport] |= USB_PORT_STAT_LOW_SPEED;
143 /* spin_lock(&the_controller->vdev[rhport].ud.lock);
144 * the_controller->vdev[rhport].ud.status = VDEV_CONNECT;
145 * spin_unlock(&the_controller->vdev[rhport].ud.lock); */
147 spin_unlock_irqrestore(&the_controller->lock, flags);
149 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
152 void rh_port_disconnect(int rhport)
156 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
158 spin_lock_irqsave(&the_controller->lock, flags);
159 /* stop_activity(dum, driver); */
160 the_controller->port_status[rhport] &= ~USB_PORT_STAT_CONNECTION;
161 the_controller->port_status[rhport] |=
162 (1 << USB_PORT_FEAT_C_CONNECTION);
164 /* not yet complete the disconnection
165 * spin_lock(&vdev->ud.lock);
166 * vdev->ud.status = VHC_ST_DISCONNECT;
167 * spin_unlock(&vdev->ud.lock); */
169 spin_unlock_irqrestore(&the_controller->lock, flags);
170 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
173 #define PORT_C_MASK \
174 ((USB_PORT_STAT_C_CONNECTION \
175 | USB_PORT_STAT_C_ENABLE \
176 | USB_PORT_STAT_C_SUSPEND \
177 | USB_PORT_STAT_C_OVERCURRENT \
178 | USB_PORT_STAT_C_RESET) << 16)
181 * This function is almostly the same as dummy_hcd.c:dummy_hub_status() without
182 * suspend/resume support. But, it is modified to provide multiple ports.
184 * @buf: a bitmap to show which port status has been changed.
185 * bit 0: reserved or used for another purpose?
186 * bit 1: the status of port 0 has been changed.
187 * bit 2: the status of port 1 has been changed.
189 * bit 7: the status of port 6 has been changed.
190 * bit 8: the status of port 7 has been changed.
192 * bit 15: the status of port 14 has been changed.
194 * So, the maximum number of ports is 31 ( port 0 to port 30) ?
196 * The return value is the actual transferred length in byte. If nothing has
197 * been changed, return 0. In the case that the number of ports is less than or
198 * equal to 6 (VHCI_NPORTS==7), return 1.
201 static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
203 struct vhci_hcd *vhci;
207 /* the enough buffer is allocated according to USB_MAXCHILDREN */
208 unsigned long *event_bits = (unsigned long *) buf;
214 vhci = hcd_to_vhci(hcd);
216 spin_lock_irqsave(&vhci->lock, flags);
217 if (!HCD_HW_ACCESSIBLE(hcd)) {
218 usbip_dbg_vhci_rh("hw accessible flag in on?\n");
222 /* check pseudo status register for each port */
223 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
224 if ((vhci->port_status[rhport] & PORT_C_MASK)) {
225 /* The status of a port has been changed, */
226 usbip_dbg_vhci_rh("port %d is changed\n", rhport);
228 *event_bits |= 1 << (rhport + 1);
233 pr_info("changed %d\n", changed);
235 if (hcd->state == HC_STATE_SUSPENDED)
236 usb_hcd_resume_root_hub(hcd);
239 retval = 1 + (VHCI_NPORTS / 8);
244 spin_unlock_irqrestore(&vhci->lock, flags);
248 /* See hub_configure in hub.c */
249 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
253 memset(desc, 0, sizeof(*desc));
254 desc->bDescriptorType = 0x29;
255 desc->wHubCharacteristics = (__force __u16)
256 (__constant_cpu_to_le16(0x0001));
258 desc->bNbrPorts = VHCI_NPORTS;
259 BUILD_BUG_ON(VHCI_NPORTS > USB_MAXCHILDREN);
260 width = desc->bNbrPorts / 8 + 1;
261 desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * width;
262 memset(&desc->u.hs.DeviceRemovable[0], 0, width);
263 memset(&desc->u.hs.DeviceRemovable[width], 0xff, width);
266 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
267 u16 wIndex, char *buf, u16 wLength)
269 struct vhci_hcd *dum;
274 u32 prev_port_status[VHCI_NPORTS];
276 if (!HCD_HW_ACCESSIBLE(hcd))
281 * wIndex shows the port number and begins from 1.
283 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
285 if (wIndex > VHCI_NPORTS)
286 pr_err("invalid port number %d\n", wIndex);
287 rhport = ((__u8)(wIndex & 0x00ff)) - 1;
289 dum = hcd_to_vhci(hcd);
291 spin_lock_irqsave(&dum->lock, flags);
293 /* store old status and compare now and old later */
294 if (usbip_dbg_flag_vhci_rh) {
295 memcpy(prev_port_status, dum->port_status,
296 sizeof(prev_port_status));
300 case ClearHubFeature:
301 usbip_dbg_vhci_rh(" ClearHubFeature\n");
303 case ClearPortFeature:
305 case USB_PORT_FEAT_SUSPEND:
306 if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
307 /* 20msec signaling */
310 jiffies + msecs_to_jiffies(20);
313 case USB_PORT_FEAT_POWER:
314 usbip_dbg_vhci_rh(" ClearPortFeature: "
315 "USB_PORT_FEAT_POWER\n");
316 dum->port_status[rhport] = 0;
317 /* dum->address = 0; */
321 case USB_PORT_FEAT_C_RESET:
322 usbip_dbg_vhci_rh(" ClearPortFeature: "
323 "USB_PORT_FEAT_C_RESET\n");
324 switch (dum->vdev[rhport].speed) {
326 dum->port_status[rhport] |=
327 USB_PORT_STAT_HIGH_SPEED;
330 dum->port_status[rhport] |=
331 USB_PORT_STAT_LOW_SPEED;
337 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
339 dum->port_status[rhport] &= ~(1 << wValue);
343 case GetHubDescriptor:
344 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
345 hub_descriptor((struct usb_hub_descriptor *) buf);
348 usbip_dbg_vhci_rh(" GetHubStatus\n");
349 *(__le32 *) buf = __constant_cpu_to_le32(0);
352 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
353 if (wIndex > VHCI_NPORTS || wIndex < 1) {
354 pr_err("invalid port number %d\n", wIndex);
358 /* we do no care of resume. */
360 /* whoever resets or resumes must GetPortStatus to
363 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
364 dum->port_status[rhport] |=
365 (1 << USB_PORT_FEAT_C_SUSPEND);
366 dum->port_status[rhport] &=
367 ~(1 << USB_PORT_FEAT_SUSPEND);
370 /* if (dum->driver && dum->driver->resume) {
371 * spin_unlock (&dum->lock);
372 * dum->driver->resume (&dum->gadget);
373 * spin_lock (&dum->lock);
377 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
378 0 && time_after(jiffies, dum->re_timeout)) {
379 dum->port_status[rhport] |=
380 (1 << USB_PORT_FEAT_C_RESET);
381 dum->port_status[rhport] &=
382 ~(1 << USB_PORT_FEAT_RESET);
385 if (dum->vdev[rhport].ud.status ==
386 VDEV_ST_NOTASSIGNED) {
387 usbip_dbg_vhci_rh(" enable rhport %d "
390 dum->vdev[rhport].ud.status);
391 dum->port_status[rhport] |=
392 USB_PORT_STAT_ENABLE;
396 dum->port_status[rhport] |=
397 USB_PORT_STAT_ENABLE;
398 /* give it the best speed we agree on */
399 dum->gadget.speed = dum->driver->speed;
400 dum->gadget.ep0->maxpacket = 64;
401 switch (dum->gadget.speed) {
403 dum->port_status[rhport] |=
404 USB_PORT_STAT_HIGH_SPEED;
407 dum->gadget.ep0->maxpacket = 8;
408 dum->port_status[rhport] |=
409 USB_PORT_STAT_LOW_SPEED;
412 dum->gadget.speed = USB_SPEED_FULL;
418 ((u16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
419 ((u16 *) buf)[1] = cpu_to_le16(dum->port_status[rhport] >> 16);
421 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
425 usbip_dbg_vhci_rh(" SetHubFeature\n");
430 case USB_PORT_FEAT_SUSPEND:
431 usbip_dbg_vhci_rh(" SetPortFeature: "
432 "USB_PORT_FEAT_SUSPEND\n");
434 dum->port_status[rhport] |=
435 (1 << USB_PORT_FEAT_SUSPEND);
436 if (dum->driver->suspend) {
437 spin_unlock(&dum->lock);
438 dum->driver->suspend(&dum->gadget);
439 spin_lock(&dum->lock);
443 case USB_PORT_FEAT_RESET:
444 usbip_dbg_vhci_rh(" SetPortFeature: "
445 "USB_PORT_FEAT_RESET\n");
446 /* if it's already running, disconnect first */
447 if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
448 dum->port_status[rhport] &=
449 ~(USB_PORT_STAT_ENABLE |
450 USB_PORT_STAT_LOW_SPEED |
451 USB_PORT_STAT_HIGH_SPEED);
454 dev_dbg(hardware, "disconnect\n");
455 stop_activity(dum, dum->driver);
459 /* FIXME test that code path! */
461 /* 50msec reset signaling */
462 dum->re_timeout = jiffies + msecs_to_jiffies(50);
466 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
468 dum->port_status[rhport] |= (1 << wValue);
474 pr_err("default: no such request\n");
475 /* dev_dbg (hardware,
476 * "hub control req%04x v%04x i%04x l%d\n",
477 * typeReq, wValue, wIndex, wLength); */
479 /* "protocol stall" on error */
483 if (usbip_dbg_flag_vhci_rh) {
484 pr_debug("port %d\n", rhport);
485 /* Only dump valid port status */
487 dump_port_status_diff(prev_port_status[rhport],
488 dum->port_status[rhport]);
491 usbip_dbg_vhci_rh(" bye\n");
493 spin_unlock_irqrestore(&dum->lock, flags);
498 static struct vhci_device *get_vdev(struct usb_device *udev)
505 for (i = 0; i < VHCI_NPORTS; i++)
506 if (the_controller->vdev[i].udev == udev)
507 return port_to_vdev(i);
512 static void vhci_tx_urb(struct urb *urb)
514 struct vhci_device *vdev = get_vdev(urb->dev);
515 struct vhci_priv *priv;
519 pr_err("could not get virtual device");
524 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
526 spin_lock_irqsave(&vdev->priv_lock, flag);
529 dev_err(&urb->dev->dev, "malloc vhci_priv\n");
530 spin_unlock_irqrestore(&vdev->priv_lock, flag);
531 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
535 priv->seqnum = atomic_inc_return(&the_controller->seqnum);
536 if (priv->seqnum == 0xffff)
537 dev_info(&urb->dev->dev, "seqnum max\n");
542 urb->hcpriv = (void *) priv;
544 list_add_tail(&priv->list, &vdev->priv_tx);
546 wake_up(&vdev->waitq_tx);
547 spin_unlock_irqrestore(&vdev->priv_lock, flag);
550 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
553 struct device *dev = &urb->dev->dev;
556 struct vhci_device *vdev;
558 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
559 hcd, urb, mem_flags);
561 /* patch to usb_sg_init() is in 2.5.60 */
562 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
564 spin_lock_irqsave(&the_controller->lock, flags);
566 if (urb->status != -EINPROGRESS) {
567 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
568 spin_unlock_irqrestore(&the_controller->lock, flags);
572 vdev = port_to_vdev(urb->dev->portnum-1);
574 /* refuse enqueue for dead connection */
575 spin_lock(&vdev->ud.lock);
576 if (vdev->ud.status == VDEV_ST_NULL ||
577 vdev->ud.status == VDEV_ST_ERROR) {
578 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
579 spin_unlock(&vdev->ud.lock);
580 spin_unlock_irqrestore(&the_controller->lock, flags);
583 spin_unlock(&vdev->ud.lock);
585 ret = usb_hcd_link_urb_to_ep(hcd, urb);
590 * The enumeration process is as follows;
592 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
593 * to get max packet length of default pipe
595 * 2. Set_Address request to DevAddr(0) EndPoint(0)
598 if (usb_pipedevice(urb->pipe) == 0) {
599 __u8 type = usb_pipetype(urb->pipe);
600 struct usb_ctrlrequest *ctrlreq =
601 (struct usb_ctrlrequest *) urb->setup_packet;
603 if (type != PIPE_CONTROL || !ctrlreq) {
604 dev_err(dev, "invalid request to devnum 0\n");
609 switch (ctrlreq->bRequest) {
610 case USB_REQ_SET_ADDRESS:
611 /* set_address may come when a device is reset */
612 dev_info(dev, "SetAddress Request (%d) to port %d\n",
613 ctrlreq->wValue, vdev->rhport);
616 usb_put_dev(vdev->udev);
617 vdev->udev = usb_get_dev(urb->dev);
619 spin_lock(&vdev->ud.lock);
620 vdev->ud.status = VDEV_ST_USED;
621 spin_unlock(&vdev->ud.lock);
623 if (urb->status == -EINPROGRESS) {
624 /* This request is successfully completed. */
625 /* If not -EINPROGRESS, possibly unlinked. */
631 case USB_REQ_GET_DESCRIPTOR:
632 if (ctrlreq->wValue == (USB_DT_DEVICE << 8))
633 usbip_dbg_vhci_hc("Not yet?: "
634 "Get_Descriptor to device 0 "
635 "(get max pipe size)\n");
638 usb_put_dev(vdev->udev);
639 vdev->udev = usb_get_dev(urb->dev);
644 dev_err(dev, "invalid request to devnum 0 bRequest %u, "
645 "wValue %u\n", ctrlreq->bRequest,
655 spin_unlock_irqrestore(&the_controller->lock, flags);
660 usb_hcd_unlink_urb_from_ep(hcd, urb);
662 spin_unlock_irqrestore(&the_controller->lock, flags);
663 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb, urb->status);
668 * vhci_rx gives back the urb after receiving the reply of the urb. If an
669 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
670 * back its urb. For the driver unlinking the urb, the content of the urb is
671 * not important, but the calling to its completion handler is important; the
672 * completion of unlinking is notified by the completion handler.
677 * - When vhci_hcd receives RET_SUBMIT,
679 * - case 1a). the urb of the pdu is not unlinking.
681 * => just give back the urb
683 * - case 1b). the urb of the pdu is unlinking.
684 * - usbip.ko will return a reply of the unlinking request.
685 * => give back the urb now and go to case 2b).
687 * - When vhci_hcd receives RET_UNLINK,
689 * - case 2a). a submit request is still pending in vhci_hcd.
690 * - urb was really pending in usbip.ko and urb_unlink_urb() was
692 * => free a pending submit request
693 * => notify unlink completeness by giving back the urb
695 * - case 2b). a submit request is *not* pending in vhci_hcd.
696 * - urb was already given back to the core driver.
697 * => do not give back the urb
702 * - When usbip receives CMD_UNLINK,
704 * - case 3a). the urb of the unlink request is now in submission.
705 * => do usb_unlink_urb().
706 * => after the unlink is completed, send RET_UNLINK.
708 * - case 3b). the urb of the unlink request is not in submission.
709 * - may be already completed or never be received
713 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
716 struct vhci_priv *priv;
717 struct vhci_device *vdev;
719 pr_info("dequeue a urb %p\n", urb);
721 spin_lock_irqsave(&the_controller->lock, flags);
725 /* URB was never linked! or will be soon given back by
727 spin_unlock_irqrestore(&the_controller->lock, flags);
733 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
735 spin_unlock_irqrestore(&the_controller->lock, flags);
740 /* send unlink request here? */
743 if (!vdev->ud.tcp_socket) {
744 /* tcp connection is closed */
745 unsigned long flags2;
747 spin_lock_irqsave(&vdev->priv_lock, flags2);
749 pr_info("device %p seems to be disconnected\n", vdev);
750 list_del(&priv->list);
754 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
757 * If tcp connection is alive, we have sent CMD_UNLINK.
758 * vhci_rx will receive RET_UNLINK and give back the URB.
759 * Otherwise, we give back it here.
761 pr_info("gives back urb %p\n", urb);
763 usb_hcd_unlink_urb_from_ep(hcd, urb);
765 spin_unlock_irqrestore(&the_controller->lock, flags);
766 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
768 spin_lock_irqsave(&the_controller->lock, flags);
771 /* tcp connection is alive */
772 unsigned long flags2;
773 struct vhci_unlink *unlink;
775 spin_lock_irqsave(&vdev->priv_lock, flags2);
777 /* setup CMD_UNLINK pdu */
778 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
780 pr_err("malloc vhci_unlink\n");
781 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
782 spin_unlock_irqrestore(&the_controller->lock, flags);
783 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
787 unlink->seqnum = atomic_inc_return(&the_controller->seqnum);
788 if (unlink->seqnum == 0xffff)
789 pr_info("seqnum max\n");
791 unlink->unlink_seqnum = priv->seqnum;
793 pr_info("device %p seems to be still connected\n", vdev);
795 /* send cmd_unlink and try to cancel the pending URB in the
797 list_add_tail(&unlink->list, &vdev->unlink_tx);
798 wake_up(&vdev->waitq_tx);
800 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
803 spin_unlock_irqrestore(&the_controller->lock, flags);
805 usbip_dbg_vhci_hc("leave\n");
809 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
811 struct vhci_unlink *unlink, *tmp;
813 spin_lock(&vdev->priv_lock);
815 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
816 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
817 list_del(&unlink->list);
821 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_rx, list) {
824 /* give back URB of unanswered unlink request */
825 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
827 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
829 pr_info("the urb (seqnum %lu) was already given back\n",
830 unlink->unlink_seqnum);
831 list_del(&unlink->list);
836 urb->status = -ENODEV;
838 spin_lock(&the_controller->lock);
839 usb_hcd_unlink_urb_from_ep(vhci_to_hcd(the_controller), urb);
840 spin_unlock(&the_controller->lock);
842 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
845 list_del(&unlink->list);
849 spin_unlock(&vdev->priv_lock);
853 * The important thing is that only one context begins cleanup.
854 * This is why error handling and cleanup become simple.
855 * We do not want to consider race condition as possible.
857 static void vhci_shutdown_connection(struct usbip_device *ud)
859 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
861 /* need this? see stub_dev.c */
862 if (ud->tcp_socket) {
863 pr_debug("shutdown tcp_socket %p\n", ud->tcp_socket);
864 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
867 /* kill threads related to this sdev, if v.c. exists */
868 if (vdev->ud.tcp_rx && !task_is_dead(vdev->ud.tcp_rx))
869 kthread_stop(vdev->ud.tcp_rx);
870 if (vdev->ud.tcp_tx && !task_is_dead(vdev->ud.tcp_tx))
871 kthread_stop(vdev->ud.tcp_tx);
873 pr_info("stop threads\n");
875 /* active connection is closed */
876 if (vdev->ud.tcp_socket != NULL) {
877 sock_release(vdev->ud.tcp_socket);
878 vdev->ud.tcp_socket = NULL;
880 pr_info("release socket\n");
882 vhci_device_unlink_cleanup(vdev);
885 * rh_port_disconnect() is a trigger of ...
886 * usb_disable_device():
887 * disable all the endpoints for a USB device.
888 * usb_disable_endpoint():
889 * disable endpoints. pending urbs are unlinked(dequeued).
891 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
892 * deteched device should release used urbs in a cleanup function(i.e.
893 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
894 * pushed urbs and their private data in this function.
896 * NOTE: vhci_dequeue() must be considered carefully. When shutdowning
897 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
898 * gives back pushed urbs and frees their private data by request of
899 * the cleanup function of a USB driver. When unlinking a urb with an
900 * active connection, vhci_dequeue() does not give back the urb which
901 * is actually given back by vhci_rx after receiving its return pdu.
904 rh_port_disconnect(vdev->rhport);
906 pr_info("disconnect device\n");
910 static void vhci_device_reset(struct usbip_device *ud)
912 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
914 spin_lock(&ud->lock);
920 usb_put_dev(vdev->udev);
923 ud->tcp_socket = NULL;
924 ud->status = VDEV_ST_NULL;
926 spin_unlock(&ud->lock);
929 static void vhci_device_unusable(struct usbip_device *ud)
931 spin_lock(&ud->lock);
932 ud->status = VDEV_ST_ERROR;
933 spin_unlock(&ud->lock);
936 static void vhci_device_init(struct vhci_device *vdev)
938 memset(vdev, 0, sizeof(*vdev));
940 vdev->ud.side = USBIP_VHCI;
941 vdev->ud.status = VDEV_ST_NULL;
942 /* vdev->ud.lock = SPIN_LOCK_UNLOCKED; */
943 spin_lock_init(&vdev->ud.lock);
945 INIT_LIST_HEAD(&vdev->priv_rx);
946 INIT_LIST_HEAD(&vdev->priv_tx);
947 INIT_LIST_HEAD(&vdev->unlink_tx);
948 INIT_LIST_HEAD(&vdev->unlink_rx);
949 /* vdev->priv_lock = SPIN_LOCK_UNLOCKED; */
950 spin_lock_init(&vdev->priv_lock);
952 init_waitqueue_head(&vdev->waitq_tx);
954 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
955 vdev->ud.eh_ops.reset = vhci_device_reset;
956 vdev->ud.eh_ops.unusable = vhci_device_unusable;
958 usbip_start_eh(&vdev->ud);
961 static int vhci_start(struct usb_hcd *hcd)
963 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
967 usbip_dbg_vhci_hc("enter vhci_start\n");
969 /* initialize private data of usb_hcd */
971 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
972 struct vhci_device *vdev = &vhci->vdev[rhport];
973 vhci_device_init(vdev);
974 vdev->rhport = rhport;
977 atomic_set(&vhci->seqnum, 0);
978 spin_lock_init(&vhci->lock);
980 hcd->power_budget = 0; /* no limit */
981 hcd->state = HC_STATE_RUNNING;
982 hcd->uses_new_polling = 1;
984 /* vhci_hcd is now ready to be controlled through sysfs */
985 err = sysfs_create_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
987 pr_err("create sysfs files\n");
994 static void vhci_stop(struct usb_hcd *hcd)
996 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
999 usbip_dbg_vhci_hc("stop VHCI controller\n");
1001 /* 1. remove the userland interface of vhci_hcd */
1002 sysfs_remove_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
1004 /* 2. shutdown all the ports of vhci_hcd */
1005 for (rhport = 0 ; rhport < VHCI_NPORTS; rhport++) {
1006 struct vhci_device *vdev = &vhci->vdev[rhport];
1008 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1009 usbip_stop_eh(&vdev->ud);
1013 static int vhci_get_frame_number(struct usb_hcd *hcd)
1015 pr_err("Not yet implemented\n");
1021 /* FIXME: suspend/resume */
1022 static int vhci_bus_suspend(struct usb_hcd *hcd)
1024 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1026 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1028 spin_lock_irq(&vhci->lock);
1029 /* vhci->rh_state = DUMMY_RH_SUSPENDED;
1030 * set_link_state(vhci); */
1031 hcd->state = HC_STATE_SUSPENDED;
1032 spin_unlock_irq(&vhci->lock);
1037 static int vhci_bus_resume(struct usb_hcd *hcd)
1039 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1042 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1044 spin_lock_irq(&vhci->lock);
1045 if (!HCD_HW_ACCESSIBLE(hcd)) {
1048 /* vhci->rh_state = DUMMY_RH_RUNNING;
1049 * set_link_state(vhci);
1050 * if (!list_empty(&vhci->urbp_list))
1051 * mod_timer(&vhci->timer, jiffies); */
1052 hcd->state = HC_STATE_RUNNING;
1054 spin_unlock_irq(&vhci->lock);
1061 #define vhci_bus_suspend NULL
1062 #define vhci_bus_resume NULL
1065 static struct hc_driver vhci_hc_driver = {
1066 .description = driver_name,
1067 .product_desc = driver_desc,
1068 .hcd_priv_size = sizeof(struct vhci_hcd),
1072 .start = vhci_start,
1075 .urb_enqueue = vhci_urb_enqueue,
1076 .urb_dequeue = vhci_urb_dequeue,
1078 .get_frame_number = vhci_get_frame_number,
1080 .hub_status_data = vhci_hub_status,
1081 .hub_control = vhci_hub_control,
1082 .bus_suspend = vhci_bus_suspend,
1083 .bus_resume = vhci_bus_resume,
1086 static int vhci_hcd_probe(struct platform_device *pdev)
1088 struct usb_hcd *hcd;
1091 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1093 /* will be removed */
1094 if (pdev->dev.dma_mask) {
1095 dev_info(&pdev->dev, "vhci_hcd DMA not supported\n");
1100 * Allocate and initialize hcd.
1101 * Our private data is also allocated automatically.
1103 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1105 pr_err("create hcd failed\n");
1110 /* this is private data for vhci_hcd */
1111 the_controller = hcd_to_vhci(hcd);
1114 * Finish generic HCD structure initialization and register.
1115 * Call the driver's reset() and start() routines.
1117 ret = usb_add_hcd(hcd, 0, 0);
1119 pr_err("usb_add_hcd failed %d\n", ret);
1121 the_controller = NULL;
1125 usbip_dbg_vhci_hc("bye\n");
1129 static int vhci_hcd_remove(struct platform_device *pdev)
1131 struct usb_hcd *hcd;
1133 hcd = platform_get_drvdata(pdev);
1138 * Disconnects the root hub,
1139 * then reverses the effects of usb_add_hcd(),
1140 * invoking the HCD's stop() methods.
1142 usb_remove_hcd(hcd);
1144 the_controller = NULL;
1151 /* what should happen for USB/IP under suspend/resume? */
1152 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1154 struct usb_hcd *hcd;
1159 hcd = platform_get_drvdata(pdev);
1161 spin_lock(&the_controller->lock);
1163 for (rhport = 0; rhport < VHCI_NPORTS; rhport++)
1164 if (the_controller->port_status[rhport] &
1165 USB_PORT_STAT_CONNECTION)
1168 spin_unlock(&the_controller->lock);
1170 if (connected > 0) {
1171 dev_info(&pdev->dev, "We have %d active connection%s. Do not "
1172 "suspend.\n", connected, (connected == 1 ? "" : "s"));
1175 dev_info(&pdev->dev, "suspend vhci_hcd");
1176 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1182 static int vhci_hcd_resume(struct platform_device *pdev)
1184 struct usb_hcd *hcd;
1186 dev_dbg(&pdev->dev, "%s\n", __func__);
1188 hcd = platform_get_drvdata(pdev);
1189 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1190 usb_hcd_poll_rh_status(hcd);
1197 #define vhci_hcd_suspend NULL
1198 #define vhci_hcd_resume NULL
1202 static struct platform_driver vhci_driver = {
1203 .probe = vhci_hcd_probe,
1204 .remove = __devexit_p(vhci_hcd_remove),
1205 .suspend = vhci_hcd_suspend,
1206 .resume = vhci_hcd_resume,
1208 .name = (char *) driver_name,
1209 .owner = THIS_MODULE,
1214 * The VHCI 'device' is 'virtual'; not a real plug&play hardware.
1215 * We need to add this virtual device as a platform device arbitrarily:
1216 * 1. platform_device_register()
1218 static void the_pdev_release(struct device *dev)
1223 static struct platform_device the_pdev = {
1224 /* should be the same name as driver_name */
1225 .name = (char *) driver_name,
1228 /* .driver = &vhci_driver, */
1229 .release = the_pdev_release,
1233 static int __init vhci_hcd_init(void)
1240 ret = platform_driver_register(&vhci_driver);
1242 goto err_driver_register;
1244 ret = platform_device_register(&the_pdev);
1246 goto err_platform_device_register;
1248 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
1251 err_platform_device_register:
1252 platform_driver_unregister(&vhci_driver);
1253 err_driver_register:
1257 static void __exit vhci_hcd_exit(void)
1259 platform_device_unregister(&the_pdev);
1260 platform_driver_unregister(&vhci_driver);
1263 module_init(vhci_hcd_init);
1264 module_exit(vhci_hcd_exit);
1266 MODULE_AUTHOR(DRIVER_AUTHOR);
1267 MODULE_DESCRIPTION(DRIVER_DESC);
1268 MODULE_LICENSE("GPL");
1269 MODULE_VERSION(USBIP_VERSION);