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
;
240 struct urbp
*next_frame_urbp
;
243 u8 num_stream
[30 / 2];
246 unsigned old_active
:1;
254 * SLAVE/GADGET side support
256 struct dummy_ep ep
[DUMMY_ENDPOINTS
];
259 struct usb_gadget gadget
;
260 struct usb_gadget_driver
*driver
;
261 struct dummy_request fifo_req
;
262 u8 fifo_buf
[FIFO_SIZE
];
264 unsigned ints_enabled
:1;
265 unsigned udc_suspended
:1;
269 * MASTER/HOST side support
271 struct dummy_hcd
*hs_hcd
;
272 struct dummy_hcd
*ss_hcd
;
275 static inline struct dummy_hcd
*hcd_to_dummy_hcd(struct usb_hcd
*hcd
)
277 return (struct dummy_hcd
*) (hcd
->hcd_priv
);
280 static inline struct usb_hcd
*dummy_hcd_to_hcd(struct dummy_hcd
*dum
)
282 return container_of((void *) dum
, struct usb_hcd
, hcd_priv
);
285 static inline struct device
*dummy_dev(struct dummy_hcd
*dum
)
287 return dummy_hcd_to_hcd(dum
)->self
.controller
;
290 static inline struct device
*udc_dev(struct dummy
*dum
)
292 return dum
->gadget
.dev
.parent
;
295 static inline struct dummy
*ep_to_dummy(struct dummy_ep
*ep
)
297 return container_of(ep
->gadget
, struct dummy
, gadget
);
300 static inline struct dummy_hcd
*gadget_to_dummy_hcd(struct usb_gadget
*gadget
)
302 struct dummy
*dum
= container_of(gadget
, struct dummy
, gadget
);
303 if (dum
->gadget
.speed
== USB_SPEED_SUPER
)
309 static inline struct dummy
*gadget_dev_to_dummy(struct device
*dev
)
311 return container_of(dev
, struct dummy
, gadget
.dev
);
314 /*-------------------------------------------------------------------------*/
316 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
318 /* called with spinlock held */
319 static void nuke(struct dummy
*dum
, struct dummy_ep
*ep
)
321 while (!list_empty(&ep
->queue
)) {
322 struct dummy_request
*req
;
324 req
= list_entry(ep
->queue
.next
, struct dummy_request
, queue
);
325 list_del_init(&req
->queue
);
326 req
->req
.status
= -ESHUTDOWN
;
328 spin_unlock(&dum
->lock
);
329 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
330 spin_lock(&dum
->lock
);
334 /* caller must hold lock */
335 static void stop_activity(struct dummy
*dum
)
339 /* prevent any more requests */
342 /* The timer is left running so that outstanding URBs can fail */
344 /* nuke any pending requests first, so driver i/o is quiesced */
345 for (i
= 0; i
< DUMMY_ENDPOINTS
; ++i
)
346 nuke(dum
, &dum
->ep
[i
]);
348 /* driver now does any non-usb quiescing necessary */
352 * set_link_state_by_speed() - Sets the current state of the link according to
354 * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
356 * This function updates the port_status according to the link state and the
359 static void set_link_state_by_speed(struct dummy_hcd
*dum_hcd
)
361 struct dummy
*dum
= dum_hcd
->dum
;
363 if (dummy_hcd_to_hcd(dum_hcd
)->speed
== HCD_USB3
) {
364 if ((dum_hcd
->port_status
& USB_SS_PORT_STAT_POWER
) == 0) {
365 dum_hcd
->port_status
= 0;
366 } else if (!dum
->pullup
|| dum
->udc_suspended
) {
367 /* UDC suspend must cause a disconnect */
368 dum_hcd
->port_status
&= ~(USB_PORT_STAT_CONNECTION
|
369 USB_PORT_STAT_ENABLE
);
370 if ((dum_hcd
->old_status
&
371 USB_PORT_STAT_CONNECTION
) != 0)
372 dum_hcd
->port_status
|=
373 (USB_PORT_STAT_C_CONNECTION
<< 16);
375 /* device is connected and not suspended */
376 dum_hcd
->port_status
|= (USB_PORT_STAT_CONNECTION
|
377 USB_PORT_STAT_SPEED_5GBPS
) ;
378 if ((dum_hcd
->old_status
&
379 USB_PORT_STAT_CONNECTION
) == 0)
380 dum_hcd
->port_status
|=
381 (USB_PORT_STAT_C_CONNECTION
<< 16);
382 if ((dum_hcd
->port_status
&
383 USB_PORT_STAT_ENABLE
) == 1 &&
384 (dum_hcd
->port_status
&
385 USB_SS_PORT_LS_U0
) == 1 &&
386 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
390 if ((dum_hcd
->port_status
& USB_PORT_STAT_POWER
) == 0) {
391 dum_hcd
->port_status
= 0;
392 } else if (!dum
->pullup
|| dum
->udc_suspended
) {
393 /* UDC suspend must cause a disconnect */
394 dum_hcd
->port_status
&= ~(USB_PORT_STAT_CONNECTION
|
395 USB_PORT_STAT_ENABLE
|
396 USB_PORT_STAT_LOW_SPEED
|
397 USB_PORT_STAT_HIGH_SPEED
|
398 USB_PORT_STAT_SUSPEND
);
399 if ((dum_hcd
->old_status
&
400 USB_PORT_STAT_CONNECTION
) != 0)
401 dum_hcd
->port_status
|=
402 (USB_PORT_STAT_C_CONNECTION
<< 16);
404 dum_hcd
->port_status
|= USB_PORT_STAT_CONNECTION
;
405 if ((dum_hcd
->old_status
&
406 USB_PORT_STAT_CONNECTION
) == 0)
407 dum_hcd
->port_status
|=
408 (USB_PORT_STAT_C_CONNECTION
<< 16);
409 if ((dum_hcd
->port_status
& USB_PORT_STAT_ENABLE
) == 0)
410 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
411 else if ((dum_hcd
->port_status
&
412 USB_PORT_STAT_SUSPEND
) == 0 &&
413 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
419 /* caller must hold lock */
420 static void set_link_state(struct dummy_hcd
*dum_hcd
)
422 struct dummy
*dum
= dum_hcd
->dum
;
423 unsigned int power_bit
;
427 if ((dummy_hcd_to_hcd(dum_hcd
)->speed
== HCD_USB3
&&
428 dum
->gadget
.speed
!= USB_SPEED_SUPER
) ||
429 (dummy_hcd_to_hcd(dum_hcd
)->speed
!= HCD_USB3
&&
430 dum
->gadget
.speed
== USB_SPEED_SUPER
))
433 set_link_state_by_speed(dum_hcd
);
434 power_bit
= (dummy_hcd_to_hcd(dum_hcd
)->speed
== HCD_USB3
?
435 USB_SS_PORT_STAT_POWER
: USB_PORT_STAT_POWER
);
437 if ((dum_hcd
->port_status
& USB_PORT_STAT_ENABLE
) == 0 ||
439 dum_hcd
->resuming
= 0;
441 /* Currently !connected or in reset */
442 if ((dum_hcd
->port_status
& power_bit
) == 0 ||
443 (dum_hcd
->port_status
& USB_PORT_STAT_RESET
) != 0) {
444 unsigned int disconnect
= power_bit
&
445 dum_hcd
->old_status
& (~dum_hcd
->port_status
);
446 unsigned int reset
= USB_PORT_STAT_RESET
&
447 (~dum_hcd
->old_status
) & dum_hcd
->port_status
;
449 /* Report reset and disconnect events to the driver */
450 if (dum
->ints_enabled
&& (disconnect
|| reset
)) {
452 ++dum
->callback_usage
;
453 spin_unlock(&dum
->lock
);
455 usb_gadget_udc_reset(&dum
->gadget
, dum
->driver
);
457 dum
->driver
->disconnect(&dum
->gadget
);
458 spin_lock(&dum
->lock
);
459 --dum
->callback_usage
;
461 } else if (dum_hcd
->active
!= dum_hcd
->old_active
&&
463 ++dum
->callback_usage
;
464 spin_unlock(&dum
->lock
);
465 if (dum_hcd
->old_active
&& dum
->driver
->suspend
)
466 dum
->driver
->suspend(&dum
->gadget
);
467 else if (!dum_hcd
->old_active
&& dum
->driver
->resume
)
468 dum
->driver
->resume(&dum
->gadget
);
469 spin_lock(&dum
->lock
);
470 --dum
->callback_usage
;
473 dum_hcd
->old_status
= dum_hcd
->port_status
;
474 dum_hcd
->old_active
= dum_hcd
->active
;
477 /*-------------------------------------------------------------------------*/
479 /* SLAVE/GADGET SIDE DRIVER
481 * This only tracks gadget state. All the work is done when the host
482 * side tries some (emulated) i/o operation. Real device controller
483 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
486 #define is_enabled(dum) \
487 (dum->port_status & USB_PORT_STAT_ENABLE)
489 static int dummy_enable(struct usb_ep
*_ep
,
490 const struct usb_endpoint_descriptor
*desc
)
493 struct dummy_hcd
*dum_hcd
;
498 ep
= usb_ep_to_dummy_ep(_ep
);
499 if (!_ep
|| !desc
|| ep
->desc
|| _ep
->name
== ep0name
500 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
)
502 dum
= ep_to_dummy(ep
);
506 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
507 if (!is_enabled(dum_hcd
))
511 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
512 * maximum packet size.
513 * For SS devices the wMaxPacketSize is limited by 1024.
515 max
= usb_endpoint_maxp(desc
) & 0x7ff;
517 /* drivers must not request bad settings, since lower levels
518 * (hardware or its drivers) may not check. some endpoints
519 * can't do iso, many have maxpacket limitations, etc.
521 * since this "hardware" driver is here to help debugging, we
522 * have some extra sanity checks. (there could be more though,
523 * especially for "ep9out" style fixed function ones.)
526 switch (usb_endpoint_type(desc
)) {
527 case USB_ENDPOINT_XFER_BULK
:
528 if (strstr(ep
->ep
.name
, "-iso")
529 || strstr(ep
->ep
.name
, "-int")) {
532 switch (dum
->gadget
.speed
) {
533 case USB_SPEED_SUPER
:
542 if (max
== 8 || max
== 16 || max
== 32 || max
== 64)
543 /* we'll fake any legal size */
545 /* save a return statement */
550 case USB_ENDPOINT_XFER_INT
:
551 if (strstr(ep
->ep
.name
, "-iso")) /* bulk is ok */
553 /* real hardware might not handle all packet sizes */
554 switch (dum
->gadget
.speed
) {
555 case USB_SPEED_SUPER
:
559 /* save a return statement */
563 /* save a return statement */
570 case USB_ENDPOINT_XFER_ISOC
:
571 if (strstr(ep
->ep
.name
, "-bulk")
572 || strstr(ep
->ep
.name
, "-int"))
574 /* real hardware might not handle all packet sizes */
575 switch (dum
->gadget
.speed
) {
576 case USB_SPEED_SUPER
:
580 /* save a return statement */
584 /* save a return statement */
590 /* few chips support control except on ep0 */
594 _ep
->maxpacket
= max
;
595 if (usb_ss_max_streams(_ep
->comp_desc
)) {
596 if (!usb_endpoint_xfer_bulk(desc
)) {
597 dev_err(udc_dev(dum
), "Can't enable stream support on "
598 "non-bulk ep %s\n", _ep
->name
);
605 dev_dbg(udc_dev(dum
), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
607 desc
->bEndpointAddress
& 0x0f,
608 (desc
->bEndpointAddress
& USB_DIR_IN
) ? "in" : "out",
610 switch (usb_endpoint_type(desc
)) {
611 case USB_ENDPOINT_XFER_BULK
:
614 case USB_ENDPOINT_XFER_ISOC
:
617 case USB_ENDPOINT_XFER_INT
:
624 max
, ep
->stream_en
? "enabled" : "disabled");
626 /* at this point real hardware should be NAKing transfers
627 * to that endpoint, until a buffer is queued to it.
629 ep
->halted
= ep
->wedged
= 0;
635 static int dummy_disable(struct usb_ep
*_ep
)
641 ep
= usb_ep_to_dummy_ep(_ep
);
642 if (!_ep
|| !ep
->desc
|| _ep
->name
== ep0name
)
644 dum
= ep_to_dummy(ep
);
646 spin_lock_irqsave(&dum
->lock
, flags
);
650 spin_unlock_irqrestore(&dum
->lock
, flags
);
652 dev_dbg(udc_dev(dum
), "disabled %s\n", _ep
->name
);
656 static struct usb_request
*dummy_alloc_request(struct usb_ep
*_ep
,
660 struct dummy_request
*req
;
664 ep
= usb_ep_to_dummy_ep(_ep
);
666 req
= kzalloc(sizeof(*req
), mem_flags
);
669 INIT_LIST_HEAD(&req
->queue
);
673 static void dummy_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
675 struct dummy_request
*req
;
682 req
= usb_request_to_dummy_request(_req
);
683 WARN_ON(!list_empty(&req
->queue
));
687 static void fifo_complete(struct usb_ep
*ep
, struct usb_request
*req
)
691 static int dummy_queue(struct usb_ep
*_ep
, struct usb_request
*_req
,
695 struct dummy_request
*req
;
697 struct dummy_hcd
*dum_hcd
;
700 req
= usb_request_to_dummy_request(_req
);
701 if (!_req
|| !list_empty(&req
->queue
) || !_req
->complete
)
704 ep
= usb_ep_to_dummy_ep(_ep
);
705 if (!_ep
|| (!ep
->desc
&& _ep
->name
!= ep0name
))
708 dum
= ep_to_dummy(ep
);
709 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
710 if (!dum
->driver
|| !is_enabled(dum_hcd
))
714 dev_dbg(udc_dev(dum
), "ep %p queue req %p to %s, len %d buf %p\n",
715 ep
, _req
, _ep
->name
, _req
->length
, _req
->buf
);
717 _req
->status
= -EINPROGRESS
;
719 spin_lock_irqsave(&dum
->lock
, flags
);
721 /* implement an emulated single-request FIFO */
722 if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
723 list_empty(&dum
->fifo_req
.queue
) &&
724 list_empty(&ep
->queue
) &&
725 _req
->length
<= FIFO_SIZE
) {
726 req
= &dum
->fifo_req
;
728 req
->req
.buf
= dum
->fifo_buf
;
729 memcpy(dum
->fifo_buf
, _req
->buf
, _req
->length
);
730 req
->req
.context
= dum
;
731 req
->req
.complete
= fifo_complete
;
733 list_add_tail(&req
->queue
, &ep
->queue
);
734 spin_unlock(&dum
->lock
);
735 _req
->actual
= _req
->length
;
737 usb_gadget_giveback_request(_ep
, _req
);
738 spin_lock(&dum
->lock
);
740 list_add_tail(&req
->queue
, &ep
->queue
);
741 spin_unlock_irqrestore(&dum
->lock
, flags
);
743 /* real hardware would likely enable transfers here, in case
744 * it'd been left NAKing.
749 static int dummy_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
753 int retval
= -EINVAL
;
755 struct dummy_request
*req
= NULL
;
759 ep
= usb_ep_to_dummy_ep(_ep
);
760 dum
= ep_to_dummy(ep
);
765 local_irq_save(flags
);
766 spin_lock(&dum
->lock
);
767 list_for_each_entry(req
, &ep
->queue
, queue
) {
768 if (&req
->req
== _req
) {
769 list_del_init(&req
->queue
);
770 _req
->status
= -ECONNRESET
;
775 spin_unlock(&dum
->lock
);
778 dev_dbg(udc_dev(dum
),
779 "dequeued req %p from %s, len %d buf %p\n",
780 req
, _ep
->name
, _req
->length
, _req
->buf
);
781 usb_gadget_giveback_request(_ep
, _req
);
783 local_irq_restore(flags
);
788 dummy_set_halt_and_wedge(struct usb_ep
*_ep
, int value
, int wedged
)
795 ep
= usb_ep_to_dummy_ep(_ep
);
796 dum
= ep_to_dummy(ep
);
800 ep
->halted
= ep
->wedged
= 0;
801 else if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
802 !list_empty(&ep
->queue
))
809 /* FIXME clear emulated data toggle too */
814 dummy_set_halt(struct usb_ep
*_ep
, int value
)
816 return dummy_set_halt_and_wedge(_ep
, value
, 0);
819 static int dummy_set_wedge(struct usb_ep
*_ep
)
821 if (!_ep
|| _ep
->name
== ep0name
)
823 return dummy_set_halt_and_wedge(_ep
, 1, 1);
826 static const struct usb_ep_ops dummy_ep_ops
= {
827 .enable
= dummy_enable
,
828 .disable
= dummy_disable
,
830 .alloc_request
= dummy_alloc_request
,
831 .free_request
= dummy_free_request
,
833 .queue
= dummy_queue
,
834 .dequeue
= dummy_dequeue
,
836 .set_halt
= dummy_set_halt
,
837 .set_wedge
= dummy_set_wedge
,
840 /*-------------------------------------------------------------------------*/
842 /* there are both host and device side versions of this call ... */
843 static int dummy_g_get_frame(struct usb_gadget
*_gadget
)
845 struct timespec64 ts64
;
847 ktime_get_ts64(&ts64
);
848 return ts64
.tv_nsec
/ NSEC_PER_MSEC
;
851 static int dummy_wakeup(struct usb_gadget
*_gadget
)
853 struct dummy_hcd
*dum_hcd
;
855 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
856 if (!(dum_hcd
->dum
->devstatus
& ((1 << USB_DEVICE_B_HNP_ENABLE
)
857 | (1 << USB_DEVICE_REMOTE_WAKEUP
))))
859 if ((dum_hcd
->port_status
& USB_PORT_STAT_CONNECTION
) == 0)
861 if ((dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) == 0 &&
862 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
865 /* FIXME: What if the root hub is suspended but the port isn't? */
867 /* hub notices our request, issues downstream resume, etc */
868 dum_hcd
->resuming
= 1;
869 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(20);
870 mod_timer(&dummy_hcd_to_hcd(dum_hcd
)->rh_timer
, dum_hcd
->re_timeout
);
874 static int dummy_set_selfpowered(struct usb_gadget
*_gadget
, int value
)
878 _gadget
->is_selfpowered
= (value
!= 0);
879 dum
= gadget_to_dummy_hcd(_gadget
)->dum
;
881 dum
->devstatus
|= (1 << USB_DEVICE_SELF_POWERED
);
883 dum
->devstatus
&= ~(1 << USB_DEVICE_SELF_POWERED
);
887 static void dummy_udc_update_ep0(struct dummy
*dum
)
889 if (dum
->gadget
.speed
== USB_SPEED_SUPER
)
890 dum
->ep
[0].ep
.maxpacket
= 9;
892 dum
->ep
[0].ep
.maxpacket
= 64;
895 static int dummy_pullup(struct usb_gadget
*_gadget
, int value
)
897 struct dummy_hcd
*dum_hcd
;
901 dum
= gadget_dev_to_dummy(&_gadget
->dev
);
903 if (value
&& dum
->driver
) {
904 if (mod_data
.is_super_speed
)
905 dum
->gadget
.speed
= dum
->driver
->max_speed
;
906 else if (mod_data
.is_high_speed
)
907 dum
->gadget
.speed
= min_t(u8
, USB_SPEED_HIGH
,
908 dum
->driver
->max_speed
);
910 dum
->gadget
.speed
= USB_SPEED_FULL
;
911 dummy_udc_update_ep0(dum
);
913 if (dum
->gadget
.speed
< dum
->driver
->max_speed
)
914 dev_dbg(udc_dev(dum
), "This device can perform faster"
915 " if you connect it to a %s port...\n",
916 usb_speed_string(dum
->driver
->max_speed
));
918 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
920 spin_lock_irqsave(&dum
->lock
, flags
);
921 dum
->pullup
= (value
!= 0);
922 set_link_state(dum_hcd
);
923 spin_unlock_irqrestore(&dum
->lock
, flags
);
925 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
929 static int dummy_udc_start(struct usb_gadget
*g
,
930 struct usb_gadget_driver
*driver
);
931 static int dummy_udc_stop(struct usb_gadget
*g
);
933 static const struct usb_gadget_ops dummy_ops
= {
934 .get_frame
= dummy_g_get_frame
,
935 .wakeup
= dummy_wakeup
,
936 .set_selfpowered
= dummy_set_selfpowered
,
937 .pullup
= dummy_pullup
,
938 .udc_start
= dummy_udc_start
,
939 .udc_stop
= dummy_udc_stop
,
942 /*-------------------------------------------------------------------------*/
944 /* "function" sysfs attribute */
945 static ssize_t
function_show(struct device
*dev
, struct device_attribute
*attr
,
948 struct dummy
*dum
= gadget_dev_to_dummy(dev
);
950 if (!dum
->driver
|| !dum
->driver
->function
)
952 return scnprintf(buf
, PAGE_SIZE
, "%s\n", dum
->driver
->function
);
954 static DEVICE_ATTR_RO(function
);
956 /*-------------------------------------------------------------------------*/
959 * Driver registration/unregistration.
961 * This is basically hardware-specific; there's usually only one real USB
962 * device (not host) controller since that's how USB devices are intended
963 * to work. So most implementations of these api calls will rely on the
964 * fact that only one driver will ever bind to the hardware. But curious
965 * hardware can be built with discrete components, so the gadget API doesn't
966 * require that assumption.
968 * For this emulator, it might be convenient to create a usb slave device
969 * for each driver that registers: just add to a big root hub.
972 static int dummy_udc_start(struct usb_gadget
*g
,
973 struct usb_gadget_driver
*driver
)
975 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
976 struct dummy
*dum
= dum_hcd
->dum
;
978 if (driver
->max_speed
== USB_SPEED_UNKNOWN
)
982 * SLAVE side init ... the layer above hardware, which
983 * can't enumerate without help from the driver we're binding.
986 spin_lock_irq(&dum
->lock
);
988 dum
->driver
= driver
;
989 dum
->ints_enabled
= 1;
990 spin_unlock_irq(&dum
->lock
);
995 static int dummy_udc_stop(struct usb_gadget
*g
)
997 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
998 struct dummy
*dum
= dum_hcd
->dum
;
1000 spin_lock_irq(&dum
->lock
);
1001 dum
->ints_enabled
= 0;
1004 /* emulate synchronize_irq(): wait for callbacks to finish */
1005 while (dum
->callback_usage
> 0) {
1006 spin_unlock_irq(&dum
->lock
);
1007 usleep_range(1000, 2000);
1008 spin_lock_irq(&dum
->lock
);
1012 spin_unlock_irq(&dum
->lock
);
1019 /* The gadget structure is stored inside the hcd structure and will be
1020 * released along with it. */
1021 static void init_dummy_udc_hw(struct dummy
*dum
)
1025 INIT_LIST_HEAD(&dum
->gadget
.ep_list
);
1026 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1027 struct dummy_ep
*ep
= &dum
->ep
[i
];
1029 if (!ep_info
[i
].name
)
1031 ep
->ep
.name
= ep_info
[i
].name
;
1032 ep
->ep
.caps
= ep_info
[i
].caps
;
1033 ep
->ep
.ops
= &dummy_ep_ops
;
1034 list_add_tail(&ep
->ep
.ep_list
, &dum
->gadget
.ep_list
);
1035 ep
->halted
= ep
->wedged
= ep
->already_seen
=
1036 ep
->setup_stage
= 0;
1037 usb_ep_set_maxpacket_limit(&ep
->ep
, ~0);
1038 ep
->ep
.max_streams
= 16;
1039 ep
->last_io
= jiffies
;
1040 ep
->gadget
= &dum
->gadget
;
1042 INIT_LIST_HEAD(&ep
->queue
);
1045 dum
->gadget
.ep0
= &dum
->ep
[0].ep
;
1046 list_del_init(&dum
->ep
[0].ep
.ep_list
);
1047 INIT_LIST_HEAD(&dum
->fifo_req
.queue
);
1049 #ifdef CONFIG_USB_OTG
1050 dum
->gadget
.is_otg
= 1;
1054 static int dummy_udc_probe(struct platform_device
*pdev
)
1059 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
1060 /* Clear usb_gadget region for new registration to udc-core */
1061 memzero_explicit(&dum
->gadget
, sizeof(struct usb_gadget
));
1062 dum
->gadget
.name
= gadget_name
;
1063 dum
->gadget
.ops
= &dummy_ops
;
1064 if (mod_data
.is_super_speed
)
1065 dum
->gadget
.max_speed
= USB_SPEED_SUPER
;
1066 else if (mod_data
.is_high_speed
)
1067 dum
->gadget
.max_speed
= USB_SPEED_HIGH
;
1069 dum
->gadget
.max_speed
= USB_SPEED_FULL
;
1071 dum
->gadget
.dev
.parent
= &pdev
->dev
;
1072 init_dummy_udc_hw(dum
);
1074 rc
= usb_add_gadget_udc(&pdev
->dev
, &dum
->gadget
);
1078 rc
= device_create_file(&dum
->gadget
.dev
, &dev_attr_function
);
1081 platform_set_drvdata(pdev
, dum
);
1085 usb_del_gadget_udc(&dum
->gadget
);
1090 static int dummy_udc_remove(struct platform_device
*pdev
)
1092 struct dummy
*dum
= platform_get_drvdata(pdev
);
1094 device_remove_file(&dum
->gadget
.dev
, &dev_attr_function
);
1095 usb_del_gadget_udc(&dum
->gadget
);
1099 static void dummy_udc_pm(struct dummy
*dum
, struct dummy_hcd
*dum_hcd
,
1102 spin_lock_irq(&dum
->lock
);
1103 dum
->udc_suspended
= suspend
;
1104 set_link_state(dum_hcd
);
1105 spin_unlock_irq(&dum
->lock
);
1108 static int dummy_udc_suspend(struct platform_device
*pdev
, pm_message_t state
)
1110 struct dummy
*dum
= platform_get_drvdata(pdev
);
1111 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1113 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1114 dummy_udc_pm(dum
, dum_hcd
, 1);
1115 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1119 static int dummy_udc_resume(struct platform_device
*pdev
)
1121 struct dummy
*dum
= platform_get_drvdata(pdev
);
1122 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1124 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1125 dummy_udc_pm(dum
, dum_hcd
, 0);
1126 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1130 static struct platform_driver dummy_udc_driver
= {
1131 .probe
= dummy_udc_probe
,
1132 .remove
= dummy_udc_remove
,
1133 .suspend
= dummy_udc_suspend
,
1134 .resume
= dummy_udc_resume
,
1136 .name
= (char *) gadget_name
,
1140 /*-------------------------------------------------------------------------*/
1142 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor
*desc
)
1146 index
= usb_endpoint_num(desc
) << 1;
1147 if (usb_endpoint_dir_in(desc
))
1152 /* MASTER/HOST SIDE DRIVER
1154 * this uses the hcd framework to hook up to host side drivers.
1155 * its root hub will only have one device, otherwise it acts like
1156 * a normal host controller.
1158 * when urbs are queued, they're just stuck on a list that we
1159 * scan in a timer callback. that callback connects writes from
1160 * the host with reads from the device, and so on, based on the
1164 static int dummy_ep_stream_en(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1166 const struct usb_endpoint_descriptor
*desc
= &urb
->ep
->desc
;
1169 if (!usb_endpoint_xfer_bulk(desc
))
1172 index
= dummy_get_ep_idx(desc
);
1173 return (1 << index
) & dum_hcd
->stream_en_ep
;
1177 * The max stream number is saved as a nibble so for the 30 possible endpoints
1178 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1179 * means we use only 1 stream). The maximum according to the spec is 16bit so
1180 * if the 16 stream limit is about to go, the array size should be incremented
1181 * to 30 elements of type u16.
1183 static int get_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1188 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1189 if (usb_pipeout(pipe
))
1197 static void set_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1198 unsigned int pipe
, unsigned int streams
)
1203 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1204 if (usb_pipeout(pipe
)) {
1208 max_streams
&= 0xf0;
1210 max_streams
|= streams
;
1211 dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)] = max_streams
;
1214 static int dummy_validate_stream(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1216 unsigned int max_streams
;
1219 enabled
= dummy_ep_stream_en(dum_hcd
, urb
);
1220 if (!urb
->stream_id
) {
1228 max_streams
= get_max_streams_for_pipe(dum_hcd
,
1229 usb_pipeendpoint(urb
->pipe
));
1230 if (urb
->stream_id
> max_streams
) {
1231 dev_err(dummy_dev(dum_hcd
), "Stream id %d is out of range.\n",
1239 static int dummy_urb_enqueue(
1240 struct usb_hcd
*hcd
,
1244 struct dummy_hcd
*dum_hcd
;
1246 unsigned long flags
;
1249 urbp
= kmalloc(sizeof *urbp
, mem_flags
);
1253 urbp
->miter_started
= 0;
1255 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1256 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1258 rc
= dummy_validate_stream(dum_hcd
, urb
);
1264 rc
= usb_hcd_link_urb_to_ep(hcd
, urb
);
1270 if (!dum_hcd
->udev
) {
1271 dum_hcd
->udev
= urb
->dev
;
1272 usb_get_dev(dum_hcd
->udev
);
1273 } else if (unlikely(dum_hcd
->udev
!= urb
->dev
))
1274 dev_err(dummy_dev(dum_hcd
), "usb_device address has changed!\n");
1276 list_add_tail(&urbp
->urbp_list
, &dum_hcd
->urbp_list
);
1278 if (!dum_hcd
->next_frame_urbp
)
1279 dum_hcd
->next_frame_urbp
= urbp
;
1280 if (usb_pipetype(urb
->pipe
) == PIPE_CONTROL
)
1281 urb
->error_count
= 1; /* mark as a new urb */
1283 /* kick the scheduler, it'll do the rest */
1284 if (!timer_pending(&dum_hcd
->timer
))
1285 mod_timer(&dum_hcd
->timer
, jiffies
+ 1);
1288 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1292 static int dummy_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1294 struct dummy_hcd
*dum_hcd
;
1295 unsigned long flags
;
1298 /* giveback happens automatically in timer callback,
1299 * so make sure the callback happens */
1300 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1301 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1303 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
1304 if (!rc
&& dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
&&
1305 !list_empty(&dum_hcd
->urbp_list
))
1306 mod_timer(&dum_hcd
->timer
, jiffies
);
1308 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1312 static int dummy_perform_transfer(struct urb
*urb
, struct dummy_request
*req
,
1316 struct urbp
*urbp
= urb
->hcpriv
;
1318 struct sg_mapping_iter
*miter
= &urbp
->miter
;
1323 to_host
= usb_pipein(urb
->pipe
);
1324 rbuf
= req
->req
.buf
+ req
->req
.actual
;
1326 if (!urb
->num_sgs
) {
1327 ubuf
= urb
->transfer_buffer
+ urb
->actual_length
;
1329 memcpy(ubuf
, rbuf
, len
);
1331 memcpy(rbuf
, ubuf
, len
);
1335 if (!urbp
->miter_started
) {
1336 u32 flags
= SG_MITER_ATOMIC
;
1339 flags
|= SG_MITER_TO_SG
;
1341 flags
|= SG_MITER_FROM_SG
;
1343 sg_miter_start(miter
, urb
->sg
, urb
->num_sgs
, flags
);
1344 urbp
->miter_started
= 1;
1346 next_sg
= sg_miter_next(miter
);
1347 if (next_sg
== false) {
1353 this_sg
= min_t(u32
, len
, miter
->length
);
1354 miter
->consumed
= this_sg
;
1358 memcpy(ubuf
, rbuf
, this_sg
);
1360 memcpy(rbuf
, ubuf
, this_sg
);
1365 next_sg
= sg_miter_next(miter
);
1366 if (next_sg
== false) {
1374 sg_miter_stop(miter
);
1378 /* transfer up to a frame's worth; caller must own lock */
1379 static int transfer(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1380 struct dummy_ep
*ep
, int limit
, int *status
)
1382 struct dummy
*dum
= dum_hcd
->dum
;
1383 struct dummy_request
*req
;
1387 /* if there's no request queued, the device is NAKing; return */
1388 list_for_each_entry(req
, &ep
->queue
, queue
) {
1389 unsigned host_len
, dev_len
, len
;
1390 int is_short
, to_host
;
1393 if (dummy_ep_stream_en(dum_hcd
, urb
)) {
1394 if ((urb
->stream_id
!= req
->req
.stream_id
))
1398 /* 1..N packets of ep->ep.maxpacket each ... the last one
1399 * may be short (including zero length).
1401 * writer can send a zlp explicitly (length 0) or implicitly
1402 * (length mod maxpacket zero, and 'zero' flag); they always
1405 host_len
= urb
->transfer_buffer_length
- urb
->actual_length
;
1406 dev_len
= req
->req
.length
- req
->req
.actual
;
1407 len
= min(host_len
, dev_len
);
1409 /* FIXME update emulated data toggle too */
1411 to_host
= usb_pipein(urb
->pipe
);
1412 if (unlikely(len
== 0))
1415 /* not enough bandwidth left? */
1416 if (limit
< ep
->ep
.maxpacket
&& limit
< len
)
1418 len
= min_t(unsigned, len
, limit
);
1422 /* send multiple of maxpacket first, then remainder */
1423 if (len
>= ep
->ep
.maxpacket
) {
1425 if (len
% ep
->ep
.maxpacket
)
1427 len
-= len
% ep
->ep
.maxpacket
;
1432 len
= dummy_perform_transfer(urb
, req
, len
);
1434 ep
->last_io
= jiffies
;
1436 req
->req
.status
= len
;
1440 urb
->actual_length
+= len
;
1441 req
->req
.actual
+= len
;
1445 /* short packets terminate, maybe with overflow/underflow.
1446 * it's only really an error to write too much.
1448 * partially filling a buffer optionally blocks queue advances
1449 * (so completion handlers can clean up the queue) but we don't
1450 * need to emulate such data-in-flight.
1453 if (host_len
== dev_len
) {
1454 req
->req
.status
= 0;
1456 } else if (to_host
) {
1457 req
->req
.status
= 0;
1458 if (dev_len
> host_len
)
1459 *status
= -EOVERFLOW
;
1464 if (host_len
> dev_len
)
1465 req
->req
.status
= -EOVERFLOW
;
1467 req
->req
.status
= 0;
1471 * many requests terminate without a short packet.
1472 * send a zlp if demanded by flags.
1475 if (req
->req
.length
== req
->req
.actual
) {
1476 if (req
->req
.zero
&& to_host
)
1479 req
->req
.status
= 0;
1481 if (urb
->transfer_buffer_length
== urb
->actual_length
) {
1482 if (urb
->transfer_flags
& URB_ZERO_PACKET
&&
1490 /* device side completion --> continuable */
1491 if (req
->req
.status
!= -EINPROGRESS
) {
1492 list_del_init(&req
->queue
);
1494 spin_unlock(&dum
->lock
);
1495 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1496 spin_lock(&dum
->lock
);
1498 /* requests might have been unlinked... */
1502 /* host side completion --> terminate */
1503 if (*status
!= -EINPROGRESS
)
1506 /* rescan to continue with any other queued i/o */
1513 static int periodic_bytes(struct dummy
*dum
, struct dummy_ep
*ep
)
1515 int limit
= ep
->ep
.maxpacket
;
1517 if (dum
->gadget
.speed
== USB_SPEED_HIGH
) {
1520 /* high bandwidth mode */
1521 tmp
= usb_endpoint_maxp(ep
->desc
);
1522 tmp
= (tmp
>> 11) & 0x03;
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(unsigned long _dum_hcd
)
1761 struct dummy_hcd
*dum_hcd
= (struct dummy_hcd
*) _dum_hcd
;
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 switch (dum
->gadget
.speed
) {
1771 total
= 8/*bytes*/ * 12/*packets*/;
1773 case USB_SPEED_FULL
:
1774 total
= 64/*bytes*/ * 19/*packets*/;
1776 case USB_SPEED_HIGH
:
1777 total
= 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1779 case USB_SPEED_SUPER
:
1780 /* Bus speed is 500000 bytes/ms, so use a little less */
1784 dev_err(dummy_dev(dum_hcd
), "bogus device speed\n");
1788 /* FIXME if HZ != 1000 this will probably misbehave ... */
1790 /* look at each urb queued by the host side driver */
1791 spin_lock_irqsave(&dum
->lock
, flags
);
1793 if (!dum_hcd
->udev
) {
1794 dev_err(dummy_dev(dum_hcd
),
1795 "timer fired with no URBs pending?\n");
1796 spin_unlock_irqrestore(&dum
->lock
, flags
);
1799 dum_hcd
->next_frame_urbp
= NULL
;
1801 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1802 if (!ep_info
[i
].name
)
1804 dum
->ep
[i
].already_seen
= 0;
1808 list_for_each_entry_safe(urbp
, tmp
, &dum_hcd
->urbp_list
, urbp_list
) {
1810 struct dummy_request
*req
;
1812 struct dummy_ep
*ep
= NULL
;
1814 int status
= -EINPROGRESS
;
1816 /* stop when we reach URBs queued after the timer interrupt */
1817 if (urbp
== dum_hcd
->next_frame_urbp
)
1823 else if (dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
)
1825 type
= usb_pipetype(urb
->pipe
);
1827 /* used up this frame's non-periodic bandwidth?
1828 * FIXME there's infinite bandwidth for control and
1829 * periodic transfers ... unrealistic.
1831 if (total
<= 0 && type
== PIPE_BULK
)
1834 /* find the gadget's ep for this request (if configured) */
1835 address
= usb_pipeendpoint (urb
->pipe
);
1836 if (usb_pipein(urb
->pipe
))
1837 address
|= USB_DIR_IN
;
1838 ep
= find_endpoint(dum
, address
);
1840 /* set_configuration() disagreement */
1841 dev_dbg(dummy_dev(dum_hcd
),
1842 "no ep configured for urb %p\n",
1848 if (ep
->already_seen
)
1850 ep
->already_seen
= 1;
1851 if (ep
== &dum
->ep
[0] && urb
->error_count
) {
1852 ep
->setup_stage
= 1; /* a new urb */
1853 urb
->error_count
= 0;
1855 if (ep
->halted
&& !ep
->setup_stage
) {
1856 /* NOTE: must not be iso! */
1857 dev_dbg(dummy_dev(dum_hcd
), "ep %s halted, urb %p\n",
1862 /* FIXME make sure both ends agree on maxpacket */
1864 /* handle control requests */
1865 if (ep
== &dum
->ep
[0] && ep
->setup_stage
) {
1866 struct usb_ctrlrequest setup
;
1869 setup
= *(struct usb_ctrlrequest
*) urb
->setup_packet
;
1870 /* paranoia, in case of stale queued data */
1871 list_for_each_entry(req
, &ep
->queue
, queue
) {
1872 list_del_init(&req
->queue
);
1873 req
->req
.status
= -EOVERFLOW
;
1874 dev_dbg(udc_dev(dum
), "stale req = %p\n",
1877 spin_unlock(&dum
->lock
);
1878 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1879 spin_lock(&dum
->lock
);
1880 ep
->already_seen
= 0;
1884 /* gadget driver never sees set_address or operations
1885 * on standard feature flags. some hardware doesn't
1888 ep
->last_io
= jiffies
;
1889 ep
->setup_stage
= 0;
1892 value
= handle_control_request(dum_hcd
, urb
, &setup
,
1895 /* gadget driver handles all other requests. block
1896 * until setup() returns; no reentrancy issues etc.
1899 ++dum
->callback_usage
;
1900 spin_unlock(&dum
->lock
);
1901 value
= dum
->driver
->setup(&dum
->gadget
,
1903 spin_lock(&dum
->lock
);
1904 --dum
->callback_usage
;
1907 /* no delays (max 64KB data stage) */
1909 goto treat_control_like_bulk
;
1911 /* error, see below */
1915 if (value
!= -EOPNOTSUPP
)
1916 dev_dbg(udc_dev(dum
),
1920 urb
->actual_length
= 0;
1926 /* non-control requests */
1928 switch (usb_pipetype(urb
->pipe
)) {
1929 case PIPE_ISOCHRONOUS
:
1930 /* FIXME is it urb->interval since the last xfer?
1931 * use urb->iso_frame_desc[i].
1932 * complete whether or not ep has requests queued.
1933 * report random errors, to debug drivers.
1935 limit
= max(limit
, periodic_bytes(dum
, ep
));
1939 case PIPE_INTERRUPT
:
1940 /* FIXME is it urb->interval since the last xfer?
1941 * this almost certainly polls too fast.
1943 limit
= max(limit
, periodic_bytes(dum
, ep
));
1947 treat_control_like_bulk
:
1948 ep
->last_io
= jiffies
;
1949 total
-= transfer(dum_hcd
, urb
, ep
, limit
, &status
);
1953 /* incomplete transfer? */
1954 if (status
== -EINPROGRESS
)
1958 list_del(&urbp
->urbp_list
);
1961 ep
->already_seen
= ep
->setup_stage
= 0;
1963 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd
), urb
);
1964 spin_unlock(&dum
->lock
);
1965 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd
), urb
, status
);
1966 spin_lock(&dum
->lock
);
1971 if (list_empty(&dum_hcd
->urbp_list
)) {
1972 usb_put_dev(dum_hcd
->udev
);
1973 dum_hcd
->udev
= NULL
;
1974 } else if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
1975 /* want a 1 msec delay here */
1976 mod_timer(&dum_hcd
->timer
, jiffies
+ msecs_to_jiffies(1));
1979 spin_unlock_irqrestore(&dum
->lock
, flags
);
1982 /*-------------------------------------------------------------------------*/
1984 #define PORT_C_MASK \
1985 ((USB_PORT_STAT_C_CONNECTION \
1986 | USB_PORT_STAT_C_ENABLE \
1987 | USB_PORT_STAT_C_SUSPEND \
1988 | USB_PORT_STAT_C_OVERCURRENT \
1989 | USB_PORT_STAT_C_RESET) << 16)
1991 static int dummy_hub_status(struct usb_hcd
*hcd
, char *buf
)
1993 struct dummy_hcd
*dum_hcd
;
1994 unsigned long flags
;
1997 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1999 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2000 if (!HCD_HW_ACCESSIBLE(hcd
))
2003 if (dum_hcd
->resuming
&& time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2004 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
2005 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
2006 set_link_state(dum_hcd
);
2009 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0) {
2011 dev_dbg(dummy_dev(dum_hcd
), "port status 0x%08x has changes\n",
2012 dum_hcd
->port_status
);
2014 if (dum_hcd
->rh_state
== DUMMY_RH_SUSPENDED
)
2015 usb_hcd_resume_root_hub(hcd
);
2018 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2022 /* usb 3.0 root hub device descriptor */
2024 struct usb_bos_descriptor bos
;
2025 struct usb_ss_cap_descriptor ss_cap
;
2026 } __packed usb3_bos_desc
= {
2029 .bLength
= USB_DT_BOS_SIZE
,
2030 .bDescriptorType
= USB_DT_BOS
,
2031 .wTotalLength
= cpu_to_le16(sizeof(usb3_bos_desc
)),
2032 .bNumDeviceCaps
= 1,
2035 .bLength
= USB_DT_USB_SS_CAP_SIZE
,
2036 .bDescriptorType
= USB_DT_DEVICE_CAPABILITY
,
2037 .bDevCapabilityType
= USB_SS_CAP_TYPE
,
2038 .wSpeedSupported
= cpu_to_le16(USB_5GBPS_OPERATION
),
2039 .bFunctionalitySupport
= ilog2(USB_5GBPS_OPERATION
),
2044 ss_hub_descriptor(struct usb_hub_descriptor
*desc
)
2046 memset(desc
, 0, sizeof *desc
);
2047 desc
->bDescriptorType
= USB_DT_SS_HUB
;
2048 desc
->bDescLength
= 12;
2049 desc
->wHubCharacteristics
= cpu_to_le16(
2050 HUB_CHAR_INDV_PORT_LPSM
|
2051 HUB_CHAR_COMMON_OCPM
);
2052 desc
->bNbrPorts
= 1;
2053 desc
->u
.ss
.bHubHdrDecLat
= 0x04; /* Worst case: 0.4 micro sec*/
2054 desc
->u
.ss
.DeviceRemovable
= 0;
2057 static inline void hub_descriptor(struct usb_hub_descriptor
*desc
)
2059 memset(desc
, 0, sizeof *desc
);
2060 desc
->bDescriptorType
= USB_DT_HUB
;
2061 desc
->bDescLength
= 9;
2062 desc
->wHubCharacteristics
= cpu_to_le16(
2063 HUB_CHAR_INDV_PORT_LPSM
|
2064 HUB_CHAR_COMMON_OCPM
);
2065 desc
->bNbrPorts
= 1;
2066 desc
->u
.hs
.DeviceRemovable
[0] = 0;
2067 desc
->u
.hs
.DeviceRemovable
[1] = 0xff; /* PortPwrCtrlMask */
2070 static int dummy_hub_control(
2071 struct usb_hcd
*hcd
,
2078 struct dummy_hcd
*dum_hcd
;
2080 unsigned long flags
;
2082 if (!HCD_HW_ACCESSIBLE(hcd
))
2085 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2087 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2089 case ClearHubFeature
:
2091 case ClearPortFeature
:
2093 case USB_PORT_FEAT_SUSPEND
:
2094 if (hcd
->speed
== HCD_USB3
) {
2095 dev_dbg(dummy_dev(dum_hcd
),
2096 "USB_PORT_FEAT_SUSPEND req not "
2097 "supported for USB 3.0 roothub\n");
2100 if (dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) {
2101 /* 20msec resume signaling */
2102 dum_hcd
->resuming
= 1;
2103 dum_hcd
->re_timeout
= jiffies
+
2104 msecs_to_jiffies(20);
2107 case USB_PORT_FEAT_POWER
:
2108 dev_dbg(dummy_dev(dum_hcd
), "power-off\n");
2109 if (hcd
->speed
== HCD_USB3
)
2110 dum_hcd
->port_status
&= ~USB_SS_PORT_STAT_POWER
;
2112 dum_hcd
->port_status
&= ~USB_PORT_STAT_POWER
;
2113 set_link_state(dum_hcd
);
2116 dum_hcd
->port_status
&= ~(1 << wValue
);
2117 set_link_state(dum_hcd
);
2120 case GetHubDescriptor
:
2121 if (hcd
->speed
== HCD_USB3
&&
2122 (wLength
< USB_DT_SS_HUB_SIZE
||
2123 wValue
!= (USB_DT_SS_HUB
<< 8))) {
2124 dev_dbg(dummy_dev(dum_hcd
),
2125 "Wrong hub descriptor type for "
2126 "USB 3.0 roothub.\n");
2129 if (hcd
->speed
== HCD_USB3
)
2130 ss_hub_descriptor((struct usb_hub_descriptor
*) buf
);
2132 hub_descriptor((struct usb_hub_descriptor
*) buf
);
2135 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
2136 if (hcd
->speed
!= HCD_USB3
)
2139 if ((wValue
>> 8) != USB_DT_BOS
)
2142 memcpy(buf
, &usb3_bos_desc
, sizeof(usb3_bos_desc
));
2143 retval
= sizeof(usb3_bos_desc
);
2147 *(__le32
*) buf
= cpu_to_le32(0);
2153 /* whoever resets or resumes must GetPortStatus to
2156 if (dum_hcd
->resuming
&&
2157 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2158 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
2159 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
2161 if ((dum_hcd
->port_status
& USB_PORT_STAT_RESET
) != 0 &&
2162 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2163 dum_hcd
->port_status
|= (USB_PORT_STAT_C_RESET
<< 16);
2164 dum_hcd
->port_status
&= ~USB_PORT_STAT_RESET
;
2165 if (dum_hcd
->dum
->pullup
) {
2166 dum_hcd
->port_status
|= USB_PORT_STAT_ENABLE
;
2168 if (hcd
->speed
< HCD_USB3
) {
2169 switch (dum_hcd
->dum
->gadget
.speed
) {
2170 case USB_SPEED_HIGH
:
2171 dum_hcd
->port_status
|=
2172 USB_PORT_STAT_HIGH_SPEED
;
2175 dum_hcd
->dum
->gadget
.ep0
->
2177 dum_hcd
->port_status
|=
2178 USB_PORT_STAT_LOW_SPEED
;
2181 dum_hcd
->dum
->gadget
.speed
=
2188 set_link_state(dum_hcd
);
2189 ((__le16
*) buf
)[0] = cpu_to_le16(dum_hcd
->port_status
);
2190 ((__le16
*) buf
)[1] = cpu_to_le16(dum_hcd
->port_status
>> 16);
2195 case SetPortFeature
:
2197 case USB_PORT_FEAT_LINK_STATE
:
2198 if (hcd
->speed
!= HCD_USB3
) {
2199 dev_dbg(dummy_dev(dum_hcd
),
2200 "USB_PORT_FEAT_LINK_STATE req not "
2201 "supported for USB 2.0 roothub\n");
2205 * Since this is dummy we don't have an actual link so
2206 * there is nothing to do for the SET_LINK_STATE cmd
2209 case USB_PORT_FEAT_U1_TIMEOUT
:
2210 case USB_PORT_FEAT_U2_TIMEOUT
:
2211 /* TODO: add suspend/resume support! */
2212 if (hcd
->speed
!= HCD_USB3
) {
2213 dev_dbg(dummy_dev(dum_hcd
),
2214 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2215 "supported for USB 2.0 roothub\n");
2219 case USB_PORT_FEAT_SUSPEND
:
2220 /* Applicable only for USB2.0 hub */
2221 if (hcd
->speed
== HCD_USB3
) {
2222 dev_dbg(dummy_dev(dum_hcd
),
2223 "USB_PORT_FEAT_SUSPEND req not "
2224 "supported for USB 3.0 roothub\n");
2227 if (dum_hcd
->active
) {
2228 dum_hcd
->port_status
|= USB_PORT_STAT_SUSPEND
;
2230 /* HNP would happen here; for now we
2231 * assume b_bus_req is always true.
2233 set_link_state(dum_hcd
);
2234 if (((1 << USB_DEVICE_B_HNP_ENABLE
)
2235 & dum_hcd
->dum
->devstatus
) != 0)
2236 dev_dbg(dummy_dev(dum_hcd
),
2240 case USB_PORT_FEAT_POWER
:
2241 if (hcd
->speed
== HCD_USB3
)
2242 dum_hcd
->port_status
|= USB_SS_PORT_STAT_POWER
;
2244 dum_hcd
->port_status
|= USB_PORT_STAT_POWER
;
2245 set_link_state(dum_hcd
);
2247 case USB_PORT_FEAT_BH_PORT_RESET
:
2248 /* Applicable only for USB3.0 hub */
2249 if (hcd
->speed
!= HCD_USB3
) {
2250 dev_dbg(dummy_dev(dum_hcd
),
2251 "USB_PORT_FEAT_BH_PORT_RESET req not "
2252 "supported for USB 2.0 roothub\n");
2256 case USB_PORT_FEAT_RESET
:
2257 /* if it's already enabled, disable */
2258 if (hcd
->speed
== HCD_USB3
) {
2259 dum_hcd
->port_status
= 0;
2260 dum_hcd
->port_status
=
2261 (USB_SS_PORT_STAT_POWER
|
2262 USB_PORT_STAT_CONNECTION
|
2263 USB_PORT_STAT_RESET
);
2265 dum_hcd
->port_status
&= ~(USB_PORT_STAT_ENABLE
2266 | USB_PORT_STAT_LOW_SPEED
2267 | USB_PORT_STAT_HIGH_SPEED
);
2269 * We want to reset device status. All but the
2270 * Self powered feature
2272 dum_hcd
->dum
->devstatus
&=
2273 (1 << USB_DEVICE_SELF_POWERED
);
2275 * FIXME USB3.0: what is the correct reset signaling
2276 * interval? Is it still 50msec as for HS?
2278 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(50);
2281 if (hcd
->speed
== HCD_USB3
) {
2282 if ((dum_hcd
->port_status
&
2283 USB_SS_PORT_STAT_POWER
) != 0) {
2284 dum_hcd
->port_status
|= (1 << wValue
);
2287 if ((dum_hcd
->port_status
&
2288 USB_PORT_STAT_POWER
) != 0) {
2289 dum_hcd
->port_status
|= (1 << wValue
);
2291 set_link_state(dum_hcd
);
2294 case GetPortErrorCount
:
2295 if (hcd
->speed
!= HCD_USB3
) {
2296 dev_dbg(dummy_dev(dum_hcd
),
2297 "GetPortErrorCount req not "
2298 "supported for USB 2.0 roothub\n");
2301 /* We'll always return 0 since this is a dummy hub */
2302 *(__le32
*) buf
= cpu_to_le32(0);
2305 if (hcd
->speed
!= HCD_USB3
) {
2306 dev_dbg(dummy_dev(dum_hcd
),
2307 "SetHubDepth req not supported for "
2308 "USB 2.0 roothub\n");
2313 dev_dbg(dummy_dev(dum_hcd
),
2314 "hub control req%04x v%04x i%04x l%d\n",
2315 typeReq
, wValue
, wIndex
, wLength
);
2317 /* "protocol stall" on error */
2320 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2322 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0)
2323 usb_hcd_poll_rh_status(hcd
);
2327 static int dummy_bus_suspend(struct usb_hcd
*hcd
)
2329 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2331 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2333 spin_lock_irq(&dum_hcd
->dum
->lock
);
2334 dum_hcd
->rh_state
= DUMMY_RH_SUSPENDED
;
2335 set_link_state(dum_hcd
);
2336 hcd
->state
= HC_STATE_SUSPENDED
;
2337 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2341 static int dummy_bus_resume(struct usb_hcd
*hcd
)
2343 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2346 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2348 spin_lock_irq(&dum_hcd
->dum
->lock
);
2349 if (!HCD_HW_ACCESSIBLE(hcd
)) {
2352 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2353 set_link_state(dum_hcd
);
2354 if (!list_empty(&dum_hcd
->urbp_list
))
2355 mod_timer(&dum_hcd
->timer
, jiffies
);
2356 hcd
->state
= HC_STATE_RUNNING
;
2358 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2362 /*-------------------------------------------------------------------------*/
2364 static inline ssize_t
show_urb(char *buf
, size_t size
, struct urb
*urb
)
2366 int ep
= usb_pipeendpoint(urb
->pipe
);
2368 return snprintf(buf
, size
,
2369 "urb/%p %s ep%d%s%s len %d/%d\n",
2372 switch (urb
->dev
->speed
) {
2376 case USB_SPEED_FULL
:
2379 case USB_SPEED_HIGH
:
2382 case USB_SPEED_SUPER
:
2389 ep
, ep
? (usb_pipein(urb
->pipe
) ? "in" : "out") : "",
2391 switch (usb_pipetype(urb
->pipe
)) { \
2392 case PIPE_CONTROL
: \
2398 case PIPE_INTERRUPT
: \
2405 urb
->actual_length
, urb
->transfer_buffer_length
);
2408 static ssize_t
urbs_show(struct device
*dev
, struct device_attribute
*attr
,
2411 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
2412 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2415 unsigned long flags
;
2417 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2418 list_for_each_entry(urbp
, &dum_hcd
->urbp_list
, urbp_list
) {
2421 temp
= show_urb(buf
, PAGE_SIZE
- size
, urbp
->urb
);
2425 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2429 static DEVICE_ATTR_RO(urbs
);
2431 static int dummy_start_ss(struct dummy_hcd
*dum_hcd
)
2433 init_timer(&dum_hcd
->timer
);
2434 dum_hcd
->timer
.function
= dummy_timer
;
2435 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2436 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2437 dum_hcd
->stream_en_ep
= 0;
2438 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2439 dummy_hcd_to_hcd(dum_hcd
)->power_budget
= POWER_BUDGET
;
2440 dummy_hcd_to_hcd(dum_hcd
)->state
= HC_STATE_RUNNING
;
2441 dummy_hcd_to_hcd(dum_hcd
)->uses_new_polling
= 1;
2442 #ifdef CONFIG_USB_OTG
2443 dummy_hcd_to_hcd(dum_hcd
)->self
.otg_port
= 1;
2447 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2448 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2451 static int dummy_start(struct usb_hcd
*hcd
)
2453 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2456 * MASTER side init ... we emulate a root hub that'll only ever
2457 * talk to one device (the slave side). Also appears in sysfs,
2458 * just like more familiar pci-based HCDs.
2460 if (!usb_hcd_is_primary_hcd(hcd
))
2461 return dummy_start_ss(dum_hcd
);
2463 spin_lock_init(&dum_hcd
->dum
->lock
);
2464 init_timer(&dum_hcd
->timer
);
2465 dum_hcd
->timer
.function
= dummy_timer
;
2466 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2467 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2469 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2471 hcd
->power_budget
= POWER_BUDGET
;
2472 hcd
->state
= HC_STATE_RUNNING
;
2473 hcd
->uses_new_polling
= 1;
2475 #ifdef CONFIG_USB_OTG
2476 hcd
->self
.otg_port
= 1;
2479 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2480 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2483 static void dummy_stop(struct usb_hcd
*hcd
)
2487 dum
= hcd_to_dummy_hcd(hcd
)->dum
;
2488 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd
)), &dev_attr_urbs
);
2489 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd
)), "stopped\n");
2492 /*-------------------------------------------------------------------------*/
2494 static int dummy_h_get_frame(struct usb_hcd
*hcd
)
2496 return dummy_g_get_frame(NULL
);
2499 static int dummy_setup(struct usb_hcd
*hcd
)
2503 dum
= *((void **)dev_get_platdata(hcd
->self
.controller
));
2504 hcd
->self
.sg_tablesize
= ~0;
2505 if (usb_hcd_is_primary_hcd(hcd
)) {
2506 dum
->hs_hcd
= hcd_to_dummy_hcd(hcd
);
2507 dum
->hs_hcd
->dum
= dum
;
2509 * Mark the first roothub as being USB 2.0.
2510 * The USB 3.0 roothub will be registered later by
2513 hcd
->speed
= HCD_USB2
;
2514 hcd
->self
.root_hub
->speed
= USB_SPEED_HIGH
;
2516 dum
->ss_hcd
= hcd_to_dummy_hcd(hcd
);
2517 dum
->ss_hcd
->dum
= dum
;
2518 hcd
->speed
= HCD_USB3
;
2519 hcd
->self
.root_hub
->speed
= USB_SPEED_SUPER
;
2524 /* Change a group of bulk endpoints to support multiple stream IDs */
2525 static int dummy_alloc_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2526 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2527 unsigned int num_streams
, gfp_t mem_flags
)
2529 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2530 unsigned long flags
;
2532 int ret_streams
= num_streams
;
2539 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2540 for (i
= 0; i
< num_eps
; i
++) {
2541 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2542 if ((1 << index
) & dum_hcd
->stream_en_ep
) {
2543 ret_streams
= -EINVAL
;
2546 max_stream
= usb_ss_max_streams(&eps
[i
]->ss_ep_comp
);
2548 ret_streams
= -EINVAL
;
2551 if (max_stream
< ret_streams
) {
2552 dev_dbg(dummy_dev(dum_hcd
), "Ep 0x%x only supports %u "
2554 eps
[i
]->desc
.bEndpointAddress
,
2556 ret_streams
= max_stream
;
2560 for (i
= 0; i
< num_eps
; i
++) {
2561 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2562 dum_hcd
->stream_en_ep
|= 1 << index
;
2563 set_max_streams_for_pipe(dum_hcd
,
2564 usb_endpoint_num(&eps
[i
]->desc
), ret_streams
);
2567 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2571 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2572 static int dummy_free_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2573 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2576 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2577 unsigned long flags
;
2582 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2583 for (i
= 0; i
< num_eps
; i
++) {
2584 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2585 if (!((1 << index
) & dum_hcd
->stream_en_ep
)) {
2591 for (i
= 0; i
< num_eps
; i
++) {
2592 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2593 dum_hcd
->stream_en_ep
&= ~(1 << index
);
2594 set_max_streams_for_pipe(dum_hcd
,
2595 usb_endpoint_num(&eps
[i
]->desc
), 0);
2599 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2603 static struct hc_driver dummy_hcd
= {
2604 .description
= (char *) driver_name
,
2605 .product_desc
= "Dummy host controller",
2606 .hcd_priv_size
= sizeof(struct dummy_hcd
),
2608 .reset
= dummy_setup
,
2609 .start
= dummy_start
,
2612 .urb_enqueue
= dummy_urb_enqueue
,
2613 .urb_dequeue
= dummy_urb_dequeue
,
2615 .get_frame_number
= dummy_h_get_frame
,
2617 .hub_status_data
= dummy_hub_status
,
2618 .hub_control
= dummy_hub_control
,
2619 .bus_suspend
= dummy_bus_suspend
,
2620 .bus_resume
= dummy_bus_resume
,
2622 .alloc_streams
= dummy_alloc_streams
,
2623 .free_streams
= dummy_free_streams
,
2626 static int dummy_hcd_probe(struct platform_device
*pdev
)
2629 struct usb_hcd
*hs_hcd
;
2630 struct usb_hcd
*ss_hcd
;
2633 dev_info(&pdev
->dev
, "%s, driver " DRIVER_VERSION
"\n", driver_desc
);
2634 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
2636 if (mod_data
.is_super_speed
)
2637 dummy_hcd
.flags
= HCD_USB3
| HCD_SHARED
;
2638 else if (mod_data
.is_high_speed
)
2639 dummy_hcd
.flags
= HCD_USB2
;
2641 dummy_hcd
.flags
= HCD_USB11
;
2642 hs_hcd
= usb_create_hcd(&dummy_hcd
, &pdev
->dev
, dev_name(&pdev
->dev
));
2647 retval
= usb_add_hcd(hs_hcd
, 0, 0);
2651 if (mod_data
.is_super_speed
) {
2652 ss_hcd
= usb_create_shared_hcd(&dummy_hcd
, &pdev
->dev
,
2653 dev_name(&pdev
->dev
), hs_hcd
);
2656 goto dealloc_usb2_hcd
;
2659 retval
= usb_add_hcd(ss_hcd
, 0, 0);
2666 usb_put_hcd(ss_hcd
);
2668 usb_remove_hcd(hs_hcd
);
2670 usb_put_hcd(hs_hcd
);
2671 dum
->hs_hcd
= dum
->ss_hcd
= NULL
;
2675 static int dummy_hcd_remove(struct platform_device
*pdev
)
2679 dum
= hcd_to_dummy_hcd(platform_get_drvdata(pdev
))->dum
;
2682 usb_remove_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2683 usb_put_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2686 usb_remove_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2687 usb_put_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2695 static int dummy_hcd_suspend(struct platform_device
*pdev
, pm_message_t state
)
2697 struct usb_hcd
*hcd
;
2698 struct dummy_hcd
*dum_hcd
;
2701 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2703 hcd
= platform_get_drvdata(pdev
);
2704 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2705 if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
2706 dev_warn(&pdev
->dev
, "Root hub isn't suspended!\n");
2709 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2713 static int dummy_hcd_resume(struct platform_device
*pdev
)
2715 struct usb_hcd
*hcd
;
2717 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2719 hcd
= platform_get_drvdata(pdev
);
2720 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2721 usb_hcd_poll_rh_status(hcd
);
2725 static struct platform_driver dummy_hcd_driver
= {
2726 .probe
= dummy_hcd_probe
,
2727 .remove
= dummy_hcd_remove
,
2728 .suspend
= dummy_hcd_suspend
,
2729 .resume
= dummy_hcd_resume
,
2731 .name
= (char *) driver_name
,
2735 /*-------------------------------------------------------------------------*/
2736 #define MAX_NUM_UDC 2
2737 static struct platform_device
*the_udc_pdev
[MAX_NUM_UDC
];
2738 static struct platform_device
*the_hcd_pdev
[MAX_NUM_UDC
];
2740 static int __init
init(void)
2742 int retval
= -ENOMEM
;
2744 struct dummy
*dum
[MAX_NUM_UDC
];
2749 if (!mod_data
.is_high_speed
&& mod_data
.is_super_speed
)
2752 if (mod_data
.num
< 1 || mod_data
.num
> MAX_NUM_UDC
) {
2753 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2758 for (i
= 0; i
< mod_data
.num
; i
++) {
2759 the_hcd_pdev
[i
] = platform_device_alloc(driver_name
, i
);
2760 if (!the_hcd_pdev
[i
]) {
2763 platform_device_put(the_hcd_pdev
[i
--]);
2767 for (i
= 0; i
< mod_data
.num
; i
++) {
2768 the_udc_pdev
[i
] = platform_device_alloc(gadget_name
, i
);
2769 if (!the_udc_pdev
[i
]) {
2772 platform_device_put(the_udc_pdev
[i
--]);
2776 for (i
= 0; i
< mod_data
.num
; i
++) {
2777 dum
[i
] = kzalloc(sizeof(struct dummy
), GFP_KERNEL
);
2782 retval
= platform_device_add_data(the_hcd_pdev
[i
], &dum
[i
],
2786 retval
= platform_device_add_data(the_udc_pdev
[i
], &dum
[i
],
2792 retval
= platform_driver_register(&dummy_hcd_driver
);
2795 retval
= platform_driver_register(&dummy_udc_driver
);
2797 goto err_register_udc_driver
;
2799 for (i
= 0; i
< mod_data
.num
; i
++) {
2800 retval
= platform_device_add(the_hcd_pdev
[i
]);
2804 platform_device_del(the_hcd_pdev
[i
--]);
2808 for (i
= 0; i
< mod_data
.num
; i
++) {
2809 if (!dum
[i
]->hs_hcd
||
2810 (!dum
[i
]->ss_hcd
&& mod_data
.is_super_speed
)) {
2812 * The hcd was added successfully but its probe
2813 * function failed for some reason.
2820 for (i
= 0; i
< mod_data
.num
; i
++) {
2821 retval
= platform_device_add(the_udc_pdev
[i
]);
2825 platform_device_del(the_udc_pdev
[i
]);
2830 for (i
= 0; i
< mod_data
.num
; i
++) {
2831 if (!platform_get_drvdata(the_udc_pdev
[i
])) {
2833 * The udc was added successfully but its probe
2834 * function failed for some reason.
2843 for (i
= 0; i
< mod_data
.num
; i
++)
2844 platform_device_del(the_udc_pdev
[i
]);
2846 for (i
= 0; i
< mod_data
.num
; i
++)
2847 platform_device_del(the_hcd_pdev
[i
]);
2849 platform_driver_unregister(&dummy_udc_driver
);
2850 err_register_udc_driver
:
2851 platform_driver_unregister(&dummy_hcd_driver
);
2853 for (i
= 0; i
< mod_data
.num
; i
++)
2855 for (i
= 0; i
< mod_data
.num
; i
++)
2856 platform_device_put(the_udc_pdev
[i
]);
2858 for (i
= 0; i
< mod_data
.num
; i
++)
2859 platform_device_put(the_hcd_pdev
[i
]);
2864 static void __exit
cleanup(void)
2868 for (i
= 0; i
< mod_data
.num
; i
++) {
2871 dum
= *((void **)dev_get_platdata(&the_udc_pdev
[i
]->dev
));
2873 platform_device_unregister(the_udc_pdev
[i
]);
2874 platform_device_unregister(the_hcd_pdev
[i
]);
2877 platform_driver_unregister(&dummy_udc_driver
);
2878 platform_driver_unregister(&dummy_hcd_driver
);
2880 module_exit(cleanup
);