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/slab.h>
22 #include "usbip_common.h"
25 #define DRIVER_VERSION "1.0"
26 #define DRIVER_AUTHOR "Takahiro Hirofuchi"
27 #define DRIVER_DESC "Virtual Host Controller Interface Driver for USB/IP"
28 #define DRIVER_LICENCE "GPL"
29 MODULE_AUTHOR(DRIVER_AUTHOR);
30 MODULE_DESCRIPTION(DRIVER_DESC);
31 MODULE_LICENSE(DRIVER_LICENCE);
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
46 /* See usb gadget dummy hcd */
49 static int vhci_hub_status(struct usb_hcd *hcd, char *buff);
50 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
51 u16 wIndex, char *buff, u16 wLength);
52 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
54 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
55 static int vhci_start(struct usb_hcd *vhci_hcd);
56 static void vhci_stop(struct usb_hcd *hcd);
57 static int vhci_get_frame_number(struct usb_hcd *hcd);
59 static const char driver_name[] = "vhci_hcd";
60 static const char driver_desc[] = "USB/IP Virtual Host Controller";
62 struct vhci_hcd *the_controller;
64 static const char *bit_desc[] = {
81 "C_CONNECTION", /*16*/
84 "C_OVER_CURRENT", /*19*/
100 static void dump_port_status(u32 status)
104 printk(KERN_DEBUG "status %08x:", status);
105 for (i = 0; i < 32; i++) {
106 if (status & (1 << i))
107 printk(" %s", bit_desc[i]);
115 void rh_port_connect(int rhport, enum usb_device_speed speed)
119 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
121 spin_lock_irqsave(&the_controller->lock, flags);
123 the_controller->port_status[rhport] |= USB_PORT_STAT_CONNECTION
124 | (1 << USB_PORT_FEAT_C_CONNECTION);
128 the_controller->port_status[rhport] |= USB_PORT_STAT_HIGH_SPEED;
131 the_controller->port_status[rhport] |= USB_PORT_STAT_LOW_SPEED;
137 /* spin_lock(&the_controller->vdev[rhport].ud.lock);
138 * the_controller->vdev[rhport].ud.status = VDEV_CONNECT;
139 * spin_unlock(&the_controller->vdev[rhport].ud.lock); */
141 spin_unlock_irqrestore(&the_controller->lock, flags);
143 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
146 void rh_port_disconnect(int rhport)
150 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
152 spin_lock_irqsave(&the_controller->lock, flags);
153 /* stop_activity(dum, driver); */
154 the_controller->port_status[rhport] &= ~USB_PORT_STAT_CONNECTION;
155 the_controller->port_status[rhport] |=
156 (1 << USB_PORT_FEAT_C_CONNECTION);
159 /* not yet complete the disconnection
160 * spin_lock(&vdev->ud.lock);
161 * vdev->ud.status = VHC_ST_DISCONNECT;
162 * spin_unlock(&vdev->ud.lock); */
164 spin_unlock_irqrestore(&the_controller->lock, flags);
166 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
171 /*----------------------------------------------------------------------*/
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 transfered 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;
215 vhci = hcd_to_vhci(hcd);
217 spin_lock_irqsave(&vhci->lock, flags);
218 if (!HCD_HW_ACCESSIBLE(hcd)) {
219 usbip_dbg_vhci_rh("hw accessible flag in on?\n");
223 /* check pseudo status register for each port */
224 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
225 if ((vhci->port_status[rhport] & PORT_C_MASK)) {
226 /* The status of a port has been changed, */
227 usbip_dbg_vhci_rh("port %d is changed\n", rhport);
229 *event_bits |= 1 << (rhport + 1);
234 usbip_uinfo("changed %d\n", changed);
236 if (hcd->state == HC_STATE_SUSPENDED)
237 usb_hcd_resume_root_hub(hcd);
240 retval = 1 + (VHCI_NPORTS / 8);
245 spin_unlock_irqrestore(&vhci->lock, flags);
249 /* See hub_configure in hub.c */
250 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
252 memset(desc, 0, sizeof(*desc));
253 desc->bDescriptorType = 0x29;
254 desc->bDescLength = 9;
255 desc->wHubCharacteristics = (__force __u16)
256 (__constant_cpu_to_le16(0x0001));
257 desc->bNbrPorts = VHCI_NPORTS;
258 desc->bitmap[0] = 0xff;
259 desc->bitmap[1] = 0xff;
262 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
263 u16 wIndex, char *buf, u16 wLength)
265 struct vhci_hcd *dum;
270 u32 prev_port_status[VHCI_NPORTS];
272 if (!HCD_HW_ACCESSIBLE(hcd))
277 * wIndex shows the port number and begins from 1.
279 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
281 if (wIndex > VHCI_NPORTS)
282 printk(KERN_ERR "%s: invalid port number %d\n", __func__,
284 rhport = ((__u8)(wIndex & 0x00ff)) - 1;
286 dum = hcd_to_vhci(hcd);
288 spin_lock_irqsave(&dum->lock, flags);
290 /* store old status and compare now and old later */
291 if (usbip_dbg_flag_vhci_rh) {
293 for (i = 0; i < VHCI_NPORTS; i++)
294 prev_port_status[i] = dum->port_status[i];
298 case ClearHubFeature:
299 usbip_dbg_vhci_rh(" ClearHubFeature\n");
301 case ClearPortFeature:
303 case USB_PORT_FEAT_SUSPEND:
304 if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
305 /* 20msec signaling */
308 jiffies + msecs_to_jiffies(20);
311 case USB_PORT_FEAT_POWER:
312 usbip_dbg_vhci_rh(" ClearPortFeature: "
313 "USB_PORT_FEAT_POWER\n");
314 dum->port_status[rhport] = 0;
315 /* dum->address = 0; */
319 case USB_PORT_FEAT_C_RESET:
320 usbip_dbg_vhci_rh(" ClearPortFeature: "
321 "USB_PORT_FEAT_C_RESET\n");
322 switch (dum->vdev[rhport].speed) {
324 dum->port_status[rhport] |=
325 USB_PORT_STAT_HIGH_SPEED;
328 dum->port_status[rhport] |=
329 USB_PORT_STAT_LOW_SPEED;
335 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
337 dum->port_status[rhport] &= ~(1 << wValue);
340 case GetHubDescriptor:
341 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
342 hub_descriptor((struct usb_hub_descriptor *) buf);
345 usbip_dbg_vhci_rh(" GetHubStatus\n");
346 *(__le32 *) buf = __constant_cpu_to_le32(0);
349 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
350 if (wIndex > VHCI_NPORTS || wIndex < 1) {
351 printk(KERN_ERR "%s: invalid port number %d\n",
356 /* we do no care of resume. */
358 /* whoever resets or resumes must GetPortStatus to
361 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
362 printk(KERN_ERR "%s: not yet\n", __func__);
363 dum->port_status[rhport] |=
364 (1 << USB_PORT_FEAT_C_SUSPEND);
365 dum->port_status[rhport] &=
366 ~(1 << USB_PORT_FEAT_SUSPEND);
369 /* if (dum->driver && dum->driver->resume) {
370 * spin_unlock (&dum->lock);
371 * dum->driver->resume (&dum->gadget);
372 * spin_lock (&dum->lock);
376 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
377 0 && time_after(jiffies, dum->re_timeout)) {
378 dum->port_status[rhport] |=
379 (1 << USB_PORT_FEAT_C_RESET);
380 dum->port_status[rhport] &=
381 ~(1 << USB_PORT_FEAT_RESET);
384 if (dum->vdev[rhport].ud.status ==
385 VDEV_ST_NOTASSIGNED) {
386 usbip_dbg_vhci_rh(" enable rhport %d "
389 dum->vdev[rhport].ud.status);
390 dum->port_status[rhport] |=
391 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;
419 ((u16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
421 cpu_to_le16(dum->port_status[rhport] >> 16);
423 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
427 usbip_dbg_vhci_rh(" SetHubFeature\n");
432 case USB_PORT_FEAT_SUSPEND:
433 usbip_dbg_vhci_rh(" SetPortFeature: "
434 "USB_PORT_FEAT_SUSPEND\n");
435 printk(KERN_ERR "%s: not yet\n", __func__);
437 dum->port_status[rhport] |=
438 (1 << USB_PORT_FEAT_SUSPEND);
439 if (dum->driver->suspend) {
440 spin_unlock(&dum->lock);
441 dum->driver->suspend(&dum->gadget);
442 spin_lock(&dum->lock);
446 case USB_PORT_FEAT_RESET:
447 usbip_dbg_vhci_rh(" SetPortFeature: "
448 "USB_PORT_FEAT_RESET\n");
449 /* if it's already running, disconnect first */
450 if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
451 dum->port_status[rhport] &=
452 ~(USB_PORT_STAT_ENABLE |
453 USB_PORT_STAT_LOW_SPEED |
454 USB_PORT_STAT_HIGH_SPEED);
457 dev_dbg(hardware, "disconnect\n");
458 stop_activity(dum, dum->driver);
462 /* FIXME test that code path! */
464 /* 50msec reset signaling */
465 dum->re_timeout = jiffies + msecs_to_jiffies(50);
469 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
471 dum->port_status[rhport] |= (1 << wValue);
476 printk(KERN_ERR "%s: default: no such request\n", __func__);
477 /* dev_dbg (hardware,
478 * "hub control req%04x v%04x i%04x l%d\n",
479 * typeReq, wValue, wIndex, wLength); */
481 /* "protocol stall" on error */
485 if (usbip_dbg_flag_vhci_rh) {
486 printk(KERN_DEBUG "port %d\n", rhport);
487 dump_port_status(prev_port_status[rhport]);
488 dump_port_status(dum->port_status[rhport]);
490 usbip_dbg_vhci_rh(" bye\n");
492 spin_unlock_irqrestore(&dum->lock, flags);
499 /*----------------------------------------------------------------------*/
501 static struct vhci_device *get_vdev(struct usb_device *udev)
508 for (i = 0; i < VHCI_NPORTS; i++)
509 if (the_controller->vdev[i].udev == udev)
510 return port_to_vdev(i);
515 static void vhci_tx_urb(struct urb *urb)
517 struct vhci_device *vdev = get_vdev(urb->dev);
518 struct vhci_priv *priv;
522 err("could not get virtual device");
527 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
529 spin_lock_irqsave(&vdev->priv_lock, flag);
532 dev_err(&urb->dev->dev, "malloc vhci_priv\n");
533 spin_unlock_irqrestore(&vdev->priv_lock, flag);
534 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
538 priv->seqnum = atomic_inc_return(&the_controller->seqnum);
539 if (priv->seqnum == 0xffff)
540 usbip_uinfo("seqnum max\n");
545 urb->hcpriv = (void *) priv;
548 list_add_tail(&priv->list, &vdev->priv_tx);
550 wake_up(&vdev->waitq_tx);
551 spin_unlock_irqrestore(&vdev->priv_lock, flag);
554 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
557 struct device *dev = &urb->dev->dev;
560 struct vhci_device *vdev;
562 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
563 hcd, urb, mem_flags);
565 /* patch to usb_sg_init() is in 2.5.60 */
566 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
568 spin_lock_irqsave(&the_controller->lock, flags);
570 if (urb->status != -EINPROGRESS) {
571 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
572 spin_unlock_irqrestore(&the_controller->lock, flags);
576 vdev = port_to_vdev(urb->dev->portnum-1);
578 /* refuse enqueue for dead connection */
579 spin_lock(&vdev->ud.lock);
580 if (vdev->ud.status == VDEV_ST_NULL || vdev->ud.status == VDEV_ST_ERROR) {
581 usbip_uerr("enqueue for inactive port %d\n", vdev->rhport);
582 spin_unlock(&vdev->ud.lock);
583 spin_unlock_irqrestore(&the_controller->lock, flags);
586 spin_unlock(&vdev->ud.lock);
588 ret = usb_hcd_link_urb_to_ep(hcd, urb);
593 * The enumeration process is as follows;
595 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
596 * to get max packet length of default pipe
598 * 2. Set_Address request to DevAddr(0) EndPoint(0)
602 if (usb_pipedevice(urb->pipe) == 0) {
603 __u8 type = usb_pipetype(urb->pipe);
604 struct usb_ctrlrequest *ctrlreq =
605 (struct usb_ctrlrequest *) urb->setup_packet;
607 if (type != PIPE_CONTROL || !ctrlreq) {
608 dev_err(dev, "invalid request to devnum 0\n");
613 switch (ctrlreq->bRequest) {
614 case USB_REQ_SET_ADDRESS:
615 /* set_address may come when a device is reset */
616 dev_info(dev, "SetAddress Request (%d) to port %d\n",
617 ctrlreq->wValue, vdev->rhport);
620 usb_put_dev(vdev->udev);
621 vdev->udev = usb_get_dev(urb->dev);
623 spin_lock(&vdev->ud.lock);
624 vdev->ud.status = VDEV_ST_USED;
625 spin_unlock(&vdev->ud.lock);
627 if (urb->status == -EINPROGRESS) {
628 /* This request is successfully completed. */
629 /* If not -EINPROGRESS, possibly unlinked. */
635 case USB_REQ_GET_DESCRIPTOR:
636 if (ctrlreq->wValue == (USB_DT_DEVICE << 8))
637 usbip_dbg_vhci_hc("Not yet?: "
638 "Get_Descriptor to device 0 "
639 "(get max pipe size)\n");
642 usb_put_dev(vdev->udev);
643 vdev->udev = usb_get_dev(urb->dev);
648 dev_err(dev, "invalid request to devnum 0 bRequest %u, "
649 "wValue %u\n", ctrlreq->bRequest,
660 spin_unlock_irqrestore(&the_controller->lock, flags);
665 usb_hcd_unlink_urb_from_ep(hcd, urb);
667 spin_unlock_irqrestore(&the_controller->lock, flags);
669 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb, urb->status);
675 * vhci_rx gives back the urb after receiving the reply of the urb. If an
676 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
677 * back its urb. For the driver unlinking the urb, the content of the urb is
678 * not important, but the calling to its completion handler is important; the
679 * completion of unlinking is notified by the completion handler.
684 * - When vhci_hcd receives RET_SUBMIT,
686 * - case 1a). the urb of the pdu is not unlinking.
688 * => just give back the urb
690 * - case 1b). the urb of the pdu is unlinking.
691 * - usbip.ko will return a reply of the unlinking request.
692 * => give back the urb now and go to case 2b).
694 * - When vhci_hcd receives RET_UNLINK,
696 * - case 2a). a submit request is still pending in vhci_hcd.
697 * - urb was really pending in usbip.ko and urb_unlink_urb() was
699 * => free a pending submit request
700 * => notify unlink completeness by giving back the urb
702 * - case 2b). a submit request is *not* pending in vhci_hcd.
703 * - urb was already given back to the core driver.
704 * => do not give back the urb
709 * - When usbip receives CMD_UNLINK,
711 * - case 3a). the urb of the unlink request is now in submission.
712 * => do usb_unlink_urb().
713 * => after the unlink is completed, send RET_UNLINK.
715 * - case 3b). the urb of the unlink request is not in submission.
716 * - may be already completed or never be received
720 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
723 struct vhci_priv *priv;
724 struct vhci_device *vdev;
726 usbip_uinfo("vhci_hcd: dequeue a urb %p\n", urb);
729 spin_lock_irqsave(&the_controller->lock, flags);
733 /* URB was never linked! or will be soon given back by
735 spin_unlock_irqrestore(&the_controller->lock, flags);
741 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
743 spin_unlock_irqrestore(&the_controller->lock, flags);
748 /* send unlink request here? */
751 if (!vdev->ud.tcp_socket) {
752 /* tcp connection is closed */
753 unsigned long flags2;
755 spin_lock_irqsave(&vdev->priv_lock, flags2);
757 usbip_uinfo("vhci_hcd: device %p seems to be disconnected\n",
759 list_del(&priv->list);
763 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
766 * If tcp connection is alive, we have sent CMD_UNLINK.
767 * vhci_rx will receive RET_UNLINK and give back the URB.
768 * Otherwise, we give back it here.
770 usbip_uinfo("vhci_hcd: vhci_urb_dequeue() gives back urb %p\n",
773 usb_hcd_unlink_urb_from_ep(hcd, urb);
775 spin_unlock_irqrestore(&the_controller->lock, flags);
776 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
778 spin_lock_irqsave(&the_controller->lock, flags);
781 /* tcp connection is alive */
782 unsigned long flags2;
783 struct vhci_unlink *unlink;
785 spin_lock_irqsave(&vdev->priv_lock, flags2);
787 /* setup CMD_UNLINK pdu */
788 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
790 usbip_uerr("malloc vhci_unlink\n");
791 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
792 spin_unlock_irqrestore(&the_controller->lock, flags);
793 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
797 unlink->seqnum = atomic_inc_return(&the_controller->seqnum);
798 if (unlink->seqnum == 0xffff)
799 usbip_uinfo("seqnum max\n");
801 unlink->unlink_seqnum = priv->seqnum;
803 usbip_uinfo("vhci_hcd: device %p seems to be still connected\n",
806 /* send cmd_unlink and try to cancel the pending URB in the
808 list_add_tail(&unlink->list, &vdev->unlink_tx);
809 wake_up(&vdev->waitq_tx);
811 spin_unlock_irqrestore(&vdev->priv_lock, flags2);
814 spin_unlock_irqrestore(&the_controller->lock, flags);
816 usbip_dbg_vhci_hc("leave\n");
820 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
822 struct vhci_unlink *unlink, *tmp;
824 spin_lock(&vdev->priv_lock);
826 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
827 usbip_uinfo("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
828 list_del(&unlink->list);
832 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_rx, list) {
835 /* give back URB of unanswered unlink request */
836 usbip_uinfo("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
838 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
840 usbip_uinfo("the urb (seqnum %lu) was already given back\n",
841 unlink->unlink_seqnum);
842 list_del(&unlink->list);
847 urb->status = -ENODEV;
849 spin_lock(&the_controller->lock);
850 usb_hcd_unlink_urb_from_ep(vhci_to_hcd(the_controller), urb);
851 spin_unlock(&the_controller->lock);
853 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb, urb->status);
855 list_del(&unlink->list);
859 spin_unlock(&vdev->priv_lock);
863 * The important thing is that only one context begins cleanup.
864 * This is why error handling and cleanup become simple.
865 * We do not want to consider race condition as possible.
867 static void vhci_shutdown_connection(struct usbip_device *ud)
869 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
871 /* need this? see stub_dev.c */
872 if (ud->tcp_socket) {
873 usbip_udbg("shutdown tcp_socket %p\n", ud->tcp_socket);
874 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
877 usbip_stop_threads(&vdev->ud);
878 usbip_uinfo("stop threads\n");
880 /* active connection is closed */
881 if (vdev->ud.tcp_socket != NULL) {
882 sock_release(vdev->ud.tcp_socket);
883 vdev->ud.tcp_socket = NULL;
885 usbip_uinfo("release socket\n");
887 vhci_device_unlink_cleanup(vdev);
890 * rh_port_disconnect() is a trigger of ...
891 * usb_disable_device():
892 * disable all the endpoints for a USB device.
893 * usb_disable_endpoint():
894 * disable endpoints. pending urbs are unlinked(dequeued).
896 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
897 * deteched device should release used urbs in a cleanup function(i.e.
898 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
899 * pushed urbs and their private data in this function.
901 * NOTE: vhci_dequeue() must be considered carefully. When shutdowning
902 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
903 * gives back pushed urbs and frees their private data by request of
904 * the cleanup function of a USB driver. When unlinking a urb with an
905 * active connection, vhci_dequeue() does not give back the urb which
906 * is actually given back by vhci_rx after receiving its return pdu.
909 rh_port_disconnect(vdev->rhport);
911 usbip_uinfo("disconnect device\n");
915 static void vhci_device_reset(struct usbip_device *ud)
917 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
919 spin_lock(&ud->lock);
925 usb_put_dev(vdev->udev);
928 ud->tcp_socket = NULL;
930 ud->status = VDEV_ST_NULL;
932 spin_unlock(&ud->lock);
935 static void vhci_device_unusable(struct usbip_device *ud)
937 spin_lock(&ud->lock);
939 ud->status = VDEV_ST_ERROR;
941 spin_unlock(&ud->lock);
944 static void vhci_device_init(struct vhci_device *vdev)
946 memset(vdev, 0, sizeof(*vdev));
948 usbip_task_init(&vdev->ud.tcp_rx, "vhci_rx", vhci_rx_loop);
949 usbip_task_init(&vdev->ud.tcp_tx, "vhci_tx", vhci_tx_loop);
951 vdev->ud.side = USBIP_VHCI;
952 vdev->ud.status = VDEV_ST_NULL;
953 /* vdev->ud.lock = SPIN_LOCK_UNLOCKED; */
954 spin_lock_init(&vdev->ud.lock);
956 INIT_LIST_HEAD(&vdev->priv_rx);
957 INIT_LIST_HEAD(&vdev->priv_tx);
958 INIT_LIST_HEAD(&vdev->unlink_tx);
959 INIT_LIST_HEAD(&vdev->unlink_rx);
960 /* vdev->priv_lock = SPIN_LOCK_UNLOCKED; */
961 spin_lock_init(&vdev->priv_lock);
963 init_waitqueue_head(&vdev->waitq_tx);
965 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
966 vdev->ud.eh_ops.reset = vhci_device_reset;
967 vdev->ud.eh_ops.unusable = vhci_device_unusable;
969 usbip_start_eh(&vdev->ud);
973 /*----------------------------------------------------------------------*/
975 static int vhci_start(struct usb_hcd *hcd)
977 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
981 usbip_dbg_vhci_hc("enter vhci_start\n");
984 /* initialize private data of usb_hcd */
986 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
987 struct vhci_device *vdev = &vhci->vdev[rhport];
988 vhci_device_init(vdev);
989 vdev->rhport = rhport;
992 atomic_set(&vhci->seqnum, 0);
993 spin_lock_init(&vhci->lock);
997 hcd->power_budget = 0; /* no limit */
998 hcd->state = HC_STATE_RUNNING;
999 hcd->uses_new_polling = 1;
1002 /* vhci_hcd is now ready to be controlled through sysfs */
1003 err = sysfs_create_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
1005 usbip_uerr("create sysfs files\n");
1012 static void vhci_stop(struct usb_hcd *hcd)
1014 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1017 usbip_dbg_vhci_hc("stop VHCI controller\n");
1020 /* 1. remove the userland interface of vhci_hcd */
1021 sysfs_remove_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
1023 /* 2. shutdown all the ports of vhci_hcd */
1024 for (rhport = 0 ; rhport < VHCI_NPORTS; rhport++) {
1025 struct vhci_device *vdev = &vhci->vdev[rhport];
1027 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1028 usbip_stop_eh(&vdev->ud);
1032 usbip_uinfo("vhci_stop done\n");
1035 /*----------------------------------------------------------------------*/
1037 static int vhci_get_frame_number(struct usb_hcd *hcd)
1039 usbip_uerr("Not yet implemented\n");
1046 /* FIXME: suspend/resume */
1047 static int vhci_bus_suspend(struct usb_hcd *hcd)
1049 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1051 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1053 spin_lock_irq(&vhci->lock);
1054 /* vhci->rh_state = DUMMY_RH_SUSPENDED;
1055 * set_link_state(vhci); */
1056 hcd->state = HC_STATE_SUSPENDED;
1057 spin_unlock_irq(&vhci->lock);
1062 static int vhci_bus_resume(struct usb_hcd *hcd)
1064 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1067 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1069 spin_lock_irq(&vhci->lock);
1070 if (!HCD_HW_ACCESSIBLE(hcd)) {
1073 /* vhci->rh_state = DUMMY_RH_RUNNING;
1074 * set_link_state(vhci);
1075 * if (!list_empty(&vhci->urbp_list))
1076 * mod_timer(&vhci->timer, jiffies); */
1077 hcd->state = HC_STATE_RUNNING;
1079 spin_unlock_irq(&vhci->lock);
1087 #define vhci_bus_suspend NULL
1088 #define vhci_bus_resume NULL
1093 static struct hc_driver vhci_hc_driver = {
1094 .description = driver_name,
1095 .product_desc = driver_desc,
1096 .hcd_priv_size = sizeof(struct vhci_hcd),
1100 .start = vhci_start,
1103 .urb_enqueue = vhci_urb_enqueue,
1104 .urb_dequeue = vhci_urb_dequeue,
1106 .get_frame_number = vhci_get_frame_number,
1108 .hub_status_data = vhci_hub_status,
1109 .hub_control = vhci_hub_control,
1110 .bus_suspend = vhci_bus_suspend,
1111 .bus_resume = vhci_bus_resume,
1114 static int vhci_hcd_probe(struct platform_device *pdev)
1116 struct usb_hcd *hcd;
1119 usbip_uinfo("proving...\n");
1121 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1123 /* will be removed */
1124 if (pdev->dev.dma_mask) {
1125 dev_info(&pdev->dev, "vhci_hcd DMA not supported\n");
1130 * Allocate and initialize hcd.
1131 * Our private data is also allocated automatically.
1133 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1135 usbip_uerr("create hcd failed\n");
1140 /* this is private data for vhci_hcd */
1141 the_controller = hcd_to_vhci(hcd);
1144 * Finish generic HCD structure initialization and register.
1145 * Call the driver's reset() and start() routines.
1147 ret = usb_add_hcd(hcd, 0, 0);
1149 usbip_uerr("usb_add_hcd failed %d\n", ret);
1151 the_controller = NULL;
1156 usbip_dbg_vhci_hc("bye\n");
1161 static int vhci_hcd_remove(struct platform_device *pdev)
1163 struct usb_hcd *hcd;
1165 hcd = platform_get_drvdata(pdev);
1170 * Disconnects the root hub,
1171 * then reverses the effects of usb_add_hcd(),
1172 * invoking the HCD's stop() methods.
1174 usb_remove_hcd(hcd);
1176 the_controller = NULL;
1186 /* what should happen for USB/IP under suspend/resume? */
1187 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1189 struct usb_hcd *hcd;
1194 dev_dbg(&pdev->dev, "%s\n", __func__);
1196 hcd = platform_get_drvdata(pdev);
1198 spin_lock(&the_controller->lock);
1200 for (rhport = 0; rhport < VHCI_NPORTS; rhport++)
1201 if (the_controller->port_status[rhport] &
1202 USB_PORT_STAT_CONNECTION)
1205 spin_unlock(&the_controller->lock);
1207 if (connected > 0) {
1208 usbip_uinfo("We have %d active connection%s. Do not suspend.\n",
1209 connected, (connected == 1 ? "" : "s"));
1212 usbip_uinfo("suspend vhci_hcd");
1213 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1219 static int vhci_hcd_resume(struct platform_device *pdev)
1221 struct usb_hcd *hcd;
1223 dev_dbg(&pdev->dev, "%s\n", __func__);
1225 hcd = platform_get_drvdata(pdev);
1226 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1227 usb_hcd_poll_rh_status(hcd);
1234 #define vhci_hcd_suspend NULL
1235 #define vhci_hcd_resume NULL
1240 static struct platform_driver vhci_driver = {
1241 .probe = vhci_hcd_probe,
1242 .remove = __devexit_p(vhci_hcd_remove),
1243 .suspend = vhci_hcd_suspend,
1244 .resume = vhci_hcd_resume,
1246 .name = (char *) driver_name,
1247 .owner = THIS_MODULE,
1251 /*----------------------------------------------------------------------*/
1254 * The VHCI 'device' is 'virtual'; not a real plug&play hardware.
1255 * We need to add this virtual device as a platform device arbitrarily:
1256 * 1. platform_device_register()
1258 static void the_pdev_release(struct device *dev)
1263 static struct platform_device the_pdev = {
1264 /* should be the same name as driver_name */
1265 .name = (char *) driver_name,
1268 /* .driver = &vhci_driver, */
1269 .release = the_pdev_release,
1273 static int __init vhci_init(void)
1277 usbip_dbg_vhci_hc("enter\n");
1281 printk(KERN_INFO KBUILD_MODNAME ": %s, %s\n", driver_name,
1284 ret = platform_driver_register(&vhci_driver);
1286 goto err_driver_register;
1288 ret = platform_device_register(&the_pdev);
1290 goto err_platform_device_register;
1292 usbip_dbg_vhci_hc("bye\n");
1295 /* error occurred */
1296 err_platform_device_register:
1297 platform_driver_unregister(&vhci_driver);
1299 err_driver_register:
1300 usbip_dbg_vhci_hc("bye\n");
1303 module_init(vhci_init);
1305 static void __exit vhci_cleanup(void)
1307 usbip_dbg_vhci_hc("enter\n");
1309 platform_device_unregister(&the_pdev);
1310 platform_driver_unregister(&vhci_driver);
1312 usbip_dbg_vhci_hc("bye\n");
1314 module_exit(vhci_cleanup);