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/file.h>
22 #include <linux/kernel.h>
23 #include <linux/kthread.h>
24 #include <linux/module.h>
25 #include <linux/platform_device.h>
26 #include <linux/slab.h>
28 #include "usbip_common.h"
31 #define DRIVER_AUTHOR "Takahiro Hirofuchi"
32 #define DRIVER_DESC "USB/IP 'Virtual' Host Controller (VHCI) Driver"
36 * - update root hub emulation
37 * - move the emulation code to userland ?
38 * porting to other operating systems
39 * minimize kernel code
40 * - add suspend/resume code
41 * - clean up everything
44 /* See usb gadget dummy hcd */
46 static int vhci_hub_status(struct usb_hcd *hcd, char *buff);
47 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
48 u16 wIndex, char *buff, u16 wLength);
49 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
51 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
52 static int vhci_start(struct usb_hcd *vhci_hcd);
53 static void vhci_stop(struct usb_hcd *hcd);
54 static int vhci_get_frame_number(struct usb_hcd *hcd);
56 static const char driver_name[] = "vhci_hcd";
57 static const char driver_desc[] = "USB/IP Virtual Host Controller";
59 struct vhci_hcd *the_controller;
61 static const char * const bit_desc[] = {
78 "C_CONNECTION", /*16*/
81 "C_OVER_CURRENT", /*19*/
96 static void dump_port_status_diff(u32 prev_status, u32 new_status)
101 pr_debug("status prev -> new: %08x -> %08x\n", prev_status, new_status);
103 u32 prev = prev_status & bit;
104 u32 new = new_status & bit;
109 else if (prev && !new)
115 pr_debug(" %c%s\n", change, bit_desc[i]);
122 void rh_port_connect(int rhport, enum usb_device_speed speed)
124 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
126 spin_lock(&the_controller->lock);
128 the_controller->port_status[rhport] |= USB_PORT_STAT_CONNECTION
129 | (1 << USB_PORT_FEAT_C_CONNECTION);
133 the_controller->port_status[rhport] |= USB_PORT_STAT_HIGH_SPEED;
136 the_controller->port_status[rhport] |= USB_PORT_STAT_LOW_SPEED;
142 spin_unlock(&the_controller->lock);
144 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
147 static void rh_port_disconnect(int rhport)
149 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
151 spin_lock(&the_controller->lock);
153 the_controller->port_status[rhport] &= ~USB_PORT_STAT_CONNECTION;
154 the_controller->port_status[rhport] |=
155 (1 << USB_PORT_FEAT_C_CONNECTION);
157 spin_unlock(&the_controller->lock);
158 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
161 #define PORT_C_MASK \
162 ((USB_PORT_STAT_C_CONNECTION \
163 | USB_PORT_STAT_C_ENABLE \
164 | USB_PORT_STAT_C_SUSPEND \
165 | USB_PORT_STAT_C_OVERCURRENT \
166 | USB_PORT_STAT_C_RESET) << 16)
169 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
170 * Ports are 0-indexed from the HCD point of view,
171 * and 1-indexed from the USB core pointer of view.
173 * @buf: a bitmap to show which port status has been changed.
175 * bit 1: the status of port 0 has been changed.
176 * bit 2: the status of port 1 has been changed.
179 static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
181 struct vhci_hcd *vhci;
186 retval = DIV_ROUND_UP(VHCI_NPORTS + 1, 8);
187 memset(buf, 0, retval);
189 vhci = hcd_to_vhci(hcd);
191 spin_lock(&vhci->lock);
192 if (!HCD_HW_ACCESSIBLE(hcd)) {
193 usbip_dbg_vhci_rh("hw accessible flag not on?\n");
197 /* check pseudo status register for each port */
198 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
199 if ((vhci->port_status[rhport] & PORT_C_MASK)) {
200 /* The status of a port has been changed, */
201 usbip_dbg_vhci_rh("port %d status changed\n", rhport);
203 buf[(rhport + 1) / 8] |= 1 << (rhport + 1) % 8;
208 if ((hcd->state == HC_STATE_SUSPENDED) && (changed == 1))
209 usb_hcd_resume_root_hub(hcd);
212 spin_unlock(&vhci->lock);
213 return changed ? retval : 0;
216 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
218 memset(desc, 0, sizeof(*desc));
219 desc->bDescriptorType = 0x29;
220 desc->bDescLength = 9;
221 desc->wHubCharacteristics = (__constant_cpu_to_le16(0x0001));
222 desc->bNbrPorts = VHCI_NPORTS;
223 desc->u.hs.DeviceRemovable[0] = 0xff;
224 desc->u.hs.DeviceRemovable[1] = 0xff;
227 static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
228 u16 wIndex, char *buf, u16 wLength)
230 struct vhci_hcd *dum;
234 u32 prev_port_status[VHCI_NPORTS];
236 if (!HCD_HW_ACCESSIBLE(hcd))
241 * wIndex shows the port number and begins from 1.
243 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
245 if (wIndex > VHCI_NPORTS)
246 pr_err("invalid port number %d\n", wIndex);
247 rhport = ((__u8)(wIndex & 0x00ff)) - 1;
249 dum = hcd_to_vhci(hcd);
251 spin_lock(&dum->lock);
253 /* store old status and compare now and old later */
254 if (usbip_dbg_flag_vhci_rh) {
255 memcpy(prev_port_status, dum->port_status,
256 sizeof(prev_port_status));
260 case ClearHubFeature:
261 usbip_dbg_vhci_rh(" ClearHubFeature\n");
263 case ClearPortFeature:
265 case USB_PORT_FEAT_SUSPEND:
266 if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
267 /* 20msec signaling */
270 jiffies + msecs_to_jiffies(20);
273 case USB_PORT_FEAT_POWER:
275 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
276 dum->port_status[rhport] = 0;
279 case USB_PORT_FEAT_C_RESET:
281 " ClearPortFeature: USB_PORT_FEAT_C_RESET\n");
282 switch (dum->vdev[rhport].speed) {
284 dum->port_status[rhport] |=
285 USB_PORT_STAT_HIGH_SPEED;
288 dum->port_status[rhport] |=
289 USB_PORT_STAT_LOW_SPEED;
295 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
297 dum->port_status[rhport] &= ~(1 << wValue);
301 case GetHubDescriptor:
302 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
303 hub_descriptor((struct usb_hub_descriptor *) buf);
306 usbip_dbg_vhci_rh(" GetHubStatus\n");
307 *(__le32 *) buf = cpu_to_le32(0);
310 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
311 if (wIndex > VHCI_NPORTS || wIndex < 1) {
312 pr_err("invalid port number %d\n", wIndex);
316 /* we do not care about resume. */
318 /* whoever resets or resumes must GetPortStatus to
321 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
322 dum->port_status[rhport] |=
323 (1 << USB_PORT_FEAT_C_SUSPEND);
324 dum->port_status[rhport] &=
325 ~(1 << USB_PORT_FEAT_SUSPEND);
330 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
331 0 && time_after(jiffies, dum->re_timeout)) {
332 dum->port_status[rhport] |=
333 (1 << USB_PORT_FEAT_C_RESET);
334 dum->port_status[rhport] &=
335 ~(1 << USB_PORT_FEAT_RESET);
338 if (dum->vdev[rhport].ud.status ==
339 VDEV_ST_NOTASSIGNED) {
341 " enable rhport %d (status %u)\n",
343 dum->vdev[rhport].ud.status);
344 dum->port_status[rhport] |=
345 USB_PORT_STAT_ENABLE;
348 ((__le16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
349 ((__le16 *) buf)[1] =
350 cpu_to_le16(dum->port_status[rhport] >> 16);
352 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
356 usbip_dbg_vhci_rh(" SetHubFeature\n");
361 case USB_PORT_FEAT_SUSPEND:
363 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
365 case USB_PORT_FEAT_RESET:
367 " SetPortFeature: USB_PORT_FEAT_RESET\n");
368 /* if it's already running, disconnect first */
369 if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
370 dum->port_status[rhport] &=
371 ~(USB_PORT_STAT_ENABLE |
372 USB_PORT_STAT_LOW_SPEED |
373 USB_PORT_STAT_HIGH_SPEED);
374 /* FIXME test that code path! */
376 /* 50msec reset signaling */
377 dum->re_timeout = jiffies + msecs_to_jiffies(50);
381 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
383 dum->port_status[rhport] |= (1 << wValue);
389 pr_err("default: no such request\n");
391 /* "protocol stall" on error */
395 if (usbip_dbg_flag_vhci_rh) {
396 pr_debug("port %d\n", rhport);
397 /* Only dump valid port status */
399 dump_port_status_diff(prev_port_status[rhport],
400 dum->port_status[rhport]);
403 usbip_dbg_vhci_rh(" bye\n");
405 spin_unlock(&dum->lock);
410 static struct vhci_device *get_vdev(struct usb_device *udev)
417 for (i = 0; i < VHCI_NPORTS; i++)
418 if (the_controller->vdev[i].udev == udev)
419 return port_to_vdev(i);
424 static void vhci_tx_urb(struct urb *urb)
426 struct vhci_device *vdev = get_vdev(urb->dev);
427 struct vhci_priv *priv;
430 pr_err("could not get virtual device");
434 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
436 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
440 spin_lock(&vdev->priv_lock);
442 priv->seqnum = atomic_inc_return(&the_controller->seqnum);
443 if (priv->seqnum == 0xffff)
444 dev_info(&urb->dev->dev, "seqnum max\n");
449 urb->hcpriv = (void *) priv;
451 list_add_tail(&priv->list, &vdev->priv_tx);
453 wake_up(&vdev->waitq_tx);
454 spin_unlock(&vdev->priv_lock);
457 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
460 struct device *dev = &urb->dev->dev;
462 struct vhci_device *vdev;
464 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
465 hcd, urb, mem_flags);
467 /* patch to usb_sg_init() is in 2.5.60 */
468 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
470 spin_lock(&the_controller->lock);
472 if (urb->status != -EINPROGRESS) {
473 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
474 spin_unlock(&the_controller->lock);
478 vdev = port_to_vdev(urb->dev->portnum-1);
480 /* refuse enqueue for dead connection */
481 spin_lock(&vdev->ud.lock);
482 if (vdev->ud.status == VDEV_ST_NULL ||
483 vdev->ud.status == VDEV_ST_ERROR) {
484 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
485 spin_unlock(&vdev->ud.lock);
486 spin_unlock(&the_controller->lock);
489 spin_unlock(&vdev->ud.lock);
491 ret = usb_hcd_link_urb_to_ep(hcd, urb);
496 * The enumeration process is as follows;
498 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
499 * to get max packet length of default pipe
501 * 2. Set_Address request to DevAddr(0) EndPoint(0)
504 if (usb_pipedevice(urb->pipe) == 0) {
505 __u8 type = usb_pipetype(urb->pipe);
506 struct usb_ctrlrequest *ctrlreq =
507 (struct usb_ctrlrequest *) urb->setup_packet;
509 if (type != PIPE_CONTROL || !ctrlreq) {
510 dev_err(dev, "invalid request to devnum 0\n");
515 switch (ctrlreq->bRequest) {
516 case USB_REQ_SET_ADDRESS:
517 /* set_address may come when a device is reset */
518 dev_info(dev, "SetAddress Request (%d) to port %d\n",
519 ctrlreq->wValue, vdev->rhport);
521 usb_put_dev(vdev->udev);
522 vdev->udev = usb_get_dev(urb->dev);
524 spin_lock(&vdev->ud.lock);
525 vdev->ud.status = VDEV_ST_USED;
526 spin_unlock(&vdev->ud.lock);
528 if (urb->status == -EINPROGRESS) {
529 /* This request is successfully completed. */
530 /* If not -EINPROGRESS, possibly unlinked. */
536 case USB_REQ_GET_DESCRIPTOR:
537 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
539 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
541 usb_put_dev(vdev->udev);
542 vdev->udev = usb_get_dev(urb->dev);
548 "invalid request to devnum 0 bRequest %u, wValue %u\n",
559 spin_unlock(&the_controller->lock);
564 usb_hcd_unlink_urb_from_ep(hcd, urb);
566 spin_unlock(&the_controller->lock);
567 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb, urb->status);
572 * vhci_rx gives back the urb after receiving the reply of the urb. If an
573 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
574 * back its urb. For the driver unlinking the urb, the content of the urb is
575 * not important, but the calling to its completion handler is important; the
576 * completion of unlinking is notified by the completion handler.
581 * - When vhci_hcd receives RET_SUBMIT,
583 * - case 1a). the urb of the pdu is not unlinking.
585 * => just give back the urb
587 * - case 1b). the urb of the pdu is unlinking.
588 * - usbip.ko will return a reply of the unlinking request.
589 * => give back the urb now and go to case 2b).
591 * - When vhci_hcd receives RET_UNLINK,
593 * - case 2a). a submit request is still pending in vhci_hcd.
594 * - urb was really pending in usbip.ko and urb_unlink_urb() was
596 * => free a pending submit request
597 * => notify unlink completeness by giving back the urb
599 * - case 2b). a submit request is *not* pending in vhci_hcd.
600 * - urb was already given back to the core driver.
601 * => do not give back the urb
606 * - When usbip receives CMD_UNLINK,
608 * - case 3a). the urb of the unlink request is now in submission.
609 * => do usb_unlink_urb().
610 * => after the unlink is completed, send RET_UNLINK.
612 * - case 3b). the urb of the unlink request is not in submission.
613 * - may be already completed or never be received
617 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
619 struct vhci_priv *priv;
620 struct vhci_device *vdev;
622 pr_info("dequeue a urb %p\n", urb);
624 spin_lock(&the_controller->lock);
628 /* URB was never linked! or will be soon given back by
630 spin_unlock(&the_controller->lock);
637 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
639 spin_unlock(&the_controller->lock);
644 /* send unlink request here? */
647 if (!vdev->ud.tcp_socket) {
648 /* tcp connection is closed */
649 spin_lock(&vdev->priv_lock);
651 pr_info("device %p seems to be disconnected\n", vdev);
652 list_del(&priv->list);
656 spin_unlock(&vdev->priv_lock);
659 * If tcp connection is alive, we have sent CMD_UNLINK.
660 * vhci_rx will receive RET_UNLINK and give back the URB.
661 * Otherwise, we give back it here.
663 pr_info("gives back urb %p\n", urb);
665 usb_hcd_unlink_urb_from_ep(hcd, urb);
667 spin_unlock(&the_controller->lock);
668 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
670 spin_lock(&the_controller->lock);
673 /* tcp connection is alive */
674 struct vhci_unlink *unlink;
676 spin_lock(&vdev->priv_lock);
678 /* setup CMD_UNLINK pdu */
679 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
681 spin_unlock(&vdev->priv_lock);
682 spin_unlock(&the_controller->lock);
683 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
687 unlink->seqnum = atomic_inc_return(&the_controller->seqnum);
688 if (unlink->seqnum == 0xffff)
689 pr_info("seqnum max\n");
691 unlink->unlink_seqnum = priv->seqnum;
693 pr_info("device %p seems to be still connected\n", vdev);
695 /* send cmd_unlink and try to cancel the pending URB in the
697 list_add_tail(&unlink->list, &vdev->unlink_tx);
698 wake_up(&vdev->waitq_tx);
700 spin_unlock(&vdev->priv_lock);
703 spin_unlock(&the_controller->lock);
705 usbip_dbg_vhci_hc("leave\n");
709 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
711 struct vhci_unlink *unlink, *tmp;
713 spin_lock(&the_controller->lock);
714 spin_lock(&vdev->priv_lock);
716 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
717 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
718 list_del(&unlink->list);
722 while (!list_empty(&vdev->unlink_rx)) {
725 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
728 /* give back URB of unanswered unlink request */
729 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
731 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
733 pr_info("the urb (seqnum %lu) was already given back\n",
734 unlink->unlink_seqnum);
735 list_del(&unlink->list);
740 urb->status = -ENODEV;
742 usb_hcd_unlink_urb_from_ep(vhci_to_hcd(the_controller), urb);
744 list_del(&unlink->list);
746 spin_unlock(&vdev->priv_lock);
747 spin_unlock(&the_controller->lock);
749 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
752 spin_lock(&the_controller->lock);
753 spin_lock(&vdev->priv_lock);
758 spin_unlock(&vdev->priv_lock);
759 spin_unlock(&the_controller->lock);
763 * The important thing is that only one context begins cleanup.
764 * This is why error handling and cleanup become simple.
765 * We do not want to consider race condition as possible.
767 static void vhci_shutdown_connection(struct usbip_device *ud)
769 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
771 /* need this? see stub_dev.c */
772 if (ud->tcp_socket) {
773 pr_debug("shutdown tcp_socket %p\n", ud->tcp_socket);
774 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
777 /* kill threads related to this sdev */
778 if (vdev->ud.tcp_rx) {
779 kthread_stop_put(vdev->ud.tcp_rx);
780 vdev->ud.tcp_rx = NULL;
782 if (vdev->ud.tcp_tx) {
783 kthread_stop_put(vdev->ud.tcp_tx);
784 vdev->ud.tcp_tx = NULL;
786 pr_info("stop threads\n");
788 /* active connection is closed */
789 if (vdev->ud.tcp_socket) {
790 sockfd_put(vdev->ud.tcp_socket);
791 vdev->ud.tcp_socket = NULL;
793 pr_info("release socket\n");
795 vhci_device_unlink_cleanup(vdev);
798 * rh_port_disconnect() is a trigger of ...
799 * usb_disable_device():
800 * disable all the endpoints for a USB device.
801 * usb_disable_endpoint():
802 * disable endpoints. pending urbs are unlinked(dequeued).
804 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
805 * detached device should release used urbs in a cleanup function (i.e.
806 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
807 * pushed urbs and their private data in this function.
809 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
810 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
811 * gives back pushed urbs and frees their private data by request of
812 * the cleanup function of a USB driver. When unlinking a urb with an
813 * active connection, vhci_dequeue() does not give back the urb which
814 * is actually given back by vhci_rx after receiving its return pdu.
817 rh_port_disconnect(vdev->rhport);
819 pr_info("disconnect device\n");
823 static void vhci_device_reset(struct usbip_device *ud)
825 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
827 spin_lock(&ud->lock);
832 usb_put_dev(vdev->udev);
835 if (ud->tcp_socket) {
836 sockfd_put(ud->tcp_socket);
837 ud->tcp_socket = NULL;
839 ud->status = VDEV_ST_NULL;
841 spin_unlock(&ud->lock);
844 static void vhci_device_unusable(struct usbip_device *ud)
846 spin_lock(&ud->lock);
847 ud->status = VDEV_ST_ERROR;
848 spin_unlock(&ud->lock);
851 static void vhci_device_init(struct vhci_device *vdev)
853 memset(vdev, 0, sizeof(*vdev));
855 vdev->ud.side = USBIP_VHCI;
856 vdev->ud.status = VDEV_ST_NULL;
857 spin_lock_init(&vdev->ud.lock);
859 INIT_LIST_HEAD(&vdev->priv_rx);
860 INIT_LIST_HEAD(&vdev->priv_tx);
861 INIT_LIST_HEAD(&vdev->unlink_tx);
862 INIT_LIST_HEAD(&vdev->unlink_rx);
863 spin_lock_init(&vdev->priv_lock);
865 init_waitqueue_head(&vdev->waitq_tx);
867 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
868 vdev->ud.eh_ops.reset = vhci_device_reset;
869 vdev->ud.eh_ops.unusable = vhci_device_unusable;
871 usbip_start_eh(&vdev->ud);
874 static int vhci_start(struct usb_hcd *hcd)
876 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
880 usbip_dbg_vhci_hc("enter vhci_start\n");
882 /* initialize private data of usb_hcd */
884 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
885 struct vhci_device *vdev = &vhci->vdev[rhport];
887 vhci_device_init(vdev);
888 vdev->rhport = rhport;
891 atomic_set(&vhci->seqnum, 0);
892 spin_lock_init(&vhci->lock);
894 hcd->power_budget = 0; /* no limit */
895 hcd->uses_new_polling = 1;
897 /* vhci_hcd is now ready to be controlled through sysfs */
898 err = sysfs_create_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
900 pr_err("create sysfs files\n");
907 static void vhci_stop(struct usb_hcd *hcd)
909 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
912 usbip_dbg_vhci_hc("stop VHCI controller\n");
914 /* 1. remove the userland interface of vhci_hcd */
915 sysfs_remove_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
917 /* 2. shutdown all the ports of vhci_hcd */
918 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
919 struct vhci_device *vdev = &vhci->vdev[rhport];
921 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
922 usbip_stop_eh(&vdev->ud);
926 static int vhci_get_frame_number(struct usb_hcd *hcd)
928 pr_err("Not yet implemented\n");
934 /* FIXME: suspend/resume */
935 static int vhci_bus_suspend(struct usb_hcd *hcd)
937 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
939 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
941 spin_lock(&vhci->lock);
942 hcd->state = HC_STATE_SUSPENDED;
943 spin_unlock(&vhci->lock);
948 static int vhci_bus_resume(struct usb_hcd *hcd)
950 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
953 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
955 spin_lock(&vhci->lock);
956 if (!HCD_HW_ACCESSIBLE(hcd))
959 hcd->state = HC_STATE_RUNNING;
960 spin_unlock(&vhci->lock);
967 #define vhci_bus_suspend NULL
968 #define vhci_bus_resume NULL
971 static struct hc_driver vhci_hc_driver = {
972 .description = driver_name,
973 .product_desc = driver_desc,
974 .hcd_priv_size = sizeof(struct vhci_hcd),
981 .urb_enqueue = vhci_urb_enqueue,
982 .urb_dequeue = vhci_urb_dequeue,
984 .get_frame_number = vhci_get_frame_number,
986 .hub_status_data = vhci_hub_status,
987 .hub_control = vhci_hub_control,
988 .bus_suspend = vhci_bus_suspend,
989 .bus_resume = vhci_bus_resume,
992 static int vhci_hcd_probe(struct platform_device *pdev)
997 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1000 * Allocate and initialize hcd.
1001 * Our private data is also allocated automatically.
1003 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1005 pr_err("create hcd failed\n");
1010 /* this is private data for vhci_hcd */
1011 the_controller = hcd_to_vhci(hcd);
1014 * Finish generic HCD structure initialization and register.
1015 * Call the driver's reset() and start() routines.
1017 ret = usb_add_hcd(hcd, 0, 0);
1019 pr_err("usb_add_hcd failed %d\n", ret);
1021 the_controller = NULL;
1025 usbip_dbg_vhci_hc("bye\n");
1029 static int vhci_hcd_remove(struct platform_device *pdev)
1031 struct usb_hcd *hcd;
1033 hcd = platform_get_drvdata(pdev);
1038 * Disconnects the root hub,
1039 * then reverses the effects of usb_add_hcd(),
1040 * invoking the HCD's stop() methods.
1042 usb_remove_hcd(hcd);
1044 the_controller = NULL;
1051 /* what should happen for USB/IP under suspend/resume? */
1052 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1054 struct usb_hcd *hcd;
1059 hcd = platform_get_drvdata(pdev);
1061 spin_lock(&the_controller->lock);
1063 for (rhport = 0; rhport < VHCI_NPORTS; rhport++)
1064 if (the_controller->port_status[rhport] &
1065 USB_PORT_STAT_CONNECTION)
1068 spin_unlock(&the_controller->lock);
1070 if (connected > 0) {
1071 dev_info(&pdev->dev,
1072 "We have %d active connection%s. Do not suspend.\n",
1073 connected, (connected == 1 ? "" : "s"));
1076 dev_info(&pdev->dev, "suspend vhci_hcd");
1077 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1083 static int vhci_hcd_resume(struct platform_device *pdev)
1085 struct usb_hcd *hcd;
1087 dev_dbg(&pdev->dev, "%s\n", __func__);
1089 hcd = platform_get_drvdata(pdev);
1090 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1091 usb_hcd_poll_rh_status(hcd);
1098 #define vhci_hcd_suspend NULL
1099 #define vhci_hcd_resume NULL
1103 static struct platform_driver vhci_driver = {
1104 .probe = vhci_hcd_probe,
1105 .remove = vhci_hcd_remove,
1106 .suspend = vhci_hcd_suspend,
1107 .resume = vhci_hcd_resume,
1109 .name = driver_name,
1114 * The VHCI 'device' is 'virtual'; not a real plug&play hardware.
1115 * We need to add this virtual device as a platform device arbitrarily:
1116 * 1. platform_device_register()
1118 static void the_pdev_release(struct device *dev)
1122 static struct platform_device the_pdev = {
1123 /* should be the same name as driver_name */
1124 .name = driver_name,
1127 .release = the_pdev_release,
1131 static int __init vhci_hcd_init(void)
1138 ret = platform_driver_register(&vhci_driver);
1140 goto err_driver_register;
1142 ret = platform_device_register(&the_pdev);
1144 goto err_platform_device_register;
1146 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
1149 err_platform_device_register:
1150 platform_driver_unregister(&vhci_driver);
1151 err_driver_register:
1155 static void __exit vhci_hcd_exit(void)
1157 platform_device_unregister(&the_pdev);
1158 platform_driver_unregister(&vhci_driver);
1161 module_init(vhci_hcd_init);
1162 module_exit(vhci_hcd_exit);
1164 MODULE_AUTHOR(DRIVER_AUTHOR);
1165 MODULE_DESCRIPTION(DRIVER_DESC);
1166 MODULE_LICENSE("GPL");
1167 MODULE_VERSION(USBIP_VERSION);