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