xref: /linux/drivers/usb/gadget/udc/dummy_hcd.c (revision 6fdcba32711044c35c0e1b094cbd8f3f0b4472c9)
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * dummy_hcd.c -- Dummy/Loopback USB host and device emulator driver.
4  *
5  * Maintainer: Alan Stern <stern@rowland.harvard.edu>
6  *
7  * Copyright (C) 2003 David Brownell
8  * Copyright (C) 2003-2005 Alan Stern
9  */
10 
11 
12 /*
13  * This exposes a device side "USB gadget" API, driven by requests to a
14  * Linux-USB host controller driver.  USB traffic is simulated; there's
15  * no need for USB hardware.  Use this with two other drivers:
16  *
17  *  - Gadget driver, responding to requests (slave);
18  *  - Host-side device driver, as already familiar in Linux.
19  *
20  * Having this all in one kernel can help some stages of development,
21  * bypassing some hardware (and driver) issues.  UML could help too.
22  *
23  * Note: The emulation does not include isochronous transfers!
24  */
25 
26 #include <linux/module.h>
27 #include <linux/kernel.h>
28 #include <linux/delay.h>
29 #include <linux/ioport.h>
30 #include <linux/slab.h>
31 #include <linux/errno.h>
32 #include <linux/init.h>
33 #include <linux/timer.h>
34 #include <linux/list.h>
35 #include <linux/interrupt.h>
36 #include <linux/platform_device.h>
37 #include <linux/usb.h>
38 #include <linux/usb/gadget.h>
39 #include <linux/usb/hcd.h>
40 #include <linux/scatterlist.h>
41 
42 #include <asm/byteorder.h>
43 #include <linux/io.h>
44 #include <asm/irq.h>
45 #include <asm/unaligned.h>
46 
47 #define DRIVER_DESC	"USB Host+Gadget Emulator"
48 #define DRIVER_VERSION	"02 May 2005"
49 
50 #define POWER_BUDGET	500	/* in mA; use 8 for low-power port testing */
51 #define POWER_BUDGET_3	900	/* in mA */
52 
53 static const char	driver_name[] = "dummy_hcd";
54 static const char	driver_desc[] = "USB Host+Gadget Emulator";
55 
56 static const char	gadget_name[] = "dummy_udc";
57 
58 MODULE_DESCRIPTION(DRIVER_DESC);
59 MODULE_AUTHOR("David Brownell");
60 MODULE_LICENSE("GPL");
61 
62 struct dummy_hcd_module_parameters {
63 	bool is_super_speed;
64 	bool is_high_speed;
65 	unsigned int num;
66 };
67 
68 static struct dummy_hcd_module_parameters mod_data = {
69 	.is_super_speed = false,
70 	.is_high_speed = true,
71 	.num = 1,
72 };
73 module_param_named(is_super_speed, mod_data.is_super_speed, bool, S_IRUGO);
74 MODULE_PARM_DESC(is_super_speed, "true to simulate SuperSpeed connection");
75 module_param_named(is_high_speed, mod_data.is_high_speed, bool, S_IRUGO);
76 MODULE_PARM_DESC(is_high_speed, "true to simulate HighSpeed connection");
77 module_param_named(num, mod_data.num, uint, S_IRUGO);
78 MODULE_PARM_DESC(num, "number of emulated controllers");
79 /*-------------------------------------------------------------------------*/
80 
81 /* gadget side driver data structres */
82 struct dummy_ep {
83 	struct list_head		queue;
84 	unsigned long			last_io;	/* jiffies timestamp */
85 	struct usb_gadget		*gadget;
86 	const struct usb_endpoint_descriptor *desc;
87 	struct usb_ep			ep;
88 	unsigned			halted:1;
89 	unsigned			wedged:1;
90 	unsigned			already_seen:1;
91 	unsigned			setup_stage:1;
92 	unsigned			stream_en:1;
93 };
94 
95 struct dummy_request {
96 	struct list_head		queue;		/* ep's requests */
97 	struct usb_request		req;
98 };
99 
100 static inline struct dummy_ep *usb_ep_to_dummy_ep(struct usb_ep *_ep)
101 {
102 	return container_of(_ep, struct dummy_ep, ep);
103 }
104 
105 static inline struct dummy_request *usb_request_to_dummy_request
106 		(struct usb_request *_req)
107 {
108 	return container_of(_req, struct dummy_request, req);
109 }
110 
111 /*-------------------------------------------------------------------------*/
112 
113 /*
114  * Every device has ep0 for control requests, plus up to 30 more endpoints,
115  * in one of two types:
116  *
117  *   - Configurable:  direction (in/out), type (bulk, iso, etc), and endpoint
118  *     number can be changed.  Names like "ep-a" are used for this type.
119  *
120  *   - Fixed Function:  in other cases.  some characteristics may be mutable;
121  *     that'd be hardware-specific.  Names like "ep12out-bulk" are used.
122  *
123  * Gadget drivers are responsible for not setting up conflicting endpoint
124  * configurations, illegal or unsupported packet lengths, and so on.
125  */
126 
127 static const char ep0name[] = "ep0";
128 
129 static const struct {
130 	const char *name;
131 	const struct usb_ep_caps caps;
132 } ep_info[] = {
133 #define EP_INFO(_name, _caps) \
134 	{ \
135 		.name = _name, \
136 		.caps = _caps, \
137 	}
138 
139 /* we don't provide isochronous endpoints since we don't support them */
140 #define TYPE_BULK_OR_INT	(USB_EP_CAPS_TYPE_BULK | USB_EP_CAPS_TYPE_INT)
141 
142 	/* everyone has ep0 */
143 	EP_INFO(ep0name,
144 		USB_EP_CAPS(USB_EP_CAPS_TYPE_CONTROL, USB_EP_CAPS_DIR_ALL)),
145 	/* act like a pxa250: fifteen fixed function endpoints */
146 	EP_INFO("ep1in-bulk",
147 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
148 	EP_INFO("ep2out-bulk",
149 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
150 /*
151 	EP_INFO("ep3in-iso",
152 		USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
153 	EP_INFO("ep4out-iso",
154 		USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
155 */
156 	EP_INFO("ep5in-int",
157 		USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
158 	EP_INFO("ep6in-bulk",
159 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
160 	EP_INFO("ep7out-bulk",
161 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
162 /*
163 	EP_INFO("ep8in-iso",
164 		USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
165 	EP_INFO("ep9out-iso",
166 		USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
167 */
168 	EP_INFO("ep10in-int",
169 		USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
170 	EP_INFO("ep11in-bulk",
171 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
172 	EP_INFO("ep12out-bulk",
173 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
174 /*
175 	EP_INFO("ep13in-iso",
176 		USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
177 	EP_INFO("ep14out-iso",
178 		USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
179 */
180 	EP_INFO("ep15in-int",
181 		USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
182 
183 	/* or like sa1100: two fixed function endpoints */
184 	EP_INFO("ep1out-bulk",
185 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
186 	EP_INFO("ep2in-bulk",
187 		USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
188 
189 	/* and now some generic EPs so we have enough in multi config */
190 	EP_INFO("ep3out",
191 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
192 	EP_INFO("ep4in",
193 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_IN)),
194 	EP_INFO("ep5out",
195 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
196 	EP_INFO("ep6out",
197 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
198 	EP_INFO("ep7in",
199 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_IN)),
200 	EP_INFO("ep8out",
201 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
202 	EP_INFO("ep9in",
203 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_IN)),
204 	EP_INFO("ep10out",
205 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
206 	EP_INFO("ep11out",
207 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
208 	EP_INFO("ep12in",
209 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_IN)),
210 	EP_INFO("ep13out",
211 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
212 	EP_INFO("ep14in",
213 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_IN)),
214 	EP_INFO("ep15out",
215 		USB_EP_CAPS(TYPE_BULK_OR_INT, USB_EP_CAPS_DIR_OUT)),
216 
217 #undef EP_INFO
218 };
219 
220 #define DUMMY_ENDPOINTS	ARRAY_SIZE(ep_info)
221 
222 /*-------------------------------------------------------------------------*/
223 
224 #define FIFO_SIZE		64
225 
226 struct urbp {
227 	struct urb		*urb;
228 	struct list_head	urbp_list;
229 	struct sg_mapping_iter	miter;
230 	u32			miter_started;
231 };
232 
233 
234 enum dummy_rh_state {
235 	DUMMY_RH_RESET,
236 	DUMMY_RH_SUSPENDED,
237 	DUMMY_RH_RUNNING
238 };
239 
240 struct dummy_hcd {
241 	struct dummy			*dum;
242 	enum dummy_rh_state		rh_state;
243 	struct timer_list		timer;
244 	u32				port_status;
245 	u32				old_status;
246 	unsigned long			re_timeout;
247 
248 	struct usb_device		*udev;
249 	struct list_head		urbp_list;
250 	struct urbp			*next_frame_urbp;
251 
252 	u32				stream_en_ep;
253 	u8				num_stream[30 / 2];
254 
255 	unsigned			active:1;
256 	unsigned			old_active:1;
257 	unsigned			resuming:1;
258 };
259 
260 struct dummy {
261 	spinlock_t			lock;
262 
263 	/*
264 	 * SLAVE/GADGET side support
265 	 */
266 	struct dummy_ep			ep[DUMMY_ENDPOINTS];
267 	int				address;
268 	int				callback_usage;
269 	struct usb_gadget		gadget;
270 	struct usb_gadget_driver	*driver;
271 	struct dummy_request		fifo_req;
272 	u8				fifo_buf[FIFO_SIZE];
273 	u16				devstatus;
274 	unsigned			ints_enabled:1;
275 	unsigned			udc_suspended:1;
276 	unsigned			pullup:1;
277 
278 	/*
279 	 * MASTER/HOST side support
280 	 */
281 	struct dummy_hcd		*hs_hcd;
282 	struct dummy_hcd		*ss_hcd;
283 };
284 
285 static inline struct dummy_hcd *hcd_to_dummy_hcd(struct usb_hcd *hcd)
286 {
287 	return (struct dummy_hcd *) (hcd->hcd_priv);
288 }
289 
290 static inline struct usb_hcd *dummy_hcd_to_hcd(struct dummy_hcd *dum)
291 {
292 	return container_of((void *) dum, struct usb_hcd, hcd_priv);
293 }
294 
295 static inline struct device *dummy_dev(struct dummy_hcd *dum)
296 {
297 	return dummy_hcd_to_hcd(dum)->self.controller;
298 }
299 
300 static inline struct device *udc_dev(struct dummy *dum)
301 {
302 	return dum->gadget.dev.parent;
303 }
304 
305 static inline struct dummy *ep_to_dummy(struct dummy_ep *ep)
306 {
307 	return container_of(ep->gadget, struct dummy, gadget);
308 }
309 
310 static inline struct dummy_hcd *gadget_to_dummy_hcd(struct usb_gadget *gadget)
311 {
312 	struct dummy *dum = container_of(gadget, struct dummy, gadget);
313 	if (dum->gadget.speed == USB_SPEED_SUPER)
314 		return dum->ss_hcd;
315 	else
316 		return dum->hs_hcd;
317 }
318 
319 static inline struct dummy *gadget_dev_to_dummy(struct device *dev)
320 {
321 	return container_of(dev, struct dummy, gadget.dev);
322 }
323 
324 /*-------------------------------------------------------------------------*/
325 
326 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
327 
328 /* called with spinlock held */
329 static void nuke(struct dummy *dum, struct dummy_ep *ep)
330 {
331 	while (!list_empty(&ep->queue)) {
332 		struct dummy_request	*req;
333 
334 		req = list_entry(ep->queue.next, struct dummy_request, queue);
335 		list_del_init(&req->queue);
336 		req->req.status = -ESHUTDOWN;
337 
338 		spin_unlock(&dum->lock);
339 		usb_gadget_giveback_request(&ep->ep, &req->req);
340 		spin_lock(&dum->lock);
341 	}
342 }
343 
344 /* caller must hold lock */
345 static void stop_activity(struct dummy *dum)
346 {
347 	int i;
348 
349 	/* prevent any more requests */
350 	dum->address = 0;
351 
352 	/* The timer is left running so that outstanding URBs can fail */
353 
354 	/* nuke any pending requests first, so driver i/o is quiesced */
355 	for (i = 0; i < DUMMY_ENDPOINTS; ++i)
356 		nuke(dum, &dum->ep[i]);
357 
358 	/* driver now does any non-usb quiescing necessary */
359 }
360 
361 /**
362  * set_link_state_by_speed() - Sets the current state of the link according to
363  *	the hcd speed
364  * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
365  *
366  * This function updates the port_status according to the link state and the
367  * speed of the hcd.
368  */
369 static void set_link_state_by_speed(struct dummy_hcd *dum_hcd)
370 {
371 	struct dummy *dum = dum_hcd->dum;
372 
373 	if (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3) {
374 		if ((dum_hcd->port_status & USB_SS_PORT_STAT_POWER) == 0) {
375 			dum_hcd->port_status = 0;
376 		} else if (!dum->pullup || dum->udc_suspended) {
377 			/* UDC suspend must cause a disconnect */
378 			dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
379 						USB_PORT_STAT_ENABLE);
380 			if ((dum_hcd->old_status &
381 			     USB_PORT_STAT_CONNECTION) != 0)
382 				dum_hcd->port_status |=
383 					(USB_PORT_STAT_C_CONNECTION << 16);
384 		} else {
385 			/* device is connected and not suspended */
386 			dum_hcd->port_status |= (USB_PORT_STAT_CONNECTION |
387 						 USB_PORT_STAT_SPEED_5GBPS) ;
388 			if ((dum_hcd->old_status &
389 			     USB_PORT_STAT_CONNECTION) == 0)
390 				dum_hcd->port_status |=
391 					(USB_PORT_STAT_C_CONNECTION << 16);
392 			if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) &&
393 			    (dum_hcd->port_status &
394 			     USB_PORT_STAT_LINK_STATE) == USB_SS_PORT_LS_U0 &&
395 			    dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
396 				dum_hcd->active = 1;
397 		}
398 	} else {
399 		if ((dum_hcd->port_status & USB_PORT_STAT_POWER) == 0) {
400 			dum_hcd->port_status = 0;
401 		} else if (!dum->pullup || dum->udc_suspended) {
402 			/* UDC suspend must cause a disconnect */
403 			dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
404 						USB_PORT_STAT_ENABLE |
405 						USB_PORT_STAT_LOW_SPEED |
406 						USB_PORT_STAT_HIGH_SPEED |
407 						USB_PORT_STAT_SUSPEND);
408 			if ((dum_hcd->old_status &
409 			     USB_PORT_STAT_CONNECTION) != 0)
410 				dum_hcd->port_status |=
411 					(USB_PORT_STAT_C_CONNECTION << 16);
412 		} else {
413 			dum_hcd->port_status |= USB_PORT_STAT_CONNECTION;
414 			if ((dum_hcd->old_status &
415 			     USB_PORT_STAT_CONNECTION) == 0)
416 				dum_hcd->port_status |=
417 					(USB_PORT_STAT_C_CONNECTION << 16);
418 			if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0)
419 				dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
420 			else if ((dum_hcd->port_status &
421 				  USB_PORT_STAT_SUSPEND) == 0 &&
422 					dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
423 				dum_hcd->active = 1;
424 		}
425 	}
426 }
427 
428 /* caller must hold lock */
429 static void set_link_state(struct dummy_hcd *dum_hcd)
430 {
431 	struct dummy *dum = dum_hcd->dum;
432 	unsigned int power_bit;
433 
434 	dum_hcd->active = 0;
435 	if (dum->pullup)
436 		if ((dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 &&
437 		     dum->gadget.speed != USB_SPEED_SUPER) ||
438 		    (dummy_hcd_to_hcd(dum_hcd)->speed != HCD_USB3 &&
439 		     dum->gadget.speed == USB_SPEED_SUPER))
440 			return;
441 
442 	set_link_state_by_speed(dum_hcd);
443 	power_bit = (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 ?
444 			USB_SS_PORT_STAT_POWER : USB_PORT_STAT_POWER);
445 
446 	if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0 ||
447 	     dum_hcd->active)
448 		dum_hcd->resuming = 0;
449 
450 	/* Currently !connected or in reset */
451 	if ((dum_hcd->port_status & power_bit) == 0 ||
452 			(dum_hcd->port_status & USB_PORT_STAT_RESET) != 0) {
453 		unsigned int disconnect = power_bit &
454 				dum_hcd->old_status & (~dum_hcd->port_status);
455 		unsigned int reset = USB_PORT_STAT_RESET &
456 				(~dum_hcd->old_status) & dum_hcd->port_status;
457 
458 		/* Report reset and disconnect events to the driver */
459 		if (dum->ints_enabled && (disconnect || reset)) {
460 			stop_activity(dum);
461 			++dum->callback_usage;
462 			spin_unlock(&dum->lock);
463 			if (reset)
464 				usb_gadget_udc_reset(&dum->gadget, dum->driver);
465 			else
466 				dum->driver->disconnect(&dum->gadget);
467 			spin_lock(&dum->lock);
468 			--dum->callback_usage;
469 		}
470 	} else if (dum_hcd->active != dum_hcd->old_active &&
471 			dum->ints_enabled) {
472 		++dum->callback_usage;
473 		spin_unlock(&dum->lock);
474 		if (dum_hcd->old_active && dum->driver->suspend)
475 			dum->driver->suspend(&dum->gadget);
476 		else if (!dum_hcd->old_active &&  dum->driver->resume)
477 			dum->driver->resume(&dum->gadget);
478 		spin_lock(&dum->lock);
479 		--dum->callback_usage;
480 	}
481 
482 	dum_hcd->old_status = dum_hcd->port_status;
483 	dum_hcd->old_active = dum_hcd->active;
484 }
485 
486 /*-------------------------------------------------------------------------*/
487 
488 /* SLAVE/GADGET SIDE DRIVER
489  *
490  * This only tracks gadget state.  All the work is done when the host
491  * side tries some (emulated) i/o operation.  Real device controller
492  * drivers would do real i/o using dma, fifos, irqs, timers, etc.
493  */
494 
495 #define is_enabled(dum) \
496 	(dum->port_status & USB_PORT_STAT_ENABLE)
497 
498 static int dummy_enable(struct usb_ep *_ep,
499 		const struct usb_endpoint_descriptor *desc)
500 {
501 	struct dummy		*dum;
502 	struct dummy_hcd	*dum_hcd;
503 	struct dummy_ep		*ep;
504 	unsigned		max;
505 	int			retval;
506 
507 	ep = usb_ep_to_dummy_ep(_ep);
508 	if (!_ep || !desc || ep->desc || _ep->name == ep0name
509 			|| desc->bDescriptorType != USB_DT_ENDPOINT)
510 		return -EINVAL;
511 	dum = ep_to_dummy(ep);
512 	if (!dum->driver)
513 		return -ESHUTDOWN;
514 
515 	dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
516 	if (!is_enabled(dum_hcd))
517 		return -ESHUTDOWN;
518 
519 	/*
520 	 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
521 	 * maximum packet size.
522 	 * For SS devices the wMaxPacketSize is limited by 1024.
523 	 */
524 	max = usb_endpoint_maxp(desc);
525 
526 	/* drivers must not request bad settings, since lower levels
527 	 * (hardware or its drivers) may not check.  some endpoints
528 	 * can't do iso, many have maxpacket limitations, etc.
529 	 *
530 	 * since this "hardware" driver is here to help debugging, we
531 	 * have some extra sanity checks.  (there could be more though,
532 	 * especially for "ep9out" style fixed function ones.)
533 	 */
534 	retval = -EINVAL;
535 	switch (usb_endpoint_type(desc)) {
536 	case USB_ENDPOINT_XFER_BULK:
537 		if (strstr(ep->ep.name, "-iso")
538 				|| strstr(ep->ep.name, "-int")) {
539 			goto done;
540 		}
541 		switch (dum->gadget.speed) {
542 		case USB_SPEED_SUPER:
543 			if (max == 1024)
544 				break;
545 			goto done;
546 		case USB_SPEED_HIGH:
547 			if (max == 512)
548 				break;
549 			goto done;
550 		case USB_SPEED_FULL:
551 			if (max == 8 || max == 16 || max == 32 || max == 64)
552 				/* we'll fake any legal size */
553 				break;
554 			/* save a return statement */
555 		default:
556 			goto done;
557 		}
558 		break;
559 	case USB_ENDPOINT_XFER_INT:
560 		if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
561 			goto done;
562 		/* real hardware might not handle all packet sizes */
563 		switch (dum->gadget.speed) {
564 		case USB_SPEED_SUPER:
565 		case USB_SPEED_HIGH:
566 			if (max <= 1024)
567 				break;
568 			/* save a return statement */
569 			/* fall through */
570 		case USB_SPEED_FULL:
571 			if (max <= 64)
572 				break;
573 			/* save a return statement */
574 			/* fall through */
575 		default:
576 			if (max <= 8)
577 				break;
578 			goto done;
579 		}
580 		break;
581 	case USB_ENDPOINT_XFER_ISOC:
582 		if (strstr(ep->ep.name, "-bulk")
583 				|| strstr(ep->ep.name, "-int"))
584 			goto done;
585 		/* real hardware might not handle all packet sizes */
586 		switch (dum->gadget.speed) {
587 		case USB_SPEED_SUPER:
588 		case USB_SPEED_HIGH:
589 			if (max <= 1024)
590 				break;
591 			/* save a return statement */
592 			/* fall through */
593 		case USB_SPEED_FULL:
594 			if (max <= 1023)
595 				break;
596 			/* save a return statement */
597 		default:
598 			goto done;
599 		}
600 		break;
601 	default:
602 		/* few chips support control except on ep0 */
603 		goto done;
604 	}
605 
606 	_ep->maxpacket = max;
607 	if (usb_ss_max_streams(_ep->comp_desc)) {
608 		if (!usb_endpoint_xfer_bulk(desc)) {
609 			dev_err(udc_dev(dum), "Can't enable stream support on "
610 					"non-bulk ep %s\n", _ep->name);
611 			return -EINVAL;
612 		}
613 		ep->stream_en = 1;
614 	}
615 	ep->desc = desc;
616 
617 	dev_dbg(udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
618 		_ep->name,
619 		desc->bEndpointAddress & 0x0f,
620 		(desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
621 		usb_ep_type_string(usb_endpoint_type(desc)),
622 		max, ep->stream_en ? "enabled" : "disabled");
623 
624 	/* at this point real hardware should be NAKing transfers
625 	 * to that endpoint, until a buffer is queued to it.
626 	 */
627 	ep->halted = ep->wedged = 0;
628 	retval = 0;
629 done:
630 	return retval;
631 }
632 
633 static int dummy_disable(struct usb_ep *_ep)
634 {
635 	struct dummy_ep		*ep;
636 	struct dummy		*dum;
637 	unsigned long		flags;
638 
639 	ep = usb_ep_to_dummy_ep(_ep);
640 	if (!_ep || !ep->desc || _ep->name == ep0name)
641 		return -EINVAL;
642 	dum = ep_to_dummy(ep);
643 
644 	spin_lock_irqsave(&dum->lock, flags);
645 	ep->desc = NULL;
646 	ep->stream_en = 0;
647 	nuke(dum, ep);
648 	spin_unlock_irqrestore(&dum->lock, flags);
649 
650 	dev_dbg(udc_dev(dum), "disabled %s\n", _ep->name);
651 	return 0;
652 }
653 
654 static struct usb_request *dummy_alloc_request(struct usb_ep *_ep,
655 		gfp_t mem_flags)
656 {
657 	struct dummy_request	*req;
658 
659 	if (!_ep)
660 		return NULL;
661 
662 	req = kzalloc(sizeof(*req), mem_flags);
663 	if (!req)
664 		return NULL;
665 	INIT_LIST_HEAD(&req->queue);
666 	return &req->req;
667 }
668 
669 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
670 {
671 	struct dummy_request	*req;
672 
673 	if (!_ep || !_req) {
674 		WARN_ON(1);
675 		return;
676 	}
677 
678 	req = usb_request_to_dummy_request(_req);
679 	WARN_ON(!list_empty(&req->queue));
680 	kfree(req);
681 }
682 
683 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
684 {
685 }
686 
687 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
688 		gfp_t mem_flags)
689 {
690 	struct dummy_ep		*ep;
691 	struct dummy_request	*req;
692 	struct dummy		*dum;
693 	struct dummy_hcd	*dum_hcd;
694 	unsigned long		flags;
695 
696 	req = usb_request_to_dummy_request(_req);
697 	if (!_req || !list_empty(&req->queue) || !_req->complete)
698 		return -EINVAL;
699 
700 	ep = usb_ep_to_dummy_ep(_ep);
701 	if (!_ep || (!ep->desc && _ep->name != ep0name))
702 		return -EINVAL;
703 
704 	dum = ep_to_dummy(ep);
705 	dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
706 	if (!dum->driver || !is_enabled(dum_hcd))
707 		return -ESHUTDOWN;
708 
709 #if 0
710 	dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
711 			ep, _req, _ep->name, _req->length, _req->buf);
712 #endif
713 	_req->status = -EINPROGRESS;
714 	_req->actual = 0;
715 	spin_lock_irqsave(&dum->lock, flags);
716 
717 	/* implement an emulated single-request FIFO */
718 	if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
719 			list_empty(&dum->fifo_req.queue) &&
720 			list_empty(&ep->queue) &&
721 			_req->length <= FIFO_SIZE) {
722 		req = &dum->fifo_req;
723 		req->req = *_req;
724 		req->req.buf = dum->fifo_buf;
725 		memcpy(dum->fifo_buf, _req->buf, _req->length);
726 		req->req.context = dum;
727 		req->req.complete = fifo_complete;
728 
729 		list_add_tail(&req->queue, &ep->queue);
730 		spin_unlock(&dum->lock);
731 		_req->actual = _req->length;
732 		_req->status = 0;
733 		usb_gadget_giveback_request(_ep, _req);
734 		spin_lock(&dum->lock);
735 	}  else
736 		list_add_tail(&req->queue, &ep->queue);
737 	spin_unlock_irqrestore(&dum->lock, flags);
738 
739 	/* real hardware would likely enable transfers here, in case
740 	 * it'd been left NAKing.
741 	 */
742 	return 0;
743 }
744 
745 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
746 {
747 	struct dummy_ep		*ep;
748 	struct dummy		*dum;
749 	int			retval = -EINVAL;
750 	unsigned long		flags;
751 	struct dummy_request	*req = NULL;
752 
753 	if (!_ep || !_req)
754 		return retval;
755 	ep = usb_ep_to_dummy_ep(_ep);
756 	dum = ep_to_dummy(ep);
757 
758 	if (!dum->driver)
759 		return -ESHUTDOWN;
760 
761 	local_irq_save(flags);
762 	spin_lock(&dum->lock);
763 	list_for_each_entry(req, &ep->queue, queue) {
764 		if (&req->req == _req) {
765 			list_del_init(&req->queue);
766 			_req->status = -ECONNRESET;
767 			retval = 0;
768 			break;
769 		}
770 	}
771 	spin_unlock(&dum->lock);
772 
773 	if (retval == 0) {
774 		dev_dbg(udc_dev(dum),
775 				"dequeued req %p from %s, len %d buf %p\n",
776 				req, _ep->name, _req->length, _req->buf);
777 		usb_gadget_giveback_request(_ep, _req);
778 	}
779 	local_irq_restore(flags);
780 	return retval;
781 }
782 
783 static int
784 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
785 {
786 	struct dummy_ep		*ep;
787 	struct dummy		*dum;
788 
789 	if (!_ep)
790 		return -EINVAL;
791 	ep = usb_ep_to_dummy_ep(_ep);
792 	dum = ep_to_dummy(ep);
793 	if (!dum->driver)
794 		return -ESHUTDOWN;
795 	if (!value)
796 		ep->halted = ep->wedged = 0;
797 	else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
798 			!list_empty(&ep->queue))
799 		return -EAGAIN;
800 	else {
801 		ep->halted = 1;
802 		if (wedged)
803 			ep->wedged = 1;
804 	}
805 	/* FIXME clear emulated data toggle too */
806 	return 0;
807 }
808 
809 static int
810 dummy_set_halt(struct usb_ep *_ep, int value)
811 {
812 	return dummy_set_halt_and_wedge(_ep, value, 0);
813 }
814 
815 static int dummy_set_wedge(struct usb_ep *_ep)
816 {
817 	if (!_ep || _ep->name == ep0name)
818 		return -EINVAL;
819 	return dummy_set_halt_and_wedge(_ep, 1, 1);
820 }
821 
822 static const struct usb_ep_ops dummy_ep_ops = {
823 	.enable		= dummy_enable,
824 	.disable	= dummy_disable,
825 
826 	.alloc_request	= dummy_alloc_request,
827 	.free_request	= dummy_free_request,
828 
829 	.queue		= dummy_queue,
830 	.dequeue	= dummy_dequeue,
831 
832 	.set_halt	= dummy_set_halt,
833 	.set_wedge	= dummy_set_wedge,
834 };
835 
836 /*-------------------------------------------------------------------------*/
837 
838 /* there are both host and device side versions of this call ... */
839 static int dummy_g_get_frame(struct usb_gadget *_gadget)
840 {
841 	struct timespec64 ts64;
842 
843 	ktime_get_ts64(&ts64);
844 	return ts64.tv_nsec / NSEC_PER_MSEC;
845 }
846 
847 static int dummy_wakeup(struct usb_gadget *_gadget)
848 {
849 	struct dummy_hcd *dum_hcd;
850 
851 	dum_hcd = gadget_to_dummy_hcd(_gadget);
852 	if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
853 				| (1 << USB_DEVICE_REMOTE_WAKEUP))))
854 		return -EINVAL;
855 	if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
856 		return -ENOLINK;
857 	if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
858 			 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
859 		return -EIO;
860 
861 	/* FIXME: What if the root hub is suspended but the port isn't? */
862 
863 	/* hub notices our request, issues downstream resume, etc */
864 	dum_hcd->resuming = 1;
865 	dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
866 	mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
867 	return 0;
868 }
869 
870 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
871 {
872 	struct dummy	*dum;
873 
874 	_gadget->is_selfpowered = (value != 0);
875 	dum = gadget_to_dummy_hcd(_gadget)->dum;
876 	if (value)
877 		dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
878 	else
879 		dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
880 	return 0;
881 }
882 
883 static void dummy_udc_update_ep0(struct dummy *dum)
884 {
885 	if (dum->gadget.speed == USB_SPEED_SUPER)
886 		dum->ep[0].ep.maxpacket = 9;
887 	else
888 		dum->ep[0].ep.maxpacket = 64;
889 }
890 
891 static int dummy_pullup(struct usb_gadget *_gadget, int value)
892 {
893 	struct dummy_hcd *dum_hcd;
894 	struct dummy	*dum;
895 	unsigned long	flags;
896 
897 	dum = gadget_dev_to_dummy(&_gadget->dev);
898 	dum_hcd = gadget_to_dummy_hcd(_gadget);
899 
900 	spin_lock_irqsave(&dum->lock, flags);
901 	dum->pullup = (value != 0);
902 	set_link_state(dum_hcd);
903 	spin_unlock_irqrestore(&dum->lock, flags);
904 
905 	usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
906 	return 0;
907 }
908 
909 static void dummy_udc_set_speed(struct usb_gadget *_gadget,
910 		enum usb_device_speed speed)
911 {
912 	struct dummy	*dum;
913 
914 	dum = gadget_dev_to_dummy(&_gadget->dev);
915 	dum->gadget.speed = speed;
916 	dummy_udc_update_ep0(dum);
917 }
918 
919 static int dummy_udc_start(struct usb_gadget *g,
920 		struct usb_gadget_driver *driver);
921 static int dummy_udc_stop(struct usb_gadget *g);
922 
923 static const struct usb_gadget_ops dummy_ops = {
924 	.get_frame	= dummy_g_get_frame,
925 	.wakeup		= dummy_wakeup,
926 	.set_selfpowered = dummy_set_selfpowered,
927 	.pullup		= dummy_pullup,
928 	.udc_start	= dummy_udc_start,
929 	.udc_stop	= dummy_udc_stop,
930 	.udc_set_speed	= dummy_udc_set_speed,
931 };
932 
933 /*-------------------------------------------------------------------------*/
934 
935 /* "function" sysfs attribute */
936 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
937 		char *buf)
938 {
939 	struct dummy	*dum = gadget_dev_to_dummy(dev);
940 
941 	if (!dum->driver || !dum->driver->function)
942 		return 0;
943 	return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
944 }
945 static DEVICE_ATTR_RO(function);
946 
947 /*-------------------------------------------------------------------------*/
948 
949 /*
950  * Driver registration/unregistration.
951  *
952  * This is basically hardware-specific; there's usually only one real USB
953  * device (not host) controller since that's how USB devices are intended
954  * to work.  So most implementations of these api calls will rely on the
955  * fact that only one driver will ever bind to the hardware.  But curious
956  * hardware can be built with discrete components, so the gadget API doesn't
957  * require that assumption.
958  *
959  * For this emulator, it might be convenient to create a usb slave device
960  * for each driver that registers:  just add to a big root hub.
961  */
962 
963 static int dummy_udc_start(struct usb_gadget *g,
964 		struct usb_gadget_driver *driver)
965 {
966 	struct dummy_hcd	*dum_hcd = gadget_to_dummy_hcd(g);
967 	struct dummy		*dum = dum_hcd->dum;
968 
969 	switch (g->speed) {
970 	/* All the speeds we support */
971 	case USB_SPEED_LOW:
972 	case USB_SPEED_FULL:
973 	case USB_SPEED_HIGH:
974 	case USB_SPEED_SUPER:
975 		break;
976 	default:
977 		dev_err(dummy_dev(dum_hcd), "Unsupported driver max speed %d\n",
978 				driver->max_speed);
979 		return -EINVAL;
980 	}
981 
982 	/*
983 	 * SLAVE side init ... the layer above hardware, which
984 	 * can't enumerate without help from the driver we're binding.
985 	 */
986 
987 	spin_lock_irq(&dum->lock);
988 	dum->devstatus = 0;
989 	dum->driver = driver;
990 	dum->ints_enabled = 1;
991 	spin_unlock_irq(&dum->lock);
992 
993 	return 0;
994 }
995 
996 static int dummy_udc_stop(struct usb_gadget *g)
997 {
998 	struct dummy_hcd	*dum_hcd = gadget_to_dummy_hcd(g);
999 	struct dummy		*dum = dum_hcd->dum;
1000 
1001 	spin_lock_irq(&dum->lock);
1002 	dum->ints_enabled = 0;
1003 	stop_activity(dum);
1004 
1005 	/* emulate synchronize_irq(): wait for callbacks to finish */
1006 	while (dum->callback_usage > 0) {
1007 		spin_unlock_irq(&dum->lock);
1008 		usleep_range(1000, 2000);
1009 		spin_lock_irq(&dum->lock);
1010 	}
1011 
1012 	dum->driver = NULL;
1013 	spin_unlock_irq(&dum->lock);
1014 
1015 	return 0;
1016 }
1017 
1018 #undef is_enabled
1019 
1020 /* The gadget structure is stored inside the hcd structure and will be
1021  * released along with it. */
1022 static void init_dummy_udc_hw(struct dummy *dum)
1023 {
1024 	int i;
1025 
1026 	INIT_LIST_HEAD(&dum->gadget.ep_list);
1027 	for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1028 		struct dummy_ep	*ep = &dum->ep[i];
1029 
1030 		if (!ep_info[i].name)
1031 			break;
1032 		ep->ep.name = ep_info[i].name;
1033 		ep->ep.caps = ep_info[i].caps;
1034 		ep->ep.ops = &dummy_ep_ops;
1035 		list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1036 		ep->halted = ep->wedged = ep->already_seen =
1037 				ep->setup_stage = 0;
1038 		usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1039 		ep->ep.max_streams = 16;
1040 		ep->last_io = jiffies;
1041 		ep->gadget = &dum->gadget;
1042 		ep->desc = NULL;
1043 		INIT_LIST_HEAD(&ep->queue);
1044 	}
1045 
1046 	dum->gadget.ep0 = &dum->ep[0].ep;
1047 	list_del_init(&dum->ep[0].ep.ep_list);
1048 	INIT_LIST_HEAD(&dum->fifo_req.queue);
1049 
1050 #ifdef CONFIG_USB_OTG
1051 	dum->gadget.is_otg = 1;
1052 #endif
1053 }
1054 
1055 static int dummy_udc_probe(struct platform_device *pdev)
1056 {
1057 	struct dummy	*dum;
1058 	int		rc;
1059 
1060 	dum = *((void **)dev_get_platdata(&pdev->dev));
1061 	/* Clear usb_gadget region for new registration to udc-core */
1062 	memzero_explicit(&dum->gadget, sizeof(struct usb_gadget));
1063 	dum->gadget.name = gadget_name;
1064 	dum->gadget.ops = &dummy_ops;
1065 	if (mod_data.is_super_speed)
1066 		dum->gadget.max_speed = USB_SPEED_SUPER;
1067 	else if (mod_data.is_high_speed)
1068 		dum->gadget.max_speed = USB_SPEED_HIGH;
1069 	else
1070 		dum->gadget.max_speed = USB_SPEED_FULL;
1071 
1072 	dum->gadget.dev.parent = &pdev->dev;
1073 	init_dummy_udc_hw(dum);
1074 
1075 	rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1076 	if (rc < 0)
1077 		goto err_udc;
1078 
1079 	rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1080 	if (rc < 0)
1081 		goto err_dev;
1082 	platform_set_drvdata(pdev, dum);
1083 	return rc;
1084 
1085 err_dev:
1086 	usb_del_gadget_udc(&dum->gadget);
1087 err_udc:
1088 	return rc;
1089 }
1090 
1091 static int dummy_udc_remove(struct platform_device *pdev)
1092 {
1093 	struct dummy	*dum = platform_get_drvdata(pdev);
1094 
1095 	device_remove_file(&dum->gadget.dev, &dev_attr_function);
1096 	usb_del_gadget_udc(&dum->gadget);
1097 	return 0;
1098 }
1099 
1100 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1101 		int suspend)
1102 {
1103 	spin_lock_irq(&dum->lock);
1104 	dum->udc_suspended = suspend;
1105 	set_link_state(dum_hcd);
1106 	spin_unlock_irq(&dum->lock);
1107 }
1108 
1109 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1110 {
1111 	struct dummy		*dum = platform_get_drvdata(pdev);
1112 	struct dummy_hcd	*dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1113 
1114 	dev_dbg(&pdev->dev, "%s\n", __func__);
1115 	dummy_udc_pm(dum, dum_hcd, 1);
1116 	usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1117 	return 0;
1118 }
1119 
1120 static int dummy_udc_resume(struct platform_device *pdev)
1121 {
1122 	struct dummy		*dum = platform_get_drvdata(pdev);
1123 	struct dummy_hcd	*dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1124 
1125 	dev_dbg(&pdev->dev, "%s\n", __func__);
1126 	dummy_udc_pm(dum, dum_hcd, 0);
1127 	usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1128 	return 0;
1129 }
1130 
1131 static struct platform_driver dummy_udc_driver = {
1132 	.probe		= dummy_udc_probe,
1133 	.remove		= dummy_udc_remove,
1134 	.suspend	= dummy_udc_suspend,
1135 	.resume		= dummy_udc_resume,
1136 	.driver		= {
1137 		.name	= (char *) gadget_name,
1138 	},
1139 };
1140 
1141 /*-------------------------------------------------------------------------*/
1142 
1143 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1144 {
1145 	unsigned int index;
1146 
1147 	index = usb_endpoint_num(desc) << 1;
1148 	if (usb_endpoint_dir_in(desc))
1149 		index |= 1;
1150 	return index;
1151 }
1152 
1153 /* MASTER/HOST SIDE DRIVER
1154  *
1155  * this uses the hcd framework to hook up to host side drivers.
1156  * its root hub will only have one device, otherwise it acts like
1157  * a normal host controller.
1158  *
1159  * when urbs are queued, they're just stuck on a list that we
1160  * scan in a timer callback.  that callback connects writes from
1161  * the host with reads from the device, and so on, based on the
1162  * usb 2.0 rules.
1163  */
1164 
1165 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1166 {
1167 	const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1168 	u32 index;
1169 
1170 	if (!usb_endpoint_xfer_bulk(desc))
1171 		return 0;
1172 
1173 	index = dummy_get_ep_idx(desc);
1174 	return (1 << index) & dum_hcd->stream_en_ep;
1175 }
1176 
1177 /*
1178  * The max stream number is saved as a nibble so for the 30 possible endpoints
1179  * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1180  * means we use only 1 stream). The maximum according to the spec is 16bit so
1181  * if the 16 stream limit is about to go, the array size should be incremented
1182  * to 30 elements of type u16.
1183  */
1184 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1185 		unsigned int pipe)
1186 {
1187 	int max_streams;
1188 
1189 	max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1190 	if (usb_pipeout(pipe))
1191 		max_streams >>= 4;
1192 	else
1193 		max_streams &= 0xf;
1194 	max_streams++;
1195 	return max_streams;
1196 }
1197 
1198 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1199 		unsigned int pipe, unsigned int streams)
1200 {
1201 	int max_streams;
1202 
1203 	streams--;
1204 	max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1205 	if (usb_pipeout(pipe)) {
1206 		streams <<= 4;
1207 		max_streams &= 0xf;
1208 	} else {
1209 		max_streams &= 0xf0;
1210 	}
1211 	max_streams |= streams;
1212 	dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1213 }
1214 
1215 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1216 {
1217 	unsigned int max_streams;
1218 	int enabled;
1219 
1220 	enabled = dummy_ep_stream_en(dum_hcd, urb);
1221 	if (!urb->stream_id) {
1222 		if (enabled)
1223 			return -EINVAL;
1224 		return 0;
1225 	}
1226 	if (!enabled)
1227 		return -EINVAL;
1228 
1229 	max_streams = get_max_streams_for_pipe(dum_hcd,
1230 			usb_pipeendpoint(urb->pipe));
1231 	if (urb->stream_id > max_streams) {
1232 		dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1233 				urb->stream_id);
1234 		BUG();
1235 		return -EINVAL;
1236 	}
1237 	return 0;
1238 }
1239 
1240 static int dummy_urb_enqueue(
1241 	struct usb_hcd			*hcd,
1242 	struct urb			*urb,
1243 	gfp_t				mem_flags
1244 ) {
1245 	struct dummy_hcd *dum_hcd;
1246 	struct urbp	*urbp;
1247 	unsigned long	flags;
1248 	int		rc;
1249 
1250 	urbp = kmalloc(sizeof *urbp, mem_flags);
1251 	if (!urbp)
1252 		return -ENOMEM;
1253 	urbp->urb = urb;
1254 	urbp->miter_started = 0;
1255 
1256 	dum_hcd = hcd_to_dummy_hcd(hcd);
1257 	spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1258 
1259 	rc = dummy_validate_stream(dum_hcd, urb);
1260 	if (rc) {
1261 		kfree(urbp);
1262 		goto done;
1263 	}
1264 
1265 	rc = usb_hcd_link_urb_to_ep(hcd, urb);
1266 	if (rc) {
1267 		kfree(urbp);
1268 		goto done;
1269 	}
1270 
1271 	if (!dum_hcd->udev) {
1272 		dum_hcd->udev = urb->dev;
1273 		usb_get_dev(dum_hcd->udev);
1274 	} else if (unlikely(dum_hcd->udev != urb->dev))
1275 		dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1276 
1277 	list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1278 	urb->hcpriv = urbp;
1279 	if (!dum_hcd->next_frame_urbp)
1280 		dum_hcd->next_frame_urbp = urbp;
1281 	if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1282 		urb->error_count = 1;		/* mark as a new urb */
1283 
1284 	/* kick the scheduler, it'll do the rest */
1285 	if (!timer_pending(&dum_hcd->timer))
1286 		mod_timer(&dum_hcd->timer, jiffies + 1);
1287 
1288  done:
1289 	spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1290 	return rc;
1291 }
1292 
1293 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1294 {
1295 	struct dummy_hcd *dum_hcd;
1296 	unsigned long	flags;
1297 	int		rc;
1298 
1299 	/* giveback happens automatically in timer callback,
1300 	 * so make sure the callback happens */
1301 	dum_hcd = hcd_to_dummy_hcd(hcd);
1302 	spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1303 
1304 	rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1305 	if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1306 			!list_empty(&dum_hcd->urbp_list))
1307 		mod_timer(&dum_hcd->timer, jiffies);
1308 
1309 	spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1310 	return rc;
1311 }
1312 
1313 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1314 		u32 len)
1315 {
1316 	void *ubuf, *rbuf;
1317 	struct urbp *urbp = urb->hcpriv;
1318 	int to_host;
1319 	struct sg_mapping_iter *miter = &urbp->miter;
1320 	u32 trans = 0;
1321 	u32 this_sg;
1322 	bool next_sg;
1323 
1324 	to_host = usb_urb_dir_in(urb);
1325 	rbuf = req->req.buf + req->req.actual;
1326 
1327 	if (!urb->num_sgs) {
1328 		ubuf = urb->transfer_buffer + urb->actual_length;
1329 		if (to_host)
1330 			memcpy(ubuf, rbuf, len);
1331 		else
1332 			memcpy(rbuf, ubuf, len);
1333 		return len;
1334 	}
1335 
1336 	if (!urbp->miter_started) {
1337 		u32 flags = SG_MITER_ATOMIC;
1338 
1339 		if (to_host)
1340 			flags |= SG_MITER_TO_SG;
1341 		else
1342 			flags |= SG_MITER_FROM_SG;
1343 
1344 		sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1345 		urbp->miter_started = 1;
1346 	}
1347 	next_sg = sg_miter_next(miter);
1348 	if (next_sg == false) {
1349 		WARN_ON_ONCE(1);
1350 		return -EINVAL;
1351 	}
1352 	do {
1353 		ubuf = miter->addr;
1354 		this_sg = min_t(u32, len, miter->length);
1355 		miter->consumed = this_sg;
1356 		trans += this_sg;
1357 
1358 		if (to_host)
1359 			memcpy(ubuf, rbuf, this_sg);
1360 		else
1361 			memcpy(rbuf, ubuf, this_sg);
1362 		len -= this_sg;
1363 
1364 		if (!len)
1365 			break;
1366 		next_sg = sg_miter_next(miter);
1367 		if (next_sg == false) {
1368 			WARN_ON_ONCE(1);
1369 			return -EINVAL;
1370 		}
1371 
1372 		rbuf += this_sg;
1373 	} while (1);
1374 
1375 	sg_miter_stop(miter);
1376 	return trans;
1377 }
1378 
1379 /* transfer up to a frame's worth; caller must own lock */
1380 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1381 		struct dummy_ep *ep, int limit, int *status)
1382 {
1383 	struct dummy		*dum = dum_hcd->dum;
1384 	struct dummy_request	*req;
1385 	int			sent = 0;
1386 
1387 top:
1388 	/* if there's no request queued, the device is NAKing; return */
1389 	list_for_each_entry(req, &ep->queue, queue) {
1390 		unsigned	host_len, dev_len, len;
1391 		int		is_short, to_host;
1392 		int		rescan = 0;
1393 
1394 		if (dummy_ep_stream_en(dum_hcd, urb)) {
1395 			if ((urb->stream_id != req->req.stream_id))
1396 				continue;
1397 		}
1398 
1399 		/* 1..N packets of ep->ep.maxpacket each ... the last one
1400 		 * may be short (including zero length).
1401 		 *
1402 		 * writer can send a zlp explicitly (length 0) or implicitly
1403 		 * (length mod maxpacket zero, and 'zero' flag); they always
1404 		 * terminate reads.
1405 		 */
1406 		host_len = urb->transfer_buffer_length - urb->actual_length;
1407 		dev_len = req->req.length - req->req.actual;
1408 		len = min(host_len, dev_len);
1409 
1410 		/* FIXME update emulated data toggle too */
1411 
1412 		to_host = usb_urb_dir_in(urb);
1413 		if (unlikely(len == 0))
1414 			is_short = 1;
1415 		else {
1416 			/* not enough bandwidth left? */
1417 			if (limit < ep->ep.maxpacket && limit < len)
1418 				break;
1419 			len = min_t(unsigned, len, limit);
1420 			if (len == 0)
1421 				break;
1422 
1423 			/* send multiple of maxpacket first, then remainder */
1424 			if (len >= ep->ep.maxpacket) {
1425 				is_short = 0;
1426 				if (len % ep->ep.maxpacket)
1427 					rescan = 1;
1428 				len -= len % ep->ep.maxpacket;
1429 			} else {
1430 				is_short = 1;
1431 			}
1432 
1433 			len = dummy_perform_transfer(urb, req, len);
1434 
1435 			ep->last_io = jiffies;
1436 			if ((int)len < 0) {
1437 				req->req.status = len;
1438 			} else {
1439 				limit -= len;
1440 				sent += len;
1441 				urb->actual_length += len;
1442 				req->req.actual += len;
1443 			}
1444 		}
1445 
1446 		/* short packets terminate, maybe with overflow/underflow.
1447 		 * it's only really an error to write too much.
1448 		 *
1449 		 * partially filling a buffer optionally blocks queue advances
1450 		 * (so completion handlers can clean up the queue) but we don't
1451 		 * need to emulate such data-in-flight.
1452 		 */
1453 		if (is_short) {
1454 			if (host_len == dev_len) {
1455 				req->req.status = 0;
1456 				*status = 0;
1457 			} else if (to_host) {
1458 				req->req.status = 0;
1459 				if (dev_len > host_len)
1460 					*status = -EOVERFLOW;
1461 				else
1462 					*status = 0;
1463 			} else {
1464 				*status = 0;
1465 				if (host_len > dev_len)
1466 					req->req.status = -EOVERFLOW;
1467 				else
1468 					req->req.status = 0;
1469 			}
1470 
1471 		/*
1472 		 * many requests terminate without a short packet.
1473 		 * send a zlp if demanded by flags.
1474 		 */
1475 		} else {
1476 			if (req->req.length == req->req.actual) {
1477 				if (req->req.zero && to_host)
1478 					rescan = 1;
1479 				else
1480 					req->req.status = 0;
1481 			}
1482 			if (urb->transfer_buffer_length == urb->actual_length) {
1483 				if (urb->transfer_flags & URB_ZERO_PACKET &&
1484 				    !to_host)
1485 					rescan = 1;
1486 				else
1487 					*status = 0;
1488 			}
1489 		}
1490 
1491 		/* device side completion --> continuable */
1492 		if (req->req.status != -EINPROGRESS) {
1493 			list_del_init(&req->queue);
1494 
1495 			spin_unlock(&dum->lock);
1496 			usb_gadget_giveback_request(&ep->ep, &req->req);
1497 			spin_lock(&dum->lock);
1498 
1499 			/* requests might have been unlinked... */
1500 			rescan = 1;
1501 		}
1502 
1503 		/* host side completion --> terminate */
1504 		if (*status != -EINPROGRESS)
1505 			break;
1506 
1507 		/* rescan to continue with any other queued i/o */
1508 		if (rescan)
1509 			goto top;
1510 	}
1511 	return sent;
1512 }
1513 
1514 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1515 {
1516 	int	limit = ep->ep.maxpacket;
1517 
1518 	if (dum->gadget.speed == USB_SPEED_HIGH) {
1519 		int	tmp;
1520 
1521 		/* high bandwidth mode */
1522 		tmp = usb_endpoint_maxp_mult(ep->desc);
1523 		tmp *= 8 /* applies to entire frame */;
1524 		limit += limit * tmp;
1525 	}
1526 	if (dum->gadget.speed == USB_SPEED_SUPER) {
1527 		switch (usb_endpoint_type(ep->desc)) {
1528 		case USB_ENDPOINT_XFER_ISOC:
1529 			/* Sec. 4.4.8.2 USB3.0 Spec */
1530 			limit = 3 * 16 * 1024 * 8;
1531 			break;
1532 		case USB_ENDPOINT_XFER_INT:
1533 			/* Sec. 4.4.7.2 USB3.0 Spec */
1534 			limit = 3 * 1024 * 8;
1535 			break;
1536 		case USB_ENDPOINT_XFER_BULK:
1537 		default:
1538 			break;
1539 		}
1540 	}
1541 	return limit;
1542 }
1543 
1544 #define is_active(dum_hcd)	((dum_hcd->port_status & \
1545 		(USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1546 			USB_PORT_STAT_SUSPEND)) \
1547 		== (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1548 
1549 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1550 {
1551 	int		i;
1552 
1553 	if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1554 			dum->ss_hcd : dum->hs_hcd)))
1555 		return NULL;
1556 	if (!dum->ints_enabled)
1557 		return NULL;
1558 	if ((address & ~USB_DIR_IN) == 0)
1559 		return &dum->ep[0];
1560 	for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1561 		struct dummy_ep	*ep = &dum->ep[i];
1562 
1563 		if (!ep->desc)
1564 			continue;
1565 		if (ep->desc->bEndpointAddress == address)
1566 			return ep;
1567 	}
1568 	return NULL;
1569 }
1570 
1571 #undef is_active
1572 
1573 #define Dev_Request	(USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1574 #define Dev_InRequest	(Dev_Request | USB_DIR_IN)
1575 #define Intf_Request	(USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1576 #define Intf_InRequest	(Intf_Request | USB_DIR_IN)
1577 #define Ep_Request	(USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1578 #define Ep_InRequest	(Ep_Request | USB_DIR_IN)
1579 
1580 
1581 /**
1582  * handle_control_request() - handles all control transfers
1583  * @dum: pointer to dummy (the_controller)
1584  * @urb: the urb request to handle
1585  * @setup: pointer to the setup data for a USB device control
1586  *	 request
1587  * @status: pointer to request handling status
1588  *
1589  * Return 0 - if the request was handled
1590  *	  1 - if the request wasn't handles
1591  *	  error code on error
1592  */
1593 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1594 				  struct usb_ctrlrequest *setup,
1595 				  int *status)
1596 {
1597 	struct dummy_ep		*ep2;
1598 	struct dummy		*dum = dum_hcd->dum;
1599 	int			ret_val = 1;
1600 	unsigned	w_index;
1601 	unsigned	w_value;
1602 
1603 	w_index = le16_to_cpu(setup->wIndex);
1604 	w_value = le16_to_cpu(setup->wValue);
1605 	switch (setup->bRequest) {
1606 	case USB_REQ_SET_ADDRESS:
1607 		if (setup->bRequestType != Dev_Request)
1608 			break;
1609 		dum->address = w_value;
1610 		*status = 0;
1611 		dev_dbg(udc_dev(dum), "set_address = %d\n",
1612 				w_value);
1613 		ret_val = 0;
1614 		break;
1615 	case USB_REQ_SET_FEATURE:
1616 		if (setup->bRequestType == Dev_Request) {
1617 			ret_val = 0;
1618 			switch (w_value) {
1619 			case USB_DEVICE_REMOTE_WAKEUP:
1620 				break;
1621 			case USB_DEVICE_B_HNP_ENABLE:
1622 				dum->gadget.b_hnp_enable = 1;
1623 				break;
1624 			case USB_DEVICE_A_HNP_SUPPORT:
1625 				dum->gadget.a_hnp_support = 1;
1626 				break;
1627 			case USB_DEVICE_A_ALT_HNP_SUPPORT:
1628 				dum->gadget.a_alt_hnp_support = 1;
1629 				break;
1630 			case USB_DEVICE_U1_ENABLE:
1631 				if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1632 				    HCD_USB3)
1633 					w_value = USB_DEV_STAT_U1_ENABLED;
1634 				else
1635 					ret_val = -EOPNOTSUPP;
1636 				break;
1637 			case USB_DEVICE_U2_ENABLE:
1638 				if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1639 				    HCD_USB3)
1640 					w_value = USB_DEV_STAT_U2_ENABLED;
1641 				else
1642 					ret_val = -EOPNOTSUPP;
1643 				break;
1644 			case USB_DEVICE_LTM_ENABLE:
1645 				if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1646 				    HCD_USB3)
1647 					w_value = USB_DEV_STAT_LTM_ENABLED;
1648 				else
1649 					ret_val = -EOPNOTSUPP;
1650 				break;
1651 			default:
1652 				ret_val = -EOPNOTSUPP;
1653 			}
1654 			if (ret_val == 0) {
1655 				dum->devstatus |= (1 << w_value);
1656 				*status = 0;
1657 			}
1658 		} else if (setup->bRequestType == Ep_Request) {
1659 			/* endpoint halt */
1660 			ep2 = find_endpoint(dum, w_index);
1661 			if (!ep2 || ep2->ep.name == ep0name) {
1662 				ret_val = -EOPNOTSUPP;
1663 				break;
1664 			}
1665 			ep2->halted = 1;
1666 			ret_val = 0;
1667 			*status = 0;
1668 		}
1669 		break;
1670 	case USB_REQ_CLEAR_FEATURE:
1671 		if (setup->bRequestType == Dev_Request) {
1672 			ret_val = 0;
1673 			switch (w_value) {
1674 			case USB_DEVICE_REMOTE_WAKEUP:
1675 				w_value = USB_DEVICE_REMOTE_WAKEUP;
1676 				break;
1677 			case USB_DEVICE_U1_ENABLE:
1678 				if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1679 				    HCD_USB3)
1680 					w_value = USB_DEV_STAT_U1_ENABLED;
1681 				else
1682 					ret_val = -EOPNOTSUPP;
1683 				break;
1684 			case USB_DEVICE_U2_ENABLE:
1685 				if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1686 				    HCD_USB3)
1687 					w_value = USB_DEV_STAT_U2_ENABLED;
1688 				else
1689 					ret_val = -EOPNOTSUPP;
1690 				break;
1691 			case USB_DEVICE_LTM_ENABLE:
1692 				if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1693 				    HCD_USB3)
1694 					w_value = USB_DEV_STAT_LTM_ENABLED;
1695 				else
1696 					ret_val = -EOPNOTSUPP;
1697 				break;
1698 			default:
1699 				ret_val = -EOPNOTSUPP;
1700 				break;
1701 			}
1702 			if (ret_val == 0) {
1703 				dum->devstatus &= ~(1 << w_value);
1704 				*status = 0;
1705 			}
1706 		} else if (setup->bRequestType == Ep_Request) {
1707 			/* endpoint halt */
1708 			ep2 = find_endpoint(dum, w_index);
1709 			if (!ep2) {
1710 				ret_val = -EOPNOTSUPP;
1711 				break;
1712 			}
1713 			if (!ep2->wedged)
1714 				ep2->halted = 0;
1715 			ret_val = 0;
1716 			*status = 0;
1717 		}
1718 		break;
1719 	case USB_REQ_GET_STATUS:
1720 		if (setup->bRequestType == Dev_InRequest
1721 				|| setup->bRequestType == Intf_InRequest
1722 				|| setup->bRequestType == Ep_InRequest) {
1723 			char *buf;
1724 			/*
1725 			 * device: remote wakeup, selfpowered
1726 			 * interface: nothing
1727 			 * endpoint: halt
1728 			 */
1729 			buf = (char *)urb->transfer_buffer;
1730 			if (urb->transfer_buffer_length > 0) {
1731 				if (setup->bRequestType == Ep_InRequest) {
1732 					ep2 = find_endpoint(dum, w_index);
1733 					if (!ep2) {
1734 						ret_val = -EOPNOTSUPP;
1735 						break;
1736 					}
1737 					buf[0] = ep2->halted;
1738 				} else if (setup->bRequestType ==
1739 					   Dev_InRequest) {
1740 					buf[0] = (u8)dum->devstatus;
1741 				} else
1742 					buf[0] = 0;
1743 			}
1744 			if (urb->transfer_buffer_length > 1)
1745 				buf[1] = 0;
1746 			urb->actual_length = min_t(u32, 2,
1747 				urb->transfer_buffer_length);
1748 			ret_val = 0;
1749 			*status = 0;
1750 		}
1751 		break;
1752 	}
1753 	return ret_val;
1754 }
1755 
1756 /* drive both sides of the transfers; looks like irq handlers to
1757  * both drivers except the callbacks aren't in_irq().
1758  */
1759 static void dummy_timer(struct timer_list *t)
1760 {
1761 	struct dummy_hcd	*dum_hcd = from_timer(dum_hcd, t, timer);
1762 	struct dummy		*dum = dum_hcd->dum;
1763 	struct urbp		*urbp, *tmp;
1764 	unsigned long		flags;
1765 	int			limit, total;
1766 	int			i;
1767 
1768 	/* simplistic model for one frame's bandwidth */
1769 	/* FIXME: account for transaction and packet overhead */
1770 	switch (dum->gadget.speed) {
1771 	case USB_SPEED_LOW:
1772 		total = 8/*bytes*/ * 12/*packets*/;
1773 		break;
1774 	case USB_SPEED_FULL:
1775 		total = 64/*bytes*/ * 19/*packets*/;
1776 		break;
1777 	case USB_SPEED_HIGH:
1778 		total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1779 		break;
1780 	case USB_SPEED_SUPER:
1781 		/* Bus speed is 500000 bytes/ms, so use a little less */
1782 		total = 490000;
1783 		break;
1784 	default:	/* Can't happen */
1785 		dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1786 		total = 0;
1787 		break;
1788 	}
1789 
1790 	/* FIXME if HZ != 1000 this will probably misbehave ... */
1791 
1792 	/* look at each urb queued by the host side driver */
1793 	spin_lock_irqsave(&dum->lock, flags);
1794 
1795 	if (!dum_hcd->udev) {
1796 		dev_err(dummy_dev(dum_hcd),
1797 				"timer fired with no URBs pending?\n");
1798 		spin_unlock_irqrestore(&dum->lock, flags);
1799 		return;
1800 	}
1801 	dum_hcd->next_frame_urbp = NULL;
1802 
1803 	for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1804 		if (!ep_info[i].name)
1805 			break;
1806 		dum->ep[i].already_seen = 0;
1807 	}
1808 
1809 restart:
1810 	list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1811 		struct urb		*urb;
1812 		struct dummy_request	*req;
1813 		u8			address;
1814 		struct dummy_ep		*ep = NULL;
1815 		int			status = -EINPROGRESS;
1816 
1817 		/* stop when we reach URBs queued after the timer interrupt */
1818 		if (urbp == dum_hcd->next_frame_urbp)
1819 			break;
1820 
1821 		urb = urbp->urb;
1822 		if (urb->unlinked)
1823 			goto return_urb;
1824 		else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1825 			continue;
1826 
1827 		/* Used up this frame's bandwidth? */
1828 		if (total <= 0)
1829 			continue;
1830 
1831 		/* find the gadget's ep for this request (if configured) */
1832 		address = usb_pipeendpoint (urb->pipe);
1833 		if (usb_urb_dir_in(urb))
1834 			address |= USB_DIR_IN;
1835 		ep = find_endpoint(dum, address);
1836 		if (!ep) {
1837 			/* set_configuration() disagreement */
1838 			dev_dbg(dummy_dev(dum_hcd),
1839 				"no ep configured for urb %p\n",
1840 				urb);
1841 			status = -EPROTO;
1842 			goto return_urb;
1843 		}
1844 
1845 		if (ep->already_seen)
1846 			continue;
1847 		ep->already_seen = 1;
1848 		if (ep == &dum->ep[0] && urb->error_count) {
1849 			ep->setup_stage = 1;	/* a new urb */
1850 			urb->error_count = 0;
1851 		}
1852 		if (ep->halted && !ep->setup_stage) {
1853 			/* NOTE: must not be iso! */
1854 			dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1855 					ep->ep.name, urb);
1856 			status = -EPIPE;
1857 			goto return_urb;
1858 		}
1859 		/* FIXME make sure both ends agree on maxpacket */
1860 
1861 		/* handle control requests */
1862 		if (ep == &dum->ep[0] && ep->setup_stage) {
1863 			struct usb_ctrlrequest		setup;
1864 			int				value = 1;
1865 
1866 			setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1867 			/* paranoia, in case of stale queued data */
1868 			list_for_each_entry(req, &ep->queue, queue) {
1869 				list_del_init(&req->queue);
1870 				req->req.status = -EOVERFLOW;
1871 				dev_dbg(udc_dev(dum), "stale req = %p\n",
1872 						req);
1873 
1874 				spin_unlock(&dum->lock);
1875 				usb_gadget_giveback_request(&ep->ep, &req->req);
1876 				spin_lock(&dum->lock);
1877 				ep->already_seen = 0;
1878 				goto restart;
1879 			}
1880 
1881 			/* gadget driver never sees set_address or operations
1882 			 * on standard feature flags.  some hardware doesn't
1883 			 * even expose them.
1884 			 */
1885 			ep->last_io = jiffies;
1886 			ep->setup_stage = 0;
1887 			ep->halted = 0;
1888 
1889 			value = handle_control_request(dum_hcd, urb, &setup,
1890 						       &status);
1891 
1892 			/* gadget driver handles all other requests.  block
1893 			 * until setup() returns; no reentrancy issues etc.
1894 			 */
1895 			if (value > 0) {
1896 				++dum->callback_usage;
1897 				spin_unlock(&dum->lock);
1898 				value = dum->driver->setup(&dum->gadget,
1899 						&setup);
1900 				spin_lock(&dum->lock);
1901 				--dum->callback_usage;
1902 
1903 				if (value >= 0) {
1904 					/* no delays (max 64KB data stage) */
1905 					limit = 64*1024;
1906 					goto treat_control_like_bulk;
1907 				}
1908 				/* error, see below */
1909 			}
1910 
1911 			if (value < 0) {
1912 				if (value != -EOPNOTSUPP)
1913 					dev_dbg(udc_dev(dum),
1914 						"setup --> %d\n",
1915 						value);
1916 				status = -EPIPE;
1917 				urb->actual_length = 0;
1918 			}
1919 
1920 			goto return_urb;
1921 		}
1922 
1923 		/* non-control requests */
1924 		limit = total;
1925 		switch (usb_pipetype(urb->pipe)) {
1926 		case PIPE_ISOCHRONOUS:
1927 			/*
1928 			 * We don't support isochronous.  But if we did,
1929 			 * here are some of the issues we'd have to face:
1930 			 *
1931 			 * Is it urb->interval since the last xfer?
1932 			 * Use urb->iso_frame_desc[i].
1933 			 * Complete whether or not ep has requests queued.
1934 			 * Report random errors, to debug drivers.
1935 			 */
1936 			limit = max(limit, periodic_bytes(dum, ep));
1937 			status = -EINVAL;	/* fail all xfers */
1938 			break;
1939 
1940 		case PIPE_INTERRUPT:
1941 			/* FIXME is it urb->interval since the last xfer?
1942 			 * this almost certainly polls too fast.
1943 			 */
1944 			limit = max(limit, periodic_bytes(dum, ep));
1945 			/* FALLTHROUGH */
1946 
1947 		default:
1948 treat_control_like_bulk:
1949 			ep->last_io = jiffies;
1950 			total -= transfer(dum_hcd, urb, ep, limit, &status);
1951 			break;
1952 		}
1953 
1954 		/* incomplete transfer? */
1955 		if (status == -EINPROGRESS)
1956 			continue;
1957 
1958 return_urb:
1959 		list_del(&urbp->urbp_list);
1960 		kfree(urbp);
1961 		if (ep)
1962 			ep->already_seen = ep->setup_stage = 0;
1963 
1964 		usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1965 		spin_unlock(&dum->lock);
1966 		usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1967 		spin_lock(&dum->lock);
1968 
1969 		goto restart;
1970 	}
1971 
1972 	if (list_empty(&dum_hcd->urbp_list)) {
1973 		usb_put_dev(dum_hcd->udev);
1974 		dum_hcd->udev = NULL;
1975 	} else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1976 		/* want a 1 msec delay here */
1977 		mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1978 	}
1979 
1980 	spin_unlock_irqrestore(&dum->lock, flags);
1981 }
1982 
1983 /*-------------------------------------------------------------------------*/
1984 
1985 #define PORT_C_MASK \
1986 	((USB_PORT_STAT_C_CONNECTION \
1987 	| USB_PORT_STAT_C_ENABLE \
1988 	| USB_PORT_STAT_C_SUSPEND \
1989 	| USB_PORT_STAT_C_OVERCURRENT \
1990 	| USB_PORT_STAT_C_RESET) << 16)
1991 
1992 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1993 {
1994 	struct dummy_hcd	*dum_hcd;
1995 	unsigned long		flags;
1996 	int			retval = 0;
1997 
1998 	dum_hcd = hcd_to_dummy_hcd(hcd);
1999 
2000 	spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2001 	if (!HCD_HW_ACCESSIBLE(hcd))
2002 		goto done;
2003 
2004 	if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
2005 		dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2006 		dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2007 		set_link_state(dum_hcd);
2008 	}
2009 
2010 	if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
2011 		*buf = (1 << 1);
2012 		dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
2013 				dum_hcd->port_status);
2014 		retval = 1;
2015 		if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
2016 			usb_hcd_resume_root_hub(hcd);
2017 	}
2018 done:
2019 	spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2020 	return retval;
2021 }
2022 
2023 /* usb 3.0 root hub device descriptor */
2024 static struct {
2025 	struct usb_bos_descriptor bos;
2026 	struct usb_ss_cap_descriptor ss_cap;
2027 } __packed usb3_bos_desc = {
2028 
2029 	.bos = {
2030 		.bLength		= USB_DT_BOS_SIZE,
2031 		.bDescriptorType	= USB_DT_BOS,
2032 		.wTotalLength		= cpu_to_le16(sizeof(usb3_bos_desc)),
2033 		.bNumDeviceCaps		= 1,
2034 	},
2035 	.ss_cap = {
2036 		.bLength		= USB_DT_USB_SS_CAP_SIZE,
2037 		.bDescriptorType	= USB_DT_DEVICE_CAPABILITY,
2038 		.bDevCapabilityType	= USB_SS_CAP_TYPE,
2039 		.wSpeedSupported	= cpu_to_le16(USB_5GBPS_OPERATION),
2040 		.bFunctionalitySupport	= ilog2(USB_5GBPS_OPERATION),
2041 	},
2042 };
2043 
2044 static inline void
2045 ss_hub_descriptor(struct usb_hub_descriptor *desc)
2046 {
2047 	memset(desc, 0, sizeof *desc);
2048 	desc->bDescriptorType = USB_DT_SS_HUB;
2049 	desc->bDescLength = 12;
2050 	desc->wHubCharacteristics = cpu_to_le16(
2051 			HUB_CHAR_INDV_PORT_LPSM |
2052 			HUB_CHAR_COMMON_OCPM);
2053 	desc->bNbrPorts = 1;
2054 	desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2055 	desc->u.ss.DeviceRemovable = 0;
2056 }
2057 
2058 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2059 {
2060 	memset(desc, 0, sizeof *desc);
2061 	desc->bDescriptorType = USB_DT_HUB;
2062 	desc->bDescLength = 9;
2063 	desc->wHubCharacteristics = cpu_to_le16(
2064 			HUB_CHAR_INDV_PORT_LPSM |
2065 			HUB_CHAR_COMMON_OCPM);
2066 	desc->bNbrPorts = 1;
2067 	desc->u.hs.DeviceRemovable[0] = 0;
2068 	desc->u.hs.DeviceRemovable[1] = 0xff;	/* PortPwrCtrlMask */
2069 }
2070 
2071 static int dummy_hub_control(
2072 	struct usb_hcd	*hcd,
2073 	u16		typeReq,
2074 	u16		wValue,
2075 	u16		wIndex,
2076 	char		*buf,
2077 	u16		wLength
2078 ) {
2079 	struct dummy_hcd *dum_hcd;
2080 	int		retval = 0;
2081 	unsigned long	flags;
2082 
2083 	if (!HCD_HW_ACCESSIBLE(hcd))
2084 		return -ETIMEDOUT;
2085 
2086 	dum_hcd = hcd_to_dummy_hcd(hcd);
2087 
2088 	spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2089 	switch (typeReq) {
2090 	case ClearHubFeature:
2091 		break;
2092 	case ClearPortFeature:
2093 		switch (wValue) {
2094 		case USB_PORT_FEAT_SUSPEND:
2095 			if (hcd->speed == HCD_USB3) {
2096 				dev_dbg(dummy_dev(dum_hcd),
2097 					 "USB_PORT_FEAT_SUSPEND req not "
2098 					 "supported for USB 3.0 roothub\n");
2099 				goto error;
2100 			}
2101 			if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2102 				/* 20msec resume signaling */
2103 				dum_hcd->resuming = 1;
2104 				dum_hcd->re_timeout = jiffies +
2105 						msecs_to_jiffies(20);
2106 			}
2107 			break;
2108 		case USB_PORT_FEAT_POWER:
2109 			dev_dbg(dummy_dev(dum_hcd), "power-off\n");
2110 			if (hcd->speed == HCD_USB3)
2111 				dum_hcd->port_status &= ~USB_SS_PORT_STAT_POWER;
2112 			else
2113 				dum_hcd->port_status &= ~USB_PORT_STAT_POWER;
2114 			set_link_state(dum_hcd);
2115 			break;
2116 		default:
2117 			dum_hcd->port_status &= ~(1 << wValue);
2118 			set_link_state(dum_hcd);
2119 		}
2120 		break;
2121 	case GetHubDescriptor:
2122 		if (hcd->speed == HCD_USB3 &&
2123 				(wLength < USB_DT_SS_HUB_SIZE ||
2124 				 wValue != (USB_DT_SS_HUB << 8))) {
2125 			dev_dbg(dummy_dev(dum_hcd),
2126 				"Wrong hub descriptor type for "
2127 				"USB 3.0 roothub.\n");
2128 			goto error;
2129 		}
2130 		if (hcd->speed == HCD_USB3)
2131 			ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2132 		else
2133 			hub_descriptor((struct usb_hub_descriptor *) buf);
2134 		break;
2135 
2136 	case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2137 		if (hcd->speed != HCD_USB3)
2138 			goto error;
2139 
2140 		if ((wValue >> 8) != USB_DT_BOS)
2141 			goto error;
2142 
2143 		memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2144 		retval = sizeof(usb3_bos_desc);
2145 		break;
2146 
2147 	case GetHubStatus:
2148 		*(__le32 *) buf = cpu_to_le32(0);
2149 		break;
2150 	case GetPortStatus:
2151 		if (wIndex != 1)
2152 			retval = -EPIPE;
2153 
2154 		/* whoever resets or resumes must GetPortStatus to
2155 		 * complete it!!
2156 		 */
2157 		if (dum_hcd->resuming &&
2158 				time_after_eq(jiffies, dum_hcd->re_timeout)) {
2159 			dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2160 			dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2161 		}
2162 		if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2163 				time_after_eq(jiffies, dum_hcd->re_timeout)) {
2164 			dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2165 			dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2166 			if (dum_hcd->dum->pullup) {
2167 				dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2168 
2169 				if (hcd->speed < HCD_USB3) {
2170 					switch (dum_hcd->dum->gadget.speed) {
2171 					case USB_SPEED_HIGH:
2172 						dum_hcd->port_status |=
2173 						      USB_PORT_STAT_HIGH_SPEED;
2174 						break;
2175 					case USB_SPEED_LOW:
2176 						dum_hcd->dum->gadget.ep0->
2177 							maxpacket = 8;
2178 						dum_hcd->port_status |=
2179 							USB_PORT_STAT_LOW_SPEED;
2180 						break;
2181 					default:
2182 						break;
2183 					}
2184 				}
2185 			}
2186 		}
2187 		set_link_state(dum_hcd);
2188 		((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2189 		((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2190 		break;
2191 	case SetHubFeature:
2192 		retval = -EPIPE;
2193 		break;
2194 	case SetPortFeature:
2195 		switch (wValue) {
2196 		case USB_PORT_FEAT_LINK_STATE:
2197 			if (hcd->speed != HCD_USB3) {
2198 				dev_dbg(dummy_dev(dum_hcd),
2199 					 "USB_PORT_FEAT_LINK_STATE req not "
2200 					 "supported for USB 2.0 roothub\n");
2201 				goto error;
2202 			}
2203 			/*
2204 			 * Since this is dummy we don't have an actual link so
2205 			 * there is nothing to do for the SET_LINK_STATE cmd
2206 			 */
2207 			break;
2208 		case USB_PORT_FEAT_U1_TIMEOUT:
2209 		case USB_PORT_FEAT_U2_TIMEOUT:
2210 			/* TODO: add suspend/resume support! */
2211 			if (hcd->speed != HCD_USB3) {
2212 				dev_dbg(dummy_dev(dum_hcd),
2213 					 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2214 					 "supported for USB 2.0 roothub\n");
2215 				goto error;
2216 			}
2217 			break;
2218 		case USB_PORT_FEAT_SUSPEND:
2219 			/* Applicable only for USB2.0 hub */
2220 			if (hcd->speed == HCD_USB3) {
2221 				dev_dbg(dummy_dev(dum_hcd),
2222 					 "USB_PORT_FEAT_SUSPEND req not "
2223 					 "supported for USB 3.0 roothub\n");
2224 				goto error;
2225 			}
2226 			if (dum_hcd->active) {
2227 				dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2228 
2229 				/* HNP would happen here; for now we
2230 				 * assume b_bus_req is always true.
2231 				 */
2232 				set_link_state(dum_hcd);
2233 				if (((1 << USB_DEVICE_B_HNP_ENABLE)
2234 						& dum_hcd->dum->devstatus) != 0)
2235 					dev_dbg(dummy_dev(dum_hcd),
2236 							"no HNP yet!\n");
2237 			}
2238 			break;
2239 		case USB_PORT_FEAT_POWER:
2240 			if (hcd->speed == HCD_USB3)
2241 				dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2242 			else
2243 				dum_hcd->port_status |= USB_PORT_STAT_POWER;
2244 			set_link_state(dum_hcd);
2245 			break;
2246 		case USB_PORT_FEAT_BH_PORT_RESET:
2247 			/* Applicable only for USB3.0 hub */
2248 			if (hcd->speed != HCD_USB3) {
2249 				dev_dbg(dummy_dev(dum_hcd),
2250 					 "USB_PORT_FEAT_BH_PORT_RESET req not "
2251 					 "supported for USB 2.0 roothub\n");
2252 				goto error;
2253 			}
2254 			/* FALLS THROUGH */
2255 		case USB_PORT_FEAT_RESET:
2256 			/* if it's already enabled, disable */
2257 			if (hcd->speed == HCD_USB3) {
2258 				dum_hcd->port_status = 0;
2259 				dum_hcd->port_status =
2260 					(USB_SS_PORT_STAT_POWER |
2261 					 USB_PORT_STAT_CONNECTION |
2262 					 USB_PORT_STAT_RESET);
2263 			} else
2264 				dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2265 					| USB_PORT_STAT_LOW_SPEED
2266 					| USB_PORT_STAT_HIGH_SPEED);
2267 			/*
2268 			 * We want to reset device status. All but the
2269 			 * Self powered feature
2270 			 */
2271 			dum_hcd->dum->devstatus &=
2272 				(1 << USB_DEVICE_SELF_POWERED);
2273 			/*
2274 			 * FIXME USB3.0: what is the correct reset signaling
2275 			 * interval? Is it still 50msec as for HS?
2276 			 */
2277 			dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2278 			/* FALLS THROUGH */
2279 		default:
2280 			if (hcd->speed == HCD_USB3) {
2281 				if ((dum_hcd->port_status &
2282 				     USB_SS_PORT_STAT_POWER) != 0) {
2283 					dum_hcd->port_status |= (1 << wValue);
2284 				}
2285 			} else
2286 				if ((dum_hcd->port_status &
2287 				     USB_PORT_STAT_POWER) != 0) {
2288 					dum_hcd->port_status |= (1 << wValue);
2289 				}
2290 			set_link_state(dum_hcd);
2291 		}
2292 		break;
2293 	case GetPortErrorCount:
2294 		if (hcd->speed != HCD_USB3) {
2295 			dev_dbg(dummy_dev(dum_hcd),
2296 				 "GetPortErrorCount req not "
2297 				 "supported for USB 2.0 roothub\n");
2298 			goto error;
2299 		}
2300 		/* We'll always return 0 since this is a dummy hub */
2301 		*(__le32 *) buf = cpu_to_le32(0);
2302 		break;
2303 	case SetHubDepth:
2304 		if (hcd->speed != HCD_USB3) {
2305 			dev_dbg(dummy_dev(dum_hcd),
2306 				 "SetHubDepth req not supported for "
2307 				 "USB 2.0 roothub\n");
2308 			goto error;
2309 		}
2310 		break;
2311 	default:
2312 		dev_dbg(dummy_dev(dum_hcd),
2313 			"hub control req%04x v%04x i%04x l%d\n",
2314 			typeReq, wValue, wIndex, wLength);
2315 error:
2316 		/* "protocol stall" on error */
2317 		retval = -EPIPE;
2318 	}
2319 	spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2320 
2321 	if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2322 		usb_hcd_poll_rh_status(hcd);
2323 	return retval;
2324 }
2325 
2326 static int dummy_bus_suspend(struct usb_hcd *hcd)
2327 {
2328 	struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2329 
2330 	dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2331 
2332 	spin_lock_irq(&dum_hcd->dum->lock);
2333 	dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2334 	set_link_state(dum_hcd);
2335 	hcd->state = HC_STATE_SUSPENDED;
2336 	spin_unlock_irq(&dum_hcd->dum->lock);
2337 	return 0;
2338 }
2339 
2340 static int dummy_bus_resume(struct usb_hcd *hcd)
2341 {
2342 	struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2343 	int rc = 0;
2344 
2345 	dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2346 
2347 	spin_lock_irq(&dum_hcd->dum->lock);
2348 	if (!HCD_HW_ACCESSIBLE(hcd)) {
2349 		rc = -ESHUTDOWN;
2350 	} else {
2351 		dum_hcd->rh_state = DUMMY_RH_RUNNING;
2352 		set_link_state(dum_hcd);
2353 		if (!list_empty(&dum_hcd->urbp_list))
2354 			mod_timer(&dum_hcd->timer, jiffies);
2355 		hcd->state = HC_STATE_RUNNING;
2356 	}
2357 	spin_unlock_irq(&dum_hcd->dum->lock);
2358 	return rc;
2359 }
2360 
2361 /*-------------------------------------------------------------------------*/
2362 
2363 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2364 {
2365 	int ep = usb_pipeendpoint(urb->pipe);
2366 
2367 	return scnprintf(buf, size,
2368 		"urb/%p %s ep%d%s%s len %d/%d\n",
2369 		urb,
2370 		({ char *s;
2371 		switch (urb->dev->speed) {
2372 		case USB_SPEED_LOW:
2373 			s = "ls";
2374 			break;
2375 		case USB_SPEED_FULL:
2376 			s = "fs";
2377 			break;
2378 		case USB_SPEED_HIGH:
2379 			s = "hs";
2380 			break;
2381 		case USB_SPEED_SUPER:
2382 			s = "ss";
2383 			break;
2384 		default:
2385 			s = "?";
2386 			break;
2387 		 } s; }),
2388 		ep, ep ? (usb_urb_dir_in(urb) ? "in" : "out") : "",
2389 		({ char *s; \
2390 		switch (usb_pipetype(urb->pipe)) { \
2391 		case PIPE_CONTROL: \
2392 			s = ""; \
2393 			break; \
2394 		case PIPE_BULK: \
2395 			s = "-bulk"; \
2396 			break; \
2397 		case PIPE_INTERRUPT: \
2398 			s = "-int"; \
2399 			break; \
2400 		default: \
2401 			s = "-iso"; \
2402 			break; \
2403 		} s; }),
2404 		urb->actual_length, urb->transfer_buffer_length);
2405 }
2406 
2407 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2408 		char *buf)
2409 {
2410 	struct usb_hcd		*hcd = dev_get_drvdata(dev);
2411 	struct dummy_hcd	*dum_hcd = hcd_to_dummy_hcd(hcd);
2412 	struct urbp		*urbp;
2413 	size_t			size = 0;
2414 	unsigned long		flags;
2415 
2416 	spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2417 	list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2418 		size_t		temp;
2419 
2420 		temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2421 		buf += temp;
2422 		size += temp;
2423 	}
2424 	spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2425 
2426 	return size;
2427 }
2428 static DEVICE_ATTR_RO(urbs);
2429 
2430 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2431 {
2432 	timer_setup(&dum_hcd->timer, dummy_timer, 0);
2433 	dum_hcd->rh_state = DUMMY_RH_RUNNING;
2434 	dum_hcd->stream_en_ep = 0;
2435 	INIT_LIST_HEAD(&dum_hcd->urbp_list);
2436 	dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET_3;
2437 	dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2438 	dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2439 #ifdef CONFIG_USB_OTG
2440 	dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2441 #endif
2442 	return 0;
2443 
2444 	/* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2445 	return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2446 }
2447 
2448 static int dummy_start(struct usb_hcd *hcd)
2449 {
2450 	struct dummy_hcd	*dum_hcd = hcd_to_dummy_hcd(hcd);
2451 
2452 	/*
2453 	 * MASTER side init ... we emulate a root hub that'll only ever
2454 	 * talk to one device (the slave side).  Also appears in sysfs,
2455 	 * just like more familiar pci-based HCDs.
2456 	 */
2457 	if (!usb_hcd_is_primary_hcd(hcd))
2458 		return dummy_start_ss(dum_hcd);
2459 
2460 	spin_lock_init(&dum_hcd->dum->lock);
2461 	timer_setup(&dum_hcd->timer, dummy_timer, 0);
2462 	dum_hcd->rh_state = DUMMY_RH_RUNNING;
2463 
2464 	INIT_LIST_HEAD(&dum_hcd->urbp_list);
2465 
2466 	hcd->power_budget = POWER_BUDGET;
2467 	hcd->state = HC_STATE_RUNNING;
2468 	hcd->uses_new_polling = 1;
2469 
2470 #ifdef CONFIG_USB_OTG
2471 	hcd->self.otg_port = 1;
2472 #endif
2473 
2474 	/* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2475 	return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2476 }
2477 
2478 static void dummy_stop(struct usb_hcd *hcd)
2479 {
2480 	device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2481 	dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2482 }
2483 
2484 /*-------------------------------------------------------------------------*/
2485 
2486 static int dummy_h_get_frame(struct usb_hcd *hcd)
2487 {
2488 	return dummy_g_get_frame(NULL);
2489 }
2490 
2491 static int dummy_setup(struct usb_hcd *hcd)
2492 {
2493 	struct dummy *dum;
2494 
2495 	dum = *((void **)dev_get_platdata(hcd->self.controller));
2496 	hcd->self.sg_tablesize = ~0;
2497 	if (usb_hcd_is_primary_hcd(hcd)) {
2498 		dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2499 		dum->hs_hcd->dum = dum;
2500 		/*
2501 		 * Mark the first roothub as being USB 2.0.
2502 		 * The USB 3.0 roothub will be registered later by
2503 		 * dummy_hcd_probe()
2504 		 */
2505 		hcd->speed = HCD_USB2;
2506 		hcd->self.root_hub->speed = USB_SPEED_HIGH;
2507 	} else {
2508 		dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2509 		dum->ss_hcd->dum = dum;
2510 		hcd->speed = HCD_USB3;
2511 		hcd->self.root_hub->speed = USB_SPEED_SUPER;
2512 	}
2513 	return 0;
2514 }
2515 
2516 /* Change a group of bulk endpoints to support multiple stream IDs */
2517 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2518 	struct usb_host_endpoint **eps, unsigned int num_eps,
2519 	unsigned int num_streams, gfp_t mem_flags)
2520 {
2521 	struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2522 	unsigned long flags;
2523 	int max_stream;
2524 	int ret_streams = num_streams;
2525 	unsigned int index;
2526 	unsigned int i;
2527 
2528 	if (!num_eps)
2529 		return -EINVAL;
2530 
2531 	spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2532 	for (i = 0; i < num_eps; i++) {
2533 		index = dummy_get_ep_idx(&eps[i]->desc);
2534 		if ((1 << index) & dum_hcd->stream_en_ep) {
2535 			ret_streams = -EINVAL;
2536 			goto out;
2537 		}
2538 		max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2539 		if (!max_stream) {
2540 			ret_streams = -EINVAL;
2541 			goto out;
2542 		}
2543 		if (max_stream < ret_streams) {
2544 			dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2545 					"stream IDs.\n",
2546 					eps[i]->desc.bEndpointAddress,
2547 					max_stream);
2548 			ret_streams = max_stream;
2549 		}
2550 	}
2551 
2552 	for (i = 0; i < num_eps; i++) {
2553 		index = dummy_get_ep_idx(&eps[i]->desc);
2554 		dum_hcd->stream_en_ep |= 1 << index;
2555 		set_max_streams_for_pipe(dum_hcd,
2556 				usb_endpoint_num(&eps[i]->desc), ret_streams);
2557 	}
2558 out:
2559 	spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2560 	return ret_streams;
2561 }
2562 
2563 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2564 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2565 	struct usb_host_endpoint **eps, unsigned int num_eps,
2566 	gfp_t mem_flags)
2567 {
2568 	struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2569 	unsigned long flags;
2570 	int ret;
2571 	unsigned int index;
2572 	unsigned int i;
2573 
2574 	spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2575 	for (i = 0; i < num_eps; i++) {
2576 		index = dummy_get_ep_idx(&eps[i]->desc);
2577 		if (!((1 << index) & dum_hcd->stream_en_ep)) {
2578 			ret = -EINVAL;
2579 			goto out;
2580 		}
2581 	}
2582 
2583 	for (i = 0; i < num_eps; i++) {
2584 		index = dummy_get_ep_idx(&eps[i]->desc);
2585 		dum_hcd->stream_en_ep &= ~(1 << index);
2586 		set_max_streams_for_pipe(dum_hcd,
2587 				usb_endpoint_num(&eps[i]->desc), 0);
2588 	}
2589 	ret = 0;
2590 out:
2591 	spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2592 	return ret;
2593 }
2594 
2595 static struct hc_driver dummy_hcd = {
2596 	.description =		(char *) driver_name,
2597 	.product_desc =		"Dummy host controller",
2598 	.hcd_priv_size =	sizeof(struct dummy_hcd),
2599 
2600 	.reset =		dummy_setup,
2601 	.start =		dummy_start,
2602 	.stop =			dummy_stop,
2603 
2604 	.urb_enqueue =		dummy_urb_enqueue,
2605 	.urb_dequeue =		dummy_urb_dequeue,
2606 
2607 	.get_frame_number =	dummy_h_get_frame,
2608 
2609 	.hub_status_data =	dummy_hub_status,
2610 	.hub_control =		dummy_hub_control,
2611 	.bus_suspend =		dummy_bus_suspend,
2612 	.bus_resume =		dummy_bus_resume,
2613 
2614 	.alloc_streams =	dummy_alloc_streams,
2615 	.free_streams =		dummy_free_streams,
2616 };
2617 
2618 static int dummy_hcd_probe(struct platform_device *pdev)
2619 {
2620 	struct dummy		*dum;
2621 	struct usb_hcd		*hs_hcd;
2622 	struct usb_hcd		*ss_hcd;
2623 	int			retval;
2624 
2625 	dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2626 	dum = *((void **)dev_get_platdata(&pdev->dev));
2627 
2628 	if (mod_data.is_super_speed)
2629 		dummy_hcd.flags = HCD_USB3 | HCD_SHARED;
2630 	else if (mod_data.is_high_speed)
2631 		dummy_hcd.flags = HCD_USB2;
2632 	else
2633 		dummy_hcd.flags = HCD_USB11;
2634 	hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2635 	if (!hs_hcd)
2636 		return -ENOMEM;
2637 	hs_hcd->has_tt = 1;
2638 
2639 	retval = usb_add_hcd(hs_hcd, 0, 0);
2640 	if (retval)
2641 		goto put_usb2_hcd;
2642 
2643 	if (mod_data.is_super_speed) {
2644 		ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2645 					dev_name(&pdev->dev), hs_hcd);
2646 		if (!ss_hcd) {
2647 			retval = -ENOMEM;
2648 			goto dealloc_usb2_hcd;
2649 		}
2650 
2651 		retval = usb_add_hcd(ss_hcd, 0, 0);
2652 		if (retval)
2653 			goto put_usb3_hcd;
2654 	}
2655 	return 0;
2656 
2657 put_usb3_hcd:
2658 	usb_put_hcd(ss_hcd);
2659 dealloc_usb2_hcd:
2660 	usb_remove_hcd(hs_hcd);
2661 put_usb2_hcd:
2662 	usb_put_hcd(hs_hcd);
2663 	dum->hs_hcd = dum->ss_hcd = NULL;
2664 	return retval;
2665 }
2666 
2667 static int dummy_hcd_remove(struct platform_device *pdev)
2668 {
2669 	struct dummy		*dum;
2670 
2671 	dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2672 
2673 	if (dum->ss_hcd) {
2674 		usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2675 		usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2676 	}
2677 
2678 	usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2679 	usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2680 
2681 	dum->hs_hcd = NULL;
2682 	dum->ss_hcd = NULL;
2683 
2684 	return 0;
2685 }
2686 
2687 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2688 {
2689 	struct usb_hcd		*hcd;
2690 	struct dummy_hcd	*dum_hcd;
2691 	int			rc = 0;
2692 
2693 	dev_dbg(&pdev->dev, "%s\n", __func__);
2694 
2695 	hcd = platform_get_drvdata(pdev);
2696 	dum_hcd = hcd_to_dummy_hcd(hcd);
2697 	if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2698 		dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2699 		rc = -EBUSY;
2700 	} else
2701 		clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2702 	return rc;
2703 }
2704 
2705 static int dummy_hcd_resume(struct platform_device *pdev)
2706 {
2707 	struct usb_hcd		*hcd;
2708 
2709 	dev_dbg(&pdev->dev, "%s\n", __func__);
2710 
2711 	hcd = platform_get_drvdata(pdev);
2712 	set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2713 	usb_hcd_poll_rh_status(hcd);
2714 	return 0;
2715 }
2716 
2717 static struct platform_driver dummy_hcd_driver = {
2718 	.probe		= dummy_hcd_probe,
2719 	.remove		= dummy_hcd_remove,
2720 	.suspend	= dummy_hcd_suspend,
2721 	.resume		= dummy_hcd_resume,
2722 	.driver		= {
2723 		.name	= (char *) driver_name,
2724 	},
2725 };
2726 
2727 /*-------------------------------------------------------------------------*/
2728 #define MAX_NUM_UDC	32
2729 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2730 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2731 
2732 static int __init init(void)
2733 {
2734 	int	retval = -ENOMEM;
2735 	int	i;
2736 	struct	dummy *dum[MAX_NUM_UDC];
2737 
2738 	if (usb_disabled())
2739 		return -ENODEV;
2740 
2741 	if (!mod_data.is_high_speed && mod_data.is_super_speed)
2742 		return -EINVAL;
2743 
2744 	if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2745 		pr_err("Number of emulated UDC must be in range of 1...%d\n",
2746 				MAX_NUM_UDC);
2747 		return -EINVAL;
2748 	}
2749 
2750 	for (i = 0; i < mod_data.num; i++) {
2751 		the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2752 		if (!the_hcd_pdev[i]) {
2753 			i--;
2754 			while (i >= 0)
2755 				platform_device_put(the_hcd_pdev[i--]);
2756 			return retval;
2757 		}
2758 	}
2759 	for (i = 0; i < mod_data.num; i++) {
2760 		the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2761 		if (!the_udc_pdev[i]) {
2762 			i--;
2763 			while (i >= 0)
2764 				platform_device_put(the_udc_pdev[i--]);
2765 			goto err_alloc_udc;
2766 		}
2767 	}
2768 	for (i = 0; i < mod_data.num; i++) {
2769 		dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2770 		if (!dum[i]) {
2771 			retval = -ENOMEM;
2772 			goto err_add_pdata;
2773 		}
2774 		retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2775 				sizeof(void *));
2776 		if (retval)
2777 			goto err_add_pdata;
2778 		retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2779 				sizeof(void *));
2780 		if (retval)
2781 			goto err_add_pdata;
2782 	}
2783 
2784 	retval = platform_driver_register(&dummy_hcd_driver);
2785 	if (retval < 0)
2786 		goto err_add_pdata;
2787 	retval = platform_driver_register(&dummy_udc_driver);
2788 	if (retval < 0)
2789 		goto err_register_udc_driver;
2790 
2791 	for (i = 0; i < mod_data.num; i++) {
2792 		retval = platform_device_add(the_hcd_pdev[i]);
2793 		if (retval < 0) {
2794 			i--;
2795 			while (i >= 0)
2796 				platform_device_del(the_hcd_pdev[i--]);
2797 			goto err_add_hcd;
2798 		}
2799 	}
2800 	for (i = 0; i < mod_data.num; i++) {
2801 		if (!dum[i]->hs_hcd ||
2802 				(!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2803 			/*
2804 			 * The hcd was added successfully but its probe
2805 			 * function failed for some reason.
2806 			 */
2807 			retval = -EINVAL;
2808 			goto err_add_udc;
2809 		}
2810 	}
2811 
2812 	for (i = 0; i < mod_data.num; i++) {
2813 		retval = platform_device_add(the_udc_pdev[i]);
2814 		if (retval < 0) {
2815 			i--;
2816 			while (i >= 0)
2817 				platform_device_del(the_udc_pdev[i--]);
2818 			goto err_add_udc;
2819 		}
2820 	}
2821 
2822 	for (i = 0; i < mod_data.num; i++) {
2823 		if (!platform_get_drvdata(the_udc_pdev[i])) {
2824 			/*
2825 			 * The udc was added successfully but its probe
2826 			 * function failed for some reason.
2827 			 */
2828 			retval = -EINVAL;
2829 			goto err_probe_udc;
2830 		}
2831 	}
2832 	return retval;
2833 
2834 err_probe_udc:
2835 	for (i = 0; i < mod_data.num; i++)
2836 		platform_device_del(the_udc_pdev[i]);
2837 err_add_udc:
2838 	for (i = 0; i < mod_data.num; i++)
2839 		platform_device_del(the_hcd_pdev[i]);
2840 err_add_hcd:
2841 	platform_driver_unregister(&dummy_udc_driver);
2842 err_register_udc_driver:
2843 	platform_driver_unregister(&dummy_hcd_driver);
2844 err_add_pdata:
2845 	for (i = 0; i < mod_data.num; i++)
2846 		kfree(dum[i]);
2847 	for (i = 0; i < mod_data.num; i++)
2848 		platform_device_put(the_udc_pdev[i]);
2849 err_alloc_udc:
2850 	for (i = 0; i < mod_data.num; i++)
2851 		platform_device_put(the_hcd_pdev[i]);
2852 	return retval;
2853 }
2854 module_init(init);
2855 
2856 static void __exit cleanup(void)
2857 {
2858 	int i;
2859 
2860 	for (i = 0; i < mod_data.num; i++) {
2861 		struct dummy *dum;
2862 
2863 		dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2864 
2865 		platform_device_unregister(the_udc_pdev[i]);
2866 		platform_device_unregister(the_hcd_pdev[i]);
2867 		kfree(dum);
2868 	}
2869 	platform_driver_unregister(&dummy_udc_driver);
2870 	platform_driver_unregister(&dummy_hcd_driver);
2871 }
2872 module_exit(cleanup);
2873