Merge branch 'bind_unbind' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[GitHub/LineageOS/android_kernel_motorola_exynos9610.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
885 if (value && dum->driver) {
886 if (mod_data.is_super_speed)
887 dum->gadget.speed = dum->driver->max_speed;
888 else if (mod_data.is_high_speed)
889 dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
890 dum->driver->max_speed);
891 else
892 dum->gadget.speed = USB_SPEED_FULL;
893 dummy_udc_update_ep0(dum);
894
895 if (dum->gadget.speed < dum->driver->max_speed)
896 dev_dbg(udc_dev(dum), "This device can perform faster"
897 " if you connect it to a %s port...\n",
898 usb_speed_string(dum->driver->max_speed));
899 }
900 dum_hcd = gadget_to_dummy_hcd(_gadget);
901
902 spin_lock_irqsave(&dum->lock, flags);
903 dum->pullup = (value != 0);
904 set_link_state(dum_hcd);
905 spin_unlock_irqrestore(&dum->lock, flags);
906
907 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
908 return 0;
909 }
910
911 static int dummy_udc_start(struct usb_gadget *g,
912 struct usb_gadget_driver *driver);
913 static int dummy_udc_stop(struct usb_gadget *g);
914
915 static const struct usb_gadget_ops dummy_ops = {
916 .get_frame = dummy_g_get_frame,
917 .wakeup = dummy_wakeup,
918 .set_selfpowered = dummy_set_selfpowered,
919 .pullup = dummy_pullup,
920 .udc_start = dummy_udc_start,
921 .udc_stop = dummy_udc_stop,
922 };
923
924 /*-------------------------------------------------------------------------*/
925
926 /* "function" sysfs attribute */
927 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
928 char *buf)
929 {
930 struct dummy *dum = gadget_dev_to_dummy(dev);
931
932 if (!dum->driver || !dum->driver->function)
933 return 0;
934 return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
935 }
936 static DEVICE_ATTR_RO(function);
937
938 /*-------------------------------------------------------------------------*/
939
940 /*
941 * Driver registration/unregistration.
942 *
943 * This is basically hardware-specific; there's usually only one real USB
944 * device (not host) controller since that's how USB devices are intended
945 * to work. So most implementations of these api calls will rely on the
946 * fact that only one driver will ever bind to the hardware. But curious
947 * hardware can be built with discrete components, so the gadget API doesn't
948 * require that assumption.
949 *
950 * For this emulator, it might be convenient to create a usb slave device
951 * for each driver that registers: just add to a big root hub.
952 */
953
954 static int dummy_udc_start(struct usb_gadget *g,
955 struct usb_gadget_driver *driver)
956 {
957 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
958 struct dummy *dum = dum_hcd->dum;
959
960 if (driver->max_speed == USB_SPEED_UNKNOWN)
961 return -EINVAL;
962
963 /*
964 * SLAVE side init ... the layer above hardware, which
965 * can't enumerate without help from the driver we're binding.
966 */
967
968 dum->devstatus = 0;
969 dum->driver = driver;
970
971 return 0;
972 }
973
974 static int dummy_udc_stop(struct usb_gadget *g)
975 {
976 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
977 struct dummy *dum = dum_hcd->dum;
978
979 spin_lock_irq(&dum->lock);
980 dum->driver = NULL;
981 spin_unlock_irq(&dum->lock);
982
983 return 0;
984 }
985
986 #undef is_enabled
987
988 /* The gadget structure is stored inside the hcd structure and will be
989 * released along with it. */
990 static void init_dummy_udc_hw(struct dummy *dum)
991 {
992 int i;
993
994 INIT_LIST_HEAD(&dum->gadget.ep_list);
995 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
996 struct dummy_ep *ep = &dum->ep[i];
997
998 if (!ep_info[i].name)
999 break;
1000 ep->ep.name = ep_info[i].name;
1001 ep->ep.caps = ep_info[i].caps;
1002 ep->ep.ops = &dummy_ep_ops;
1003 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1004 ep->halted = ep->wedged = ep->already_seen =
1005 ep->setup_stage = 0;
1006 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1007 ep->ep.max_streams = 16;
1008 ep->last_io = jiffies;
1009 ep->gadget = &dum->gadget;
1010 ep->desc = NULL;
1011 INIT_LIST_HEAD(&ep->queue);
1012 }
1013
1014 dum->gadget.ep0 = &dum->ep[0].ep;
1015 list_del_init(&dum->ep[0].ep.ep_list);
1016 INIT_LIST_HEAD(&dum->fifo_req.queue);
1017
1018 #ifdef CONFIG_USB_OTG
1019 dum->gadget.is_otg = 1;
1020 #endif
1021 }
1022
1023 static int dummy_udc_probe(struct platform_device *pdev)
1024 {
1025 struct dummy *dum;
1026 int rc;
1027
1028 dum = *((void **)dev_get_platdata(&pdev->dev));
1029 /* Clear usb_gadget region for new registration to udc-core */
1030 memzero_explicit(&dum->gadget, sizeof(struct usb_gadget));
1031 dum->gadget.name = gadget_name;
1032 dum->gadget.ops = &dummy_ops;
1033 dum->gadget.max_speed = USB_SPEED_SUPER;
1034
1035 dum->gadget.dev.parent = &pdev->dev;
1036 init_dummy_udc_hw(dum);
1037
1038 rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1039 if (rc < 0)
1040 goto err_udc;
1041
1042 rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1043 if (rc < 0)
1044 goto err_dev;
1045 platform_set_drvdata(pdev, dum);
1046 return rc;
1047
1048 err_dev:
1049 usb_del_gadget_udc(&dum->gadget);
1050 err_udc:
1051 return rc;
1052 }
1053
1054 static int dummy_udc_remove(struct platform_device *pdev)
1055 {
1056 struct dummy *dum = platform_get_drvdata(pdev);
1057
1058 device_remove_file(&dum->gadget.dev, &dev_attr_function);
1059 usb_del_gadget_udc(&dum->gadget);
1060 return 0;
1061 }
1062
1063 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1064 int suspend)
1065 {
1066 spin_lock_irq(&dum->lock);
1067 dum->udc_suspended = suspend;
1068 set_link_state(dum_hcd);
1069 spin_unlock_irq(&dum->lock);
1070 }
1071
1072 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1073 {
1074 struct dummy *dum = platform_get_drvdata(pdev);
1075 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1076
1077 dev_dbg(&pdev->dev, "%s\n", __func__);
1078 dummy_udc_pm(dum, dum_hcd, 1);
1079 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1080 return 0;
1081 }
1082
1083 static int dummy_udc_resume(struct platform_device *pdev)
1084 {
1085 struct dummy *dum = platform_get_drvdata(pdev);
1086 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1087
1088 dev_dbg(&pdev->dev, "%s\n", __func__);
1089 dummy_udc_pm(dum, dum_hcd, 0);
1090 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1091 return 0;
1092 }
1093
1094 static struct platform_driver dummy_udc_driver = {
1095 .probe = dummy_udc_probe,
1096 .remove = dummy_udc_remove,
1097 .suspend = dummy_udc_suspend,
1098 .resume = dummy_udc_resume,
1099 .driver = {
1100 .name = (char *) gadget_name,
1101 },
1102 };
1103
1104 /*-------------------------------------------------------------------------*/
1105
1106 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1107 {
1108 unsigned int index;
1109
1110 index = usb_endpoint_num(desc) << 1;
1111 if (usb_endpoint_dir_in(desc))
1112 index |= 1;
1113 return index;
1114 }
1115
1116 /* MASTER/HOST SIDE DRIVER
1117 *
1118 * this uses the hcd framework to hook up to host side drivers.
1119 * its root hub will only have one device, otherwise it acts like
1120 * a normal host controller.
1121 *
1122 * when urbs are queued, they're just stuck on a list that we
1123 * scan in a timer callback. that callback connects writes from
1124 * the host with reads from the device, and so on, based on the
1125 * usb 2.0 rules.
1126 */
1127
1128 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1129 {
1130 const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1131 u32 index;
1132
1133 if (!usb_endpoint_xfer_bulk(desc))
1134 return 0;
1135
1136 index = dummy_get_ep_idx(desc);
1137 return (1 << index) & dum_hcd->stream_en_ep;
1138 }
1139
1140 /*
1141 * The max stream number is saved as a nibble so for the 30 possible endpoints
1142 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1143 * means we use only 1 stream). The maximum according to the spec is 16bit so
1144 * if the 16 stream limit is about to go, the array size should be incremented
1145 * to 30 elements of type u16.
1146 */
1147 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1148 unsigned int pipe)
1149 {
1150 int max_streams;
1151
1152 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1153 if (usb_pipeout(pipe))
1154 max_streams >>= 4;
1155 else
1156 max_streams &= 0xf;
1157 max_streams++;
1158 return max_streams;
1159 }
1160
1161 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1162 unsigned int pipe, unsigned int streams)
1163 {
1164 int max_streams;
1165
1166 streams--;
1167 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1168 if (usb_pipeout(pipe)) {
1169 streams <<= 4;
1170 max_streams &= 0xf;
1171 } else {
1172 max_streams &= 0xf0;
1173 }
1174 max_streams |= streams;
1175 dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1176 }
1177
1178 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1179 {
1180 unsigned int max_streams;
1181 int enabled;
1182
1183 enabled = dummy_ep_stream_en(dum_hcd, urb);
1184 if (!urb->stream_id) {
1185 if (enabled)
1186 return -EINVAL;
1187 return 0;
1188 }
1189 if (!enabled)
1190 return -EINVAL;
1191
1192 max_streams = get_max_streams_for_pipe(dum_hcd,
1193 usb_pipeendpoint(urb->pipe));
1194 if (urb->stream_id > max_streams) {
1195 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1196 urb->stream_id);
1197 BUG();
1198 return -EINVAL;
1199 }
1200 return 0;
1201 }
1202
1203 static int dummy_urb_enqueue(
1204 struct usb_hcd *hcd,
1205 struct urb *urb,
1206 gfp_t mem_flags
1207 ) {
1208 struct dummy_hcd *dum_hcd;
1209 struct urbp *urbp;
1210 unsigned long flags;
1211 int rc;
1212
1213 urbp = kmalloc(sizeof *urbp, mem_flags);
1214 if (!urbp)
1215 return -ENOMEM;
1216 urbp->urb = urb;
1217 urbp->miter_started = 0;
1218
1219 dum_hcd = hcd_to_dummy_hcd(hcd);
1220 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1221
1222 rc = dummy_validate_stream(dum_hcd, urb);
1223 if (rc) {
1224 kfree(urbp);
1225 goto done;
1226 }
1227
1228 rc = usb_hcd_link_urb_to_ep(hcd, urb);
1229 if (rc) {
1230 kfree(urbp);
1231 goto done;
1232 }
1233
1234 if (!dum_hcd->udev) {
1235 dum_hcd->udev = urb->dev;
1236 usb_get_dev(dum_hcd->udev);
1237 } else if (unlikely(dum_hcd->udev != urb->dev))
1238 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1239
1240 list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1241 urb->hcpriv = urbp;
1242 if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1243 urb->error_count = 1; /* mark as a new urb */
1244
1245 /* kick the scheduler, it'll do the rest */
1246 if (!timer_pending(&dum_hcd->timer))
1247 mod_timer(&dum_hcd->timer, jiffies + 1);
1248
1249 done:
1250 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1251 return rc;
1252 }
1253
1254 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1255 {
1256 struct dummy_hcd *dum_hcd;
1257 unsigned long flags;
1258 int rc;
1259
1260 /* giveback happens automatically in timer callback,
1261 * so make sure the callback happens */
1262 dum_hcd = hcd_to_dummy_hcd(hcd);
1263 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1264
1265 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1266 if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1267 !list_empty(&dum_hcd->urbp_list))
1268 mod_timer(&dum_hcd->timer, jiffies);
1269
1270 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1271 return rc;
1272 }
1273
1274 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1275 u32 len)
1276 {
1277 void *ubuf, *rbuf;
1278 struct urbp *urbp = urb->hcpriv;
1279 int to_host;
1280 struct sg_mapping_iter *miter = &urbp->miter;
1281 u32 trans = 0;
1282 u32 this_sg;
1283 bool next_sg;
1284
1285 to_host = usb_pipein(urb->pipe);
1286 rbuf = req->req.buf + req->req.actual;
1287
1288 if (!urb->num_sgs) {
1289 ubuf = urb->transfer_buffer + urb->actual_length;
1290 if (to_host)
1291 memcpy(ubuf, rbuf, len);
1292 else
1293 memcpy(rbuf, ubuf, len);
1294 return len;
1295 }
1296
1297 if (!urbp->miter_started) {
1298 u32 flags = SG_MITER_ATOMIC;
1299
1300 if (to_host)
1301 flags |= SG_MITER_TO_SG;
1302 else
1303 flags |= SG_MITER_FROM_SG;
1304
1305 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1306 urbp->miter_started = 1;
1307 }
1308 next_sg = sg_miter_next(miter);
1309 if (next_sg == false) {
1310 WARN_ON_ONCE(1);
1311 return -EINVAL;
1312 }
1313 do {
1314 ubuf = miter->addr;
1315 this_sg = min_t(u32, len, miter->length);
1316 miter->consumed = this_sg;
1317 trans += this_sg;
1318
1319 if (to_host)
1320 memcpy(ubuf, rbuf, this_sg);
1321 else
1322 memcpy(rbuf, ubuf, this_sg);
1323 len -= this_sg;
1324
1325 if (!len)
1326 break;
1327 next_sg = sg_miter_next(miter);
1328 if (next_sg == false) {
1329 WARN_ON_ONCE(1);
1330 return -EINVAL;
1331 }
1332
1333 rbuf += this_sg;
1334 } while (1);
1335
1336 sg_miter_stop(miter);
1337 return trans;
1338 }
1339
1340 /* transfer up to a frame's worth; caller must own lock */
1341 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1342 struct dummy_ep *ep, int limit, int *status)
1343 {
1344 struct dummy *dum = dum_hcd->dum;
1345 struct dummy_request *req;
1346 int sent = 0;
1347
1348 top:
1349 /* if there's no request queued, the device is NAKing; return */
1350 list_for_each_entry(req, &ep->queue, queue) {
1351 unsigned host_len, dev_len, len;
1352 int is_short, to_host;
1353 int rescan = 0;
1354
1355 if (dummy_ep_stream_en(dum_hcd, urb)) {
1356 if ((urb->stream_id != req->req.stream_id))
1357 continue;
1358 }
1359
1360 /* 1..N packets of ep->ep.maxpacket each ... the last one
1361 * may be short (including zero length).
1362 *
1363 * writer can send a zlp explicitly (length 0) or implicitly
1364 * (length mod maxpacket zero, and 'zero' flag); they always
1365 * terminate reads.
1366 */
1367 host_len = urb->transfer_buffer_length - urb->actual_length;
1368 dev_len = req->req.length - req->req.actual;
1369 len = min(host_len, dev_len);
1370
1371 /* FIXME update emulated data toggle too */
1372
1373 to_host = usb_pipein(urb->pipe);
1374 if (unlikely(len == 0))
1375 is_short = 1;
1376 else {
1377 /* not enough bandwidth left? */
1378 if (limit < ep->ep.maxpacket && limit < len)
1379 break;
1380 len = min_t(unsigned, len, limit);
1381 if (len == 0)
1382 break;
1383
1384 /* send multiple of maxpacket first, then remainder */
1385 if (len >= ep->ep.maxpacket) {
1386 is_short = 0;
1387 if (len % ep->ep.maxpacket)
1388 rescan = 1;
1389 len -= len % ep->ep.maxpacket;
1390 } else {
1391 is_short = 1;
1392 }
1393
1394 len = dummy_perform_transfer(urb, req, len);
1395
1396 ep->last_io = jiffies;
1397 if ((int)len < 0) {
1398 req->req.status = len;
1399 } else {
1400 limit -= len;
1401 sent += len;
1402 urb->actual_length += len;
1403 req->req.actual += len;
1404 }
1405 }
1406
1407 /* short packets terminate, maybe with overflow/underflow.
1408 * it's only really an error to write too much.
1409 *
1410 * partially filling a buffer optionally blocks queue advances
1411 * (so completion handlers can clean up the queue) but we don't
1412 * need to emulate such data-in-flight.
1413 */
1414 if (is_short) {
1415 if (host_len == dev_len) {
1416 req->req.status = 0;
1417 *status = 0;
1418 } else if (to_host) {
1419 req->req.status = 0;
1420 if (dev_len > host_len)
1421 *status = -EOVERFLOW;
1422 else
1423 *status = 0;
1424 } else {
1425 *status = 0;
1426 if (host_len > dev_len)
1427 req->req.status = -EOVERFLOW;
1428 else
1429 req->req.status = 0;
1430 }
1431
1432 /*
1433 * many requests terminate without a short packet.
1434 * send a zlp if demanded by flags.
1435 */
1436 } else {
1437 if (req->req.length == req->req.actual) {
1438 if (req->req.zero && to_host)
1439 rescan = 1;
1440 else
1441 req->req.status = 0;
1442 }
1443 if (urb->transfer_buffer_length == urb->actual_length) {
1444 if (urb->transfer_flags & URB_ZERO_PACKET &&
1445 !to_host)
1446 rescan = 1;
1447 else
1448 *status = 0;
1449 }
1450 }
1451
1452 /* device side completion --> continuable */
1453 if (req->req.status != -EINPROGRESS) {
1454 list_del_init(&req->queue);
1455
1456 spin_unlock(&dum->lock);
1457 usb_gadget_giveback_request(&ep->ep, &req->req);
1458 spin_lock(&dum->lock);
1459
1460 /* requests might have been unlinked... */
1461 rescan = 1;
1462 }
1463
1464 /* host side completion --> terminate */
1465 if (*status != -EINPROGRESS)
1466 break;
1467
1468 /* rescan to continue with any other queued i/o */
1469 if (rescan)
1470 goto top;
1471 }
1472 return sent;
1473 }
1474
1475 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1476 {
1477 int limit = ep->ep.maxpacket;
1478
1479 if (dum->gadget.speed == USB_SPEED_HIGH) {
1480 int tmp;
1481
1482 /* high bandwidth mode */
1483 tmp = usb_endpoint_maxp_mult(ep->desc);
1484 tmp *= 8 /* applies to entire frame */;
1485 limit += limit * tmp;
1486 }
1487 if (dum->gadget.speed == USB_SPEED_SUPER) {
1488 switch (usb_endpoint_type(ep->desc)) {
1489 case USB_ENDPOINT_XFER_ISOC:
1490 /* Sec. 4.4.8.2 USB3.0 Spec */
1491 limit = 3 * 16 * 1024 * 8;
1492 break;
1493 case USB_ENDPOINT_XFER_INT:
1494 /* Sec. 4.4.7.2 USB3.0 Spec */
1495 limit = 3 * 1024 * 8;
1496 break;
1497 case USB_ENDPOINT_XFER_BULK:
1498 default:
1499 break;
1500 }
1501 }
1502 return limit;
1503 }
1504
1505 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1506 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1507 USB_PORT_STAT_SUSPEND)) \
1508 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1509
1510 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1511 {
1512 int i;
1513
1514 if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1515 dum->ss_hcd : dum->hs_hcd)))
1516 return NULL;
1517 if ((address & ~USB_DIR_IN) == 0)
1518 return &dum->ep[0];
1519 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1520 struct dummy_ep *ep = &dum->ep[i];
1521
1522 if (!ep->desc)
1523 continue;
1524 if (ep->desc->bEndpointAddress == address)
1525 return ep;
1526 }
1527 return NULL;
1528 }
1529
1530 #undef is_active
1531
1532 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1533 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1534 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1535 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1536 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1537 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1538
1539
1540 /**
1541 * handle_control_request() - handles all control transfers
1542 * @dum: pointer to dummy (the_controller)
1543 * @urb: the urb request to handle
1544 * @setup: pointer to the setup data for a USB device control
1545 * request
1546 * @status: pointer to request handling status
1547 *
1548 * Return 0 - if the request was handled
1549 * 1 - if the request wasn't handles
1550 * error code on error
1551 */
1552 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1553 struct usb_ctrlrequest *setup,
1554 int *status)
1555 {
1556 struct dummy_ep *ep2;
1557 struct dummy *dum = dum_hcd->dum;
1558 int ret_val = 1;
1559 unsigned w_index;
1560 unsigned w_value;
1561
1562 w_index = le16_to_cpu(setup->wIndex);
1563 w_value = le16_to_cpu(setup->wValue);
1564 switch (setup->bRequest) {
1565 case USB_REQ_SET_ADDRESS:
1566 if (setup->bRequestType != Dev_Request)
1567 break;
1568 dum->address = w_value;
1569 *status = 0;
1570 dev_dbg(udc_dev(dum), "set_address = %d\n",
1571 w_value);
1572 ret_val = 0;
1573 break;
1574 case USB_REQ_SET_FEATURE:
1575 if (setup->bRequestType == Dev_Request) {
1576 ret_val = 0;
1577 switch (w_value) {
1578 case USB_DEVICE_REMOTE_WAKEUP:
1579 break;
1580 case USB_DEVICE_B_HNP_ENABLE:
1581 dum->gadget.b_hnp_enable = 1;
1582 break;
1583 case USB_DEVICE_A_HNP_SUPPORT:
1584 dum->gadget.a_hnp_support = 1;
1585 break;
1586 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1587 dum->gadget.a_alt_hnp_support = 1;
1588 break;
1589 case USB_DEVICE_U1_ENABLE:
1590 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1591 HCD_USB3)
1592 w_value = USB_DEV_STAT_U1_ENABLED;
1593 else
1594 ret_val = -EOPNOTSUPP;
1595 break;
1596 case USB_DEVICE_U2_ENABLE:
1597 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1598 HCD_USB3)
1599 w_value = USB_DEV_STAT_U2_ENABLED;
1600 else
1601 ret_val = -EOPNOTSUPP;
1602 break;
1603 case USB_DEVICE_LTM_ENABLE:
1604 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1605 HCD_USB3)
1606 w_value = USB_DEV_STAT_LTM_ENABLED;
1607 else
1608 ret_val = -EOPNOTSUPP;
1609 break;
1610 default:
1611 ret_val = -EOPNOTSUPP;
1612 }
1613 if (ret_val == 0) {
1614 dum->devstatus |= (1 << w_value);
1615 *status = 0;
1616 }
1617 } else if (setup->bRequestType == Ep_Request) {
1618 /* endpoint halt */
1619 ep2 = find_endpoint(dum, w_index);
1620 if (!ep2 || ep2->ep.name == ep0name) {
1621 ret_val = -EOPNOTSUPP;
1622 break;
1623 }
1624 ep2->halted = 1;
1625 ret_val = 0;
1626 *status = 0;
1627 }
1628 break;
1629 case USB_REQ_CLEAR_FEATURE:
1630 if (setup->bRequestType == Dev_Request) {
1631 ret_val = 0;
1632 switch (w_value) {
1633 case USB_DEVICE_REMOTE_WAKEUP:
1634 w_value = USB_DEVICE_REMOTE_WAKEUP;
1635 break;
1636 case USB_DEVICE_U1_ENABLE:
1637 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1638 HCD_USB3)
1639 w_value = USB_DEV_STAT_U1_ENABLED;
1640 else
1641 ret_val = -EOPNOTSUPP;
1642 break;
1643 case USB_DEVICE_U2_ENABLE:
1644 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1645 HCD_USB3)
1646 w_value = USB_DEV_STAT_U2_ENABLED;
1647 else
1648 ret_val = -EOPNOTSUPP;
1649 break;
1650 case USB_DEVICE_LTM_ENABLE:
1651 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1652 HCD_USB3)
1653 w_value = USB_DEV_STAT_LTM_ENABLED;
1654 else
1655 ret_val = -EOPNOTSUPP;
1656 break;
1657 default:
1658 ret_val = -EOPNOTSUPP;
1659 break;
1660 }
1661 if (ret_val == 0) {
1662 dum->devstatus &= ~(1 << w_value);
1663 *status = 0;
1664 }
1665 } else if (setup->bRequestType == Ep_Request) {
1666 /* endpoint halt */
1667 ep2 = find_endpoint(dum, w_index);
1668 if (!ep2) {
1669 ret_val = -EOPNOTSUPP;
1670 break;
1671 }
1672 if (!ep2->wedged)
1673 ep2->halted = 0;
1674 ret_val = 0;
1675 *status = 0;
1676 }
1677 break;
1678 case USB_REQ_GET_STATUS:
1679 if (setup->bRequestType == Dev_InRequest
1680 || setup->bRequestType == Intf_InRequest
1681 || setup->bRequestType == Ep_InRequest) {
1682 char *buf;
1683 /*
1684 * device: remote wakeup, selfpowered
1685 * interface: nothing
1686 * endpoint: halt
1687 */
1688 buf = (char *)urb->transfer_buffer;
1689 if (urb->transfer_buffer_length > 0) {
1690 if (setup->bRequestType == Ep_InRequest) {
1691 ep2 = find_endpoint(dum, w_index);
1692 if (!ep2) {
1693 ret_val = -EOPNOTSUPP;
1694 break;
1695 }
1696 buf[0] = ep2->halted;
1697 } else if (setup->bRequestType ==
1698 Dev_InRequest) {
1699 buf[0] = (u8)dum->devstatus;
1700 } else
1701 buf[0] = 0;
1702 }
1703 if (urb->transfer_buffer_length > 1)
1704 buf[1] = 0;
1705 urb->actual_length = min_t(u32, 2,
1706 urb->transfer_buffer_length);
1707 ret_val = 0;
1708 *status = 0;
1709 }
1710 break;
1711 }
1712 return ret_val;
1713 }
1714
1715 /* drive both sides of the transfers; looks like irq handlers to
1716 * both drivers except the callbacks aren't in_irq().
1717 */
1718 static void dummy_timer(unsigned long _dum_hcd)
1719 {
1720 struct dummy_hcd *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1721 struct dummy *dum = dum_hcd->dum;
1722 struct urbp *urbp, *tmp;
1723 unsigned long flags;
1724 int limit, total;
1725 int i;
1726
1727 /* simplistic model for one frame's bandwidth */
1728 switch (dum->gadget.speed) {
1729 case USB_SPEED_LOW:
1730 total = 8/*bytes*/ * 12/*packets*/;
1731 break;
1732 case USB_SPEED_FULL:
1733 total = 64/*bytes*/ * 19/*packets*/;
1734 break;
1735 case USB_SPEED_HIGH:
1736 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1737 break;
1738 case USB_SPEED_SUPER:
1739 /* Bus speed is 500000 bytes/ms, so use a little less */
1740 total = 490000;
1741 break;
1742 default:
1743 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1744 return;
1745 }
1746
1747 /* FIXME if HZ != 1000 this will probably misbehave ... */
1748
1749 /* look at each urb queued by the host side driver */
1750 spin_lock_irqsave(&dum->lock, flags);
1751
1752 if (!dum_hcd->udev) {
1753 dev_err(dummy_dev(dum_hcd),
1754 "timer fired with no URBs pending?\n");
1755 spin_unlock_irqrestore(&dum->lock, flags);
1756 return;
1757 }
1758
1759 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1760 if (!ep_info[i].name)
1761 break;
1762 dum->ep[i].already_seen = 0;
1763 }
1764
1765 restart:
1766 list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1767 struct urb *urb;
1768 struct dummy_request *req;
1769 u8 address;
1770 struct dummy_ep *ep = NULL;
1771 int type;
1772 int status = -EINPROGRESS;
1773
1774 urb = urbp->urb;
1775 if (urb->unlinked)
1776 goto return_urb;
1777 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1778 continue;
1779 type = usb_pipetype(urb->pipe);
1780
1781 /* used up this frame's non-periodic bandwidth?
1782 * FIXME there's infinite bandwidth for control and
1783 * periodic transfers ... unrealistic.
1784 */
1785 if (total <= 0 && type == PIPE_BULK)
1786 continue;
1787
1788 /* find the gadget's ep for this request (if configured) */
1789 address = usb_pipeendpoint (urb->pipe);
1790 if (usb_pipein(urb->pipe))
1791 address |= USB_DIR_IN;
1792 ep = find_endpoint(dum, address);
1793 if (!ep) {
1794 /* set_configuration() disagreement */
1795 dev_dbg(dummy_dev(dum_hcd),
1796 "no ep configured for urb %p\n",
1797 urb);
1798 status = -EPROTO;
1799 goto return_urb;
1800 }
1801
1802 if (ep->already_seen)
1803 continue;
1804 ep->already_seen = 1;
1805 if (ep == &dum->ep[0] && urb->error_count) {
1806 ep->setup_stage = 1; /* a new urb */
1807 urb->error_count = 0;
1808 }
1809 if (ep->halted && !ep->setup_stage) {
1810 /* NOTE: must not be iso! */
1811 dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1812 ep->ep.name, urb);
1813 status = -EPIPE;
1814 goto return_urb;
1815 }
1816 /* FIXME make sure both ends agree on maxpacket */
1817
1818 /* handle control requests */
1819 if (ep == &dum->ep[0] && ep->setup_stage) {
1820 struct usb_ctrlrequest setup;
1821 int value = 1;
1822
1823 setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1824 /* paranoia, in case of stale queued data */
1825 list_for_each_entry(req, &ep->queue, queue) {
1826 list_del_init(&req->queue);
1827 req->req.status = -EOVERFLOW;
1828 dev_dbg(udc_dev(dum), "stale req = %p\n",
1829 req);
1830
1831 spin_unlock(&dum->lock);
1832 usb_gadget_giveback_request(&ep->ep, &req->req);
1833 spin_lock(&dum->lock);
1834 ep->already_seen = 0;
1835 goto restart;
1836 }
1837
1838 /* gadget driver never sees set_address or operations
1839 * on standard feature flags. some hardware doesn't
1840 * even expose them.
1841 */
1842 ep->last_io = jiffies;
1843 ep->setup_stage = 0;
1844 ep->halted = 0;
1845
1846 value = handle_control_request(dum_hcd, urb, &setup,
1847 &status);
1848
1849 /* gadget driver handles all other requests. block
1850 * until setup() returns; no reentrancy issues etc.
1851 */
1852 if (value > 0) {
1853 spin_unlock(&dum->lock);
1854 value = dum->driver->setup(&dum->gadget,
1855 &setup);
1856 spin_lock(&dum->lock);
1857
1858 if (value >= 0) {
1859 /* no delays (max 64KB data stage) */
1860 limit = 64*1024;
1861 goto treat_control_like_bulk;
1862 }
1863 /* error, see below */
1864 }
1865
1866 if (value < 0) {
1867 if (value != -EOPNOTSUPP)
1868 dev_dbg(udc_dev(dum),
1869 "setup --> %d\n",
1870 value);
1871 status = -EPIPE;
1872 urb->actual_length = 0;
1873 }
1874
1875 goto return_urb;
1876 }
1877
1878 /* non-control requests */
1879 limit = total;
1880 switch (usb_pipetype(urb->pipe)) {
1881 case PIPE_ISOCHRONOUS:
1882 /* FIXME is it urb->interval since the last xfer?
1883 * use urb->iso_frame_desc[i].
1884 * complete whether or not ep has requests queued.
1885 * report random errors, to debug drivers.
1886 */
1887 limit = max(limit, periodic_bytes(dum, ep));
1888 status = -ENOSYS;
1889 break;
1890
1891 case PIPE_INTERRUPT:
1892 /* FIXME is it urb->interval since the last xfer?
1893 * this almost certainly polls too fast.
1894 */
1895 limit = max(limit, periodic_bytes(dum, ep));
1896 /* FALLTHROUGH */
1897
1898 default:
1899 treat_control_like_bulk:
1900 ep->last_io = jiffies;
1901 total -= transfer(dum_hcd, urb, ep, limit, &status);
1902 break;
1903 }
1904
1905 /* incomplete transfer? */
1906 if (status == -EINPROGRESS)
1907 continue;
1908
1909 return_urb:
1910 list_del(&urbp->urbp_list);
1911 kfree(urbp);
1912 if (ep)
1913 ep->already_seen = ep->setup_stage = 0;
1914
1915 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1916 spin_unlock(&dum->lock);
1917 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1918 spin_lock(&dum->lock);
1919
1920 goto restart;
1921 }
1922
1923 if (list_empty(&dum_hcd->urbp_list)) {
1924 usb_put_dev(dum_hcd->udev);
1925 dum_hcd->udev = NULL;
1926 } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1927 /* want a 1 msec delay here */
1928 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1929 }
1930
1931 spin_unlock_irqrestore(&dum->lock, flags);
1932 }
1933
1934 /*-------------------------------------------------------------------------*/
1935
1936 #define PORT_C_MASK \
1937 ((USB_PORT_STAT_C_CONNECTION \
1938 | USB_PORT_STAT_C_ENABLE \
1939 | USB_PORT_STAT_C_SUSPEND \
1940 | USB_PORT_STAT_C_OVERCURRENT \
1941 | USB_PORT_STAT_C_RESET) << 16)
1942
1943 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1944 {
1945 struct dummy_hcd *dum_hcd;
1946 unsigned long flags;
1947 int retval = 0;
1948
1949 dum_hcd = hcd_to_dummy_hcd(hcd);
1950
1951 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1952 if (!HCD_HW_ACCESSIBLE(hcd))
1953 goto done;
1954
1955 if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
1956 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1957 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
1958 set_link_state(dum_hcd);
1959 }
1960
1961 if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
1962 *buf = (1 << 1);
1963 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
1964 dum_hcd->port_status);
1965 retval = 1;
1966 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
1967 usb_hcd_resume_root_hub(hcd);
1968 }
1969 done:
1970 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1971 return retval;
1972 }
1973
1974 /* usb 3.0 root hub device descriptor */
1975 static struct {
1976 struct usb_bos_descriptor bos;
1977 struct usb_ss_cap_descriptor ss_cap;
1978 } __packed usb3_bos_desc = {
1979
1980 .bos = {
1981 .bLength = USB_DT_BOS_SIZE,
1982 .bDescriptorType = USB_DT_BOS,
1983 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
1984 .bNumDeviceCaps = 1,
1985 },
1986 .ss_cap = {
1987 .bLength = USB_DT_USB_SS_CAP_SIZE,
1988 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
1989 .bDevCapabilityType = USB_SS_CAP_TYPE,
1990 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
1991 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
1992 },
1993 };
1994
1995 static inline void
1996 ss_hub_descriptor(struct usb_hub_descriptor *desc)
1997 {
1998 memset(desc, 0, sizeof *desc);
1999 desc->bDescriptorType = USB_DT_SS_HUB;
2000 desc->bDescLength = 12;
2001 desc->wHubCharacteristics = cpu_to_le16(
2002 HUB_CHAR_INDV_PORT_LPSM |
2003 HUB_CHAR_COMMON_OCPM);
2004 desc->bNbrPorts = 1;
2005 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2006 desc->u.ss.DeviceRemovable = 0;
2007 }
2008
2009 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2010 {
2011 memset(desc, 0, sizeof *desc);
2012 desc->bDescriptorType = USB_DT_HUB;
2013 desc->bDescLength = 9;
2014 desc->wHubCharacteristics = cpu_to_le16(
2015 HUB_CHAR_INDV_PORT_LPSM |
2016 HUB_CHAR_COMMON_OCPM);
2017 desc->bNbrPorts = 1;
2018 desc->u.hs.DeviceRemovable[0] = 0;
2019 desc->u.hs.DeviceRemovable[1] = 0xff; /* PortPwrCtrlMask */
2020 }
2021
2022 static int dummy_hub_control(
2023 struct usb_hcd *hcd,
2024 u16 typeReq,
2025 u16 wValue,
2026 u16 wIndex,
2027 char *buf,
2028 u16 wLength
2029 ) {
2030 struct dummy_hcd *dum_hcd;
2031 int retval = 0;
2032 unsigned long flags;
2033
2034 if (!HCD_HW_ACCESSIBLE(hcd))
2035 return -ETIMEDOUT;
2036
2037 dum_hcd = hcd_to_dummy_hcd(hcd);
2038
2039 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2040 switch (typeReq) {
2041 case ClearHubFeature:
2042 break;
2043 case ClearPortFeature:
2044 switch (wValue) {
2045 case USB_PORT_FEAT_SUSPEND:
2046 if (hcd->speed == HCD_USB3) {
2047 dev_dbg(dummy_dev(dum_hcd),
2048 "USB_PORT_FEAT_SUSPEND req not "
2049 "supported for USB 3.0 roothub\n");
2050 goto error;
2051 }
2052 if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2053 /* 20msec resume signaling */
2054 dum_hcd->resuming = 1;
2055 dum_hcd->re_timeout = jiffies +
2056 msecs_to_jiffies(20);
2057 }
2058 break;
2059 case USB_PORT_FEAT_POWER:
2060 dev_dbg(dummy_dev(dum_hcd), "power-off\n");
2061 if (hcd->speed == HCD_USB3)
2062 dum_hcd->port_status &= ~USB_SS_PORT_STAT_POWER;
2063 else
2064 dum_hcd->port_status &= ~USB_PORT_STAT_POWER;
2065 set_link_state(dum_hcd);
2066 break;
2067 default:
2068 dum_hcd->port_status &= ~(1 << wValue);
2069 set_link_state(dum_hcd);
2070 }
2071 break;
2072 case GetHubDescriptor:
2073 if (hcd->speed == HCD_USB3 &&
2074 (wLength < USB_DT_SS_HUB_SIZE ||
2075 wValue != (USB_DT_SS_HUB << 8))) {
2076 dev_dbg(dummy_dev(dum_hcd),
2077 "Wrong hub descriptor type for "
2078 "USB 3.0 roothub.\n");
2079 goto error;
2080 }
2081 if (hcd->speed == HCD_USB3)
2082 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2083 else
2084 hub_descriptor((struct usb_hub_descriptor *) buf);
2085 break;
2086
2087 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2088 if (hcd->speed != HCD_USB3)
2089 goto error;
2090
2091 if ((wValue >> 8) != USB_DT_BOS)
2092 goto error;
2093
2094 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2095 retval = sizeof(usb3_bos_desc);
2096 break;
2097
2098 case GetHubStatus:
2099 *(__le32 *) buf = cpu_to_le32(0);
2100 break;
2101 case GetPortStatus:
2102 if (wIndex != 1)
2103 retval = -EPIPE;
2104
2105 /* whoever resets or resumes must GetPortStatus to
2106 * complete it!!
2107 */
2108 if (dum_hcd->resuming &&
2109 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2110 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2111 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2112 }
2113 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2114 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2115 dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2116 dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2117 if (dum_hcd->dum->pullup) {
2118 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2119
2120 if (hcd->speed < HCD_USB3) {
2121 switch (dum_hcd->dum->gadget.speed) {
2122 case USB_SPEED_HIGH:
2123 dum_hcd->port_status |=
2124 USB_PORT_STAT_HIGH_SPEED;
2125 break;
2126 case USB_SPEED_LOW:
2127 dum_hcd->dum->gadget.ep0->
2128 maxpacket = 8;
2129 dum_hcd->port_status |=
2130 USB_PORT_STAT_LOW_SPEED;
2131 break;
2132 default:
2133 dum_hcd->dum->gadget.speed =
2134 USB_SPEED_FULL;
2135 break;
2136 }
2137 }
2138 }
2139 }
2140 set_link_state(dum_hcd);
2141 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2142 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2143 break;
2144 case SetHubFeature:
2145 retval = -EPIPE;
2146 break;
2147 case SetPortFeature:
2148 switch (wValue) {
2149 case USB_PORT_FEAT_LINK_STATE:
2150 if (hcd->speed != HCD_USB3) {
2151 dev_dbg(dummy_dev(dum_hcd),
2152 "USB_PORT_FEAT_LINK_STATE req not "
2153 "supported for USB 2.0 roothub\n");
2154 goto error;
2155 }
2156 /*
2157 * Since this is dummy we don't have an actual link so
2158 * there is nothing to do for the SET_LINK_STATE cmd
2159 */
2160 break;
2161 case USB_PORT_FEAT_U1_TIMEOUT:
2162 case USB_PORT_FEAT_U2_TIMEOUT:
2163 /* TODO: add suspend/resume support! */
2164 if (hcd->speed != HCD_USB3) {
2165 dev_dbg(dummy_dev(dum_hcd),
2166 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2167 "supported for USB 2.0 roothub\n");
2168 goto error;
2169 }
2170 break;
2171 case USB_PORT_FEAT_SUSPEND:
2172 /* Applicable only for USB2.0 hub */
2173 if (hcd->speed == HCD_USB3) {
2174 dev_dbg(dummy_dev(dum_hcd),
2175 "USB_PORT_FEAT_SUSPEND req not "
2176 "supported for USB 3.0 roothub\n");
2177 goto error;
2178 }
2179 if (dum_hcd->active) {
2180 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2181
2182 /* HNP would happen here; for now we
2183 * assume b_bus_req is always true.
2184 */
2185 set_link_state(dum_hcd);
2186 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2187 & dum_hcd->dum->devstatus) != 0)
2188 dev_dbg(dummy_dev(dum_hcd),
2189 "no HNP yet!\n");
2190 }
2191 break;
2192 case USB_PORT_FEAT_POWER:
2193 if (hcd->speed == HCD_USB3)
2194 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2195 else
2196 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2197 set_link_state(dum_hcd);
2198 break;
2199 case USB_PORT_FEAT_BH_PORT_RESET:
2200 /* Applicable only for USB3.0 hub */
2201 if (hcd->speed != HCD_USB3) {
2202 dev_dbg(dummy_dev(dum_hcd),
2203 "USB_PORT_FEAT_BH_PORT_RESET req not "
2204 "supported for USB 2.0 roothub\n");
2205 goto error;
2206 }
2207 /* FALLS THROUGH */
2208 case USB_PORT_FEAT_RESET:
2209 /* if it's already enabled, disable */
2210 if (hcd->speed == HCD_USB3) {
2211 dum_hcd->port_status = 0;
2212 dum_hcd->port_status =
2213 (USB_SS_PORT_STAT_POWER |
2214 USB_PORT_STAT_CONNECTION |
2215 USB_PORT_STAT_RESET);
2216 } else
2217 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2218 | USB_PORT_STAT_LOW_SPEED
2219 | USB_PORT_STAT_HIGH_SPEED);
2220 /*
2221 * We want to reset device status. All but the
2222 * Self powered feature
2223 */
2224 dum_hcd->dum->devstatus &=
2225 (1 << USB_DEVICE_SELF_POWERED);
2226 /*
2227 * FIXME USB3.0: what is the correct reset signaling
2228 * interval? Is it still 50msec as for HS?
2229 */
2230 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2231 /* FALLS THROUGH */
2232 default:
2233 if (hcd->speed == HCD_USB3) {
2234 if ((dum_hcd->port_status &
2235 USB_SS_PORT_STAT_POWER) != 0) {
2236 dum_hcd->port_status |= (1 << wValue);
2237 }
2238 } else
2239 if ((dum_hcd->port_status &
2240 USB_PORT_STAT_POWER) != 0) {
2241 dum_hcd->port_status |= (1 << wValue);
2242 }
2243 set_link_state(dum_hcd);
2244 }
2245 break;
2246 case GetPortErrorCount:
2247 if (hcd->speed != HCD_USB3) {
2248 dev_dbg(dummy_dev(dum_hcd),
2249 "GetPortErrorCount req not "
2250 "supported for USB 2.0 roothub\n");
2251 goto error;
2252 }
2253 /* We'll always return 0 since this is a dummy hub */
2254 *(__le32 *) buf = cpu_to_le32(0);
2255 break;
2256 case SetHubDepth:
2257 if (hcd->speed != HCD_USB3) {
2258 dev_dbg(dummy_dev(dum_hcd),
2259 "SetHubDepth req not supported for "
2260 "USB 2.0 roothub\n");
2261 goto error;
2262 }
2263 break;
2264 default:
2265 dev_dbg(dummy_dev(dum_hcd),
2266 "hub control req%04x v%04x i%04x l%d\n",
2267 typeReq, wValue, wIndex, wLength);
2268 error:
2269 /* "protocol stall" on error */
2270 retval = -EPIPE;
2271 }
2272 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2273
2274 if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2275 usb_hcd_poll_rh_status(hcd);
2276 return retval;
2277 }
2278
2279 static int dummy_bus_suspend(struct usb_hcd *hcd)
2280 {
2281 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2282
2283 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2284
2285 spin_lock_irq(&dum_hcd->dum->lock);
2286 dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2287 set_link_state(dum_hcd);
2288 hcd->state = HC_STATE_SUSPENDED;
2289 spin_unlock_irq(&dum_hcd->dum->lock);
2290 return 0;
2291 }
2292
2293 static int dummy_bus_resume(struct usb_hcd *hcd)
2294 {
2295 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2296 int rc = 0;
2297
2298 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2299
2300 spin_lock_irq(&dum_hcd->dum->lock);
2301 if (!HCD_HW_ACCESSIBLE(hcd)) {
2302 rc = -ESHUTDOWN;
2303 } else {
2304 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2305 set_link_state(dum_hcd);
2306 if (!list_empty(&dum_hcd->urbp_list))
2307 mod_timer(&dum_hcd->timer, jiffies);
2308 hcd->state = HC_STATE_RUNNING;
2309 }
2310 spin_unlock_irq(&dum_hcd->dum->lock);
2311 return rc;
2312 }
2313
2314 /*-------------------------------------------------------------------------*/
2315
2316 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2317 {
2318 int ep = usb_pipeendpoint(urb->pipe);
2319
2320 return snprintf(buf, size,
2321 "urb/%p %s ep%d%s%s len %d/%d\n",
2322 urb,
2323 ({ char *s;
2324 switch (urb->dev->speed) {
2325 case USB_SPEED_LOW:
2326 s = "ls";
2327 break;
2328 case USB_SPEED_FULL:
2329 s = "fs";
2330 break;
2331 case USB_SPEED_HIGH:
2332 s = "hs";
2333 break;
2334 case USB_SPEED_SUPER:
2335 s = "ss";
2336 break;
2337 default:
2338 s = "?";
2339 break;
2340 } s; }),
2341 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2342 ({ char *s; \
2343 switch (usb_pipetype(urb->pipe)) { \
2344 case PIPE_CONTROL: \
2345 s = ""; \
2346 break; \
2347 case PIPE_BULK: \
2348 s = "-bulk"; \
2349 break; \
2350 case PIPE_INTERRUPT: \
2351 s = "-int"; \
2352 break; \
2353 default: \
2354 s = "-iso"; \
2355 break; \
2356 } s; }),
2357 urb->actual_length, urb->transfer_buffer_length);
2358 }
2359
2360 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2361 char *buf)
2362 {
2363 struct usb_hcd *hcd = dev_get_drvdata(dev);
2364 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2365 struct urbp *urbp;
2366 size_t size = 0;
2367 unsigned long flags;
2368
2369 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2370 list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2371 size_t temp;
2372
2373 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2374 buf += temp;
2375 size += temp;
2376 }
2377 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2378
2379 return size;
2380 }
2381 static DEVICE_ATTR_RO(urbs);
2382
2383 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2384 {
2385 init_timer(&dum_hcd->timer);
2386 dum_hcd->timer.function = dummy_timer;
2387 dum_hcd->timer.data = (unsigned long)dum_hcd;
2388 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2389 dum_hcd->stream_en_ep = 0;
2390 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2391 dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET;
2392 dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2393 dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2394 #ifdef CONFIG_USB_OTG
2395 dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2396 #endif
2397 return 0;
2398
2399 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2400 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2401 }
2402
2403 static int dummy_start(struct usb_hcd *hcd)
2404 {
2405 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2406
2407 /*
2408 * MASTER side init ... we emulate a root hub that'll only ever
2409 * talk to one device (the slave side). Also appears in sysfs,
2410 * just like more familiar pci-based HCDs.
2411 */
2412 if (!usb_hcd_is_primary_hcd(hcd))
2413 return dummy_start_ss(dum_hcd);
2414
2415 spin_lock_init(&dum_hcd->dum->lock);
2416 init_timer(&dum_hcd->timer);
2417 dum_hcd->timer.function = dummy_timer;
2418 dum_hcd->timer.data = (unsigned long)dum_hcd;
2419 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2420
2421 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2422
2423 hcd->power_budget = POWER_BUDGET;
2424 hcd->state = HC_STATE_RUNNING;
2425 hcd->uses_new_polling = 1;
2426
2427 #ifdef CONFIG_USB_OTG
2428 hcd->self.otg_port = 1;
2429 #endif
2430
2431 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2432 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2433 }
2434
2435 static void dummy_stop(struct usb_hcd *hcd)
2436 {
2437 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2438 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2439 }
2440
2441 /*-------------------------------------------------------------------------*/
2442
2443 static int dummy_h_get_frame(struct usb_hcd *hcd)
2444 {
2445 return dummy_g_get_frame(NULL);
2446 }
2447
2448 static int dummy_setup(struct usb_hcd *hcd)
2449 {
2450 struct dummy *dum;
2451
2452 dum = *((void **)dev_get_platdata(hcd->self.controller));
2453 hcd->self.sg_tablesize = ~0;
2454 if (usb_hcd_is_primary_hcd(hcd)) {
2455 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2456 dum->hs_hcd->dum = dum;
2457 /*
2458 * Mark the first roothub as being USB 2.0.
2459 * The USB 3.0 roothub will be registered later by
2460 * dummy_hcd_probe()
2461 */
2462 hcd->speed = HCD_USB2;
2463 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2464 } else {
2465 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2466 dum->ss_hcd->dum = dum;
2467 hcd->speed = HCD_USB3;
2468 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2469 }
2470 return 0;
2471 }
2472
2473 /* Change a group of bulk endpoints to support multiple stream IDs */
2474 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2475 struct usb_host_endpoint **eps, unsigned int num_eps,
2476 unsigned int num_streams, gfp_t mem_flags)
2477 {
2478 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2479 unsigned long flags;
2480 int max_stream;
2481 int ret_streams = num_streams;
2482 unsigned int index;
2483 unsigned int i;
2484
2485 if (!num_eps)
2486 return -EINVAL;
2487
2488 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2489 for (i = 0; i < num_eps; i++) {
2490 index = dummy_get_ep_idx(&eps[i]->desc);
2491 if ((1 << index) & dum_hcd->stream_en_ep) {
2492 ret_streams = -EINVAL;
2493 goto out;
2494 }
2495 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2496 if (!max_stream) {
2497 ret_streams = -EINVAL;
2498 goto out;
2499 }
2500 if (max_stream < ret_streams) {
2501 dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2502 "stream IDs.\n",
2503 eps[i]->desc.bEndpointAddress,
2504 max_stream);
2505 ret_streams = max_stream;
2506 }
2507 }
2508
2509 for (i = 0; i < num_eps; i++) {
2510 index = dummy_get_ep_idx(&eps[i]->desc);
2511 dum_hcd->stream_en_ep |= 1 << index;
2512 set_max_streams_for_pipe(dum_hcd,
2513 usb_endpoint_num(&eps[i]->desc), ret_streams);
2514 }
2515 out:
2516 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2517 return ret_streams;
2518 }
2519
2520 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2521 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2522 struct usb_host_endpoint **eps, unsigned int num_eps,
2523 gfp_t mem_flags)
2524 {
2525 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2526 unsigned long flags;
2527 int ret;
2528 unsigned int index;
2529 unsigned int i;
2530
2531 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2532 for (i = 0; i < num_eps; i++) {
2533 index = dummy_get_ep_idx(&eps[i]->desc);
2534 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2535 ret = -EINVAL;
2536 goto out;
2537 }
2538 }
2539
2540 for (i = 0; i < num_eps; i++) {
2541 index = dummy_get_ep_idx(&eps[i]->desc);
2542 dum_hcd->stream_en_ep &= ~(1 << index);
2543 set_max_streams_for_pipe(dum_hcd,
2544 usb_endpoint_num(&eps[i]->desc), 0);
2545 }
2546 ret = 0;
2547 out:
2548 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2549 return ret;
2550 }
2551
2552 static struct hc_driver dummy_hcd = {
2553 .description = (char *) driver_name,
2554 .product_desc = "Dummy host controller",
2555 .hcd_priv_size = sizeof(struct dummy_hcd),
2556
2557 .flags = HCD_USB3 | HCD_SHARED,
2558
2559 .reset = dummy_setup,
2560 .start = dummy_start,
2561 .stop = dummy_stop,
2562
2563 .urb_enqueue = dummy_urb_enqueue,
2564 .urb_dequeue = dummy_urb_dequeue,
2565
2566 .get_frame_number = dummy_h_get_frame,
2567
2568 .hub_status_data = dummy_hub_status,
2569 .hub_control = dummy_hub_control,
2570 .bus_suspend = dummy_bus_suspend,
2571 .bus_resume = dummy_bus_resume,
2572
2573 .alloc_streams = dummy_alloc_streams,
2574 .free_streams = dummy_free_streams,
2575 };
2576
2577 static int dummy_hcd_probe(struct platform_device *pdev)
2578 {
2579 struct dummy *dum;
2580 struct usb_hcd *hs_hcd;
2581 struct usb_hcd *ss_hcd;
2582 int retval;
2583
2584 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2585 dum = *((void **)dev_get_platdata(&pdev->dev));
2586
2587 if (!mod_data.is_super_speed)
2588 dummy_hcd.flags = HCD_USB2;
2589 hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2590 if (!hs_hcd)
2591 return -ENOMEM;
2592 hs_hcd->has_tt = 1;
2593
2594 retval = usb_add_hcd(hs_hcd, 0, 0);
2595 if (retval)
2596 goto put_usb2_hcd;
2597
2598 if (mod_data.is_super_speed) {
2599 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2600 dev_name(&pdev->dev), hs_hcd);
2601 if (!ss_hcd) {
2602 retval = -ENOMEM;
2603 goto dealloc_usb2_hcd;
2604 }
2605
2606 retval = usb_add_hcd(ss_hcd, 0, 0);
2607 if (retval)
2608 goto put_usb3_hcd;
2609 }
2610 return 0;
2611
2612 put_usb3_hcd:
2613 usb_put_hcd(ss_hcd);
2614 dealloc_usb2_hcd:
2615 usb_remove_hcd(hs_hcd);
2616 put_usb2_hcd:
2617 usb_put_hcd(hs_hcd);
2618 dum->hs_hcd = dum->ss_hcd = NULL;
2619 return retval;
2620 }
2621
2622 static int dummy_hcd_remove(struct platform_device *pdev)
2623 {
2624 struct dummy *dum;
2625
2626 dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2627
2628 if (dum->ss_hcd) {
2629 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2630 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2631 }
2632
2633 usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2634 usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2635
2636 dum->hs_hcd = NULL;
2637 dum->ss_hcd = NULL;
2638
2639 return 0;
2640 }
2641
2642 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2643 {
2644 struct usb_hcd *hcd;
2645 struct dummy_hcd *dum_hcd;
2646 int rc = 0;
2647
2648 dev_dbg(&pdev->dev, "%s\n", __func__);
2649
2650 hcd = platform_get_drvdata(pdev);
2651 dum_hcd = hcd_to_dummy_hcd(hcd);
2652 if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2653 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2654 rc = -EBUSY;
2655 } else
2656 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2657 return rc;
2658 }
2659
2660 static int dummy_hcd_resume(struct platform_device *pdev)
2661 {
2662 struct usb_hcd *hcd;
2663
2664 dev_dbg(&pdev->dev, "%s\n", __func__);
2665
2666 hcd = platform_get_drvdata(pdev);
2667 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2668 usb_hcd_poll_rh_status(hcd);
2669 return 0;
2670 }
2671
2672 static struct platform_driver dummy_hcd_driver = {
2673 .probe = dummy_hcd_probe,
2674 .remove = dummy_hcd_remove,
2675 .suspend = dummy_hcd_suspend,
2676 .resume = dummy_hcd_resume,
2677 .driver = {
2678 .name = (char *) driver_name,
2679 },
2680 };
2681
2682 /*-------------------------------------------------------------------------*/
2683 #define MAX_NUM_UDC 2
2684 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2685 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2686
2687 static int __init init(void)
2688 {
2689 int retval = -ENOMEM;
2690 int i;
2691 struct dummy *dum[MAX_NUM_UDC];
2692
2693 if (usb_disabled())
2694 return -ENODEV;
2695
2696 if (!mod_data.is_high_speed && mod_data.is_super_speed)
2697 return -EINVAL;
2698
2699 if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2700 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2701 MAX_NUM_UDC);
2702 return -EINVAL;
2703 }
2704
2705 for (i = 0; i < mod_data.num; i++) {
2706 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2707 if (!the_hcd_pdev[i]) {
2708 i--;
2709 while (i >= 0)
2710 platform_device_put(the_hcd_pdev[i--]);
2711 return retval;
2712 }
2713 }
2714 for (i = 0; i < mod_data.num; i++) {
2715 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2716 if (!the_udc_pdev[i]) {
2717 i--;
2718 while (i >= 0)
2719 platform_device_put(the_udc_pdev[i--]);
2720 goto err_alloc_udc;
2721 }
2722 }
2723 for (i = 0; i < mod_data.num; i++) {
2724 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2725 if (!dum[i]) {
2726 retval = -ENOMEM;
2727 goto err_add_pdata;
2728 }
2729 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2730 sizeof(void *));
2731 if (retval)
2732 goto err_add_pdata;
2733 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2734 sizeof(void *));
2735 if (retval)
2736 goto err_add_pdata;
2737 }
2738
2739 retval = platform_driver_register(&dummy_hcd_driver);
2740 if (retval < 0)
2741 goto err_add_pdata;
2742 retval = platform_driver_register(&dummy_udc_driver);
2743 if (retval < 0)
2744 goto err_register_udc_driver;
2745
2746 for (i = 0; i < mod_data.num; i++) {
2747 retval = platform_device_add(the_hcd_pdev[i]);
2748 if (retval < 0) {
2749 i--;
2750 while (i >= 0)
2751 platform_device_del(the_hcd_pdev[i--]);
2752 goto err_add_hcd;
2753 }
2754 }
2755 for (i = 0; i < mod_data.num; i++) {
2756 if (!dum[i]->hs_hcd ||
2757 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2758 /*
2759 * The hcd was added successfully but its probe
2760 * function failed for some reason.
2761 */
2762 retval = -EINVAL;
2763 goto err_add_udc;
2764 }
2765 }
2766
2767 for (i = 0; i < mod_data.num; i++) {
2768 retval = platform_device_add(the_udc_pdev[i]);
2769 if (retval < 0) {
2770 i--;
2771 while (i >= 0)
2772 platform_device_del(the_udc_pdev[i]);
2773 goto err_add_udc;
2774 }
2775 }
2776
2777 for (i = 0; i < mod_data.num; i++) {
2778 if (!platform_get_drvdata(the_udc_pdev[i])) {
2779 /*
2780 * The udc was added successfully but its probe
2781 * function failed for some reason.
2782 */
2783 retval = -EINVAL;
2784 goto err_probe_udc;
2785 }
2786 }
2787 return retval;
2788
2789 err_probe_udc:
2790 for (i = 0; i < mod_data.num; i++)
2791 platform_device_del(the_udc_pdev[i]);
2792 err_add_udc:
2793 for (i = 0; i < mod_data.num; i++)
2794 platform_device_del(the_hcd_pdev[i]);
2795 err_add_hcd:
2796 platform_driver_unregister(&dummy_udc_driver);
2797 err_register_udc_driver:
2798 platform_driver_unregister(&dummy_hcd_driver);
2799 err_add_pdata:
2800 for (i = 0; i < mod_data.num; i++)
2801 kfree(dum[i]);
2802 for (i = 0; i < mod_data.num; i++)
2803 platform_device_put(the_udc_pdev[i]);
2804 err_alloc_udc:
2805 for (i = 0; i < mod_data.num; i++)
2806 platform_device_put(the_hcd_pdev[i]);
2807 return retval;
2808 }
2809 module_init(init);
2810
2811 static void __exit cleanup(void)
2812 {
2813 int i;
2814
2815 for (i = 0; i < mod_data.num; i++) {
2816 struct dummy *dum;
2817
2818 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2819
2820 platform_device_unregister(the_udc_pdev[i]);
2821 platform_device_unregister(the_hcd_pdev[i]);
2822 kfree(dum);
2823 }
2824 platform_driver_unregister(&dummy_udc_driver);
2825 platform_driver_unregister(&dummy_hcd_driver);
2826 }
2827 module_exit(cleanup);