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