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
15
16 /*
17 * This exposes a device side "USB gadget" API, driven by requests to a
18 * Linux-USB host controller driver. USB traffic is simulated; there's
19 * no need for USB hardware. Use this with two other drivers:
20 *
21 * - Gadget driver, responding to requests (slave);
22 * - Host-side device driver, as already familiar in Linux.
23 *
24 * Having this all in one kernel can help some stages of development,
25 * bypassing some hardware (and driver) issues. UML could help too.
26 */
27
28 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/delay.h>
31 #include <linux/ioport.h>
32 #include <linux/slab.h>
33 #include <linux/errno.h>
34 #include <linux/init.h>
35 #include <linux/timer.h>
36 #include <linux/list.h>
37 #include <linux/interrupt.h>
38 #include <linux/platform_device.h>
39 #include <linux/usb.h>
40 #include <linux/usb/gadget.h>
41 #include <linux/usb/hcd.h>
42 #include <linux/scatterlist.h>
43
44 #include <asm/byteorder.h>
45 #include <linux/io.h>
46 #include <asm/irq.h>
47 #include <asm/unaligned.h>
48
49 #define DRIVER_DESC "USB Host+Gadget Emulator"
50 #define DRIVER_VERSION "02 May 2005"
51
52 #define POWER_BUDGET 500 /* in mA; use 8 for low-power port testing */
53 #define POWER_BUDGET_3 900 /* in mA */
54
55 static const char driver_name[] = "dummy_hcd";
56 static const char driver_desc[] = "USB Host+Gadget Emulator";
57
58 static const char gadget_name[] = "dummy_udc";
59
60 MODULE_DESCRIPTION(DRIVER_DESC);
61 MODULE_AUTHOR("David Brownell");
62 MODULE_LICENSE("GPL");
63
64 struct dummy_hcd_module_parameters {
65 bool is_super_speed;
66 bool is_high_speed;
67 unsigned int num;
68 };
69
70 static struct dummy_hcd_module_parameters mod_data = {
71 .is_super_speed = false,
72 .is_high_speed = true,
73 .num = 1,
74 };
75 module_param_named(is_super_speed, mod_data.is_super_speed, bool, S_IRUGO);
76 MODULE_PARM_DESC(is_super_speed, "true to simulate SuperSpeed connection");
77 module_param_named(is_high_speed, mod_data.is_high_speed, bool, S_IRUGO);
78 MODULE_PARM_DESC(is_high_speed, "true to simulate HighSpeed connection");
79 module_param_named(num, mod_data.num, uint, S_IRUGO);
80 MODULE_PARM_DESC(num, "number of emulated controllers");
81 /*-------------------------------------------------------------------------*/
82
83 /* gadget side driver data structres */
84 struct dummy_ep {
85 struct list_head queue;
86 unsigned long last_io; /* jiffies timestamp */
87 struct usb_gadget *gadget;
88 const struct usb_endpoint_descriptor *desc;
89 struct usb_ep ep;
90 unsigned halted:1;
91 unsigned wedged:1;
92 unsigned already_seen:1;
93 unsigned setup_stage:1;
94 unsigned stream_en:1;
95 };
96
97 struct dummy_request {
98 struct list_head queue; /* ep's requests */
99 struct usb_request req;
100 };
101
usb_ep_to_dummy_ep(struct usb_ep * _ep)102 static inline struct dummy_ep *usb_ep_to_dummy_ep(struct usb_ep *_ep)
103 {
104 return container_of(_ep, struct dummy_ep, ep);
105 }
106
usb_request_to_dummy_request(struct usb_request * _req)107 static inline struct dummy_request *usb_request_to_dummy_request
108 (struct usb_request *_req)
109 {
110 return container_of(_req, struct dummy_request, req);
111 }
112
113 /*-------------------------------------------------------------------------*/
114
115 /*
116 * Every device has ep0 for control requests, plus up to 30 more endpoints,
117 * in one of two types:
118 *
119 * - Configurable: direction (in/out), type (bulk, iso, etc), and endpoint
120 * number can be changed. Names like "ep-a" are used for this type.
121 *
122 * - Fixed Function: in other cases. some characteristics may be mutable;
123 * that'd be hardware-specific. Names like "ep12out-bulk" are used.
124 *
125 * Gadget drivers are responsible for not setting up conflicting endpoint
126 * configurations, illegal or unsupported packet lengths, and so on.
127 */
128
129 static const char ep0name[] = "ep0";
130
131 static const struct {
132 const char *name;
133 const struct usb_ep_caps caps;
134 } ep_info[] = {
135 #define EP_INFO(_name, _caps) \
136 { \
137 .name = _name, \
138 .caps = _caps, \
139 }
140
141 /* everyone has ep0 */
142 EP_INFO(ep0name,
143 USB_EP_CAPS(USB_EP_CAPS_TYPE_CONTROL, USB_EP_CAPS_DIR_ALL)),
144 /* act like a pxa250: fifteen fixed function endpoints */
145 EP_INFO("ep1in-bulk",
146 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
147 EP_INFO("ep2out-bulk",
148 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
149 EP_INFO("ep3in-iso",
150 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
151 EP_INFO("ep4out-iso",
152 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
153 EP_INFO("ep5in-int",
154 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
155 EP_INFO("ep6in-bulk",
156 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
157 EP_INFO("ep7out-bulk",
158 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
159 EP_INFO("ep8in-iso",
160 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
161 EP_INFO("ep9out-iso",
162 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
163 EP_INFO("ep10in-int",
164 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
165 EP_INFO("ep11in-bulk",
166 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
167 EP_INFO("ep12out-bulk",
168 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
169 EP_INFO("ep13in-iso",
170 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_IN)),
171 EP_INFO("ep14out-iso",
172 USB_EP_CAPS(USB_EP_CAPS_TYPE_ISO, USB_EP_CAPS_DIR_OUT)),
173 EP_INFO("ep15in-int",
174 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_IN)),
175 /* or like sa1100: two fixed function endpoints */
176 EP_INFO("ep1out-bulk",
177 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_OUT)),
178 EP_INFO("ep2in-bulk",
179 USB_EP_CAPS(USB_EP_CAPS_TYPE_BULK, USB_EP_CAPS_DIR_IN)),
180 /* and now some generic EPs so we have enough in multi config */
181 EP_INFO("ep3out",
182 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
183 EP_INFO("ep4in",
184 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
185 EP_INFO("ep5out",
186 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
187 EP_INFO("ep6out",
188 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
189 EP_INFO("ep7in",
190 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
191 EP_INFO("ep8out",
192 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
193 EP_INFO("ep9in",
194 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
195 EP_INFO("ep10out",
196 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
197 EP_INFO("ep11out",
198 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
199 EP_INFO("ep12in",
200 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
201 EP_INFO("ep13out",
202 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
203 EP_INFO("ep14in",
204 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_IN)),
205 EP_INFO("ep15out",
206 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_OUT)),
207
208 #undef EP_INFO
209 };
210
211 #define DUMMY_ENDPOINTS ARRAY_SIZE(ep_info)
212
213 /*-------------------------------------------------------------------------*/
214
215 #define FIFO_SIZE 64
216
217 struct urbp {
218 struct urb *urb;
219 struct list_head urbp_list;
220 struct sg_mapping_iter miter;
221 u32 miter_started;
222 };
223
224
225 enum dummy_rh_state {
226 DUMMY_RH_RESET,
227 DUMMY_RH_SUSPENDED,
228 DUMMY_RH_RUNNING
229 };
230
231 struct dummy_hcd {
232 struct dummy *dum;
233 enum dummy_rh_state rh_state;
234 struct timer_list timer;
235 u32 port_status;
236 u32 old_status;
237 unsigned long re_timeout;
238
239 struct usb_device *udev;
240 struct list_head urbp_list;
241 struct urbp *next_frame_urbp;
242
243 u32 stream_en_ep;
244 u8 num_stream[30 / 2];
245
246 unsigned active:1;
247 unsigned old_active:1;
248 unsigned resuming:1;
249 };
250
251 struct dummy {
252 spinlock_t lock;
253
254 /*
255 * SLAVE/GADGET side support
256 */
257 struct dummy_ep ep[DUMMY_ENDPOINTS];
258 int address;
259 int callback_usage;
260 struct usb_gadget gadget;
261 struct usb_gadget_driver *driver;
262 struct dummy_request fifo_req;
263 u8 fifo_buf[FIFO_SIZE];
264 u16 devstatus;
265 unsigned ints_enabled:1;
266 unsigned udc_suspended:1;
267 unsigned pullup:1;
268
269 /*
270 * MASTER/HOST side support
271 */
272 struct dummy_hcd *hs_hcd;
273 struct dummy_hcd *ss_hcd;
274 };
275
hcd_to_dummy_hcd(struct usb_hcd * hcd)276 static inline struct dummy_hcd *hcd_to_dummy_hcd(struct usb_hcd *hcd)
277 {
278 return (struct dummy_hcd *) (hcd->hcd_priv);
279 }
280
dummy_hcd_to_hcd(struct dummy_hcd * dum)281 static inline struct usb_hcd *dummy_hcd_to_hcd(struct dummy_hcd *dum)
282 {
283 return container_of((void *) dum, struct usb_hcd, hcd_priv);
284 }
285
dummy_dev(struct dummy_hcd * dum)286 static inline struct device *dummy_dev(struct dummy_hcd *dum)
287 {
288 return dummy_hcd_to_hcd(dum)->self.controller;
289 }
290
udc_dev(struct dummy * dum)291 static inline struct device *udc_dev(struct dummy *dum)
292 {
293 return dum->gadget.dev.parent;
294 }
295
ep_to_dummy(struct dummy_ep * ep)296 static inline struct dummy *ep_to_dummy(struct dummy_ep *ep)
297 {
298 return container_of(ep->gadget, struct dummy, gadget);
299 }
300
gadget_to_dummy_hcd(struct usb_gadget * gadget)301 static inline struct dummy_hcd *gadget_to_dummy_hcd(struct usb_gadget *gadget)
302 {
303 struct dummy *dum = container_of(gadget, struct dummy, gadget);
304 if (dum->gadget.speed == USB_SPEED_SUPER)
305 return dum->ss_hcd;
306 else
307 return dum->hs_hcd;
308 }
309
gadget_dev_to_dummy(struct device * dev)310 static inline struct dummy *gadget_dev_to_dummy(struct device *dev)
311 {
312 return container_of(dev, struct dummy, gadget.dev);
313 }
314
315 /*-------------------------------------------------------------------------*/
316
317 /* SLAVE/GADGET SIDE UTILITY ROUTINES */
318
319 /* called with spinlock held */
nuke(struct dummy * dum,struct dummy_ep * ep)320 static void nuke(struct dummy *dum, struct dummy_ep *ep)
321 {
322 while (!list_empty(&ep->queue)) {
323 struct dummy_request *req;
324
325 req = list_entry(ep->queue.next, struct dummy_request, queue);
326 list_del_init(&req->queue);
327 req->req.status = -ESHUTDOWN;
328
329 spin_unlock(&dum->lock);
330 usb_gadget_giveback_request(&ep->ep, &req->req);
331 spin_lock(&dum->lock);
332 }
333 }
334
335 /* caller must hold lock */
stop_activity(struct dummy * dum)336 static void stop_activity(struct dummy *dum)
337 {
338 int i;
339
340 /* prevent any more requests */
341 dum->address = 0;
342
343 /* The timer is left running so that outstanding URBs can fail */
344
345 /* nuke any pending requests first, so driver i/o is quiesced */
346 for (i = 0; i < DUMMY_ENDPOINTS; ++i)
347 nuke(dum, &dum->ep[i]);
348
349 /* driver now does any non-usb quiescing necessary */
350 }
351
352 /**
353 * set_link_state_by_speed() - Sets the current state of the link according to
354 * the hcd speed
355 * @dum_hcd: pointer to the dummy_hcd structure to update the link state for
356 *
357 * This function updates the port_status according to the link state and the
358 * speed of the hcd.
359 */
set_link_state_by_speed(struct dummy_hcd * dum_hcd)360 static void set_link_state_by_speed(struct dummy_hcd *dum_hcd)
361 {
362 struct dummy *dum = dum_hcd->dum;
363
364 if (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3) {
365 if ((dum_hcd->port_status & USB_SS_PORT_STAT_POWER) == 0) {
366 dum_hcd->port_status = 0;
367 } else if (!dum->pullup || dum->udc_suspended) {
368 /* UDC suspend must cause a disconnect */
369 dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
370 USB_PORT_STAT_ENABLE);
371 if ((dum_hcd->old_status &
372 USB_PORT_STAT_CONNECTION) != 0)
373 dum_hcd->port_status |=
374 (USB_PORT_STAT_C_CONNECTION << 16);
375 } else {
376 /* device is connected and not suspended */
377 dum_hcd->port_status |= (USB_PORT_STAT_CONNECTION |
378 USB_PORT_STAT_SPEED_5GBPS) ;
379 if ((dum_hcd->old_status &
380 USB_PORT_STAT_CONNECTION) == 0)
381 dum_hcd->port_status |=
382 (USB_PORT_STAT_C_CONNECTION << 16);
383 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) &&
384 (dum_hcd->port_status &
385 USB_PORT_STAT_LINK_STATE) == USB_SS_PORT_LS_U0 &&
386 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
387 dum_hcd->active = 1;
388 }
389 } else {
390 if ((dum_hcd->port_status & USB_PORT_STAT_POWER) == 0) {
391 dum_hcd->port_status = 0;
392 } else if (!dum->pullup || dum->udc_suspended) {
393 /* UDC suspend must cause a disconnect */
394 dum_hcd->port_status &= ~(USB_PORT_STAT_CONNECTION |
395 USB_PORT_STAT_ENABLE |
396 USB_PORT_STAT_LOW_SPEED |
397 USB_PORT_STAT_HIGH_SPEED |
398 USB_PORT_STAT_SUSPEND);
399 if ((dum_hcd->old_status &
400 USB_PORT_STAT_CONNECTION) != 0)
401 dum_hcd->port_status |=
402 (USB_PORT_STAT_C_CONNECTION << 16);
403 } else {
404 dum_hcd->port_status |= USB_PORT_STAT_CONNECTION;
405 if ((dum_hcd->old_status &
406 USB_PORT_STAT_CONNECTION) == 0)
407 dum_hcd->port_status |=
408 (USB_PORT_STAT_C_CONNECTION << 16);
409 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0)
410 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
411 else if ((dum_hcd->port_status &
412 USB_PORT_STAT_SUSPEND) == 0 &&
413 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
414 dum_hcd->active = 1;
415 }
416 }
417 }
418
419 /* caller must hold lock */
set_link_state(struct dummy_hcd * dum_hcd)420 static void set_link_state(struct dummy_hcd *dum_hcd)
421 {
422 struct dummy *dum = dum_hcd->dum;
423 unsigned int power_bit;
424
425 dum_hcd->active = 0;
426 if (dum->pullup)
427 if ((dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 &&
428 dum->gadget.speed != USB_SPEED_SUPER) ||
429 (dummy_hcd_to_hcd(dum_hcd)->speed != HCD_USB3 &&
430 dum->gadget.speed == USB_SPEED_SUPER))
431 return;
432
433 set_link_state_by_speed(dum_hcd);
434 power_bit = (dummy_hcd_to_hcd(dum_hcd)->speed == HCD_USB3 ?
435 USB_SS_PORT_STAT_POWER : USB_PORT_STAT_POWER);
436
437 if ((dum_hcd->port_status & USB_PORT_STAT_ENABLE) == 0 ||
438 dum_hcd->active)
439 dum_hcd->resuming = 0;
440
441 /* Currently !connected or in reset */
442 if ((dum_hcd->port_status & power_bit) == 0 ||
443 (dum_hcd->port_status & USB_PORT_STAT_RESET) != 0) {
444 unsigned int disconnect = power_bit &
445 dum_hcd->old_status & (~dum_hcd->port_status);
446 unsigned int reset = USB_PORT_STAT_RESET &
447 (~dum_hcd->old_status) & dum_hcd->port_status;
448
449 /* Report reset and disconnect events to the driver */
450 if (dum->ints_enabled && (disconnect || reset)) {
451 stop_activity(dum);
452 ++dum->callback_usage;
453 spin_unlock(&dum->lock);
454 if (reset)
455 usb_gadget_udc_reset(&dum->gadget, dum->driver);
456 else
457 dum->driver->disconnect(&dum->gadget);
458 spin_lock(&dum->lock);
459 --dum->callback_usage;
460 }
461 } else if (dum_hcd->active != dum_hcd->old_active &&
462 dum->ints_enabled) {
463 ++dum->callback_usage;
464 spin_unlock(&dum->lock);
465 if (dum_hcd->old_active && dum->driver->suspend)
466 dum->driver->suspend(&dum->gadget);
467 else if (!dum_hcd->old_active && dum->driver->resume)
468 dum->driver->resume(&dum->gadget);
469 spin_lock(&dum->lock);
470 --dum->callback_usage;
471 }
472
473 dum_hcd->old_status = dum_hcd->port_status;
474 dum_hcd->old_active = dum_hcd->active;
475 }
476
477 /*-------------------------------------------------------------------------*/
478
479 /* SLAVE/GADGET SIDE DRIVER
480 *
481 * This only tracks gadget state. All the work is done when the host
482 * side tries some (emulated) i/o operation. Real device controller
483 * drivers would do real i/o using dma, fifos, irqs, timers, etc.
484 */
485
486 #define is_enabled(dum) \
487 (dum->port_status & USB_PORT_STAT_ENABLE)
488
dummy_enable(struct usb_ep * _ep,const struct usb_endpoint_descriptor * desc)489 static int dummy_enable(struct usb_ep *_ep,
490 const struct usb_endpoint_descriptor *desc)
491 {
492 struct dummy *dum;
493 struct dummy_hcd *dum_hcd;
494 struct dummy_ep *ep;
495 unsigned max;
496 int retval;
497
498 ep = usb_ep_to_dummy_ep(_ep);
499 if (!_ep || !desc || ep->desc || _ep->name == ep0name
500 || desc->bDescriptorType != USB_DT_ENDPOINT)
501 return -EINVAL;
502 dum = ep_to_dummy(ep);
503 if (!dum->driver)
504 return -ESHUTDOWN;
505
506 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
507 if (!is_enabled(dum_hcd))
508 return -ESHUTDOWN;
509
510 /*
511 * For HS/FS devices only bits 0..10 of the wMaxPacketSize represent the
512 * maximum packet size.
513 * For SS devices the wMaxPacketSize is limited by 1024.
514 */
515 max = usb_endpoint_maxp(desc) & 0x7ff;
516
517 /* drivers must not request bad settings, since lower levels
518 * (hardware or its drivers) may not check. some endpoints
519 * can't do iso, many have maxpacket limitations, etc.
520 *
521 * since this "hardware" driver is here to help debugging, we
522 * have some extra sanity checks. (there could be more though,
523 * especially for "ep9out" style fixed function ones.)
524 */
525 retval = -EINVAL;
526 switch (usb_endpoint_type(desc)) {
527 case USB_ENDPOINT_XFER_BULK:
528 if (strstr(ep->ep.name, "-iso")
529 || strstr(ep->ep.name, "-int")) {
530 goto done;
531 }
532 switch (dum->gadget.speed) {
533 case USB_SPEED_SUPER:
534 if (max == 1024)
535 break;
536 goto done;
537 case USB_SPEED_HIGH:
538 if (max == 512)
539 break;
540 goto done;
541 case USB_SPEED_FULL:
542 if (max == 8 || max == 16 || max == 32 || max == 64)
543 /* we'll fake any legal size */
544 break;
545 /* save a return statement */
546 default:
547 goto done;
548 }
549 break;
550 case USB_ENDPOINT_XFER_INT:
551 if (strstr(ep->ep.name, "-iso")) /* bulk is ok */
552 goto done;
553 /* real hardware might not handle all packet sizes */
554 switch (dum->gadget.speed) {
555 case USB_SPEED_SUPER:
556 case USB_SPEED_HIGH:
557 if (max <= 1024)
558 break;
559 /* save a return statement */
560 case USB_SPEED_FULL:
561 if (max <= 64)
562 break;
563 /* save a return statement */
564 default:
565 if (max <= 8)
566 break;
567 goto done;
568 }
569 break;
570 case USB_ENDPOINT_XFER_ISOC:
571 if (strstr(ep->ep.name, "-bulk")
572 || strstr(ep->ep.name, "-int"))
573 goto done;
574 /* real hardware might not handle all packet sizes */
575 switch (dum->gadget.speed) {
576 case USB_SPEED_SUPER:
577 case USB_SPEED_HIGH:
578 if (max <= 1024)
579 break;
580 /* save a return statement */
581 case USB_SPEED_FULL:
582 if (max <= 1023)
583 break;
584 /* save a return statement */
585 default:
586 goto done;
587 }
588 break;
589 default:
590 /* few chips support control except on ep0 */
591 goto done;
592 }
593
594 _ep->maxpacket = max;
595 if (usb_ss_max_streams(_ep->comp_desc)) {
596 if (!usb_endpoint_xfer_bulk(desc)) {
597 dev_err(udc_dev(dum), "Can't enable stream support on "
598 "non-bulk ep %s\n", _ep->name);
599 return -EINVAL;
600 }
601 ep->stream_en = 1;
602 }
603 ep->desc = desc;
604
605 dev_dbg(udc_dev(dum), "enabled %s (ep%d%s-%s) maxpacket %d stream %s\n",
606 _ep->name,
607 desc->bEndpointAddress & 0x0f,
608 (desc->bEndpointAddress & USB_DIR_IN) ? "in" : "out",
609 ({ char *val;
610 switch (usb_endpoint_type(desc)) {
611 case USB_ENDPOINT_XFER_BULK:
612 val = "bulk";
613 break;
614 case USB_ENDPOINT_XFER_ISOC:
615 val = "iso";
616 break;
617 case USB_ENDPOINT_XFER_INT:
618 val = "intr";
619 break;
620 default:
621 val = "ctrl";
622 break;
623 } val; }),
624 max, ep->stream_en ? "enabled" : "disabled");
625
626 /* at this point real hardware should be NAKing transfers
627 * to that endpoint, until a buffer is queued to it.
628 */
629 ep->halted = ep->wedged = 0;
630 retval = 0;
631 done:
632 return retval;
633 }
634
dummy_disable(struct usb_ep * _ep)635 static int dummy_disable(struct usb_ep *_ep)
636 {
637 struct dummy_ep *ep;
638 struct dummy *dum;
639 unsigned long flags;
640
641 ep = usb_ep_to_dummy_ep(_ep);
642 if (!_ep || !ep->desc || _ep->name == ep0name)
643 return -EINVAL;
644 dum = ep_to_dummy(ep);
645
646 spin_lock_irqsave(&dum->lock, flags);
647 ep->desc = NULL;
648 ep->stream_en = 0;
649 nuke(dum, ep);
650 spin_unlock_irqrestore(&dum->lock, flags);
651
652 dev_dbg(udc_dev(dum), "disabled %s\n", _ep->name);
653 return 0;
654 }
655
dummy_alloc_request(struct usb_ep * _ep,gfp_t mem_flags)656 static struct usb_request *dummy_alloc_request(struct usb_ep *_ep,
657 gfp_t mem_flags)
658 {
659 struct dummy_ep *ep;
660 struct dummy_request *req;
661
662 if (!_ep)
663 return NULL;
664 ep = usb_ep_to_dummy_ep(_ep);
665
666 req = kzalloc(sizeof(*req), mem_flags);
667 if (!req)
668 return NULL;
669 INIT_LIST_HEAD(&req->queue);
670 return &req->req;
671 }
672
dummy_free_request(struct usb_ep * _ep,struct usb_request * _req)673 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
674 {
675 struct dummy_request *req;
676
677 if (!_ep || !_req) {
678 WARN_ON(1);
679 return;
680 }
681
682 req = usb_request_to_dummy_request(_req);
683 WARN_ON(!list_empty(&req->queue));
684 kfree(req);
685 }
686
fifo_complete(struct usb_ep * ep,struct usb_request * req)687 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
688 {
689 }
690
dummy_queue(struct usb_ep * _ep,struct usb_request * _req,gfp_t mem_flags)691 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
692 gfp_t mem_flags)
693 {
694 struct dummy_ep *ep;
695 struct dummy_request *req;
696 struct dummy *dum;
697 struct dummy_hcd *dum_hcd;
698 unsigned long flags;
699
700 req = usb_request_to_dummy_request(_req);
701 if (!_req || !list_empty(&req->queue) || !_req->complete)
702 return -EINVAL;
703
704 ep = usb_ep_to_dummy_ep(_ep);
705 if (!_ep || (!ep->desc && _ep->name != ep0name))
706 return -EINVAL;
707
708 dum = ep_to_dummy(ep);
709 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
710 if (!dum->driver || !is_enabled(dum_hcd))
711 return -ESHUTDOWN;
712
713 #if 0
714 dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
715 ep, _req, _ep->name, _req->length, _req->buf);
716 #endif
717 _req->status = -EINPROGRESS;
718 _req->actual = 0;
719 spin_lock_irqsave(&dum->lock, flags);
720
721 /* implement an emulated single-request FIFO */
722 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
723 list_empty(&dum->fifo_req.queue) &&
724 list_empty(&ep->queue) &&
725 _req->length <= FIFO_SIZE) {
726 req = &dum->fifo_req;
727 req->req = *_req;
728 req->req.buf = dum->fifo_buf;
729 memcpy(dum->fifo_buf, _req->buf, _req->length);
730 req->req.context = dum;
731 req->req.complete = fifo_complete;
732
733 list_add_tail(&req->queue, &ep->queue);
734 spin_unlock(&dum->lock);
735 _req->actual = _req->length;
736 _req->status = 0;
737 usb_gadget_giveback_request(_ep, _req);
738 spin_lock(&dum->lock);
739 } else
740 list_add_tail(&req->queue, &ep->queue);
741 spin_unlock_irqrestore(&dum->lock, flags);
742
743 /* real hardware would likely enable transfers here, in case
744 * it'd been left NAKing.
745 */
746 return 0;
747 }
748
dummy_dequeue(struct usb_ep * _ep,struct usb_request * _req)749 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
750 {
751 struct dummy_ep *ep;
752 struct dummy *dum;
753 int retval = -EINVAL;
754 unsigned long flags;
755 struct dummy_request *req = NULL;
756
757 if (!_ep || !_req)
758 return retval;
759 ep = usb_ep_to_dummy_ep(_ep);
760 dum = ep_to_dummy(ep);
761
762 if (!dum->driver)
763 return -ESHUTDOWN;
764
765 local_irq_save(flags);
766 spin_lock(&dum->lock);
767 list_for_each_entry(req, &ep->queue, queue) {
768 if (&req->req == _req) {
769 list_del_init(&req->queue);
770 _req->status = -ECONNRESET;
771 retval = 0;
772 break;
773 }
774 }
775 spin_unlock(&dum->lock);
776
777 if (retval == 0) {
778 dev_dbg(udc_dev(dum),
779 "dequeued req %p from %s, len %d buf %p\n",
780 req, _ep->name, _req->length, _req->buf);
781 usb_gadget_giveback_request(_ep, _req);
782 }
783 local_irq_restore(flags);
784 return retval;
785 }
786
787 static int
dummy_set_halt_and_wedge(struct usb_ep * _ep,int value,int wedged)788 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
789 {
790 struct dummy_ep *ep;
791 struct dummy *dum;
792
793 if (!_ep)
794 return -EINVAL;
795 ep = usb_ep_to_dummy_ep(_ep);
796 dum = ep_to_dummy(ep);
797 if (!dum->driver)
798 return -ESHUTDOWN;
799 if (!value)
800 ep->halted = ep->wedged = 0;
801 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
802 !list_empty(&ep->queue))
803 return -EAGAIN;
804 else {
805 ep->halted = 1;
806 if (wedged)
807 ep->wedged = 1;
808 }
809 /* FIXME clear emulated data toggle too */
810 return 0;
811 }
812
813 static int
dummy_set_halt(struct usb_ep * _ep,int value)814 dummy_set_halt(struct usb_ep *_ep, int value)
815 {
816 return dummy_set_halt_and_wedge(_ep, value, 0);
817 }
818
dummy_set_wedge(struct usb_ep * _ep)819 static int dummy_set_wedge(struct usb_ep *_ep)
820 {
821 if (!_ep || _ep->name == ep0name)
822 return -EINVAL;
823 return dummy_set_halt_and_wedge(_ep, 1, 1);
824 }
825
826 static const struct usb_ep_ops dummy_ep_ops = {
827 .enable = dummy_enable,
828 .disable = dummy_disable,
829
830 .alloc_request = dummy_alloc_request,
831 .free_request = dummy_free_request,
832
833 .queue = dummy_queue,
834 .dequeue = dummy_dequeue,
835
836 .set_halt = dummy_set_halt,
837 .set_wedge = dummy_set_wedge,
838 };
839
840 /*-------------------------------------------------------------------------*/
841
842 /* there are both host and device side versions of this call ... */
dummy_g_get_frame(struct usb_gadget * _gadget)843 static int dummy_g_get_frame(struct usb_gadget *_gadget)
844 {
845 struct timespec64 ts64;
846
847 ktime_get_ts64(&ts64);
848 return ts64.tv_nsec / NSEC_PER_MSEC;
849 }
850
dummy_wakeup(struct usb_gadget * _gadget)851 static int dummy_wakeup(struct usb_gadget *_gadget)
852 {
853 struct dummy_hcd *dum_hcd;
854
855 dum_hcd = gadget_to_dummy_hcd(_gadget);
856 if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
857 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
858 return -EINVAL;
859 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
860 return -ENOLINK;
861 if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
862 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
863 return -EIO;
864
865 /* FIXME: What if the root hub is suspended but the port isn't? */
866
867 /* hub notices our request, issues downstream resume, etc */
868 dum_hcd->resuming = 1;
869 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
870 mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
871 return 0;
872 }
873
dummy_set_selfpowered(struct usb_gadget * _gadget,int value)874 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
875 {
876 struct dummy *dum;
877
878 _gadget->is_selfpowered = (value != 0);
879 dum = gadget_to_dummy_hcd(_gadget)->dum;
880 if (value)
881 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
882 else
883 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
884 return 0;
885 }
886
dummy_udc_update_ep0(struct dummy * dum)887 static void dummy_udc_update_ep0(struct dummy *dum)
888 {
889 if (dum->gadget.speed == USB_SPEED_SUPER)
890 dum->ep[0].ep.maxpacket = 9;
891 else
892 dum->ep[0].ep.maxpacket = 64;
893 }
894
dummy_pullup(struct usb_gadget * _gadget,int value)895 static int dummy_pullup(struct usb_gadget *_gadget, int value)
896 {
897 struct dummy_hcd *dum_hcd;
898 struct dummy *dum;
899 unsigned long flags;
900
901 dum = gadget_dev_to_dummy(&_gadget->dev);
902
903 if (value && dum->driver) {
904 if (mod_data.is_super_speed)
905 dum->gadget.speed = dum->driver->max_speed;
906 else if (mod_data.is_high_speed)
907 dum->gadget.speed = min_t(u8, USB_SPEED_HIGH,
908 dum->driver->max_speed);
909 else
910 dum->gadget.speed = USB_SPEED_FULL;
911 dummy_udc_update_ep0(dum);
912
913 if (dum->gadget.speed < dum->driver->max_speed)
914 dev_dbg(udc_dev(dum), "This device can perform faster"
915 " if you connect it to a %s port...\n",
916 usb_speed_string(dum->driver->max_speed));
917 }
918 dum_hcd = gadget_to_dummy_hcd(_gadget);
919
920 spin_lock_irqsave(&dum->lock, flags);
921 dum->pullup = (value != 0);
922 set_link_state(dum_hcd);
923 if (value == 0) {
924 /*
925 * Emulate synchronize_irq(): wait for callbacks to finish.
926 * This seems to be the best place to emulate the call to
927 * synchronize_irq() that's in usb_gadget_remove_driver().
928 * Doing it in dummy_udc_stop() would be too late since it
929 * is called after the unbind callback and unbind shouldn't
930 * be invoked until all the other callbacks are finished.
931 */
932 while (dum->callback_usage > 0) {
933 spin_unlock_irqrestore(&dum->lock, flags);
934 usleep_range(1000, 2000);
935 spin_lock_irqsave(&dum->lock, flags);
936 }
937 }
938 spin_unlock_irqrestore(&dum->lock, flags);
939
940 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
941 return 0;
942 }
943
944 static int dummy_udc_start(struct usb_gadget *g,
945 struct usb_gadget_driver *driver);
946 static int dummy_udc_stop(struct usb_gadget *g);
947
948 static const struct usb_gadget_ops dummy_ops = {
949 .get_frame = dummy_g_get_frame,
950 .wakeup = dummy_wakeup,
951 .set_selfpowered = dummy_set_selfpowered,
952 .pullup = dummy_pullup,
953 .udc_start = dummy_udc_start,
954 .udc_stop = dummy_udc_stop,
955 };
956
957 /*-------------------------------------------------------------------------*/
958
959 /* "function" sysfs attribute */
function_show(struct device * dev,struct device_attribute * attr,char * buf)960 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
961 char *buf)
962 {
963 struct dummy *dum = gadget_dev_to_dummy(dev);
964
965 if (!dum->driver || !dum->driver->function)
966 return 0;
967 return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
968 }
969 static DEVICE_ATTR_RO(function);
970
971 /*-------------------------------------------------------------------------*/
972
973 /*
974 * Driver registration/unregistration.
975 *
976 * This is basically hardware-specific; there's usually only one real USB
977 * device (not host) controller since that's how USB devices are intended
978 * to work. So most implementations of these api calls will rely on the
979 * fact that only one driver will ever bind to the hardware. But curious
980 * hardware can be built with discrete components, so the gadget API doesn't
981 * require that assumption.
982 *
983 * For this emulator, it might be convenient to create a usb slave device
984 * for each driver that registers: just add to a big root hub.
985 */
986
dummy_udc_start(struct usb_gadget * g,struct usb_gadget_driver * driver)987 static int dummy_udc_start(struct usb_gadget *g,
988 struct usb_gadget_driver *driver)
989 {
990 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
991 struct dummy *dum = dum_hcd->dum;
992
993 if (driver->max_speed == USB_SPEED_UNKNOWN)
994 return -EINVAL;
995
996 /*
997 * SLAVE side init ... the layer above hardware, which
998 * can't enumerate without help from the driver we're binding.
999 */
1000
1001 spin_lock_irq(&dum->lock);
1002 dum->devstatus = 0;
1003 dum->driver = driver;
1004 dum->ints_enabled = 1;
1005 spin_unlock_irq(&dum->lock);
1006
1007 return 0;
1008 }
1009
dummy_udc_stop(struct usb_gadget * g)1010 static int dummy_udc_stop(struct usb_gadget *g)
1011 {
1012 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
1013 struct dummy *dum = dum_hcd->dum;
1014
1015 spin_lock_irq(&dum->lock);
1016 dum->ints_enabled = 0;
1017 stop_activity(dum);
1018 dum->driver = NULL;
1019 spin_unlock_irq(&dum->lock);
1020
1021 return 0;
1022 }
1023
1024 #undef is_enabled
1025
1026 /* The gadget structure is stored inside the hcd structure and will be
1027 * released along with it. */
init_dummy_udc_hw(struct dummy * dum)1028 static void init_dummy_udc_hw(struct dummy *dum)
1029 {
1030 int i;
1031
1032 INIT_LIST_HEAD(&dum->gadget.ep_list);
1033 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1034 struct dummy_ep *ep = &dum->ep[i];
1035
1036 if (!ep_info[i].name)
1037 break;
1038 ep->ep.name = ep_info[i].name;
1039 ep->ep.caps = ep_info[i].caps;
1040 ep->ep.ops = &dummy_ep_ops;
1041 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1042 ep->halted = ep->wedged = ep->already_seen =
1043 ep->setup_stage = 0;
1044 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1045 ep->ep.max_streams = 16;
1046 ep->last_io = jiffies;
1047 ep->gadget = &dum->gadget;
1048 ep->desc = NULL;
1049 INIT_LIST_HEAD(&ep->queue);
1050 }
1051
1052 dum->gadget.ep0 = &dum->ep[0].ep;
1053 list_del_init(&dum->ep[0].ep.ep_list);
1054 INIT_LIST_HEAD(&dum->fifo_req.queue);
1055
1056 #ifdef CONFIG_USB_OTG
1057 dum->gadget.is_otg = 1;
1058 #endif
1059 }
1060
dummy_udc_probe(struct platform_device * pdev)1061 static int dummy_udc_probe(struct platform_device *pdev)
1062 {
1063 struct dummy *dum;
1064 int rc;
1065
1066 dum = *((void **)dev_get_platdata(&pdev->dev));
1067 /* Clear usb_gadget region for new registration to udc-core */
1068 memzero_explicit(&dum->gadget, sizeof(struct usb_gadget));
1069 dum->gadget.name = gadget_name;
1070 dum->gadget.ops = &dummy_ops;
1071 if (mod_data.is_super_speed)
1072 dum->gadget.max_speed = USB_SPEED_SUPER;
1073 else if (mod_data.is_high_speed)
1074 dum->gadget.max_speed = USB_SPEED_HIGH;
1075 else
1076 dum->gadget.max_speed = USB_SPEED_FULL;
1077
1078 dum->gadget.dev.parent = &pdev->dev;
1079 init_dummy_udc_hw(dum);
1080
1081 rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1082 if (rc < 0)
1083 goto err_udc;
1084
1085 rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1086 if (rc < 0)
1087 goto err_dev;
1088 platform_set_drvdata(pdev, dum);
1089 return rc;
1090
1091 err_dev:
1092 usb_del_gadget_udc(&dum->gadget);
1093 err_udc:
1094 return rc;
1095 }
1096
dummy_udc_remove(struct platform_device * pdev)1097 static int dummy_udc_remove(struct platform_device *pdev)
1098 {
1099 struct dummy *dum = platform_get_drvdata(pdev);
1100
1101 device_remove_file(&dum->gadget.dev, &dev_attr_function);
1102 usb_del_gadget_udc(&dum->gadget);
1103 return 0;
1104 }
1105
dummy_udc_pm(struct dummy * dum,struct dummy_hcd * dum_hcd,int suspend)1106 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1107 int suspend)
1108 {
1109 spin_lock_irq(&dum->lock);
1110 dum->udc_suspended = suspend;
1111 set_link_state(dum_hcd);
1112 spin_unlock_irq(&dum->lock);
1113 }
1114
dummy_udc_suspend(struct platform_device * pdev,pm_message_t state)1115 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1116 {
1117 struct dummy *dum = platform_get_drvdata(pdev);
1118 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1119
1120 dev_dbg(&pdev->dev, "%s\n", __func__);
1121 dummy_udc_pm(dum, dum_hcd, 1);
1122 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1123 return 0;
1124 }
1125
dummy_udc_resume(struct platform_device * pdev)1126 static int dummy_udc_resume(struct platform_device *pdev)
1127 {
1128 struct dummy *dum = platform_get_drvdata(pdev);
1129 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1130
1131 dev_dbg(&pdev->dev, "%s\n", __func__);
1132 dummy_udc_pm(dum, dum_hcd, 0);
1133 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1134 return 0;
1135 }
1136
1137 static struct platform_driver dummy_udc_driver = {
1138 .probe = dummy_udc_probe,
1139 .remove = dummy_udc_remove,
1140 .suspend = dummy_udc_suspend,
1141 .resume = dummy_udc_resume,
1142 .driver = {
1143 .name = (char *) gadget_name,
1144 },
1145 };
1146
1147 /*-------------------------------------------------------------------------*/
1148
dummy_get_ep_idx(const struct usb_endpoint_descriptor * desc)1149 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1150 {
1151 unsigned int index;
1152
1153 index = usb_endpoint_num(desc) << 1;
1154 if (usb_endpoint_dir_in(desc))
1155 index |= 1;
1156 return index;
1157 }
1158
1159 /* MASTER/HOST SIDE DRIVER
1160 *
1161 * this uses the hcd framework to hook up to host side drivers.
1162 * its root hub will only have one device, otherwise it acts like
1163 * a normal host controller.
1164 *
1165 * when urbs are queued, they're just stuck on a list that we
1166 * scan in a timer callback. that callback connects writes from
1167 * the host with reads from the device, and so on, based on the
1168 * usb 2.0 rules.
1169 */
1170
dummy_ep_stream_en(struct dummy_hcd * dum_hcd,struct urb * urb)1171 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1172 {
1173 const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1174 u32 index;
1175
1176 if (!usb_endpoint_xfer_bulk(desc))
1177 return 0;
1178
1179 index = dummy_get_ep_idx(desc);
1180 return (1 << index) & dum_hcd->stream_en_ep;
1181 }
1182
1183 /*
1184 * The max stream number is saved as a nibble so for the 30 possible endpoints
1185 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1186 * means we use only 1 stream). The maximum according to the spec is 16bit so
1187 * if the 16 stream limit is about to go, the array size should be incremented
1188 * to 30 elements of type u16.
1189 */
get_max_streams_for_pipe(struct dummy_hcd * dum_hcd,unsigned int pipe)1190 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1191 unsigned int pipe)
1192 {
1193 int max_streams;
1194
1195 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1196 if (usb_pipeout(pipe))
1197 max_streams >>= 4;
1198 else
1199 max_streams &= 0xf;
1200 max_streams++;
1201 return max_streams;
1202 }
1203
set_max_streams_for_pipe(struct dummy_hcd * dum_hcd,unsigned int pipe,unsigned int streams)1204 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1205 unsigned int pipe, unsigned int streams)
1206 {
1207 int max_streams;
1208
1209 streams--;
1210 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1211 if (usb_pipeout(pipe)) {
1212 streams <<= 4;
1213 max_streams &= 0xf;
1214 } else {
1215 max_streams &= 0xf0;
1216 }
1217 max_streams |= streams;
1218 dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1219 }
1220
dummy_validate_stream(struct dummy_hcd * dum_hcd,struct urb * urb)1221 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1222 {
1223 unsigned int max_streams;
1224 int enabled;
1225
1226 enabled = dummy_ep_stream_en(dum_hcd, urb);
1227 if (!urb->stream_id) {
1228 if (enabled)
1229 return -EINVAL;
1230 return 0;
1231 }
1232 if (!enabled)
1233 return -EINVAL;
1234
1235 max_streams = get_max_streams_for_pipe(dum_hcd,
1236 usb_pipeendpoint(urb->pipe));
1237 if (urb->stream_id > max_streams) {
1238 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1239 urb->stream_id);
1240 BUG();
1241 return -EINVAL;
1242 }
1243 return 0;
1244 }
1245
dummy_urb_enqueue(struct usb_hcd * hcd,struct urb * urb,gfp_t mem_flags)1246 static int dummy_urb_enqueue(
1247 struct usb_hcd *hcd,
1248 struct urb *urb,
1249 gfp_t mem_flags
1250 ) {
1251 struct dummy_hcd *dum_hcd;
1252 struct urbp *urbp;
1253 unsigned long flags;
1254 int rc;
1255
1256 urbp = kmalloc(sizeof *urbp, mem_flags);
1257 if (!urbp)
1258 return -ENOMEM;
1259 urbp->urb = urb;
1260 urbp->miter_started = 0;
1261
1262 dum_hcd = hcd_to_dummy_hcd(hcd);
1263 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1264
1265 rc = dummy_validate_stream(dum_hcd, urb);
1266 if (rc) {
1267 kfree(urbp);
1268 goto done;
1269 }
1270
1271 rc = usb_hcd_link_urb_to_ep(hcd, urb);
1272 if (rc) {
1273 kfree(urbp);
1274 goto done;
1275 }
1276
1277 if (!dum_hcd->udev) {
1278 dum_hcd->udev = urb->dev;
1279 usb_get_dev(dum_hcd->udev);
1280 } else if (unlikely(dum_hcd->udev != urb->dev))
1281 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1282
1283 list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1284 urb->hcpriv = urbp;
1285 if (!dum_hcd->next_frame_urbp)
1286 dum_hcd->next_frame_urbp = urbp;
1287 if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1288 urb->error_count = 1; /* mark as a new urb */
1289
1290 /* kick the scheduler, it'll do the rest */
1291 if (!timer_pending(&dum_hcd->timer))
1292 mod_timer(&dum_hcd->timer, jiffies + 1);
1293
1294 done:
1295 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1296 return rc;
1297 }
1298
dummy_urb_dequeue(struct usb_hcd * hcd,struct urb * urb,int status)1299 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1300 {
1301 struct dummy_hcd *dum_hcd;
1302 unsigned long flags;
1303 int rc;
1304
1305 /* giveback happens automatically in timer callback,
1306 * so make sure the callback happens */
1307 dum_hcd = hcd_to_dummy_hcd(hcd);
1308 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1309
1310 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1311 if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1312 !list_empty(&dum_hcd->urbp_list))
1313 mod_timer(&dum_hcd->timer, jiffies);
1314
1315 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1316 return rc;
1317 }
1318
dummy_perform_transfer(struct urb * urb,struct dummy_request * req,u32 len)1319 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1320 u32 len)
1321 {
1322 void *ubuf, *rbuf;
1323 struct urbp *urbp = urb->hcpriv;
1324 int to_host;
1325 struct sg_mapping_iter *miter = &urbp->miter;
1326 u32 trans = 0;
1327 u32 this_sg;
1328 bool next_sg;
1329
1330 to_host = usb_pipein(urb->pipe);
1331 rbuf = req->req.buf + req->req.actual;
1332
1333 if (!urb->num_sgs) {
1334 ubuf = urb->transfer_buffer + urb->actual_length;
1335 if (to_host)
1336 memcpy(ubuf, rbuf, len);
1337 else
1338 memcpy(rbuf, ubuf, len);
1339 return len;
1340 }
1341
1342 if (!urbp->miter_started) {
1343 u32 flags = SG_MITER_ATOMIC;
1344
1345 if (to_host)
1346 flags |= SG_MITER_TO_SG;
1347 else
1348 flags |= SG_MITER_FROM_SG;
1349
1350 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1351 urbp->miter_started = 1;
1352 }
1353 next_sg = sg_miter_next(miter);
1354 if (next_sg == false) {
1355 WARN_ON_ONCE(1);
1356 return -EINVAL;
1357 }
1358 do {
1359 ubuf = miter->addr;
1360 this_sg = min_t(u32, len, miter->length);
1361 miter->consumed = this_sg;
1362 trans += this_sg;
1363
1364 if (to_host)
1365 memcpy(ubuf, rbuf, this_sg);
1366 else
1367 memcpy(rbuf, ubuf, this_sg);
1368 len -= this_sg;
1369
1370 if (!len)
1371 break;
1372 next_sg = sg_miter_next(miter);
1373 if (next_sg == false) {
1374 WARN_ON_ONCE(1);
1375 return -EINVAL;
1376 }
1377
1378 rbuf += this_sg;
1379 } while (1);
1380
1381 sg_miter_stop(miter);
1382 return trans;
1383 }
1384
1385 /* transfer up to a frame's worth; caller must own lock */
transfer(struct dummy_hcd * dum_hcd,struct urb * urb,struct dummy_ep * ep,int limit,int * status)1386 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1387 struct dummy_ep *ep, int limit, int *status)
1388 {
1389 struct dummy *dum = dum_hcd->dum;
1390 struct dummy_request *req;
1391 int sent = 0;
1392
1393 top:
1394 /* if there's no request queued, the device is NAKing; return */
1395 list_for_each_entry(req, &ep->queue, queue) {
1396 unsigned host_len, dev_len, len;
1397 int is_short, to_host;
1398 int rescan = 0;
1399
1400 if (dummy_ep_stream_en(dum_hcd, urb)) {
1401 if ((urb->stream_id != req->req.stream_id))
1402 continue;
1403 }
1404
1405 /* 1..N packets of ep->ep.maxpacket each ... the last one
1406 * may be short (including zero length).
1407 *
1408 * writer can send a zlp explicitly (length 0) or implicitly
1409 * (length mod maxpacket zero, and 'zero' flag); they always
1410 * terminate reads.
1411 */
1412 host_len = urb->transfer_buffer_length - urb->actual_length;
1413 dev_len = req->req.length - req->req.actual;
1414 len = min(host_len, dev_len);
1415
1416 /* FIXME update emulated data toggle too */
1417
1418 to_host = usb_pipein(urb->pipe);
1419 if (unlikely(len == 0))
1420 is_short = 1;
1421 else {
1422 /* not enough bandwidth left? */
1423 if (limit < ep->ep.maxpacket && limit < len)
1424 break;
1425 len = min_t(unsigned, len, limit);
1426 if (len == 0)
1427 break;
1428
1429 /* send multiple of maxpacket first, then remainder */
1430 if (len >= ep->ep.maxpacket) {
1431 is_short = 0;
1432 if (len % ep->ep.maxpacket)
1433 rescan = 1;
1434 len -= len % ep->ep.maxpacket;
1435 } else {
1436 is_short = 1;
1437 }
1438
1439 len = dummy_perform_transfer(urb, req, len);
1440
1441 ep->last_io = jiffies;
1442 if ((int)len < 0) {
1443 req->req.status = len;
1444 } else {
1445 limit -= len;
1446 sent += len;
1447 urb->actual_length += len;
1448 req->req.actual += len;
1449 }
1450 }
1451
1452 /* short packets terminate, maybe with overflow/underflow.
1453 * it's only really an error to write too much.
1454 *
1455 * partially filling a buffer optionally blocks queue advances
1456 * (so completion handlers can clean up the queue) but we don't
1457 * need to emulate such data-in-flight.
1458 */
1459 if (is_short) {
1460 if (host_len == dev_len) {
1461 req->req.status = 0;
1462 *status = 0;
1463 } else if (to_host) {
1464 req->req.status = 0;
1465 if (dev_len > host_len)
1466 *status = -EOVERFLOW;
1467 else
1468 *status = 0;
1469 } else {
1470 *status = 0;
1471 if (host_len > dev_len)
1472 req->req.status = -EOVERFLOW;
1473 else
1474 req->req.status = 0;
1475 }
1476
1477 /*
1478 * many requests terminate without a short packet.
1479 * send a zlp if demanded by flags.
1480 */
1481 } else {
1482 if (req->req.length == req->req.actual) {
1483 if (req->req.zero && to_host)
1484 rescan = 1;
1485 else
1486 req->req.status = 0;
1487 }
1488 if (urb->transfer_buffer_length == urb->actual_length) {
1489 if (urb->transfer_flags & URB_ZERO_PACKET &&
1490 !to_host)
1491 rescan = 1;
1492 else
1493 *status = 0;
1494 }
1495 }
1496
1497 /* device side completion --> continuable */
1498 if (req->req.status != -EINPROGRESS) {
1499 list_del_init(&req->queue);
1500
1501 spin_unlock(&dum->lock);
1502 usb_gadget_giveback_request(&ep->ep, &req->req);
1503 spin_lock(&dum->lock);
1504
1505 /* requests might have been unlinked... */
1506 rescan = 1;
1507 }
1508
1509 /* host side completion --> terminate */
1510 if (*status != -EINPROGRESS)
1511 break;
1512
1513 /* rescan to continue with any other queued i/o */
1514 if (rescan)
1515 goto top;
1516 }
1517 return sent;
1518 }
1519
periodic_bytes(struct dummy * dum,struct dummy_ep * ep)1520 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1521 {
1522 int limit = ep->ep.maxpacket;
1523
1524 if (dum->gadget.speed == USB_SPEED_HIGH) {
1525 int tmp;
1526
1527 /* high bandwidth mode */
1528 tmp = usb_endpoint_maxp(ep->desc);
1529 tmp = (tmp >> 11) & 0x03;
1530 tmp *= 8 /* applies to entire frame */;
1531 limit += limit * tmp;
1532 }
1533 if (dum->gadget.speed == USB_SPEED_SUPER) {
1534 switch (usb_endpoint_type(ep->desc)) {
1535 case USB_ENDPOINT_XFER_ISOC:
1536 /* Sec. 4.4.8.2 USB3.0 Spec */
1537 limit = 3 * 16 * 1024 * 8;
1538 break;
1539 case USB_ENDPOINT_XFER_INT:
1540 /* Sec. 4.4.7.2 USB3.0 Spec */
1541 limit = 3 * 1024 * 8;
1542 break;
1543 case USB_ENDPOINT_XFER_BULK:
1544 default:
1545 break;
1546 }
1547 }
1548 return limit;
1549 }
1550
1551 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1552 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1553 USB_PORT_STAT_SUSPEND)) \
1554 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1555
find_endpoint(struct dummy * dum,u8 address)1556 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1557 {
1558 int i;
1559
1560 if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1561 dum->ss_hcd : dum->hs_hcd)))
1562 return NULL;
1563 if (!dum->ints_enabled)
1564 return NULL;
1565 if ((address & ~USB_DIR_IN) == 0)
1566 return &dum->ep[0];
1567 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1568 struct dummy_ep *ep = &dum->ep[i];
1569
1570 if (!ep->desc)
1571 continue;
1572 if (ep->desc->bEndpointAddress == address)
1573 return ep;
1574 }
1575 return NULL;
1576 }
1577
1578 #undef is_active
1579
1580 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1581 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1582 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1583 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1584 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1585 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1586
1587
1588 /**
1589 * handle_control_request() - handles all control transfers
1590 * @dum: pointer to dummy (the_controller)
1591 * @urb: the urb request to handle
1592 * @setup: pointer to the setup data for a USB device control
1593 * request
1594 * @status: pointer to request handling status
1595 *
1596 * Return 0 - if the request was handled
1597 * 1 - if the request wasn't handles
1598 * error code on error
1599 */
handle_control_request(struct dummy_hcd * dum_hcd,struct urb * urb,struct usb_ctrlrequest * setup,int * status)1600 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1601 struct usb_ctrlrequest *setup,
1602 int *status)
1603 {
1604 struct dummy_ep *ep2;
1605 struct dummy *dum = dum_hcd->dum;
1606 int ret_val = 1;
1607 unsigned w_index;
1608 unsigned w_value;
1609
1610 w_index = le16_to_cpu(setup->wIndex);
1611 w_value = le16_to_cpu(setup->wValue);
1612 switch (setup->bRequest) {
1613 case USB_REQ_SET_ADDRESS:
1614 if (setup->bRequestType != Dev_Request)
1615 break;
1616 dum->address = w_value;
1617 *status = 0;
1618 dev_dbg(udc_dev(dum), "set_address = %d\n",
1619 w_value);
1620 ret_val = 0;
1621 break;
1622 case USB_REQ_SET_FEATURE:
1623 if (setup->bRequestType == Dev_Request) {
1624 ret_val = 0;
1625 switch (w_value) {
1626 case USB_DEVICE_REMOTE_WAKEUP:
1627 break;
1628 case USB_DEVICE_B_HNP_ENABLE:
1629 dum->gadget.b_hnp_enable = 1;
1630 break;
1631 case USB_DEVICE_A_HNP_SUPPORT:
1632 dum->gadget.a_hnp_support = 1;
1633 break;
1634 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1635 dum->gadget.a_alt_hnp_support = 1;
1636 break;
1637 case USB_DEVICE_U1_ENABLE:
1638 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1639 HCD_USB3)
1640 w_value = USB_DEV_STAT_U1_ENABLED;
1641 else
1642 ret_val = -EOPNOTSUPP;
1643 break;
1644 case USB_DEVICE_U2_ENABLE:
1645 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1646 HCD_USB3)
1647 w_value = USB_DEV_STAT_U2_ENABLED;
1648 else
1649 ret_val = -EOPNOTSUPP;
1650 break;
1651 case USB_DEVICE_LTM_ENABLE:
1652 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1653 HCD_USB3)
1654 w_value = USB_DEV_STAT_LTM_ENABLED;
1655 else
1656 ret_val = -EOPNOTSUPP;
1657 break;
1658 default:
1659 ret_val = -EOPNOTSUPP;
1660 }
1661 if (ret_val == 0) {
1662 dum->devstatus |= (1 << w_value);
1663 *status = 0;
1664 }
1665 } else if (setup->bRequestType == Ep_Request) {
1666 /* endpoint halt */
1667 ep2 = find_endpoint(dum, w_index);
1668 if (!ep2 || ep2->ep.name == ep0name) {
1669 ret_val = -EOPNOTSUPP;
1670 break;
1671 }
1672 ep2->halted = 1;
1673 ret_val = 0;
1674 *status = 0;
1675 }
1676 break;
1677 case USB_REQ_CLEAR_FEATURE:
1678 if (setup->bRequestType == Dev_Request) {
1679 ret_val = 0;
1680 switch (w_value) {
1681 case USB_DEVICE_REMOTE_WAKEUP:
1682 w_value = USB_DEVICE_REMOTE_WAKEUP;
1683 break;
1684 case USB_DEVICE_U1_ENABLE:
1685 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1686 HCD_USB3)
1687 w_value = USB_DEV_STAT_U1_ENABLED;
1688 else
1689 ret_val = -EOPNOTSUPP;
1690 break;
1691 case USB_DEVICE_U2_ENABLE:
1692 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1693 HCD_USB3)
1694 w_value = USB_DEV_STAT_U2_ENABLED;
1695 else
1696 ret_val = -EOPNOTSUPP;
1697 break;
1698 case USB_DEVICE_LTM_ENABLE:
1699 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1700 HCD_USB3)
1701 w_value = USB_DEV_STAT_LTM_ENABLED;
1702 else
1703 ret_val = -EOPNOTSUPP;
1704 break;
1705 default:
1706 ret_val = -EOPNOTSUPP;
1707 break;
1708 }
1709 if (ret_val == 0) {
1710 dum->devstatus &= ~(1 << w_value);
1711 *status = 0;
1712 }
1713 } else if (setup->bRequestType == Ep_Request) {
1714 /* endpoint halt */
1715 ep2 = find_endpoint(dum, w_index);
1716 if (!ep2) {
1717 ret_val = -EOPNOTSUPP;
1718 break;
1719 }
1720 if (!ep2->wedged)
1721 ep2->halted = 0;
1722 ret_val = 0;
1723 *status = 0;
1724 }
1725 break;
1726 case USB_REQ_GET_STATUS:
1727 if (setup->bRequestType == Dev_InRequest
1728 || setup->bRequestType == Intf_InRequest
1729 || setup->bRequestType == Ep_InRequest) {
1730 char *buf;
1731 /*
1732 * device: remote wakeup, selfpowered
1733 * interface: nothing
1734 * endpoint: halt
1735 */
1736 buf = (char *)urb->transfer_buffer;
1737 if (urb->transfer_buffer_length > 0) {
1738 if (setup->bRequestType == Ep_InRequest) {
1739 ep2 = find_endpoint(dum, w_index);
1740 if (!ep2) {
1741 ret_val = -EOPNOTSUPP;
1742 break;
1743 }
1744 buf[0] = ep2->halted;
1745 } else if (setup->bRequestType ==
1746 Dev_InRequest) {
1747 buf[0] = (u8)dum->devstatus;
1748 } else
1749 buf[0] = 0;
1750 }
1751 if (urb->transfer_buffer_length > 1)
1752 buf[1] = 0;
1753 urb->actual_length = min_t(u32, 2,
1754 urb->transfer_buffer_length);
1755 ret_val = 0;
1756 *status = 0;
1757 }
1758 break;
1759 }
1760 return ret_val;
1761 }
1762
1763 /* drive both sides of the transfers; looks like irq handlers to
1764 * both drivers except the callbacks aren't in_irq().
1765 */
dummy_timer(unsigned long _dum_hcd)1766 static void dummy_timer(unsigned long _dum_hcd)
1767 {
1768 struct dummy_hcd *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1769 struct dummy *dum = dum_hcd->dum;
1770 struct urbp *urbp, *tmp;
1771 unsigned long flags;
1772 int limit, total;
1773 int i;
1774
1775 /* simplistic model for one frame's bandwidth */
1776 switch (dum->gadget.speed) {
1777 case USB_SPEED_LOW:
1778 total = 8/*bytes*/ * 12/*packets*/;
1779 break;
1780 case USB_SPEED_FULL:
1781 total = 64/*bytes*/ * 19/*packets*/;
1782 break;
1783 case USB_SPEED_HIGH:
1784 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1785 break;
1786 case USB_SPEED_SUPER:
1787 /* Bus speed is 500000 bytes/ms, so use a little less */
1788 total = 490000;
1789 break;
1790 default:
1791 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1792 return;
1793 }
1794
1795 /* FIXME if HZ != 1000 this will probably misbehave ... */
1796
1797 /* look at each urb queued by the host side driver */
1798 spin_lock_irqsave(&dum->lock, flags);
1799
1800 if (!dum_hcd->udev) {
1801 dev_err(dummy_dev(dum_hcd),
1802 "timer fired with no URBs pending?\n");
1803 spin_unlock_irqrestore(&dum->lock, flags);
1804 return;
1805 }
1806 dum_hcd->next_frame_urbp = NULL;
1807
1808 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1809 if (!ep_info[i].name)
1810 break;
1811 dum->ep[i].already_seen = 0;
1812 }
1813
1814 restart:
1815 list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1816 struct urb *urb;
1817 struct dummy_request *req;
1818 u8 address;
1819 struct dummy_ep *ep = NULL;
1820 int type;
1821 int status = -EINPROGRESS;
1822
1823 /* stop when we reach URBs queued after the timer interrupt */
1824 if (urbp == dum_hcd->next_frame_urbp)
1825 break;
1826
1827 urb = urbp->urb;
1828 if (urb->unlinked)
1829 goto return_urb;
1830 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1831 continue;
1832 type = usb_pipetype(urb->pipe);
1833
1834 /* used up this frame's non-periodic bandwidth?
1835 * FIXME there's infinite bandwidth for control and
1836 * periodic transfers ... unrealistic.
1837 */
1838 if (total <= 0 && type == PIPE_BULK)
1839 continue;
1840
1841 /* find the gadget's ep for this request (if configured) */
1842 address = usb_pipeendpoint (urb->pipe);
1843 if (usb_pipein(urb->pipe))
1844 address |= USB_DIR_IN;
1845 ep = find_endpoint(dum, address);
1846 if (!ep) {
1847 /* set_configuration() disagreement */
1848 dev_dbg(dummy_dev(dum_hcd),
1849 "no ep configured for urb %p\n",
1850 urb);
1851 status = -EPROTO;
1852 goto return_urb;
1853 }
1854
1855 if (ep->already_seen)
1856 continue;
1857 ep->already_seen = 1;
1858 if (ep == &dum->ep[0] && urb->error_count) {
1859 ep->setup_stage = 1; /* a new urb */
1860 urb->error_count = 0;
1861 }
1862 if (ep->halted && !ep->setup_stage) {
1863 /* NOTE: must not be iso! */
1864 dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1865 ep->ep.name, urb);
1866 status = -EPIPE;
1867 goto return_urb;
1868 }
1869 /* FIXME make sure both ends agree on maxpacket */
1870
1871 /* handle control requests */
1872 if (ep == &dum->ep[0] && ep->setup_stage) {
1873 struct usb_ctrlrequest setup;
1874 int value = 1;
1875
1876 setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1877 /* paranoia, in case of stale queued data */
1878 list_for_each_entry(req, &ep->queue, queue) {
1879 list_del_init(&req->queue);
1880 req->req.status = -EOVERFLOW;
1881 dev_dbg(udc_dev(dum), "stale req = %p\n",
1882 req);
1883
1884 spin_unlock(&dum->lock);
1885 usb_gadget_giveback_request(&ep->ep, &req->req);
1886 spin_lock(&dum->lock);
1887 ep->already_seen = 0;
1888 goto restart;
1889 }
1890
1891 /* gadget driver never sees set_address or operations
1892 * on standard feature flags. some hardware doesn't
1893 * even expose them.
1894 */
1895 ep->last_io = jiffies;
1896 ep->setup_stage = 0;
1897 ep->halted = 0;
1898
1899 value = handle_control_request(dum_hcd, urb, &setup,
1900 &status);
1901
1902 /* gadget driver handles all other requests. block
1903 * until setup() returns; no reentrancy issues etc.
1904 */
1905 if (value > 0) {
1906 ++dum->callback_usage;
1907 spin_unlock(&dum->lock);
1908 value = dum->driver->setup(&dum->gadget,
1909 &setup);
1910 spin_lock(&dum->lock);
1911 --dum->callback_usage;
1912
1913 if (value >= 0) {
1914 /* no delays (max 64KB data stage) */
1915 limit = 64*1024;
1916 goto treat_control_like_bulk;
1917 }
1918 /* error, see below */
1919 }
1920
1921 if (value < 0) {
1922 if (value != -EOPNOTSUPP)
1923 dev_dbg(udc_dev(dum),
1924 "setup --> %d\n",
1925 value);
1926 status = -EPIPE;
1927 urb->actual_length = 0;
1928 }
1929
1930 goto return_urb;
1931 }
1932
1933 /* non-control requests */
1934 limit = total;
1935 switch (usb_pipetype(urb->pipe)) {
1936 case PIPE_ISOCHRONOUS:
1937 /* FIXME is it urb->interval since the last xfer?
1938 * use urb->iso_frame_desc[i].
1939 * complete whether or not ep has requests queued.
1940 * report random errors, to debug drivers.
1941 */
1942 limit = max(limit, periodic_bytes(dum, ep));
1943 status = -ENOSYS;
1944 break;
1945
1946 case PIPE_INTERRUPT:
1947 /* FIXME is it urb->interval since the last xfer?
1948 * this almost certainly polls too fast.
1949 */
1950 limit = max(limit, periodic_bytes(dum, ep));
1951 /* FALLTHROUGH */
1952
1953 default:
1954 treat_control_like_bulk:
1955 ep->last_io = jiffies;
1956 total -= transfer(dum_hcd, urb, ep, limit, &status);
1957 break;
1958 }
1959
1960 /* incomplete transfer? */
1961 if (status == -EINPROGRESS)
1962 continue;
1963
1964 return_urb:
1965 list_del(&urbp->urbp_list);
1966 kfree(urbp);
1967 if (ep)
1968 ep->already_seen = ep->setup_stage = 0;
1969
1970 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1971 spin_unlock(&dum->lock);
1972 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1973 spin_lock(&dum->lock);
1974
1975 goto restart;
1976 }
1977
1978 if (list_empty(&dum_hcd->urbp_list)) {
1979 usb_put_dev(dum_hcd->udev);
1980 dum_hcd->udev = NULL;
1981 } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1982 /* want a 1 msec delay here */
1983 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1984 }
1985
1986 spin_unlock_irqrestore(&dum->lock, flags);
1987 }
1988
1989 /*-------------------------------------------------------------------------*/
1990
1991 #define PORT_C_MASK \
1992 ((USB_PORT_STAT_C_CONNECTION \
1993 | USB_PORT_STAT_C_ENABLE \
1994 | USB_PORT_STAT_C_SUSPEND \
1995 | USB_PORT_STAT_C_OVERCURRENT \
1996 | USB_PORT_STAT_C_RESET) << 16)
1997
dummy_hub_status(struct usb_hcd * hcd,char * buf)1998 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1999 {
2000 struct dummy_hcd *dum_hcd;
2001 unsigned long flags;
2002 int retval = 0;
2003
2004 dum_hcd = hcd_to_dummy_hcd(hcd);
2005
2006 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2007 if (!HCD_HW_ACCESSIBLE(hcd))
2008 goto done;
2009
2010 if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
2011 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2012 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2013 set_link_state(dum_hcd);
2014 }
2015
2016 if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
2017 *buf = (1 << 1);
2018 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
2019 dum_hcd->port_status);
2020 retval = 1;
2021 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
2022 usb_hcd_resume_root_hub(hcd);
2023 }
2024 done:
2025 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2026 return retval;
2027 }
2028
2029 /* usb 3.0 root hub device descriptor */
2030 static struct {
2031 struct usb_bos_descriptor bos;
2032 struct usb_ss_cap_descriptor ss_cap;
2033 } __packed usb3_bos_desc = {
2034
2035 .bos = {
2036 .bLength = USB_DT_BOS_SIZE,
2037 .bDescriptorType = USB_DT_BOS,
2038 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
2039 .bNumDeviceCaps = 1,
2040 },
2041 .ss_cap = {
2042 .bLength = USB_DT_USB_SS_CAP_SIZE,
2043 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
2044 .bDevCapabilityType = USB_SS_CAP_TYPE,
2045 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
2046 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
2047 },
2048 };
2049
2050 static inline void
ss_hub_descriptor(struct usb_hub_descriptor * desc)2051 ss_hub_descriptor(struct usb_hub_descriptor *desc)
2052 {
2053 memset(desc, 0, sizeof *desc);
2054 desc->bDescriptorType = USB_DT_SS_HUB;
2055 desc->bDescLength = 12;
2056 desc->wHubCharacteristics = cpu_to_le16(
2057 HUB_CHAR_INDV_PORT_LPSM |
2058 HUB_CHAR_COMMON_OCPM);
2059 desc->bNbrPorts = 1;
2060 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2061 desc->u.ss.DeviceRemovable = 0;
2062 }
2063
hub_descriptor(struct usb_hub_descriptor * desc)2064 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2065 {
2066 memset(desc, 0, sizeof *desc);
2067 desc->bDescriptorType = USB_DT_HUB;
2068 desc->bDescLength = 9;
2069 desc->wHubCharacteristics = cpu_to_le16(
2070 HUB_CHAR_INDV_PORT_LPSM |
2071 HUB_CHAR_COMMON_OCPM);
2072 desc->bNbrPorts = 1;
2073 desc->u.hs.DeviceRemovable[0] = 0;
2074 desc->u.hs.DeviceRemovable[1] = 0xff; /* PortPwrCtrlMask */
2075 }
2076
dummy_hub_control(struct usb_hcd * hcd,u16 typeReq,u16 wValue,u16 wIndex,char * buf,u16 wLength)2077 static int dummy_hub_control(
2078 struct usb_hcd *hcd,
2079 u16 typeReq,
2080 u16 wValue,
2081 u16 wIndex,
2082 char *buf,
2083 u16 wLength
2084 ) {
2085 struct dummy_hcd *dum_hcd;
2086 int retval = 0;
2087 unsigned long flags;
2088
2089 if (!HCD_HW_ACCESSIBLE(hcd))
2090 return -ETIMEDOUT;
2091
2092 dum_hcd = hcd_to_dummy_hcd(hcd);
2093
2094 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2095 switch (typeReq) {
2096 case ClearHubFeature:
2097 break;
2098 case ClearPortFeature:
2099 switch (wValue) {
2100 case USB_PORT_FEAT_SUSPEND:
2101 if (hcd->speed == HCD_USB3) {
2102 dev_dbg(dummy_dev(dum_hcd),
2103 "USB_PORT_FEAT_SUSPEND req not "
2104 "supported for USB 3.0 roothub\n");
2105 goto error;
2106 }
2107 if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2108 /* 20msec resume signaling */
2109 dum_hcd->resuming = 1;
2110 dum_hcd->re_timeout = jiffies +
2111 msecs_to_jiffies(20);
2112 }
2113 break;
2114 case USB_PORT_FEAT_POWER:
2115 dev_dbg(dummy_dev(dum_hcd), "power-off\n");
2116 if (hcd->speed == HCD_USB3)
2117 dum_hcd->port_status &= ~USB_SS_PORT_STAT_POWER;
2118 else
2119 dum_hcd->port_status &= ~USB_PORT_STAT_POWER;
2120 set_link_state(dum_hcd);
2121 break;
2122 default:
2123 dum_hcd->port_status &= ~(1 << wValue);
2124 set_link_state(dum_hcd);
2125 }
2126 break;
2127 case GetHubDescriptor:
2128 if (hcd->speed == HCD_USB3 &&
2129 (wLength < USB_DT_SS_HUB_SIZE ||
2130 wValue != (USB_DT_SS_HUB << 8))) {
2131 dev_dbg(dummy_dev(dum_hcd),
2132 "Wrong hub descriptor type for "
2133 "USB 3.0 roothub.\n");
2134 goto error;
2135 }
2136 if (hcd->speed == HCD_USB3)
2137 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2138 else
2139 hub_descriptor((struct usb_hub_descriptor *) buf);
2140 break;
2141
2142 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2143 if (hcd->speed != HCD_USB3)
2144 goto error;
2145
2146 if ((wValue >> 8) != USB_DT_BOS)
2147 goto error;
2148
2149 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2150 retval = sizeof(usb3_bos_desc);
2151 break;
2152
2153 case GetHubStatus:
2154 *(__le32 *) buf = cpu_to_le32(0);
2155 break;
2156 case GetPortStatus:
2157 if (wIndex != 1)
2158 retval = -EPIPE;
2159
2160 /* whoever resets or resumes must GetPortStatus to
2161 * complete it!!
2162 */
2163 if (dum_hcd->resuming &&
2164 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2165 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2166 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2167 }
2168 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2169 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2170 dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2171 dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2172 if (dum_hcd->dum->pullup) {
2173 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2174
2175 if (hcd->speed < HCD_USB3) {
2176 switch (dum_hcd->dum->gadget.speed) {
2177 case USB_SPEED_HIGH:
2178 dum_hcd->port_status |=
2179 USB_PORT_STAT_HIGH_SPEED;
2180 break;
2181 case USB_SPEED_LOW:
2182 dum_hcd->dum->gadget.ep0->
2183 maxpacket = 8;
2184 dum_hcd->port_status |=
2185 USB_PORT_STAT_LOW_SPEED;
2186 break;
2187 default:
2188 dum_hcd->dum->gadget.speed =
2189 USB_SPEED_FULL;
2190 break;
2191 }
2192 }
2193 }
2194 }
2195 set_link_state(dum_hcd);
2196 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2197 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2198 break;
2199 case SetHubFeature:
2200 retval = -EPIPE;
2201 break;
2202 case SetPortFeature:
2203 switch (wValue) {
2204 case USB_PORT_FEAT_LINK_STATE:
2205 if (hcd->speed != HCD_USB3) {
2206 dev_dbg(dummy_dev(dum_hcd),
2207 "USB_PORT_FEAT_LINK_STATE req not "
2208 "supported for USB 2.0 roothub\n");
2209 goto error;
2210 }
2211 /*
2212 * Since this is dummy we don't have an actual link so
2213 * there is nothing to do for the SET_LINK_STATE cmd
2214 */
2215 break;
2216 case USB_PORT_FEAT_U1_TIMEOUT:
2217 case USB_PORT_FEAT_U2_TIMEOUT:
2218 /* TODO: add suspend/resume support! */
2219 if (hcd->speed != HCD_USB3) {
2220 dev_dbg(dummy_dev(dum_hcd),
2221 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2222 "supported for USB 2.0 roothub\n");
2223 goto error;
2224 }
2225 break;
2226 case USB_PORT_FEAT_SUSPEND:
2227 /* Applicable only for USB2.0 hub */
2228 if (hcd->speed == HCD_USB3) {
2229 dev_dbg(dummy_dev(dum_hcd),
2230 "USB_PORT_FEAT_SUSPEND req not "
2231 "supported for USB 3.0 roothub\n");
2232 goto error;
2233 }
2234 if (dum_hcd->active) {
2235 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2236
2237 /* HNP would happen here; for now we
2238 * assume b_bus_req is always true.
2239 */
2240 set_link_state(dum_hcd);
2241 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2242 & dum_hcd->dum->devstatus) != 0)
2243 dev_dbg(dummy_dev(dum_hcd),
2244 "no HNP yet!\n");
2245 }
2246 break;
2247 case USB_PORT_FEAT_POWER:
2248 if (hcd->speed == HCD_USB3)
2249 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2250 else
2251 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2252 set_link_state(dum_hcd);
2253 break;
2254 case USB_PORT_FEAT_BH_PORT_RESET:
2255 /* Applicable only for USB3.0 hub */
2256 if (hcd->speed != HCD_USB3) {
2257 dev_dbg(dummy_dev(dum_hcd),
2258 "USB_PORT_FEAT_BH_PORT_RESET req not "
2259 "supported for USB 2.0 roothub\n");
2260 goto error;
2261 }
2262 /* FALLS THROUGH */
2263 case USB_PORT_FEAT_RESET:
2264 /* if it's already enabled, disable */
2265 if (hcd->speed == HCD_USB3) {
2266 dum_hcd->port_status = 0;
2267 dum_hcd->port_status =
2268 (USB_SS_PORT_STAT_POWER |
2269 USB_PORT_STAT_CONNECTION |
2270 USB_PORT_STAT_RESET);
2271 } else
2272 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2273 | USB_PORT_STAT_LOW_SPEED
2274 | USB_PORT_STAT_HIGH_SPEED);
2275 /*
2276 * We want to reset device status. All but the
2277 * Self powered feature
2278 */
2279 dum_hcd->dum->devstatus &=
2280 (1 << USB_DEVICE_SELF_POWERED);
2281 /*
2282 * FIXME USB3.0: what is the correct reset signaling
2283 * interval? Is it still 50msec as for HS?
2284 */
2285 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2286 /* FALLS THROUGH */
2287 default:
2288 if (hcd->speed == HCD_USB3) {
2289 if ((dum_hcd->port_status &
2290 USB_SS_PORT_STAT_POWER) != 0) {
2291 dum_hcd->port_status |= (1 << wValue);
2292 }
2293 } else
2294 if ((dum_hcd->port_status &
2295 USB_PORT_STAT_POWER) != 0) {
2296 dum_hcd->port_status |= (1 << wValue);
2297 }
2298 set_link_state(dum_hcd);
2299 }
2300 break;
2301 case GetPortErrorCount:
2302 if (hcd->speed != HCD_USB3) {
2303 dev_dbg(dummy_dev(dum_hcd),
2304 "GetPortErrorCount req not "
2305 "supported for USB 2.0 roothub\n");
2306 goto error;
2307 }
2308 /* We'll always return 0 since this is a dummy hub */
2309 *(__le32 *) buf = cpu_to_le32(0);
2310 break;
2311 case SetHubDepth:
2312 if (hcd->speed != HCD_USB3) {
2313 dev_dbg(dummy_dev(dum_hcd),
2314 "SetHubDepth req not supported for "
2315 "USB 2.0 roothub\n");
2316 goto error;
2317 }
2318 break;
2319 default:
2320 dev_dbg(dummy_dev(dum_hcd),
2321 "hub control req%04x v%04x i%04x l%d\n",
2322 typeReq, wValue, wIndex, wLength);
2323 error:
2324 /* "protocol stall" on error */
2325 retval = -EPIPE;
2326 }
2327 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2328
2329 if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2330 usb_hcd_poll_rh_status(hcd);
2331 return retval;
2332 }
2333
dummy_bus_suspend(struct usb_hcd * hcd)2334 static int dummy_bus_suspend(struct usb_hcd *hcd)
2335 {
2336 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2337
2338 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2339
2340 spin_lock_irq(&dum_hcd->dum->lock);
2341 dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2342 set_link_state(dum_hcd);
2343 hcd->state = HC_STATE_SUSPENDED;
2344 spin_unlock_irq(&dum_hcd->dum->lock);
2345 return 0;
2346 }
2347
dummy_bus_resume(struct usb_hcd * hcd)2348 static int dummy_bus_resume(struct usb_hcd *hcd)
2349 {
2350 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2351 int rc = 0;
2352
2353 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2354
2355 spin_lock_irq(&dum_hcd->dum->lock);
2356 if (!HCD_HW_ACCESSIBLE(hcd)) {
2357 rc = -ESHUTDOWN;
2358 } else {
2359 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2360 set_link_state(dum_hcd);
2361 if (!list_empty(&dum_hcd->urbp_list))
2362 mod_timer(&dum_hcd->timer, jiffies);
2363 hcd->state = HC_STATE_RUNNING;
2364 }
2365 spin_unlock_irq(&dum_hcd->dum->lock);
2366 return rc;
2367 }
2368
2369 /*-------------------------------------------------------------------------*/
2370
show_urb(char * buf,size_t size,struct urb * urb)2371 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2372 {
2373 int ep = usb_pipeendpoint(urb->pipe);
2374
2375 return snprintf(buf, size,
2376 "urb/%p %s ep%d%s%s len %d/%d\n",
2377 urb,
2378 ({ char *s;
2379 switch (urb->dev->speed) {
2380 case USB_SPEED_LOW:
2381 s = "ls";
2382 break;
2383 case USB_SPEED_FULL:
2384 s = "fs";
2385 break;
2386 case USB_SPEED_HIGH:
2387 s = "hs";
2388 break;
2389 case USB_SPEED_SUPER:
2390 s = "ss";
2391 break;
2392 default:
2393 s = "?";
2394 break;
2395 } s; }),
2396 ep, ep ? (usb_pipein(urb->pipe) ? "in" : "out") : "",
2397 ({ char *s; \
2398 switch (usb_pipetype(urb->pipe)) { \
2399 case PIPE_CONTROL: \
2400 s = ""; \
2401 break; \
2402 case PIPE_BULK: \
2403 s = "-bulk"; \
2404 break; \
2405 case PIPE_INTERRUPT: \
2406 s = "-int"; \
2407 break; \
2408 default: \
2409 s = "-iso"; \
2410 break; \
2411 } s; }),
2412 urb->actual_length, urb->transfer_buffer_length);
2413 }
2414
urbs_show(struct device * dev,struct device_attribute * attr,char * buf)2415 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2416 char *buf)
2417 {
2418 struct usb_hcd *hcd = dev_get_drvdata(dev);
2419 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2420 struct urbp *urbp;
2421 size_t size = 0;
2422 unsigned long flags;
2423
2424 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2425 list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2426 size_t temp;
2427
2428 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2429 buf += temp;
2430 size += temp;
2431 }
2432 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2433
2434 return size;
2435 }
2436 static DEVICE_ATTR_RO(urbs);
2437
dummy_start_ss(struct dummy_hcd * dum_hcd)2438 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2439 {
2440 init_timer(&dum_hcd->timer);
2441 dum_hcd->timer.function = dummy_timer;
2442 dum_hcd->timer.data = (unsigned long)dum_hcd;
2443 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2444 dum_hcd->stream_en_ep = 0;
2445 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2446 dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET_3;
2447 dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2448 dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2449 #ifdef CONFIG_USB_OTG
2450 dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2451 #endif
2452 return 0;
2453
2454 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2455 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2456 }
2457
dummy_start(struct usb_hcd * hcd)2458 static int dummy_start(struct usb_hcd *hcd)
2459 {
2460 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2461
2462 /*
2463 * MASTER side init ... we emulate a root hub that'll only ever
2464 * talk to one device (the slave side). Also appears in sysfs,
2465 * just like more familiar pci-based HCDs.
2466 */
2467 if (!usb_hcd_is_primary_hcd(hcd))
2468 return dummy_start_ss(dum_hcd);
2469
2470 spin_lock_init(&dum_hcd->dum->lock);
2471 init_timer(&dum_hcd->timer);
2472 dum_hcd->timer.function = dummy_timer;
2473 dum_hcd->timer.data = (unsigned long)dum_hcd;
2474 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2475
2476 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2477
2478 hcd->power_budget = POWER_BUDGET;
2479 hcd->state = HC_STATE_RUNNING;
2480 hcd->uses_new_polling = 1;
2481
2482 #ifdef CONFIG_USB_OTG
2483 hcd->self.otg_port = 1;
2484 #endif
2485
2486 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2487 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2488 }
2489
dummy_stop(struct usb_hcd * hcd)2490 static void dummy_stop(struct usb_hcd *hcd)
2491 {
2492 struct dummy *dum;
2493
2494 dum = hcd_to_dummy_hcd(hcd)->dum;
2495 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2496 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2497 }
2498
2499 /*-------------------------------------------------------------------------*/
2500
dummy_h_get_frame(struct usb_hcd * hcd)2501 static int dummy_h_get_frame(struct usb_hcd *hcd)
2502 {
2503 return dummy_g_get_frame(NULL);
2504 }
2505
dummy_setup(struct usb_hcd * hcd)2506 static int dummy_setup(struct usb_hcd *hcd)
2507 {
2508 struct dummy *dum;
2509
2510 dum = *((void **)dev_get_platdata(hcd->self.controller));
2511 hcd->self.sg_tablesize = ~0;
2512 if (usb_hcd_is_primary_hcd(hcd)) {
2513 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2514 dum->hs_hcd->dum = dum;
2515 /*
2516 * Mark the first roothub as being USB 2.0.
2517 * The USB 3.0 roothub will be registered later by
2518 * dummy_hcd_probe()
2519 */
2520 hcd->speed = HCD_USB2;
2521 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2522 } else {
2523 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2524 dum->ss_hcd->dum = dum;
2525 hcd->speed = HCD_USB3;
2526 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2527 }
2528 return 0;
2529 }
2530
2531 /* Change a group of bulk endpoints to support multiple stream IDs */
dummy_alloc_streams(struct usb_hcd * hcd,struct usb_device * udev,struct usb_host_endpoint ** eps,unsigned int num_eps,unsigned int num_streams,gfp_t mem_flags)2532 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2533 struct usb_host_endpoint **eps, unsigned int num_eps,
2534 unsigned int num_streams, gfp_t mem_flags)
2535 {
2536 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2537 unsigned long flags;
2538 int max_stream;
2539 int ret_streams = num_streams;
2540 unsigned int index;
2541 unsigned int i;
2542
2543 if (!num_eps)
2544 return -EINVAL;
2545
2546 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2547 for (i = 0; i < num_eps; i++) {
2548 index = dummy_get_ep_idx(&eps[i]->desc);
2549 if ((1 << index) & dum_hcd->stream_en_ep) {
2550 ret_streams = -EINVAL;
2551 goto out;
2552 }
2553 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2554 if (!max_stream) {
2555 ret_streams = -EINVAL;
2556 goto out;
2557 }
2558 if (max_stream < ret_streams) {
2559 dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2560 "stream IDs.\n",
2561 eps[i]->desc.bEndpointAddress,
2562 max_stream);
2563 ret_streams = max_stream;
2564 }
2565 }
2566
2567 for (i = 0; i < num_eps; i++) {
2568 index = dummy_get_ep_idx(&eps[i]->desc);
2569 dum_hcd->stream_en_ep |= 1 << index;
2570 set_max_streams_for_pipe(dum_hcd,
2571 usb_endpoint_num(&eps[i]->desc), ret_streams);
2572 }
2573 out:
2574 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2575 return ret_streams;
2576 }
2577
2578 /* Reverts a group of bulk endpoints back to not using stream IDs. */
dummy_free_streams(struct usb_hcd * hcd,struct usb_device * udev,struct usb_host_endpoint ** eps,unsigned int num_eps,gfp_t mem_flags)2579 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2580 struct usb_host_endpoint **eps, unsigned int num_eps,
2581 gfp_t mem_flags)
2582 {
2583 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2584 unsigned long flags;
2585 int ret;
2586 unsigned int index;
2587 unsigned int i;
2588
2589 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2590 for (i = 0; i < num_eps; i++) {
2591 index = dummy_get_ep_idx(&eps[i]->desc);
2592 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2593 ret = -EINVAL;
2594 goto out;
2595 }
2596 }
2597
2598 for (i = 0; i < num_eps; i++) {
2599 index = dummy_get_ep_idx(&eps[i]->desc);
2600 dum_hcd->stream_en_ep &= ~(1 << index);
2601 set_max_streams_for_pipe(dum_hcd,
2602 usb_endpoint_num(&eps[i]->desc), 0);
2603 }
2604 ret = 0;
2605 out:
2606 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2607 return ret;
2608 }
2609
2610 static struct hc_driver dummy_hcd = {
2611 .description = (char *) driver_name,
2612 .product_desc = "Dummy host controller",
2613 .hcd_priv_size = sizeof(struct dummy_hcd),
2614
2615 .reset = dummy_setup,
2616 .start = dummy_start,
2617 .stop = dummy_stop,
2618
2619 .urb_enqueue = dummy_urb_enqueue,
2620 .urb_dequeue = dummy_urb_dequeue,
2621
2622 .get_frame_number = dummy_h_get_frame,
2623
2624 .hub_status_data = dummy_hub_status,
2625 .hub_control = dummy_hub_control,
2626 .bus_suspend = dummy_bus_suspend,
2627 .bus_resume = dummy_bus_resume,
2628
2629 .alloc_streams = dummy_alloc_streams,
2630 .free_streams = dummy_free_streams,
2631 };
2632
dummy_hcd_probe(struct platform_device * pdev)2633 static int dummy_hcd_probe(struct platform_device *pdev)
2634 {
2635 struct dummy *dum;
2636 struct usb_hcd *hs_hcd;
2637 struct usb_hcd *ss_hcd;
2638 int retval;
2639
2640 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2641 dum = *((void **)dev_get_platdata(&pdev->dev));
2642
2643 if (mod_data.is_super_speed)
2644 dummy_hcd.flags = HCD_USB3 | HCD_SHARED;
2645 else if (mod_data.is_high_speed)
2646 dummy_hcd.flags = HCD_USB2;
2647 else
2648 dummy_hcd.flags = HCD_USB11;
2649 hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2650 if (!hs_hcd)
2651 return -ENOMEM;
2652 hs_hcd->has_tt = 1;
2653
2654 retval = usb_add_hcd(hs_hcd, 0, 0);
2655 if (retval)
2656 goto put_usb2_hcd;
2657
2658 if (mod_data.is_super_speed) {
2659 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2660 dev_name(&pdev->dev), hs_hcd);
2661 if (!ss_hcd) {
2662 retval = -ENOMEM;
2663 goto dealloc_usb2_hcd;
2664 }
2665
2666 retval = usb_add_hcd(ss_hcd, 0, 0);
2667 if (retval)
2668 goto put_usb3_hcd;
2669 }
2670 return 0;
2671
2672 put_usb3_hcd:
2673 usb_put_hcd(ss_hcd);
2674 dealloc_usb2_hcd:
2675 usb_remove_hcd(hs_hcd);
2676 put_usb2_hcd:
2677 usb_put_hcd(hs_hcd);
2678 dum->hs_hcd = dum->ss_hcd = NULL;
2679 return retval;
2680 }
2681
dummy_hcd_remove(struct platform_device * pdev)2682 static int dummy_hcd_remove(struct platform_device *pdev)
2683 {
2684 struct dummy *dum;
2685
2686 dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2687
2688 if (dum->ss_hcd) {
2689 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2690 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2691 }
2692
2693 usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2694 usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2695
2696 dum->hs_hcd = NULL;
2697 dum->ss_hcd = NULL;
2698
2699 return 0;
2700 }
2701
dummy_hcd_suspend(struct platform_device * pdev,pm_message_t state)2702 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2703 {
2704 struct usb_hcd *hcd;
2705 struct dummy_hcd *dum_hcd;
2706 int rc = 0;
2707
2708 dev_dbg(&pdev->dev, "%s\n", __func__);
2709
2710 hcd = platform_get_drvdata(pdev);
2711 dum_hcd = hcd_to_dummy_hcd(hcd);
2712 if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2713 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2714 rc = -EBUSY;
2715 } else
2716 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2717 return rc;
2718 }
2719
dummy_hcd_resume(struct platform_device * pdev)2720 static int dummy_hcd_resume(struct platform_device *pdev)
2721 {
2722 struct usb_hcd *hcd;
2723
2724 dev_dbg(&pdev->dev, "%s\n", __func__);
2725
2726 hcd = platform_get_drvdata(pdev);
2727 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2728 usb_hcd_poll_rh_status(hcd);
2729 return 0;
2730 }
2731
2732 static struct platform_driver dummy_hcd_driver = {
2733 .probe = dummy_hcd_probe,
2734 .remove = dummy_hcd_remove,
2735 .suspend = dummy_hcd_suspend,
2736 .resume = dummy_hcd_resume,
2737 .driver = {
2738 .name = (char *) driver_name,
2739 },
2740 };
2741
2742 /*-------------------------------------------------------------------------*/
2743 #define MAX_NUM_UDC 2
2744 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2745 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2746
init(void)2747 static int __init init(void)
2748 {
2749 int retval = -ENOMEM;
2750 int i;
2751 struct dummy *dum[MAX_NUM_UDC] = {};
2752
2753 if (usb_disabled())
2754 return -ENODEV;
2755
2756 if (!mod_data.is_high_speed && mod_data.is_super_speed)
2757 return -EINVAL;
2758
2759 if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2760 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2761 MAX_NUM_UDC);
2762 return -EINVAL;
2763 }
2764
2765 for (i = 0; i < mod_data.num; i++) {
2766 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2767 if (!the_hcd_pdev[i]) {
2768 i--;
2769 while (i >= 0)
2770 platform_device_put(the_hcd_pdev[i--]);
2771 return retval;
2772 }
2773 }
2774 for (i = 0; i < mod_data.num; i++) {
2775 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2776 if (!the_udc_pdev[i]) {
2777 i--;
2778 while (i >= 0)
2779 platform_device_put(the_udc_pdev[i--]);
2780 goto err_alloc_udc;
2781 }
2782 }
2783 for (i = 0; i < mod_data.num; i++) {
2784 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2785 if (!dum[i]) {
2786 retval = -ENOMEM;
2787 goto err_add_pdata;
2788 }
2789 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2790 sizeof(void *));
2791 if (retval)
2792 goto err_add_pdata;
2793 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2794 sizeof(void *));
2795 if (retval)
2796 goto err_add_pdata;
2797 }
2798
2799 retval = platform_driver_register(&dummy_hcd_driver);
2800 if (retval < 0)
2801 goto err_add_pdata;
2802 retval = platform_driver_register(&dummy_udc_driver);
2803 if (retval < 0)
2804 goto err_register_udc_driver;
2805
2806 for (i = 0; i < mod_data.num; i++) {
2807 retval = platform_device_add(the_hcd_pdev[i]);
2808 if (retval < 0) {
2809 i--;
2810 while (i >= 0)
2811 platform_device_del(the_hcd_pdev[i--]);
2812 goto err_add_hcd;
2813 }
2814 }
2815 for (i = 0; i < mod_data.num; i++) {
2816 if (!dum[i]->hs_hcd ||
2817 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2818 /*
2819 * The hcd was added successfully but its probe
2820 * function failed for some reason.
2821 */
2822 retval = -EINVAL;
2823 goto err_add_udc;
2824 }
2825 }
2826
2827 for (i = 0; i < mod_data.num; i++) {
2828 retval = platform_device_add(the_udc_pdev[i]);
2829 if (retval < 0) {
2830 i--;
2831 while (i >= 0)
2832 platform_device_del(the_udc_pdev[i]);
2833 goto err_add_udc;
2834 }
2835 }
2836
2837 for (i = 0; i < mod_data.num; i++) {
2838 if (!platform_get_drvdata(the_udc_pdev[i])) {
2839 /*
2840 * The udc was added successfully but its probe
2841 * function failed for some reason.
2842 */
2843 retval = -EINVAL;
2844 goto err_probe_udc;
2845 }
2846 }
2847 return retval;
2848
2849 err_probe_udc:
2850 for (i = 0; i < mod_data.num; i++)
2851 platform_device_del(the_udc_pdev[i]);
2852 err_add_udc:
2853 for (i = 0; i < mod_data.num; i++)
2854 platform_device_del(the_hcd_pdev[i]);
2855 err_add_hcd:
2856 platform_driver_unregister(&dummy_udc_driver);
2857 err_register_udc_driver:
2858 platform_driver_unregister(&dummy_hcd_driver);
2859 err_add_pdata:
2860 for (i = 0; i < mod_data.num; i++)
2861 kfree(dum[i]);
2862 for (i = 0; i < mod_data.num; i++)
2863 platform_device_put(the_udc_pdev[i]);
2864 err_alloc_udc:
2865 for (i = 0; i < mod_data.num; i++)
2866 platform_device_put(the_hcd_pdev[i]);
2867 return retval;
2868 }
2869 module_init(init);
2870
cleanup(void)2871 static void __exit cleanup(void)
2872 {
2873 int i;
2874
2875 for (i = 0; i < mod_data.num; i++) {
2876 struct dummy *dum;
2877
2878 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2879
2880 platform_device_unregister(the_udc_pdev[i]);
2881 platform_device_unregister(the_hcd_pdev[i]);
2882 kfree(dum);
2883 }
2884 platform_driver_unregister(&dummy_udc_driver);
2885 platform_driver_unregister(&dummy_hcd_driver);
2886 }
2887 module_exit(cleanup);
2888