Linux 4.2.1
[linux/fpc-iii.git] / drivers / usb / gadget / udc / dummy_hcd.c
blob181112c88f430d39985c199312b2043337c02cf6
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 usb_gadget_giveback_request(&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 /* Currently !connected or in reset */
371 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0 ||
372 (dum_hcd->port_status & USB_PORT_STAT_RESET) != 0) {
373 unsigned disconnect = USB_PORT_STAT_CONNECTION &
374 dum_hcd->old_status & (~dum_hcd->port_status);
375 unsigned reset = USB_PORT_STAT_RESET &
376 (~dum_hcd->old_status) & dum_hcd->port_status;
378 /* Report reset and disconnect events to the driver */
379 if (dum->driver && (disconnect || reset)) {
380 stop_activity(dum);
381 spin_unlock(&dum->lock);
382 if (reset)
383 usb_gadget_udc_reset(&dum->gadget, dum->driver);
384 else
385 dum->driver->disconnect(&dum->gadget);
386 spin_lock(&dum->lock);
388 } else if (dum_hcd->active != dum_hcd->old_active) {
389 if (dum_hcd->old_active && dum->driver->suspend) {
390 spin_unlock(&dum->lock);
391 dum->driver->suspend(&dum->gadget);
392 spin_lock(&dum->lock);
393 } else if (!dum_hcd->old_active && dum->driver->resume) {
394 spin_unlock(&dum->lock);
395 dum->driver->resume(&dum->gadget);
396 spin_lock(&dum->lock);
400 dum_hcd->old_status = dum_hcd->port_status;
401 dum_hcd->old_active = dum_hcd->active;
404 /*-------------------------------------------------------------------------*/
406 /* SLAVE/GADGET SIDE DRIVER
408 * This only tracks gadget state. All the work is done when the host
409 * side tries some (emulated) i/o operation. Real device controller
410 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
413 #define is_enabled(dum) \
414 (dum->port_status & USB_PORT_STAT_ENABLE)
416 static int dummy_enable(struct usb_ep *_ep,
417 const struct usb_endpoint_descriptor *desc)
419 struct dummy *dum;
420 struct dummy_hcd *dum_hcd;
421 struct dummy_ep *ep;
422 unsigned max;
423 int retval;
425 ep = usb_ep_to_dummy_ep(_ep);
426 if (!_ep || !desc || ep->desc || _ep->name == ep0name
427 || desc->bDescriptorType != USB_DT_ENDPOINT)
428 return -EINVAL;
429 dum = ep_to_dummy(ep);
430 if (!dum->driver)
431 return -ESHUTDOWN;
433 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
434 if (!is_enabled(dum_hcd))
435 return -ESHUTDOWN;
438 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
439 * maximum packet size.
440 * For SS devices the wMaxPacketSize is limited by 1024.
442 max = usb_endpoint_maxp(desc) & 0x7ff;
444 /* drivers must not request bad settings, since lower levels
445 * (hardware or its drivers) may not check. some endpoints
446 * can't do iso, many have maxpacket limitations, etc.
448 * since this "hardware" driver is here to help debugging, we
449 * have some extra sanity checks. (there could be more though,
450 * especially for "ep9out" style fixed function ones.)
452 retval = -EINVAL;
453 switch (usb_endpoint_type(desc)) {
454 case USB_ENDPOINT_XFER_BULK:
455 if (strstr(ep->ep.name, "-iso")
456 || strstr(ep->ep.name, "-int")) {
457 goto done;
459 switch (dum->gadget.speed) {
460 case USB_SPEED_SUPER:
461 if (max == 1024)
462 break;
463 goto done;
464 case USB_SPEED_HIGH:
465 if (max == 512)
466 break;
467 goto done;
468 case USB_SPEED_FULL:
469 if (max == 8 || max == 16 || max == 32 || max == 64)
470 /* we'll fake any legal size */
471 break;
472 /* save a return statement */
473 default:
474 goto done;
476 break;
477 case USB_ENDPOINT_XFER_INT:
478 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
479 goto done;
480 /* real hardware might not handle all packet sizes */
481 switch (dum->gadget.speed) {
482 case USB_SPEED_SUPER:
483 case USB_SPEED_HIGH:
484 if (max <= 1024)
485 break;
486 /* save a return statement */
487 case USB_SPEED_FULL:
488 if (max <= 64)
489 break;
490 /* save a return statement */
491 default:
492 if (max <= 8)
493 break;
494 goto done;
496 break;
497 case USB_ENDPOINT_XFER_ISOC:
498 if (strstr(ep->ep.name, "-bulk")
499 || strstr(ep->ep.name, "-int"))
500 goto done;
501 /* real hardware might not handle all packet sizes */
502 switch (dum->gadget.speed) {
503 case USB_SPEED_SUPER:
504 case USB_SPEED_HIGH:
505 if (max <= 1024)
506 break;
507 /* save a return statement */
508 case USB_SPEED_FULL:
509 if (max <= 1023)
510 break;
511 /* save a return statement */
512 default:
513 goto done;
515 break;
516 default:
517 /* few chips support control except on ep0 */
518 goto done;
521 _ep->maxpacket = max;
522 if (usb_ss_max_streams(_ep->comp_desc)) {
523 if (!usb_endpoint_xfer_bulk(desc)) {
524 dev_err(udc_dev(dum), "Can't enable stream support on "
525 "non-bulk ep %s\n", _ep->name);
526 return -EINVAL;
528 ep->stream_en = 1;
530 ep->desc = desc;
532 dev_dbg(udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
533 _ep->name,
534 desc->bEndpointAddress & 0x0f,
535 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
536 ({ char *val;
537 switch (usb_endpoint_type(desc)) {
538 case USB_ENDPOINT_XFER_BULK:
539 val = "bulk";
540 break;
541 case USB_ENDPOINT_XFER_ISOC:
542 val = "iso";
543 break;
544 case USB_ENDPOINT_XFER_INT:
545 val = "intr";
546 break;
547 default:
548 val = "ctrl";
549 break;
550 } val; }),
551 max, ep->stream_en ? "enabled" : "disabled");
553 /* at this point real hardware should be NAKing transfers
554 * to that endpoint, until a buffer is queued to it.
556 ep->halted = ep->wedged = 0;
557 retval = 0;
558 done:
559 return retval;
562 static int dummy_disable(struct usb_ep *_ep)
564 struct dummy_ep *ep;
565 struct dummy *dum;
566 unsigned long flags;
568 ep = usb_ep_to_dummy_ep(_ep);
569 if (!_ep || !ep->desc || _ep->name == ep0name)
570 return -EINVAL;
571 dum = ep_to_dummy(ep);
573 spin_lock_irqsave(&dum->lock, flags);
574 ep->desc = NULL;
575 ep->stream_en = 0;
576 nuke(dum, ep);
577 spin_unlock_irqrestore(&dum->lock, flags);
579 dev_dbg(udc_dev(dum), "disabled %s\n", _ep->name);
580 return 0;
583 static struct usb_request *dummy_alloc_request(struct usb_ep *_ep,
584 gfp_t mem_flags)
586 struct dummy_ep *ep;
587 struct dummy_request *req;
589 if (!_ep)
590 return NULL;
591 ep = usb_ep_to_dummy_ep(_ep);
593 req = kzalloc(sizeof(*req), mem_flags);
594 if (!req)
595 return NULL;
596 INIT_LIST_HEAD(&req->queue);
597 return &req->req;
600 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
602 struct dummy_request *req;
604 if (!_ep || !_req) {
605 WARN_ON(1);
606 return;
609 req = usb_request_to_dummy_request(_req);
610 WARN_ON(!list_empty(&req->queue));
611 kfree(req);
614 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
618 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
619 gfp_t mem_flags)
621 struct dummy_ep *ep;
622 struct dummy_request *req;
623 struct dummy *dum;
624 struct dummy_hcd *dum_hcd;
625 unsigned long flags;
627 req = usb_request_to_dummy_request(_req);
628 if (!_req || !list_empty(&req->queue) || !_req->complete)
629 return -EINVAL;
631 ep = usb_ep_to_dummy_ep(_ep);
632 if (!_ep || (!ep->desc && _ep->name != ep0name))
633 return -EINVAL;
635 dum = ep_to_dummy(ep);
636 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
637 if (!dum->driver || !is_enabled(dum_hcd))
638 return -ESHUTDOWN;
640 #if 0
641 dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
642 ep, _req, _ep->name, _req->length, _req->buf);
643 #endif
644 _req->status = -EINPROGRESS;
645 _req->actual = 0;
646 spin_lock_irqsave(&dum->lock, flags);
648 /* implement an emulated single-request FIFO */
649 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
650 list_empty(&dum->fifo_req.queue) &&
651 list_empty(&ep->queue) &&
652 _req->length <= FIFO_SIZE) {
653 req = &dum->fifo_req;
654 req->req = *_req;
655 req->req.buf = dum->fifo_buf;
656 memcpy(dum->fifo_buf, _req->buf, _req->length);
657 req->req.context = dum;
658 req->req.complete = fifo_complete;
660 list_add_tail(&req->queue, &ep->queue);
661 spin_unlock(&dum->lock);
662 _req->actual = _req->length;
663 _req->status = 0;
664 usb_gadget_giveback_request(_ep, _req);
665 spin_lock(&dum->lock);
666 } else
667 list_add_tail(&req->queue, &ep->queue);
668 spin_unlock_irqrestore(&dum->lock, flags);
670 /* real hardware would likely enable transfers here, in case
671 * it'd been left NAKing.
673 return 0;
676 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
678 struct dummy_ep *ep;
679 struct dummy *dum;
680 int retval = -EINVAL;
681 unsigned long flags;
682 struct dummy_request *req = NULL;
684 if (!_ep || !_req)
685 return retval;
686 ep = usb_ep_to_dummy_ep(_ep);
687 dum = ep_to_dummy(ep);
689 if (!dum->driver)
690 return -ESHUTDOWN;
692 local_irq_save(flags);
693 spin_lock(&dum->lock);
694 list_for_each_entry(req, &ep->queue, queue) {
695 if (&req->req == _req) {
696 list_del_init(&req->queue);
697 _req->status = -ECONNRESET;
698 retval = 0;
699 break;
702 spin_unlock(&dum->lock);
704 if (retval == 0) {
705 dev_dbg(udc_dev(dum),
706 "dequeued req %p from %s, len %d buf %p\n",
707 req, _ep->name, _req->length, _req->buf);
708 usb_gadget_giveback_request(_ep, _req);
710 local_irq_restore(flags);
711 return retval;
714 static int
715 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
717 struct dummy_ep *ep;
718 struct dummy *dum;
720 if (!_ep)
721 return -EINVAL;
722 ep = usb_ep_to_dummy_ep(_ep);
723 dum = ep_to_dummy(ep);
724 if (!dum->driver)
725 return -ESHUTDOWN;
726 if (!value)
727 ep->halted = ep->wedged = 0;
728 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
729 !list_empty(&ep->queue))
730 return -EAGAIN;
731 else {
732 ep->halted = 1;
733 if (wedged)
734 ep->wedged = 1;
736 /* FIXME clear emulated data toggle too */
737 return 0;
740 static int
741 dummy_set_halt(struct usb_ep *_ep, int value)
743 return dummy_set_halt_and_wedge(_ep, value, 0);
746 static int dummy_set_wedge(struct usb_ep *_ep)
748 if (!_ep || _ep->name == ep0name)
749 return -EINVAL;
750 return dummy_set_halt_and_wedge(_ep, 1, 1);
753 static const struct usb_ep_ops dummy_ep_ops = {
754 .enable = dummy_enable,
755 .disable = dummy_disable,
757 .alloc_request = dummy_alloc_request,
758 .free_request = dummy_free_request,
760 .queue = dummy_queue,
761 .dequeue = dummy_dequeue,
763 .set_halt = dummy_set_halt,
764 .set_wedge = dummy_set_wedge,
767 /*-------------------------------------------------------------------------*/
769 /* there are both host and device side versions of this call ... */
770 static int dummy_g_get_frame(struct usb_gadget *_gadget)
772 struct timeval tv;
774 do_gettimeofday(&tv);
775 return tv.tv_usec / 1000;
778 static int dummy_wakeup(struct usb_gadget *_gadget)
780 struct dummy_hcd *dum_hcd;
782 dum_hcd = gadget_to_dummy_hcd(_gadget);
783 if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
784 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
785 return -EINVAL;
786 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
787 return -ENOLINK;
788 if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
789 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
790 return -EIO;
792 /* FIXME: What if the root hub is suspended but the port isn't? */
794 /* hub notices our request, issues downstream resume, etc */
795 dum_hcd->resuming = 1;
796 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
797 mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
798 return 0;
801 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
803 struct dummy *dum;
805 _gadget->is_selfpowered = (value != 0);
806 dum = gadget_to_dummy_hcd(_gadget)->dum;
807 if (value)
808 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
809 else
810 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
811 return 0;
814 static void dummy_udc_update_ep0(struct dummy *dum)
816 if (dum->gadget.speed == USB_SPEED_SUPER)
817 dum->ep[0].ep.maxpacket = 9;
818 else
819 dum->ep[0].ep.maxpacket = 64;
822 static int dummy_pullup(struct usb_gadget *_gadget, int value)
824 struct dummy_hcd *dum_hcd;
825 struct dummy *dum;
826 unsigned long flags;
828 dum = gadget_dev_to_dummy(&_gadget->dev);
830 if (value && dum->driver) {
831 if (mod_data.is_super_speed)
832 dum->gadget.speed = dum->driver->max_speed;
833 else if (mod_data.is_high_speed)
834 dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
835 dum->driver->max_speed);
836 else
837 dum->gadget.speed = USB_SPEED_FULL;
838 dummy_udc_update_ep0(dum);
840 if (dum->gadget.speed < dum->driver->max_speed)
841 dev_dbg(udc_dev(dum), "This device can perform faster"
842 " if you connect it to a %s port...\n",
843 usb_speed_string(dum->driver->max_speed));
845 dum_hcd = gadget_to_dummy_hcd(_gadget);
847 spin_lock_irqsave(&dum->lock, flags);
848 dum->pullup = (value != 0);
849 set_link_state(dum_hcd);
850 spin_unlock_irqrestore(&dum->lock, flags);
852 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
853 return 0;
856 static int dummy_udc_start(struct usb_gadget *g,
857 struct usb_gadget_driver *driver);
858 static int dummy_udc_stop(struct usb_gadget *g);
860 static const struct usb_gadget_ops dummy_ops = {
861 .get_frame = dummy_g_get_frame,
862 .wakeup = dummy_wakeup,
863 .set_selfpowered = dummy_set_selfpowered,
864 .pullup = dummy_pullup,
865 .udc_start = dummy_udc_start,
866 .udc_stop = dummy_udc_stop,
869 /*-------------------------------------------------------------------------*/
871 /* "function" sysfs attribute */
872 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
873 char *buf)
875 struct dummy *dum = gadget_dev_to_dummy(dev);
877 if (!dum->driver || !dum->driver->function)
878 return 0;
879 return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
881 static DEVICE_ATTR_RO(function);
883 /*-------------------------------------------------------------------------*/
886 * Driver registration/unregistration.
888 * This is basically hardware-specific; there's usually only one real USB
889 * device (not host) controller since that's how USB devices are intended
890 * to work. So most implementations of these api calls will rely on the
891 * fact that only one driver will ever bind to the hardware. But curious
892 * hardware can be built with discrete components, so the gadget API doesn't
893 * require that assumption.
895 * For this emulator, it might be convenient to create a usb slave device
896 * for each driver that registers: just add to a big root hub.
899 static int dummy_udc_start(struct usb_gadget *g,
900 struct usb_gadget_driver *driver)
902 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
903 struct dummy *dum = dum_hcd->dum;
905 if (driver->max_speed == USB_SPEED_UNKNOWN)
906 return -EINVAL;
909 * SLAVE side init ... the layer above hardware, which
910 * can't enumerate without help from the driver we're binding.
913 dum->devstatus = 0;
914 dum->driver = driver;
916 return 0;
919 static int dummy_udc_stop(struct usb_gadget *g)
921 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
922 struct dummy *dum = dum_hcd->dum;
924 dum->driver = NULL;
926 return 0;
929 #undef is_enabled
931 /* The gadget structure is stored inside the hcd structure and will be
932 * released along with it. */
933 static void init_dummy_udc_hw(struct dummy *dum)
935 int i;
937 INIT_LIST_HEAD(&dum->gadget.ep_list);
938 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
939 struct dummy_ep *ep = &dum->ep[i];
941 if (!ep_name[i])
942 break;
943 ep->ep.name = ep_name[i];
944 ep->ep.ops = &dummy_ep_ops;
945 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
946 ep->halted = ep->wedged = ep->already_seen =
947 ep->setup_stage = 0;
948 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
949 ep->ep.max_streams = 16;
950 ep->last_io = jiffies;
951 ep->gadget = &dum->gadget;
952 ep->desc = NULL;
953 INIT_LIST_HEAD(&ep->queue);
956 dum->gadget.ep0 = &dum->ep[0].ep;
957 list_del_init(&dum->ep[0].ep.ep_list);
958 INIT_LIST_HEAD(&dum->fifo_req.queue);
960 #ifdef CONFIG_USB_OTG
961 dum->gadget.is_otg = 1;
962 #endif
965 static int dummy_udc_probe(struct platform_device *pdev)
967 struct dummy *dum;
968 int rc;
970 dum = *((void **)dev_get_platdata(&pdev->dev));
971 dum->gadget.name = gadget_name;
972 dum->gadget.ops = &dummy_ops;
973 dum->gadget.max_speed = USB_SPEED_SUPER;
975 dum->gadget.dev.parent = &pdev->dev;
976 init_dummy_udc_hw(dum);
978 rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
979 if (rc < 0)
980 goto err_udc;
982 rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
983 if (rc < 0)
984 goto err_dev;
985 platform_set_drvdata(pdev, dum);
986 return rc;
988 err_dev:
989 usb_del_gadget_udc(&dum->gadget);
990 err_udc:
991 return rc;
994 static int dummy_udc_remove(struct platform_device *pdev)
996 struct dummy *dum = platform_get_drvdata(pdev);
998 device_remove_file(&dum->gadget.dev, &dev_attr_function);
999 usb_del_gadget_udc(&dum->gadget);
1000 return 0;
1003 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1004 int suspend)
1006 spin_lock_irq(&dum->lock);
1007 dum->udc_suspended = suspend;
1008 set_link_state(dum_hcd);
1009 spin_unlock_irq(&dum->lock);
1012 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1014 struct dummy *dum = platform_get_drvdata(pdev);
1015 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1017 dev_dbg(&pdev->dev, "%s\n", __func__);
1018 dummy_udc_pm(dum, dum_hcd, 1);
1019 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1020 return 0;
1023 static int dummy_udc_resume(struct platform_device *pdev)
1025 struct dummy *dum = platform_get_drvdata(pdev);
1026 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1028 dev_dbg(&pdev->dev, "%s\n", __func__);
1029 dummy_udc_pm(dum, dum_hcd, 0);
1030 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1031 return 0;
1034 static struct platform_driver dummy_udc_driver = {
1035 .probe = dummy_udc_probe,
1036 .remove = dummy_udc_remove,
1037 .suspend = dummy_udc_suspend,
1038 .resume = dummy_udc_resume,
1039 .driver = {
1040 .name = (char *) gadget_name,
1044 /*-------------------------------------------------------------------------*/
1046 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1048 unsigned int index;
1050 index = usb_endpoint_num(desc) << 1;
1051 if (usb_endpoint_dir_in(desc))
1052 index |= 1;
1053 return index;
1056 /* MASTER/HOST SIDE DRIVER
1058 * this uses the hcd framework to hook up to host side drivers.
1059 * its root hub will only have one device, otherwise it acts like
1060 * a normal host controller.
1062 * when urbs are queued, they're just stuck on a list that we
1063 * scan in a timer callback. that callback connects writes from
1064 * the host with reads from the device, and so on, based on the
1065 * usb 2.0 rules.
1068 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1070 const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1071 u32 index;
1073 if (!usb_endpoint_xfer_bulk(desc))
1074 return 0;
1076 index = dummy_get_ep_idx(desc);
1077 return (1 << index) & dum_hcd->stream_en_ep;
1081 * The max stream number is saved as a nibble so for the 30 possible endpoints
1082 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1083 * means we use only 1 stream). The maximum according to the spec is 16bit so
1084 * if the 16 stream limit is about to go, the array size should be incremented
1085 * to 30 elements of type u16.
1087 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1088 unsigned int pipe)
1090 int max_streams;
1092 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1093 if (usb_pipeout(pipe))
1094 max_streams >>= 4;
1095 else
1096 max_streams &= 0xf;
1097 max_streams++;
1098 return max_streams;
1101 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1102 unsigned int pipe, unsigned int streams)
1104 int max_streams;
1106 streams--;
1107 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1108 if (usb_pipeout(pipe)) {
1109 streams <<= 4;
1110 max_streams &= 0xf;
1111 } else {
1112 max_streams &= 0xf0;
1114 max_streams |= streams;
1115 dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1118 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1120 unsigned int max_streams;
1121 int enabled;
1123 enabled = dummy_ep_stream_en(dum_hcd, urb);
1124 if (!urb->stream_id) {
1125 if (enabled)
1126 return -EINVAL;
1127 return 0;
1129 if (!enabled)
1130 return -EINVAL;
1132 max_streams = get_max_streams_for_pipe(dum_hcd,
1133 usb_pipeendpoint(urb->pipe));
1134 if (urb->stream_id > max_streams) {
1135 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1136 urb->stream_id);
1137 BUG();
1138 return -EINVAL;
1140 return 0;
1143 static int dummy_urb_enqueue(
1144 struct usb_hcd *hcd,
1145 struct urb *urb,
1146 gfp_t mem_flags
1148 struct dummy_hcd *dum_hcd;
1149 struct urbp *urbp;
1150 unsigned long flags;
1151 int rc;
1153 urbp = kmalloc(sizeof *urbp, mem_flags);
1154 if (!urbp)
1155 return -ENOMEM;
1156 urbp->urb = urb;
1157 urbp->miter_started = 0;
1159 dum_hcd = hcd_to_dummy_hcd(hcd);
1160 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1162 rc = dummy_validate_stream(dum_hcd, urb);
1163 if (rc) {
1164 kfree(urbp);
1165 goto done;
1168 rc = usb_hcd_link_urb_to_ep(hcd, urb);
1169 if (rc) {
1170 kfree(urbp);
1171 goto done;
1174 if (!dum_hcd->udev) {
1175 dum_hcd->udev = urb->dev;
1176 usb_get_dev(dum_hcd->udev);
1177 } else if (unlikely(dum_hcd->udev != urb->dev))
1178 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1180 list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1181 urb->hcpriv = urbp;
1182 if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1183 urb->error_count = 1; /* mark as a new urb */
1185 /* kick the scheduler, it'll do the rest */
1186 if (!timer_pending(&dum_hcd->timer))
1187 mod_timer(&dum_hcd->timer, jiffies + 1);
1189 done:
1190 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1191 return rc;
1194 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1196 struct dummy_hcd *dum_hcd;
1197 unsigned long flags;
1198 int rc;
1200 /* giveback happens automatically in timer callback,
1201 * so make sure the callback happens */
1202 dum_hcd = hcd_to_dummy_hcd(hcd);
1203 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1205 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1206 if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1207 !list_empty(&dum_hcd->urbp_list))
1208 mod_timer(&dum_hcd->timer, jiffies);
1210 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1211 return rc;
1214 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1215 u32 len)
1217 void *ubuf, *rbuf;
1218 struct urbp *urbp = urb->hcpriv;
1219 int to_host;
1220 struct sg_mapping_iter *miter = &urbp->miter;
1221 u32 trans = 0;
1222 u32 this_sg;
1223 bool next_sg;
1225 to_host = usb_pipein(urb->pipe);
1226 rbuf = req->req.buf + req->req.actual;
1228 if (!urb->num_sgs) {
1229 ubuf = urb->transfer_buffer + urb->actual_length;
1230 if (to_host)
1231 memcpy(ubuf, rbuf, len);
1232 else
1233 memcpy(rbuf, ubuf, len);
1234 return len;
1237 if (!urbp->miter_started) {
1238 u32 flags = SG_MITER_ATOMIC;
1240 if (to_host)
1241 flags |= SG_MITER_TO_SG;
1242 else
1243 flags |= SG_MITER_FROM_SG;
1245 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1246 urbp->miter_started = 1;
1248 next_sg = sg_miter_next(miter);
1249 if (next_sg == false) {
1250 WARN_ON_ONCE(1);
1251 return -EINVAL;
1253 do {
1254 ubuf = miter->addr;
1255 this_sg = min_t(u32, len, miter->length);
1256 miter->consumed = this_sg;
1257 trans += this_sg;
1259 if (to_host)
1260 memcpy(ubuf, rbuf, this_sg);
1261 else
1262 memcpy(rbuf, ubuf, this_sg);
1263 len -= this_sg;
1265 if (!len)
1266 break;
1267 next_sg = sg_miter_next(miter);
1268 if (next_sg == false) {
1269 WARN_ON_ONCE(1);
1270 return -EINVAL;
1273 rbuf += this_sg;
1274 } while (1);
1276 sg_miter_stop(miter);
1277 return trans;
1280 /* transfer up to a frame's worth; caller must own lock */
1281 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1282 struct dummy_ep *ep, int limit, int *status)
1284 struct dummy *dum = dum_hcd->dum;
1285 struct dummy_request *req;
1287 top:
1288 /* if there's no request queued, the device is NAKing; return */
1289 list_for_each_entry(req, &ep->queue, queue) {
1290 unsigned host_len, dev_len, len;
1291 int is_short, to_host;
1292 int rescan = 0;
1294 if (dummy_ep_stream_en(dum_hcd, urb)) {
1295 if ((urb->stream_id != req->req.stream_id))
1296 continue;
1299 /* 1..N packets of ep->ep.maxpacket each ... the last one
1300 * may be short (including zero length).
1302 * writer can send a zlp explicitly (length 0) or implicitly
1303 * (length mod maxpacket zero, and 'zero' flag); they always
1304 * terminate reads.
1306 host_len = urb->transfer_buffer_length - urb->actual_length;
1307 dev_len = req->req.length - req->req.actual;
1308 len = min(host_len, dev_len);
1310 /* FIXME update emulated data toggle too */
1312 to_host = usb_pipein(urb->pipe);
1313 if (unlikely(len == 0))
1314 is_short = 1;
1315 else {
1316 /* not enough bandwidth left? */
1317 if (limit < ep->ep.maxpacket && limit < len)
1318 break;
1319 len = min_t(unsigned, len, limit);
1320 if (len == 0)
1321 break;
1323 /* use an extra pass for the final short packet */
1324 if (len > ep->ep.maxpacket) {
1325 rescan = 1;
1326 len -= (len % ep->ep.maxpacket);
1328 is_short = (len % ep->ep.maxpacket) != 0;
1330 len = dummy_perform_transfer(urb, req, len);
1332 ep->last_io = jiffies;
1333 if ((int)len < 0) {
1334 req->req.status = len;
1335 } else {
1336 limit -= len;
1337 urb->actual_length += len;
1338 req->req.actual += len;
1342 /* short packets terminate, maybe with overflow/underflow.
1343 * it's only really an error to write too much.
1345 * partially filling a buffer optionally blocks queue advances
1346 * (so completion handlers can clean up the queue) but we don't
1347 * need to emulate such data-in-flight.
1349 if (is_short) {
1350 if (host_len == dev_len) {
1351 req->req.status = 0;
1352 *status = 0;
1353 } else if (to_host) {
1354 req->req.status = 0;
1355 if (dev_len > host_len)
1356 *status = -EOVERFLOW;
1357 else
1358 *status = 0;
1359 } else if (!to_host) {
1360 *status = 0;
1361 if (host_len > dev_len)
1362 req->req.status = -EOVERFLOW;
1363 else
1364 req->req.status = 0;
1367 /* many requests terminate without a short packet */
1368 } else {
1369 if (req->req.length == req->req.actual
1370 && !req->req.zero)
1371 req->req.status = 0;
1372 if (urb->transfer_buffer_length == urb->actual_length
1373 && !(urb->transfer_flags
1374 & URB_ZERO_PACKET))
1375 *status = 0;
1378 /* device side completion --> continuable */
1379 if (req->req.status != -EINPROGRESS) {
1380 list_del_init(&req->queue);
1382 spin_unlock(&dum->lock);
1383 usb_gadget_giveback_request(&ep->ep, &req->req);
1384 spin_lock(&dum->lock);
1386 /* requests might have been unlinked... */
1387 rescan = 1;
1390 /* host side completion --> terminate */
1391 if (*status != -EINPROGRESS)
1392 break;
1394 /* rescan to continue with any other queued i/o */
1395 if (rescan)
1396 goto top;
1398 return limit;
1401 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1403 int limit = ep->ep.maxpacket;
1405 if (dum->gadget.speed == USB_SPEED_HIGH) {
1406 int tmp;
1408 /* high bandwidth mode */
1409 tmp = usb_endpoint_maxp(ep->desc);
1410 tmp = (tmp >> 11) & 0x03;
1411 tmp *= 8 /* applies to entire frame */;
1412 limit += limit * tmp;
1414 if (dum->gadget.speed == USB_SPEED_SUPER) {
1415 switch (usb_endpoint_type(ep->desc)) {
1416 case USB_ENDPOINT_XFER_ISOC:
1417 /* Sec. 4.4.8.2 USB3.0 Spec */
1418 limit = 3 * 16 * 1024 * 8;
1419 break;
1420 case USB_ENDPOINT_XFER_INT:
1421 /* Sec. 4.4.7.2 USB3.0 Spec */
1422 limit = 3 * 1024 * 8;
1423 break;
1424 case USB_ENDPOINT_XFER_BULK:
1425 default:
1426 break;
1429 return limit;
1432 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1433 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1434 USB_PORT_STAT_SUSPEND)) \
1435 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1437 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1439 int i;
1441 if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1442 dum->ss_hcd : dum->hs_hcd)))
1443 return NULL;
1444 if ((address & ~USB_DIR_IN) == 0)
1445 return &dum->ep[0];
1446 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1447 struct dummy_ep *ep = &dum->ep[i];
1449 if (!ep->desc)
1450 continue;
1451 if (ep->desc->bEndpointAddress == address)
1452 return ep;
1454 return NULL;
1457 #undef is_active
1459 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1460 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1461 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1462 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1463 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1464 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1468 * handle_control_request() - handles all control transfers
1469 * @dum: pointer to dummy (the_controller)
1470 * @urb: the urb request to handle
1471 * @setup: pointer to the setup data for a USB device control
1472 * request
1473 * @status: pointer to request handling status
1475 * Return 0 - if the request was handled
1476 * 1 - if the request wasn't handles
1477 * error code on error
1479 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1480 struct usb_ctrlrequest *setup,
1481 int *status)
1483 struct dummy_ep *ep2;
1484 struct dummy *dum = dum_hcd->dum;
1485 int ret_val = 1;
1486 unsigned w_index;
1487 unsigned w_value;
1489 w_index = le16_to_cpu(setup->wIndex);
1490 w_value = le16_to_cpu(setup->wValue);
1491 switch (setup->bRequest) {
1492 case USB_REQ_SET_ADDRESS:
1493 if (setup->bRequestType != Dev_Request)
1494 break;
1495 dum->address = w_value;
1496 *status = 0;
1497 dev_dbg(udc_dev(dum), "set_address = %d\n",
1498 w_value);
1499 ret_val = 0;
1500 break;
1501 case USB_REQ_SET_FEATURE:
1502 if (setup->bRequestType == Dev_Request) {
1503 ret_val = 0;
1504 switch (w_value) {
1505 case USB_DEVICE_REMOTE_WAKEUP:
1506 break;
1507 case USB_DEVICE_B_HNP_ENABLE:
1508 dum->gadget.b_hnp_enable = 1;
1509 break;
1510 case USB_DEVICE_A_HNP_SUPPORT:
1511 dum->gadget.a_hnp_support = 1;
1512 break;
1513 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1514 dum->gadget.a_alt_hnp_support = 1;
1515 break;
1516 case USB_DEVICE_U1_ENABLE:
1517 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1518 HCD_USB3)
1519 w_value = USB_DEV_STAT_U1_ENABLED;
1520 else
1521 ret_val = -EOPNOTSUPP;
1522 break;
1523 case USB_DEVICE_U2_ENABLE:
1524 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1525 HCD_USB3)
1526 w_value = USB_DEV_STAT_U2_ENABLED;
1527 else
1528 ret_val = -EOPNOTSUPP;
1529 break;
1530 case USB_DEVICE_LTM_ENABLE:
1531 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1532 HCD_USB3)
1533 w_value = USB_DEV_STAT_LTM_ENABLED;
1534 else
1535 ret_val = -EOPNOTSUPP;
1536 break;
1537 default:
1538 ret_val = -EOPNOTSUPP;
1540 if (ret_val == 0) {
1541 dum->devstatus |= (1 << w_value);
1542 *status = 0;
1544 } else if (setup->bRequestType == Ep_Request) {
1545 /* endpoint halt */
1546 ep2 = find_endpoint(dum, w_index);
1547 if (!ep2 || ep2->ep.name == ep0name) {
1548 ret_val = -EOPNOTSUPP;
1549 break;
1551 ep2->halted = 1;
1552 ret_val = 0;
1553 *status = 0;
1555 break;
1556 case USB_REQ_CLEAR_FEATURE:
1557 if (setup->bRequestType == Dev_Request) {
1558 ret_val = 0;
1559 switch (w_value) {
1560 case USB_DEVICE_REMOTE_WAKEUP:
1561 w_value = USB_DEVICE_REMOTE_WAKEUP;
1562 break;
1563 case USB_DEVICE_U1_ENABLE:
1564 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1565 HCD_USB3)
1566 w_value = USB_DEV_STAT_U1_ENABLED;
1567 else
1568 ret_val = -EOPNOTSUPP;
1569 break;
1570 case USB_DEVICE_U2_ENABLE:
1571 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1572 HCD_USB3)
1573 w_value = USB_DEV_STAT_U2_ENABLED;
1574 else
1575 ret_val = -EOPNOTSUPP;
1576 break;
1577 case USB_DEVICE_LTM_ENABLE:
1578 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1579 HCD_USB3)
1580 w_value = USB_DEV_STAT_LTM_ENABLED;
1581 else
1582 ret_val = -EOPNOTSUPP;
1583 break;
1584 default:
1585 ret_val = -EOPNOTSUPP;
1586 break;
1588 if (ret_val == 0) {
1589 dum->devstatus &= ~(1 << w_value);
1590 *status = 0;
1592 } else if (setup->bRequestType == Ep_Request) {
1593 /* endpoint halt */
1594 ep2 = find_endpoint(dum, w_index);
1595 if (!ep2) {
1596 ret_val = -EOPNOTSUPP;
1597 break;
1599 if (!ep2->wedged)
1600 ep2->halted = 0;
1601 ret_val = 0;
1602 *status = 0;
1604 break;
1605 case USB_REQ_GET_STATUS:
1606 if (setup->bRequestType == Dev_InRequest
1607 || setup->bRequestType == Intf_InRequest
1608 || setup->bRequestType == Ep_InRequest) {
1609 char *buf;
1611 * device: remote wakeup, selfpowered
1612 * interface: nothing
1613 * endpoint: halt
1615 buf = (char *)urb->transfer_buffer;
1616 if (urb->transfer_buffer_length > 0) {
1617 if (setup->bRequestType == Ep_InRequest) {
1618 ep2 = find_endpoint(dum, w_index);
1619 if (!ep2) {
1620 ret_val = -EOPNOTSUPP;
1621 break;
1623 buf[0] = ep2->halted;
1624 } else if (setup->bRequestType ==
1625 Dev_InRequest) {
1626 buf[0] = (u8)dum->devstatus;
1627 } else
1628 buf[0] = 0;
1630 if (urb->transfer_buffer_length > 1)
1631 buf[1] = 0;
1632 urb->actual_length = min_t(u32, 2,
1633 urb->transfer_buffer_length);
1634 ret_val = 0;
1635 *status = 0;
1637 break;
1639 return ret_val;
1642 /* drive both sides of the transfers; looks like irq handlers to
1643 * both drivers except the callbacks aren't in_irq().
1645 static void dummy_timer(unsigned long _dum_hcd)
1647 struct dummy_hcd *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1648 struct dummy *dum = dum_hcd->dum;
1649 struct urbp *urbp, *tmp;
1650 unsigned long flags;
1651 int limit, total;
1652 int i;
1654 /* simplistic model for one frame's bandwidth */
1655 switch (dum->gadget.speed) {
1656 case USB_SPEED_LOW:
1657 total = 8/*bytes*/ * 12/*packets*/;
1658 break;
1659 case USB_SPEED_FULL:
1660 total = 64/*bytes*/ * 19/*packets*/;
1661 break;
1662 case USB_SPEED_HIGH:
1663 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1664 break;
1665 case USB_SPEED_SUPER:
1666 /* Bus speed is 500000 bytes/ms, so use a little less */
1667 total = 490000;
1668 break;
1669 default:
1670 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1671 return;
1674 /* FIXME if HZ != 1000 this will probably misbehave ... */
1676 /* look at each urb queued by the host side driver */
1677 spin_lock_irqsave(&dum->lock, flags);
1679 if (!dum_hcd->udev) {
1680 dev_err(dummy_dev(dum_hcd),
1681 "timer fired with no URBs pending?\n");
1682 spin_unlock_irqrestore(&dum->lock, flags);
1683 return;
1686 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1687 if (!ep_name[i])
1688 break;
1689 dum->ep[i].already_seen = 0;
1692 restart:
1693 list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1694 struct urb *urb;
1695 struct dummy_request *req;
1696 u8 address;
1697 struct dummy_ep *ep = NULL;
1698 int type;
1699 int status = -EINPROGRESS;
1701 urb = urbp->urb;
1702 if (urb->unlinked)
1703 goto return_urb;
1704 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1705 continue;
1706 type = usb_pipetype(urb->pipe);
1708 /* used up this frame's non-periodic bandwidth?
1709 * FIXME there's infinite bandwidth for control and
1710 * periodic transfers ... unrealistic.
1712 if (total <= 0 && type == PIPE_BULK)
1713 continue;
1715 /* find the gadget's ep for this request (if configured) */
1716 address = usb_pipeendpoint (urb->pipe);
1717 if (usb_pipein(urb->pipe))
1718 address |= USB_DIR_IN;
1719 ep = find_endpoint(dum, address);
1720 if (!ep) {
1721 /* set_configuration() disagreement */
1722 dev_dbg(dummy_dev(dum_hcd),
1723 "no ep configured for urb %p\n",
1724 urb);
1725 status = -EPROTO;
1726 goto return_urb;
1729 if (ep->already_seen)
1730 continue;
1731 ep->already_seen = 1;
1732 if (ep == &dum->ep[0] && urb->error_count) {
1733 ep->setup_stage = 1; /* a new urb */
1734 urb->error_count = 0;
1736 if (ep->halted && !ep->setup_stage) {
1737 /* NOTE: must not be iso! */
1738 dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1739 ep->ep.name, urb);
1740 status = -EPIPE;
1741 goto return_urb;
1743 /* FIXME make sure both ends agree on maxpacket */
1745 /* handle control requests */
1746 if (ep == &dum->ep[0] && ep->setup_stage) {
1747 struct usb_ctrlrequest setup;
1748 int value = 1;
1750 setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1751 /* paranoia, in case of stale queued data */
1752 list_for_each_entry(req, &ep->queue, queue) {
1753 list_del_init(&req->queue);
1754 req->req.status = -EOVERFLOW;
1755 dev_dbg(udc_dev(dum), "stale req = %p\n",
1756 req);
1758 spin_unlock(&dum->lock);
1759 usb_gadget_giveback_request(&ep->ep, &req->req);
1760 spin_lock(&dum->lock);
1761 ep->already_seen = 0;
1762 goto restart;
1765 /* gadget driver never sees set_address or operations
1766 * on standard feature flags. some hardware doesn't
1767 * even expose them.
1769 ep->last_io = jiffies;
1770 ep->setup_stage = 0;
1771 ep->halted = 0;
1773 value = handle_control_request(dum_hcd, urb, &setup,
1774 &status);
1776 /* gadget driver handles all other requests. block
1777 * until setup() returns; no reentrancy issues etc.
1779 if (value > 0) {
1780 spin_unlock(&dum->lock);
1781 value = dum->driver->setup(&dum->gadget,
1782 &setup);
1783 spin_lock(&dum->lock);
1785 if (value >= 0) {
1786 /* no delays (max 64KB data stage) */
1787 limit = 64*1024;
1788 goto treat_control_like_bulk;
1790 /* error, see below */
1793 if (value < 0) {
1794 if (value != -EOPNOTSUPP)
1795 dev_dbg(udc_dev(dum),
1796 "setup --> %d\n",
1797 value);
1798 status = -EPIPE;
1799 urb->actual_length = 0;
1802 goto return_urb;
1805 /* non-control requests */
1806 limit = total;
1807 switch (usb_pipetype(urb->pipe)) {
1808 case PIPE_ISOCHRONOUS:
1809 /* FIXME is it urb->interval since the last xfer?
1810 * use urb->iso_frame_desc[i].
1811 * complete whether or not ep has requests queued.
1812 * report random errors, to debug drivers.
1814 limit = max(limit, periodic_bytes(dum, ep));
1815 status = -ENOSYS;
1816 break;
1818 case PIPE_INTERRUPT:
1819 /* FIXME is it urb->interval since the last xfer?
1820 * this almost certainly polls too fast.
1822 limit = max(limit, periodic_bytes(dum, ep));
1823 /* FALLTHROUGH */
1825 default:
1826 treat_control_like_bulk:
1827 ep->last_io = jiffies;
1828 total = transfer(dum_hcd, urb, ep, limit, &status);
1829 break;
1832 /* incomplete transfer? */
1833 if (status == -EINPROGRESS)
1834 continue;
1836 return_urb:
1837 list_del(&urbp->urbp_list);
1838 kfree(urbp);
1839 if (ep)
1840 ep->already_seen = ep->setup_stage = 0;
1842 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1843 spin_unlock(&dum->lock);
1844 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1845 spin_lock(&dum->lock);
1847 goto restart;
1850 if (list_empty(&dum_hcd->urbp_list)) {
1851 usb_put_dev(dum_hcd->udev);
1852 dum_hcd->udev = NULL;
1853 } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1854 /* want a 1 msec delay here */
1855 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1858 spin_unlock_irqrestore(&dum->lock, flags);
1861 /*-------------------------------------------------------------------------*/
1863 #define PORT_C_MASK \
1864 ((USB_PORT_STAT_C_CONNECTION \
1865 | USB_PORT_STAT_C_ENABLE \
1866 | USB_PORT_STAT_C_SUSPEND \
1867 | USB_PORT_STAT_C_OVERCURRENT \
1868 | USB_PORT_STAT_C_RESET) << 16)
1870 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1872 struct dummy_hcd *dum_hcd;
1873 unsigned long flags;
1874 int retval = 0;
1876 dum_hcd = hcd_to_dummy_hcd(hcd);
1878 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1879 if (!HCD_HW_ACCESSIBLE(hcd))
1880 goto done;
1882 if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
1883 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1884 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
1885 set_link_state(dum_hcd);
1888 if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
1889 *buf = (1 << 1);
1890 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
1891 dum_hcd->port_status);
1892 retval = 1;
1893 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
1894 usb_hcd_resume_root_hub(hcd);
1896 done:
1897 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1898 return retval;
1901 /* usb 3.0 root hub device descriptor */
1902 static struct {
1903 struct usb_bos_descriptor bos;
1904 struct usb_ss_cap_descriptor ss_cap;
1905 } __packed usb3_bos_desc = {
1907 .bos = {
1908 .bLength = USB_DT_BOS_SIZE,
1909 .bDescriptorType = USB_DT_BOS,
1910 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
1911 .bNumDeviceCaps = 1,
1913 .ss_cap = {
1914 .bLength = USB_DT_USB_SS_CAP_SIZE,
1915 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
1916 .bDevCapabilityType = USB_SS_CAP_TYPE,
1917 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
1918 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
1922 static inline void
1923 ss_hub_descriptor(struct usb_hub_descriptor *desc)
1925 memset(desc, 0, sizeof *desc);
1926 desc->bDescriptorType = USB_DT_SS_HUB;
1927 desc->bDescLength = 12;
1928 desc->wHubCharacteristics = cpu_to_le16(
1929 HUB_CHAR_INDV_PORT_LPSM |
1930 HUB_CHAR_COMMON_OCPM);
1931 desc->bNbrPorts = 1;
1932 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
1933 desc->u.ss.DeviceRemovable = 0xffff;
1936 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
1938 memset(desc, 0, sizeof *desc);
1939 desc->bDescriptorType = USB_DT_HUB;
1940 desc->bDescLength = 9;
1941 desc->wHubCharacteristics = cpu_to_le16(
1942 HUB_CHAR_INDV_PORT_LPSM |
1943 HUB_CHAR_COMMON_OCPM);
1944 desc->bNbrPorts = 1;
1945 desc->u.hs.DeviceRemovable[0] = 0xff;
1946 desc->u.hs.DeviceRemovable[1] = 0xff;
1949 static int dummy_hub_control(
1950 struct usb_hcd *hcd,
1951 u16 typeReq,
1952 u16 wValue,
1953 u16 wIndex,
1954 char *buf,
1955 u16 wLength
1957 struct dummy_hcd *dum_hcd;
1958 int retval = 0;
1959 unsigned long flags;
1961 if (!HCD_HW_ACCESSIBLE(hcd))
1962 return -ETIMEDOUT;
1964 dum_hcd = hcd_to_dummy_hcd(hcd);
1966 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1967 switch (typeReq) {
1968 case ClearHubFeature:
1969 break;
1970 case ClearPortFeature:
1971 switch (wValue) {
1972 case USB_PORT_FEAT_SUSPEND:
1973 if (hcd->speed == HCD_USB3) {
1974 dev_dbg(dummy_dev(dum_hcd),
1975 "USB_PORT_FEAT_SUSPEND req not "
1976 "supported for USB 3.0 roothub\n");
1977 goto error;
1979 if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
1980 /* 20msec resume signaling */
1981 dum_hcd->resuming = 1;
1982 dum_hcd->re_timeout = jiffies +
1983 msecs_to_jiffies(20);
1985 break;
1986 case USB_PORT_FEAT_POWER:
1987 if (hcd->speed == HCD_USB3) {
1988 if (dum_hcd->port_status & USB_PORT_STAT_POWER)
1989 dev_dbg(dummy_dev(dum_hcd),
1990 "power-off\n");
1991 } else
1992 if (dum_hcd->port_status &
1993 USB_SS_PORT_STAT_POWER)
1994 dev_dbg(dummy_dev(dum_hcd),
1995 "power-off\n");
1996 /* FALLS THROUGH */
1997 default:
1998 dum_hcd->port_status &= ~(1 << wValue);
1999 set_link_state(dum_hcd);
2001 break;
2002 case GetHubDescriptor:
2003 if (hcd->speed == HCD_USB3 &&
2004 (wLength < USB_DT_SS_HUB_SIZE ||
2005 wValue != (USB_DT_SS_HUB << 8))) {
2006 dev_dbg(dummy_dev(dum_hcd),
2007 "Wrong hub descriptor type for "
2008 "USB 3.0 roothub.\n");
2009 goto error;
2011 if (hcd->speed == HCD_USB3)
2012 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2013 else
2014 hub_descriptor((struct usb_hub_descriptor *) buf);
2015 break;
2017 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2018 if (hcd->speed != HCD_USB3)
2019 goto error;
2021 if ((wValue >> 8) != USB_DT_BOS)
2022 goto error;
2024 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2025 retval = sizeof(usb3_bos_desc);
2026 break;
2028 case GetHubStatus:
2029 *(__le32 *) buf = cpu_to_le32(0);
2030 break;
2031 case GetPortStatus:
2032 if (wIndex != 1)
2033 retval = -EPIPE;
2035 /* whoever resets or resumes must GetPortStatus to
2036 * complete it!!
2038 if (dum_hcd->resuming &&
2039 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2040 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2041 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2043 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2044 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2045 dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2046 dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2047 if (dum_hcd->dum->pullup) {
2048 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2050 if (hcd->speed < HCD_USB3) {
2051 switch (dum_hcd->dum->gadget.speed) {
2052 case USB_SPEED_HIGH:
2053 dum_hcd->port_status |=
2054 USB_PORT_STAT_HIGH_SPEED;
2055 break;
2056 case USB_SPEED_LOW:
2057 dum_hcd->dum->gadget.ep0->
2058 maxpacket = 8;
2059 dum_hcd->port_status |=
2060 USB_PORT_STAT_LOW_SPEED;
2061 break;
2062 default:
2063 dum_hcd->dum->gadget.speed =
2064 USB_SPEED_FULL;
2065 break;
2070 set_link_state(dum_hcd);
2071 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2072 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2073 break;
2074 case SetHubFeature:
2075 retval = -EPIPE;
2076 break;
2077 case SetPortFeature:
2078 switch (wValue) {
2079 case USB_PORT_FEAT_LINK_STATE:
2080 if (hcd->speed != HCD_USB3) {
2081 dev_dbg(dummy_dev(dum_hcd),
2082 "USB_PORT_FEAT_LINK_STATE req not "
2083 "supported for USB 2.0 roothub\n");
2084 goto error;
2087 * Since this is dummy we don't have an actual link so
2088 * there is nothing to do for the SET_LINK_STATE cmd
2090 break;
2091 case USB_PORT_FEAT_U1_TIMEOUT:
2092 case USB_PORT_FEAT_U2_TIMEOUT:
2093 /* TODO: add suspend/resume support! */
2094 if (hcd->speed != HCD_USB3) {
2095 dev_dbg(dummy_dev(dum_hcd),
2096 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2097 "supported for USB 2.0 roothub\n");
2098 goto error;
2100 break;
2101 case USB_PORT_FEAT_SUSPEND:
2102 /* Applicable only for USB2.0 hub */
2103 if (hcd->speed == HCD_USB3) {
2104 dev_dbg(dummy_dev(dum_hcd),
2105 "USB_PORT_FEAT_SUSPEND req not "
2106 "supported for USB 3.0 roothub\n");
2107 goto error;
2109 if (dum_hcd->active) {
2110 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2112 /* HNP would happen here; for now we
2113 * assume b_bus_req is always true.
2115 set_link_state(dum_hcd);
2116 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2117 & dum_hcd->dum->devstatus) != 0)
2118 dev_dbg(dummy_dev(dum_hcd),
2119 "no HNP yet!\n");
2121 break;
2122 case USB_PORT_FEAT_POWER:
2123 if (hcd->speed == HCD_USB3)
2124 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2125 else
2126 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2127 set_link_state(dum_hcd);
2128 break;
2129 case USB_PORT_FEAT_BH_PORT_RESET:
2130 /* Applicable only for USB3.0 hub */
2131 if (hcd->speed != HCD_USB3) {
2132 dev_dbg(dummy_dev(dum_hcd),
2133 "USB_PORT_FEAT_BH_PORT_RESET req not "
2134 "supported for USB 2.0 roothub\n");
2135 goto error;
2137 /* FALLS THROUGH */
2138 case USB_PORT_FEAT_RESET:
2139 /* if it's already enabled, disable */
2140 if (hcd->speed == HCD_USB3) {
2141 dum_hcd->port_status = 0;
2142 dum_hcd->port_status =
2143 (USB_SS_PORT_STAT_POWER |
2144 USB_PORT_STAT_CONNECTION |
2145 USB_PORT_STAT_RESET);
2146 } else
2147 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2148 | USB_PORT_STAT_LOW_SPEED
2149 | USB_PORT_STAT_HIGH_SPEED);
2151 * We want to reset device status. All but the
2152 * Self powered feature
2154 dum_hcd->dum->devstatus &=
2155 (1 << USB_DEVICE_SELF_POWERED);
2157 * FIXME USB3.0: what is the correct reset signaling
2158 * interval? Is it still 50msec as for HS?
2160 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2161 /* FALLS THROUGH */
2162 default:
2163 if (hcd->speed == HCD_USB3) {
2164 if ((dum_hcd->port_status &
2165 USB_SS_PORT_STAT_POWER) != 0) {
2166 dum_hcd->port_status |= (1 << wValue);
2167 set_link_state(dum_hcd);
2169 } else
2170 if ((dum_hcd->port_status &
2171 USB_PORT_STAT_POWER) != 0) {
2172 dum_hcd->port_status |= (1 << wValue);
2173 set_link_state(dum_hcd);
2176 break;
2177 case GetPortErrorCount:
2178 if (hcd->speed != HCD_USB3) {
2179 dev_dbg(dummy_dev(dum_hcd),
2180 "GetPortErrorCount req not "
2181 "supported for USB 2.0 roothub\n");
2182 goto error;
2184 /* We'll always return 0 since this is a dummy hub */
2185 *(__le32 *) buf = cpu_to_le32(0);
2186 break;
2187 case SetHubDepth:
2188 if (hcd->speed != HCD_USB3) {
2189 dev_dbg(dummy_dev(dum_hcd),
2190 "SetHubDepth req not supported for "
2191 "USB 2.0 roothub\n");
2192 goto error;
2194 break;
2195 default:
2196 dev_dbg(dummy_dev(dum_hcd),
2197 "hub control req%04x v%04x i%04x l%d\n",
2198 typeReq, wValue, wIndex, wLength);
2199 error:
2200 /* "protocol stall" on error */
2201 retval = -EPIPE;
2203 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2205 if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2206 usb_hcd_poll_rh_status(hcd);
2207 return retval;
2210 static int dummy_bus_suspend(struct usb_hcd *hcd)
2212 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2214 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2216 spin_lock_irq(&dum_hcd->dum->lock);
2217 dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2218 set_link_state(dum_hcd);
2219 hcd->state = HC_STATE_SUSPENDED;
2220 spin_unlock_irq(&dum_hcd->dum->lock);
2221 return 0;
2224 static int dummy_bus_resume(struct usb_hcd *hcd)
2226 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2227 int rc = 0;
2229 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2231 spin_lock_irq(&dum_hcd->dum->lock);
2232 if (!HCD_HW_ACCESSIBLE(hcd)) {
2233 rc = -ESHUTDOWN;
2234 } else {
2235 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2236 set_link_state(dum_hcd);
2237 if (!list_empty(&dum_hcd->urbp_list))
2238 mod_timer(&dum_hcd->timer, jiffies);
2239 hcd->state = HC_STATE_RUNNING;
2241 spin_unlock_irq(&dum_hcd->dum->lock);
2242 return rc;
2245 /*-------------------------------------------------------------------------*/
2247 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2249 int ep = usb_pipeendpoint(urb->pipe);
2251 return snprintf(buf, size,
2252 "urb/%p %s ep%d%s%s len %d/%d\n",
2253 urb,
2254 ({ char *s;
2255 switch (urb->dev->speed) {
2256 case USB_SPEED_LOW:
2257 s = "ls";
2258 break;
2259 case USB_SPEED_FULL:
2260 s = "fs";
2261 break;
2262 case USB_SPEED_HIGH:
2263 s = "hs";
2264 break;
2265 case USB_SPEED_SUPER:
2266 s = "ss";
2267 break;
2268 default:
2269 s = "?";
2270 break;
2271 } s; }),
2272 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2273 ({ char *s; \
2274 switch (usb_pipetype(urb->pipe)) { \
2275 case PIPE_CONTROL: \
2276 s = ""; \
2277 break; \
2278 case PIPE_BULK: \
2279 s = "-bulk"; \
2280 break; \
2281 case PIPE_INTERRUPT: \
2282 s = "-int"; \
2283 break; \
2284 default: \
2285 s = "-iso"; \
2286 break; \
2287 } s; }),
2288 urb->actual_length, urb->transfer_buffer_length);
2291 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2292 char *buf)
2294 struct usb_hcd *hcd = dev_get_drvdata(dev);
2295 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2296 struct urbp *urbp;
2297 size_t size = 0;
2298 unsigned long flags;
2300 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2301 list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2302 size_t temp;
2304 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2305 buf += temp;
2306 size += temp;
2308 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2310 return size;
2312 static DEVICE_ATTR_RO(urbs);
2314 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2316 init_timer(&dum_hcd->timer);
2317 dum_hcd->timer.function = dummy_timer;
2318 dum_hcd->timer.data = (unsigned long)dum_hcd;
2319 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2320 dum_hcd->stream_en_ep = 0;
2321 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2322 dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET;
2323 dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2324 dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2325 #ifdef CONFIG_USB_OTG
2326 dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2327 #endif
2328 return 0;
2330 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2331 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2334 static int dummy_start(struct usb_hcd *hcd)
2336 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2339 * MASTER side init ... we emulate a root hub that'll only ever
2340 * talk to one device (the slave side). Also appears in sysfs,
2341 * just like more familiar pci-based HCDs.
2343 if (!usb_hcd_is_primary_hcd(hcd))
2344 return dummy_start_ss(dum_hcd);
2346 spin_lock_init(&dum_hcd->dum->lock);
2347 init_timer(&dum_hcd->timer);
2348 dum_hcd->timer.function = dummy_timer;
2349 dum_hcd->timer.data = (unsigned long)dum_hcd;
2350 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2352 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2354 hcd->power_budget = POWER_BUDGET;
2355 hcd->state = HC_STATE_RUNNING;
2356 hcd->uses_new_polling = 1;
2358 #ifdef CONFIG_USB_OTG
2359 hcd->self.otg_port = 1;
2360 #endif
2362 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2363 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2366 static void dummy_stop(struct usb_hcd *hcd)
2368 struct dummy *dum;
2370 dum = hcd_to_dummy_hcd(hcd)->dum;
2371 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2372 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2375 /*-------------------------------------------------------------------------*/
2377 static int dummy_h_get_frame(struct usb_hcd *hcd)
2379 return dummy_g_get_frame(NULL);
2382 static int dummy_setup(struct usb_hcd *hcd)
2384 struct dummy *dum;
2386 dum = *((void **)dev_get_platdata(hcd->self.controller));
2387 hcd->self.sg_tablesize = ~0;
2388 if (usb_hcd_is_primary_hcd(hcd)) {
2389 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2390 dum->hs_hcd->dum = dum;
2392 * Mark the first roothub as being USB 2.0.
2393 * The USB 3.0 roothub will be registered later by
2394 * dummy_hcd_probe()
2396 hcd->speed = HCD_USB2;
2397 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2398 } else {
2399 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2400 dum->ss_hcd->dum = dum;
2401 hcd->speed = HCD_USB3;
2402 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2404 return 0;
2407 /* Change a group of bulk endpoints to support multiple stream IDs */
2408 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2409 struct usb_host_endpoint **eps, unsigned int num_eps,
2410 unsigned int num_streams, gfp_t mem_flags)
2412 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2413 unsigned long flags;
2414 int max_stream;
2415 int ret_streams = num_streams;
2416 unsigned int index;
2417 unsigned int i;
2419 if (!num_eps)
2420 return -EINVAL;
2422 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2423 for (i = 0; i < num_eps; i++) {
2424 index = dummy_get_ep_idx(&eps[i]->desc);
2425 if ((1 << index) & dum_hcd->stream_en_ep) {
2426 ret_streams = -EINVAL;
2427 goto out;
2429 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2430 if (!max_stream) {
2431 ret_streams = -EINVAL;
2432 goto out;
2434 if (max_stream < ret_streams) {
2435 dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2436 "stream IDs.\n",
2437 eps[i]->desc.bEndpointAddress,
2438 max_stream);
2439 ret_streams = max_stream;
2443 for (i = 0; i < num_eps; i++) {
2444 index = dummy_get_ep_idx(&eps[i]->desc);
2445 dum_hcd->stream_en_ep |= 1 << index;
2446 set_max_streams_for_pipe(dum_hcd,
2447 usb_endpoint_num(&eps[i]->desc), ret_streams);
2449 out:
2450 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2451 return ret_streams;
2454 /* Reverts a group of bulk endpoints back to not using stream IDs. */
2455 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2456 struct usb_host_endpoint **eps, unsigned int num_eps,
2457 gfp_t mem_flags)
2459 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2460 unsigned long flags;
2461 int ret;
2462 unsigned int index;
2463 unsigned int i;
2465 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2466 for (i = 0; i < num_eps; i++) {
2467 index = dummy_get_ep_idx(&eps[i]->desc);
2468 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2469 ret = -EINVAL;
2470 goto out;
2474 for (i = 0; i < num_eps; i++) {
2475 index = dummy_get_ep_idx(&eps[i]->desc);
2476 dum_hcd->stream_en_ep &= ~(1 << index);
2477 set_max_streams_for_pipe(dum_hcd,
2478 usb_endpoint_num(&eps[i]->desc), 0);
2480 ret = 0;
2481 out:
2482 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2483 return ret;
2486 static struct hc_driver dummy_hcd = {
2487 .description = (char *) driver_name,
2488 .product_desc = "Dummy host controller",
2489 .hcd_priv_size = sizeof(struct dummy_hcd),
2491 .flags = HCD_USB3 | HCD_SHARED,
2493 .reset = dummy_setup,
2494 .start = dummy_start,
2495 .stop = dummy_stop,
2497 .urb_enqueue = dummy_urb_enqueue,
2498 .urb_dequeue = dummy_urb_dequeue,
2500 .get_frame_number = dummy_h_get_frame,
2502 .hub_status_data = dummy_hub_status,
2503 .hub_control = dummy_hub_control,
2504 .bus_suspend = dummy_bus_suspend,
2505 .bus_resume = dummy_bus_resume,
2507 .alloc_streams = dummy_alloc_streams,
2508 .free_streams = dummy_free_streams,
2511 static int dummy_hcd_probe(struct platform_device *pdev)
2513 struct dummy *dum;
2514 struct usb_hcd *hs_hcd;
2515 struct usb_hcd *ss_hcd;
2516 int retval;
2518 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2519 dum = *((void **)dev_get_platdata(&pdev->dev));
2521 if (!mod_data.is_super_speed)
2522 dummy_hcd.flags = HCD_USB2;
2523 hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2524 if (!hs_hcd)
2525 return -ENOMEM;
2526 hs_hcd->has_tt = 1;
2528 retval = usb_add_hcd(hs_hcd, 0, 0);
2529 if (retval)
2530 goto put_usb2_hcd;
2532 if (mod_data.is_super_speed) {
2533 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2534 dev_name(&pdev->dev), hs_hcd);
2535 if (!ss_hcd) {
2536 retval = -ENOMEM;
2537 goto dealloc_usb2_hcd;
2540 retval = usb_add_hcd(ss_hcd, 0, 0);
2541 if (retval)
2542 goto put_usb3_hcd;
2544 return 0;
2546 put_usb3_hcd:
2547 usb_put_hcd(ss_hcd);
2548 dealloc_usb2_hcd:
2549 usb_remove_hcd(hs_hcd);
2550 put_usb2_hcd:
2551 usb_put_hcd(hs_hcd);
2552 dum->hs_hcd = dum->ss_hcd = NULL;
2553 return retval;
2556 static int dummy_hcd_remove(struct platform_device *pdev)
2558 struct dummy *dum;
2560 dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2562 if (dum->ss_hcd) {
2563 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2564 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2567 usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2568 usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2570 dum->hs_hcd = NULL;
2571 dum->ss_hcd = NULL;
2573 return 0;
2576 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2578 struct usb_hcd *hcd;
2579 struct dummy_hcd *dum_hcd;
2580 int rc = 0;
2582 dev_dbg(&pdev->dev, "%s\n", __func__);
2584 hcd = platform_get_drvdata(pdev);
2585 dum_hcd = hcd_to_dummy_hcd(hcd);
2586 if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2587 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2588 rc = -EBUSY;
2589 } else
2590 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2591 return rc;
2594 static int dummy_hcd_resume(struct platform_device *pdev)
2596 struct usb_hcd *hcd;
2598 dev_dbg(&pdev->dev, "%s\n", __func__);
2600 hcd = platform_get_drvdata(pdev);
2601 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2602 usb_hcd_poll_rh_status(hcd);
2603 return 0;
2606 static struct platform_driver dummy_hcd_driver = {
2607 .probe = dummy_hcd_probe,
2608 .remove = dummy_hcd_remove,
2609 .suspend = dummy_hcd_suspend,
2610 .resume = dummy_hcd_resume,
2611 .driver = {
2612 .name = (char *) driver_name,
2616 /*-------------------------------------------------------------------------*/
2617 #define MAX_NUM_UDC 2
2618 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2619 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2621 static int __init init(void)
2623 int retval = -ENOMEM;
2624 int i;
2625 struct dummy *dum[MAX_NUM_UDC];
2627 if (usb_disabled())
2628 return -ENODEV;
2630 if (!mod_data.is_high_speed && mod_data.is_super_speed)
2631 return -EINVAL;
2633 if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2634 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2635 MAX_NUM_UDC);
2636 return -EINVAL;
2639 for (i = 0; i < mod_data.num; i++) {
2640 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2641 if (!the_hcd_pdev[i]) {
2642 i--;
2643 while (i >= 0)
2644 platform_device_put(the_hcd_pdev[i--]);
2645 return retval;
2648 for (i = 0; i < mod_data.num; i++) {
2649 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2650 if (!the_udc_pdev[i]) {
2651 i--;
2652 while (i >= 0)
2653 platform_device_put(the_udc_pdev[i--]);
2654 goto err_alloc_udc;
2657 for (i = 0; i < mod_data.num; i++) {
2658 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2659 if (!dum[i]) {
2660 retval = -ENOMEM;
2661 goto err_add_pdata;
2663 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2664 sizeof(void *));
2665 if (retval)
2666 goto err_add_pdata;
2667 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2668 sizeof(void *));
2669 if (retval)
2670 goto err_add_pdata;
2673 retval = platform_driver_register(&dummy_hcd_driver);
2674 if (retval < 0)
2675 goto err_add_pdata;
2676 retval = platform_driver_register(&dummy_udc_driver);
2677 if (retval < 0)
2678 goto err_register_udc_driver;
2680 for (i = 0; i < mod_data.num; i++) {
2681 retval = platform_device_add(the_hcd_pdev[i]);
2682 if (retval < 0) {
2683 i--;
2684 while (i >= 0)
2685 platform_device_del(the_hcd_pdev[i--]);
2686 goto err_add_hcd;
2689 for (i = 0; i < mod_data.num; i++) {
2690 if (!dum[i]->hs_hcd ||
2691 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2693 * The hcd was added successfully but its probe
2694 * function failed for some reason.
2696 retval = -EINVAL;
2697 goto err_add_udc;
2701 for (i = 0; i < mod_data.num; i++) {
2702 retval = platform_device_add(the_udc_pdev[i]);
2703 if (retval < 0) {
2704 i--;
2705 while (i >= 0)
2706 platform_device_del(the_udc_pdev[i]);
2707 goto err_add_udc;
2711 for (i = 0; i < mod_data.num; i++) {
2712 if (!platform_get_drvdata(the_udc_pdev[i])) {
2714 * The udc was added successfully but its probe
2715 * function failed for some reason.
2717 retval = -EINVAL;
2718 goto err_probe_udc;
2721 return retval;
2723 err_probe_udc:
2724 for (i = 0; i < mod_data.num; i++)
2725 platform_device_del(the_udc_pdev[i]);
2726 err_add_udc:
2727 for (i = 0; i < mod_data.num; i++)
2728 platform_device_del(the_hcd_pdev[i]);
2729 err_add_hcd:
2730 platform_driver_unregister(&dummy_udc_driver);
2731 err_register_udc_driver:
2732 platform_driver_unregister(&dummy_hcd_driver);
2733 err_add_pdata:
2734 for (i = 0; i < mod_data.num; i++)
2735 kfree(dum[i]);
2736 for (i = 0; i < mod_data.num; i++)
2737 platform_device_put(the_udc_pdev[i]);
2738 err_alloc_udc:
2739 for (i = 0; i < mod_data.num; i++)
2740 platform_device_put(the_hcd_pdev[i]);
2741 return retval;
2743 module_init(init);
2745 static void __exit cleanup(void)
2747 int i;
2749 for (i = 0; i < mod_data.num; i++) {
2750 struct dummy *dum;
2752 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2754 platform_device_unregister(the_udc_pdev[i]);
2755 platform_device_unregister(the_hcd_pdev[i]);
2756 kfree(dum);
2758 platform_driver_unregister(&dummy_udc_driver);
2759 platform_driver_unregister(&dummy_hcd_driver);
2761 module_exit(cleanup);