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