[PATCH] USB: Rename hcd->hub_suspend to hcd->bus_suspend
[linux/fpc-iii.git] / drivers / usb / gadget / dummy_hcd.c
blobc605aaeed6367c82fd890f5f5b61da47149c7434
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.
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.
37 #define DEBUG
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>
58 #include <asm/io.h>
59 #include <asm/irq.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 "02 May 2005"
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 */
82 struct dummy_ep {
83 struct list_head queue;
84 unsigned long last_io; /* jiffies timestamp */
85 struct usb_gadget *gadget;
86 const struct usb_endpoint_descriptor *desc;
87 struct usb_ep ep;
88 unsigned halted : 1;
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 static inline struct dummy_ep *usb_ep_to_dummy_ep (struct usb_ep *_ep)
100 return container_of (_ep, struct dummy_ep, ep);
103 static inline struct dummy_request *usb_request_to_dummy_request
104 (struct usb_request *_req)
106 return container_of (_req, struct dummy_request, req);
109 /*-------------------------------------------------------------------------*/
112 * Every device has ep0 for control requests, plus up to 30 more endpoints,
113 * in one of two types:
115 * - Configurable: direction (in/out), type (bulk, iso, etc), and endpoint
116 * number can be changed. Names like "ep-a" are used for this type.
118 * - Fixed Function: in other cases. some characteristics may be mutable;
119 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
121 * Gadget drivers are responsible for not setting up conflicting endpoint
122 * configurations, illegal or unsupported packet lengths, and so on.
125 static const char ep0name [] = "ep0";
127 static const char *const ep_name [] = {
128 ep0name, /* everyone has ep0 */
130 /* act like a net2280: high speed, six configurable endpoints */
131 "ep-a", "ep-b", "ep-c", "ep-d", "ep-e", "ep-f",
133 /* or like 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 #define DUMMY_ENDPOINTS (sizeof(ep_name)/sizeof(char *))
144 /*-------------------------------------------------------------------------*/
146 #define FIFO_SIZE 64
148 struct urbp {
149 struct urb *urb;
150 struct list_head urbp_list;
154 enum dummy_rh_state {
155 DUMMY_RH_RESET,
156 DUMMY_RH_SUSPENDED,
157 DUMMY_RH_RUNNING
160 struct dummy {
161 spinlock_t lock;
164 * SLAVE/GADGET side support
166 struct dummy_ep ep [DUMMY_ENDPOINTS];
167 int address;
168 struct usb_gadget gadget;
169 struct usb_gadget_driver *driver;
170 struct dummy_request fifo_req;
171 u8 fifo_buf [FIFO_SIZE];
172 u16 devstatus;
173 unsigned udc_suspended:1;
174 unsigned pullup:1;
175 unsigned active:1;
176 unsigned old_active:1;
179 * MASTER/HOST side support
181 enum dummy_rh_state rh_state;
182 struct timer_list timer;
183 u32 port_status;
184 u32 old_status;
185 unsigned resuming:1;
186 unsigned long re_timeout;
188 struct usb_device *udev;
189 struct list_head urbp_list;
192 static inline struct dummy *hcd_to_dummy (struct usb_hcd *hcd)
194 return (struct dummy *) (hcd->hcd_priv);
197 static inline struct usb_hcd *dummy_to_hcd (struct dummy *dum)
199 return container_of((void *) dum, struct usb_hcd, hcd_priv);
202 static inline struct device *dummy_dev (struct dummy *dum)
204 return dummy_to_hcd(dum)->self.controller;
207 static inline struct device *udc_dev (struct dummy *dum)
209 return dum->gadget.dev.parent;
212 static inline struct dummy *ep_to_dummy (struct dummy_ep *ep)
214 return container_of (ep->gadget, struct dummy, gadget);
217 static inline struct dummy *gadget_to_dummy (struct usb_gadget *gadget)
219 return container_of (gadget, struct dummy, gadget);
222 static inline struct dummy *gadget_dev_to_dummy (struct device *dev)
224 return container_of (dev, struct dummy, gadget.dev);
227 static struct dummy *the_controller;
229 /*-------------------------------------------------------------------------*/
231 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
233 /* called with spinlock held */
234 static void nuke (struct dummy *dum, struct dummy_ep *ep)
236 while (!list_empty (&ep->queue)) {
237 struct dummy_request *req;
239 req = list_entry (ep->queue.next, struct dummy_request, queue);
240 list_del_init (&req->queue);
241 req->req.status = -ESHUTDOWN;
243 spin_unlock (&dum->lock);
244 req->req.complete (&ep->ep, &req->req);
245 spin_lock (&dum->lock);
249 /* caller must hold lock */
250 static void
251 stop_activity (struct dummy *dum)
253 struct dummy_ep *ep;
255 /* prevent any more requests */
256 dum->address = 0;
258 /* The timer is left running so that outstanding URBs can fail */
260 /* nuke any pending requests first, so driver i/o is quiesced */
261 list_for_each_entry (ep, &dum->gadget.ep_list, ep.ep_list)
262 nuke (dum, ep);
264 /* driver now does any non-usb quiescing necessary */
267 /* caller must hold lock */
268 static void
269 set_link_state (struct dummy *dum)
271 dum->active = 0;
272 if ((dum->port_status & USB_PORT_STAT_POWER) == 0)
273 dum->port_status = 0;
275 /* UDC suspend must cause a disconnect */
276 else if (!dum->pullup || dum->udc_suspended) {
277 dum->port_status &= ~(USB_PORT_STAT_CONNECTION |
278 USB_PORT_STAT_ENABLE |
279 USB_PORT_STAT_LOW_SPEED |
280 USB_PORT_STAT_HIGH_SPEED |
281 USB_PORT_STAT_SUSPEND);
282 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0)
283 dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
284 } else {
285 dum->port_status |= USB_PORT_STAT_CONNECTION;
286 if ((dum->old_status & USB_PORT_STAT_CONNECTION) == 0)
287 dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
288 if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0)
289 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
290 else if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
291 dum->rh_state != DUMMY_RH_SUSPENDED)
292 dum->active = 1;
295 if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0 || dum->active)
296 dum->resuming = 0;
298 if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0 ||
299 (dum->port_status & USB_PORT_STAT_RESET) != 0) {
300 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0 &&
301 (dum->old_status & USB_PORT_STAT_RESET) == 0 &&
302 dum->driver) {
303 stop_activity (dum);
304 spin_unlock (&dum->lock);
305 dum->driver->disconnect (&dum->gadget);
306 spin_lock (&dum->lock);
308 } else if (dum->active != dum->old_active) {
309 if (dum->old_active && dum->driver->suspend) {
310 spin_unlock (&dum->lock);
311 dum->driver->suspend (&dum->gadget);
312 spin_lock (&dum->lock);
313 } else if (!dum->old_active && dum->driver->resume) {
314 spin_unlock (&dum->lock);
315 dum->driver->resume (&dum->gadget);
316 spin_lock (&dum->lock);
320 dum->old_status = dum->port_status;
321 dum->old_active = dum->active;
324 /*-------------------------------------------------------------------------*/
326 /* SLAVE/GADGET SIDE DRIVER
328 * This only tracks gadget state. All the work is done when the host
329 * side tries some (emulated) i/o operation. Real device controller
330 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
333 #define is_enabled(dum) \
334 (dum->port_status & USB_PORT_STAT_ENABLE)
336 static int
337 dummy_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
339 struct dummy *dum;
340 struct dummy_ep *ep;
341 unsigned max;
342 int retval;
344 ep = usb_ep_to_dummy_ep (_ep);
345 if (!_ep || !desc || ep->desc || _ep->name == ep0name
346 || desc->bDescriptorType != USB_DT_ENDPOINT)
347 return -EINVAL;
348 dum = ep_to_dummy (ep);
349 if (!dum->driver || !is_enabled (dum))
350 return -ESHUTDOWN;
351 max = le16_to_cpu(desc->wMaxPacketSize) & 0x3ff;
353 /* drivers must not request bad settings, since lower levels
354 * (hardware or its drivers) may not check. some endpoints
355 * can't do iso, many have maxpacket limitations, etc.
357 * since this "hardware" driver is here to help debugging, we
358 * have some extra sanity checks. (there could be more though,
359 * especially for "ep9out" style fixed function ones.)
361 retval = -EINVAL;
362 switch (desc->bmAttributes & 0x03) {
363 case USB_ENDPOINT_XFER_BULK:
364 if (strstr (ep->ep.name, "-iso")
365 || strstr (ep->ep.name, "-int")) {
366 goto done;
368 switch (dum->gadget.speed) {
369 case USB_SPEED_HIGH:
370 if (max == 512)
371 break;
372 /* conserve return statements */
373 default:
374 switch (max) {
375 case 8: case 16: case 32: case 64:
376 /* we'll fake any legal size */
377 break;
378 default:
379 case USB_SPEED_LOW:
380 goto done;
383 break;
384 case USB_ENDPOINT_XFER_INT:
385 if (strstr (ep->ep.name, "-iso")) /* bulk is ok */
386 goto done;
387 /* real hardware might not handle all packet sizes */
388 switch (dum->gadget.speed) {
389 case USB_SPEED_HIGH:
390 if (max <= 1024)
391 break;
392 /* save a return statement */
393 case USB_SPEED_FULL:
394 if (max <= 64)
395 break;
396 /* save a return statement */
397 default:
398 if (max <= 8)
399 break;
400 goto done;
402 break;
403 case USB_ENDPOINT_XFER_ISOC:
404 if (strstr (ep->ep.name, "-bulk")
405 || strstr (ep->ep.name, "-int"))
406 goto done;
407 /* real hardware might not handle all packet sizes */
408 switch (dum->gadget.speed) {
409 case USB_SPEED_HIGH:
410 if (max <= 1024)
411 break;
412 /* save a return statement */
413 case USB_SPEED_FULL:
414 if (max <= 1023)
415 break;
416 /* save a return statement */
417 default:
418 goto done;
420 break;
421 default:
422 /* few chips support control except on ep0 */
423 goto done;
426 _ep->maxpacket = max;
427 ep->desc = desc;
429 dev_dbg (udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d\n",
430 _ep->name,
431 desc->bEndpointAddress & 0x0f,
432 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
433 ({ char *val;
434 switch (desc->bmAttributes & 0x03) {
435 case USB_ENDPOINT_XFER_BULK: val = "bulk"; break;
436 case USB_ENDPOINT_XFER_ISOC: val = "iso"; break;
437 case USB_ENDPOINT_XFER_INT: val = "intr"; break;
438 default: val = "ctrl"; break;
439 }; val; }),
440 max);
442 /* at this point real hardware should be NAKing transfers
443 * to that endpoint, until a buffer is queued to it.
445 retval = 0;
446 done:
447 return retval;
450 static int dummy_disable (struct usb_ep *_ep)
452 struct dummy_ep *ep;
453 struct dummy *dum;
454 unsigned long flags;
455 int retval;
457 ep = usb_ep_to_dummy_ep (_ep);
458 if (!_ep || !ep->desc || _ep->name == ep0name)
459 return -EINVAL;
460 dum = ep_to_dummy (ep);
462 spin_lock_irqsave (&dum->lock, flags);
463 ep->desc = NULL;
464 retval = 0;
465 nuke (dum, ep);
466 spin_unlock_irqrestore (&dum->lock, flags);
468 dev_dbg (udc_dev(dum), "disabled %s\n", _ep->name);
469 return retval;
472 static struct usb_request *
473 dummy_alloc_request (struct usb_ep *_ep, gfp_t mem_flags)
475 struct dummy_ep *ep;
476 struct dummy_request *req;
478 if (!_ep)
479 return NULL;
480 ep = usb_ep_to_dummy_ep (_ep);
482 req = kmalloc (sizeof *req, mem_flags);
483 if (!req)
484 return NULL;
485 memset (req, 0, sizeof *req);
486 INIT_LIST_HEAD (&req->queue);
487 return &req->req;
490 static void
491 dummy_free_request (struct usb_ep *_ep, struct usb_request *_req)
493 struct dummy_ep *ep;
494 struct dummy_request *req;
496 ep = usb_ep_to_dummy_ep (_ep);
497 if (!ep || !_req || (!ep->desc && _ep->name != ep0name))
498 return;
500 req = usb_request_to_dummy_request (_req);
501 WARN_ON (!list_empty (&req->queue));
502 kfree (req);
505 static void *
506 dummy_alloc_buffer (
507 struct usb_ep *_ep,
508 unsigned bytes,
509 dma_addr_t *dma,
510 gfp_t mem_flags
512 char *retval;
513 struct dummy_ep *ep;
514 struct dummy *dum;
516 ep = usb_ep_to_dummy_ep (_ep);
517 dum = ep_to_dummy (ep);
519 if (!dum->driver)
520 return NULL;
521 retval = kmalloc (bytes, mem_flags);
522 *dma = (dma_addr_t) retval;
523 return retval;
526 static void
527 dummy_free_buffer (
528 struct usb_ep *_ep,
529 void *buf,
530 dma_addr_t dma,
531 unsigned bytes
533 if (bytes)
534 kfree (buf);
537 static void
538 fifo_complete (struct usb_ep *ep, struct usb_request *req)
542 static int
543 dummy_queue (struct usb_ep *_ep, struct usb_request *_req,
544 gfp_t mem_flags)
546 struct dummy_ep *ep;
547 struct dummy_request *req;
548 struct dummy *dum;
549 unsigned long flags;
551 req = usb_request_to_dummy_request (_req);
552 if (!_req || !list_empty (&req->queue) || !_req->complete)
553 return -EINVAL;
555 ep = usb_ep_to_dummy_ep (_ep);
556 if (!_ep || (!ep->desc && _ep->name != ep0name))
557 return -EINVAL;
559 dum = ep_to_dummy (ep);
560 if (!dum->driver || !is_enabled (dum))
561 return -ESHUTDOWN;
563 #if 0
564 dev_dbg (udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
565 ep, _req, _ep->name, _req->length, _req->buf);
566 #endif
568 _req->status = -EINPROGRESS;
569 _req->actual = 0;
570 spin_lock_irqsave (&dum->lock, flags);
572 /* implement an emulated single-request FIFO */
573 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
574 list_empty (&dum->fifo_req.queue) &&
575 list_empty (&ep->queue) &&
576 _req->length <= FIFO_SIZE) {
577 req = &dum->fifo_req;
578 req->req = *_req;
579 req->req.buf = dum->fifo_buf;
580 memcpy (dum->fifo_buf, _req->buf, _req->length);
581 req->req.context = dum;
582 req->req.complete = fifo_complete;
584 spin_unlock (&dum->lock);
585 _req->actual = _req->length;
586 _req->status = 0;
587 _req->complete (_ep, _req);
588 spin_lock (&dum->lock);
590 list_add_tail (&req->queue, &ep->queue);
591 spin_unlock_irqrestore (&dum->lock, flags);
593 /* real hardware would likely enable transfers here, in case
594 * it'd been left NAKing.
596 return 0;
599 static int dummy_dequeue (struct usb_ep *_ep, struct usb_request *_req)
601 struct dummy_ep *ep;
602 struct dummy *dum;
603 int retval = -EINVAL;
604 unsigned long flags;
605 struct dummy_request *req = NULL;
607 if (!_ep || !_req)
608 return retval;
609 ep = usb_ep_to_dummy_ep (_ep);
610 dum = ep_to_dummy (ep);
612 if (!dum->driver)
613 return -ESHUTDOWN;
615 spin_lock_irqsave (&dum->lock, flags);
616 list_for_each_entry (req, &ep->queue, queue) {
617 if (&req->req == _req) {
618 list_del_init (&req->queue);
619 _req->status = -ECONNRESET;
620 retval = 0;
621 break;
624 spin_unlock_irqrestore (&dum->lock, flags);
626 if (retval == 0) {
627 dev_dbg (udc_dev(dum),
628 "dequeued req %p from %s, len %d buf %p\n",
629 req, _ep->name, _req->length, _req->buf);
630 _req->complete (_ep, _req);
632 return retval;
635 static int
636 dummy_set_halt (struct usb_ep *_ep, int value)
638 struct dummy_ep *ep;
639 struct dummy *dum;
641 if (!_ep)
642 return -EINVAL;
643 ep = usb_ep_to_dummy_ep (_ep);
644 dum = ep_to_dummy (ep);
645 if (!dum->driver)
646 return -ESHUTDOWN;
647 if (!value)
648 ep->halted = 0;
649 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
650 !list_empty (&ep->queue))
651 return -EAGAIN;
652 else
653 ep->halted = 1;
654 /* FIXME clear emulated data toggle too */
655 return 0;
658 static const struct usb_ep_ops dummy_ep_ops = {
659 .enable = dummy_enable,
660 .disable = dummy_disable,
662 .alloc_request = dummy_alloc_request,
663 .free_request = dummy_free_request,
665 .alloc_buffer = dummy_alloc_buffer,
666 .free_buffer = dummy_free_buffer,
667 /* map, unmap, ... eventually hook the "generic" dma calls */
669 .queue = dummy_queue,
670 .dequeue = dummy_dequeue,
672 .set_halt = dummy_set_halt,
675 /*-------------------------------------------------------------------------*/
677 /* there are both host and device side versions of this call ... */
678 static int dummy_g_get_frame (struct usb_gadget *_gadget)
680 struct timeval tv;
682 do_gettimeofday (&tv);
683 return tv.tv_usec / 1000;
686 static int dummy_wakeup (struct usb_gadget *_gadget)
688 struct dummy *dum;
690 dum = gadget_to_dummy (_gadget);
691 if (!(dum->devstatus & ( (1 << USB_DEVICE_B_HNP_ENABLE)
692 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
693 return -EINVAL;
694 if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0)
695 return -ENOLINK;
696 if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
697 dum->rh_state != DUMMY_RH_SUSPENDED)
698 return -EIO;
700 /* FIXME: What if the root hub is suspended but the port isn't? */
702 /* hub notices our request, issues downstream resume, etc */
703 dum->resuming = 1;
704 dum->re_timeout = jiffies + msecs_to_jiffies(20);
705 mod_timer (&dummy_to_hcd (dum)->rh_timer, dum->re_timeout);
706 return 0;
709 static int dummy_set_selfpowered (struct usb_gadget *_gadget, int value)
711 struct dummy *dum;
713 dum = gadget_to_dummy (_gadget);
714 if (value)
715 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
716 else
717 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
718 return 0;
721 static int dummy_pullup (struct usb_gadget *_gadget, int value)
723 struct dummy *dum;
724 unsigned long flags;
726 dum = gadget_to_dummy (_gadget);
727 spin_lock_irqsave (&dum->lock, flags);
728 dum->pullup = (value != 0);
729 set_link_state (dum);
730 spin_unlock_irqrestore (&dum->lock, flags);
732 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
733 return 0;
736 static const struct usb_gadget_ops dummy_ops = {
737 .get_frame = dummy_g_get_frame,
738 .wakeup = dummy_wakeup,
739 .set_selfpowered = dummy_set_selfpowered,
740 .pullup = dummy_pullup,
743 /*-------------------------------------------------------------------------*/
745 /* "function" sysfs attribute */
746 static ssize_t
747 show_function (struct device *dev, struct device_attribute *attr, char *buf)
749 struct dummy *dum = gadget_dev_to_dummy (dev);
751 if (!dum->driver || !dum->driver->function)
752 return 0;
753 return scnprintf (buf, PAGE_SIZE, "%s\n", dum->driver->function);
755 static DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
757 /*-------------------------------------------------------------------------*/
760 * Driver registration/unregistration.
762 * This is basically hardware-specific; there's usually only one real USB
763 * device (not host) controller since that's how USB devices are intended
764 * to work. So most implementations of these api calls will rely on the
765 * fact that only one driver will ever bind to the hardware. But curious
766 * hardware can be built with discrete components, so the gadget API doesn't
767 * require that assumption.
769 * For this emulator, it might be convenient to create a usb slave device
770 * for each driver that registers: just add to a big root hub.
774 usb_gadget_register_driver (struct usb_gadget_driver *driver)
776 struct dummy *dum = the_controller;
777 int retval, i;
779 if (!dum)
780 return -EINVAL;
781 if (dum->driver)
782 return -EBUSY;
783 if (!driver->bind || !driver->unbind || !driver->setup
784 || driver->speed == USB_SPEED_UNKNOWN)
785 return -EINVAL;
788 * SLAVE side init ... the layer above hardware, which
789 * can't enumerate without help from the driver we're binding.
792 dum->devstatus = 0;
794 INIT_LIST_HEAD (&dum->gadget.ep_list);
795 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
796 struct dummy_ep *ep = &dum->ep [i];
798 if (!ep_name [i])
799 break;
800 ep->ep.name = ep_name [i];
801 ep->ep.ops = &dummy_ep_ops;
802 list_add_tail (&ep->ep.ep_list, &dum->gadget.ep_list);
803 ep->halted = ep->already_seen = ep->setup_stage = 0;
804 ep->ep.maxpacket = ~0;
805 ep->last_io = jiffies;
806 ep->gadget = &dum->gadget;
807 ep->desc = NULL;
808 INIT_LIST_HEAD (&ep->queue);
811 dum->gadget.ep0 = &dum->ep [0].ep;
812 dum->ep [0].ep.maxpacket = 64;
813 list_del_init (&dum->ep [0].ep.ep_list);
814 INIT_LIST_HEAD(&dum->fifo_req.queue);
816 dum->driver = driver;
817 dum->gadget.dev.driver = &driver->driver;
818 dev_dbg (udc_dev(dum), "binding gadget driver '%s'\n",
819 driver->driver.name);
820 if ((retval = driver->bind (&dum->gadget)) != 0) {
821 dum->driver = NULL;
822 dum->gadget.dev.driver = NULL;
823 return retval;
826 driver->driver.bus = dum->gadget.dev.parent->bus;
827 driver_register (&driver->driver);
828 device_bind_driver (&dum->gadget.dev);
830 /* khubd will enumerate this in a while */
831 spin_lock_irq (&dum->lock);
832 dum->pullup = 1;
833 set_link_state (dum);
834 spin_unlock_irq (&dum->lock);
836 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
837 return 0;
839 EXPORT_SYMBOL (usb_gadget_register_driver);
842 usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
844 struct dummy *dum = the_controller;
845 unsigned long flags;
847 if (!dum)
848 return -ENODEV;
849 if (!driver || driver != dum->driver)
850 return -EINVAL;
852 dev_dbg (udc_dev(dum), "unregister gadget driver '%s'\n",
853 driver->driver.name);
855 spin_lock_irqsave (&dum->lock, flags);
856 dum->pullup = 0;
857 set_link_state (dum);
858 spin_unlock_irqrestore (&dum->lock, flags);
860 driver->unbind (&dum->gadget);
861 dum->driver = NULL;
863 device_release_driver (&dum->gadget.dev);
864 driver_unregister (&driver->driver);
866 spin_lock_irqsave (&dum->lock, flags);
867 dum->pullup = 0;
868 set_link_state (dum);
869 spin_unlock_irqrestore (&dum->lock, flags);
871 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
872 return 0;
874 EXPORT_SYMBOL (usb_gadget_unregister_driver);
876 #undef is_enabled
878 /* just declare this in any driver that really need it */
879 extern int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode);
881 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
883 return -ENOSYS;
885 EXPORT_SYMBOL (net2280_set_fifo_mode);
888 /* The gadget structure is stored inside the hcd structure and will be
889 * released along with it. */
890 static void
891 dummy_gadget_release (struct device *dev)
893 #if 0 /* usb_bus_put isn't EXPORTed! */
894 struct dummy *dum = gadget_dev_to_dummy (dev);
896 usb_bus_put (&dummy_to_hcd (dum)->self);
897 #endif
900 static int dummy_udc_probe (struct device *dev)
902 struct dummy *dum = the_controller;
903 int rc;
905 dum->gadget.name = gadget_name;
906 dum->gadget.ops = &dummy_ops;
907 dum->gadget.is_dualspeed = 1;
909 /* maybe claim OTG support, though we won't complete HNP */
910 dum->gadget.is_otg = (dummy_to_hcd(dum)->self.otg_port != 0);
912 strcpy (dum->gadget.dev.bus_id, "gadget");
913 dum->gadget.dev.parent = dev;
914 dum->gadget.dev.release = dummy_gadget_release;
915 rc = device_register (&dum->gadget.dev);
916 if (rc < 0)
917 return rc;
919 #if 0 /* usb_bus_get isn't EXPORTed! */
920 usb_bus_get (&dummy_to_hcd (dum)->self);
921 #endif
923 dev_set_drvdata (dev, dum);
924 device_create_file (&dum->gadget.dev, &dev_attr_function);
925 return rc;
928 static int dummy_udc_remove (struct device *dev)
930 struct dummy *dum = dev_get_drvdata (dev);
932 dev_set_drvdata (dev, NULL);
933 device_remove_file (&dum->gadget.dev, &dev_attr_function);
934 device_unregister (&dum->gadget.dev);
935 return 0;
938 static int dummy_udc_suspend (struct device *dev, pm_message_t state)
940 struct dummy *dum = dev_get_drvdata(dev);
942 dev_dbg (dev, "%s\n", __FUNCTION__);
943 spin_lock_irq (&dum->lock);
944 dum->udc_suspended = 1;
945 set_link_state (dum);
946 spin_unlock_irq (&dum->lock);
948 dev->power.power_state = state;
949 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
950 return 0;
953 static int dummy_udc_resume (struct device *dev)
955 struct dummy *dum = dev_get_drvdata(dev);
957 dev_dbg (dev, "%s\n", __FUNCTION__);
958 spin_lock_irq (&dum->lock);
959 dum->udc_suspended = 0;
960 set_link_state (dum);
961 spin_unlock_irq (&dum->lock);
963 dev->power.power_state = PMSG_ON;
964 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
965 return 0;
968 static struct device_driver dummy_udc_driver = {
969 .name = (char *) gadget_name,
970 .bus = &platform_bus_type,
971 .probe = dummy_udc_probe,
972 .remove = dummy_udc_remove,
973 .suspend = dummy_udc_suspend,
974 .resume = dummy_udc_resume,
977 /*-------------------------------------------------------------------------*/
979 /* MASTER/HOST SIDE DRIVER
981 * this uses the hcd framework to hook up to host side drivers.
982 * its root hub will only have one device, otherwise it acts like
983 * a normal host controller.
985 * when urbs are queued, they're just stuck on a list that we
986 * scan in a timer callback. that callback connects writes from
987 * the host with reads from the device, and so on, based on the
988 * usb 2.0 rules.
991 static int dummy_urb_enqueue (
992 struct usb_hcd *hcd,
993 struct usb_host_endpoint *ep,
994 struct urb *urb,
995 gfp_t mem_flags
997 struct dummy *dum;
998 struct urbp *urbp;
999 unsigned long flags;
1001 if (!urb->transfer_buffer && urb->transfer_buffer_length)
1002 return -EINVAL;
1004 urbp = kmalloc (sizeof *urbp, mem_flags);
1005 if (!urbp)
1006 return -ENOMEM;
1007 urbp->urb = urb;
1009 dum = hcd_to_dummy (hcd);
1010 spin_lock_irqsave (&dum->lock, flags);
1012 if (!dum->udev) {
1013 dum->udev = urb->dev;
1014 usb_get_dev (dum->udev);
1015 } else if (unlikely (dum->udev != urb->dev))
1016 dev_err (dummy_dev(dum), "usb_device address has changed!\n");
1018 list_add_tail (&urbp->urbp_list, &dum->urbp_list);
1019 urb->hcpriv = urbp;
1020 if (usb_pipetype (urb->pipe) == PIPE_CONTROL)
1021 urb->error_count = 1; /* mark as a new urb */
1023 /* kick the scheduler, it'll do the rest */
1024 if (!timer_pending (&dum->timer))
1025 mod_timer (&dum->timer, jiffies + 1);
1027 spin_unlock_irqrestore (&dum->lock, flags);
1028 return 0;
1031 static int dummy_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
1033 struct dummy *dum;
1034 unsigned long flags;
1036 /* giveback happens automatically in timer callback,
1037 * so make sure the callback happens */
1038 dum = hcd_to_dummy (hcd);
1039 spin_lock_irqsave (&dum->lock, flags);
1040 if (dum->rh_state != DUMMY_RH_RUNNING && !list_empty(&dum->urbp_list))
1041 mod_timer (&dum->timer, jiffies);
1042 spin_unlock_irqrestore (&dum->lock, flags);
1043 return 0;
1046 static void maybe_set_status (struct urb *urb, int status)
1048 spin_lock (&urb->lock);
1049 if (urb->status == -EINPROGRESS)
1050 urb->status = status;
1051 spin_unlock (&urb->lock);
1054 /* transfer up to a frame's worth; caller must own lock */
1055 static int
1056 transfer (struct dummy *dum, struct urb *urb, struct dummy_ep *ep, int limit)
1058 struct dummy_request *req;
1060 top:
1061 /* if there's no request queued, the device is NAKing; return */
1062 list_for_each_entry (req, &ep->queue, queue) {
1063 unsigned host_len, dev_len, len;
1064 int is_short, to_host;
1065 int rescan = 0;
1067 /* 1..N packets of ep->ep.maxpacket each ... the last one
1068 * may be short (including zero length).
1070 * writer can send a zlp explicitly (length 0) or implicitly
1071 * (length mod maxpacket zero, and 'zero' flag); they always
1072 * terminate reads.
1074 host_len = urb->transfer_buffer_length - urb->actual_length;
1075 dev_len = req->req.length - req->req.actual;
1076 len = min (host_len, dev_len);
1078 /* FIXME update emulated data toggle too */
1080 to_host = usb_pipein (urb->pipe);
1081 if (unlikely (len == 0))
1082 is_short = 1;
1083 else {
1084 char *ubuf, *rbuf;
1086 /* not enough bandwidth left? */
1087 if (limit < ep->ep.maxpacket && limit < len)
1088 break;
1089 len = min (len, (unsigned) limit);
1090 if (len == 0)
1091 break;
1093 /* use an extra pass for the final short packet */
1094 if (len > ep->ep.maxpacket) {
1095 rescan = 1;
1096 len -= (len % ep->ep.maxpacket);
1098 is_short = (len % ep->ep.maxpacket) != 0;
1100 /* else transfer packet(s) */
1101 ubuf = urb->transfer_buffer + urb->actual_length;
1102 rbuf = req->req.buf + req->req.actual;
1103 if (to_host)
1104 memcpy (ubuf, rbuf, len);
1105 else
1106 memcpy (rbuf, ubuf, len);
1107 ep->last_io = jiffies;
1109 limit -= len;
1110 urb->actual_length += len;
1111 req->req.actual += len;
1114 /* short packets terminate, maybe with overflow/underflow.
1115 * it's only really an error to write too much.
1117 * partially filling a buffer optionally blocks queue advances
1118 * (so completion handlers can clean up the queue) but we don't
1119 * need to emulate such data-in-flight. so we only show part
1120 * of the URB_SHORT_NOT_OK effect: completion status.
1122 if (is_short) {
1123 if (host_len == dev_len) {
1124 req->req.status = 0;
1125 maybe_set_status (urb, 0);
1126 } else if (to_host) {
1127 req->req.status = 0;
1128 if (dev_len > host_len)
1129 maybe_set_status (urb, -EOVERFLOW);
1130 else
1131 maybe_set_status (urb,
1132 (urb->transfer_flags
1133 & URB_SHORT_NOT_OK)
1134 ? -EREMOTEIO : 0);
1135 } else if (!to_host) {
1136 maybe_set_status (urb, 0);
1137 if (host_len > dev_len)
1138 req->req.status = -EOVERFLOW;
1139 else
1140 req->req.status = 0;
1143 /* many requests terminate without a short packet */
1144 } else {
1145 if (req->req.length == req->req.actual
1146 && !req->req.zero)
1147 req->req.status = 0;
1148 if (urb->transfer_buffer_length == urb->actual_length
1149 && !(urb->transfer_flags
1150 & URB_ZERO_PACKET)) {
1151 maybe_set_status (urb, 0);
1155 /* device side completion --> continuable */
1156 if (req->req.status != -EINPROGRESS) {
1157 list_del_init (&req->queue);
1159 spin_unlock (&dum->lock);
1160 req->req.complete (&ep->ep, &req->req);
1161 spin_lock (&dum->lock);
1163 /* requests might have been unlinked... */
1164 rescan = 1;
1167 /* host side completion --> terminate */
1168 if (urb->status != -EINPROGRESS)
1169 break;
1171 /* rescan to continue with any other queued i/o */
1172 if (rescan)
1173 goto top;
1175 return limit;
1178 static int periodic_bytes (struct dummy *dum, struct dummy_ep *ep)
1180 int limit = ep->ep.maxpacket;
1182 if (dum->gadget.speed == USB_SPEED_HIGH) {
1183 int tmp;
1185 /* high bandwidth mode */
1186 tmp = le16_to_cpu(ep->desc->wMaxPacketSize);
1187 tmp = (tmp >> 11) & 0x03;
1188 tmp *= 8 /* applies to entire frame */;
1189 limit += limit * tmp;
1191 return limit;
1194 #define is_active(dum) ((dum->port_status & \
1195 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1196 USB_PORT_STAT_SUSPEND)) \
1197 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1199 static struct dummy_ep *find_endpoint (struct dummy *dum, u8 address)
1201 int i;
1203 if (!is_active (dum))
1204 return NULL;
1205 if ((address & ~USB_DIR_IN) == 0)
1206 return &dum->ep [0];
1207 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1208 struct dummy_ep *ep = &dum->ep [i];
1210 if (!ep->desc)
1211 continue;
1212 if (ep->desc->bEndpointAddress == address)
1213 return ep;
1215 return NULL;
1218 #undef is_active
1220 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1221 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1222 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1223 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1224 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1225 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1227 /* drive both sides of the transfers; looks like irq handlers to
1228 * both drivers except the callbacks aren't in_irq().
1230 static void dummy_timer (unsigned long _dum)
1232 struct dummy *dum = (struct dummy *) _dum;
1233 struct urbp *urbp, *tmp;
1234 unsigned long flags;
1235 int limit, total;
1236 int i;
1238 /* simplistic model for one frame's bandwidth */
1239 switch (dum->gadget.speed) {
1240 case USB_SPEED_LOW:
1241 total = 8/*bytes*/ * 12/*packets*/;
1242 break;
1243 case USB_SPEED_FULL:
1244 total = 64/*bytes*/ * 19/*packets*/;
1245 break;
1246 case USB_SPEED_HIGH:
1247 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1248 break;
1249 default:
1250 dev_err (dummy_dev(dum), "bogus device speed\n");
1251 return;
1254 /* FIXME if HZ != 1000 this will probably misbehave ... */
1256 /* look at each urb queued by the host side driver */
1257 spin_lock_irqsave (&dum->lock, flags);
1259 if (!dum->udev) {
1260 dev_err (dummy_dev(dum),
1261 "timer fired with no URBs pending?\n");
1262 spin_unlock_irqrestore (&dum->lock, flags);
1263 return;
1266 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1267 if (!ep_name [i])
1268 break;
1269 dum->ep [i].already_seen = 0;
1272 restart:
1273 list_for_each_entry_safe (urbp, tmp, &dum->urbp_list, urbp_list) {
1274 struct urb *urb;
1275 struct dummy_request *req;
1276 u8 address;
1277 struct dummy_ep *ep = NULL;
1278 int type;
1280 urb = urbp->urb;
1281 if (urb->status != -EINPROGRESS) {
1282 /* likely it was just unlinked */
1283 goto return_urb;
1284 } else if (dum->rh_state != DUMMY_RH_RUNNING)
1285 continue;
1286 type = usb_pipetype (urb->pipe);
1288 /* used up this frame's non-periodic bandwidth?
1289 * FIXME there's infinite bandwidth for control and
1290 * periodic transfers ... unrealistic.
1292 if (total <= 0 && type == PIPE_BULK)
1293 continue;
1295 /* find the gadget's ep for this request (if configured) */
1296 address = usb_pipeendpoint (urb->pipe);
1297 if (usb_pipein (urb->pipe))
1298 address |= USB_DIR_IN;
1299 ep = find_endpoint(dum, address);
1300 if (!ep) {
1301 /* set_configuration() disagreement */
1302 dev_dbg (dummy_dev(dum),
1303 "no ep configured for urb %p\n",
1304 urb);
1305 maybe_set_status (urb, -EPROTO);
1306 goto return_urb;
1309 if (ep->already_seen)
1310 continue;
1311 ep->already_seen = 1;
1312 if (ep == &dum->ep [0] && urb->error_count) {
1313 ep->setup_stage = 1; /* a new urb */
1314 urb->error_count = 0;
1316 if (ep->halted && !ep->setup_stage) {
1317 /* NOTE: must not be iso! */
1318 dev_dbg (dummy_dev(dum), "ep %s halted, urb %p\n",
1319 ep->ep.name, urb);
1320 maybe_set_status (urb, -EPIPE);
1321 goto return_urb;
1323 /* FIXME make sure both ends agree on maxpacket */
1325 /* handle control requests */
1326 if (ep == &dum->ep [0] && ep->setup_stage) {
1327 struct usb_ctrlrequest setup;
1328 int value = 1;
1329 struct dummy_ep *ep2;
1330 unsigned w_index;
1331 unsigned w_value;
1333 setup = *(struct usb_ctrlrequest*) urb->setup_packet;
1334 w_index = le16_to_cpu(setup.wIndex);
1335 w_value = le16_to_cpu(setup.wValue);
1336 if (le16_to_cpu(setup.wLength) !=
1337 urb->transfer_buffer_length) {
1338 maybe_set_status (urb, -EOVERFLOW);
1339 goto return_urb;
1342 /* paranoia, in case of stale queued data */
1343 list_for_each_entry (req, &ep->queue, queue) {
1344 list_del_init (&req->queue);
1345 req->req.status = -EOVERFLOW;
1346 dev_dbg (udc_dev(dum), "stale req = %p\n",
1347 req);
1349 spin_unlock (&dum->lock);
1350 req->req.complete (&ep->ep, &req->req);
1351 spin_lock (&dum->lock);
1352 ep->already_seen = 0;
1353 goto restart;
1356 /* gadget driver never sees set_address or operations
1357 * on standard feature flags. some hardware doesn't
1358 * even expose them.
1360 ep->last_io = jiffies;
1361 ep->setup_stage = 0;
1362 ep->halted = 0;
1363 switch (setup.bRequest) {
1364 case USB_REQ_SET_ADDRESS:
1365 if (setup.bRequestType != Dev_Request)
1366 break;
1367 dum->address = w_value;
1368 maybe_set_status (urb, 0);
1369 dev_dbg (udc_dev(dum), "set_address = %d\n",
1370 w_value);
1371 value = 0;
1372 break;
1373 case USB_REQ_SET_FEATURE:
1374 if (setup.bRequestType == Dev_Request) {
1375 value = 0;
1376 switch (w_value) {
1377 case USB_DEVICE_REMOTE_WAKEUP:
1378 break;
1379 case USB_DEVICE_B_HNP_ENABLE:
1380 dum->gadget.b_hnp_enable = 1;
1381 break;
1382 case USB_DEVICE_A_HNP_SUPPORT:
1383 dum->gadget.a_hnp_support = 1;
1384 break;
1385 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1386 dum->gadget.a_alt_hnp_support
1387 = 1;
1388 break;
1389 default:
1390 value = -EOPNOTSUPP;
1392 if (value == 0) {
1393 dum->devstatus |=
1394 (1 << w_value);
1395 maybe_set_status (urb, 0);
1398 } else if (setup.bRequestType == Ep_Request) {
1399 // endpoint halt
1400 ep2 = find_endpoint (dum, w_index);
1401 if (!ep2) {
1402 value = -EOPNOTSUPP;
1403 break;
1405 ep2->halted = 1;
1406 value = 0;
1407 maybe_set_status (urb, 0);
1409 break;
1410 case USB_REQ_CLEAR_FEATURE:
1411 if (setup.bRequestType == Dev_Request) {
1412 switch (w_value) {
1413 case USB_DEVICE_REMOTE_WAKEUP:
1414 dum->devstatus &= ~(1 <<
1415 USB_DEVICE_REMOTE_WAKEUP);
1416 value = 0;
1417 maybe_set_status (urb, 0);
1418 break;
1419 default:
1420 value = -EOPNOTSUPP;
1421 break;
1423 } else if (setup.bRequestType == Ep_Request) {
1424 // endpoint halt
1425 ep2 = find_endpoint (dum, w_index);
1426 if (!ep2) {
1427 value = -EOPNOTSUPP;
1428 break;
1430 ep2->halted = 0;
1431 value = 0;
1432 maybe_set_status (urb, 0);
1434 break;
1435 case USB_REQ_GET_STATUS:
1436 if (setup.bRequestType == Dev_InRequest
1437 || setup.bRequestType
1438 == Intf_InRequest
1439 || setup.bRequestType
1440 == Ep_InRequest
1442 char *buf;
1444 // device: remote wakeup, selfpowered
1445 // interface: nothing
1446 // endpoint: halt
1447 buf = (char *)urb->transfer_buffer;
1448 if (urb->transfer_buffer_length > 0) {
1449 if (setup.bRequestType ==
1450 Ep_InRequest) {
1451 ep2 = find_endpoint (dum, w_index);
1452 if (!ep2) {
1453 value = -EOPNOTSUPP;
1454 break;
1456 buf [0] = ep2->halted;
1457 } else if (setup.bRequestType ==
1458 Dev_InRequest) {
1459 buf [0] = (u8)
1460 dum->devstatus;
1461 } else
1462 buf [0] = 0;
1464 if (urb->transfer_buffer_length > 1)
1465 buf [1] = 0;
1466 urb->actual_length = min (2,
1467 urb->transfer_buffer_length);
1468 value = 0;
1469 maybe_set_status (urb, 0);
1471 break;
1474 /* gadget driver handles all other requests. block
1475 * until setup() returns; no reentrancy issues etc.
1477 if (value > 0) {
1478 spin_unlock (&dum->lock);
1479 value = dum->driver->setup (&dum->gadget,
1480 &setup);
1481 spin_lock (&dum->lock);
1483 if (value >= 0) {
1484 /* no delays (max 64KB data stage) */
1485 limit = 64*1024;
1486 goto treat_control_like_bulk;
1488 /* error, see below */
1491 if (value < 0) {
1492 if (value != -EOPNOTSUPP)
1493 dev_dbg (udc_dev(dum),
1494 "setup --> %d\n",
1495 value);
1496 maybe_set_status (urb, -EPIPE);
1497 urb->actual_length = 0;
1500 goto return_urb;
1503 /* non-control requests */
1504 limit = total;
1505 switch (usb_pipetype (urb->pipe)) {
1506 case PIPE_ISOCHRONOUS:
1507 /* FIXME is it urb->interval since the last xfer?
1508 * use urb->iso_frame_desc[i].
1509 * complete whether or not ep has requests queued.
1510 * report random errors, to debug drivers.
1512 limit = max (limit, periodic_bytes (dum, ep));
1513 maybe_set_status (urb, -ENOSYS);
1514 break;
1516 case PIPE_INTERRUPT:
1517 /* FIXME is it urb->interval since the last xfer?
1518 * this almost certainly polls too fast.
1520 limit = max (limit, periodic_bytes (dum, ep));
1521 /* FALLTHROUGH */
1523 // case PIPE_BULK: case PIPE_CONTROL:
1524 default:
1525 treat_control_like_bulk:
1526 ep->last_io = jiffies;
1527 total = transfer (dum, urb, ep, limit);
1528 break;
1531 /* incomplete transfer? */
1532 if (urb->status == -EINPROGRESS)
1533 continue;
1535 return_urb:
1536 urb->hcpriv = NULL;
1537 list_del (&urbp->urbp_list);
1538 kfree (urbp);
1539 if (ep)
1540 ep->already_seen = ep->setup_stage = 0;
1542 spin_unlock (&dum->lock);
1543 usb_hcd_giveback_urb (dummy_to_hcd(dum), urb, NULL);
1544 spin_lock (&dum->lock);
1546 goto restart;
1549 if (list_empty (&dum->urbp_list)) {
1550 usb_put_dev (dum->udev);
1551 dum->udev = NULL;
1552 } else if (dum->rh_state == DUMMY_RH_RUNNING) {
1553 /* want a 1 msec delay here */
1554 mod_timer (&dum->timer, jiffies + msecs_to_jiffies(1));
1557 spin_unlock_irqrestore (&dum->lock, flags);
1560 /*-------------------------------------------------------------------------*/
1562 #define PORT_C_MASK \
1563 ((USB_PORT_STAT_C_CONNECTION \
1564 | USB_PORT_STAT_C_ENABLE \
1565 | USB_PORT_STAT_C_SUSPEND \
1566 | USB_PORT_STAT_C_OVERCURRENT \
1567 | USB_PORT_STAT_C_RESET) << 16)
1569 static int dummy_hub_status (struct usb_hcd *hcd, char *buf)
1571 struct dummy *dum;
1572 unsigned long flags;
1573 int retval = 0;
1575 dum = hcd_to_dummy (hcd);
1577 spin_lock_irqsave (&dum->lock, flags);
1578 if (hcd->state != HC_STATE_RUNNING)
1579 goto done;
1581 if (dum->resuming && time_after_eq (jiffies, dum->re_timeout)) {
1582 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1583 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1584 set_link_state (dum);
1587 if ((dum->port_status & PORT_C_MASK) != 0) {
1588 *buf = (1 << 1);
1589 dev_dbg (dummy_dev(dum), "port status 0x%08x has changes\n",
1590 dum->port_status);
1591 retval = 1;
1592 if (dum->rh_state == DUMMY_RH_SUSPENDED)
1593 usb_hcd_resume_root_hub (hcd);
1595 done:
1596 spin_unlock_irqrestore (&dum->lock, flags);
1597 return retval;
1600 static inline void
1601 hub_descriptor (struct usb_hub_descriptor *desc)
1603 memset (desc, 0, sizeof *desc);
1604 desc->bDescriptorType = 0x29;
1605 desc->bDescLength = 9;
1606 desc->wHubCharacteristics = (__force __u16)
1607 (__constant_cpu_to_le16 (0x0001));
1608 desc->bNbrPorts = 1;
1609 desc->bitmap [0] = 0xff;
1610 desc->bitmap [1] = 0xff;
1613 static int dummy_hub_control (
1614 struct usb_hcd *hcd,
1615 u16 typeReq,
1616 u16 wValue,
1617 u16 wIndex,
1618 char *buf,
1619 u16 wLength
1621 struct dummy *dum;
1622 int retval = 0;
1623 unsigned long flags;
1625 if (hcd->state != HC_STATE_RUNNING)
1626 return -ETIMEDOUT;
1628 dum = hcd_to_dummy (hcd);
1629 spin_lock_irqsave (&dum->lock, flags);
1630 switch (typeReq) {
1631 case ClearHubFeature:
1632 break;
1633 case ClearPortFeature:
1634 switch (wValue) {
1635 case USB_PORT_FEAT_SUSPEND:
1636 if (dum->port_status & USB_PORT_STAT_SUSPEND) {
1637 /* 20msec resume signaling */
1638 dum->resuming = 1;
1639 dum->re_timeout = jiffies +
1640 msecs_to_jiffies(20);
1642 break;
1643 case USB_PORT_FEAT_POWER:
1644 if (dum->port_status & USB_PORT_STAT_POWER)
1645 dev_dbg (dummy_dev(dum), "power-off\n");
1646 /* FALLS THROUGH */
1647 default:
1648 dum->port_status &= ~(1 << wValue);
1649 set_link_state (dum);
1651 break;
1652 case GetHubDescriptor:
1653 hub_descriptor ((struct usb_hub_descriptor *) buf);
1654 break;
1655 case GetHubStatus:
1656 *(__le32 *) buf = __constant_cpu_to_le32 (0);
1657 break;
1658 case GetPortStatus:
1659 if (wIndex != 1)
1660 retval = -EPIPE;
1662 /* whoever resets or resumes must GetPortStatus to
1663 * complete it!!
1665 if (dum->resuming &&
1666 time_after_eq (jiffies, dum->re_timeout)) {
1667 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1668 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1670 if ((dum->port_status & USB_PORT_STAT_RESET) != 0 &&
1671 time_after_eq (jiffies, dum->re_timeout)) {
1672 dum->port_status |= (USB_PORT_STAT_C_RESET << 16);
1673 dum->port_status &= ~USB_PORT_STAT_RESET;
1674 if (dum->pullup) {
1675 dum->port_status |= USB_PORT_STAT_ENABLE;
1676 /* give it the best speed we agree on */
1677 dum->gadget.speed = dum->driver->speed;
1678 dum->gadget.ep0->maxpacket = 64;
1679 switch (dum->gadget.speed) {
1680 case USB_SPEED_HIGH:
1681 dum->port_status |=
1682 USB_PORT_STAT_HIGH_SPEED;
1683 break;
1684 case USB_SPEED_LOW:
1685 dum->gadget.ep0->maxpacket = 8;
1686 dum->port_status |=
1687 USB_PORT_STAT_LOW_SPEED;
1688 break;
1689 default:
1690 dum->gadget.speed = USB_SPEED_FULL;
1691 break;
1695 set_link_state (dum);
1696 ((__le16 *) buf)[0] = cpu_to_le16 (dum->port_status);
1697 ((__le16 *) buf)[1] = cpu_to_le16 (dum->port_status >> 16);
1698 break;
1699 case SetHubFeature:
1700 retval = -EPIPE;
1701 break;
1702 case SetPortFeature:
1703 switch (wValue) {
1704 case USB_PORT_FEAT_SUSPEND:
1705 if (dum->active) {
1706 dum->port_status |= USB_PORT_STAT_SUSPEND;
1708 /* HNP would happen here; for now we
1709 * assume b_bus_req is always true.
1711 set_link_state (dum);
1712 if (((1 << USB_DEVICE_B_HNP_ENABLE)
1713 & dum->devstatus) != 0)
1714 dev_dbg (dummy_dev(dum),
1715 "no HNP yet!\n");
1717 break;
1718 case USB_PORT_FEAT_POWER:
1719 dum->port_status |= USB_PORT_STAT_POWER;
1720 set_link_state (dum);
1721 break;
1722 case USB_PORT_FEAT_RESET:
1723 /* if it's already enabled, disable */
1724 dum->port_status &= ~(USB_PORT_STAT_ENABLE
1725 | USB_PORT_STAT_LOW_SPEED
1726 | USB_PORT_STAT_HIGH_SPEED);
1727 dum->devstatus = 0;
1728 /* 50msec reset signaling */
1729 dum->re_timeout = jiffies + msecs_to_jiffies(50);
1730 /* FALLS THROUGH */
1731 default:
1732 if ((dum->port_status & USB_PORT_STAT_POWER) != 0) {
1733 dum->port_status |= (1 << wValue);
1734 set_link_state (dum);
1737 break;
1739 default:
1740 dev_dbg (dummy_dev(dum),
1741 "hub control req%04x v%04x i%04x l%d\n",
1742 typeReq, wValue, wIndex, wLength);
1744 /* "protocol stall" on error */
1745 retval = -EPIPE;
1747 spin_unlock_irqrestore (&dum->lock, flags);
1749 if ((dum->port_status & PORT_C_MASK) != 0)
1750 usb_hcd_poll_rh_status (hcd);
1751 return retval;
1754 static int dummy_bus_suspend (struct usb_hcd *hcd)
1756 struct dummy *dum = hcd_to_dummy (hcd);
1758 spin_lock_irq (&dum->lock);
1759 dum->rh_state = DUMMY_RH_SUSPENDED;
1760 set_link_state (dum);
1761 spin_unlock_irq (&dum->lock);
1762 return 0;
1765 static int dummy_bus_resume (struct usb_hcd *hcd)
1767 struct dummy *dum = hcd_to_dummy (hcd);
1769 spin_lock_irq (&dum->lock);
1770 dum->rh_state = DUMMY_RH_RUNNING;
1771 set_link_state (dum);
1772 if (!list_empty(&dum->urbp_list))
1773 mod_timer (&dum->timer, jiffies);
1774 spin_unlock_irq (&dum->lock);
1775 return 0;
1778 /*-------------------------------------------------------------------------*/
1780 static inline ssize_t
1781 show_urb (char *buf, size_t size, struct urb *urb)
1783 int ep = usb_pipeendpoint (urb->pipe);
1785 return snprintf (buf, size,
1786 "urb/%p %s ep%d%s%s len %d/%d\n",
1787 urb,
1788 ({ char *s;
1789 switch (urb->dev->speed) {
1790 case USB_SPEED_LOW: s = "ls"; break;
1791 case USB_SPEED_FULL: s = "fs"; break;
1792 case USB_SPEED_HIGH: s = "hs"; break;
1793 default: s = "?"; break;
1794 }; s; }),
1795 ep, ep ? (usb_pipein (urb->pipe) ? "in" : "out") : "",
1796 ({ char *s; \
1797 switch (usb_pipetype (urb->pipe)) { \
1798 case PIPE_CONTROL: s = ""; break; \
1799 case PIPE_BULK: s = "-bulk"; break; \
1800 case PIPE_INTERRUPT: s = "-int"; break; \
1801 default: s = "-iso"; break; \
1802 }; s;}),
1803 urb->actual_length, urb->transfer_buffer_length);
1806 static ssize_t
1807 show_urbs (struct device *dev, struct device_attribute *attr, char *buf)
1809 struct usb_hcd *hcd = dev_get_drvdata (dev);
1810 struct dummy *dum = hcd_to_dummy (hcd);
1811 struct urbp *urbp;
1812 size_t size = 0;
1813 unsigned long flags;
1815 spin_lock_irqsave (&dum->lock, flags);
1816 list_for_each_entry (urbp, &dum->urbp_list, urbp_list) {
1817 size_t temp;
1819 temp = show_urb (buf, PAGE_SIZE - size, urbp->urb);
1820 buf += temp;
1821 size += temp;
1823 spin_unlock_irqrestore (&dum->lock, flags);
1825 return size;
1827 static DEVICE_ATTR (urbs, S_IRUGO, show_urbs, NULL);
1829 static int dummy_start (struct usb_hcd *hcd)
1831 struct dummy *dum;
1833 dum = hcd_to_dummy (hcd);
1836 * MASTER side init ... we emulate a root hub that'll only ever
1837 * talk to one device (the slave side). Also appears in sysfs,
1838 * just like more familiar pci-based HCDs.
1840 spin_lock_init (&dum->lock);
1841 init_timer (&dum->timer);
1842 dum->timer.function = dummy_timer;
1843 dum->timer.data = (unsigned long) dum;
1844 dum->rh_state = DUMMY_RH_RUNNING;
1846 INIT_LIST_HEAD (&dum->urbp_list);
1848 /* only show a low-power port: just 8mA */
1849 hcd->power_budget = 8;
1850 hcd->state = HC_STATE_RUNNING;
1851 hcd->uses_new_polling = 1;
1853 #ifdef CONFIG_USB_OTG
1854 hcd->self.otg_port = 1;
1855 #endif
1857 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
1858 device_create_file (dummy_dev(dum), &dev_attr_urbs);
1859 return 0;
1862 static void dummy_stop (struct usb_hcd *hcd)
1864 struct dummy *dum;
1866 dum = hcd_to_dummy (hcd);
1868 device_remove_file (dummy_dev(dum), &dev_attr_urbs);
1869 usb_gadget_unregister_driver (dum->driver);
1870 dev_info (dummy_dev(dum), "stopped\n");
1873 /*-------------------------------------------------------------------------*/
1875 static int dummy_h_get_frame (struct usb_hcd *hcd)
1877 return dummy_g_get_frame (NULL);
1880 static const struct hc_driver dummy_hcd = {
1881 .description = (char *) driver_name,
1882 .product_desc = "Dummy host controller",
1883 .hcd_priv_size = sizeof(struct dummy),
1885 .flags = HCD_USB2,
1887 .start = dummy_start,
1888 .stop = dummy_stop,
1890 .urb_enqueue = dummy_urb_enqueue,
1891 .urb_dequeue = dummy_urb_dequeue,
1893 .get_frame_number = dummy_h_get_frame,
1895 .hub_status_data = dummy_hub_status,
1896 .hub_control = dummy_hub_control,
1897 .bus_suspend = dummy_bus_suspend,
1898 .bus_resume = dummy_bus_resume,
1901 static int dummy_hcd_probe (struct device *dev)
1903 struct usb_hcd *hcd;
1904 int retval;
1906 dev_info (dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
1908 hcd = usb_create_hcd (&dummy_hcd, dev, dev->bus_id);
1909 if (!hcd)
1910 return -ENOMEM;
1911 the_controller = hcd_to_dummy (hcd);
1913 retval = usb_add_hcd(hcd, 0, 0);
1914 if (retval != 0) {
1915 usb_put_hcd (hcd);
1916 the_controller = NULL;
1918 return retval;
1921 static int dummy_hcd_remove (struct device *dev)
1923 struct usb_hcd *hcd;
1925 hcd = dev_get_drvdata (dev);
1926 usb_remove_hcd (hcd);
1927 usb_put_hcd (hcd);
1928 the_controller = NULL;
1929 return 0;
1932 static int dummy_hcd_suspend (struct device *dev, pm_message_t state)
1934 struct usb_hcd *hcd;
1936 dev_dbg (dev, "%s\n", __FUNCTION__);
1937 hcd = dev_get_drvdata (dev);
1939 hcd->state = HC_STATE_SUSPENDED;
1940 return 0;
1943 static int dummy_hcd_resume (struct device *dev)
1945 struct usb_hcd *hcd;
1947 dev_dbg (dev, "%s\n", __FUNCTION__);
1948 hcd = dev_get_drvdata (dev);
1949 hcd->state = HC_STATE_RUNNING;
1951 usb_hcd_poll_rh_status (hcd);
1952 return 0;
1955 static struct device_driver dummy_hcd_driver = {
1956 .name = (char *) driver_name,
1957 .bus = &platform_bus_type,
1958 .probe = dummy_hcd_probe,
1959 .remove = dummy_hcd_remove,
1960 .suspend = dummy_hcd_suspend,
1961 .resume = dummy_hcd_resume,
1964 /*-------------------------------------------------------------------------*/
1966 /* These don't need to do anything because the pdev structures are
1967 * statically allocated. */
1968 static void
1969 dummy_udc_release (struct device *dev) {}
1971 static void
1972 dummy_hcd_release (struct device *dev) {}
1974 static struct platform_device the_udc_pdev = {
1975 .name = (char *) gadget_name,
1976 .id = -1,
1977 .dev = {
1978 .release = dummy_udc_release,
1982 static struct platform_device the_hcd_pdev = {
1983 .name = (char *) driver_name,
1984 .id = -1,
1985 .dev = {
1986 .release = dummy_hcd_release,
1990 static int __init init (void)
1992 int retval;
1994 if (usb_disabled ())
1995 return -ENODEV;
1997 retval = driver_register (&dummy_hcd_driver);
1998 if (retval < 0)
1999 return retval;
2001 retval = driver_register (&dummy_udc_driver);
2002 if (retval < 0)
2003 goto err_register_udc_driver;
2005 retval = platform_device_register (&the_hcd_pdev);
2006 if (retval < 0)
2007 goto err_register_hcd;
2009 retval = platform_device_register (&the_udc_pdev);
2010 if (retval < 0)
2011 goto err_register_udc;
2012 return retval;
2014 err_register_udc:
2015 platform_device_unregister (&the_hcd_pdev);
2016 err_register_hcd:
2017 driver_unregister (&dummy_udc_driver);
2018 err_register_udc_driver:
2019 driver_unregister (&dummy_hcd_driver);
2020 return retval;
2022 module_init (init);
2024 static void __exit cleanup (void)
2026 platform_device_unregister (&the_udc_pdev);
2027 platform_device_unregister (&the_hcd_pdev);
2028 driver_unregister (&dummy_udc_driver);
2029 driver_unregister (&dummy_hcd_driver);
2031 module_exit (cleanup);