Merge branch 'for-3.11' of git://linux-nfs.org/~bfields/linux
[linux-2.6.git] / drivers / usb / gadget / dummy_hcd.c
blobc588e8e486e590843ed2714403f282a7b3748a68
1 /*
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>
45 #include <linux/io.h>
46 #include <asm/irq.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 {
64 bool is_super_speed;
65 bool is_high_speed;
66 unsigned int num;
69 static struct dummy_hcd_module_parameters mod_data = {
70 .is_super_speed = false,
71 .is_high_speed = true,
72 .num = 1,
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 */
83 struct dummy_ep {
84 struct list_head queue;
85 unsigned long last_io; /* jiffies timestamp */
86 struct usb_gadget *gadget;
87 const struct usb_endpoint_descriptor *desc;
88 struct usb_ep ep;
89 unsigned halted:1;
90 unsigned wedged:1;
91 unsigned already_seen:1;
92 unsigned setup_stage:1;
93 unsigned stream_en: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 char *const ep_name[] = {
131 ep0name, /* everyone has ep0 */
133 /* act like a pxa250: fifteen fixed function endpoints */
134 "ep1in-bulk", "ep2out-bulk", "ep3in-iso", "ep4out-iso", "ep5in-int",
135 "ep6in-bulk", "ep7out-bulk", "ep8in-iso", "ep9out-iso", "ep10in-int",
136 "ep11in-bulk", "ep12out-bulk", "ep13in-iso", "ep14out-iso",
137 "ep15in-int",
139 /* or like sa1100: two fixed function endpoints */
140 "ep1out-bulk", "ep2in-bulk",
142 /* and now some generic EPs so we have enough in multi config */
143 "ep3out", "ep4in", "ep5out", "ep6out", "ep7in", "ep8out", "ep9in",
144 "ep10out", "ep11out", "ep12in", "ep13out", "ep14in", "ep15out",
146 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_name)
148 /*-------------------------------------------------------------------------*/
150 #define FIFO_SIZE 64
152 struct urbp {
153 struct urb *urb;
154 struct list_head urbp_list;
155 struct sg_mapping_iter miter;
156 u32 miter_started;
160 enum dummy_rh_state {
161 DUMMY_RH_RESET,
162 DUMMY_RH_SUSPENDED,
163 DUMMY_RH_RUNNING
166 struct dummy_hcd {
167 struct dummy *dum;
168 enum dummy_rh_state rh_state;
169 struct timer_list timer;
170 u32 port_status;
171 u32 old_status;
172 unsigned long re_timeout;
174 struct usb_device *udev;
175 struct list_head urbp_list;
176 u32 stream_en_ep;
177 u8 num_stream[30 / 2];
179 unsigned active:1;
180 unsigned old_active:1;
181 unsigned resuming:1;
184 struct dummy {
185 spinlock_t lock;
188 * SLAVE/GADGET side support
190 struct dummy_ep ep[DUMMY_ENDPOINTS];
191 int address;
192 struct usb_gadget gadget;
193 struct usb_gadget_driver *driver;
194 struct dummy_request fifo_req;
195 u8 fifo_buf[FIFO_SIZE];
196 u16 devstatus;
197 unsigned udc_suspended:1;
198 unsigned pullup:1;
201 * MASTER/HOST side support
203 struct dummy_hcd *hs_hcd;
204 struct dummy_hcd *ss_hcd;
207 static inline struct dummy_hcd *hcd_to_dummy_hcd(struct usb_hcd *hcd)
209 return (struct dummy_hcd *) (hcd->hcd_priv);
212 static inline struct usb_hcd *dummy_hcd_to_hcd(struct dummy_hcd *dum)
214 return container_of((void *) dum, struct usb_hcd, hcd_priv);
217 static inline struct device *dummy_dev(struct dummy_hcd *dum)
219 return dummy_hcd_to_hcd(dum)->self.controller;
222 static inline struct device *udc_dev(struct dummy *dum)
224 return dum->gadget.dev.parent;
227 static inline struct dummy *ep_to_dummy(struct dummy_ep *ep)
229 return container_of(ep->gadget, struct dummy, gadget);
232 static inline struct dummy_hcd *gadget_to_dummy_hcd(struct usb_gadget *gadget)
234 struct dummy *dum = container_of(gadget, struct dummy, gadget);
235 if (dum->gadget.speed == USB_SPEED_SUPER)
236 return dum->ss_hcd;
237 else
238 return dum->hs_hcd;
241 static inline struct dummy *gadget_dev_to_dummy(struct device *dev)
243 return container_of(dev, struct dummy, gadget.dev);
246 /*-------------------------------------------------------------------------*/
248 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
250 /* called with spinlock held */
251 static void nuke(struct dummy *dum, struct dummy_ep *ep)
253 while (!list_empty(&ep->queue)) {
254 struct dummy_request *req;
256 req = list_entry(ep->queue.next, struct dummy_request, queue);
257 list_del_init(&req->queue);
258 req->req.status = -ESHUTDOWN;
260 spin_unlock(&dum->lock);
261 req->req.complete(&ep->ep, &req->req);
262 spin_lock(&dum->lock);
266 /* caller must hold lock */
267 static void stop_activity(struct dummy *dum)
269 struct dummy_ep *ep;
271 /* prevent any more requests */
272 dum->address = 0;
274 /* The timer is left running so that outstanding URBs can fail */
276 /* nuke any pending requests first, so driver i/o is quiesced */
277 list_for_each_entry(ep, &dum->gadget.ep_list, ep.ep_list)
278 nuke(dum, ep);
280 /* driver now does any non-usb quiescing necessary */
284 * set_link_state_by_speed() - Sets the current state of the link according to
285 * the hcd speed
286 * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
288 * This function updates the port_status according to the link state and the
289 * speed of the hcd.
291 static void set_link_state_by_speed(struct dummy_hcd *dum_hcd)
293 struct dummy *dum = dum_hcd->dum;
295 if (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3) {
296 if ((dum_hcd->port_status & USB_SS_PORT_STAT_POWER) == 0) {
297 dum_hcd->port_status = 0;
298 } else if (!dum->pullup || dum->udc_suspended) {
299 /* UDC suspend must cause a disconnect */
300 dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
301 USB_PORT_STAT_ENABLE);
302 if ((dum_hcd->old_status &
303 USB_PORT_STAT_CONNECTION) != 0)
304 dum_hcd->port_status |=
305 (USB_PORT_STAT_C_CONNECTION << 16);
306 } else {
307 /* device is connected and not suspended */
308 dum_hcd->port_status |= (USB_PORT_STAT_CONNECTION |
309 USB_PORT_STAT_SPEED_5GBPS) ;
310 if ((dum_hcd->old_status &
311 USB_PORT_STAT_CONNECTION) == 0)
312 dum_hcd->port_status |=
313 (USB_PORT_STAT_C_CONNECTION << 16);
314 if ((dum_hcd->port_status &
315 USB_PORT_STAT_ENABLE) == 1 &&
316 (dum_hcd->port_status &
317 USB_SS_PORT_LS_U0) == 1 &&
318 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
319 dum_hcd->active = 1;
321 } else {
322 if ((dum_hcd->port_status & USB_PORT_STAT_POWER) == 0) {
323 dum_hcd->port_status = 0;
324 } else if (!dum->pullup || dum->udc_suspended) {
325 /* UDC suspend must cause a disconnect */
326 dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
327 USB_PORT_STAT_ENABLE |
328 USB_PORT_STAT_LOW_SPEED |
329 USB_PORT_STAT_HIGH_SPEED |
330 USB_PORT_STAT_SUSPEND);
331 if ((dum_hcd->old_status &
332 USB_PORT_STAT_CONNECTION) != 0)
333 dum_hcd->port_status |=
334 (USB_PORT_STAT_C_CONNECTION << 16);
335 } else {
336 dum_hcd->port_status |= USB_PORT_STAT_CONNECTION;
337 if ((dum_hcd->old_status &
338 USB_PORT_STAT_CONNECTION) == 0)
339 dum_hcd->port_status |=
340 (USB_PORT_STAT_C_CONNECTION << 16);
341 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0)
342 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
343 else if ((dum_hcd->port_status &
344 USB_PORT_STAT_SUSPEND) == 0 &&
345 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
346 dum_hcd->active = 1;
351 /* caller must hold lock */
352 static void set_link_state(struct dummy_hcd *dum_hcd)
354 struct dummy *dum = dum_hcd->dum;
356 dum_hcd->active = 0;
357 if (dum->pullup)
358 if ((dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 &&
359 dum->gadget.speed != USB_SPEED_SUPER) ||
360 (dummy_hcd_to_hcd(dum_hcd)->speed != HCD_USB3 &&
361 dum->gadget.speed == USB_SPEED_SUPER))
362 return;
364 set_link_state_by_speed(dum_hcd);
366 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0 ||
367 dum_hcd->active)
368 dum_hcd->resuming = 0;
370 /* if !connected or reset */
371 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0 ||
372 (dum_hcd->port_status & USB_PORT_STAT_RESET) != 0) {
374 * We're connected and not reset (reset occurred now),
375 * and driver attached - disconnect!
377 if ((dum_hcd->old_status & USB_PORT_STAT_CONNECTION) != 0 &&
378 (dum_hcd->old_status & USB_PORT_STAT_RESET) == 0 &&
379 dum->driver) {
380 stop_activity(dum);
381 spin_unlock(&dum->lock);
382 dum->driver->disconnect(&dum->gadget);
383 spin_lock(&dum->lock);
385 } else if (dum_hcd->active != dum_hcd->old_active) {
386 if (dum_hcd->old_active && dum->driver->suspend) {
387 spin_unlock(&dum->lock);
388 dum->driver->suspend(&dum->gadget);
389 spin_lock(&dum->lock);
390 } else if (!dum_hcd->old_active && dum->driver->resume) {
391 spin_unlock(&dum->lock);
392 dum->driver->resume(&dum->gadget);
393 spin_lock(&dum->lock);
397 dum_hcd->old_status = dum_hcd->port_status;
398 dum_hcd->old_active = dum_hcd->active;
401 /*-------------------------------------------------------------------------*/
403 /* SLAVE/GADGET SIDE DRIVER
405 * This only tracks gadget state. All the work is done when the host
406 * side tries some (emulated) i/o operation. Real device controller
407 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
410 #define is_enabled(dum) \
411 (dum->port_status & USB_PORT_STAT_ENABLE)
413 static int dummy_enable(struct usb_ep *_ep,
414 const struct usb_endpoint_descriptor *desc)
416 struct dummy *dum;
417 struct dummy_hcd *dum_hcd;
418 struct dummy_ep *ep;
419 unsigned max;
420 int retval;
422 ep = usb_ep_to_dummy_ep(_ep);
423 if (!_ep || !desc || ep->desc || _ep->name == ep0name
424 || desc->bDescriptorType != USB_DT_ENDPOINT)
425 return -EINVAL;
426 dum = ep_to_dummy(ep);
427 if (!dum->driver)
428 return -ESHUTDOWN;
430 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
431 if (!is_enabled(dum_hcd))
432 return -ESHUTDOWN;
435 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
436 * maximum packet size.
437 * For SS devices the wMaxPacketSize is limited by 1024.
439 max = usb_endpoint_maxp(desc) & 0x7ff;
441 /* drivers must not request bad settings, since lower levels
442 * (hardware or its drivers) may not check. some endpoints
443 * can't do iso, many have maxpacket limitations, etc.
445 * since this "hardware" driver is here to help debugging, we
446 * have some extra sanity checks. (there could be more though,
447 * especially for "ep9out" style fixed function ones.)
449 retval = -EINVAL;
450 switch (usb_endpoint_type(desc)) {
451 case USB_ENDPOINT_XFER_BULK:
452 if (strstr(ep->ep.name, "-iso")
453 || strstr(ep->ep.name, "-int")) {
454 goto done;
456 switch (dum->gadget.speed) {
457 case USB_SPEED_SUPER:
458 if (max == 1024)
459 break;
460 goto done;
461 case USB_SPEED_HIGH:
462 if (max == 512)
463 break;
464 goto done;
465 case USB_SPEED_FULL:
466 if (max == 8 || max == 16 || max == 32 || max == 64)
467 /* we'll fake any legal size */
468 break;
469 /* save a return statement */
470 default:
471 goto done;
473 break;
474 case USB_ENDPOINT_XFER_INT:
475 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
476 goto done;
477 /* real hardware might not handle all packet sizes */
478 switch (dum->gadget.speed) {
479 case USB_SPEED_SUPER:
480 case USB_SPEED_HIGH:
481 if (max <= 1024)
482 break;
483 /* save a return statement */
484 case USB_SPEED_FULL:
485 if (max <= 64)
486 break;
487 /* save a return statement */
488 default:
489 if (max <= 8)
490 break;
491 goto done;
493 break;
494 case USB_ENDPOINT_XFER_ISOC:
495 if (strstr(ep->ep.name, "-bulk")
496 || strstr(ep->ep.name, "-int"))
497 goto done;
498 /* real hardware might not handle all packet sizes */
499 switch (dum->gadget.speed) {
500 case USB_SPEED_SUPER:
501 case USB_SPEED_HIGH:
502 if (max <= 1024)
503 break;
504 /* save a return statement */
505 case USB_SPEED_FULL:
506 if (max <= 1023)
507 break;
508 /* save a return statement */
509 default:
510 goto done;
512 break;
513 default:
514 /* few chips support control except on ep0 */
515 goto done;
518 _ep->maxpacket = max;
519 if (usb_ss_max_streams(_ep->comp_desc)) {
520 if (!usb_endpoint_xfer_bulk(desc)) {
521 dev_err(udc_dev(dum), "Can't enable stream support on "
522 "non-bulk ep %s\n", _ep->name);
523 return -EINVAL;
525 ep->stream_en = 1;
527 ep->desc = desc;
529 dev_dbg(udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
530 _ep->name,
531 desc->bEndpointAddress & 0x0f,
532 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
533 ({ char *val;
534 switch (usb_endpoint_type(desc)) {
535 case USB_ENDPOINT_XFER_BULK:
536 val = "bulk";
537 break;
538 case USB_ENDPOINT_XFER_ISOC:
539 val = "iso";
540 break;
541 case USB_ENDPOINT_XFER_INT:
542 val = "intr";
543 break;
544 default:
545 val = "ctrl";
546 break;
547 }; val; }),
548 max, ep->stream_en ? "enabled" : "disabled");
550 /* at this point real hardware should be NAKing transfers
551 * to that endpoint, until a buffer is queued to it.
553 ep->halted = ep->wedged = 0;
554 retval = 0;
555 done:
556 return retval;
559 static int dummy_disable(struct usb_ep *_ep)
561 struct dummy_ep *ep;
562 struct dummy *dum;
563 unsigned long flags;
564 int retval;
566 ep = usb_ep_to_dummy_ep(_ep);
567 if (!_ep || !ep->desc || _ep->name == ep0name)
568 return -EINVAL;
569 dum = ep_to_dummy(ep);
571 spin_lock_irqsave(&dum->lock, flags);
572 ep->desc = NULL;
573 ep->stream_en = 0;
574 retval = 0;
575 nuke(dum, ep);
576 spin_unlock_irqrestore(&dum->lock, flags);
578 dev_dbg(udc_dev(dum), "disabled %s\n", _ep->name);
579 return retval;
582 static struct usb_request *dummy_alloc_request(struct usb_ep *_ep,
583 gfp_t mem_flags)
585 struct dummy_ep *ep;
586 struct dummy_request *req;
588 if (!_ep)
589 return NULL;
590 ep = usb_ep_to_dummy_ep(_ep);
592 req = kzalloc(sizeof(*req), mem_flags);
593 if (!req)
594 return NULL;
595 INIT_LIST_HEAD(&req->queue);
596 return &req->req;
599 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
601 struct dummy_request *req;
603 if (!_ep || !_req) {
604 WARN_ON(1);
605 return;
608 req = usb_request_to_dummy_request(_req);
609 WARN_ON(!list_empty(&req->queue));
610 kfree(req);
613 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
617 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
618 gfp_t mem_flags)
620 struct dummy_ep *ep;
621 struct dummy_request *req;
622 struct dummy *dum;
623 struct dummy_hcd *dum_hcd;
624 unsigned long flags;
626 req = usb_request_to_dummy_request(_req);
627 if (!_req || !list_empty(&req->queue) || !_req->complete)
628 return -EINVAL;
630 ep = usb_ep_to_dummy_ep(_ep);
631 if (!_ep || (!ep->desc && _ep->name != ep0name))
632 return -EINVAL;
634 dum = ep_to_dummy(ep);
635 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
636 if (!dum->driver || !is_enabled(dum_hcd))
637 return -ESHUTDOWN;
639 #if 0
640 dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
641 ep, _req, _ep->name, _req->length, _req->buf);
642 #endif
643 _req->status = -EINPROGRESS;
644 _req->actual = 0;
645 spin_lock_irqsave(&dum->lock, flags);
647 /* implement an emulated single-request FIFO */
648 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
649 list_empty(&dum->fifo_req.queue) &&
650 list_empty(&ep->queue) &&
651 _req->length <= FIFO_SIZE) {
652 req = &dum->fifo_req;
653 req->req = *_req;
654 req->req.buf = dum->fifo_buf;
655 memcpy(dum->fifo_buf, _req->buf, _req->length);
656 req->req.context = dum;
657 req->req.complete = fifo_complete;
659 list_add_tail(&req->queue, &ep->queue);
660 spin_unlock(&dum->lock);
661 _req->actual = _req->length;
662 _req->status = 0;
663 _req->complete(_ep, _req);
664 spin_lock(&dum->lock);
665 } else
666 list_add_tail(&req->queue, &ep->queue);
667 spin_unlock_irqrestore(&dum->lock, flags);
669 /* real hardware would likely enable transfers here, in case
670 * it'd been left NAKing.
672 return 0;
675 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
677 struct dummy_ep *ep;
678 struct dummy *dum;
679 int retval = -EINVAL;
680 unsigned long flags;
681 struct dummy_request *req = NULL;
683 if (!_ep || !_req)
684 return retval;
685 ep = usb_ep_to_dummy_ep(_ep);
686 dum = ep_to_dummy(ep);
688 if (!dum->driver)
689 return -ESHUTDOWN;
691 local_irq_save(flags);
692 spin_lock(&dum->lock);
693 list_for_each_entry(req, &ep->queue, queue) {
694 if (&req->req == _req) {
695 list_del_init(&req->queue);
696 _req->status = -ECONNRESET;
697 retval = 0;
698 break;
701 spin_unlock(&dum->lock);
703 if (retval == 0) {
704 dev_dbg(udc_dev(dum),
705 "dequeued req %p from %s, len %d buf %p\n",
706 req, _ep->name, _req->length, _req->buf);
707 _req->complete(_ep, _req);
709 local_irq_restore(flags);
710 return retval;
713 static int
714 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
716 struct dummy_ep *ep;
717 struct dummy *dum;
719 if (!_ep)
720 return -EINVAL;
721 ep = usb_ep_to_dummy_ep(_ep);
722 dum = ep_to_dummy(ep);
723 if (!dum->driver)
724 return -ESHUTDOWN;
725 if (!value)
726 ep->halted = ep->wedged = 0;
727 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
728 !list_empty(&ep->queue))
729 return -EAGAIN;
730 else {
731 ep->halted = 1;
732 if (wedged)
733 ep->wedged = 1;
735 /* FIXME clear emulated data toggle too */
736 return 0;
739 static int
740 dummy_set_halt(struct usb_ep *_ep, int value)
742 return dummy_set_halt_and_wedge(_ep, value, 0);
745 static int dummy_set_wedge(struct usb_ep *_ep)
747 if (!_ep || _ep->name == ep0name)
748 return -EINVAL;
749 return dummy_set_halt_and_wedge(_ep, 1, 1);
752 static const struct usb_ep_ops dummy_ep_ops = {
753 .enable = dummy_enable,
754 .disable = dummy_disable,
756 .alloc_request = dummy_alloc_request,
757 .free_request = dummy_free_request,
759 .queue = dummy_queue,
760 .dequeue = dummy_dequeue,
762 .set_halt = dummy_set_halt,
763 .set_wedge = dummy_set_wedge,
766 /*-------------------------------------------------------------------------*/
768 /* there are both host and device side versions of this call ... */
769 static int dummy_g_get_frame(struct usb_gadget *_gadget)
771 struct timeval tv;
773 do_gettimeofday(&tv);
774 return tv.tv_usec / 1000;
777 static int dummy_wakeup(struct usb_gadget *_gadget)
779 struct dummy_hcd *dum_hcd;
781 dum_hcd = gadget_to_dummy_hcd(_gadget);
782 if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
783 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
784 return -EINVAL;
785 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
786 return -ENOLINK;
787 if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
788 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
789 return -EIO;
791 /* FIXME: What if the root hub is suspended but the port isn't? */
793 /* hub notices our request, issues downstream resume, etc */
794 dum_hcd->resuming = 1;
795 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
796 mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
797 return 0;
800 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
802 struct dummy *dum;
804 dum = gadget_to_dummy_hcd(_gadget)->dum;
805 if (value)
806 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
807 else
808 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
809 return 0;
812 static void dummy_udc_update_ep0(struct dummy *dum)
814 if (dum->gadget.speed == USB_SPEED_SUPER)
815 dum->ep[0].ep.maxpacket = 9;
816 else
817 dum->ep[0].ep.maxpacket = 64;
820 static int dummy_pullup(struct usb_gadget *_gadget, int value)
822 struct dummy_hcd *dum_hcd;
823 struct dummy *dum;
824 unsigned long flags;
826 dum = gadget_dev_to_dummy(&_gadget->dev);
828 if (value && dum->driver) {
829 if (mod_data.is_super_speed)
830 dum->gadget.speed = dum->driver->max_speed;
831 else if (mod_data.is_high_speed)
832 dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
833 dum->driver->max_speed);
834 else
835 dum->gadget.speed = USB_SPEED_FULL;
836 dummy_udc_update_ep0(dum);
838 if (dum->gadget.speed < dum->driver->max_speed)
839 dev_dbg(udc_dev(dum), "This device can perform faster"
840 " if you connect it to a %s port...\n",
841 usb_speed_string(dum->driver->max_speed));
843 dum_hcd = gadget_to_dummy_hcd(_gadget);
845 spin_lock_irqsave(&dum->lock, flags);
846 dum->pullup = (value != 0);
847 set_link_state(dum_hcd);
848 spin_unlock_irqrestore(&dum->lock, flags);
850 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
851 return 0;
854 static int dummy_udc_start(struct usb_gadget *g,
855 struct usb_gadget_driver *driver);
856 static int dummy_udc_stop(struct usb_gadget *g,
857 struct usb_gadget_driver *driver);
859 static const struct usb_gadget_ops dummy_ops = {
860 .get_frame = dummy_g_get_frame,
861 .wakeup = dummy_wakeup,
862 .set_selfpowered = dummy_set_selfpowered,
863 .pullup = dummy_pullup,
864 .udc_start = dummy_udc_start,
865 .udc_stop = dummy_udc_stop,
868 /*-------------------------------------------------------------------------*/
870 /* "function" sysfs attribute */
871 static ssize_t show_function(struct device *dev, struct device_attribute *attr,
872 char *buf)
874 struct dummy *dum = gadget_dev_to_dummy(dev);
876 if (!dum->driver || !dum->driver->function)
877 return 0;
878 return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
880 static DEVICE_ATTR(function, S_IRUGO, show_function, NULL);
882 /*-------------------------------------------------------------------------*/
885 * Driver registration/unregistration.
887 * This is basically hardware-specific; there's usually only one real USB
888 * device (not host) controller since that's how USB devices are intended
889 * to work. So most implementations of these api calls will rely on the
890 * fact that only one driver will ever bind to the hardware. But curious
891 * hardware can be built with discrete components, so the gadget API doesn't
892 * require that assumption.
894 * For this emulator, it might be convenient to create a usb slave device
895 * for each driver that registers: just add to a big root hub.
898 static int dummy_udc_start(struct usb_gadget *g,
899 struct usb_gadget_driver *driver)
901 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
902 struct dummy *dum = dum_hcd->dum;
904 if (driver->max_speed == USB_SPEED_UNKNOWN)
905 return -EINVAL;
908 * SLAVE side init ... the layer above hardware, which
909 * can't enumerate without help from the driver we're binding.
912 dum->devstatus = 0;
914 dum->driver = driver;
915 dev_dbg(udc_dev(dum), "binding gadget driver '%s'\n",
916 driver->driver.name);
917 return 0;
920 static int dummy_udc_stop(struct usb_gadget *g,
921 struct usb_gadget_driver *driver)
923 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
924 struct dummy *dum = dum_hcd->dum;
926 dev_dbg(udc_dev(dum), "unregister gadget driver '%s'\n",
927 driver->driver.name);
929 dum->driver = NULL;
931 return 0;
934 #undef is_enabled
936 /* The gadget structure is stored inside the hcd structure and will be
937 * released along with it. */
938 static void init_dummy_udc_hw(struct dummy *dum)
940 int i;
942 INIT_LIST_HEAD(&dum->gadget.ep_list);
943 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
944 struct dummy_ep *ep = &dum->ep[i];
946 if (!ep_name[i])
947 break;
948 ep->ep.name = ep_name[i];
949 ep->ep.ops = &dummy_ep_ops;
950 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
951 ep->halted = ep->wedged = ep->already_seen =
952 ep->setup_stage = 0;
953 ep->ep.maxpacket = ~0;
954 ep->ep.max_streams = 16;
955 ep->last_io = jiffies;
956 ep->gadget = &dum->gadget;
957 ep->desc = NULL;
958 INIT_LIST_HEAD(&ep->queue);
961 dum->gadget.ep0 = &dum->ep[0].ep;
962 list_del_init(&dum->ep[0].ep.ep_list);
963 INIT_LIST_HEAD(&dum->fifo_req.queue);
965 #ifdef CONFIG_USB_OTG
966 dum->gadget.is_otg = 1;
967 #endif
970 static int dummy_udc_probe(struct platform_device *pdev)
972 struct dummy *dum;
973 int rc;
975 dum = *((void **)dev_get_platdata(&pdev->dev));
976 dum->gadget.name = gadget_name;
977 dum->gadget.ops = &dummy_ops;
978 dum->gadget.max_speed = USB_SPEED_SUPER;
980 dum->gadget.dev.parent = &pdev->dev;
981 init_dummy_udc_hw(dum);
983 rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
984 if (rc < 0)
985 goto err_udc;
987 rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
988 if (rc < 0)
989 goto err_dev;
990 platform_set_drvdata(pdev, dum);
991 return rc;
993 err_dev:
994 usb_del_gadget_udc(&dum->gadget);
995 err_udc:
996 return rc;
999 static int dummy_udc_remove(struct platform_device *pdev)
1001 struct dummy *dum = platform_get_drvdata(pdev);
1003 usb_del_gadget_udc(&dum->gadget);
1004 device_remove_file(&dum->gadget.dev, &dev_attr_function);
1005 return 0;
1008 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1009 int suspend)
1011 spin_lock_irq(&dum->lock);
1012 dum->udc_suspended = suspend;
1013 set_link_state(dum_hcd);
1014 spin_unlock_irq(&dum->lock);
1017 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1019 struct dummy *dum = platform_get_drvdata(pdev);
1020 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1022 dev_dbg(&pdev->dev, "%s\n", __func__);
1023 dummy_udc_pm(dum, dum_hcd, 1);
1024 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1025 return 0;
1028 static int dummy_udc_resume(struct platform_device *pdev)
1030 struct dummy *dum = platform_get_drvdata(pdev);
1031 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1033 dev_dbg(&pdev->dev, "%s\n", __func__);
1034 dummy_udc_pm(dum, dum_hcd, 0);
1035 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1036 return 0;
1039 static struct platform_driver dummy_udc_driver = {
1040 .probe = dummy_udc_probe,
1041 .remove = dummy_udc_remove,
1042 .suspend = dummy_udc_suspend,
1043 .resume = dummy_udc_resume,
1044 .driver = {
1045 .name = (char *) gadget_name,
1046 .owner = THIS_MODULE,
1050 /*-------------------------------------------------------------------------*/
1052 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1054 unsigned int index;
1056 index = usb_endpoint_num(desc) << 1;
1057 if (usb_endpoint_dir_in(desc))
1058 index |= 1;
1059 return index;
1062 /* MASTER/HOST SIDE DRIVER
1064 * this uses the hcd framework to hook up to host side drivers.
1065 * its root hub will only have one device, otherwise it acts like
1066 * a normal host controller.
1068 * when urbs are queued, they're just stuck on a list that we
1069 * scan in a timer callback. that callback connects writes from
1070 * the host with reads from the device, and so on, based on the
1071 * usb 2.0 rules.
1074 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1076 const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1077 u32 index;
1079 if (!usb_endpoint_xfer_bulk(desc))
1080 return 0;
1082 index = dummy_get_ep_idx(desc);
1083 return (1 << index) & dum_hcd->stream_en_ep;
1087 * The max stream number is saved as a nibble so for the 30 possible endpoints
1088 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1089 * means we use only 1 stream). The maximum according to the spec is 16bit so
1090 * if the 16 stream limit is about to go, the array size should be incremented
1091 * to 30 elements of type u16.
1093 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1094 unsigned int pipe)
1096 int max_streams;
1098 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1099 if (usb_pipeout(pipe))
1100 max_streams >>= 4;
1101 else
1102 max_streams &= 0xf;
1103 max_streams++;
1104 return max_streams;
1107 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1108 unsigned int pipe, unsigned int streams)
1110 int max_streams;
1112 streams--;
1113 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1114 if (usb_pipeout(pipe)) {
1115 streams <<= 4;
1116 max_streams &= 0xf;
1117 } else {
1118 max_streams &= 0xf0;
1120 max_streams |= streams;
1121 dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1124 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1126 unsigned int max_streams;
1127 int enabled;
1129 enabled = dummy_ep_stream_en(dum_hcd, urb);
1130 if (!urb->stream_id) {
1131 if (enabled)
1132 return -EINVAL;
1133 return 0;
1135 if (!enabled)
1136 return -EINVAL;
1138 max_streams = get_max_streams_for_pipe(dum_hcd,
1139 usb_pipeendpoint(urb->pipe));
1140 if (urb->stream_id > max_streams) {
1141 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1142 urb->stream_id);
1143 BUG();
1144 return -EINVAL;
1146 return 0;
1149 static int dummy_urb_enqueue(
1150 struct usb_hcd *hcd,
1151 struct urb *urb,
1152 gfp_t mem_flags
1154 struct dummy_hcd *dum_hcd;
1155 struct urbp *urbp;
1156 unsigned long flags;
1157 int rc;
1159 urbp = kmalloc(sizeof *urbp, mem_flags);
1160 if (!urbp)
1161 return -ENOMEM;
1162 urbp->urb = urb;
1163 urbp->miter_started = 0;
1165 dum_hcd = hcd_to_dummy_hcd(hcd);
1166 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1168 rc = dummy_validate_stream(dum_hcd, urb);
1169 if (rc) {
1170 kfree(urbp);
1171 goto done;
1174 rc = usb_hcd_link_urb_to_ep(hcd, urb);
1175 if (rc) {
1176 kfree(urbp);
1177 goto done;
1180 if (!dum_hcd->udev) {
1181 dum_hcd->udev = urb->dev;
1182 usb_get_dev(dum_hcd->udev);
1183 } else if (unlikely(dum_hcd->udev != urb->dev))
1184 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1186 list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1187 urb->hcpriv = urbp;
1188 if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1189 urb->error_count = 1; /* mark as a new urb */
1191 /* kick the scheduler, it'll do the rest */
1192 if (!timer_pending(&dum_hcd->timer))
1193 mod_timer(&dum_hcd->timer, jiffies + 1);
1195 done:
1196 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1197 return rc;
1200 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1202 struct dummy_hcd *dum_hcd;
1203 unsigned long flags;
1204 int rc;
1206 /* giveback happens automatically in timer callback,
1207 * so make sure the callback happens */
1208 dum_hcd = hcd_to_dummy_hcd(hcd);
1209 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1211 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1212 if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1213 !list_empty(&dum_hcd->urbp_list))
1214 mod_timer(&dum_hcd->timer, jiffies);
1216 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1217 return rc;
1220 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1221 u32 len)
1223 void *ubuf, *rbuf;
1224 struct urbp *urbp = urb->hcpriv;
1225 int to_host;
1226 struct sg_mapping_iter *miter = &urbp->miter;
1227 u32 trans = 0;
1228 u32 this_sg;
1229 bool next_sg;
1231 to_host = usb_pipein(urb->pipe);
1232 rbuf = req->req.buf + req->req.actual;
1234 if (!urb->num_sgs) {
1235 ubuf = urb->transfer_buffer + urb->actual_length;
1236 if (to_host)
1237 memcpy(ubuf, rbuf, len);
1238 else
1239 memcpy(rbuf, ubuf, len);
1240 return len;
1243 if (!urbp->miter_started) {
1244 u32 flags = SG_MITER_ATOMIC;
1246 if (to_host)
1247 flags |= SG_MITER_TO_SG;
1248 else
1249 flags |= SG_MITER_FROM_SG;
1251 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1252 urbp->miter_started = 1;
1254 next_sg = sg_miter_next(miter);
1255 if (next_sg == false) {
1256 WARN_ON_ONCE(1);
1257 return -EINVAL;
1259 do {
1260 ubuf = miter->addr;
1261 this_sg = min_t(u32, len, miter->length);
1262 miter->consumed = this_sg;
1263 trans += this_sg;
1265 if (to_host)
1266 memcpy(ubuf, rbuf, this_sg);
1267 else
1268 memcpy(rbuf, ubuf, this_sg);
1269 len -= this_sg;
1271 if (!len)
1272 break;
1273 next_sg = sg_miter_next(miter);
1274 if (next_sg == false) {
1275 WARN_ON_ONCE(1);
1276 return -EINVAL;
1279 rbuf += this_sg;
1280 } while (1);
1282 sg_miter_stop(miter);
1283 return trans;
1286 /* transfer up to a frame's worth; caller must own lock */
1287 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1288 struct dummy_ep *ep, int limit, int *status)
1290 struct dummy *dum = dum_hcd->dum;
1291 struct dummy_request *req;
1293 top:
1294 /* if there's no request queued, the device is NAKing; return */
1295 list_for_each_entry(req, &ep->queue, queue) {
1296 unsigned host_len, dev_len, len;
1297 int is_short, to_host;
1298 int rescan = 0;
1300 if (dummy_ep_stream_en(dum_hcd, urb)) {
1301 if ((urb->stream_id != req->req.stream_id))
1302 continue;
1305 /* 1..N packets of ep->ep.maxpacket each ... the last one
1306 * may be short (including zero length).
1308 * writer can send a zlp explicitly (length 0) or implicitly
1309 * (length mod maxpacket zero, and 'zero' flag); they always
1310 * terminate reads.
1312 host_len = urb->transfer_buffer_length - urb->actual_length;
1313 dev_len = req->req.length - req->req.actual;
1314 len = min(host_len, dev_len);
1316 /* FIXME update emulated data toggle too */
1318 to_host = usb_pipein(urb->pipe);
1319 if (unlikely(len == 0))
1320 is_short = 1;
1321 else {
1322 /* not enough bandwidth left? */
1323 if (limit < ep->ep.maxpacket && limit < len)
1324 break;
1325 len = min_t(unsigned, len, limit);
1326 if (len == 0)
1327 break;
1329 /* use an extra pass for the final short packet */
1330 if (len > ep->ep.maxpacket) {
1331 rescan = 1;
1332 len -= (len % ep->ep.maxpacket);
1334 is_short = (len % ep->ep.maxpacket) != 0;
1336 len = dummy_perform_transfer(urb, req, len);
1338 ep->last_io = jiffies;
1339 if ((int)len < 0) {
1340 req->req.status = len;
1341 } else {
1342 limit -= len;
1343 urb->actual_length += len;
1344 req->req.actual += len;
1348 /* short packets terminate, maybe with overflow/underflow.
1349 * it's only really an error to write too much.
1351 * partially filling a buffer optionally blocks queue advances
1352 * (so completion handlers can clean up the queue) but we don't
1353 * need to emulate such data-in-flight.
1355 if (is_short) {
1356 if (host_len == dev_len) {
1357 req->req.status = 0;
1358 *status = 0;
1359 } else if (to_host) {
1360 req->req.status = 0;
1361 if (dev_len > host_len)
1362 *status = -EOVERFLOW;
1363 else
1364 *status = 0;
1365 } else if (!to_host) {
1366 *status = 0;
1367 if (host_len > dev_len)
1368 req->req.status = -EOVERFLOW;
1369 else
1370 req->req.status = 0;
1373 /* many requests terminate without a short packet */
1374 } else {
1375 if (req->req.length == req->req.actual
1376 && !req->req.zero)
1377 req->req.status = 0;
1378 if (urb->transfer_buffer_length == urb->actual_length
1379 && !(urb->transfer_flags
1380 & URB_ZERO_PACKET))
1381 *status = 0;
1384 /* device side completion --> continuable */
1385 if (req->req.status != -EINPROGRESS) {
1386 list_del_init(&req->queue);
1388 spin_unlock(&dum->lock);
1389 req->req.complete(&ep->ep, &req->req);
1390 spin_lock(&dum->lock);
1392 /* requests might have been unlinked... */
1393 rescan = 1;
1396 /* host side completion --> terminate */
1397 if (*status != -EINPROGRESS)
1398 break;
1400 /* rescan to continue with any other queued i/o */
1401 if (rescan)
1402 goto top;
1404 return limit;
1407 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1409 int limit = ep->ep.maxpacket;
1411 if (dum->gadget.speed == USB_SPEED_HIGH) {
1412 int tmp;
1414 /* high bandwidth mode */
1415 tmp = usb_endpoint_maxp(ep->desc);
1416 tmp = (tmp >> 11) & 0x03;
1417 tmp *= 8 /* applies to entire frame */;
1418 limit += limit * tmp;
1420 if (dum->gadget.speed == USB_SPEED_SUPER) {
1421 switch (usb_endpoint_type(ep->desc)) {
1422 case USB_ENDPOINT_XFER_ISOC:
1423 /* Sec. 4.4.8.2 USB3.0 Spec */
1424 limit = 3 * 16 * 1024 * 8;
1425 break;
1426 case USB_ENDPOINT_XFER_INT:
1427 /* Sec. 4.4.7.2 USB3.0 Spec */
1428 limit = 3 * 1024 * 8;
1429 break;
1430 case USB_ENDPOINT_XFER_BULK:
1431 default:
1432 break;
1435 return limit;
1438 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1439 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1440 USB_PORT_STAT_SUSPEND)) \
1441 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1443 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1445 int i;
1447 if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1448 dum->ss_hcd : dum->hs_hcd)))
1449 return NULL;
1450 if ((address & ~USB_DIR_IN) == 0)
1451 return &dum->ep[0];
1452 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1453 struct dummy_ep *ep = &dum->ep[i];
1455 if (!ep->desc)
1456 continue;
1457 if (ep->desc->bEndpointAddress == address)
1458 return ep;
1460 return NULL;
1463 #undef is_active
1465 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1466 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1467 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1468 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1469 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1470 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1474 * handle_control_request() - handles all control transfers
1475 * @dum: pointer to dummy (the_controller)
1476 * @urb: the urb request to handle
1477 * @setup: pointer to the setup data for a USB device control
1478 * request
1479 * @status: pointer to request handling status
1481 * Return 0 - if the request was handled
1482 * 1 - if the request wasn't handles
1483 * error code on error
1485 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1486 struct usb_ctrlrequest *setup,
1487 int *status)
1489 struct dummy_ep *ep2;
1490 struct dummy *dum = dum_hcd->dum;
1491 int ret_val = 1;
1492 unsigned w_index;
1493 unsigned w_value;
1495 w_index = le16_to_cpu(setup->wIndex);
1496 w_value = le16_to_cpu(setup->wValue);
1497 switch (setup->bRequest) {
1498 case USB_REQ_SET_ADDRESS:
1499 if (setup->bRequestType != Dev_Request)
1500 break;
1501 dum->address = w_value;
1502 *status = 0;
1503 dev_dbg(udc_dev(dum), "set_address = %d\n",
1504 w_value);
1505 ret_val = 0;
1506 break;
1507 case USB_REQ_SET_FEATURE:
1508 if (setup->bRequestType == Dev_Request) {
1509 ret_val = 0;
1510 switch (w_value) {
1511 case USB_DEVICE_REMOTE_WAKEUP:
1512 break;
1513 case USB_DEVICE_B_HNP_ENABLE:
1514 dum->gadget.b_hnp_enable = 1;
1515 break;
1516 case USB_DEVICE_A_HNP_SUPPORT:
1517 dum->gadget.a_hnp_support = 1;
1518 break;
1519 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1520 dum->gadget.a_alt_hnp_support = 1;
1521 break;
1522 case USB_DEVICE_U1_ENABLE:
1523 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1524 HCD_USB3)
1525 w_value = USB_DEV_STAT_U1_ENABLED;
1526 else
1527 ret_val = -EOPNOTSUPP;
1528 break;
1529 case USB_DEVICE_U2_ENABLE:
1530 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1531 HCD_USB3)
1532 w_value = USB_DEV_STAT_U2_ENABLED;
1533 else
1534 ret_val = -EOPNOTSUPP;
1535 break;
1536 case USB_DEVICE_LTM_ENABLE:
1537 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1538 HCD_USB3)
1539 w_value = USB_DEV_STAT_LTM_ENABLED;
1540 else
1541 ret_val = -EOPNOTSUPP;
1542 break;
1543 default:
1544 ret_val = -EOPNOTSUPP;
1546 if (ret_val == 0) {
1547 dum->devstatus |= (1 << w_value);
1548 *status = 0;
1550 } else if (setup->bRequestType == Ep_Request) {
1551 /* endpoint halt */
1552 ep2 = find_endpoint(dum, w_index);
1553 if (!ep2 || ep2->ep.name == ep0name) {
1554 ret_val = -EOPNOTSUPP;
1555 break;
1557 ep2->halted = 1;
1558 ret_val = 0;
1559 *status = 0;
1561 break;
1562 case USB_REQ_CLEAR_FEATURE:
1563 if (setup->bRequestType == Dev_Request) {
1564 ret_val = 0;
1565 switch (w_value) {
1566 case USB_DEVICE_REMOTE_WAKEUP:
1567 w_value = USB_DEVICE_REMOTE_WAKEUP;
1568 break;
1569 case USB_DEVICE_U1_ENABLE:
1570 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1571 HCD_USB3)
1572 w_value = USB_DEV_STAT_U1_ENABLED;
1573 else
1574 ret_val = -EOPNOTSUPP;
1575 break;
1576 case USB_DEVICE_U2_ENABLE:
1577 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1578 HCD_USB3)
1579 w_value = USB_DEV_STAT_U2_ENABLED;
1580 else
1581 ret_val = -EOPNOTSUPP;
1582 break;
1583 case USB_DEVICE_LTM_ENABLE:
1584 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1585 HCD_USB3)
1586 w_value = USB_DEV_STAT_LTM_ENABLED;
1587 else
1588 ret_val = -EOPNOTSUPP;
1589 break;
1590 default:
1591 ret_val = -EOPNOTSUPP;
1592 break;
1594 if (ret_val == 0) {
1595 dum->devstatus &= ~(1 << w_value);
1596 *status = 0;
1598 } else if (setup->bRequestType == Ep_Request) {
1599 /* endpoint halt */
1600 ep2 = find_endpoint(dum, w_index);
1601 if (!ep2) {
1602 ret_val = -EOPNOTSUPP;
1603 break;
1605 if (!ep2->wedged)
1606 ep2->halted = 0;
1607 ret_val = 0;
1608 *status = 0;
1610 break;
1611 case USB_REQ_GET_STATUS:
1612 if (setup->bRequestType == Dev_InRequest
1613 || setup->bRequestType == Intf_InRequest
1614 || setup->bRequestType == Ep_InRequest) {
1615 char *buf;
1617 * device: remote wakeup, selfpowered
1618 * interface: nothing
1619 * endpoint: halt
1621 buf = (char *)urb->transfer_buffer;
1622 if (urb->transfer_buffer_length > 0) {
1623 if (setup->bRequestType == Ep_InRequest) {
1624 ep2 = find_endpoint(dum, w_index);
1625 if (!ep2) {
1626 ret_val = -EOPNOTSUPP;
1627 break;
1629 buf[0] = ep2->halted;
1630 } else if (setup->bRequestType ==
1631 Dev_InRequest) {
1632 buf[0] = (u8)dum->devstatus;
1633 } else
1634 buf[0] = 0;
1636 if (urb->transfer_buffer_length > 1)
1637 buf[1] = 0;
1638 urb->actual_length = min_t(u32, 2,
1639 urb->transfer_buffer_length);
1640 ret_val = 0;
1641 *status = 0;
1643 break;
1645 return ret_val;
1648 /* drive both sides of the transfers; looks like irq handlers to
1649 * both drivers except the callbacks aren't in_irq().
1651 static void dummy_timer(unsigned long _dum_hcd)
1653 struct dummy_hcd *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1654 struct dummy *dum = dum_hcd->dum;
1655 struct urbp *urbp, *tmp;
1656 unsigned long flags;
1657 int limit, total;
1658 int i;
1660 /* simplistic model for one frame's bandwidth */
1661 switch (dum->gadget.speed) {
1662 case USB_SPEED_LOW:
1663 total = 8/*bytes*/ * 12/*packets*/;
1664 break;
1665 case USB_SPEED_FULL:
1666 total = 64/*bytes*/ * 19/*packets*/;
1667 break;
1668 case USB_SPEED_HIGH:
1669 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1670 break;
1671 case USB_SPEED_SUPER:
1672 /* Bus speed is 500000 bytes/ms, so use a little less */
1673 total = 490000;
1674 break;
1675 default:
1676 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1677 return;
1680 /* FIXME if HZ != 1000 this will probably misbehave ... */
1682 /* look at each urb queued by the host side driver */
1683 spin_lock_irqsave(&dum->lock, flags);
1685 if (!dum_hcd->udev) {
1686 dev_err(dummy_dev(dum_hcd),
1687 "timer fired with no URBs pending?\n");
1688 spin_unlock_irqrestore(&dum->lock, flags);
1689 return;
1692 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1693 if (!ep_name[i])
1694 break;
1695 dum->ep[i].already_seen = 0;
1698 restart:
1699 list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1700 struct urb *urb;
1701 struct dummy_request *req;
1702 u8 address;
1703 struct dummy_ep *ep = NULL;
1704 int type;
1705 int status = -EINPROGRESS;
1707 urb = urbp->urb;
1708 if (urb->unlinked)
1709 goto return_urb;
1710 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1711 continue;
1712 type = usb_pipetype(urb->pipe);
1714 /* used up this frame's non-periodic bandwidth?
1715 * FIXME there's infinite bandwidth for control and
1716 * periodic transfers ... unrealistic.
1718 if (total <= 0 && type == PIPE_BULK)
1719 continue;
1721 /* find the gadget's ep for this request (if configured) */
1722 address = usb_pipeendpoint (urb->pipe);
1723 if (usb_pipein(urb->pipe))
1724 address |= USB_DIR_IN;
1725 ep = find_endpoint(dum, address);
1726 if (!ep) {
1727 /* set_configuration() disagreement */
1728 dev_dbg(dummy_dev(dum_hcd),
1729 "no ep configured for urb %p\n",
1730 urb);
1731 status = -EPROTO;
1732 goto return_urb;
1735 if (ep->already_seen)
1736 continue;
1737 ep->already_seen = 1;
1738 if (ep == &dum->ep[0] && urb->error_count) {
1739 ep->setup_stage = 1; /* a new urb */
1740 urb->error_count = 0;
1742 if (ep->halted && !ep->setup_stage) {
1743 /* NOTE: must not be iso! */
1744 dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1745 ep->ep.name, urb);
1746 status = -EPIPE;
1747 goto return_urb;
1749 /* FIXME make sure both ends agree on maxpacket */
1751 /* handle control requests */
1752 if (ep == &dum->ep[0] && ep->setup_stage) {
1753 struct usb_ctrlrequest setup;
1754 int value = 1;
1756 setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1757 /* paranoia, in case of stale queued data */
1758 list_for_each_entry(req, &ep->queue, queue) {
1759 list_del_init(&req->queue);
1760 req->req.status = -EOVERFLOW;
1761 dev_dbg(udc_dev(dum), "stale req = %p\n",
1762 req);
1764 spin_unlock(&dum->lock);
1765 req->req.complete(&ep->ep, &req->req);
1766 spin_lock(&dum->lock);
1767 ep->already_seen = 0;
1768 goto restart;
1771 /* gadget driver never sees set_address or operations
1772 * on standard feature flags. some hardware doesn't
1773 * even expose them.
1775 ep->last_io = jiffies;
1776 ep->setup_stage = 0;
1777 ep->halted = 0;
1779 value = handle_control_request(dum_hcd, urb, &setup,
1780 &status);
1782 /* gadget driver handles all other requests. block
1783 * until setup() returns; no reentrancy issues etc.
1785 if (value > 0) {
1786 spin_unlock(&dum->lock);
1787 value = dum->driver->setup(&dum->gadget,
1788 &setup);
1789 spin_lock(&dum->lock);
1791 if (value >= 0) {
1792 /* no delays (max 64KB data stage) */
1793 limit = 64*1024;
1794 goto treat_control_like_bulk;
1796 /* error, see below */
1799 if (value < 0) {
1800 if (value != -EOPNOTSUPP)
1801 dev_dbg(udc_dev(dum),
1802 "setup --> %d\n",
1803 value);
1804 status = -EPIPE;
1805 urb->actual_length = 0;
1808 goto return_urb;
1811 /* non-control requests */
1812 limit = total;
1813 switch (usb_pipetype(urb->pipe)) {
1814 case PIPE_ISOCHRONOUS:
1815 /* FIXME is it urb->interval since the last xfer?
1816 * use urb->iso_frame_desc[i].
1817 * complete whether or not ep has requests queued.
1818 * report random errors, to debug drivers.
1820 limit = max(limit, periodic_bytes(dum, ep));
1821 status = -ENOSYS;
1822 break;
1824 case PIPE_INTERRUPT:
1825 /* FIXME is it urb->interval since the last xfer?
1826 * this almost certainly polls too fast.
1828 limit = max(limit, periodic_bytes(dum, ep));
1829 /* FALLTHROUGH */
1831 default:
1832 treat_control_like_bulk:
1833 ep->last_io = jiffies;
1834 total = transfer(dum_hcd, urb, ep, limit, &status);
1835 break;
1838 /* incomplete transfer? */
1839 if (status == -EINPROGRESS)
1840 continue;
1842 return_urb:
1843 list_del(&urbp->urbp_list);
1844 kfree(urbp);
1845 if (ep)
1846 ep->already_seen = ep->setup_stage = 0;
1848 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1849 spin_unlock(&dum->lock);
1850 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1851 spin_lock(&dum->lock);
1853 goto restart;
1856 if (list_empty(&dum_hcd->urbp_list)) {
1857 usb_put_dev(dum_hcd->udev);
1858 dum_hcd->udev = NULL;
1859 } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1860 /* want a 1 msec delay here */
1861 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1864 spin_unlock_irqrestore(&dum->lock, flags);
1867 /*-------------------------------------------------------------------------*/
1869 #define PORT_C_MASK \
1870 ((USB_PORT_STAT_C_CONNECTION \
1871 | USB_PORT_STAT_C_ENABLE \
1872 | USB_PORT_STAT_C_SUSPEND \
1873 | USB_PORT_STAT_C_OVERCURRENT \
1874 | USB_PORT_STAT_C_RESET) << 16)
1876 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1878 struct dummy_hcd *dum_hcd;
1879 unsigned long flags;
1880 int retval = 0;
1882 dum_hcd = hcd_to_dummy_hcd(hcd);
1884 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1885 if (!HCD_HW_ACCESSIBLE(hcd))
1886 goto done;
1888 if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
1889 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1890 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
1891 set_link_state(dum_hcd);
1894 if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
1895 *buf = (1 << 1);
1896 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
1897 dum_hcd->port_status);
1898 retval = 1;
1899 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
1900 usb_hcd_resume_root_hub(hcd);
1902 done:
1903 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1904 return retval;
1907 /* usb 3.0 root hub device descriptor */
1908 static struct {
1909 struct usb_bos_descriptor bos;
1910 struct usb_ss_cap_descriptor ss_cap;
1911 } __packed usb3_bos_desc = {
1913 .bos = {
1914 .bLength = USB_DT_BOS_SIZE,
1915 .bDescriptorType = USB_DT_BOS,
1916 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
1917 .bNumDeviceCaps = 1,
1919 .ss_cap = {
1920 .bLength = USB_DT_USB_SS_CAP_SIZE,
1921 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
1922 .bDevCapabilityType = USB_SS_CAP_TYPE,
1923 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
1924 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
1928 static inline void
1929 ss_hub_descriptor(struct usb_hub_descriptor *desc)
1931 memset(desc, 0, sizeof *desc);
1932 desc->bDescriptorType = 0x2a;
1933 desc->bDescLength = 12;
1934 desc->wHubCharacteristics = cpu_to_le16(0x0001);
1935 desc->bNbrPorts = 1;
1936 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
1937 desc->u.ss.DeviceRemovable = 0xffff;
1940 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
1942 memset(desc, 0, sizeof *desc);
1943 desc->bDescriptorType = 0x29;
1944 desc->bDescLength = 9;
1945 desc->wHubCharacteristics = cpu_to_le16(0x0001);
1946 desc->bNbrPorts = 1;
1947 desc->u.hs.DeviceRemovable[0] = 0xff;
1948 desc->u.hs.DeviceRemovable[1] = 0xff;
1951 static int dummy_hub_control(
1952 struct usb_hcd *hcd,
1953 u16 typeReq,
1954 u16 wValue,
1955 u16 wIndex,
1956 char *buf,
1957 u16 wLength
1959 struct dummy_hcd *dum_hcd;
1960 int retval = 0;
1961 unsigned long flags;
1963 if (!HCD_HW_ACCESSIBLE(hcd))
1964 return -ETIMEDOUT;
1966 dum_hcd = hcd_to_dummy_hcd(hcd);
1968 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1969 switch (typeReq) {
1970 case ClearHubFeature:
1971 break;
1972 case ClearPortFeature:
1973 switch (wValue) {
1974 case USB_PORT_FEAT_SUSPEND:
1975 if (hcd->speed == HCD_USB3) {
1976 dev_dbg(dummy_dev(dum_hcd),
1977 "USB_PORT_FEAT_SUSPEND req not "
1978 "supported for USB 3.0 roothub\n");
1979 goto error;
1981 if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
1982 /* 20msec resume signaling */
1983 dum_hcd->resuming = 1;
1984 dum_hcd->re_timeout = jiffies +
1985 msecs_to_jiffies(20);
1987 break;
1988 case USB_PORT_FEAT_POWER:
1989 if (hcd->speed == HCD_USB3) {
1990 if (dum_hcd->port_status & USB_PORT_STAT_POWER)
1991 dev_dbg(dummy_dev(dum_hcd),
1992 "power-off\n");
1993 } else
1994 if (dum_hcd->port_status &
1995 USB_SS_PORT_STAT_POWER)
1996 dev_dbg(dummy_dev(dum_hcd),
1997 "power-off\n");
1998 /* FALLS THROUGH */
1999 default:
2000 dum_hcd->port_status &= ~(1 << wValue);
2001 set_link_state(dum_hcd);
2003 break;
2004 case GetHubDescriptor:
2005 if (hcd->speed == HCD_USB3 &&
2006 (wLength < USB_DT_SS_HUB_SIZE ||
2007 wValue != (USB_DT_SS_HUB << 8))) {
2008 dev_dbg(dummy_dev(dum_hcd),
2009 "Wrong hub descriptor type for "
2010 "USB 3.0 roothub.\n");
2011 goto error;
2013 if (hcd->speed == HCD_USB3)
2014 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2015 else
2016 hub_descriptor((struct usb_hub_descriptor *) buf);
2017 break;
2019 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2020 if (hcd->speed != HCD_USB3)
2021 goto error;
2023 if ((wValue >> 8) != USB_DT_BOS)
2024 goto error;
2026 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2027 retval = sizeof(usb3_bos_desc);
2028 break;
2030 case GetHubStatus:
2031 *(__le32 *) buf = cpu_to_le32(0);
2032 break;
2033 case GetPortStatus:
2034 if (wIndex != 1)
2035 retval = -EPIPE;
2037 /* whoever resets or resumes must GetPortStatus to
2038 * complete it!!
2040 if (dum_hcd->resuming &&
2041 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2042 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2043 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2045 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2046 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2047 dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2048 dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2049 if (dum_hcd->dum->pullup) {
2050 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2052 if (hcd->speed < HCD_USB3) {
2053 switch (dum_hcd->dum->gadget.speed) {
2054 case USB_SPEED_HIGH:
2055 dum_hcd->port_status |=
2056 USB_PORT_STAT_HIGH_SPEED;
2057 break;
2058 case USB_SPEED_LOW:
2059 dum_hcd->dum->gadget.ep0->
2060 maxpacket = 8;
2061 dum_hcd->port_status |=
2062 USB_PORT_STAT_LOW_SPEED;
2063 break;
2064 default:
2065 dum_hcd->dum->gadget.speed =
2066 USB_SPEED_FULL;
2067 break;
2072 set_link_state(dum_hcd);
2073 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2074 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2075 break;
2076 case SetHubFeature:
2077 retval = -EPIPE;
2078 break;
2079 case SetPortFeature:
2080 switch (wValue) {
2081 case USB_PORT_FEAT_LINK_STATE:
2082 if (hcd->speed != HCD_USB3) {
2083 dev_dbg(dummy_dev(dum_hcd),
2084 "USB_PORT_FEAT_LINK_STATE req not "
2085 "supported for USB 2.0 roothub\n");
2086 goto error;
2089 * Since this is dummy we don't have an actual link so
2090 * there is nothing to do for the SET_LINK_STATE cmd
2092 break;
2093 case USB_PORT_FEAT_U1_TIMEOUT:
2094 case USB_PORT_FEAT_U2_TIMEOUT:
2095 /* TODO: add suspend/resume support! */
2096 if (hcd->speed != HCD_USB3) {
2097 dev_dbg(dummy_dev(dum_hcd),
2098 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2099 "supported for USB 2.0 roothub\n");
2100 goto error;
2102 break;
2103 case USB_PORT_FEAT_SUSPEND:
2104 /* Applicable only for USB2.0 hub */
2105 if (hcd->speed == HCD_USB3) {
2106 dev_dbg(dummy_dev(dum_hcd),
2107 "USB_PORT_FEAT_SUSPEND req not "
2108 "supported for USB 3.0 roothub\n");
2109 goto error;
2111 if (dum_hcd->active) {
2112 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2114 /* HNP would happen here; for now we
2115 * assume b_bus_req is always true.
2117 set_link_state(dum_hcd);
2118 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2119 & dum_hcd->dum->devstatus) != 0)
2120 dev_dbg(dummy_dev(dum_hcd),
2121 "no HNP yet!\n");
2123 break;
2124 case USB_PORT_FEAT_POWER:
2125 if (hcd->speed == HCD_USB3)
2126 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2127 else
2128 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2129 set_link_state(dum_hcd);
2130 break;
2131 case USB_PORT_FEAT_BH_PORT_RESET:
2132 /* Applicable only for USB3.0 hub */
2133 if (hcd->speed != HCD_USB3) {
2134 dev_dbg(dummy_dev(dum_hcd),
2135 "USB_PORT_FEAT_BH_PORT_RESET req not "
2136 "supported for USB 2.0 roothub\n");
2137 goto error;
2139 /* FALLS THROUGH */
2140 case USB_PORT_FEAT_RESET:
2141 /* if it's already enabled, disable */
2142 if (hcd->speed == HCD_USB3) {
2143 dum_hcd->port_status = 0;
2144 dum_hcd->port_status =
2145 (USB_SS_PORT_STAT_POWER |
2146 USB_PORT_STAT_CONNECTION |
2147 USB_PORT_STAT_RESET);
2148 } else
2149 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2150 | USB_PORT_STAT_LOW_SPEED
2151 | USB_PORT_STAT_HIGH_SPEED);
2153 * We want to reset device status. All but the
2154 * Self powered feature
2156 dum_hcd->dum->devstatus &=
2157 (1 << USB_DEVICE_SELF_POWERED);
2159 * FIXME USB3.0: what is the correct reset signaling
2160 * interval? Is it still 50msec as for HS?
2162 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2163 /* FALLS THROUGH */
2164 default:
2165 if (hcd->speed == HCD_USB3) {
2166 if ((dum_hcd->port_status &
2167 USB_SS_PORT_STAT_POWER) != 0) {
2168 dum_hcd->port_status |= (1 << wValue);
2169 set_link_state(dum_hcd);
2171 } else
2172 if ((dum_hcd->port_status &
2173 USB_PORT_STAT_POWER) != 0) {
2174 dum_hcd->port_status |= (1 << wValue);
2175 set_link_state(dum_hcd);
2178 break;
2179 case GetPortErrorCount:
2180 if (hcd->speed != HCD_USB3) {
2181 dev_dbg(dummy_dev(dum_hcd),
2182 "GetPortErrorCount req not "
2183 "supported for USB 2.0 roothub\n");
2184 goto error;
2186 /* We'll always return 0 since this is a dummy hub */
2187 *(__le32 *) buf = cpu_to_le32(0);
2188 break;
2189 case SetHubDepth:
2190 if (hcd->speed != HCD_USB3) {
2191 dev_dbg(dummy_dev(dum_hcd),
2192 "SetHubDepth req not supported for "
2193 "USB 2.0 roothub\n");
2194 goto error;
2196 break;
2197 default:
2198 dev_dbg(dummy_dev(dum_hcd),
2199 "hub control req%04x v%04x i%04x l%d\n",
2200 typeReq, wValue, wIndex, wLength);
2201 error:
2202 /* "protocol stall" on error */
2203 retval = -EPIPE;
2205 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2207 if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2208 usb_hcd_poll_rh_status(hcd);
2209 return retval;
2212 static int dummy_bus_suspend(struct usb_hcd *hcd)
2214 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2216 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2218 spin_lock_irq(&dum_hcd->dum->lock);
2219 dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2220 set_link_state(dum_hcd);
2221 hcd->state = HC_STATE_SUSPENDED;
2222 spin_unlock_irq(&dum_hcd->dum->lock);
2223 return 0;
2226 static int dummy_bus_resume(struct usb_hcd *hcd)
2228 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2229 int rc = 0;
2231 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2233 spin_lock_irq(&dum_hcd->dum->lock);
2234 if (!HCD_HW_ACCESSIBLE(hcd)) {
2235 rc = -ESHUTDOWN;
2236 } else {
2237 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2238 set_link_state(dum_hcd);
2239 if (!list_empty(&dum_hcd->urbp_list))
2240 mod_timer(&dum_hcd->timer, jiffies);
2241 hcd->state = HC_STATE_RUNNING;
2243 spin_unlock_irq(&dum_hcd->dum->lock);
2244 return rc;
2247 /*-------------------------------------------------------------------------*/
2249 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2251 int ep = usb_pipeendpoint(urb->pipe);
2253 return snprintf(buf, size,
2254 "urb/%p %s ep%d%s%s len %d/%d\n",
2255 urb,
2256 ({ char *s;
2257 switch (urb->dev->speed) {
2258 case USB_SPEED_LOW:
2259 s = "ls";
2260 break;
2261 case USB_SPEED_FULL:
2262 s = "fs";
2263 break;
2264 case USB_SPEED_HIGH:
2265 s = "hs";
2266 break;
2267 case USB_SPEED_SUPER:
2268 s = "ss";
2269 break;
2270 default:
2271 s = "?";
2272 break;
2273 }; s; }),
2274 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2275 ({ char *s; \
2276 switch (usb_pipetype(urb->pipe)) { \
2277 case PIPE_CONTROL: \
2278 s = ""; \
2279 break; \
2280 case PIPE_BULK: \
2281 s = "-bulk"; \
2282 break; \
2283 case PIPE_INTERRUPT: \
2284 s = "-int"; \
2285 break; \
2286 default: \
2287 s = "-iso"; \
2288 break; \
2289 }; s; }),
2290 urb->actual_length, urb->transfer_buffer_length);
2293 static ssize_t show_urbs(struct device *dev, struct device_attribute *attr,
2294 char *buf)
2296 struct usb_hcd *hcd = dev_get_drvdata(dev);
2297 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2298 struct urbp *urbp;
2299 size_t size = 0;
2300 unsigned long flags;
2302 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2303 list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2304 size_t temp;
2306 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2307 buf += temp;
2308 size += temp;
2310 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2312 return size;
2314 static DEVICE_ATTR(urbs, S_IRUGO, show_urbs, NULL);
2316 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2318 init_timer(&dum_hcd->timer);
2319 dum_hcd->timer.function = dummy_timer;
2320 dum_hcd->timer.data = (unsigned long)dum_hcd;
2321 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2322 dum_hcd->stream_en_ep = 0;
2323 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2324 dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET;
2325 dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2326 dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2327 #ifdef CONFIG_USB_OTG
2328 dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2329 #endif
2330 return 0;
2332 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2333 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2336 static int dummy_start(struct usb_hcd *hcd)
2338 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2341 * MASTER side init ... we emulate a root hub that'll only ever
2342 * talk to one device (the slave side). Also appears in sysfs,
2343 * just like more familiar pci-based HCDs.
2345 if (!usb_hcd_is_primary_hcd(hcd))
2346 return dummy_start_ss(dum_hcd);
2348 spin_lock_init(&dum_hcd->dum->lock);
2349 init_timer(&dum_hcd->timer);
2350 dum_hcd->timer.function = dummy_timer;
2351 dum_hcd->timer.data = (unsigned long)dum_hcd;
2352 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2354 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2356 hcd->power_budget = POWER_BUDGET;
2357 hcd->state = HC_STATE_RUNNING;
2358 hcd->uses_new_polling = 1;
2360 #ifdef CONFIG_USB_OTG
2361 hcd->self.otg_port = 1;
2362 #endif
2364 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2365 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2368 static void dummy_stop(struct usb_hcd *hcd)
2370 struct dummy *dum;
2372 dum = hcd_to_dummy_hcd(hcd)->dum;
2373 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2374 usb_gadget_unregister_driver(dum->driver);
2375 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2378 /*-------------------------------------------------------------------------*/
2380 static int dummy_h_get_frame(struct usb_hcd *hcd)
2382 return dummy_g_get_frame(NULL);
2385 static int dummy_setup(struct usb_hcd *hcd)
2387 struct dummy *dum;
2389 dum = *((void **)dev_get_platdata(hcd->self.controller));
2390 hcd->self.sg_tablesize = ~0;
2391 if (usb_hcd_is_primary_hcd(hcd)) {
2392 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2393 dum->hs_hcd->dum = dum;
2395 * Mark the first roothub as being USB 2.0.
2396 * The USB 3.0 roothub will be registered later by
2397 * dummy_hcd_probe()
2399 hcd->speed = HCD_USB2;
2400 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2401 } else {
2402 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2403 dum->ss_hcd->dum = dum;
2404 hcd->speed = HCD_USB3;
2405 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2407 return 0;
2410 /* Change a group of bulk endpoints to support multiple stream IDs */
2411 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2412 struct usb_host_endpoint **eps, unsigned int num_eps,
2413 unsigned int num_streams, gfp_t mem_flags)
2415 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2416 unsigned long flags;
2417 int max_stream;
2418 int ret_streams = num_streams;
2419 unsigned int index;
2420 unsigned int i;
2422 if (!num_eps)
2423 return -EINVAL;
2425 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2426 for (i = 0; i < num_eps; i++) {
2427 index = dummy_get_ep_idx(&eps[i]->desc);
2428 if ((1 << index) & dum_hcd->stream_en_ep) {
2429 ret_streams = -EINVAL;
2430 goto out;
2432 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2433 if (!max_stream) {
2434 ret_streams = -EINVAL;
2435 goto out;
2437 if (max_stream < ret_streams) {
2438 dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2439 "stream IDs.\n",
2440 eps[i]->desc.bEndpointAddress,
2441 max_stream);
2442 ret_streams = max_stream;
2446 for (i = 0; i < num_eps; i++) {
2447 index = dummy_get_ep_idx(&eps[i]->desc);
2448 dum_hcd->stream_en_ep |= 1 << index;
2449 set_max_streams_for_pipe(dum_hcd,
2450 usb_endpoint_num(&eps[i]->desc), ret_streams);
2452 out:
2453 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2454 return ret_streams;
2457 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2458 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2459 struct usb_host_endpoint **eps, unsigned int num_eps,
2460 gfp_t mem_flags)
2462 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2463 unsigned long flags;
2464 int ret;
2465 unsigned int index;
2466 unsigned int i;
2468 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2469 for (i = 0; i < num_eps; i++) {
2470 index = dummy_get_ep_idx(&eps[i]->desc);
2471 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2472 ret = -EINVAL;
2473 goto out;
2477 for (i = 0; i < num_eps; i++) {
2478 index = dummy_get_ep_idx(&eps[i]->desc);
2479 dum_hcd->stream_en_ep &= ~(1 << index);
2480 set_max_streams_for_pipe(dum_hcd,
2481 usb_endpoint_num(&eps[i]->desc), 0);
2483 ret = 0;
2484 out:
2485 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2486 return ret;
2489 static struct hc_driver dummy_hcd = {
2490 .description = (char *) driver_name,
2491 .product_desc = "Dummy host controller",
2492 .hcd_priv_size = sizeof(struct dummy_hcd),
2494 .flags = HCD_USB3 | HCD_SHARED,
2496 .reset = dummy_setup,
2497 .start = dummy_start,
2498 .stop = dummy_stop,
2500 .urb_enqueue = dummy_urb_enqueue,
2501 .urb_dequeue = dummy_urb_dequeue,
2503 .get_frame_number = dummy_h_get_frame,
2505 .hub_status_data = dummy_hub_status,
2506 .hub_control = dummy_hub_control,
2507 .bus_suspend = dummy_bus_suspend,
2508 .bus_resume = dummy_bus_resume,
2510 .alloc_streams = dummy_alloc_streams,
2511 .free_streams = dummy_free_streams,
2514 static int dummy_hcd_probe(struct platform_device *pdev)
2516 struct dummy *dum;
2517 struct usb_hcd *hs_hcd;
2518 struct usb_hcd *ss_hcd;
2519 int retval;
2521 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2522 dum = *((void **)dev_get_platdata(&pdev->dev));
2524 if (!mod_data.is_super_speed)
2525 dummy_hcd.flags = HCD_USB2;
2526 hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2527 if (!hs_hcd)
2528 return -ENOMEM;
2529 hs_hcd->has_tt = 1;
2531 retval = usb_add_hcd(hs_hcd, 0, 0);
2532 if (retval)
2533 goto put_usb2_hcd;
2535 if (mod_data.is_super_speed) {
2536 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2537 dev_name(&pdev->dev), hs_hcd);
2538 if (!ss_hcd) {
2539 retval = -ENOMEM;
2540 goto dealloc_usb2_hcd;
2543 retval = usb_add_hcd(ss_hcd, 0, 0);
2544 if (retval)
2545 goto put_usb3_hcd;
2547 return 0;
2549 put_usb3_hcd:
2550 usb_put_hcd(ss_hcd);
2551 dealloc_usb2_hcd:
2552 usb_remove_hcd(hs_hcd);
2553 put_usb2_hcd:
2554 usb_put_hcd(hs_hcd);
2555 dum->hs_hcd = dum->ss_hcd = NULL;
2556 return retval;
2559 static int dummy_hcd_remove(struct platform_device *pdev)
2561 struct dummy *dum;
2563 dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2565 if (dum->ss_hcd) {
2566 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2567 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2570 usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2571 usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2573 dum->hs_hcd = NULL;
2574 dum->ss_hcd = NULL;
2576 return 0;
2579 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2581 struct usb_hcd *hcd;
2582 struct dummy_hcd *dum_hcd;
2583 int rc = 0;
2585 dev_dbg(&pdev->dev, "%s\n", __func__);
2587 hcd = platform_get_drvdata(pdev);
2588 dum_hcd = hcd_to_dummy_hcd(hcd);
2589 if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2590 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2591 rc = -EBUSY;
2592 } else
2593 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2594 return rc;
2597 static int dummy_hcd_resume(struct platform_device *pdev)
2599 struct usb_hcd *hcd;
2601 dev_dbg(&pdev->dev, "%s\n", __func__);
2603 hcd = platform_get_drvdata(pdev);
2604 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2605 usb_hcd_poll_rh_status(hcd);
2606 return 0;
2609 static struct platform_driver dummy_hcd_driver = {
2610 .probe = dummy_hcd_probe,
2611 .remove = dummy_hcd_remove,
2612 .suspend = dummy_hcd_suspend,
2613 .resume = dummy_hcd_resume,
2614 .driver = {
2615 .name = (char *) driver_name,
2616 .owner = THIS_MODULE,
2620 /*-------------------------------------------------------------------------*/
2621 #define MAX_NUM_UDC 2
2622 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2623 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2625 static int __init init(void)
2627 int retval = -ENOMEM;
2628 int i;
2629 struct dummy *dum[MAX_NUM_UDC];
2631 if (usb_disabled())
2632 return -ENODEV;
2634 if (!mod_data.is_high_speed && mod_data.is_super_speed)
2635 return -EINVAL;
2637 if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2638 pr_err("Number of emulated UDC must be in range of 1…%d\n",
2639 MAX_NUM_UDC);
2640 return -EINVAL;
2643 for (i = 0; i < mod_data.num; i++) {
2644 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2645 if (!the_hcd_pdev[i]) {
2646 i--;
2647 while (i >= 0)
2648 platform_device_put(the_hcd_pdev[i--]);
2649 return retval;
2652 for (i = 0; i < mod_data.num; i++) {
2653 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2654 if (!the_udc_pdev[i]) {
2655 i--;
2656 while (i >= 0)
2657 platform_device_put(the_udc_pdev[i--]);
2658 goto err_alloc_udc;
2661 for (i = 0; i < mod_data.num; i++) {
2662 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2663 if (!dum[i]) {
2664 retval = -ENOMEM;
2665 goto err_add_pdata;
2667 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2668 sizeof(void *));
2669 if (retval)
2670 goto err_add_pdata;
2671 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2672 sizeof(void *));
2673 if (retval)
2674 goto err_add_pdata;
2677 retval = platform_driver_register(&dummy_hcd_driver);
2678 if (retval < 0)
2679 goto err_add_pdata;
2680 retval = platform_driver_register(&dummy_udc_driver);
2681 if (retval < 0)
2682 goto err_register_udc_driver;
2684 for (i = 0; i < mod_data.num; i++) {
2685 retval = platform_device_add(the_hcd_pdev[i]);
2686 if (retval < 0) {
2687 i--;
2688 while (i >= 0)
2689 platform_device_del(the_hcd_pdev[i--]);
2690 goto err_add_hcd;
2693 for (i = 0; i < mod_data.num; i++) {
2694 if (!dum[i]->hs_hcd ||
2695 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2697 * The hcd was added successfully but its probe
2698 * function failed for some reason.
2700 retval = -EINVAL;
2701 goto err_add_udc;
2705 for (i = 0; i < mod_data.num; i++) {
2706 retval = platform_device_add(the_udc_pdev[i]);
2707 if (retval < 0) {
2708 i--;
2709 while (i >= 0)
2710 platform_device_del(the_udc_pdev[i]);
2711 goto err_add_udc;
2715 for (i = 0; i < mod_data.num; i++) {
2716 if (!platform_get_drvdata(the_udc_pdev[i])) {
2718 * The udc was added successfully but its probe
2719 * function failed for some reason.
2721 retval = -EINVAL;
2722 goto err_probe_udc;
2725 return retval;
2727 err_probe_udc:
2728 for (i = 0; i < mod_data.num; i++)
2729 platform_device_del(the_udc_pdev[i]);
2730 err_add_udc:
2731 for (i = 0; i < mod_data.num; i++)
2732 platform_device_del(the_hcd_pdev[i]);
2733 err_add_hcd:
2734 platform_driver_unregister(&dummy_udc_driver);
2735 err_register_udc_driver:
2736 platform_driver_unregister(&dummy_hcd_driver);
2737 err_add_pdata:
2738 for (i = 0; i < mod_data.num; i++)
2739 kfree(dum[i]);
2740 for (i = 0; i < mod_data.num; i++)
2741 platform_device_put(the_udc_pdev[i]);
2742 err_alloc_udc:
2743 for (i = 0; i < mod_data.num; i++)
2744 platform_device_put(the_hcd_pdev[i]);
2745 return retval;
2747 module_init(init);
2749 static void __exit cleanup(void)
2751 int i;
2753 for (i = 0; i < mod_data.num; i++) {
2754 struct dummy *dum;
2756 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2758 platform_device_unregister(the_udc_pdev[i]);
2759 platform_device_unregister(the_hcd_pdev[i]);
2760 kfree(dum);
2762 platform_driver_unregister(&dummy_udc_driver);
2763 platform_driver_unregister(&dummy_hcd_driver);
2765 module_exit(cleanup);