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
)
240 memset(desc
, 0, sizeof(*desc
));
241 desc
->bDescriptorType
= USB_DT_HUB
;
242 desc
->wHubCharacteristics
= cpu_to_le16(
243 HUB_CHAR_INDV_PORT_LPSM
| HUB_CHAR_COMMON_OCPM
);
245 desc
->bNbrPorts
= VHCI_HC_PORTS
;
246 BUILD_BUG_ON(VHCI_HC_PORTS
> USB_MAXCHILDREN
);
247 width
= desc
->bNbrPorts
/ 8 + 1;
248 desc
->bDescLength
= USB_DT_HUB_NONVAR_SIZE
+ 2 * width
;
249 memset(&desc
->u
.hs
.DeviceRemovable
[0], 0, width
);
250 memset(&desc
->u
.hs
.DeviceRemovable
[width
], 0xff, width
);
253 static int vhci_hub_control(struct usb_hcd
*hcd
, u16 typeReq
, u16 wValue
,
254 u16 wIndex
, char *buf
, u16 wLength
)
256 struct vhci_hcd
*dum
;
261 u32 prev_port_status
[VHCI_HC_PORTS
];
263 if (!HCD_HW_ACCESSIBLE(hcd
))
268 * wIndex shows the port number and begins from 1.
270 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq
, wValue
,
272 if (wIndex
> VHCI_HC_PORTS
)
273 pr_err("invalid port number %d\n", wIndex
);
274 rhport
= ((__u8
)(wIndex
& 0x00ff)) - 1;
276 dum
= hcd_to_vhci(hcd
);
278 spin_lock_irqsave(&dum
->lock
, flags
);
280 /* store old status and compare now and old later */
281 if (usbip_dbg_flag_vhci_rh
) {
282 memcpy(prev_port_status
, dum
->port_status
,
283 sizeof(prev_port_status
));
287 case ClearHubFeature
:
288 usbip_dbg_vhci_rh(" ClearHubFeature\n");
290 case ClearPortFeature
:
292 case USB_PORT_FEAT_SUSPEND
:
293 if (dum
->port_status
[rhport
] & USB_PORT_STAT_SUSPEND
) {
294 /* 20msec signaling */
297 jiffies
+ msecs_to_jiffies(20);
300 case USB_PORT_FEAT_POWER
:
302 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
303 dum
->port_status
[rhport
] = 0;
306 case USB_PORT_FEAT_C_RESET
:
308 " ClearPortFeature: USB_PORT_FEAT_C_RESET\n");
309 switch (dum
->vdev
[rhport
].speed
) {
311 dum
->port_status
[rhport
] |=
312 USB_PORT_STAT_HIGH_SPEED
;
315 dum
->port_status
[rhport
] |=
316 USB_PORT_STAT_LOW_SPEED
;
323 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
325 dum
->port_status
[rhport
] &= ~(1 << wValue
);
329 case GetHubDescriptor
:
330 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
331 hub_descriptor((struct usb_hub_descriptor
*) buf
);
334 usbip_dbg_vhci_rh(" GetHubStatus\n");
335 *(__le32
*) buf
= cpu_to_le32(0);
338 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex
);
339 if (wIndex
> VHCI_HC_PORTS
|| wIndex
< 1) {
340 pr_err("invalid port number %d\n", wIndex
);
344 /* we do not care about resume. */
346 /* whoever resets or resumes must GetPortStatus to
349 if (dum
->resuming
&& time_after(jiffies
, dum
->re_timeout
)) {
350 dum
->port_status
[rhport
] |=
351 (1 << USB_PORT_FEAT_C_SUSPEND
);
352 dum
->port_status
[rhport
] &=
353 ~(1 << USB_PORT_FEAT_SUSPEND
);
358 if ((dum
->port_status
[rhport
] & (1 << USB_PORT_FEAT_RESET
)) !=
359 0 && time_after(jiffies
, dum
->re_timeout
)) {
360 dum
->port_status
[rhport
] |=
361 (1 << USB_PORT_FEAT_C_RESET
);
362 dum
->port_status
[rhport
] &=
363 ~(1 << USB_PORT_FEAT_RESET
);
366 if (dum
->vdev
[rhport
].ud
.status
==
367 VDEV_ST_NOTASSIGNED
) {
369 " enable rhport %d (status %u)\n",
371 dum
->vdev
[rhport
].ud
.status
);
372 dum
->port_status
[rhport
] |=
373 USB_PORT_STAT_ENABLE
;
376 ((__le16
*) buf
)[0] = cpu_to_le16(dum
->port_status
[rhport
]);
377 ((__le16
*) buf
)[1] =
378 cpu_to_le16(dum
->port_status
[rhport
] >> 16);
380 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16
*)buf
)[0],
384 usbip_dbg_vhci_rh(" SetHubFeature\n");
389 case USB_PORT_FEAT_SUSPEND
:
391 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
393 case USB_PORT_FEAT_RESET
:
395 " SetPortFeature: USB_PORT_FEAT_RESET\n");
396 /* if it's already running, disconnect first */
397 if (dum
->port_status
[rhport
] & USB_PORT_STAT_ENABLE
) {
398 dum
->port_status
[rhport
] &=
399 ~(USB_PORT_STAT_ENABLE
|
400 USB_PORT_STAT_LOW_SPEED
|
401 USB_PORT_STAT_HIGH_SPEED
);
402 /* FIXME test that code path! */
404 /* 50msec reset signaling */
405 dum
->re_timeout
= jiffies
+ msecs_to_jiffies(50);
409 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
411 dum
->port_status
[rhport
] |= (1 << wValue
);
417 pr_err("default: no such request\n");
419 /* "protocol stall" on error */
423 if (usbip_dbg_flag_vhci_rh
) {
424 pr_debug("port %d\n", rhport
);
425 /* Only dump valid port status */
427 dump_port_status_diff(prev_port_status
[rhport
],
428 dum
->port_status
[rhport
]);
431 usbip_dbg_vhci_rh(" bye\n");
433 spin_unlock_irqrestore(&dum
->lock
, flags
);
438 static void vhci_tx_urb(struct urb
*urb
, struct vhci_device
*vdev
)
440 struct vhci_priv
*priv
;
441 struct vhci_hcd
*vhci
;
445 pr_err("could not get virtual device");
448 vhci
= vdev_to_vhci(vdev
);
450 priv
= kzalloc(sizeof(struct vhci_priv
), GFP_ATOMIC
);
452 usbip_event_add(&vdev
->ud
, VDEV_EVENT_ERROR_MALLOC
);
456 spin_lock_irqsave(&vdev
->priv_lock
, flags
);
458 priv
->seqnum
= atomic_inc_return(&vhci
->seqnum
);
459 if (priv
->seqnum
== 0xffff)
460 dev_info(&urb
->dev
->dev
, "seqnum max\n");
465 urb
->hcpriv
= (void *) priv
;
467 list_add_tail(&priv
->list
, &vdev
->priv_tx
);
469 wake_up(&vdev
->waitq_tx
);
470 spin_unlock_irqrestore(&vdev
->priv_lock
, flags
);
473 static int vhci_urb_enqueue(struct usb_hcd
*hcd
, struct urb
*urb
,
476 struct vhci_hcd
*vhci
= hcd_to_vhci(hcd
);
477 struct device
*dev
= &urb
->dev
->dev
;
478 u8 portnum
= urb
->dev
->portnum
;
480 struct vhci_device
*vdev
;
483 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
484 hcd
, urb
, mem_flags
);
486 if (portnum
> VHCI_HC_PORTS
) {
487 pr_err("invalid port number %d\n", portnum
);
490 vdev
= &vhci
->vdev
[portnum
-1];
492 /* patch to usb_sg_init() is in 2.5.60 */
493 BUG_ON(!urb
->transfer_buffer
&& urb
->transfer_buffer_length
);
495 spin_lock_irqsave(&vhci
->lock
, flags
);
497 if (urb
->status
!= -EINPROGRESS
) {
498 dev_err(dev
, "URB already unlinked!, status %d\n", urb
->status
);
499 spin_unlock_irqrestore(&vhci
->lock
, flags
);
503 /* refuse enqueue for dead connection */
504 spin_lock(&vdev
->ud
.lock
);
505 if (vdev
->ud
.status
== VDEV_ST_NULL
||
506 vdev
->ud
.status
== VDEV_ST_ERROR
) {
507 dev_err(dev
, "enqueue for inactive port %d\n", vdev
->rhport
);
508 spin_unlock(&vdev
->ud
.lock
);
509 spin_unlock_irqrestore(&vhci
->lock
, flags
);
512 spin_unlock(&vdev
->ud
.lock
);
514 ret
= usb_hcd_link_urb_to_ep(hcd
, urb
);
519 * The enumeration process is as follows;
521 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
522 * to get max packet length of default pipe
524 * 2. Set_Address request to DevAddr(0) EndPoint(0)
527 if (usb_pipedevice(urb
->pipe
) == 0) {
528 __u8 type
= usb_pipetype(urb
->pipe
);
529 struct usb_ctrlrequest
*ctrlreq
=
530 (struct usb_ctrlrequest
*) urb
->setup_packet
;
532 if (type
!= PIPE_CONTROL
|| !ctrlreq
) {
533 dev_err(dev
, "invalid request to devnum 0\n");
538 switch (ctrlreq
->bRequest
) {
539 case USB_REQ_SET_ADDRESS
:
540 /* set_address may come when a device is reset */
541 dev_info(dev
, "SetAddress Request (%d) to port %d\n",
542 ctrlreq
->wValue
, vdev
->rhport
);
544 usb_put_dev(vdev
->udev
);
545 vdev
->udev
= usb_get_dev(urb
->dev
);
547 spin_lock(&vdev
->ud
.lock
);
548 vdev
->ud
.status
= VDEV_ST_USED
;
549 spin_unlock(&vdev
->ud
.lock
);
551 if (urb
->status
== -EINPROGRESS
) {
552 /* This request is successfully completed. */
553 /* If not -EINPROGRESS, possibly unlinked. */
559 case USB_REQ_GET_DESCRIPTOR
:
560 if (ctrlreq
->wValue
== cpu_to_le16(USB_DT_DEVICE
<< 8))
562 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
564 usb_put_dev(vdev
->udev
);
565 vdev
->udev
= usb_get_dev(urb
->dev
);
571 "invalid request to devnum 0 bRequest %u, wValue %u\n",
581 vhci_tx_urb(urb
, vdev
);
582 spin_unlock_irqrestore(&vhci
->lock
, flags
);
587 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
589 spin_unlock_irqrestore(&vhci
->lock
, flags
);
591 usb_hcd_giveback_urb(hcd
, urb
, urb
->status
);
596 * vhci_rx gives back the urb after receiving the reply of the urb. If an
597 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
598 * back its urb. For the driver unlinking the urb, the content of the urb is
599 * not important, but the calling to its completion handler is important; the
600 * completion of unlinking is notified by the completion handler.
605 * - When vhci_hcd receives RET_SUBMIT,
607 * - case 1a). the urb of the pdu is not unlinking.
609 * => just give back the urb
611 * - case 1b). the urb of the pdu is unlinking.
612 * - usbip.ko will return a reply of the unlinking request.
613 * => give back the urb now and go to case 2b).
615 * - When vhci_hcd receives RET_UNLINK,
617 * - case 2a). a submit request is still pending in vhci_hcd.
618 * - urb was really pending in usbip.ko and urb_unlink_urb() was
620 * => free a pending submit request
621 * => notify unlink completeness by giving back the urb
623 * - case 2b). a submit request is *not* pending in vhci_hcd.
624 * - urb was already given back to the core driver.
625 * => do not give back the urb
630 * - When usbip receives CMD_UNLINK,
632 * - case 3a). the urb of the unlink request is now in submission.
633 * => do usb_unlink_urb().
634 * => after the unlink is completed, send RET_UNLINK.
636 * - case 3b). the urb of the unlink request is not in submission.
637 * - may be already completed or never be received
641 static int vhci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
643 struct vhci_hcd
*vhci
= hcd_to_vhci(hcd
);
644 struct vhci_priv
*priv
;
645 struct vhci_device
*vdev
;
648 pr_info("dequeue a urb %p\n", urb
);
650 spin_lock_irqsave(&vhci
->lock
, flags
);
654 /* URB was never linked! or will be soon given back by
656 spin_unlock_irqrestore(&vhci
->lock
, flags
);
663 ret
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
665 spin_unlock_irqrestore(&vhci
->lock
, flags
);
670 /* send unlink request here? */
673 if (!vdev
->ud
.tcp_socket
) {
674 /* tcp connection is closed */
675 spin_lock(&vdev
->priv_lock
);
677 pr_info("device %p seems to be disconnected\n", vdev
);
678 list_del(&priv
->list
);
682 spin_unlock(&vdev
->priv_lock
);
685 * If tcp connection is alive, we have sent CMD_UNLINK.
686 * vhci_rx will receive RET_UNLINK and give back the URB.
687 * Otherwise, we give back it here.
689 pr_info("gives back urb %p\n", urb
);
691 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
693 spin_unlock_irqrestore(&vhci
->lock
, flags
);
694 usb_hcd_giveback_urb(vhci_to_hcd(vhci
), urb
, urb
->status
);
695 spin_lock_irqsave(&vhci
->lock
, flags
);
698 /* tcp connection is alive */
699 struct vhci_unlink
*unlink
;
701 spin_lock(&vdev
->priv_lock
);
703 /* setup CMD_UNLINK pdu */
704 unlink
= kzalloc(sizeof(struct vhci_unlink
), GFP_ATOMIC
);
706 spin_unlock(&vdev
->priv_lock
);
707 spin_unlock_irqrestore(&vhci
->lock
, flags
);
708 usbip_event_add(&vdev
->ud
, VDEV_EVENT_ERROR_MALLOC
);
712 unlink
->seqnum
= atomic_inc_return(&vhci
->seqnum
);
713 if (unlink
->seqnum
== 0xffff)
714 pr_info("seqnum max\n");
716 unlink
->unlink_seqnum
= priv
->seqnum
;
718 pr_info("device %p seems to be still connected\n", vdev
);
720 /* send cmd_unlink and try to cancel the pending URB in the
722 list_add_tail(&unlink
->list
, &vdev
->unlink_tx
);
723 wake_up(&vdev
->waitq_tx
);
725 spin_unlock(&vdev
->priv_lock
);
728 spin_unlock_irqrestore(&vhci
->lock
, flags
);
730 usbip_dbg_vhci_hc("leave\n");
734 static void vhci_device_unlink_cleanup(struct vhci_device
*vdev
)
736 struct vhci_hcd
*vhci
= vdev_to_vhci(vdev
);
737 struct usb_hcd
*hcd
= vhci_to_hcd(vhci
);
738 struct vhci_unlink
*unlink
, *tmp
;
741 spin_lock_irqsave(&vhci
->lock
, flags
);
742 spin_lock(&vdev
->priv_lock
);
744 list_for_each_entry_safe(unlink
, tmp
, &vdev
->unlink_tx
, list
) {
745 pr_info("unlink cleanup tx %lu\n", unlink
->unlink_seqnum
);
746 list_del(&unlink
->list
);
750 while (!list_empty(&vdev
->unlink_rx
)) {
753 unlink
= list_first_entry(&vdev
->unlink_rx
, struct vhci_unlink
,
756 /* give back URB of unanswered unlink request */
757 pr_info("unlink cleanup rx %lu\n", unlink
->unlink_seqnum
);
759 urb
= pickup_urb_and_free_priv(vdev
, unlink
->unlink_seqnum
);
761 pr_info("the urb (seqnum %lu) was already given back\n",
762 unlink
->unlink_seqnum
);
763 list_del(&unlink
->list
);
768 urb
->status
= -ENODEV
;
770 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
772 list_del(&unlink
->list
);
774 spin_unlock(&vdev
->priv_lock
);
775 spin_unlock_irqrestore(&vhci
->lock
, flags
);
777 usb_hcd_giveback_urb(hcd
, urb
, urb
->status
);
779 spin_lock_irqsave(&vhci
->lock
, flags
);
780 spin_lock(&vdev
->priv_lock
);
785 spin_unlock(&vdev
->priv_lock
);
786 spin_unlock_irqrestore(&vhci
->lock
, flags
);
790 * The important thing is that only one context begins cleanup.
791 * This is why error handling and cleanup become simple.
792 * We do not want to consider race condition as possible.
794 static void vhci_shutdown_connection(struct usbip_device
*ud
)
796 struct vhci_device
*vdev
= container_of(ud
, struct vhci_device
, ud
);
798 /* need this? see stub_dev.c */
799 if (ud
->tcp_socket
) {
800 pr_debug("shutdown tcp_socket %p\n", ud
->tcp_socket
);
801 kernel_sock_shutdown(ud
->tcp_socket
, SHUT_RDWR
);
804 /* kill threads related to this sdev */
805 if (vdev
->ud
.tcp_rx
) {
806 kthread_stop_put(vdev
->ud
.tcp_rx
);
807 vdev
->ud
.tcp_rx
= NULL
;
809 if (vdev
->ud
.tcp_tx
) {
810 kthread_stop_put(vdev
->ud
.tcp_tx
);
811 vdev
->ud
.tcp_tx
= NULL
;
813 pr_info("stop threads\n");
815 /* active connection is closed */
816 if (vdev
->ud
.tcp_socket
) {
817 sockfd_put(vdev
->ud
.tcp_socket
);
818 vdev
->ud
.tcp_socket
= NULL
;
820 pr_info("release socket\n");
822 vhci_device_unlink_cleanup(vdev
);
825 * rh_port_disconnect() is a trigger of ...
826 * usb_disable_device():
827 * disable all the endpoints for a USB device.
828 * usb_disable_endpoint():
829 * disable endpoints. pending urbs are unlinked(dequeued).
831 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
832 * detached device should release used urbs in a cleanup function (i.e.
833 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
834 * pushed urbs and their private data in this function.
836 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
837 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
838 * gives back pushed urbs and frees their private data by request of
839 * the cleanup function of a USB driver. When unlinking a urb with an
840 * active connection, vhci_dequeue() does not give back the urb which
841 * is actually given back by vhci_rx after receiving its return pdu.
844 rh_port_disconnect(vdev
);
846 pr_info("disconnect device\n");
850 static void vhci_device_reset(struct usbip_device
*ud
)
852 struct vhci_device
*vdev
= container_of(ud
, struct vhci_device
, ud
);
855 spin_lock_irqsave(&ud
->lock
, flags
);
860 usb_put_dev(vdev
->udev
);
863 if (ud
->tcp_socket
) {
864 sockfd_put(ud
->tcp_socket
);
865 ud
->tcp_socket
= NULL
;
867 ud
->status
= VDEV_ST_NULL
;
869 spin_unlock_irqrestore(&ud
->lock
, flags
);
872 static void vhci_device_unusable(struct usbip_device
*ud
)
876 spin_lock_irqsave(&ud
->lock
, flags
);
877 ud
->status
= VDEV_ST_ERROR
;
878 spin_unlock_irqrestore(&ud
->lock
, flags
);
881 static void vhci_device_init(struct vhci_device
*vdev
)
883 memset(vdev
, 0, sizeof(struct vhci_device
));
885 vdev
->ud
.side
= USBIP_VHCI
;
886 vdev
->ud
.status
= VDEV_ST_NULL
;
887 spin_lock_init(&vdev
->ud
.lock
);
889 INIT_LIST_HEAD(&vdev
->priv_rx
);
890 INIT_LIST_HEAD(&vdev
->priv_tx
);
891 INIT_LIST_HEAD(&vdev
->unlink_tx
);
892 INIT_LIST_HEAD(&vdev
->unlink_rx
);
893 spin_lock_init(&vdev
->priv_lock
);
895 init_waitqueue_head(&vdev
->waitq_tx
);
897 vdev
->ud
.eh_ops
.shutdown
= vhci_shutdown_connection
;
898 vdev
->ud
.eh_ops
.reset
= vhci_device_reset
;
899 vdev
->ud
.eh_ops
.unusable
= vhci_device_unusable
;
901 usbip_start_eh(&vdev
->ud
);
904 static int hcd_name_to_id(const char *name
)
910 c
= strchr(name
, '.');
914 ret
= kstrtol(c
+1, 10, &val
);
921 static int vhci_start(struct usb_hcd
*hcd
)
923 struct vhci_hcd
*vhci
= hcd_to_vhci(hcd
);
927 usbip_dbg_vhci_hc("enter vhci_start\n");
929 /* initialize private data of usb_hcd */
931 for (rhport
= 0; rhport
< VHCI_HC_PORTS
; rhport
++) {
932 struct vhci_device
*vdev
= &vhci
->vdev
[rhport
];
934 vhci_device_init(vdev
);
935 vdev
->rhport
= rhport
;
938 atomic_set(&vhci
->seqnum
, 0);
939 spin_lock_init(&vhci
->lock
);
941 hcd
->power_budget
= 0; /* no limit */
942 hcd
->uses_new_polling
= 1;
944 id
= hcd_name_to_id(hcd_name(hcd
));
946 pr_err("invalid vhci name %s\n", hcd_name(hcd
));
950 /* vhci_hcd is now ready to be controlled through sysfs */
952 err
= vhci_init_attr_group();
954 pr_err("init attr group\n");
957 err
= sysfs_create_group(&hcd_dev(hcd
)->kobj
, &vhci_attr_group
);
959 pr_err("create sysfs files\n");
960 vhci_finish_attr_group();
963 pr_info("created sysfs %s\n", hcd_name(hcd
));
969 static void vhci_stop(struct usb_hcd
*hcd
)
971 struct vhci_hcd
*vhci
= hcd_to_vhci(hcd
);
974 usbip_dbg_vhci_hc("stop VHCI controller\n");
976 /* 1. remove the userland interface of vhci_hcd */
977 id
= hcd_name_to_id(hcd_name(hcd
));
979 sysfs_remove_group(&hcd_dev(hcd
)->kobj
, &vhci_attr_group
);
980 vhci_finish_attr_group();
983 /* 2. shutdown all the ports of vhci_hcd */
984 for (rhport
= 0; rhport
< VHCI_HC_PORTS
; rhport
++) {
985 struct vhci_device
*vdev
= &vhci
->vdev
[rhport
];
987 usbip_event_add(&vdev
->ud
, VDEV_EVENT_REMOVED
);
988 usbip_stop_eh(&vdev
->ud
);
992 static int vhci_get_frame_number(struct usb_hcd
*hcd
)
994 dev_err_ratelimited(&hcd
->self
.root_hub
->dev
, "Not yet implemented\n");
1000 /* FIXME: suspend/resume */
1001 static int vhci_bus_suspend(struct usb_hcd
*hcd
)
1003 struct vhci_hcd
*vhci
= hcd_to_vhci(hcd
);
1004 unsigned long flags
;
1006 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
1008 spin_lock_irqsave(&vhci
->lock
, flags
);
1009 hcd
->state
= HC_STATE_SUSPENDED
;
1010 spin_unlock_irqrestore(&vhci
->lock
, flags
);
1015 static int vhci_bus_resume(struct usb_hcd
*hcd
)
1017 struct vhci_hcd
*vhci
= hcd_to_vhci(hcd
);
1019 unsigned long flags
;
1021 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
1023 spin_lock_irqsave(&vhci
->lock
, flags
);
1024 if (!HCD_HW_ACCESSIBLE(hcd
))
1027 hcd
->state
= HC_STATE_RUNNING
;
1028 spin_unlock_irqrestore(&vhci
->lock
, flags
);
1035 #define vhci_bus_suspend NULL
1036 #define vhci_bus_resume NULL
1039 static struct hc_driver vhci_hc_driver
= {
1040 .description
= driver_name
,
1041 .product_desc
= driver_desc
,
1042 .hcd_priv_size
= sizeof(struct vhci_hcd
),
1046 .start
= vhci_start
,
1049 .urb_enqueue
= vhci_urb_enqueue
,
1050 .urb_dequeue
= vhci_urb_dequeue
,
1052 .get_frame_number
= vhci_get_frame_number
,
1054 .hub_status_data
= vhci_hub_status
,
1055 .hub_control
= vhci_hub_control
,
1056 .bus_suspend
= vhci_bus_suspend
,
1057 .bus_resume
= vhci_bus_resume
,
1060 static int vhci_hcd_probe(struct platform_device
*pdev
)
1062 struct usb_hcd
*hcd
;
1065 usbip_dbg_vhci_hc("name %s id %d\n", pdev
->name
, pdev
->id
);
1068 * Allocate and initialize hcd.
1069 * Our private data is also allocated automatically.
1071 hcd
= usb_create_hcd(&vhci_hc_driver
, &pdev
->dev
, dev_name(&pdev
->dev
));
1073 pr_err("create hcd failed\n");
1079 * Finish generic HCD structure initialization and register.
1080 * Call the driver's reset() and start() routines.
1082 ret
= usb_add_hcd(hcd
, 0, 0);
1084 pr_err("usb_add_hcd failed %d\n", ret
);
1089 usbip_dbg_vhci_hc("bye\n");
1093 static int vhci_hcd_remove(struct platform_device
*pdev
)
1095 struct usb_hcd
*hcd
;
1097 hcd
= platform_get_drvdata(pdev
);
1102 * Disconnects the root hub,
1103 * then reverses the effects of usb_add_hcd(),
1104 * invoking the HCD's stop() methods.
1106 usb_remove_hcd(hcd
);
1114 /* what should happen for USB/IP under suspend/resume? */
1115 static int vhci_hcd_suspend(struct platform_device
*pdev
, pm_message_t state
)
1117 struct usb_hcd
*hcd
;
1118 struct vhci_hcd
*vhci
;
1122 unsigned long flags
;
1124 hcd
= platform_get_drvdata(pdev
);
1127 vhci
= hcd_to_vhci(hcd
);
1129 spin_lock_irqsave(&vhci
->lock
, flags
);
1131 for (rhport
= 0; rhport
< VHCI_HC_PORTS
; rhport
++)
1132 if (vhci
->port_status
[rhport
] & USB_PORT_STAT_CONNECTION
)
1135 spin_unlock_irqrestore(&vhci
->lock
, flags
);
1137 if (connected
> 0) {
1138 dev_info(&pdev
->dev
,
1139 "We have %d active connection%s. Do not suspend.\n",
1140 connected
, (connected
== 1 ? "" : "s"));
1143 dev_info(&pdev
->dev
, "suspend vhci_hcd");
1144 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
1150 static int vhci_hcd_resume(struct platform_device
*pdev
)
1152 struct usb_hcd
*hcd
;
1154 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1156 hcd
= platform_get_drvdata(pdev
);
1159 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
1160 usb_hcd_poll_rh_status(hcd
);
1167 #define vhci_hcd_suspend NULL
1168 #define vhci_hcd_resume NULL
1172 static struct platform_driver vhci_driver
= {
1173 .probe
= vhci_hcd_probe
,
1174 .remove
= vhci_hcd_remove
,
1175 .suspend
= vhci_hcd_suspend
,
1176 .resume
= vhci_hcd_resume
,
1178 .name
= driver_name
,
1182 static int add_platform_device(int id
)
1184 struct platform_device
*pdev
;
1192 pdev
= platform_device_register_simple(driver_name
, dev_nr
, NULL
, 0);
1194 return PTR_ERR(pdev
);
1196 *(vhci_pdevs
+ id
) = pdev
;
1200 static void del_platform_devices(void)
1202 struct platform_device
*pdev
;
1205 for (i
= 0; i
< vhci_num_controllers
; i
++) {
1206 pdev
= *(vhci_pdevs
+ i
);
1208 platform_device_unregister(pdev
);
1209 *(vhci_pdevs
+ i
) = NULL
;
1211 sysfs_remove_link(&platform_bus
.kobj
, driver_name
);
1214 static int __init
vhci_hcd_init(void)
1221 if (vhci_num_controllers
< 1)
1222 vhci_num_controllers
= 1;
1224 vhci_pdevs
= kcalloc(vhci_num_controllers
, sizeof(void *), GFP_KERNEL
);
1225 if (vhci_pdevs
== NULL
)
1228 ret
= platform_driver_register(&vhci_driver
);
1230 goto err_driver_register
;
1232 for (i
= 0; i
< vhci_num_controllers
; i
++) {
1233 ret
= add_platform_device(i
);
1235 goto err_platform_device_register
;
1238 pr_info(DRIVER_DESC
" v" USBIP_VERSION
"\n");
1241 err_platform_device_register
:
1242 del_platform_devices();
1243 platform_driver_unregister(&vhci_driver
);
1244 err_driver_register
:
1249 static void __exit
vhci_hcd_exit(void)
1251 del_platform_devices();
1252 platform_driver_unregister(&vhci_driver
);
1256 module_init(vhci_hcd_init
);
1257 module_exit(vhci_hcd_exit
);
1259 MODULE_AUTHOR(DRIVER_AUTHOR
);
1260 MODULE_DESCRIPTION(DRIVER_DESC
);
1261 MODULE_LICENSE("GPL");
1262 MODULE_VERSION(USBIP_VERSION
);