projects / deliverable / linux.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Create platform_device.h to contain all the platform device details.
[deliverable/linux.git] / drivers / usb / gadget / dummy_hcd.c
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 #include <linux/platform_device.h>
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, gfp_t 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 gfp_t 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 gfp_t 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 {
940 struct dummy *dum = dev_get_drvdata(dev);
941
942 dev_dbg (dev, "%s\n", __FUNCTION__);
943 spin_lock_irq (&dum->lock);
944 dum->udc_suspended = 1;
945 set_link_state (dum);
946 spin_unlock_irq (&dum->lock);
947
948 dev->power.power_state = state;
949 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
950 return 0;
951 }
952
953 static int dummy_udc_resume (struct device *dev)
954 {
955 struct dummy *dum = dev_get_drvdata(dev);
956
957 dev_dbg (dev, "%s\n", __FUNCTION__);
958 spin_lock_irq (&dum->lock);
959 dum->udc_suspended = 0;
960 set_link_state (dum);
961 spin_unlock_irq (&dum->lock);
962
963 dev->power.power_state = PMSG_ON;
964 usb_hcd_poll_rh_status (dummy_to_hcd (dum));
965 return 0;
966 }
967
968 static struct device_driver dummy_udc_driver = {
969 .name = (char *) gadget_name,
970 .owner = THIS_MODULE,
971 .bus = &platform_bus_type,
972 .probe = dummy_udc_probe,
973 .remove = dummy_udc_remove,
974 .suspend = dummy_udc_suspend,
975 .resume = dummy_udc_resume,
976 };
977
978 /*-------------------------------------------------------------------------*/
979
980 /* MASTER/HOST SIDE DRIVER
981 *
982 * this uses the hcd framework to hook up to host side drivers.
983 * its root hub will only have one device, otherwise it acts like
984 * a normal host controller.
985 *
986 * when urbs are queued, they're just stuck on a list that we
987 * scan in a timer callback. that callback connects writes from
988 * the host with reads from the device, and so on, based on the
989 * usb 2.0 rules.
990 */
991
992 static int dummy_urb_enqueue (
993 struct usb_hcd *hcd,
994 struct usb_host_endpoint *ep,
995 struct urb *urb,
996 gfp_t mem_flags
997 ) {
998 struct dummy *dum;
999 struct urbp *urbp;
1000 unsigned long flags;
1001
1002 if (!urb->transfer_buffer && urb->transfer_buffer_length)
1003 return -EINVAL;
1004
1005 urbp = kmalloc (sizeof *urbp, mem_flags);
1006 if (!urbp)
1007 return -ENOMEM;
1008 urbp->urb = urb;
1009
1010 dum = hcd_to_dummy (hcd);
1011 spin_lock_irqsave (&dum->lock, flags);
1012
1013 if (!dum->udev) {
1014 dum->udev = urb->dev;
1015 usb_get_dev (dum->udev);
1016 } else if (unlikely (dum->udev != urb->dev))
1017 dev_err (dummy_dev(dum), "usb_device address has changed!\n");
1018
1019 list_add_tail (&urbp->urbp_list, &dum->urbp_list);
1020 urb->hcpriv = urbp;
1021 if (usb_pipetype (urb->pipe) == PIPE_CONTROL)
1022 urb->error_count = 1; /* mark as a new urb */
1023
1024 /* kick the scheduler, it'll do the rest */
1025 if (!timer_pending (&dum->timer))
1026 mod_timer (&dum->timer, jiffies + 1);
1027
1028 spin_unlock_irqrestore (&dum->lock, flags);
1029 return 0;
1030 }
1031
1032 static int dummy_urb_dequeue (struct usb_hcd *hcd, struct urb *urb)
1033 {
1034 struct dummy *dum;
1035 unsigned long flags;
1036
1037 /* giveback happens automatically in timer callback,
1038 * so make sure the callback happens */
1039 dum = hcd_to_dummy (hcd);
1040 spin_lock_irqsave (&dum->lock, flags);
1041 if (dum->rh_state != DUMMY_RH_RUNNING && !list_empty(&dum->urbp_list))
1042 mod_timer (&dum->timer, jiffies);
1043 spin_unlock_irqrestore (&dum->lock, flags);
1044 return 0;
1045 }
1046
1047 static void maybe_set_status (struct urb *urb, int status)
1048 {
1049 spin_lock (&urb->lock);
1050 if (urb->status == -EINPROGRESS)
1051 urb->status = status;
1052 spin_unlock (&urb->lock);
1053 }
1054
1055 /* transfer up to a frame's worth; caller must own lock */
1056 static int
1057 transfer (struct dummy *dum, struct urb *urb, struct dummy_ep *ep, int limit)
1058 {
1059 struct dummy_request *req;
1060
1061 top:
1062 /* if there's no request queued, the device is NAKing; return */
1063 list_for_each_entry (req, &ep->queue, queue) {
1064 unsigned host_len, dev_len, len;
1065 int is_short, to_host;
1066 int rescan = 0;
1067
1068 /* 1..N packets of ep->ep.maxpacket each ... the last one
1069 * may be short (including zero length).
1070 *
1071 * writer can send a zlp explicitly (length 0) or implicitly
1072 * (length mod maxpacket zero, and 'zero' flag); they always
1073 * terminate reads.
1074 */
1075 host_len = urb->transfer_buffer_length - urb->actual_length;
1076 dev_len = req->req.length - req->req.actual;
1077 len = min (host_len, dev_len);
1078
1079 /* FIXME update emulated data toggle too */
1080
1081 to_host = usb_pipein (urb->pipe);
1082 if (unlikely (len == 0))
1083 is_short = 1;
1084 else {
1085 char *ubuf, *rbuf;
1086
1087 /* not enough bandwidth left? */
1088 if (limit < ep->ep.maxpacket && limit < len)
1089 break;
1090 len = min (len, (unsigned) limit);
1091 if (len == 0)
1092 break;
1093
1094 /* use an extra pass for the final short packet */
1095 if (len > ep->ep.maxpacket) {
1096 rescan = 1;
1097 len -= (len % ep->ep.maxpacket);
1098 }
1099 is_short = (len % ep->ep.maxpacket) != 0;
1100
1101 /* else transfer packet(s) */
1102 ubuf = urb->transfer_buffer + urb->actual_length;
1103 rbuf = req->req.buf + req->req.actual;
1104 if (to_host)
1105 memcpy (ubuf, rbuf, len);
1106 else
1107 memcpy (rbuf, ubuf, len);
1108 ep->last_io = jiffies;
1109
1110 limit -= len;
1111 urb->actual_length += len;
1112 req->req.actual += len;
1113 }
1114
1115 /* short packets terminate, maybe with overflow/underflow.
1116 * it's only really an error to write too much.
1117 *
1118 * partially filling a buffer optionally blocks queue advances
1119 * (so completion handlers can clean up the queue) but we don't
1120 * need to emulate such data-in-flight. so we only show part
1121 * of the URB_SHORT_NOT_OK effect: completion status.
1122 */
1123 if (is_short) {
1124 if (host_len == dev_len) {
1125 req->req.status = 0;
1126 maybe_set_status (urb, 0);
1127 } else if (to_host) {
1128 req->req.status = 0;
1129 if (dev_len > host_len)
1130 maybe_set_status (urb, -EOVERFLOW);
1131 else
1132 maybe_set_status (urb,
1133 (urb->transfer_flags
1134 & URB_SHORT_NOT_OK)
1135 ? -EREMOTEIO : 0);
1136 } else if (!to_host) {
1137 maybe_set_status (urb, 0);
1138 if (host_len > dev_len)
1139 req->req.status = -EOVERFLOW;
1140 else
1141 req->req.status = 0;
1142 }
1143
1144 /* many requests terminate without a short packet */
1145 } else {
1146 if (req->req.length == req->req.actual
1147 && !req->req.zero)
1148 req->req.status = 0;
1149 if (urb->transfer_buffer_length == urb->actual_length
1150 && !(urb->transfer_flags
1151 & URB_ZERO_PACKET)) {
1152 maybe_set_status (urb, 0);
1153 }
1154 }
1155
1156 /* device side completion --> continuable */
1157 if (req->req.status != -EINPROGRESS) {
1158 list_del_init (&req->queue);
1159
1160 spin_unlock (&dum->lock);
1161 req->req.complete (&ep->ep, &req->req);
1162 spin_lock (&dum->lock);
1163
1164 /* requests might have been unlinked... */
1165 rescan = 1;
1166 }
1167
1168 /* host side completion --> terminate */
1169 if (urb->status != -EINPROGRESS)
1170 break;
1171
1172 /* rescan to continue with any other queued i/o */
1173 if (rescan)
1174 goto top;
1175 }
1176 return limit;
1177 }
1178
1179 static int periodic_bytes (struct dummy *dum, struct dummy_ep *ep)
1180 {
1181 int limit = ep->ep.maxpacket;
1182
1183 if (dum->gadget.speed == USB_SPEED_HIGH) {
1184 int tmp;
1185
1186 /* high bandwidth mode */
1187 tmp = le16_to_cpu(ep->desc->wMaxPacketSize);
1188 tmp = (tmp >> 11) & 0x03;
1189 tmp *= 8 /* applies to entire frame */;
1190 limit += limit * tmp;
1191 }
1192 return limit;
1193 }
1194
1195 #define is_active(dum) ((dum->port_status & \
1196 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1197 USB_PORT_STAT_SUSPEND)) \
1198 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1199
1200 static struct dummy_ep *find_endpoint (struct dummy *dum, u8 address)
1201 {
1202 int i;
1203
1204 if (!is_active (dum))
1205 return NULL;
1206 if ((address & ~USB_DIR_IN) == 0)
1207 return &dum->ep [0];
1208 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1209 struct dummy_ep *ep = &dum->ep [i];
1210
1211 if (!ep->desc)
1212 continue;
1213 if (ep->desc->bEndpointAddress == address)
1214 return ep;
1215 }
1216 return NULL;
1217 }
1218
1219 #undef is_active
1220
1221 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1222 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1223 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1224 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1225 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1226 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1227
1228 /* drive both sides of the transfers; looks like irq handlers to
1229 * both drivers except the callbacks aren't in_irq().
1230 */
1231 static void dummy_timer (unsigned long _dum)
1232 {
1233 struct dummy *dum = (struct dummy *) _dum;
1234 struct urbp *urbp, *tmp;
1235 unsigned long flags;
1236 int limit, total;
1237 int i;
1238
1239 /* simplistic model for one frame's bandwidth */
1240 switch (dum->gadget.speed) {
1241 case USB_SPEED_LOW:
1242 total = 8/*bytes*/ * 12/*packets*/;
1243 break;
1244 case USB_SPEED_FULL:
1245 total = 64/*bytes*/ * 19/*packets*/;
1246 break;
1247 case USB_SPEED_HIGH:
1248 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1249 break;
1250 default:
1251 dev_err (dummy_dev(dum), "bogus device speed\n");
1252 return;
1253 }
1254
1255 /* FIXME if HZ != 1000 this will probably misbehave ... */
1256
1257 /* look at each urb queued by the host side driver */
1258 spin_lock_irqsave (&dum->lock, flags);
1259
1260 if (!dum->udev) {
1261 dev_err (dummy_dev(dum),
1262 "timer fired with no URBs pending?\n");
1263 spin_unlock_irqrestore (&dum->lock, flags);
1264 return;
1265 }
1266
1267 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1268 if (!ep_name [i])
1269 break;
1270 dum->ep [i].already_seen = 0;
1271 }
1272
1273 restart:
1274 list_for_each_entry_safe (urbp, tmp, &dum->urbp_list, urbp_list) {
1275 struct urb *urb;
1276 struct dummy_request *req;
1277 u8 address;
1278 struct dummy_ep *ep = NULL;
1279 int type;
1280
1281 urb = urbp->urb;
1282 if (urb->status != -EINPROGRESS) {
1283 /* likely it was just unlinked */
1284 goto return_urb;
1285 } else if (dum->rh_state != DUMMY_RH_RUNNING)
1286 continue;
1287 type = usb_pipetype (urb->pipe);
1288
1289 /* used up this frame's non-periodic bandwidth?
1290 * FIXME there's infinite bandwidth for control and
1291 * periodic transfers ... unrealistic.
1292 */
1293 if (total <= 0 && type == PIPE_BULK)
1294 continue;
1295
1296 /* find the gadget's ep for this request (if configured) */
1297 address = usb_pipeendpoint (urb->pipe);
1298 if (usb_pipein (urb->pipe))
1299 address |= USB_DIR_IN;
1300 ep = find_endpoint(dum, address);
1301 if (!ep) {
1302 /* set_configuration() disagreement */
1303 dev_dbg (dummy_dev(dum),
1304 "no ep configured for urb %p\n",
1305 urb);
1306 maybe_set_status (urb, -EPROTO);
1307 goto return_urb;
1308 }
1309
1310 if (ep->already_seen)
1311 continue;
1312 ep->already_seen = 1;
1313 if (ep == &dum->ep [0] && urb->error_count) {
1314 ep->setup_stage = 1; /* a new urb */
1315 urb->error_count = 0;
1316 }
1317 if (ep->halted && !ep->setup_stage) {
1318 /* NOTE: must not be iso! */
1319 dev_dbg (dummy_dev(dum), "ep %s halted, urb %p\n",
1320 ep->ep.name, urb);
1321 maybe_set_status (urb, -EPIPE);
1322 goto return_urb;
1323 }
1324 /* FIXME make sure both ends agree on maxpacket */
1325
1326 /* handle control requests */
1327 if (ep == &dum->ep [0] && ep->setup_stage) {
1328 struct usb_ctrlrequest setup;
1329 int value = 1;
1330 struct dummy_ep *ep2;
1331 unsigned w_index;
1332 unsigned w_value;
1333
1334 setup = *(struct usb_ctrlrequest*) urb->setup_packet;
1335 w_index = le16_to_cpu(setup.wIndex);
1336 w_value = le16_to_cpu(setup.wValue);
1337 if (le16_to_cpu(setup.wLength) !=
1338 urb->transfer_buffer_length) {
1339 maybe_set_status (urb, -EOVERFLOW);
1340 goto return_urb;
1341 }
1342
1343 /* paranoia, in case of stale queued data */
1344 list_for_each_entry (req, &ep->queue, queue) {
1345 list_del_init (&req->queue);
1346 req->req.status = -EOVERFLOW;
1347 dev_dbg (udc_dev(dum), "stale req = %p\n",
1348 req);
1349
1350 spin_unlock (&dum->lock);
1351 req->req.complete (&ep->ep, &req->req);
1352 spin_lock (&dum->lock);
1353 ep->already_seen = 0;
1354 goto restart;
1355 }
1356
1357 /* gadget driver never sees set_address or operations
1358 * on standard feature flags. some hardware doesn't
1359 * even expose them.
1360 */
1361 ep->last_io = jiffies;
1362 ep->setup_stage = 0;
1363 ep->halted = 0;
1364 switch (setup.bRequest) {
1365 case USB_REQ_SET_ADDRESS:
1366 if (setup.bRequestType != Dev_Request)
1367 break;
1368 dum->address = w_value;
1369 maybe_set_status (urb, 0);
1370 dev_dbg (udc_dev(dum), "set_address = %d\n",
1371 w_value);
1372 value = 0;
1373 break;
1374 case USB_REQ_SET_FEATURE:
1375 if (setup.bRequestType == Dev_Request) {
1376 value = 0;
1377 switch (w_value) {
1378 case USB_DEVICE_REMOTE_WAKEUP:
1379 break;
1380 case USB_DEVICE_B_HNP_ENABLE:
1381 dum->gadget.b_hnp_enable = 1;
1382 break;
1383 case USB_DEVICE_A_HNP_SUPPORT:
1384 dum->gadget.a_hnp_support = 1;
1385 break;
1386 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1387 dum->gadget.a_alt_hnp_support
1388 = 1;
1389 break;
1390 default:
1391 value = -EOPNOTSUPP;
1392 }
1393 if (value == 0) {
1394 dum->devstatus |=
1395 (1 << w_value);
1396 maybe_set_status (urb, 0);
1397 }
1398
1399 } else if (setup.bRequestType == Ep_Request) {
1400 // endpoint halt
1401 ep2 = find_endpoint (dum, w_index);
1402 if (!ep2) {
1403 value = -EOPNOTSUPP;
1404 break;
1405 }
1406 ep2->halted = 1;
1407 value = 0;
1408 maybe_set_status (urb, 0);
1409 }
1410 break;
1411 case USB_REQ_CLEAR_FEATURE:
1412 if (setup.bRequestType == Dev_Request) {
1413 switch (w_value) {
1414 case USB_DEVICE_REMOTE_WAKEUP:
1415 dum->devstatus &= ~(1 <<
1416 USB_DEVICE_REMOTE_WAKEUP);
1417 value = 0;
1418 maybe_set_status (urb, 0);
1419 break;
1420 default:
1421 value = -EOPNOTSUPP;
1422 break;
1423 }
1424 } else if (setup.bRequestType == Ep_Request) {
1425 // endpoint halt
1426 ep2 = find_endpoint (dum, w_index);
1427 if (!ep2) {
1428 value = -EOPNOTSUPP;
1429 break;
1430 }
1431 ep2->halted = 0;
1432 value = 0;
1433 maybe_set_status (urb, 0);
1434 }
1435 break;
1436 case USB_REQ_GET_STATUS:
1437 if (setup.bRequestType == Dev_InRequest
1438 || setup.bRequestType
1439 == Intf_InRequest
1440 || setup.bRequestType
1441 == Ep_InRequest
1442 ) {
1443 char *buf;
1444
1445 // device: remote wakeup, selfpowered
1446 // interface: nothing
1447 // endpoint: halt
1448 buf = (char *)urb->transfer_buffer;
1449 if (urb->transfer_buffer_length > 0) {
1450 if (setup.bRequestType ==
1451 Ep_InRequest) {
1452 ep2 = find_endpoint (dum, w_index);
1453 if (!ep2) {
1454 value = -EOPNOTSUPP;
1455 break;
1456 }
1457 buf [0] = ep2->halted;
1458 } else if (setup.bRequestType ==
1459 Dev_InRequest) {
1460 buf [0] = (u8)
1461 dum->devstatus;
1462 } else
1463 buf [0] = 0;
1464 }
1465 if (urb->transfer_buffer_length > 1)
1466 buf [1] = 0;
1467 urb->actual_length = min (2,
1468 urb->transfer_buffer_length);
1469 value = 0;
1470 maybe_set_status (urb, 0);
1471 }
1472 break;
1473 }
1474
1475 /* gadget driver handles all other requests. block
1476 * until setup() returns; no reentrancy issues etc.
1477 */
1478 if (value > 0) {
1479 spin_unlock (&dum->lock);
1480 value = dum->driver->setup (&dum->gadget,
1481 &setup);
1482 spin_lock (&dum->lock);
1483
1484 if (value >= 0) {
1485 /* no delays (max 64KB data stage) */
1486 limit = 64*1024;
1487 goto treat_control_like_bulk;
1488 }
1489 /* error, see below */
1490 }
1491
1492 if (value < 0) {
1493 if (value != -EOPNOTSUPP)
1494 dev_dbg (udc_dev(dum),
1495 "setup --> %d\n",
1496 value);
1497 maybe_set_status (urb, -EPIPE);
1498 urb->actual_length = 0;
1499 }
1500
1501 goto return_urb;
1502 }
1503
1504 /* non-control requests */
1505 limit = total;
1506 switch (usb_pipetype (urb->pipe)) {
1507 case PIPE_ISOCHRONOUS:
1508 /* FIXME is it urb->interval since the last xfer?
1509 * use urb->iso_frame_desc[i].
1510 * complete whether or not ep has requests queued.
1511 * report random errors, to debug drivers.
1512 */
1513 limit = max (limit, periodic_bytes (dum, ep));
1514 maybe_set_status (urb, -ENOSYS);
1515 break;
1516
1517 case PIPE_INTERRUPT:
1518 /* FIXME is it urb->interval since the last xfer?
1519 * this almost certainly polls too fast.
1520 */
1521 limit = max (limit, periodic_bytes (dum, ep));
1522 /* FALLTHROUGH */
1523
1524 // case PIPE_BULK: case PIPE_CONTROL:
1525 default:
1526 treat_control_like_bulk:
1527 ep->last_io = jiffies;
1528 total = transfer (dum, urb, ep, limit);
1529 break;
1530 }
1531
1532 /* incomplete transfer? */
1533 if (urb->status == -EINPROGRESS)
1534 continue;
1535
1536 return_urb:
1537 urb->hcpriv = NULL;
1538 list_del (&urbp->urbp_list);
1539 kfree (urbp);
1540 if (ep)
1541 ep->already_seen = ep->setup_stage = 0;
1542
1543 spin_unlock (&dum->lock);
1544 usb_hcd_giveback_urb (dummy_to_hcd(dum), urb, NULL);
1545 spin_lock (&dum->lock);
1546
1547 goto restart;
1548 }
1549
1550 if (list_empty (&dum->urbp_list)) {
1551 usb_put_dev (dum->udev);
1552 dum->udev = NULL;
1553 } else if (dum->rh_state == DUMMY_RH_RUNNING) {
1554 /* want a 1 msec delay here */
1555 mod_timer (&dum->timer, jiffies + msecs_to_jiffies(1));
1556 }
1557
1558 spin_unlock_irqrestore (&dum->lock, flags);
1559 }
1560
1561 /*-------------------------------------------------------------------------*/
1562
1563 #define PORT_C_MASK \
1564 ((USB_PORT_STAT_C_CONNECTION \
1565 | USB_PORT_STAT_C_ENABLE \
1566 | USB_PORT_STAT_C_SUSPEND \
1567 | USB_PORT_STAT_C_OVERCURRENT \
1568 | USB_PORT_STAT_C_RESET) << 16)
1569
1570 static int dummy_hub_status (struct usb_hcd *hcd, char *buf)
1571 {
1572 struct dummy *dum;
1573 unsigned long flags;
1574 int retval = 0;
1575
1576 dum = hcd_to_dummy (hcd);
1577
1578 spin_lock_irqsave (&dum->lock, flags);
1579 if (hcd->state != HC_STATE_RUNNING)
1580 goto done;
1581
1582 if (dum->resuming && time_after_eq (jiffies, dum->re_timeout)) {
1583 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1584 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1585 set_link_state (dum);
1586 }
1587
1588 if ((dum->port_status & PORT_C_MASK) != 0) {
1589 *buf = (1 << 1);
1590 dev_dbg (dummy_dev(dum), "port status 0x%08x has changes\n",
1591 dum->port_status);
1592 retval = 1;
1593 if (dum->rh_state == DUMMY_RH_SUSPENDED)
1594 usb_hcd_resume_root_hub (hcd);
1595 }
1596 done:
1597 spin_unlock_irqrestore (&dum->lock, flags);
1598 return retval;
1599 }
1600
1601 static inline void
1602 hub_descriptor (struct usb_hub_descriptor *desc)
1603 {
1604 memset (desc, 0, sizeof *desc);
1605 desc->bDescriptorType = 0x29;
1606 desc->bDescLength = 9;
1607 desc->wHubCharacteristics = (__force __u16)
1608 (__constant_cpu_to_le16 (0x0001));
1609 desc->bNbrPorts = 1;
1610 desc->bitmap [0] = 0xff;
1611 desc->bitmap [1] = 0xff;
1612 }
1613
1614 static int dummy_hub_control (
1615 struct usb_hcd *hcd,
1616 u16 typeReq,
1617 u16 wValue,
1618 u16 wIndex,
1619 char *buf,
1620 u16 wLength
1621 ) {
1622 struct dummy *dum;
1623 int retval = 0;
1624 unsigned long flags;
1625
1626 if (hcd->state != HC_STATE_RUNNING)
1627 return -ETIMEDOUT;
1628
1629 dum = hcd_to_dummy (hcd);
1630 spin_lock_irqsave (&dum->lock, flags);
1631 switch (typeReq) {
1632 case ClearHubFeature:
1633 break;
1634 case ClearPortFeature:
1635 switch (wValue) {
1636 case USB_PORT_FEAT_SUSPEND:
1637 if (dum->port_status & USB_PORT_STAT_SUSPEND) {
1638 /* 20msec resume signaling */
1639 dum->resuming = 1;
1640 dum->re_timeout = jiffies +
1641 msecs_to_jiffies(20);
1642 }
1643 break;
1644 case USB_PORT_FEAT_POWER:
1645 if (dum->port_status & USB_PORT_STAT_POWER)
1646 dev_dbg (dummy_dev(dum), "power-off\n");
1647 /* FALLS THROUGH */
1648 default:
1649 dum->port_status &= ~(1 << wValue);
1650 set_link_state (dum);
1651 }
1652 break;
1653 case GetHubDescriptor:
1654 hub_descriptor ((struct usb_hub_descriptor *) buf);
1655 break;
1656 case GetHubStatus:
1657 *(__le32 *) buf = __constant_cpu_to_le32 (0);
1658 break;
1659 case GetPortStatus:
1660 if (wIndex != 1)
1661 retval = -EPIPE;
1662
1663 /* whoever resets or resumes must GetPortStatus to
1664 * complete it!!
1665 */
1666 if (dum->resuming &&
1667 time_after_eq (jiffies, dum->re_timeout)) {
1668 dum->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
1669 dum->port_status &= ~USB_PORT_STAT_SUSPEND;
1670 }
1671 if ((dum->port_status & USB_PORT_STAT_RESET) != 0 &&
1672 time_after_eq (jiffies, dum->re_timeout)) {
1673 dum->port_status |= (USB_PORT_STAT_C_RESET << 16);
1674 dum->port_status &= ~USB_PORT_STAT_RESET;
1675 if (dum->pullup) {
1676 dum->port_status |= USB_PORT_STAT_ENABLE;
1677 /* give it the best speed we agree on */
1678 dum->gadget.speed = dum->driver->speed;
1679 dum->gadget.ep0->maxpacket = 64;
1680 switch (dum->gadget.speed) {
1681 case USB_SPEED_HIGH:
1682 dum->port_status |=
1683 USB_PORT_STAT_HIGH_SPEED;
1684 break;
1685 case USB_SPEED_LOW:
1686 dum->gadget.ep0->maxpacket = 8;
1687 dum->port_status |=
1688 USB_PORT_STAT_LOW_SPEED;
1689 break;
1690 default:
1691 dum->gadget.speed = USB_SPEED_FULL;
1692 break;
1693 }
1694 }
1695 }
1696 set_link_state (dum);
1697 ((__le16 *) buf)[0] = cpu_to_le16 (dum->port_status);
1698 ((__le16 *) buf)[1] = cpu_to_le16 (dum->port_status >> 16);
1699 break;
1700 case SetHubFeature:
1701 retval = -EPIPE;
1702 break;
1703 case SetPortFeature:
1704 switch (wValue) {
1705 case USB_PORT_FEAT_SUSPEND:
1706 if (dum->active) {
1707 dum->port_status |= USB_PORT_STAT_SUSPEND;
1708
1709 /* HNP would happen here; for now we
1710 * assume b_bus_req is always true.
1711 */
1712 set_link_state (dum);
1713 if (((1 << USB_DEVICE_B_HNP_ENABLE)
1714 & dum->devstatus) != 0)
1715 dev_dbg (dummy_dev(dum),
1716 "no HNP yet!\n");
1717 }
1718 break;
1719 case USB_PORT_FEAT_POWER:
1720 dum->port_status |= USB_PORT_STAT_POWER;
1721 set_link_state (dum);
1722 break;
1723 case USB_PORT_FEAT_RESET:
1724 /* if it's already enabled, disable */
1725 dum->port_status &= ~(USB_PORT_STAT_ENABLE
1726 | USB_PORT_STAT_LOW_SPEED
1727 | USB_PORT_STAT_HIGH_SPEED);
1728 dum->devstatus = 0;
1729 /* 50msec reset signaling */
1730 dum->re_timeout = jiffies + msecs_to_jiffies(50);
1731 /* FALLS THROUGH */
1732 default:
1733 if ((dum->port_status & USB_PORT_STAT_POWER) != 0) {
1734 dum->port_status |= (1 << wValue);
1735 set_link_state (dum);
1736 }
1737 }
1738 break;
1739
1740 default:
1741 dev_dbg (dummy_dev(dum),
1742 "hub control req%04x v%04x i%04x l%d\n",
1743 typeReq, wValue, wIndex, wLength);
1744
1745 /* "protocol stall" on error */
1746 retval = -EPIPE;
1747 }
1748 spin_unlock_irqrestore (&dum->lock, flags);
1749
1750 if ((dum->port_status & PORT_C_MASK) != 0)
1751 usb_hcd_poll_rh_status (hcd);
1752 return retval;
1753 }
1754
1755 static int dummy_bus_suspend (struct usb_hcd *hcd)
1756 {
1757 struct dummy *dum = hcd_to_dummy (hcd);
1758
1759 spin_lock_irq (&dum->lock);
1760 dum->rh_state = DUMMY_RH_SUSPENDED;
1761 set_link_state (dum);
1762 spin_unlock_irq (&dum->lock);
1763 return 0;
1764 }
1765
1766 static int dummy_bus_resume (struct usb_hcd *hcd)
1767 {
1768 struct dummy *dum = hcd_to_dummy (hcd);
1769
1770 spin_lock_irq (&dum->lock);
1771 dum->rh_state = DUMMY_RH_RUNNING;
1772 set_link_state (dum);
1773 if (!list_empty(&dum->urbp_list))
1774 mod_timer (&dum->timer, jiffies);
1775 spin_unlock_irq (&dum->lock);
1776 return 0;
1777 }
1778
1779 /*-------------------------------------------------------------------------*/
1780
1781 static inline ssize_t
1782 show_urb (char *buf, size_t size, struct urb *urb)
1783 {
1784 int ep = usb_pipeendpoint (urb->pipe);
1785
1786 return snprintf (buf, size,
1787 "urb/%p %s ep%d%s%s len %d/%d\n",
1788 urb,
1789 ({ char *s;
1790 switch (urb->dev->speed) {
1791 case USB_SPEED_LOW: s = "ls"; break;
1792 case USB_SPEED_FULL: s = "fs"; break;
1793 case USB_SPEED_HIGH: s = "hs"; break;
1794 default: s = "?"; break;
1795 }; s; }),
1796 ep, ep ? (usb_pipein (urb->pipe) ? "in" : "out") : "",
1797 ({ char *s; \
1798 switch (usb_pipetype (urb->pipe)) { \
1799 case PIPE_CONTROL: s = ""; break; \
1800 case PIPE_BULK: s = "-bulk"; break; \
1801 case PIPE_INTERRUPT: s = "-int"; break; \
1802 default: s = "-iso"; break; \
1803 }; s;}),
1804 urb->actual_length, urb->transfer_buffer_length);
1805 }
1806
1807 static ssize_t
1808 show_urbs (struct device *dev, struct device_attribute *attr, char *buf)
1809 {
1810 struct usb_hcd *hcd = dev_get_drvdata (dev);
1811 struct dummy *dum = hcd_to_dummy (hcd);
1812 struct urbp *urbp;
1813 size_t size = 0;
1814 unsigned long flags;
1815
1816 spin_lock_irqsave (&dum->lock, flags);
1817 list_for_each_entry (urbp, &dum->urbp_list, urbp_list) {
1818 size_t temp;
1819
1820 temp = show_urb (buf, PAGE_SIZE - size, urbp->urb);
1821 buf += temp;
1822 size += temp;
1823 }
1824 spin_unlock_irqrestore (&dum->lock, flags);
1825
1826 return size;
1827 }
1828 static DEVICE_ATTR (urbs, S_IRUGO, show_urbs, NULL);
1829
1830 static int dummy_start (struct usb_hcd *hcd)
1831 {
1832 struct dummy *dum;
1833
1834 dum = hcd_to_dummy (hcd);
1835
1836 /*
1837 * MASTER side init ... we emulate a root hub that'll only ever
1838 * talk to one device (the slave side). Also appears in sysfs,
1839 * just like more familiar pci-based HCDs.
1840 */
1841 spin_lock_init (&dum->lock);
1842 init_timer (&dum->timer);
1843 dum->timer.function = dummy_timer;
1844 dum->timer.data = (unsigned long) dum;
1845 dum->rh_state = DUMMY_RH_RUNNING;
1846
1847 INIT_LIST_HEAD (&dum->urbp_list);
1848
1849 /* only show a low-power port: just 8mA */
1850 hcd->power_budget = 8;
1851 hcd->state = HC_STATE_RUNNING;
1852 hcd->uses_new_polling = 1;
1853
1854 #ifdef CONFIG_USB_OTG
1855 hcd->self.otg_port = 1;
1856 #endif
1857
1858 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
1859 device_create_file (dummy_dev(dum), &dev_attr_urbs);
1860 return 0;
1861 }
1862
1863 static void dummy_stop (struct usb_hcd *hcd)
1864 {
1865 struct dummy *dum;
1866
1867 dum = hcd_to_dummy (hcd);
1868
1869 device_remove_file (dummy_dev(dum), &dev_attr_urbs);
1870 usb_gadget_unregister_driver (dum->driver);
1871 dev_info (dummy_dev(dum), "stopped\n");
1872 }
1873
1874 /*-------------------------------------------------------------------------*/
1875
1876 static int dummy_h_get_frame (struct usb_hcd *hcd)
1877 {
1878 return dummy_g_get_frame (NULL);
1879 }
1880
1881 static const struct hc_driver dummy_hcd = {
1882 .description = (char *) driver_name,
1883 .product_desc = "Dummy host controller",
1884 .hcd_priv_size = sizeof(struct dummy),
1885
1886 .flags = HCD_USB2,
1887
1888 .start = dummy_start,
1889 .stop = dummy_stop,
1890
1891 .urb_enqueue = dummy_urb_enqueue,
1892 .urb_dequeue = dummy_urb_dequeue,
1893
1894 .get_frame_number = dummy_h_get_frame,
1895
1896 .hub_status_data = dummy_hub_status,
1897 .hub_control = dummy_hub_control,
1898 .bus_suspend = dummy_bus_suspend,
1899 .bus_resume = dummy_bus_resume,
1900 };
1901
1902 static int dummy_hcd_probe (struct device *dev)
1903 {
1904 struct usb_hcd *hcd;
1905 int retval;
1906
1907 dev_info (dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
1908
1909 hcd = usb_create_hcd (&dummy_hcd, dev, dev->bus_id);
1910 if (!hcd)
1911 return -ENOMEM;
1912 the_controller = hcd_to_dummy (hcd);
1913
1914 retval = usb_add_hcd(hcd, 0, 0);
1915 if (retval != 0) {
1916 usb_put_hcd (hcd);
1917 the_controller = NULL;
1918 }
1919 return retval;
1920 }
1921
1922 static int dummy_hcd_remove (struct device *dev)
1923 {
1924 struct usb_hcd *hcd;
1925
1926 hcd = dev_get_drvdata (dev);
1927 usb_remove_hcd (hcd);
1928 usb_put_hcd (hcd);
1929 the_controller = NULL;
1930 return 0;
1931 }
1932
1933 static int dummy_hcd_suspend (struct device *dev, pm_message_t state)
1934 {
1935 struct usb_hcd *hcd;
1936
1937 dev_dbg (dev, "%s\n", __FUNCTION__);
1938 hcd = dev_get_drvdata (dev);
1939
1940 hcd->state = HC_STATE_SUSPENDED;
1941 return 0;
1942 }
1943
1944 static int dummy_hcd_resume (struct device *dev)
1945 {
1946 struct usb_hcd *hcd;
1947
1948 dev_dbg (dev, "%s\n", __FUNCTION__);
1949 hcd = dev_get_drvdata (dev);
1950 hcd->state = HC_STATE_RUNNING;
1951
1952 usb_hcd_poll_rh_status (hcd);
1953 return 0;
1954 }
1955
1956 static struct device_driver dummy_hcd_driver = {
1957 .name = (char *) driver_name,
1958 .owner = THIS_MODULE,
1959 .bus = &platform_bus_type,
1960 .probe = dummy_hcd_probe,
1961 .remove = dummy_hcd_remove,
1962 .suspend = dummy_hcd_suspend,
1963 .resume = dummy_hcd_resume,
1964 };
1965
1966 /*-------------------------------------------------------------------------*/
1967
1968 /* These don't need to do anything because the pdev structures are
1969 * statically allocated. */
1970 static void
1971 dummy_udc_release (struct device *dev) {}
1972
1973 static void
1974 dummy_hcd_release (struct device *dev) {}
1975
1976 static struct platform_device the_udc_pdev = {
1977 .name = (char *) gadget_name,
1978 .id = -1,
1979 .dev = {
1980 .release = dummy_udc_release,
1981 },
1982 };
1983
1984 static struct platform_device the_hcd_pdev = {
1985 .name = (char *) driver_name,
1986 .id = -1,
1987 .dev = {
1988 .release = dummy_hcd_release,
1989 },
1990 };
1991
1992 static int __init init (void)
1993 {
1994 int retval;
1995
1996 if (usb_disabled ())
1997 return -ENODEV;
1998
1999 retval = driver_register (&dummy_hcd_driver);
2000 if (retval < 0)
2001 return retval;
2002
2003 retval = driver_register (&dummy_udc_driver);
2004 if (retval < 0)
2005 goto err_register_udc_driver;
2006
2007 retval = platform_device_register (&the_hcd_pdev);
2008 if (retval < 0)
2009 goto err_register_hcd;
2010
2011 retval = platform_device_register (&the_udc_pdev);
2012 if (retval < 0)
2013 goto err_register_udc;
2014 return retval;
2015
2016 err_register_udc:
2017 platform_device_unregister (&the_hcd_pdev);
2018 err_register_hcd:
2019 driver_unregister (&dummy_udc_driver);
2020 err_register_udc_driver:
2021 driver_unregister (&dummy_hcd_driver);
2022 return retval;
2023 }
2024 module_init (init);
2025
2026 static void __exit cleanup (void)
2027 {
2028 platform_device_unregister (&the_udc_pdev);
2029 platform_device_unregister (&the_hcd_pdev);
2030 driver_unregister (&dummy_udc_driver);
2031 driver_unregister (&dummy_hcd_driver);
2032 }
2033 module_exit (cleanup);
Linux kernel - Deliverables
This page took 0.102933 seconds and 5 git commands to generate.