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