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 list_for_each_entry(ep
, &dum
->gadget
.ep_list
, ep
.ep_list
)
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
) & 0x7ff;
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
,
651 struct dummy_request
*req
;
655 ep
= usb_ep_to_dummy_ep(_ep
);
657 req
= kzalloc(sizeof(*req
), mem_flags
);
660 INIT_LIST_HEAD(&req
->queue
);
664 static void dummy_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
666 struct dummy_request
*req
;
673 req
= usb_request_to_dummy_request(_req
);
674 WARN_ON(!list_empty(&req
->queue
));
678 static void fifo_complete(struct usb_ep
*ep
, struct usb_request
*req
)
682 static int dummy_queue(struct usb_ep
*_ep
, struct usb_request
*_req
,
686 struct dummy_request
*req
;
688 struct dummy_hcd
*dum_hcd
;
691 req
= usb_request_to_dummy_request(_req
);
692 if (!_req
|| !list_empty(&req
->queue
) || !_req
->complete
)
695 ep
= usb_ep_to_dummy_ep(_ep
);
696 if (!_ep
|| (!ep
->desc
&& _ep
->name
!= ep0name
))
699 dum
= ep_to_dummy(ep
);
700 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
701 if (!dum
->driver
|| !is_enabled(dum_hcd
))
705 dev_dbg(udc_dev(dum
), "ep %p queue req %p to %s, len %d buf %p\n",
706 ep
, _req
, _ep
->name
, _req
->length
, _req
->buf
);
708 _req
->status
= -EINPROGRESS
;
710 spin_lock_irqsave(&dum
->lock
, flags
);
712 /* implement an emulated single-request FIFO */
713 if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
714 list_empty(&dum
->fifo_req
.queue
) &&
715 list_empty(&ep
->queue
) &&
716 _req
->length
<= FIFO_SIZE
) {
717 req
= &dum
->fifo_req
;
719 req
->req
.buf
= dum
->fifo_buf
;
720 memcpy(dum
->fifo_buf
, _req
->buf
, _req
->length
);
721 req
->req
.context
= dum
;
722 req
->req
.complete
= fifo_complete
;
724 list_add_tail(&req
->queue
, &ep
->queue
);
725 spin_unlock(&dum
->lock
);
726 _req
->actual
= _req
->length
;
728 usb_gadget_giveback_request(_ep
, _req
);
729 spin_lock(&dum
->lock
);
731 list_add_tail(&req
->queue
, &ep
->queue
);
732 spin_unlock_irqrestore(&dum
->lock
, flags
);
734 /* real hardware would likely enable transfers here, in case
735 * it'd been left NAKing.
740 static int dummy_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
744 int retval
= -EINVAL
;
746 struct dummy_request
*req
= NULL
;
750 ep
= usb_ep_to_dummy_ep(_ep
);
751 dum
= ep_to_dummy(ep
);
756 local_irq_save(flags
);
757 spin_lock(&dum
->lock
);
758 list_for_each_entry(req
, &ep
->queue
, queue
) {
759 if (&req
->req
== _req
) {
760 list_del_init(&req
->queue
);
761 _req
->status
= -ECONNRESET
;
766 spin_unlock(&dum
->lock
);
769 dev_dbg(udc_dev(dum
),
770 "dequeued req %p from %s, len %d buf %p\n",
771 req
, _ep
->name
, _req
->length
, _req
->buf
);
772 usb_gadget_giveback_request(_ep
, _req
);
774 local_irq_restore(flags
);
779 dummy_set_halt_and_wedge(struct usb_ep
*_ep
, int value
, int wedged
)
786 ep
= usb_ep_to_dummy_ep(_ep
);
787 dum
= ep_to_dummy(ep
);
791 ep
->halted
= ep
->wedged
= 0;
792 else if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
793 !list_empty(&ep
->queue
))
800 /* FIXME clear emulated data toggle too */
805 dummy_set_halt(struct usb_ep
*_ep
, int value
)
807 return dummy_set_halt_and_wedge(_ep
, value
, 0);
810 static int dummy_set_wedge(struct usb_ep
*_ep
)
812 if (!_ep
|| _ep
->name
== ep0name
)
814 return dummy_set_halt_and_wedge(_ep
, 1, 1);
817 static const struct usb_ep_ops dummy_ep_ops
= {
818 .enable
= dummy_enable
,
819 .disable
= dummy_disable
,
821 .alloc_request
= dummy_alloc_request
,
822 .free_request
= dummy_free_request
,
824 .queue
= dummy_queue
,
825 .dequeue
= dummy_dequeue
,
827 .set_halt
= dummy_set_halt
,
828 .set_wedge
= dummy_set_wedge
,
831 /*-------------------------------------------------------------------------*/
833 /* there are both host and device side versions of this call ... */
834 static int dummy_g_get_frame(struct usb_gadget
*_gadget
)
836 struct timespec64 ts64
;
838 ktime_get_ts64(&ts64
);
839 return ts64
.tv_nsec
/ NSEC_PER_MSEC
;
842 static int dummy_wakeup(struct usb_gadget
*_gadget
)
844 struct dummy_hcd
*dum_hcd
;
846 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
847 if (!(dum_hcd
->dum
->devstatus
& ((1 << USB_DEVICE_B_HNP_ENABLE
)
848 | (1 << USB_DEVICE_REMOTE_WAKEUP
))))
850 if ((dum_hcd
->port_status
& USB_PORT_STAT_CONNECTION
) == 0)
852 if ((dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) == 0 &&
853 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
856 /* FIXME: What if the root hub is suspended but the port isn't? */
858 /* hub notices our request, issues downstream resume, etc */
859 dum_hcd
->resuming
= 1;
860 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(20);
861 mod_timer(&dummy_hcd_to_hcd(dum_hcd
)->rh_timer
, dum_hcd
->re_timeout
);
865 static int dummy_set_selfpowered(struct usb_gadget
*_gadget
, int value
)
869 _gadget
->is_selfpowered
= (value
!= 0);
870 dum
= gadget_to_dummy_hcd(_gadget
)->dum
;
872 dum
->devstatus
|= (1 << USB_DEVICE_SELF_POWERED
);
874 dum
->devstatus
&= ~(1 << USB_DEVICE_SELF_POWERED
);
878 static void dummy_udc_update_ep0(struct dummy
*dum
)
880 if (dum
->gadget
.speed
== USB_SPEED_SUPER
)
881 dum
->ep
[0].ep
.maxpacket
= 9;
883 dum
->ep
[0].ep
.maxpacket
= 64;
886 static int dummy_pullup(struct usb_gadget
*_gadget
, int value
)
888 struct dummy_hcd
*dum_hcd
;
892 dum
= gadget_dev_to_dummy(&_gadget
->dev
);
894 if (value
&& dum
->driver
) {
895 if (mod_data
.is_super_speed
)
896 dum
->gadget
.speed
= dum
->driver
->max_speed
;
897 else if (mod_data
.is_high_speed
)
898 dum
->gadget
.speed
= min_t(u8
, USB_SPEED_HIGH
,
899 dum
->driver
->max_speed
);
901 dum
->gadget
.speed
= USB_SPEED_FULL
;
902 dummy_udc_update_ep0(dum
);
904 if (dum
->gadget
.speed
< dum
->driver
->max_speed
)
905 dev_dbg(udc_dev(dum
), "This device can perform faster"
906 " if you connect it to a %s port...\n",
907 usb_speed_string(dum
->driver
->max_speed
));
909 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
911 spin_lock_irqsave(&dum
->lock
, flags
);
912 dum
->pullup
= (value
!= 0);
913 set_link_state(dum_hcd
);
914 spin_unlock_irqrestore(&dum
->lock
, flags
);
916 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
920 static int dummy_udc_start(struct usb_gadget
*g
,
921 struct usb_gadget_driver
*driver
);
922 static int dummy_udc_stop(struct usb_gadget
*g
);
924 static const struct usb_gadget_ops dummy_ops
= {
925 .get_frame
= dummy_g_get_frame
,
926 .wakeup
= dummy_wakeup
,
927 .set_selfpowered
= dummy_set_selfpowered
,
928 .pullup
= dummy_pullup
,
929 .udc_start
= dummy_udc_start
,
930 .udc_stop
= dummy_udc_stop
,
933 /*-------------------------------------------------------------------------*/
935 /* "function" sysfs attribute */
936 static ssize_t
function_show(struct device
*dev
, struct device_attribute
*attr
,
939 struct dummy
*dum
= gadget_dev_to_dummy(dev
);
941 if (!dum
->driver
|| !dum
->driver
->function
)
943 return scnprintf(buf
, PAGE_SIZE
, "%s\n", dum
->driver
->function
);
945 static DEVICE_ATTR_RO(function
);
947 /*-------------------------------------------------------------------------*/
950 * Driver registration/unregistration.
952 * This is basically hardware-specific; there's usually only one real USB
953 * device (not host) controller since that's how USB devices are intended
954 * to work. So most implementations of these api calls will rely on the
955 * fact that only one driver will ever bind to the hardware. But curious
956 * hardware can be built with discrete components, so the gadget API doesn't
957 * require that assumption.
959 * For this emulator, it might be convenient to create a usb slave device
960 * for each driver that registers: just add to a big root hub.
963 static int dummy_udc_start(struct usb_gadget
*g
,
964 struct usb_gadget_driver
*driver
)
966 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
967 struct dummy
*dum
= dum_hcd
->dum
;
969 if (driver
->max_speed
== USB_SPEED_UNKNOWN
)
973 * SLAVE side init ... the layer above hardware, which
974 * can't enumerate without help from the driver we're binding.
978 dum
->driver
= driver
;
983 static int dummy_udc_stop(struct usb_gadget
*g
)
985 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
986 struct dummy
*dum
= dum_hcd
->dum
;
995 /* The gadget structure is stored inside the hcd structure and will be
996 * released along with it. */
997 static void init_dummy_udc_hw(struct dummy
*dum
)
1001 INIT_LIST_HEAD(&dum
->gadget
.ep_list
);
1002 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1003 struct dummy_ep
*ep
= &dum
->ep
[i
];
1005 if (!ep_info
[i
].name
)
1007 ep
->ep
.name
= ep_info
[i
].name
;
1008 ep
->ep
.caps
= ep_info
[i
].caps
;
1009 ep
->ep
.ops
= &dummy_ep_ops
;
1010 list_add_tail(&ep
->ep
.ep_list
, &dum
->gadget
.ep_list
);
1011 ep
->halted
= ep
->wedged
= ep
->already_seen
=
1012 ep
->setup_stage
= 0;
1013 usb_ep_set_maxpacket_limit(&ep
->ep
, ~0);
1014 ep
->ep
.max_streams
= 16;
1015 ep
->last_io
= jiffies
;
1016 ep
->gadget
= &dum
->gadget
;
1018 INIT_LIST_HEAD(&ep
->queue
);
1021 dum
->gadget
.ep0
= &dum
->ep
[0].ep
;
1022 list_del_init(&dum
->ep
[0].ep
.ep_list
);
1023 INIT_LIST_HEAD(&dum
->fifo_req
.queue
);
1025 #ifdef CONFIG_USB_OTG
1026 dum
->gadget
.is_otg
= 1;
1030 static int dummy_udc_probe(struct platform_device
*pdev
)
1035 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
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(ep
->desc
);
1489 tmp
= (tmp
>> 11) & 0x03;
1490 tmp
*= 8 /* applies to entire frame */;
1491 limit
+= limit
* tmp
;
1493 if (dum
->gadget
.speed
== USB_SPEED_SUPER
) {
1494 switch (usb_endpoint_type(ep
->desc
)) {
1495 case USB_ENDPOINT_XFER_ISOC
:
1496 /* Sec. 4.4.8.2 USB3.0 Spec */
1497 limit
= 3 * 16 * 1024 * 8;
1499 case USB_ENDPOINT_XFER_INT
:
1500 /* Sec. 4.4.7.2 USB3.0 Spec */
1501 limit
= 3 * 1024 * 8;
1503 case USB_ENDPOINT_XFER_BULK
:
1511 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1512 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1513 USB_PORT_STAT_SUSPEND)) \
1514 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1516 static struct dummy_ep
*find_endpoint(struct dummy
*dum
, u8 address
)
1520 if (!is_active((dum
->gadget
.speed
== USB_SPEED_SUPER
?
1521 dum
->ss_hcd
: dum
->hs_hcd
)))
1523 if ((address
& ~USB_DIR_IN
) == 0)
1525 for (i
= 1; i
< DUMMY_ENDPOINTS
; i
++) {
1526 struct dummy_ep
*ep
= &dum
->ep
[i
];
1530 if (ep
->desc
->bEndpointAddress
== address
)
1538 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1539 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1540 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1541 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1542 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1543 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1547 * handle_control_request() - handles all control transfers
1548 * @dum: pointer to dummy (the_controller)
1549 * @urb: the urb request to handle
1550 * @setup: pointer to the setup data for a USB device control
1552 * @status: pointer to request handling status
1554 * Return 0 - if the request was handled
1555 * 1 - if the request wasn't handles
1556 * error code on error
1558 static int handle_control_request(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1559 struct usb_ctrlrequest
*setup
,
1562 struct dummy_ep
*ep2
;
1563 struct dummy
*dum
= dum_hcd
->dum
;
1568 w_index
= le16_to_cpu(setup
->wIndex
);
1569 w_value
= le16_to_cpu(setup
->wValue
);
1570 switch (setup
->bRequest
) {
1571 case USB_REQ_SET_ADDRESS
:
1572 if (setup
->bRequestType
!= Dev_Request
)
1574 dum
->address
= w_value
;
1576 dev_dbg(udc_dev(dum
), "set_address = %d\n",
1580 case USB_REQ_SET_FEATURE
:
1581 if (setup
->bRequestType
== Dev_Request
) {
1584 case USB_DEVICE_REMOTE_WAKEUP
:
1586 case USB_DEVICE_B_HNP_ENABLE
:
1587 dum
->gadget
.b_hnp_enable
= 1;
1589 case USB_DEVICE_A_HNP_SUPPORT
:
1590 dum
->gadget
.a_hnp_support
= 1;
1592 case USB_DEVICE_A_ALT_HNP_SUPPORT
:
1593 dum
->gadget
.a_alt_hnp_support
= 1;
1595 case USB_DEVICE_U1_ENABLE
:
1596 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1598 w_value
= USB_DEV_STAT_U1_ENABLED
;
1600 ret_val
= -EOPNOTSUPP
;
1602 case USB_DEVICE_U2_ENABLE
:
1603 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1605 w_value
= USB_DEV_STAT_U2_ENABLED
;
1607 ret_val
= -EOPNOTSUPP
;
1609 case USB_DEVICE_LTM_ENABLE
:
1610 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1612 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1614 ret_val
= -EOPNOTSUPP
;
1617 ret_val
= -EOPNOTSUPP
;
1620 dum
->devstatus
|= (1 << w_value
);
1623 } else if (setup
->bRequestType
== Ep_Request
) {
1625 ep2
= find_endpoint(dum
, w_index
);
1626 if (!ep2
|| ep2
->ep
.name
== ep0name
) {
1627 ret_val
= -EOPNOTSUPP
;
1635 case USB_REQ_CLEAR_FEATURE
:
1636 if (setup
->bRequestType
== Dev_Request
) {
1639 case USB_DEVICE_REMOTE_WAKEUP
:
1640 w_value
= USB_DEVICE_REMOTE_WAKEUP
;
1642 case USB_DEVICE_U1_ENABLE
:
1643 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1645 w_value
= USB_DEV_STAT_U1_ENABLED
;
1647 ret_val
= -EOPNOTSUPP
;
1649 case USB_DEVICE_U2_ENABLE
:
1650 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1652 w_value
= USB_DEV_STAT_U2_ENABLED
;
1654 ret_val
= -EOPNOTSUPP
;
1656 case USB_DEVICE_LTM_ENABLE
:
1657 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1659 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1661 ret_val
= -EOPNOTSUPP
;
1664 ret_val
= -EOPNOTSUPP
;
1668 dum
->devstatus
&= ~(1 << w_value
);
1671 } else if (setup
->bRequestType
== Ep_Request
) {
1673 ep2
= find_endpoint(dum
, w_index
);
1675 ret_val
= -EOPNOTSUPP
;
1684 case USB_REQ_GET_STATUS
:
1685 if (setup
->bRequestType
== Dev_InRequest
1686 || setup
->bRequestType
== Intf_InRequest
1687 || setup
->bRequestType
== Ep_InRequest
) {
1690 * device: remote wakeup, selfpowered
1691 * interface: nothing
1694 buf
= (char *)urb
->transfer_buffer
;
1695 if (urb
->transfer_buffer_length
> 0) {
1696 if (setup
->bRequestType
== Ep_InRequest
) {
1697 ep2
= find_endpoint(dum
, w_index
);
1699 ret_val
= -EOPNOTSUPP
;
1702 buf
[0] = ep2
->halted
;
1703 } else if (setup
->bRequestType
==
1705 buf
[0] = (u8
)dum
->devstatus
;
1709 if (urb
->transfer_buffer_length
> 1)
1711 urb
->actual_length
= min_t(u32
, 2,
1712 urb
->transfer_buffer_length
);
1721 /* drive both sides of the transfers; looks like irq handlers to
1722 * both drivers except the callbacks aren't in_irq().
1724 static void dummy_timer(unsigned long _dum_hcd
)
1726 struct dummy_hcd
*dum_hcd
= (struct dummy_hcd
*) _dum_hcd
;
1727 struct dummy
*dum
= dum_hcd
->dum
;
1728 struct urbp
*urbp
, *tmp
;
1729 unsigned long flags
;
1733 /* simplistic model for one frame's bandwidth */
1734 switch (dum
->gadget
.speed
) {
1736 total
= 8/*bytes*/ * 12/*packets*/;
1738 case USB_SPEED_FULL
:
1739 total
= 64/*bytes*/ * 19/*packets*/;
1741 case USB_SPEED_HIGH
:
1742 total
= 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1744 case USB_SPEED_SUPER
:
1745 /* Bus speed is 500000 bytes/ms, so use a little less */
1749 dev_err(dummy_dev(dum_hcd
), "bogus device speed\n");
1753 /* FIXME if HZ != 1000 this will probably misbehave ... */
1755 /* look at each urb queued by the host side driver */
1756 spin_lock_irqsave(&dum
->lock
, flags
);
1758 if (!dum_hcd
->udev
) {
1759 dev_err(dummy_dev(dum_hcd
),
1760 "timer fired with no URBs pending?\n");
1761 spin_unlock_irqrestore(&dum
->lock
, flags
);
1765 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1766 if (!ep_info
[i
].name
)
1768 dum
->ep
[i
].already_seen
= 0;
1772 list_for_each_entry_safe(urbp
, tmp
, &dum_hcd
->urbp_list
, urbp_list
) {
1774 struct dummy_request
*req
;
1776 struct dummy_ep
*ep
= NULL
;
1778 int status
= -EINPROGRESS
;
1783 else if (dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
)
1785 type
= usb_pipetype(urb
->pipe
);
1787 /* used up this frame's non-periodic bandwidth?
1788 * FIXME there's infinite bandwidth for control and
1789 * periodic transfers ... unrealistic.
1791 if (total
<= 0 && type
== PIPE_BULK
)
1794 /* find the gadget's ep for this request (if configured) */
1795 address
= usb_pipeendpoint (urb
->pipe
);
1796 if (usb_pipein(urb
->pipe
))
1797 address
|= USB_DIR_IN
;
1798 ep
= find_endpoint(dum
, address
);
1800 /* set_configuration() disagreement */
1801 dev_dbg(dummy_dev(dum_hcd
),
1802 "no ep configured for urb %p\n",
1808 if (ep
->already_seen
)
1810 ep
->already_seen
= 1;
1811 if (ep
== &dum
->ep
[0] && urb
->error_count
) {
1812 ep
->setup_stage
= 1; /* a new urb */
1813 urb
->error_count
= 0;
1815 if (ep
->halted
&& !ep
->setup_stage
) {
1816 /* NOTE: must not be iso! */
1817 dev_dbg(dummy_dev(dum_hcd
), "ep %s halted, urb %p\n",
1822 /* FIXME make sure both ends agree on maxpacket */
1824 /* handle control requests */
1825 if (ep
== &dum
->ep
[0] && ep
->setup_stage
) {
1826 struct usb_ctrlrequest setup
;
1829 setup
= *(struct usb_ctrlrequest
*) urb
->setup_packet
;
1830 /* paranoia, in case of stale queued data */
1831 list_for_each_entry(req
, &ep
->queue
, queue
) {
1832 list_del_init(&req
->queue
);
1833 req
->req
.status
= -EOVERFLOW
;
1834 dev_dbg(udc_dev(dum
), "stale req = %p\n",
1837 spin_unlock(&dum
->lock
);
1838 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1839 spin_lock(&dum
->lock
);
1840 ep
->already_seen
= 0;
1844 /* gadget driver never sees set_address or operations
1845 * on standard feature flags. some hardware doesn't
1848 ep
->last_io
= jiffies
;
1849 ep
->setup_stage
= 0;
1852 value
= handle_control_request(dum_hcd
, urb
, &setup
,
1855 /* gadget driver handles all other requests. block
1856 * until setup() returns; no reentrancy issues etc.
1859 spin_unlock(&dum
->lock
);
1860 value
= dum
->driver
->setup(&dum
->gadget
,
1862 spin_lock(&dum
->lock
);
1865 /* no delays (max 64KB data stage) */
1867 goto treat_control_like_bulk
;
1869 /* error, see below */
1873 if (value
!= -EOPNOTSUPP
)
1874 dev_dbg(udc_dev(dum
),
1878 urb
->actual_length
= 0;
1884 /* non-control requests */
1886 switch (usb_pipetype(urb
->pipe
)) {
1887 case PIPE_ISOCHRONOUS
:
1888 /* FIXME is it urb->interval since the last xfer?
1889 * use urb->iso_frame_desc[i].
1890 * complete whether or not ep has requests queued.
1891 * report random errors, to debug drivers.
1893 limit
= max(limit
, periodic_bytes(dum
, ep
));
1897 case PIPE_INTERRUPT
:
1898 /* FIXME is it urb->interval since the last xfer?
1899 * this almost certainly polls too fast.
1901 limit
= max(limit
, periodic_bytes(dum
, ep
));
1905 treat_control_like_bulk
:
1906 ep
->last_io
= jiffies
;
1907 total
-= transfer(dum_hcd
, urb
, ep
, limit
, &status
);
1911 /* incomplete transfer? */
1912 if (status
== -EINPROGRESS
)
1916 list_del(&urbp
->urbp_list
);
1919 ep
->already_seen
= ep
->setup_stage
= 0;
1921 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd
), urb
);
1922 spin_unlock(&dum
->lock
);
1923 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd
), urb
, status
);
1924 spin_lock(&dum
->lock
);
1929 if (list_empty(&dum_hcd
->urbp_list
)) {
1930 usb_put_dev(dum_hcd
->udev
);
1931 dum_hcd
->udev
= NULL
;
1932 } else if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
1933 /* want a 1 msec delay here */
1934 mod_timer(&dum_hcd
->timer
, jiffies
+ msecs_to_jiffies(1));
1937 spin_unlock_irqrestore(&dum
->lock
, flags
);
1940 /*-------------------------------------------------------------------------*/
1942 #define PORT_C_MASK \
1943 ((USB_PORT_STAT_C_CONNECTION \
1944 | USB_PORT_STAT_C_ENABLE \
1945 | USB_PORT_STAT_C_SUSPEND \
1946 | USB_PORT_STAT_C_OVERCURRENT \
1947 | USB_PORT_STAT_C_RESET) << 16)
1949 static int dummy_hub_status(struct usb_hcd
*hcd
, char *buf
)
1951 struct dummy_hcd
*dum_hcd
;
1952 unsigned long flags
;
1955 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1957 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1958 if (!HCD_HW_ACCESSIBLE(hcd
))
1961 if (dum_hcd
->resuming
&& time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
1962 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
1963 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
1964 set_link_state(dum_hcd
);
1967 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0) {
1969 dev_dbg(dummy_dev(dum_hcd
), "port status 0x%08x has changes\n",
1970 dum_hcd
->port_status
);
1972 if (dum_hcd
->rh_state
== DUMMY_RH_SUSPENDED
)
1973 usb_hcd_resume_root_hub(hcd
);
1976 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1980 /* usb 3.0 root hub device descriptor */
1982 struct usb_bos_descriptor bos
;
1983 struct usb_ss_cap_descriptor ss_cap
;
1984 } __packed usb3_bos_desc
= {
1987 .bLength
= USB_DT_BOS_SIZE
,
1988 .bDescriptorType
= USB_DT_BOS
,
1989 .wTotalLength
= cpu_to_le16(sizeof(usb3_bos_desc
)),
1990 .bNumDeviceCaps
= 1,
1993 .bLength
= USB_DT_USB_SS_CAP_SIZE
,
1994 .bDescriptorType
= USB_DT_DEVICE_CAPABILITY
,
1995 .bDevCapabilityType
= USB_SS_CAP_TYPE
,
1996 .wSpeedSupported
= cpu_to_le16(USB_5GBPS_OPERATION
),
1997 .bFunctionalitySupport
= ilog2(USB_5GBPS_OPERATION
),
2002 ss_hub_descriptor(struct usb_hub_descriptor
*desc
)
2004 memset(desc
, 0, sizeof *desc
);
2005 desc
->bDescriptorType
= USB_DT_SS_HUB
;
2006 desc
->bDescLength
= 12;
2007 desc
->wHubCharacteristics
= cpu_to_le16(
2008 HUB_CHAR_INDV_PORT_LPSM
|
2009 HUB_CHAR_COMMON_OCPM
);
2010 desc
->bNbrPorts
= 1;
2011 desc
->u
.ss
.bHubHdrDecLat
= 0x04; /* Worst case: 0.4 micro sec*/
2012 desc
->u
.ss
.DeviceRemovable
= 0xffff;
2015 static inline void hub_descriptor(struct usb_hub_descriptor
*desc
)
2017 memset(desc
, 0, sizeof *desc
);
2018 desc
->bDescriptorType
= USB_DT_HUB
;
2019 desc
->bDescLength
= 9;
2020 desc
->wHubCharacteristics
= cpu_to_le16(
2021 HUB_CHAR_INDV_PORT_LPSM
|
2022 HUB_CHAR_COMMON_OCPM
);
2023 desc
->bNbrPorts
= 1;
2024 desc
->u
.hs
.DeviceRemovable
[0] = 0xff;
2025 desc
->u
.hs
.DeviceRemovable
[1] = 0xff;
2028 static int dummy_hub_control(
2029 struct usb_hcd
*hcd
,
2036 struct dummy_hcd
*dum_hcd
;
2038 unsigned long flags
;
2040 if (!HCD_HW_ACCESSIBLE(hcd
))
2043 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2045 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2047 case ClearHubFeature
:
2049 case ClearPortFeature
:
2051 case USB_PORT_FEAT_SUSPEND
:
2052 if (hcd
->speed
== HCD_USB3
) {
2053 dev_dbg(dummy_dev(dum_hcd
),
2054 "USB_PORT_FEAT_SUSPEND req not "
2055 "supported for USB 3.0 roothub\n");
2058 if (dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) {
2059 /* 20msec resume signaling */
2060 dum_hcd
->resuming
= 1;
2061 dum_hcd
->re_timeout
= jiffies
+
2062 msecs_to_jiffies(20);
2065 case USB_PORT_FEAT_POWER
:
2066 if (hcd
->speed
== HCD_USB3
) {
2067 if (dum_hcd
->port_status
& USB_PORT_STAT_POWER
)
2068 dev_dbg(dummy_dev(dum_hcd
),
2071 if (dum_hcd
->port_status
&
2072 USB_SS_PORT_STAT_POWER
)
2073 dev_dbg(dummy_dev(dum_hcd
),
2077 dum_hcd
->port_status
&= ~(1 << wValue
);
2078 set_link_state(dum_hcd
);
2081 case GetHubDescriptor
:
2082 if (hcd
->speed
== HCD_USB3
&&
2083 (wLength
< USB_DT_SS_HUB_SIZE
||
2084 wValue
!= (USB_DT_SS_HUB
<< 8))) {
2085 dev_dbg(dummy_dev(dum_hcd
),
2086 "Wrong hub descriptor type for "
2087 "USB 3.0 roothub.\n");
2090 if (hcd
->speed
== HCD_USB3
)
2091 ss_hub_descriptor((struct usb_hub_descriptor
*) buf
);
2093 hub_descriptor((struct usb_hub_descriptor
*) buf
);
2096 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
2097 if (hcd
->speed
!= HCD_USB3
)
2100 if ((wValue
>> 8) != USB_DT_BOS
)
2103 memcpy(buf
, &usb3_bos_desc
, sizeof(usb3_bos_desc
));
2104 retval
= sizeof(usb3_bos_desc
);
2108 *(__le32
*) buf
= cpu_to_le32(0);
2114 /* whoever resets or resumes must GetPortStatus to
2117 if (dum_hcd
->resuming
&&
2118 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2119 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
2120 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
2122 if ((dum_hcd
->port_status
& USB_PORT_STAT_RESET
) != 0 &&
2123 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2124 dum_hcd
->port_status
|= (USB_PORT_STAT_C_RESET
<< 16);
2125 dum_hcd
->port_status
&= ~USB_PORT_STAT_RESET
;
2126 if (dum_hcd
->dum
->pullup
) {
2127 dum_hcd
->port_status
|= USB_PORT_STAT_ENABLE
;
2129 if (hcd
->speed
< HCD_USB3
) {
2130 switch (dum_hcd
->dum
->gadget
.speed
) {
2131 case USB_SPEED_HIGH
:
2132 dum_hcd
->port_status
|=
2133 USB_PORT_STAT_HIGH_SPEED
;
2136 dum_hcd
->dum
->gadget
.ep0
->
2138 dum_hcd
->port_status
|=
2139 USB_PORT_STAT_LOW_SPEED
;
2142 dum_hcd
->dum
->gadget
.speed
=
2149 set_link_state(dum_hcd
);
2150 ((__le16
*) buf
)[0] = cpu_to_le16(dum_hcd
->port_status
);
2151 ((__le16
*) buf
)[1] = cpu_to_le16(dum_hcd
->port_status
>> 16);
2156 case SetPortFeature
:
2158 case USB_PORT_FEAT_LINK_STATE
:
2159 if (hcd
->speed
!= HCD_USB3
) {
2160 dev_dbg(dummy_dev(dum_hcd
),
2161 "USB_PORT_FEAT_LINK_STATE req not "
2162 "supported for USB 2.0 roothub\n");
2166 * Since this is dummy we don't have an actual link so
2167 * there is nothing to do for the SET_LINK_STATE cmd
2170 case USB_PORT_FEAT_U1_TIMEOUT
:
2171 case USB_PORT_FEAT_U2_TIMEOUT
:
2172 /* TODO: add suspend/resume support! */
2173 if (hcd
->speed
!= HCD_USB3
) {
2174 dev_dbg(dummy_dev(dum_hcd
),
2175 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2176 "supported for USB 2.0 roothub\n");
2180 case USB_PORT_FEAT_SUSPEND
:
2181 /* Applicable only for USB2.0 hub */
2182 if (hcd
->speed
== HCD_USB3
) {
2183 dev_dbg(dummy_dev(dum_hcd
),
2184 "USB_PORT_FEAT_SUSPEND req not "
2185 "supported for USB 3.0 roothub\n");
2188 if (dum_hcd
->active
) {
2189 dum_hcd
->port_status
|= USB_PORT_STAT_SUSPEND
;
2191 /* HNP would happen here; for now we
2192 * assume b_bus_req is always true.
2194 set_link_state(dum_hcd
);
2195 if (((1 << USB_DEVICE_B_HNP_ENABLE
)
2196 & dum_hcd
->dum
->devstatus
) != 0)
2197 dev_dbg(dummy_dev(dum_hcd
),
2201 case USB_PORT_FEAT_POWER
:
2202 if (hcd
->speed
== HCD_USB3
)
2203 dum_hcd
->port_status
|= USB_SS_PORT_STAT_POWER
;
2205 dum_hcd
->port_status
|= USB_PORT_STAT_POWER
;
2206 set_link_state(dum_hcd
);
2208 case USB_PORT_FEAT_BH_PORT_RESET
:
2209 /* Applicable only for USB3.0 hub */
2210 if (hcd
->speed
!= HCD_USB3
) {
2211 dev_dbg(dummy_dev(dum_hcd
),
2212 "USB_PORT_FEAT_BH_PORT_RESET req not "
2213 "supported for USB 2.0 roothub\n");
2217 case USB_PORT_FEAT_RESET
:
2218 /* if it's already enabled, disable */
2219 if (hcd
->speed
== HCD_USB3
) {
2220 dum_hcd
->port_status
= 0;
2221 dum_hcd
->port_status
=
2222 (USB_SS_PORT_STAT_POWER
|
2223 USB_PORT_STAT_CONNECTION
|
2224 USB_PORT_STAT_RESET
);
2226 dum_hcd
->port_status
&= ~(USB_PORT_STAT_ENABLE
2227 | USB_PORT_STAT_LOW_SPEED
2228 | USB_PORT_STAT_HIGH_SPEED
);
2230 * We want to reset device status. All but the
2231 * Self powered feature
2233 dum_hcd
->dum
->devstatus
&=
2234 (1 << USB_DEVICE_SELF_POWERED
);
2236 * FIXME USB3.0: what is the correct reset signaling
2237 * interval? Is it still 50msec as for HS?
2239 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(50);
2242 if (hcd
->speed
== HCD_USB3
) {
2243 if ((dum_hcd
->port_status
&
2244 USB_SS_PORT_STAT_POWER
) != 0) {
2245 dum_hcd
->port_status
|= (1 << wValue
);
2246 set_link_state(dum_hcd
);
2249 if ((dum_hcd
->port_status
&
2250 USB_PORT_STAT_POWER
) != 0) {
2251 dum_hcd
->port_status
|= (1 << wValue
);
2252 set_link_state(dum_hcd
);
2256 case GetPortErrorCount
:
2257 if (hcd
->speed
!= HCD_USB3
) {
2258 dev_dbg(dummy_dev(dum_hcd
),
2259 "GetPortErrorCount req not "
2260 "supported for USB 2.0 roothub\n");
2263 /* We'll always return 0 since this is a dummy hub */
2264 *(__le32
*) buf
= cpu_to_le32(0);
2267 if (hcd
->speed
!= HCD_USB3
) {
2268 dev_dbg(dummy_dev(dum_hcd
),
2269 "SetHubDepth req not supported for "
2270 "USB 2.0 roothub\n");
2275 dev_dbg(dummy_dev(dum_hcd
),
2276 "hub control req%04x v%04x i%04x l%d\n",
2277 typeReq
, wValue
, wIndex
, wLength
);
2279 /* "protocol stall" on error */
2282 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2284 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0)
2285 usb_hcd_poll_rh_status(hcd
);
2289 static int dummy_bus_suspend(struct usb_hcd
*hcd
)
2291 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2293 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2295 spin_lock_irq(&dum_hcd
->dum
->lock
);
2296 dum_hcd
->rh_state
= DUMMY_RH_SUSPENDED
;
2297 set_link_state(dum_hcd
);
2298 hcd
->state
= HC_STATE_SUSPENDED
;
2299 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2303 static int dummy_bus_resume(struct usb_hcd
*hcd
)
2305 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2308 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2310 spin_lock_irq(&dum_hcd
->dum
->lock
);
2311 if (!HCD_HW_ACCESSIBLE(hcd
)) {
2314 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2315 set_link_state(dum_hcd
);
2316 if (!list_empty(&dum_hcd
->urbp_list
))
2317 mod_timer(&dum_hcd
->timer
, jiffies
);
2318 hcd
->state
= HC_STATE_RUNNING
;
2320 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2324 /*-------------------------------------------------------------------------*/
2326 static inline ssize_t
show_urb(char *buf
, size_t size
, struct urb
*urb
)
2328 int ep
= usb_pipeendpoint(urb
->pipe
);
2330 return snprintf(buf
, size
,
2331 "urb/%p %s ep%d%s%s len %d/%d\n",
2334 switch (urb
->dev
->speed
) {
2338 case USB_SPEED_FULL
:
2341 case USB_SPEED_HIGH
:
2344 case USB_SPEED_SUPER
:
2351 ep
, ep
? (usb_pipein(urb
->pipe
) ? "in" : "out") : "",
2353 switch (usb_pipetype(urb
->pipe
)) { \
2354 case PIPE_CONTROL
: \
2360 case PIPE_INTERRUPT
: \
2367 urb
->actual_length
, urb
->transfer_buffer_length
);
2370 static ssize_t
urbs_show(struct device
*dev
, struct device_attribute
*attr
,
2373 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
2374 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2377 unsigned long flags
;
2379 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2380 list_for_each_entry(urbp
, &dum_hcd
->urbp_list
, urbp_list
) {
2383 temp
= show_urb(buf
, PAGE_SIZE
- size
, urbp
->urb
);
2387 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2391 static DEVICE_ATTR_RO(urbs
);
2393 static int dummy_start_ss(struct dummy_hcd
*dum_hcd
)
2395 init_timer(&dum_hcd
->timer
);
2396 dum_hcd
->timer
.function
= dummy_timer
;
2397 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2398 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2399 dum_hcd
->stream_en_ep
= 0;
2400 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2401 dummy_hcd_to_hcd(dum_hcd
)->power_budget
= POWER_BUDGET
;
2402 dummy_hcd_to_hcd(dum_hcd
)->state
= HC_STATE_RUNNING
;
2403 dummy_hcd_to_hcd(dum_hcd
)->uses_new_polling
= 1;
2404 #ifdef CONFIG_USB_OTG
2405 dummy_hcd_to_hcd(dum_hcd
)->self
.otg_port
= 1;
2409 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2410 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2413 static int dummy_start(struct usb_hcd
*hcd
)
2415 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2418 * MASTER side init ... we emulate a root hub that'll only ever
2419 * talk to one device (the slave side). Also appears in sysfs,
2420 * just like more familiar pci-based HCDs.
2422 if (!usb_hcd_is_primary_hcd(hcd
))
2423 return dummy_start_ss(dum_hcd
);
2425 spin_lock_init(&dum_hcd
->dum
->lock
);
2426 init_timer(&dum_hcd
->timer
);
2427 dum_hcd
->timer
.function
= dummy_timer
;
2428 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2429 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2431 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2433 hcd
->power_budget
= POWER_BUDGET
;
2434 hcd
->state
= HC_STATE_RUNNING
;
2435 hcd
->uses_new_polling
= 1;
2437 #ifdef CONFIG_USB_OTG
2438 hcd
->self
.otg_port
= 1;
2441 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2442 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2445 static void dummy_stop(struct usb_hcd
*hcd
)
2449 dum
= hcd_to_dummy_hcd(hcd
)->dum
;
2450 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd
)), &dev_attr_urbs
);
2451 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd
)), "stopped\n");
2454 /*-------------------------------------------------------------------------*/
2456 static int dummy_h_get_frame(struct usb_hcd
*hcd
)
2458 return dummy_g_get_frame(NULL
);
2461 static int dummy_setup(struct usb_hcd
*hcd
)
2465 dum
= *((void **)dev_get_platdata(hcd
->self
.controller
));
2466 hcd
->self
.sg_tablesize
= ~0;
2467 if (usb_hcd_is_primary_hcd(hcd
)) {
2468 dum
->hs_hcd
= hcd_to_dummy_hcd(hcd
);
2469 dum
->hs_hcd
->dum
= dum
;
2471 * Mark the first roothub as being USB 2.0.
2472 * The USB 3.0 roothub will be registered later by
2475 hcd
->speed
= HCD_USB2
;
2476 hcd
->self
.root_hub
->speed
= USB_SPEED_HIGH
;
2478 dum
->ss_hcd
= hcd_to_dummy_hcd(hcd
);
2479 dum
->ss_hcd
->dum
= dum
;
2480 hcd
->speed
= HCD_USB3
;
2481 hcd
->self
.root_hub
->speed
= USB_SPEED_SUPER
;
2486 /* Change a group of bulk endpoints to support multiple stream IDs */
2487 static int dummy_alloc_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2488 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2489 unsigned int num_streams
, gfp_t mem_flags
)
2491 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2492 unsigned long flags
;
2494 int ret_streams
= num_streams
;
2501 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2502 for (i
= 0; i
< num_eps
; i
++) {
2503 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2504 if ((1 << index
) & dum_hcd
->stream_en_ep
) {
2505 ret_streams
= -EINVAL
;
2508 max_stream
= usb_ss_max_streams(&eps
[i
]->ss_ep_comp
);
2510 ret_streams
= -EINVAL
;
2513 if (max_stream
< ret_streams
) {
2514 dev_dbg(dummy_dev(dum_hcd
), "Ep 0x%x only supports %u "
2516 eps
[i
]->desc
.bEndpointAddress
,
2518 ret_streams
= max_stream
;
2522 for (i
= 0; i
< num_eps
; i
++) {
2523 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2524 dum_hcd
->stream_en_ep
|= 1 << index
;
2525 set_max_streams_for_pipe(dum_hcd
,
2526 usb_endpoint_num(&eps
[i
]->desc
), ret_streams
);
2529 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2533 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2534 static int dummy_free_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2535 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2538 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2539 unsigned long flags
;
2544 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2545 for (i
= 0; i
< num_eps
; i
++) {
2546 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2547 if (!((1 << index
) & dum_hcd
->stream_en_ep
)) {
2553 for (i
= 0; i
< num_eps
; i
++) {
2554 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2555 dum_hcd
->stream_en_ep
&= ~(1 << index
);
2556 set_max_streams_for_pipe(dum_hcd
,
2557 usb_endpoint_num(&eps
[i
]->desc
), 0);
2561 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2565 static struct hc_driver dummy_hcd
= {
2566 .description
= (char *) driver_name
,
2567 .product_desc
= "Dummy host controller",
2568 .hcd_priv_size
= sizeof(struct dummy_hcd
),
2570 .flags
= HCD_USB3
| HCD_SHARED
,
2572 .reset
= dummy_setup
,
2573 .start
= dummy_start
,
2576 .urb_enqueue
= dummy_urb_enqueue
,
2577 .urb_dequeue
= dummy_urb_dequeue
,
2579 .get_frame_number
= dummy_h_get_frame
,
2581 .hub_status_data
= dummy_hub_status
,
2582 .hub_control
= dummy_hub_control
,
2583 .bus_suspend
= dummy_bus_suspend
,
2584 .bus_resume
= dummy_bus_resume
,
2586 .alloc_streams
= dummy_alloc_streams
,
2587 .free_streams
= dummy_free_streams
,
2590 static int dummy_hcd_probe(struct platform_device
*pdev
)
2593 struct usb_hcd
*hs_hcd
;
2594 struct usb_hcd
*ss_hcd
;
2597 dev_info(&pdev
->dev
, "%s, driver " DRIVER_VERSION
"\n", driver_desc
);
2598 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
2600 if (!mod_data
.is_super_speed
)
2601 dummy_hcd
.flags
= HCD_USB2
;
2602 hs_hcd
= usb_create_hcd(&dummy_hcd
, &pdev
->dev
, dev_name(&pdev
->dev
));
2607 retval
= usb_add_hcd(hs_hcd
, 0, 0);
2611 if (mod_data
.is_super_speed
) {
2612 ss_hcd
= usb_create_shared_hcd(&dummy_hcd
, &pdev
->dev
,
2613 dev_name(&pdev
->dev
), hs_hcd
);
2616 goto dealloc_usb2_hcd
;
2619 retval
= usb_add_hcd(ss_hcd
, 0, 0);
2626 usb_put_hcd(ss_hcd
);
2628 usb_remove_hcd(hs_hcd
);
2630 usb_put_hcd(hs_hcd
);
2631 dum
->hs_hcd
= dum
->ss_hcd
= NULL
;
2635 static int dummy_hcd_remove(struct platform_device
*pdev
)
2639 dum
= hcd_to_dummy_hcd(platform_get_drvdata(pdev
))->dum
;
2642 usb_remove_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2643 usb_put_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2646 usb_remove_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2647 usb_put_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2655 static int dummy_hcd_suspend(struct platform_device
*pdev
, pm_message_t state
)
2657 struct usb_hcd
*hcd
;
2658 struct dummy_hcd
*dum_hcd
;
2661 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2663 hcd
= platform_get_drvdata(pdev
);
2664 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2665 if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
2666 dev_warn(&pdev
->dev
, "Root hub isn't suspended!\n");
2669 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2673 static int dummy_hcd_resume(struct platform_device
*pdev
)
2675 struct usb_hcd
*hcd
;
2677 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2679 hcd
= platform_get_drvdata(pdev
);
2680 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2681 usb_hcd_poll_rh_status(hcd
);
2685 static struct platform_driver dummy_hcd_driver
= {
2686 .probe
= dummy_hcd_probe
,
2687 .remove
= dummy_hcd_remove
,
2688 .suspend
= dummy_hcd_suspend
,
2689 .resume
= dummy_hcd_resume
,
2691 .name
= (char *) driver_name
,
2695 /*-------------------------------------------------------------------------*/
2696 #define MAX_NUM_UDC 2
2697 static struct platform_device
*the_udc_pdev
[MAX_NUM_UDC
];
2698 static struct platform_device
*the_hcd_pdev
[MAX_NUM_UDC
];
2700 static int __init
init(void)
2702 int retval
= -ENOMEM
;
2704 struct dummy
*dum
[MAX_NUM_UDC
];
2709 if (!mod_data
.is_high_speed
&& mod_data
.is_super_speed
)
2712 if (mod_data
.num
< 1 || mod_data
.num
> MAX_NUM_UDC
) {
2713 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2718 for (i
= 0; i
< mod_data
.num
; i
++) {
2719 the_hcd_pdev
[i
] = platform_device_alloc(driver_name
, i
);
2720 if (!the_hcd_pdev
[i
]) {
2723 platform_device_put(the_hcd_pdev
[i
--]);
2727 for (i
= 0; i
< mod_data
.num
; i
++) {
2728 the_udc_pdev
[i
] = platform_device_alloc(gadget_name
, i
);
2729 if (!the_udc_pdev
[i
]) {
2732 platform_device_put(the_udc_pdev
[i
--]);
2736 for (i
= 0; i
< mod_data
.num
; i
++) {
2737 dum
[i
] = kzalloc(sizeof(struct dummy
), GFP_KERNEL
);
2742 retval
= platform_device_add_data(the_hcd_pdev
[i
], &dum
[i
],
2746 retval
= platform_device_add_data(the_udc_pdev
[i
], &dum
[i
],
2752 retval
= platform_driver_register(&dummy_hcd_driver
);
2755 retval
= platform_driver_register(&dummy_udc_driver
);
2757 goto err_register_udc_driver
;
2759 for (i
= 0; i
< mod_data
.num
; i
++) {
2760 retval
= platform_device_add(the_hcd_pdev
[i
]);
2764 platform_device_del(the_hcd_pdev
[i
--]);
2768 for (i
= 0; i
< mod_data
.num
; i
++) {
2769 if (!dum
[i
]->hs_hcd
||
2770 (!dum
[i
]->ss_hcd
&& mod_data
.is_super_speed
)) {
2772 * The hcd was added successfully but its probe
2773 * function failed for some reason.
2780 for (i
= 0; i
< mod_data
.num
; i
++) {
2781 retval
= platform_device_add(the_udc_pdev
[i
]);
2785 platform_device_del(the_udc_pdev
[i
]);
2790 for (i
= 0; i
< mod_data
.num
; i
++) {
2791 if (!platform_get_drvdata(the_udc_pdev
[i
])) {
2793 * The udc was added successfully but its probe
2794 * function failed for some reason.
2803 for (i
= 0; i
< mod_data
.num
; i
++)
2804 platform_device_del(the_udc_pdev
[i
]);
2806 for (i
= 0; i
< mod_data
.num
; i
++)
2807 platform_device_del(the_hcd_pdev
[i
]);
2809 platform_driver_unregister(&dummy_udc_driver
);
2810 err_register_udc_driver
:
2811 platform_driver_unregister(&dummy_hcd_driver
);
2813 for (i
= 0; i
< mod_data
.num
; i
++)
2815 for (i
= 0; i
< mod_data
.num
; i
++)
2816 platform_device_put(the_udc_pdev
[i
]);
2818 for (i
= 0; i
< mod_data
.num
; i
++)
2819 platform_device_put(the_hcd_pdev
[i
]);
2824 static void __exit
cleanup(void)
2828 for (i
= 0; i
< mod_data
.num
; i
++) {
2831 dum
= *((void **)dev_get_platdata(&the_udc_pdev
[i
]->dev
));
2833 platform_device_unregister(the_udc_pdev
[i
]);
2834 platform_device_unregister(the_hcd_pdev
[i
]);
2837 platform_driver_unregister(&dummy_udc_driver
);
2838 platform_driver_unregister(&dummy_hcd_driver
);
2840 module_exit(cleanup
);