USB: ftdi-elan: client driver for ELAN Uxxx adapters
[linux-2.6/cjktty.git] / drivers / usb / gadget / dummy_hcd.c
blobfdab97a27c08bdbd152cc013dc3de9091fef3fa7
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/module.h>
40 #include <linux/kernel.h>
41 #include <linux/delay.h>
42 #include <linux/ioport.h>
43 #include <linux/sched.h>
44 #include <linux/slab.h>
45 #include <linux/smp_lock.h>
46 #include <linux/errno.h>
47 #include <linux/init.h>
48 #include <linux/timer.h>
49 #include <linux/list.h>
50 #include <linux/interrupt.h>
51 #include <linux/platform_device.h>
52 #include <linux/usb.h>
53 #include <linux/usb_gadget.h>
55 #include <asm/byteorder.h>
56 #include <asm/io.h>
57 #include <asm/irq.h>
58 #include <asm/system.h>
59 #include <asm/unaligned.h>
62 #include "../core/hcd.h"
65 #define DRIVER_DESC "USB Host+Gadget Emulator"
66 #define DRIVER_VERSION "02 May 2005"
68 static const char driver_name [] = "dummy_hcd";
69 static const char driver_desc [] = "USB Host+Gadget Emulator";
71 static const char gadget_name [] = "dummy_udc";
73 MODULE_DESCRIPTION (DRIVER_DESC);
74 MODULE_AUTHOR ("David Brownell");
75 MODULE_LICENSE ("GPL");
77 /*-------------------------------------------------------------------------*/
79 /* gadget side driver data structres */
80 struct dummy_ep {
81 struct list_head queue;
82 unsigned long last_io; /* jiffies timestamp */
83 struct usb_gadget *gadget;
84 const struct usb_endpoint_descriptor *desc;
85 struct usb_ep ep;
86 unsigned halted : 1;
87 unsigned already_seen : 1;
88 unsigned setup_stage : 1;
91 struct dummy_request {
92 struct list_head queue; /* ep's requests */
93 struct usb_request req;
96 static inline struct dummy_ep *usb_ep_to_dummy_ep (struct usb_ep *_ep)
98 return container_of (_ep, struct dummy_ep, ep);
101 static inline struct dummy_request *usb_request_to_dummy_request
102 (struct usb_request *_req)
104 return container_of (_req, struct dummy_request, req);
107 /*-------------------------------------------------------------------------*/
110 * Every device has ep0 for control requests, plus up to 30 more endpoints,
111 * in one of two types:
113 * - Configurable: direction (in/out), type (bulk, iso, etc), and endpoint
114 * number can be changed. Names like "ep-a" are used for this type.
116 * - Fixed Function: in other cases. some characteristics may be mutable;
117 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
119 * Gadget drivers are responsible for not setting up conflicting endpoint
120 * configurations, illegal or unsupported packet lengths, and so on.
123 static const char ep0name [] = "ep0";
125 static const char *const ep_name [] = {
126 ep0name, /* everyone has ep0 */
128 /* act like a net2280: high speed, six configurable endpoints */
129 "ep-a", "ep-b", "ep-c", "ep-d", "ep-e", "ep-f",
131 /* or like pxa250: fifteen fixed function endpoints */
132 "ep1in-bulk", "ep2out-bulk", "ep3in-iso", "ep4out-iso", "ep5in-int",
133 "ep6in-bulk", "ep7out-bulk", "ep8in-iso", "ep9out-iso", "ep10in-int",
134 "ep11in-bulk", "ep12out-bulk", "ep13in-iso", "ep14out-iso",
135 "ep15in-int",
137 /* or like sa1100: two fixed function endpoints */
138 "ep1out-bulk", "ep2in-bulk",
140 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_name)
142 /*-------------------------------------------------------------------------*/
144 #define FIFO_SIZE 64
146 struct urbp {
147 struct urb *urb;
148 struct list_head urbp_list;
152 enum dummy_rh_state {
153 DUMMY_RH_RESET,
154 DUMMY_RH_SUSPENDED,
155 DUMMY_RH_RUNNING
158 struct dummy {
159 spinlock_t lock;
162 * SLAVE/GADGET side support
164 struct dummy_ep ep [DUMMY_ENDPOINTS];
165 int address;
166 struct usb_gadget gadget;
167 struct usb_gadget_driver *driver;
168 struct dummy_request fifo_req;
169 u8 fifo_buf [FIFO_SIZE];
170 u16 devstatus;
171 unsigned udc_suspended:1;
172 unsigned pullup:1;
173 unsigned active:1;
174 unsigned old_active:1;
177 * MASTER/HOST side support
179 enum dummy_rh_state rh_state;
180 struct timer_list timer;
181 u32 port_status;
182 u32 old_status;
183 unsigned resuming:1;
184 unsigned long re_timeout;
186 struct usb_device *udev;
187 struct list_head urbp_list;
190 static inline struct dummy *hcd_to_dummy (struct usb_hcd *hcd)
192 return (struct dummy *) (hcd->hcd_priv);
195 static inline struct usb_hcd *dummy_to_hcd (struct dummy *dum)
197 return container_of((void *) dum, struct usb_hcd, hcd_priv);
200 static inline struct device *dummy_dev (struct dummy *dum)
202 return dummy_to_hcd(dum)->self.controller;
205 static inline struct device *udc_dev (struct dummy *dum)
207 return dum->gadget.dev.parent;
210 static inline struct dummy *ep_to_dummy (struct dummy_ep *ep)
212 return container_of (ep->gadget, struct dummy, gadget);
215 static inline struct dummy *gadget_to_dummy (struct usb_gadget *gadget)
217 return container_of (gadget, struct dummy, gadget);
220 static inline struct dummy *gadget_dev_to_dummy (struct device *dev)
222 return container_of (dev, struct dummy, gadget.dev);
225 static struct dummy *the_controller;
227 /*-------------------------------------------------------------------------*/
229 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
231 /* called with spinlock held */
232 static void nuke (struct dummy *dum, struct dummy_ep *ep)
234 while (!list_empty (&ep->queue)) {
235 struct dummy_request *req;
237 req = list_entry (ep->queue.next, struct dummy_request, queue);
238 list_del_init (&req->queue);
239 req->req.status = -ESHUTDOWN;
241 spin_unlock (&dum->lock);
242 req->req.complete (&ep->ep, &req->req);
243 spin_lock (&dum->lock);
247 /* caller must hold lock */
248 static void
249 stop_activity (struct dummy *dum)
251 struct dummy_ep *ep;
253 /* prevent any more requests */
254 dum->address = 0;
256 /* The timer is left running so that outstanding URBs can fail */
258 /* nuke any pending requests first, so driver i/o is quiesced */
259 list_for_each_entry (ep, &dum->gadget.ep_list, ep.ep_list)
260 nuke (dum, ep);
262 /* driver now does any non-usb quiescing necessary */
265 /* caller must hold lock */
266 static void
267 set_link_state (struct dummy *dum)
269 dum->active = 0;
270 if ((dum->port_status & USB_PORT_STAT_POWER) == 0)
271 dum->port_status = 0;
273 /* UDC suspend must cause a disconnect */
274 else if (!dum->pullup || dum->udc_suspended) {
275 dum->port_status &= ~(USB_PORT_STAT_CONNECTION |
276 USB_PORT_STAT_ENABLE |
277 USB_PORT_STAT_LOW_SPEED |
278 USB_PORT_STAT_HIGH_SPEED |
279 USB_PORT_STAT_SUSPEND);
280 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0)
281 dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
282 } else {
283 dum->port_status |= USB_PORT_STAT_CONNECTION;
284 if ((dum->old_status & USB_PORT_STAT_CONNECTION) == 0)
285 dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
286 if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0)
287 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
288 else if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
289 dum->rh_state != DUMMY_RH_SUSPENDED)
290 dum->active = 1;
293 if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0 || dum->active)
294 dum->resuming = 0;
296 if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0 ||
297 (dum->port_status & USB_PORT_STAT_RESET) != 0) {
298 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0 &&
299 (dum->old_status & USB_PORT_STAT_RESET) == 0 &&
300 dum->driver) {
301 stop_activity (dum);
302 spin_unlock (&dum->lock);
303 dum->driver->disconnect (&dum->gadget);
304 spin_lock (&dum->lock);
306 } else if (dum->active != dum->old_active) {
307 if (dum->old_active && dum->driver->suspend) {
308 spin_unlock (&dum->lock);
309 dum->driver->suspend (&dum->gadget);
310 spin_lock (&dum->lock);
311 } else if (!dum->old_active && dum->driver->resume) {
312 spin_unlock (&dum->lock);
313 dum->driver->resume (&dum->gadget);
314 spin_lock (&dum->lock);
318 dum->old_status = dum->port_status;
319 dum->old_active = dum->active;
322 /*-------------------------------------------------------------------------*/
324 /* SLAVE/GADGET SIDE DRIVER
326 * This only tracks gadget state. All the work is done when the host
327 * side tries some (emulated) i/o operation. Real device controller
328 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
331 #define is_enabled(dum) \
332 (dum->port_status & USB_PORT_STAT_ENABLE)
334 static int
335 dummy_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
337 struct dummy *dum;
338 struct dummy_ep *ep;
339 unsigned max;
340 int retval;
342 ep = usb_ep_to_dummy_ep (_ep);
343 if (!_ep || !desc || ep->desc || _ep->name == ep0name
344 || desc->bDescriptorType != USB_DT_ENDPOINT)
345 return -EINVAL;
346 dum = ep_to_dummy (ep);
347 if (!dum->driver || !is_enabled (dum))
348 return -ESHUTDOWN;
349 max = le16_to_cpu(desc->wMaxPacketSize) & 0x3ff;
351 /* drivers must not request bad settings, since lower levels
352 * (hardware or its drivers) may not check. some endpoints
353 * can't do iso, many have maxpacket limitations, etc.
355 * since this "hardware" driver is here to help debugging, we
356 * have some extra sanity checks. (there could be more though,
357 * especially for "ep9out" style fixed function ones.)
359 retval = -EINVAL;
360 switch (desc->bmAttributes & 0x03) {
361 case USB_ENDPOINT_XFER_BULK:
362 if (strstr (ep->ep.name, "-iso")
363 || strstr (ep->ep.name, "-int")) {
364 goto done;
366 switch (dum->gadget.speed) {
367 case USB_SPEED_HIGH:
368 if (max == 512)
369 break;
370 /* conserve return statements */
371 default:
372 switch (max) {
373 case 8: case 16: case 32: case 64:
374 /* we'll fake any legal size */
375 break;
376 default:
377 case USB_SPEED_LOW:
378 goto done;
381 break;
382 case USB_ENDPOINT_XFER_INT:
383 if (strstr (ep->ep.name, "-iso")) /* bulk is ok */
384 goto done;
385 /* real hardware might not handle all packet sizes */
386 switch (dum->gadget.speed) {
387 case USB_SPEED_HIGH:
388 if (max <= 1024)
389 break;
390 /* save a return statement */
391 case USB_SPEED_FULL:
392 if (max <= 64)
393 break;
394 /* save a return statement */
395 default:
396 if (max <= 8)
397 break;
398 goto done;
400 break;
401 case USB_ENDPOINT_XFER_ISOC:
402 if (strstr (ep->ep.name, "-bulk")
403 || strstr (ep->ep.name, "-int"))
404 goto done;
405 /* real hardware might not handle all packet sizes */
406 switch (dum->gadget.speed) {
407 case USB_SPEED_HIGH:
408 if (max <= 1024)
409 break;
410 /* save a return statement */
411 case USB_SPEED_FULL:
412 if (max <= 1023)
413 break;
414 /* save a return statement */
415 default:
416 goto done;
418 break;
419 default:
420 /* few chips support control except on ep0 */
421 goto done;
424 _ep->maxpacket = max;
425 ep->desc = desc;
427 dev_dbg (udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d\n",
428 _ep->name,
429 desc->bEndpointAddress & 0x0f,
430 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
431 ({ char *val;
432 switch (desc->bmAttributes & 0x03) {
433 case USB_ENDPOINT_XFER_BULK: val = "bulk"; break;
434 case USB_ENDPOINT_XFER_ISOC: val = "iso"; break;
435 case USB_ENDPOINT_XFER_INT: val = "intr"; break;
436 default: val = "ctrl"; break;
437 }; val; }),
438 max);
440 /* at this point real hardware should be NAKing transfers
441 * to that endpoint, until a buffer is queued to it.
443 retval = 0;
444 done:
445 return retval;
448 static int dummy_disable (struct usb_ep *_ep)
450 struct dummy_ep *ep;
451 struct dummy *dum;
452 unsigned long flags;
453 int retval;
455 ep = usb_ep_to_dummy_ep (_ep);
456 if (!_ep || !ep->desc || _ep->name == ep0name)
457 return -EINVAL;
458 dum = ep_to_dummy (ep);
460 spin_lock_irqsave (&dum->lock, flags);
461 ep->desc = NULL;
462 retval = 0;
463 nuke (dum, ep);
464 spin_unlock_irqrestore (&dum->lock, flags);
466 dev_dbg (udc_dev(dum), "disabled %s\n", _ep->name);
467 return retval;
470 static struct usb_request *
471 dummy_alloc_request (struct usb_ep *_ep, gfp_t mem_flags)
473 struct dummy_ep *ep;
474 struct dummy_request *req;
476 if (!_ep)
477 return NULL;
478 ep = usb_ep_to_dummy_ep (_ep);
480 req = kzalloc(sizeof(*req), mem_flags);
481 if (!req)
482 return NULL;
483 INIT_LIST_HEAD (&req->queue);
484 return &req->req;
487 static void
488 dummy_free_request (struct usb_ep *_ep, struct usb_request *_req)
490 struct dummy_ep *ep;
491 struct dummy_request *req;
493 ep = usb_ep_to_dummy_ep (_ep);
494 if (!ep || !_req || (!ep->desc && _ep->name != ep0name))
495 return;
497 req = usb_request_to_dummy_request (_req);
498 WARN_ON (!list_empty (&req->queue));
499 kfree (req);
502 static void *
503 dummy_alloc_buffer (
504 struct usb_ep *_ep,
505 unsigned bytes,
506 dma_addr_t *dma,
507 gfp_t mem_flags
509 char *retval;
510 struct dummy_ep *ep;
511 struct dummy *dum;
513 ep = usb_ep_to_dummy_ep (_ep);
514 dum = ep_to_dummy (ep);
516 if (!dum->driver)
517 return NULL;
518 retval = kmalloc (bytes, mem_flags);
519 *dma = (dma_addr_t) retval;
520 return retval;
523 static void
524 dummy_free_buffer (
525 struct usb_ep *_ep,
526 void *buf,
527 dma_addr_t dma,
528 unsigned bytes
530 if (bytes)
531 kfree (buf);
534 static void
535 fifo_complete (struct usb_ep *ep, struct usb_request *req)
539 static int
540 dummy_queue (struct usb_ep *_ep, struct usb_request *_req,
541 gfp_t mem_flags)
543 struct dummy_ep *ep;
544 struct dummy_request *req;
545 struct dummy *dum;
546 unsigned long flags;
548 req = usb_request_to_dummy_request (_req);
549 if (!_req || !list_empty (&req->queue) || !_req->complete)
550 return -EINVAL;
552 ep = usb_ep_to_dummy_ep (_ep);
553 if (!_ep || (!ep->desc && _ep->name != ep0name))
554 return -EINVAL;
556 dum = ep_to_dummy (ep);
557 if (!dum->driver || !is_enabled (dum))
558 return -ESHUTDOWN;
560 #if 0
561 dev_dbg (udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
562 ep, _req, _ep->name, _req->length, _req->buf);
563 #endif
565 _req->status = -EINPROGRESS;
566 _req->actual = 0;
567 spin_lock_irqsave (&dum->lock, flags);
569 /* implement an emulated single-request FIFO */
570 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
571 list_empty (&dum->fifo_req.queue) &&
572 list_empty (&ep->queue) &&
573 _req->length <= FIFO_SIZE) {
574 req = &dum->fifo_req;
575 req->req = *_req;
576 req->req.buf = dum->fifo_buf;
577 memcpy (dum->fifo_buf, _req->buf, _req->length);
578 req->req.context = dum;
579 req->req.complete = fifo_complete;
581 spin_unlock (&dum->lock);
582 _req->actual = _req->length;
583 _req->status = 0;
584 _req->complete (_ep, _req);
585 spin_lock (&dum->lock);
587 list_add_tail (&req->queue, &ep->queue);
588 spin_unlock_irqrestore (&dum->lock, flags);
590 /* real hardware would likely enable transfers here, in case
591 * it'd been left NAKing.
593 return 0;
596 static int dummy_dequeue (struct usb_ep *_ep, struct usb_request *_req)
598 struct dummy_ep *ep;
599 struct dummy *dum;
600 int retval = -EINVAL;
601 unsigned long flags;
602 struct dummy_request *req = NULL;
604 if (!_ep || !_req)
605 return retval;
606 ep = usb_ep_to_dummy_ep (_ep);
607 dum = ep_to_dummy (ep);
609 if (!dum->driver)
610 return -ESHUTDOWN;
612 local_irq_save (flags);
613 spin_lock (&dum->lock);
614 list_for_each_entry (req, &ep->queue, queue) {
615 if (&req->req == _req) {
616 list_del_init (&req->queue);
617 _req->status = -ECONNRESET;
618 retval = 0;
619 break;
622 spin_unlock (&dum->lock);
624 if (retval == 0) {
625 dev_dbg (udc_dev(dum),
626 "dequeued req %p from %s, len %d buf %p\n",
627 req, _ep->name, _req->length, _req->buf);
628 _req->complete (_ep, _req);
630 local_irq_restore (flags);
631 return retval;
634 static int
635 dummy_set_halt (struct usb_ep *_ep, int value)
637 struct dummy_ep *ep;
638 struct dummy *dum;
640 if (!_ep)
641 return -EINVAL;
642 ep = usb_ep_to_dummy_ep (_ep);
643 dum = ep_to_dummy (ep);
644 if (!dum->driver)
645 return -ESHUTDOWN;
646 if (!value)
647 ep->halted = 0;
648 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
649 !list_empty (&ep->queue))
650 return -EAGAIN;
651 else
652 ep->halted = 1;
653 /* FIXME clear emulated data toggle too */
654 return 0;
657 static const struct usb_ep_ops dummy_ep_ops = {
658 .enable = dummy_enable,
659 .disable = dummy_disable,
661 .alloc_request = dummy_alloc_request,
662 .free_request = dummy_free_request,
664 .alloc_buffer = dummy_alloc_buffer,
665 .free_buffer = dummy_free_buffer,
666 /* map, unmap, ... eventually hook the "generic" dma calls */
668 .queue = dummy_queue,
669 .dequeue = dummy_dequeue,
671 .set_halt = dummy_set_halt,
674 /*-------------------------------------------------------------------------*/
676 /* there are both host and device side versions of this call ... */
677 static int dummy_g_get_frame (struct usb_gadget *_gadget)
679 struct timeval tv;
681 do_gettimeofday (&tv);
682 return tv.tv_usec / 1000;
685 static int dummy_wakeup (struct usb_gadget *_gadget)
687 struct dummy *dum;
689 dum = gadget_to_dummy (_gadget);
690 if (!(dum->devstatus & ( (1 << USB_DEVICE_B_HNP_ENABLE)
691 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
692 return -EINVAL;
693 if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0)
694 return -ENOLINK;
695 if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
696 dum->rh_state != DUMMY_RH_SUSPENDED)
697 return -EIO;
699 /* FIXME: What if the root hub is suspended but the port isn't? */
701 /* hub notices our request, issues downstream resume, etc */
702 dum->resuming = 1;
703 dum->re_timeout = jiffies + msecs_to_jiffies(20);
704 mod_timer (&dummy_to_hcd (dum)->rh_timer, dum->re_timeout);
705 return 0;
708 static int dummy_set_selfpowered (struct usb_gadget *_gadget, int value)
710 struct dummy *dum;
712 dum = gadget_to_dummy (_gadget);
713 if (value)
714 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
715 else
716 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
717 return 0;
720 static int dummy_pullup (struct usb_gadget *_gadget, int value)
722 struct dummy *dum;
723 unsigned long flags;
725 dum = gadget_to_dummy (_gadget);
726 spin_lock_irqsave (&dum->lock, flags);
727 dum->pullup = (value != 0);
728 set_link_state (dum);
729 spin_unlock_irqrestore (&dum->lock, flags);
731 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
732 return 0;
735 static const struct usb_gadget_ops dummy_ops = {
736 .get_frame = dummy_g_get_frame,
737 .wakeup = dummy_wakeup,
738 .set_selfpowered = dummy_set_selfpowered,
739 .pullup = dummy_pullup,
742 /*-------------------------------------------------------------------------*/
744 /* "function" sysfs attribute */
745 static ssize_t
746 show_function (struct device *dev, struct device_attribute *attr, char *buf)
748 struct dummy *dum = gadget_dev_to_dummy (dev);
750 if (!dum->driver || !dum->driver->function)
751 return 0;
752 return scnprintf (buf, PAGE_SIZE, "%s\n", dum->driver->function);
754 static DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
756 /*-------------------------------------------------------------------------*/
759 * Driver registration/unregistration.
761 * This is basically hardware-specific; there's usually only one real USB
762 * device (not host) controller since that's how USB devices are intended
763 * to work. So most implementations of these api calls will rely on the
764 * fact that only one driver will ever bind to the hardware. But curious
765 * hardware can be built with discrete components, so the gadget API doesn't
766 * require that assumption.
768 * For this emulator, it might be convenient to create a usb slave device
769 * for each driver that registers: just add to a big root hub.
773 usb_gadget_register_driver (struct usb_gadget_driver *driver)
775 struct dummy *dum = the_controller;
776 int retval, i;
778 if (!dum)
779 return -EINVAL;
780 if (dum->driver)
781 return -EBUSY;
782 if (!driver->bind || !driver->unbind || !driver->setup
783 || driver->speed == USB_SPEED_UNKNOWN)
784 return -EINVAL;
787 * SLAVE side init ... the layer above hardware, which
788 * can't enumerate without help from the driver we're binding.
791 dum->devstatus = 0;
793 INIT_LIST_HEAD (&dum->gadget.ep_list);
794 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
795 struct dummy_ep *ep = &dum->ep [i];
797 if (!ep_name [i])
798 break;
799 ep->ep.name = ep_name [i];
800 ep->ep.ops = &dummy_ep_ops;
801 list_add_tail (&ep->ep.ep_list, &dum->gadget.ep_list);
802 ep->halted = ep->already_seen = ep->setup_stage = 0;
803 ep->ep.maxpacket = ~0;
804 ep->last_io = jiffies;
805 ep->gadget = &dum->gadget;
806 ep->desc = NULL;
807 INIT_LIST_HEAD (&ep->queue);
810 dum->gadget.ep0 = &dum->ep [0].ep;
811 dum->ep [0].ep.maxpacket = 64;
812 list_del_init (&dum->ep [0].ep.ep_list);
813 INIT_LIST_HEAD(&dum->fifo_req.queue);
815 dum->driver = driver;
816 dum->gadget.dev.driver = &driver->driver;
817 dev_dbg (udc_dev(dum), "binding gadget driver '%s'\n",
818 driver->driver.name);
819 if ((retval = driver->bind (&dum->gadget)) != 0) {
820 dum->driver = NULL;
821 dum->gadget.dev.driver = NULL;
822 return retval;
825 driver->driver.bus = dum->gadget.dev.parent->bus;
826 driver_register (&driver->driver);
827 device_bind_driver (&dum->gadget.dev);
829 /* khubd will enumerate this in a while */
830 spin_lock_irq (&dum->lock);
831 dum->pullup = 1;
832 set_link_state (dum);
833 spin_unlock_irq (&dum->lock);
835 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
836 return 0;
838 EXPORT_SYMBOL (usb_gadget_register_driver);
841 usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
843 struct dummy *dum = the_controller;
844 unsigned long flags;
846 if (!dum)
847 return -ENODEV;
848 if (!driver || driver != dum->driver)
849 return -EINVAL;
851 dev_dbg (udc_dev(dum), "unregister gadget driver '%s'\n",
852 driver->driver.name);
854 spin_lock_irqsave (&dum->lock, flags);
855 dum->pullup = 0;
856 set_link_state (dum);
857 spin_unlock_irqrestore (&dum->lock, flags);
859 driver->unbind (&dum->gadget);
860 dum->driver = NULL;
862 device_release_driver (&dum->gadget.dev);
863 driver_unregister (&driver->driver);
865 spin_lock_irqsave (&dum->lock, flags);
866 dum->pullup = 0;
867 set_link_state (dum);
868 spin_unlock_irqrestore (&dum->lock, flags);
870 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
871 return 0;
873 EXPORT_SYMBOL (usb_gadget_unregister_driver);
875 #undef is_enabled
877 /* just declare this in any driver that really need it */
878 extern int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode);
880 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
882 return -ENOSYS;
884 EXPORT_SYMBOL (net2280_set_fifo_mode);
887 /* The gadget structure is stored inside the hcd structure and will be
888 * released along with it. */
889 static void
890 dummy_gadget_release (struct device *dev)
892 struct dummy *dum = gadget_dev_to_dummy (dev);
894 usb_put_hcd (dummy_to_hcd (dum));
897 static int dummy_udc_probe (struct platform_device *pdev)
899 struct dummy *dum = the_controller;
900 int rc;
902 dum->gadget.name = gadget_name;
903 dum->gadget.ops = &dummy_ops;
904 dum->gadget.is_dualspeed = 1;
906 /* maybe claim OTG support, though we won't complete HNP */
907 dum->gadget.is_otg = (dummy_to_hcd(dum)->self.otg_port != 0);
909 strcpy (dum->gadget.dev.bus_id, "gadget");
910 dum->gadget.dev.parent = &pdev->dev;
911 dum->gadget.dev.release = dummy_gadget_release;
912 rc = device_register (&dum->gadget.dev);
913 if (rc < 0)
914 return rc;
916 usb_get_hcd (dummy_to_hcd (dum));
918 platform_set_drvdata (pdev, dum);
919 device_create_file (&dum->gadget.dev, &dev_attr_function);
920 return rc;
923 static int dummy_udc_remove (struct platform_device *pdev)
925 struct dummy *dum = platform_get_drvdata (pdev);
927 platform_set_drvdata (pdev, NULL);
928 device_remove_file (&dum->gadget.dev, &dev_attr_function);
929 device_unregister (&dum->gadget.dev);
930 return 0;
933 static int dummy_udc_suspend (struct platform_device *pdev, pm_message_t state)
935 struct dummy *dum = platform_get_drvdata(pdev);
937 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
938 spin_lock_irq (&dum->lock);
939 dum->udc_suspended = 1;
940 set_link_state (dum);
941 spin_unlock_irq (&dum->lock);
943 pdev->dev.power.power_state = state;
944 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
945 return 0;
948 static int dummy_udc_resume (struct platform_device *pdev)
950 struct dummy *dum = platform_get_drvdata(pdev);
952 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
953 spin_lock_irq (&dum->lock);
954 dum->udc_suspended = 0;
955 set_link_state (dum);
956 spin_unlock_irq (&dum->lock);
958 pdev->dev.power.power_state = PMSG_ON;
959 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
960 return 0;
963 static struct platform_driver dummy_udc_driver = {
964 .probe = dummy_udc_probe,
965 .remove = dummy_udc_remove,
966 .suspend = dummy_udc_suspend,
967 .resume = dummy_udc_resume,
968 .driver = {
969 .name = (char *) gadget_name,
970 .owner = THIS_MODULE,
974 /*-------------------------------------------------------------------------*/
976 /* MASTER/HOST SIDE DRIVER
978 * this uses the hcd framework to hook up to host side drivers.
979 * its root hub will only have one device, otherwise it acts like
980 * a normal host controller.
982 * when urbs are queued, they're just stuck on a list that we
983 * scan in a timer callback. that callback connects writes from
984 * the host with reads from the device, and so on, based on the
985 * usb 2.0 rules.
988 static int dummy_urb_enqueue (
989 struct usb_hcd *hcd,
990 struct usb_host_endpoint *ep,
991 struct urb *urb,
992 gfp_t mem_flags
994 struct dummy *dum;
995 struct urbp *urbp;
996 unsigned long flags;
998 if (!urb->transfer_buffer && urb->transfer_buffer_length)
999 return -EINVAL;
1001 urbp = kmalloc (sizeof *urbp, mem_flags);
1002 if (!urbp)
1003 return -ENOMEM;
1004 urbp->urb = urb;
1006 dum = hcd_to_dummy (hcd);
1007 spin_lock_irqsave (&dum->lock, flags);
1009 if (!dum->udev) {
1010 dum->udev = urb->dev;
1011 usb_get_dev (dum->udev);
1012 } else if (unlikely (dum->udev != urb->dev))
1013 dev_err (dummy_dev(dum), "usb_device address has changed!\n");
1015 list_add_tail (&urbp->urbp_list, &dum->urbp_list);
1016 urb->hcpriv = urbp;
1017 if (usb_pipetype (urb->pipe) == PIPE_CONTROL)
1018 urb->error_count = 1; /* mark as a new urb */
1020 /* kick the scheduler, it'll do the rest */
1021 if (!timer_pending (&dum->timer))
1022 mod_timer (&dum->timer, jiffies + 1);
1024 spin_unlock_irqrestore (&dum->lock, flags);
1025 return 0;
1028 static int dummy_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
1030 struct dummy *dum;
1031 unsigned long flags;
1033 /* giveback happens automatically in timer callback,
1034 * so make sure the callback happens */
1035 dum = hcd_to_dummy (hcd);
1036 spin_lock_irqsave (&dum->lock, flags);
1037 if (dum->rh_state != DUMMY_RH_RUNNING && !list_empty(&dum->urbp_list))
1038 mod_timer (&dum->timer, jiffies);
1039 spin_unlock_irqrestore (&dum->lock, flags);
1040 return 0;
1043 static void maybe_set_status (struct urb *urb, int status)
1045 spin_lock (&urb->lock);
1046 if (urb->status == -EINPROGRESS)
1047 urb->status = status;
1048 spin_unlock (&urb->lock);
1051 /* transfer up to a frame's worth; caller must own lock */
1052 static int
1053 transfer (struct dummy *dum, struct urb *urb, struct dummy_ep *ep, int limit)
1055 struct dummy_request *req;
1057 top:
1058 /* if there's no request queued, the device is NAKing; return */
1059 list_for_each_entry (req, &ep->queue, queue) {
1060 unsigned host_len, dev_len, len;
1061 int is_short, to_host;
1062 int rescan = 0;
1064 /* 1..N packets of ep->ep.maxpacket each ... the last one
1065 * may be short (including zero length).
1067 * writer can send a zlp explicitly (length 0) or implicitly
1068 * (length mod maxpacket zero, and 'zero' flag); they always
1069 * terminate reads.
1071 host_len = urb->transfer_buffer_length - urb->actual_length;
1072 dev_len = req->req.length - req->req.actual;
1073 len = min (host_len, dev_len);
1075 /* FIXME update emulated data toggle too */
1077 to_host = usb_pipein (urb->pipe);
1078 if (unlikely (len == 0))
1079 is_short = 1;
1080 else {
1081 char *ubuf, *rbuf;
1083 /* not enough bandwidth left? */
1084 if (limit < ep->ep.maxpacket && limit < len)
1085 break;
1086 len = min (len, (unsigned) limit);
1087 if (len == 0)
1088 break;
1090 /* use an extra pass for the final short packet */
1091 if (len > ep->ep.maxpacket) {
1092 rescan = 1;
1093 len -= (len % ep->ep.maxpacket);
1095 is_short = (len % ep->ep.maxpacket) != 0;
1097 /* else transfer packet(s) */
1098 ubuf = urb->transfer_buffer + urb->actual_length;
1099 rbuf = req->req.buf + req->req.actual;
1100 if (to_host)
1101 memcpy (ubuf, rbuf, len);
1102 else
1103 memcpy (rbuf, ubuf, len);
1104 ep->last_io = jiffies;
1106 limit -= len;
1107 urb->actual_length += len;
1108 req->req.actual += len;
1111 /* short packets terminate, maybe with overflow/underflow.
1112 * it's only really an error to write too much.
1114 * partially filling a buffer optionally blocks queue advances
1115 * (so completion handlers can clean up the queue) but we don't
1116 * need to emulate such data-in-flight. so we only show part
1117 * of the URB_SHORT_NOT_OK effect: completion status.
1119 if (is_short) {
1120 if (host_len == dev_len) {
1121 req->req.status = 0;
1122 maybe_set_status (urb, 0);
1123 } else if (to_host) {
1124 req->req.status = 0;
1125 if (dev_len > host_len)
1126 maybe_set_status (urb, -EOVERFLOW);
1127 else
1128 maybe_set_status (urb,
1129 (urb->transfer_flags
1130 & URB_SHORT_NOT_OK)
1131 ? -EREMOTEIO : 0);
1132 } else if (!to_host) {
1133 maybe_set_status (urb, 0);
1134 if (host_len > dev_len)
1135 req->req.status = -EOVERFLOW;
1136 else
1137 req->req.status = 0;
1140 /* many requests terminate without a short packet */
1141 } else {
1142 if (req->req.length == req->req.actual
1143 && !req->req.zero)
1144 req->req.status = 0;
1145 if (urb->transfer_buffer_length == urb->actual_length
1146 && !(urb->transfer_flags
1147 & URB_ZERO_PACKET)) {
1148 maybe_set_status (urb, 0);
1152 /* device side completion --> continuable */
1153 if (req->req.status != -EINPROGRESS) {
1154 list_del_init (&req->queue);
1156 spin_unlock (&dum->lock);
1157 req->req.complete (&ep->ep, &req->req);
1158 spin_lock (&dum->lock);
1160 /* requests might have been unlinked... */
1161 rescan = 1;
1164 /* host side completion --> terminate */
1165 if (urb->status != -EINPROGRESS)
1166 break;
1168 /* rescan to continue with any other queued i/o */
1169 if (rescan)
1170 goto top;
1172 return limit;
1175 static int periodic_bytes (struct dummy *dum, struct dummy_ep *ep)
1177 int limit = ep->ep.maxpacket;
1179 if (dum->gadget.speed == USB_SPEED_HIGH) {
1180 int tmp;
1182 /* high bandwidth mode */
1183 tmp = le16_to_cpu(ep->desc->wMaxPacketSize);
1184 tmp = (tmp >> 11) & 0x03;
1185 tmp *= 8 /* applies to entire frame */;
1186 limit += limit * tmp;
1188 return limit;
1191 #define is_active(dum) ((dum->port_status & \
1192 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1193 USB_PORT_STAT_SUSPEND)) \
1194 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1196 static struct dummy_ep *find_endpoint (struct dummy *dum, u8 address)
1198 int i;
1200 if (!is_active (dum))
1201 return NULL;
1202 if ((address & ~USB_DIR_IN) == 0)
1203 return &dum->ep [0];
1204 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1205 struct dummy_ep *ep = &dum->ep [i];
1207 if (!ep->desc)
1208 continue;
1209 if (ep->desc->bEndpointAddress == address)
1210 return ep;
1212 return NULL;
1215 #undef is_active
1217 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1218 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1219 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1220 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1221 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1222 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1224 /* drive both sides of the transfers; looks like irq handlers to
1225 * both drivers except the callbacks aren't in_irq().
1227 static void dummy_timer (unsigned long _dum)
1229 struct dummy *dum = (struct dummy *) _dum;
1230 struct urbp *urbp, *tmp;
1231 unsigned long flags;
1232 int limit, total;
1233 int i;
1235 /* simplistic model for one frame's bandwidth */
1236 switch (dum->gadget.speed) {
1237 case USB_SPEED_LOW:
1238 total = 8/*bytes*/ * 12/*packets*/;
1239 break;
1240 case USB_SPEED_FULL:
1241 total = 64/*bytes*/ * 19/*packets*/;
1242 break;
1243 case USB_SPEED_HIGH:
1244 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1245 break;
1246 default:
1247 dev_err (dummy_dev(dum), "bogus device speed\n");
1248 return;
1251 /* FIXME if HZ != 1000 this will probably misbehave ... */
1253 /* look at each urb queued by the host side driver */
1254 spin_lock_irqsave (&dum->lock, flags);
1256 if (!dum->udev) {
1257 dev_err (dummy_dev(dum),
1258 "timer fired with no URBs pending?\n");
1259 spin_unlock_irqrestore (&dum->lock, flags);
1260 return;
1263 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1264 if (!ep_name [i])
1265 break;
1266 dum->ep [i].already_seen = 0;
1269 restart:
1270 list_for_each_entry_safe (urbp, tmp, &dum->urbp_list, urbp_list) {
1271 struct urb *urb;
1272 struct dummy_request *req;
1273 u8 address;
1274 struct dummy_ep *ep = NULL;
1275 int type;
1277 urb = urbp->urb;
1278 if (urb->status != -EINPROGRESS) {
1279 /* likely it was just unlinked */
1280 goto return_urb;
1281 } else if (dum->rh_state != DUMMY_RH_RUNNING)
1282 continue;
1283 type = usb_pipetype (urb->pipe);
1285 /* used up this frame's non-periodic bandwidth?
1286 * FIXME there's infinite bandwidth for control and
1287 * periodic transfers ... unrealistic.
1289 if (total <= 0 && type == PIPE_BULK)
1290 continue;
1292 /* find the gadget's ep for this request (if configured) */
1293 address = usb_pipeendpoint (urb->pipe);
1294 if (usb_pipein (urb->pipe))
1295 address |= USB_DIR_IN;
1296 ep = find_endpoint(dum, address);
1297 if (!ep) {
1298 /* set_configuration() disagreement */
1299 dev_dbg (dummy_dev(dum),
1300 "no ep configured for urb %p\n",
1301 urb);
1302 maybe_set_status (urb, -EPROTO);
1303 goto return_urb;
1306 if (ep->already_seen)
1307 continue;
1308 ep->already_seen = 1;
1309 if (ep == &dum->ep [0] && urb->error_count) {
1310 ep->setup_stage = 1; /* a new urb */
1311 urb->error_count = 0;
1313 if (ep->halted && !ep->setup_stage) {
1314 /* NOTE: must not be iso! */
1315 dev_dbg (dummy_dev(dum), "ep %s halted, urb %p\n",
1316 ep->ep.name, urb);
1317 maybe_set_status (urb, -EPIPE);
1318 goto return_urb;
1320 /* FIXME make sure both ends agree on maxpacket */
1322 /* handle control requests */
1323 if (ep == &dum->ep [0] && ep->setup_stage) {
1324 struct usb_ctrlrequest setup;
1325 int value = 1;
1326 struct dummy_ep *ep2;
1327 unsigned w_index;
1328 unsigned w_value;
1330 setup = *(struct usb_ctrlrequest*) urb->setup_packet;
1331 w_index = le16_to_cpu(setup.wIndex);
1332 w_value = le16_to_cpu(setup.wValue);
1333 if (le16_to_cpu(setup.wLength) !=
1334 urb->transfer_buffer_length) {
1335 maybe_set_status (urb, -EOVERFLOW);
1336 goto return_urb;
1339 /* paranoia, in case of stale queued data */
1340 list_for_each_entry (req, &ep->queue, queue) {
1341 list_del_init (&req->queue);
1342 req->req.status = -EOVERFLOW;
1343 dev_dbg (udc_dev(dum), "stale req = %p\n",
1344 req);
1346 spin_unlock (&dum->lock);
1347 req->req.complete (&ep->ep, &req->req);
1348 spin_lock (&dum->lock);
1349 ep->already_seen = 0;
1350 goto restart;
1353 /* gadget driver never sees set_address or operations
1354 * on standard feature flags. some hardware doesn't
1355 * even expose them.
1357 ep->last_io = jiffies;
1358 ep->setup_stage = 0;
1359 ep->halted = 0;
1360 switch (setup.bRequest) {
1361 case USB_REQ_SET_ADDRESS:
1362 if (setup.bRequestType != Dev_Request)
1363 break;
1364 dum->address = w_value;
1365 maybe_set_status (urb, 0);
1366 dev_dbg (udc_dev(dum), "set_address = %d\n",
1367 w_value);
1368 value = 0;
1369 break;
1370 case USB_REQ_SET_FEATURE:
1371 if (setup.bRequestType == Dev_Request) {
1372 value = 0;
1373 switch (w_value) {
1374 case USB_DEVICE_REMOTE_WAKEUP:
1375 break;
1376 case USB_DEVICE_B_HNP_ENABLE:
1377 dum->gadget.b_hnp_enable = 1;
1378 break;
1379 case USB_DEVICE_A_HNP_SUPPORT:
1380 dum->gadget.a_hnp_support = 1;
1381 break;
1382 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1383 dum->gadget.a_alt_hnp_support
1384 = 1;
1385 break;
1386 default:
1387 value = -EOPNOTSUPP;
1389 if (value == 0) {
1390 dum->devstatus |=
1391 (1 << w_value);
1392 maybe_set_status (urb, 0);
1395 } else if (setup.bRequestType == Ep_Request) {
1396 // endpoint halt
1397 ep2 = find_endpoint (dum, w_index);
1398 if (!ep2) {
1399 value = -EOPNOTSUPP;
1400 break;
1402 ep2->halted = 1;
1403 value = 0;
1404 maybe_set_status (urb, 0);
1406 break;
1407 case USB_REQ_CLEAR_FEATURE:
1408 if (setup.bRequestType == Dev_Request) {
1409 switch (w_value) {
1410 case USB_DEVICE_REMOTE_WAKEUP:
1411 dum->devstatus &= ~(1 <<
1412 USB_DEVICE_REMOTE_WAKEUP);
1413 value = 0;
1414 maybe_set_status (urb, 0);
1415 break;
1416 default:
1417 value = -EOPNOTSUPP;
1418 break;
1420 } else if (setup.bRequestType == Ep_Request) {
1421 // endpoint halt
1422 ep2 = find_endpoint (dum, w_index);
1423 if (!ep2) {
1424 value = -EOPNOTSUPP;
1425 break;
1427 ep2->halted = 0;
1428 value = 0;
1429 maybe_set_status (urb, 0);
1431 break;
1432 case USB_REQ_GET_STATUS:
1433 if (setup.bRequestType == Dev_InRequest
1434 || setup.bRequestType
1435 == Intf_InRequest
1436 || setup.bRequestType
1437 == Ep_InRequest
1439 char *buf;
1441 // device: remote wakeup, selfpowered
1442 // interface: nothing
1443 // endpoint: halt
1444 buf = (char *)urb->transfer_buffer;
1445 if (urb->transfer_buffer_length > 0) {
1446 if (setup.bRequestType ==
1447 Ep_InRequest) {
1448 ep2 = find_endpoint (dum, w_index);
1449 if (!ep2) {
1450 value = -EOPNOTSUPP;
1451 break;
1453 buf [0] = ep2->halted;
1454 } else if (setup.bRequestType ==
1455 Dev_InRequest) {
1456 buf [0] = (u8)
1457 dum->devstatus;
1458 } else
1459 buf [0] = 0;
1461 if (urb->transfer_buffer_length > 1)
1462 buf [1] = 0;
1463 urb->actual_length = min (2,
1464 urb->transfer_buffer_length);
1465 value = 0;
1466 maybe_set_status (urb, 0);
1468 break;
1471 /* gadget driver handles all other requests. block
1472 * until setup() returns; no reentrancy issues etc.
1474 if (value > 0) {
1475 spin_unlock (&dum->lock);
1476 value = dum->driver->setup (&dum->gadget,
1477 &setup);
1478 spin_lock (&dum->lock);
1480 if (value >= 0) {
1481 /* no delays (max 64KB data stage) */
1482 limit = 64*1024;
1483 goto treat_control_like_bulk;
1485 /* error, see below */
1488 if (value < 0) {
1489 if (value != -EOPNOTSUPP)
1490 dev_dbg (udc_dev(dum),
1491 "setup --> %d\n",
1492 value);
1493 maybe_set_status (urb, -EPIPE);
1494 urb->actual_length = 0;
1497 goto return_urb;
1500 /* non-control requests */
1501 limit = total;
1502 switch (usb_pipetype (urb->pipe)) {
1503 case PIPE_ISOCHRONOUS:
1504 /* FIXME is it urb->interval since the last xfer?
1505 * use urb->iso_frame_desc[i].
1506 * complete whether or not ep has requests queued.
1507 * report random errors, to debug drivers.
1509 limit = max (limit, periodic_bytes (dum, ep));
1510 maybe_set_status (urb, -ENOSYS);
1511 break;
1513 case PIPE_INTERRUPT:
1514 /* FIXME is it urb->interval since the last xfer?
1515 * this almost certainly polls too fast.
1517 limit = max (limit, periodic_bytes (dum, ep));
1518 /* FALLTHROUGH */
1520 // case PIPE_BULK: case PIPE_CONTROL:
1521 default:
1522 treat_control_like_bulk:
1523 ep->last_io = jiffies;
1524 total = transfer (dum, urb, ep, limit);
1525 break;
1528 /* incomplete transfer? */
1529 if (urb->status == -EINPROGRESS)
1530 continue;
1532 return_urb:
1533 urb->hcpriv = NULL;
1534 list_del (&urbp->urbp_list);
1535 kfree (urbp);
1536 if (ep)
1537 ep->already_seen = ep->setup_stage = 0;
1539 spin_unlock (&dum->lock);
1540 usb_hcd_giveback_urb (dummy_to_hcd(dum), urb, NULL);
1541 spin_lock (&dum->lock);
1543 goto restart;
1546 if (list_empty (&dum->urbp_list)) {
1547 usb_put_dev (dum->udev);
1548 dum->udev = NULL;
1549 } else if (dum->rh_state == DUMMY_RH_RUNNING) {
1550 /* want a 1 msec delay here */
1551 mod_timer (&dum->timer, jiffies + msecs_to_jiffies(1));
1554 spin_unlock_irqrestore (&dum->lock, flags);
1557 /*-------------------------------------------------------------------------*/
1559 #define PORT_C_MASK \
1560 ((USB_PORT_STAT_C_CONNECTION \
1561 | USB_PORT_STAT_C_ENABLE \
1562 | USB_PORT_STAT_C_SUSPEND \
1563 | USB_PORT_STAT_C_OVERCURRENT \
1564 | USB_PORT_STAT_C_RESET) << 16)
1566 static int dummy_hub_status (struct usb_hcd *hcd, char *buf)
1568 struct dummy *dum;
1569 unsigned long flags;
1570 int retval = 0;
1572 dum = hcd_to_dummy (hcd);
1574 spin_lock_irqsave (&dum->lock, flags);
1575 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
1576 goto done;
1578 if (dum->resuming && time_after_eq (jiffies, dum->re_timeout)) {
1579 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1580 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1581 set_link_state (dum);
1584 if ((dum->port_status & PORT_C_MASK) != 0) {
1585 *buf = (1 << 1);
1586 dev_dbg (dummy_dev(dum), "port status 0x%08x has changes\n",
1587 dum->port_status);
1588 retval = 1;
1589 if (dum->rh_state == DUMMY_RH_SUSPENDED)
1590 usb_hcd_resume_root_hub (hcd);
1592 done:
1593 spin_unlock_irqrestore (&dum->lock, flags);
1594 return retval;
1597 static inline void
1598 hub_descriptor (struct usb_hub_descriptor *desc)
1600 memset (desc, 0, sizeof *desc);
1601 desc->bDescriptorType = 0x29;
1602 desc->bDescLength = 9;
1603 desc->wHubCharacteristics = (__force __u16)
1604 (__constant_cpu_to_le16 (0x0001));
1605 desc->bNbrPorts = 1;
1606 desc->bitmap [0] = 0xff;
1607 desc->bitmap [1] = 0xff;
1610 static int dummy_hub_control (
1611 struct usb_hcd *hcd,
1612 u16 typeReq,
1613 u16 wValue,
1614 u16 wIndex,
1615 char *buf,
1616 u16 wLength
1618 struct dummy *dum;
1619 int retval = 0;
1620 unsigned long flags;
1622 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
1623 return -ETIMEDOUT;
1625 dum = hcd_to_dummy (hcd);
1626 spin_lock_irqsave (&dum->lock, flags);
1627 switch (typeReq) {
1628 case ClearHubFeature:
1629 break;
1630 case ClearPortFeature:
1631 switch (wValue) {
1632 case USB_PORT_FEAT_SUSPEND:
1633 if (dum->port_status & USB_PORT_STAT_SUSPEND) {
1634 /* 20msec resume signaling */
1635 dum->resuming = 1;
1636 dum->re_timeout = jiffies +
1637 msecs_to_jiffies(20);
1639 break;
1640 case USB_PORT_FEAT_POWER:
1641 if (dum->port_status & USB_PORT_STAT_POWER)
1642 dev_dbg (dummy_dev(dum), "power-off\n");
1643 /* FALLS THROUGH */
1644 default:
1645 dum->port_status &= ~(1 << wValue);
1646 set_link_state (dum);
1648 break;
1649 case GetHubDescriptor:
1650 hub_descriptor ((struct usb_hub_descriptor *) buf);
1651 break;
1652 case GetHubStatus:
1653 *(__le32 *) buf = __constant_cpu_to_le32 (0);
1654 break;
1655 case GetPortStatus:
1656 if (wIndex != 1)
1657 retval = -EPIPE;
1659 /* whoever resets or resumes must GetPortStatus to
1660 * complete it!!
1662 if (dum->resuming &&
1663 time_after_eq (jiffies, dum->re_timeout)) {
1664 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1665 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1667 if ((dum->port_status & USB_PORT_STAT_RESET) != 0 &&
1668 time_after_eq (jiffies, dum->re_timeout)) {
1669 dum->port_status |= (USB_PORT_STAT_C_RESET << 16);
1670 dum->port_status &= ~USB_PORT_STAT_RESET;
1671 if (dum->pullup) {
1672 dum->port_status |= USB_PORT_STAT_ENABLE;
1673 /* give it the best speed we agree on */
1674 dum->gadget.speed = dum->driver->speed;
1675 dum->gadget.ep0->maxpacket = 64;
1676 switch (dum->gadget.speed) {
1677 case USB_SPEED_HIGH:
1678 dum->port_status |=
1679 USB_PORT_STAT_HIGH_SPEED;
1680 break;
1681 case USB_SPEED_LOW:
1682 dum->gadget.ep0->maxpacket = 8;
1683 dum->port_status |=
1684 USB_PORT_STAT_LOW_SPEED;
1685 break;
1686 default:
1687 dum->gadget.speed = USB_SPEED_FULL;
1688 break;
1692 set_link_state (dum);
1693 ((__le16 *) buf)[0] = cpu_to_le16 (dum->port_status);
1694 ((__le16 *) buf)[1] = cpu_to_le16 (dum->port_status >> 16);
1695 break;
1696 case SetHubFeature:
1697 retval = -EPIPE;
1698 break;
1699 case SetPortFeature:
1700 switch (wValue) {
1701 case USB_PORT_FEAT_SUSPEND:
1702 if (dum->active) {
1703 dum->port_status |= USB_PORT_STAT_SUSPEND;
1705 /* HNP would happen here; for now we
1706 * assume b_bus_req is always true.
1708 set_link_state (dum);
1709 if (((1 << USB_DEVICE_B_HNP_ENABLE)
1710 & dum->devstatus) != 0)
1711 dev_dbg (dummy_dev(dum),
1712 "no HNP yet!\n");
1714 break;
1715 case USB_PORT_FEAT_POWER:
1716 dum->port_status |= USB_PORT_STAT_POWER;
1717 set_link_state (dum);
1718 break;
1719 case USB_PORT_FEAT_RESET:
1720 /* if it's already enabled, disable */
1721 dum->port_status &= ~(USB_PORT_STAT_ENABLE
1722 | USB_PORT_STAT_LOW_SPEED
1723 | USB_PORT_STAT_HIGH_SPEED);
1724 dum->devstatus = 0;
1725 /* 50msec reset signaling */
1726 dum->re_timeout = jiffies + msecs_to_jiffies(50);
1727 /* FALLS THROUGH */
1728 default:
1729 if ((dum->port_status & USB_PORT_STAT_POWER) != 0) {
1730 dum->port_status |= (1 << wValue);
1731 set_link_state (dum);
1734 break;
1736 default:
1737 dev_dbg (dummy_dev(dum),
1738 "hub control req%04x v%04x i%04x l%d\n",
1739 typeReq, wValue, wIndex, wLength);
1741 /* "protocol stall" on error */
1742 retval = -EPIPE;
1744 spin_unlock_irqrestore (&dum->lock, flags);
1746 if ((dum->port_status & PORT_C_MASK) != 0)
1747 usb_hcd_poll_rh_status (hcd);
1748 return retval;
1751 static int dummy_bus_suspend (struct usb_hcd *hcd)
1753 struct dummy *dum = hcd_to_dummy (hcd);
1755 dev_dbg (&hcd->self.root_hub->dev, "%s\n", __FUNCTION__);
1757 spin_lock_irq (&dum->lock);
1758 dum->rh_state = DUMMY_RH_SUSPENDED;
1759 set_link_state (dum);
1760 hcd->state = HC_STATE_SUSPENDED;
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);
1768 int rc = 0;
1770 dev_dbg (&hcd->self.root_hub->dev, "%s\n", __FUNCTION__);
1772 spin_lock_irq (&dum->lock);
1773 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
1774 dev_warn (&hcd->self.root_hub->dev, "HC isn't running!\n");
1775 rc = -ENODEV;
1776 } else {
1777 dum->rh_state = DUMMY_RH_RUNNING;
1778 set_link_state (dum);
1779 if (!list_empty(&dum->urbp_list))
1780 mod_timer (&dum->timer, jiffies);
1781 hcd->state = HC_STATE_RUNNING;
1783 spin_unlock_irq (&dum->lock);
1784 return rc;
1787 /*-------------------------------------------------------------------------*/
1789 static inline ssize_t
1790 show_urb (char *buf, size_t size, struct urb *urb)
1792 int ep = usb_pipeendpoint (urb->pipe);
1794 return snprintf (buf, size,
1795 "urb/%p %s ep%d%s%s len %d/%d\n",
1796 urb,
1797 ({ char *s;
1798 switch (urb->dev->speed) {
1799 case USB_SPEED_LOW: s = "ls"; break;
1800 case USB_SPEED_FULL: s = "fs"; break;
1801 case USB_SPEED_HIGH: s = "hs"; break;
1802 default: s = "?"; break;
1803 }; s; }),
1804 ep, ep ? (usb_pipein (urb->pipe) ? "in" : "out") : "",
1805 ({ char *s; \
1806 switch (usb_pipetype (urb->pipe)) { \
1807 case PIPE_CONTROL: s = ""; break; \
1808 case PIPE_BULK: s = "-bulk"; break; \
1809 case PIPE_INTERRUPT: s = "-int"; break; \
1810 default: s = "-iso"; break; \
1811 }; s;}),
1812 urb->actual_length, urb->transfer_buffer_length);
1815 static ssize_t
1816 show_urbs (struct device *dev, struct device_attribute *attr, char *buf)
1818 struct usb_hcd *hcd = dev_get_drvdata (dev);
1819 struct dummy *dum = hcd_to_dummy (hcd);
1820 struct urbp *urbp;
1821 size_t size = 0;
1822 unsigned long flags;
1824 spin_lock_irqsave (&dum->lock, flags);
1825 list_for_each_entry (urbp, &dum->urbp_list, urbp_list) {
1826 size_t temp;
1828 temp = show_urb (buf, PAGE_SIZE - size, urbp->urb);
1829 buf += temp;
1830 size += temp;
1832 spin_unlock_irqrestore (&dum->lock, flags);
1834 return size;
1836 static DEVICE_ATTR (urbs, S_IRUGO, show_urbs, NULL);
1838 static int dummy_start (struct usb_hcd *hcd)
1840 struct dummy *dum;
1842 dum = hcd_to_dummy (hcd);
1845 * MASTER side init ... we emulate a root hub that'll only ever
1846 * talk to one device (the slave side). Also appears in sysfs,
1847 * just like more familiar pci-based HCDs.
1849 spin_lock_init (&dum->lock);
1850 init_timer (&dum->timer);
1851 dum->timer.function = dummy_timer;
1852 dum->timer.data = (unsigned long) dum;
1853 dum->rh_state = DUMMY_RH_RUNNING;
1855 INIT_LIST_HEAD (&dum->urbp_list);
1857 /* only show a low-power port: just 8mA */
1858 hcd->power_budget = 8;
1859 hcd->state = HC_STATE_RUNNING;
1860 hcd->uses_new_polling = 1;
1862 #ifdef CONFIG_USB_OTG
1863 hcd->self.otg_port = 1;
1864 #endif
1866 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
1867 device_create_file (dummy_dev(dum), &dev_attr_urbs);
1868 return 0;
1871 static void dummy_stop (struct usb_hcd *hcd)
1873 struct dummy *dum;
1875 dum = hcd_to_dummy (hcd);
1877 device_remove_file (dummy_dev(dum), &dev_attr_urbs);
1878 usb_gadget_unregister_driver (dum->driver);
1879 dev_info (dummy_dev(dum), "stopped\n");
1882 /*-------------------------------------------------------------------------*/
1884 static int dummy_h_get_frame (struct usb_hcd *hcd)
1886 return dummy_g_get_frame (NULL);
1889 static const struct hc_driver dummy_hcd = {
1890 .description = (char *) driver_name,
1891 .product_desc = "Dummy host controller",
1892 .hcd_priv_size = sizeof(struct dummy),
1894 .flags = HCD_USB2,
1896 .start = dummy_start,
1897 .stop = dummy_stop,
1899 .urb_enqueue = dummy_urb_enqueue,
1900 .urb_dequeue = dummy_urb_dequeue,
1902 .get_frame_number = dummy_h_get_frame,
1904 .hub_status_data = dummy_hub_status,
1905 .hub_control = dummy_hub_control,
1906 .bus_suspend = dummy_bus_suspend,
1907 .bus_resume = dummy_bus_resume,
1910 static int dummy_hcd_probe(struct platform_device *pdev)
1912 struct usb_hcd *hcd;
1913 int retval;
1915 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
1917 hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, pdev->dev.bus_id);
1918 if (!hcd)
1919 return -ENOMEM;
1920 the_controller = hcd_to_dummy (hcd);
1922 retval = usb_add_hcd(hcd, 0, 0);
1923 if (retval != 0) {
1924 usb_put_hcd (hcd);
1925 the_controller = NULL;
1927 return retval;
1930 static int dummy_hcd_remove (struct platform_device *pdev)
1932 struct usb_hcd *hcd;
1934 hcd = platform_get_drvdata (pdev);
1935 usb_remove_hcd (hcd);
1936 usb_put_hcd (hcd);
1937 the_controller = NULL;
1938 return 0;
1941 static int dummy_hcd_suspend (struct platform_device *pdev, pm_message_t state)
1943 struct usb_hcd *hcd;
1944 struct dummy *dum;
1945 int rc = 0;
1947 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
1949 hcd = platform_get_drvdata (pdev);
1950 dum = hcd_to_dummy (hcd);
1951 if (dum->rh_state == DUMMY_RH_RUNNING) {
1952 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
1953 rc = -EBUSY;
1954 } else
1955 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1956 return rc;
1959 static int dummy_hcd_resume (struct platform_device *pdev)
1961 struct usb_hcd *hcd;
1963 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
1965 hcd = platform_get_drvdata (pdev);
1966 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1967 usb_hcd_poll_rh_status (hcd);
1968 return 0;
1971 static struct platform_driver dummy_hcd_driver = {
1972 .probe = dummy_hcd_probe,
1973 .remove = dummy_hcd_remove,
1974 .suspend = dummy_hcd_suspend,
1975 .resume = dummy_hcd_resume,
1976 .driver = {
1977 .name = (char *) driver_name,
1978 .owner = THIS_MODULE,
1982 /*-------------------------------------------------------------------------*/
1984 /* These don't need to do anything because the pdev structures are
1985 * statically allocated. */
1986 static void
1987 dummy_udc_release (struct device *dev) {}
1989 static void
1990 dummy_hcd_release (struct device *dev) {}
1992 static struct platform_device the_udc_pdev = {
1993 .name = (char *) gadget_name,
1994 .id = -1,
1995 .dev = {
1996 .release = dummy_udc_release,
2000 static struct platform_device the_hcd_pdev = {
2001 .name = (char *) driver_name,
2002 .id = -1,
2003 .dev = {
2004 .release = dummy_hcd_release,
2008 static int __init init (void)
2010 int retval;
2012 if (usb_disabled ())
2013 return -ENODEV;
2015 retval = platform_driver_register (&dummy_hcd_driver);
2016 if (retval < 0)
2017 return retval;
2019 retval = platform_driver_register (&dummy_udc_driver);
2020 if (retval < 0)
2021 goto err_register_udc_driver;
2023 retval = platform_device_register (&the_hcd_pdev);
2024 if (retval < 0)
2025 goto err_register_hcd;
2027 retval = platform_device_register (&the_udc_pdev);
2028 if (retval < 0)
2029 goto err_register_udc;
2030 return retval;
2032 err_register_udc:
2033 platform_device_unregister (&the_hcd_pdev);
2034 err_register_hcd:
2035 platform_driver_unregister (&dummy_udc_driver);
2036 err_register_udc_driver:
2037 platform_driver_unregister (&dummy_hcd_driver);
2038 return retval;
2040 module_init (init);
2042 static void __exit cleanup (void)
2044 platform_device_unregister (&the_udc_pdev);
2045 platform_device_unregister (&the_hcd_pdev);
2046 platform_driver_unregister (&dummy_udc_driver);
2047 platform_driver_unregister (&dummy_hcd_driver);
2049 module_exit (cleanup);