?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
USB: dummy_hcd: don't register drivers on the platform bus
[linux-2.6/mini2440.git] / drivers / usb / gadget / dummy_hcd.c
blob1a8a5f33443e37593fcfd87865a876f4f9ec54d6
1 /*
2 * dummy_hcd.c -- Dummy/Loopback USB host and device emulator driver.
3 *
4 * Maintainer: Alan Stern <stern@rowland.harvard.edu>
5 *
6 * Copyright (C) 2003 David Brownell
7 * Copyright (C) 2003-2005 Alan Stern
8 *
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.
13 *
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.
18 *
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
22 */
23
24
25 /*
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:
29 *
30 * - Gadget driver, responding to requests (slave);
31 * - Host-side device driver, as already familiar in Linux.
32 *
33 * Having this all in one kernel can help some stages of development,
34 * bypassing some hardware (and driver) issues. UML could help too.
35 */
36
37 #include <linux/module.h>
38 #include <linux/kernel.h>
39 #include <linux/delay.h>
40 #include <linux/ioport.h>
41 #include <linux/slab.h>
42 #include <linux/errno.h>
43 #include <linux/init.h>
44 #include <linux/timer.h>
45 #include <linux/list.h>
46 #include <linux/interrupt.h>
47 #include <linux/platform_device.h>
48 #include <linux/usb.h>
49 #include <linux/usb/gadget.h>
50
51 #include <asm/byteorder.h>
52 #include <asm/io.h>
53 #include <asm/irq.h>
54 #include <asm/system.h>
55 #include <asm/unaligned.h>
56
57
58 #include "../core/hcd.h"
59
60
61 #define DRIVER_DESC "USB Host+Gadget Emulator"
62 #define DRIVER_VERSION "02 May 2005"
63
64 static const char driver_name [] = "dummy_hcd";
65 static const char driver_desc [] = "USB Host+Gadget Emulator";
66
67 static const char gadget_name [] = "dummy_udc";
68
69 MODULE_DESCRIPTION (DRIVER_DESC);
70 MODULE_AUTHOR ("David Brownell");
71 MODULE_LICENSE ("GPL");
72
73 /*-------------------------------------------------------------------------*/
74
75 /* gadget side driver data structres */
76 struct dummy_ep {
77 struct list_head queue;
78 unsigned long last_io; /* jiffies timestamp */
79 struct usb_gadget *gadget;
80 const struct usb_endpoint_descriptor *desc;
81 struct usb_ep ep;
82 unsigned halted : 1;
83 unsigned already_seen : 1;
84 unsigned setup_stage : 1;
85 };
86
87 struct dummy_request {
88 struct list_head queue; /* ep's requests */
89 struct usb_request req;
90 };
91
92 static inline struct dummy_ep *usb_ep_to_dummy_ep (struct usb_ep *_ep)
93 {
94 return container_of (_ep, struct dummy_ep, ep);
95 }
96
97 static inline struct dummy_request *usb_request_to_dummy_request
98 (struct usb_request *_req)
99 {
100 return container_of (_req, struct dummy_request, req);
101 }
102
103 /*-------------------------------------------------------------------------*/
104
105 /*
106 * Every device has ep0 for control requests, plus up to 30 more endpoints,
107 * in one of two types:
108 *
109 * - Configurable: direction (in/out), type (bulk, iso, etc), and endpoint
110 * number can be changed. Names like "ep-a" are used for this type.
111 *
112 * - Fixed Function: in other cases. some characteristics may be mutable;
113 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
114 *
115 * Gadget drivers are responsible for not setting up conflicting endpoint
116 * configurations, illegal or unsupported packet lengths, and so on.
117 */
118
119 static const char ep0name [] = "ep0";
120
121 static const char *const ep_name [] = {
122 ep0name, /* everyone has ep0 */
123
124 /* act like a net2280: high speed, six configurable endpoints */
125 "ep-a", "ep-b", "ep-c", "ep-d", "ep-e", "ep-f",
126
127 /* or like pxa250: fifteen fixed function endpoints */
128 "ep1in-bulk", "ep2out-bulk", "ep3in-iso", "ep4out-iso", "ep5in-int",
129 "ep6in-bulk", "ep7out-bulk", "ep8in-iso", "ep9out-iso", "ep10in-int",
130 "ep11in-bulk", "ep12out-bulk", "ep13in-iso", "ep14out-iso",
131 "ep15in-int",
132
133 /* or like sa1100: two fixed function endpoints */
134 "ep1out-bulk", "ep2in-bulk",
135 };
136 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_name)
137
138 /*-------------------------------------------------------------------------*/
139
140 #define FIFO_SIZE 64
141
142 struct urbp {
143 struct urb *urb;
144 struct list_head urbp_list;
145 };
146
147
148 enum dummy_rh_state {
149 DUMMY_RH_RESET,
150 DUMMY_RH_SUSPENDED,
151 DUMMY_RH_RUNNING
152 };
153
154 struct dummy {
155 spinlock_t lock;
156
157 /*
158 * SLAVE/GADGET side support
159 */
160 struct dummy_ep ep [DUMMY_ENDPOINTS];
161 int address;
162 struct usb_gadget gadget;
163 struct usb_gadget_driver *driver;
164 struct dummy_request fifo_req;
165 u8 fifo_buf [FIFO_SIZE];
166 u16 devstatus;
167 unsigned udc_suspended:1;
168 unsigned pullup:1;
169 unsigned active:1;
170 unsigned old_active:1;
171
172 /*
173 * MASTER/HOST side support
174 */
175 enum dummy_rh_state rh_state;
176 struct timer_list timer;
177 u32 port_status;
178 u32 old_status;
179 unsigned resuming:1;
180 unsigned long re_timeout;
181
182 struct usb_device *udev;
183 struct list_head urbp_list;
184 };
185
186 static inline struct dummy *hcd_to_dummy (struct usb_hcd *hcd)
187 {
188 return (struct dummy *) (hcd->hcd_priv);
189 }
190
191 static inline struct usb_hcd *dummy_to_hcd (struct dummy *dum)
192 {
193 return container_of((void *) dum, struct usb_hcd, hcd_priv);
194 }
195
196 static inline struct device *dummy_dev (struct dummy *dum)
197 {
198 return dummy_to_hcd(dum)->self.controller;
199 }
200
201 static inline struct device *udc_dev (struct dummy *dum)
202 {
203 return dum->gadget.dev.parent;
204 }
205
206 static inline struct dummy *ep_to_dummy (struct dummy_ep *ep)
207 {
208 return container_of (ep->gadget, struct dummy, gadget);
209 }
210
211 static inline struct dummy *gadget_to_dummy (struct usb_gadget *gadget)
212 {
213 return container_of (gadget, struct dummy, gadget);
214 }
215
216 static inline struct dummy *gadget_dev_to_dummy (struct device *dev)
217 {
218 return container_of (dev, struct dummy, gadget.dev);
219 }
220
221 static struct dummy *the_controller;
222
223 /*-------------------------------------------------------------------------*/
224
225 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
226
227 /* called with spinlock held */
228 static void nuke (struct dummy *dum, struct dummy_ep *ep)
229 {
230 while (!list_empty (&ep->queue)) {
231 struct dummy_request *req;
232
233 req = list_entry (ep->queue.next, struct dummy_request, queue);
234 list_del_init (&req->queue);
235 req->req.status = -ESHUTDOWN;
236
237 spin_unlock (&dum->lock);
238 req->req.complete (&ep->ep, &req->req);
239 spin_lock (&dum->lock);
240 }
241 }
242
243 /* caller must hold lock */
244 static void
245 stop_activity (struct dummy *dum)
246 {
247 struct dummy_ep *ep;
248
249 /* prevent any more requests */
250 dum->address = 0;
251
252 /* The timer is left running so that outstanding URBs can fail */
253
254 /* nuke any pending requests first, so driver i/o is quiesced */
255 list_for_each_entry (ep, &dum->gadget.ep_list, ep.ep_list)
256 nuke (dum, ep);
257
258 /* driver now does any non-usb quiescing necessary */
259 }
260
261 /* caller must hold lock */
262 static void
263 set_link_state (struct dummy *dum)
264 {
265 dum->active = 0;
266 if ((dum->port_status & USB_PORT_STAT_POWER) == 0)
267 dum->port_status = 0;
268
269 /* UDC suspend must cause a disconnect */
270 else if (!dum->pullup || dum->udc_suspended) {
271 dum->port_status &= ~(USB_PORT_STAT_CONNECTION |
272 USB_PORT_STAT_ENABLE |
273 USB_PORT_STAT_LOW_SPEED |
274 USB_PORT_STAT_HIGH_SPEED |
275 USB_PORT_STAT_SUSPEND);
276 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0)
277 dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
278 } else {
279 dum->port_status |= USB_PORT_STAT_CONNECTION;
280 if ((dum->old_status & USB_PORT_STAT_CONNECTION) == 0)
281 dum->port_status |= (USB_PORT_STAT_C_CONNECTION << 16);
282 if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0)
283 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
284 else if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
285 dum->rh_state != DUMMY_RH_SUSPENDED)
286 dum->active = 1;
287 }
288
289 if ((dum->port_status & USB_PORT_STAT_ENABLE) == 0 || dum->active)
290 dum->resuming = 0;
291
292 if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0 ||
293 (dum->port_status & USB_PORT_STAT_RESET) != 0) {
294 if ((dum->old_status & USB_PORT_STAT_CONNECTION) != 0 &&
295 (dum->old_status & USB_PORT_STAT_RESET) == 0 &&
296 dum->driver) {
297 stop_activity (dum);
298 spin_unlock (&dum->lock);
299 dum->driver->disconnect (&dum->gadget);
300 spin_lock (&dum->lock);
301 }
302 } else if (dum->active != dum->old_active) {
303 if (dum->old_active && dum->driver->suspend) {
304 spin_unlock (&dum->lock);
305 dum->driver->suspend (&dum->gadget);
306 spin_lock (&dum->lock);
307 } else if (!dum->old_active && dum->driver->resume) {
308 spin_unlock (&dum->lock);
309 dum->driver->resume (&dum->gadget);
310 spin_lock (&dum->lock);
311 }
312 }
313
314 dum->old_status = dum->port_status;
315 dum->old_active = dum->active;
316 }
317
318 /*-------------------------------------------------------------------------*/
319
320 /* SLAVE/GADGET SIDE DRIVER
321 *
322 * This only tracks gadget state. All the work is done when the host
323 * side tries some (emulated) i/o operation. Real device controller
324 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
325 */
326
327 #define is_enabled(dum) \
328 (dum->port_status & USB_PORT_STAT_ENABLE)
329
330 static int
331 dummy_enable (struct usb_ep *_ep, const struct usb_endpoint_descriptor *desc)
332 {
333 struct dummy *dum;
334 struct dummy_ep *ep;
335 unsigned max;
336 int retval;
337
338 ep = usb_ep_to_dummy_ep (_ep);
339 if (!_ep || !desc || ep->desc || _ep->name == ep0name
340 || desc->bDescriptorType != USB_DT_ENDPOINT)
341 return -EINVAL;
342 dum = ep_to_dummy (ep);
343 if (!dum->driver || !is_enabled (dum))
344 return -ESHUTDOWN;
345 max = le16_to_cpu(desc->wMaxPacketSize) & 0x3ff;
346
347 /* drivers must not request bad settings, since lower levels
348 * (hardware or its drivers) may not check. some endpoints
349 * can't do iso, many have maxpacket limitations, etc.
350 *
351 * since this "hardware" driver is here to help debugging, we
352 * have some extra sanity checks. (there could be more though,
353 * especially for "ep9out" style fixed function ones.)
354 */
355 retval = -EINVAL;
356 switch (desc->bmAttributes & 0x03) {
357 case USB_ENDPOINT_XFER_BULK:
358 if (strstr (ep->ep.name, "-iso")
359 || strstr (ep->ep.name, "-int")) {
360 goto done;
361 }
362 switch (dum->gadget.speed) {
363 case USB_SPEED_HIGH:
364 if (max == 512)
365 break;
366 /* conserve return statements */
367 default:
368 switch (max) {
369 case 8: case 16: case 32: case 64:
370 /* we'll fake any legal size */
371 break;
372 default:
373 case USB_SPEED_LOW:
374 goto done;
375 }
376 }
377 break;
378 case USB_ENDPOINT_XFER_INT:
379 if (strstr (ep->ep.name, "-iso")) /* bulk is ok */
380 goto done;
381 /* real hardware might not handle all packet sizes */
382 switch (dum->gadget.speed) {
383 case USB_SPEED_HIGH:
384 if (max <= 1024)
385 break;
386 /* save a return statement */
387 case USB_SPEED_FULL:
388 if (max <= 64)
389 break;
390 /* save a return statement */
391 default:
392 if (max <= 8)
393 break;
394 goto done;
395 }
396 break;
397 case USB_ENDPOINT_XFER_ISOC:
398 if (strstr (ep->ep.name, "-bulk")
399 || strstr (ep->ep.name, "-int"))
400 goto done;
401 /* real hardware might not handle all packet sizes */
402 switch (dum->gadget.speed) {
403 case USB_SPEED_HIGH:
404 if (max <= 1024)
405 break;
406 /* save a return statement */
407 case USB_SPEED_FULL:
408 if (max <= 1023)
409 break;
410 /* save a return statement */
411 default:
412 goto done;
413 }
414 break;
415 default:
416 /* few chips support control except on ep0 */
417 goto done;
418 }
419
420 _ep->maxpacket = max;
421 ep->desc = desc;
422
423 dev_dbg (udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d\n",
424 _ep->name,
425 desc->bEndpointAddress & 0x0f,
426 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
427 ({ char *val;
428 switch (desc->bmAttributes & 0x03) {
429 case USB_ENDPOINT_XFER_BULK: val = "bulk"; break;
430 case USB_ENDPOINT_XFER_ISOC: val = "iso"; break;
431 case USB_ENDPOINT_XFER_INT: val = "intr"; break;
432 default: val = "ctrl"; break;
433 }; val; }),
434 max);
435
436 /* at this point real hardware should be NAKing transfers
437 * to that endpoint, until a buffer is queued to it.
438 */
439 retval = 0;
440 done:
441 return retval;
442 }
443
444 static int dummy_disable (struct usb_ep *_ep)
445 {
446 struct dummy_ep *ep;
447 struct dummy *dum;
448 unsigned long flags;
449 int retval;
450
451 ep = usb_ep_to_dummy_ep (_ep);
452 if (!_ep || !ep->desc || _ep->name == ep0name)
453 return -EINVAL;
454 dum = ep_to_dummy (ep);
455
456 spin_lock_irqsave (&dum->lock, flags);
457 ep->desc = NULL;
458 retval = 0;
459 nuke (dum, ep);
460 spin_unlock_irqrestore (&dum->lock, flags);
461
462 dev_dbg (udc_dev(dum), "disabled %s\n", _ep->name);
463 return retval;
464 }
465
466 static struct usb_request *
467 dummy_alloc_request (struct usb_ep *_ep, gfp_t mem_flags)
468 {
469 struct dummy_ep *ep;
470 struct dummy_request *req;
471
472 if (!_ep)
473 return NULL;
474 ep = usb_ep_to_dummy_ep (_ep);
475
476 req = kzalloc(sizeof(*req), mem_flags);
477 if (!req)
478 return NULL;
479 INIT_LIST_HEAD (&req->queue);
480 return &req->req;
481 }
482
483 static void
484 dummy_free_request (struct usb_ep *_ep, struct usb_request *_req)
485 {
486 struct dummy_ep *ep;
487 struct dummy_request *req;
488
489 ep = usb_ep_to_dummy_ep (_ep);
490 if (!ep || !_req || (!ep->desc && _ep->name != ep0name))
491 return;
492
493 req = usb_request_to_dummy_request (_req);
494 WARN_ON (!list_empty (&req->queue));
495 kfree (req);
496 }
497
498 static void
499 fifo_complete (struct usb_ep *ep, struct usb_request *req)
500 {
501 }
502
503 static int
504 dummy_queue (struct usb_ep *_ep, struct usb_request *_req,
505 gfp_t mem_flags)
506 {
507 struct dummy_ep *ep;
508 struct dummy_request *req;
509 struct dummy *dum;
510 unsigned long flags;
511
512 req = usb_request_to_dummy_request (_req);
513 if (!_req || !list_empty (&req->queue) || !_req->complete)
514 return -EINVAL;
515
516 ep = usb_ep_to_dummy_ep (_ep);
517 if (!_ep || (!ep->desc && _ep->name != ep0name))
518 return -EINVAL;
519
520 dum = ep_to_dummy (ep);
521 if (!dum->driver || !is_enabled (dum))
522 return -ESHUTDOWN;
523
524 #if 0
525 dev_dbg (udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
526 ep, _req, _ep->name, _req->length, _req->buf);
527 #endif
528
529 _req->status = -EINPROGRESS;
530 _req->actual = 0;
531 spin_lock_irqsave (&dum->lock, flags);
532
533 /* implement an emulated single-request FIFO */
534 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
535 list_empty (&dum->fifo_req.queue) &&
536 list_empty (&ep->queue) &&
537 _req->length <= FIFO_SIZE) {
538 req = &dum->fifo_req;
539 req->req = *_req;
540 req->req.buf = dum->fifo_buf;
541 memcpy (dum->fifo_buf, _req->buf, _req->length);
542 req->req.context = dum;
543 req->req.complete = fifo_complete;
544
545 spin_unlock (&dum->lock);
546 _req->actual = _req->length;
547 _req->status = 0;
548 _req->complete (_ep, _req);
549 spin_lock (&dum->lock);
550 }
551 list_add_tail (&req->queue, &ep->queue);
552 spin_unlock_irqrestore (&dum->lock, flags);
553
554 /* real hardware would likely enable transfers here, in case
555 * it'd been left NAKing.
556 */
557 return 0;
558 }
559
560 static int dummy_dequeue (struct usb_ep *_ep, struct usb_request *_req)
561 {
562 struct dummy_ep *ep;
563 struct dummy *dum;
564 int retval = -EINVAL;
565 unsigned long flags;
566 struct dummy_request *req = NULL;
567
568 if (!_ep || !_req)
569 return retval;
570 ep = usb_ep_to_dummy_ep (_ep);
571 dum = ep_to_dummy (ep);
572
573 if (!dum->driver)
574 return -ESHUTDOWN;
575
576 local_irq_save (flags);
577 spin_lock (&dum->lock);
578 list_for_each_entry (req, &ep->queue, queue) {
579 if (&req->req == _req) {
580 list_del_init (&req->queue);
581 _req->status = -ECONNRESET;
582 retval = 0;
583 break;
584 }
585 }
586 spin_unlock (&dum->lock);
587
588 if (retval == 0) {
589 dev_dbg (udc_dev(dum),
590 "dequeued req %p from %s, len %d buf %p\n",
591 req, _ep->name, _req->length, _req->buf);
592 _req->complete (_ep, _req);
593 }
594 local_irq_restore (flags);
595 return retval;
596 }
597
598 static int
599 dummy_set_halt (struct usb_ep *_ep, int value)
600 {
601 struct dummy_ep *ep;
602 struct dummy *dum;
603
604 if (!_ep)
605 return -EINVAL;
606 ep = usb_ep_to_dummy_ep (_ep);
607 dum = ep_to_dummy (ep);
608 if (!dum->driver)
609 return -ESHUTDOWN;
610 if (!value)
611 ep->halted = 0;
612 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
613 !list_empty (&ep->queue))
614 return -EAGAIN;
615 else
616 ep->halted = 1;
617 /* FIXME clear emulated data toggle too */
618 return 0;
619 }
620
621 static const struct usb_ep_ops dummy_ep_ops = {
622 .enable = dummy_enable,
623 .disable = dummy_disable,
624
625 .alloc_request = dummy_alloc_request,
626 .free_request = dummy_free_request,
627
628 .queue = dummy_queue,
629 .dequeue = dummy_dequeue,
630
631 .set_halt = dummy_set_halt,
632 };
633
634 /*-------------------------------------------------------------------------*/
635
636 /* there are both host and device side versions of this call ... */
637 static int dummy_g_get_frame (struct usb_gadget *_gadget)
638 {
639 struct timeval tv;
640
641 do_gettimeofday (&tv);
642 return tv.tv_usec / 1000;
643 }
644
645 static int dummy_wakeup (struct usb_gadget *_gadget)
646 {
647 struct dummy *dum;
648
649 dum = gadget_to_dummy (_gadget);
650 if (!(dum->devstatus & ( (1 << USB_DEVICE_B_HNP_ENABLE)
651 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
652 return -EINVAL;
653 if ((dum->port_status & USB_PORT_STAT_CONNECTION) == 0)
654 return -ENOLINK;
655 if ((dum->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
656 dum->rh_state != DUMMY_RH_SUSPENDED)
657 return -EIO;
658
659 /* FIXME: What if the root hub is suspended but the port isn't? */
660
661 /* hub notices our request, issues downstream resume, etc */
662 dum->resuming = 1;
663 dum->re_timeout = jiffies + msecs_to_jiffies(20);
664 mod_timer (&dummy_to_hcd (dum)->rh_timer, dum->re_timeout);
665 return 0;
666 }
667
668 static int dummy_set_selfpowered (struct usb_gadget *_gadget, int value)
669 {
670 struct dummy *dum;
671
672 dum = gadget_to_dummy (_gadget);
673 if (value)
674 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
675 else
676 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
677 return 0;
678 }
679
680 static int dummy_pullup (struct usb_gadget *_gadget, int value)
681 {
682 struct dummy *dum;
683 unsigned long flags;
684
685 dum = gadget_to_dummy (_gadget);
686 spin_lock_irqsave (&dum->lock, flags);
687 dum->pullup = (value != 0);
688 set_link_state (dum);
689 spin_unlock_irqrestore (&dum->lock, flags);
690
691 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
692 return 0;
693 }
694
695 static const struct usb_gadget_ops dummy_ops = {
696 .get_frame = dummy_g_get_frame,
697 .wakeup = dummy_wakeup,
698 .set_selfpowered = dummy_set_selfpowered,
699 .pullup = dummy_pullup,
700 };
701
702 /*-------------------------------------------------------------------------*/
703
704 /* "function" sysfs attribute */
705 static ssize_t
706 show_function (struct device *dev, struct device_attribute *attr, char *buf)
707 {
708 struct dummy *dum = gadget_dev_to_dummy (dev);
709
710 if (!dum->driver || !dum->driver->function)
711 return 0;
712 return scnprintf (buf, PAGE_SIZE, "%s\n", dum->driver->function);
713 }
714 static DEVICE_ATTR (function, S_IRUGO, show_function, NULL);
715
716 /*-------------------------------------------------------------------------*/
717
718 /*
719 * Driver registration/unregistration.
720 *
721 * This is basically hardware-specific; there's usually only one real USB
722 * device (not host) controller since that's how USB devices are intended
723 * to work. So most implementations of these api calls will rely on the
724 * fact that only one driver will ever bind to the hardware. But curious
725 * hardware can be built with discrete components, so the gadget API doesn't
726 * require that assumption.
727 *
728 * For this emulator, it might be convenient to create a usb slave device
729 * for each driver that registers: just add to a big root hub.
730 */
731
732 int
733 usb_gadget_register_driver (struct usb_gadget_driver *driver)
734 {
735 struct dummy *dum = the_controller;
736 int retval, i;
737
738 if (!dum)
739 return -EINVAL;
740 if (dum->driver)
741 return -EBUSY;
742 if (!driver->bind || !driver->setup
743 || driver->speed == USB_SPEED_UNKNOWN)
744 return -EINVAL;
745
746 /*
747 * SLAVE side init ... the layer above hardware, which
748 * can't enumerate without help from the driver we're binding.
749 */
750
751 dum->devstatus = 0;
752
753 INIT_LIST_HEAD (&dum->gadget.ep_list);
754 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
755 struct dummy_ep *ep = &dum->ep [i];
756
757 if (!ep_name [i])
758 break;
759 ep->ep.name = ep_name [i];
760 ep->ep.ops = &dummy_ep_ops;
761 list_add_tail (&ep->ep.ep_list, &dum->gadget.ep_list);
762 ep->halted = ep->already_seen = ep->setup_stage = 0;
763 ep->ep.maxpacket = ~0;
764 ep->last_io = jiffies;
765 ep->gadget = &dum->gadget;
766 ep->desc = NULL;
767 INIT_LIST_HEAD (&ep->queue);
768 }
769
770 dum->gadget.ep0 = &dum->ep [0].ep;
771 dum->ep [0].ep.maxpacket = 64;
772 list_del_init (&dum->ep [0].ep.ep_list);
773 INIT_LIST_HEAD(&dum->fifo_req.queue);
774
775 driver->driver.bus = NULL;
776 dum->driver = driver;
777 dum->gadget.dev.driver = &driver->driver;
778 dev_dbg (udc_dev(dum), "binding gadget driver '%s'\n",
779 driver->driver.name);
780 retval = driver->bind(&dum->gadget);
781 if (retval) {
782 dum->driver = NULL;
783 dum->gadget.dev.driver = NULL;
784 return retval;
785 }
786
787 /* khubd will enumerate this in a while */
788 spin_lock_irq (&dum->lock);
789 dum->pullup = 1;
790 set_link_state (dum);
791 spin_unlock_irq (&dum->lock);
792
793 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
794 return 0;
795 }
796 EXPORT_SYMBOL (usb_gadget_register_driver);
797
798 int
799 usb_gadget_unregister_driver (struct usb_gadget_driver *driver)
800 {
801 struct dummy *dum = the_controller;
802 unsigned long flags;
803
804 if (!dum)
805 return -ENODEV;
806 if (!driver || driver != dum->driver || !driver->unbind)
807 return -EINVAL;
808
809 dev_dbg (udc_dev(dum), "unregister gadget driver '%s'\n",
810 driver->driver.name);
811
812 spin_lock_irqsave (&dum->lock, flags);
813 dum->pullup = 0;
814 set_link_state (dum);
815 spin_unlock_irqrestore (&dum->lock, flags);
816
817 driver->unbind (&dum->gadget);
818 dum->gadget.dev.driver = NULL;
819 dum->driver = NULL;
820
821 spin_lock_irqsave (&dum->lock, flags);
822 dum->pullup = 0;
823 set_link_state (dum);
824 spin_unlock_irqrestore (&dum->lock, flags);
825
826 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
827 return 0;
828 }
829 EXPORT_SYMBOL (usb_gadget_unregister_driver);
830
831 #undef is_enabled
832
833 /* just declare this in any driver that really need it */
834 extern int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode);
835
836 int net2280_set_fifo_mode (struct usb_gadget *gadget, int mode)
837 {
838 return -ENOSYS;
839 }
840 EXPORT_SYMBOL (net2280_set_fifo_mode);
841
842
843 /* The gadget structure is stored inside the hcd structure and will be
844 * released along with it. */
845 static void
846 dummy_gadget_release (struct device *dev)
847 {
848 struct dummy *dum = gadget_dev_to_dummy (dev);
849
850 usb_put_hcd (dummy_to_hcd (dum));
851 }
852
853 static int dummy_udc_probe (struct platform_device *pdev)
854 {
855 struct dummy *dum = the_controller;
856 int rc;
857
858 dum->gadget.name = gadget_name;
859 dum->gadget.ops = &dummy_ops;
860 dum->gadget.is_dualspeed = 1;
861
862 /* maybe claim OTG support, though we won't complete HNP */
863 dum->gadget.is_otg = (dummy_to_hcd(dum)->self.otg_port != 0);
864
865 strcpy (dum->gadget.dev.bus_id, "gadget");
866 dum->gadget.dev.parent = &pdev->dev;
867 dum->gadget.dev.release = dummy_gadget_release;
868 rc = device_register (&dum->gadget.dev);
869 if (rc < 0)
870 return rc;
871
872 usb_get_hcd (dummy_to_hcd (dum));
873
874 platform_set_drvdata (pdev, dum);
875 rc = device_create_file (&dum->gadget.dev, &dev_attr_function);
876 if (rc < 0)
877 device_unregister (&dum->gadget.dev);
878 return rc;
879 }
880
881 static int dummy_udc_remove (struct platform_device *pdev)
882 {
883 struct dummy *dum = platform_get_drvdata (pdev);
884
885 platform_set_drvdata (pdev, NULL);
886 device_remove_file (&dum->gadget.dev, &dev_attr_function);
887 device_unregister (&dum->gadget.dev);
888 return 0;
889 }
890
891 static int dummy_udc_suspend (struct platform_device *pdev, pm_message_t state)
892 {
893 struct dummy *dum = platform_get_drvdata(pdev);
894
895 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
896 spin_lock_irq (&dum->lock);
897 dum->udc_suspended = 1;
898 set_link_state (dum);
899 spin_unlock_irq (&dum->lock);
900
901 pdev->dev.power.power_state = state;
902 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
903 return 0;
904 }
905
906 static int dummy_udc_resume (struct platform_device *pdev)
907 {
908 struct dummy *dum = platform_get_drvdata(pdev);
909
910 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
911 spin_lock_irq (&dum->lock);
912 dum->udc_suspended = 0;
913 set_link_state (dum);
914 spin_unlock_irq (&dum->lock);
915
916 pdev->dev.power.power_state = PMSG_ON;
917 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
918 return 0;
919 }
920
921 static struct platform_driver dummy_udc_driver = {
922 .probe = dummy_udc_probe,
923 .remove = dummy_udc_remove,
924 .suspend = dummy_udc_suspend,
925 .resume = dummy_udc_resume,
926 .driver = {
927 .name = (char *) gadget_name,
928 .owner = THIS_MODULE,
929 },
930 };
931
932 /*-------------------------------------------------------------------------*/
933
934 /* MASTER/HOST SIDE DRIVER
935 *
936 * this uses the hcd framework to hook up to host side drivers.
937 * its root hub will only have one device, otherwise it acts like
938 * a normal host controller.
939 *
940 * when urbs are queued, they're just stuck on a list that we
941 * scan in a timer callback. that callback connects writes from
942 * the host with reads from the device, and so on, based on the
943 * usb 2.0 rules.
944 */
945
946 static int dummy_urb_enqueue (
947 struct usb_hcd *hcd,
948 struct urb *urb,
949 gfp_t mem_flags
950 ) {
951 struct dummy *dum;
952 struct urbp *urbp;
953 unsigned long flags;
954 int rc;
955
956 if (!urb->transfer_buffer && urb->transfer_buffer_length)
957 return -EINVAL;
958
959 urbp = kmalloc (sizeof *urbp, mem_flags);
960 if (!urbp)
961 return -ENOMEM;
962 urbp->urb = urb;
963
964 dum = hcd_to_dummy (hcd);
965 spin_lock_irqsave (&dum->lock, flags);
966 rc = usb_hcd_link_urb_to_ep(hcd, urb);
967 if (rc) {
968 kfree(urbp);
969 goto done;
970 }
971
972 if (!dum->udev) {
973 dum->udev = urb->dev;
974 usb_get_dev (dum->udev);
975 } else if (unlikely (dum->udev != urb->dev))
976 dev_err (dummy_dev(dum), "usb_device address has changed!\n");
977
978 list_add_tail (&urbp->urbp_list, &dum->urbp_list);
979 urb->hcpriv = urbp;
980 if (usb_pipetype (urb->pipe) == PIPE_CONTROL)
981 urb->error_count = 1; /* mark as a new urb */
982
983 /* kick the scheduler, it'll do the rest */
984 if (!timer_pending (&dum->timer))
985 mod_timer (&dum->timer, jiffies + 1);
986
987 done:
988 spin_unlock_irqrestore(&dum->lock, flags);
989 return rc;
990 }
991
992 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
993 {
994 struct dummy *dum;
995 unsigned long flags;
996 int rc;
997
998 /* giveback happens automatically in timer callback,
999 * so make sure the callback happens */
1000 dum = hcd_to_dummy (hcd);
1001 spin_lock_irqsave (&dum->lock, flags);
1002
1003 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1004 if (!rc && dum->rh_state != DUMMY_RH_RUNNING &&
1005 !list_empty(&dum->urbp_list))
1006 mod_timer (&dum->timer, jiffies);
1007
1008 spin_unlock_irqrestore (&dum->lock, flags);
1009 return rc;
1010 }
1011
1012 /* transfer up to a frame's worth; caller must own lock */
1013 static int
1014 transfer(struct dummy *dum, struct urb *urb, struct dummy_ep *ep, int limit,
1015 int *status)
1016 {
1017 struct dummy_request *req;
1018
1019 top:
1020 /* if there's no request queued, the device is NAKing; return */
1021 list_for_each_entry (req, &ep->queue, queue) {
1022 unsigned host_len, dev_len, len;
1023 int is_short, to_host;
1024 int rescan = 0;
1025
1026 /* 1..N packets of ep->ep.maxpacket each ... the last one
1027 * may be short (including zero length).
1028 *
1029 * writer can send a zlp explicitly (length 0) or implicitly
1030 * (length mod maxpacket zero, and 'zero' flag); they always
1031 * terminate reads.
1032 */
1033 host_len = urb->transfer_buffer_length - urb->actual_length;
1034 dev_len = req->req.length - req->req.actual;
1035 len = min (host_len, dev_len);
1036
1037 /* FIXME update emulated data toggle too */
1038
1039 to_host = usb_pipein (urb->pipe);
1040 if (unlikely (len == 0))
1041 is_short = 1;
1042 else {
1043 char *ubuf, *rbuf;
1044
1045 /* not enough bandwidth left? */
1046 if (limit < ep->ep.maxpacket && limit < len)
1047 break;
1048 len = min (len, (unsigned) limit);
1049 if (len == 0)
1050 break;
1051
1052 /* use an extra pass for the final short packet */
1053 if (len > ep->ep.maxpacket) {
1054 rescan = 1;
1055 len -= (len % ep->ep.maxpacket);
1056 }
1057 is_short = (len % ep->ep.maxpacket) != 0;
1058
1059 /* else transfer packet(s) */
1060 ubuf = urb->transfer_buffer + urb->actual_length;
1061 rbuf = req->req.buf + req->req.actual;
1062 if (to_host)
1063 memcpy (ubuf, rbuf, len);
1064 else
1065 memcpy (rbuf, ubuf, len);
1066 ep->last_io = jiffies;
1067
1068 limit -= len;
1069 urb->actual_length += len;
1070 req->req.actual += len;
1071 }
1072
1073 /* short packets terminate, maybe with overflow/underflow.
1074 * it's only really an error to write too much.
1075 *
1076 * partially filling a buffer optionally blocks queue advances
1077 * (so completion handlers can clean up the queue) but we don't
1078 * need to emulate such data-in-flight.
1079 */
1080 if (is_short) {
1081 if (host_len == dev_len) {
1082 req->req.status = 0;
1083 *status = 0;
1084 } else if (to_host) {
1085 req->req.status = 0;
1086 if (dev_len > host_len)
1087 *status = -EOVERFLOW;
1088 else
1089 *status = 0;
1090 } else if (!to_host) {
1091 *status = 0;
1092 if (host_len > dev_len)
1093 req->req.status = -EOVERFLOW;
1094 else
1095 req->req.status = 0;
1096 }
1097
1098 /* many requests terminate without a short packet */
1099 } else {
1100 if (req->req.length == req->req.actual
1101 && !req->req.zero)
1102 req->req.status = 0;
1103 if (urb->transfer_buffer_length == urb->actual_length
1104 && !(urb->transfer_flags
1105 & URB_ZERO_PACKET))
1106 *status = 0;
1107 }
1108
1109 /* device side completion --> continuable */
1110 if (req->req.status != -EINPROGRESS) {
1111 list_del_init (&req->queue);
1112
1113 spin_unlock (&dum->lock);
1114 req->req.complete (&ep->ep, &req->req);
1115 spin_lock (&dum->lock);
1116
1117 /* requests might have been unlinked... */
1118 rescan = 1;
1119 }
1120
1121 /* host side completion --> terminate */
1122 if (*status != -EINPROGRESS)
1123 break;
1124
1125 /* rescan to continue with any other queued i/o */
1126 if (rescan)
1127 goto top;
1128 }
1129 return limit;
1130 }
1131
1132 static int periodic_bytes (struct dummy *dum, struct dummy_ep *ep)
1133 {
1134 int limit = ep->ep.maxpacket;
1135
1136 if (dum->gadget.speed == USB_SPEED_HIGH) {
1137 int tmp;
1138
1139 /* high bandwidth mode */
1140 tmp = le16_to_cpu(ep->desc->wMaxPacketSize);
1141 tmp = (tmp >> 11) & 0x03;
1142 tmp *= 8 /* applies to entire frame */;
1143 limit += limit * tmp;
1144 }
1145 return limit;
1146 }
1147
1148 #define is_active(dum) ((dum->port_status & \
1149 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1150 USB_PORT_STAT_SUSPEND)) \
1151 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1152
1153 static struct dummy_ep *find_endpoint (struct dummy *dum, u8 address)
1154 {
1155 int i;
1156
1157 if (!is_active (dum))
1158 return NULL;
1159 if ((address & ~USB_DIR_IN) == 0)
1160 return &dum->ep [0];
1161 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1162 struct dummy_ep *ep = &dum->ep [i];
1163
1164 if (!ep->desc)
1165 continue;
1166 if (ep->desc->bEndpointAddress == address)
1167 return ep;
1168 }
1169 return NULL;
1170 }
1171
1172 #undef is_active
1173
1174 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1175 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1176 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1177 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1178 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1179 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1180
1181 /* drive both sides of the transfers; looks like irq handlers to
1182 * both drivers except the callbacks aren't in_irq().
1183 */
1184 static void dummy_timer (unsigned long _dum)
1185 {
1186 struct dummy *dum = (struct dummy *) _dum;
1187 struct urbp *urbp, *tmp;
1188 unsigned long flags;
1189 int limit, total;
1190 int i;
1191
1192 /* simplistic model for one frame's bandwidth */
1193 switch (dum->gadget.speed) {
1194 case USB_SPEED_LOW:
1195 total = 8/*bytes*/ * 12/*packets*/;
1196 break;
1197 case USB_SPEED_FULL:
1198 total = 64/*bytes*/ * 19/*packets*/;
1199 break;
1200 case USB_SPEED_HIGH:
1201 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1202 break;
1203 default:
1204 dev_err (dummy_dev(dum), "bogus device speed\n");
1205 return;
1206 }
1207
1208 /* FIXME if HZ != 1000 this will probably misbehave ... */
1209
1210 /* look at each urb queued by the host side driver */
1211 spin_lock_irqsave (&dum->lock, flags);
1212
1213 if (!dum->udev) {
1214 dev_err (dummy_dev(dum),
1215 "timer fired with no URBs pending?\n");
1216 spin_unlock_irqrestore (&dum->lock, flags);
1217 return;
1218 }
1219
1220 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1221 if (!ep_name [i])
1222 break;
1223 dum->ep [i].already_seen = 0;
1224 }
1225
1226 restart:
1227 list_for_each_entry_safe (urbp, tmp, &dum->urbp_list, urbp_list) {
1228 struct urb *urb;
1229 struct dummy_request *req;
1230 u8 address;
1231 struct dummy_ep *ep = NULL;
1232 int type;
1233 int status = -EINPROGRESS;
1234
1235 urb = urbp->urb;
1236 if (urb->unlinked)
1237 goto return_urb;
1238 else if (dum->rh_state != DUMMY_RH_RUNNING)
1239 continue;
1240 type = usb_pipetype (urb->pipe);
1241
1242 /* used up this frame's non-periodic bandwidth?
1243 * FIXME there's infinite bandwidth for control and
1244 * periodic transfers ... unrealistic.
1245 */
1246 if (total <= 0 && type == PIPE_BULK)
1247 continue;
1248
1249 /* find the gadget's ep for this request (if configured) */
1250 address = usb_pipeendpoint (urb->pipe);
1251 if (usb_pipein (urb->pipe))
1252 address |= USB_DIR_IN;
1253 ep = find_endpoint(dum, address);
1254 if (!ep) {
1255 /* set_configuration() disagreement */
1256 dev_dbg (dummy_dev(dum),
1257 "no ep configured for urb %p\n",
1258 urb);
1259 status = -EPROTO;
1260 goto return_urb;
1261 }
1262
1263 if (ep->already_seen)
1264 continue;
1265 ep->already_seen = 1;
1266 if (ep == &dum->ep [0] && urb->error_count) {
1267 ep->setup_stage = 1; /* a new urb */
1268 urb->error_count = 0;
1269 }
1270 if (ep->halted && !ep->setup_stage) {
1271 /* NOTE: must not be iso! */
1272 dev_dbg (dummy_dev(dum), "ep %s halted, urb %p\n",
1273 ep->ep.name, urb);
1274 status = -EPIPE;
1275 goto return_urb;
1276 }
1277 /* FIXME make sure both ends agree on maxpacket */
1278
1279 /* handle control requests */
1280 if (ep == &dum->ep [0] && ep->setup_stage) {
1281 struct usb_ctrlrequest setup;
1282 int value = 1;
1283 struct dummy_ep *ep2;
1284 unsigned w_index;
1285 unsigned w_value;
1286
1287 setup = *(struct usb_ctrlrequest*) urb->setup_packet;
1288 w_index = le16_to_cpu(setup.wIndex);
1289 w_value = le16_to_cpu(setup.wValue);
1290 if (le16_to_cpu(setup.wLength) !=
1291 urb->transfer_buffer_length) {
1292 status = -EOVERFLOW;
1293 goto return_urb;
1294 }
1295
1296 /* paranoia, in case of stale queued data */
1297 list_for_each_entry (req, &ep->queue, queue) {
1298 list_del_init (&req->queue);
1299 req->req.status = -EOVERFLOW;
1300 dev_dbg (udc_dev(dum), "stale req = %p\n",
1301 req);
1302
1303 spin_unlock (&dum->lock);
1304 req->req.complete (&ep->ep, &req->req);
1305 spin_lock (&dum->lock);
1306 ep->already_seen = 0;
1307 goto restart;
1308 }
1309
1310 /* gadget driver never sees set_address or operations
1311 * on standard feature flags. some hardware doesn't
1312 * even expose them.
1313 */
1314 ep->last_io = jiffies;
1315 ep->setup_stage = 0;
1316 ep->halted = 0;
1317 switch (setup.bRequest) {
1318 case USB_REQ_SET_ADDRESS:
1319 if (setup.bRequestType != Dev_Request)
1320 break;
1321 dum->address = w_value;
1322 status = 0;
1323 dev_dbg (udc_dev(dum), "set_address = %d\n",
1324 w_value);
1325 value = 0;
1326 break;
1327 case USB_REQ_SET_FEATURE:
1328 if (setup.bRequestType == Dev_Request) {
1329 value = 0;
1330 switch (w_value) {
1331 case USB_DEVICE_REMOTE_WAKEUP:
1332 break;
1333 case USB_DEVICE_B_HNP_ENABLE:
1334 dum->gadget.b_hnp_enable = 1;
1335 break;
1336 case USB_DEVICE_A_HNP_SUPPORT:
1337 dum->gadget.a_hnp_support = 1;
1338 break;
1339 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1340 dum->gadget.a_alt_hnp_support
1341 = 1;
1342 break;
1343 default:
1344 value = -EOPNOTSUPP;
1345 }
1346 if (value == 0) {
1347 dum->devstatus |=
1348 (1 << w_value);
1349 status = 0;
1350 }
1351
1352 } else if (setup.bRequestType == Ep_Request) {
1353 // endpoint halt
1354 ep2 = find_endpoint (dum, w_index);
1355 if (!ep2) {
1356 value = -EOPNOTSUPP;
1357 break;
1358 }
1359 ep2->halted = 1;
1360 value = 0;
1361 status = 0;
1362 }
1363 break;
1364 case USB_REQ_CLEAR_FEATURE:
1365 if (setup.bRequestType == Dev_Request) {
1366 switch (w_value) {
1367 case USB_DEVICE_REMOTE_WAKEUP:
1368 dum->devstatus &= ~(1 <<
1369 USB_DEVICE_REMOTE_WAKEUP);
1370 value = 0;
1371 status = 0;
1372 break;
1373 default:
1374 value = -EOPNOTSUPP;
1375 break;
1376 }
1377 } else if (setup.bRequestType == Ep_Request) {
1378 // endpoint halt
1379 ep2 = find_endpoint (dum, w_index);
1380 if (!ep2) {
1381 value = -EOPNOTSUPP;
1382 break;
1383 }
1384 ep2->halted = 0;
1385 value = 0;
1386 status = 0;
1387 }
1388 break;
1389 case USB_REQ_GET_STATUS:
1390 if (setup.bRequestType == Dev_InRequest
1391 || setup.bRequestType
1392 == Intf_InRequest
1393 || setup.bRequestType
1394 == Ep_InRequest
1395 ) {
1396 char *buf;
1397
1398 // device: remote wakeup, selfpowered
1399 // interface: nothing
1400 // endpoint: halt
1401 buf = (char *)urb->transfer_buffer;
1402 if (urb->transfer_buffer_length > 0) {
1403 if (setup.bRequestType ==
1404 Ep_InRequest) {
1405 ep2 = find_endpoint (dum, w_index);
1406 if (!ep2) {
1407 value = -EOPNOTSUPP;
1408 break;
1409 }
1410 buf [0] = ep2->halted;
1411 } else if (setup.bRequestType ==
1412 Dev_InRequest) {
1413 buf [0] = (u8)
1414 dum->devstatus;
1415 } else
1416 buf [0] = 0;
1417 }
1418 if (urb->transfer_buffer_length > 1)
1419 buf [1] = 0;
1420 urb->actual_length = min (2,
1421 urb->transfer_buffer_length);
1422 value = 0;
1423 status = 0;
1424 }
1425 break;
1426 }
1427
1428 /* gadget driver handles all other requests. block
1429 * until setup() returns; no reentrancy issues etc.
1430 */
1431 if (value > 0) {
1432 spin_unlock (&dum->lock);
1433 value = dum->driver->setup (&dum->gadget,
1434 &setup);
1435 spin_lock (&dum->lock);
1436
1437 if (value >= 0) {
1438 /* no delays (max 64KB data stage) */
1439 limit = 64*1024;
1440 goto treat_control_like_bulk;
1441 }
1442 /* error, see below */
1443 }
1444
1445 if (value < 0) {
1446 if (value != -EOPNOTSUPP)
1447 dev_dbg (udc_dev(dum),
1448 "setup --> %d\n",
1449 value);
1450 status = -EPIPE;
1451 urb->actual_length = 0;
1452 }
1453
1454 goto return_urb;
1455 }
1456
1457 /* non-control requests */
1458 limit = total;
1459 switch (usb_pipetype (urb->pipe)) {
1460 case PIPE_ISOCHRONOUS:
1461 /* FIXME is it urb->interval since the last xfer?
1462 * use urb->iso_frame_desc[i].
1463 * complete whether or not ep has requests queued.
1464 * report random errors, to debug drivers.
1465 */
1466 limit = max (limit, periodic_bytes (dum, ep));
1467 status = -ENOSYS;
1468 break;
1469
1470 case PIPE_INTERRUPT:
1471 /* FIXME is it urb->interval since the last xfer?
1472 * this almost certainly polls too fast.
1473 */
1474 limit = max (limit, periodic_bytes (dum, ep));
1475 /* FALLTHROUGH */
1476
1477 // case PIPE_BULK: case PIPE_CONTROL:
1478 default:
1479 treat_control_like_bulk:
1480 ep->last_io = jiffies;
1481 total = transfer(dum, urb, ep, limit, &status);
1482 break;
1483 }
1484
1485 /* incomplete transfer? */
1486 if (status == -EINPROGRESS)
1487 continue;
1488
1489 return_urb:
1490 list_del (&urbp->urbp_list);
1491 kfree (urbp);
1492 if (ep)
1493 ep->already_seen = ep->setup_stage = 0;
1494
1495 usb_hcd_unlink_urb_from_ep(dummy_to_hcd(dum), urb);
1496 spin_unlock (&dum->lock);
1497 usb_hcd_giveback_urb(dummy_to_hcd(dum), urb, status);
1498 spin_lock (&dum->lock);
1499
1500 goto restart;
1501 }
1502
1503 if (list_empty (&dum->urbp_list)) {
1504 usb_put_dev (dum->udev);
1505 dum->udev = NULL;
1506 } else if (dum->rh_state == DUMMY_RH_RUNNING) {
1507 /* want a 1 msec delay here */
1508 mod_timer (&dum->timer, jiffies + msecs_to_jiffies(1));
1509 }
1510
1511 spin_unlock_irqrestore (&dum->lock, flags);
1512 }
1513
1514 /*-------------------------------------------------------------------------*/
1515
1516 #define PORT_C_MASK \
1517 ((USB_PORT_STAT_C_CONNECTION \
1518 | USB_PORT_STAT_C_ENABLE \
1519 | USB_PORT_STAT_C_SUSPEND \
1520 | USB_PORT_STAT_C_OVERCURRENT \
1521 | USB_PORT_STAT_C_RESET) << 16)
1522
1523 static int dummy_hub_status (struct usb_hcd *hcd, char *buf)
1524 {
1525 struct dummy *dum;
1526 unsigned long flags;
1527 int retval = 0;
1528
1529 dum = hcd_to_dummy (hcd);
1530
1531 spin_lock_irqsave (&dum->lock, flags);
1532 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
1533 goto done;
1534
1535 if (dum->resuming && time_after_eq (jiffies, dum->re_timeout)) {
1536 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1537 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1538 set_link_state (dum);
1539 }
1540
1541 if ((dum->port_status & PORT_C_MASK) != 0) {
1542 *buf = (1 << 1);
1543 dev_dbg (dummy_dev(dum), "port status 0x%08x has changes\n",
1544 dum->port_status);
1545 retval = 1;
1546 if (dum->rh_state == DUMMY_RH_SUSPENDED)
1547 usb_hcd_resume_root_hub (hcd);
1548 }
1549 done:
1550 spin_unlock_irqrestore (&dum->lock, flags);
1551 return retval;
1552 }
1553
1554 static inline void
1555 hub_descriptor (struct usb_hub_descriptor *desc)
1556 {
1557 memset (desc, 0, sizeof *desc);
1558 desc->bDescriptorType = 0x29;
1559 desc->bDescLength = 9;
1560 desc->wHubCharacteristics = (__force __u16)
1561 (__constant_cpu_to_le16 (0x0001));
1562 desc->bNbrPorts = 1;
1563 desc->bitmap [0] = 0xff;
1564 desc->bitmap [1] = 0xff;
1565 }
1566
1567 static int dummy_hub_control (
1568 struct usb_hcd *hcd,
1569 u16 typeReq,
1570 u16 wValue,
1571 u16 wIndex,
1572 char *buf,
1573 u16 wLength
1574 ) {
1575 struct dummy *dum;
1576 int retval = 0;
1577 unsigned long flags;
1578
1579 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags))
1580 return -ETIMEDOUT;
1581
1582 dum = hcd_to_dummy (hcd);
1583 spin_lock_irqsave (&dum->lock, flags);
1584 switch (typeReq) {
1585 case ClearHubFeature:
1586 break;
1587 case ClearPortFeature:
1588 switch (wValue) {
1589 case USB_PORT_FEAT_SUSPEND:
1590 if (dum->port_status & USB_PORT_STAT_SUSPEND) {
1591 /* 20msec resume signaling */
1592 dum->resuming = 1;
1593 dum->re_timeout = jiffies +
1594 msecs_to_jiffies(20);
1595 }
1596 break;
1597 case USB_PORT_FEAT_POWER:
1598 if (dum->port_status & USB_PORT_STAT_POWER)
1599 dev_dbg (dummy_dev(dum), "power-off\n");
1600 /* FALLS THROUGH */
1601 default:
1602 dum->port_status &= ~(1 << wValue);
1603 set_link_state (dum);
1604 }
1605 break;
1606 case GetHubDescriptor:
1607 hub_descriptor ((struct usb_hub_descriptor *) buf);
1608 break;
1609 case GetHubStatus:
1610 *(__le32 *) buf = __constant_cpu_to_le32 (0);
1611 break;
1612 case GetPortStatus:
1613 if (wIndex != 1)
1614 retval = -EPIPE;
1615
1616 /* whoever resets or resumes must GetPortStatus to
1617 * complete it!!
1618 */
1619 if (dum->resuming &&
1620 time_after_eq (jiffies, dum->re_timeout)) {
1621 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1622 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1623 }
1624 if ((dum->port_status & USB_PORT_STAT_RESET) != 0 &&
1625 time_after_eq (jiffies, dum->re_timeout)) {
1626 dum->port_status |= (USB_PORT_STAT_C_RESET << 16);
1627 dum->port_status &= ~USB_PORT_STAT_RESET;
1628 if (dum->pullup) {
1629 dum->port_status |= USB_PORT_STAT_ENABLE;
1630 /* give it the best speed we agree on */
1631 dum->gadget.speed = dum->driver->speed;
1632 dum->gadget.ep0->maxpacket = 64;
1633 switch (dum->gadget.speed) {
1634 case USB_SPEED_HIGH:
1635 dum->port_status |=
1636 USB_PORT_STAT_HIGH_SPEED;
1637 break;
1638 case USB_SPEED_LOW:
1639 dum->gadget.ep0->maxpacket = 8;
1640 dum->port_status |=
1641 USB_PORT_STAT_LOW_SPEED;
1642 break;
1643 default:
1644 dum->gadget.speed = USB_SPEED_FULL;
1645 break;
1646 }
1647 }
1648 }
1649 set_link_state (dum);
1650 ((__le16 *) buf)[0] = cpu_to_le16 (dum->port_status);
1651 ((__le16 *) buf)[1] = cpu_to_le16 (dum->port_status >> 16);
1652 break;
1653 case SetHubFeature:
1654 retval = -EPIPE;
1655 break;
1656 case SetPortFeature:
1657 switch (wValue) {
1658 case USB_PORT_FEAT_SUSPEND:
1659 if (dum->active) {
1660 dum->port_status |= USB_PORT_STAT_SUSPEND;
1661
1662 /* HNP would happen here; for now we
1663 * assume b_bus_req is always true.
1664 */
1665 set_link_state (dum);
1666 if (((1 << USB_DEVICE_B_HNP_ENABLE)
1667 & dum->devstatus) != 0)
1668 dev_dbg (dummy_dev(dum),
1669 "no HNP yet!\n");
1670 }
1671 break;
1672 case USB_PORT_FEAT_POWER:
1673 dum->port_status |= USB_PORT_STAT_POWER;
1674 set_link_state (dum);
1675 break;
1676 case USB_PORT_FEAT_RESET:
1677 /* if it's already enabled, disable */
1678 dum->port_status &= ~(USB_PORT_STAT_ENABLE
1679 | USB_PORT_STAT_LOW_SPEED
1680 | USB_PORT_STAT_HIGH_SPEED);
1681 dum->devstatus = 0;
1682 /* 50msec reset signaling */
1683 dum->re_timeout = jiffies + msecs_to_jiffies(50);
1684 /* FALLS THROUGH */
1685 default:
1686 if ((dum->port_status & USB_PORT_STAT_POWER) != 0) {
1687 dum->port_status |= (1 << wValue);
1688 set_link_state (dum);
1689 }
1690 }
1691 break;
1692
1693 default:
1694 dev_dbg (dummy_dev(dum),
1695 "hub control req%04x v%04x i%04x l%d\n",
1696 typeReq, wValue, wIndex, wLength);
1697
1698 /* "protocol stall" on error */
1699 retval = -EPIPE;
1700 }
1701 spin_unlock_irqrestore (&dum->lock, flags);
1702
1703 if ((dum->port_status & PORT_C_MASK) != 0)
1704 usb_hcd_poll_rh_status (hcd);
1705 return retval;
1706 }
1707
1708 static int dummy_bus_suspend (struct usb_hcd *hcd)
1709 {
1710 struct dummy *dum = hcd_to_dummy (hcd);
1711
1712 dev_dbg (&hcd->self.root_hub->dev, "%s\n", __FUNCTION__);
1713
1714 spin_lock_irq (&dum->lock);
1715 dum->rh_state = DUMMY_RH_SUSPENDED;
1716 set_link_state (dum);
1717 hcd->state = HC_STATE_SUSPENDED;
1718 spin_unlock_irq (&dum->lock);
1719 return 0;
1720 }
1721
1722 static int dummy_bus_resume (struct usb_hcd *hcd)
1723 {
1724 struct dummy *dum = hcd_to_dummy (hcd);
1725 int rc = 0;
1726
1727 dev_dbg (&hcd->self.root_hub->dev, "%s\n", __FUNCTION__);
1728
1729 spin_lock_irq (&dum->lock);
1730 if (!test_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags)) {
1731 rc = -ESHUTDOWN;
1732 } else {
1733 dum->rh_state = DUMMY_RH_RUNNING;
1734 set_link_state (dum);
1735 if (!list_empty(&dum->urbp_list))
1736 mod_timer (&dum->timer, jiffies);
1737 hcd->state = HC_STATE_RUNNING;
1738 }
1739 spin_unlock_irq (&dum->lock);
1740 return rc;
1741 }
1742
1743 /*-------------------------------------------------------------------------*/
1744
1745 static inline ssize_t
1746 show_urb (char *buf, size_t size, struct urb *urb)
1747 {
1748 int ep = usb_pipeendpoint (urb->pipe);
1749
1750 return snprintf (buf, size,
1751 "urb/%p %s ep%d%s%s len %d/%d\n",
1752 urb,
1753 ({ char *s;
1754 switch (urb->dev->speed) {
1755 case USB_SPEED_LOW: s = "ls"; break;
1756 case USB_SPEED_FULL: s = "fs"; break;
1757 case USB_SPEED_HIGH: s = "hs"; break;
1758 default: s = "?"; break;
1759 }; s; }),
1760 ep, ep ? (usb_pipein (urb->pipe) ? "in" : "out") : "",
1761 ({ char *s; \
1762 switch (usb_pipetype (urb->pipe)) { \
1763 case PIPE_CONTROL: s = ""; break; \
1764 case PIPE_BULK: s = "-bulk"; break; \
1765 case PIPE_INTERRUPT: s = "-int"; break; \
1766 default: s = "-iso"; break; \
1767 }; s;}),
1768 urb->actual_length, urb->transfer_buffer_length);
1769 }
1770
1771 static ssize_t
1772 show_urbs (struct device *dev, struct device_attribute *attr, char *buf)
1773 {
1774 struct usb_hcd *hcd = dev_get_drvdata (dev);
1775 struct dummy *dum = hcd_to_dummy (hcd);
1776 struct urbp *urbp;
1777 size_t size = 0;
1778 unsigned long flags;
1779
1780 spin_lock_irqsave (&dum->lock, flags);
1781 list_for_each_entry (urbp, &dum->urbp_list, urbp_list) {
1782 size_t temp;
1783
1784 temp = show_urb (buf, PAGE_SIZE - size, urbp->urb);
1785 buf += temp;
1786 size += temp;
1787 }
1788 spin_unlock_irqrestore (&dum->lock, flags);
1789
1790 return size;
1791 }
1792 static DEVICE_ATTR (urbs, S_IRUGO, show_urbs, NULL);
1793
1794 static int dummy_start (struct usb_hcd *hcd)
1795 {
1796 struct dummy *dum;
1797
1798 dum = hcd_to_dummy (hcd);
1799
1800 /*
1801 * MASTER side init ... we emulate a root hub that'll only ever
1802 * talk to one device (the slave side). Also appears in sysfs,
1803 * just like more familiar pci-based HCDs.
1804 */
1805 spin_lock_init (&dum->lock);
1806 init_timer (&dum->timer);
1807 dum->timer.function = dummy_timer;
1808 dum->timer.data = (unsigned long) dum;
1809 dum->rh_state = DUMMY_RH_RUNNING;
1810
1811 INIT_LIST_HEAD (&dum->urbp_list);
1812
1813 /* only show a low-power port: just 8mA */
1814 hcd->power_budget = 8;
1815 hcd->state = HC_STATE_RUNNING;
1816 hcd->uses_new_polling = 1;
1817
1818 #ifdef CONFIG_USB_OTG
1819 hcd->self.otg_port = 1;
1820 #endif
1821
1822 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
1823 return device_create_file (dummy_dev(dum), &dev_attr_urbs);
1824 }
1825
1826 static void dummy_stop (struct usb_hcd *hcd)
1827 {
1828 struct dummy *dum;
1829
1830 dum = hcd_to_dummy (hcd);
1831
1832 device_remove_file (dummy_dev(dum), &dev_attr_urbs);
1833 usb_gadget_unregister_driver (dum->driver);
1834 dev_info (dummy_dev(dum), "stopped\n");
1835 }
1836
1837 /*-------------------------------------------------------------------------*/
1838
1839 static int dummy_h_get_frame (struct usb_hcd *hcd)
1840 {
1841 return dummy_g_get_frame (NULL);
1842 }
1843
1844 static const struct hc_driver dummy_hcd = {
1845 .description = (char *) driver_name,
1846 .product_desc = "Dummy host controller",
1847 .hcd_priv_size = sizeof(struct dummy),
1848
1849 .flags = HCD_USB2,
1850
1851 .start = dummy_start,
1852 .stop = dummy_stop,
1853
1854 .urb_enqueue = dummy_urb_enqueue,
1855 .urb_dequeue = dummy_urb_dequeue,
1856
1857 .get_frame_number = dummy_h_get_frame,
1858
1859 .hub_status_data = dummy_hub_status,
1860 .hub_control = dummy_hub_control,
1861 .bus_suspend = dummy_bus_suspend,
1862 .bus_resume = dummy_bus_resume,
1863 };
1864
1865 static int dummy_hcd_probe(struct platform_device *pdev)
1866 {
1867 struct usb_hcd *hcd;
1868 int retval;
1869
1870 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
1871
1872 hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, pdev->dev.bus_id);
1873 if (!hcd)
1874 return -ENOMEM;
1875 the_controller = hcd_to_dummy (hcd);
1876
1877 retval = usb_add_hcd(hcd, 0, 0);
1878 if (retval != 0) {
1879 usb_put_hcd (hcd);
1880 the_controller = NULL;
1881 }
1882 return retval;
1883 }
1884
1885 static int dummy_hcd_remove (struct platform_device *pdev)
1886 {
1887 struct usb_hcd *hcd;
1888
1889 hcd = platform_get_drvdata (pdev);
1890 usb_remove_hcd (hcd);
1891 usb_put_hcd (hcd);
1892 the_controller = NULL;
1893 return 0;
1894 }
1895
1896 static int dummy_hcd_suspend (struct platform_device *pdev, pm_message_t state)
1897 {
1898 struct usb_hcd *hcd;
1899 struct dummy *dum;
1900 int rc = 0;
1901
1902 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
1903
1904 hcd = platform_get_drvdata (pdev);
1905 dum = hcd_to_dummy (hcd);
1906 if (dum->rh_state == DUMMY_RH_RUNNING) {
1907 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
1908 rc = -EBUSY;
1909 } else
1910 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1911 return rc;
1912 }
1913
1914 static int dummy_hcd_resume (struct platform_device *pdev)
1915 {
1916 struct usb_hcd *hcd;
1917
1918 dev_dbg (&pdev->dev, "%s\n", __FUNCTION__);
1919
1920 hcd = platform_get_drvdata (pdev);
1921 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
1922 usb_hcd_poll_rh_status (hcd);
1923 return 0;
1924 }
1925
1926 static struct platform_driver dummy_hcd_driver = {
1927 .probe = dummy_hcd_probe,
1928 .remove = dummy_hcd_remove,
1929 .suspend = dummy_hcd_suspend,
1930 .resume = dummy_hcd_resume,
1931 .driver = {
1932 .name = (char *) driver_name,
1933 .owner = THIS_MODULE,
1934 },
1935 };
1936
1937 /*-------------------------------------------------------------------------*/
1938
1939 /* These don't need to do anything because the pdev structures are
1940 * statically allocated. */
1941 static void
1942 dummy_udc_release (struct device *dev) {}
1943
1944 static void
1945 dummy_hcd_release (struct device *dev) {}
1946
1947 static struct platform_device the_udc_pdev = {
1948 .name = (char *) gadget_name,
1949 .id = -1,
1950 .dev = {
1951 .release = dummy_udc_release,
1952 },
1953 };
1954
1955 static struct platform_device the_hcd_pdev = {
1956 .name = (char *) driver_name,
1957 .id = -1,
1958 .dev = {
1959 .release = dummy_hcd_release,
1960 },
1961 };
1962
1963 static int __init init (void)
1964 {
1965 int retval;
1966
1967 if (usb_disabled ())
1968 return -ENODEV;
1969
1970 retval = platform_driver_register (&dummy_hcd_driver);
1971 if (retval < 0)
1972 return retval;
1973
1974 retval = platform_driver_register (&dummy_udc_driver);
1975 if (retval < 0)
1976 goto err_register_udc_driver;
1977
1978 retval = platform_device_register (&the_hcd_pdev);
1979 if (retval < 0)
1980 goto err_register_hcd;
1981
1982 retval = platform_device_register (&the_udc_pdev);
1983 if (retval < 0)
1984 goto err_register_udc;
1985 return retval;
1986
1987 err_register_udc:
1988 platform_device_unregister (&the_hcd_pdev);
1989 err_register_hcd:
1990 platform_driver_unregister (&dummy_udc_driver);
1991 err_register_udc_driver:
1992 platform_driver_unregister (&dummy_hcd_driver);
1993 return retval;
1994 }
1995 module_init (init);
1996
1997 static void __exit cleanup (void)
1998 {
1999 platform_device_unregister (&the_udc_pdev);
2000 platform_device_unregister (&the_hcd_pdev);
2001 platform_driver_unregister (&dummy_udc_driver);
2002 platform_driver_unregister (&dummy_hcd_driver);
2003 }
2004 module_exit (cleanup);
Support for the Chinese Samsung S3C2440 based development boards