Loading...
Note: File does not exist in v3.1.
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;
322 unsigned long flags;
323
324 u32 prev_port_status[VHCI_HC_PORTS];
325
326 if (!HCD_HW_ACCESSIBLE(hcd))
327 return -ETIMEDOUT;
328
329 /*
330 * NOTE:
331 * wIndex (bits 0-7) shows the port number and begins from 1?
332 */
333 wIndex = ((__u8)(wIndex & 0x00ff));
334 usbip_dbg_vhci_rh("typeReq %x wValue %x wIndex %x\n", typeReq, wValue,
335 wIndex);
336
337 if (wIndex > VHCI_HC_PORTS)
338 pr_err("invalid port number %d\n", wIndex);
339 rhport = wIndex - 1;
340
341 vhci_hcd = hcd_to_vhci_hcd(hcd);
342 vhci = vhci_hcd->vhci;
343
344 spin_lock_irqsave(&vhci->lock, flags);
345
346 /* store old status and compare now and old later */
347 if (usbip_dbg_flag_vhci_rh) {
348 memcpy(prev_port_status, vhci_hcd->port_status,
349 sizeof(prev_port_status));
350 }
351
352 switch (typeReq) {
353 case ClearHubFeature:
354 usbip_dbg_vhci_rh(" ClearHubFeature\n");
355 break;
356 case ClearPortFeature:
357 if (rhport < 0)
358 goto error;
359 switch (wValue) {
360 case USB_PORT_FEAT_SUSPEND:
361 if (hcd->speed == HCD_USB3) {
362 pr_err(" ClearPortFeature: USB_PORT_FEAT_SUSPEND req not "
363 "supported for USB 3.0 roothub\n");
364 goto error;
365 }
366 usbip_dbg_vhci_rh(
367 " ClearPortFeature: USB_PORT_FEAT_SUSPEND\n");
368 if (vhci_hcd->port_status[rhport] & USB_PORT_STAT_SUSPEND) {
369 /* 20msec signaling */
370 vhci_hcd->resuming = 1;
371 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
372 }
373 break;
374 case USB_PORT_FEAT_POWER:
375 usbip_dbg_vhci_rh(
376 " ClearPortFeature: USB_PORT_FEAT_POWER\n");
377 if (hcd->speed == HCD_USB3)
378 vhci_hcd->port_status[rhport] &= ~USB_SS_PORT_STAT_POWER;
379 else
380 vhci_hcd->port_status[rhport] &= ~USB_PORT_STAT_POWER;
381 break;
382 default:
383 usbip_dbg_vhci_rh(" ClearPortFeature: default %x\n",
384 wValue);
385 vhci_hcd->port_status[rhport] &= ~(1 << wValue);
386 break;
387 }
388 break;
389 case GetHubDescriptor:
390 usbip_dbg_vhci_rh(" GetHubDescriptor\n");
391 if (hcd->speed == HCD_USB3 &&
392 (wLength < USB_DT_SS_HUB_SIZE ||
393 wValue != (USB_DT_SS_HUB << 8))) {
394 pr_err("Wrong hub descriptor type for USB 3.0 roothub.\n");
395 goto error;
396 }
397 if (hcd->speed == HCD_USB3)
398 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
399 else
400 hub_descriptor((struct usb_hub_descriptor *) buf);
401 break;
402 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
403 if (hcd->speed != HCD_USB3)
404 goto error;
405
406 if ((wValue >> 8) != USB_DT_BOS)
407 goto error;
408
409 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
410 retval = sizeof(usb3_bos_desc);
411 break;
412 case GetHubStatus:
413 usbip_dbg_vhci_rh(" GetHubStatus\n");
414 *(__le32 *) buf = cpu_to_le32(0);
415 break;
416 case GetPortStatus:
417 usbip_dbg_vhci_rh(" GetPortStatus port %x\n", wIndex);
418 if (wIndex < 1) {
419 pr_err("invalid port number %d\n", wIndex);
420 retval = -EPIPE;
421 }
422
423 /* we do not care about resume. */
424
425 /* whoever resets or resumes must GetPortStatus to
426 * complete it!!
427 */
428 if (vhci_hcd->resuming && time_after(jiffies, vhci_hcd->re_timeout)) {
429 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_SUSPEND);
430 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_SUSPEND);
431 vhci_hcd->resuming = 0;
432 vhci_hcd->re_timeout = 0;
433 }
434
435 if ((vhci_hcd->port_status[rhport] & (1 << USB_PORT_FEAT_RESET)) !=
436 0 && time_after(jiffies, vhci_hcd->re_timeout)) {
437 vhci_hcd->port_status[rhport] |= (1 << USB_PORT_FEAT_C_RESET);
438 vhci_hcd->port_status[rhport] &= ~(1 << USB_PORT_FEAT_RESET);
439 vhci_hcd->re_timeout = 0;
440
441 if (vhci_hcd->vdev[rhport].ud.status ==
442 VDEV_ST_NOTASSIGNED) {
443 usbip_dbg_vhci_rh(
444 " enable rhport %d (status %u)\n",
445 rhport,
446 vhci_hcd->vdev[rhport].ud.status);
447 vhci_hcd->port_status[rhport] |=
448 USB_PORT_STAT_ENABLE;
449 }
450
451 if (hcd->speed < HCD_USB3) {
452 switch (vhci_hcd->vdev[rhport].speed) {
453 case USB_SPEED_HIGH:
454 vhci_hcd->port_status[rhport] |=
455 USB_PORT_STAT_HIGH_SPEED;
456 break;
457 case USB_SPEED_LOW:
458 vhci_hcd->port_status[rhport] |=
459 USB_PORT_STAT_LOW_SPEED;
460 break;
461 default:
462 pr_err("vhci_device speed not set\n");
463 break;
464 }
465 }
466 }
467 ((__le16 *) buf)[0] = cpu_to_le16(vhci_hcd->port_status[rhport]);
468 ((__le16 *) buf)[1] =
469 cpu_to_le16(vhci_hcd->port_status[rhport] >> 16);
470
471 usbip_dbg_vhci_rh(" GetPortStatus bye %x %x\n", ((u16 *)buf)[0],
472 ((u16 *)buf)[1]);
473 break;
474 case SetHubFeature:
475 usbip_dbg_vhci_rh(" SetHubFeature\n");
476 retval = -EPIPE;
477 break;
478 case SetPortFeature:
479 switch (wValue) {
480 case USB_PORT_FEAT_LINK_STATE:
481 usbip_dbg_vhci_rh(
482 " SetPortFeature: USB_PORT_FEAT_LINK_STATE\n");
483 if (hcd->speed != HCD_USB3) {
484 pr_err("USB_PORT_FEAT_LINK_STATE req not "
485 "supported for USB 2.0 roothub\n");
486 goto error;
487 }
488 /*
489 * Since this is dummy we don't have an actual link so
490 * there is nothing to do for the SET_LINK_STATE cmd
491 */
492 break;
493 case USB_PORT_FEAT_U1_TIMEOUT:
494 usbip_dbg_vhci_rh(
495 " SetPortFeature: USB_PORT_FEAT_U1_TIMEOUT\n");
496 case USB_PORT_FEAT_U2_TIMEOUT:
497 usbip_dbg_vhci_rh(
498 " SetPortFeature: USB_PORT_FEAT_U2_TIMEOUT\n");
499 /* TODO: add suspend/resume support! */
500 if (hcd->speed != HCD_USB3) {
501 pr_err("USB_PORT_FEAT_U1/2_TIMEOUT req not "
502 "supported for USB 2.0 roothub\n");
503 goto error;
504 }
505 break;
506 case USB_PORT_FEAT_SUSPEND:
507 usbip_dbg_vhci_rh(
508 " SetPortFeature: USB_PORT_FEAT_SUSPEND\n");
509 /* Applicable only for USB2.0 hub */
510 if (hcd->speed == HCD_USB3) {
511 pr_err("USB_PORT_FEAT_SUSPEND req not "
512 "supported for USB 3.0 roothub\n");
513 goto error;
514 }
515
516 if (rhport < 0)
517 goto error;
518
519 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_SUSPEND;
520 break;
521 case USB_PORT_FEAT_POWER:
522 usbip_dbg_vhci_rh(
523 " SetPortFeature: USB_PORT_FEAT_POWER\n");
524 if (rhport < 0)
525 goto error;
526 if (hcd->speed == HCD_USB3)
527 vhci_hcd->port_status[rhport] |= USB_SS_PORT_STAT_POWER;
528 else
529 vhci_hcd->port_status[rhport] |= USB_PORT_STAT_POWER;
530 break;
531 case USB_PORT_FEAT_BH_PORT_RESET:
532 usbip_dbg_vhci_rh(
533 " SetPortFeature: USB_PORT_FEAT_BH_PORT_RESET\n");
534 if (rhport < 0)
535 goto error;
536 /* Applicable only for USB3.0 hub */
537 if (hcd->speed != HCD_USB3) {
538 pr_err("USB_PORT_FEAT_BH_PORT_RESET req not "
539 "supported for USB 2.0 roothub\n");
540 goto error;
541 }
542 /* FALLS THROUGH */
543 case USB_PORT_FEAT_RESET:
544 usbip_dbg_vhci_rh(
545 " SetPortFeature: USB_PORT_FEAT_RESET\n");
546 if (rhport < 0)
547 goto error;
548 /* if it's already enabled, disable */
549 if (hcd->speed == HCD_USB3) {
550 vhci_hcd->port_status[rhport] = 0;
551 vhci_hcd->port_status[rhport] =
552 (USB_SS_PORT_STAT_POWER |
553 USB_PORT_STAT_CONNECTION |
554 USB_PORT_STAT_RESET);
555 } else if (vhci_hcd->port_status[rhport] & USB_PORT_STAT_ENABLE) {
556 vhci_hcd->port_status[rhport] &= ~(USB_PORT_STAT_ENABLE
557 | USB_PORT_STAT_LOW_SPEED
558 | USB_PORT_STAT_HIGH_SPEED);
559 }
560
561 /* 50msec reset signaling */
562 vhci_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
563
564 /* FALLS THROUGH */
565 default:
566 usbip_dbg_vhci_rh(" SetPortFeature: default %d\n",
567 wValue);
568 if (rhport < 0)
569 goto error;
570 if (hcd->speed == HCD_USB3) {
571 if ((vhci_hcd->port_status[rhport] &
572 USB_SS_PORT_STAT_POWER) != 0) {
573 vhci_hcd->port_status[rhport] |= (1 << wValue);
574 }
575 } else
576 if ((vhci_hcd->port_status[rhport] &
577 USB_PORT_STAT_POWER) != 0) {
578 vhci_hcd->port_status[rhport] |= (1 << wValue);
579 }
580 }
581 break;
582 case GetPortErrorCount:
583 usbip_dbg_vhci_rh(" GetPortErrorCount\n");
584 if (hcd->speed != HCD_USB3) {
585 pr_err("GetPortErrorCount req not "
586 "supported for USB 2.0 roothub\n");
587 goto error;
588 }
589 /* We'll always return 0 since this is a dummy hub */
590 *(__le32 *) buf = cpu_to_le32(0);
591 break;
592 case SetHubDepth:
593 usbip_dbg_vhci_rh(" SetHubDepth\n");
594 if (hcd->speed != HCD_USB3) {
595 pr_err("SetHubDepth req not supported for "
596 "USB 2.0 roothub\n");
597 goto error;
598 }
599 break;
600 default:
601 pr_err("default hub control req: %04x v%04x i%04x l%d\n",
602 typeReq, wValue, wIndex, wLength);
603error:
604 /* "protocol stall" on error */
605 retval = -EPIPE;
606 }
607
608 if (usbip_dbg_flag_vhci_rh) {
609 pr_debug("port %d\n", rhport);
610 /* Only dump valid port status */
611 if (rhport >= 0) {
612 dump_port_status_diff(prev_port_status[rhport],
613 vhci_hcd->port_status[rhport],
614 hcd->speed == HCD_USB3);
615 }
616 }
617 usbip_dbg_vhci_rh(" bye\n");
618
619 spin_unlock_irqrestore(&vhci->lock, flags);
620
621 if ((vhci_hcd->port_status[rhport] & PORT_C_MASK) != 0)
622 usb_hcd_poll_rh_status(hcd);
623
624 return retval;
625}
626
627static void vhci_tx_urb(struct urb *urb, struct vhci_device *vdev)
628{
629 struct vhci_priv *priv;
630 struct vhci_hcd *vhci_hcd;
631 unsigned long flags;
632
633 if (!vdev) {
634 pr_err("could not get virtual device");
635 return;
636 }
637 vhci_hcd = vdev_to_vhci_hcd(vdev);
638
639 priv = kzalloc(sizeof(struct vhci_priv), GFP_ATOMIC);
640 if (!priv) {
641 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
642 return;
643 }
644
645 spin_lock_irqsave(&vdev->priv_lock, flags);
646
647 priv->seqnum = atomic_inc_return(&vhci_hcd->seqnum);
648 if (priv->seqnum == 0xffff)
649 dev_info(&urb->dev->dev, "seqnum max\n");
650
651 priv->vdev = vdev;
652 priv->urb = urb;
653
654 urb->hcpriv = (void *) priv;
655
656 list_add_tail(&priv->list, &vdev->priv_tx);
657
658 wake_up(&vdev->waitq_tx);
659 spin_unlock_irqrestore(&vdev->priv_lock, flags);
660}
661
662static int vhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags)
663{
664 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
665 struct vhci *vhci = vhci_hcd->vhci;
666 struct device *dev = &urb->dev->dev;
667 u8 portnum = urb->dev->portnum;
668 int ret = 0;
669 struct vhci_device *vdev;
670 unsigned long flags;
671
672 if (portnum > VHCI_HC_PORTS) {
673 pr_err("invalid port number %d\n", portnum);
674 return -ENODEV;
675 }
676 vdev = &vhci_hcd->vdev[portnum-1];
677
678 /* patch to usb_sg_init() is in 2.5.60 */
679 BUG_ON(!urb->transfer_buffer && urb->transfer_buffer_length);
680
681 spin_lock_irqsave(&vhci->lock, flags);
682
683 if (urb->status != -EINPROGRESS) {
684 dev_err(dev, "URB already unlinked!, status %d\n", urb->status);
685 spin_unlock_irqrestore(&vhci->lock, flags);
686 return urb->status;
687 }
688
689 /* refuse enqueue for dead connection */
690 spin_lock(&vdev->ud.lock);
691 if (vdev->ud.status == VDEV_ST_NULL ||
692 vdev->ud.status == VDEV_ST_ERROR) {
693 dev_err(dev, "enqueue for inactive port %d\n", vdev->rhport);
694 spin_unlock(&vdev->ud.lock);
695 spin_unlock_irqrestore(&vhci->lock, flags);
696 return -ENODEV;
697 }
698 spin_unlock(&vdev->ud.lock);
699
700 ret = usb_hcd_link_urb_to_ep(hcd, urb);
701 if (ret)
702 goto no_need_unlink;
703
704 /*
705 * The enumeration process is as follows;
706 *
707 * 1. Get_Descriptor request to DevAddrs(0) EndPoint(0)
708 * to get max packet length of default pipe
709 *
710 * 2. Set_Address request to DevAddr(0) EndPoint(0)
711 *
712 */
713 if (usb_pipedevice(urb->pipe) == 0) {
714 __u8 type = usb_pipetype(urb->pipe);
715 struct usb_ctrlrequest *ctrlreq =
716 (struct usb_ctrlrequest *) urb->setup_packet;
717
718 if (type != PIPE_CONTROL || !ctrlreq) {
719 dev_err(dev, "invalid request to devnum 0\n");
720 ret = -EINVAL;
721 goto no_need_xmit;
722 }
723
724 switch (ctrlreq->bRequest) {
725 case USB_REQ_SET_ADDRESS:
726 /* set_address may come when a device is reset */
727 dev_info(dev, "SetAddress Request (%d) to port %d\n",
728 ctrlreq->wValue, vdev->rhport);
729
730 usb_put_dev(vdev->udev);
731 vdev->udev = usb_get_dev(urb->dev);
732
733 spin_lock(&vdev->ud.lock);
734 vdev->ud.status = VDEV_ST_USED;
735 spin_unlock(&vdev->ud.lock);
736
737 if (urb->status == -EINPROGRESS) {
738 /* This request is successfully completed. */
739 /* If not -EINPROGRESS, possibly unlinked. */
740 urb->status = 0;
741 }
742
743 goto no_need_xmit;
744
745 case USB_REQ_GET_DESCRIPTOR:
746 if (ctrlreq->wValue == cpu_to_le16(USB_DT_DEVICE << 8))
747 usbip_dbg_vhci_hc(
748 "Not yet?:Get_Descriptor to device 0 (get max pipe size)\n");
749
750 usb_put_dev(vdev->udev);
751 vdev->udev = usb_get_dev(urb->dev);
752 goto out;
753
754 default:
755 /* NOT REACHED */
756 dev_err(dev,
757 "invalid request to devnum 0 bRequest %u, wValue %u\n",
758 ctrlreq->bRequest,
759 ctrlreq->wValue);
760 ret = -EINVAL;
761 goto no_need_xmit;
762 }
763
764 }
765
766out:
767 vhci_tx_urb(urb, vdev);
768 spin_unlock_irqrestore(&vhci->lock, flags);
769
770 return 0;
771
772no_need_xmit:
773 usb_hcd_unlink_urb_from_ep(hcd, urb);
774no_need_unlink:
775 spin_unlock_irqrestore(&vhci->lock, flags);
776 if (!ret)
777 usb_hcd_giveback_urb(hcd, urb, urb->status);
778 return ret;
779}
780
781/*
782 * vhci_rx gives back the urb after receiving the reply of the urb. If an
783 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
784 * back its urb. For the driver unlinking the urb, the content of the urb is
785 * not important, but the calling to its completion handler is important; the
786 * completion of unlinking is notified by the completion handler.
787 *
788 *
789 * CLIENT SIDE
790 *
791 * - When vhci_hcd receives RET_SUBMIT,
792 *
793 * - case 1a). the urb of the pdu is not unlinking.
794 * - normal case
795 * => just give back the urb
796 *
797 * - case 1b). the urb of the pdu is unlinking.
798 * - usbip.ko will return a reply of the unlinking request.
799 * => give back the urb now and go to case 2b).
800 *
801 * - When vhci_hcd receives RET_UNLINK,
802 *
803 * - case 2a). a submit request is still pending in vhci_hcd.
804 * - urb was really pending in usbip.ko and urb_unlink_urb() was
805 * completed there.
806 * => free a pending submit request
807 * => notify unlink completeness by giving back the urb
808 *
809 * - case 2b). a submit request is *not* pending in vhci_hcd.
810 * - urb was already given back to the core driver.
811 * => do not give back the urb
812 *
813 *
814 * SERVER SIDE
815 *
816 * - When usbip receives CMD_UNLINK,
817 *
818 * - case 3a). the urb of the unlink request is now in submission.
819 * => do usb_unlink_urb().
820 * => after the unlink is completed, send RET_UNLINK.
821 *
822 * - case 3b). the urb of the unlink request is not in submission.
823 * - may be already completed or never be received
824 * => send RET_UNLINK
825 *
826 */
827static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
828{
829 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
830 struct vhci *vhci = vhci_hcd->vhci;
831 struct vhci_priv *priv;
832 struct vhci_device *vdev;
833 unsigned long flags;
834
835 spin_lock_irqsave(&vhci->lock, flags);
836
837 priv = urb->hcpriv;
838 if (!priv) {
839 /* URB was never linked! or will be soon given back by
840 * vhci_rx. */
841 spin_unlock_irqrestore(&vhci->lock, flags);
842 return -EIDRM;
843 }
844
845 {
846 int ret = 0;
847
848 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
849 if (ret) {
850 spin_unlock_irqrestore(&vhci->lock, flags);
851 return ret;
852 }
853 }
854
855 /* send unlink request here? */
856 vdev = priv->vdev;
857
858 if (!vdev->ud.tcp_socket) {
859 /* tcp connection is closed */
860 spin_lock(&vdev->priv_lock);
861
862 list_del(&priv->list);
863 kfree(priv);
864 urb->hcpriv = NULL;
865
866 spin_unlock(&vdev->priv_lock);
867
868 /*
869 * If tcp connection is alive, we have sent CMD_UNLINK.
870 * vhci_rx will receive RET_UNLINK and give back the URB.
871 * Otherwise, we give back it here.
872 */
873 usb_hcd_unlink_urb_from_ep(hcd, urb);
874
875 spin_unlock_irqrestore(&vhci->lock, flags);
876 usb_hcd_giveback_urb(hcd, urb, urb->status);
877 spin_lock_irqsave(&vhci->lock, flags);
878
879 } else {
880 /* tcp connection is alive */
881 struct vhci_unlink *unlink;
882
883 spin_lock(&vdev->priv_lock);
884
885 /* setup CMD_UNLINK pdu */
886 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
887 if (!unlink) {
888 spin_unlock(&vdev->priv_lock);
889 spin_unlock_irqrestore(&vhci->lock, flags);
890 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
891 return -ENOMEM;
892 }
893
894 unlink->seqnum = atomic_inc_return(&vhci_hcd->seqnum);
895 if (unlink->seqnum == 0xffff)
896 pr_info("seqnum max\n");
897
898 unlink->unlink_seqnum = priv->seqnum;
899
900 /* send cmd_unlink and try to cancel the pending URB in the
901 * peer */
902 list_add_tail(&unlink->list, &vdev->unlink_tx);
903 wake_up(&vdev->waitq_tx);
904
905 spin_unlock(&vdev->priv_lock);
906 }
907
908 spin_unlock_irqrestore(&vhci->lock, flags);
909
910 usbip_dbg_vhci_hc("leave\n");
911 return 0;
912}
913
914static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
915{
916 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
917 struct usb_hcd *hcd = vhci_hcd_to_hcd(vhci_hcd);
918 struct vhci *vhci = vhci_hcd->vhci;
919 struct vhci_unlink *unlink, *tmp;
920 unsigned long flags;
921
922 spin_lock_irqsave(&vhci->lock, flags);
923 spin_lock(&vdev->priv_lock);
924
925 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
926 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
927 list_del(&unlink->list);
928 kfree(unlink);
929 }
930
931 while (!list_empty(&vdev->unlink_rx)) {
932 struct urb *urb;
933
934 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
935 list);
936
937 /* give back URB of unanswered unlink request */
938 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
939
940 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
941 if (!urb) {
942 pr_info("the urb (seqnum %lu) was already given back\n",
943 unlink->unlink_seqnum);
944 list_del(&unlink->list);
945 kfree(unlink);
946 continue;
947 }
948
949 urb->status = -ENODEV;
950
951 usb_hcd_unlink_urb_from_ep(hcd, urb);
952
953 list_del(&unlink->list);
954
955 spin_unlock(&vdev->priv_lock);
956 spin_unlock_irqrestore(&vhci->lock, flags);
957
958 usb_hcd_giveback_urb(hcd, urb, urb->status);
959
960 spin_lock_irqsave(&vhci->lock, flags);
961 spin_lock(&vdev->priv_lock);
962
963 kfree(unlink);
964 }
965
966 spin_unlock(&vdev->priv_lock);
967 spin_unlock_irqrestore(&vhci->lock, flags);
968}
969
970/*
971 * The important thing is that only one context begins cleanup.
972 * This is why error handling and cleanup become simple.
973 * We do not want to consider race condition as possible.
974 */
975static void vhci_shutdown_connection(struct usbip_device *ud)
976{
977 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
978
979 /* need this? see stub_dev.c */
980 if (ud->tcp_socket) {
981 pr_debug("shutdown tcp_socket %d\n", ud->sockfd);
982 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
983 }
984
985 /* kill threads related to this sdev */
986 if (vdev->ud.tcp_rx) {
987 kthread_stop_put(vdev->ud.tcp_rx);
988 vdev->ud.tcp_rx = NULL;
989 }
990 if (vdev->ud.tcp_tx) {
991 kthread_stop_put(vdev->ud.tcp_tx);
992 vdev->ud.tcp_tx = NULL;
993 }
994 pr_info("stop threads\n");
995
996 /* active connection is closed */
997 if (vdev->ud.tcp_socket) {
998 sockfd_put(vdev->ud.tcp_socket);
999 vdev->ud.tcp_socket = NULL;
1000 vdev->ud.sockfd = -1;
1001 }
1002 pr_info("release socket\n");
1003
1004 vhci_device_unlink_cleanup(vdev);
1005
1006 /*
1007 * rh_port_disconnect() is a trigger of ...
1008 * usb_disable_device():
1009 * disable all the endpoints for a USB device.
1010 * usb_disable_endpoint():
1011 * disable endpoints. pending urbs are unlinked(dequeued).
1012 *
1013 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
1014 * detached device should release used urbs in a cleanup function (i.e.
1015 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
1016 * pushed urbs and their private data in this function.
1017 *
1018 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
1019 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
1020 * gives back pushed urbs and frees their private data by request of
1021 * the cleanup function of a USB driver. When unlinking a urb with an
1022 * active connection, vhci_dequeue() does not give back the urb which
1023 * is actually given back by vhci_rx after receiving its return pdu.
1024 *
1025 */
1026 rh_port_disconnect(vdev);
1027
1028 pr_info("disconnect device\n");
1029}
1030
1031static void vhci_device_reset(struct usbip_device *ud)
1032{
1033 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
1034 unsigned long flags;
1035
1036 spin_lock_irqsave(&ud->lock, flags);
1037
1038 vdev->speed = 0;
1039 vdev->devid = 0;
1040
1041 usb_put_dev(vdev->udev);
1042 vdev->udev = NULL;
1043
1044 if (ud->tcp_socket) {
1045 sockfd_put(ud->tcp_socket);
1046 ud->tcp_socket = NULL;
1047 ud->sockfd = -1;
1048 }
1049 ud->status = VDEV_ST_NULL;
1050
1051 spin_unlock_irqrestore(&ud->lock, flags);
1052}
1053
1054static void vhci_device_unusable(struct usbip_device *ud)
1055{
1056 unsigned long flags;
1057
1058 spin_lock_irqsave(&ud->lock, flags);
1059 ud->status = VDEV_ST_ERROR;
1060 spin_unlock_irqrestore(&ud->lock, flags);
1061}
1062
1063static void vhci_device_init(struct vhci_device *vdev)
1064{
1065 memset(vdev, 0, sizeof(struct vhci_device));
1066
1067 vdev->ud.side = USBIP_VHCI;
1068 vdev->ud.status = VDEV_ST_NULL;
1069 spin_lock_init(&vdev->ud.lock);
1070
1071 INIT_LIST_HEAD(&vdev->priv_rx);
1072 INIT_LIST_HEAD(&vdev->priv_tx);
1073 INIT_LIST_HEAD(&vdev->unlink_tx);
1074 INIT_LIST_HEAD(&vdev->unlink_rx);
1075 spin_lock_init(&vdev->priv_lock);
1076
1077 init_waitqueue_head(&vdev->waitq_tx);
1078
1079 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
1080 vdev->ud.eh_ops.reset = vhci_device_reset;
1081 vdev->ud.eh_ops.unusable = vhci_device_unusable;
1082
1083 usbip_start_eh(&vdev->ud);
1084}
1085
1086static int hcd_name_to_id(const char *name)
1087{
1088 char *c;
1089 long val;
1090 int ret;
1091
1092 c = strchr(name, '.');
1093 if (c == NULL)
1094 return 0;
1095
1096 ret = kstrtol(c+1, 10, &val);
1097 if (ret < 0)
1098 return ret;
1099
1100 return val;
1101}
1102
1103static int vhci_setup(struct usb_hcd *hcd)
1104{
1105 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1106 if (usb_hcd_is_primary_hcd(hcd)) {
1107 vhci->vhci_hcd_hs = hcd_to_vhci_hcd(hcd);
1108 vhci->vhci_hcd_hs->vhci = vhci;
1109 /*
1110 * Mark the first roothub as being USB 2.0.
1111 * The USB 3.0 roothub will be registered later by
1112 * vhci_hcd_probe()
1113 */
1114 hcd->speed = HCD_USB2;
1115 hcd->self.root_hub->speed = USB_SPEED_HIGH;
1116 } else {
1117 vhci->vhci_hcd_ss = hcd_to_vhci_hcd(hcd);
1118 vhci->vhci_hcd_ss->vhci = vhci;
1119 hcd->speed = HCD_USB3;
1120 hcd->self.root_hub->speed = USB_SPEED_SUPER;
1121 }
1122 return 0;
1123}
1124
1125static int vhci_start(struct usb_hcd *hcd)
1126{
1127 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1128 int id, rhport;
1129 int err;
1130
1131 usbip_dbg_vhci_hc("enter vhci_start\n");
1132
1133 if (usb_hcd_is_primary_hcd(hcd))
1134 spin_lock_init(&vhci_hcd->vhci->lock);
1135
1136 /* initialize private data of usb_hcd */
1137
1138 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1139 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1140
1141 vhci_device_init(vdev);
1142 vdev->rhport = rhport;
1143 }
1144
1145 atomic_set(&vhci_hcd->seqnum, 0);
1146
1147 hcd->power_budget = 0; /* no limit */
1148 hcd->uses_new_polling = 1;
1149
1150#ifdef CONFIG_USB_OTG
1151 hcd->self.otg_port = 1;
1152#endif
1153
1154 id = hcd_name_to_id(hcd_name(hcd));
1155 if (id < 0) {
1156 pr_err("invalid vhci name %s\n", hcd_name(hcd));
1157 return -EINVAL;
1158 }
1159
1160 /* vhci_hcd is now ready to be controlled through sysfs */
1161 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1162 err = vhci_init_attr_group();
1163 if (err) {
1164 pr_err("init attr group\n");
1165 return err;
1166 }
1167 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1168 if (err) {
1169 pr_err("create sysfs files\n");
1170 vhci_finish_attr_group();
1171 return err;
1172 }
1173 pr_info("created sysfs %s\n", hcd_name(hcd));
1174 }
1175
1176 return 0;
1177}
1178
1179static void vhci_stop(struct usb_hcd *hcd)
1180{
1181 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1182 int id, rhport;
1183
1184 usbip_dbg_vhci_hc("stop VHCI controller\n");
1185
1186 /* 1. remove the userland interface of vhci_hcd */
1187 id = hcd_name_to_id(hcd_name(hcd));
1188 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1189 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1190 vhci_finish_attr_group();
1191 }
1192
1193 /* 2. shutdown all the ports of vhci_hcd */
1194 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1195 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1196
1197 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1198 usbip_stop_eh(&vdev->ud);
1199 }
1200}
1201
1202static int vhci_get_frame_number(struct usb_hcd *hcd)
1203{
1204 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n");
1205 return 0;
1206}
1207
1208#ifdef CONFIG_PM
1209
1210/* FIXME: suspend/resume */
1211static int vhci_bus_suspend(struct usb_hcd *hcd)
1212{
1213 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1214 unsigned long flags;
1215
1216 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1217
1218 spin_lock_irqsave(&vhci->lock, flags);
1219 hcd->state = HC_STATE_SUSPENDED;
1220 spin_unlock_irqrestore(&vhci->lock, flags);
1221
1222 return 0;
1223}
1224
1225static int vhci_bus_resume(struct usb_hcd *hcd)
1226{
1227 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1228 int rc = 0;
1229 unsigned long flags;
1230
1231 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1232
1233 spin_lock_irqsave(&vhci->lock, flags);
1234 if (!HCD_HW_ACCESSIBLE(hcd))
1235 rc = -ESHUTDOWN;
1236 else
1237 hcd->state = HC_STATE_RUNNING;
1238 spin_unlock_irqrestore(&vhci->lock, flags);
1239
1240 return rc;
1241}
1242
1243#else
1244
1245#define vhci_bus_suspend NULL
1246#define vhci_bus_resume NULL
1247#endif
1248
1249/* Change a group of bulk endpoints to support multiple stream IDs */
1250static int vhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1251 struct usb_host_endpoint **eps, unsigned int num_eps,
1252 unsigned int num_streams, gfp_t mem_flags)
1253{
1254 dev_dbg(&hcd->self.root_hub->dev, "vhci_alloc_streams not implemented\n");
1255 return 0;
1256}
1257
1258/* Reverts a group of bulk endpoints back to not using stream IDs. */
1259static int vhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1260 struct usb_host_endpoint **eps, unsigned int num_eps,
1261 gfp_t mem_flags)
1262{
1263 dev_dbg(&hcd->self.root_hub->dev, "vhci_free_streams not implemented\n");
1264 return 0;
1265}
1266
1267static const struct hc_driver vhci_hc_driver = {
1268 .description = driver_name,
1269 .product_desc = driver_desc,
1270 .hcd_priv_size = sizeof(struct vhci_hcd),
1271
1272 .flags = HCD_USB3 | HCD_SHARED,
1273
1274 .reset = vhci_setup,
1275 .start = vhci_start,
1276 .stop = vhci_stop,
1277
1278 .urb_enqueue = vhci_urb_enqueue,
1279 .urb_dequeue = vhci_urb_dequeue,
1280
1281 .get_frame_number = vhci_get_frame_number,
1282
1283 .hub_status_data = vhci_hub_status,
1284 .hub_control = vhci_hub_control,
1285 .bus_suspend = vhci_bus_suspend,
1286 .bus_resume = vhci_bus_resume,
1287
1288 .alloc_streams = vhci_alloc_streams,
1289 .free_streams = vhci_free_streams,
1290};
1291
1292static int vhci_hcd_probe(struct platform_device *pdev)
1293{
1294 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1295 struct usb_hcd *hcd_hs;
1296 struct usb_hcd *hcd_ss;
1297 int ret;
1298
1299 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1300
1301 /*
1302 * Allocate and initialize hcd.
1303 * Our private data is also allocated automatically.
1304 */
1305 hcd_hs = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1306 if (!hcd_hs) {
1307 pr_err("create primary hcd failed\n");
1308 return -ENOMEM;
1309 }
1310 hcd_hs->has_tt = 1;
1311
1312 /*
1313 * Finish generic HCD structure initialization and register.
1314 * Call the driver's reset() and start() routines.
1315 */
1316 ret = usb_add_hcd(hcd_hs, 0, 0);
1317 if (ret != 0) {
1318 pr_err("usb_add_hcd hs failed %d\n", ret);
1319 goto put_usb2_hcd;
1320 }
1321
1322 hcd_ss = usb_create_shared_hcd(&vhci_hc_driver, &pdev->dev,
1323 dev_name(&pdev->dev), hcd_hs);
1324 if (!hcd_ss) {
1325 ret = -ENOMEM;
1326 pr_err("create shared hcd failed\n");
1327 goto remove_usb2_hcd;
1328 }
1329
1330 ret = usb_add_hcd(hcd_ss, 0, 0);
1331 if (ret) {
1332 pr_err("usb_add_hcd ss failed %d\n", ret);
1333 goto put_usb3_hcd;
1334 }
1335
1336 usbip_dbg_vhci_hc("bye\n");
1337 return 0;
1338
1339put_usb3_hcd:
1340 usb_put_hcd(hcd_ss);
1341remove_usb2_hcd:
1342 usb_remove_hcd(hcd_hs);
1343put_usb2_hcd:
1344 usb_put_hcd(hcd_hs);
1345 vhci->vhci_hcd_hs = NULL;
1346 vhci->vhci_hcd_ss = NULL;
1347 return ret;
1348}
1349
1350static int vhci_hcd_remove(struct platform_device *pdev)
1351{
1352 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1353
1354 /*
1355 * Disconnects the root hub,
1356 * then reverses the effects of usb_add_hcd(),
1357 * invoking the HCD's stop() methods.
1358 */
1359 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1360 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1361
1362 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1363 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1364
1365 vhci->vhci_hcd_hs = NULL;
1366 vhci->vhci_hcd_ss = NULL;
1367
1368 return 0;
1369}
1370
1371#ifdef CONFIG_PM
1372
1373/* what should happen for USB/IP under suspend/resume? */
1374static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1375{
1376 struct usb_hcd *hcd;
1377 struct vhci *vhci;
1378 int rhport;
1379 int connected = 0;
1380 int ret = 0;
1381 unsigned long flags;
1382
1383 dev_dbg(&pdev->dev, "%s\n", __func__);
1384
1385 hcd = platform_get_drvdata(pdev);
1386 if (!hcd)
1387 return 0;
1388
1389 vhci = *((void **)dev_get_platdata(hcd->self.controller));
1390
1391 spin_lock_irqsave(&vhci->lock, flags);
1392
1393 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1394 if (vhci->vhci_hcd_hs->port_status[rhport] &
1395 USB_PORT_STAT_CONNECTION)
1396 connected += 1;
1397
1398 if (vhci->vhci_hcd_ss->port_status[rhport] &
1399 USB_PORT_STAT_CONNECTION)
1400 connected += 1;
1401 }
1402
1403 spin_unlock_irqrestore(&vhci->lock, flags);
1404
1405 if (connected > 0) {
1406 dev_info(&pdev->dev,
1407 "We have %d active connection%s. Do not suspend.\n",
1408 connected, (connected == 1 ? "" : "s"));
1409 ret = -EBUSY;
1410 } else {
1411 dev_info(&pdev->dev, "suspend vhci_hcd");
1412 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1413 }
1414
1415 return ret;
1416}
1417
1418static int vhci_hcd_resume(struct platform_device *pdev)
1419{
1420 struct usb_hcd *hcd;
1421
1422 dev_dbg(&pdev->dev, "%s\n", __func__);
1423
1424 hcd = platform_get_drvdata(pdev);
1425 if (!hcd)
1426 return 0;
1427 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1428 usb_hcd_poll_rh_status(hcd);
1429
1430 return 0;
1431}
1432
1433#else
1434
1435#define vhci_hcd_suspend NULL
1436#define vhci_hcd_resume NULL
1437
1438#endif
1439
1440static struct platform_driver vhci_driver = {
1441 .probe = vhci_hcd_probe,
1442 .remove = vhci_hcd_remove,
1443 .suspend = vhci_hcd_suspend,
1444 .resume = vhci_hcd_resume,
1445 .driver = {
1446 .name = driver_name,
1447 },
1448};
1449
1450static void del_platform_devices(void)
1451{
1452 struct platform_device *pdev;
1453 int i;
1454
1455 for (i = 0; i < vhci_num_controllers; i++) {
1456 pdev = vhcis[i].pdev;
1457 if (pdev != NULL)
1458 platform_device_unregister(pdev);
1459 vhcis[i].pdev = NULL;
1460 }
1461 sysfs_remove_link(&platform_bus.kobj, driver_name);
1462}
1463
1464static int __init vhci_hcd_init(void)
1465{
1466 int i, ret;
1467
1468 if (usb_disabled())
1469 return -ENODEV;
1470
1471 if (vhci_num_controllers < 1)
1472 vhci_num_controllers = 1;
1473
1474 vhcis = kcalloc(vhci_num_controllers, sizeof(struct vhci), GFP_KERNEL);
1475 if (vhcis == NULL)
1476 return -ENOMEM;
1477
1478 for (i = 0; i < vhci_num_controllers; i++) {
1479 vhcis[i].pdev = platform_device_alloc(driver_name, i);
1480 if (!vhcis[i].pdev) {
1481 i--;
1482 while (i >= 0)
1483 platform_device_put(vhcis[i--].pdev);
1484 ret = -ENOMEM;
1485 goto err_device_alloc;
1486 }
1487 }
1488 for (i = 0; i < vhci_num_controllers; i++) {
1489 void *vhci = &vhcis[i];
1490 ret = platform_device_add_data(vhcis[i].pdev, &vhci, sizeof(void *));
1491 if (ret)
1492 goto err_driver_register;
1493 }
1494
1495 ret = platform_driver_register(&vhci_driver);
1496 if (ret)
1497 goto err_driver_register;
1498
1499 for (i = 0; i < vhci_num_controllers; i++) {
1500 ret = platform_device_add(vhcis[i].pdev);
1501 if (ret < 0) {
1502 i--;
1503 while (i >= 0)
1504 platform_device_del(vhcis[i--].pdev);
1505 goto err_add_hcd;
1506 }
1507 }
1508
1509 return ret;
1510
1511err_add_hcd:
1512 platform_driver_unregister(&vhci_driver);
1513err_driver_register:
1514 for (i = 0; i < vhci_num_controllers; i++)
1515 platform_device_put(vhcis[i].pdev);
1516err_device_alloc:
1517 kfree(vhcis);
1518 return ret;
1519}
1520
1521static void __exit vhci_hcd_exit(void)
1522{
1523 del_platform_devices();
1524 platform_driver_unregister(&vhci_driver);
1525 kfree(vhcis);
1526}
1527
1528module_init(vhci_hcd_init);
1529module_exit(vhci_hcd_exit);
1530
1531MODULE_AUTHOR(DRIVER_AUTHOR);
1532MODULE_DESCRIPTION(DRIVER_DESC);
1533MODULE_LICENSE("GPL");