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