aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/usb/usbip/vhci_hcd.c
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/usb/usbip/vhci_hcd.c')
-rw-r--r--drivers/usb/usbip/vhci_hcd.c1171
1 files changed, 1171 insertions, 0 deletions
diff --git a/drivers/usb/usbip/vhci_hcd.c b/drivers/usb/usbip/vhci_hcd.c
new file mode 100644
index 000000000000..c02374b6049c
--- /dev/null
+++ b/drivers/usb/usbip/vhci_hcd.c
@@ -0,0 +1,1171 @@
1/*
2 * Copyright (C) 2003-2008 Takahiro Hirofuchi
3 *
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.
8 *
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.
13 *
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,
17 * USA.
18 */
19
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>
27
28#include "usbip_common.h"
29#include "vhci.h"
30
31#define DRIVER_AUTHOR "Takahiro Hirofuchi"
32#define DRIVER_DESC "USB/IP 'Virtual' Host Controller (VHCI) Driver"
33
34/*
35 * TODO
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
42 */
43
44/* See usb gadget dummy hcd */
45
46static int vhci_hub_status(struct usb_hcd *hcd, char *buff);
47static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
48 u16 wIndex, char *buff, u16 wLength);
49static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
50 gfp_t mem_flags);
51static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
52static int vhci_start(struct usb_hcd *vhci_hcd);
53static void vhci_stop(struct usb_hcd *hcd);
54static int vhci_get_frame_number(struct usb_hcd *hcd);
55
56static const char driver_name[] = "vhci_hcd";
57static const char driver_desc[] = "USB/IP Virtual Host Controller";
58
59struct vhci_hcd *the_controller;
60
61static const char * const bit_desc[] = {
62 "CONNECTION", /*0*/
63 "ENABLE", /*1*/
64 "SUSPEND", /*2*/
65 "OVER_CURRENT", /*3*/
66 "RESET", /*4*/
67 "R5", /*5*/
68 "R6", /*6*/
69 "R7", /*7*/
70 "POWER", /*8*/
71 "LOWSPEED", /*9*/
72 "HIGHSPEED", /*10*/
73 "PORT_TEST", /*11*/
74 "INDICATOR", /*12*/
75 "R13", /*13*/
76 "R14", /*14*/
77 "R15", /*15*/
78 "C_CONNECTION", /*16*/
79 "C_ENABLE", /*17*/
80 "C_SUSPEND", /*18*/
81 "C_OVER_CURRENT", /*19*/
82 "C_RESET", /*20*/
83 "R21", /*21*/
84 "R22", /*22*/
85 "R23", /*23*/
86 "R24", /*24*/
87 "R25", /*25*/
88 "R26", /*26*/
89 "R27", /*27*/
90 "R28", /*28*/
91 "R29", /*29*/
92 "R30", /*30*/
93 "R31", /*31*/
94};
95
96static void dump_port_status_diff(u32 prev_status, u32 new_status)
97{
98 int i = 0;
99 u32 bit = 1;
100
101 pr_debug("status prev -> new: %08x -> %08x\n", prev_status, new_status);
102 while (bit) {
103 u32 prev = prev_status & bit;
104 u32 new = new_status & bit;
105 char change;
106
107 if (!prev && new)
108 change = '+';
109 else if (prev && !new)
110 change = '-';
111 else
112 change = ' ';
113
114 if (prev || new)
115 pr_debug(" %c%s\n", change, bit_desc[i]);
116 bit <<= 1;
117 i++;
118 }
119 pr_debug("\n");
120}
121
122void rh_port_connect(int rhport, enum usb_device_speed speed)
123{
124 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
125
126 spin_lock(&the_controller->lock);
127
128 the_controller->port_status[rhport] |= USB_PORT_STAT_CONNECTION
129 | (1 << USB_PORT_FEAT_C_CONNECTION);
130
131 switch (speed) {
132 case USB_SPEED_HIGH:
133 the_controller->port_status[rhport] |= USB_PORT_STAT_HIGH_SPEED;
134 break;
135 case USB_SPEED_LOW:
136 the_controller->port_status[rhport] |= USB_PORT_STAT_LOW_SPEED;
137 break;
138 default:
139 break;
140 }
141
142 spin_unlock(&the_controller->lock);
143
144 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
145}
146
147static void rh_port_disconnect(int rhport)
148{
149 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
150
151 spin_lock(&the_controller->lock);
152
153 the_controller->port_status[rhport] &= ~USB_PORT_STAT_CONNECTION;
154 the_controller->port_status[rhport] |=
155 (1 << USB_PORT_FEAT_C_CONNECTION);
156
157 spin_unlock(&the_controller->lock);
158 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
159}
160
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)
167
168/*
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.
172 *
173 * @buf: a bitmap to show which port status has been changed.
174 * bit 0: reserved
175 * bit 1: the status of port 0 has been changed.
176 * bit 2: the status of port 1 has been changed.
177 * ...
178 */
179static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
180{
181 struct vhci_hcd *vhci;
182 int retval;
183 int rhport;
184 int changed = 0;
185
186 retval = DIV_ROUND_UP(VHCI_NPORTS + 1, 8);
187 memset(buf, 0, retval);
188
189 vhci = hcd_to_vhci(hcd);
190
191 spin_lock(&vhci->lock);
192 if (!HCD_HW_ACCESSIBLE(hcd)) {
193 usbip_dbg_vhci_rh("hw accessible flag not on?\n");
194 goto done;
195 }
196
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);
202
203 buf[(rhport + 1) / 8] |= 1 << (rhport + 1) % 8;
204 changed = 1;
205 }
206 }
207
208 if ((hcd->state == HC_STATE_SUSPENDED) && (changed == 1))
209 usb_hcd_resume_root_hub(hcd);
210
211done:
212 spin_unlock(&vhci->lock);
213 return changed ? retval : 0;
214}
215
216static inline void hub_descriptor(struct usb_hub_descriptor *desc)
217{
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;
225}
226
227static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
228 u16 wIndex, char *buf, u16 wLength)
229{
230 struct vhci_hcd *dum;
231 int retval = 0;
232 int rhport;
233
234 u32 prev_port_status[VHCI_NPORTS];
235
236 if (!HCD_HW_ACCESSIBLE(hcd))
237 return -ETIMEDOUT;
238
239 /*
240 * NOTE:
241 * wIndex shows the port number and begins from 1.
242 */
243 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
244 wIndex);
245 if (wIndex > VHCI_NPORTS)
246 pr_err("invalid port number %d\n", wIndex);
247 rhport = ((__u8)(wIndex & 0x00ff)) - 1;
248
249 dum = hcd_to_vhci(hcd);
250
251 spin_lock(&dum->lock);
252
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));
257 }
258
259 switch (typeReq) {
260 case ClearHubFeature:
261 usbip_dbg_vhci_rh(" ClearHubFeature\n");
262 break;
263 case ClearPortFeature:
264 switch (wValue) {
265 case USB_PORT_FEAT_SUSPEND:
266 if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
267 /* 20msec signaling */
268 dum->resuming = 1;
269 dum->re_timeout =
270 jiffies + msecs_to_jiffies(20);
271 }
272 break;
273 case USB_PORT_FEAT_POWER:
274 usbip_dbg_vhci_rh(
275 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
276 dum->port_status[rhport] = 0;
277 dum->resuming = 0;
278 break;
279 case USB_PORT_FEAT_C_RESET:
280 usbip_dbg_vhci_rh(
281 " ClearPortFeature: USB_PORT_FEAT_C_RESET\n");
282 switch (dum->vdev[rhport].speed) {
283 case USB_SPEED_HIGH:
284 dum->port_status[rhport] |=
285 USB_PORT_STAT_HIGH_SPEED;
286 break;
287 case USB_SPEED_LOW:
288 dum->port_status[rhport] |=
289 USB_PORT_STAT_LOW_SPEED;
290 break;
291 default:
292 break;
293 }
294 default:
295 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
296 wValue);
297 dum->port_status[rhport] &= ~(1 << wValue);
298 break;
299 }
300 break;
301 case GetHubDescriptor:
302 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
303 hub_descriptor((struct usb_hub_descriptor *) buf);
304 break;
305 case GetHubStatus:
306 usbip_dbg_vhci_rh(" GetHubStatus\n");
307 *(__le32 *) buf = cpu_to_le32(0);
308 break;
309 case GetPortStatus:
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);
313 retval = -EPIPE;
314 }
315
316 /* we do not care about resume. */
317
318 /* whoever resets or resumes must GetPortStatus to
319 * complete it!!
320 */
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);
326 dum->resuming = 0;
327 dum->re_timeout = 0;
328 }
329
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);
336 dum->re_timeout = 0;
337
338 if (dum->vdev[rhport].ud.status ==
339 VDEV_ST_NOTASSIGNED) {
340 usbip_dbg_vhci_rh(
341 " enable rhport %d (status %u)\n",
342 rhport,
343 dum->vdev[rhport].ud.status);
344 dum->port_status[rhport] |=
345 USB_PORT_STAT_ENABLE;
346 }
347 }
348 ((__le16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
349 ((__le16 *) buf)[1] =
350 cpu_to_le16(dum->port_status[rhport] >> 16);
351
352 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
353 ((u16 *)buf)[1]);
354 break;
355 case SetHubFeature:
356 usbip_dbg_vhci_rh(" SetHubFeature\n");
357 retval = -EPIPE;
358 break;
359 case SetPortFeature:
360 switch (wValue) {
361 case USB_PORT_FEAT_SUSPEND:
362 usbip_dbg_vhci_rh(
363 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
364 break;
365 case USB_PORT_FEAT_RESET:
366 usbip_dbg_vhci_rh(
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! */
375 }
376 /* 50msec reset signaling */
377 dum->re_timeout = jiffies + msecs_to_jiffies(50);
378
379 /* FALLTHROUGH */
380 default:
381 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
382 wValue);
383 dum->port_status[rhport] |= (1 << wValue);
384 break;
385 }
386 break;
387
388 default:
389 pr_err("default: no such request\n");
390
391 /* "protocol stall" on error */
392 retval = -EPIPE;
393 }
394
395 if (usbip_dbg_flag_vhci_rh) {
396 pr_debug("port %d\n", rhport);
397 /* Only dump valid port status */
398 if (rhport >= 0) {
399 dump_port_status_diff(prev_port_status[rhport],
400 dum->port_status[rhport]);
401 }
402 }
403 usbip_dbg_vhci_rh(" bye\n");
404
405 spin_unlock(&dum->lock);
406
407 return retval;
408}
409
410static struct vhci_device *get_vdev(struct usb_device *udev)
411{
412 int i;
413
414 if (!udev)
415 return NULL;
416
417 for (i = 0; i < VHCI_NPORTS; i++)
418 if (the_controller->vdev[i].udev == udev)
419 return port_to_vdev(i);
420
421 return NULL;
422}
423
424static void vhci_tx_urb(struct urb *urb)
425{
426 struct vhci_device *vdev = get_vdev(urb->dev);
427 struct vhci_priv *priv;
428
429 if (!vdev) {
430 pr_err("could not get virtual device");
431 return;
432 }
433
434 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
435 if (!priv) {
436 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
437 return;
438 }
439
440 spin_lock(&vdev->priv_lock);
441
442 priv->seqnum = atomic_inc_return(&the_controller->seqnum);
443 if (priv->seqnum == 0xffff)
444 dev_info(&urb->dev->dev, "seqnum max\n");
445
446 priv->vdev = vdev;
447 priv->urb = urb;
448
449 urb->hcpriv = (void *) priv;
450
451 list_add_tail(&priv->list, &vdev->priv_tx);
452
453 wake_up(&vdev->waitq_tx);
454 spin_unlock(&vdev->priv_lock);
455}
456
457static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
458 gfp_t mem_flags)
459{
460 struct device *dev = &urb->dev->dev;
461 int ret = 0;
462 struct vhci_device *vdev;
463
464 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
465 hcd, urb, mem_flags);
466
467 /* patch to usb_sg_init() is in 2.5.60 */
468 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
469
470 spin_lock(&the_controller->lock);
471
472 if (urb->status != -EINPROGRESS) {
473 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
474 spin_unlock(&the_controller->lock);
475 return urb->status;
476 }
477
478 vdev = port_to_vdev(urb->dev->portnum-1);
479
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);
487 return -ENODEV;
488 }
489 spin_unlock(&vdev->ud.lock);
490
491 ret = usb_hcd_link_urb_to_ep(hcd, urb);
492 if (ret)
493 goto no_need_unlink;
494
495 /*
496 * The enumeration process is as follows;
497 *
498 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
499 * to get max packet length of default pipe
500 *
501 * 2. Set_Address request to DevAddr(0) EndPoint(0)
502 *
503 */
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;
508
509 if (type != PIPE_CONTROL || !ctrlreq) {
510 dev_err(dev, "invalid request to devnum 0\n");
511 ret = -EINVAL;
512 goto no_need_xmit;
513 }
514
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);
520
521 if (vdev->udev)
522 usb_put_dev(vdev->udev);
523 vdev->udev = usb_get_dev(urb->dev);
524
525 spin_lock(&vdev->ud.lock);
526 vdev->ud.status = VDEV_ST_USED;
527 spin_unlock(&vdev->ud.lock);
528
529 if (urb->status == -EINPROGRESS) {
530 /* This request is successfully completed. */
531 /* If not -EINPROGRESS, possibly unlinked. */
532 urb->status = 0;
533 }
534
535 goto no_need_xmit;
536
537 case USB_REQ_GET_DESCRIPTOR:
538 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
539 usbip_dbg_vhci_hc(
540 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
541
542 if (vdev->udev)
543 usb_put_dev(vdev->udev);
544 vdev->udev = usb_get_dev(urb->dev);
545 goto out;
546
547 default:
548 /* NOT REACHED */
549 dev_err(dev,
550 "invalid request to devnum 0 bRequest %u, wValue %u\n",
551 ctrlreq->bRequest,
552 ctrlreq->wValue);
553 ret = -EINVAL;
554 goto no_need_xmit;
555 }
556
557 }
558
559out:
560 vhci_tx_urb(urb);
561 spin_unlock(&the_controller->lock);
562
563 return 0;
564
565no_need_xmit:
566 usb_hcd_unlink_urb_from_ep(hcd, urb);
567no_need_unlink:
568 spin_unlock(&the_controller->lock);
569 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb, urb->status);
570 return ret;
571}
572
573/*
574 * vhci_rx gives back the urb after receiving the reply of the urb. If an
575 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
576 * back its urb. For the driver unlinking the urb, the content of the urb is
577 * not important, but the calling to its completion handler is important; the
578 * completion of unlinking is notified by the completion handler.
579 *
580 *
581 * CLIENT SIDE
582 *
583 * - When vhci_hcd receives RET_SUBMIT,
584 *
585 * - case 1a). the urb of the pdu is not unlinking.
586 * - normal case
587 * => just give back the urb
588 *
589 * - case 1b). the urb of the pdu is unlinking.
590 * - usbip.ko will return a reply of the unlinking request.
591 * => give back the urb now and go to case 2b).
592 *
593 * - When vhci_hcd receives RET_UNLINK,
594 *
595 * - case 2a). a submit request is still pending in vhci_hcd.
596 * - urb was really pending in usbip.ko and urb_unlink_urb() was
597 * completed there.
598 * => free a pending submit request
599 * => notify unlink completeness by giving back the urb
600 *
601 * - case 2b). a submit request is *not* pending in vhci_hcd.
602 * - urb was already given back to the core driver.
603 * => do not give back the urb
604 *
605 *
606 * SERVER SIDE
607 *
608 * - When usbip receives CMD_UNLINK,
609 *
610 * - case 3a). the urb of the unlink request is now in submission.
611 * => do usb_unlink_urb().
612 * => after the unlink is completed, send RET_UNLINK.
613 *
614 * - case 3b). the urb of the unlink request is not in submission.
615 * - may be already completed or never be received
616 * => send RET_UNLINK
617 *
618 */
619static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
620{
621 struct vhci_priv *priv;
622 struct vhci_device *vdev;
623
624 pr_info("dequeue a urb %p\n", urb);
625
626 spin_lock(&the_controller->lock);
627
628 priv = urb->hcpriv;
629 if (!priv) {
630 /* URB was never linked! or will be soon given back by
631 * vhci_rx. */
632 spin_unlock(&the_controller->lock);
633 return 0;
634 }
635
636 {
637 int ret = 0;
638
639 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
640 if (ret) {
641 spin_unlock(&the_controller->lock);
642 return ret;
643 }
644 }
645
646 /* send unlink request here? */
647 vdev = priv->vdev;
648
649 if (!vdev->ud.tcp_socket) {
650 /* tcp connection is closed */
651 spin_lock(&vdev->priv_lock);
652
653 pr_info("device %p seems to be disconnected\n", vdev);
654 list_del(&priv->list);
655 kfree(priv);
656 urb->hcpriv = NULL;
657
658 spin_unlock(&vdev->priv_lock);
659
660 /*
661 * If tcp connection is alive, we have sent CMD_UNLINK.
662 * vhci_rx will receive RET_UNLINK and give back the URB.
663 * Otherwise, we give back it here.
664 */
665 pr_info("gives back urb %p\n", urb);
666
667 usb_hcd_unlink_urb_from_ep(hcd, urb);
668
669 spin_unlock(&the_controller->lock);
670 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
671 urb->status);
672 spin_lock(&the_controller->lock);
673
674 } else {
675 /* tcp connection is alive */
676 struct vhci_unlink *unlink;
677
678 spin_lock(&vdev->priv_lock);
679
680 /* setup CMD_UNLINK pdu */
681 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
682 if (!unlink) {
683 spin_unlock(&vdev->priv_lock);
684 spin_unlock(&the_controller->lock);
685 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
686 return -ENOMEM;
687 }
688
689 unlink->seqnum = atomic_inc_return(&the_controller->seqnum);
690 if (unlink->seqnum == 0xffff)
691 pr_info("seqnum max\n");
692
693 unlink->unlink_seqnum = priv->seqnum;
694
695 pr_info("device %p seems to be still connected\n", vdev);
696
697 /* send cmd_unlink and try to cancel the pending URB in the
698 * peer */
699 list_add_tail(&unlink->list, &vdev->unlink_tx);
700 wake_up(&vdev->waitq_tx);
701
702 spin_unlock(&vdev->priv_lock);
703 }
704
705 spin_unlock(&the_controller->lock);
706
707 usbip_dbg_vhci_hc("leave\n");
708 return 0;
709}
710
711static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
712{
713 struct vhci_unlink *unlink, *tmp;
714
715 spin_lock(&the_controller->lock);
716 spin_lock(&vdev->priv_lock);
717
718 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
719 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
720 list_del(&unlink->list);
721 kfree(unlink);
722 }
723
724 while (!list_empty(&vdev->unlink_rx)) {
725 struct urb *urb;
726
727 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
728 list);
729
730 /* give back URB of unanswered unlink request */
731 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
732
733 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
734 if (!urb) {
735 pr_info("the urb (seqnum %lu) was already given back\n",
736 unlink->unlink_seqnum);
737 list_del(&unlink->list);
738 kfree(unlink);
739 continue;
740 }
741
742 urb->status = -ENODEV;
743
744 usb_hcd_unlink_urb_from_ep(vhci_to_hcd(the_controller), urb);
745
746 list_del(&unlink->list);
747
748 spin_unlock(&vdev->priv_lock);
749 spin_unlock(&the_controller->lock);
750
751 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
752 urb->status);
753
754 spin_lock(&the_controller->lock);
755 spin_lock(&vdev->priv_lock);
756
757 kfree(unlink);
758 }
759
760 spin_unlock(&vdev->priv_lock);
761 spin_unlock(&the_controller->lock);
762}
763
764/*
765 * The important thing is that only one context begins cleanup.
766 * This is why error handling and cleanup become simple.
767 * We do not want to consider race condition as possible.
768 */
769static void vhci_shutdown_connection(struct usbip_device *ud)
770{
771 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
772
773 /* need this? see stub_dev.c */
774 if (ud->tcp_socket) {
775 pr_debug("shutdown tcp_socket %p\n", ud->tcp_socket);
776 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
777 }
778
779 /* kill threads related to this sdev */
780 if (vdev->ud.tcp_rx) {
781 kthread_stop_put(vdev->ud.tcp_rx);
782 vdev->ud.tcp_rx = NULL;
783 }
784 if (vdev->ud.tcp_tx) {
785 kthread_stop_put(vdev->ud.tcp_tx);
786 vdev->ud.tcp_tx = NULL;
787 }
788 pr_info("stop threads\n");
789
790 /* active connection is closed */
791 if (vdev->ud.tcp_socket) {
792 sockfd_put(vdev->ud.tcp_socket);
793 vdev->ud.tcp_socket = NULL;
794 }
795 pr_info("release socket\n");
796
797 vhci_device_unlink_cleanup(vdev);
798
799 /*
800 * rh_port_disconnect() is a trigger of ...
801 * usb_disable_device():
802 * disable all the endpoints for a USB device.
803 * usb_disable_endpoint():
804 * disable endpoints. pending urbs are unlinked(dequeued).
805 *
806 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
807 * detached device should release used urbs in a cleanup function (i.e.
808 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
809 * pushed urbs and their private data in this function.
810 *
811 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
812 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
813 * gives back pushed urbs and frees their private data by request of
814 * the cleanup function of a USB driver. When unlinking a urb with an
815 * active connection, vhci_dequeue() does not give back the urb which
816 * is actually given back by vhci_rx after receiving its return pdu.
817 *
818 */
819 rh_port_disconnect(vdev->rhport);
820
821 pr_info("disconnect device\n");
822}
823
824
825static void vhci_device_reset(struct usbip_device *ud)
826{
827 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
828
829 spin_lock(&ud->lock);
830
831 vdev->speed = 0;
832 vdev->devid = 0;
833
834 if (vdev->udev)
835 usb_put_dev(vdev->udev);
836 vdev->udev = NULL;
837
838 if (ud->tcp_socket) {
839 sockfd_put(ud->tcp_socket);
840 ud->tcp_socket = NULL;
841 }
842 ud->status = VDEV_ST_NULL;
843
844 spin_unlock(&ud->lock);
845}
846
847static void vhci_device_unusable(struct usbip_device *ud)
848{
849 spin_lock(&ud->lock);
850 ud->status = VDEV_ST_ERROR;
851 spin_unlock(&ud->lock);
852}
853
854static void vhci_device_init(struct vhci_device *vdev)
855{
856 memset(vdev, 0, sizeof(*vdev));
857
858 vdev->ud.side = USBIP_VHCI;
859 vdev->ud.status = VDEV_ST_NULL;
860 spin_lock_init(&vdev->ud.lock);
861
862 INIT_LIST_HEAD(&vdev->priv_rx);
863 INIT_LIST_HEAD(&vdev->priv_tx);
864 INIT_LIST_HEAD(&vdev->unlink_tx);
865 INIT_LIST_HEAD(&vdev->unlink_rx);
866 spin_lock_init(&vdev->priv_lock);
867
868 init_waitqueue_head(&vdev->waitq_tx);
869
870 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
871 vdev->ud.eh_ops.reset = vhci_device_reset;
872 vdev->ud.eh_ops.unusable = vhci_device_unusable;
873
874 usbip_start_eh(&vdev->ud);
875}
876
877static int vhci_start(struct usb_hcd *hcd)
878{
879 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
880 int rhport;
881 int err = 0;
882
883 usbip_dbg_vhci_hc("enter vhci_start\n");
884
885 /* initialize private data of usb_hcd */
886
887 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
888 struct vhci_device *vdev = &vhci->vdev[rhport];
889
890 vhci_device_init(vdev);
891 vdev->rhport = rhport;
892 }
893
894 atomic_set(&vhci->seqnum, 0);
895 spin_lock_init(&vhci->lock);
896
897 hcd->power_budget = 0; /* no limit */
898 hcd->uses_new_polling = 1;
899
900 /* vhci_hcd is now ready to be controlled through sysfs */
901 err = sysfs_create_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
902 if (err) {
903 pr_err("create sysfs files\n");
904 return err;
905 }
906
907 return 0;
908}
909
910static void vhci_stop(struct usb_hcd *hcd)
911{
912 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
913 int rhport = 0;
914
915 usbip_dbg_vhci_hc("stop VHCI controller\n");
916
917 /* 1. remove the userland interface of vhci_hcd */
918 sysfs_remove_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
919
920 /* 2. shutdown all the ports of vhci_hcd */
921 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
922 struct vhci_device *vdev = &vhci->vdev[rhport];
923
924 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
925 usbip_stop_eh(&vdev->ud);
926 }
927}
928
929static int vhci_get_frame_number(struct usb_hcd *hcd)
930{
931 pr_err("Not yet implemented\n");
932 return 0;
933}
934
935#ifdef CONFIG_PM
936
937/* FIXME: suspend/resume */
938static int vhci_bus_suspend(struct usb_hcd *hcd)
939{
940 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
941
942 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
943
944 spin_lock(&vhci->lock);
945 hcd->state = HC_STATE_SUSPENDED;
946 spin_unlock(&vhci->lock);
947
948 return 0;
949}
950
951static int vhci_bus_resume(struct usb_hcd *hcd)
952{
953 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
954 int rc = 0;
955
956 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
957
958 spin_lock(&vhci->lock);
959 if (!HCD_HW_ACCESSIBLE(hcd))
960 rc = -ESHUTDOWN;
961 else
962 hcd->state = HC_STATE_RUNNING;
963 spin_unlock(&vhci->lock);
964
965 return rc;
966}
967
968#else
969
970#define vhci_bus_suspend NULL
971#define vhci_bus_resume NULL
972#endif
973
974static struct hc_driver vhci_hc_driver = {
975 .description = driver_name,
976 .product_desc = driver_desc,
977 .hcd_priv_size = sizeof(struct vhci_hcd),
978
979 .flags = HCD_USB2,
980
981 .start = vhci_start,
982 .stop = vhci_stop,
983
984 .urb_enqueue = vhci_urb_enqueue,
985 .urb_dequeue = vhci_urb_dequeue,
986
987 .get_frame_number = vhci_get_frame_number,
988
989 .hub_status_data = vhci_hub_status,
990 .hub_control = vhci_hub_control,
991 .bus_suspend = vhci_bus_suspend,
992 .bus_resume = vhci_bus_resume,
993};
994
995static int vhci_hcd_probe(struct platform_device *pdev)
996{
997 struct usb_hcd *hcd;
998 int ret;
999
1000 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1001
1002 /*
1003 * Allocate and initialize hcd.
1004 * Our private data is also allocated automatically.
1005 */
1006 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1007 if (!hcd) {
1008 pr_err("create hcd failed\n");
1009 return -ENOMEM;
1010 }
1011 hcd->has_tt = 1;
1012
1013 /* this is private data for vhci_hcd */
1014 the_controller = hcd_to_vhci(hcd);
1015
1016 /*
1017 * Finish generic HCD structure initialization and register.
1018 * Call the driver's reset() and start() routines.
1019 */
1020 ret = usb_add_hcd(hcd, 0, 0);
1021 if (ret != 0) {
1022 pr_err("usb_add_hcd failed %d\n", ret);
1023 usb_put_hcd(hcd);
1024 the_controller = NULL;
1025 return ret;
1026 }
1027
1028 usbip_dbg_vhci_hc("bye\n");
1029 return 0;
1030}
1031
1032static int vhci_hcd_remove(struct platform_device *pdev)
1033{
1034 struct usb_hcd *hcd;
1035
1036 hcd = platform_get_drvdata(pdev);
1037 if (!hcd)
1038 return 0;
1039
1040 /*
1041 * Disconnects the root hub,
1042 * then reverses the effects of usb_add_hcd(),
1043 * invoking the HCD's stop() methods.
1044 */
1045 usb_remove_hcd(hcd);
1046 usb_put_hcd(hcd);
1047 the_controller = NULL;
1048
1049 return 0;
1050}
1051
1052#ifdef CONFIG_PM
1053
1054/* what should happen for USB/IP under suspend/resume? */
1055static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1056{
1057 struct usb_hcd *hcd;
1058 int rhport = 0;
1059 int connected = 0;
1060 int ret = 0;
1061
1062 hcd = platform_get_drvdata(pdev);
1063
1064 spin_lock(&the_controller->lock);
1065
1066 for (rhport = 0; rhport < VHCI_NPORTS; rhport++)
1067 if (the_controller->port_status[rhport] &
1068 USB_PORT_STAT_CONNECTION)
1069 connected += 1;
1070
1071 spin_unlock(&the_controller->lock);
1072
1073 if (connected > 0) {
1074 dev_info(&pdev->dev,
1075 "We have %d active connection%s. Do not suspend.\n",
1076 connected, (connected == 1 ? "" : "s"));
1077 ret = -EBUSY;
1078 } else {
1079 dev_info(&pdev->dev, "suspend vhci_hcd");
1080 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1081 }
1082
1083 return ret;
1084}
1085
1086static int vhci_hcd_resume(struct platform_device *pdev)
1087{
1088 struct usb_hcd *hcd;
1089
1090 dev_dbg(&pdev->dev, "%s\n", __func__);
1091
1092 hcd = platform_get_drvdata(pdev);
1093 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1094 usb_hcd_poll_rh_status(hcd);
1095
1096 return 0;
1097}
1098
1099#else
1100
1101#define vhci_hcd_suspend NULL
1102#define vhci_hcd_resume NULL
1103
1104#endif
1105
1106static struct platform_driver vhci_driver = {
1107 .probe = vhci_hcd_probe,
1108 .remove = vhci_hcd_remove,
1109 .suspend = vhci_hcd_suspend,
1110 .resume = vhci_hcd_resume,
1111 .driver = {
1112 .name = driver_name,
1113 .owner = THIS_MODULE,
1114 },
1115};
1116
1117/*
1118 * The VHCI 'device' is 'virtual'; not a real plug&play hardware.
1119 * We need to add this virtual device as a platform device arbitrarily:
1120 * 1. platform_device_register()
1121 */
1122static void the_pdev_release(struct device *dev)
1123{
1124}
1125
1126static struct platform_device the_pdev = {
1127 /* should be the same name as driver_name */
1128 .name = driver_name,
1129 .id = -1,
1130 .dev = {
1131 .release = the_pdev_release,
1132 },
1133};
1134
1135static int __init vhci_hcd_init(void)
1136{
1137 int ret;
1138
1139 if (usb_disabled())
1140 return -ENODEV;
1141
1142 ret = platform_driver_register(&vhci_driver);
1143 if (ret)
1144 goto err_driver_register;
1145
1146 ret = platform_device_register(&the_pdev);
1147 if (ret)
1148 goto err_platform_device_register;
1149
1150 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
1151 return ret;
1152
1153err_platform_device_register:
1154 platform_driver_unregister(&vhci_driver);
1155err_driver_register:
1156 return ret;
1157}
1158
1159static void __exit vhci_hcd_exit(void)
1160{
1161 platform_device_unregister(&the_pdev);
1162 platform_driver_unregister(&vhci_driver);
1163}
1164
1165module_init(vhci_hcd_init);
1166module_exit(vhci_hcd_exit);
1167
1168MODULE_AUTHOR(DRIVER_AUTHOR);
1169MODULE_DESCRIPTION(DRIVER_DESC);
1170MODULE_LICENSE("GPL");
1171MODULE_VERSION(USBIP_VERSION);
generated by cgit v1.2.2 (git 2.25.0) at 2025-06-01 00:35:47 -0400