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
);
508 /* drivers must not request bad settings, since lower levels
509 * (hardware or its drivers) may not check. some endpoints
510 * can't do iso, many have maxpacket limitations, etc.
512 * since this "hardware" driver is here to help debugging, we
513 * have some extra sanity checks. (there could be more though,
514 * especially for "ep9out" style fixed function ones.)
517 switch (usb_endpoint_type(desc
)) {
518 case USB_ENDPOINT_XFER_BULK
:
519 if (strstr(ep
->ep
.name
, "-iso")
520 || strstr(ep
->ep
.name
, "-int")) {
523 switch (dum
->gadget
.speed
) {
524 case USB_SPEED_SUPER
:
533 if (max
== 8 || max
== 16 || max
== 32 || max
== 64)
534 /* we'll fake any legal size */
536 /* save a return statement */
541 case USB_ENDPOINT_XFER_INT
:
542 if (strstr(ep
->ep
.name
, "-iso")) /* bulk is ok */
544 /* real hardware might not handle all packet sizes */
545 switch (dum
->gadget
.speed
) {
546 case USB_SPEED_SUPER
:
550 /* save a return statement */
554 /* save a return statement */
561 case USB_ENDPOINT_XFER_ISOC
:
562 if (strstr(ep
->ep
.name
, "-bulk")
563 || strstr(ep
->ep
.name
, "-int"))
565 /* real hardware might not handle all packet sizes */
566 switch (dum
->gadget
.speed
) {
567 case USB_SPEED_SUPER
:
571 /* save a return statement */
575 /* save a return statement */
581 /* few chips support control except on ep0 */
585 _ep
->maxpacket
= max
;
586 if (usb_ss_max_streams(_ep
->comp_desc
)) {
587 if (!usb_endpoint_xfer_bulk(desc
)) {
588 dev_err(udc_dev(dum
), "Can't enable stream support on "
589 "non-bulk ep %s\n", _ep
->name
);
596 dev_dbg(udc_dev(dum
), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
598 desc
->bEndpointAddress
& 0x0f,
599 (desc
->bEndpointAddress
& USB_DIR_IN
) ? "in" : "out",
601 switch (usb_endpoint_type(desc
)) {
602 case USB_ENDPOINT_XFER_BULK
:
605 case USB_ENDPOINT_XFER_ISOC
:
608 case USB_ENDPOINT_XFER_INT
:
615 max
, ep
->stream_en
? "enabled" : "disabled");
617 /* at this point real hardware should be NAKing transfers
618 * to that endpoint, until a buffer is queued to it.
620 ep
->halted
= ep
->wedged
= 0;
626 static int dummy_disable(struct usb_ep
*_ep
)
632 ep
= usb_ep_to_dummy_ep(_ep
);
633 if (!_ep
|| !ep
->desc
|| _ep
->name
== ep0name
)
635 dum
= ep_to_dummy(ep
);
637 spin_lock_irqsave(&dum
->lock
, flags
);
641 spin_unlock_irqrestore(&dum
->lock
, flags
);
643 dev_dbg(udc_dev(dum
), "disabled %s\n", _ep
->name
);
647 static struct usb_request
*dummy_alloc_request(struct usb_ep
*_ep
,
650 struct dummy_request
*req
;
655 req
= kzalloc(sizeof(*req
), mem_flags
);
658 INIT_LIST_HEAD(&req
->queue
);
662 static void dummy_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
664 struct dummy_request
*req
;
671 req
= usb_request_to_dummy_request(_req
);
672 WARN_ON(!list_empty(&req
->queue
));
676 static void fifo_complete(struct usb_ep
*ep
, struct usb_request
*req
)
680 static int dummy_queue(struct usb_ep
*_ep
, struct usb_request
*_req
,
684 struct dummy_request
*req
;
686 struct dummy_hcd
*dum_hcd
;
689 req
= usb_request_to_dummy_request(_req
);
690 if (!_req
|| !list_empty(&req
->queue
) || !_req
->complete
)
693 ep
= usb_ep_to_dummy_ep(_ep
);
694 if (!_ep
|| (!ep
->desc
&& _ep
->name
!= ep0name
))
697 dum
= ep_to_dummy(ep
);
698 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
699 if (!dum
->driver
|| !is_enabled(dum_hcd
))
703 dev_dbg(udc_dev(dum
), "ep %p queue req %p to %s, len %d buf %p\n",
704 ep
, _req
, _ep
->name
, _req
->length
, _req
->buf
);
706 _req
->status
= -EINPROGRESS
;
708 spin_lock_irqsave(&dum
->lock
, flags
);
710 /* implement an emulated single-request FIFO */
711 if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
712 list_empty(&dum
->fifo_req
.queue
) &&
713 list_empty(&ep
->queue
) &&
714 _req
->length
<= FIFO_SIZE
) {
715 req
= &dum
->fifo_req
;
717 req
->req
.buf
= dum
->fifo_buf
;
718 memcpy(dum
->fifo_buf
, _req
->buf
, _req
->length
);
719 req
->req
.context
= dum
;
720 req
->req
.complete
= fifo_complete
;
722 list_add_tail(&req
->queue
, &ep
->queue
);
723 spin_unlock(&dum
->lock
);
724 _req
->actual
= _req
->length
;
726 usb_gadget_giveback_request(_ep
, _req
);
727 spin_lock(&dum
->lock
);
729 list_add_tail(&req
->queue
, &ep
->queue
);
730 spin_unlock_irqrestore(&dum
->lock
, flags
);
732 /* real hardware would likely enable transfers here, in case
733 * it'd been left NAKing.
738 static int dummy_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
742 int retval
= -EINVAL
;
744 struct dummy_request
*req
= NULL
;
748 ep
= usb_ep_to_dummy_ep(_ep
);
749 dum
= ep_to_dummy(ep
);
754 local_irq_save(flags
);
755 spin_lock(&dum
->lock
);
756 list_for_each_entry(req
, &ep
->queue
, queue
) {
757 if (&req
->req
== _req
) {
758 list_del_init(&req
->queue
);
759 _req
->status
= -ECONNRESET
;
764 spin_unlock(&dum
->lock
);
767 dev_dbg(udc_dev(dum
),
768 "dequeued req %p from %s, len %d buf %p\n",
769 req
, _ep
->name
, _req
->length
, _req
->buf
);
770 usb_gadget_giveback_request(_ep
, _req
);
772 local_irq_restore(flags
);
777 dummy_set_halt_and_wedge(struct usb_ep
*_ep
, int value
, int wedged
)
784 ep
= usb_ep_to_dummy_ep(_ep
);
785 dum
= ep_to_dummy(ep
);
789 ep
->halted
= ep
->wedged
= 0;
790 else if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
791 !list_empty(&ep
->queue
))
798 /* FIXME clear emulated data toggle too */
803 dummy_set_halt(struct usb_ep
*_ep
, int value
)
805 return dummy_set_halt_and_wedge(_ep
, value
, 0);
808 static int dummy_set_wedge(struct usb_ep
*_ep
)
810 if (!_ep
|| _ep
->name
== ep0name
)
812 return dummy_set_halt_and_wedge(_ep
, 1, 1);
815 static const struct usb_ep_ops dummy_ep_ops
= {
816 .enable
= dummy_enable
,
817 .disable
= dummy_disable
,
819 .alloc_request
= dummy_alloc_request
,
820 .free_request
= dummy_free_request
,
822 .queue
= dummy_queue
,
823 .dequeue
= dummy_dequeue
,
825 .set_halt
= dummy_set_halt
,
826 .set_wedge
= dummy_set_wedge
,
829 /*-------------------------------------------------------------------------*/
831 /* there are both host and device side versions of this call ... */
832 static int dummy_g_get_frame(struct usb_gadget
*_gadget
)
834 struct timespec64 ts64
;
836 ktime_get_ts64(&ts64
);
837 return ts64
.tv_nsec
/ NSEC_PER_MSEC
;
840 static int dummy_wakeup(struct usb_gadget
*_gadget
)
842 struct dummy_hcd
*dum_hcd
;
844 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
845 if (!(dum_hcd
->dum
->devstatus
& ((1 << USB_DEVICE_B_HNP_ENABLE
)
846 | (1 << USB_DEVICE_REMOTE_WAKEUP
))))
848 if ((dum_hcd
->port_status
& USB_PORT_STAT_CONNECTION
) == 0)
850 if ((dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) == 0 &&
851 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
854 /* FIXME: What if the root hub is suspended but the port isn't? */
856 /* hub notices our request, issues downstream resume, etc */
857 dum_hcd
->resuming
= 1;
858 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(20);
859 mod_timer(&dummy_hcd_to_hcd(dum_hcd
)->rh_timer
, dum_hcd
->re_timeout
);
863 static int dummy_set_selfpowered(struct usb_gadget
*_gadget
, int value
)
867 _gadget
->is_selfpowered
= (value
!= 0);
868 dum
= gadget_to_dummy_hcd(_gadget
)->dum
;
870 dum
->devstatus
|= (1 << USB_DEVICE_SELF_POWERED
);
872 dum
->devstatus
&= ~(1 << USB_DEVICE_SELF_POWERED
);
876 static void dummy_udc_update_ep0(struct dummy
*dum
)
878 if (dum
->gadget
.speed
== USB_SPEED_SUPER
)
879 dum
->ep
[0].ep
.maxpacket
= 9;
881 dum
->ep
[0].ep
.maxpacket
= 64;
884 static int dummy_pullup(struct usb_gadget
*_gadget
, int value
)
886 struct dummy_hcd
*dum_hcd
;
890 dum
= gadget_dev_to_dummy(&_gadget
->dev
);
892 if (value
&& dum
->driver
) {
893 if (mod_data
.is_super_speed
)
894 dum
->gadget
.speed
= dum
->driver
->max_speed
;
895 else if (mod_data
.is_high_speed
)
896 dum
->gadget
.speed
= min_t(u8
, USB_SPEED_HIGH
,
897 dum
->driver
->max_speed
);
899 dum
->gadget
.speed
= USB_SPEED_FULL
;
900 dummy_udc_update_ep0(dum
);
902 if (dum
->gadget
.speed
< dum
->driver
->max_speed
)
903 dev_dbg(udc_dev(dum
), "This device can perform faster"
904 " if you connect it to a %s port...\n",
905 usb_speed_string(dum
->driver
->max_speed
));
907 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
909 spin_lock_irqsave(&dum
->lock
, flags
);
910 dum
->pullup
= (value
!= 0);
911 set_link_state(dum_hcd
);
912 spin_unlock_irqrestore(&dum
->lock
, flags
);
914 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
918 static int dummy_udc_start(struct usb_gadget
*g
,
919 struct usb_gadget_driver
*driver
);
920 static int dummy_udc_stop(struct usb_gadget
*g
);
922 static const struct usb_gadget_ops dummy_ops
= {
923 .get_frame
= dummy_g_get_frame
,
924 .wakeup
= dummy_wakeup
,
925 .set_selfpowered
= dummy_set_selfpowered
,
926 .pullup
= dummy_pullup
,
927 .udc_start
= dummy_udc_start
,
928 .udc_stop
= dummy_udc_stop
,
931 /*-------------------------------------------------------------------------*/
933 /* "function" sysfs attribute */
934 static ssize_t
function_show(struct device
*dev
, struct device_attribute
*attr
,
937 struct dummy
*dum
= gadget_dev_to_dummy(dev
);
939 if (!dum
->driver
|| !dum
->driver
->function
)
941 return scnprintf(buf
, PAGE_SIZE
, "%s\n", dum
->driver
->function
);
943 static DEVICE_ATTR_RO(function
);
945 /*-------------------------------------------------------------------------*/
948 * Driver registration/unregistration.
950 * This is basically hardware-specific; there's usually only one real USB
951 * device (not host) controller since that's how USB devices are intended
952 * to work. So most implementations of these api calls will rely on the
953 * fact that only one driver will ever bind to the hardware. But curious
954 * hardware can be built with discrete components, so the gadget API doesn't
955 * require that assumption.
957 * For this emulator, it might be convenient to create a usb slave device
958 * for each driver that registers: just add to a big root hub.
961 static int dummy_udc_start(struct usb_gadget
*g
,
962 struct usb_gadget_driver
*driver
)
964 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
965 struct dummy
*dum
= dum_hcd
->dum
;
967 if (driver
->max_speed
== USB_SPEED_UNKNOWN
)
971 * SLAVE side init ... the layer above hardware, which
972 * can't enumerate without help from the driver we're binding.
976 dum
->driver
= driver
;
981 static int dummy_udc_stop(struct usb_gadget
*g
)
983 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
984 struct dummy
*dum
= dum_hcd
->dum
;
993 /* The gadget structure is stored inside the hcd structure and will be
994 * released along with it. */
995 static void init_dummy_udc_hw(struct dummy
*dum
)
999 INIT_LIST_HEAD(&dum
->gadget
.ep_list
);
1000 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1001 struct dummy_ep
*ep
= &dum
->ep
[i
];
1003 if (!ep_info
[i
].name
)
1005 ep
->ep
.name
= ep_info
[i
].name
;
1006 ep
->ep
.caps
= ep_info
[i
].caps
;
1007 ep
->ep
.ops
= &dummy_ep_ops
;
1008 list_add_tail(&ep
->ep
.ep_list
, &dum
->gadget
.ep_list
);
1009 ep
->halted
= ep
->wedged
= ep
->already_seen
=
1010 ep
->setup_stage
= 0;
1011 usb_ep_set_maxpacket_limit(&ep
->ep
, ~0);
1012 ep
->ep
.max_streams
= 16;
1013 ep
->last_io
= jiffies
;
1014 ep
->gadget
= &dum
->gadget
;
1016 INIT_LIST_HEAD(&ep
->queue
);
1019 dum
->gadget
.ep0
= &dum
->ep
[0].ep
;
1020 list_del_init(&dum
->ep
[0].ep
.ep_list
);
1021 INIT_LIST_HEAD(&dum
->fifo_req
.queue
);
1023 #ifdef CONFIG_USB_OTG
1024 dum
->gadget
.is_otg
= 1;
1028 static int dummy_udc_probe(struct platform_device
*pdev
)
1033 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
1034 dum
->gadget
.name
= gadget_name
;
1035 dum
->gadget
.ops
= &dummy_ops
;
1036 dum
->gadget
.max_speed
= USB_SPEED_SUPER
;
1038 dum
->gadget
.dev
.parent
= &pdev
->dev
;
1039 init_dummy_udc_hw(dum
);
1041 rc
= usb_add_gadget_udc(&pdev
->dev
, &dum
->gadget
);
1045 rc
= device_create_file(&dum
->gadget
.dev
, &dev_attr_function
);
1048 platform_set_drvdata(pdev
, dum
);
1052 usb_del_gadget_udc(&dum
->gadget
);
1057 static int dummy_udc_remove(struct platform_device
*pdev
)
1059 struct dummy
*dum
= platform_get_drvdata(pdev
);
1061 device_remove_file(&dum
->gadget
.dev
, &dev_attr_function
);
1062 usb_del_gadget_udc(&dum
->gadget
);
1066 static void dummy_udc_pm(struct dummy
*dum
, struct dummy_hcd
*dum_hcd
,
1069 spin_lock_irq(&dum
->lock
);
1070 dum
->udc_suspended
= suspend
;
1071 set_link_state(dum_hcd
);
1072 spin_unlock_irq(&dum
->lock
);
1075 static int dummy_udc_suspend(struct platform_device
*pdev
, pm_message_t state
)
1077 struct dummy
*dum
= platform_get_drvdata(pdev
);
1078 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1080 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1081 dummy_udc_pm(dum
, dum_hcd
, 1);
1082 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1086 static int dummy_udc_resume(struct platform_device
*pdev
)
1088 struct dummy
*dum
= platform_get_drvdata(pdev
);
1089 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1091 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1092 dummy_udc_pm(dum
, dum_hcd
, 0);
1093 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1097 static struct platform_driver dummy_udc_driver
= {
1098 .probe
= dummy_udc_probe
,
1099 .remove
= dummy_udc_remove
,
1100 .suspend
= dummy_udc_suspend
,
1101 .resume
= dummy_udc_resume
,
1103 .name
= (char *) gadget_name
,
1107 /*-------------------------------------------------------------------------*/
1109 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor
*desc
)
1113 index
= usb_endpoint_num(desc
) << 1;
1114 if (usb_endpoint_dir_in(desc
))
1119 /* MASTER/HOST SIDE DRIVER
1121 * this uses the hcd framework to hook up to host side drivers.
1122 * its root hub will only have one device, otherwise it acts like
1123 * a normal host controller.
1125 * when urbs are queued, they're just stuck on a list that we
1126 * scan in a timer callback. that callback connects writes from
1127 * the host with reads from the device, and so on, based on the
1131 static int dummy_ep_stream_en(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1133 const struct usb_endpoint_descriptor
*desc
= &urb
->ep
->desc
;
1136 if (!usb_endpoint_xfer_bulk(desc
))
1139 index
= dummy_get_ep_idx(desc
);
1140 return (1 << index
) & dum_hcd
->stream_en_ep
;
1144 * The max stream number is saved as a nibble so for the 30 possible endpoints
1145 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1146 * means we use only 1 stream). The maximum according to the spec is 16bit so
1147 * if the 16 stream limit is about to go, the array size should be incremented
1148 * to 30 elements of type u16.
1150 static int get_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1155 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1156 if (usb_pipeout(pipe
))
1164 static void set_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1165 unsigned int pipe
, unsigned int streams
)
1170 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1171 if (usb_pipeout(pipe
)) {
1175 max_streams
&= 0xf0;
1177 max_streams
|= streams
;
1178 dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)] = max_streams
;
1181 static int dummy_validate_stream(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1183 unsigned int max_streams
;
1186 enabled
= dummy_ep_stream_en(dum_hcd
, urb
);
1187 if (!urb
->stream_id
) {
1195 max_streams
= get_max_streams_for_pipe(dum_hcd
,
1196 usb_pipeendpoint(urb
->pipe
));
1197 if (urb
->stream_id
> max_streams
) {
1198 dev_err(dummy_dev(dum_hcd
), "Stream id %d is out of range.\n",
1206 static int dummy_urb_enqueue(
1207 struct usb_hcd
*hcd
,
1211 struct dummy_hcd
*dum_hcd
;
1213 unsigned long flags
;
1216 urbp
= kmalloc(sizeof *urbp
, mem_flags
);
1220 urbp
->miter_started
= 0;
1222 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1223 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1225 rc
= dummy_validate_stream(dum_hcd
, urb
);
1231 rc
= usb_hcd_link_urb_to_ep(hcd
, urb
);
1237 if (!dum_hcd
->udev
) {
1238 dum_hcd
->udev
= urb
->dev
;
1239 usb_get_dev(dum_hcd
->udev
);
1240 } else if (unlikely(dum_hcd
->udev
!= urb
->dev
))
1241 dev_err(dummy_dev(dum_hcd
), "usb_device address has changed!\n");
1243 list_add_tail(&urbp
->urbp_list
, &dum_hcd
->urbp_list
);
1245 if (usb_pipetype(urb
->pipe
) == PIPE_CONTROL
)
1246 urb
->error_count
= 1; /* mark as a new urb */
1248 /* kick the scheduler, it'll do the rest */
1249 if (!timer_pending(&dum_hcd
->timer
))
1250 mod_timer(&dum_hcd
->timer
, jiffies
+ 1);
1253 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1257 static int dummy_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1259 struct dummy_hcd
*dum_hcd
;
1260 unsigned long flags
;
1263 /* giveback happens automatically in timer callback,
1264 * so make sure the callback happens */
1265 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1266 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1268 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
1269 if (!rc
&& dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
&&
1270 !list_empty(&dum_hcd
->urbp_list
))
1271 mod_timer(&dum_hcd
->timer
, jiffies
);
1273 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1277 static int dummy_perform_transfer(struct urb
*urb
, struct dummy_request
*req
,
1281 struct urbp
*urbp
= urb
->hcpriv
;
1283 struct sg_mapping_iter
*miter
= &urbp
->miter
;
1288 to_host
= usb_pipein(urb
->pipe
);
1289 rbuf
= req
->req
.buf
+ req
->req
.actual
;
1291 if (!urb
->num_sgs
) {
1292 ubuf
= urb
->transfer_buffer
+ urb
->actual_length
;
1294 memcpy(ubuf
, rbuf
, len
);
1296 memcpy(rbuf
, ubuf
, len
);
1300 if (!urbp
->miter_started
) {
1301 u32 flags
= SG_MITER_ATOMIC
;
1304 flags
|= SG_MITER_TO_SG
;
1306 flags
|= SG_MITER_FROM_SG
;
1308 sg_miter_start(miter
, urb
->sg
, urb
->num_sgs
, flags
);
1309 urbp
->miter_started
= 1;
1311 next_sg
= sg_miter_next(miter
);
1312 if (next_sg
== false) {
1318 this_sg
= min_t(u32
, len
, miter
->length
);
1319 miter
->consumed
= this_sg
;
1323 memcpy(ubuf
, rbuf
, this_sg
);
1325 memcpy(rbuf
, ubuf
, this_sg
);
1330 next_sg
= sg_miter_next(miter
);
1331 if (next_sg
== false) {
1339 sg_miter_stop(miter
);
1343 /* transfer up to a frame's worth; caller must own lock */
1344 static int transfer(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1345 struct dummy_ep
*ep
, int limit
, int *status
)
1347 struct dummy
*dum
= dum_hcd
->dum
;
1348 struct dummy_request
*req
;
1352 /* if there's no request queued, the device is NAKing; return */
1353 list_for_each_entry(req
, &ep
->queue
, queue
) {
1354 unsigned host_len
, dev_len
, len
;
1355 int is_short
, to_host
;
1358 if (dummy_ep_stream_en(dum_hcd
, urb
)) {
1359 if ((urb
->stream_id
!= req
->req
.stream_id
))
1363 /* 1..N packets of ep->ep.maxpacket each ... the last one
1364 * may be short (including zero length).
1366 * writer can send a zlp explicitly (length 0) or implicitly
1367 * (length mod maxpacket zero, and 'zero' flag); they always
1370 host_len
= urb
->transfer_buffer_length
- urb
->actual_length
;
1371 dev_len
= req
->req
.length
- req
->req
.actual
;
1372 len
= min(host_len
, dev_len
);
1374 /* FIXME update emulated data toggle too */
1376 to_host
= usb_pipein(urb
->pipe
);
1377 if (unlikely(len
== 0))
1380 /* not enough bandwidth left? */
1381 if (limit
< ep
->ep
.maxpacket
&& limit
< len
)
1383 len
= min_t(unsigned, len
, limit
);
1387 /* send multiple of maxpacket first, then remainder */
1388 if (len
>= ep
->ep
.maxpacket
) {
1390 if (len
% ep
->ep
.maxpacket
)
1392 len
-= len
% ep
->ep
.maxpacket
;
1397 len
= dummy_perform_transfer(urb
, req
, len
);
1399 ep
->last_io
= jiffies
;
1401 req
->req
.status
= len
;
1405 urb
->actual_length
+= len
;
1406 req
->req
.actual
+= len
;
1410 /* short packets terminate, maybe with overflow/underflow.
1411 * it's only really an error to write too much.
1413 * partially filling a buffer optionally blocks queue advances
1414 * (so completion handlers can clean up the queue) but we don't
1415 * need to emulate such data-in-flight.
1418 if (host_len
== dev_len
) {
1419 req
->req
.status
= 0;
1421 } else if (to_host
) {
1422 req
->req
.status
= 0;
1423 if (dev_len
> host_len
)
1424 *status
= -EOVERFLOW
;
1429 if (host_len
> dev_len
)
1430 req
->req
.status
= -EOVERFLOW
;
1432 req
->req
.status
= 0;
1436 * many requests terminate without a short packet.
1437 * send a zlp if demanded by flags.
1440 if (req
->req
.length
== req
->req
.actual
) {
1441 if (req
->req
.zero
&& to_host
)
1444 req
->req
.status
= 0;
1446 if (urb
->transfer_buffer_length
== urb
->actual_length
) {
1447 if (urb
->transfer_flags
& URB_ZERO_PACKET
&&
1455 /* device side completion --> continuable */
1456 if (req
->req
.status
!= -EINPROGRESS
) {
1457 list_del_init(&req
->queue
);
1459 spin_unlock(&dum
->lock
);
1460 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1461 spin_lock(&dum
->lock
);
1463 /* requests might have been unlinked... */
1467 /* host side completion --> terminate */
1468 if (*status
!= -EINPROGRESS
)
1471 /* rescan to continue with any other queued i/o */
1478 static int periodic_bytes(struct dummy
*dum
, struct dummy_ep
*ep
)
1480 int limit
= ep
->ep
.maxpacket
;
1482 if (dum
->gadget
.speed
== USB_SPEED_HIGH
) {
1485 /* high bandwidth mode */
1486 tmp
= usb_endpoint_maxp_mult(ep
->desc
);
1487 tmp
*= 8 /* applies to entire frame */;
1488 limit
+= limit
* tmp
;
1490 if (dum
->gadget
.speed
== USB_SPEED_SUPER
) {
1491 switch (usb_endpoint_type(ep
->desc
)) {
1492 case USB_ENDPOINT_XFER_ISOC
:
1493 /* Sec. 4.4.8.2 USB3.0 Spec */
1494 limit
= 3 * 16 * 1024 * 8;
1496 case USB_ENDPOINT_XFER_INT
:
1497 /* Sec. 4.4.7.2 USB3.0 Spec */
1498 limit
= 3 * 1024 * 8;
1500 case USB_ENDPOINT_XFER_BULK
:
1508 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1509 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1510 USB_PORT_STAT_SUSPEND)) \
1511 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1513 static struct dummy_ep
*find_endpoint(struct dummy
*dum
, u8 address
)
1517 if (!is_active((dum
->gadget
.speed
== USB_SPEED_SUPER
?
1518 dum
->ss_hcd
: dum
->hs_hcd
)))
1520 if ((address
& ~USB_DIR_IN
) == 0)
1522 for (i
= 1; i
< DUMMY_ENDPOINTS
; i
++) {
1523 struct dummy_ep
*ep
= &dum
->ep
[i
];
1527 if (ep
->desc
->bEndpointAddress
== address
)
1535 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1536 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1537 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1538 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1539 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1540 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1544 * handle_control_request() - handles all control transfers
1545 * @dum: pointer to dummy (the_controller)
1546 * @urb: the urb request to handle
1547 * @setup: pointer to the setup data for a USB device control
1549 * @status: pointer to request handling status
1551 * Return 0 - if the request was handled
1552 * 1 - if the request wasn't handles
1553 * error code on error
1555 static int handle_control_request(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1556 struct usb_ctrlrequest
*setup
,
1559 struct dummy_ep
*ep2
;
1560 struct dummy
*dum
= dum_hcd
->dum
;
1565 w_index
= le16_to_cpu(setup
->wIndex
);
1566 w_value
= le16_to_cpu(setup
->wValue
);
1567 switch (setup
->bRequest
) {
1568 case USB_REQ_SET_ADDRESS
:
1569 if (setup
->bRequestType
!= Dev_Request
)
1571 dum
->address
= w_value
;
1573 dev_dbg(udc_dev(dum
), "set_address = %d\n",
1577 case USB_REQ_SET_FEATURE
:
1578 if (setup
->bRequestType
== Dev_Request
) {
1581 case USB_DEVICE_REMOTE_WAKEUP
:
1583 case USB_DEVICE_B_HNP_ENABLE
:
1584 dum
->gadget
.b_hnp_enable
= 1;
1586 case USB_DEVICE_A_HNP_SUPPORT
:
1587 dum
->gadget
.a_hnp_support
= 1;
1589 case USB_DEVICE_A_ALT_HNP_SUPPORT
:
1590 dum
->gadget
.a_alt_hnp_support
= 1;
1592 case USB_DEVICE_U1_ENABLE
:
1593 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1595 w_value
= USB_DEV_STAT_U1_ENABLED
;
1597 ret_val
= -EOPNOTSUPP
;
1599 case USB_DEVICE_U2_ENABLE
:
1600 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1602 w_value
= USB_DEV_STAT_U2_ENABLED
;
1604 ret_val
= -EOPNOTSUPP
;
1606 case USB_DEVICE_LTM_ENABLE
:
1607 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1609 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1611 ret_val
= -EOPNOTSUPP
;
1614 ret_val
= -EOPNOTSUPP
;
1617 dum
->devstatus
|= (1 << w_value
);
1620 } else if (setup
->bRequestType
== Ep_Request
) {
1622 ep2
= find_endpoint(dum
, w_index
);
1623 if (!ep2
|| ep2
->ep
.name
== ep0name
) {
1624 ret_val
= -EOPNOTSUPP
;
1632 case USB_REQ_CLEAR_FEATURE
:
1633 if (setup
->bRequestType
== Dev_Request
) {
1636 case USB_DEVICE_REMOTE_WAKEUP
:
1637 w_value
= USB_DEVICE_REMOTE_WAKEUP
;
1639 case USB_DEVICE_U1_ENABLE
:
1640 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1642 w_value
= USB_DEV_STAT_U1_ENABLED
;
1644 ret_val
= -EOPNOTSUPP
;
1646 case USB_DEVICE_U2_ENABLE
:
1647 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1649 w_value
= USB_DEV_STAT_U2_ENABLED
;
1651 ret_val
= -EOPNOTSUPP
;
1653 case USB_DEVICE_LTM_ENABLE
:
1654 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1656 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1658 ret_val
= -EOPNOTSUPP
;
1661 ret_val
= -EOPNOTSUPP
;
1665 dum
->devstatus
&= ~(1 << w_value
);
1668 } else if (setup
->bRequestType
== Ep_Request
) {
1670 ep2
= find_endpoint(dum
, w_index
);
1672 ret_val
= -EOPNOTSUPP
;
1681 case USB_REQ_GET_STATUS
:
1682 if (setup
->bRequestType
== Dev_InRequest
1683 || setup
->bRequestType
== Intf_InRequest
1684 || setup
->bRequestType
== Ep_InRequest
) {
1687 * device: remote wakeup, selfpowered
1688 * interface: nothing
1691 buf
= (char *)urb
->transfer_buffer
;
1692 if (urb
->transfer_buffer_length
> 0) {
1693 if (setup
->bRequestType
== Ep_InRequest
) {
1694 ep2
= find_endpoint(dum
, w_index
);
1696 ret_val
= -EOPNOTSUPP
;
1699 buf
[0] = ep2
->halted
;
1700 } else if (setup
->bRequestType
==
1702 buf
[0] = (u8
)dum
->devstatus
;
1706 if (urb
->transfer_buffer_length
> 1)
1708 urb
->actual_length
= min_t(u32
, 2,
1709 urb
->transfer_buffer_length
);
1718 /* drive both sides of the transfers; looks like irq handlers to
1719 * both drivers except the callbacks aren't in_irq().
1721 static void dummy_timer(unsigned long _dum_hcd
)
1723 struct dummy_hcd
*dum_hcd
= (struct dummy_hcd
*) _dum_hcd
;
1724 struct dummy
*dum
= dum_hcd
->dum
;
1725 struct urbp
*urbp
, *tmp
;
1726 unsigned long flags
;
1730 /* simplistic model for one frame's bandwidth */
1731 switch (dum
->gadget
.speed
) {
1733 total
= 8/*bytes*/ * 12/*packets*/;
1735 case USB_SPEED_FULL
:
1736 total
= 64/*bytes*/ * 19/*packets*/;
1738 case USB_SPEED_HIGH
:
1739 total
= 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1741 case USB_SPEED_SUPER
:
1742 /* Bus speed is 500000 bytes/ms, so use a little less */
1746 dev_err(dummy_dev(dum_hcd
), "bogus device speed\n");
1750 /* FIXME if HZ != 1000 this will probably misbehave ... */
1752 /* look at each urb queued by the host side driver */
1753 spin_lock_irqsave(&dum
->lock
, flags
);
1755 if (!dum_hcd
->udev
) {
1756 dev_err(dummy_dev(dum_hcd
),
1757 "timer fired with no URBs pending?\n");
1758 spin_unlock_irqrestore(&dum
->lock
, flags
);
1762 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1763 if (!ep_info
[i
].name
)
1765 dum
->ep
[i
].already_seen
= 0;
1769 list_for_each_entry_safe(urbp
, tmp
, &dum_hcd
->urbp_list
, urbp_list
) {
1771 struct dummy_request
*req
;
1773 struct dummy_ep
*ep
= NULL
;
1775 int status
= -EINPROGRESS
;
1780 else if (dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
)
1782 type
= usb_pipetype(urb
->pipe
);
1784 /* used up this frame's non-periodic bandwidth?
1785 * FIXME there's infinite bandwidth for control and
1786 * periodic transfers ... unrealistic.
1788 if (total
<= 0 && type
== PIPE_BULK
)
1791 /* find the gadget's ep for this request (if configured) */
1792 address
= usb_pipeendpoint (urb
->pipe
);
1793 if (usb_pipein(urb
->pipe
))
1794 address
|= USB_DIR_IN
;
1795 ep
= find_endpoint(dum
, address
);
1797 /* set_configuration() disagreement */
1798 dev_dbg(dummy_dev(dum_hcd
),
1799 "no ep configured for urb %p\n",
1805 if (ep
->already_seen
)
1807 ep
->already_seen
= 1;
1808 if (ep
== &dum
->ep
[0] && urb
->error_count
) {
1809 ep
->setup_stage
= 1; /* a new urb */
1810 urb
->error_count
= 0;
1812 if (ep
->halted
&& !ep
->setup_stage
) {
1813 /* NOTE: must not be iso! */
1814 dev_dbg(dummy_dev(dum_hcd
), "ep %s halted, urb %p\n",
1819 /* FIXME make sure both ends agree on maxpacket */
1821 /* handle control requests */
1822 if (ep
== &dum
->ep
[0] && ep
->setup_stage
) {
1823 struct usb_ctrlrequest setup
;
1826 setup
= *(struct usb_ctrlrequest
*) urb
->setup_packet
;
1827 /* paranoia, in case of stale queued data */
1828 list_for_each_entry(req
, &ep
->queue
, queue
) {
1829 list_del_init(&req
->queue
);
1830 req
->req
.status
= -EOVERFLOW
;
1831 dev_dbg(udc_dev(dum
), "stale req = %p\n",
1834 spin_unlock(&dum
->lock
);
1835 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1836 spin_lock(&dum
->lock
);
1837 ep
->already_seen
= 0;
1841 /* gadget driver never sees set_address or operations
1842 * on standard feature flags. some hardware doesn't
1845 ep
->last_io
= jiffies
;
1846 ep
->setup_stage
= 0;
1849 value
= handle_control_request(dum_hcd
, urb
, &setup
,
1852 /* gadget driver handles all other requests. block
1853 * until setup() returns; no reentrancy issues etc.
1856 spin_unlock(&dum
->lock
);
1857 value
= dum
->driver
->setup(&dum
->gadget
,
1859 spin_lock(&dum
->lock
);
1862 /* no delays (max 64KB data stage) */
1864 goto treat_control_like_bulk
;
1866 /* error, see below */
1870 if (value
!= -EOPNOTSUPP
)
1871 dev_dbg(udc_dev(dum
),
1875 urb
->actual_length
= 0;
1881 /* non-control requests */
1883 switch (usb_pipetype(urb
->pipe
)) {
1884 case PIPE_ISOCHRONOUS
:
1885 /* FIXME is it urb->interval since the last xfer?
1886 * use urb->iso_frame_desc[i].
1887 * complete whether or not ep has requests queued.
1888 * report random errors, to debug drivers.
1890 limit
= max(limit
, periodic_bytes(dum
, ep
));
1894 case PIPE_INTERRUPT
:
1895 /* FIXME is it urb->interval since the last xfer?
1896 * this almost certainly polls too fast.
1898 limit
= max(limit
, periodic_bytes(dum
, ep
));
1902 treat_control_like_bulk
:
1903 ep
->last_io
= jiffies
;
1904 total
-= transfer(dum_hcd
, urb
, ep
, limit
, &status
);
1908 /* incomplete transfer? */
1909 if (status
== -EINPROGRESS
)
1913 list_del(&urbp
->urbp_list
);
1916 ep
->already_seen
= ep
->setup_stage
= 0;
1918 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd
), urb
);
1919 spin_unlock(&dum
->lock
);
1920 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd
), urb
, status
);
1921 spin_lock(&dum
->lock
);
1926 if (list_empty(&dum_hcd
->urbp_list
)) {
1927 usb_put_dev(dum_hcd
->udev
);
1928 dum_hcd
->udev
= NULL
;
1929 } else if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
1930 /* want a 1 msec delay here */
1931 mod_timer(&dum_hcd
->timer
, jiffies
+ msecs_to_jiffies(1));
1934 spin_unlock_irqrestore(&dum
->lock
, flags
);
1937 /*-------------------------------------------------------------------------*/
1939 #define PORT_C_MASK \
1940 ((USB_PORT_STAT_C_CONNECTION \
1941 | USB_PORT_STAT_C_ENABLE \
1942 | USB_PORT_STAT_C_SUSPEND \
1943 | USB_PORT_STAT_C_OVERCURRENT \
1944 | USB_PORT_STAT_C_RESET) << 16)
1946 static int dummy_hub_status(struct usb_hcd
*hcd
, char *buf
)
1948 struct dummy_hcd
*dum_hcd
;
1949 unsigned long flags
;
1952 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1954 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1955 if (!HCD_HW_ACCESSIBLE(hcd
))
1958 if (dum_hcd
->resuming
&& time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
1959 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
1960 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
1961 set_link_state(dum_hcd
);
1964 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0) {
1966 dev_dbg(dummy_dev(dum_hcd
), "port status 0x%08x has changes\n",
1967 dum_hcd
->port_status
);
1969 if (dum_hcd
->rh_state
== DUMMY_RH_SUSPENDED
)
1970 usb_hcd_resume_root_hub(hcd
);
1973 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1977 /* usb 3.0 root hub device descriptor */
1979 struct usb_bos_descriptor bos
;
1980 struct usb_ss_cap_descriptor ss_cap
;
1981 } __packed usb3_bos_desc
= {
1984 .bLength
= USB_DT_BOS_SIZE
,
1985 .bDescriptorType
= USB_DT_BOS
,
1986 .wTotalLength
= cpu_to_le16(sizeof(usb3_bos_desc
)),
1987 .bNumDeviceCaps
= 1,
1990 .bLength
= USB_DT_USB_SS_CAP_SIZE
,
1991 .bDescriptorType
= USB_DT_DEVICE_CAPABILITY
,
1992 .bDevCapabilityType
= USB_SS_CAP_TYPE
,
1993 .wSpeedSupported
= cpu_to_le16(USB_5GBPS_OPERATION
),
1994 .bFunctionalitySupport
= ilog2(USB_5GBPS_OPERATION
),
1999 ss_hub_descriptor(struct usb_hub_descriptor
*desc
)
2001 memset(desc
, 0, sizeof *desc
);
2002 desc
->bDescriptorType
= USB_DT_SS_HUB
;
2003 desc
->bDescLength
= 12;
2004 desc
->wHubCharacteristics
= cpu_to_le16(
2005 HUB_CHAR_INDV_PORT_LPSM
|
2006 HUB_CHAR_COMMON_OCPM
);
2007 desc
->bNbrPorts
= 1;
2008 desc
->u
.ss
.bHubHdrDecLat
= 0x04; /* Worst case: 0.4 micro sec*/
2009 desc
->u
.ss
.DeviceRemovable
= 0xffff;
2012 static inline void hub_descriptor(struct usb_hub_descriptor
*desc
)
2014 memset(desc
, 0, sizeof *desc
);
2015 desc
->bDescriptorType
= USB_DT_HUB
;
2016 desc
->bDescLength
= 9;
2017 desc
->wHubCharacteristics
= cpu_to_le16(
2018 HUB_CHAR_INDV_PORT_LPSM
|
2019 HUB_CHAR_COMMON_OCPM
);
2020 desc
->bNbrPorts
= 1;
2021 desc
->u
.hs
.DeviceRemovable
[0] = 0xff;
2022 desc
->u
.hs
.DeviceRemovable
[1] = 0xff;
2025 static int dummy_hub_control(
2026 struct usb_hcd
*hcd
,
2033 struct dummy_hcd
*dum_hcd
;
2035 unsigned long flags
;
2037 if (!HCD_HW_ACCESSIBLE(hcd
))
2040 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2042 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2044 case ClearHubFeature
:
2046 case ClearPortFeature
:
2048 case USB_PORT_FEAT_SUSPEND
:
2049 if (hcd
->speed
== HCD_USB3
) {
2050 dev_dbg(dummy_dev(dum_hcd
),
2051 "USB_PORT_FEAT_SUSPEND req not "
2052 "supported for USB 3.0 roothub\n");
2055 if (dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) {
2056 /* 20msec resume signaling */
2057 dum_hcd
->resuming
= 1;
2058 dum_hcd
->re_timeout
= jiffies
+
2059 msecs_to_jiffies(20);
2062 case USB_PORT_FEAT_POWER
:
2063 if (hcd
->speed
== HCD_USB3
) {
2064 if (dum_hcd
->port_status
& USB_PORT_STAT_POWER
)
2065 dev_dbg(dummy_dev(dum_hcd
),
2068 if (dum_hcd
->port_status
&
2069 USB_SS_PORT_STAT_POWER
)
2070 dev_dbg(dummy_dev(dum_hcd
),
2074 dum_hcd
->port_status
&= ~(1 << wValue
);
2075 set_link_state(dum_hcd
);
2078 case GetHubDescriptor
:
2079 if (hcd
->speed
== HCD_USB3
&&
2080 (wLength
< USB_DT_SS_HUB_SIZE
||
2081 wValue
!= (USB_DT_SS_HUB
<< 8))) {
2082 dev_dbg(dummy_dev(dum_hcd
),
2083 "Wrong hub descriptor type for "
2084 "USB 3.0 roothub.\n");
2087 if (hcd
->speed
== HCD_USB3
)
2088 ss_hub_descriptor((struct usb_hub_descriptor
*) buf
);
2090 hub_descriptor((struct usb_hub_descriptor
*) buf
);
2093 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
2094 if (hcd
->speed
!= HCD_USB3
)
2097 if ((wValue
>> 8) != USB_DT_BOS
)
2100 memcpy(buf
, &usb3_bos_desc
, sizeof(usb3_bos_desc
));
2101 retval
= sizeof(usb3_bos_desc
);
2105 *(__le32
*) buf
= cpu_to_le32(0);
2111 /* whoever resets or resumes must GetPortStatus to
2114 if (dum_hcd
->resuming
&&
2115 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2116 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
2117 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
2119 if ((dum_hcd
->port_status
& USB_PORT_STAT_RESET
) != 0 &&
2120 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2121 dum_hcd
->port_status
|= (USB_PORT_STAT_C_RESET
<< 16);
2122 dum_hcd
->port_status
&= ~USB_PORT_STAT_RESET
;
2123 if (dum_hcd
->dum
->pullup
) {
2124 dum_hcd
->port_status
|= USB_PORT_STAT_ENABLE
;
2126 if (hcd
->speed
< HCD_USB3
) {
2127 switch (dum_hcd
->dum
->gadget
.speed
) {
2128 case USB_SPEED_HIGH
:
2129 dum_hcd
->port_status
|=
2130 USB_PORT_STAT_HIGH_SPEED
;
2133 dum_hcd
->dum
->gadget
.ep0
->
2135 dum_hcd
->port_status
|=
2136 USB_PORT_STAT_LOW_SPEED
;
2139 dum_hcd
->dum
->gadget
.speed
=
2146 set_link_state(dum_hcd
);
2147 ((__le16
*) buf
)[0] = cpu_to_le16(dum_hcd
->port_status
);
2148 ((__le16
*) buf
)[1] = cpu_to_le16(dum_hcd
->port_status
>> 16);
2153 case SetPortFeature
:
2155 case USB_PORT_FEAT_LINK_STATE
:
2156 if (hcd
->speed
!= HCD_USB3
) {
2157 dev_dbg(dummy_dev(dum_hcd
),
2158 "USB_PORT_FEAT_LINK_STATE req not "
2159 "supported for USB 2.0 roothub\n");
2163 * Since this is dummy we don't have an actual link so
2164 * there is nothing to do for the SET_LINK_STATE cmd
2167 case USB_PORT_FEAT_U1_TIMEOUT
:
2168 case USB_PORT_FEAT_U2_TIMEOUT
:
2169 /* TODO: add suspend/resume support! */
2170 if (hcd
->speed
!= HCD_USB3
) {
2171 dev_dbg(dummy_dev(dum_hcd
),
2172 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2173 "supported for USB 2.0 roothub\n");
2177 case USB_PORT_FEAT_SUSPEND
:
2178 /* Applicable only for USB2.0 hub */
2179 if (hcd
->speed
== HCD_USB3
) {
2180 dev_dbg(dummy_dev(dum_hcd
),
2181 "USB_PORT_FEAT_SUSPEND req not "
2182 "supported for USB 3.0 roothub\n");
2185 if (dum_hcd
->active
) {
2186 dum_hcd
->port_status
|= USB_PORT_STAT_SUSPEND
;
2188 /* HNP would happen here; for now we
2189 * assume b_bus_req is always true.
2191 set_link_state(dum_hcd
);
2192 if (((1 << USB_DEVICE_B_HNP_ENABLE
)
2193 & dum_hcd
->dum
->devstatus
) != 0)
2194 dev_dbg(dummy_dev(dum_hcd
),
2198 case USB_PORT_FEAT_POWER
:
2199 if (hcd
->speed
== HCD_USB3
)
2200 dum_hcd
->port_status
|= USB_SS_PORT_STAT_POWER
;
2202 dum_hcd
->port_status
|= USB_PORT_STAT_POWER
;
2203 set_link_state(dum_hcd
);
2205 case USB_PORT_FEAT_BH_PORT_RESET
:
2206 /* Applicable only for USB3.0 hub */
2207 if (hcd
->speed
!= HCD_USB3
) {
2208 dev_dbg(dummy_dev(dum_hcd
),
2209 "USB_PORT_FEAT_BH_PORT_RESET req not "
2210 "supported for USB 2.0 roothub\n");
2214 case USB_PORT_FEAT_RESET
:
2215 /* if it's already enabled, disable */
2216 if (hcd
->speed
== HCD_USB3
) {
2217 dum_hcd
->port_status
= 0;
2218 dum_hcd
->port_status
=
2219 (USB_SS_PORT_STAT_POWER
|
2220 USB_PORT_STAT_CONNECTION
|
2221 USB_PORT_STAT_RESET
);
2223 dum_hcd
->port_status
&= ~(USB_PORT_STAT_ENABLE
2224 | USB_PORT_STAT_LOW_SPEED
2225 | USB_PORT_STAT_HIGH_SPEED
);
2227 * We want to reset device status. All but the
2228 * Self powered feature
2230 dum_hcd
->dum
->devstatus
&=
2231 (1 << USB_DEVICE_SELF_POWERED
);
2233 * FIXME USB3.0: what is the correct reset signaling
2234 * interval? Is it still 50msec as for HS?
2236 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(50);
2239 if (hcd
->speed
== HCD_USB3
) {
2240 if ((dum_hcd
->port_status
&
2241 USB_SS_PORT_STAT_POWER
) != 0) {
2242 dum_hcd
->port_status
|= (1 << wValue
);
2243 set_link_state(dum_hcd
);
2246 if ((dum_hcd
->port_status
&
2247 USB_PORT_STAT_POWER
) != 0) {
2248 dum_hcd
->port_status
|= (1 << wValue
);
2249 set_link_state(dum_hcd
);
2253 case GetPortErrorCount
:
2254 if (hcd
->speed
!= HCD_USB3
) {
2255 dev_dbg(dummy_dev(dum_hcd
),
2256 "GetPortErrorCount req not "
2257 "supported for USB 2.0 roothub\n");
2260 /* We'll always return 0 since this is a dummy hub */
2261 *(__le32
*) buf
= cpu_to_le32(0);
2264 if (hcd
->speed
!= HCD_USB3
) {
2265 dev_dbg(dummy_dev(dum_hcd
),
2266 "SetHubDepth req not supported for "
2267 "USB 2.0 roothub\n");
2272 dev_dbg(dummy_dev(dum_hcd
),
2273 "hub control req%04x v%04x i%04x l%d\n",
2274 typeReq
, wValue
, wIndex
, wLength
);
2276 /* "protocol stall" on error */
2279 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2281 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0)
2282 usb_hcd_poll_rh_status(hcd
);
2286 static int dummy_bus_suspend(struct usb_hcd
*hcd
)
2288 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2290 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2292 spin_lock_irq(&dum_hcd
->dum
->lock
);
2293 dum_hcd
->rh_state
= DUMMY_RH_SUSPENDED
;
2294 set_link_state(dum_hcd
);
2295 hcd
->state
= HC_STATE_SUSPENDED
;
2296 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2300 static int dummy_bus_resume(struct usb_hcd
*hcd
)
2302 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2305 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2307 spin_lock_irq(&dum_hcd
->dum
->lock
);
2308 if (!HCD_HW_ACCESSIBLE(hcd
)) {
2311 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2312 set_link_state(dum_hcd
);
2313 if (!list_empty(&dum_hcd
->urbp_list
))
2314 mod_timer(&dum_hcd
->timer
, jiffies
);
2315 hcd
->state
= HC_STATE_RUNNING
;
2317 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2321 /*-------------------------------------------------------------------------*/
2323 static inline ssize_t
show_urb(char *buf
, size_t size
, struct urb
*urb
)
2325 int ep
= usb_pipeendpoint(urb
->pipe
);
2327 return snprintf(buf
, size
,
2328 "urb/%p %s ep%d%s%s len %d/%d\n",
2331 switch (urb
->dev
->speed
) {
2335 case USB_SPEED_FULL
:
2338 case USB_SPEED_HIGH
:
2341 case USB_SPEED_SUPER
:
2348 ep
, ep
? (usb_pipein(urb
->pipe
) ? "in" : "out") : "",
2350 switch (usb_pipetype(urb
->pipe
)) { \
2351 case PIPE_CONTROL
: \
2357 case PIPE_INTERRUPT
: \
2364 urb
->actual_length
, urb
->transfer_buffer_length
);
2367 static ssize_t
urbs_show(struct device
*dev
, struct device_attribute
*attr
,
2370 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
2371 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2374 unsigned long flags
;
2376 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2377 list_for_each_entry(urbp
, &dum_hcd
->urbp_list
, urbp_list
) {
2380 temp
= show_urb(buf
, PAGE_SIZE
- size
, urbp
->urb
);
2384 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2388 static DEVICE_ATTR_RO(urbs
);
2390 static int dummy_start_ss(struct dummy_hcd
*dum_hcd
)
2392 init_timer(&dum_hcd
->timer
);
2393 dum_hcd
->timer
.function
= dummy_timer
;
2394 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2395 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2396 dum_hcd
->stream_en_ep
= 0;
2397 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2398 dummy_hcd_to_hcd(dum_hcd
)->power_budget
= POWER_BUDGET
;
2399 dummy_hcd_to_hcd(dum_hcd
)->state
= HC_STATE_RUNNING
;
2400 dummy_hcd_to_hcd(dum_hcd
)->uses_new_polling
= 1;
2401 #ifdef CONFIG_USB_OTG
2402 dummy_hcd_to_hcd(dum_hcd
)->self
.otg_port
= 1;
2406 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2407 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2410 static int dummy_start(struct usb_hcd
*hcd
)
2412 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2415 * MASTER side init ... we emulate a root hub that'll only ever
2416 * talk to one device (the slave side). Also appears in sysfs,
2417 * just like more familiar pci-based HCDs.
2419 if (!usb_hcd_is_primary_hcd(hcd
))
2420 return dummy_start_ss(dum_hcd
);
2422 spin_lock_init(&dum_hcd
->dum
->lock
);
2423 init_timer(&dum_hcd
->timer
);
2424 dum_hcd
->timer
.function
= dummy_timer
;
2425 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2426 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2428 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2430 hcd
->power_budget
= POWER_BUDGET
;
2431 hcd
->state
= HC_STATE_RUNNING
;
2432 hcd
->uses_new_polling
= 1;
2434 #ifdef CONFIG_USB_OTG
2435 hcd
->self
.otg_port
= 1;
2438 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2439 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2442 static void dummy_stop(struct usb_hcd
*hcd
)
2444 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd
)), &dev_attr_urbs
);
2445 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd
)), "stopped\n");
2448 /*-------------------------------------------------------------------------*/
2450 static int dummy_h_get_frame(struct usb_hcd
*hcd
)
2452 return dummy_g_get_frame(NULL
);
2455 static int dummy_setup(struct usb_hcd
*hcd
)
2459 dum
= *((void **)dev_get_platdata(hcd
->self
.controller
));
2460 hcd
->self
.sg_tablesize
= ~0;
2461 if (usb_hcd_is_primary_hcd(hcd
)) {
2462 dum
->hs_hcd
= hcd_to_dummy_hcd(hcd
);
2463 dum
->hs_hcd
->dum
= dum
;
2465 * Mark the first roothub as being USB 2.0.
2466 * The USB 3.0 roothub will be registered later by
2469 hcd
->speed
= HCD_USB2
;
2470 hcd
->self
.root_hub
->speed
= USB_SPEED_HIGH
;
2472 dum
->ss_hcd
= hcd_to_dummy_hcd(hcd
);
2473 dum
->ss_hcd
->dum
= dum
;
2474 hcd
->speed
= HCD_USB3
;
2475 hcd
->self
.root_hub
->speed
= USB_SPEED_SUPER
;
2480 /* Change a group of bulk endpoints to support multiple stream IDs */
2481 static int dummy_alloc_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2482 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2483 unsigned int num_streams
, gfp_t mem_flags
)
2485 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2486 unsigned long flags
;
2488 int ret_streams
= num_streams
;
2495 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2496 for (i
= 0; i
< num_eps
; i
++) {
2497 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2498 if ((1 << index
) & dum_hcd
->stream_en_ep
) {
2499 ret_streams
= -EINVAL
;
2502 max_stream
= usb_ss_max_streams(&eps
[i
]->ss_ep_comp
);
2504 ret_streams
= -EINVAL
;
2507 if (max_stream
< ret_streams
) {
2508 dev_dbg(dummy_dev(dum_hcd
), "Ep 0x%x only supports %u "
2510 eps
[i
]->desc
.bEndpointAddress
,
2512 ret_streams
= max_stream
;
2516 for (i
= 0; i
< num_eps
; i
++) {
2517 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2518 dum_hcd
->stream_en_ep
|= 1 << index
;
2519 set_max_streams_for_pipe(dum_hcd
,
2520 usb_endpoint_num(&eps
[i
]->desc
), ret_streams
);
2523 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2527 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2528 static int dummy_free_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2529 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2532 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2533 unsigned long flags
;
2538 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2539 for (i
= 0; i
< num_eps
; i
++) {
2540 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2541 if (!((1 << index
) & dum_hcd
->stream_en_ep
)) {
2547 for (i
= 0; i
< num_eps
; i
++) {
2548 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2549 dum_hcd
->stream_en_ep
&= ~(1 << index
);
2550 set_max_streams_for_pipe(dum_hcd
,
2551 usb_endpoint_num(&eps
[i
]->desc
), 0);
2555 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2559 static struct hc_driver dummy_hcd
= {
2560 .description
= (char *) driver_name
,
2561 .product_desc
= "Dummy host controller",
2562 .hcd_priv_size
= sizeof(struct dummy_hcd
),
2564 .flags
= HCD_USB3
| HCD_SHARED
,
2566 .reset
= dummy_setup
,
2567 .start
= dummy_start
,
2570 .urb_enqueue
= dummy_urb_enqueue
,
2571 .urb_dequeue
= dummy_urb_dequeue
,
2573 .get_frame_number
= dummy_h_get_frame
,
2575 .hub_status_data
= dummy_hub_status
,
2576 .hub_control
= dummy_hub_control
,
2577 .bus_suspend
= dummy_bus_suspend
,
2578 .bus_resume
= dummy_bus_resume
,
2580 .alloc_streams
= dummy_alloc_streams
,
2581 .free_streams
= dummy_free_streams
,
2584 static int dummy_hcd_probe(struct platform_device
*pdev
)
2587 struct usb_hcd
*hs_hcd
;
2588 struct usb_hcd
*ss_hcd
;
2591 dev_info(&pdev
->dev
, "%s, driver " DRIVER_VERSION
"\n", driver_desc
);
2592 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
2594 if (!mod_data
.is_super_speed
)
2595 dummy_hcd
.flags
= HCD_USB2
;
2596 hs_hcd
= usb_create_hcd(&dummy_hcd
, &pdev
->dev
, dev_name(&pdev
->dev
));
2601 retval
= usb_add_hcd(hs_hcd
, 0, 0);
2605 if (mod_data
.is_super_speed
) {
2606 ss_hcd
= usb_create_shared_hcd(&dummy_hcd
, &pdev
->dev
,
2607 dev_name(&pdev
->dev
), hs_hcd
);
2610 goto dealloc_usb2_hcd
;
2613 retval
= usb_add_hcd(ss_hcd
, 0, 0);
2620 usb_put_hcd(ss_hcd
);
2622 usb_remove_hcd(hs_hcd
);
2624 usb_put_hcd(hs_hcd
);
2625 dum
->hs_hcd
= dum
->ss_hcd
= NULL
;
2629 static int dummy_hcd_remove(struct platform_device
*pdev
)
2633 dum
= hcd_to_dummy_hcd(platform_get_drvdata(pdev
))->dum
;
2636 usb_remove_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2637 usb_put_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2640 usb_remove_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2641 usb_put_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2649 static int dummy_hcd_suspend(struct platform_device
*pdev
, pm_message_t state
)
2651 struct usb_hcd
*hcd
;
2652 struct dummy_hcd
*dum_hcd
;
2655 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2657 hcd
= platform_get_drvdata(pdev
);
2658 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2659 if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
2660 dev_warn(&pdev
->dev
, "Root hub isn't suspended!\n");
2663 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2667 static int dummy_hcd_resume(struct platform_device
*pdev
)
2669 struct usb_hcd
*hcd
;
2671 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2673 hcd
= platform_get_drvdata(pdev
);
2674 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2675 usb_hcd_poll_rh_status(hcd
);
2679 static struct platform_driver dummy_hcd_driver
= {
2680 .probe
= dummy_hcd_probe
,
2681 .remove
= dummy_hcd_remove
,
2682 .suspend
= dummy_hcd_suspend
,
2683 .resume
= dummy_hcd_resume
,
2685 .name
= (char *) driver_name
,
2689 /*-------------------------------------------------------------------------*/
2690 #define MAX_NUM_UDC 2
2691 static struct platform_device
*the_udc_pdev
[MAX_NUM_UDC
];
2692 static struct platform_device
*the_hcd_pdev
[MAX_NUM_UDC
];
2694 static int __init
init(void)
2696 int retval
= -ENOMEM
;
2698 struct dummy
*dum
[MAX_NUM_UDC
];
2703 if (!mod_data
.is_high_speed
&& mod_data
.is_super_speed
)
2706 if (mod_data
.num
< 1 || mod_data
.num
> MAX_NUM_UDC
) {
2707 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2712 for (i
= 0; i
< mod_data
.num
; i
++) {
2713 the_hcd_pdev
[i
] = platform_device_alloc(driver_name
, i
);
2714 if (!the_hcd_pdev
[i
]) {
2717 platform_device_put(the_hcd_pdev
[i
--]);
2721 for (i
= 0; i
< mod_data
.num
; i
++) {
2722 the_udc_pdev
[i
] = platform_device_alloc(gadget_name
, i
);
2723 if (!the_udc_pdev
[i
]) {
2726 platform_device_put(the_udc_pdev
[i
--]);
2730 for (i
= 0; i
< mod_data
.num
; i
++) {
2731 dum
[i
] = kzalloc(sizeof(struct dummy
), GFP_KERNEL
);
2736 retval
= platform_device_add_data(the_hcd_pdev
[i
], &dum
[i
],
2740 retval
= platform_device_add_data(the_udc_pdev
[i
], &dum
[i
],
2746 retval
= platform_driver_register(&dummy_hcd_driver
);
2749 retval
= platform_driver_register(&dummy_udc_driver
);
2751 goto err_register_udc_driver
;
2753 for (i
= 0; i
< mod_data
.num
; i
++) {
2754 retval
= platform_device_add(the_hcd_pdev
[i
]);
2758 platform_device_del(the_hcd_pdev
[i
--]);
2762 for (i
= 0; i
< mod_data
.num
; i
++) {
2763 if (!dum
[i
]->hs_hcd
||
2764 (!dum
[i
]->ss_hcd
&& mod_data
.is_super_speed
)) {
2766 * The hcd was added successfully but its probe
2767 * function failed for some reason.
2774 for (i
= 0; i
< mod_data
.num
; i
++) {
2775 retval
= platform_device_add(the_udc_pdev
[i
]);
2779 platform_device_del(the_udc_pdev
[i
]);
2784 for (i
= 0; i
< mod_data
.num
; i
++) {
2785 if (!platform_get_drvdata(the_udc_pdev
[i
])) {
2787 * The udc was added successfully but its probe
2788 * function failed for some reason.
2797 for (i
= 0; i
< mod_data
.num
; i
++)
2798 platform_device_del(the_udc_pdev
[i
]);
2800 for (i
= 0; i
< mod_data
.num
; i
++)
2801 platform_device_del(the_hcd_pdev
[i
]);
2803 platform_driver_unregister(&dummy_udc_driver
);
2804 err_register_udc_driver
:
2805 platform_driver_unregister(&dummy_hcd_driver
);
2807 for (i
= 0; i
< mod_data
.num
; i
++)
2809 for (i
= 0; i
< mod_data
.num
; i
++)
2810 platform_device_put(the_udc_pdev
[i
]);
2812 for (i
= 0; i
< mod_data
.num
; i
++)
2813 platform_device_put(the_hcd_pdev
[i
]);
2818 static void __exit
cleanup(void)
2822 for (i
= 0; i
< mod_data
.num
; i
++) {
2825 dum
= *((void **)dev_get_platdata(&the_udc_pdev
[i
]->dev
));
2827 platform_device_unregister(the_udc_pdev
[i
]);
2828 platform_device_unregister(the_hcd_pdev
[i
]);
2831 platform_driver_unregister(&dummy_udc_driver
);
2832 platform_driver_unregister(&dummy_hcd_driver
);
2834 module_exit(cleanup
);