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