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