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