Loading...
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 unsigned long flags;
125
126 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
127
128 spin_lock_irqsave(&the_controller->lock, flags);
129
130 the_controller->port_status[rhport] |= USB_PORT_STAT_CONNECTION
131 | (1 << USB_PORT_FEAT_C_CONNECTION);
132
133 switch (speed) {
134 case USB_SPEED_HIGH:
135 the_controller->port_status[rhport] |= USB_PORT_STAT_HIGH_SPEED;
136 break;
137 case USB_SPEED_LOW:
138 the_controller->port_status[rhport] |= USB_PORT_STAT_LOW_SPEED;
139 break;
140 default:
141 break;
142 }
143
144 spin_unlock_irqrestore(&the_controller->lock, flags);
145
146 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
147}
148
149static void rh_port_disconnect(int rhport)
150{
151 unsigned long flags;
152
153 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
154
155 spin_lock_irqsave(&the_controller->lock, flags);
156
157 the_controller->port_status[rhport] &= ~USB_PORT_STAT_CONNECTION;
158 the_controller->port_status[rhport] |=
159 (1 << USB_PORT_FEAT_C_CONNECTION);
160
161 spin_unlock_irqrestore(&the_controller->lock, flags);
162 usb_hcd_poll_rh_status(vhci_to_hcd(the_controller));
163}
164
165#define PORT_C_MASK \
166 ((USB_PORT_STAT_C_CONNECTION \
167 | USB_PORT_STAT_C_ENABLE \
168 | USB_PORT_STAT_C_SUSPEND \
169 | USB_PORT_STAT_C_OVERCURRENT \
170 | USB_PORT_STAT_C_RESET) << 16)
171
172/*
173 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
174 * Ports are 0-indexed from the HCD point of view,
175 * and 1-indexed from the USB core pointer of view.
176 *
177 * @buf: a bitmap to show which port status has been changed.
178 * bit 0: reserved
179 * bit 1: the status of port 0 has been changed.
180 * bit 2: the status of port 1 has been changed.
181 * ...
182 */
183static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
184{
185 struct vhci_hcd *vhci;
186 int retval;
187 int rhport;
188 int changed = 0;
189 unsigned long flags;
190
191 retval = DIV_ROUND_UP(VHCI_NPORTS + 1, 8);
192 memset(buf, 0, retval);
193
194 vhci = hcd_to_vhci(hcd);
195
196 spin_lock_irqsave(&vhci->lock, flags);
197 if (!HCD_HW_ACCESSIBLE(hcd)) {
198 usbip_dbg_vhci_rh("hw accessible flag not on?\n");
199 goto done;
200 }
201
202 /* check pseudo status register for each port */
203 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
204 if ((vhci->port_status[rhport] & PORT_C_MASK)) {
205 /* The status of a port has been changed, */
206 usbip_dbg_vhci_rh("port %d status changed\n", rhport);
207
208 buf[(rhport + 1) / 8] |= 1 << (rhport + 1) % 8;
209 changed = 1;
210 }
211 }
212
213 if ((hcd->state == HC_STATE_SUSPENDED) && (changed == 1))
214 usb_hcd_resume_root_hub(hcd);
215
216done:
217 spin_unlock_irqrestore(&vhci->lock, flags);
218 return changed ? retval : 0;
219}
220
221static inline void hub_descriptor(struct usb_hub_descriptor *desc)
222{
223 memset(desc, 0, sizeof(*desc));
224 desc->bDescriptorType = USB_DT_HUB;
225 desc->bDescLength = 9;
226 desc->wHubCharacteristics = cpu_to_le16(
227 HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_COMMON_OCPM);
228 desc->bNbrPorts = VHCI_NPORTS;
229 desc->u.hs.DeviceRemovable[0] = 0xff;
230 desc->u.hs.DeviceRemovable[1] = 0xff;
231}
232
233static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
234 u16 wIndex, char *buf, u16 wLength)
235{
236 struct vhci_hcd *dum;
237 int retval = 0;
238 int rhport;
239 unsigned long flags;
240
241 u32 prev_port_status[VHCI_NPORTS];
242
243 if (!HCD_HW_ACCESSIBLE(hcd))
244 return -ETIMEDOUT;
245
246 /*
247 * NOTE:
248 * wIndex shows the port number and begins from 1.
249 */
250 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
251 wIndex);
252 if (wIndex > VHCI_NPORTS)
253 pr_err("invalid port number %d\n", wIndex);
254 rhport = ((__u8)(wIndex & 0x00ff)) - 1;
255
256 dum = hcd_to_vhci(hcd);
257
258 spin_lock_irqsave(&dum->lock, flags);
259
260 /* store old status and compare now and old later */
261 if (usbip_dbg_flag_vhci_rh) {
262 memcpy(prev_port_status, dum->port_status,
263 sizeof(prev_port_status));
264 }
265
266 switch (typeReq) {
267 case ClearHubFeature:
268 usbip_dbg_vhci_rh(" ClearHubFeature\n");
269 break;
270 case ClearPortFeature:
271 switch (wValue) {
272 case USB_PORT_FEAT_SUSPEND:
273 if (dum->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
274 /* 20msec signaling */
275 dum->resuming = 1;
276 dum->re_timeout =
277 jiffies + msecs_to_jiffies(20);
278 }
279 break;
280 case USB_PORT_FEAT_POWER:
281 usbip_dbg_vhci_rh(
282 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
283 dum->port_status[rhport] = 0;
284 dum->resuming = 0;
285 break;
286 case USB_PORT_FEAT_C_RESET:
287 usbip_dbg_vhci_rh(
288 " ClearPortFeature: USB_PORT_FEAT_C_RESET\n");
289 switch (dum->vdev[rhport].speed) {
290 case USB_SPEED_HIGH:
291 dum->port_status[rhport] |=
292 USB_PORT_STAT_HIGH_SPEED;
293 break;
294 case USB_SPEED_LOW:
295 dum->port_status[rhport] |=
296 USB_PORT_STAT_LOW_SPEED;
297 break;
298 default:
299 break;
300 }
301 default:
302 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
303 wValue);
304 dum->port_status[rhport] &= ~(1 << wValue);
305 break;
306 }
307 break;
308 case GetHubDescriptor:
309 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
310 hub_descriptor((struct usb_hub_descriptor *) buf);
311 break;
312 case GetHubStatus:
313 usbip_dbg_vhci_rh(" GetHubStatus\n");
314 *(__le32 *) buf = cpu_to_le32(0);
315 break;
316 case GetPortStatus:
317 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
318 if (wIndex > VHCI_NPORTS || wIndex < 1) {
319 pr_err("invalid port number %d\n", wIndex);
320 retval = -EPIPE;
321 }
322
323 /* we do not care about resume. */
324
325 /* whoever resets or resumes must GetPortStatus to
326 * complete it!!
327 */
328 if (dum->resuming && time_after(jiffies, dum->re_timeout)) {
329 dum->port_status[rhport] |=
330 (1 << USB_PORT_FEAT_C_SUSPEND);
331 dum->port_status[rhport] &=
332 ~(1 << USB_PORT_FEAT_SUSPEND);
333 dum->resuming = 0;
334 dum->re_timeout = 0;
335 }
336
337 if ((dum->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
338 0 && time_after(jiffies, dum->re_timeout)) {
339 dum->port_status[rhport] |=
340 (1 << USB_PORT_FEAT_C_RESET);
341 dum->port_status[rhport] &=
342 ~(1 << USB_PORT_FEAT_RESET);
343 dum->re_timeout = 0;
344
345 if (dum->vdev[rhport].ud.status ==
346 VDEV_ST_NOTASSIGNED) {
347 usbip_dbg_vhci_rh(
348 " enable rhport %d (status %u)\n",
349 rhport,
350 dum->vdev[rhport].ud.status);
351 dum->port_status[rhport] |=
352 USB_PORT_STAT_ENABLE;
353 }
354 }
355 ((__le16 *) buf)[0] = cpu_to_le16(dum->port_status[rhport]);
356 ((__le16 *) buf)[1] =
357 cpu_to_le16(dum->port_status[rhport] >> 16);
358
359 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
360 ((u16 *)buf)[1]);
361 break;
362 case SetHubFeature:
363 usbip_dbg_vhci_rh(" SetHubFeature\n");
364 retval = -EPIPE;
365 break;
366 case SetPortFeature:
367 switch (wValue) {
368 case USB_PORT_FEAT_SUSPEND:
369 usbip_dbg_vhci_rh(
370 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
371 break;
372 case USB_PORT_FEAT_RESET:
373 usbip_dbg_vhci_rh(
374 " SetPortFeature: USB_PORT_FEAT_RESET\n");
375 /* if it's already running, disconnect first */
376 if (dum->port_status[rhport] & USB_PORT_STAT_ENABLE) {
377 dum->port_status[rhport] &=
378 ~(USB_PORT_STAT_ENABLE |
379 USB_PORT_STAT_LOW_SPEED |
380 USB_PORT_STAT_HIGH_SPEED);
381 /* FIXME test that code path! */
382 }
383 /* 50msec reset signaling */
384 dum->re_timeout = jiffies + msecs_to_jiffies(50);
385
386 /* FALLTHROUGH */
387 default:
388 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
389 wValue);
390 dum->port_status[rhport] |= (1 << wValue);
391 break;
392 }
393 break;
394
395 default:
396 pr_err("default: no such request\n");
397
398 /* "protocol stall" on error */
399 retval = -EPIPE;
400 }
401
402 if (usbip_dbg_flag_vhci_rh) {
403 pr_debug("port %d\n", rhport);
404 /* Only dump valid port status */
405 if (rhport >= 0) {
406 dump_port_status_diff(prev_port_status[rhport],
407 dum->port_status[rhport]);
408 }
409 }
410 usbip_dbg_vhci_rh(" bye\n");
411
412 spin_unlock_irqrestore(&dum->lock, flags);
413
414 return retval;
415}
416
417static struct vhci_device *get_vdev(struct usb_device *udev)
418{
419 int i;
420
421 if (!udev)
422 return NULL;
423
424 for (i = 0; i < VHCI_NPORTS; i++)
425 if (the_controller->vdev[i].udev == udev)
426 return port_to_vdev(i);
427
428 return NULL;
429}
430
431static void vhci_tx_urb(struct urb *urb)
432{
433 struct vhci_device *vdev = get_vdev(urb->dev);
434 struct vhci_priv *priv;
435 unsigned long flags;
436
437 if (!vdev) {
438 pr_err("could not get virtual device");
439 return;
440 }
441
442 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
443 if (!priv) {
444 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
445 return;
446 }
447
448 spin_lock_irqsave(&vdev->priv_lock, flags);
449
450 priv->seqnum = atomic_inc_return(&the_controller->seqnum);
451 if (priv->seqnum == 0xffff)
452 dev_info(&urb->dev->dev, "seqnum max\n");
453
454 priv->vdev = vdev;
455 priv->urb = urb;
456
457 urb->hcpriv = (void *) priv;
458
459 list_add_tail(&priv->list, &vdev->priv_tx);
460
461 wake_up(&vdev->waitq_tx);
462 spin_unlock_irqrestore(&vdev->priv_lock, flags);
463}
464
465static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
466 gfp_t mem_flags)
467{
468 struct device *dev = &urb->dev->dev;
469 int ret = 0;
470 struct vhci_device *vdev;
471 unsigned long flags;
472
473 usbip_dbg_vhci_hc("enter, usb_hcd %p urb %p mem_flags %d\n",
474 hcd, urb, mem_flags);
475
476 /* patch to usb_sg_init() is in 2.5.60 */
477 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
478
479 spin_lock_irqsave(&the_controller->lock, flags);
480
481 if (urb->status != -EINPROGRESS) {
482 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
483 spin_unlock_irqrestore(&the_controller->lock, flags);
484 return urb->status;
485 }
486
487 vdev = port_to_vdev(urb->dev->portnum-1);
488
489 /* refuse enqueue for dead connection */
490 spin_lock(&vdev->ud.lock);
491 if (vdev->ud.status == VDEV_ST_NULL ||
492 vdev->ud.status == VDEV_ST_ERROR) {
493 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
494 spin_unlock(&vdev->ud.lock);
495 spin_unlock_irqrestore(&the_controller->lock, flags);
496 return -ENODEV;
497 }
498 spin_unlock(&vdev->ud.lock);
499
500 ret = usb_hcd_link_urb_to_ep(hcd, urb);
501 if (ret)
502 goto no_need_unlink;
503
504 /*
505 * The enumeration process is as follows;
506 *
507 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
508 * to get max packet length of default pipe
509 *
510 * 2. Set_Address request to DevAddr(0) EndPoint(0)
511 *
512 */
513 if (usb_pipedevice(urb->pipe) == 0) {
514 __u8 type = usb_pipetype(urb->pipe);
515 struct usb_ctrlrequest *ctrlreq =
516 (struct usb_ctrlrequest *) urb->setup_packet;
517
518 if (type != PIPE_CONTROL || !ctrlreq) {
519 dev_err(dev, "invalid request to devnum 0\n");
520 ret = -EINVAL;
521 goto no_need_xmit;
522 }
523
524 switch (ctrlreq->bRequest) {
525 case USB_REQ_SET_ADDRESS:
526 /* set_address may come when a device is reset */
527 dev_info(dev, "SetAddress Request (%d) to port %d\n",
528 ctrlreq->wValue, vdev->rhport);
529
530 usb_put_dev(vdev->udev);
531 vdev->udev = usb_get_dev(urb->dev);
532
533 spin_lock(&vdev->ud.lock);
534 vdev->ud.status = VDEV_ST_USED;
535 spin_unlock(&vdev->ud.lock);
536
537 if (urb->status == -EINPROGRESS) {
538 /* This request is successfully completed. */
539 /* If not -EINPROGRESS, possibly unlinked. */
540 urb->status = 0;
541 }
542
543 goto no_need_xmit;
544
545 case USB_REQ_GET_DESCRIPTOR:
546 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
547 usbip_dbg_vhci_hc(
548 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
549
550 usb_put_dev(vdev->udev);
551 vdev->udev = usb_get_dev(urb->dev);
552 goto out;
553
554 default:
555 /* NOT REACHED */
556 dev_err(dev,
557 "invalid request to devnum 0 bRequest %u, wValue %u\n",
558 ctrlreq->bRequest,
559 ctrlreq->wValue);
560 ret = -EINVAL;
561 goto no_need_xmit;
562 }
563
564 }
565
566out:
567 vhci_tx_urb(urb);
568 spin_unlock_irqrestore(&the_controller->lock, flags);
569
570 return 0;
571
572no_need_xmit:
573 usb_hcd_unlink_urb_from_ep(hcd, urb);
574no_need_unlink:
575 spin_unlock_irqrestore(&the_controller->lock, flags);
576 if (!ret)
577 usb_hcd_giveback_urb(vhci_to_hcd(the_controller),
578 urb, urb->status);
579 return ret;
580}
581
582/*
583 * vhci_rx gives back the urb after receiving the reply of the urb. If an
584 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
585 * back its urb. For the driver unlinking the urb, the content of the urb is
586 * not important, but the calling to its completion handler is important; the
587 * completion of unlinking is notified by the completion handler.
588 *
589 *
590 * CLIENT SIDE
591 *
592 * - When vhci_hcd receives RET_SUBMIT,
593 *
594 * - case 1a). the urb of the pdu is not unlinking.
595 * - normal case
596 * => just give back the urb
597 *
598 * - case 1b). the urb of the pdu is unlinking.
599 * - usbip.ko will return a reply of the unlinking request.
600 * => give back the urb now and go to case 2b).
601 *
602 * - When vhci_hcd receives RET_UNLINK,
603 *
604 * - case 2a). a submit request is still pending in vhci_hcd.
605 * - urb was really pending in usbip.ko and urb_unlink_urb() was
606 * completed there.
607 * => free a pending submit request
608 * => notify unlink completeness by giving back the urb
609 *
610 * - case 2b). a submit request is *not* pending in vhci_hcd.
611 * - urb was already given back to the core driver.
612 * => do not give back the urb
613 *
614 *
615 * SERVER SIDE
616 *
617 * - When usbip receives CMD_UNLINK,
618 *
619 * - case 3a). the urb of the unlink request is now in submission.
620 * => do usb_unlink_urb().
621 * => after the unlink is completed, send RET_UNLINK.
622 *
623 * - case 3b). the urb of the unlink request is not in submission.
624 * - may be already completed or never be received
625 * => send RET_UNLINK
626 *
627 */
628static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
629{
630 struct vhci_priv *priv;
631 struct vhci_device *vdev;
632 unsigned long flags;
633
634 pr_info("dequeue a urb %p\n", urb);
635
636 spin_lock_irqsave(&the_controller->lock, flags);
637
638 priv = urb->hcpriv;
639 if (!priv) {
640 /* URB was never linked! or will be soon given back by
641 * vhci_rx. */
642 spin_unlock_irqrestore(&the_controller->lock, flags);
643 return -EIDRM;
644 }
645
646 {
647 int ret = 0;
648
649 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
650 if (ret) {
651 spin_unlock_irqrestore(&the_controller->lock, flags);
652 return ret;
653 }
654 }
655
656 /* send unlink request here? */
657 vdev = priv->vdev;
658
659 if (!vdev->ud.tcp_socket) {
660 /* tcp connection is closed */
661 spin_lock(&vdev->priv_lock);
662
663 pr_info("device %p seems to be disconnected\n", vdev);
664 list_del(&priv->list);
665 kfree(priv);
666 urb->hcpriv = NULL;
667
668 spin_unlock(&vdev->priv_lock);
669
670 /*
671 * If tcp connection is alive, we have sent CMD_UNLINK.
672 * vhci_rx will receive RET_UNLINK and give back the URB.
673 * Otherwise, we give back it here.
674 */
675 pr_info("gives back urb %p\n", urb);
676
677 usb_hcd_unlink_urb_from_ep(hcd, urb);
678
679 spin_unlock_irqrestore(&the_controller->lock, flags);
680 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
681 urb->status);
682 spin_lock_irqsave(&the_controller->lock, flags);
683
684 } else {
685 /* tcp connection is alive */
686 struct vhci_unlink *unlink;
687
688 spin_lock(&vdev->priv_lock);
689
690 /* setup CMD_UNLINK pdu */
691 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
692 if (!unlink) {
693 spin_unlock(&vdev->priv_lock);
694 spin_unlock_irqrestore(&the_controller->lock, flags);
695 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
696 return -ENOMEM;
697 }
698
699 unlink->seqnum = atomic_inc_return(&the_controller->seqnum);
700 if (unlink->seqnum == 0xffff)
701 pr_info("seqnum max\n");
702
703 unlink->unlink_seqnum = priv->seqnum;
704
705 pr_info("device %p seems to be still connected\n", vdev);
706
707 /* send cmd_unlink and try to cancel the pending URB in the
708 * peer */
709 list_add_tail(&unlink->list, &vdev->unlink_tx);
710 wake_up(&vdev->waitq_tx);
711
712 spin_unlock(&vdev->priv_lock);
713 }
714
715 spin_unlock_irqrestore(&the_controller->lock, flags);
716
717 usbip_dbg_vhci_hc("leave\n");
718 return 0;
719}
720
721static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
722{
723 struct vhci_unlink *unlink, *tmp;
724 unsigned long flags;
725
726 spin_lock_irqsave(&the_controller->lock, flags);
727 spin_lock(&vdev->priv_lock);
728
729 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
730 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
731 list_del(&unlink->list);
732 kfree(unlink);
733 }
734
735 while (!list_empty(&vdev->unlink_rx)) {
736 struct urb *urb;
737
738 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
739 list);
740
741 /* give back URB of unanswered unlink request */
742 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
743
744 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
745 if (!urb) {
746 pr_info("the urb (seqnum %lu) was already given back\n",
747 unlink->unlink_seqnum);
748 list_del(&unlink->list);
749 kfree(unlink);
750 continue;
751 }
752
753 urb->status = -ENODEV;
754
755 usb_hcd_unlink_urb_from_ep(vhci_to_hcd(the_controller), urb);
756
757 list_del(&unlink->list);
758
759 spin_unlock(&vdev->priv_lock);
760 spin_unlock_irqrestore(&the_controller->lock, flags);
761
762 usb_hcd_giveback_urb(vhci_to_hcd(the_controller), urb,
763 urb->status);
764
765 spin_lock_irqsave(&the_controller->lock, flags);
766 spin_lock(&vdev->priv_lock);
767
768 kfree(unlink);
769 }
770
771 spin_unlock(&vdev->priv_lock);
772 spin_unlock_irqrestore(&the_controller->lock, flags);
773}
774
775/*
776 * The important thing is that only one context begins cleanup.
777 * This is why error handling and cleanup become simple.
778 * We do not want to consider race condition as possible.
779 */
780static void vhci_shutdown_connection(struct usbip_device *ud)
781{
782 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
783
784 /* need this? see stub_dev.c */
785 if (ud->tcp_socket) {
786 pr_debug("shutdown tcp_socket %p\n", ud->tcp_socket);
787 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
788 }
789
790 /* kill threads related to this sdev */
791 if (vdev->ud.tcp_rx) {
792 kthread_stop_put(vdev->ud.tcp_rx);
793 vdev->ud.tcp_rx = NULL;
794 }
795 if (vdev->ud.tcp_tx) {
796 kthread_stop_put(vdev->ud.tcp_tx);
797 vdev->ud.tcp_tx = NULL;
798 }
799 pr_info("stop threads\n");
800
801 /* active connection is closed */
802 if (vdev->ud.tcp_socket) {
803 sockfd_put(vdev->ud.tcp_socket);
804 vdev->ud.tcp_socket = NULL;
805 }
806 pr_info("release socket\n");
807
808 vhci_device_unlink_cleanup(vdev);
809
810 /*
811 * rh_port_disconnect() is a trigger of ...
812 * usb_disable_device():
813 * disable all the endpoints for a USB device.
814 * usb_disable_endpoint():
815 * disable endpoints. pending urbs are unlinked(dequeued).
816 *
817 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
818 * detached device should release used urbs in a cleanup function (i.e.
819 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
820 * pushed urbs and their private data in this function.
821 *
822 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
823 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
824 * gives back pushed urbs and frees their private data by request of
825 * the cleanup function of a USB driver. When unlinking a urb with an
826 * active connection, vhci_dequeue() does not give back the urb which
827 * is actually given back by vhci_rx after receiving its return pdu.
828 *
829 */
830 rh_port_disconnect(vdev->rhport);
831
832 pr_info("disconnect device\n");
833}
834
835
836static void vhci_device_reset(struct usbip_device *ud)
837{
838 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
839 unsigned long flags;
840
841 spin_lock_irqsave(&ud->lock, flags);
842
843 vdev->speed = 0;
844 vdev->devid = 0;
845
846 usb_put_dev(vdev->udev);
847 vdev->udev = NULL;
848
849 if (ud->tcp_socket) {
850 sockfd_put(ud->tcp_socket);
851 ud->tcp_socket = NULL;
852 }
853 ud->status = VDEV_ST_NULL;
854
855 spin_unlock_irqrestore(&ud->lock, flags);
856}
857
858static void vhci_device_unusable(struct usbip_device *ud)
859{
860 unsigned long flags;
861
862 spin_lock_irqsave(&ud->lock, flags);
863 ud->status = VDEV_ST_ERROR;
864 spin_unlock_irqrestore(&ud->lock, flags);
865}
866
867static void vhci_device_init(struct vhci_device *vdev)
868{
869 memset(vdev, 0, sizeof(*vdev));
870
871 vdev->ud.side = USBIP_VHCI;
872 vdev->ud.status = VDEV_ST_NULL;
873 spin_lock_init(&vdev->ud.lock);
874
875 INIT_LIST_HEAD(&vdev->priv_rx);
876 INIT_LIST_HEAD(&vdev->priv_tx);
877 INIT_LIST_HEAD(&vdev->unlink_tx);
878 INIT_LIST_HEAD(&vdev->unlink_rx);
879 spin_lock_init(&vdev->priv_lock);
880
881 init_waitqueue_head(&vdev->waitq_tx);
882
883 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
884 vdev->ud.eh_ops.reset = vhci_device_reset;
885 vdev->ud.eh_ops.unusable = vhci_device_unusable;
886
887 usbip_start_eh(&vdev->ud);
888}
889
890static int vhci_start(struct usb_hcd *hcd)
891{
892 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
893 int rhport;
894 int err = 0;
895
896 usbip_dbg_vhci_hc("enter vhci_start\n");
897
898 /* initialize private data of usb_hcd */
899
900 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
901 struct vhci_device *vdev = &vhci->vdev[rhport];
902
903 vhci_device_init(vdev);
904 vdev->rhport = rhport;
905 }
906
907 atomic_set(&vhci->seqnum, 0);
908 spin_lock_init(&vhci->lock);
909
910 hcd->power_budget = 0; /* no limit */
911 hcd->uses_new_polling = 1;
912
913 /* vhci_hcd is now ready to be controlled through sysfs */
914 err = sysfs_create_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
915 if (err) {
916 pr_err("create sysfs files\n");
917 return err;
918 }
919
920 return 0;
921}
922
923static void vhci_stop(struct usb_hcd *hcd)
924{
925 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
926 int rhport = 0;
927
928 usbip_dbg_vhci_hc("stop VHCI controller\n");
929
930 /* 1. remove the userland interface of vhci_hcd */
931 sysfs_remove_group(&vhci_dev(vhci)->kobj, &dev_attr_group);
932
933 /* 2. shutdown all the ports of vhci_hcd */
934 for (rhport = 0; rhport < VHCI_NPORTS; rhport++) {
935 struct vhci_device *vdev = &vhci->vdev[rhport];
936
937 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
938 usbip_stop_eh(&vdev->ud);
939 }
940}
941
942static int vhci_get_frame_number(struct usb_hcd *hcd)
943{
944 pr_err("Not yet implemented\n");
945 return 0;
946}
947
948#ifdef CONFIG_PM
949
950/* FIXME: suspend/resume */
951static int vhci_bus_suspend(struct usb_hcd *hcd)
952{
953 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
954 unsigned long flags;
955
956 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
957
958 spin_lock_irqsave(&vhci->lock, flags);
959 hcd->state = HC_STATE_SUSPENDED;
960 spin_unlock_irqrestore(&vhci->lock, flags);
961
962 return 0;
963}
964
965static int vhci_bus_resume(struct usb_hcd *hcd)
966{
967 struct vhci_hcd *vhci = hcd_to_vhci(hcd);
968 int rc = 0;
969 unsigned long flags;
970
971 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
972
973 spin_lock_irqsave(&vhci->lock, flags);
974 if (!HCD_HW_ACCESSIBLE(hcd))
975 rc = -ESHUTDOWN;
976 else
977 hcd->state = HC_STATE_RUNNING;
978 spin_unlock_irqrestore(&vhci->lock, flags);
979
980 return rc;
981}
982
983#else
984
985#define vhci_bus_suspend NULL
986#define vhci_bus_resume NULL
987#endif
988
989static struct hc_driver vhci_hc_driver = {
990 .description = driver_name,
991 .product_desc = driver_desc,
992 .hcd_priv_size = sizeof(struct vhci_hcd),
993
994 .flags = HCD_USB2,
995
996 .start = vhci_start,
997 .stop = vhci_stop,
998
999 .urb_enqueue = vhci_urb_enqueue,
1000 .urb_dequeue = vhci_urb_dequeue,
1001
1002 .get_frame_number = vhci_get_frame_number,
1003
1004 .hub_status_data = vhci_hub_status,
1005 .hub_control = vhci_hub_control,
1006 .bus_suspend = vhci_bus_suspend,
1007 .bus_resume = vhci_bus_resume,
1008};
1009
1010static int vhci_hcd_probe(struct platform_device *pdev)
1011{
1012 struct usb_hcd *hcd;
1013 int ret;
1014
1015 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1016
1017 /*
1018 * Allocate and initialize hcd.
1019 * Our private data is also allocated automatically.
1020 */
1021 hcd = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1022 if (!hcd) {
1023 pr_err("create hcd failed\n");
1024 return -ENOMEM;
1025 }
1026 hcd->has_tt = 1;
1027
1028 /* this is private data for vhci_hcd */
1029 the_controller = hcd_to_vhci(hcd);
1030
1031 /*
1032 * Finish generic HCD structure initialization and register.
1033 * Call the driver's reset() and start() routines.
1034 */
1035 ret = usb_add_hcd(hcd, 0, 0);
1036 if (ret != 0) {
1037 pr_err("usb_add_hcd failed %d\n", ret);
1038 usb_put_hcd(hcd);
1039 the_controller = NULL;
1040 return ret;
1041 }
1042
1043 usbip_dbg_vhci_hc("bye\n");
1044 return 0;
1045}
1046
1047static int vhci_hcd_remove(struct platform_device *pdev)
1048{
1049 struct usb_hcd *hcd;
1050
1051 hcd = platform_get_drvdata(pdev);
1052 if (!hcd)
1053 return 0;
1054
1055 /*
1056 * Disconnects the root hub,
1057 * then reverses the effects of usb_add_hcd(),
1058 * invoking the HCD's stop() methods.
1059 */
1060 usb_remove_hcd(hcd);
1061 usb_put_hcd(hcd);
1062 the_controller = NULL;
1063
1064 return 0;
1065}
1066
1067#ifdef CONFIG_PM
1068
1069/* what should happen for USB/IP under suspend/resume? */
1070static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1071{
1072 struct usb_hcd *hcd;
1073 int rhport = 0;
1074 int connected = 0;
1075 int ret = 0;
1076 unsigned long flags;
1077
1078 hcd = platform_get_drvdata(pdev);
1079
1080 spin_lock_irqsave(&the_controller->lock, flags);
1081
1082 for (rhport = 0; rhport < VHCI_NPORTS; rhport++)
1083 if (the_controller->port_status[rhport] &
1084 USB_PORT_STAT_CONNECTION)
1085 connected += 1;
1086
1087 spin_unlock_irqrestore(&the_controller->lock, flags);
1088
1089 if (connected > 0) {
1090 dev_info(&pdev->dev,
1091 "We have %d active connection%s. Do not suspend.\n",
1092 connected, (connected == 1 ? "" : "s"));
1093 ret = -EBUSY;
1094 } else {
1095 dev_info(&pdev->dev, "suspend vhci_hcd");
1096 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1097 }
1098
1099 return ret;
1100}
1101
1102static int vhci_hcd_resume(struct platform_device *pdev)
1103{
1104 struct usb_hcd *hcd;
1105
1106 dev_dbg(&pdev->dev, "%s\n", __func__);
1107
1108 hcd = platform_get_drvdata(pdev);
1109 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1110 usb_hcd_poll_rh_status(hcd);
1111
1112 return 0;
1113}
1114
1115#else
1116
1117#define vhci_hcd_suspend NULL
1118#define vhci_hcd_resume NULL
1119
1120#endif
1121
1122static struct platform_driver vhci_driver = {
1123 .probe = vhci_hcd_probe,
1124 .remove = vhci_hcd_remove,
1125 .suspend = vhci_hcd_suspend,
1126 .resume = vhci_hcd_resume,
1127 .driver = {
1128 .name = driver_name,
1129 },
1130};
1131
1132/*
1133 * The VHCI 'device' is 'virtual'; not a real plug&play hardware.
1134 * We need to add this virtual device as a platform device arbitrarily:
1135 * 1. platform_device_register()
1136 */
1137static void the_pdev_release(struct device *dev)
1138{
1139}
1140
1141static struct platform_device the_pdev = {
1142 /* should be the same name as driver_name */
1143 .name = driver_name,
1144 .id = -1,
1145 .dev = {
1146 .release = the_pdev_release,
1147 },
1148};
1149
1150static int __init vhci_hcd_init(void)
1151{
1152 int ret;
1153
1154 if (usb_disabled())
1155 return -ENODEV;
1156
1157 ret = platform_driver_register(&vhci_driver);
1158 if (ret)
1159 goto err_driver_register;
1160
1161 ret = platform_device_register(&the_pdev);
1162 if (ret)
1163 goto err_platform_device_register;
1164
1165 pr_info(DRIVER_DESC " v" USBIP_VERSION "\n");
1166 return ret;
1167
1168err_platform_device_register:
1169 platform_driver_unregister(&vhci_driver);
1170err_driver_register:
1171 return ret;
1172}
1173
1174static void __exit vhci_hcd_exit(void)
1175{
1176 platform_device_unregister(&the_pdev);
1177 platform_driver_unregister(&vhci_driver);
1178}
1179
1180module_init(vhci_hcd_init);
1181module_exit(vhci_hcd_exit);
1182
1183MODULE_AUTHOR(DRIVER_AUTHOR);
1184MODULE_DESCRIPTION(DRIVER_DESC);
1185MODULE_LICENSE("GPL");
1186MODULE_VERSION(USBIP_VERSION);
1// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Copyright (C) 2003-2008 Takahiro Hirofuchi
4 * Copyright (C) 2015-2016 Nobuo Iwata
5 */
6
7#include <linux/init.h>
8#include <linux/file.h>
9#include <linux/kernel.h>
10#include <linux/kthread.h>
11#include <linux/module.h>
12#include <linux/platform_device.h>
13#include <linux/slab.h>
14
15#include "usbip_common.h"
16#include "vhci.h"
17
18#define DRIVER_AUTHOR "Takahiro Hirofuchi"
19#define DRIVER_DESC "USB/IP 'Virtual' Host Controller (VHCI) Driver"
20
21/*
22 * TODO
23 * - update root hub emulation
24 * - move the emulation code to userland ?
25 * porting to other operating systems
26 * minimize kernel code
27 * - add suspend/resume code
28 * - clean up everything
29 */
30
31/* See usb gadget dummy hcd */
32
33static int vhci_hub_status(struct usb_hcd *hcd, char *buff);
34static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
35 u16 wIndex, char *buff, u16 wLength);
36static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb,
37 gfp_t mem_flags);
38static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
39static int vhci_start(struct usb_hcd *vhci_hcd);
40static void vhci_stop(struct usb_hcd *hcd);
41static int vhci_get_frame_number(struct usb_hcd *hcd);
42
43static const char driver_name[] = "vhci_hcd";
44static const char driver_desc[] = "USB/IP Virtual Host Controller";
45
46int vhci_num_controllers = VHCI_NR_HCS;
47struct vhci *vhcis;
48
49static const char * const bit_desc[] = {
50 "CONNECTION", /*0*/
51 "ENABLE", /*1*/
52 "SUSPEND", /*2*/
53 "OVER_CURRENT", /*3*/
54 "RESET", /*4*/
55 "L1", /*5*/
56 "R6", /*6*/
57 "R7", /*7*/
58 "POWER", /*8*/
59 "LOWSPEED", /*9*/
60 "HIGHSPEED", /*10*/
61 "PORT_TEST", /*11*/
62 "INDICATOR", /*12*/
63 "R13", /*13*/
64 "R14", /*14*/
65 "R15", /*15*/
66 "C_CONNECTION", /*16*/
67 "C_ENABLE", /*17*/
68 "C_SUSPEND", /*18*/
69 "C_OVER_CURRENT", /*19*/
70 "C_RESET", /*20*/
71 "C_L1", /*21*/
72 "R22", /*22*/
73 "R23", /*23*/
74 "R24", /*24*/
75 "R25", /*25*/
76 "R26", /*26*/
77 "R27", /*27*/
78 "R28", /*28*/
79 "R29", /*29*/
80 "R30", /*30*/
81 "R31", /*31*/
82};
83
84static const char * const bit_desc_ss[] = {
85 "CONNECTION", /*0*/
86 "ENABLE", /*1*/
87 "SUSPEND", /*2*/
88 "OVER_CURRENT", /*3*/
89 "RESET", /*4*/
90 "L1", /*5*/
91 "R6", /*6*/
92 "R7", /*7*/
93 "R8", /*8*/
94 "POWER", /*9*/
95 "HIGHSPEED", /*10*/
96 "PORT_TEST", /*11*/
97 "INDICATOR", /*12*/
98 "R13", /*13*/
99 "R14", /*14*/
100 "R15", /*15*/
101 "C_CONNECTION", /*16*/
102 "C_ENABLE", /*17*/
103 "C_SUSPEND", /*18*/
104 "C_OVER_CURRENT", /*19*/
105 "C_RESET", /*20*/
106 "C_BH_RESET", /*21*/
107 "C_LINK_STATE", /*22*/
108 "C_CONFIG_ERROR", /*23*/
109 "R24", /*24*/
110 "R25", /*25*/
111 "R26", /*26*/
112 "R27", /*27*/
113 "R28", /*28*/
114 "R29", /*29*/
115 "R30", /*30*/
116 "R31", /*31*/
117};
118
119static void dump_port_status_diff(u32 prev_status, u32 new_status, bool usb3)
120{
121 int i = 0;
122 u32 bit = 1;
123 const char * const *desc = bit_desc;
124
125 if (usb3)
126 desc = bit_desc_ss;
127
128 pr_debug("status prev -> new: %08x -> %08x\n", prev_status, new_status);
129 while (bit) {
130 u32 prev = prev_status & bit;
131 u32 new = new_status & bit;
132 char change;
133
134 if (!prev && new)
135 change = '+';
136 else if (prev && !new)
137 change = '-';
138 else
139 change = ' ';
140
141 if (prev || new) {
142 pr_debug(" %c%s\n", change, desc[i]);
143
144 if (bit == 1) /* USB_PORT_STAT_CONNECTION */
145 pr_debug(" %c%s\n", change, "USB_PORT_STAT_SPEED_5GBPS");
146 }
147 bit <<= 1;
148 i++;
149 }
150 pr_debug("\n");
151}
152
153void rh_port_connect(struct vhci_device *vdev, enum usb_device_speed speed)
154{
155 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
156 struct vhci *vhci = vhci_hcd->vhci;
157 int rhport = vdev->rhport;
158 u32 status;
159 unsigned long flags;
160
161 usbip_dbg_vhci_rh("rh_port_connect %d\n", rhport);
162
163 spin_lock_irqsave(&vhci->lock, flags);
164
165 status = vhci_hcd->port_status[rhport];
166
167 status |= USB_PORT_STAT_CONNECTION | (1 << USB_PORT_FEAT_C_CONNECTION);
168
169 switch (speed) {
170 case USB_SPEED_HIGH:
171 status |= USB_PORT_STAT_HIGH_SPEED;
172 break;
173 case USB_SPEED_LOW:
174 status |= USB_PORT_STAT_LOW_SPEED;
175 break;
176 default:
177 break;
178 }
179
180 vhci_hcd->port_status[rhport] = status;
181
182 spin_unlock_irqrestore(&vhci->lock, flags);
183
184 usb_hcd_poll_rh_status(vhci_hcd_to_hcd(vhci_hcd));
185}
186
187static void rh_port_disconnect(struct vhci_device *vdev)
188{
189 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
190 struct vhci *vhci = vhci_hcd->vhci;
191 int rhport = vdev->rhport;
192 u32 status;
193 unsigned long flags;
194
195 usbip_dbg_vhci_rh("rh_port_disconnect %d\n", rhport);
196
197 spin_lock_irqsave(&vhci->lock, flags);
198
199 status = vhci_hcd->port_status[rhport];
200
201 status &= ~USB_PORT_STAT_CONNECTION;
202 status |= (1 << USB_PORT_FEAT_C_CONNECTION);
203
204 vhci_hcd->port_status[rhport] = status;
205
206 spin_unlock_irqrestore(&vhci->lock, flags);
207 usb_hcd_poll_rh_status(vhci_hcd_to_hcd(vhci_hcd));
208}
209
210#define PORT_C_MASK \
211 ((USB_PORT_STAT_C_CONNECTION \
212 | USB_PORT_STAT_C_ENABLE \
213 | USB_PORT_STAT_C_SUSPEND \
214 | USB_PORT_STAT_C_OVERCURRENT \
215 | USB_PORT_STAT_C_RESET) << 16)
216
217/*
218 * Returns 0 if the status hasn't changed, or the number of bytes in buf.
219 * Ports are 0-indexed from the HCD point of view,
220 * and 1-indexed from the USB core pointer of view.
221 *
222 * @buf: a bitmap to show which port status has been changed.
223 * bit 0: reserved
224 * bit 1: the status of port 0 has been changed.
225 * bit 2: the status of port 1 has been changed.
226 * ...
227 */
228static int vhci_hub_status(struct usb_hcd *hcd, char *buf)
229{
230 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
231 struct vhci *vhci = vhci_hcd->vhci;
232 int retval = DIV_ROUND_UP(VHCI_HC_PORTS + 1, 8);
233 int rhport;
234 int changed = 0;
235 unsigned long flags;
236
237 memset(buf, 0, retval);
238
239 spin_lock_irqsave(&vhci->lock, flags);
240 if (!HCD_HW_ACCESSIBLE(hcd)) {
241 usbip_dbg_vhci_rh("hw accessible flag not on?\n");
242 goto done;
243 }
244
245 /* check pseudo status register for each port */
246 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
247 if ((vhci_hcd->port_status[rhport] & PORT_C_MASK)) {
248 /* The status of a port has been changed, */
249 usbip_dbg_vhci_rh("port %d status changed\n", rhport);
250
251 buf[(rhport + 1) / 8] |= 1 << (rhport + 1) % 8;
252 changed = 1;
253 }
254 }
255
256 if ((hcd->state == HC_STATE_SUSPENDED) && (changed == 1))
257 usb_hcd_resume_root_hub(hcd);
258
259done:
260 spin_unlock_irqrestore(&vhci->lock, flags);
261 return changed ? retval : 0;
262}
263
264/* usb 3.0 root hub device descriptor */
265static struct {
266 struct usb_bos_descriptor bos;
267 struct usb_ss_cap_descriptor ss_cap;
268} __packed usb3_bos_desc = {
269
270 .bos = {
271 .bLength = USB_DT_BOS_SIZE,
272 .bDescriptorType = USB_DT_BOS,
273 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
274 .bNumDeviceCaps = 1,
275 },
276 .ss_cap = {
277 .bLength = USB_DT_USB_SS_CAP_SIZE,
278 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
279 .bDevCapabilityType = USB_SS_CAP_TYPE,
280 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
281 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
282 },
283};
284
285static inline void
286ss_hub_descriptor(struct usb_hub_descriptor *desc)
287{
288 memset(desc, 0, sizeof *desc);
289 desc->bDescriptorType = USB_DT_SS_HUB;
290 desc->bDescLength = 12;
291 desc->wHubCharacteristics = cpu_to_le16(
292 HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_COMMON_OCPM);
293 desc->bNbrPorts = VHCI_HC_PORTS;
294 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
295 desc->u.ss.DeviceRemovable = 0xffff;
296}
297
298static inline void hub_descriptor(struct usb_hub_descriptor *desc)
299{
300 int width;
301
302 memset(desc, 0, sizeof(*desc));
303 desc->bDescriptorType = USB_DT_HUB;
304 desc->wHubCharacteristics = cpu_to_le16(
305 HUB_CHAR_INDV_PORT_LPSM | HUB_CHAR_COMMON_OCPM);
306
307 desc->bNbrPorts = VHCI_HC_PORTS;
308 BUILD_BUG_ON(VHCI_HC_PORTS > USB_MAXCHILDREN);
309 width = desc->bNbrPorts / 8 + 1;
310 desc->bDescLength = USB_DT_HUB_NONVAR_SIZE + 2 * width;
311 memset(&desc->u.hs.DeviceRemovable[0], 0, width);
312 memset(&desc->u.hs.DeviceRemovable[width], 0xff, width);
313}
314
315static int vhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue,
316 u16 wIndex, char *buf, u16 wLength)
317{
318 struct vhci_hcd *vhci_hcd;
319 struct vhci *vhci;
320 int retval = 0;
321 int rhport = -1;
322 unsigned long flags;
323 bool invalid_rhport = false;
324
325 u32 prev_port_status[VHCI_HC_PORTS];
326
327 if (!HCD_HW_ACCESSIBLE(hcd))
328 return -ETIMEDOUT;
329
330 /*
331 * NOTE:
332 * wIndex (bits 0-7) shows the port number and begins from 1?
333 */
334 wIndex = ((__u8)(wIndex & 0x00ff));
335 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
336 wIndex);
337
338 /*
339 * wIndex can be 0 for some request types (typeReq). rhport is
340 * in valid range when wIndex >= 1 and < VHCI_HC_PORTS.
341 *
342 * Reference port_status[] only with valid rhport when
343 * invalid_rhport is false.
344 */
345 if (wIndex < 1 || wIndex > VHCI_HC_PORTS) {
346 invalid_rhport = true;
347 if (wIndex > VHCI_HC_PORTS)
348 pr_err("invalid port number %d\n", wIndex);
349 } else
350 rhport = wIndex - 1;
351
352 vhci_hcd = hcd_to_vhci_hcd(hcd);
353 vhci = vhci_hcd->vhci;
354
355 spin_lock_irqsave(&vhci->lock, flags);
356
357 /* store old status and compare now and old later */
358 if (usbip_dbg_flag_vhci_rh) {
359 if (!invalid_rhport)
360 memcpy(prev_port_status, vhci_hcd->port_status,
361 sizeof(prev_port_status));
362 }
363
364 switch (typeReq) {
365 case ClearHubFeature:
366 usbip_dbg_vhci_rh(" ClearHubFeature\n");
367 break;
368 case ClearPortFeature:
369 if (invalid_rhport) {
370 pr_err("invalid port number %d\n", wIndex);
371 goto error;
372 }
373 switch (wValue) {
374 case USB_PORT_FEAT_SUSPEND:
375 if (hcd->speed == HCD_USB3) {
376 pr_err(" ClearPortFeature: USB_PORT_FEAT_SUSPEND req not "
377 "supported for USB 3.0 roothub\n");
378 goto error;
379 }
380 usbip_dbg_vhci_rh(
381 " ClearPortFeature: USB_PORT_FEAT_SUSPEND\n");
382 if (vhci_hcd->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
383 /* 20msec signaling */
384 vhci_hcd->resuming = 1;
385 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
386 }
387 break;
388 case USB_PORT_FEAT_POWER:
389 usbip_dbg_vhci_rh(
390 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
391 if (hcd->speed == HCD_USB3)
392 vhci_hcd->port_status[rhport] &= ~USB_SS_PORT_STAT_POWER;
393 else
394 vhci_hcd->port_status[rhport] &= ~USB_PORT_STAT_POWER;
395 break;
396 default:
397 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
398 wValue);
399 vhci_hcd->port_status[rhport] &= ~(1 << wValue);
400 break;
401 }
402 break;
403 case GetHubDescriptor:
404 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
405 if (hcd->speed == HCD_USB3 &&
406 (wLength < USB_DT_SS_HUB_SIZE ||
407 wValue != (USB_DT_SS_HUB << 8))) {
408 pr_err("Wrong hub descriptor type for USB 3.0 roothub.\n");
409 goto error;
410 }
411 if (hcd->speed == HCD_USB3)
412 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
413 else
414 hub_descriptor((struct usb_hub_descriptor *) buf);
415 break;
416 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
417 if (hcd->speed != HCD_USB3)
418 goto error;
419
420 if ((wValue >> 8) != USB_DT_BOS)
421 goto error;
422
423 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
424 retval = sizeof(usb3_bos_desc);
425 break;
426 case GetHubStatus:
427 usbip_dbg_vhci_rh(" GetHubStatus\n");
428 *(__le32 *) buf = cpu_to_le32(0);
429 break;
430 case GetPortStatus:
431 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
432 if (invalid_rhport) {
433 pr_err("invalid port number %d\n", wIndex);
434 retval = -EPIPE;
435 goto error;
436 }
437
438 /* we do not care about resume. */
439
440 /* whoever resets or resumes must GetPortStatus to
441 * complete it!!
442 */
443 if (vhci_hcd->resuming && time_after(jiffies, vhci_hcd->re_timeout)) {
444 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_SUSPEND);
445 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_SUSPEND);
446 vhci_hcd->resuming = 0;
447 vhci_hcd->re_timeout = 0;
448 }
449
450 if ((vhci_hcd->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
451 0 && time_after(jiffies, vhci_hcd->re_timeout)) {
452 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_RESET);
453 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_RESET);
454 vhci_hcd->re_timeout = 0;
455
456 if (vhci_hcd->vdev[rhport].ud.status ==
457 VDEV_ST_NOTASSIGNED) {
458 usbip_dbg_vhci_rh(
459 " enable rhport %d (status %u)\n",
460 rhport,
461 vhci_hcd->vdev[rhport].ud.status);
462 vhci_hcd->port_status[rhport] |=
463 USB_PORT_STAT_ENABLE;
464 }
465
466 if (hcd->speed < HCD_USB3) {
467 switch (vhci_hcd->vdev[rhport].speed) {
468 case USB_SPEED_HIGH:
469 vhci_hcd->port_status[rhport] |=
470 USB_PORT_STAT_HIGH_SPEED;
471 break;
472 case USB_SPEED_LOW:
473 vhci_hcd->port_status[rhport] |=
474 USB_PORT_STAT_LOW_SPEED;
475 break;
476 default:
477 pr_err("vhci_device speed not set\n");
478 break;
479 }
480 }
481 }
482 ((__le16 *) buf)[0] = cpu_to_le16(vhci_hcd->port_status[rhport]);
483 ((__le16 *) buf)[1] =
484 cpu_to_le16(vhci_hcd->port_status[rhport] >> 16);
485
486 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
487 ((u16 *)buf)[1]);
488 break;
489 case SetHubFeature:
490 usbip_dbg_vhci_rh(" SetHubFeature\n");
491 retval = -EPIPE;
492 break;
493 case SetPortFeature:
494 switch (wValue) {
495 case USB_PORT_FEAT_LINK_STATE:
496 usbip_dbg_vhci_rh(
497 " SetPortFeature: USB_PORT_FEAT_LINK_STATE\n");
498 if (hcd->speed != HCD_USB3) {
499 pr_err("USB_PORT_FEAT_LINK_STATE req not "
500 "supported for USB 2.0 roothub\n");
501 goto error;
502 }
503 /*
504 * Since this is dummy we don't have an actual link so
505 * there is nothing to do for the SET_LINK_STATE cmd
506 */
507 break;
508 case USB_PORT_FEAT_U1_TIMEOUT:
509 usbip_dbg_vhci_rh(
510 " SetPortFeature: USB_PORT_FEAT_U1_TIMEOUT\n");
511 fallthrough;
512 case USB_PORT_FEAT_U2_TIMEOUT:
513 usbip_dbg_vhci_rh(
514 " SetPortFeature: USB_PORT_FEAT_U2_TIMEOUT\n");
515 /* TODO: add suspend/resume support! */
516 if (hcd->speed != HCD_USB3) {
517 pr_err("USB_PORT_FEAT_U1/2_TIMEOUT req not "
518 "supported for USB 2.0 roothub\n");
519 goto error;
520 }
521 break;
522 case USB_PORT_FEAT_SUSPEND:
523 usbip_dbg_vhci_rh(
524 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
525 /* Applicable only for USB2.0 hub */
526 if (hcd->speed == HCD_USB3) {
527 pr_err("USB_PORT_FEAT_SUSPEND req not "
528 "supported for USB 3.0 roothub\n");
529 goto error;
530 }
531
532 if (invalid_rhport) {
533 pr_err("invalid port number %d\n", wIndex);
534 goto error;
535 }
536
537 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_SUSPEND;
538 break;
539 case USB_PORT_FEAT_POWER:
540 usbip_dbg_vhci_rh(
541 " SetPortFeature: USB_PORT_FEAT_POWER\n");
542 if (invalid_rhport) {
543 pr_err("invalid port number %d\n", wIndex);
544 goto error;
545 }
546 if (hcd->speed == HCD_USB3)
547 vhci_hcd->port_status[rhport] |= USB_SS_PORT_STAT_POWER;
548 else
549 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_POWER;
550 break;
551 case USB_PORT_FEAT_BH_PORT_RESET:
552 usbip_dbg_vhci_rh(
553 " SetPortFeature: USB_PORT_FEAT_BH_PORT_RESET\n");
554 if (invalid_rhport) {
555 pr_err("invalid port number %d\n", wIndex);
556 goto error;
557 }
558 /* Applicable only for USB3.0 hub */
559 if (hcd->speed != HCD_USB3) {
560 pr_err("USB_PORT_FEAT_BH_PORT_RESET req not "
561 "supported for USB 2.0 roothub\n");
562 goto error;
563 }
564 fallthrough;
565 case USB_PORT_FEAT_RESET:
566 usbip_dbg_vhci_rh(
567 " SetPortFeature: USB_PORT_FEAT_RESET\n");
568 if (invalid_rhport) {
569 pr_err("invalid port number %d\n", wIndex);
570 goto error;
571 }
572 /* if it's already enabled, disable */
573 if (hcd->speed == HCD_USB3) {
574 vhci_hcd->port_status[rhport] = 0;
575 vhci_hcd->port_status[rhport] =
576 (USB_SS_PORT_STAT_POWER |
577 USB_PORT_STAT_CONNECTION |
578 USB_PORT_STAT_RESET);
579 } else if (vhci_hcd->port_status[rhport] & USB_PORT_STAT_ENABLE) {
580 vhci_hcd->port_status[rhport] &= ~(USB_PORT_STAT_ENABLE
581 | USB_PORT_STAT_LOW_SPEED
582 | USB_PORT_STAT_HIGH_SPEED);
583 }
584
585 /* 50msec reset signaling */
586 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
587 fallthrough;
588 default:
589 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
590 wValue);
591 if (invalid_rhport) {
592 pr_err("invalid port number %d\n", wIndex);
593 goto error;
594 }
595 if (hcd->speed == HCD_USB3) {
596 if ((vhci_hcd->port_status[rhport] &
597 USB_SS_PORT_STAT_POWER) != 0) {
598 vhci_hcd->port_status[rhport] |= (1 << wValue);
599 }
600 } else
601 if ((vhci_hcd->port_status[rhport] &
602 USB_PORT_STAT_POWER) != 0) {
603 vhci_hcd->port_status[rhport] |= (1 << wValue);
604 }
605 }
606 break;
607 case GetPortErrorCount:
608 usbip_dbg_vhci_rh(" GetPortErrorCount\n");
609 if (hcd->speed != HCD_USB3) {
610 pr_err("GetPortErrorCount req not "
611 "supported for USB 2.0 roothub\n");
612 goto error;
613 }
614 /* We'll always return 0 since this is a dummy hub */
615 *(__le32 *) buf = cpu_to_le32(0);
616 break;
617 case SetHubDepth:
618 usbip_dbg_vhci_rh(" SetHubDepth\n");
619 if (hcd->speed != HCD_USB3) {
620 pr_err("SetHubDepth req not supported for "
621 "USB 2.0 roothub\n");
622 goto error;
623 }
624 break;
625 default:
626 pr_err("default hub control req: %04x v%04x i%04x l%d\n",
627 typeReq, wValue, wIndex, wLength);
628error:
629 /* "protocol stall" on error */
630 retval = -EPIPE;
631 }
632
633 if (usbip_dbg_flag_vhci_rh) {
634 pr_debug("port %d\n", rhport);
635 /* Only dump valid port status */
636 if (!invalid_rhport) {
637 dump_port_status_diff(prev_port_status[rhport],
638 vhci_hcd->port_status[rhport],
639 hcd->speed == HCD_USB3);
640 }
641 }
642 usbip_dbg_vhci_rh(" bye\n");
643
644 spin_unlock_irqrestore(&vhci->lock, flags);
645
646 if (!invalid_rhport &&
647 (vhci_hcd->port_status[rhport] & PORT_C_MASK) != 0) {
648 usb_hcd_poll_rh_status(hcd);
649 }
650
651 return retval;
652}
653
654static void vhci_tx_urb(struct urb *urb, struct vhci_device *vdev)
655{
656 struct vhci_priv *priv;
657 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
658 unsigned long flags;
659
660 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
661 if (!priv) {
662 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
663 return;
664 }
665
666 spin_lock_irqsave(&vdev->priv_lock, flags);
667
668 priv->seqnum = atomic_inc_return(&vhci_hcd->seqnum);
669 if (priv->seqnum == 0xffff)
670 dev_info(&urb->dev->dev, "seqnum max\n");
671
672 priv->vdev = vdev;
673 priv->urb = urb;
674
675 urb->hcpriv = (void *) priv;
676
677 list_add_tail(&priv->list, &vdev->priv_tx);
678
679 wake_up(&vdev->waitq_tx);
680 spin_unlock_irqrestore(&vdev->priv_lock, flags);
681}
682
683static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags)
684{
685 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
686 struct vhci *vhci = vhci_hcd->vhci;
687 struct device *dev = &urb->dev->dev;
688 u8 portnum = urb->dev->portnum;
689 int ret = 0;
690 struct vhci_device *vdev;
691 unsigned long flags;
692
693 if (portnum > VHCI_HC_PORTS) {
694 pr_err("invalid port number %d\n", portnum);
695 return -ENODEV;
696 }
697 vdev = &vhci_hcd->vdev[portnum-1];
698
699 if (!urb->transfer_buffer && !urb->num_sgs &&
700 urb->transfer_buffer_length) {
701 dev_dbg(dev, "Null URB transfer buffer\n");
702 return -EINVAL;
703 }
704
705 spin_lock_irqsave(&vhci->lock, flags);
706
707 if (urb->status != -EINPROGRESS) {
708 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
709 spin_unlock_irqrestore(&vhci->lock, flags);
710 return urb->status;
711 }
712
713 /* refuse enqueue for dead connection */
714 spin_lock(&vdev->ud.lock);
715 if (vdev->ud.status == VDEV_ST_NULL ||
716 vdev->ud.status == VDEV_ST_ERROR) {
717 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
718 spin_unlock(&vdev->ud.lock);
719 spin_unlock_irqrestore(&vhci->lock, flags);
720 return -ENODEV;
721 }
722 spin_unlock(&vdev->ud.lock);
723
724 ret = usb_hcd_link_urb_to_ep(hcd, urb);
725 if (ret)
726 goto no_need_unlink;
727
728 /*
729 * The enumeration process is as follows;
730 *
731 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
732 * to get max packet length of default pipe
733 *
734 * 2. Set_Address request to DevAddr(0) EndPoint(0)
735 *
736 */
737 if (usb_pipedevice(urb->pipe) == 0) {
738 __u8 type = usb_pipetype(urb->pipe);
739 struct usb_ctrlrequest *ctrlreq =
740 (struct usb_ctrlrequest *) urb->setup_packet;
741
742 if (type != PIPE_CONTROL || !ctrlreq) {
743 dev_err(dev, "invalid request to devnum 0\n");
744 ret = -EINVAL;
745 goto no_need_xmit;
746 }
747
748 switch (ctrlreq->bRequest) {
749 case USB_REQ_SET_ADDRESS:
750 /* set_address may come when a device is reset */
751 dev_info(dev, "SetAddress Request (%d) to port %d\n",
752 ctrlreq->wValue, vdev->rhport);
753
754 usb_put_dev(vdev->udev);
755 vdev->udev = usb_get_dev(urb->dev);
756
757 spin_lock(&vdev->ud.lock);
758 vdev->ud.status = VDEV_ST_USED;
759 spin_unlock(&vdev->ud.lock);
760
761 if (urb->status == -EINPROGRESS) {
762 /* This request is successfully completed. */
763 /* If not -EINPROGRESS, possibly unlinked. */
764 urb->status = 0;
765 }
766
767 goto no_need_xmit;
768
769 case USB_REQ_GET_DESCRIPTOR:
770 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
771 usbip_dbg_vhci_hc(
772 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
773
774 usb_put_dev(vdev->udev);
775 vdev->udev = usb_get_dev(urb->dev);
776 goto out;
777
778 default:
779 /* NOT REACHED */
780 dev_err(dev,
781 "invalid request to devnum 0 bRequest %u, wValue %u\n",
782 ctrlreq->bRequest,
783 ctrlreq->wValue);
784 ret = -EINVAL;
785 goto no_need_xmit;
786 }
787
788 }
789
790out:
791 vhci_tx_urb(urb, vdev);
792 spin_unlock_irqrestore(&vhci->lock, flags);
793
794 return 0;
795
796no_need_xmit:
797 usb_hcd_unlink_urb_from_ep(hcd, urb);
798no_need_unlink:
799 spin_unlock_irqrestore(&vhci->lock, flags);
800 if (!ret)
801 usb_hcd_giveback_urb(hcd, urb, urb->status);
802 return ret;
803}
804
805/*
806 * vhci_rx gives back the urb after receiving the reply of the urb. If an
807 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
808 * back its urb. For the driver unlinking the urb, the content of the urb is
809 * not important, but the calling to its completion handler is important; the
810 * completion of unlinking is notified by the completion handler.
811 *
812 *
813 * CLIENT SIDE
814 *
815 * - When vhci_hcd receives RET_SUBMIT,
816 *
817 * - case 1a). the urb of the pdu is not unlinking.
818 * - normal case
819 * => just give back the urb
820 *
821 * - case 1b). the urb of the pdu is unlinking.
822 * - usbip.ko will return a reply of the unlinking request.
823 * => give back the urb now and go to case 2b).
824 *
825 * - When vhci_hcd receives RET_UNLINK,
826 *
827 * - case 2a). a submit request is still pending in vhci_hcd.
828 * - urb was really pending in usbip.ko and urb_unlink_urb() was
829 * completed there.
830 * => free a pending submit request
831 * => notify unlink completeness by giving back the urb
832 *
833 * - case 2b). a submit request is *not* pending in vhci_hcd.
834 * - urb was already given back to the core driver.
835 * => do not give back the urb
836 *
837 *
838 * SERVER SIDE
839 *
840 * - When usbip receives CMD_UNLINK,
841 *
842 * - case 3a). the urb of the unlink request is now in submission.
843 * => do usb_unlink_urb().
844 * => after the unlink is completed, send RET_UNLINK.
845 *
846 * - case 3b). the urb of the unlink request is not in submission.
847 * - may be already completed or never be received
848 * => send RET_UNLINK
849 *
850 */
851static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
852{
853 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
854 struct vhci *vhci = vhci_hcd->vhci;
855 struct vhci_priv *priv;
856 struct vhci_device *vdev;
857 unsigned long flags;
858
859 spin_lock_irqsave(&vhci->lock, flags);
860
861 priv = urb->hcpriv;
862 if (!priv) {
863 /* URB was never linked! or will be soon given back by
864 * vhci_rx. */
865 spin_unlock_irqrestore(&vhci->lock, flags);
866 return -EIDRM;
867 }
868
869 {
870 int ret = 0;
871
872 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
873 if (ret) {
874 spin_unlock_irqrestore(&vhci->lock, flags);
875 return ret;
876 }
877 }
878
879 /* send unlink request here? */
880 vdev = priv->vdev;
881
882 if (!vdev->ud.tcp_socket) {
883 /* tcp connection is closed */
884 spin_lock(&vdev->priv_lock);
885
886 list_del(&priv->list);
887 kfree(priv);
888 urb->hcpriv = NULL;
889
890 spin_unlock(&vdev->priv_lock);
891
892 /*
893 * If tcp connection is alive, we have sent CMD_UNLINK.
894 * vhci_rx will receive RET_UNLINK and give back the URB.
895 * Otherwise, we give back it here.
896 */
897 usb_hcd_unlink_urb_from_ep(hcd, urb);
898
899 spin_unlock_irqrestore(&vhci->lock, flags);
900 usb_hcd_giveback_urb(hcd, urb, urb->status);
901 spin_lock_irqsave(&vhci->lock, flags);
902
903 } else {
904 /* tcp connection is alive */
905 struct vhci_unlink *unlink;
906
907 spin_lock(&vdev->priv_lock);
908
909 /* setup CMD_UNLINK pdu */
910 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
911 if (!unlink) {
912 spin_unlock(&vdev->priv_lock);
913 spin_unlock_irqrestore(&vhci->lock, flags);
914 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
915 return -ENOMEM;
916 }
917
918 unlink->seqnum = atomic_inc_return(&vhci_hcd->seqnum);
919 if (unlink->seqnum == 0xffff)
920 pr_info("seqnum max\n");
921
922 unlink->unlink_seqnum = priv->seqnum;
923
924 /* send cmd_unlink and try to cancel the pending URB in the
925 * peer */
926 list_add_tail(&unlink->list, &vdev->unlink_tx);
927 wake_up(&vdev->waitq_tx);
928
929 spin_unlock(&vdev->priv_lock);
930 }
931
932 spin_unlock_irqrestore(&vhci->lock, flags);
933
934 usbip_dbg_vhci_hc("leave\n");
935 return 0;
936}
937
938static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
939{
940 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
941 struct usb_hcd *hcd = vhci_hcd_to_hcd(vhci_hcd);
942 struct vhci *vhci = vhci_hcd->vhci;
943 struct vhci_unlink *unlink, *tmp;
944 unsigned long flags;
945
946 spin_lock_irqsave(&vhci->lock, flags);
947 spin_lock(&vdev->priv_lock);
948
949 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
950 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
951 list_del(&unlink->list);
952 kfree(unlink);
953 }
954
955 while (!list_empty(&vdev->unlink_rx)) {
956 struct urb *urb;
957
958 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
959 list);
960
961 /* give back URB of unanswered unlink request */
962 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
963
964 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
965 if (!urb) {
966 pr_info("the urb (seqnum %lu) was already given back\n",
967 unlink->unlink_seqnum);
968 list_del(&unlink->list);
969 kfree(unlink);
970 continue;
971 }
972
973 urb->status = -ENODEV;
974
975 usb_hcd_unlink_urb_from_ep(hcd, urb);
976
977 list_del(&unlink->list);
978
979 spin_unlock(&vdev->priv_lock);
980 spin_unlock_irqrestore(&vhci->lock, flags);
981
982 usb_hcd_giveback_urb(hcd, urb, urb->status);
983
984 spin_lock_irqsave(&vhci->lock, flags);
985 spin_lock(&vdev->priv_lock);
986
987 kfree(unlink);
988 }
989
990 spin_unlock(&vdev->priv_lock);
991 spin_unlock_irqrestore(&vhci->lock, flags);
992}
993
994/*
995 * The important thing is that only one context begins cleanup.
996 * This is why error handling and cleanup become simple.
997 * We do not want to consider race condition as possible.
998 */
999static void vhci_shutdown_connection(struct usbip_device *ud)
1000{
1001 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
1002
1003 /* need this? see stub_dev.c */
1004 if (ud->tcp_socket) {
1005 pr_debug("shutdown tcp_socket %d\n", ud->sockfd);
1006 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
1007 }
1008
1009 /* kill threads related to this sdev */
1010 if (vdev->ud.tcp_rx) {
1011 kthread_stop_put(vdev->ud.tcp_rx);
1012 vdev->ud.tcp_rx = NULL;
1013 }
1014 if (vdev->ud.tcp_tx) {
1015 kthread_stop_put(vdev->ud.tcp_tx);
1016 vdev->ud.tcp_tx = NULL;
1017 }
1018 pr_info("stop threads\n");
1019
1020 /* active connection is closed */
1021 if (vdev->ud.tcp_socket) {
1022 sockfd_put(vdev->ud.tcp_socket);
1023 vdev->ud.tcp_socket = NULL;
1024 vdev->ud.sockfd = -1;
1025 }
1026 pr_info("release socket\n");
1027
1028 vhci_device_unlink_cleanup(vdev);
1029
1030 /*
1031 * rh_port_disconnect() is a trigger of ...
1032 * usb_disable_device():
1033 * disable all the endpoints for a USB device.
1034 * usb_disable_endpoint():
1035 * disable endpoints. pending urbs are unlinked(dequeued).
1036 *
1037 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
1038 * detached device should release used urbs in a cleanup function (i.e.
1039 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
1040 * pushed urbs and their private data in this function.
1041 *
1042 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
1043 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
1044 * gives back pushed urbs and frees their private data by request of
1045 * the cleanup function of a USB driver. When unlinking a urb with an
1046 * active connection, vhci_dequeue() does not give back the urb which
1047 * is actually given back by vhci_rx after receiving its return pdu.
1048 *
1049 */
1050 rh_port_disconnect(vdev);
1051
1052 pr_info("disconnect device\n");
1053}
1054
1055static void vhci_device_reset(struct usbip_device *ud)
1056{
1057 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
1058 unsigned long flags;
1059
1060 spin_lock_irqsave(&ud->lock, flags);
1061
1062 vdev->speed = 0;
1063 vdev->devid = 0;
1064
1065 usb_put_dev(vdev->udev);
1066 vdev->udev = NULL;
1067
1068 if (ud->tcp_socket) {
1069 sockfd_put(ud->tcp_socket);
1070 ud->tcp_socket = NULL;
1071 ud->sockfd = -1;
1072 }
1073 ud->status = VDEV_ST_NULL;
1074
1075 spin_unlock_irqrestore(&ud->lock, flags);
1076}
1077
1078static void vhci_device_unusable(struct usbip_device *ud)
1079{
1080 unsigned long flags;
1081
1082 spin_lock_irqsave(&ud->lock, flags);
1083 ud->status = VDEV_ST_ERROR;
1084 spin_unlock_irqrestore(&ud->lock, flags);
1085}
1086
1087static void vhci_device_init(struct vhci_device *vdev)
1088{
1089 memset(vdev, 0, sizeof(struct vhci_device));
1090
1091 vdev->ud.side = USBIP_VHCI;
1092 vdev->ud.status = VDEV_ST_NULL;
1093 spin_lock_init(&vdev->ud.lock);
1094
1095 INIT_LIST_HEAD(&vdev->priv_rx);
1096 INIT_LIST_HEAD(&vdev->priv_tx);
1097 INIT_LIST_HEAD(&vdev->unlink_tx);
1098 INIT_LIST_HEAD(&vdev->unlink_rx);
1099 spin_lock_init(&vdev->priv_lock);
1100
1101 init_waitqueue_head(&vdev->waitq_tx);
1102
1103 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
1104 vdev->ud.eh_ops.reset = vhci_device_reset;
1105 vdev->ud.eh_ops.unusable = vhci_device_unusable;
1106
1107 usbip_start_eh(&vdev->ud);
1108}
1109
1110static int hcd_name_to_id(const char *name)
1111{
1112 char *c;
1113 long val;
1114 int ret;
1115
1116 c = strchr(name, '.');
1117 if (c == NULL)
1118 return 0;
1119
1120 ret = kstrtol(c+1, 10, &val);
1121 if (ret < 0)
1122 return ret;
1123
1124 return val;
1125}
1126
1127static int vhci_setup(struct usb_hcd *hcd)
1128{
1129 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1130 if (usb_hcd_is_primary_hcd(hcd)) {
1131 vhci->vhci_hcd_hs = hcd_to_vhci_hcd(hcd);
1132 vhci->vhci_hcd_hs->vhci = vhci;
1133 /*
1134 * Mark the first roothub as being USB 2.0.
1135 * The USB 3.0 roothub will be registered later by
1136 * vhci_hcd_probe()
1137 */
1138 hcd->speed = HCD_USB2;
1139 hcd->self.root_hub->speed = USB_SPEED_HIGH;
1140 } else {
1141 vhci->vhci_hcd_ss = hcd_to_vhci_hcd(hcd);
1142 vhci->vhci_hcd_ss->vhci = vhci;
1143 hcd->speed = HCD_USB3;
1144 hcd->self.root_hub->speed = USB_SPEED_SUPER;
1145 }
1146
1147 /*
1148 * Support SG.
1149 * sg_tablesize is an arbitrary value to alleviate memory pressure
1150 * on the host.
1151 */
1152 hcd->self.sg_tablesize = 32;
1153 hcd->self.no_sg_constraint = 1;
1154
1155 return 0;
1156}
1157
1158static int vhci_start(struct usb_hcd *hcd)
1159{
1160 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1161 int id, rhport;
1162 int err;
1163
1164 usbip_dbg_vhci_hc("enter vhci_start\n");
1165
1166 if (usb_hcd_is_primary_hcd(hcd))
1167 spin_lock_init(&vhci_hcd->vhci->lock);
1168
1169 /* initialize private data of usb_hcd */
1170
1171 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1172 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1173
1174 vhci_device_init(vdev);
1175 vdev->rhport = rhport;
1176 }
1177
1178 atomic_set(&vhci_hcd->seqnum, 0);
1179
1180 hcd->power_budget = 0; /* no limit */
1181 hcd->uses_new_polling = 1;
1182
1183#ifdef CONFIG_USB_OTG
1184 hcd->self.otg_port = 1;
1185#endif
1186
1187 id = hcd_name_to_id(hcd_name(hcd));
1188 if (id < 0) {
1189 pr_err("invalid vhci name %s\n", hcd_name(hcd));
1190 return -EINVAL;
1191 }
1192
1193 /* vhci_hcd is now ready to be controlled through sysfs */
1194 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1195 err = vhci_init_attr_group();
1196 if (err) {
1197 dev_err(hcd_dev(hcd), "init attr group failed, err = %d\n", err);
1198 return err;
1199 }
1200 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1201 if (err) {
1202 dev_err(hcd_dev(hcd), "create sysfs files failed, err = %d\n", err);
1203 vhci_finish_attr_group();
1204 return err;
1205 }
1206 pr_info("created sysfs %s\n", hcd_name(hcd));
1207 }
1208
1209 return 0;
1210}
1211
1212static void vhci_stop(struct usb_hcd *hcd)
1213{
1214 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1215 int id, rhport;
1216
1217 usbip_dbg_vhci_hc("stop VHCI controller\n");
1218
1219 /* 1. remove the userland interface of vhci_hcd */
1220 id = hcd_name_to_id(hcd_name(hcd));
1221 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1222 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1223 vhci_finish_attr_group();
1224 }
1225
1226 /* 2. shutdown all the ports of vhci_hcd */
1227 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1228 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1229
1230 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1231 usbip_stop_eh(&vdev->ud);
1232 }
1233}
1234
1235static int vhci_get_frame_number(struct usb_hcd *hcd)
1236{
1237 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n");
1238 return 0;
1239}
1240
1241#ifdef CONFIG_PM
1242
1243/* FIXME: suspend/resume */
1244static int vhci_bus_suspend(struct usb_hcd *hcd)
1245{
1246 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1247 unsigned long flags;
1248
1249 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1250
1251 spin_lock_irqsave(&vhci->lock, flags);
1252 hcd->state = HC_STATE_SUSPENDED;
1253 spin_unlock_irqrestore(&vhci->lock, flags);
1254
1255 return 0;
1256}
1257
1258static int vhci_bus_resume(struct usb_hcd *hcd)
1259{
1260 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1261 int rc = 0;
1262 unsigned long flags;
1263
1264 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1265
1266 spin_lock_irqsave(&vhci->lock, flags);
1267 if (!HCD_HW_ACCESSIBLE(hcd))
1268 rc = -ESHUTDOWN;
1269 else
1270 hcd->state = HC_STATE_RUNNING;
1271 spin_unlock_irqrestore(&vhci->lock, flags);
1272
1273 return rc;
1274}
1275
1276#else
1277
1278#define vhci_bus_suspend NULL
1279#define vhci_bus_resume NULL
1280#endif
1281
1282/* Change a group of bulk endpoints to support multiple stream IDs */
1283static int vhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1284 struct usb_host_endpoint **eps, unsigned int num_eps,
1285 unsigned int num_streams, gfp_t mem_flags)
1286{
1287 dev_dbg(&hcd->self.root_hub->dev, "vhci_alloc_streams not implemented\n");
1288 return 0;
1289}
1290
1291/* Reverts a group of bulk endpoints back to not using stream IDs. */
1292static int vhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1293 struct usb_host_endpoint **eps, unsigned int num_eps,
1294 gfp_t mem_flags)
1295{
1296 dev_dbg(&hcd->self.root_hub->dev, "vhci_free_streams not implemented\n");
1297 return 0;
1298}
1299
1300static const struct hc_driver vhci_hc_driver = {
1301 .description = driver_name,
1302 .product_desc = driver_desc,
1303 .hcd_priv_size = sizeof(struct vhci_hcd),
1304
1305 .flags = HCD_USB3 | HCD_SHARED,
1306
1307 .reset = vhci_setup,
1308 .start = vhci_start,
1309 .stop = vhci_stop,
1310
1311 .urb_enqueue = vhci_urb_enqueue,
1312 .urb_dequeue = vhci_urb_dequeue,
1313
1314 .get_frame_number = vhci_get_frame_number,
1315
1316 .hub_status_data = vhci_hub_status,
1317 .hub_control = vhci_hub_control,
1318 .bus_suspend = vhci_bus_suspend,
1319 .bus_resume = vhci_bus_resume,
1320
1321 .alloc_streams = vhci_alloc_streams,
1322 .free_streams = vhci_free_streams,
1323};
1324
1325static int vhci_hcd_probe(struct platform_device *pdev)
1326{
1327 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1328 struct usb_hcd *hcd_hs;
1329 struct usb_hcd *hcd_ss;
1330 int ret;
1331
1332 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1333
1334 /*
1335 * Allocate and initialize hcd.
1336 * Our private data is also allocated automatically.
1337 */
1338 hcd_hs = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1339 if (!hcd_hs) {
1340 pr_err("create primary hcd failed\n");
1341 return -ENOMEM;
1342 }
1343 hcd_hs->has_tt = 1;
1344
1345 /*
1346 * Finish generic HCD structure initialization and register.
1347 * Call the driver's reset() and start() routines.
1348 */
1349 ret = usb_add_hcd(hcd_hs, 0, 0);
1350 if (ret != 0) {
1351 pr_err("usb_add_hcd hs failed %d\n", ret);
1352 goto put_usb2_hcd;
1353 }
1354
1355 hcd_ss = usb_create_shared_hcd(&vhci_hc_driver, &pdev->dev,
1356 dev_name(&pdev->dev), hcd_hs);
1357 if (!hcd_ss) {
1358 ret = -ENOMEM;
1359 pr_err("create shared hcd failed\n");
1360 goto remove_usb2_hcd;
1361 }
1362
1363 ret = usb_add_hcd(hcd_ss, 0, 0);
1364 if (ret) {
1365 pr_err("usb_add_hcd ss failed %d\n", ret);
1366 goto put_usb3_hcd;
1367 }
1368
1369 usbip_dbg_vhci_hc("bye\n");
1370 return 0;
1371
1372put_usb3_hcd:
1373 usb_put_hcd(hcd_ss);
1374remove_usb2_hcd:
1375 usb_remove_hcd(hcd_hs);
1376put_usb2_hcd:
1377 usb_put_hcd(hcd_hs);
1378 vhci->vhci_hcd_hs = NULL;
1379 vhci->vhci_hcd_ss = NULL;
1380 return ret;
1381}
1382
1383static int vhci_hcd_remove(struct platform_device *pdev)
1384{
1385 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1386
1387 /*
1388 * Disconnects the root hub,
1389 * then reverses the effects of usb_add_hcd(),
1390 * invoking the HCD's stop() methods.
1391 */
1392 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1393 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1394
1395 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1396 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1397
1398 vhci->vhci_hcd_hs = NULL;
1399 vhci->vhci_hcd_ss = NULL;
1400
1401 return 0;
1402}
1403
1404#ifdef CONFIG_PM
1405
1406/* what should happen for USB/IP under suspend/resume? */
1407static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1408{
1409 struct usb_hcd *hcd;
1410 struct vhci *vhci;
1411 int rhport;
1412 int connected = 0;
1413 int ret = 0;
1414 unsigned long flags;
1415
1416 dev_dbg(&pdev->dev, "%s\n", __func__);
1417
1418 hcd = platform_get_drvdata(pdev);
1419 if (!hcd)
1420 return 0;
1421
1422 vhci = *((void **)dev_get_platdata(hcd->self.controller));
1423
1424 spin_lock_irqsave(&vhci->lock, flags);
1425
1426 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1427 if (vhci->vhci_hcd_hs->port_status[rhport] &
1428 USB_PORT_STAT_CONNECTION)
1429 connected += 1;
1430
1431 if (vhci->vhci_hcd_ss->port_status[rhport] &
1432 USB_PORT_STAT_CONNECTION)
1433 connected += 1;
1434 }
1435
1436 spin_unlock_irqrestore(&vhci->lock, flags);
1437
1438 if (connected > 0) {
1439 dev_info(&pdev->dev,
1440 "We have %d active connection%s. Do not suspend.\n",
1441 connected, (connected == 1 ? "" : "s"));
1442 ret = -EBUSY;
1443 } else {
1444 dev_info(&pdev->dev, "suspend vhci_hcd");
1445 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1446 }
1447
1448 return ret;
1449}
1450
1451static int vhci_hcd_resume(struct platform_device *pdev)
1452{
1453 struct usb_hcd *hcd;
1454
1455 dev_dbg(&pdev->dev, "%s\n", __func__);
1456
1457 hcd = platform_get_drvdata(pdev);
1458 if (!hcd)
1459 return 0;
1460 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1461 usb_hcd_poll_rh_status(hcd);
1462
1463 return 0;
1464}
1465
1466#else
1467
1468#define vhci_hcd_suspend NULL
1469#define vhci_hcd_resume NULL
1470
1471#endif
1472
1473static struct platform_driver vhci_driver = {
1474 .probe = vhci_hcd_probe,
1475 .remove = vhci_hcd_remove,
1476 .suspend = vhci_hcd_suspend,
1477 .resume = vhci_hcd_resume,
1478 .driver = {
1479 .name = driver_name,
1480 },
1481};
1482
1483static void del_platform_devices(void)
1484{
1485 struct platform_device *pdev;
1486 int i;
1487
1488 for (i = 0; i < vhci_num_controllers; i++) {
1489 pdev = vhcis[i].pdev;
1490 if (pdev != NULL)
1491 platform_device_unregister(pdev);
1492 vhcis[i].pdev = NULL;
1493 }
1494 sysfs_remove_link(&platform_bus.kobj, driver_name);
1495}
1496
1497static int __init vhci_hcd_init(void)
1498{
1499 int i, ret;
1500
1501 if (usb_disabled())
1502 return -ENODEV;
1503
1504 if (vhci_num_controllers < 1)
1505 vhci_num_controllers = 1;
1506
1507 vhcis = kcalloc(vhci_num_controllers, sizeof(struct vhci), GFP_KERNEL);
1508 if (vhcis == NULL)
1509 return -ENOMEM;
1510
1511 for (i = 0; i < vhci_num_controllers; i++) {
1512 vhcis[i].pdev = platform_device_alloc(driver_name, i);
1513 if (!vhcis[i].pdev) {
1514 i--;
1515 while (i >= 0)
1516 platform_device_put(vhcis[i--].pdev);
1517 ret = -ENOMEM;
1518 goto err_device_alloc;
1519 }
1520 }
1521 for (i = 0; i < vhci_num_controllers; i++) {
1522 void *vhci = &vhcis[i];
1523 ret = platform_device_add_data(vhcis[i].pdev, &vhci, sizeof(void *));
1524 if (ret)
1525 goto err_driver_register;
1526 }
1527
1528 ret = platform_driver_register(&vhci_driver);
1529 if (ret)
1530 goto err_driver_register;
1531
1532 for (i = 0; i < vhci_num_controllers; i++) {
1533 ret = platform_device_add(vhcis[i].pdev);
1534 if (ret < 0) {
1535 i--;
1536 while (i >= 0)
1537 platform_device_del(vhcis[i--].pdev);
1538 goto err_add_hcd;
1539 }
1540 }
1541
1542 return ret;
1543
1544err_add_hcd:
1545 platform_driver_unregister(&vhci_driver);
1546err_driver_register:
1547 for (i = 0; i < vhci_num_controllers; i++)
1548 platform_device_put(vhcis[i].pdev);
1549err_device_alloc:
1550 kfree(vhcis);
1551 return ret;
1552}
1553
1554static void __exit vhci_hcd_exit(void)
1555{
1556 del_platform_devices();
1557 platform_driver_unregister(&vhci_driver);
1558 kfree(vhcis);
1559}
1560
1561module_init(vhci_hcd_init);
1562module_exit(vhci_hcd_exit);
1563
1564MODULE_AUTHOR(DRIVER_AUTHOR);
1565MODULE_DESCRIPTION(DRIVER_DESC);
1566MODULE_LICENSE("GPL");