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 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);
628 error:
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
vhci_tx_urb(struct urb * urb,struct vhci_device * vdev)654 static 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
vhci_urb_enqueue(struct usb_hcd * hcd,struct urb * urb,gfp_t mem_flags)683 static 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
790 out:
791 vhci_tx_urb(urb, vdev);
792 spin_unlock_irqrestore(&vhci->lock, flags);
793
794 return 0;
795
796 no_need_xmit:
797 usb_hcd_unlink_urb_from_ep(hcd, urb);
798 no_need_unlink:
799 spin_unlock_irqrestore(&vhci->lock, flags);
800 if (!ret) {
801 /* usb_hcd_giveback_urb() should be called with
802 * irqs disabled
803 */
804 local_irq_disable();
805 usb_hcd_giveback_urb(hcd, urb, urb->status);
806 local_irq_enable();
807 }
808 return ret;
809 }
810
811 /*
812 * vhci_rx gives back the urb after receiving the reply of the urb. If an
813 * unlink pdu is sent or not, vhci_rx receives a normal return pdu and gives
814 * back its urb. For the driver unlinking the urb, the content of the urb is
815 * not important, but the calling to its completion handler is important; the
816 * completion of unlinking is notified by the completion handler.
817 *
818 *
819 * CLIENT SIDE
820 *
821 * - When vhci_hcd receives RET_SUBMIT,
822 *
823 * - case 1a). the urb of the pdu is not unlinking.
824 * - normal case
825 * => just give back the urb
826 *
827 * - case 1b). the urb of the pdu is unlinking.
828 * - usbip.ko will return a reply of the unlinking request.
829 * => give back the urb now and go to case 2b).
830 *
831 * - When vhci_hcd receives RET_UNLINK,
832 *
833 * - case 2a). a submit request is still pending in vhci_hcd.
834 * - urb was really pending in usbip.ko and urb_unlink_urb() was
835 * completed there.
836 * => free a pending submit request
837 * => notify unlink completeness by giving back the urb
838 *
839 * - case 2b). a submit request is *not* pending in vhci_hcd.
840 * - urb was already given back to the core driver.
841 * => do not give back the urb
842 *
843 *
844 * SERVER SIDE
845 *
846 * - When usbip receives CMD_UNLINK,
847 *
848 * - case 3a). the urb of the unlink request is now in submission.
849 * => do usb_unlink_urb().
850 * => after the unlink is completed, send RET_UNLINK.
851 *
852 * - case 3b). the urb of the unlink request is not in submission.
853 * - may be already completed or never be received
854 * => send RET_UNLINK
855 *
856 */
vhci_urb_dequeue(struct usb_hcd * hcd,struct urb * urb,int status)857 static int vhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
858 {
859 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
860 struct vhci *vhci = vhci_hcd->vhci;
861 struct vhci_priv *priv;
862 struct vhci_device *vdev;
863 unsigned long flags;
864
865 spin_lock_irqsave(&vhci->lock, flags);
866
867 priv = urb->hcpriv;
868 if (!priv) {
869 /* URB was never linked! or will be soon given back by
870 * vhci_rx. */
871 spin_unlock_irqrestore(&vhci->lock, flags);
872 return -EIDRM;
873 }
874
875 {
876 int ret = 0;
877
878 ret = usb_hcd_check_unlink_urb(hcd, urb, status);
879 if (ret) {
880 spin_unlock_irqrestore(&vhci->lock, flags);
881 return ret;
882 }
883 }
884
885 /* send unlink request here? */
886 vdev = priv->vdev;
887
888 if (!vdev->ud.tcp_socket) {
889 /* tcp connection is closed */
890 spin_lock(&vdev->priv_lock);
891
892 list_del(&priv->list);
893 kfree(priv);
894 urb->hcpriv = NULL;
895
896 spin_unlock(&vdev->priv_lock);
897
898 /*
899 * If tcp connection is alive, we have sent CMD_UNLINK.
900 * vhci_rx will receive RET_UNLINK and give back the URB.
901 * Otherwise, we give back it here.
902 */
903 usb_hcd_unlink_urb_from_ep(hcd, urb);
904
905 spin_unlock_irqrestore(&vhci->lock, flags);
906 usb_hcd_giveback_urb(hcd, urb, urb->status);
907 spin_lock_irqsave(&vhci->lock, flags);
908
909 } else {
910 /* tcp connection is alive */
911 struct vhci_unlink *unlink;
912
913 spin_lock(&vdev->priv_lock);
914
915 /* setup CMD_UNLINK pdu */
916 unlink = kzalloc(sizeof(struct vhci_unlink), GFP_ATOMIC);
917 if (!unlink) {
918 spin_unlock(&vdev->priv_lock);
919 spin_unlock_irqrestore(&vhci->lock, flags);
920 usbip_event_add(&vdev->ud, VDEV_EVENT_ERROR_MALLOC);
921 return -ENOMEM;
922 }
923
924 unlink->seqnum = atomic_inc_return(&vhci_hcd->seqnum);
925 if (unlink->seqnum == 0xffff)
926 pr_info("seqnum max\n");
927
928 unlink->unlink_seqnum = priv->seqnum;
929
930 /* send cmd_unlink and try to cancel the pending URB in the
931 * peer */
932 list_add_tail(&unlink->list, &vdev->unlink_tx);
933 wake_up(&vdev->waitq_tx);
934
935 spin_unlock(&vdev->priv_lock);
936 }
937
938 spin_unlock_irqrestore(&vhci->lock, flags);
939
940 usbip_dbg_vhci_hc("leave\n");
941 return 0;
942 }
943
vhci_device_unlink_cleanup(struct vhci_device * vdev)944 static void vhci_device_unlink_cleanup(struct vhci_device *vdev)
945 {
946 struct vhci_hcd *vhci_hcd = vdev_to_vhci_hcd(vdev);
947 struct usb_hcd *hcd = vhci_hcd_to_hcd(vhci_hcd);
948 struct vhci *vhci = vhci_hcd->vhci;
949 struct vhci_unlink *unlink, *tmp;
950 unsigned long flags;
951
952 spin_lock_irqsave(&vhci->lock, flags);
953 spin_lock(&vdev->priv_lock);
954
955 list_for_each_entry_safe(unlink, tmp, &vdev->unlink_tx, list) {
956 pr_info("unlink cleanup tx %lu\n", unlink->unlink_seqnum);
957 list_del(&unlink->list);
958 kfree(unlink);
959 }
960
961 while (!list_empty(&vdev->unlink_rx)) {
962 struct urb *urb;
963
964 unlink = list_first_entry(&vdev->unlink_rx, struct vhci_unlink,
965 list);
966
967 /* give back URB of unanswered unlink request */
968 pr_info("unlink cleanup rx %lu\n", unlink->unlink_seqnum);
969
970 urb = pickup_urb_and_free_priv(vdev, unlink->unlink_seqnum);
971 if (!urb) {
972 pr_info("the urb (seqnum %lu) was already given back\n",
973 unlink->unlink_seqnum);
974 list_del(&unlink->list);
975 kfree(unlink);
976 continue;
977 }
978
979 urb->status = -ENODEV;
980
981 usb_hcd_unlink_urb_from_ep(hcd, urb);
982
983 list_del(&unlink->list);
984
985 spin_unlock(&vdev->priv_lock);
986 spin_unlock_irqrestore(&vhci->lock, flags);
987
988 usb_hcd_giveback_urb(hcd, urb, urb->status);
989
990 spin_lock_irqsave(&vhci->lock, flags);
991 spin_lock(&vdev->priv_lock);
992
993 kfree(unlink);
994 }
995
996 spin_unlock(&vdev->priv_lock);
997 spin_unlock_irqrestore(&vhci->lock, flags);
998 }
999
1000 /*
1001 * The important thing is that only one context begins cleanup.
1002 * This is why error handling and cleanup become simple.
1003 * We do not want to consider race condition as possible.
1004 */
vhci_shutdown_connection(struct usbip_device * ud)1005 static void vhci_shutdown_connection(struct usbip_device *ud)
1006 {
1007 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
1008
1009 /* need this? see stub_dev.c */
1010 if (ud->tcp_socket) {
1011 pr_debug("shutdown tcp_socket %d\n", ud->sockfd);
1012 kernel_sock_shutdown(ud->tcp_socket, SHUT_RDWR);
1013 }
1014
1015 /* kill threads related to this sdev */
1016 if (vdev->ud.tcp_rx) {
1017 kthread_stop_put(vdev->ud.tcp_rx);
1018 vdev->ud.tcp_rx = NULL;
1019 }
1020 if (vdev->ud.tcp_tx) {
1021 kthread_stop_put(vdev->ud.tcp_tx);
1022 vdev->ud.tcp_tx = NULL;
1023 }
1024 pr_info("stop threads\n");
1025
1026 /* active connection is closed */
1027 if (vdev->ud.tcp_socket) {
1028 sockfd_put(vdev->ud.tcp_socket);
1029 vdev->ud.tcp_socket = NULL;
1030 vdev->ud.sockfd = -1;
1031 }
1032 pr_info("release socket\n");
1033
1034 vhci_device_unlink_cleanup(vdev);
1035
1036 /*
1037 * rh_port_disconnect() is a trigger of ...
1038 * usb_disable_device():
1039 * disable all the endpoints for a USB device.
1040 * usb_disable_endpoint():
1041 * disable endpoints. pending urbs are unlinked(dequeued).
1042 *
1043 * NOTE: After calling rh_port_disconnect(), the USB device drivers of a
1044 * detached device should release used urbs in a cleanup function (i.e.
1045 * xxx_disconnect()). Therefore, vhci_hcd does not need to release
1046 * pushed urbs and their private data in this function.
1047 *
1048 * NOTE: vhci_dequeue() must be considered carefully. When shutting down
1049 * a connection, vhci_shutdown_connection() expects vhci_dequeue()
1050 * gives back pushed urbs and frees their private data by request of
1051 * the cleanup function of a USB driver. When unlinking a urb with an
1052 * active connection, vhci_dequeue() does not give back the urb which
1053 * is actually given back by vhci_rx after receiving its return pdu.
1054 *
1055 */
1056 rh_port_disconnect(vdev);
1057
1058 pr_info("disconnect device\n");
1059 }
1060
vhci_device_reset(struct usbip_device * ud)1061 static void vhci_device_reset(struct usbip_device *ud)
1062 {
1063 struct vhci_device *vdev = container_of(ud, struct vhci_device, ud);
1064 unsigned long flags;
1065
1066 spin_lock_irqsave(&ud->lock, flags);
1067
1068 vdev->speed = 0;
1069 vdev->devid = 0;
1070
1071 usb_put_dev(vdev->udev);
1072 vdev->udev = NULL;
1073
1074 if (ud->tcp_socket) {
1075 sockfd_put(ud->tcp_socket);
1076 ud->tcp_socket = NULL;
1077 ud->sockfd = -1;
1078 }
1079 ud->status = VDEV_ST_NULL;
1080
1081 spin_unlock_irqrestore(&ud->lock, flags);
1082 }
1083
vhci_device_unusable(struct usbip_device * ud)1084 static void vhci_device_unusable(struct usbip_device *ud)
1085 {
1086 unsigned long flags;
1087
1088 spin_lock_irqsave(&ud->lock, flags);
1089 ud->status = VDEV_ST_ERROR;
1090 spin_unlock_irqrestore(&ud->lock, flags);
1091 }
1092
vhci_device_init(struct vhci_device * vdev)1093 static void vhci_device_init(struct vhci_device *vdev)
1094 {
1095 memset(vdev, 0, sizeof(struct vhci_device));
1096
1097 vdev->ud.side = USBIP_VHCI;
1098 vdev->ud.status = VDEV_ST_NULL;
1099 spin_lock_init(&vdev->ud.lock);
1100
1101 INIT_LIST_HEAD(&vdev->priv_rx);
1102 INIT_LIST_HEAD(&vdev->priv_tx);
1103 INIT_LIST_HEAD(&vdev->unlink_tx);
1104 INIT_LIST_HEAD(&vdev->unlink_rx);
1105 spin_lock_init(&vdev->priv_lock);
1106
1107 init_waitqueue_head(&vdev->waitq_tx);
1108
1109 vdev->ud.eh_ops.shutdown = vhci_shutdown_connection;
1110 vdev->ud.eh_ops.reset = vhci_device_reset;
1111 vdev->ud.eh_ops.unusable = vhci_device_unusable;
1112
1113 usbip_start_eh(&vdev->ud);
1114 }
1115
hcd_name_to_id(const char * name)1116 static int hcd_name_to_id(const char *name)
1117 {
1118 char *c;
1119 long val;
1120 int ret;
1121
1122 c = strchr(name, '.');
1123 if (c == NULL)
1124 return 0;
1125
1126 ret = kstrtol(c+1, 10, &val);
1127 if (ret < 0)
1128 return ret;
1129
1130 return val;
1131 }
1132
vhci_setup(struct usb_hcd * hcd)1133 static int vhci_setup(struct usb_hcd *hcd)
1134 {
1135 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1136 if (usb_hcd_is_primary_hcd(hcd)) {
1137 vhci->vhci_hcd_hs = hcd_to_vhci_hcd(hcd);
1138 vhci->vhci_hcd_hs->vhci = vhci;
1139 /*
1140 * Mark the first roothub as being USB 2.0.
1141 * The USB 3.0 roothub will be registered later by
1142 * vhci_hcd_probe()
1143 */
1144 hcd->speed = HCD_USB2;
1145 hcd->self.root_hub->speed = USB_SPEED_HIGH;
1146 } else {
1147 vhci->vhci_hcd_ss = hcd_to_vhci_hcd(hcd);
1148 vhci->vhci_hcd_ss->vhci = vhci;
1149 hcd->speed = HCD_USB3;
1150 hcd->self.root_hub->speed = USB_SPEED_SUPER;
1151 }
1152
1153 /*
1154 * Support SG.
1155 * sg_tablesize is an arbitrary value to alleviate memory pressure
1156 * on the host.
1157 */
1158 hcd->self.sg_tablesize = 32;
1159 hcd->self.no_sg_constraint = 1;
1160
1161 return 0;
1162 }
1163
vhci_start(struct usb_hcd * hcd)1164 static int vhci_start(struct usb_hcd *hcd)
1165 {
1166 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1167 int id, rhport;
1168 int err;
1169
1170 usbip_dbg_vhci_hc("enter vhci_start\n");
1171
1172 if (usb_hcd_is_primary_hcd(hcd))
1173 spin_lock_init(&vhci_hcd->vhci->lock);
1174
1175 /* initialize private data of usb_hcd */
1176
1177 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1178 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1179
1180 vhci_device_init(vdev);
1181 vdev->rhport = rhport;
1182 }
1183
1184 atomic_set(&vhci_hcd->seqnum, 0);
1185
1186 hcd->power_budget = 0; /* no limit */
1187 hcd->uses_new_polling = 1;
1188
1189 #ifdef CONFIG_USB_OTG
1190 hcd->self.otg_port = 1;
1191 #endif
1192
1193 id = hcd_name_to_id(hcd_name(hcd));
1194 if (id < 0) {
1195 pr_err("invalid vhci name %s\n", hcd_name(hcd));
1196 return -EINVAL;
1197 }
1198
1199 /* vhci_hcd is now ready to be controlled through sysfs */
1200 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1201 err = vhci_init_attr_group();
1202 if (err) {
1203 dev_err(hcd_dev(hcd), "init attr group failed, err = %d\n", err);
1204 return err;
1205 }
1206 err = sysfs_create_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1207 if (err) {
1208 dev_err(hcd_dev(hcd), "create sysfs files failed, err = %d\n", err);
1209 vhci_finish_attr_group();
1210 return err;
1211 }
1212 pr_info("created sysfs %s\n", hcd_name(hcd));
1213 }
1214
1215 return 0;
1216 }
1217
vhci_stop(struct usb_hcd * hcd)1218 static void vhci_stop(struct usb_hcd *hcd)
1219 {
1220 struct vhci_hcd *vhci_hcd = hcd_to_vhci_hcd(hcd);
1221 int id, rhport;
1222
1223 usbip_dbg_vhci_hc("stop VHCI controller\n");
1224
1225 /* 1. remove the userland interface of vhci_hcd */
1226 id = hcd_name_to_id(hcd_name(hcd));
1227 if (id == 0 && usb_hcd_is_primary_hcd(hcd)) {
1228 sysfs_remove_group(&hcd_dev(hcd)->kobj, &vhci_attr_group);
1229 vhci_finish_attr_group();
1230 }
1231
1232 /* 2. shutdown all the ports of vhci_hcd */
1233 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1234 struct vhci_device *vdev = &vhci_hcd->vdev[rhport];
1235
1236 usbip_event_add(&vdev->ud, VDEV_EVENT_REMOVED);
1237 usbip_stop_eh(&vdev->ud);
1238 }
1239 }
1240
vhci_get_frame_number(struct usb_hcd * hcd)1241 static int vhci_get_frame_number(struct usb_hcd *hcd)
1242 {
1243 dev_err_ratelimited(&hcd->self.root_hub->dev, "Not yet implemented\n");
1244 return 0;
1245 }
1246
1247 #ifdef CONFIG_PM
1248
1249 /* FIXME: suspend/resume */
vhci_bus_suspend(struct usb_hcd * hcd)1250 static int vhci_bus_suspend(struct usb_hcd *hcd)
1251 {
1252 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1253 unsigned long flags;
1254
1255 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1256
1257 spin_lock_irqsave(&vhci->lock, flags);
1258 hcd->state = HC_STATE_SUSPENDED;
1259 spin_unlock_irqrestore(&vhci->lock, flags);
1260
1261 return 0;
1262 }
1263
vhci_bus_resume(struct usb_hcd * hcd)1264 static int vhci_bus_resume(struct usb_hcd *hcd)
1265 {
1266 struct vhci *vhci = *((void **)dev_get_platdata(hcd->self.controller));
1267 int rc = 0;
1268 unsigned long flags;
1269
1270 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
1271
1272 spin_lock_irqsave(&vhci->lock, flags);
1273 if (!HCD_HW_ACCESSIBLE(hcd))
1274 rc = -ESHUTDOWN;
1275 else
1276 hcd->state = HC_STATE_RUNNING;
1277 spin_unlock_irqrestore(&vhci->lock, flags);
1278
1279 return rc;
1280 }
1281
1282 #else
1283
1284 #define vhci_bus_suspend NULL
1285 #define vhci_bus_resume NULL
1286 #endif
1287
1288 /* 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)1289 static int vhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1290 struct usb_host_endpoint **eps, unsigned int num_eps,
1291 unsigned int num_streams, gfp_t mem_flags)
1292 {
1293 dev_dbg(&hcd->self.root_hub->dev, "vhci_alloc_streams not implemented\n");
1294 return 0;
1295 }
1296
1297 /* 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)1298 static int vhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1299 struct usb_host_endpoint **eps, unsigned int num_eps,
1300 gfp_t mem_flags)
1301 {
1302 dev_dbg(&hcd->self.root_hub->dev, "vhci_free_streams not implemented\n");
1303 return 0;
1304 }
1305
1306 static const struct hc_driver vhci_hc_driver = {
1307 .description = driver_name,
1308 .product_desc = driver_desc,
1309 .hcd_priv_size = sizeof(struct vhci_hcd),
1310
1311 .flags = HCD_USB3 | HCD_SHARED,
1312
1313 .reset = vhci_setup,
1314 .start = vhci_start,
1315 .stop = vhci_stop,
1316
1317 .urb_enqueue = vhci_urb_enqueue,
1318 .urb_dequeue = vhci_urb_dequeue,
1319
1320 .get_frame_number = vhci_get_frame_number,
1321
1322 .hub_status_data = vhci_hub_status,
1323 .hub_control = vhci_hub_control,
1324 .bus_suspend = vhci_bus_suspend,
1325 .bus_resume = vhci_bus_resume,
1326
1327 .alloc_streams = vhci_alloc_streams,
1328 .free_streams = vhci_free_streams,
1329 };
1330
vhci_hcd_probe(struct platform_device * pdev)1331 static int vhci_hcd_probe(struct platform_device *pdev)
1332 {
1333 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1334 struct usb_hcd *hcd_hs;
1335 struct usb_hcd *hcd_ss;
1336 int ret;
1337
1338 usbip_dbg_vhci_hc("name %s id %d\n", pdev->name, pdev->id);
1339
1340 /*
1341 * Allocate and initialize hcd.
1342 * Our private data is also allocated automatically.
1343 */
1344 hcd_hs = usb_create_hcd(&vhci_hc_driver, &pdev->dev, dev_name(&pdev->dev));
1345 if (!hcd_hs) {
1346 pr_err("create primary hcd failed\n");
1347 return -ENOMEM;
1348 }
1349 hcd_hs->has_tt = 1;
1350
1351 /*
1352 * Finish generic HCD structure initialization and register.
1353 * Call the driver's reset() and start() routines.
1354 */
1355 ret = usb_add_hcd(hcd_hs, 0, 0);
1356 if (ret != 0) {
1357 pr_err("usb_add_hcd hs failed %d\n", ret);
1358 goto put_usb2_hcd;
1359 }
1360
1361 hcd_ss = usb_create_shared_hcd(&vhci_hc_driver, &pdev->dev,
1362 dev_name(&pdev->dev), hcd_hs);
1363 if (!hcd_ss) {
1364 ret = -ENOMEM;
1365 pr_err("create shared hcd failed\n");
1366 goto remove_usb2_hcd;
1367 }
1368
1369 ret = usb_add_hcd(hcd_ss, 0, 0);
1370 if (ret) {
1371 pr_err("usb_add_hcd ss failed %d\n", ret);
1372 goto put_usb3_hcd;
1373 }
1374
1375 usbip_dbg_vhci_hc("bye\n");
1376 return 0;
1377
1378 put_usb3_hcd:
1379 usb_put_hcd(hcd_ss);
1380 remove_usb2_hcd:
1381 usb_remove_hcd(hcd_hs);
1382 put_usb2_hcd:
1383 usb_put_hcd(hcd_hs);
1384 vhci->vhci_hcd_hs = NULL;
1385 vhci->vhci_hcd_ss = NULL;
1386 return ret;
1387 }
1388
vhci_hcd_remove(struct platform_device * pdev)1389 static int vhci_hcd_remove(struct platform_device *pdev)
1390 {
1391 struct vhci *vhci = *((void **)dev_get_platdata(&pdev->dev));
1392
1393 /*
1394 * Disconnects the root hub,
1395 * then reverses the effects of usb_add_hcd(),
1396 * invoking the HCD's stop() methods.
1397 */
1398 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1399 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_ss));
1400
1401 usb_remove_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1402 usb_put_hcd(vhci_hcd_to_hcd(vhci->vhci_hcd_hs));
1403
1404 vhci->vhci_hcd_hs = NULL;
1405 vhci->vhci_hcd_ss = NULL;
1406
1407 return 0;
1408 }
1409
1410 #ifdef CONFIG_PM
1411
1412 /* what should happen for USB/IP under suspend/resume? */
vhci_hcd_suspend(struct platform_device * pdev,pm_message_t state)1413 static int vhci_hcd_suspend(struct platform_device *pdev, pm_message_t state)
1414 {
1415 struct usb_hcd *hcd;
1416 struct vhci *vhci;
1417 int rhport;
1418 int connected = 0;
1419 int ret = 0;
1420 unsigned long flags;
1421
1422 dev_dbg(&pdev->dev, "%s\n", __func__);
1423
1424 hcd = platform_get_drvdata(pdev);
1425 if (!hcd)
1426 return 0;
1427
1428 vhci = *((void **)dev_get_platdata(hcd->self.controller));
1429
1430 spin_lock_irqsave(&vhci->lock, flags);
1431
1432 for (rhport = 0; rhport < VHCI_HC_PORTS; rhport++) {
1433 if (vhci->vhci_hcd_hs->port_status[rhport] &
1434 USB_PORT_STAT_CONNECTION)
1435 connected += 1;
1436
1437 if (vhci->vhci_hcd_ss->port_status[rhport] &
1438 USB_PORT_STAT_CONNECTION)
1439 connected += 1;
1440 }
1441
1442 spin_unlock_irqrestore(&vhci->lock, flags);
1443
1444 if (connected > 0) {
1445 dev_info(&pdev->dev,
1446 "We have %d active connection%s. Do not suspend.\n",
1447 connected, (connected == 1 ? "" : "s"));
1448 ret = -EBUSY;
1449 } else {
1450 dev_info(&pdev->dev, "suspend vhci_hcd");
1451 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1452 }
1453
1454 return ret;
1455 }
1456
vhci_hcd_resume(struct platform_device * pdev)1457 static int vhci_hcd_resume(struct platform_device *pdev)
1458 {
1459 struct usb_hcd *hcd;
1460
1461 dev_dbg(&pdev->dev, "%s\n", __func__);
1462
1463 hcd = platform_get_drvdata(pdev);
1464 if (!hcd)
1465 return 0;
1466 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1467 usb_hcd_poll_rh_status(hcd);
1468
1469 return 0;
1470 }
1471
1472 #else
1473
1474 #define vhci_hcd_suspend NULL
1475 #define vhci_hcd_resume NULL
1476
1477 #endif
1478
1479 static struct platform_driver vhci_driver = {
1480 .probe = vhci_hcd_probe,
1481 .remove = vhci_hcd_remove,
1482 .suspend = vhci_hcd_suspend,
1483 .resume = vhci_hcd_resume,
1484 .driver = {
1485 .name = driver_name,
1486 },
1487 };
1488
del_platform_devices(void)1489 static void del_platform_devices(void)
1490 {
1491 struct platform_device *pdev;
1492 int i;
1493
1494 for (i = 0; i < vhci_num_controllers; i++) {
1495 pdev = vhcis[i].pdev;
1496 if (pdev != NULL)
1497 platform_device_unregister(pdev);
1498 vhcis[i].pdev = NULL;
1499 }
1500 sysfs_remove_link(&platform_bus.kobj, driver_name);
1501 }
1502
vhci_hcd_init(void)1503 static int __init vhci_hcd_init(void)
1504 {
1505 int i, ret;
1506
1507 if (usb_disabled())
1508 return -ENODEV;
1509
1510 if (vhci_num_controllers < 1)
1511 vhci_num_controllers = 1;
1512
1513 vhcis = kcalloc(vhci_num_controllers, sizeof(struct vhci), GFP_KERNEL);
1514 if (vhcis == NULL)
1515 return -ENOMEM;
1516
1517 for (i = 0; i < vhci_num_controllers; i++) {
1518 vhcis[i].pdev = platform_device_alloc(driver_name, i);
1519 if (!vhcis[i].pdev) {
1520 i--;
1521 while (i >= 0)
1522 platform_device_put(vhcis[i--].pdev);
1523 ret = -ENOMEM;
1524 goto err_device_alloc;
1525 }
1526 }
1527 for (i = 0; i < vhci_num_controllers; i++) {
1528 void *vhci = &vhcis[i];
1529 ret = platform_device_add_data(vhcis[i].pdev, &vhci, sizeof(void *));
1530 if (ret)
1531 goto err_driver_register;
1532 }
1533
1534 ret = platform_driver_register(&vhci_driver);
1535 if (ret)
1536 goto err_driver_register;
1537
1538 for (i = 0; i < vhci_num_controllers; i++) {
1539 ret = platform_device_add(vhcis[i].pdev);
1540 if (ret < 0) {
1541 i--;
1542 while (i >= 0)
1543 platform_device_del(vhcis[i--].pdev);
1544 goto err_add_hcd;
1545 }
1546 }
1547
1548 return ret;
1549
1550 err_add_hcd:
1551 platform_driver_unregister(&vhci_driver);
1552 err_driver_register:
1553 for (i = 0; i < vhci_num_controllers; i++)
1554 platform_device_put(vhcis[i].pdev);
1555 err_device_alloc:
1556 kfree(vhcis);
1557 return ret;
1558 }
1559
vhci_hcd_exit(void)1560 static void __exit vhci_hcd_exit(void)
1561 {
1562 del_platform_devices();
1563 platform_driver_unregister(&vhci_driver);
1564 kfree(vhcis);
1565 }
1566
1567 module_init(vhci_hcd_init);
1568 module_exit(vhci_hcd_exit);
1569
1570 MODULE_AUTHOR(DRIVER_AUTHOR);
1571 MODULE_DESCRIPTION(DRIVER_DESC);
1572 MODULE_LICENSE("GPL");
1573
