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