1 // SPDX-License-Identifier: GPL-2.0+
3 * dummy_hcd.c -- Dummy/Loopback USB host and device emulator driver.
5 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
7 * Copyright (C) 2003 David Brownell
8 * Copyright (C) 2003-2005 Alan Stern
13 * This exposes a device side "USB gadget" API, driven by requests to a
14 * Linux-USB host controller driver. USB traffic is simulated; there's
15 * no need for USB hardware. Use this with two other drivers:
17 * - Gadget driver, responding to requests (slave);
18 * - Host-side device driver, as already familiar in Linux.
20 * Having this all in one kernel can help some stages of development,
21 * bypassing some hardware (and driver) issues. UML could help too.
23 * Note: The emulation does not include isochronous transfers!
26 #include <linux/module.h>
27 #include <linux/kernel.h>
28 #include <linux/delay.h>
29 #include <linux/ioport.h>
30 #include <linux/slab.h>
31 #include <linux/errno.h>
32 #include <linux/init.h>
33 #include <linux/timer.h>
34 #include <linux/list.h>
35 #include <linux/interrupt.h>
36 #include <linux/platform_device.h>
37 #include <linux/usb.h>
38 #include <linux/usb/gadget.h>
39 #include <linux/usb/hcd.h>
40 #include <linux/scatterlist.h>
42 #include <asm/byteorder.h>
45 #include <asm/unaligned.h>
47 #define DRIVER_DESC "USB Host+Gadget Emulator"
48 #define DRIVER_VERSION "02 May 2005"
50 #define POWER_BUDGET 500 /* in mA; use 8 for low-power port testing */
51 #define POWER_BUDGET_3 900 /* in mA */
53 static const char driver_name
[] = "dummy_hcd";
54 static const char driver_desc
[] = "USB Host+Gadget Emulator";
56 static const char gadget_name
[] = "dummy_udc";
58 MODULE_DESCRIPTION(DRIVER_DESC
);
59 MODULE_AUTHOR("David Brownell");
60 MODULE_LICENSE("GPL");
62 struct dummy_hcd_module_parameters
{
68 static struct dummy_hcd_module_parameters mod_data
= {
69 .is_super_speed
= false,
70 .is_high_speed
= true,
73 module_param_named(is_super_speed
, mod_data
.is_super_speed
, bool, S_IRUGO
);
74 MODULE_PARM_DESC(is_super_speed
, "true to simulate SuperSpeed connection");
75 module_param_named(is_high_speed
, mod_data
.is_high_speed
, bool, S_IRUGO
);
76 MODULE_PARM_DESC(is_high_speed
, "true to simulate HighSpeed connection");
77 module_param_named(num
, mod_data
.num
, uint
, S_IRUGO
);
78 MODULE_PARM_DESC(num
, "number of emulated controllers");
79 /*-------------------------------------------------------------------------*/
81 /* gadget side driver data structres */
83 struct list_head queue
;
84 unsigned long last_io
; /* jiffies timestamp */
85 struct usb_gadget
*gadget
;
86 const struct usb_endpoint_descriptor
*desc
;
90 unsigned already_seen
:1;
91 unsigned setup_stage
:1;
95 struct dummy_request
{
96 struct list_head queue
; /* ep's requests */
97 struct usb_request req
;
100 static inline struct dummy_ep
*usb_ep_to_dummy_ep(struct usb_ep
*_ep
)
102 return container_of(_ep
, struct dummy_ep
, ep
);
105 static inline struct dummy_request
*usb_request_to_dummy_request
106 (struct usb_request
*_req
)
108 return container_of(_req
, struct dummy_request
, req
);
111 /*-------------------------------------------------------------------------*/
114 * Every device has ep0 for control requests, plus up to 30 more endpoints,
115 * in one of two types:
117 * - Configurable: direction (in/out), type (bulk, iso, etc), and endpoint
118 * number can be changed. Names like "ep-a" are used for this type.
120 * - Fixed Function: in other cases. some characteristics may be mutable;
121 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
123 * Gadget drivers are responsible for not setting up conflicting endpoint
124 * configurations, illegal or unsupported packet lengths, and so on.
127 static const char ep0name
[] = "ep0";
129 static const struct {
131 const struct usb_ep_caps caps
;
133 #define EP_INFO(_name, _caps) \
139 /* we don't provide isochronous endpoints since we don't support them */
140 #define TYPE_BULK_OR_INT (USB_EP_CAPS_TYPE_BULK | USB_EP_CAPS_TYPE_INT)
142 /* everyone has ep0 */
144 USB_EP_CAPS(USB_EP_CAPS_TYPE_CONTROL
, USB_EP_CAPS_DIR_ALL
)),
145 /* act like a pxa250: fifteen fixed function endpoints */
146 EP_INFO("ep1in-bulk",
147 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_IN
)),
148 EP_INFO("ep2out-bulk",
149 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_OUT
)),
152 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
153 EP_INFO("ep4out-iso",
154 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
157 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT
, USB_EP_CAPS_DIR_IN
)),
158 EP_INFO("ep6in-bulk",
159 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_IN
)),
160 EP_INFO("ep7out-bulk",
161 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_OUT
)),
164 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
165 EP_INFO("ep9out-iso",
166 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
168 EP_INFO("ep10in-int",
169 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT
, USB_EP_CAPS_DIR_IN
)),
170 EP_INFO("ep11in-bulk",
171 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_IN
)),
172 EP_INFO("ep12out-bulk",
173 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_OUT
)),
175 EP_INFO("ep13in-iso",
176 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
177 EP_INFO("ep14out-iso",
178 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
180 EP_INFO("ep15in-int",
181 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT
, USB_EP_CAPS_DIR_IN
)),
183 /* or like sa1100: two fixed function endpoints */
184 EP_INFO("ep1out-bulk",
185 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_OUT
)),
186 EP_INFO("ep2in-bulk",
187 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK
, USB_EP_CAPS_DIR_IN
)),
189 /* and now some generic EPs so we have enough in multi config */
191 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
193 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_IN
)),
195 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
197 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
199 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_IN
)),
201 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
203 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_IN
)),
205 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
207 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
209 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_IN
)),
211 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
213 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_IN
)),
215 USB_EP_CAPS(TYPE_BULK_OR_INT
, USB_EP_CAPS_DIR_OUT
)),
220 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_info)
222 /*-------------------------------------------------------------------------*/
228 struct list_head urbp_list
;
229 struct sg_mapping_iter miter
;
234 enum dummy_rh_state
{
242 enum dummy_rh_state rh_state
;
243 struct timer_list timer
;
246 unsigned long re_timeout
;
248 struct usb_device
*udev
;
249 struct list_head urbp_list
;
250 struct urbp
*next_frame_urbp
;
253 u8 num_stream
[30 / 2];
256 unsigned old_active
:1;
264 * SLAVE/GADGET side support
266 struct dummy_ep ep
[DUMMY_ENDPOINTS
];
269 struct usb_gadget gadget
;
270 struct usb_gadget_driver
*driver
;
271 struct dummy_request fifo_req
;
272 u8 fifo_buf
[FIFO_SIZE
];
274 unsigned ints_enabled
:1;
275 unsigned udc_suspended
:1;
279 * MASTER/HOST side support
281 struct dummy_hcd
*hs_hcd
;
282 struct dummy_hcd
*ss_hcd
;
285 static inline struct dummy_hcd
*hcd_to_dummy_hcd(struct usb_hcd
*hcd
)
287 return (struct dummy_hcd
*) (hcd
->hcd_priv
);
290 static inline struct usb_hcd
*dummy_hcd_to_hcd(struct dummy_hcd
*dum
)
292 return container_of((void *) dum
, struct usb_hcd
, hcd_priv
);
295 static inline struct device
*dummy_dev(struct dummy_hcd
*dum
)
297 return dummy_hcd_to_hcd(dum
)->self
.controller
;
300 static inline struct device
*udc_dev(struct dummy
*dum
)
302 return dum
->gadget
.dev
.parent
;
305 static inline struct dummy
*ep_to_dummy(struct dummy_ep
*ep
)
307 return container_of(ep
->gadget
, struct dummy
, gadget
);
310 static inline struct dummy_hcd
*gadget_to_dummy_hcd(struct usb_gadget
*gadget
)
312 struct dummy
*dum
= container_of(gadget
, struct dummy
, gadget
);
313 if (dum
->gadget
.speed
== USB_SPEED_SUPER
)
319 static inline struct dummy
*gadget_dev_to_dummy(struct device
*dev
)
321 return container_of(dev
, struct dummy
, gadget
.dev
);
324 /*-------------------------------------------------------------------------*/
326 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
328 /* called with spinlock held */
329 static void nuke(struct dummy
*dum
, struct dummy_ep
*ep
)
331 while (!list_empty(&ep
->queue
)) {
332 struct dummy_request
*req
;
334 req
= list_entry(ep
->queue
.next
, struct dummy_request
, queue
);
335 list_del_init(&req
->queue
);
336 req
->req
.status
= -ESHUTDOWN
;
338 spin_unlock(&dum
->lock
);
339 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
340 spin_lock(&dum
->lock
);
344 /* caller must hold lock */
345 static void stop_activity(struct dummy
*dum
)
349 /* prevent any more requests */
352 /* The timer is left running so that outstanding URBs can fail */
354 /* nuke any pending requests first, so driver i/o is quiesced */
355 for (i
= 0; i
< DUMMY_ENDPOINTS
; ++i
)
356 nuke(dum
, &dum
->ep
[i
]);
358 /* driver now does any non-usb quiescing necessary */
362 * set_link_state_by_speed() - Sets the current state of the link according to
364 * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
366 * This function updates the port_status according to the link state and the
369 static void set_link_state_by_speed(struct dummy_hcd
*dum_hcd
)
371 struct dummy
*dum
= dum_hcd
->dum
;
373 if (dummy_hcd_to_hcd(dum_hcd
)->speed
== HCD_USB3
) {
374 if ((dum_hcd
->port_status
& USB_SS_PORT_STAT_POWER
) == 0) {
375 dum_hcd
->port_status
= 0;
376 } else if (!dum
->pullup
|| dum
->udc_suspended
) {
377 /* UDC suspend must cause a disconnect */
378 dum_hcd
->port_status
&= ~(USB_PORT_STAT_CONNECTION
|
379 USB_PORT_STAT_ENABLE
);
380 if ((dum_hcd
->old_status
&
381 USB_PORT_STAT_CONNECTION
) != 0)
382 dum_hcd
->port_status
|=
383 (USB_PORT_STAT_C_CONNECTION
<< 16);
385 /* device is connected and not suspended */
386 dum_hcd
->port_status
|= (USB_PORT_STAT_CONNECTION
|
387 USB_PORT_STAT_SPEED_5GBPS
) ;
388 if ((dum_hcd
->old_status
&
389 USB_PORT_STAT_CONNECTION
) == 0)
390 dum_hcd
->port_status
|=
391 (USB_PORT_STAT_C_CONNECTION
<< 16);
392 if ((dum_hcd
->port_status
& USB_PORT_STAT_ENABLE
) &&
393 (dum_hcd
->port_status
&
394 USB_PORT_STAT_LINK_STATE
) == USB_SS_PORT_LS_U0
&&
395 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
399 if ((dum_hcd
->port_status
& USB_PORT_STAT_POWER
) == 0) {
400 dum_hcd
->port_status
= 0;
401 } else if (!dum
->pullup
|| dum
->udc_suspended
) {
402 /* UDC suspend must cause a disconnect */
403 dum_hcd
->port_status
&= ~(USB_PORT_STAT_CONNECTION
|
404 USB_PORT_STAT_ENABLE
|
405 USB_PORT_STAT_LOW_SPEED
|
406 USB_PORT_STAT_HIGH_SPEED
|
407 USB_PORT_STAT_SUSPEND
);
408 if ((dum_hcd
->old_status
&
409 USB_PORT_STAT_CONNECTION
) != 0)
410 dum_hcd
->port_status
|=
411 (USB_PORT_STAT_C_CONNECTION
<< 16);
413 dum_hcd
->port_status
|= USB_PORT_STAT_CONNECTION
;
414 if ((dum_hcd
->old_status
&
415 USB_PORT_STAT_CONNECTION
) == 0)
416 dum_hcd
->port_status
|=
417 (USB_PORT_STAT_C_CONNECTION
<< 16);
418 if ((dum_hcd
->port_status
& USB_PORT_STAT_ENABLE
) == 0)
419 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
420 else if ((dum_hcd
->port_status
&
421 USB_PORT_STAT_SUSPEND
) == 0 &&
422 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
428 /* caller must hold lock */
429 static void set_link_state(struct dummy_hcd
*dum_hcd
)
431 struct dummy
*dum
= dum_hcd
->dum
;
432 unsigned int power_bit
;
436 if ((dummy_hcd_to_hcd(dum_hcd
)->speed
== HCD_USB3
&&
437 dum
->gadget
.speed
!= USB_SPEED_SUPER
) ||
438 (dummy_hcd_to_hcd(dum_hcd
)->speed
!= HCD_USB3
&&
439 dum
->gadget
.speed
== USB_SPEED_SUPER
))
442 set_link_state_by_speed(dum_hcd
);
443 power_bit
= (dummy_hcd_to_hcd(dum_hcd
)->speed
== HCD_USB3
?
444 USB_SS_PORT_STAT_POWER
: USB_PORT_STAT_POWER
);
446 if ((dum_hcd
->port_status
& USB_PORT_STAT_ENABLE
) == 0 ||
448 dum_hcd
->resuming
= 0;
450 /* Currently !connected or in reset */
451 if ((dum_hcd
->port_status
& power_bit
) == 0 ||
452 (dum_hcd
->port_status
& USB_PORT_STAT_RESET
) != 0) {
453 unsigned int disconnect
= power_bit
&
454 dum_hcd
->old_status
& (~dum_hcd
->port_status
);
455 unsigned int reset
= USB_PORT_STAT_RESET
&
456 (~dum_hcd
->old_status
) & dum_hcd
->port_status
;
458 /* Report reset and disconnect events to the driver */
459 if (dum
->ints_enabled
&& (disconnect
|| reset
)) {
461 ++dum
->callback_usage
;
462 spin_unlock(&dum
->lock
);
464 usb_gadget_udc_reset(&dum
->gadget
, dum
->driver
);
466 dum
->driver
->disconnect(&dum
->gadget
);
467 spin_lock(&dum
->lock
);
468 --dum
->callback_usage
;
470 } else if (dum_hcd
->active
!= dum_hcd
->old_active
&&
472 ++dum
->callback_usage
;
473 spin_unlock(&dum
->lock
);
474 if (dum_hcd
->old_active
&& dum
->driver
->suspend
)
475 dum
->driver
->suspend(&dum
->gadget
);
476 else if (!dum_hcd
->old_active
&& dum
->driver
->resume
)
477 dum
->driver
->resume(&dum
->gadget
);
478 spin_lock(&dum
->lock
);
479 --dum
->callback_usage
;
482 dum_hcd
->old_status
= dum_hcd
->port_status
;
483 dum_hcd
->old_active
= dum_hcd
->active
;
486 /*-------------------------------------------------------------------------*/
488 /* SLAVE/GADGET SIDE DRIVER
490 * This only tracks gadget state. All the work is done when the host
491 * side tries some (emulated) i/o operation. Real device controller
492 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
495 #define is_enabled(dum) \
496 (dum->port_status & USB_PORT_STAT_ENABLE)
498 static int dummy_enable(struct usb_ep
*_ep
,
499 const struct usb_endpoint_descriptor
*desc
)
502 struct dummy_hcd
*dum_hcd
;
507 ep
= usb_ep_to_dummy_ep(_ep
);
508 if (!_ep
|| !desc
|| ep
->desc
|| _ep
->name
== ep0name
509 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
)
511 dum
= ep_to_dummy(ep
);
515 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
516 if (!is_enabled(dum_hcd
))
520 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
521 * maximum packet size.
522 * For SS devices the wMaxPacketSize is limited by 1024.
524 max
= usb_endpoint_maxp(desc
);
526 /* drivers must not request bad settings, since lower levels
527 * (hardware or its drivers) may not check. some endpoints
528 * can't do iso, many have maxpacket limitations, etc.
530 * since this "hardware" driver is here to help debugging, we
531 * have some extra sanity checks. (there could be more though,
532 * especially for "ep9out" style fixed function ones.)
535 switch (usb_endpoint_type(desc
)) {
536 case USB_ENDPOINT_XFER_BULK
:
537 if (strstr(ep
->ep
.name
, "-iso")
538 || strstr(ep
->ep
.name
, "-int")) {
541 switch (dum
->gadget
.speed
) {
542 case USB_SPEED_SUPER
:
551 if (max
== 8 || max
== 16 || max
== 32 || max
== 64)
552 /* we'll fake any legal size */
554 /* save a return statement */
559 case USB_ENDPOINT_XFER_INT
:
560 if (strstr(ep
->ep
.name
, "-iso")) /* bulk is ok */
562 /* real hardware might not handle all packet sizes */
563 switch (dum
->gadget
.speed
) {
564 case USB_SPEED_SUPER
:
568 /* save a return statement */
573 /* save a return statement */
581 case USB_ENDPOINT_XFER_ISOC
:
582 if (strstr(ep
->ep
.name
, "-bulk")
583 || strstr(ep
->ep
.name
, "-int"))
585 /* real hardware might not handle all packet sizes */
586 switch (dum
->gadget
.speed
) {
587 case USB_SPEED_SUPER
:
591 /* save a return statement */
596 /* save a return statement */
602 /* few chips support control except on ep0 */
606 _ep
->maxpacket
= max
;
607 if (usb_ss_max_streams(_ep
->comp_desc
)) {
608 if (!usb_endpoint_xfer_bulk(desc
)) {
609 dev_err(udc_dev(dum
), "Can't enable stream support on "
610 "non-bulk ep %s\n", _ep
->name
);
617 dev_dbg(udc_dev(dum
), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
619 desc
->bEndpointAddress
& 0x0f,
620 (desc
->bEndpointAddress
& USB_DIR_IN
) ? "in" : "out",
621 usb_ep_type_string(usb_endpoint_type(desc
)),
622 max
, ep
->stream_en
? "enabled" : "disabled");
624 /* at this point real hardware should be NAKing transfers
625 * to that endpoint, until a buffer is queued to it.
627 ep
->halted
= ep
->wedged
= 0;
633 static int dummy_disable(struct usb_ep
*_ep
)
639 ep
= usb_ep_to_dummy_ep(_ep
);
640 if (!_ep
|| !ep
->desc
|| _ep
->name
== ep0name
)
642 dum
= ep_to_dummy(ep
);
644 spin_lock_irqsave(&dum
->lock
, flags
);
648 spin_unlock_irqrestore(&dum
->lock
, flags
);
650 dev_dbg(udc_dev(dum
), "disabled %s\n", _ep
->name
);
654 static struct usb_request
*dummy_alloc_request(struct usb_ep
*_ep
,
657 struct dummy_request
*req
;
662 req
= kzalloc(sizeof(*req
), mem_flags
);
665 INIT_LIST_HEAD(&req
->queue
);
669 static void dummy_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
671 struct dummy_request
*req
;
678 req
= usb_request_to_dummy_request(_req
);
679 WARN_ON(!list_empty(&req
->queue
));
683 static void fifo_complete(struct usb_ep
*ep
, struct usb_request
*req
)
687 static int dummy_queue(struct usb_ep
*_ep
, struct usb_request
*_req
,
691 struct dummy_request
*req
;
693 struct dummy_hcd
*dum_hcd
;
696 req
= usb_request_to_dummy_request(_req
);
697 if (!_req
|| !list_empty(&req
->queue
) || !_req
->complete
)
700 ep
= usb_ep_to_dummy_ep(_ep
);
701 if (!_ep
|| (!ep
->desc
&& _ep
->name
!= ep0name
))
704 dum
= ep_to_dummy(ep
);
705 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
706 if (!dum
->driver
|| !is_enabled(dum_hcd
))
710 dev_dbg(udc_dev(dum
), "ep %p queue req %p to %s, len %d buf %p\n",
711 ep
, _req
, _ep
->name
, _req
->length
, _req
->buf
);
713 _req
->status
= -EINPROGRESS
;
715 spin_lock_irqsave(&dum
->lock
, flags
);
717 /* implement an emulated single-request FIFO */
718 if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
719 list_empty(&dum
->fifo_req
.queue
) &&
720 list_empty(&ep
->queue
) &&
721 _req
->length
<= FIFO_SIZE
) {
722 req
= &dum
->fifo_req
;
724 req
->req
.buf
= dum
->fifo_buf
;
725 memcpy(dum
->fifo_buf
, _req
->buf
, _req
->length
);
726 req
->req
.context
= dum
;
727 req
->req
.complete
= fifo_complete
;
729 list_add_tail(&req
->queue
, &ep
->queue
);
730 spin_unlock(&dum
->lock
);
731 _req
->actual
= _req
->length
;
733 usb_gadget_giveback_request(_ep
, _req
);
734 spin_lock(&dum
->lock
);
736 list_add_tail(&req
->queue
, &ep
->queue
);
737 spin_unlock_irqrestore(&dum
->lock
, flags
);
739 /* real hardware would likely enable transfers here, in case
740 * it'd been left NAKing.
745 static int dummy_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
749 int retval
= -EINVAL
;
751 struct dummy_request
*req
= NULL
;
755 ep
= usb_ep_to_dummy_ep(_ep
);
756 dum
= ep_to_dummy(ep
);
761 local_irq_save(flags
);
762 spin_lock(&dum
->lock
);
763 list_for_each_entry(req
, &ep
->queue
, queue
) {
764 if (&req
->req
== _req
) {
765 list_del_init(&req
->queue
);
766 _req
->status
= -ECONNRESET
;
771 spin_unlock(&dum
->lock
);
774 dev_dbg(udc_dev(dum
),
775 "dequeued req %p from %s, len %d buf %p\n",
776 req
, _ep
->name
, _req
->length
, _req
->buf
);
777 usb_gadget_giveback_request(_ep
, _req
);
779 local_irq_restore(flags
);
784 dummy_set_halt_and_wedge(struct usb_ep
*_ep
, int value
, int wedged
)
791 ep
= usb_ep_to_dummy_ep(_ep
);
792 dum
= ep_to_dummy(ep
);
796 ep
->halted
= ep
->wedged
= 0;
797 else if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
798 !list_empty(&ep
->queue
))
805 /* FIXME clear emulated data toggle too */
810 dummy_set_halt(struct usb_ep
*_ep
, int value
)
812 return dummy_set_halt_and_wedge(_ep
, value
, 0);
815 static int dummy_set_wedge(struct usb_ep
*_ep
)
817 if (!_ep
|| _ep
->name
== ep0name
)
819 return dummy_set_halt_and_wedge(_ep
, 1, 1);
822 static const struct usb_ep_ops dummy_ep_ops
= {
823 .enable
= dummy_enable
,
824 .disable
= dummy_disable
,
826 .alloc_request
= dummy_alloc_request
,
827 .free_request
= dummy_free_request
,
829 .queue
= dummy_queue
,
830 .dequeue
= dummy_dequeue
,
832 .set_halt
= dummy_set_halt
,
833 .set_wedge
= dummy_set_wedge
,
836 /*-------------------------------------------------------------------------*/
838 /* there are both host and device side versions of this call ... */
839 static int dummy_g_get_frame(struct usb_gadget
*_gadget
)
841 struct timespec64 ts64
;
843 ktime_get_ts64(&ts64
);
844 return ts64
.tv_nsec
/ NSEC_PER_MSEC
;
847 static int dummy_wakeup(struct usb_gadget
*_gadget
)
849 struct dummy_hcd
*dum_hcd
;
851 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
852 if (!(dum_hcd
->dum
->devstatus
& ((1 << USB_DEVICE_B_HNP_ENABLE
)
853 | (1 << USB_DEVICE_REMOTE_WAKEUP
))))
855 if ((dum_hcd
->port_status
& USB_PORT_STAT_CONNECTION
) == 0)
857 if ((dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) == 0 &&
858 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
861 /* FIXME: What if the root hub is suspended but the port isn't? */
863 /* hub notices our request, issues downstream resume, etc */
864 dum_hcd
->resuming
= 1;
865 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(20);
866 mod_timer(&dummy_hcd_to_hcd(dum_hcd
)->rh_timer
, dum_hcd
->re_timeout
);
870 static int dummy_set_selfpowered(struct usb_gadget
*_gadget
, int value
)
874 _gadget
->is_selfpowered
= (value
!= 0);
875 dum
= gadget_to_dummy_hcd(_gadget
)->dum
;
877 dum
->devstatus
|= (1 << USB_DEVICE_SELF_POWERED
);
879 dum
->devstatus
&= ~(1 << USB_DEVICE_SELF_POWERED
);
883 static void dummy_udc_update_ep0(struct dummy
*dum
)
885 if (dum
->gadget
.speed
== USB_SPEED_SUPER
)
886 dum
->ep
[0].ep
.maxpacket
= 9;
888 dum
->ep
[0].ep
.maxpacket
= 64;
891 static int dummy_pullup(struct usb_gadget
*_gadget
, int value
)
893 struct dummy_hcd
*dum_hcd
;
897 dum
= gadget_dev_to_dummy(&_gadget
->dev
);
898 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
900 spin_lock_irqsave(&dum
->lock
, flags
);
901 dum
->pullup
= (value
!= 0);
902 set_link_state(dum_hcd
);
903 spin_unlock_irqrestore(&dum
->lock
, flags
);
905 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
909 static void dummy_udc_set_speed(struct usb_gadget
*_gadget
,
910 enum usb_device_speed speed
)
914 dum
= gadget_dev_to_dummy(&_gadget
->dev
);
915 dum
->gadget
.speed
= speed
;
916 dummy_udc_update_ep0(dum
);
919 static int dummy_udc_start(struct usb_gadget
*g
,
920 struct usb_gadget_driver
*driver
);
921 static int dummy_udc_stop(struct usb_gadget
*g
);
923 static const struct usb_gadget_ops dummy_ops
= {
924 .get_frame
= dummy_g_get_frame
,
925 .wakeup
= dummy_wakeup
,
926 .set_selfpowered
= dummy_set_selfpowered
,
927 .pullup
= dummy_pullup
,
928 .udc_start
= dummy_udc_start
,
929 .udc_stop
= dummy_udc_stop
,
930 .udc_set_speed
= dummy_udc_set_speed
,
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
;
970 /* All the speeds we support */
974 case USB_SPEED_SUPER
:
977 dev_err(dummy_dev(dum_hcd
), "Unsupported driver max speed %d\n",
983 * SLAVE side init ... the layer above hardware, which
984 * can't enumerate without help from the driver we're binding.
987 spin_lock_irq(&dum
->lock
);
989 dum
->driver
= driver
;
990 dum
->ints_enabled
= 1;
991 spin_unlock_irq(&dum
->lock
);
996 static int dummy_udc_stop(struct usb_gadget
*g
)
998 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
999 struct dummy
*dum
= dum_hcd
->dum
;
1001 spin_lock_irq(&dum
->lock
);
1002 dum
->ints_enabled
= 0;
1005 /* emulate synchronize_irq(): wait for callbacks to finish */
1006 while (dum
->callback_usage
> 0) {
1007 spin_unlock_irq(&dum
->lock
);
1008 usleep_range(1000, 2000);
1009 spin_lock_irq(&dum
->lock
);
1013 spin_unlock_irq(&dum
->lock
);
1020 /* The gadget structure is stored inside the hcd structure and will be
1021 * released along with it. */
1022 static void init_dummy_udc_hw(struct dummy
*dum
)
1026 INIT_LIST_HEAD(&dum
->gadget
.ep_list
);
1027 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1028 struct dummy_ep
*ep
= &dum
->ep
[i
];
1030 if (!ep_info
[i
].name
)
1032 ep
->ep
.name
= ep_info
[i
].name
;
1033 ep
->ep
.caps
= ep_info
[i
].caps
;
1034 ep
->ep
.ops
= &dummy_ep_ops
;
1035 list_add_tail(&ep
->ep
.ep_list
, &dum
->gadget
.ep_list
);
1036 ep
->halted
= ep
->wedged
= ep
->already_seen
=
1037 ep
->setup_stage
= 0;
1038 usb_ep_set_maxpacket_limit(&ep
->ep
, ~0);
1039 ep
->ep
.max_streams
= 16;
1040 ep
->last_io
= jiffies
;
1041 ep
->gadget
= &dum
->gadget
;
1043 INIT_LIST_HEAD(&ep
->queue
);
1046 dum
->gadget
.ep0
= &dum
->ep
[0].ep
;
1047 list_del_init(&dum
->ep
[0].ep
.ep_list
);
1048 INIT_LIST_HEAD(&dum
->fifo_req
.queue
);
1050 #ifdef CONFIG_USB_OTG
1051 dum
->gadget
.is_otg
= 1;
1055 static int dummy_udc_probe(struct platform_device
*pdev
)
1060 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
1061 /* Clear usb_gadget region for new registration to udc-core */
1062 memzero_explicit(&dum
->gadget
, sizeof(struct usb_gadget
));
1063 dum
->gadget
.name
= gadget_name
;
1064 dum
->gadget
.ops
= &dummy_ops
;
1065 if (mod_data
.is_super_speed
)
1066 dum
->gadget
.max_speed
= USB_SPEED_SUPER
;
1067 else if (mod_data
.is_high_speed
)
1068 dum
->gadget
.max_speed
= USB_SPEED_HIGH
;
1070 dum
->gadget
.max_speed
= USB_SPEED_FULL
;
1072 dum
->gadget
.dev
.parent
= &pdev
->dev
;
1073 init_dummy_udc_hw(dum
);
1075 rc
= usb_add_gadget_udc(&pdev
->dev
, &dum
->gadget
);
1079 rc
= device_create_file(&dum
->gadget
.dev
, &dev_attr_function
);
1082 platform_set_drvdata(pdev
, dum
);
1086 usb_del_gadget_udc(&dum
->gadget
);
1091 static int dummy_udc_remove(struct platform_device
*pdev
)
1093 struct dummy
*dum
= platform_get_drvdata(pdev
);
1095 device_remove_file(&dum
->gadget
.dev
, &dev_attr_function
);
1096 usb_del_gadget_udc(&dum
->gadget
);
1100 static void dummy_udc_pm(struct dummy
*dum
, struct dummy_hcd
*dum_hcd
,
1103 spin_lock_irq(&dum
->lock
);
1104 dum
->udc_suspended
= suspend
;
1105 set_link_state(dum_hcd
);
1106 spin_unlock_irq(&dum
->lock
);
1109 static int dummy_udc_suspend(struct platform_device
*pdev
, pm_message_t state
)
1111 struct dummy
*dum
= platform_get_drvdata(pdev
);
1112 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1114 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1115 dummy_udc_pm(dum
, dum_hcd
, 1);
1116 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1120 static int dummy_udc_resume(struct platform_device
*pdev
)
1122 struct dummy
*dum
= platform_get_drvdata(pdev
);
1123 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1125 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1126 dummy_udc_pm(dum
, dum_hcd
, 0);
1127 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1131 static struct platform_driver dummy_udc_driver
= {
1132 .probe
= dummy_udc_probe
,
1133 .remove
= dummy_udc_remove
,
1134 .suspend
= dummy_udc_suspend
,
1135 .resume
= dummy_udc_resume
,
1137 .name
= gadget_name
,
1141 /*-------------------------------------------------------------------------*/
1143 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor
*desc
)
1147 index
= usb_endpoint_num(desc
) << 1;
1148 if (usb_endpoint_dir_in(desc
))
1153 /* MASTER/HOST SIDE DRIVER
1155 * this uses the hcd framework to hook up to host side drivers.
1156 * its root hub will only have one device, otherwise it acts like
1157 * a normal host controller.
1159 * when urbs are queued, they're just stuck on a list that we
1160 * scan in a timer callback. that callback connects writes from
1161 * the host with reads from the device, and so on, based on the
1165 static int dummy_ep_stream_en(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1167 const struct usb_endpoint_descriptor
*desc
= &urb
->ep
->desc
;
1170 if (!usb_endpoint_xfer_bulk(desc
))
1173 index
= dummy_get_ep_idx(desc
);
1174 return (1 << index
) & dum_hcd
->stream_en_ep
;
1178 * The max stream number is saved as a nibble so for the 30 possible endpoints
1179 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1180 * means we use only 1 stream). The maximum according to the spec is 16bit so
1181 * if the 16 stream limit is about to go, the array size should be incremented
1182 * to 30 elements of type u16.
1184 static int get_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1189 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1190 if (usb_pipeout(pipe
))
1198 static void set_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1199 unsigned int pipe
, unsigned int streams
)
1204 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1205 if (usb_pipeout(pipe
)) {
1209 max_streams
&= 0xf0;
1211 max_streams
|= streams
;
1212 dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)] = max_streams
;
1215 static int dummy_validate_stream(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1217 unsigned int max_streams
;
1220 enabled
= dummy_ep_stream_en(dum_hcd
, urb
);
1221 if (!urb
->stream_id
) {
1229 max_streams
= get_max_streams_for_pipe(dum_hcd
,
1230 usb_pipeendpoint(urb
->pipe
));
1231 if (urb
->stream_id
> max_streams
) {
1232 dev_err(dummy_dev(dum_hcd
), "Stream id %d is out of range.\n",
1240 static int dummy_urb_enqueue(
1241 struct usb_hcd
*hcd
,
1245 struct dummy_hcd
*dum_hcd
;
1247 unsigned long flags
;
1250 urbp
= kmalloc(sizeof *urbp
, mem_flags
);
1254 urbp
->miter_started
= 0;
1256 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1257 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1259 rc
= dummy_validate_stream(dum_hcd
, urb
);
1265 rc
= usb_hcd_link_urb_to_ep(hcd
, urb
);
1271 if (!dum_hcd
->udev
) {
1272 dum_hcd
->udev
= urb
->dev
;
1273 usb_get_dev(dum_hcd
->udev
);
1274 } else if (unlikely(dum_hcd
->udev
!= urb
->dev
))
1275 dev_err(dummy_dev(dum_hcd
), "usb_device address has changed!\n");
1277 list_add_tail(&urbp
->urbp_list
, &dum_hcd
->urbp_list
);
1279 if (!dum_hcd
->next_frame_urbp
)
1280 dum_hcd
->next_frame_urbp
= urbp
;
1281 if (usb_pipetype(urb
->pipe
) == PIPE_CONTROL
)
1282 urb
->error_count
= 1; /* mark as a new urb */
1284 /* kick the scheduler, it'll do the rest */
1285 if (!timer_pending(&dum_hcd
->timer
))
1286 mod_timer(&dum_hcd
->timer
, jiffies
+ 1);
1289 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1293 static int dummy_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1295 struct dummy_hcd
*dum_hcd
;
1296 unsigned long flags
;
1299 /* giveback happens automatically in timer callback,
1300 * so make sure the callback happens */
1301 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1302 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1304 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
1305 if (!rc
&& dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
&&
1306 !list_empty(&dum_hcd
->urbp_list
))
1307 mod_timer(&dum_hcd
->timer
, jiffies
);
1309 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1313 static int dummy_perform_transfer(struct urb
*urb
, struct dummy_request
*req
,
1317 struct urbp
*urbp
= urb
->hcpriv
;
1319 struct sg_mapping_iter
*miter
= &urbp
->miter
;
1324 to_host
= usb_urb_dir_in(urb
);
1325 rbuf
= req
->req
.buf
+ req
->req
.actual
;
1327 if (!urb
->num_sgs
) {
1328 ubuf
= urb
->transfer_buffer
+ urb
->actual_length
;
1330 memcpy(ubuf
, rbuf
, len
);
1332 memcpy(rbuf
, ubuf
, len
);
1336 if (!urbp
->miter_started
) {
1337 u32 flags
= SG_MITER_ATOMIC
;
1340 flags
|= SG_MITER_TO_SG
;
1342 flags
|= SG_MITER_FROM_SG
;
1344 sg_miter_start(miter
, urb
->sg
, urb
->num_sgs
, flags
);
1345 urbp
->miter_started
= 1;
1347 next_sg
= sg_miter_next(miter
);
1348 if (next_sg
== false) {
1354 this_sg
= min_t(u32
, len
, miter
->length
);
1355 miter
->consumed
= this_sg
;
1359 memcpy(ubuf
, rbuf
, this_sg
);
1361 memcpy(rbuf
, ubuf
, this_sg
);
1366 next_sg
= sg_miter_next(miter
);
1367 if (next_sg
== false) {
1375 sg_miter_stop(miter
);
1379 /* transfer up to a frame's worth; caller must own lock */
1380 static int transfer(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1381 struct dummy_ep
*ep
, int limit
, int *status
)
1383 struct dummy
*dum
= dum_hcd
->dum
;
1384 struct dummy_request
*req
;
1388 /* if there's no request queued, the device is NAKing; return */
1389 list_for_each_entry(req
, &ep
->queue
, queue
) {
1390 unsigned host_len
, dev_len
, len
;
1391 int is_short
, to_host
;
1394 if (dummy_ep_stream_en(dum_hcd
, urb
)) {
1395 if ((urb
->stream_id
!= req
->req
.stream_id
))
1399 /* 1..N packets of ep->ep.maxpacket each ... the last one
1400 * may be short (including zero length).
1402 * writer can send a zlp explicitly (length 0) or implicitly
1403 * (length mod maxpacket zero, and 'zero' flag); they always
1406 host_len
= urb
->transfer_buffer_length
- urb
->actual_length
;
1407 dev_len
= req
->req
.length
- req
->req
.actual
;
1408 len
= min(host_len
, dev_len
);
1410 /* FIXME update emulated data toggle too */
1412 to_host
= usb_urb_dir_in(urb
);
1413 if (unlikely(len
== 0))
1416 /* not enough bandwidth left? */
1417 if (limit
< ep
->ep
.maxpacket
&& limit
< len
)
1419 len
= min_t(unsigned, len
, limit
);
1423 /* send multiple of maxpacket first, then remainder */
1424 if (len
>= ep
->ep
.maxpacket
) {
1426 if (len
% ep
->ep
.maxpacket
)
1428 len
-= len
% ep
->ep
.maxpacket
;
1433 len
= dummy_perform_transfer(urb
, req
, len
);
1435 ep
->last_io
= jiffies
;
1437 req
->req
.status
= len
;
1441 urb
->actual_length
+= len
;
1442 req
->req
.actual
+= len
;
1446 /* short packets terminate, maybe with overflow/underflow.
1447 * it's only really an error to write too much.
1449 * partially filling a buffer optionally blocks queue advances
1450 * (so completion handlers can clean up the queue) but we don't
1451 * need to emulate such data-in-flight.
1454 if (host_len
== dev_len
) {
1455 req
->req
.status
= 0;
1457 } else if (to_host
) {
1458 req
->req
.status
= 0;
1459 if (dev_len
> host_len
)
1460 *status
= -EOVERFLOW
;
1465 if (host_len
> dev_len
)
1466 req
->req
.status
= -EOVERFLOW
;
1468 req
->req
.status
= 0;
1472 * many requests terminate without a short packet.
1473 * send a zlp if demanded by flags.
1476 if (req
->req
.length
== req
->req
.actual
) {
1477 if (req
->req
.zero
&& to_host
)
1480 req
->req
.status
= 0;
1482 if (urb
->transfer_buffer_length
== urb
->actual_length
) {
1483 if (urb
->transfer_flags
& URB_ZERO_PACKET
&&
1491 /* device side completion --> continuable */
1492 if (req
->req
.status
!= -EINPROGRESS
) {
1493 list_del_init(&req
->queue
);
1495 spin_unlock(&dum
->lock
);
1496 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1497 spin_lock(&dum
->lock
);
1499 /* requests might have been unlinked... */
1503 /* host side completion --> terminate */
1504 if (*status
!= -EINPROGRESS
)
1507 /* rescan to continue with any other queued i/o */
1514 static int periodic_bytes(struct dummy
*dum
, struct dummy_ep
*ep
)
1516 int limit
= ep
->ep
.maxpacket
;
1518 if (dum
->gadget
.speed
== USB_SPEED_HIGH
) {
1521 /* high bandwidth mode */
1522 tmp
= usb_endpoint_maxp_mult(ep
->desc
);
1523 tmp
*= 8 /* applies to entire frame */;
1524 limit
+= limit
* tmp
;
1526 if (dum
->gadget
.speed
== USB_SPEED_SUPER
) {
1527 switch (usb_endpoint_type(ep
->desc
)) {
1528 case USB_ENDPOINT_XFER_ISOC
:
1529 /* Sec. 4.4.8.2 USB3.0 Spec */
1530 limit
= 3 * 16 * 1024 * 8;
1532 case USB_ENDPOINT_XFER_INT
:
1533 /* Sec. 4.4.7.2 USB3.0 Spec */
1534 limit
= 3 * 1024 * 8;
1536 case USB_ENDPOINT_XFER_BULK
:
1544 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1545 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1546 USB_PORT_STAT_SUSPEND)) \
1547 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1549 static struct dummy_ep
*find_endpoint(struct dummy
*dum
, u8 address
)
1553 if (!is_active((dum
->gadget
.speed
== USB_SPEED_SUPER
?
1554 dum
->ss_hcd
: dum
->hs_hcd
)))
1556 if (!dum
->ints_enabled
)
1558 if ((address
& ~USB_DIR_IN
) == 0)
1560 for (i
= 1; i
< DUMMY_ENDPOINTS
; i
++) {
1561 struct dummy_ep
*ep
= &dum
->ep
[i
];
1565 if (ep
->desc
->bEndpointAddress
== address
)
1573 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1574 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1575 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1576 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1577 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1578 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1582 * handle_control_request() - handles all control transfers
1583 * @dum: pointer to dummy (the_controller)
1584 * @urb: the urb request to handle
1585 * @setup: pointer to the setup data for a USB device control
1587 * @status: pointer to request handling status
1589 * Return 0 - if the request was handled
1590 * 1 - if the request wasn't handles
1591 * error code on error
1593 static int handle_control_request(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1594 struct usb_ctrlrequest
*setup
,
1597 struct dummy_ep
*ep2
;
1598 struct dummy
*dum
= dum_hcd
->dum
;
1603 w_index
= le16_to_cpu(setup
->wIndex
);
1604 w_value
= le16_to_cpu(setup
->wValue
);
1605 switch (setup
->bRequest
) {
1606 case USB_REQ_SET_ADDRESS
:
1607 if (setup
->bRequestType
!= Dev_Request
)
1609 dum
->address
= w_value
;
1611 dev_dbg(udc_dev(dum
), "set_address = %d\n",
1615 case USB_REQ_SET_FEATURE
:
1616 if (setup
->bRequestType
== Dev_Request
) {
1619 case USB_DEVICE_REMOTE_WAKEUP
:
1621 case USB_DEVICE_B_HNP_ENABLE
:
1622 dum
->gadget
.b_hnp_enable
= 1;
1624 case USB_DEVICE_A_HNP_SUPPORT
:
1625 dum
->gadget
.a_hnp_support
= 1;
1627 case USB_DEVICE_A_ALT_HNP_SUPPORT
:
1628 dum
->gadget
.a_alt_hnp_support
= 1;
1630 case USB_DEVICE_U1_ENABLE
:
1631 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1633 w_value
= USB_DEV_STAT_U1_ENABLED
;
1635 ret_val
= -EOPNOTSUPP
;
1637 case USB_DEVICE_U2_ENABLE
:
1638 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1640 w_value
= USB_DEV_STAT_U2_ENABLED
;
1642 ret_val
= -EOPNOTSUPP
;
1644 case USB_DEVICE_LTM_ENABLE
:
1645 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1647 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1649 ret_val
= -EOPNOTSUPP
;
1652 ret_val
= -EOPNOTSUPP
;
1655 dum
->devstatus
|= (1 << w_value
);
1658 } else if (setup
->bRequestType
== Ep_Request
) {
1660 ep2
= find_endpoint(dum
, w_index
);
1661 if (!ep2
|| ep2
->ep
.name
== ep0name
) {
1662 ret_val
= -EOPNOTSUPP
;
1670 case USB_REQ_CLEAR_FEATURE
:
1671 if (setup
->bRequestType
== Dev_Request
) {
1674 case USB_DEVICE_REMOTE_WAKEUP
:
1675 w_value
= USB_DEVICE_REMOTE_WAKEUP
;
1677 case USB_DEVICE_U1_ENABLE
:
1678 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1680 w_value
= USB_DEV_STAT_U1_ENABLED
;
1682 ret_val
= -EOPNOTSUPP
;
1684 case USB_DEVICE_U2_ENABLE
:
1685 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1687 w_value
= USB_DEV_STAT_U2_ENABLED
;
1689 ret_val
= -EOPNOTSUPP
;
1691 case USB_DEVICE_LTM_ENABLE
:
1692 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1694 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1696 ret_val
= -EOPNOTSUPP
;
1699 ret_val
= -EOPNOTSUPP
;
1703 dum
->devstatus
&= ~(1 << w_value
);
1706 } else if (setup
->bRequestType
== Ep_Request
) {
1708 ep2
= find_endpoint(dum
, w_index
);
1710 ret_val
= -EOPNOTSUPP
;
1719 case USB_REQ_GET_STATUS
:
1720 if (setup
->bRequestType
== Dev_InRequest
1721 || setup
->bRequestType
== Intf_InRequest
1722 || setup
->bRequestType
== Ep_InRequest
) {
1725 * device: remote wakeup, selfpowered
1726 * interface: nothing
1729 buf
= (char *)urb
->transfer_buffer
;
1730 if (urb
->transfer_buffer_length
> 0) {
1731 if (setup
->bRequestType
== Ep_InRequest
) {
1732 ep2
= find_endpoint(dum
, w_index
);
1734 ret_val
= -EOPNOTSUPP
;
1737 buf
[0] = ep2
->halted
;
1738 } else if (setup
->bRequestType
==
1740 buf
[0] = (u8
)dum
->devstatus
;
1744 if (urb
->transfer_buffer_length
> 1)
1746 urb
->actual_length
= min_t(u32
, 2,
1747 urb
->transfer_buffer_length
);
1756 /* drive both sides of the transfers; looks like irq handlers to
1757 * both drivers except the callbacks aren't in_irq().
1759 static void dummy_timer(struct timer_list
*t
)
1761 struct dummy_hcd
*dum_hcd
= from_timer(dum_hcd
, t
, timer
);
1762 struct dummy
*dum
= dum_hcd
->dum
;
1763 struct urbp
*urbp
, *tmp
;
1764 unsigned long flags
;
1768 /* simplistic model for one frame's bandwidth */
1769 /* FIXME: account for transaction and packet overhead */
1770 switch (dum
->gadget
.speed
) {
1772 total
= 8/*bytes*/ * 12/*packets*/;
1774 case USB_SPEED_FULL
:
1775 total
= 64/*bytes*/ * 19/*packets*/;
1777 case USB_SPEED_HIGH
:
1778 total
= 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1780 case USB_SPEED_SUPER
:
1781 /* Bus speed is 500000 bytes/ms, so use a little less */
1784 default: /* Can't happen */
1785 dev_err(dummy_dev(dum_hcd
), "bogus device speed\n");
1790 /* FIXME if HZ != 1000 this will probably misbehave ... */
1792 /* look at each urb queued by the host side driver */
1793 spin_lock_irqsave(&dum
->lock
, flags
);
1795 if (!dum_hcd
->udev
) {
1796 dev_err(dummy_dev(dum_hcd
),
1797 "timer fired with no URBs pending?\n");
1798 spin_unlock_irqrestore(&dum
->lock
, flags
);
1801 dum_hcd
->next_frame_urbp
= NULL
;
1803 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1804 if (!ep_info
[i
].name
)
1806 dum
->ep
[i
].already_seen
= 0;
1810 list_for_each_entry_safe(urbp
, tmp
, &dum_hcd
->urbp_list
, urbp_list
) {
1812 struct dummy_request
*req
;
1814 struct dummy_ep
*ep
= NULL
;
1815 int status
= -EINPROGRESS
;
1817 /* stop when we reach URBs queued after the timer interrupt */
1818 if (urbp
== dum_hcd
->next_frame_urbp
)
1824 else if (dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
)
1827 /* Used up this frame's bandwidth? */
1831 /* find the gadget's ep for this request (if configured) */
1832 address
= usb_pipeendpoint (urb
->pipe
);
1833 if (usb_urb_dir_in(urb
))
1834 address
|= USB_DIR_IN
;
1835 ep
= find_endpoint(dum
, address
);
1837 /* set_configuration() disagreement */
1838 dev_dbg(dummy_dev(dum_hcd
),
1839 "no ep configured for urb %p\n",
1845 if (ep
->already_seen
)
1847 ep
->already_seen
= 1;
1848 if (ep
== &dum
->ep
[0] && urb
->error_count
) {
1849 ep
->setup_stage
= 1; /* a new urb */
1850 urb
->error_count
= 0;
1852 if (ep
->halted
&& !ep
->setup_stage
) {
1853 /* NOTE: must not be iso! */
1854 dev_dbg(dummy_dev(dum_hcd
), "ep %s halted, urb %p\n",
1859 /* FIXME make sure both ends agree on maxpacket */
1861 /* handle control requests */
1862 if (ep
== &dum
->ep
[0] && ep
->setup_stage
) {
1863 struct usb_ctrlrequest setup
;
1866 setup
= *(struct usb_ctrlrequest
*) urb
->setup_packet
;
1867 /* paranoia, in case of stale queued data */
1868 list_for_each_entry(req
, &ep
->queue
, queue
) {
1869 list_del_init(&req
->queue
);
1870 req
->req
.status
= -EOVERFLOW
;
1871 dev_dbg(udc_dev(dum
), "stale req = %p\n",
1874 spin_unlock(&dum
->lock
);
1875 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1876 spin_lock(&dum
->lock
);
1877 ep
->already_seen
= 0;
1881 /* gadget driver never sees set_address or operations
1882 * on standard feature flags. some hardware doesn't
1885 ep
->last_io
= jiffies
;
1886 ep
->setup_stage
= 0;
1889 value
= handle_control_request(dum_hcd
, urb
, &setup
,
1892 /* gadget driver handles all other requests. block
1893 * until setup() returns; no reentrancy issues etc.
1896 ++dum
->callback_usage
;
1897 spin_unlock(&dum
->lock
);
1898 value
= dum
->driver
->setup(&dum
->gadget
,
1900 spin_lock(&dum
->lock
);
1901 --dum
->callback_usage
;
1904 /* no delays (max 64KB data stage) */
1906 goto treat_control_like_bulk
;
1908 /* error, see below */
1912 if (value
!= -EOPNOTSUPP
)
1913 dev_dbg(udc_dev(dum
),
1917 urb
->actual_length
= 0;
1923 /* non-control requests */
1925 switch (usb_pipetype(urb
->pipe
)) {
1926 case PIPE_ISOCHRONOUS
:
1928 * We don't support isochronous. But if we did,
1929 * here are some of the issues we'd have to face:
1931 * Is it urb->interval since the last xfer?
1932 * Use urb->iso_frame_desc[i].
1933 * Complete whether or not ep has requests queued.
1934 * Report random errors, to debug drivers.
1936 limit
= max(limit
, periodic_bytes(dum
, ep
));
1937 status
= -EINVAL
; /* fail all xfers */
1940 case PIPE_INTERRUPT
:
1941 /* FIXME is it urb->interval since the last xfer?
1942 * this almost certainly polls too fast.
1944 limit
= max(limit
, periodic_bytes(dum
, ep
));
1948 treat_control_like_bulk
:
1949 ep
->last_io
= jiffies
;
1950 total
-= transfer(dum_hcd
, urb
, ep
, limit
, &status
);
1954 /* incomplete transfer? */
1955 if (status
== -EINPROGRESS
)
1959 list_del(&urbp
->urbp_list
);
1962 ep
->already_seen
= ep
->setup_stage
= 0;
1964 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd
), urb
);
1965 spin_unlock(&dum
->lock
);
1966 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd
), urb
, status
);
1967 spin_lock(&dum
->lock
);
1972 if (list_empty(&dum_hcd
->urbp_list
)) {
1973 usb_put_dev(dum_hcd
->udev
);
1974 dum_hcd
->udev
= NULL
;
1975 } else if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
1976 /* want a 1 msec delay here */
1977 mod_timer(&dum_hcd
->timer
, jiffies
+ msecs_to_jiffies(1));
1980 spin_unlock_irqrestore(&dum
->lock
, flags
);
1983 /*-------------------------------------------------------------------------*/
1985 #define PORT_C_MASK \
1986 ((USB_PORT_STAT_C_CONNECTION \
1987 | USB_PORT_STAT_C_ENABLE \
1988 | USB_PORT_STAT_C_SUSPEND \
1989 | USB_PORT_STAT_C_OVERCURRENT \
1990 | USB_PORT_STAT_C_RESET) << 16)
1992 static int dummy_hub_status(struct usb_hcd
*hcd
, char *buf
)
1994 struct dummy_hcd
*dum_hcd
;
1995 unsigned long flags
;
1998 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2000 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2001 if (!HCD_HW_ACCESSIBLE(hcd
))
2004 if (dum_hcd
->resuming
&& time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2005 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
2006 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
2007 set_link_state(dum_hcd
);
2010 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0) {
2012 dev_dbg(dummy_dev(dum_hcd
), "port status 0x%08x has changes\n",
2013 dum_hcd
->port_status
);
2015 if (dum_hcd
->rh_state
== DUMMY_RH_SUSPENDED
)
2016 usb_hcd_resume_root_hub(hcd
);
2019 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2023 /* usb 3.0 root hub device descriptor */
2025 struct usb_bos_descriptor bos
;
2026 struct usb_ss_cap_descriptor ss_cap
;
2027 } __packed usb3_bos_desc
= {
2030 .bLength
= USB_DT_BOS_SIZE
,
2031 .bDescriptorType
= USB_DT_BOS
,
2032 .wTotalLength
= cpu_to_le16(sizeof(usb3_bos_desc
)),
2033 .bNumDeviceCaps
= 1,
2036 .bLength
= USB_DT_USB_SS_CAP_SIZE
,
2037 .bDescriptorType
= USB_DT_DEVICE_CAPABILITY
,
2038 .bDevCapabilityType
= USB_SS_CAP_TYPE
,
2039 .wSpeedSupported
= cpu_to_le16(USB_5GBPS_OPERATION
),
2040 .bFunctionalitySupport
= ilog2(USB_5GBPS_OPERATION
),
2045 ss_hub_descriptor(struct usb_hub_descriptor
*desc
)
2047 memset(desc
, 0, sizeof *desc
);
2048 desc
->bDescriptorType
= USB_DT_SS_HUB
;
2049 desc
->bDescLength
= 12;
2050 desc
->wHubCharacteristics
= cpu_to_le16(
2051 HUB_CHAR_INDV_PORT_LPSM
|
2052 HUB_CHAR_COMMON_OCPM
);
2053 desc
->bNbrPorts
= 1;
2054 desc
->u
.ss
.bHubHdrDecLat
= 0x04; /* Worst case: 0.4 micro sec*/
2055 desc
->u
.ss
.DeviceRemovable
= 0;
2058 static inline void hub_descriptor(struct usb_hub_descriptor
*desc
)
2060 memset(desc
, 0, sizeof *desc
);
2061 desc
->bDescriptorType
= USB_DT_HUB
;
2062 desc
->bDescLength
= 9;
2063 desc
->wHubCharacteristics
= cpu_to_le16(
2064 HUB_CHAR_INDV_PORT_LPSM
|
2065 HUB_CHAR_COMMON_OCPM
);
2066 desc
->bNbrPorts
= 1;
2067 desc
->u
.hs
.DeviceRemovable
[0] = 0;
2068 desc
->u
.hs
.DeviceRemovable
[1] = 0xff; /* PortPwrCtrlMask */
2071 static int dummy_hub_control(
2072 struct usb_hcd
*hcd
,
2079 struct dummy_hcd
*dum_hcd
;
2081 unsigned long flags
;
2083 if (!HCD_HW_ACCESSIBLE(hcd
))
2086 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2088 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2090 case ClearHubFeature
:
2092 case ClearPortFeature
:
2094 case USB_PORT_FEAT_SUSPEND
:
2095 if (hcd
->speed
== HCD_USB3
) {
2096 dev_dbg(dummy_dev(dum_hcd
),
2097 "USB_PORT_FEAT_SUSPEND req not "
2098 "supported for USB 3.0 roothub\n");
2101 if (dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) {
2102 /* 20msec resume signaling */
2103 dum_hcd
->resuming
= 1;
2104 dum_hcd
->re_timeout
= jiffies
+
2105 msecs_to_jiffies(20);
2108 case USB_PORT_FEAT_POWER
:
2109 dev_dbg(dummy_dev(dum_hcd
), "power-off\n");
2110 if (hcd
->speed
== HCD_USB3
)
2111 dum_hcd
->port_status
&= ~USB_SS_PORT_STAT_POWER
;
2113 dum_hcd
->port_status
&= ~USB_PORT_STAT_POWER
;
2114 set_link_state(dum_hcd
);
2117 dum_hcd
->port_status
&= ~(1 << wValue
);
2118 set_link_state(dum_hcd
);
2121 case GetHubDescriptor
:
2122 if (hcd
->speed
== HCD_USB3
&&
2123 (wLength
< USB_DT_SS_HUB_SIZE
||
2124 wValue
!= (USB_DT_SS_HUB
<< 8))) {
2125 dev_dbg(dummy_dev(dum_hcd
),
2126 "Wrong hub descriptor type for "
2127 "USB 3.0 roothub.\n");
2130 if (hcd
->speed
== HCD_USB3
)
2131 ss_hub_descriptor((struct usb_hub_descriptor
*) buf
);
2133 hub_descriptor((struct usb_hub_descriptor
*) buf
);
2136 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
2137 if (hcd
->speed
!= HCD_USB3
)
2140 if ((wValue
>> 8) != USB_DT_BOS
)
2143 memcpy(buf
, &usb3_bos_desc
, sizeof(usb3_bos_desc
));
2144 retval
= sizeof(usb3_bos_desc
);
2148 *(__le32
*) buf
= cpu_to_le32(0);
2154 /* whoever resets or resumes must GetPortStatus to
2157 if (dum_hcd
->resuming
&&
2158 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2159 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
2160 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
2162 if ((dum_hcd
->port_status
& USB_PORT_STAT_RESET
) != 0 &&
2163 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2164 dum_hcd
->port_status
|= (USB_PORT_STAT_C_RESET
<< 16);
2165 dum_hcd
->port_status
&= ~USB_PORT_STAT_RESET
;
2166 if (dum_hcd
->dum
->pullup
) {
2167 dum_hcd
->port_status
|= USB_PORT_STAT_ENABLE
;
2169 if (hcd
->speed
< HCD_USB3
) {
2170 switch (dum_hcd
->dum
->gadget
.speed
) {
2171 case USB_SPEED_HIGH
:
2172 dum_hcd
->port_status
|=
2173 USB_PORT_STAT_HIGH_SPEED
;
2176 dum_hcd
->dum
->gadget
.ep0
->
2178 dum_hcd
->port_status
|=
2179 USB_PORT_STAT_LOW_SPEED
;
2187 set_link_state(dum_hcd
);
2188 ((__le16
*) buf
)[0] = cpu_to_le16(dum_hcd
->port_status
);
2189 ((__le16
*) buf
)[1] = cpu_to_le16(dum_hcd
->port_status
>> 16);
2194 case SetPortFeature
:
2196 case USB_PORT_FEAT_LINK_STATE
:
2197 if (hcd
->speed
!= HCD_USB3
) {
2198 dev_dbg(dummy_dev(dum_hcd
),
2199 "USB_PORT_FEAT_LINK_STATE req not "
2200 "supported for USB 2.0 roothub\n");
2204 * Since this is dummy we don't have an actual link so
2205 * there is nothing to do for the SET_LINK_STATE cmd
2208 case USB_PORT_FEAT_U1_TIMEOUT
:
2209 case USB_PORT_FEAT_U2_TIMEOUT
:
2210 /* TODO: add suspend/resume support! */
2211 if (hcd
->speed
!= HCD_USB3
) {
2212 dev_dbg(dummy_dev(dum_hcd
),
2213 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2214 "supported for USB 2.0 roothub\n");
2218 case USB_PORT_FEAT_SUSPEND
:
2219 /* Applicable only for USB2.0 hub */
2220 if (hcd
->speed
== HCD_USB3
) {
2221 dev_dbg(dummy_dev(dum_hcd
),
2222 "USB_PORT_FEAT_SUSPEND req not "
2223 "supported for USB 3.0 roothub\n");
2226 if (dum_hcd
->active
) {
2227 dum_hcd
->port_status
|= USB_PORT_STAT_SUSPEND
;
2229 /* HNP would happen here; for now we
2230 * assume b_bus_req is always true.
2232 set_link_state(dum_hcd
);
2233 if (((1 << USB_DEVICE_B_HNP_ENABLE
)
2234 & dum_hcd
->dum
->devstatus
) != 0)
2235 dev_dbg(dummy_dev(dum_hcd
),
2239 case USB_PORT_FEAT_POWER
:
2240 if (hcd
->speed
== HCD_USB3
)
2241 dum_hcd
->port_status
|= USB_SS_PORT_STAT_POWER
;
2243 dum_hcd
->port_status
|= USB_PORT_STAT_POWER
;
2244 set_link_state(dum_hcd
);
2246 case USB_PORT_FEAT_BH_PORT_RESET
:
2247 /* Applicable only for USB3.0 hub */
2248 if (hcd
->speed
!= HCD_USB3
) {
2249 dev_dbg(dummy_dev(dum_hcd
),
2250 "USB_PORT_FEAT_BH_PORT_RESET req not "
2251 "supported for USB 2.0 roothub\n");
2255 case USB_PORT_FEAT_RESET
:
2256 /* if it's already enabled, disable */
2257 if (hcd
->speed
== HCD_USB3
) {
2258 dum_hcd
->port_status
= 0;
2259 dum_hcd
->port_status
=
2260 (USB_SS_PORT_STAT_POWER
|
2261 USB_PORT_STAT_CONNECTION
|
2262 USB_PORT_STAT_RESET
);
2264 dum_hcd
->port_status
&= ~(USB_PORT_STAT_ENABLE
2265 | USB_PORT_STAT_LOW_SPEED
2266 | USB_PORT_STAT_HIGH_SPEED
);
2268 * We want to reset device status. All but the
2269 * Self powered feature
2271 dum_hcd
->dum
->devstatus
&=
2272 (1 << USB_DEVICE_SELF_POWERED
);
2274 * FIXME USB3.0: what is the correct reset signaling
2275 * interval? Is it still 50msec as for HS?
2277 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(50);
2280 if (hcd
->speed
== HCD_USB3
) {
2281 if ((dum_hcd
->port_status
&
2282 USB_SS_PORT_STAT_POWER
) != 0) {
2283 dum_hcd
->port_status
|= (1 << wValue
);
2286 if ((dum_hcd
->port_status
&
2287 USB_PORT_STAT_POWER
) != 0) {
2288 dum_hcd
->port_status
|= (1 << wValue
);
2290 set_link_state(dum_hcd
);
2293 case GetPortErrorCount
:
2294 if (hcd
->speed
!= HCD_USB3
) {
2295 dev_dbg(dummy_dev(dum_hcd
),
2296 "GetPortErrorCount req not "
2297 "supported for USB 2.0 roothub\n");
2300 /* We'll always return 0 since this is a dummy hub */
2301 *(__le32
*) buf
= cpu_to_le32(0);
2304 if (hcd
->speed
!= HCD_USB3
) {
2305 dev_dbg(dummy_dev(dum_hcd
),
2306 "SetHubDepth req not supported for "
2307 "USB 2.0 roothub\n");
2312 dev_dbg(dummy_dev(dum_hcd
),
2313 "hub control req%04x v%04x i%04x l%d\n",
2314 typeReq
, wValue
, wIndex
, wLength
);
2316 /* "protocol stall" on error */
2319 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2321 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0)
2322 usb_hcd_poll_rh_status(hcd
);
2326 static int dummy_bus_suspend(struct usb_hcd
*hcd
)
2328 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2330 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2332 spin_lock_irq(&dum_hcd
->dum
->lock
);
2333 dum_hcd
->rh_state
= DUMMY_RH_SUSPENDED
;
2334 set_link_state(dum_hcd
);
2335 hcd
->state
= HC_STATE_SUSPENDED
;
2336 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2340 static int dummy_bus_resume(struct usb_hcd
*hcd
)
2342 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2345 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2347 spin_lock_irq(&dum_hcd
->dum
->lock
);
2348 if (!HCD_HW_ACCESSIBLE(hcd
)) {
2351 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2352 set_link_state(dum_hcd
);
2353 if (!list_empty(&dum_hcd
->urbp_list
))
2354 mod_timer(&dum_hcd
->timer
, jiffies
);
2355 hcd
->state
= HC_STATE_RUNNING
;
2357 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2361 /*-------------------------------------------------------------------------*/
2363 static inline ssize_t
show_urb(char *buf
, size_t size
, struct urb
*urb
)
2365 int ep
= usb_pipeendpoint(urb
->pipe
);
2367 return scnprintf(buf
, size
,
2368 "urb/%p %s ep%d%s%s len %d/%d\n",
2371 switch (urb
->dev
->speed
) {
2375 case USB_SPEED_FULL
:
2378 case USB_SPEED_HIGH
:
2381 case USB_SPEED_SUPER
:
2388 ep
, ep
? (usb_urb_dir_in(urb
) ? "in" : "out") : "",
2390 switch (usb_pipetype(urb
->pipe
)) { \
2391 case PIPE_CONTROL
: \
2397 case PIPE_INTERRUPT
: \
2404 urb
->actual_length
, urb
->transfer_buffer_length
);
2407 static ssize_t
urbs_show(struct device
*dev
, struct device_attribute
*attr
,
2410 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
2411 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2414 unsigned long flags
;
2416 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2417 list_for_each_entry(urbp
, &dum_hcd
->urbp_list
, urbp_list
) {
2420 temp
= show_urb(buf
, PAGE_SIZE
- size
, urbp
->urb
);
2424 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2428 static DEVICE_ATTR_RO(urbs
);
2430 static int dummy_start_ss(struct dummy_hcd
*dum_hcd
)
2432 timer_setup(&dum_hcd
->timer
, dummy_timer
, 0);
2433 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2434 dum_hcd
->stream_en_ep
= 0;
2435 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2436 dummy_hcd_to_hcd(dum_hcd
)->power_budget
= POWER_BUDGET_3
;
2437 dummy_hcd_to_hcd(dum_hcd
)->state
= HC_STATE_RUNNING
;
2438 dummy_hcd_to_hcd(dum_hcd
)->uses_new_polling
= 1;
2439 #ifdef CONFIG_USB_OTG
2440 dummy_hcd_to_hcd(dum_hcd
)->self
.otg_port
= 1;
2444 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2445 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2448 static int dummy_start(struct usb_hcd
*hcd
)
2450 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2453 * MASTER side init ... we emulate a root hub that'll only ever
2454 * talk to one device (the slave side). Also appears in sysfs,
2455 * just like more familiar pci-based HCDs.
2457 if (!usb_hcd_is_primary_hcd(hcd
))
2458 return dummy_start_ss(dum_hcd
);
2460 spin_lock_init(&dum_hcd
->dum
->lock
);
2461 timer_setup(&dum_hcd
->timer
, dummy_timer
, 0);
2462 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2464 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2466 hcd
->power_budget
= POWER_BUDGET
;
2467 hcd
->state
= HC_STATE_RUNNING
;
2468 hcd
->uses_new_polling
= 1;
2470 #ifdef CONFIG_USB_OTG
2471 hcd
->self
.otg_port
= 1;
2474 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2475 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2478 static void dummy_stop(struct usb_hcd
*hcd
)
2480 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd
)), &dev_attr_urbs
);
2481 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd
)), "stopped\n");
2484 /*-------------------------------------------------------------------------*/
2486 static int dummy_h_get_frame(struct usb_hcd
*hcd
)
2488 return dummy_g_get_frame(NULL
);
2491 static int dummy_setup(struct usb_hcd
*hcd
)
2495 dum
= *((void **)dev_get_platdata(hcd
->self
.controller
));
2496 hcd
->self
.sg_tablesize
= ~0;
2497 if (usb_hcd_is_primary_hcd(hcd
)) {
2498 dum
->hs_hcd
= hcd_to_dummy_hcd(hcd
);
2499 dum
->hs_hcd
->dum
= dum
;
2501 * Mark the first roothub as being USB 2.0.
2502 * The USB 3.0 roothub will be registered later by
2505 hcd
->speed
= HCD_USB2
;
2506 hcd
->self
.root_hub
->speed
= USB_SPEED_HIGH
;
2508 dum
->ss_hcd
= hcd_to_dummy_hcd(hcd
);
2509 dum
->ss_hcd
->dum
= dum
;
2510 hcd
->speed
= HCD_USB3
;
2511 hcd
->self
.root_hub
->speed
= USB_SPEED_SUPER
;
2516 /* Change a group of bulk endpoints to support multiple stream IDs */
2517 static int dummy_alloc_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2518 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2519 unsigned int num_streams
, gfp_t mem_flags
)
2521 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2522 unsigned long flags
;
2524 int ret_streams
= num_streams
;
2531 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2532 for (i
= 0; i
< num_eps
; i
++) {
2533 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2534 if ((1 << index
) & dum_hcd
->stream_en_ep
) {
2535 ret_streams
= -EINVAL
;
2538 max_stream
= usb_ss_max_streams(&eps
[i
]->ss_ep_comp
);
2540 ret_streams
= -EINVAL
;
2543 if (max_stream
< ret_streams
) {
2544 dev_dbg(dummy_dev(dum_hcd
), "Ep 0x%x only supports %u "
2546 eps
[i
]->desc
.bEndpointAddress
,
2548 ret_streams
= max_stream
;
2552 for (i
= 0; i
< num_eps
; i
++) {
2553 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2554 dum_hcd
->stream_en_ep
|= 1 << index
;
2555 set_max_streams_for_pipe(dum_hcd
,
2556 usb_endpoint_num(&eps
[i
]->desc
), ret_streams
);
2559 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2563 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2564 static int dummy_free_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2565 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2568 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2569 unsigned long flags
;
2574 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2575 for (i
= 0; i
< num_eps
; i
++) {
2576 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2577 if (!((1 << index
) & dum_hcd
->stream_en_ep
)) {
2583 for (i
= 0; i
< num_eps
; i
++) {
2584 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2585 dum_hcd
->stream_en_ep
&= ~(1 << index
);
2586 set_max_streams_for_pipe(dum_hcd
,
2587 usb_endpoint_num(&eps
[i
]->desc
), 0);
2591 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2595 static struct hc_driver dummy_hcd
= {
2596 .description
= (char *) driver_name
,
2597 .product_desc
= "Dummy host controller",
2598 .hcd_priv_size
= sizeof(struct dummy_hcd
),
2600 .reset
= dummy_setup
,
2601 .start
= dummy_start
,
2604 .urb_enqueue
= dummy_urb_enqueue
,
2605 .urb_dequeue
= dummy_urb_dequeue
,
2607 .get_frame_number
= dummy_h_get_frame
,
2609 .hub_status_data
= dummy_hub_status
,
2610 .hub_control
= dummy_hub_control
,
2611 .bus_suspend
= dummy_bus_suspend
,
2612 .bus_resume
= dummy_bus_resume
,
2614 .alloc_streams
= dummy_alloc_streams
,
2615 .free_streams
= dummy_free_streams
,
2618 static int dummy_hcd_probe(struct platform_device
*pdev
)
2621 struct usb_hcd
*hs_hcd
;
2622 struct usb_hcd
*ss_hcd
;
2625 dev_info(&pdev
->dev
, "%s, driver " DRIVER_VERSION
"\n", driver_desc
);
2626 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
2628 if (mod_data
.is_super_speed
)
2629 dummy_hcd
.flags
= HCD_USB3
| HCD_SHARED
;
2630 else if (mod_data
.is_high_speed
)
2631 dummy_hcd
.flags
= HCD_USB2
;
2633 dummy_hcd
.flags
= HCD_USB11
;
2634 hs_hcd
= usb_create_hcd(&dummy_hcd
, &pdev
->dev
, dev_name(&pdev
->dev
));
2639 retval
= usb_add_hcd(hs_hcd
, 0, 0);
2643 if (mod_data
.is_super_speed
) {
2644 ss_hcd
= usb_create_shared_hcd(&dummy_hcd
, &pdev
->dev
,
2645 dev_name(&pdev
->dev
), hs_hcd
);
2648 goto dealloc_usb2_hcd
;
2651 retval
= usb_add_hcd(ss_hcd
, 0, 0);
2658 usb_put_hcd(ss_hcd
);
2660 usb_remove_hcd(hs_hcd
);
2662 usb_put_hcd(hs_hcd
);
2663 dum
->hs_hcd
= dum
->ss_hcd
= NULL
;
2667 static int dummy_hcd_remove(struct platform_device
*pdev
)
2671 dum
= hcd_to_dummy_hcd(platform_get_drvdata(pdev
))->dum
;
2674 usb_remove_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2675 usb_put_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2678 usb_remove_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2679 usb_put_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2687 static int dummy_hcd_suspend(struct platform_device
*pdev
, pm_message_t state
)
2689 struct usb_hcd
*hcd
;
2690 struct dummy_hcd
*dum_hcd
;
2693 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2695 hcd
= platform_get_drvdata(pdev
);
2696 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2697 if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
2698 dev_warn(&pdev
->dev
, "Root hub isn't suspended!\n");
2701 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2705 static int dummy_hcd_resume(struct platform_device
*pdev
)
2707 struct usb_hcd
*hcd
;
2709 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2711 hcd
= platform_get_drvdata(pdev
);
2712 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2713 usb_hcd_poll_rh_status(hcd
);
2717 static struct platform_driver dummy_hcd_driver
= {
2718 .probe
= dummy_hcd_probe
,
2719 .remove
= dummy_hcd_remove
,
2720 .suspend
= dummy_hcd_suspend
,
2721 .resume
= dummy_hcd_resume
,
2723 .name
= driver_name
,
2727 /*-------------------------------------------------------------------------*/
2728 #define MAX_NUM_UDC 32
2729 static struct platform_device
*the_udc_pdev
[MAX_NUM_UDC
];
2730 static struct platform_device
*the_hcd_pdev
[MAX_NUM_UDC
];
2732 static int __init
init(void)
2734 int retval
= -ENOMEM
;
2736 struct dummy
*dum
[MAX_NUM_UDC
];
2741 if (!mod_data
.is_high_speed
&& mod_data
.is_super_speed
)
2744 if (mod_data
.num
< 1 || mod_data
.num
> MAX_NUM_UDC
) {
2745 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2750 for (i
= 0; i
< mod_data
.num
; i
++) {
2751 the_hcd_pdev
[i
] = platform_device_alloc(driver_name
, i
);
2752 if (!the_hcd_pdev
[i
]) {
2755 platform_device_put(the_hcd_pdev
[i
--]);
2759 for (i
= 0; i
< mod_data
.num
; i
++) {
2760 the_udc_pdev
[i
] = platform_device_alloc(gadget_name
, i
);
2761 if (!the_udc_pdev
[i
]) {
2764 platform_device_put(the_udc_pdev
[i
--]);
2768 for (i
= 0; i
< mod_data
.num
; i
++) {
2769 dum
[i
] = kzalloc(sizeof(struct dummy
), GFP_KERNEL
);
2774 retval
= platform_device_add_data(the_hcd_pdev
[i
], &dum
[i
],
2778 retval
= platform_device_add_data(the_udc_pdev
[i
], &dum
[i
],
2784 retval
= platform_driver_register(&dummy_hcd_driver
);
2787 retval
= platform_driver_register(&dummy_udc_driver
);
2789 goto err_register_udc_driver
;
2791 for (i
= 0; i
< mod_data
.num
; i
++) {
2792 retval
= platform_device_add(the_hcd_pdev
[i
]);
2796 platform_device_del(the_hcd_pdev
[i
--]);
2800 for (i
= 0; i
< mod_data
.num
; i
++) {
2801 if (!dum
[i
]->hs_hcd
||
2802 (!dum
[i
]->ss_hcd
&& mod_data
.is_super_speed
)) {
2804 * The hcd was added successfully but its probe
2805 * function failed for some reason.
2812 for (i
= 0; i
< mod_data
.num
; i
++) {
2813 retval
= platform_device_add(the_udc_pdev
[i
]);
2817 platform_device_del(the_udc_pdev
[i
--]);
2822 for (i
= 0; i
< mod_data
.num
; i
++) {
2823 if (!platform_get_drvdata(the_udc_pdev
[i
])) {
2825 * The udc was added successfully but its probe
2826 * function failed for some reason.
2835 for (i
= 0; i
< mod_data
.num
; i
++)
2836 platform_device_del(the_udc_pdev
[i
]);
2838 for (i
= 0; i
< mod_data
.num
; i
++)
2839 platform_device_del(the_hcd_pdev
[i
]);
2841 platform_driver_unregister(&dummy_udc_driver
);
2842 err_register_udc_driver
:
2843 platform_driver_unregister(&dummy_hcd_driver
);
2845 for (i
= 0; i
< mod_data
.num
; i
++)
2847 for (i
= 0; i
< mod_data
.num
; i
++)
2848 platform_device_put(the_udc_pdev
[i
]);
2850 for (i
= 0; i
< mod_data
.num
; i
++)
2851 platform_device_put(the_hcd_pdev
[i
]);
2856 static void __exit
cleanup(void)
2860 for (i
= 0; i
< mod_data
.num
; i
++) {
2863 dum
= *((void **)dev_get_platdata(&the_udc_pdev
[i
]->dev
));
2865 platform_device_unregister(the_udc_pdev
[i
]);
2866 platform_device_unregister(the_hcd_pdev
[i
]);
2869 platform_driver_unregister(&dummy_udc_driver
);
2870 platform_driver_unregister(&dummy_hcd_driver
);
2872 module_exit(cleanup
);