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 for (i
= 0; i
< DUMMY_ENDPOINTS
; ++i
)
342 nuke(dum
, &dum
->ep
[i
]);
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
)) {
446 usb_gadget_udc_reset(&dum
->gadget
, dum
->driver
);
448 dum
->driver
->disconnect(&dum
->gadget
);
450 } else if (dum_hcd
->active
!= dum_hcd
->old_active
) {
451 if (dum_hcd
->old_active
&& dum
->driver
->suspend
)
452 dum
->driver
->suspend(&dum
->gadget
);
453 else if (!dum_hcd
->old_active
&& dum
->driver
->resume
)
454 dum
->driver
->resume(&dum
->gadget
);
457 dum_hcd
->old_status
= dum_hcd
->port_status
;
458 dum_hcd
->old_active
= dum_hcd
->active
;
461 /*-------------------------------------------------------------------------*/
463 /* SLAVE/GADGET SIDE DRIVER
465 * This only tracks gadget state. All the work is done when the host
466 * side tries some (emulated) i/o operation. Real device controller
467 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
470 #define is_enabled(dum) \
471 (dum->port_status & USB_PORT_STAT_ENABLE)
473 static int dummy_enable(struct usb_ep
*_ep
,
474 const struct usb_endpoint_descriptor
*desc
)
477 struct dummy_hcd
*dum_hcd
;
482 ep
= usb_ep_to_dummy_ep(_ep
);
483 if (!_ep
|| !desc
|| ep
->desc
|| _ep
->name
== ep0name
484 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
)
486 dum
= ep_to_dummy(ep
);
490 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
491 if (!is_enabled(dum_hcd
))
495 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
496 * maximum packet size.
497 * For SS devices the wMaxPacketSize is limited by 1024.
499 max
= usb_endpoint_maxp(desc
);
501 /* drivers must not request bad settings, since lower levels
502 * (hardware or its drivers) may not check. some endpoints
503 * can't do iso, many have maxpacket limitations, etc.
505 * since this "hardware" driver is here to help debugging, we
506 * have some extra sanity checks. (there could be more though,
507 * especially for "ep9out" style fixed function ones.)
510 switch (usb_endpoint_type(desc
)) {
511 case USB_ENDPOINT_XFER_BULK
:
512 if (strstr(ep
->ep
.name
, "-iso")
513 || strstr(ep
->ep
.name
, "-int")) {
516 switch (dum
->gadget
.speed
) {
517 case USB_SPEED_SUPER
:
526 if (max
== 8 || max
== 16 || max
== 32 || max
== 64)
527 /* we'll fake any legal size */
529 /* save a return statement */
534 case USB_ENDPOINT_XFER_INT
:
535 if (strstr(ep
->ep
.name
, "-iso")) /* bulk is ok */
537 /* real hardware might not handle all packet sizes */
538 switch (dum
->gadget
.speed
) {
539 case USB_SPEED_SUPER
:
543 /* save a return statement */
547 /* save a return statement */
554 case USB_ENDPOINT_XFER_ISOC
:
555 if (strstr(ep
->ep
.name
, "-bulk")
556 || strstr(ep
->ep
.name
, "-int"))
558 /* real hardware might not handle all packet sizes */
559 switch (dum
->gadget
.speed
) {
560 case USB_SPEED_SUPER
:
564 /* save a return statement */
568 /* save a return statement */
574 /* few chips support control except on ep0 */
578 _ep
->maxpacket
= max
;
579 if (usb_ss_max_streams(_ep
->comp_desc
)) {
580 if (!usb_endpoint_xfer_bulk(desc
)) {
581 dev_err(udc_dev(dum
), "Can't enable stream support on "
582 "non-bulk ep %s\n", _ep
->name
);
589 dev_dbg(udc_dev(dum
), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
591 desc
->bEndpointAddress
& 0x0f,
592 (desc
->bEndpointAddress
& USB_DIR_IN
) ? "in" : "out",
594 switch (usb_endpoint_type(desc
)) {
595 case USB_ENDPOINT_XFER_BULK
:
598 case USB_ENDPOINT_XFER_ISOC
:
601 case USB_ENDPOINT_XFER_INT
:
608 max
, ep
->stream_en
? "enabled" : "disabled");
610 /* at this point real hardware should be NAKing transfers
611 * to that endpoint, until a buffer is queued to it.
613 ep
->halted
= ep
->wedged
= 0;
619 static int dummy_disable(struct usb_ep
*_ep
)
625 ep
= usb_ep_to_dummy_ep(_ep
);
626 if (!_ep
|| !ep
->desc
|| _ep
->name
== ep0name
)
628 dum
= ep_to_dummy(ep
);
630 spin_lock_irqsave(&dum
->lock
, flags
);
634 spin_unlock_irqrestore(&dum
->lock
, flags
);
636 dev_dbg(udc_dev(dum
), "disabled %s\n", _ep
->name
);
640 static struct usb_request
*dummy_alloc_request(struct usb_ep
*_ep
,
643 struct dummy_request
*req
;
648 req
= kzalloc(sizeof(*req
), mem_flags
);
651 INIT_LIST_HEAD(&req
->queue
);
655 static void dummy_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
657 struct dummy_request
*req
;
664 req
= usb_request_to_dummy_request(_req
);
665 WARN_ON(!list_empty(&req
->queue
));
669 static void fifo_complete(struct usb_ep
*ep
, struct usb_request
*req
)
673 static int dummy_queue(struct usb_ep
*_ep
, struct usb_request
*_req
,
677 struct dummy_request
*req
;
679 struct dummy_hcd
*dum_hcd
;
682 req
= usb_request_to_dummy_request(_req
);
683 if (!_req
|| !list_empty(&req
->queue
) || !_req
->complete
)
686 ep
= usb_ep_to_dummy_ep(_ep
);
687 if (!_ep
|| (!ep
->desc
&& _ep
->name
!= ep0name
))
690 dum
= ep_to_dummy(ep
);
691 dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
692 if (!dum
->driver
|| !is_enabled(dum_hcd
))
696 dev_dbg(udc_dev(dum
), "ep %p queue req %p to %s, len %d buf %p\n",
697 ep
, _req
, _ep
->name
, _req
->length
, _req
->buf
);
699 _req
->status
= -EINPROGRESS
;
701 spin_lock_irqsave(&dum
->lock
, flags
);
703 /* implement an emulated single-request FIFO */
704 if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
705 list_empty(&dum
->fifo_req
.queue
) &&
706 list_empty(&ep
->queue
) &&
707 _req
->length
<= FIFO_SIZE
) {
708 req
= &dum
->fifo_req
;
710 req
->req
.buf
= dum
->fifo_buf
;
711 memcpy(dum
->fifo_buf
, _req
->buf
, _req
->length
);
712 req
->req
.context
= dum
;
713 req
->req
.complete
= fifo_complete
;
715 list_add_tail(&req
->queue
, &ep
->queue
);
716 spin_unlock(&dum
->lock
);
717 _req
->actual
= _req
->length
;
719 usb_gadget_giveback_request(_ep
, _req
);
720 spin_lock(&dum
->lock
);
722 list_add_tail(&req
->queue
, &ep
->queue
);
723 spin_unlock_irqrestore(&dum
->lock
, flags
);
725 /* real hardware would likely enable transfers here, in case
726 * it'd been left NAKing.
731 static int dummy_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
735 int retval
= -EINVAL
;
737 struct dummy_request
*req
= NULL
;
741 ep
= usb_ep_to_dummy_ep(_ep
);
742 dum
= ep_to_dummy(ep
);
747 local_irq_save(flags
);
748 spin_lock(&dum
->lock
);
749 list_for_each_entry(req
, &ep
->queue
, queue
) {
750 if (&req
->req
== _req
) {
751 list_del_init(&req
->queue
);
752 _req
->status
= -ECONNRESET
;
757 spin_unlock(&dum
->lock
);
760 dev_dbg(udc_dev(dum
),
761 "dequeued req %p from %s, len %d buf %p\n",
762 req
, _ep
->name
, _req
->length
, _req
->buf
);
763 usb_gadget_giveback_request(_ep
, _req
);
765 local_irq_restore(flags
);
770 dummy_set_halt_and_wedge(struct usb_ep
*_ep
, int value
, int wedged
)
777 ep
= usb_ep_to_dummy_ep(_ep
);
778 dum
= ep_to_dummy(ep
);
782 ep
->halted
= ep
->wedged
= 0;
783 else if (ep
->desc
&& (ep
->desc
->bEndpointAddress
& USB_DIR_IN
) &&
784 !list_empty(&ep
->queue
))
791 /* FIXME clear emulated data toggle too */
796 dummy_set_halt(struct usb_ep
*_ep
, int value
)
798 return dummy_set_halt_and_wedge(_ep
, value
, 0);
801 static int dummy_set_wedge(struct usb_ep
*_ep
)
803 if (!_ep
|| _ep
->name
== ep0name
)
805 return dummy_set_halt_and_wedge(_ep
, 1, 1);
808 static const struct usb_ep_ops dummy_ep_ops
= {
809 .enable
= dummy_enable
,
810 .disable
= dummy_disable
,
812 .alloc_request
= dummy_alloc_request
,
813 .free_request
= dummy_free_request
,
815 .queue
= dummy_queue
,
816 .dequeue
= dummy_dequeue
,
818 .set_halt
= dummy_set_halt
,
819 .set_wedge
= dummy_set_wedge
,
822 /*-------------------------------------------------------------------------*/
824 /* there are both host and device side versions of this call ... */
825 static int dummy_g_get_frame(struct usb_gadget
*_gadget
)
827 struct timespec64 ts64
;
829 ktime_get_ts64(&ts64
);
830 return ts64
.tv_nsec
/ NSEC_PER_MSEC
;
833 static int dummy_wakeup(struct usb_gadget
*_gadget
)
835 struct dummy_hcd
*dum_hcd
;
837 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
838 if (!(dum_hcd
->dum
->devstatus
& ((1 << USB_DEVICE_B_HNP_ENABLE
)
839 | (1 << USB_DEVICE_REMOTE_WAKEUP
))))
841 if ((dum_hcd
->port_status
& USB_PORT_STAT_CONNECTION
) == 0)
843 if ((dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) == 0 &&
844 dum_hcd
->rh_state
!= DUMMY_RH_SUSPENDED
)
847 /* FIXME: What if the root hub is suspended but the port isn't? */
849 /* hub notices our request, issues downstream resume, etc */
850 dum_hcd
->resuming
= 1;
851 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(20);
852 mod_timer(&dummy_hcd_to_hcd(dum_hcd
)->rh_timer
, dum_hcd
->re_timeout
);
856 static int dummy_set_selfpowered(struct usb_gadget
*_gadget
, int value
)
860 _gadget
->is_selfpowered
= (value
!= 0);
861 dum
= gadget_to_dummy_hcd(_gadget
)->dum
;
863 dum
->devstatus
|= (1 << USB_DEVICE_SELF_POWERED
);
865 dum
->devstatus
&= ~(1 << USB_DEVICE_SELF_POWERED
);
869 static void dummy_udc_update_ep0(struct dummy
*dum
)
871 if (dum
->gadget
.speed
== USB_SPEED_SUPER
)
872 dum
->ep
[0].ep
.maxpacket
= 9;
874 dum
->ep
[0].ep
.maxpacket
= 64;
877 static int dummy_pullup(struct usb_gadget
*_gadget
, int value
)
879 struct dummy_hcd
*dum_hcd
;
883 dum
= gadget_dev_to_dummy(&_gadget
->dev
);
885 if (value
&& dum
->driver
) {
886 if (mod_data
.is_super_speed
)
887 dum
->gadget
.speed
= dum
->driver
->max_speed
;
888 else if (mod_data
.is_high_speed
)
889 dum
->gadget
.speed
= min_t(u8
, USB_SPEED_HIGH
,
890 dum
->driver
->max_speed
);
892 dum
->gadget
.speed
= USB_SPEED_FULL
;
893 dummy_udc_update_ep0(dum
);
895 if (dum
->gadget
.speed
< dum
->driver
->max_speed
)
896 dev_dbg(udc_dev(dum
), "This device can perform faster"
897 " if you connect it to a %s port...\n",
898 usb_speed_string(dum
->driver
->max_speed
));
900 dum_hcd
= gadget_to_dummy_hcd(_gadget
);
902 spin_lock_irqsave(&dum
->lock
, flags
);
903 dum
->pullup
= (value
!= 0);
904 set_link_state(dum_hcd
);
905 spin_unlock_irqrestore(&dum
->lock
, flags
);
907 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
911 static int dummy_udc_start(struct usb_gadget
*g
,
912 struct usb_gadget_driver
*driver
);
913 static int dummy_udc_stop(struct usb_gadget
*g
);
915 static const struct usb_gadget_ops dummy_ops
= {
916 .get_frame
= dummy_g_get_frame
,
917 .wakeup
= dummy_wakeup
,
918 .set_selfpowered
= dummy_set_selfpowered
,
919 .pullup
= dummy_pullup
,
920 .udc_start
= dummy_udc_start
,
921 .udc_stop
= dummy_udc_stop
,
924 /*-------------------------------------------------------------------------*/
926 /* "function" sysfs attribute */
927 static ssize_t
function_show(struct device
*dev
, struct device_attribute
*attr
,
930 struct dummy
*dum
= gadget_dev_to_dummy(dev
);
932 if (!dum
->driver
|| !dum
->driver
->function
)
934 return scnprintf(buf
, PAGE_SIZE
, "%s\n", dum
->driver
->function
);
936 static DEVICE_ATTR_RO(function
);
938 /*-------------------------------------------------------------------------*/
941 * Driver registration/unregistration.
943 * This is basically hardware-specific; there's usually only one real USB
944 * device (not host) controller since that's how USB devices are intended
945 * to work. So most implementations of these api calls will rely on the
946 * fact that only one driver will ever bind to the hardware. But curious
947 * hardware can be built with discrete components, so the gadget API doesn't
948 * require that assumption.
950 * For this emulator, it might be convenient to create a usb slave device
951 * for each driver that registers: just add to a big root hub.
954 static int dummy_udc_start(struct usb_gadget
*g
,
955 struct usb_gadget_driver
*driver
)
957 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
958 struct dummy
*dum
= dum_hcd
->dum
;
960 if (driver
->max_speed
== USB_SPEED_UNKNOWN
)
964 * SLAVE side init ... the layer above hardware, which
965 * can't enumerate without help from the driver we're binding.
969 dum
->driver
= driver
;
974 static int dummy_udc_stop(struct usb_gadget
*g
)
976 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(g
);
977 struct dummy
*dum
= dum_hcd
->dum
;
979 spin_lock_irq(&dum
->lock
);
981 spin_unlock_irq(&dum
->lock
);
988 /* The gadget structure is stored inside the hcd structure and will be
989 * released along with it. */
990 static void init_dummy_udc_hw(struct dummy
*dum
)
994 INIT_LIST_HEAD(&dum
->gadget
.ep_list
);
995 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
996 struct dummy_ep
*ep
= &dum
->ep
[i
];
998 if (!ep_info
[i
].name
)
1000 ep
->ep
.name
= ep_info
[i
].name
;
1001 ep
->ep
.caps
= ep_info
[i
].caps
;
1002 ep
->ep
.ops
= &dummy_ep_ops
;
1003 list_add_tail(&ep
->ep
.ep_list
, &dum
->gadget
.ep_list
);
1004 ep
->halted
= ep
->wedged
= ep
->already_seen
=
1005 ep
->setup_stage
= 0;
1006 usb_ep_set_maxpacket_limit(&ep
->ep
, ~0);
1007 ep
->ep
.max_streams
= 16;
1008 ep
->last_io
= jiffies
;
1009 ep
->gadget
= &dum
->gadget
;
1011 INIT_LIST_HEAD(&ep
->queue
);
1014 dum
->gadget
.ep0
= &dum
->ep
[0].ep
;
1015 list_del_init(&dum
->ep
[0].ep
.ep_list
);
1016 INIT_LIST_HEAD(&dum
->fifo_req
.queue
);
1018 #ifdef CONFIG_USB_OTG
1019 dum
->gadget
.is_otg
= 1;
1023 static int dummy_udc_probe(struct platform_device
*pdev
)
1028 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
1029 /* Clear usb_gadget region for new registration to udc-core */
1030 memzero_explicit(&dum
->gadget
, sizeof(struct usb_gadget
));
1031 dum
->gadget
.name
= gadget_name
;
1032 dum
->gadget
.ops
= &dummy_ops
;
1033 dum
->gadget
.max_speed
= USB_SPEED_SUPER
;
1035 dum
->gadget
.dev
.parent
= &pdev
->dev
;
1036 init_dummy_udc_hw(dum
);
1038 rc
= usb_add_gadget_udc(&pdev
->dev
, &dum
->gadget
);
1042 rc
= device_create_file(&dum
->gadget
.dev
, &dev_attr_function
);
1045 platform_set_drvdata(pdev
, dum
);
1049 usb_del_gadget_udc(&dum
->gadget
);
1054 static int dummy_udc_remove(struct platform_device
*pdev
)
1056 struct dummy
*dum
= platform_get_drvdata(pdev
);
1058 device_remove_file(&dum
->gadget
.dev
, &dev_attr_function
);
1059 usb_del_gadget_udc(&dum
->gadget
);
1063 static void dummy_udc_pm(struct dummy
*dum
, struct dummy_hcd
*dum_hcd
,
1066 spin_lock_irq(&dum
->lock
);
1067 dum
->udc_suspended
= suspend
;
1068 set_link_state(dum_hcd
);
1069 spin_unlock_irq(&dum
->lock
);
1072 static int dummy_udc_suspend(struct platform_device
*pdev
, pm_message_t state
)
1074 struct dummy
*dum
= platform_get_drvdata(pdev
);
1075 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1077 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1078 dummy_udc_pm(dum
, dum_hcd
, 1);
1079 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1083 static int dummy_udc_resume(struct platform_device
*pdev
)
1085 struct dummy
*dum
= platform_get_drvdata(pdev
);
1086 struct dummy_hcd
*dum_hcd
= gadget_to_dummy_hcd(&dum
->gadget
);
1088 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
1089 dummy_udc_pm(dum
, dum_hcd
, 0);
1090 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd
));
1094 static struct platform_driver dummy_udc_driver
= {
1095 .probe
= dummy_udc_probe
,
1096 .remove
= dummy_udc_remove
,
1097 .suspend
= dummy_udc_suspend
,
1098 .resume
= dummy_udc_resume
,
1100 .name
= (char *) gadget_name
,
1104 /*-------------------------------------------------------------------------*/
1106 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor
*desc
)
1110 index
= usb_endpoint_num(desc
) << 1;
1111 if (usb_endpoint_dir_in(desc
))
1116 /* MASTER/HOST SIDE DRIVER
1118 * this uses the hcd framework to hook up to host side drivers.
1119 * its root hub will only have one device, otherwise it acts like
1120 * a normal host controller.
1122 * when urbs are queued, they're just stuck on a list that we
1123 * scan in a timer callback. that callback connects writes from
1124 * the host with reads from the device, and so on, based on the
1128 static int dummy_ep_stream_en(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1130 const struct usb_endpoint_descriptor
*desc
= &urb
->ep
->desc
;
1133 if (!usb_endpoint_xfer_bulk(desc
))
1136 index
= dummy_get_ep_idx(desc
);
1137 return (1 << index
) & dum_hcd
->stream_en_ep
;
1141 * The max stream number is saved as a nibble so for the 30 possible endpoints
1142 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1143 * means we use only 1 stream). The maximum according to the spec is 16bit so
1144 * if the 16 stream limit is about to go, the array size should be incremented
1145 * to 30 elements of type u16.
1147 static int get_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1152 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1153 if (usb_pipeout(pipe
))
1161 static void set_max_streams_for_pipe(struct dummy_hcd
*dum_hcd
,
1162 unsigned int pipe
, unsigned int streams
)
1167 max_streams
= dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)];
1168 if (usb_pipeout(pipe
)) {
1172 max_streams
&= 0xf0;
1174 max_streams
|= streams
;
1175 dum_hcd
->num_stream
[usb_pipeendpoint(pipe
)] = max_streams
;
1178 static int dummy_validate_stream(struct dummy_hcd
*dum_hcd
, struct urb
*urb
)
1180 unsigned int max_streams
;
1183 enabled
= dummy_ep_stream_en(dum_hcd
, urb
);
1184 if (!urb
->stream_id
) {
1192 max_streams
= get_max_streams_for_pipe(dum_hcd
,
1193 usb_pipeendpoint(urb
->pipe
));
1194 if (urb
->stream_id
> max_streams
) {
1195 dev_err(dummy_dev(dum_hcd
), "Stream id %d is out of range.\n",
1203 static int dummy_urb_enqueue(
1204 struct usb_hcd
*hcd
,
1208 struct dummy_hcd
*dum_hcd
;
1210 unsigned long flags
;
1213 urbp
= kmalloc(sizeof *urbp
, mem_flags
);
1217 urbp
->miter_started
= 0;
1219 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1220 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1222 rc
= dummy_validate_stream(dum_hcd
, urb
);
1228 rc
= usb_hcd_link_urb_to_ep(hcd
, urb
);
1234 if (!dum_hcd
->udev
) {
1235 dum_hcd
->udev
= urb
->dev
;
1236 usb_get_dev(dum_hcd
->udev
);
1237 } else if (unlikely(dum_hcd
->udev
!= urb
->dev
))
1238 dev_err(dummy_dev(dum_hcd
), "usb_device address has changed!\n");
1240 list_add_tail(&urbp
->urbp_list
, &dum_hcd
->urbp_list
);
1242 if (usb_pipetype(urb
->pipe
) == PIPE_CONTROL
)
1243 urb
->error_count
= 1; /* mark as a new urb */
1245 /* kick the scheduler, it'll do the rest */
1246 if (!timer_pending(&dum_hcd
->timer
))
1247 mod_timer(&dum_hcd
->timer
, jiffies
+ 1);
1250 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1254 static int dummy_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1256 struct dummy_hcd
*dum_hcd
;
1257 unsigned long flags
;
1260 /* giveback happens automatically in timer callback,
1261 * so make sure the callback happens */
1262 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1263 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1265 rc
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
1266 if (!rc
&& dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
&&
1267 !list_empty(&dum_hcd
->urbp_list
))
1268 mod_timer(&dum_hcd
->timer
, jiffies
);
1270 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1274 static int dummy_perform_transfer(struct urb
*urb
, struct dummy_request
*req
,
1278 struct urbp
*urbp
= urb
->hcpriv
;
1280 struct sg_mapping_iter
*miter
= &urbp
->miter
;
1285 to_host
= usb_pipein(urb
->pipe
);
1286 rbuf
= req
->req
.buf
+ req
->req
.actual
;
1288 if (!urb
->num_sgs
) {
1289 ubuf
= urb
->transfer_buffer
+ urb
->actual_length
;
1291 memcpy(ubuf
, rbuf
, len
);
1293 memcpy(rbuf
, ubuf
, len
);
1297 if (!urbp
->miter_started
) {
1298 u32 flags
= SG_MITER_ATOMIC
;
1301 flags
|= SG_MITER_TO_SG
;
1303 flags
|= SG_MITER_FROM_SG
;
1305 sg_miter_start(miter
, urb
->sg
, urb
->num_sgs
, flags
);
1306 urbp
->miter_started
= 1;
1308 next_sg
= sg_miter_next(miter
);
1309 if (next_sg
== false) {
1315 this_sg
= min_t(u32
, len
, miter
->length
);
1316 miter
->consumed
= this_sg
;
1320 memcpy(ubuf
, rbuf
, this_sg
);
1322 memcpy(rbuf
, ubuf
, this_sg
);
1327 next_sg
= sg_miter_next(miter
);
1328 if (next_sg
== false) {
1336 sg_miter_stop(miter
);
1340 /* transfer up to a frame's worth; caller must own lock */
1341 static int transfer(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1342 struct dummy_ep
*ep
, int limit
, int *status
)
1344 struct dummy
*dum
= dum_hcd
->dum
;
1345 struct dummy_request
*req
;
1349 /* if there's no request queued, the device is NAKing; return */
1350 list_for_each_entry(req
, &ep
->queue
, queue
) {
1351 unsigned host_len
, dev_len
, len
;
1352 int is_short
, to_host
;
1355 if (dummy_ep_stream_en(dum_hcd
, urb
)) {
1356 if ((urb
->stream_id
!= req
->req
.stream_id
))
1360 /* 1..N packets of ep->ep.maxpacket each ... the last one
1361 * may be short (including zero length).
1363 * writer can send a zlp explicitly (length 0) or implicitly
1364 * (length mod maxpacket zero, and 'zero' flag); they always
1367 host_len
= urb
->transfer_buffer_length
- urb
->actual_length
;
1368 dev_len
= req
->req
.length
- req
->req
.actual
;
1369 len
= min(host_len
, dev_len
);
1371 /* FIXME update emulated data toggle too */
1373 to_host
= usb_pipein(urb
->pipe
);
1374 if (unlikely(len
== 0))
1377 /* not enough bandwidth left? */
1378 if (limit
< ep
->ep
.maxpacket
&& limit
< len
)
1380 len
= min_t(unsigned, len
, limit
);
1384 /* send multiple of maxpacket first, then remainder */
1385 if (len
>= ep
->ep
.maxpacket
) {
1387 if (len
% ep
->ep
.maxpacket
)
1389 len
-= len
% ep
->ep
.maxpacket
;
1394 len
= dummy_perform_transfer(urb
, req
, len
);
1396 ep
->last_io
= jiffies
;
1398 req
->req
.status
= len
;
1402 urb
->actual_length
+= len
;
1403 req
->req
.actual
+= len
;
1407 /* short packets terminate, maybe with overflow/underflow.
1408 * it's only really an error to write too much.
1410 * partially filling a buffer optionally blocks queue advances
1411 * (so completion handlers can clean up the queue) but we don't
1412 * need to emulate such data-in-flight.
1415 if (host_len
== dev_len
) {
1416 req
->req
.status
= 0;
1418 } else if (to_host
) {
1419 req
->req
.status
= 0;
1420 if (dev_len
> host_len
)
1421 *status
= -EOVERFLOW
;
1426 if (host_len
> dev_len
)
1427 req
->req
.status
= -EOVERFLOW
;
1429 req
->req
.status
= 0;
1433 * many requests terminate without a short packet.
1434 * send a zlp if demanded by flags.
1437 if (req
->req
.length
== req
->req
.actual
) {
1438 if (req
->req
.zero
&& to_host
)
1441 req
->req
.status
= 0;
1443 if (urb
->transfer_buffer_length
== urb
->actual_length
) {
1444 if (urb
->transfer_flags
& URB_ZERO_PACKET
&&
1452 /* device side completion --> continuable */
1453 if (req
->req
.status
!= -EINPROGRESS
) {
1454 list_del_init(&req
->queue
);
1456 spin_unlock(&dum
->lock
);
1457 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1458 spin_lock(&dum
->lock
);
1460 /* requests might have been unlinked... */
1464 /* host side completion --> terminate */
1465 if (*status
!= -EINPROGRESS
)
1468 /* rescan to continue with any other queued i/o */
1475 static int periodic_bytes(struct dummy
*dum
, struct dummy_ep
*ep
)
1477 int limit
= ep
->ep
.maxpacket
;
1479 if (dum
->gadget
.speed
== USB_SPEED_HIGH
) {
1482 /* high bandwidth mode */
1483 tmp
= usb_endpoint_maxp_mult(ep
->desc
);
1484 tmp
*= 8 /* applies to entire frame */;
1485 limit
+= limit
* tmp
;
1487 if (dum
->gadget
.speed
== USB_SPEED_SUPER
) {
1488 switch (usb_endpoint_type(ep
->desc
)) {
1489 case USB_ENDPOINT_XFER_ISOC
:
1490 /* Sec. 4.4.8.2 USB3.0 Spec */
1491 limit
= 3 * 16 * 1024 * 8;
1493 case USB_ENDPOINT_XFER_INT
:
1494 /* Sec. 4.4.7.2 USB3.0 Spec */
1495 limit
= 3 * 1024 * 8;
1497 case USB_ENDPOINT_XFER_BULK
:
1505 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1506 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1507 USB_PORT_STAT_SUSPEND)) \
1508 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1510 static struct dummy_ep
*find_endpoint(struct dummy
*dum
, u8 address
)
1514 if (!is_active((dum
->gadget
.speed
== USB_SPEED_SUPER
?
1515 dum
->ss_hcd
: dum
->hs_hcd
)))
1517 if ((address
& ~USB_DIR_IN
) == 0)
1519 for (i
= 1; i
< DUMMY_ENDPOINTS
; i
++) {
1520 struct dummy_ep
*ep
= &dum
->ep
[i
];
1524 if (ep
->desc
->bEndpointAddress
== address
)
1532 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1533 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1534 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1535 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1536 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1537 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1541 * handle_control_request() - handles all control transfers
1542 * @dum: pointer to dummy (the_controller)
1543 * @urb: the urb request to handle
1544 * @setup: pointer to the setup data for a USB device control
1546 * @status: pointer to request handling status
1548 * Return 0 - if the request was handled
1549 * 1 - if the request wasn't handles
1550 * error code on error
1552 static int handle_control_request(struct dummy_hcd
*dum_hcd
, struct urb
*urb
,
1553 struct usb_ctrlrequest
*setup
,
1556 struct dummy_ep
*ep2
;
1557 struct dummy
*dum
= dum_hcd
->dum
;
1562 w_index
= le16_to_cpu(setup
->wIndex
);
1563 w_value
= le16_to_cpu(setup
->wValue
);
1564 switch (setup
->bRequest
) {
1565 case USB_REQ_SET_ADDRESS
:
1566 if (setup
->bRequestType
!= Dev_Request
)
1568 dum
->address
= w_value
;
1570 dev_dbg(udc_dev(dum
), "set_address = %d\n",
1574 case USB_REQ_SET_FEATURE
:
1575 if (setup
->bRequestType
== Dev_Request
) {
1578 case USB_DEVICE_REMOTE_WAKEUP
:
1580 case USB_DEVICE_B_HNP_ENABLE
:
1581 dum
->gadget
.b_hnp_enable
= 1;
1583 case USB_DEVICE_A_HNP_SUPPORT
:
1584 dum
->gadget
.a_hnp_support
= 1;
1586 case USB_DEVICE_A_ALT_HNP_SUPPORT
:
1587 dum
->gadget
.a_alt_hnp_support
= 1;
1589 case USB_DEVICE_U1_ENABLE
:
1590 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1592 w_value
= USB_DEV_STAT_U1_ENABLED
;
1594 ret_val
= -EOPNOTSUPP
;
1596 case USB_DEVICE_U2_ENABLE
:
1597 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1599 w_value
= USB_DEV_STAT_U2_ENABLED
;
1601 ret_val
= -EOPNOTSUPP
;
1603 case USB_DEVICE_LTM_ENABLE
:
1604 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1606 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1608 ret_val
= -EOPNOTSUPP
;
1611 ret_val
= -EOPNOTSUPP
;
1614 dum
->devstatus
|= (1 << w_value
);
1617 } else if (setup
->bRequestType
== Ep_Request
) {
1619 ep2
= find_endpoint(dum
, w_index
);
1620 if (!ep2
|| ep2
->ep
.name
== ep0name
) {
1621 ret_val
= -EOPNOTSUPP
;
1629 case USB_REQ_CLEAR_FEATURE
:
1630 if (setup
->bRequestType
== Dev_Request
) {
1633 case USB_DEVICE_REMOTE_WAKEUP
:
1634 w_value
= USB_DEVICE_REMOTE_WAKEUP
;
1636 case USB_DEVICE_U1_ENABLE
:
1637 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1639 w_value
= USB_DEV_STAT_U1_ENABLED
;
1641 ret_val
= -EOPNOTSUPP
;
1643 case USB_DEVICE_U2_ENABLE
:
1644 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1646 w_value
= USB_DEV_STAT_U2_ENABLED
;
1648 ret_val
= -EOPNOTSUPP
;
1650 case USB_DEVICE_LTM_ENABLE
:
1651 if (dummy_hcd_to_hcd(dum_hcd
)->speed
==
1653 w_value
= USB_DEV_STAT_LTM_ENABLED
;
1655 ret_val
= -EOPNOTSUPP
;
1658 ret_val
= -EOPNOTSUPP
;
1662 dum
->devstatus
&= ~(1 << w_value
);
1665 } else if (setup
->bRequestType
== Ep_Request
) {
1667 ep2
= find_endpoint(dum
, w_index
);
1669 ret_val
= -EOPNOTSUPP
;
1678 case USB_REQ_GET_STATUS
:
1679 if (setup
->bRequestType
== Dev_InRequest
1680 || setup
->bRequestType
== Intf_InRequest
1681 || setup
->bRequestType
== Ep_InRequest
) {
1684 * device: remote wakeup, selfpowered
1685 * interface: nothing
1688 buf
= (char *)urb
->transfer_buffer
;
1689 if (urb
->transfer_buffer_length
> 0) {
1690 if (setup
->bRequestType
== Ep_InRequest
) {
1691 ep2
= find_endpoint(dum
, w_index
);
1693 ret_val
= -EOPNOTSUPP
;
1696 buf
[0] = ep2
->halted
;
1697 } else if (setup
->bRequestType
==
1699 buf
[0] = (u8
)dum
->devstatus
;
1703 if (urb
->transfer_buffer_length
> 1)
1705 urb
->actual_length
= min_t(u32
, 2,
1706 urb
->transfer_buffer_length
);
1715 /* drive both sides of the transfers; looks like irq handlers to
1716 * both drivers except the callbacks aren't in_irq().
1718 static void dummy_timer(unsigned long _dum_hcd
)
1720 struct dummy_hcd
*dum_hcd
= (struct dummy_hcd
*) _dum_hcd
;
1721 struct dummy
*dum
= dum_hcd
->dum
;
1722 struct urbp
*urbp
, *tmp
;
1723 unsigned long flags
;
1727 /* simplistic model for one frame's bandwidth */
1728 switch (dum
->gadget
.speed
) {
1730 total
= 8/*bytes*/ * 12/*packets*/;
1732 case USB_SPEED_FULL
:
1733 total
= 64/*bytes*/ * 19/*packets*/;
1735 case USB_SPEED_HIGH
:
1736 total
= 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1738 case USB_SPEED_SUPER
:
1739 /* Bus speed is 500000 bytes/ms, so use a little less */
1743 dev_err(dummy_dev(dum_hcd
), "bogus device speed\n");
1747 /* FIXME if HZ != 1000 this will probably misbehave ... */
1749 /* look at each urb queued by the host side driver */
1750 spin_lock_irqsave(&dum
->lock
, flags
);
1752 if (!dum_hcd
->udev
) {
1753 dev_err(dummy_dev(dum_hcd
),
1754 "timer fired with no URBs pending?\n");
1755 spin_unlock_irqrestore(&dum
->lock
, flags
);
1759 for (i
= 0; i
< DUMMY_ENDPOINTS
; i
++) {
1760 if (!ep_info
[i
].name
)
1762 dum
->ep
[i
].already_seen
= 0;
1766 list_for_each_entry_safe(urbp
, tmp
, &dum_hcd
->urbp_list
, urbp_list
) {
1768 struct dummy_request
*req
;
1770 struct dummy_ep
*ep
= NULL
;
1772 int status
= -EINPROGRESS
;
1777 else if (dum_hcd
->rh_state
!= DUMMY_RH_RUNNING
)
1779 type
= usb_pipetype(urb
->pipe
);
1781 /* used up this frame's non-periodic bandwidth?
1782 * FIXME there's infinite bandwidth for control and
1783 * periodic transfers ... unrealistic.
1785 if (total
<= 0 && type
== PIPE_BULK
)
1788 /* find the gadget's ep for this request (if configured) */
1789 address
= usb_pipeendpoint (urb
->pipe
);
1790 if (usb_pipein(urb
->pipe
))
1791 address
|= USB_DIR_IN
;
1792 ep
= find_endpoint(dum
, address
);
1794 /* set_configuration() disagreement */
1795 dev_dbg(dummy_dev(dum_hcd
),
1796 "no ep configured for urb %p\n",
1802 if (ep
->already_seen
)
1804 ep
->already_seen
= 1;
1805 if (ep
== &dum
->ep
[0] && urb
->error_count
) {
1806 ep
->setup_stage
= 1; /* a new urb */
1807 urb
->error_count
= 0;
1809 if (ep
->halted
&& !ep
->setup_stage
) {
1810 /* NOTE: must not be iso! */
1811 dev_dbg(dummy_dev(dum_hcd
), "ep %s halted, urb %p\n",
1816 /* FIXME make sure both ends agree on maxpacket */
1818 /* handle control requests */
1819 if (ep
== &dum
->ep
[0] && ep
->setup_stage
) {
1820 struct usb_ctrlrequest setup
;
1823 setup
= *(struct usb_ctrlrequest
*) urb
->setup_packet
;
1824 /* paranoia, in case of stale queued data */
1825 list_for_each_entry(req
, &ep
->queue
, queue
) {
1826 list_del_init(&req
->queue
);
1827 req
->req
.status
= -EOVERFLOW
;
1828 dev_dbg(udc_dev(dum
), "stale req = %p\n",
1831 spin_unlock(&dum
->lock
);
1832 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
1833 spin_lock(&dum
->lock
);
1834 ep
->already_seen
= 0;
1838 /* gadget driver never sees set_address or operations
1839 * on standard feature flags. some hardware doesn't
1842 ep
->last_io
= jiffies
;
1843 ep
->setup_stage
= 0;
1846 value
= handle_control_request(dum_hcd
, urb
, &setup
,
1849 /* gadget driver handles all other requests. block
1850 * until setup() returns; no reentrancy issues etc.
1853 spin_unlock(&dum
->lock
);
1854 value
= dum
->driver
->setup(&dum
->gadget
,
1856 spin_lock(&dum
->lock
);
1859 /* no delays (max 64KB data stage) */
1861 goto treat_control_like_bulk
;
1863 /* error, see below */
1867 if (value
!= -EOPNOTSUPP
)
1868 dev_dbg(udc_dev(dum
),
1872 urb
->actual_length
= 0;
1878 /* non-control requests */
1880 switch (usb_pipetype(urb
->pipe
)) {
1881 case PIPE_ISOCHRONOUS
:
1882 /* FIXME is it urb->interval since the last xfer?
1883 * use urb->iso_frame_desc[i].
1884 * complete whether or not ep has requests queued.
1885 * report random errors, to debug drivers.
1887 limit
= max(limit
, periodic_bytes(dum
, ep
));
1891 case PIPE_INTERRUPT
:
1892 /* FIXME is it urb->interval since the last xfer?
1893 * this almost certainly polls too fast.
1895 limit
= max(limit
, periodic_bytes(dum
, ep
));
1899 treat_control_like_bulk
:
1900 ep
->last_io
= jiffies
;
1901 total
-= transfer(dum_hcd
, urb
, ep
, limit
, &status
);
1905 /* incomplete transfer? */
1906 if (status
== -EINPROGRESS
)
1910 list_del(&urbp
->urbp_list
);
1913 ep
->already_seen
= ep
->setup_stage
= 0;
1915 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd
), urb
);
1916 spin_unlock(&dum
->lock
);
1917 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd
), urb
, status
);
1918 spin_lock(&dum
->lock
);
1923 if (list_empty(&dum_hcd
->urbp_list
)) {
1924 usb_put_dev(dum_hcd
->udev
);
1925 dum_hcd
->udev
= NULL
;
1926 } else if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
1927 /* want a 1 msec delay here */
1928 mod_timer(&dum_hcd
->timer
, jiffies
+ msecs_to_jiffies(1));
1931 spin_unlock_irqrestore(&dum
->lock
, flags
);
1934 /*-------------------------------------------------------------------------*/
1936 #define PORT_C_MASK \
1937 ((USB_PORT_STAT_C_CONNECTION \
1938 | USB_PORT_STAT_C_ENABLE \
1939 | USB_PORT_STAT_C_SUSPEND \
1940 | USB_PORT_STAT_C_OVERCURRENT \
1941 | USB_PORT_STAT_C_RESET) << 16)
1943 static int dummy_hub_status(struct usb_hcd
*hcd
, char *buf
)
1945 struct dummy_hcd
*dum_hcd
;
1946 unsigned long flags
;
1949 dum_hcd
= hcd_to_dummy_hcd(hcd
);
1951 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
1952 if (!HCD_HW_ACCESSIBLE(hcd
))
1955 if (dum_hcd
->resuming
&& time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
1956 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
1957 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
1958 set_link_state(dum_hcd
);
1961 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0) {
1963 dev_dbg(dummy_dev(dum_hcd
), "port status 0x%08x has changes\n",
1964 dum_hcd
->port_status
);
1966 if (dum_hcd
->rh_state
== DUMMY_RH_SUSPENDED
)
1967 usb_hcd_resume_root_hub(hcd
);
1970 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
1974 /* usb 3.0 root hub device descriptor */
1976 struct usb_bos_descriptor bos
;
1977 struct usb_ss_cap_descriptor ss_cap
;
1978 } __packed usb3_bos_desc
= {
1981 .bLength
= USB_DT_BOS_SIZE
,
1982 .bDescriptorType
= USB_DT_BOS
,
1983 .wTotalLength
= cpu_to_le16(sizeof(usb3_bos_desc
)),
1984 .bNumDeviceCaps
= 1,
1987 .bLength
= USB_DT_USB_SS_CAP_SIZE
,
1988 .bDescriptorType
= USB_DT_DEVICE_CAPABILITY
,
1989 .bDevCapabilityType
= USB_SS_CAP_TYPE
,
1990 .wSpeedSupported
= cpu_to_le16(USB_5GBPS_OPERATION
),
1991 .bFunctionalitySupport
= ilog2(USB_5GBPS_OPERATION
),
1996 ss_hub_descriptor(struct usb_hub_descriptor
*desc
)
1998 memset(desc
, 0, sizeof *desc
);
1999 desc
->bDescriptorType
= USB_DT_SS_HUB
;
2000 desc
->bDescLength
= 12;
2001 desc
->wHubCharacteristics
= cpu_to_le16(
2002 HUB_CHAR_INDV_PORT_LPSM
|
2003 HUB_CHAR_COMMON_OCPM
);
2004 desc
->bNbrPorts
= 1;
2005 desc
->u
.ss
.bHubHdrDecLat
= 0x04; /* Worst case: 0.4 micro sec*/
2006 desc
->u
.ss
.DeviceRemovable
= 0;
2009 static inline void hub_descriptor(struct usb_hub_descriptor
*desc
)
2011 memset(desc
, 0, sizeof *desc
);
2012 desc
->bDescriptorType
= USB_DT_HUB
;
2013 desc
->bDescLength
= 9;
2014 desc
->wHubCharacteristics
= cpu_to_le16(
2015 HUB_CHAR_INDV_PORT_LPSM
|
2016 HUB_CHAR_COMMON_OCPM
);
2017 desc
->bNbrPorts
= 1;
2018 desc
->u
.hs
.DeviceRemovable
[0] = 0;
2019 desc
->u
.hs
.DeviceRemovable
[1] = 0xff; /* PortPwrCtrlMask */
2022 static int dummy_hub_control(
2023 struct usb_hcd
*hcd
,
2030 struct dummy_hcd
*dum_hcd
;
2032 unsigned long flags
;
2034 if (!HCD_HW_ACCESSIBLE(hcd
))
2037 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2039 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2041 case ClearHubFeature
:
2043 case ClearPortFeature
:
2045 case USB_PORT_FEAT_SUSPEND
:
2046 if (hcd
->speed
== HCD_USB3
) {
2047 dev_dbg(dummy_dev(dum_hcd
),
2048 "USB_PORT_FEAT_SUSPEND req not "
2049 "supported for USB 3.0 roothub\n");
2052 if (dum_hcd
->port_status
& USB_PORT_STAT_SUSPEND
) {
2053 /* 20msec resume signaling */
2054 dum_hcd
->resuming
= 1;
2055 dum_hcd
->re_timeout
= jiffies
+
2056 msecs_to_jiffies(20);
2059 case USB_PORT_FEAT_POWER
:
2060 dev_dbg(dummy_dev(dum_hcd
), "power-off\n");
2061 if (hcd
->speed
== HCD_USB3
)
2062 dum_hcd
->port_status
&= ~USB_SS_PORT_STAT_POWER
;
2064 dum_hcd
->port_status
&= ~USB_PORT_STAT_POWER
;
2065 set_link_state(dum_hcd
);
2068 dum_hcd
->port_status
&= ~(1 << wValue
);
2069 set_link_state(dum_hcd
);
2072 case GetHubDescriptor
:
2073 if (hcd
->speed
== HCD_USB3
&&
2074 (wLength
< USB_DT_SS_HUB_SIZE
||
2075 wValue
!= (USB_DT_SS_HUB
<< 8))) {
2076 dev_dbg(dummy_dev(dum_hcd
),
2077 "Wrong hub descriptor type for "
2078 "USB 3.0 roothub.\n");
2081 if (hcd
->speed
== HCD_USB3
)
2082 ss_hub_descriptor((struct usb_hub_descriptor
*) buf
);
2084 hub_descriptor((struct usb_hub_descriptor
*) buf
);
2087 case DeviceRequest
| USB_REQ_GET_DESCRIPTOR
:
2088 if (hcd
->speed
!= HCD_USB3
)
2091 if ((wValue
>> 8) != USB_DT_BOS
)
2094 memcpy(buf
, &usb3_bos_desc
, sizeof(usb3_bos_desc
));
2095 retval
= sizeof(usb3_bos_desc
);
2099 *(__le32
*) buf
= cpu_to_le32(0);
2105 /* whoever resets or resumes must GetPortStatus to
2108 if (dum_hcd
->resuming
&&
2109 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2110 dum_hcd
->port_status
|= (USB_PORT_STAT_C_SUSPEND
<< 16);
2111 dum_hcd
->port_status
&= ~USB_PORT_STAT_SUSPEND
;
2113 if ((dum_hcd
->port_status
& USB_PORT_STAT_RESET
) != 0 &&
2114 time_after_eq(jiffies
, dum_hcd
->re_timeout
)) {
2115 dum_hcd
->port_status
|= (USB_PORT_STAT_C_RESET
<< 16);
2116 dum_hcd
->port_status
&= ~USB_PORT_STAT_RESET
;
2117 if (dum_hcd
->dum
->pullup
) {
2118 dum_hcd
->port_status
|= USB_PORT_STAT_ENABLE
;
2120 if (hcd
->speed
< HCD_USB3
) {
2121 switch (dum_hcd
->dum
->gadget
.speed
) {
2122 case USB_SPEED_HIGH
:
2123 dum_hcd
->port_status
|=
2124 USB_PORT_STAT_HIGH_SPEED
;
2127 dum_hcd
->dum
->gadget
.ep0
->
2129 dum_hcd
->port_status
|=
2130 USB_PORT_STAT_LOW_SPEED
;
2133 dum_hcd
->dum
->gadget
.speed
=
2140 set_link_state(dum_hcd
);
2141 ((__le16
*) buf
)[0] = cpu_to_le16(dum_hcd
->port_status
);
2142 ((__le16
*) buf
)[1] = cpu_to_le16(dum_hcd
->port_status
>> 16);
2147 case SetPortFeature
:
2149 case USB_PORT_FEAT_LINK_STATE
:
2150 if (hcd
->speed
!= HCD_USB3
) {
2151 dev_dbg(dummy_dev(dum_hcd
),
2152 "USB_PORT_FEAT_LINK_STATE req not "
2153 "supported for USB 2.0 roothub\n");
2157 * Since this is dummy we don't have an actual link so
2158 * there is nothing to do for the SET_LINK_STATE cmd
2161 case USB_PORT_FEAT_U1_TIMEOUT
:
2162 case USB_PORT_FEAT_U2_TIMEOUT
:
2163 /* TODO: add suspend/resume support! */
2164 if (hcd
->speed
!= HCD_USB3
) {
2165 dev_dbg(dummy_dev(dum_hcd
),
2166 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2167 "supported for USB 2.0 roothub\n");
2171 case USB_PORT_FEAT_SUSPEND
:
2172 /* Applicable only for USB2.0 hub */
2173 if (hcd
->speed
== HCD_USB3
) {
2174 dev_dbg(dummy_dev(dum_hcd
),
2175 "USB_PORT_FEAT_SUSPEND req not "
2176 "supported for USB 3.0 roothub\n");
2179 if (dum_hcd
->active
) {
2180 dum_hcd
->port_status
|= USB_PORT_STAT_SUSPEND
;
2182 /* HNP would happen here; for now we
2183 * assume b_bus_req is always true.
2185 set_link_state(dum_hcd
);
2186 if (((1 << USB_DEVICE_B_HNP_ENABLE
)
2187 & dum_hcd
->dum
->devstatus
) != 0)
2188 dev_dbg(dummy_dev(dum_hcd
),
2192 case USB_PORT_FEAT_POWER
:
2193 if (hcd
->speed
== HCD_USB3
)
2194 dum_hcd
->port_status
|= USB_SS_PORT_STAT_POWER
;
2196 dum_hcd
->port_status
|= USB_PORT_STAT_POWER
;
2197 set_link_state(dum_hcd
);
2199 case USB_PORT_FEAT_BH_PORT_RESET
:
2200 /* Applicable only for USB3.0 hub */
2201 if (hcd
->speed
!= HCD_USB3
) {
2202 dev_dbg(dummy_dev(dum_hcd
),
2203 "USB_PORT_FEAT_BH_PORT_RESET req not "
2204 "supported for USB 2.0 roothub\n");
2208 case USB_PORT_FEAT_RESET
:
2209 /* if it's already enabled, disable */
2210 if (hcd
->speed
== HCD_USB3
) {
2211 dum_hcd
->port_status
= 0;
2212 dum_hcd
->port_status
=
2213 (USB_SS_PORT_STAT_POWER
|
2214 USB_PORT_STAT_CONNECTION
|
2215 USB_PORT_STAT_RESET
);
2217 dum_hcd
->port_status
&= ~(USB_PORT_STAT_ENABLE
2218 | USB_PORT_STAT_LOW_SPEED
2219 | USB_PORT_STAT_HIGH_SPEED
);
2221 * We want to reset device status. All but the
2222 * Self powered feature
2224 dum_hcd
->dum
->devstatus
&=
2225 (1 << USB_DEVICE_SELF_POWERED
);
2227 * FIXME USB3.0: what is the correct reset signaling
2228 * interval? Is it still 50msec as for HS?
2230 dum_hcd
->re_timeout
= jiffies
+ msecs_to_jiffies(50);
2233 if (hcd
->speed
== HCD_USB3
) {
2234 if ((dum_hcd
->port_status
&
2235 USB_SS_PORT_STAT_POWER
) != 0) {
2236 dum_hcd
->port_status
|= (1 << wValue
);
2239 if ((dum_hcd
->port_status
&
2240 USB_PORT_STAT_POWER
) != 0) {
2241 dum_hcd
->port_status
|= (1 << wValue
);
2243 set_link_state(dum_hcd
);
2246 case GetPortErrorCount
:
2247 if (hcd
->speed
!= HCD_USB3
) {
2248 dev_dbg(dummy_dev(dum_hcd
),
2249 "GetPortErrorCount req not "
2250 "supported for USB 2.0 roothub\n");
2253 /* We'll always return 0 since this is a dummy hub */
2254 *(__le32
*) buf
= cpu_to_le32(0);
2257 if (hcd
->speed
!= HCD_USB3
) {
2258 dev_dbg(dummy_dev(dum_hcd
),
2259 "SetHubDepth req not supported for "
2260 "USB 2.0 roothub\n");
2265 dev_dbg(dummy_dev(dum_hcd
),
2266 "hub control req%04x v%04x i%04x l%d\n",
2267 typeReq
, wValue
, wIndex
, wLength
);
2269 /* "protocol stall" on error */
2272 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2274 if ((dum_hcd
->port_status
& PORT_C_MASK
) != 0)
2275 usb_hcd_poll_rh_status(hcd
);
2279 static int dummy_bus_suspend(struct usb_hcd
*hcd
)
2281 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2283 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2285 spin_lock_irq(&dum_hcd
->dum
->lock
);
2286 dum_hcd
->rh_state
= DUMMY_RH_SUSPENDED
;
2287 set_link_state(dum_hcd
);
2288 hcd
->state
= HC_STATE_SUSPENDED
;
2289 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2293 static int dummy_bus_resume(struct usb_hcd
*hcd
)
2295 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2298 dev_dbg(&hcd
->self
.root_hub
->dev
, "%s\n", __func__
);
2300 spin_lock_irq(&dum_hcd
->dum
->lock
);
2301 if (!HCD_HW_ACCESSIBLE(hcd
)) {
2304 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2305 set_link_state(dum_hcd
);
2306 if (!list_empty(&dum_hcd
->urbp_list
))
2307 mod_timer(&dum_hcd
->timer
, jiffies
);
2308 hcd
->state
= HC_STATE_RUNNING
;
2310 spin_unlock_irq(&dum_hcd
->dum
->lock
);
2314 /*-------------------------------------------------------------------------*/
2316 static inline ssize_t
show_urb(char *buf
, size_t size
, struct urb
*urb
)
2318 int ep
= usb_pipeendpoint(urb
->pipe
);
2320 return snprintf(buf
, size
,
2321 "urb/%p %s ep%d%s%s len %d/%d\n",
2324 switch (urb
->dev
->speed
) {
2328 case USB_SPEED_FULL
:
2331 case USB_SPEED_HIGH
:
2334 case USB_SPEED_SUPER
:
2341 ep
, ep
? (usb_pipein(urb
->pipe
) ? "in" : "out") : "",
2343 switch (usb_pipetype(urb
->pipe
)) { \
2344 case PIPE_CONTROL
: \
2350 case PIPE_INTERRUPT
: \
2357 urb
->actual_length
, urb
->transfer_buffer_length
);
2360 static ssize_t
urbs_show(struct device
*dev
, struct device_attribute
*attr
,
2363 struct usb_hcd
*hcd
= dev_get_drvdata(dev
);
2364 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2367 unsigned long flags
;
2369 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2370 list_for_each_entry(urbp
, &dum_hcd
->urbp_list
, urbp_list
) {
2373 temp
= show_urb(buf
, PAGE_SIZE
- size
, urbp
->urb
);
2377 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2381 static DEVICE_ATTR_RO(urbs
);
2383 static int dummy_start_ss(struct dummy_hcd
*dum_hcd
)
2385 init_timer(&dum_hcd
->timer
);
2386 dum_hcd
->timer
.function
= dummy_timer
;
2387 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2388 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2389 dum_hcd
->stream_en_ep
= 0;
2390 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2391 dummy_hcd_to_hcd(dum_hcd
)->power_budget
= POWER_BUDGET
;
2392 dummy_hcd_to_hcd(dum_hcd
)->state
= HC_STATE_RUNNING
;
2393 dummy_hcd_to_hcd(dum_hcd
)->uses_new_polling
= 1;
2394 #ifdef CONFIG_USB_OTG
2395 dummy_hcd_to_hcd(dum_hcd
)->self
.otg_port
= 1;
2399 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2400 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2403 static int dummy_start(struct usb_hcd
*hcd
)
2405 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2408 * MASTER side init ... we emulate a root hub that'll only ever
2409 * talk to one device (the slave side). Also appears in sysfs,
2410 * just like more familiar pci-based HCDs.
2412 if (!usb_hcd_is_primary_hcd(hcd
))
2413 return dummy_start_ss(dum_hcd
);
2415 spin_lock_init(&dum_hcd
->dum
->lock
);
2416 init_timer(&dum_hcd
->timer
);
2417 dum_hcd
->timer
.function
= dummy_timer
;
2418 dum_hcd
->timer
.data
= (unsigned long)dum_hcd
;
2419 dum_hcd
->rh_state
= DUMMY_RH_RUNNING
;
2421 INIT_LIST_HEAD(&dum_hcd
->urbp_list
);
2423 hcd
->power_budget
= POWER_BUDGET
;
2424 hcd
->state
= HC_STATE_RUNNING
;
2425 hcd
->uses_new_polling
= 1;
2427 #ifdef CONFIG_USB_OTG
2428 hcd
->self
.otg_port
= 1;
2431 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2432 return device_create_file(dummy_dev(dum_hcd
), &dev_attr_urbs
);
2435 static void dummy_stop(struct usb_hcd
*hcd
)
2437 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd
)), &dev_attr_urbs
);
2438 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd
)), "stopped\n");
2441 /*-------------------------------------------------------------------------*/
2443 static int dummy_h_get_frame(struct usb_hcd
*hcd
)
2445 return dummy_g_get_frame(NULL
);
2448 static int dummy_setup(struct usb_hcd
*hcd
)
2452 dum
= *((void **)dev_get_platdata(hcd
->self
.controller
));
2453 hcd
->self
.sg_tablesize
= ~0;
2454 if (usb_hcd_is_primary_hcd(hcd
)) {
2455 dum
->hs_hcd
= hcd_to_dummy_hcd(hcd
);
2456 dum
->hs_hcd
->dum
= dum
;
2458 * Mark the first roothub as being USB 2.0.
2459 * The USB 3.0 roothub will be registered later by
2462 hcd
->speed
= HCD_USB2
;
2463 hcd
->self
.root_hub
->speed
= USB_SPEED_HIGH
;
2465 dum
->ss_hcd
= hcd_to_dummy_hcd(hcd
);
2466 dum
->ss_hcd
->dum
= dum
;
2467 hcd
->speed
= HCD_USB3
;
2468 hcd
->self
.root_hub
->speed
= USB_SPEED_SUPER
;
2473 /* Change a group of bulk endpoints to support multiple stream IDs */
2474 static int dummy_alloc_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2475 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2476 unsigned int num_streams
, gfp_t mem_flags
)
2478 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2479 unsigned long flags
;
2481 int ret_streams
= num_streams
;
2488 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2489 for (i
= 0; i
< num_eps
; i
++) {
2490 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2491 if ((1 << index
) & dum_hcd
->stream_en_ep
) {
2492 ret_streams
= -EINVAL
;
2495 max_stream
= usb_ss_max_streams(&eps
[i
]->ss_ep_comp
);
2497 ret_streams
= -EINVAL
;
2500 if (max_stream
< ret_streams
) {
2501 dev_dbg(dummy_dev(dum_hcd
), "Ep 0x%x only supports %u "
2503 eps
[i
]->desc
.bEndpointAddress
,
2505 ret_streams
= max_stream
;
2509 for (i
= 0; i
< num_eps
; i
++) {
2510 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2511 dum_hcd
->stream_en_ep
|= 1 << index
;
2512 set_max_streams_for_pipe(dum_hcd
,
2513 usb_endpoint_num(&eps
[i
]->desc
), ret_streams
);
2516 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2520 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2521 static int dummy_free_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2522 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2525 struct dummy_hcd
*dum_hcd
= hcd_to_dummy_hcd(hcd
);
2526 unsigned long flags
;
2531 spin_lock_irqsave(&dum_hcd
->dum
->lock
, flags
);
2532 for (i
= 0; i
< num_eps
; i
++) {
2533 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2534 if (!((1 << index
) & dum_hcd
->stream_en_ep
)) {
2540 for (i
= 0; i
< num_eps
; i
++) {
2541 index
= dummy_get_ep_idx(&eps
[i
]->desc
);
2542 dum_hcd
->stream_en_ep
&= ~(1 << index
);
2543 set_max_streams_for_pipe(dum_hcd
,
2544 usb_endpoint_num(&eps
[i
]->desc
), 0);
2548 spin_unlock_irqrestore(&dum_hcd
->dum
->lock
, flags
);
2552 static struct hc_driver dummy_hcd
= {
2553 .description
= (char *) driver_name
,
2554 .product_desc
= "Dummy host controller",
2555 .hcd_priv_size
= sizeof(struct dummy_hcd
),
2557 .flags
= HCD_USB3
| HCD_SHARED
,
2559 .reset
= dummy_setup
,
2560 .start
= dummy_start
,
2563 .urb_enqueue
= dummy_urb_enqueue
,
2564 .urb_dequeue
= dummy_urb_dequeue
,
2566 .get_frame_number
= dummy_h_get_frame
,
2568 .hub_status_data
= dummy_hub_status
,
2569 .hub_control
= dummy_hub_control
,
2570 .bus_suspend
= dummy_bus_suspend
,
2571 .bus_resume
= dummy_bus_resume
,
2573 .alloc_streams
= dummy_alloc_streams
,
2574 .free_streams
= dummy_free_streams
,
2577 static int dummy_hcd_probe(struct platform_device
*pdev
)
2580 struct usb_hcd
*hs_hcd
;
2581 struct usb_hcd
*ss_hcd
;
2584 dev_info(&pdev
->dev
, "%s, driver " DRIVER_VERSION
"\n", driver_desc
);
2585 dum
= *((void **)dev_get_platdata(&pdev
->dev
));
2587 if (!mod_data
.is_super_speed
)
2588 dummy_hcd
.flags
= HCD_USB2
;
2589 hs_hcd
= usb_create_hcd(&dummy_hcd
, &pdev
->dev
, dev_name(&pdev
->dev
));
2594 retval
= usb_add_hcd(hs_hcd
, 0, 0);
2598 if (mod_data
.is_super_speed
) {
2599 ss_hcd
= usb_create_shared_hcd(&dummy_hcd
, &pdev
->dev
,
2600 dev_name(&pdev
->dev
), hs_hcd
);
2603 goto dealloc_usb2_hcd
;
2606 retval
= usb_add_hcd(ss_hcd
, 0, 0);
2613 usb_put_hcd(ss_hcd
);
2615 usb_remove_hcd(hs_hcd
);
2617 usb_put_hcd(hs_hcd
);
2618 dum
->hs_hcd
= dum
->ss_hcd
= NULL
;
2622 static int dummy_hcd_remove(struct platform_device
*pdev
)
2626 dum
= hcd_to_dummy_hcd(platform_get_drvdata(pdev
))->dum
;
2629 usb_remove_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2630 usb_put_hcd(dummy_hcd_to_hcd(dum
->ss_hcd
));
2633 usb_remove_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2634 usb_put_hcd(dummy_hcd_to_hcd(dum
->hs_hcd
));
2642 static int dummy_hcd_suspend(struct platform_device
*pdev
, pm_message_t state
)
2644 struct usb_hcd
*hcd
;
2645 struct dummy_hcd
*dum_hcd
;
2648 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2650 hcd
= platform_get_drvdata(pdev
);
2651 dum_hcd
= hcd_to_dummy_hcd(hcd
);
2652 if (dum_hcd
->rh_state
== DUMMY_RH_RUNNING
) {
2653 dev_warn(&pdev
->dev
, "Root hub isn't suspended!\n");
2656 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2660 static int dummy_hcd_resume(struct platform_device
*pdev
)
2662 struct usb_hcd
*hcd
;
2664 dev_dbg(&pdev
->dev
, "%s\n", __func__
);
2666 hcd
= platform_get_drvdata(pdev
);
2667 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
2668 usb_hcd_poll_rh_status(hcd
);
2672 static struct platform_driver dummy_hcd_driver
= {
2673 .probe
= dummy_hcd_probe
,
2674 .remove
= dummy_hcd_remove
,
2675 .suspend
= dummy_hcd_suspend
,
2676 .resume
= dummy_hcd_resume
,
2678 .name
= (char *) driver_name
,
2682 /*-------------------------------------------------------------------------*/
2683 #define MAX_NUM_UDC 2
2684 static struct platform_device
*the_udc_pdev
[MAX_NUM_UDC
];
2685 static struct platform_device
*the_hcd_pdev
[MAX_NUM_UDC
];
2687 static int __init
init(void)
2689 int retval
= -ENOMEM
;
2691 struct dummy
*dum
[MAX_NUM_UDC
];
2696 if (!mod_data
.is_high_speed
&& mod_data
.is_super_speed
)
2699 if (mod_data
.num
< 1 || mod_data
.num
> MAX_NUM_UDC
) {
2700 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2705 for (i
= 0; i
< mod_data
.num
; i
++) {
2706 the_hcd_pdev
[i
] = platform_device_alloc(driver_name
, i
);
2707 if (!the_hcd_pdev
[i
]) {
2710 platform_device_put(the_hcd_pdev
[i
--]);
2714 for (i
= 0; i
< mod_data
.num
; i
++) {
2715 the_udc_pdev
[i
] = platform_device_alloc(gadget_name
, i
);
2716 if (!the_udc_pdev
[i
]) {
2719 platform_device_put(the_udc_pdev
[i
--]);
2723 for (i
= 0; i
< mod_data
.num
; i
++) {
2724 dum
[i
] = kzalloc(sizeof(struct dummy
), GFP_KERNEL
);
2729 retval
= platform_device_add_data(the_hcd_pdev
[i
], &dum
[i
],
2733 retval
= platform_device_add_data(the_udc_pdev
[i
], &dum
[i
],
2739 retval
= platform_driver_register(&dummy_hcd_driver
);
2742 retval
= platform_driver_register(&dummy_udc_driver
);
2744 goto err_register_udc_driver
;
2746 for (i
= 0; i
< mod_data
.num
; i
++) {
2747 retval
= platform_device_add(the_hcd_pdev
[i
]);
2751 platform_device_del(the_hcd_pdev
[i
--]);
2755 for (i
= 0; i
< mod_data
.num
; i
++) {
2756 if (!dum
[i
]->hs_hcd
||
2757 (!dum
[i
]->ss_hcd
&& mod_data
.is_super_speed
)) {
2759 * The hcd was added successfully but its probe
2760 * function failed for some reason.
2767 for (i
= 0; i
< mod_data
.num
; i
++) {
2768 retval
= platform_device_add(the_udc_pdev
[i
]);
2772 platform_device_del(the_udc_pdev
[i
]);
2777 for (i
= 0; i
< mod_data
.num
; i
++) {
2778 if (!platform_get_drvdata(the_udc_pdev
[i
])) {
2780 * The udc was added successfully but its probe
2781 * function failed for some reason.
2790 for (i
= 0; i
< mod_data
.num
; i
++)
2791 platform_device_del(the_udc_pdev
[i
]);
2793 for (i
= 0; i
< mod_data
.num
; i
++)
2794 platform_device_del(the_hcd_pdev
[i
]);
2796 platform_driver_unregister(&dummy_udc_driver
);
2797 err_register_udc_driver
:
2798 platform_driver_unregister(&dummy_hcd_driver
);
2800 for (i
= 0; i
< mod_data
.num
; i
++)
2802 for (i
= 0; i
< mod_data
.num
; i
++)
2803 platform_device_put(the_udc_pdev
[i
]);
2805 for (i
= 0; i
< mod_data
.num
; i
++)
2806 platform_device_put(the_hcd_pdev
[i
]);
2811 static void __exit
cleanup(void)
2815 for (i
= 0; i
< mod_data
.num
; i
++) {
2818 dum
= *((void **)dev_get_platdata(&the_udc_pdev
[i
]->dev
));
2820 platform_device_unregister(the_udc_pdev
[i
]);
2821 platform_device_unregister(the_hcd_pdev
[i
]);
2824 platform_driver_unregister(&dummy_udc_driver
);
2825 platform_driver_unregister(&dummy_hcd_driver
);
2827 module_exit(cleanup
);