]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/usb/gadget/udc/dummy_hcd.c
projects / mirror_ubuntu-bionic-kernel.git / blob
? search:


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