2 * dummy_hcd.c -- Dummy/Loopback USB host and device emulator driver.
4 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
6 * Copyright (C) 2003 David Brownell
7 * Copyright (C) 2003-2005 Alan Stern
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.
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:
21 * - Gadget driver, responding to requests (slave);
22 * - Host-side device driver, as already familiar in Linux.
24 * Having this all in one kernel can help some stages of development,
25 * bypassing some hardware (and driver) issues. UML could help too.
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>
44 #include <asm/byteorder.h>
47 #include <asm/unaligned.h>
49 #define DRIVER_DESC "USB Host+Gadget Emulator"
50 #define DRIVER_VERSION "02 May 2005"
52 #define POWER_BUDGET 500 /* in mA; use 8 for low-power port testing */
54 static const char driver_name[] = "dummy_hcd";
55 static const char driver_desc[] = "USB Host+Gadget Emulator";
57 static const char gadget_name[] = "dummy_udc";
59 MODULE_DESCRIPTION(DRIVER_DESC);
60 MODULE_AUTHOR("David Brownell");
61 MODULE_LICENSE("GPL");
63 struct dummy_hcd_module_parameters {
69 static struct dummy_hcd_module_parameters mod_data = {
70 .is_super_speed = false,
71 .is_high_speed = true,
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 /*-------------------------------------------------------------------------*/
82 /* gadget side driver data structres */
84 struct list_head queue;
85 unsigned long last_io; /* jiffies timestamp */
86 struct usb_gadget *gadget;
87 const struct usb_endpoint_descriptor *desc;
91 unsigned already_seen:1;
92 unsigned setup_stage:1;
96 struct dummy_request {
97 struct list_head queue; /* ep's requests */
98 struct usb_request req;
101 static inline struct dummy_ep *usb_ep_to_dummy_ep(struct usb_ep *_ep)
103 return container_of(_ep, struct dummy_ep, ep);
106 static inline struct dummy_request *usb_request_to_dummy_request
107 (struct usb_request *_req)
109 return container_of(_req, struct dummy_request, req);
112 /*-------------------------------------------------------------------------*/
115 * Every device has ep0 for control requests, plus up to 30 more endpoints,
116 * in one of two types:
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.
121 * - Fixed Function: in other cases. some characteristics may be mutable;
122 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
124 * Gadget drivers are responsible for not setting up conflicting endpoint
125 * configurations, illegal or unsupported packet lengths, and so on.
128 static const char ep0name[] = "ep0";
130 static const struct {
132 const struct usb_ep_caps caps;
134 #define EP_INFO(_name, _caps) \
140 /* everyone has ep0 */
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)),
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)),
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)),
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 */
181 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
183 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
185 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
187 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
189 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
191 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
193 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
195 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
197 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
199 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
201 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
203 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
205 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
210 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_info)
212 /*-------------------------------------------------------------------------*/
218 struct list_head urbp_list;
219 struct sg_mapping_iter miter;
224 enum dummy_rh_state {
232 enum dummy_rh_state rh_state;
233 struct timer_list timer;
236 unsigned long re_timeout;
238 struct usb_device *udev;
239 struct list_head urbp_list;
241 u8 num_stream[30 / 2];
244 unsigned old_active:1;
252 * SLAVE/GADGET side support
254 struct dummy_ep ep[DUMMY_ENDPOINTS];
256 struct usb_gadget gadget;
257 struct usb_gadget_driver *driver;
258 struct dummy_request fifo_req;
259 u8 fifo_buf[FIFO_SIZE];
261 unsigned udc_suspended:1;
265 * MASTER/HOST side support
267 struct dummy_hcd *hs_hcd;
268 struct dummy_hcd *ss_hcd;
271 static inline struct dummy_hcd *hcd_to_dummy_hcd(struct usb_hcd *hcd)
273 return (struct dummy_hcd *) (hcd->hcd_priv);
276 static inline struct usb_hcd *dummy_hcd_to_hcd(struct dummy_hcd *dum)
278 return container_of((void *) dum, struct usb_hcd, hcd_priv);
281 static inline struct device *dummy_dev(struct dummy_hcd *dum)
283 return dummy_hcd_to_hcd(dum)->self.controller;
286 static inline struct device *udc_dev(struct dummy *dum)
288 return dum->gadget.dev.parent;
291 static inline struct dummy *ep_to_dummy(struct dummy_ep *ep)
293 return container_of(ep->gadget, struct dummy, gadget);
296 static inline struct dummy_hcd *gadget_to_dummy_hcd(struct usb_gadget *gadget)
298 struct dummy *dum = container_of(gadget, struct dummy, gadget);
299 if (dum->gadget.speed == USB_SPEED_SUPER)
305 static inline struct dummy *gadget_dev_to_dummy(struct device *dev)
307 return container_of(dev, struct dummy, gadget.dev);
310 /*-------------------------------------------------------------------------*/
312 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
314 /* called with spinlock held */
315 static void nuke(struct dummy *dum, struct dummy_ep *ep)
317 while (!list_empty(&ep->queue)) {
318 struct dummy_request *req;
320 req = list_entry(ep->queue.next, struct dummy_request, queue);
321 list_del_init(&req->queue);
322 req->req.status = -ESHUTDOWN;
324 spin_unlock(&dum->lock);
325 usb_gadget_giveback_request(&ep->ep, &req->req);
326 spin_lock(&dum->lock);
330 /* caller must hold lock */
331 static void stop_activity(struct dummy *dum)
335 /* prevent any more requests */
338 /* The timer is left running so that outstanding URBs can fail */
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]);
344 /* driver now does any non-usb quiescing necessary */
348 * set_link_state_by_speed() - Sets the current state of the link according to
350 * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
352 * This function updates the port_status according to the link state and the
355 static void set_link_state_by_speed(struct dummy_hcd *dum_hcd)
357 struct dummy *dum = dum_hcd->dum;
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);
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)
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);
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)
415 /* caller must hold lock */
416 static void set_link_state(struct dummy_hcd *dum_hcd)
418 struct dummy *dum = dum_hcd->dum;
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))
428 set_link_state_by_speed(dum_hcd);
430 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0 ||
432 dum_hcd->resuming = 0;
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;
442 /* Report reset and disconnect events to the driver */
443 if (dum->driver && (disconnect || reset)) {
445 spin_unlock(&dum->lock);
447 usb_gadget_udc_reset(&dum->gadget, dum->driver);
449 dum->driver->disconnect(&dum->gadget);
450 spin_lock(&dum->lock);
452 } else if (dum_hcd->active != dum_hcd->old_active) {
453 if (dum_hcd->old_active && dum->driver->suspend) {
454 spin_unlock(&dum->lock);
455 dum->driver->suspend(&dum->gadget);
456 spin_lock(&dum->lock);
457 } else if (!dum_hcd->old_active && dum->driver->resume) {
458 spin_unlock(&dum->lock);
459 dum->driver->resume(&dum->gadget);
460 spin_lock(&dum->lock);
464 dum_hcd->old_status = dum_hcd->port_status;
465 dum_hcd->old_active = dum_hcd->active;
468 /*-------------------------------------------------------------------------*/
470 /* SLAVE/GADGET SIDE DRIVER
472 * This only tracks gadget state. All the work is done when the host
473 * side tries some (emulated) i/o operation. Real device controller
474 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
477 #define is_enabled(dum) \
478 (dum->port_status & USB_PORT_STAT_ENABLE)
480 static int dummy_enable(struct usb_ep *_ep,
481 const struct usb_endpoint_descriptor *desc)
484 struct dummy_hcd *dum_hcd;
489 ep = usb_ep_to_dummy_ep(_ep);
490 if (!_ep || !desc || ep->desc || _ep->name == ep0name
491 || desc->bDescriptorType != USB_DT_ENDPOINT)
493 dum = ep_to_dummy(ep);
497 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
498 if (!is_enabled(dum_hcd))
502 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
503 * maximum packet size.
504 * For SS devices the wMaxPacketSize is limited by 1024.
506 max = usb_endpoint_maxp(desc);
508 /* drivers must not request bad settings, since lower levels
509 * (hardware or its drivers) may not check. some endpoints
510 * can't do iso, many have maxpacket limitations, etc.
512 * since this "hardware" driver is here to help debugging, we
513 * have some extra sanity checks. (there could be more though,
514 * especially for "ep9out" style fixed function ones.)
517 switch (usb_endpoint_type(desc)) {
518 case USB_ENDPOINT_XFER_BULK:
519 if (strstr(ep->ep.name, "-iso")
520 || strstr(ep->ep.name, "-int")) {
523 switch (dum->gadget.speed) {
524 case USB_SPEED_SUPER:
533 if (max == 8 || max == 16 || max == 32 || max == 64)
534 /* we'll fake any legal size */
536 /* save a return statement */
541 case USB_ENDPOINT_XFER_INT:
542 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
544 /* real hardware might not handle all packet sizes */
545 switch (dum->gadget.speed) {
546 case USB_SPEED_SUPER:
550 /* save a return statement */
554 /* save a return statement */
561 case USB_ENDPOINT_XFER_ISOC:
562 if (strstr(ep->ep.name, "-bulk")
563 || strstr(ep->ep.name, "-int"))
565 /* real hardware might not handle all packet sizes */
566 switch (dum->gadget.speed) {
567 case USB_SPEED_SUPER:
571 /* save a return statement */
575 /* save a return statement */
581 /* few chips support control except on ep0 */
585 _ep->maxpacket = max;
586 if (usb_ss_max_streams(_ep->comp_desc)) {
587 if (!usb_endpoint_xfer_bulk(desc)) {
588 dev_err(udc_dev(dum), "Can't enable stream support on "
589 "non-bulk ep %s\n", _ep->name);
596 dev_dbg(udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
598 desc->bEndpointAddress & 0x0f,
599 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
601 switch (usb_endpoint_type(desc)) {
602 case USB_ENDPOINT_XFER_BULK:
605 case USB_ENDPOINT_XFER_ISOC:
608 case USB_ENDPOINT_XFER_INT:
615 max, ep->stream_en ? "enabled" : "disabled");
617 /* at this point real hardware should be NAKing transfers
618 * to that endpoint, until a buffer is queued to it.
620 ep->halted = ep->wedged = 0;
626 static int dummy_disable(struct usb_ep *_ep)
632 ep = usb_ep_to_dummy_ep(_ep);
633 if (!_ep || !ep->desc || _ep->name == ep0name)
635 dum = ep_to_dummy(ep);
637 spin_lock_irqsave(&dum->lock, flags);
641 spin_unlock_irqrestore(&dum->lock, flags);
643 dev_dbg(udc_dev(dum), "disabled %s\n", _ep->name);
647 static struct usb_request *dummy_alloc_request(struct usb_ep *_ep,
650 struct dummy_request *req;
655 req = kzalloc(sizeof(*req), mem_flags);
658 INIT_LIST_HEAD(&req->queue);
662 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
664 struct dummy_request *req;
671 req = usb_request_to_dummy_request(_req);
672 WARN_ON(!list_empty(&req->queue));
676 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
680 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
684 struct dummy_request *req;
686 struct dummy_hcd *dum_hcd;
689 req = usb_request_to_dummy_request(_req);
690 if (!_req || !list_empty(&req->queue) || !_req->complete)
693 ep = usb_ep_to_dummy_ep(_ep);
694 if (!_ep || (!ep->desc && _ep->name != ep0name))
697 dum = ep_to_dummy(ep);
698 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
699 if (!dum->driver || !is_enabled(dum_hcd))
703 dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
704 ep, _req, _ep->name, _req->length, _req->buf);
706 _req->status = -EINPROGRESS;
708 spin_lock_irqsave(&dum->lock, flags);
710 /* implement an emulated single-request FIFO */
711 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
712 list_empty(&dum->fifo_req.queue) &&
713 list_empty(&ep->queue) &&
714 _req->length <= FIFO_SIZE) {
715 req = &dum->fifo_req;
717 req->req.buf = dum->fifo_buf;
718 memcpy(dum->fifo_buf, _req->buf, _req->length);
719 req->req.context = dum;
720 req->req.complete = fifo_complete;
722 list_add_tail(&req->queue, &ep->queue);
723 spin_unlock(&dum->lock);
724 _req->actual = _req->length;
726 usb_gadget_giveback_request(_ep, _req);
727 spin_lock(&dum->lock);
729 list_add_tail(&req->queue, &ep->queue);
730 spin_unlock_irqrestore(&dum->lock, flags);
732 /* real hardware would likely enable transfers here, in case
733 * it'd been left NAKing.
738 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
742 int retval = -EINVAL;
744 struct dummy_request *req = NULL;
748 ep = usb_ep_to_dummy_ep(_ep);
749 dum = ep_to_dummy(ep);
754 local_irq_save(flags);
755 spin_lock(&dum->lock);
756 list_for_each_entry(req, &ep->queue, queue) {
757 if (&req->req == _req) {
758 list_del_init(&req->queue);
759 _req->status = -ECONNRESET;
764 spin_unlock(&dum->lock);
767 dev_dbg(udc_dev(dum),
768 "dequeued req %p from %s, len %d buf %p\n",
769 req, _ep->name, _req->length, _req->buf);
770 usb_gadget_giveback_request(_ep, _req);
772 local_irq_restore(flags);
777 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
784 ep = usb_ep_to_dummy_ep(_ep);
785 dum = ep_to_dummy(ep);
789 ep->halted = ep->wedged = 0;
790 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
791 !list_empty(&ep->queue))
798 /* FIXME clear emulated data toggle too */
803 dummy_set_halt(struct usb_ep *_ep, int value)
805 return dummy_set_halt_and_wedge(_ep, value, 0);
808 static int dummy_set_wedge(struct usb_ep *_ep)
810 if (!_ep || _ep->name == ep0name)
812 return dummy_set_halt_and_wedge(_ep, 1, 1);
815 static const struct usb_ep_ops dummy_ep_ops = {
816 .enable = dummy_enable,
817 .disable = dummy_disable,
819 .alloc_request = dummy_alloc_request,
820 .free_request = dummy_free_request,
822 .queue = dummy_queue,
823 .dequeue = dummy_dequeue,
825 .set_halt = dummy_set_halt,
826 .set_wedge = dummy_set_wedge,
829 /*-------------------------------------------------------------------------*/
831 /* there are both host and device side versions of this call ... */
832 static int dummy_g_get_frame(struct usb_gadget *_gadget)
834 struct timespec64 ts64;
836 ktime_get_ts64(&ts64);
837 return ts64.tv_nsec / NSEC_PER_MSEC;
840 static int dummy_wakeup(struct usb_gadget *_gadget)
842 struct dummy_hcd *dum_hcd;
844 dum_hcd = gadget_to_dummy_hcd(_gadget);
845 if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
846 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
848 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
850 if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
851 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
854 /* FIXME: What if the root hub is suspended but the port isn't? */
856 /* hub notices our request, issues downstream resume, etc */
857 dum_hcd->resuming = 1;
858 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
859 mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
863 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
867 _gadget->is_selfpowered = (value != 0);
868 dum = gadget_to_dummy_hcd(_gadget)->dum;
870 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
872 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
876 static void dummy_udc_update_ep0(struct dummy *dum)
878 if (dum->gadget.speed == USB_SPEED_SUPER)
879 dum->ep[0].ep.maxpacket = 9;
881 dum->ep[0].ep.maxpacket = 64;
884 static int dummy_pullup(struct usb_gadget *_gadget, int value)
886 struct dummy_hcd *dum_hcd;
890 dum = gadget_dev_to_dummy(&_gadget->dev);
892 if (value && dum->driver) {
893 if (mod_data.is_super_speed)
894 dum->gadget.speed = dum->driver->max_speed;
895 else if (mod_data.is_high_speed)
896 dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
897 dum->driver->max_speed);
899 dum->gadget.speed = USB_SPEED_FULL;
900 dummy_udc_update_ep0(dum);
902 if (dum->gadget.speed < dum->driver->max_speed)
903 dev_dbg(udc_dev(dum), "This device can perform faster"
904 " if you connect it to a %s port...\n",
905 usb_speed_string(dum->driver->max_speed));
907 dum_hcd = gadget_to_dummy_hcd(_gadget);
909 spin_lock_irqsave(&dum->lock, flags);
910 dum->pullup = (value != 0);
911 set_link_state(dum_hcd);
912 spin_unlock_irqrestore(&dum->lock, flags);
914 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
918 static int dummy_udc_start(struct usb_gadget *g,
919 struct usb_gadget_driver *driver);
920 static int dummy_udc_stop(struct usb_gadget *g);
922 static const struct usb_gadget_ops dummy_ops = {
923 .get_frame = dummy_g_get_frame,
924 .wakeup = dummy_wakeup,
925 .set_selfpowered = dummy_set_selfpowered,
926 .pullup = dummy_pullup,
927 .udc_start = dummy_udc_start,
928 .udc_stop = dummy_udc_stop,
931 /*-------------------------------------------------------------------------*/
933 /* "function" sysfs attribute */
934 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
937 struct dummy *dum = gadget_dev_to_dummy(dev);
939 if (!dum->driver || !dum->driver->function)
941 return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
943 static DEVICE_ATTR_RO(function);
945 /*-------------------------------------------------------------------------*/
948 * Driver registration/unregistration.
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.
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.
961 static int dummy_udc_start(struct usb_gadget *g,
962 struct usb_gadget_driver *driver)
964 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
965 struct dummy *dum = dum_hcd->dum;
967 if (driver->max_speed == USB_SPEED_UNKNOWN)
971 * SLAVE side init ... the layer above hardware, which
972 * can't enumerate without help from the driver we're binding.
976 dum->driver = driver;
981 static int dummy_udc_stop(struct usb_gadget *g)
983 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
984 struct dummy *dum = dum_hcd->dum;
993 /* The gadget structure is stored inside the hcd structure and will be
994 * released along with it. */
995 static void init_dummy_udc_hw(struct dummy *dum)
999 INIT_LIST_HEAD(&dum->gadget.ep_list);
1000 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1001 struct dummy_ep *ep = &dum->ep[i];
1003 if (!ep_info[i].name)
1005 ep->ep.name = ep_info[i].name;
1006 ep->ep.caps = ep_info[i].caps;
1007 ep->ep.ops = &dummy_ep_ops;
1008 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1009 ep->halted = ep->wedged = ep->already_seen =
1010 ep->setup_stage = 0;
1011 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1012 ep->ep.max_streams = 16;
1013 ep->last_io = jiffies;
1014 ep->gadget = &dum->gadget;
1016 INIT_LIST_HEAD(&ep->queue);
1019 dum->gadget.ep0 = &dum->ep[0].ep;
1020 list_del_init(&dum->ep[0].ep.ep_list);
1021 INIT_LIST_HEAD(&dum->fifo_req.queue);
1023 #ifdef CONFIG_USB_OTG
1024 dum->gadget.is_otg = 1;
1028 static int dummy_udc_probe(struct platform_device *pdev)
1033 dum = *((void **)dev_get_platdata(&pdev->dev));
1034 /* Clear usb_gadget region for new registration to udc-core */
1035 memzero_explicit(&dum->gadget, sizeof(struct usb_gadget));
1036 dum->gadget.name = gadget_name;
1037 dum->gadget.ops = &dummy_ops;
1038 dum->gadget.max_speed = USB_SPEED_SUPER;
1040 dum->gadget.dev.parent = &pdev->dev;
1041 init_dummy_udc_hw(dum);
1043 rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1047 rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1050 platform_set_drvdata(pdev, dum);
1054 usb_del_gadget_udc(&dum->gadget);
1059 static int dummy_udc_remove(struct platform_device *pdev)
1061 struct dummy *dum = platform_get_drvdata(pdev);
1063 device_remove_file(&dum->gadget.dev, &dev_attr_function);
1064 usb_del_gadget_udc(&dum->gadget);
1068 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1071 spin_lock_irq(&dum->lock);
1072 dum->udc_suspended = suspend;
1073 set_link_state(dum_hcd);
1074 spin_unlock_irq(&dum->lock);
1077 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1079 struct dummy *dum = platform_get_drvdata(pdev);
1080 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1082 dev_dbg(&pdev->dev, "%s\n", __func__);
1083 dummy_udc_pm(dum, dum_hcd, 1);
1084 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1088 static int dummy_udc_resume(struct platform_device *pdev)
1090 struct dummy *dum = platform_get_drvdata(pdev);
1091 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1093 dev_dbg(&pdev->dev, "%s\n", __func__);
1094 dummy_udc_pm(dum, dum_hcd, 0);
1095 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1099 static struct platform_driver dummy_udc_driver = {
1100 .probe = dummy_udc_probe,
1101 .remove = dummy_udc_remove,
1102 .suspend = dummy_udc_suspend,
1103 .resume = dummy_udc_resume,
1105 .name = (char *) gadget_name,
1109 /*-------------------------------------------------------------------------*/
1111 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1115 index = usb_endpoint_num(desc) << 1;
1116 if (usb_endpoint_dir_in(desc))
1121 /* MASTER/HOST SIDE DRIVER
1123 * this uses the hcd framework to hook up to host side drivers.
1124 * its root hub will only have one device, otherwise it acts like
1125 * a normal host controller.
1127 * when urbs are queued, they're just stuck on a list that we
1128 * scan in a timer callback. that callback connects writes from
1129 * the host with reads from the device, and so on, based on the
1133 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1135 const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1138 if (!usb_endpoint_xfer_bulk(desc))
1141 index = dummy_get_ep_idx(desc);
1142 return (1 << index) & dum_hcd->stream_en_ep;
1146 * The max stream number is saved as a nibble so for the 30 possible endpoints
1147 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1148 * means we use only 1 stream). The maximum according to the spec is 16bit so
1149 * if the 16 stream limit is about to go, the array size should be incremented
1150 * to 30 elements of type u16.
1152 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1157 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1158 if (usb_pipeout(pipe))
1166 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1167 unsigned int pipe, unsigned int streams)
1172 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1173 if (usb_pipeout(pipe)) {
1177 max_streams &= 0xf0;
1179 max_streams |= streams;
1180 dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1183 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1185 unsigned int max_streams;
1188 enabled = dummy_ep_stream_en(dum_hcd, urb);
1189 if (!urb->stream_id) {
1197 max_streams = get_max_streams_for_pipe(dum_hcd,
1198 usb_pipeendpoint(urb->pipe));
1199 if (urb->stream_id > max_streams) {
1200 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1208 static int dummy_urb_enqueue(
1209 struct usb_hcd *hcd,
1213 struct dummy_hcd *dum_hcd;
1215 unsigned long flags;
1218 urbp = kmalloc(sizeof *urbp, mem_flags);
1222 urbp->miter_started = 0;
1224 dum_hcd = hcd_to_dummy_hcd(hcd);
1225 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1227 rc = dummy_validate_stream(dum_hcd, urb);
1233 rc = usb_hcd_link_urb_to_ep(hcd, urb);
1239 if (!dum_hcd->udev) {
1240 dum_hcd->udev = urb->dev;
1241 usb_get_dev(dum_hcd->udev);
1242 } else if (unlikely(dum_hcd->udev != urb->dev))
1243 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1245 list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1247 if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1248 urb->error_count = 1; /* mark as a new urb */
1250 /* kick the scheduler, it'll do the rest */
1251 if (!timer_pending(&dum_hcd->timer))
1252 mod_timer(&dum_hcd->timer, jiffies + 1);
1255 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1259 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1261 struct dummy_hcd *dum_hcd;
1262 unsigned long flags;
1265 /* giveback happens automatically in timer callback,
1266 * so make sure the callback happens */
1267 dum_hcd = hcd_to_dummy_hcd(hcd);
1268 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1270 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1271 if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1272 !list_empty(&dum_hcd->urbp_list))
1273 mod_timer(&dum_hcd->timer, jiffies);
1275 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1279 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1283 struct urbp *urbp = urb->hcpriv;
1285 struct sg_mapping_iter *miter = &urbp->miter;
1290 to_host = usb_pipein(urb->pipe);
1291 rbuf = req->req.buf + req->req.actual;
1293 if (!urb->num_sgs) {
1294 ubuf = urb->transfer_buffer + urb->actual_length;
1296 memcpy(ubuf, rbuf, len);
1298 memcpy(rbuf, ubuf, len);
1302 if (!urbp->miter_started) {
1303 u32 flags = SG_MITER_ATOMIC;
1306 flags |= SG_MITER_TO_SG;
1308 flags |= SG_MITER_FROM_SG;
1310 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1311 urbp->miter_started = 1;
1313 next_sg = sg_miter_next(miter);
1314 if (next_sg == false) {
1320 this_sg = min_t(u32, len, miter->length);
1321 miter->consumed = this_sg;
1325 memcpy(ubuf, rbuf, this_sg);
1327 memcpy(rbuf, ubuf, this_sg);
1332 next_sg = sg_miter_next(miter);
1333 if (next_sg == false) {
1341 sg_miter_stop(miter);
1345 /* transfer up to a frame's worth; caller must own lock */
1346 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1347 struct dummy_ep *ep, int limit, int *status)
1349 struct dummy *dum = dum_hcd->dum;
1350 struct dummy_request *req;
1354 /* if there's no request queued, the device is NAKing; return */
1355 list_for_each_entry(req, &ep->queue, queue) {
1356 unsigned host_len, dev_len, len;
1357 int is_short, to_host;
1360 if (dummy_ep_stream_en(dum_hcd, urb)) {
1361 if ((urb->stream_id != req->req.stream_id))
1365 /* 1..N packets of ep->ep.maxpacket each ... the last one
1366 * may be short (including zero length).
1368 * writer can send a zlp explicitly (length 0) or implicitly
1369 * (length mod maxpacket zero, and 'zero' flag); they always
1372 host_len = urb->transfer_buffer_length - urb->actual_length;
1373 dev_len = req->req.length - req->req.actual;
1374 len = min(host_len, dev_len);
1376 /* FIXME update emulated data toggle too */
1378 to_host = usb_pipein(urb->pipe);
1379 if (unlikely(len == 0))
1382 /* not enough bandwidth left? */
1383 if (limit < ep->ep.maxpacket && limit < len)
1385 len = min_t(unsigned, len, limit);
1389 /* send multiple of maxpacket first, then remainder */
1390 if (len >= ep->ep.maxpacket) {
1392 if (len % ep->ep.maxpacket)
1394 len -= len % ep->ep.maxpacket;
1399 len = dummy_perform_transfer(urb, req, len);
1401 ep->last_io = jiffies;
1403 req->req.status = len;
1407 urb->actual_length += len;
1408 req->req.actual += len;
1412 /* short packets terminate, maybe with overflow/underflow.
1413 * it's only really an error to write too much.
1415 * partially filling a buffer optionally blocks queue advances
1416 * (so completion handlers can clean up the queue) but we don't
1417 * need to emulate such data-in-flight.
1420 if (host_len == dev_len) {
1421 req->req.status = 0;
1423 } else if (to_host) {
1424 req->req.status = 0;
1425 if (dev_len > host_len)
1426 *status = -EOVERFLOW;
1431 if (host_len > dev_len)
1432 req->req.status = -EOVERFLOW;
1434 req->req.status = 0;
1438 * many requests terminate without a short packet.
1439 * send a zlp if demanded by flags.
1442 if (req->req.length == req->req.actual) {
1443 if (req->req.zero && to_host)
1446 req->req.status = 0;
1448 if (urb->transfer_buffer_length == urb->actual_length) {
1449 if (urb->transfer_flags & URB_ZERO_PACKET &&
1457 /* device side completion --> continuable */
1458 if (req->req.status != -EINPROGRESS) {
1459 list_del_init(&req->queue);
1461 spin_unlock(&dum->lock);
1462 usb_gadget_giveback_request(&ep->ep, &req->req);
1463 spin_lock(&dum->lock);
1465 /* requests might have been unlinked... */
1469 /* host side completion --> terminate */
1470 if (*status != -EINPROGRESS)
1473 /* rescan to continue with any other queued i/o */
1480 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1482 int limit = ep->ep.maxpacket;
1484 if (dum->gadget.speed == USB_SPEED_HIGH) {
1487 /* high bandwidth mode */
1488 tmp = usb_endpoint_maxp_mult(ep->desc);
1489 tmp *= 8 /* applies to entire frame */;
1490 limit += limit * tmp;
1492 if (dum->gadget.speed == USB_SPEED_SUPER) {
1493 switch (usb_endpoint_type(ep->desc)) {
1494 case USB_ENDPOINT_XFER_ISOC:
1495 /* Sec. 4.4.8.2 USB3.0 Spec */
1496 limit = 3 * 16 * 1024 * 8;
1498 case USB_ENDPOINT_XFER_INT:
1499 /* Sec. 4.4.7.2 USB3.0 Spec */
1500 limit = 3 * 1024 * 8;
1502 case USB_ENDPOINT_XFER_BULK:
1510 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1511 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1512 USB_PORT_STAT_SUSPEND)) \
1513 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1515 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1519 if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1520 dum->ss_hcd : dum->hs_hcd)))
1522 if ((address & ~USB_DIR_IN) == 0)
1524 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1525 struct dummy_ep *ep = &dum->ep[i];
1529 if (ep->desc->bEndpointAddress == address)
1537 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1538 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1539 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1540 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1541 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1542 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1546 * handle_control_request() - handles all control transfers
1547 * @dum: pointer to dummy (the_controller)
1548 * @urb: the urb request to handle
1549 * @setup: pointer to the setup data for a USB device control
1551 * @status: pointer to request handling status
1553 * Return 0 - if the request was handled
1554 * 1 - if the request wasn't handles
1555 * error code on error
1557 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1558 struct usb_ctrlrequest *setup,
1561 struct dummy_ep *ep2;
1562 struct dummy *dum = dum_hcd->dum;
1567 w_index = le16_to_cpu(setup->wIndex);
1568 w_value = le16_to_cpu(setup->wValue);
1569 switch (setup->bRequest) {
1570 case USB_REQ_SET_ADDRESS:
1571 if (setup->bRequestType != Dev_Request)
1573 dum->address = w_value;
1575 dev_dbg(udc_dev(dum), "set_address = %d\n",
1579 case USB_REQ_SET_FEATURE:
1580 if (setup->bRequestType == Dev_Request) {
1583 case USB_DEVICE_REMOTE_WAKEUP:
1585 case USB_DEVICE_B_HNP_ENABLE:
1586 dum->gadget.b_hnp_enable = 1;
1588 case USB_DEVICE_A_HNP_SUPPORT:
1589 dum->gadget.a_hnp_support = 1;
1591 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1592 dum->gadget.a_alt_hnp_support = 1;
1594 case USB_DEVICE_U1_ENABLE:
1595 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1597 w_value = USB_DEV_STAT_U1_ENABLED;
1599 ret_val = -EOPNOTSUPP;
1601 case USB_DEVICE_U2_ENABLE:
1602 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1604 w_value = USB_DEV_STAT_U2_ENABLED;
1606 ret_val = -EOPNOTSUPP;
1608 case USB_DEVICE_LTM_ENABLE:
1609 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1611 w_value = USB_DEV_STAT_LTM_ENABLED;
1613 ret_val = -EOPNOTSUPP;
1616 ret_val = -EOPNOTSUPP;
1619 dum->devstatus |= (1 << w_value);
1622 } else if (setup->bRequestType == Ep_Request) {
1624 ep2 = find_endpoint(dum, w_index);
1625 if (!ep2 || ep2->ep.name == ep0name) {
1626 ret_val = -EOPNOTSUPP;
1634 case USB_REQ_CLEAR_FEATURE:
1635 if (setup->bRequestType == Dev_Request) {
1638 case USB_DEVICE_REMOTE_WAKEUP:
1639 w_value = USB_DEVICE_REMOTE_WAKEUP;
1641 case USB_DEVICE_U1_ENABLE:
1642 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1644 w_value = USB_DEV_STAT_U1_ENABLED;
1646 ret_val = -EOPNOTSUPP;
1648 case USB_DEVICE_U2_ENABLE:
1649 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1651 w_value = USB_DEV_STAT_U2_ENABLED;
1653 ret_val = -EOPNOTSUPP;
1655 case USB_DEVICE_LTM_ENABLE:
1656 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1658 w_value = USB_DEV_STAT_LTM_ENABLED;
1660 ret_val = -EOPNOTSUPP;
1663 ret_val = -EOPNOTSUPP;
1667 dum->devstatus &= ~(1 << w_value);
1670 } else if (setup->bRequestType == Ep_Request) {
1672 ep2 = find_endpoint(dum, w_index);
1674 ret_val = -EOPNOTSUPP;
1683 case USB_REQ_GET_STATUS:
1684 if (setup->bRequestType == Dev_InRequest
1685 || setup->bRequestType == Intf_InRequest
1686 || setup->bRequestType == Ep_InRequest) {
1689 * device: remote wakeup, selfpowered
1690 * interface: nothing
1693 buf = (char *)urb->transfer_buffer;
1694 if (urb->transfer_buffer_length > 0) {
1695 if (setup->bRequestType == Ep_InRequest) {
1696 ep2 = find_endpoint(dum, w_index);
1698 ret_val = -EOPNOTSUPP;
1701 buf[0] = ep2->halted;
1702 } else if (setup->bRequestType ==
1704 buf[0] = (u8)dum->devstatus;
1708 if (urb->transfer_buffer_length > 1)
1710 urb->actual_length = min_t(u32, 2,
1711 urb->transfer_buffer_length);
1720 /* drive both sides of the transfers; looks like irq handlers to
1721 * both drivers except the callbacks aren't in_irq().
1723 static void dummy_timer(unsigned long _dum_hcd)
1725 struct dummy_hcd *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1726 struct dummy *dum = dum_hcd->dum;
1727 struct urbp *urbp, *tmp;
1728 unsigned long flags;
1732 /* simplistic model for one frame's bandwidth */
1733 switch (dum->gadget.speed) {
1735 total = 8/*bytes*/ * 12/*packets*/;
1737 case USB_SPEED_FULL:
1738 total = 64/*bytes*/ * 19/*packets*/;
1740 case USB_SPEED_HIGH:
1741 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1743 case USB_SPEED_SUPER:
1744 /* Bus speed is 500000 bytes/ms, so use a little less */
1748 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1752 /* FIXME if HZ != 1000 this will probably misbehave ... */
1754 /* look at each urb queued by the host side driver */
1755 spin_lock_irqsave(&dum->lock, flags);
1757 if (!dum_hcd->udev) {
1758 dev_err(dummy_dev(dum_hcd),
1759 "timer fired with no URBs pending?\n");
1760 spin_unlock_irqrestore(&dum->lock, flags);
1764 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1765 if (!ep_info[i].name)
1767 dum->ep[i].already_seen = 0;
1771 list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1773 struct dummy_request *req;
1775 struct dummy_ep *ep = NULL;
1777 int status = -EINPROGRESS;
1782 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1784 type = usb_pipetype(urb->pipe);
1786 /* used up this frame's non-periodic bandwidth?
1787 * FIXME there's infinite bandwidth for control and
1788 * periodic transfers ... unrealistic.
1790 if (total <= 0 && type == PIPE_BULK)
1793 /* find the gadget's ep for this request (if configured) */
1794 address = usb_pipeendpoint (urb->pipe);
1795 if (usb_pipein(urb->pipe))
1796 address |= USB_DIR_IN;
1797 ep = find_endpoint(dum, address);
1799 /* set_configuration() disagreement */
1800 dev_dbg(dummy_dev(dum_hcd),
1801 "no ep configured for urb %p\n",
1807 if (ep->already_seen)
1809 ep->already_seen = 1;
1810 if (ep == &dum->ep[0] && urb->error_count) {
1811 ep->setup_stage = 1; /* a new urb */
1812 urb->error_count = 0;
1814 if (ep->halted && !ep->setup_stage) {
1815 /* NOTE: must not be iso! */
1816 dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1821 /* FIXME make sure both ends agree on maxpacket */
1823 /* handle control requests */
1824 if (ep == &dum->ep[0] && ep->setup_stage) {
1825 struct usb_ctrlrequest setup;
1828 setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1829 /* paranoia, in case of stale queued data */
1830 list_for_each_entry(req, &ep->queue, queue) {
1831 list_del_init(&req->queue);
1832 req->req.status = -EOVERFLOW;
1833 dev_dbg(udc_dev(dum), "stale req = %p\n",
1836 spin_unlock(&dum->lock);
1837 usb_gadget_giveback_request(&ep->ep, &req->req);
1838 spin_lock(&dum->lock);
1839 ep->already_seen = 0;
1843 /* gadget driver never sees set_address or operations
1844 * on standard feature flags. some hardware doesn't
1847 ep->last_io = jiffies;
1848 ep->setup_stage = 0;
1851 value = handle_control_request(dum_hcd, urb, &setup,
1854 /* gadget driver handles all other requests. block
1855 * until setup() returns; no reentrancy issues etc.
1858 spin_unlock(&dum->lock);
1859 value = dum->driver->setup(&dum->gadget,
1861 spin_lock(&dum->lock);
1864 /* no delays (max 64KB data stage) */
1866 goto treat_control_like_bulk;
1868 /* error, see below */
1872 if (value != -EOPNOTSUPP)
1873 dev_dbg(udc_dev(dum),
1877 urb->actual_length = 0;
1883 /* non-control requests */
1885 switch (usb_pipetype(urb->pipe)) {
1886 case PIPE_ISOCHRONOUS:
1887 /* FIXME is it urb->interval since the last xfer?
1888 * use urb->iso_frame_desc[i].
1889 * complete whether or not ep has requests queued.
1890 * report random errors, to debug drivers.
1892 limit = max(limit, periodic_bytes(dum, ep));
1896 case PIPE_INTERRUPT:
1897 /* FIXME is it urb->interval since the last xfer?
1898 * this almost certainly polls too fast.
1900 limit = max(limit, periodic_bytes(dum, ep));
1904 treat_control_like_bulk:
1905 ep->last_io = jiffies;
1906 total -= transfer(dum_hcd, urb, ep, limit, &status);
1910 /* incomplete transfer? */
1911 if (status == -EINPROGRESS)
1915 list_del(&urbp->urbp_list);
1918 ep->already_seen = ep->setup_stage = 0;
1920 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1921 spin_unlock(&dum->lock);
1922 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1923 spin_lock(&dum->lock);
1928 if (list_empty(&dum_hcd->urbp_list)) {
1929 usb_put_dev(dum_hcd->udev);
1930 dum_hcd->udev = NULL;
1931 } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1932 /* want a 1 msec delay here */
1933 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1936 spin_unlock_irqrestore(&dum->lock, flags);
1939 /*-------------------------------------------------------------------------*/
1941 #define PORT_C_MASK \
1942 ((USB_PORT_STAT_C_CONNECTION \
1943 | USB_PORT_STAT_C_ENABLE \
1944 | USB_PORT_STAT_C_SUSPEND \
1945 | USB_PORT_STAT_C_OVERCURRENT \
1946 | USB_PORT_STAT_C_RESET) << 16)
1948 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1950 struct dummy_hcd *dum_hcd;
1951 unsigned long flags;
1954 dum_hcd = hcd_to_dummy_hcd(hcd);
1956 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1957 if (!HCD_HW_ACCESSIBLE(hcd))
1960 if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
1961 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1962 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
1963 set_link_state(dum_hcd);
1966 if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
1968 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
1969 dum_hcd->port_status);
1971 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
1972 usb_hcd_resume_root_hub(hcd);
1975 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1979 /* usb 3.0 root hub device descriptor */
1981 struct usb_bos_descriptor bos;
1982 struct usb_ss_cap_descriptor ss_cap;
1983 } __packed usb3_bos_desc = {
1986 .bLength = USB_DT_BOS_SIZE,
1987 .bDescriptorType = USB_DT_BOS,
1988 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
1989 .bNumDeviceCaps = 1,
1992 .bLength = USB_DT_USB_SS_CAP_SIZE,
1993 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
1994 .bDevCapabilityType = USB_SS_CAP_TYPE,
1995 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
1996 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
2001 ss_hub_descriptor(struct usb_hub_descriptor *desc)
2003 memset(desc, 0, sizeof *desc);
2004 desc->bDescriptorType = USB_DT_SS_HUB;
2005 desc->bDescLength = 12;
2006 desc->wHubCharacteristics = cpu_to_le16(
2007 HUB_CHAR_INDV_PORT_LPSM |
2008 HUB_CHAR_COMMON_OCPM);
2009 desc->bNbrPorts = 1;
2010 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2011 desc->u.ss.DeviceRemovable = 0xffff;
2014 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2016 memset(desc, 0, sizeof *desc);
2017 desc->bDescriptorType = USB_DT_HUB;
2018 desc->bDescLength = 9;
2019 desc->wHubCharacteristics = cpu_to_le16(
2020 HUB_CHAR_INDV_PORT_LPSM |
2021 HUB_CHAR_COMMON_OCPM);
2022 desc->bNbrPorts = 1;
2023 desc->u.hs.DeviceRemovable[0] = 0xff;
2024 desc->u.hs.DeviceRemovable[1] = 0xff;
2027 static int dummy_hub_control(
2028 struct usb_hcd *hcd,
2035 struct dummy_hcd *dum_hcd;
2037 unsigned long flags;
2039 if (!HCD_HW_ACCESSIBLE(hcd))
2042 dum_hcd = hcd_to_dummy_hcd(hcd);
2044 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2046 case ClearHubFeature:
2048 case ClearPortFeature:
2050 case USB_PORT_FEAT_SUSPEND:
2051 if (hcd->speed == HCD_USB3) {
2052 dev_dbg(dummy_dev(dum_hcd),
2053 "USB_PORT_FEAT_SUSPEND req not "
2054 "supported for USB 3.0 roothub\n");
2057 if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2058 /* 20msec resume signaling */
2059 dum_hcd->resuming = 1;
2060 dum_hcd->re_timeout = jiffies +
2061 msecs_to_jiffies(20);
2064 case USB_PORT_FEAT_POWER:
2065 dev_dbg(dummy_dev(dum_hcd), "power-off\n");
2066 if (hcd->speed == HCD_USB3)
2067 dum_hcd->port_status &= ~USB_SS_PORT_STAT_POWER;
2069 dum_hcd->port_status &= ~USB_PORT_STAT_POWER;
2070 set_link_state(dum_hcd);
2073 dum_hcd->port_status &= ~(1 << wValue);
2074 set_link_state(dum_hcd);
2077 case GetHubDescriptor:
2078 if (hcd->speed == HCD_USB3 &&
2079 (wLength < USB_DT_SS_HUB_SIZE ||
2080 wValue != (USB_DT_SS_HUB << 8))) {
2081 dev_dbg(dummy_dev(dum_hcd),
2082 "Wrong hub descriptor type for "
2083 "USB 3.0 roothub.\n");
2086 if (hcd->speed == HCD_USB3)
2087 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2089 hub_descriptor((struct usb_hub_descriptor *) buf);
2092 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2093 if (hcd->speed != HCD_USB3)
2096 if ((wValue >> 8) != USB_DT_BOS)
2099 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2100 retval = sizeof(usb3_bos_desc);
2104 *(__le32 *) buf = cpu_to_le32(0);
2110 /* whoever resets or resumes must GetPortStatus to
2113 if (dum_hcd->resuming &&
2114 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2115 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2116 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2118 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2119 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2120 dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2121 dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2122 if (dum_hcd->dum->pullup) {
2123 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2125 if (hcd->speed < HCD_USB3) {
2126 switch (dum_hcd->dum->gadget.speed) {
2127 case USB_SPEED_HIGH:
2128 dum_hcd->port_status |=
2129 USB_PORT_STAT_HIGH_SPEED;
2132 dum_hcd->dum->gadget.ep0->
2134 dum_hcd->port_status |=
2135 USB_PORT_STAT_LOW_SPEED;
2138 dum_hcd->dum->gadget.speed =
2145 set_link_state(dum_hcd);
2146 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2147 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2152 case SetPortFeature:
2154 case USB_PORT_FEAT_LINK_STATE:
2155 if (hcd->speed != HCD_USB3) {
2156 dev_dbg(dummy_dev(dum_hcd),
2157 "USB_PORT_FEAT_LINK_STATE req not "
2158 "supported for USB 2.0 roothub\n");
2162 * Since this is dummy we don't have an actual link so
2163 * there is nothing to do for the SET_LINK_STATE cmd
2166 case USB_PORT_FEAT_U1_TIMEOUT:
2167 case USB_PORT_FEAT_U2_TIMEOUT:
2168 /* TODO: add suspend/resume support! */
2169 if (hcd->speed != HCD_USB3) {
2170 dev_dbg(dummy_dev(dum_hcd),
2171 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2172 "supported for USB 2.0 roothub\n");
2176 case USB_PORT_FEAT_SUSPEND:
2177 /* Applicable only for USB2.0 hub */
2178 if (hcd->speed == HCD_USB3) {
2179 dev_dbg(dummy_dev(dum_hcd),
2180 "USB_PORT_FEAT_SUSPEND req not "
2181 "supported for USB 3.0 roothub\n");
2184 if (dum_hcd->active) {
2185 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2187 /* HNP would happen here; for now we
2188 * assume b_bus_req is always true.
2190 set_link_state(dum_hcd);
2191 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2192 & dum_hcd->dum->devstatus) != 0)
2193 dev_dbg(dummy_dev(dum_hcd),
2197 case USB_PORT_FEAT_POWER:
2198 if (hcd->speed == HCD_USB3)
2199 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2201 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2202 set_link_state(dum_hcd);
2204 case USB_PORT_FEAT_BH_PORT_RESET:
2205 /* Applicable only for USB3.0 hub */
2206 if (hcd->speed != HCD_USB3) {
2207 dev_dbg(dummy_dev(dum_hcd),
2208 "USB_PORT_FEAT_BH_PORT_RESET req not "
2209 "supported for USB 2.0 roothub\n");
2213 case USB_PORT_FEAT_RESET:
2214 /* if it's already enabled, disable */
2215 if (hcd->speed == HCD_USB3) {
2216 dum_hcd->port_status = 0;
2217 dum_hcd->port_status =
2218 (USB_SS_PORT_STAT_POWER |
2219 USB_PORT_STAT_CONNECTION |
2220 USB_PORT_STAT_RESET);
2222 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2223 | USB_PORT_STAT_LOW_SPEED
2224 | USB_PORT_STAT_HIGH_SPEED);
2226 * We want to reset device status. All but the
2227 * Self powered feature
2229 dum_hcd->dum->devstatus &=
2230 (1 << USB_DEVICE_SELF_POWERED);
2232 * FIXME USB3.0: what is the correct reset signaling
2233 * interval? Is it still 50msec as for HS?
2235 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2238 if (hcd->speed == HCD_USB3) {
2239 if ((dum_hcd->port_status &
2240 USB_SS_PORT_STAT_POWER) != 0) {
2241 dum_hcd->port_status |= (1 << wValue);
2244 if ((dum_hcd->port_status &
2245 USB_PORT_STAT_POWER) != 0) {
2246 dum_hcd->port_status |= (1 << wValue);
2248 set_link_state(dum_hcd);
2251 case GetPortErrorCount:
2252 if (hcd->speed != HCD_USB3) {
2253 dev_dbg(dummy_dev(dum_hcd),
2254 "GetPortErrorCount req not "
2255 "supported for USB 2.0 roothub\n");
2258 /* We'll always return 0 since this is a dummy hub */
2259 *(__le32 *) buf = cpu_to_le32(0);
2262 if (hcd->speed != HCD_USB3) {
2263 dev_dbg(dummy_dev(dum_hcd),
2264 "SetHubDepth req not supported for "
2265 "USB 2.0 roothub\n");
2270 dev_dbg(dummy_dev(dum_hcd),
2271 "hub control req%04x v%04x i%04x l%d\n",
2272 typeReq, wValue, wIndex, wLength);
2274 /* "protocol stall" on error */
2277 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2279 if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2280 usb_hcd_poll_rh_status(hcd);
2284 static int dummy_bus_suspend(struct usb_hcd *hcd)
2286 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2288 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2290 spin_lock_irq(&dum_hcd->dum->lock);
2291 dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2292 set_link_state(dum_hcd);
2293 hcd->state = HC_STATE_SUSPENDED;
2294 spin_unlock_irq(&dum_hcd->dum->lock);
2298 static int dummy_bus_resume(struct usb_hcd *hcd)
2300 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2303 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2305 spin_lock_irq(&dum_hcd->dum->lock);
2306 if (!HCD_HW_ACCESSIBLE(hcd)) {
2309 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2310 set_link_state(dum_hcd);
2311 if (!list_empty(&dum_hcd->urbp_list))
2312 mod_timer(&dum_hcd->timer, jiffies);
2313 hcd->state = HC_STATE_RUNNING;
2315 spin_unlock_irq(&dum_hcd->dum->lock);
2319 /*-------------------------------------------------------------------------*/
2321 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2323 int ep = usb_pipeendpoint(urb->pipe);
2325 return snprintf(buf, size,
2326 "urb/%p %s ep%d%s%s len %d/%d\n",
2329 switch (urb->dev->speed) {
2333 case USB_SPEED_FULL:
2336 case USB_SPEED_HIGH:
2339 case USB_SPEED_SUPER:
2346 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2348 switch (usb_pipetype(urb->pipe)) { \
2349 case PIPE_CONTROL: \
2355 case PIPE_INTERRUPT: \
2362 urb->actual_length, urb->transfer_buffer_length);
2365 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2368 struct usb_hcd *hcd = dev_get_drvdata(dev);
2369 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2372 unsigned long flags;
2374 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2375 list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2378 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2382 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2386 static DEVICE_ATTR_RO(urbs);
2388 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2390 init_timer(&dum_hcd->timer);
2391 dum_hcd->timer.function = dummy_timer;
2392 dum_hcd->timer.data = (unsigned long)dum_hcd;
2393 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2394 dum_hcd->stream_en_ep = 0;
2395 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2396 dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET;
2397 dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2398 dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2399 #ifdef CONFIG_USB_OTG
2400 dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2404 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2405 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2408 static int dummy_start(struct usb_hcd *hcd)
2410 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2413 * MASTER side init ... we emulate a root hub that'll only ever
2414 * talk to one device (the slave side). Also appears in sysfs,
2415 * just like more familiar pci-based HCDs.
2417 if (!usb_hcd_is_primary_hcd(hcd))
2418 return dummy_start_ss(dum_hcd);
2420 spin_lock_init(&dum_hcd->dum->lock);
2421 init_timer(&dum_hcd->timer);
2422 dum_hcd->timer.function = dummy_timer;
2423 dum_hcd->timer.data = (unsigned long)dum_hcd;
2424 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2426 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2428 hcd->power_budget = POWER_BUDGET;
2429 hcd->state = HC_STATE_RUNNING;
2430 hcd->uses_new_polling = 1;
2432 #ifdef CONFIG_USB_OTG
2433 hcd->self.otg_port = 1;
2436 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2437 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2440 static void dummy_stop(struct usb_hcd *hcd)
2442 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2443 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2446 /*-------------------------------------------------------------------------*/
2448 static int dummy_h_get_frame(struct usb_hcd *hcd)
2450 return dummy_g_get_frame(NULL);
2453 static int dummy_setup(struct usb_hcd *hcd)
2457 dum = *((void **)dev_get_platdata(hcd->self.controller));
2458 hcd->self.sg_tablesize = ~0;
2459 if (usb_hcd_is_primary_hcd(hcd)) {
2460 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2461 dum->hs_hcd->dum = dum;
2463 * Mark the first roothub as being USB 2.0.
2464 * The USB 3.0 roothub will be registered later by
2467 hcd->speed = HCD_USB2;
2468 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2470 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2471 dum->ss_hcd->dum = dum;
2472 hcd->speed = HCD_USB3;
2473 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2478 /* Change a group of bulk endpoints to support multiple stream IDs */
2479 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2480 struct usb_host_endpoint **eps, unsigned int num_eps,
2481 unsigned int num_streams, gfp_t mem_flags)
2483 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2484 unsigned long flags;
2486 int ret_streams = num_streams;
2493 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2494 for (i = 0; i < num_eps; i++) {
2495 index = dummy_get_ep_idx(&eps[i]->desc);
2496 if ((1 << index) & dum_hcd->stream_en_ep) {
2497 ret_streams = -EINVAL;
2500 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2502 ret_streams = -EINVAL;
2505 if (max_stream < ret_streams) {
2506 dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2508 eps[i]->desc.bEndpointAddress,
2510 ret_streams = max_stream;
2514 for (i = 0; i < num_eps; i++) {
2515 index = dummy_get_ep_idx(&eps[i]->desc);
2516 dum_hcd->stream_en_ep |= 1 << index;
2517 set_max_streams_for_pipe(dum_hcd,
2518 usb_endpoint_num(&eps[i]->desc), ret_streams);
2521 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2525 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2526 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2527 struct usb_host_endpoint **eps, unsigned int num_eps,
2530 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2531 unsigned long flags;
2536 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2537 for (i = 0; i < num_eps; i++) {
2538 index = dummy_get_ep_idx(&eps[i]->desc);
2539 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2545 for (i = 0; i < num_eps; i++) {
2546 index = dummy_get_ep_idx(&eps[i]->desc);
2547 dum_hcd->stream_en_ep &= ~(1 << index);
2548 set_max_streams_for_pipe(dum_hcd,
2549 usb_endpoint_num(&eps[i]->desc), 0);
2553 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2557 static struct hc_driver dummy_hcd = {
2558 .description = (char *) driver_name,
2559 .product_desc = "Dummy host controller",
2560 .hcd_priv_size = sizeof(struct dummy_hcd),
2562 .flags = HCD_USB3 | HCD_SHARED,
2564 .reset = dummy_setup,
2565 .start = dummy_start,
2568 .urb_enqueue = dummy_urb_enqueue,
2569 .urb_dequeue = dummy_urb_dequeue,
2571 .get_frame_number = dummy_h_get_frame,
2573 .hub_status_data = dummy_hub_status,
2574 .hub_control = dummy_hub_control,
2575 .bus_suspend = dummy_bus_suspend,
2576 .bus_resume = dummy_bus_resume,
2578 .alloc_streams = dummy_alloc_streams,
2579 .free_streams = dummy_free_streams,
2582 static int dummy_hcd_probe(struct platform_device *pdev)
2585 struct usb_hcd *hs_hcd;
2586 struct usb_hcd *ss_hcd;
2589 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2590 dum = *((void **)dev_get_platdata(&pdev->dev));
2592 if (!mod_data.is_super_speed)
2593 dummy_hcd.flags = HCD_USB2;
2594 hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2599 retval = usb_add_hcd(hs_hcd, 0, 0);
2603 if (mod_data.is_super_speed) {
2604 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2605 dev_name(&pdev->dev), hs_hcd);
2608 goto dealloc_usb2_hcd;
2611 retval = usb_add_hcd(ss_hcd, 0, 0);
2618 usb_put_hcd(ss_hcd);
2620 usb_remove_hcd(hs_hcd);
2622 usb_put_hcd(hs_hcd);
2623 dum->hs_hcd = dum->ss_hcd = NULL;
2627 static int dummy_hcd_remove(struct platform_device *pdev)
2631 dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2634 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2635 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2638 usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2639 usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2647 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2649 struct usb_hcd *hcd;
2650 struct dummy_hcd *dum_hcd;
2653 dev_dbg(&pdev->dev, "%s\n", __func__);
2655 hcd = platform_get_drvdata(pdev);
2656 dum_hcd = hcd_to_dummy_hcd(hcd);
2657 if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2658 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2661 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2665 static int dummy_hcd_resume(struct platform_device *pdev)
2667 struct usb_hcd *hcd;
2669 dev_dbg(&pdev->dev, "%s\n", __func__);
2671 hcd = platform_get_drvdata(pdev);
2672 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2673 usb_hcd_poll_rh_status(hcd);
2677 static struct platform_driver dummy_hcd_driver = {
2678 .probe = dummy_hcd_probe,
2679 .remove = dummy_hcd_remove,
2680 .suspend = dummy_hcd_suspend,
2681 .resume = dummy_hcd_resume,
2683 .name = (char *) driver_name,
2687 /*-------------------------------------------------------------------------*/
2688 #define MAX_NUM_UDC 2
2689 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2690 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2692 static int __init init(void)
2694 int retval = -ENOMEM;
2696 struct dummy *dum[MAX_NUM_UDC];
2701 if (!mod_data.is_high_speed && mod_data.is_super_speed)
2704 if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2705 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2710 for (i = 0; i < mod_data.num; i++) {
2711 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2712 if (!the_hcd_pdev[i]) {
2715 platform_device_put(the_hcd_pdev[i--]);
2719 for (i = 0; i < mod_data.num; i++) {
2720 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2721 if (!the_udc_pdev[i]) {
2724 platform_device_put(the_udc_pdev[i--]);
2728 for (i = 0; i < mod_data.num; i++) {
2729 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2734 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2738 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2744 retval = platform_driver_register(&dummy_hcd_driver);
2747 retval = platform_driver_register(&dummy_udc_driver);
2749 goto err_register_udc_driver;
2751 for (i = 0; i < mod_data.num; i++) {
2752 retval = platform_device_add(the_hcd_pdev[i]);
2756 platform_device_del(the_hcd_pdev[i--]);
2760 for (i = 0; i < mod_data.num; i++) {
2761 if (!dum[i]->hs_hcd ||
2762 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2764 * The hcd was added successfully but its probe
2765 * function failed for some reason.
2772 for (i = 0; i < mod_data.num; i++) {
2773 retval = platform_device_add(the_udc_pdev[i]);
2777 platform_device_del(the_udc_pdev[i]);
2782 for (i = 0; i < mod_data.num; i++) {
2783 if (!platform_get_drvdata(the_udc_pdev[i])) {
2785 * The udc was added successfully but its probe
2786 * function failed for some reason.
2795 for (i = 0; i < mod_data.num; i++)
2796 platform_device_del(the_udc_pdev[i]);
2798 for (i = 0; i < mod_data.num; i++)
2799 platform_device_del(the_hcd_pdev[i]);
2801 platform_driver_unregister(&dummy_udc_driver);
2802 err_register_udc_driver:
2803 platform_driver_unregister(&dummy_hcd_driver);
2805 for (i = 0; i < mod_data.num; i++)
2807 for (i = 0; i < mod_data.num; i++)
2808 platform_device_put(the_udc_pdev[i]);
2810 for (i = 0; i < mod_data.num; i++)
2811 platform_device_put(the_hcd_pdev[i]);
2816 static void __exit cleanup(void)
2820 for (i = 0; i < mod_data.num; i++) {
2823 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2825 platform_device_unregister(the_udc_pdev[i]);
2826 platform_device_unregister(the_hcd_pdev[i]);
2829 platform_driver_unregister(&dummy_udc_driver);
2830 platform_driver_unregister(&dummy_hcd_driver);
2832 module_exit(cleanup);