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 */
53 #define POWER_BUDGET_3 900 /* in mA */
55 static const char driver_name[] = "dummy_hcd";
56 static const char driver_desc[] = "USB Host+Gadget Emulator";
58 static const char gadget_name[] = "dummy_udc";
60 MODULE_DESCRIPTION(DRIVER_DESC);
61 MODULE_AUTHOR("David Brownell");
62 MODULE_LICENSE("GPL");
64 struct dummy_hcd_module_parameters {
70 static struct dummy_hcd_module_parameters mod_data = {
71 .is_super_speed = false,
72 .is_high_speed = true,
75 module_param_named(is_super_speed, mod_data.is_super_speed, bool, S_IRUGO);
76 MODULE_PARM_DESC(is_super_speed, "true to simulate SuperSpeed connection");
77 module_param_named(is_high_speed, mod_data.is_high_speed, bool, S_IRUGO);
78 MODULE_PARM_DESC(is_high_speed, "true to simulate HighSpeed connection");
79 module_param_named(num, mod_data.num, uint, S_IRUGO);
80 MODULE_PARM_DESC(num, "number of emulated controllers");
81 /*-------------------------------------------------------------------------*/
83 /* gadget side driver data structres */
85 struct list_head queue;
86 unsigned long last_io; /* jiffies timestamp */
87 struct usb_gadget *gadget;
88 const struct usb_endpoint_descriptor *desc;
92 unsigned already_seen:1;
93 unsigned setup_stage:1;
97 struct dummy_request {
98 struct list_head queue; /* ep's requests */
99 struct usb_request req;
102 static inline struct dummy_ep *usb_ep_to_dummy_ep(struct usb_ep *_ep)
104 return container_of(_ep, struct dummy_ep, ep);
107 static inline struct dummy_request *usb_request_to_dummy_request
108 (struct usb_request *_req)
110 return container_of(_req, struct dummy_request, req);
113 /*-------------------------------------------------------------------------*/
116 * Every device has ep0 for control requests, plus up to 30 more endpoints,
117 * in one of two types:
119 * - Configurable: direction (in/out), type (bulk, iso, etc), and endpoint
120 * number can be changed. Names like "ep-a" are used for this type.
122 * - Fixed Function: in other cases. some characteristics may be mutable;
123 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
125 * Gadget drivers are responsible for not setting up conflicting endpoint
126 * configurations, illegal or unsupported packet lengths, and so on.
129 static const char ep0name[] = "ep0";
131 static const struct {
133 const struct usb_ep_caps caps;
135 #define EP_INFO(_name, _caps) \
141 /* everyone has ep0 */
143 USB_EP_CAPS(USB_EP_CAPS_TYPE_CONTROL, USB_EP_CAPS_DIR_ALL)),
144 /* act like a pxa250: fifteen fixed function endpoints */
145 EP_INFO("ep1in-bulk",
146 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
147 EP_INFO("ep2out-bulk",
148 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
150 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
151 EP_INFO("ep4out-iso",
152 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
154 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
155 EP_INFO("ep6in-bulk",
156 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
157 EP_INFO("ep7out-bulk",
158 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
160 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
161 EP_INFO("ep9out-iso",
162 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
163 EP_INFO("ep10in-int",
164 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
165 EP_INFO("ep11in-bulk",
166 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
167 EP_INFO("ep12out-bulk",
168 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
169 EP_INFO("ep13in-iso",
170 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
171 EP_INFO("ep14out-iso",
172 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
173 EP_INFO("ep15in-int",
174 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
175 /* or like sa1100: two fixed function endpoints */
176 EP_INFO("ep1out-bulk",
177 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
178 EP_INFO("ep2in-bulk",
179 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
180 /* and now some generic EPs so we have enough in multi config */
182 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
184 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
186 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
188 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
190 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
192 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
194 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
196 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
198 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
200 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
202 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
204 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
206 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
211 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_info)
213 /*-------------------------------------------------------------------------*/
219 struct list_head urbp_list;
220 struct sg_mapping_iter miter;
225 enum dummy_rh_state {
233 enum dummy_rh_state rh_state;
234 struct timer_list timer;
237 unsigned long re_timeout;
239 struct usb_device *udev;
240 struct list_head urbp_list;
241 struct urbp *next_frame_urbp;
244 u8 num_stream[30 / 2];
247 unsigned old_active:1;
255 * SLAVE/GADGET side support
257 struct dummy_ep ep[DUMMY_ENDPOINTS];
260 struct usb_gadget gadget;
261 struct usb_gadget_driver *driver;
262 struct dummy_request fifo_req;
263 u8 fifo_buf[FIFO_SIZE];
265 unsigned ints_enabled:1;
266 unsigned udc_suspended:1;
270 * MASTER/HOST side support
272 struct dummy_hcd *hs_hcd;
273 struct dummy_hcd *ss_hcd;
276 static inline struct dummy_hcd *hcd_to_dummy_hcd(struct usb_hcd *hcd)
278 return (struct dummy_hcd *) (hcd->hcd_priv);
281 static inline struct usb_hcd *dummy_hcd_to_hcd(struct dummy_hcd *dum)
283 return container_of((void *) dum, struct usb_hcd, hcd_priv);
286 static inline struct device *dummy_dev(struct dummy_hcd *dum)
288 return dummy_hcd_to_hcd(dum)->self.controller;
291 static inline struct device *udc_dev(struct dummy *dum)
293 return dum->gadget.dev.parent;
296 static inline struct dummy *ep_to_dummy(struct dummy_ep *ep)
298 return container_of(ep->gadget, struct dummy, gadget);
301 static inline struct dummy_hcd *gadget_to_dummy_hcd(struct usb_gadget *gadget)
303 struct dummy *dum = container_of(gadget, struct dummy, gadget);
304 if (dum->gadget.speed == USB_SPEED_SUPER)
310 static inline struct dummy *gadget_dev_to_dummy(struct device *dev)
312 return container_of(dev, struct dummy, gadget.dev);
315 /*-------------------------------------------------------------------------*/
317 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
319 /* called with spinlock held */
320 static void nuke(struct dummy *dum, struct dummy_ep *ep)
322 while (!list_empty(&ep->queue)) {
323 struct dummy_request *req;
325 req = list_entry(ep->queue.next, struct dummy_request, queue);
326 list_del_init(&req->queue);
327 req->req.status = -ESHUTDOWN;
329 spin_unlock(&dum->lock);
330 usb_gadget_giveback_request(&ep->ep, &req->req);
331 spin_lock(&dum->lock);
335 /* caller must hold lock */
336 static void stop_activity(struct dummy *dum)
340 /* prevent any more requests */
343 /* The timer is left running so that outstanding URBs can fail */
345 /* nuke any pending requests first, so driver i/o is quiesced */
346 for (i = 0; i < DUMMY_ENDPOINTS; ++i)
347 nuke(dum, &dum->ep[i]);
349 /* driver now does any non-usb quiescing necessary */
353 * set_link_state_by_speed() - Sets the current state of the link according to
355 * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
357 * This function updates the port_status according to the link state and the
360 static void set_link_state_by_speed(struct dummy_hcd *dum_hcd)
362 struct dummy *dum = dum_hcd->dum;
364 if (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3) {
365 if ((dum_hcd->port_status & USB_SS_PORT_STAT_POWER) == 0) {
366 dum_hcd->port_status = 0;
367 } else if (!dum->pullup || dum->udc_suspended) {
368 /* UDC suspend must cause a disconnect */
369 dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
370 USB_PORT_STAT_ENABLE);
371 if ((dum_hcd->old_status &
372 USB_PORT_STAT_CONNECTION) != 0)
373 dum_hcd->port_status |=
374 (USB_PORT_STAT_C_CONNECTION << 16);
376 /* device is connected and not suspended */
377 dum_hcd->port_status |= (USB_PORT_STAT_CONNECTION |
378 USB_PORT_STAT_SPEED_5GBPS) ;
379 if ((dum_hcd->old_status &
380 USB_PORT_STAT_CONNECTION) == 0)
381 dum_hcd->port_status |=
382 (USB_PORT_STAT_C_CONNECTION << 16);
383 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) &&
384 (dum_hcd->port_status &
385 USB_PORT_STAT_LINK_STATE) == USB_SS_PORT_LS_U0 &&
386 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
390 if ((dum_hcd->port_status & USB_PORT_STAT_POWER) == 0) {
391 dum_hcd->port_status = 0;
392 } else if (!dum->pullup || dum->udc_suspended) {
393 /* UDC suspend must cause a disconnect */
394 dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
395 USB_PORT_STAT_ENABLE |
396 USB_PORT_STAT_LOW_SPEED |
397 USB_PORT_STAT_HIGH_SPEED |
398 USB_PORT_STAT_SUSPEND);
399 if ((dum_hcd->old_status &
400 USB_PORT_STAT_CONNECTION) != 0)
401 dum_hcd->port_status |=
402 (USB_PORT_STAT_C_CONNECTION << 16);
404 dum_hcd->port_status |= USB_PORT_STAT_CONNECTION;
405 if ((dum_hcd->old_status &
406 USB_PORT_STAT_CONNECTION) == 0)
407 dum_hcd->port_status |=
408 (USB_PORT_STAT_C_CONNECTION << 16);
409 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0)
410 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
411 else if ((dum_hcd->port_status &
412 USB_PORT_STAT_SUSPEND) == 0 &&
413 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
419 /* caller must hold lock */
420 static void set_link_state(struct dummy_hcd *dum_hcd)
422 struct dummy *dum = dum_hcd->dum;
423 unsigned int power_bit;
427 if ((dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 &&
428 dum->gadget.speed != USB_SPEED_SUPER) ||
429 (dummy_hcd_to_hcd(dum_hcd)->speed != HCD_USB3 &&
430 dum->gadget.speed == USB_SPEED_SUPER))
433 set_link_state_by_speed(dum_hcd);
434 power_bit = (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 ?
435 USB_SS_PORT_STAT_POWER : USB_PORT_STAT_POWER);
437 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0 ||
439 dum_hcd->resuming = 0;
441 /* Currently !connected or in reset */
442 if ((dum_hcd->port_status & power_bit) == 0 ||
443 (dum_hcd->port_status & USB_PORT_STAT_RESET) != 0) {
444 unsigned int disconnect = power_bit &
445 dum_hcd->old_status & (~dum_hcd->port_status);
446 unsigned int reset = USB_PORT_STAT_RESET &
447 (~dum_hcd->old_status) & dum_hcd->port_status;
449 /* Report reset and disconnect events to the driver */
450 if (dum->ints_enabled && (disconnect || reset)) {
452 ++dum->callback_usage;
453 spin_unlock(&dum->lock);
455 usb_gadget_udc_reset(&dum->gadget, dum->driver);
457 dum->driver->disconnect(&dum->gadget);
458 spin_lock(&dum->lock);
459 --dum->callback_usage;
461 } else if (dum_hcd->active != dum_hcd->old_active &&
463 ++dum->callback_usage;
464 spin_unlock(&dum->lock);
465 if (dum_hcd->old_active && dum->driver->suspend)
466 dum->driver->suspend(&dum->gadget);
467 else if (!dum_hcd->old_active && dum->driver->resume)
468 dum->driver->resume(&dum->gadget);
469 spin_lock(&dum->lock);
470 --dum->callback_usage;
473 dum_hcd->old_status = dum_hcd->port_status;
474 dum_hcd->old_active = dum_hcd->active;
477 /*-------------------------------------------------------------------------*/
479 /* SLAVE/GADGET SIDE DRIVER
481 * This only tracks gadget state. All the work is done when the host
482 * side tries some (emulated) i/o operation. Real device controller
483 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
486 #define is_enabled(dum) \
487 (dum->port_status & USB_PORT_STAT_ENABLE)
489 static int dummy_enable(struct usb_ep *_ep,
490 const struct usb_endpoint_descriptor *desc)
493 struct dummy_hcd *dum_hcd;
498 ep = usb_ep_to_dummy_ep(_ep);
499 if (!_ep || !desc || ep->desc || _ep->name == ep0name
500 || desc->bDescriptorType != USB_DT_ENDPOINT)
502 dum = ep_to_dummy(ep);
506 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
507 if (!is_enabled(dum_hcd))
511 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
512 * maximum packet size.
513 * For SS devices the wMaxPacketSize is limited by 1024.
515 max = usb_endpoint_maxp(desc) & 0x7ff;
517 /* drivers must not request bad settings, since lower levels
518 * (hardware or its drivers) may not check. some endpoints
519 * can't do iso, many have maxpacket limitations, etc.
521 * since this "hardware" driver is here to help debugging, we
522 * have some extra sanity checks. (there could be more though,
523 * especially for "ep9out" style fixed function ones.)
526 switch (usb_endpoint_type(desc)) {
527 case USB_ENDPOINT_XFER_BULK:
528 if (strstr(ep->ep.name, "-iso")
529 || strstr(ep->ep.name, "-int")) {
532 switch (dum->gadget.speed) {
533 case USB_SPEED_SUPER:
542 if (max == 8 || max == 16 || max == 32 || max == 64)
543 /* we'll fake any legal size */
545 /* save a return statement */
550 case USB_ENDPOINT_XFER_INT:
551 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
553 /* real hardware might not handle all packet sizes */
554 switch (dum->gadget.speed) {
555 case USB_SPEED_SUPER:
559 /* save a return statement */
563 /* save a return statement */
570 case USB_ENDPOINT_XFER_ISOC:
571 if (strstr(ep->ep.name, "-bulk")
572 || strstr(ep->ep.name, "-int"))
574 /* real hardware might not handle all packet sizes */
575 switch (dum->gadget.speed) {
576 case USB_SPEED_SUPER:
580 /* save a return statement */
584 /* save a return statement */
590 /* few chips support control except on ep0 */
594 _ep->maxpacket = max;
595 if (usb_ss_max_streams(_ep->comp_desc)) {
596 if (!usb_endpoint_xfer_bulk(desc)) {
597 dev_err(udc_dev(dum), "Can't enable stream support on "
598 "non-bulk ep %s\n", _ep->name);
605 dev_dbg(udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
607 desc->bEndpointAddress & 0x0f,
608 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
610 switch (usb_endpoint_type(desc)) {
611 case USB_ENDPOINT_XFER_BULK:
614 case USB_ENDPOINT_XFER_ISOC:
617 case USB_ENDPOINT_XFER_INT:
624 max, ep->stream_en ? "enabled" : "disabled");
626 /* at this point real hardware should be NAKing transfers
627 * to that endpoint, until a buffer is queued to it.
629 ep->halted = ep->wedged = 0;
635 static int dummy_disable(struct usb_ep *_ep)
641 ep = usb_ep_to_dummy_ep(_ep);
642 if (!_ep || !ep->desc || _ep->name == ep0name)
644 dum = ep_to_dummy(ep);
646 spin_lock_irqsave(&dum->lock, flags);
650 spin_unlock_irqrestore(&dum->lock, flags);
652 dev_dbg(udc_dev(dum), "disabled %s\n", _ep->name);
656 static struct usb_request *dummy_alloc_request(struct usb_ep *_ep,
659 struct dummy_request *req;
664 req = kzalloc(sizeof(*req), mem_flags);
667 INIT_LIST_HEAD(&req->queue);
671 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
673 struct dummy_request *req;
680 req = usb_request_to_dummy_request(_req);
681 WARN_ON(!list_empty(&req->queue));
685 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
689 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
693 struct dummy_request *req;
695 struct dummy_hcd *dum_hcd;
698 req = usb_request_to_dummy_request(_req);
699 if (!_req || !list_empty(&req->queue) || !_req->complete)
702 ep = usb_ep_to_dummy_ep(_ep);
703 if (!_ep || (!ep->desc && _ep->name != ep0name))
706 dum = ep_to_dummy(ep);
707 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
708 if (!dum->driver || !is_enabled(dum_hcd))
712 dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
713 ep, _req, _ep->name, _req->length, _req->buf);
715 _req->status = -EINPROGRESS;
717 spin_lock_irqsave(&dum->lock, flags);
719 /* implement an emulated single-request FIFO */
720 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
721 list_empty(&dum->fifo_req.queue) &&
722 list_empty(&ep->queue) &&
723 _req->length <= FIFO_SIZE) {
724 req = &dum->fifo_req;
726 req->req.buf = dum->fifo_buf;
727 memcpy(dum->fifo_buf, _req->buf, _req->length);
728 req->req.context = dum;
729 req->req.complete = fifo_complete;
731 list_add_tail(&req->queue, &ep->queue);
732 spin_unlock(&dum->lock);
733 _req->actual = _req->length;
735 usb_gadget_giveback_request(_ep, _req);
736 spin_lock(&dum->lock);
738 list_add_tail(&req->queue, &ep->queue);
739 spin_unlock_irqrestore(&dum->lock, flags);
741 /* real hardware would likely enable transfers here, in case
742 * it'd been left NAKing.
747 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
751 int retval = -EINVAL;
753 struct dummy_request *req = NULL;
757 ep = usb_ep_to_dummy_ep(_ep);
758 dum = ep_to_dummy(ep);
763 local_irq_save(flags);
764 spin_lock(&dum->lock);
765 list_for_each_entry(req, &ep->queue, queue) {
766 if (&req->req == _req) {
767 list_del_init(&req->queue);
768 _req->status = -ECONNRESET;
773 spin_unlock(&dum->lock);
776 dev_dbg(udc_dev(dum),
777 "dequeued req %p from %s, len %d buf %p\n",
778 req, _ep->name, _req->length, _req->buf);
779 usb_gadget_giveback_request(_ep, _req);
781 local_irq_restore(flags);
786 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
793 ep = usb_ep_to_dummy_ep(_ep);
794 dum = ep_to_dummy(ep);
798 ep->halted = ep->wedged = 0;
799 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
800 !list_empty(&ep->queue))
807 /* FIXME clear emulated data toggle too */
812 dummy_set_halt(struct usb_ep *_ep, int value)
814 return dummy_set_halt_and_wedge(_ep, value, 0);
817 static int dummy_set_wedge(struct usb_ep *_ep)
819 if (!_ep || _ep->name == ep0name)
821 return dummy_set_halt_and_wedge(_ep, 1, 1);
824 static const struct usb_ep_ops dummy_ep_ops = {
825 .enable = dummy_enable,
826 .disable = dummy_disable,
828 .alloc_request = dummy_alloc_request,
829 .free_request = dummy_free_request,
831 .queue = dummy_queue,
832 .dequeue = dummy_dequeue,
834 .set_halt = dummy_set_halt,
835 .set_wedge = dummy_set_wedge,
838 /*-------------------------------------------------------------------------*/
840 /* there are both host and device side versions of this call ... */
841 static int dummy_g_get_frame(struct usb_gadget *_gadget)
843 struct timespec64 ts64;
845 ktime_get_ts64(&ts64);
846 return ts64.tv_nsec / NSEC_PER_MSEC;
849 static int dummy_wakeup(struct usb_gadget *_gadget)
851 struct dummy_hcd *dum_hcd;
853 dum_hcd = gadget_to_dummy_hcd(_gadget);
854 if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
855 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
857 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
859 if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
860 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
863 /* FIXME: What if the root hub is suspended but the port isn't? */
865 /* hub notices our request, issues downstream resume, etc */
866 dum_hcd->resuming = 1;
867 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
868 mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
872 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
876 _gadget->is_selfpowered = (value != 0);
877 dum = gadget_to_dummy_hcd(_gadget)->dum;
879 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
881 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
885 static void dummy_udc_update_ep0(struct dummy *dum)
887 if (dum->gadget.speed == USB_SPEED_SUPER)
888 dum->ep[0].ep.maxpacket = 9;
890 dum->ep[0].ep.maxpacket = 64;
893 static int dummy_pullup(struct usb_gadget *_gadget, int value)
895 struct dummy_hcd *dum_hcd;
899 dum = gadget_dev_to_dummy(&_gadget->dev);
901 if (value && dum->driver) {
902 if (mod_data.is_super_speed)
903 dum->gadget.speed = dum->driver->max_speed;
904 else if (mod_data.is_high_speed)
905 dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
906 dum->driver->max_speed);
908 dum->gadget.speed = USB_SPEED_FULL;
909 dummy_udc_update_ep0(dum);
911 if (dum->gadget.speed < dum->driver->max_speed)
912 dev_dbg(udc_dev(dum), "This device can perform faster"
913 " if you connect it to a %s port...\n",
914 usb_speed_string(dum->driver->max_speed));
916 dum_hcd = gadget_to_dummy_hcd(_gadget);
918 spin_lock_irqsave(&dum->lock, flags);
919 dum->pullup = (value != 0);
920 set_link_state(dum_hcd);
923 * Emulate synchronize_irq(): wait for callbacks to finish.
924 * This seems to be the best place to emulate the call to
925 * synchronize_irq() that's in usb_gadget_remove_driver().
926 * Doing it in dummy_udc_stop() would be too late since it
927 * is called after the unbind callback and unbind shouldn't
928 * be invoked until all the other callbacks are finished.
930 while (dum->callback_usage > 0) {
931 spin_unlock_irqrestore(&dum->lock, flags);
932 usleep_range(1000, 2000);
933 spin_lock_irqsave(&dum->lock, flags);
936 spin_unlock_irqrestore(&dum->lock, flags);
938 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
942 static int dummy_udc_start(struct usb_gadget *g,
943 struct usb_gadget_driver *driver);
944 static int dummy_udc_stop(struct usb_gadget *g);
946 static const struct usb_gadget_ops dummy_ops = {
947 .get_frame = dummy_g_get_frame,
948 .wakeup = dummy_wakeup,
949 .set_selfpowered = dummy_set_selfpowered,
950 .pullup = dummy_pullup,
951 .udc_start = dummy_udc_start,
952 .udc_stop = dummy_udc_stop,
955 /*-------------------------------------------------------------------------*/
957 /* "function" sysfs attribute */
958 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
961 struct dummy *dum = gadget_dev_to_dummy(dev);
963 if (!dum->driver || !dum->driver->function)
965 return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
967 static DEVICE_ATTR_RO(function);
969 /*-------------------------------------------------------------------------*/
972 * Driver registration/unregistration.
974 * This is basically hardware-specific; there's usually only one real USB
975 * device (not host) controller since that's how USB devices are intended
976 * to work. So most implementations of these api calls will rely on the
977 * fact that only one driver will ever bind to the hardware. But curious
978 * hardware can be built with discrete components, so the gadget API doesn't
979 * require that assumption.
981 * For this emulator, it might be convenient to create a usb slave device
982 * for each driver that registers: just add to a big root hub.
985 static int dummy_udc_start(struct usb_gadget *g,
986 struct usb_gadget_driver *driver)
988 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
989 struct dummy *dum = dum_hcd->dum;
991 if (driver->max_speed == USB_SPEED_UNKNOWN)
995 * SLAVE side init ... the layer above hardware, which
996 * can't enumerate without help from the driver we're binding.
999 spin_lock_irq(&dum->lock);
1001 dum->driver = driver;
1002 dum->ints_enabled = 1;
1003 spin_unlock_irq(&dum->lock);
1008 static int dummy_udc_stop(struct usb_gadget *g)
1010 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
1011 struct dummy *dum = dum_hcd->dum;
1013 spin_lock_irq(&dum->lock);
1014 dum->ints_enabled = 0;
1017 spin_unlock_irq(&dum->lock);
1024 /* The gadget structure is stored inside the hcd structure and will be
1025 * released along with it. */
1026 static void init_dummy_udc_hw(struct dummy *dum)
1030 INIT_LIST_HEAD(&dum->gadget.ep_list);
1031 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1032 struct dummy_ep *ep = &dum->ep[i];
1034 if (!ep_info[i].name)
1036 ep->ep.name = ep_info[i].name;
1037 ep->ep.caps = ep_info[i].caps;
1038 ep->ep.ops = &dummy_ep_ops;
1039 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1040 ep->halted = ep->wedged = ep->already_seen =
1041 ep->setup_stage = 0;
1042 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1043 ep->ep.max_streams = 16;
1044 ep->last_io = jiffies;
1045 ep->gadget = &dum->gadget;
1047 INIT_LIST_HEAD(&ep->queue);
1050 dum->gadget.ep0 = &dum->ep[0].ep;
1051 list_del_init(&dum->ep[0].ep.ep_list);
1052 INIT_LIST_HEAD(&dum->fifo_req.queue);
1054 #ifdef CONFIG_USB_OTG
1055 dum->gadget.is_otg = 1;
1059 static int dummy_udc_probe(struct platform_device *pdev)
1064 dum = *((void **)dev_get_platdata(&pdev->dev));
1065 /* Clear usb_gadget region for new registration to udc-core */
1066 memzero_explicit(&dum->gadget, sizeof(struct usb_gadget));
1067 dum->gadget.name = gadget_name;
1068 dum->gadget.ops = &dummy_ops;
1069 if (mod_data.is_super_speed)
1070 dum->gadget.max_speed = USB_SPEED_SUPER;
1071 else if (mod_data.is_high_speed)
1072 dum->gadget.max_speed = USB_SPEED_HIGH;
1074 dum->gadget.max_speed = USB_SPEED_FULL;
1076 dum->gadget.dev.parent = &pdev->dev;
1077 init_dummy_udc_hw(dum);
1079 rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1083 rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1086 platform_set_drvdata(pdev, dum);
1090 usb_del_gadget_udc(&dum->gadget);
1095 static int dummy_udc_remove(struct platform_device *pdev)
1097 struct dummy *dum = platform_get_drvdata(pdev);
1099 device_remove_file(&dum->gadget.dev, &dev_attr_function);
1100 usb_del_gadget_udc(&dum->gadget);
1104 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1107 spin_lock_irq(&dum->lock);
1108 dum->udc_suspended = suspend;
1109 set_link_state(dum_hcd);
1110 spin_unlock_irq(&dum->lock);
1113 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1115 struct dummy *dum = platform_get_drvdata(pdev);
1116 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1118 dev_dbg(&pdev->dev, "%s\n", __func__);
1119 dummy_udc_pm(dum, dum_hcd, 1);
1120 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1124 static int dummy_udc_resume(struct platform_device *pdev)
1126 struct dummy *dum = platform_get_drvdata(pdev);
1127 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1129 dev_dbg(&pdev->dev, "%s\n", __func__);
1130 dummy_udc_pm(dum, dum_hcd, 0);
1131 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1135 static struct platform_driver dummy_udc_driver = {
1136 .probe = dummy_udc_probe,
1137 .remove = dummy_udc_remove,
1138 .suspend = dummy_udc_suspend,
1139 .resume = dummy_udc_resume,
1141 .name = (char *) gadget_name,
1145 /*-------------------------------------------------------------------------*/
1147 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1151 index = usb_endpoint_num(desc) << 1;
1152 if (usb_endpoint_dir_in(desc))
1157 /* MASTER/HOST SIDE DRIVER
1159 * this uses the hcd framework to hook up to host side drivers.
1160 * its root hub will only have one device, otherwise it acts like
1161 * a normal host controller.
1163 * when urbs are queued, they're just stuck on a list that we
1164 * scan in a timer callback. that callback connects writes from
1165 * the host with reads from the device, and so on, based on the
1169 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1171 const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1174 if (!usb_endpoint_xfer_bulk(desc))
1177 index = dummy_get_ep_idx(desc);
1178 return (1 << index) & dum_hcd->stream_en_ep;
1182 * The max stream number is saved as a nibble so for the 30 possible endpoints
1183 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1184 * means we use only 1 stream). The maximum according to the spec is 16bit so
1185 * if the 16 stream limit is about to go, the array size should be incremented
1186 * to 30 elements of type u16.
1188 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1193 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1194 if (usb_pipeout(pipe))
1202 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1203 unsigned int pipe, unsigned int streams)
1208 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1209 if (usb_pipeout(pipe)) {
1213 max_streams &= 0xf0;
1215 max_streams |= streams;
1216 dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1219 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1221 unsigned int max_streams;
1224 enabled = dummy_ep_stream_en(dum_hcd, urb);
1225 if (!urb->stream_id) {
1233 max_streams = get_max_streams_for_pipe(dum_hcd,
1234 usb_pipeendpoint(urb->pipe));
1235 if (urb->stream_id > max_streams) {
1236 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1244 static int dummy_urb_enqueue(
1245 struct usb_hcd *hcd,
1249 struct dummy_hcd *dum_hcd;
1251 unsigned long flags;
1254 urbp = kmalloc(sizeof *urbp, mem_flags);
1258 urbp->miter_started = 0;
1260 dum_hcd = hcd_to_dummy_hcd(hcd);
1261 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1263 rc = dummy_validate_stream(dum_hcd, urb);
1269 rc = usb_hcd_link_urb_to_ep(hcd, urb);
1275 if (!dum_hcd->udev) {
1276 dum_hcd->udev = urb->dev;
1277 usb_get_dev(dum_hcd->udev);
1278 } else if (unlikely(dum_hcd->udev != urb->dev))
1279 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1281 list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1283 if (!dum_hcd->next_frame_urbp)
1284 dum_hcd->next_frame_urbp = urbp;
1285 if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1286 urb->error_count = 1; /* mark as a new urb */
1288 /* kick the scheduler, it'll do the rest */
1289 if (!timer_pending(&dum_hcd->timer))
1290 mod_timer(&dum_hcd->timer, jiffies + 1);
1293 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1297 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1299 struct dummy_hcd *dum_hcd;
1300 unsigned long flags;
1303 /* giveback happens automatically in timer callback,
1304 * so make sure the callback happens */
1305 dum_hcd = hcd_to_dummy_hcd(hcd);
1306 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1308 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1309 if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1310 !list_empty(&dum_hcd->urbp_list))
1311 mod_timer(&dum_hcd->timer, jiffies);
1313 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1317 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1321 struct urbp *urbp = urb->hcpriv;
1323 struct sg_mapping_iter *miter = &urbp->miter;
1328 to_host = usb_pipein(urb->pipe);
1329 rbuf = req->req.buf + req->req.actual;
1331 if (!urb->num_sgs) {
1332 ubuf = urb->transfer_buffer + urb->actual_length;
1334 memcpy(ubuf, rbuf, len);
1336 memcpy(rbuf, ubuf, len);
1340 if (!urbp->miter_started) {
1341 u32 flags = SG_MITER_ATOMIC;
1344 flags |= SG_MITER_TO_SG;
1346 flags |= SG_MITER_FROM_SG;
1348 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1349 urbp->miter_started = 1;
1351 next_sg = sg_miter_next(miter);
1352 if (next_sg == false) {
1358 this_sg = min_t(u32, len, miter->length);
1359 miter->consumed = this_sg;
1363 memcpy(ubuf, rbuf, this_sg);
1365 memcpy(rbuf, ubuf, this_sg);
1370 next_sg = sg_miter_next(miter);
1371 if (next_sg == false) {
1379 sg_miter_stop(miter);
1383 /* transfer up to a frame's worth; caller must own lock */
1384 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1385 struct dummy_ep *ep, int limit, int *status)
1387 struct dummy *dum = dum_hcd->dum;
1388 struct dummy_request *req;
1392 /* if there's no request queued, the device is NAKing; return */
1393 list_for_each_entry(req, &ep->queue, queue) {
1394 unsigned host_len, dev_len, len;
1395 int is_short, to_host;
1398 if (dummy_ep_stream_en(dum_hcd, urb)) {
1399 if ((urb->stream_id != req->req.stream_id))
1403 /* 1..N packets of ep->ep.maxpacket each ... the last one
1404 * may be short (including zero length).
1406 * writer can send a zlp explicitly (length 0) or implicitly
1407 * (length mod maxpacket zero, and 'zero' flag); they always
1410 host_len = urb->transfer_buffer_length - urb->actual_length;
1411 dev_len = req->req.length - req->req.actual;
1412 len = min(host_len, dev_len);
1414 /* FIXME update emulated data toggle too */
1416 to_host = usb_pipein(urb->pipe);
1417 if (unlikely(len == 0))
1420 /* not enough bandwidth left? */
1421 if (limit < ep->ep.maxpacket && limit < len)
1423 len = min_t(unsigned, len, limit);
1427 /* send multiple of maxpacket first, then remainder */
1428 if (len >= ep->ep.maxpacket) {
1430 if (len % ep->ep.maxpacket)
1432 len -= len % ep->ep.maxpacket;
1437 len = dummy_perform_transfer(urb, req, len);
1439 ep->last_io = jiffies;
1441 req->req.status = len;
1445 urb->actual_length += len;
1446 req->req.actual += len;
1450 /* short packets terminate, maybe with overflow/underflow.
1451 * it's only really an error to write too much.
1453 * partially filling a buffer optionally blocks queue advances
1454 * (so completion handlers can clean up the queue) but we don't
1455 * need to emulate such data-in-flight.
1458 if (host_len == dev_len) {
1459 req->req.status = 0;
1461 } else if (to_host) {
1462 req->req.status = 0;
1463 if (dev_len > host_len)
1464 *status = -EOVERFLOW;
1469 if (host_len > dev_len)
1470 req->req.status = -EOVERFLOW;
1472 req->req.status = 0;
1476 * many requests terminate without a short packet.
1477 * send a zlp if demanded by flags.
1480 if (req->req.length == req->req.actual) {
1481 if (req->req.zero && to_host)
1484 req->req.status = 0;
1486 if (urb->transfer_buffer_length == urb->actual_length) {
1487 if (urb->transfer_flags & URB_ZERO_PACKET &&
1495 /* device side completion --> continuable */
1496 if (req->req.status != -EINPROGRESS) {
1497 list_del_init(&req->queue);
1499 spin_unlock(&dum->lock);
1500 usb_gadget_giveback_request(&ep->ep, &req->req);
1501 spin_lock(&dum->lock);
1503 /* requests might have been unlinked... */
1507 /* host side completion --> terminate */
1508 if (*status != -EINPROGRESS)
1511 /* rescan to continue with any other queued i/o */
1518 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1520 int limit = ep->ep.maxpacket;
1522 if (dum->gadget.speed == USB_SPEED_HIGH) {
1525 /* high bandwidth mode */
1526 tmp = usb_endpoint_maxp(ep->desc);
1527 tmp = (tmp >> 11) & 0x03;
1528 tmp *= 8 /* applies to entire frame */;
1529 limit += limit * tmp;
1531 if (dum->gadget.speed == USB_SPEED_SUPER) {
1532 switch (usb_endpoint_type(ep->desc)) {
1533 case USB_ENDPOINT_XFER_ISOC:
1534 /* Sec. 4.4.8.2 USB3.0 Spec */
1535 limit = 3 * 16 * 1024 * 8;
1537 case USB_ENDPOINT_XFER_INT:
1538 /* Sec. 4.4.7.2 USB3.0 Spec */
1539 limit = 3 * 1024 * 8;
1541 case USB_ENDPOINT_XFER_BULK:
1549 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1550 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1551 USB_PORT_STAT_SUSPEND)) \
1552 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1554 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1558 if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1559 dum->ss_hcd : dum->hs_hcd)))
1561 if (!dum->ints_enabled)
1563 if ((address & ~USB_DIR_IN) == 0)
1565 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1566 struct dummy_ep *ep = &dum->ep[i];
1570 if (ep->desc->bEndpointAddress == address)
1578 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1579 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1580 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1581 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1582 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1583 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1587 * handle_control_request() - handles all control transfers
1588 * @dum: pointer to dummy (the_controller)
1589 * @urb: the urb request to handle
1590 * @setup: pointer to the setup data for a USB device control
1592 * @status: pointer to request handling status
1594 * Return 0 - if the request was handled
1595 * 1 - if the request wasn't handles
1596 * error code on error
1598 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1599 struct usb_ctrlrequest *setup,
1602 struct dummy_ep *ep2;
1603 struct dummy *dum = dum_hcd->dum;
1608 w_index = le16_to_cpu(setup->wIndex);
1609 w_value = le16_to_cpu(setup->wValue);
1610 switch (setup->bRequest) {
1611 case USB_REQ_SET_ADDRESS:
1612 if (setup->bRequestType != Dev_Request)
1614 dum->address = w_value;
1616 dev_dbg(udc_dev(dum), "set_address = %d\n",
1620 case USB_REQ_SET_FEATURE:
1621 if (setup->bRequestType == Dev_Request) {
1624 case USB_DEVICE_REMOTE_WAKEUP:
1626 case USB_DEVICE_B_HNP_ENABLE:
1627 dum->gadget.b_hnp_enable = 1;
1629 case USB_DEVICE_A_HNP_SUPPORT:
1630 dum->gadget.a_hnp_support = 1;
1632 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1633 dum->gadget.a_alt_hnp_support = 1;
1635 case USB_DEVICE_U1_ENABLE:
1636 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1638 w_value = USB_DEV_STAT_U1_ENABLED;
1640 ret_val = -EOPNOTSUPP;
1642 case USB_DEVICE_U2_ENABLE:
1643 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1645 w_value = USB_DEV_STAT_U2_ENABLED;
1647 ret_val = -EOPNOTSUPP;
1649 case USB_DEVICE_LTM_ENABLE:
1650 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1652 w_value = USB_DEV_STAT_LTM_ENABLED;
1654 ret_val = -EOPNOTSUPP;
1657 ret_val = -EOPNOTSUPP;
1660 dum->devstatus |= (1 << w_value);
1663 } else if (setup->bRequestType == Ep_Request) {
1665 ep2 = find_endpoint(dum, w_index);
1666 if (!ep2 || ep2->ep.name == ep0name) {
1667 ret_val = -EOPNOTSUPP;
1675 case USB_REQ_CLEAR_FEATURE:
1676 if (setup->bRequestType == Dev_Request) {
1679 case USB_DEVICE_REMOTE_WAKEUP:
1680 w_value = USB_DEVICE_REMOTE_WAKEUP;
1682 case USB_DEVICE_U1_ENABLE:
1683 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1685 w_value = USB_DEV_STAT_U1_ENABLED;
1687 ret_val = -EOPNOTSUPP;
1689 case USB_DEVICE_U2_ENABLE:
1690 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1692 w_value = USB_DEV_STAT_U2_ENABLED;
1694 ret_val = -EOPNOTSUPP;
1696 case USB_DEVICE_LTM_ENABLE:
1697 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1699 w_value = USB_DEV_STAT_LTM_ENABLED;
1701 ret_val = -EOPNOTSUPP;
1704 ret_val = -EOPNOTSUPP;
1708 dum->devstatus &= ~(1 << w_value);
1711 } else if (setup->bRequestType == Ep_Request) {
1713 ep2 = find_endpoint(dum, w_index);
1715 ret_val = -EOPNOTSUPP;
1724 case USB_REQ_GET_STATUS:
1725 if (setup->bRequestType == Dev_InRequest
1726 || setup->bRequestType == Intf_InRequest
1727 || setup->bRequestType == Ep_InRequest) {
1730 * device: remote wakeup, selfpowered
1731 * interface: nothing
1734 buf = (char *)urb->transfer_buffer;
1735 if (urb->transfer_buffer_length > 0) {
1736 if (setup->bRequestType == Ep_InRequest) {
1737 ep2 = find_endpoint(dum, w_index);
1739 ret_val = -EOPNOTSUPP;
1742 buf[0] = ep2->halted;
1743 } else if (setup->bRequestType ==
1745 buf[0] = (u8)dum->devstatus;
1749 if (urb->transfer_buffer_length > 1)
1751 urb->actual_length = min_t(u32, 2,
1752 urb->transfer_buffer_length);
1761 /* drive both sides of the transfers; looks like irq handlers to
1762 * both drivers except the callbacks aren't in_irq().
1764 static void dummy_timer(unsigned long _dum_hcd)
1766 struct dummy_hcd *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1767 struct dummy *dum = dum_hcd->dum;
1768 struct urbp *urbp, *tmp;
1769 unsigned long flags;
1773 /* simplistic model for one frame's bandwidth */
1774 switch (dum->gadget.speed) {
1776 total = 8/*bytes*/ * 12/*packets*/;
1778 case USB_SPEED_FULL:
1779 total = 64/*bytes*/ * 19/*packets*/;
1781 case USB_SPEED_HIGH:
1782 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1784 case USB_SPEED_SUPER:
1785 /* Bus speed is 500000 bytes/ms, so use a little less */
1789 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1793 /* FIXME if HZ != 1000 this will probably misbehave ... */
1795 /* look at each urb queued by the host side driver */
1796 spin_lock_irqsave(&dum->lock, flags);
1798 if (!dum_hcd->udev) {
1799 dev_err(dummy_dev(dum_hcd),
1800 "timer fired with no URBs pending?\n");
1801 spin_unlock_irqrestore(&dum->lock, flags);
1804 dum_hcd->next_frame_urbp = NULL;
1806 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1807 if (!ep_info[i].name)
1809 dum->ep[i].already_seen = 0;
1813 list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1815 struct dummy_request *req;
1817 struct dummy_ep *ep = NULL;
1819 int status = -EINPROGRESS;
1821 /* stop when we reach URBs queued after the timer interrupt */
1822 if (urbp == dum_hcd->next_frame_urbp)
1828 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1830 type = usb_pipetype(urb->pipe);
1832 /* used up this frame's non-periodic bandwidth?
1833 * FIXME there's infinite bandwidth for control and
1834 * periodic transfers ... unrealistic.
1836 if (total <= 0 && type == PIPE_BULK)
1839 /* find the gadget's ep for this request (if configured) */
1840 address = usb_pipeendpoint (urb->pipe);
1841 if (usb_pipein(urb->pipe))
1842 address |= USB_DIR_IN;
1843 ep = find_endpoint(dum, address);
1845 /* set_configuration() disagreement */
1846 dev_dbg(dummy_dev(dum_hcd),
1847 "no ep configured for urb %p\n",
1853 if (ep->already_seen)
1855 ep->already_seen = 1;
1856 if (ep == &dum->ep[0] && urb->error_count) {
1857 ep->setup_stage = 1; /* a new urb */
1858 urb->error_count = 0;
1860 if (ep->halted && !ep->setup_stage) {
1861 /* NOTE: must not be iso! */
1862 dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1867 /* FIXME make sure both ends agree on maxpacket */
1869 /* handle control requests */
1870 if (ep == &dum->ep[0] && ep->setup_stage) {
1871 struct usb_ctrlrequest setup;
1874 setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1875 /* paranoia, in case of stale queued data */
1876 list_for_each_entry(req, &ep->queue, queue) {
1877 list_del_init(&req->queue);
1878 req->req.status = -EOVERFLOW;
1879 dev_dbg(udc_dev(dum), "stale req = %p\n",
1882 spin_unlock(&dum->lock);
1883 usb_gadget_giveback_request(&ep->ep, &req->req);
1884 spin_lock(&dum->lock);
1885 ep->already_seen = 0;
1889 /* gadget driver never sees set_address or operations
1890 * on standard feature flags. some hardware doesn't
1893 ep->last_io = jiffies;
1894 ep->setup_stage = 0;
1897 value = handle_control_request(dum_hcd, urb, &setup,
1900 /* gadget driver handles all other requests. block
1901 * until setup() returns; no reentrancy issues etc.
1904 ++dum->callback_usage;
1905 spin_unlock(&dum->lock);
1906 value = dum->driver->setup(&dum->gadget,
1908 spin_lock(&dum->lock);
1909 --dum->callback_usage;
1912 /* no delays (max 64KB data stage) */
1914 goto treat_control_like_bulk;
1916 /* error, see below */
1920 if (value != -EOPNOTSUPP)
1921 dev_dbg(udc_dev(dum),
1925 urb->actual_length = 0;
1931 /* non-control requests */
1933 switch (usb_pipetype(urb->pipe)) {
1934 case PIPE_ISOCHRONOUS:
1935 /* FIXME is it urb->interval since the last xfer?
1936 * use urb->iso_frame_desc[i].
1937 * complete whether or not ep has requests queued.
1938 * report random errors, to debug drivers.
1940 limit = max(limit, periodic_bytes(dum, ep));
1944 case PIPE_INTERRUPT:
1945 /* FIXME is it urb->interval since the last xfer?
1946 * this almost certainly polls too fast.
1948 limit = max(limit, periodic_bytes(dum, ep));
1952 treat_control_like_bulk:
1953 ep->last_io = jiffies;
1954 total -= transfer(dum_hcd, urb, ep, limit, &status);
1958 /* incomplete transfer? */
1959 if (status == -EINPROGRESS)
1963 list_del(&urbp->urbp_list);
1966 ep->already_seen = ep->setup_stage = 0;
1968 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1969 spin_unlock(&dum->lock);
1970 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1971 spin_lock(&dum->lock);
1976 if (list_empty(&dum_hcd->urbp_list)) {
1977 usb_put_dev(dum_hcd->udev);
1978 dum_hcd->udev = NULL;
1979 } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1980 /* want a 1 msec delay here */
1981 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1984 spin_unlock_irqrestore(&dum->lock, flags);
1987 /*-------------------------------------------------------------------------*/
1989 #define PORT_C_MASK \
1990 ((USB_PORT_STAT_C_CONNECTION \
1991 | USB_PORT_STAT_C_ENABLE \
1992 | USB_PORT_STAT_C_SUSPEND \
1993 | USB_PORT_STAT_C_OVERCURRENT \
1994 | USB_PORT_STAT_C_RESET) << 16)
1996 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1998 struct dummy_hcd *dum_hcd;
1999 unsigned long flags;
2002 dum_hcd = hcd_to_dummy_hcd(hcd);
2004 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2005 if (!HCD_HW_ACCESSIBLE(hcd))
2008 if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
2009 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2010 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2011 set_link_state(dum_hcd);
2014 if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
2016 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
2017 dum_hcd->port_status);
2019 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
2020 usb_hcd_resume_root_hub(hcd);
2023 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2027 /* usb 3.0 root hub device descriptor */
2029 struct usb_bos_descriptor bos;
2030 struct usb_ss_cap_descriptor ss_cap;
2031 } __packed usb3_bos_desc = {
2034 .bLength = USB_DT_BOS_SIZE,
2035 .bDescriptorType = USB_DT_BOS,
2036 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
2037 .bNumDeviceCaps = 1,
2040 .bLength = USB_DT_USB_SS_CAP_SIZE,
2041 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
2042 .bDevCapabilityType = USB_SS_CAP_TYPE,
2043 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
2044 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
2049 ss_hub_descriptor(struct usb_hub_descriptor *desc)
2051 memset(desc, 0, sizeof *desc);
2052 desc->bDescriptorType = USB_DT_SS_HUB;
2053 desc->bDescLength = 12;
2054 desc->wHubCharacteristics = cpu_to_le16(
2055 HUB_CHAR_INDV_PORT_LPSM |
2056 HUB_CHAR_COMMON_OCPM);
2057 desc->bNbrPorts = 1;
2058 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2059 desc->u.ss.DeviceRemovable = 0;
2062 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2064 memset(desc, 0, sizeof *desc);
2065 desc->bDescriptorType = USB_DT_HUB;
2066 desc->bDescLength = 9;
2067 desc->wHubCharacteristics = cpu_to_le16(
2068 HUB_CHAR_INDV_PORT_LPSM |
2069 HUB_CHAR_COMMON_OCPM);
2070 desc->bNbrPorts = 1;
2071 desc->u.hs.DeviceRemovable[0] = 0;
2072 desc->u.hs.DeviceRemovable[1] = 0xff; /* PortPwrCtrlMask */
2075 static int dummy_hub_control(
2076 struct usb_hcd *hcd,
2083 struct dummy_hcd *dum_hcd;
2085 unsigned long flags;
2087 if (!HCD_HW_ACCESSIBLE(hcd))
2090 dum_hcd = hcd_to_dummy_hcd(hcd);
2092 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2094 case ClearHubFeature:
2096 case ClearPortFeature:
2098 case USB_PORT_FEAT_SUSPEND:
2099 if (hcd->speed == HCD_USB3) {
2100 dev_dbg(dummy_dev(dum_hcd),
2101 "USB_PORT_FEAT_SUSPEND req not "
2102 "supported for USB 3.0 roothub\n");
2105 if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2106 /* 20msec resume signaling */
2107 dum_hcd->resuming = 1;
2108 dum_hcd->re_timeout = jiffies +
2109 msecs_to_jiffies(20);
2112 case USB_PORT_FEAT_POWER:
2113 dev_dbg(dummy_dev(dum_hcd), "power-off\n");
2114 if (hcd->speed == HCD_USB3)
2115 dum_hcd->port_status &= ~USB_SS_PORT_STAT_POWER;
2117 dum_hcd->port_status &= ~USB_PORT_STAT_POWER;
2118 set_link_state(dum_hcd);
2121 dum_hcd->port_status &= ~(1 << wValue);
2122 set_link_state(dum_hcd);
2125 case GetHubDescriptor:
2126 if (hcd->speed == HCD_USB3 &&
2127 (wLength < USB_DT_SS_HUB_SIZE ||
2128 wValue != (USB_DT_SS_HUB << 8))) {
2129 dev_dbg(dummy_dev(dum_hcd),
2130 "Wrong hub descriptor type for "
2131 "USB 3.0 roothub.\n");
2134 if (hcd->speed == HCD_USB3)
2135 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2137 hub_descriptor((struct usb_hub_descriptor *) buf);
2140 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2141 if (hcd->speed != HCD_USB3)
2144 if ((wValue >> 8) != USB_DT_BOS)
2147 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2148 retval = sizeof(usb3_bos_desc);
2152 *(__le32 *) buf = cpu_to_le32(0);
2158 /* whoever resets or resumes must GetPortStatus to
2161 if (dum_hcd->resuming &&
2162 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2163 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2164 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2166 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2167 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2168 dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2169 dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2170 if (dum_hcd->dum->pullup) {
2171 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2173 if (hcd->speed < HCD_USB3) {
2174 switch (dum_hcd->dum->gadget.speed) {
2175 case USB_SPEED_HIGH:
2176 dum_hcd->port_status |=
2177 USB_PORT_STAT_HIGH_SPEED;
2180 dum_hcd->dum->gadget.ep0->
2182 dum_hcd->port_status |=
2183 USB_PORT_STAT_LOW_SPEED;
2186 dum_hcd->dum->gadget.speed =
2193 set_link_state(dum_hcd);
2194 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2195 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2200 case SetPortFeature:
2202 case USB_PORT_FEAT_LINK_STATE:
2203 if (hcd->speed != HCD_USB3) {
2204 dev_dbg(dummy_dev(dum_hcd),
2205 "USB_PORT_FEAT_LINK_STATE req not "
2206 "supported for USB 2.0 roothub\n");
2210 * Since this is dummy we don't have an actual link so
2211 * there is nothing to do for the SET_LINK_STATE cmd
2214 case USB_PORT_FEAT_U1_TIMEOUT:
2215 case USB_PORT_FEAT_U2_TIMEOUT:
2216 /* TODO: add suspend/resume support! */
2217 if (hcd->speed != HCD_USB3) {
2218 dev_dbg(dummy_dev(dum_hcd),
2219 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2220 "supported for USB 2.0 roothub\n");
2224 case USB_PORT_FEAT_SUSPEND:
2225 /* Applicable only for USB2.0 hub */
2226 if (hcd->speed == HCD_USB3) {
2227 dev_dbg(dummy_dev(dum_hcd),
2228 "USB_PORT_FEAT_SUSPEND req not "
2229 "supported for USB 3.0 roothub\n");
2232 if (dum_hcd->active) {
2233 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2235 /* HNP would happen here; for now we
2236 * assume b_bus_req is always true.
2238 set_link_state(dum_hcd);
2239 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2240 & dum_hcd->dum->devstatus) != 0)
2241 dev_dbg(dummy_dev(dum_hcd),
2245 case USB_PORT_FEAT_POWER:
2246 if (hcd->speed == HCD_USB3)
2247 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2249 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2250 set_link_state(dum_hcd);
2252 case USB_PORT_FEAT_BH_PORT_RESET:
2253 /* Applicable only for USB3.0 hub */
2254 if (hcd->speed != HCD_USB3) {
2255 dev_dbg(dummy_dev(dum_hcd),
2256 "USB_PORT_FEAT_BH_PORT_RESET req not "
2257 "supported for USB 2.0 roothub\n");
2261 case USB_PORT_FEAT_RESET:
2262 /* if it's already enabled, disable */
2263 if (hcd->speed == HCD_USB3) {
2264 dum_hcd->port_status = 0;
2265 dum_hcd->port_status =
2266 (USB_SS_PORT_STAT_POWER |
2267 USB_PORT_STAT_CONNECTION |
2268 USB_PORT_STAT_RESET);
2270 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2271 | USB_PORT_STAT_LOW_SPEED
2272 | USB_PORT_STAT_HIGH_SPEED);
2274 * We want to reset device status. All but the
2275 * Self powered feature
2277 dum_hcd->dum->devstatus &=
2278 (1 << USB_DEVICE_SELF_POWERED);
2280 * FIXME USB3.0: what is the correct reset signaling
2281 * interval? Is it still 50msec as for HS?
2283 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2286 if (hcd->speed == HCD_USB3) {
2287 if ((dum_hcd->port_status &
2288 USB_SS_PORT_STAT_POWER) != 0) {
2289 dum_hcd->port_status |= (1 << wValue);
2292 if ((dum_hcd->port_status &
2293 USB_PORT_STAT_POWER) != 0) {
2294 dum_hcd->port_status |= (1 << wValue);
2296 set_link_state(dum_hcd);
2299 case GetPortErrorCount:
2300 if (hcd->speed != HCD_USB3) {
2301 dev_dbg(dummy_dev(dum_hcd),
2302 "GetPortErrorCount req not "
2303 "supported for USB 2.0 roothub\n");
2306 /* We'll always return 0 since this is a dummy hub */
2307 *(__le32 *) buf = cpu_to_le32(0);
2310 if (hcd->speed != HCD_USB3) {
2311 dev_dbg(dummy_dev(dum_hcd),
2312 "SetHubDepth req not supported for "
2313 "USB 2.0 roothub\n");
2318 dev_dbg(dummy_dev(dum_hcd),
2319 "hub control req%04x v%04x i%04x l%d\n",
2320 typeReq, wValue, wIndex, wLength);
2322 /* "protocol stall" on error */
2325 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2327 if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2328 usb_hcd_poll_rh_status(hcd);
2332 static int dummy_bus_suspend(struct usb_hcd *hcd)
2334 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2336 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2338 spin_lock_irq(&dum_hcd->dum->lock);
2339 dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2340 set_link_state(dum_hcd);
2341 hcd->state = HC_STATE_SUSPENDED;
2342 spin_unlock_irq(&dum_hcd->dum->lock);
2346 static int dummy_bus_resume(struct usb_hcd *hcd)
2348 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2351 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2353 spin_lock_irq(&dum_hcd->dum->lock);
2354 if (!HCD_HW_ACCESSIBLE(hcd)) {
2357 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2358 set_link_state(dum_hcd);
2359 if (!list_empty(&dum_hcd->urbp_list))
2360 mod_timer(&dum_hcd->timer, jiffies);
2361 hcd->state = HC_STATE_RUNNING;
2363 spin_unlock_irq(&dum_hcd->dum->lock);
2367 /*-------------------------------------------------------------------------*/
2369 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2371 int ep = usb_pipeendpoint(urb->pipe);
2373 return snprintf(buf, size,
2374 "urb/%p %s ep%d%s%s len %d/%d\n",
2377 switch (urb->dev->speed) {
2381 case USB_SPEED_FULL:
2384 case USB_SPEED_HIGH:
2387 case USB_SPEED_SUPER:
2394 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2396 switch (usb_pipetype(urb->pipe)) { \
2397 case PIPE_CONTROL: \
2403 case PIPE_INTERRUPT: \
2410 urb->actual_length, urb->transfer_buffer_length);
2413 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2416 struct usb_hcd *hcd = dev_get_drvdata(dev);
2417 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2420 unsigned long flags;
2422 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2423 list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2426 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2430 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2434 static DEVICE_ATTR_RO(urbs);
2436 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2438 init_timer(&dum_hcd->timer);
2439 dum_hcd->timer.function = dummy_timer;
2440 dum_hcd->timer.data = (unsigned long)dum_hcd;
2441 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2442 dum_hcd->stream_en_ep = 0;
2443 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2444 dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET_3;
2445 dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2446 dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2447 #ifdef CONFIG_USB_OTG
2448 dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2452 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2453 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2456 static int dummy_start(struct usb_hcd *hcd)
2458 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2461 * MASTER side init ... we emulate a root hub that'll only ever
2462 * talk to one device (the slave side). Also appears in sysfs,
2463 * just like more familiar pci-based HCDs.
2465 if (!usb_hcd_is_primary_hcd(hcd))
2466 return dummy_start_ss(dum_hcd);
2468 spin_lock_init(&dum_hcd->dum->lock);
2469 init_timer(&dum_hcd->timer);
2470 dum_hcd->timer.function = dummy_timer;
2471 dum_hcd->timer.data = (unsigned long)dum_hcd;
2472 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2474 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2476 hcd->power_budget = POWER_BUDGET;
2477 hcd->state = HC_STATE_RUNNING;
2478 hcd->uses_new_polling = 1;
2480 #ifdef CONFIG_USB_OTG
2481 hcd->self.otg_port = 1;
2484 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2485 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2488 static void dummy_stop(struct usb_hcd *hcd)
2490 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2491 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2494 /*-------------------------------------------------------------------------*/
2496 static int dummy_h_get_frame(struct usb_hcd *hcd)
2498 return dummy_g_get_frame(NULL);
2501 static int dummy_setup(struct usb_hcd *hcd)
2505 dum = *((void **)dev_get_platdata(hcd->self.controller));
2506 hcd->self.sg_tablesize = ~0;
2507 if (usb_hcd_is_primary_hcd(hcd)) {
2508 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2509 dum->hs_hcd->dum = dum;
2511 * Mark the first roothub as being USB 2.0.
2512 * The USB 3.0 roothub will be registered later by
2515 hcd->speed = HCD_USB2;
2516 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2518 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2519 dum->ss_hcd->dum = dum;
2520 hcd->speed = HCD_USB3;
2521 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2526 /* Change a group of bulk endpoints to support multiple stream IDs */
2527 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2528 struct usb_host_endpoint **eps, unsigned int num_eps,
2529 unsigned int num_streams, gfp_t mem_flags)
2531 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2532 unsigned long flags;
2534 int ret_streams = num_streams;
2541 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2542 for (i = 0; i < num_eps; i++) {
2543 index = dummy_get_ep_idx(&eps[i]->desc);
2544 if ((1 << index) & dum_hcd->stream_en_ep) {
2545 ret_streams = -EINVAL;
2548 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2550 ret_streams = -EINVAL;
2553 if (max_stream < ret_streams) {
2554 dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2556 eps[i]->desc.bEndpointAddress,
2558 ret_streams = max_stream;
2562 for (i = 0; i < num_eps; i++) {
2563 index = dummy_get_ep_idx(&eps[i]->desc);
2564 dum_hcd->stream_en_ep |= 1 << index;
2565 set_max_streams_for_pipe(dum_hcd,
2566 usb_endpoint_num(&eps[i]->desc), ret_streams);
2569 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2573 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2574 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2575 struct usb_host_endpoint **eps, unsigned int num_eps,
2578 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2579 unsigned long flags;
2584 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2585 for (i = 0; i < num_eps; i++) {
2586 index = dummy_get_ep_idx(&eps[i]->desc);
2587 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2593 for (i = 0; i < num_eps; i++) {
2594 index = dummy_get_ep_idx(&eps[i]->desc);
2595 dum_hcd->stream_en_ep &= ~(1 << index);
2596 set_max_streams_for_pipe(dum_hcd,
2597 usb_endpoint_num(&eps[i]->desc), 0);
2601 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2605 static struct hc_driver dummy_hcd = {
2606 .description = (char *) driver_name,
2607 .product_desc = "Dummy host controller",
2608 .hcd_priv_size = sizeof(struct dummy_hcd),
2610 .reset = dummy_setup,
2611 .start = dummy_start,
2614 .urb_enqueue = dummy_urb_enqueue,
2615 .urb_dequeue = dummy_urb_dequeue,
2617 .get_frame_number = dummy_h_get_frame,
2619 .hub_status_data = dummy_hub_status,
2620 .hub_control = dummy_hub_control,
2621 .bus_suspend = dummy_bus_suspend,
2622 .bus_resume = dummy_bus_resume,
2624 .alloc_streams = dummy_alloc_streams,
2625 .free_streams = dummy_free_streams,
2628 static int dummy_hcd_probe(struct platform_device *pdev)
2631 struct usb_hcd *hs_hcd;
2632 struct usb_hcd *ss_hcd;
2635 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2636 dum = *((void **)dev_get_platdata(&pdev->dev));
2638 if (mod_data.is_super_speed)
2639 dummy_hcd.flags = HCD_USB3 | HCD_SHARED;
2640 else if (mod_data.is_high_speed)
2641 dummy_hcd.flags = HCD_USB2;
2643 dummy_hcd.flags = HCD_USB11;
2644 hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2649 retval = usb_add_hcd(hs_hcd, 0, 0);
2653 if (mod_data.is_super_speed) {
2654 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2655 dev_name(&pdev->dev), hs_hcd);
2658 goto dealloc_usb2_hcd;
2661 retval = usb_add_hcd(ss_hcd, 0, 0);
2668 usb_put_hcd(ss_hcd);
2670 usb_remove_hcd(hs_hcd);
2672 usb_put_hcd(hs_hcd);
2673 dum->hs_hcd = dum->ss_hcd = NULL;
2677 static int dummy_hcd_remove(struct platform_device *pdev)
2681 dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2684 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2685 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2688 usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2689 usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2697 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2699 struct usb_hcd *hcd;
2700 struct dummy_hcd *dum_hcd;
2703 dev_dbg(&pdev->dev, "%s\n", __func__);
2705 hcd = platform_get_drvdata(pdev);
2706 dum_hcd = hcd_to_dummy_hcd(hcd);
2707 if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2708 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2711 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2715 static int dummy_hcd_resume(struct platform_device *pdev)
2717 struct usb_hcd *hcd;
2719 dev_dbg(&pdev->dev, "%s\n", __func__);
2721 hcd = platform_get_drvdata(pdev);
2722 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2723 usb_hcd_poll_rh_status(hcd);
2727 static struct platform_driver dummy_hcd_driver = {
2728 .probe = dummy_hcd_probe,
2729 .remove = dummy_hcd_remove,
2730 .suspend = dummy_hcd_suspend,
2731 .resume = dummy_hcd_resume,
2733 .name = (char *) driver_name,
2737 /*-------------------------------------------------------------------------*/
2738 #define MAX_NUM_UDC 2
2739 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2740 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2742 static int __init init(void)
2744 int retval = -ENOMEM;
2746 struct dummy *dum[MAX_NUM_UDC] = {};
2751 if (!mod_data.is_high_speed && mod_data.is_super_speed)
2754 if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2755 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2760 for (i = 0; i < mod_data.num; i++) {
2761 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2762 if (!the_hcd_pdev[i]) {
2765 platform_device_put(the_hcd_pdev[i--]);
2769 for (i = 0; i < mod_data.num; i++) {
2770 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2771 if (!the_udc_pdev[i]) {
2774 platform_device_put(the_udc_pdev[i--]);
2778 for (i = 0; i < mod_data.num; i++) {
2779 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2784 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2788 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2794 retval = platform_driver_register(&dummy_hcd_driver);
2797 retval = platform_driver_register(&dummy_udc_driver);
2799 goto err_register_udc_driver;
2801 for (i = 0; i < mod_data.num; i++) {
2802 retval = platform_device_add(the_hcd_pdev[i]);
2806 platform_device_del(the_hcd_pdev[i--]);
2810 for (i = 0; i < mod_data.num; i++) {
2811 if (!dum[i]->hs_hcd ||
2812 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2814 * The hcd was added successfully but its probe
2815 * function failed for some reason.
2822 for (i = 0; i < mod_data.num; i++) {
2823 retval = platform_device_add(the_udc_pdev[i]);
2827 platform_device_del(the_udc_pdev[i]);
2832 for (i = 0; i < mod_data.num; i++) {
2833 if (!platform_get_drvdata(the_udc_pdev[i])) {
2835 * The udc was added successfully but its probe
2836 * function failed for some reason.
2845 for (i = 0; i < mod_data.num; i++)
2846 platform_device_del(the_udc_pdev[i]);
2848 for (i = 0; i < mod_data.num; i++)
2849 platform_device_del(the_hcd_pdev[i]);
2851 platform_driver_unregister(&dummy_udc_driver);
2852 err_register_udc_driver:
2853 platform_driver_unregister(&dummy_hcd_driver);
2855 for (i = 0; i < mod_data.num; i++)
2857 for (i = 0; i < mod_data.num; i++)
2858 platform_device_put(the_udc_pdev[i]);
2860 for (i = 0; i < mod_data.num; i++)
2861 platform_device_put(the_hcd_pdev[i]);
2866 static void __exit cleanup(void)
2870 for (i = 0; i < mod_data.num; i++) {
2873 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2875 platform_device_unregister(the_udc_pdev[i]);
2876 platform_device_unregister(the_hcd_pdev[i]);
2879 platform_driver_unregister(&dummy_udc_driver);
2880 platform_driver_unregister(&dummy_hcd_driver);
2882 module_exit(cleanup);