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