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;
318 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
320 dum->port_status[rhport] &= ~(1 << wValue);
324 case GetHubDescriptor:
325 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
326 hub_descriptor((struct usb_hub_descriptor *) buf);
329 usbip_dbg_vhci_rh(" GetHubStatus\n");
330 *(__le32 *) buf = cpu_to_le32(0);
333 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
334 if (wIndex > VHCI_HC_PORTS || wIndex < 1) {
335 pr_err("invalid port number %d\n", wIndex);
339 /* we do not care about resume. */
341 /* whoever resets or resumes must GetPortStatus to
344 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
345 dum->port_status[rhport] |=
346 (1 << USB_PORT_FEAT_C_SUSPEND);
347 dum->port_status[rhport] &=
348 ~(1 << USB_PORT_FEAT_SUSPEND);
353 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
354 0 && time_after(jiffies, dum->re_timeout)) {
355 dum->port_status[rhport] |=
356 (1 << USB_PORT_FEAT_C_RESET);
357 dum->port_status[rhport] &=
358 ~(1 << USB_PORT_FEAT_RESET);
361 if (dum->vdev[rhport].ud.status ==
362 VDEV_ST_NOTASSIGNED) {
364 " enable rhport %d (status %u)\n",
366 dum->vdev[rhport].ud.status);
367 dum->port_status[rhport] |=
368 USB_PORT_STAT_ENABLE;
371 ((__le16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
372 ((__le16 *) buf)[1] =
373 cpu_to_le16(dum->port_status[rhport] >> 16);
375 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
379 usbip_dbg_vhci_rh(" SetHubFeature\n");
384 case USB_PORT_FEAT_SUSPEND:
386 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
388 case USB_PORT_FEAT_RESET:
390 " SetPortFeature: USB_PORT_FEAT_RESET\n");
391 /* if it's already running, disconnect first */
392 if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
393 dum->port_status[rhport] &=
394 ~(USB_PORT_STAT_ENABLE |
395 USB_PORT_STAT_LOW_SPEED |
396 USB_PORT_STAT_HIGH_SPEED);
397 /* FIXME test that code path! */
399 /* 50msec reset signaling */
400 dum->re_timeout = jiffies + msecs_to_jiffies(50);
404 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
406 dum->port_status[rhport] |= (1 << wValue);
412 pr_err("default: no such request\n");
414 /* "protocol stall" on error */
418 if (usbip_dbg_flag_vhci_rh) {
419 pr_debug("port %d\n", rhport);
420 /* Only dump valid port status */
422 dump_port_status_diff(prev_port_status[rhport],
423 dum->port_status[rhport]);
426 usbip_dbg_vhci_rh(" bye\n");
428 spin_unlock_irqrestore(&dum->lock, flags);
433 static void vhci_tx_urb(struct urb *urb, struct vhci_device *vdev)
435 struct vhci_priv *priv;
436 struct vhci_hcd *vhci;
440 pr_err("could not get virtual device");
443 vhci = vdev_to_vhci(vdev);
445 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
447 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
451 spin_lock_irqsave(&vdev->priv_lock, flags);
453 priv->seqnum = atomic_inc_return(&vhci->seqnum);
454 if (priv->seqnum == 0xffff)
455 dev_info(&urb->dev->dev, "seqnum max\n");
460 urb->hcpriv = (void *) priv;
462 list_add_tail(&priv->list, &vdev->priv_tx);
464 wake_up(&vdev->waitq_tx);
465 spin_unlock_irqrestore(&vdev->priv_lock, flags);
468 static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
471 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
472 struct device *dev = &urb->dev->dev;
473 u8 portnum = urb->dev->portnum;
475 struct vhci_device *vdev;
478 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
479 hcd, urb, mem_flags);
481 if (portnum > VHCI_HC_PORTS) {
482 pr_err("invalid port number %d\n", portnum);
485 vdev = &vhci->vdev[portnum-1];
487 /* patch to usb_sg_init() is in 2.5.60 */
488 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
490 spin_lock_irqsave(&vhci->lock, flags);
492 if (urb->status != -EINPROGRESS) {
493 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
494 spin_unlock_irqrestore(&vhci->lock, flags);
498 /* refuse enqueue for dead connection */
499 spin_lock(&vdev->ud.lock);
500 if (vdev->ud.status == VDEV_ST_NULL ||
501 vdev->ud.status == VDEV_ST_ERROR) {
502 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
503 spin_unlock(&vdev->ud.lock);
504 spin_unlock_irqrestore(&vhci->lock, flags);
507 spin_unlock(&vdev->ud.lock);
509 ret = usb_hcd_link_urb_to_ep(hcd, urb);
514 * The enumeration process is as follows;
516 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
517 * to get max packet length of default pipe
519 * 2. Set_Address request to DevAddr(0) EndPoint(0)
522 if (usb_pipedevice(urb->pipe) == 0) {
523 __u8 type = usb_pipetype(urb->pipe);
524 struct usb_ctrlrequest *ctrlreq =
525 (struct usb_ctrlrequest *) urb->setup_packet;
527 if (type != PIPE_CONTROL || !ctrlreq) {
528 dev_err(dev, "invalid request to devnum 0\n");
533 switch (ctrlreq->bRequest) {
534 case USB_REQ_SET_ADDRESS:
535 /* set_address may come when a device is reset */
536 dev_info(dev, "SetAddress Request (%d) to port %d\n",
537 ctrlreq->wValue, vdev->rhport);
539 usb_put_dev(vdev->udev);
540 vdev->udev = usb_get_dev(urb->dev);
542 spin_lock(&vdev->ud.lock);
543 vdev->ud.status = VDEV_ST_USED;
544 spin_unlock(&vdev->ud.lock);
546 if (urb->status == -EINPROGRESS) {
547 /* This request is successfully completed. */
548 /* If not -EINPROGRESS, possibly unlinked. */
554 case USB_REQ_GET_DESCRIPTOR:
555 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
557 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
559 usb_put_dev(vdev->udev);
560 vdev->udev = usb_get_dev(urb->dev);
566 "invalid request to devnum 0 bRequest %u, wValue %u\n",
576 vhci_tx_urb(urb, vdev);
577 spin_unlock_irqrestore(&vhci->lock, flags);
582 usb_hcd_unlink_urb_from_ep(hcd, urb);
584 spin_unlock_irqrestore(&vhci->lock, flags);
586 usb_hcd_giveback_urb(hcd, urb, urb->status);
591 * vhci_rx gives back the urb after receiving the reply of the urb. If an
592 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
593 * back its urb. For the driver unlinking the urb, the content of the urb is
594 * not important, but the calling to its completion handler is important; the
595 * completion of unlinking is notified by the completion handler.
600 * - When vhci_hcd receives RET_SUBMIT,
602 * - case 1a). the urb of the pdu is not unlinking.
604 * => just give back the urb
606 * - case 1b). the urb of the pdu is unlinking.
607 * - usbip.ko will return a reply of the unlinking request.
608 * => give back the urb now and go to case 2b).
610 * - When vhci_hcd receives RET_UNLINK,
612 * - case 2a). a submit request is still pending in vhci_hcd.
613 * - urb was really pending in usbip.ko and urb_unlink_urb() was
615 * => free a pending submit request
616 * => notify unlink completeness by giving back the urb
618 * - case 2b). a submit request is *not* pending in vhci_hcd.
619 * - urb was already given back to the core driver.
620 * => do not give back the urb
625 * - When usbip receives CMD_UNLINK,
627 * - case 3a). the urb of the unlink request is now in submission.
628 * => do usb_unlink_urb().
629 * => after the unlink is completed, send RET_UNLINK.
631 * - case 3b). the urb of the unlink request is not in submission.
632 * - may be already completed or never be received
636 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
638 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
639 struct vhci_priv *priv;
640 struct vhci_device *vdev;
643 pr_info("dequeue a urb %p\n", urb);
645 spin_lock_irqsave(&vhci->lock, flags);
649 /* URB was never linked! or will be soon given back by
651 spin_unlock_irqrestore(&vhci->lock, flags);
658 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
660 spin_unlock_irqrestore(&vhci->lock, flags);
665 /* send unlink request here? */
668 if (!vdev->ud.tcp_socket) {
669 /* tcp connection is closed */
670 spin_lock(&vdev->priv_lock);
672 pr_info("device %p seems to be disconnected\n", vdev);
673 list_del(&priv->list);
677 spin_unlock(&vdev->priv_lock);
680 * If tcp connection is alive, we have sent CMD_UNLINK.
681 * vhci_rx will receive RET_UNLINK and give back the URB.
682 * Otherwise, we give back it here.
684 pr_info("gives back urb %p\n", urb);
686 usb_hcd_unlink_urb_from_ep(hcd, urb);
688 spin_unlock_irqrestore(&vhci->lock, flags);
689 usb_hcd_giveback_urb(vhci_to_hcd(vhci), urb, urb->status);
690 spin_lock_irqsave(&vhci->lock, flags);
693 /* tcp connection is alive */
694 struct vhci_unlink *unlink;
696 spin_lock(&vdev->priv_lock);
698 /* setup CMD_UNLINK pdu */
699 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
701 spin_unlock(&vdev->priv_lock);
702 spin_unlock_irqrestore(&vhci->lock, flags);
703 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
707 unlink->seqnum = atomic_inc_return(&vhci->seqnum);
708 if (unlink->seqnum == 0xffff)
709 pr_info("seqnum max\n");
711 unlink->unlink_seqnum = priv->seqnum;
713 pr_info("device %p seems to be still connected\n", vdev);
715 /* send cmd_unlink and try to cancel the pending URB in the
717 list_add_tail(&unlink->list, &vdev->unlink_tx);
718 wake_up(&vdev->waitq_tx);
720 spin_unlock(&vdev->priv_lock);
723 spin_unlock_irqrestore(&vhci->lock, flags);
725 usbip_dbg_vhci_hc("leave\n");
729 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
731 struct vhci_hcd *vhci = vdev_to_vhci(vdev);
732 struct usb_hcd *hcd = vhci_to_hcd(vhci);
733 struct vhci_unlink *unlink, *tmp;
736 spin_lock_irqsave(&vhci->lock, flags);
737 spin_lock(&vdev->priv_lock);
739 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
740 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
741 list_del(&unlink->list);
745 while (!list_empty(&vdev->unlink_rx)) {
748 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
751 /* give back URB of unanswered unlink request */
752 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
754 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
756 pr_info("the urb (seqnum %lu) was already given back\n",
757 unlink->unlink_seqnum);
758 list_del(&unlink->list);
763 urb->status = -ENODEV;
765 usb_hcd_unlink_urb_from_ep(hcd, urb);
767 list_del(&unlink->list);
769 spin_unlock(&vdev->priv_lock);
770 spin_unlock_irqrestore(&vhci->lock, flags);
772 usb_hcd_giveback_urb(hcd, urb, urb->status);
774 spin_lock_irqsave(&vhci->lock, flags);
775 spin_lock(&vdev->priv_lock);
780 spin_unlock(&vdev->priv_lock);
781 spin_unlock_irqrestore(&vhci->lock, flags);
785 * The important thing is that only one context begins cleanup.
786 * This is why error handling and cleanup become simple.
787 * We do not want to consider race condition as possible.
789 static void vhci_shutdown_connection(struct usbip_device *ud)
791 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
793 /* need this? see stub_dev.c */
794 if (ud->tcp_socket) {
795 pr_debug("shutdown tcp_socket %p\n", ud->tcp_socket);
796 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
799 /* kill threads related to this sdev */
800 if (vdev->ud.tcp_rx) {
801 kthread_stop_put(vdev->ud.tcp_rx);
802 vdev->ud.tcp_rx = NULL;
804 if (vdev->ud.tcp_tx) {
805 kthread_stop_put(vdev->ud.tcp_tx);
806 vdev->ud.tcp_tx = NULL;
808 pr_info("stop threads\n");
810 /* active connection is closed */
811 if (vdev->ud.tcp_socket) {
812 sockfd_put(vdev->ud.tcp_socket);
813 vdev->ud.tcp_socket = NULL;
815 pr_info("release socket\n");
817 vhci_device_unlink_cleanup(vdev);
820 * rh_port_disconnect() is a trigger of ...
821 * usb_disable_device():
822 * disable all the endpoints for a USB device.
823 * usb_disable_endpoint():
824 * disable endpoints. pending urbs are unlinked(dequeued).
826 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
827 * detached device should release used urbs in a cleanup function (i.e.
828 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
829 * pushed urbs and their private data in this function.
831 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
832 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
833 * gives back pushed urbs and frees their private data by request of
834 * the cleanup function of a USB driver. When unlinking a urb with an
835 * active connection, vhci_dequeue() does not give back the urb which
836 * is actually given back by vhci_rx after receiving its return pdu.
839 rh_port_disconnect(vdev);
841 pr_info("disconnect device\n");
845 static void vhci_device_reset(struct usbip_device *ud)
847 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
850 spin_lock_irqsave(&ud->lock, flags);
855 usb_put_dev(vdev->udev);
858 if (ud->tcp_socket) {
859 sockfd_put(ud->tcp_socket);
860 ud->tcp_socket = NULL;
862 ud->status = VDEV_ST_NULL;
864 spin_unlock_irqrestore(&ud->lock, flags);
867 static void vhci_device_unusable(struct usbip_device *ud)
871 spin_lock_irqsave(&ud->lock, flags);
872 ud->status = VDEV_ST_ERROR;
873 spin_unlock_irqrestore(&ud->lock, flags);
876 static void vhci_device_init(struct vhci_device *vdev)
878 memset(vdev, 0, sizeof(struct vhci_device));
880 vdev->ud.side = USBIP_VHCI;
881 vdev->ud.status = VDEV_ST_NULL;
882 spin_lock_init(&vdev->ud.lock);
884 INIT_LIST_HEAD(&vdev->priv_rx);
885 INIT_LIST_HEAD(&vdev->priv_tx);
886 INIT_LIST_HEAD(&vdev->unlink_tx);
887 INIT_LIST_HEAD(&vdev->unlink_rx);
888 spin_lock_init(&vdev->priv_lock);
890 init_waitqueue_head(&vdev->waitq_tx);
892 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
893 vdev->ud.eh_ops.reset = vhci_device_reset;
894 vdev->ud.eh_ops.unusable = vhci_device_unusable;
896 usbip_start_eh(&vdev->ud);
899 static int hcd_name_to_id(const char *name)
905 c = strchr(name, '.');
909 ret = kstrtol(c+1, 10, &val);
916 static int vhci_start(struct usb_hcd *hcd)
918 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
922 usbip_dbg_vhci_hc("enter vhci_start\n");
924 /* initialize private data of usb_hcd */
926 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
927 struct vhci_device *vdev = &vhci->vdev[rhport];
929 vhci_device_init(vdev);
930 vdev->rhport = rhport;
933 atomic_set(&vhci->seqnum, 0);
934 spin_lock_init(&vhci->lock);
936 hcd->power_budget = 0; /* no limit */
937 hcd->uses_new_polling = 1;
939 id = hcd_name_to_id(hcd_name(hcd));
941 pr_err("invalid vhci name %s\n", hcd_name(hcd));
945 /* vhci_hcd is now ready to be controlled through sysfs */
947 err = vhci_init_attr_group();
949 pr_err("init attr group\n");
952 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
954 pr_err("create sysfs files\n");
955 vhci_finish_attr_group();
958 pr_info("created sysfs %s\n", hcd_name(hcd));
964 static void vhci_stop(struct usb_hcd *hcd)
966 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
969 usbip_dbg_vhci_hc("stop VHCI controller\n");
971 /* 1. remove the userland interface of vhci_hcd */
972 id = hcd_name_to_id(hcd_name(hcd));
974 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
975 vhci_finish_attr_group();
978 /* 2. shutdown all the ports of vhci_hcd */
979 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
980 struct vhci_device *vdev = &vhci->vdev[rhport];
982 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
983 usbip_stop_eh(&vdev->ud);
987 static int vhci_get_frame_number(struct usb_hcd *hcd)
989 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n");
995 /* FIXME: suspend/resume */
996 static int vhci_bus_suspend(struct usb_hcd *hcd)
998 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1001 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1003 spin_lock_irqsave(&vhci->lock, flags);
1004 hcd->state = HC_STATE_SUSPENDED;
1005 spin_unlock_irqrestore(&vhci->lock, flags);
1010 static int vhci_bus_resume(struct usb_hcd *hcd)
1012 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
1014 unsigned long flags;
1016 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1018 spin_lock_irqsave(&vhci->lock, flags);
1019 if (!HCD_HW_ACCESSIBLE(hcd))
1022 hcd->state = HC_STATE_RUNNING;
1023 spin_unlock_irqrestore(&vhci->lock, flags);
1030 #define vhci_bus_suspend NULL
1031 #define vhci_bus_resume NULL
1034 static struct hc_driver vhci_hc_driver = {
1035 .description = driver_name,
1036 .product_desc = driver_desc,
1037 .hcd_priv_size = sizeof(struct vhci_hcd),
1041 .start = vhci_start,
1044 .urb_enqueue = vhci_urb_enqueue,
1045 .urb_dequeue = vhci_urb_dequeue,
1047 .get_frame_number = vhci_get_frame_number,
1049 .hub_status_data = vhci_hub_status,
1050 .hub_control = vhci_hub_control,
1051 .bus_suspend = vhci_bus_suspend,
1052 .bus_resume = vhci_bus_resume,
1055 static int vhci_hcd_probe(struct platform_device *pdev)
1057 struct usb_hcd *hcd;
1060 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1063 * Allocate and initialize hcd.
1064 * Our private data is also allocated automatically.
1066 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1068 pr_err("create hcd failed\n");
1074 * Finish generic HCD structure initialization and register.
1075 * Call the driver's reset() and start() routines.
1077 ret = usb_add_hcd(hcd, 0, 0);
1079 pr_err("usb_add_hcd failed %d\n", ret);
1084 usbip_dbg_vhci_hc("bye\n");
1088 static int vhci_hcd_remove(struct platform_device *pdev)
1090 struct usb_hcd *hcd;
1092 hcd = platform_get_drvdata(pdev);
1097 * Disconnects the root hub,
1098 * then reverses the effects of usb_add_hcd(),
1099 * invoking the HCD's stop() methods.
1101 usb_remove_hcd(hcd);
1109 /* what should happen for USB/IP under suspend/resume? */
1110 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1112 struct usb_hcd *hcd;
1113 struct vhci_hcd *vhci;
1117 unsigned long flags;
1119 hcd = platform_get_drvdata(pdev);
1122 vhci = hcd_to_vhci(hcd);
1124 spin_lock_irqsave(&vhci->lock, flags);
1126 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++)
1127 if (vhci->port_status[rhport] & USB_PORT_STAT_CONNECTION)
1130 spin_unlock_irqrestore(&vhci->lock, flags);
1132 if (connected > 0) {
1133 dev_info(&pdev->dev,
1134 "We have %d active connection%s. Do not suspend.\n",
1135 connected, (connected == 1 ? "" : "s"));
1138 dev_info(&pdev->dev, "suspend vhci_hcd");
1139 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1145 static int vhci_hcd_resume(struct platform_device *pdev)
1147 struct usb_hcd *hcd;
1149 dev_dbg(&pdev->dev, "%s\n", __func__);
1151 hcd = platform_get_drvdata(pdev);
1154 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1155 usb_hcd_poll_rh_status(hcd);
1162 #define vhci_hcd_suspend NULL
1163 #define vhci_hcd_resume NULL
1167 static struct platform_driver vhci_driver = {
1168 .probe = vhci_hcd_probe,
1169 .remove = vhci_hcd_remove,
1170 .suspend = vhci_hcd_suspend,
1171 .resume = vhci_hcd_resume,
1173 .name = driver_name,
1177 static int add_platform_device(int id)
1179 struct platform_device *pdev;
1187 pdev = platform_device_register_simple(driver_name, dev_nr, NULL, 0);
1189 return PTR_ERR(pdev);
1191 *(vhci_pdevs + id) = pdev;
1195 static void del_platform_devices(void)
1197 struct platform_device *pdev;
1200 for (i = 0; i < vhci_num_controllers; i++) {
1201 pdev = *(vhci_pdevs + i);
1203 platform_device_unregister(pdev);
1204 *(vhci_pdevs + i) = NULL;
1206 sysfs_remove_link(&platform_bus.kobj, driver_name);
1209 static int __init vhci_hcd_init(void)
1216 if (vhci_num_controllers < 1)
1217 vhci_num_controllers = 1;
1219 vhci_pdevs = kcalloc(vhci_num_controllers, sizeof(void *), GFP_KERNEL);
1220 if (vhci_pdevs == NULL)
1223 ret = platform_driver_register(&vhci_driver);
1225 goto err_driver_register;
1227 for (i = 0; i < vhci_num_controllers; i++) {
1228 ret = add_platform_device(i);
1230 goto err_platform_device_register;
1233 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
1236 err_platform_device_register:
1237 del_platform_devices();
1238 platform_driver_unregister(&vhci_driver);
1239 err_driver_register:
1244 static void __exit vhci_hcd_exit(void)
1246 del_platform_devices();
1247 platform_driver_unregister(&vhci_driver);
1251 module_init(vhci_hcd_init);
1252 module_exit(vhci_hcd_exit);
1254 MODULE_AUTHOR(DRIVER_AUTHOR);
1255 MODULE_DESCRIPTION(DRIVER_DESC);
1256 MODULE_LICENSE("GPL");
1257 MODULE_VERSION(USBIP_VERSION);