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, 2004 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.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 * This exposes a device side "USB gadget" API, driven by requests to a
27 * Linux-USB host controller driver. USB traffic is simulated; there's
28 * no need for USB hardware. Use this with two other drivers:
30 * - Gadget driver, responding to requests (slave);
31 * - Host-side device driver, as already familiar in Linux.
33 * Having this all in one kernel can help some stages of development,
34 * bypassing some hardware (and driver) issues. UML could help too.
39 #include <linux/config.h>
40 #include <linux/module.h>
41 #include <linux/kernel.h>
42 #include <linux/delay.h>
43 #include <linux/ioport.h>
44 #include <linux/sched.h>
45 #include <linux/slab.h>
46 #include <linux/smp_lock.h>
47 #include <linux/errno.h>
48 #include <linux/init.h>
49 #include <linux/timer.h>
50 #include <linux/list.h>
51 #include <linux/interrupt.h>
52 #include <linux/version.h>
54 #include <linux/usb.h>
55 #include <linux/usb_gadget.h>
57 #include <asm/byteorder.h>
60 #include <asm/system.h>
61 #include <asm/unaligned.h>
64 #include "../core/hcd.h"
67 #define DRIVER_DESC "USB Host+Gadget Emulator"
68 #define DRIVER_VERSION "14 Mar 2004"
70 static const char driver_name [] = "dummy_hcd";
71 static const char driver_desc [] = "USB Host+Gadget Emulator";
73 static const char gadget_name [] = "dummy_udc";
75 MODULE_DESCRIPTION (DRIVER_DESC);
76 MODULE_AUTHOR ("David Brownell");
77 MODULE_LICENSE ("GPL");
79 /*-------------------------------------------------------------------------*/
81 /* gadget side driver data structres */
83 struct list_head queue;
84 unsigned long last_io; /* jiffies timestamp */
85 struct usb_gadget *gadget;
86 const struct usb_endpoint_descriptor *desc;
89 unsigned already_seen : 1;
90 unsigned setup_stage : 1;
93 struct dummy_request {
94 struct list_head queue; /* ep's requests */
95 struct usb_request req;
98 /*-------------------------------------------------------------------------*/
101 * Every device has ep0 for control requests, plus up to 30 more endpoints,
102 * in one of two types:
104 * - Configurable: direction (in/out), type (bulk, iso, etc), and endpoint
105 * number can be changed. Names like "ep-a" are used for this type.
107 * - Fixed Function: in other cases. some characteristics may be mutable;
108 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
110 * Gadget drivers are responsible for not setting up conflicting endpoint
111 * configurations, illegal or unsupported packet lengths, and so on.
114 static const char ep0name [] = "ep0";
116 static const char *const ep_name [] = {
117 ep0name, /* everyone has ep0 */
119 /* act like a net2280: high speed, six configurable endpoints */
120 "ep-a", "ep-b", "ep-c", "ep-d", "ep-e", "ep-f",
122 /* or like pxa250: fifteen fixed function endpoints */
123 "ep1in-bulk", "ep2out-bulk", "ep3in-iso", "ep4out-iso", "ep5in-int",
124 "ep6in-bulk", "ep7out-bulk", "ep8in-iso", "ep9out-iso", "ep10in-int",
125 "ep11in-bulk", "ep12out-bulk", "ep13in-iso", "ep14out-iso",
128 /* or like sa1100: two fixed function endpoints */
129 "ep1out-bulk", "ep2in-bulk",
131 #define DUMMY_ENDPOINTS (sizeof(ep_name)/sizeof(char *))
139 * SLAVE/GADGET side support
141 struct dummy_ep ep [DUMMY_ENDPOINTS];
143 struct usb_gadget gadget;
144 struct usb_gadget_driver *driver;
145 struct dummy_request fifo_req;
146 u8 fifo_buf [FIFO_SIZE];
149 struct hcd_dev *hdev;
152 * MASTER/HOST side support
155 struct platform_device pdev;
156 struct timer_list timer;
159 struct completion released;
161 unsigned long re_timeout;
164 static struct dummy *the_controller;
166 static inline struct dummy *ep_to_dummy (struct dummy_ep *ep)
168 return container_of (ep->gadget, struct dummy, gadget);
171 static inline struct dummy *gadget_dev_to_dummy (struct device *dev)
173 return container_of (dev, struct dummy, gadget.dev);
177 * This "hardware" may look a bit odd in diagnostics since it's got both
178 * host and device sides; and it binds different drivers to each side.
180 #define hardware (&the_controller->pdev.dev)
182 /*-------------------------------------------------------------------------*/
184 static struct device_driver dummy_driver = {
185 .name = (char *) driver_name,
186 .bus = &platform_bus_type,
189 /*-------------------------------------------------------------------------*/
191 /* SLAVE/GADGET SIDE DRIVER
193 * This only tracks gadget state. All the work is done when the host
194 * side tries some (emulated) i/o operation. Real device controller
195 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
198 #define is_enabled() \
199 (the_controller->port_status & USB_PORT_STAT_ENABLE)
202 dummy_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
209 ep = container_of (_ep, struct dummy_ep, ep);
210 if (!_ep || !desc || ep->desc || _ep->name == ep0name
211 || desc->bDescriptorType != USB_DT_ENDPOINT)
212 if (!the_controller->driver || !is_enabled ())
214 max = desc->wMaxPacketSize & 0x3ff;
216 /* drivers must not request bad settings, since lower levels
217 * (hardware or its drivers) may not check. some endpoints
218 * can't do iso, many have maxpacket limitations, etc.
220 * since this "hardware" driver is here to help debugging, we
221 * have some extra sanity checks. (there could be more though,
222 * especially for "ep9out" style fixed function ones.)
224 dum = container_of (ep->gadget, struct dummy, gadget);
226 switch (desc->bmAttributes & 0x03) {
227 case USB_ENDPOINT_XFER_BULK:
228 if (strstr (ep->ep.name, "-iso")
229 || strstr (ep->ep.name, "-int")) {
232 switch (dum->gadget.speed) {
236 /* conserve return statements */
239 case 8: case 16: case 32: case 64:
240 /* we'll fake any legal size */
248 case USB_ENDPOINT_XFER_INT:
249 if (strstr (ep->ep.name, "-iso")) /* bulk is ok */
251 /* real hardware might not handle all packet sizes */
252 switch (dum->gadget.speed) {
256 /* save a return statement */
260 /* save a return statement */
267 case USB_ENDPOINT_XFER_ISOC:
268 if (strstr (ep->ep.name, "-bulk")
269 || strstr (ep->ep.name, "-int"))
271 /* real hardware might not handle all packet sizes */
272 switch (dum->gadget.speed) {
276 /* save a return statement */
280 /* save a return statement */
286 /* few chips support control except on ep0 */
290 _ep->maxpacket = max;
293 dev_dbg (hardware, "enabled %s (ep%d%s-%s) maxpacket %d\n",
295 desc->bEndpointAddress & 0x0f,
296 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
298 switch (desc->bmAttributes & 0x03) {
299 case USB_ENDPOINT_XFER_BULK: val = "bulk"; break;
300 case USB_ENDPOINT_XFER_ISOC: val = "iso"; break;
301 case USB_ENDPOINT_XFER_INT: val = "intr"; break;
302 default: val = "ctrl"; break;
306 /* at this point real hardware should be NAKing transfers
307 * to that endpoint, until a buffer is queued to it.
314 /* called with spinlock held */
315 static void nuke (struct dummy *dum, struct dummy_ep *ep)
317 while (!list_empty (&ep->queue)) {
318 struct dummy_request *req;
320 req = list_entry (ep->queue.next, struct dummy_request, queue);
321 list_del_init (&req->queue);
322 req->req.status = -ESHUTDOWN;
324 spin_unlock (&dum->lock);
325 req->req.complete (&ep->ep, &req->req);
326 spin_lock (&dum->lock);
330 static int dummy_disable (struct usb_ep *_ep)
337 ep = container_of (_ep, struct dummy_ep, ep);
338 if (!_ep || !ep->desc || _ep->name == ep0name)
340 dum = ep_to_dummy (ep);
342 spin_lock_irqsave (&dum->lock, flags);
346 spin_unlock_irqrestore (&dum->lock, flags);
348 dev_dbg (hardware, "disabled %s\n", _ep->name);
352 static struct usb_request *
353 dummy_alloc_request (struct usb_ep *_ep, int mem_flags)
356 struct dummy_request *req;
358 ep = container_of (_ep, struct dummy_ep, ep);
362 req = kmalloc (sizeof *req, mem_flags);
365 memset (req, 0, sizeof *req);
366 INIT_LIST_HEAD (&req->queue);
371 dummy_free_request (struct usb_ep *_ep, struct usb_request *_req)
374 struct dummy_request *req;
376 ep = container_of (_ep, struct dummy_ep, ep);
377 if (!ep || !_req || (!ep->desc && _ep->name != ep0name))
380 req = container_of (_req, struct dummy_request, req);
381 WARN_ON (!list_empty (&req->queue));
394 if (!the_controller->driver)
396 retval = kmalloc (bytes, mem_flags);
397 *dma = (dma_addr_t) retval;
413 fifo_complete (struct usb_ep *ep, struct usb_request *req)
416 dev_dbg (hardware, "fifo_complete: %d\n", req->status);
421 dummy_queue (struct usb_ep *_ep, struct usb_request *_req, int mem_flags)
424 struct dummy_request *req;
428 req = container_of (_req, struct dummy_request, req);
429 if (!_req || !list_empty (&req->queue) || !_req->complete)
432 ep = container_of (_ep, struct dummy_ep, ep);
433 if (!_ep || (!ep->desc && _ep->name != ep0name))
436 if (!the_controller->driver || !is_enabled ())
439 dum = container_of (ep->gadget, struct dummy, gadget);
442 dev_dbg (hardware, "ep %p queue req %p to %s, len %d buf %p\n",
443 ep, _req, _ep->name, _req->length, _req->buf);
446 _req->status = -EINPROGRESS;
448 spin_lock_irqsave (&dum->lock, flags);
450 /* implement an emulated single-request FIFO */
451 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
452 list_empty (&dum->fifo_req.queue) &&
453 list_empty (&ep->queue) &&
454 _req->length <= FIFO_SIZE) {
455 req = &dum->fifo_req;
457 req->req.buf = dum->fifo_buf;
458 memcpy (dum->fifo_buf, _req->buf, _req->length);
459 req->req.context = dum;
460 req->req.complete = fifo_complete;
462 spin_unlock (&dum->lock);
463 _req->actual = _req->length;
465 _req->complete (_ep, _req);
466 spin_lock (&dum->lock);
468 list_add_tail (&req->queue, &ep->queue);
469 spin_unlock_irqrestore (&dum->lock, flags);
471 /* real hardware would likely enable transfers here, in case
472 * it'd been left NAKing.
477 static int dummy_dequeue (struct usb_ep *_ep, struct usb_request *_req)
481 int retval = -EINVAL;
483 struct dummy_request *req = 0;
485 if (!the_controller->driver)
490 ep = container_of (_ep, struct dummy_ep, ep);
491 dum = container_of (ep->gadget, struct dummy, gadget);
493 spin_lock_irqsave (&dum->lock, flags);
494 list_for_each_entry (req, &ep->queue, queue) {
495 if (&req->req == _req) {
496 list_del_init (&req->queue);
497 _req->status = -ECONNRESET;
502 spin_unlock_irqrestore (&dum->lock, flags);
505 dev_dbg (hardware, "dequeued req %p from %s, len %d buf %p\n",
506 req, _ep->name, _req->length, _req->buf);
508 _req->complete (_ep, _req);
514 dummy_set_halt (struct usb_ep *_ep, int value)
520 if (!the_controller->driver)
522 ep = container_of (_ep, struct dummy_ep, ep);
525 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
526 !list_empty (&ep->queue))
530 /* FIXME clear emulated data toggle too */
534 static const struct usb_ep_ops dummy_ep_ops = {
535 .enable = dummy_enable,
536 .disable = dummy_disable,
538 .alloc_request = dummy_alloc_request,
539 .free_request = dummy_free_request,
541 .alloc_buffer = dummy_alloc_buffer,
542 .free_buffer = dummy_free_buffer,
543 /* map, unmap, ... eventually hook the "generic" dma calls */
545 .queue = dummy_queue,
546 .dequeue = dummy_dequeue,
548 .set_halt = dummy_set_halt,
551 /*-------------------------------------------------------------------------*/
553 /* there are both host and device side versions of this call ... */
554 static int dummy_g_get_frame (struct usb_gadget *_gadget)
558 do_gettimeofday (&tv);
559 return tv.tv_usec / 1000;
562 static int dummy_wakeup (struct usb_gadget *_gadget)
566 dum = container_of (_gadget, struct dummy, gadget);
567 if ((dum->devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) == 0
568 || !(dum->port_status & (1 << USB_PORT_FEAT_SUSPEND)))
571 /* hub notices our request, issues downstream resume, etc */
573 dum->port_status |= (1 << USB_PORT_FEAT_C_SUSPEND);
577 static int dummy_set_selfpowered (struct usb_gadget *_gadget, int value)
581 dum = container_of (_gadget, struct dummy, gadget);
583 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
585 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
589 static const struct usb_gadget_ops dummy_ops = {
590 .get_frame = dummy_g_get_frame,
591 .wakeup = dummy_wakeup,
592 .set_selfpowered = dummy_set_selfpowered,
595 /*-------------------------------------------------------------------------*/
597 /* "function" sysfs attribute */
599 show_function (struct device *_dev, char *buf)
601 struct dummy *dum = the_controller;
603 if (!dum->driver->function
604 || strlen (dum->driver->function) > PAGE_SIZE)
606 return snprintf (buf, PAGE_SIZE, "%s\n", dum->driver->function);
608 DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
610 /*-------------------------------------------------------------------------*/
613 * Driver registration/unregistration.
615 * This is basically hardware-specific; there's usually only one real USB
616 * device (not host) controller since that's how USB devices are intended
617 * to work. So most implementations of these api calls will rely on the
618 * fact that only one driver will ever bind to the hardware. But curious
619 * hardware can be built with discrete components, so the gadget API doesn't
620 * require that assumption.
622 * For this emulator, it might be convenient to create a usb slave device
623 * for each driver that registers: just add to a big root hub.
627 dummy_udc_release (struct device *dev)
629 struct dummy *dum = gadget_dev_to_dummy (dev);
631 complete (&dum->released);
635 dummy_hc_release (struct device *dev)
637 struct dummy *dum = dev_get_drvdata (dev);
639 complete (&dum->released);
643 dummy_register_udc (struct dummy *dum)
647 strcpy (dum->gadget.dev.bus_id, "udc");
648 dum->gadget.dev.parent = &dum->pdev.dev;
649 dum->gadget.dev.release = dummy_udc_release;
651 rc = device_register (&dum->gadget.dev);
653 device_create_file (&dum->gadget.dev, &dev_attr_function);
658 dummy_unregister_udc (struct dummy *dum)
660 device_remove_file (&dum->gadget.dev, &dev_attr_function);
661 init_completion (&dum->released);
662 device_unregister (&dum->gadget.dev);
663 wait_for_completion (&dum->released);
667 usb_gadget_register_driver (struct usb_gadget_driver *driver)
669 struct dummy *dum = the_controller;
676 if (!driver->bind || !driver->unbind || !driver->setup
677 || driver->speed == USB_SPEED_UNKNOWN)
681 * SLAVE side init ... the layer above hardware, which
682 * can't enumerate without help from the driver we're binding.
684 dum->gadget.name = gadget_name;
685 dum->gadget.ops = &dummy_ops;
686 dum->gadget.is_dualspeed = 1;
691 INIT_LIST_HEAD (&dum->gadget.ep_list);
692 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
693 struct dummy_ep *ep = &dum->ep [i];
697 ep->ep.name = ep_name [i];
698 ep->ep.ops = &dummy_ep_ops;
699 list_add_tail (&ep->ep.ep_list, &dum->gadget.ep_list);
700 ep->halted = ep->already_seen = ep->setup_stage = 0;
701 ep->ep.maxpacket = ~0;
702 ep->last_io = jiffies;
703 ep->gadget = &dum->gadget;
705 INIT_LIST_HEAD (&ep->queue);
708 dum->gadget.ep0 = &dum->ep [0].ep;
709 dum->ep [0].ep.maxpacket = 64;
710 list_del_init (&dum->ep [0].ep.ep_list);
711 INIT_LIST_HEAD(&dum->fifo_req.queue);
713 dum->driver = driver;
714 dum->gadget.dev.driver = &driver->driver;
715 dev_dbg (hardware, "binding gadget driver '%s'\n", driver->driver.name);
716 if ((retval = driver->bind (&dum->gadget)) != 0) {
718 dum->gadget.dev.driver = 0;
722 // FIXME: Check these calls for errors and re-order
723 driver->driver.bus = dum->pdev.dev.bus;
724 driver_register (&driver->driver);
726 device_bind_driver (&dum->gadget.dev);
728 /* khubd will enumerate this in a while */
729 dum->port_status |= USB_PORT_STAT_CONNECTION
730 | (1 << USB_PORT_FEAT_C_CONNECTION);
733 EXPORT_SYMBOL (usb_gadget_register_driver);
735 /* caller must hold lock */
737 stop_activity (struct dummy *dum, struct usb_gadget_driver *driver)
741 /* prevent any more requests */
745 /* this might not succeed ... */
746 del_timer (&dum->timer);
748 /* nuke any pending requests first, so driver i/o is quiesced */
749 list_for_each_entry (ep, &dum->gadget.ep_list, ep.ep_list)
752 /* driver now does any non-usb quiescing necessary */
754 spin_unlock (&dum->lock);
755 driver->disconnect (&dum->gadget);
756 spin_lock (&dum->lock);
761 usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
763 struct dummy *dum = the_controller;
768 if (!driver || driver != dum->driver)
771 dev_dbg (hardware, "unregister gadget driver '%s'\n",
772 driver->driver.name);
774 spin_lock_irqsave (&dum->lock, flags);
775 stop_activity (dum, driver);
776 dum->port_status &= ~USB_PORT_STAT_CONNECTION;
777 dum->port_status |= (1 << USB_PORT_FEAT_C_CONNECTION);
778 spin_unlock_irqrestore (&dum->lock, flags);
780 driver->unbind (&dum->gadget);
783 device_release_driver (&dum->gadget.dev);
785 driver_unregister (&driver->driver);
787 del_timer_sync (&dum->timer);
790 EXPORT_SYMBOL (usb_gadget_unregister_driver);
794 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
798 EXPORT_SYMBOL (net2280_set_fifo_mode);
800 /*-------------------------------------------------------------------------*/
802 /* MASTER/HOST SIDE DRIVER
804 * this uses the hcd framework to hook up to host side drivers.
805 * its root hub will only have one device, otherwise it acts like
806 * a normal host controller.
808 * when urbs are queued, they're just stuck on a list that we
809 * scan in a timer callback. that callback connects writes from
810 * the host with reads from the device, and so on, based on the
814 static int dummy_urb_enqueue (
822 /* patch to usb_sg_init() is in 2.5.60 */
823 BUG_ON (!urb->transfer_buffer && urb->transfer_buffer_length);
825 dum = container_of (hcd, struct dummy, hcd);
826 spin_lock_irqsave (&dum->lock, flags);
829 dum->hdev = urb->dev->hcpriv;
831 if (usb_pipetype (urb->pipe) == PIPE_CONTROL)
832 urb->error_count = 1; /* mark as a new urb */
834 /* kick the scheduler, it'll do the rest */
835 if (!timer_pending (&dum->timer))
836 mod_timer (&dum->timer, jiffies + 1);
838 spin_unlock_irqrestore (&dum->lock, flags);
842 static int dummy_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
844 /* giveback happens automatically in timer callback */
848 static void maybe_set_status (struct urb *urb, int status)
850 spin_lock (&urb->lock);
851 if (urb->status == -EINPROGRESS)
852 urb->status = status;
853 spin_unlock (&urb->lock);
856 /* transfer up to a frame's worth; caller must own lock */
858 transfer (struct dummy *dum, struct urb *urb, struct dummy_ep *ep, int limit)
860 struct dummy_request *req;
863 /* if there's no request queued, the device is NAKing; return */
864 list_for_each_entry (req, &ep->queue, queue) {
865 unsigned host_len, dev_len, len;
866 int is_short, to_host;
869 /* 1..N packets of ep->ep.maxpacket each ... the last one
870 * may be short (including zero length).
872 * writer can send a zlp explicitly (length 0) or implicitly
873 * (length mod maxpacket zero, and 'zero' flag); they always
876 host_len = urb->transfer_buffer_length - urb->actual_length;
877 dev_len = req->req.length - req->req.actual;
878 len = min (host_len, dev_len);
880 /* FIXME update emulated data toggle too */
882 to_host = usb_pipein (urb->pipe);
883 if (unlikely (len == 0))
888 /* not enough bandwidth left? */
889 if (limit < ep->ep.maxpacket && limit < len)
891 len = min (len, (unsigned) limit);
895 /* use an extra pass for the final short packet */
896 if (len > ep->ep.maxpacket) {
898 len -= (len % ep->ep.maxpacket);
900 is_short = (len % ep->ep.maxpacket) != 0;
902 /* else transfer packet(s) */
903 ubuf = urb->transfer_buffer + urb->actual_length;
904 rbuf = req->req.buf + req->req.actual;
906 memcpy (ubuf, rbuf, len);
908 memcpy (rbuf, ubuf, len);
909 ep->last_io = jiffies;
912 urb->actual_length += len;
913 req->req.actual += len;
916 /* short packets terminate, maybe with overflow/underflow.
917 * it's only really an error to write too much.
919 * partially filling a buffer optionally blocks queue advances
920 * (so completion handlers can clean up the queue) but we don't
921 * need to emulate such data-in-flight. so we only show part
922 * of the URB_SHORT_NOT_OK effect: completion status.
925 if (host_len == dev_len) {
927 maybe_set_status (urb, 0);
928 } else if (to_host) {
930 if (dev_len > host_len)
931 maybe_set_status (urb, -EOVERFLOW);
933 maybe_set_status (urb,
937 } else if (!to_host) {
938 maybe_set_status (urb, 0);
939 if (host_len > dev_len)
940 req->req.status = -EOVERFLOW;
945 /* many requests terminate without a short packet */
947 if (req->req.length == req->req.actual
950 if (urb->transfer_buffer_length == urb->actual_length
951 && !(urb->transfer_flags
952 & URB_ZERO_PACKET)) {
953 maybe_set_status (urb, 0);
957 /* device side completion --> continuable */
958 if (req->req.status != -EINPROGRESS) {
959 list_del_init (&req->queue);
961 spin_unlock (&dum->lock);
962 req->req.complete (&ep->ep, &req->req);
963 spin_lock (&dum->lock);
965 /* requests might have been unlinked... */
969 /* host side completion --> terminate */
970 if (urb->status != -EINPROGRESS)
973 /* rescan to continue with any other queued i/o */
980 static int periodic_bytes (struct dummy *dum, struct dummy_ep *ep)
982 int limit = ep->ep.maxpacket;
984 if (dum->gadget.speed == USB_SPEED_HIGH) {
987 /* high bandwidth mode */
988 tmp = ep->desc->wMaxPacketSize;
989 tmp = le16_to_cpu (tmp);
990 tmp = (tmp >> 11) & 0x03;
991 tmp *= 8 /* applies to entire frame */;
992 limit += limit * tmp;
997 static struct dummy_ep *find_endpoint (struct dummy *dum, u8 address)
1001 if ((address & ~USB_DIR_IN) == 0)
1002 return &dum->ep [0];
1003 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1004 struct dummy_ep *ep = &dum->ep [i];
1008 if (ep->desc->bEndpointAddress == address)
1014 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1015 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1016 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1017 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1018 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1019 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1021 /* drive both sides of the transfers; looks like irq handlers to
1022 * both drivers except the callbacks aren't in_irq().
1024 static void dummy_timer (unsigned long _dum)
1026 struct dummy *dum = (struct dummy *) _dum;
1027 struct hcd_dev *hdev = dum->hdev;
1028 struct list_head *entry, *tmp;
1029 unsigned long flags;
1034 dev_err (hardware, "timer fired with device gone?\n");
1038 /* simplistic model for one frame's bandwidth */
1039 switch (dum->gadget.speed) {
1041 total = 8/*bytes*/ * 12/*packets*/;
1043 case USB_SPEED_FULL:
1044 total = 64/*bytes*/ * 19/*packets*/;
1046 case USB_SPEED_HIGH:
1047 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1050 dev_err (hardware, "bogus device speed\n");
1054 /* FIXME if HZ != 1000 this will probably misbehave ... */
1056 /* look at each urb queued by the host side driver */
1057 spin_lock_irqsave (&dum->lock, flags);
1058 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1061 dum->ep [i].already_seen = 0;
1065 list_for_each_safe (entry, tmp, &hdev->urb_list) {
1067 struct dummy_request *req;
1069 struct dummy_ep *ep = 0;
1072 urb = list_entry (entry, struct urb, urb_list);
1073 if (urb->status != -EINPROGRESS) {
1074 /* likely it was just unlinked */
1077 type = usb_pipetype (urb->pipe);
1079 /* used up this frame's non-periodic bandwidth?
1080 * FIXME there's infinite bandwidth for control and
1081 * periodic transfers ... unrealistic.
1083 if (total <= 0 && type == PIPE_BULK)
1086 /* find the gadget's ep for this request (if configured) */
1087 address = usb_pipeendpoint (urb->pipe);
1088 if (usb_pipein (urb->pipe))
1089 address |= USB_DIR_IN;
1090 ep = find_endpoint(dum, address);
1092 /* set_configuration() disagreement */
1094 "no ep configured for urb %p\n",
1096 maybe_set_status (urb, -ETIMEDOUT);
1100 if (ep->already_seen)
1102 ep->already_seen = 1;
1103 if (ep == &dum->ep [0] && urb->error_count) {
1104 ep->setup_stage = 1; /* a new urb */
1105 urb->error_count = 0;
1107 if (ep->halted && !ep->setup_stage) {
1108 /* NOTE: must not be iso! */
1109 dev_dbg (hardware, "ep %s halted, urb %p\n",
1111 maybe_set_status (urb, -EPIPE);
1114 /* FIXME make sure both ends agree on maxpacket */
1116 /* handle control requests */
1117 if (ep == &dum->ep [0] && ep->setup_stage) {
1118 struct usb_ctrlrequest setup;
1120 struct dummy_ep *ep2;
1122 setup = *(struct usb_ctrlrequest*) urb->setup_packet;
1123 le16_to_cpus (&setup.wIndex);
1124 le16_to_cpus (&setup.wValue);
1125 le16_to_cpus (&setup.wLength);
1126 if (setup.wLength != urb->transfer_buffer_length) {
1127 maybe_set_status (urb, -EOVERFLOW);
1131 /* paranoia, in case of stale queued data */
1132 list_for_each_entry (req, &ep->queue, queue) {
1133 list_del_init (&req->queue);
1134 req->req.status = -EOVERFLOW;
1135 dev_dbg (hardware, "stale req = %p\n", req);
1137 spin_unlock (&dum->lock);
1138 req->req.complete (&ep->ep, &req->req);
1139 spin_lock (&dum->lock);
1140 ep->already_seen = 0;
1144 /* gadget driver never sees set_address or operations
1145 * on standard feature flags. some hardware doesn't
1148 ep->last_io = jiffies;
1149 ep->setup_stage = 0;
1151 switch (setup.bRequest) {
1152 case USB_REQ_SET_ADDRESS:
1153 if (setup.bRequestType != Dev_Request)
1155 if (dum->address != 0) {
1156 maybe_set_status (urb, -ETIMEDOUT);
1157 urb->actual_length = 0;
1160 dum->address = setup.wValue;
1161 maybe_set_status (urb, 0);
1162 dev_dbg (hardware, "set_address = %d\n",
1166 case USB_REQ_SET_FEATURE:
1167 if (setup.bRequestType == Dev_Request) {
1169 switch (setup.wValue) {
1170 case USB_DEVICE_REMOTE_WAKEUP:
1173 value = -EOPNOTSUPP;
1177 (1 << setup.wValue);
1178 maybe_set_status (urb, 0);
1181 } else if (setup.bRequestType == Ep_Request) {
1183 ep2 = find_endpoint (dum,
1186 value = -EOPNOTSUPP;
1191 maybe_set_status (urb, 0);
1194 case USB_REQ_CLEAR_FEATURE:
1195 if (setup.bRequestType == Dev_Request) {
1196 switch (setup.wValue) {
1197 case USB_DEVICE_REMOTE_WAKEUP:
1198 dum->devstatus &= ~(1 <<
1199 USB_DEVICE_REMOTE_WAKEUP);
1201 maybe_set_status (urb, 0);
1204 value = -EOPNOTSUPP;
1207 } else if (setup.bRequestType == Ep_Request) {
1209 ep2 = find_endpoint (dum,
1212 value = -EOPNOTSUPP;
1217 maybe_set_status (urb, 0);
1220 case USB_REQ_GET_STATUS:
1221 if (setup.bRequestType == Dev_InRequest
1222 || setup.bRequestType
1224 || setup.bRequestType
1229 // device: remote wakeup, selfpowered
1230 // interface: nothing
1232 buf = (char *)urb->transfer_buffer;
1233 if (urb->transfer_buffer_length > 0) {
1234 if (setup.bRequestType ==
1236 ep2 = find_endpoint (dum, setup.wIndex);
1238 value = -EOPNOTSUPP;
1241 buf [0] = ep2->halted;
1242 } else if (setup.bRequestType ==
1249 if (urb->transfer_buffer_length > 1)
1251 urb->actual_length = min (2,
1252 urb->transfer_buffer_length);
1254 maybe_set_status (urb, 0);
1259 /* gadget driver handles all other requests. block
1260 * until setup() returns; no reentrancy issues etc.
1263 spin_unlock (&dum->lock);
1264 value = dum->driver->setup (&dum->gadget,
1266 spin_lock (&dum->lock);
1269 /* no delays (max 64KB data stage) */
1271 goto treat_control_like_bulk;
1273 /* error, see below */
1277 if (value != -EOPNOTSUPP)
1281 maybe_set_status (urb, -EPIPE);
1282 urb->actual_length = 0;
1288 /* non-control requests */
1290 switch (usb_pipetype (urb->pipe)) {
1291 case PIPE_ISOCHRONOUS:
1292 /* FIXME is it urb->interval since the last xfer?
1293 * use urb->iso_frame_desc[i].
1294 * complete whether or not ep has requests queued.
1295 * report random errors, to debug drivers.
1297 limit = max (limit, periodic_bytes (dum, ep));
1298 maybe_set_status (urb, -ENOSYS);
1301 case PIPE_INTERRUPT:
1302 /* FIXME is it urb->interval since the last xfer?
1303 * this almost certainly polls too fast.
1305 limit = max (limit, periodic_bytes (dum, ep));
1308 // case PIPE_BULK: case PIPE_CONTROL:
1310 treat_control_like_bulk:
1311 ep->last_io = jiffies;
1312 total = transfer (dum, urb, ep, limit);
1316 /* incomplete transfer? */
1317 if (urb->status == -EINPROGRESS)
1323 ep->already_seen = ep->setup_stage = 0;
1325 spin_unlock (&dum->lock);
1326 usb_hcd_giveback_urb (&dum->hcd, urb, 0);
1327 spin_lock (&dum->lock);
1332 /* want a 1 msec delay here */
1333 if (!list_empty (&hdev->urb_list))
1334 mod_timer (&dum->timer, jiffies + 1);
1336 spin_unlock_irqrestore (&dum->lock, flags);
1339 /*-------------------------------------------------------------------------*/
1341 #define PORT_C_MASK \
1342 ((1 << USB_PORT_FEAT_C_CONNECTION) \
1343 | (1 << USB_PORT_FEAT_C_ENABLE) \
1344 | (1 << USB_PORT_FEAT_C_SUSPEND) \
1345 | (1 << USB_PORT_FEAT_C_OVER_CURRENT) \
1346 | (1 << USB_PORT_FEAT_C_RESET))
1348 static int dummy_hub_status (struct usb_hcd *hcd, char *buf)
1351 unsigned long flags;
1354 dum = container_of (hcd, struct dummy, hcd);
1356 spin_lock_irqsave (&dum->lock, flags);
1357 if (!(dum->port_status & PORT_C_MASK))
1361 dev_dbg (hardware, "port status 0x%08x has changes\n",
1365 spin_unlock_irqrestore (&dum->lock, flags);
1370 hub_descriptor (struct usb_hub_descriptor *desc)
1372 memset (desc, 0, sizeof *desc);
1373 desc->bDescriptorType = 0x29;
1374 desc->bDescLength = 9;
1375 desc->wHubCharacteristics = __constant_cpu_to_le16 (0x0001);
1376 desc->bNbrPorts = 1;
1377 desc->bitmap [0] = 0xff;
1378 desc->bitmap [1] = 0xff;
1381 static int dummy_hub_control (
1382 struct usb_hcd *hcd,
1391 unsigned long flags;
1393 dum = container_of (hcd, struct dummy, hcd);
1394 spin_lock_irqsave (&dum->lock, flags);
1396 case ClearHubFeature:
1398 case ClearPortFeature:
1400 case USB_PORT_FEAT_SUSPEND:
1401 /* 20msec resume signaling */
1403 dum->re_timeout = jiffies + ((HZ * 20)/1000);
1405 case USB_PORT_FEAT_POWER:
1406 dum->port_status = 0;
1412 dum->port_status &= ~(1 << wValue);
1415 case GetHubDescriptor:
1416 hub_descriptor ((struct usb_hub_descriptor *) buf);
1419 *(u32 *) buf = __constant_cpu_to_le32 (0);
1425 /* whoever resets or resumes must GetPortStatus to
1428 if (dum->resuming && time_after (jiffies, dum->re_timeout)) {
1429 dum->port_status |= (1 << USB_PORT_FEAT_C_SUSPEND);
1430 dum->port_status &= ~(1 << USB_PORT_FEAT_SUSPEND);
1432 dum->re_timeout = 0;
1433 if (dum->driver->resume) {
1434 spin_unlock (&dum->lock);
1435 dum->driver->resume (&dum->gadget);
1436 spin_lock (&dum->lock);
1439 if ((dum->port_status & (1 << USB_PORT_FEAT_RESET)) != 0
1440 && time_after (jiffies, dum->re_timeout)) {
1441 dum->port_status |= (1 << USB_PORT_FEAT_C_RESET);
1442 dum->port_status &= ~(1 << USB_PORT_FEAT_RESET);
1443 dum->re_timeout = 0;
1445 dum->port_status |= USB_PORT_STAT_ENABLE;
1446 /* give it the best speed we agree on */
1447 dum->gadget.speed = dum->driver->speed;
1448 dum->gadget.ep0->maxpacket = 64;
1449 switch (dum->gadget.speed) {
1450 case USB_SPEED_HIGH:
1452 USB_PORT_STAT_HIGH_SPEED;
1455 dum->gadget.ep0->maxpacket = 8;
1457 USB_PORT_STAT_LOW_SPEED;
1460 dum->gadget.speed = USB_SPEED_FULL;
1465 ((u16 *) buf)[0] = cpu_to_le16 (dum->port_status);
1466 ((u16 *) buf)[1] = cpu_to_le16 (dum->port_status >> 16);
1471 case SetPortFeature:
1473 case USB_PORT_FEAT_SUSPEND:
1474 dum->port_status |= (1 << USB_PORT_FEAT_SUSPEND);
1475 if (dum->driver->suspend) {
1476 spin_unlock (&dum->lock);
1477 dum->driver->suspend (&dum->gadget);
1478 spin_lock (&dum->lock);
1481 case USB_PORT_FEAT_RESET:
1482 /* if it's already running, disconnect first */
1483 if (dum->port_status & USB_PORT_STAT_ENABLE) {
1484 dum->port_status &= ~(USB_PORT_STAT_ENABLE
1485 | USB_PORT_STAT_LOW_SPEED
1486 | USB_PORT_STAT_HIGH_SPEED);
1488 dev_dbg (hardware, "disconnect\n");
1489 stop_activity (dum, dum->driver);
1492 /* FIXME test that code path! */
1494 /* 50msec reset signaling */
1495 dum->re_timeout = jiffies + ((HZ * 50)/1000);
1498 dum->port_status |= (1 << wValue);
1504 "hub control req%04x v%04x i%04x l%d\n",
1505 typeReq, wValue, wIndex, wLength);
1507 /* "protocol stall" on error */
1510 spin_unlock_irqrestore (&dum->lock, flags);
1515 /*-------------------------------------------------------------------------*/
1517 static struct usb_hcd *dummy_alloc (void)
1521 dum = kmalloc (sizeof *dum, SLAB_KERNEL);
1524 memset (dum, 0, sizeof *dum);
1528 static void dummy_free (struct usb_hcd *hcd)
1532 dum = container_of (hcd, struct dummy, hcd);
1533 WARN_ON (dum->driver != 0);
1537 /*-------------------------------------------------------------------------*/
1539 static inline ssize_t
1540 show_urb (char *buf, size_t size, struct urb *urb)
1542 int ep = usb_pipeendpoint (urb->pipe);
1544 return snprintf (buf, size,
1545 "urb/%p %s ep%d%s%s len %d/%d\n",
1548 switch (urb->dev->speed) {
1549 case USB_SPEED_LOW: s = "ls"; break;
1550 case USB_SPEED_FULL: s = "fs"; break;
1551 case USB_SPEED_HIGH: s = "hs"; break;
1552 default: s = "?"; break;
1554 ep, ep ? (usb_pipein (urb->pipe) ? "in" : "out") : "",
1556 switch (usb_pipetype (urb->pipe)) { \
1557 case PIPE_CONTROL: s = ""; break; \
1558 case PIPE_BULK: s = "-bulk"; break; \
1559 case PIPE_INTERRUPT: s = "-int"; break; \
1560 default: s = "-iso"; break; \
1562 urb->actual_length, urb->transfer_buffer_length);
1566 show_urbs (struct device *dev, char *buf)
1568 struct dummy *dum = dev_get_drvdata(dev);
1571 unsigned long flags;
1573 spin_lock_irqsave (&dum->lock, flags);
1575 list_for_each_entry (urb, &dum->hdev->urb_list, urb_list) {
1578 temp = show_urb (buf, PAGE_SIZE - size, urb);
1583 spin_unlock_irqrestore (&dum->lock, flags);
1587 static DEVICE_ATTR (urbs, S_IRUGO, show_urbs, NULL);
1590 static const struct hc_driver dummy_hcd;
1592 static int dummy_start (struct usb_hcd *hcd)
1595 struct usb_bus *bus;
1596 struct usb_device *root;
1599 dum = container_of (hcd, struct dummy, hcd);
1602 * MASTER side init ... we emulate a root hub that'll only ever
1603 * talk to one device (the slave side). Also appears in sysfs,
1604 * just like more familiar pci-based HCDs.
1606 spin_lock_init (&dum->lock);
1608 retval = driver_register (&dummy_driver);
1612 dum->pdev.name = "hc";
1613 dum->pdev.dev.driver = &dummy_driver;
1614 dev_set_drvdata(&dum->pdev.dev, dum);
1615 dum->pdev.dev.release = dummy_hc_release;
1616 retval = platform_device_register (&dum->pdev);
1618 driver_unregister (&dummy_driver);
1621 dev_info (&dum->pdev.dev, "%s, driver " DRIVER_VERSION "\n",
1624 hcd->self.controller = &dum->pdev.dev;
1626 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
1627 device_create_file (hcd->self.controller, &dev_attr_urbs);
1629 init_timer (&dum->timer);
1630 dum->timer.function = dummy_timer;
1631 dum->timer.data = (unsigned long) dum;
1633 /* root hub will appear as another device */
1634 dum->hcd.driver = (struct hc_driver *) &dummy_hcd;
1635 dum->hcd.description = dummy_hcd.description;
1636 dum->hcd.product_desc = "Dummy host controller";
1638 bus = hcd_to_bus (&dum->hcd);
1639 bus->bus_name = dum->pdev.dev.bus_id;
1641 bus->op = &usb_hcd_operations;
1642 bus->hcpriv = &dum->hcd;
1644 /* FIXME don't require the pci-based buffer/alloc impls;
1645 * the "generic dma" implementation still requires them,
1646 * it's not very generic yet.
1648 if ((retval = hcd_buffer_create (&dum->hcd)) != 0) {
1650 init_completion (&dum->released);
1651 platform_device_unregister (&dum->pdev);
1652 wait_for_completion (&dum->released);
1653 driver_unregister (&dummy_driver);
1657 INIT_LIST_HEAD (&hcd->dev_list);
1658 usb_register_bus (bus);
1660 bus->root_hub = root = usb_alloc_dev (0, bus, 0);
1664 hcd_buffer_destroy (&dum->hcd);
1665 usb_deregister_bus (bus);
1669 /* root hub enters addressed state... */
1670 dum->hcd.state = USB_STATE_RUNNING;
1671 root->speed = USB_SPEED_HIGH;
1673 /* ...then configured, so khubd sees us. */
1674 if ((retval = hcd_register_root (&dum->hcd)) != 0) {
1678 dum->hcd.state = USB_STATE_QUIESCING;
1684 if ((retval = dummy_register_udc (dum)) != 0) {
1686 usb_disconnect (&bus->root_hub);
1692 static void dummy_stop (struct usb_hcd *hcd)
1695 struct usb_bus *bus;
1697 dum = container_of (hcd, struct dummy, hcd);
1702 usb_gadget_unregister_driver (dum->driver);
1703 dummy_unregister_udc (dum);
1705 bus = hcd_to_bus (&dum->hcd);
1706 hcd->state = USB_STATE_QUIESCING;
1707 dev_dbg (hardware, "remove root hub\n");
1708 usb_disconnect (&bus->root_hub);
1710 hcd_buffer_destroy (&dum->hcd);
1711 usb_deregister_bus (bus);
1713 dev_info (hardware, "stopped\n");
1715 device_remove_file (hcd->self.controller, &dev_attr_urbs);
1716 init_completion (&dum->released);
1717 platform_device_unregister (&dum->pdev);
1718 wait_for_completion (&dum->released);
1720 driver_unregister (&dummy_driver);
1723 /*-------------------------------------------------------------------------*/
1725 static int dummy_h_get_frame (struct usb_hcd *hcd)
1727 return dummy_g_get_frame (0);
1730 static const struct hc_driver dummy_hcd = {
1731 .description = (char *) driver_name,
1734 .start = dummy_start,
1737 .hcd_alloc = dummy_alloc,
1738 .hcd_free = dummy_free,
1740 .urb_enqueue = dummy_urb_enqueue,
1741 .urb_dequeue = dummy_urb_dequeue,
1743 .get_frame_number = dummy_h_get_frame,
1745 .hub_status_data = dummy_hub_status,
1746 .hub_control = dummy_hub_control,
1749 /*-------------------------------------------------------------------------*/
1751 static int __init init (void)
1753 struct usb_hcd *hcd;
1756 if (usb_disabled ())
1758 if ((hcd = dummy_alloc ()) == 0)
1761 the_controller = container_of (hcd, struct dummy, hcd);
1762 value = dummy_start (hcd);
1772 static void __exit cleanup (void)
1774 dummy_stop (&the_controller->hcd);
1775 dummy_free (&the_controller->hcd);
1778 module_exit (cleanup);