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);
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_request *req;
660
661 if (!_ep)
662 return NULL;
663
664 req = kzalloc(sizeof(*req), mem_flags);
665 if (!req)
666 return NULL;
667 INIT_LIST_HEAD(&req->queue);
668 return &req->req;
669 }
670
dummy_free_request(struct usb_ep * _ep,struct usb_request * _req)671 static void dummy_free_request(struct usb_ep *_ep, struct usb_request *_req)
672 {
673 struct dummy_request *req;
674
675 if (!_ep || !_req) {
676 WARN_ON(1);
677 return;
678 }
679
680 req = usb_request_to_dummy_request(_req);
681 WARN_ON(!list_empty(&req->queue));
682 kfree(req);
683 }
684
fifo_complete(struct usb_ep * ep,struct usb_request * req)685 static void fifo_complete(struct usb_ep *ep, struct usb_request *req)
686 {
687 }
688
dummy_queue(struct usb_ep * _ep,struct usb_request * _req,gfp_t mem_flags)689 static int dummy_queue(struct usb_ep *_ep, struct usb_request *_req,
690 gfp_t mem_flags)
691 {
692 struct dummy_ep *ep;
693 struct dummy_request *req;
694 struct dummy *dum;
695 struct dummy_hcd *dum_hcd;
696 unsigned long flags;
697
698 req = usb_request_to_dummy_request(_req);
699 if (!_req || !list_empty(&req->queue) || !_req->complete)
700 return -EINVAL;
701
702 ep = usb_ep_to_dummy_ep(_ep);
703 if (!_ep || (!ep->desc && _ep->name != ep0name))
704 return -EINVAL;
705
706 dum = ep_to_dummy(ep);
707 dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
708 if (!dum->driver || !is_enabled(dum_hcd))
709 return -ESHUTDOWN;
710
711 #if 0
712 dev_dbg(udc_dev(dum), "ep %p queue req %p to %s, len %d buf %p\n",
713 ep, _req, _ep->name, _req->length, _req->buf);
714 #endif
715 _req->status = -EINPROGRESS;
716 _req->actual = 0;
717 spin_lock_irqsave(&dum->lock, flags);
718
719 /* implement an emulated single-request FIFO */
720 if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
721 list_empty(&dum->fifo_req.queue) &&
722 list_empty(&ep->queue) &&
723 _req->length <= FIFO_SIZE) {
724 req = &dum->fifo_req;
725 req->req = *_req;
726 req->req.buf = dum->fifo_buf;
727 memcpy(dum->fifo_buf, _req->buf, _req->length);
728 req->req.context = dum;
729 req->req.complete = fifo_complete;
730
731 list_add_tail(&req->queue, &ep->queue);
732 spin_unlock(&dum->lock);
733 _req->actual = _req->length;
734 _req->status = 0;
735 usb_gadget_giveback_request(_ep, _req);
736 spin_lock(&dum->lock);
737 } else
738 list_add_tail(&req->queue, &ep->queue);
739 spin_unlock_irqrestore(&dum->lock, flags);
740
741 /* real hardware would likely enable transfers here, in case
742 * it'd been left NAKing.
743 */
744 return 0;
745 }
746
dummy_dequeue(struct usb_ep * _ep,struct usb_request * _req)747 static int dummy_dequeue(struct usb_ep *_ep, struct usb_request *_req)
748 {
749 struct dummy_ep *ep;
750 struct dummy *dum;
751 int retval = -EINVAL;
752 unsigned long flags;
753 struct dummy_request *req = NULL;
754
755 if (!_ep || !_req)
756 return retval;
757 ep = usb_ep_to_dummy_ep(_ep);
758 dum = ep_to_dummy(ep);
759
760 if (!dum->driver)
761 return -ESHUTDOWN;
762
763 local_irq_save(flags);
764 spin_lock(&dum->lock);
765 list_for_each_entry(req, &ep->queue, queue) {
766 if (&req->req == _req) {
767 list_del_init(&req->queue);
768 _req->status = -ECONNRESET;
769 retval = 0;
770 break;
771 }
772 }
773 spin_unlock(&dum->lock);
774
775 if (retval == 0) {
776 dev_dbg(udc_dev(dum),
777 "dequeued req %p from %s, len %d buf %p\n",
778 req, _ep->name, _req->length, _req->buf);
779 usb_gadget_giveback_request(_ep, _req);
780 }
781 local_irq_restore(flags);
782 return retval;
783 }
784
785 static int
dummy_set_halt_and_wedge(struct usb_ep * _ep,int value,int wedged)786 dummy_set_halt_and_wedge(struct usb_ep *_ep, int value, int wedged)
787 {
788 struct dummy_ep *ep;
789 struct dummy *dum;
790
791 if (!_ep)
792 return -EINVAL;
793 ep = usb_ep_to_dummy_ep(_ep);
794 dum = ep_to_dummy(ep);
795 if (!dum->driver)
796 return -ESHUTDOWN;
797 if (!value)
798 ep->halted = ep->wedged = 0;
799 else if (ep->desc && (ep->desc->bEndpointAddress & USB_DIR_IN) &&
800 !list_empty(&ep->queue))
801 return -EAGAIN;
802 else {
803 ep->halted = 1;
804 if (wedged)
805 ep->wedged = 1;
806 }
807 /* FIXME clear emulated data toggle too */
808 return 0;
809 }
810
811 static int
dummy_set_halt(struct usb_ep * _ep,int value)812 dummy_set_halt(struct usb_ep *_ep, int value)
813 {
814 return dummy_set_halt_and_wedge(_ep, value, 0);
815 }
816
dummy_set_wedge(struct usb_ep * _ep)817 static int dummy_set_wedge(struct usb_ep *_ep)
818 {
819 if (!_ep || _ep->name == ep0name)
820 return -EINVAL;
821 return dummy_set_halt_and_wedge(_ep, 1, 1);
822 }
823
824 static const struct usb_ep_ops dummy_ep_ops = {
825 .enable = dummy_enable,
826 .disable = dummy_disable,
827
828 .alloc_request = dummy_alloc_request,
829 .free_request = dummy_free_request,
830
831 .queue = dummy_queue,
832 .dequeue = dummy_dequeue,
833
834 .set_halt = dummy_set_halt,
835 .set_wedge = dummy_set_wedge,
836 };
837
838 /*-------------------------------------------------------------------------*/
839
840 /* there are both host and device side versions of this call ... */
dummy_g_get_frame(struct usb_gadget * _gadget)841 static int dummy_g_get_frame(struct usb_gadget *_gadget)
842 {
843 struct timespec64 ts64;
844
845 ktime_get_ts64(&ts64);
846 return ts64.tv_nsec / NSEC_PER_MSEC;
847 }
848
dummy_wakeup(struct usb_gadget * _gadget)849 static int dummy_wakeup(struct usb_gadget *_gadget)
850 {
851 struct dummy_hcd *dum_hcd;
852
853 dum_hcd = gadget_to_dummy_hcd(_gadget);
854 if (!(dum_hcd->dum->devstatus & ((1 << USB_DEVICE_B_HNP_ENABLE)
855 | (1 << USB_DEVICE_REMOTE_WAKEUP))))
856 return -EINVAL;
857 if ((dum_hcd->port_status & USB_PORT_STAT_CONNECTION) == 0)
858 return -ENOLINK;
859 if ((dum_hcd->port_status & USB_PORT_STAT_SUSPEND) == 0 &&
860 dum_hcd->rh_state != DUMMY_RH_SUSPENDED)
861 return -EIO;
862
863 /* FIXME: What if the root hub is suspended but the port isn't? */
864
865 /* hub notices our request, issues downstream resume, etc */
866 dum_hcd->resuming = 1;
867 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(20);
868 mod_timer(&dummy_hcd_to_hcd(dum_hcd)->rh_timer, dum_hcd->re_timeout);
869 return 0;
870 }
871
dummy_set_selfpowered(struct usb_gadget * _gadget,int value)872 static int dummy_set_selfpowered(struct usb_gadget *_gadget, int value)
873 {
874 struct dummy *dum;
875
876 _gadget->is_selfpowered = (value != 0);
877 dum = gadget_to_dummy_hcd(_gadget)->dum;
878 if (value)
879 dum->devstatus |= (1 << USB_DEVICE_SELF_POWERED);
880 else
881 dum->devstatus &= ~(1 << USB_DEVICE_SELF_POWERED);
882 return 0;
883 }
884
dummy_udc_update_ep0(struct dummy * dum)885 static void dummy_udc_update_ep0(struct dummy *dum)
886 {
887 if (dum->gadget.speed == USB_SPEED_SUPER)
888 dum->ep[0].ep.maxpacket = 9;
889 else
890 dum->ep[0].ep.maxpacket = 64;
891 }
892
dummy_pullup(struct usb_gadget * _gadget,int value)893 static int dummy_pullup(struct usb_gadget *_gadget, int value)
894 {
895 struct dummy_hcd *dum_hcd;
896 struct dummy *dum;
897 unsigned long flags;
898
899 dum = gadget_dev_to_dummy(&_gadget->dev);
900 dum_hcd = gadget_to_dummy_hcd(_gadget);
901
902 spin_lock_irqsave(&dum->lock, flags);
903 dum->pullup = (value != 0);
904 set_link_state(dum_hcd);
905 spin_unlock_irqrestore(&dum->lock, flags);
906
907 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
908 return 0;
909 }
910
dummy_udc_set_speed(struct usb_gadget * _gadget,enum usb_device_speed speed)911 static void dummy_udc_set_speed(struct usb_gadget *_gadget,
912 enum usb_device_speed speed)
913 {
914 struct dummy *dum;
915
916 dum = gadget_dev_to_dummy(&_gadget->dev);
917
918 if (mod_data.is_super_speed)
919 dum->gadget.speed = min_t(u8, USB_SPEED_SUPER, speed);
920 else if (mod_data.is_high_speed)
921 dum->gadget.speed = min_t(u8, USB_SPEED_HIGH, speed);
922 else
923 dum->gadget.speed = USB_SPEED_FULL;
924
925 dummy_udc_update_ep0(dum);
926
927 if (dum->gadget.speed < speed)
928 dev_dbg(udc_dev(dum), "This device can perform faster"
929 " if you connect it to a %s port...\n",
930 usb_speed_string(speed));
931 }
932
933 static int dummy_udc_start(struct usb_gadget *g,
934 struct usb_gadget_driver *driver);
935 static int dummy_udc_stop(struct usb_gadget *g);
936
937 static const struct usb_gadget_ops dummy_ops = {
938 .get_frame = dummy_g_get_frame,
939 .wakeup = dummy_wakeup,
940 .set_selfpowered = dummy_set_selfpowered,
941 .pullup = dummy_pullup,
942 .udc_start = dummy_udc_start,
943 .udc_stop = dummy_udc_stop,
944 .udc_set_speed = dummy_udc_set_speed,
945 };
946
947 /*-------------------------------------------------------------------------*/
948
949 /* "function" sysfs attribute */
function_show(struct device * dev,struct device_attribute * attr,char * buf)950 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
951 char *buf)
952 {
953 struct dummy *dum = gadget_dev_to_dummy(dev);
954
955 if (!dum->driver || !dum->driver->function)
956 return 0;
957 return scnprintf(buf, PAGE_SIZE, "%s\n", dum->driver->function);
958 }
959 static DEVICE_ATTR_RO(function);
960
961 /*-------------------------------------------------------------------------*/
962
963 /*
964 * Driver registration/unregistration.
965 *
966 * This is basically hardware-specific; there's usually only one real USB
967 * device (not host) controller since that's how USB devices are intended
968 * to work. So most implementations of these api calls will rely on the
969 * fact that only one driver will ever bind to the hardware. But curious
970 * hardware can be built with discrete components, so the gadget API doesn't
971 * require that assumption.
972 *
973 * For this emulator, it might be convenient to create a usb slave device
974 * for each driver that registers: just add to a big root hub.
975 */
976
dummy_udc_start(struct usb_gadget * g,struct usb_gadget_driver * driver)977 static int dummy_udc_start(struct usb_gadget *g,
978 struct usb_gadget_driver *driver)
979 {
980 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
981 struct dummy *dum = dum_hcd->dum;
982
983 if (driver->max_speed == USB_SPEED_UNKNOWN)
984 return -EINVAL;
985
986 /*
987 * SLAVE side init ... the layer above hardware, which
988 * can't enumerate without help from the driver we're binding.
989 */
990
991 spin_lock_irq(&dum->lock);
992 dum->devstatus = 0;
993 dum->driver = driver;
994 dum->ints_enabled = 1;
995 spin_unlock_irq(&dum->lock);
996
997 return 0;
998 }
999
dummy_udc_stop(struct usb_gadget * g)1000 static int dummy_udc_stop(struct usb_gadget *g)
1001 {
1002 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(g);
1003 struct dummy *dum = dum_hcd->dum;
1004
1005 spin_lock_irq(&dum->lock);
1006 dum->ints_enabled = 0;
1007 stop_activity(dum);
1008
1009 /* emulate synchronize_irq(): wait for callbacks to finish */
1010 while (dum->callback_usage > 0) {
1011 spin_unlock_irq(&dum->lock);
1012 usleep_range(1000, 2000);
1013 spin_lock_irq(&dum->lock);
1014 }
1015
1016 dum->driver = NULL;
1017 spin_unlock_irq(&dum->lock);
1018
1019 return 0;
1020 }
1021
1022 #undef is_enabled
1023
1024 /* The gadget structure is stored inside the hcd structure and will be
1025 * released along with it. */
init_dummy_udc_hw(struct dummy * dum)1026 static void init_dummy_udc_hw(struct dummy *dum)
1027 {
1028 int i;
1029
1030 INIT_LIST_HEAD(&dum->gadget.ep_list);
1031 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1032 struct dummy_ep *ep = &dum->ep[i];
1033
1034 if (!ep_info[i].name)
1035 break;
1036 ep->ep.name = ep_info[i].name;
1037 ep->ep.caps = ep_info[i].caps;
1038 ep->ep.ops = &dummy_ep_ops;
1039 list_add_tail(&ep->ep.ep_list, &dum->gadget.ep_list);
1040 ep->halted = ep->wedged = ep->already_seen =
1041 ep->setup_stage = 0;
1042 usb_ep_set_maxpacket_limit(&ep->ep, ~0);
1043 ep->ep.max_streams = 16;
1044 ep->last_io = jiffies;
1045 ep->gadget = &dum->gadget;
1046 ep->desc = NULL;
1047 INIT_LIST_HEAD(&ep->queue);
1048 }
1049
1050 dum->gadget.ep0 = &dum->ep[0].ep;
1051 list_del_init(&dum->ep[0].ep.ep_list);
1052 INIT_LIST_HEAD(&dum->fifo_req.queue);
1053
1054 #ifdef CONFIG_USB_OTG
1055 dum->gadget.is_otg = 1;
1056 #endif
1057 }
1058
dummy_udc_probe(struct platform_device * pdev)1059 static int dummy_udc_probe(struct platform_device *pdev)
1060 {
1061 struct dummy *dum;
1062 int rc;
1063
1064 dum = *((void **)dev_get_platdata(&pdev->dev));
1065 /* Clear usb_gadget region for new registration to udc-core */
1066 memzero_explicit(&dum->gadget, sizeof(struct usb_gadget));
1067 dum->gadget.name = gadget_name;
1068 dum->gadget.ops = &dummy_ops;
1069 if (mod_data.is_super_speed)
1070 dum->gadget.max_speed = USB_SPEED_SUPER;
1071 else if (mod_data.is_high_speed)
1072 dum->gadget.max_speed = USB_SPEED_HIGH;
1073 else
1074 dum->gadget.max_speed = USB_SPEED_FULL;
1075
1076 dum->gadget.dev.parent = &pdev->dev;
1077 init_dummy_udc_hw(dum);
1078
1079 rc = usb_add_gadget_udc(&pdev->dev, &dum->gadget);
1080 if (rc < 0)
1081 goto err_udc;
1082
1083 rc = device_create_file(&dum->gadget.dev, &dev_attr_function);
1084 if (rc < 0)
1085 goto err_dev;
1086 platform_set_drvdata(pdev, dum);
1087 return rc;
1088
1089 err_dev:
1090 usb_del_gadget_udc(&dum->gadget);
1091 err_udc:
1092 return rc;
1093 }
1094
dummy_udc_remove(struct platform_device * pdev)1095 static int dummy_udc_remove(struct platform_device *pdev)
1096 {
1097 struct dummy *dum = platform_get_drvdata(pdev);
1098
1099 device_remove_file(&dum->gadget.dev, &dev_attr_function);
1100 usb_del_gadget_udc(&dum->gadget);
1101 return 0;
1102 }
1103
dummy_udc_pm(struct dummy * dum,struct dummy_hcd * dum_hcd,int suspend)1104 static void dummy_udc_pm(struct dummy *dum, struct dummy_hcd *dum_hcd,
1105 int suspend)
1106 {
1107 spin_lock_irq(&dum->lock);
1108 dum->udc_suspended = suspend;
1109 set_link_state(dum_hcd);
1110 spin_unlock_irq(&dum->lock);
1111 }
1112
dummy_udc_suspend(struct platform_device * pdev,pm_message_t state)1113 static int dummy_udc_suspend(struct platform_device *pdev, pm_message_t state)
1114 {
1115 struct dummy *dum = platform_get_drvdata(pdev);
1116 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1117
1118 dev_dbg(&pdev->dev, "%s\n", __func__);
1119 dummy_udc_pm(dum, dum_hcd, 1);
1120 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1121 return 0;
1122 }
1123
dummy_udc_resume(struct platform_device * pdev)1124 static int dummy_udc_resume(struct platform_device *pdev)
1125 {
1126 struct dummy *dum = platform_get_drvdata(pdev);
1127 struct dummy_hcd *dum_hcd = gadget_to_dummy_hcd(&dum->gadget);
1128
1129 dev_dbg(&pdev->dev, "%s\n", __func__);
1130 dummy_udc_pm(dum, dum_hcd, 0);
1131 usb_hcd_poll_rh_status(dummy_hcd_to_hcd(dum_hcd));
1132 return 0;
1133 }
1134
1135 static struct platform_driver dummy_udc_driver = {
1136 .probe = dummy_udc_probe,
1137 .remove = dummy_udc_remove,
1138 .suspend = dummy_udc_suspend,
1139 .resume = dummy_udc_resume,
1140 .driver = {
1141 .name = (char *) gadget_name,
1142 },
1143 };
1144
1145 /*-------------------------------------------------------------------------*/
1146
dummy_get_ep_idx(const struct usb_endpoint_descriptor * desc)1147 static unsigned int dummy_get_ep_idx(const struct usb_endpoint_descriptor *desc)
1148 {
1149 unsigned int index;
1150
1151 index = usb_endpoint_num(desc) << 1;
1152 if (usb_endpoint_dir_in(desc))
1153 index |= 1;
1154 return index;
1155 }
1156
1157 /* MASTER/HOST SIDE DRIVER
1158 *
1159 * this uses the hcd framework to hook up to host side drivers.
1160 * its root hub will only have one device, otherwise it acts like
1161 * a normal host controller.
1162 *
1163 * when urbs are queued, they're just stuck on a list that we
1164 * scan in a timer callback. that callback connects writes from
1165 * the host with reads from the device, and so on, based on the
1166 * usb 2.0 rules.
1167 */
1168
dummy_ep_stream_en(struct dummy_hcd * dum_hcd,struct urb * urb)1169 static int dummy_ep_stream_en(struct dummy_hcd *dum_hcd, struct urb *urb)
1170 {
1171 const struct usb_endpoint_descriptor *desc = &urb->ep->desc;
1172 u32 index;
1173
1174 if (!usb_endpoint_xfer_bulk(desc))
1175 return 0;
1176
1177 index = dummy_get_ep_idx(desc);
1178 return (1 << index) & dum_hcd->stream_en_ep;
1179 }
1180
1181 /*
1182 * The max stream number is saved as a nibble so for the 30 possible endpoints
1183 * we only 15 bytes of memory. Therefore we are limited to max 16 streams (0
1184 * means we use only 1 stream). The maximum according to the spec is 16bit so
1185 * if the 16 stream limit is about to go, the array size should be incremented
1186 * to 30 elements of type u16.
1187 */
get_max_streams_for_pipe(struct dummy_hcd * dum_hcd,unsigned int pipe)1188 static int get_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1189 unsigned int pipe)
1190 {
1191 int max_streams;
1192
1193 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1194 if (usb_pipeout(pipe))
1195 max_streams >>= 4;
1196 else
1197 max_streams &= 0xf;
1198 max_streams++;
1199 return max_streams;
1200 }
1201
set_max_streams_for_pipe(struct dummy_hcd * dum_hcd,unsigned int pipe,unsigned int streams)1202 static void set_max_streams_for_pipe(struct dummy_hcd *dum_hcd,
1203 unsigned int pipe, unsigned int streams)
1204 {
1205 int max_streams;
1206
1207 streams--;
1208 max_streams = dum_hcd->num_stream[usb_pipeendpoint(pipe)];
1209 if (usb_pipeout(pipe)) {
1210 streams <<= 4;
1211 max_streams &= 0xf;
1212 } else {
1213 max_streams &= 0xf0;
1214 }
1215 max_streams |= streams;
1216 dum_hcd->num_stream[usb_pipeendpoint(pipe)] = max_streams;
1217 }
1218
dummy_validate_stream(struct dummy_hcd * dum_hcd,struct urb * urb)1219 static int dummy_validate_stream(struct dummy_hcd *dum_hcd, struct urb *urb)
1220 {
1221 unsigned int max_streams;
1222 int enabled;
1223
1224 enabled = dummy_ep_stream_en(dum_hcd, urb);
1225 if (!urb->stream_id) {
1226 if (enabled)
1227 return -EINVAL;
1228 return 0;
1229 }
1230 if (!enabled)
1231 return -EINVAL;
1232
1233 max_streams = get_max_streams_for_pipe(dum_hcd,
1234 usb_pipeendpoint(urb->pipe));
1235 if (urb->stream_id > max_streams) {
1236 dev_err(dummy_dev(dum_hcd), "Stream id %d is out of range.\n",
1237 urb->stream_id);
1238 BUG();
1239 return -EINVAL;
1240 }
1241 return 0;
1242 }
1243
dummy_urb_enqueue(struct usb_hcd * hcd,struct urb * urb,gfp_t mem_flags)1244 static int dummy_urb_enqueue(
1245 struct usb_hcd *hcd,
1246 struct urb *urb,
1247 gfp_t mem_flags
1248 ) {
1249 struct dummy_hcd *dum_hcd;
1250 struct urbp *urbp;
1251 unsigned long flags;
1252 int rc;
1253
1254 urbp = kmalloc(sizeof *urbp, mem_flags);
1255 if (!urbp)
1256 return -ENOMEM;
1257 urbp->urb = urb;
1258 urbp->miter_started = 0;
1259
1260 dum_hcd = hcd_to_dummy_hcd(hcd);
1261 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1262
1263 rc = dummy_validate_stream(dum_hcd, urb);
1264 if (rc) {
1265 kfree(urbp);
1266 goto done;
1267 }
1268
1269 rc = usb_hcd_link_urb_to_ep(hcd, urb);
1270 if (rc) {
1271 kfree(urbp);
1272 goto done;
1273 }
1274
1275 if (!dum_hcd->udev) {
1276 dum_hcd->udev = urb->dev;
1277 usb_get_dev(dum_hcd->udev);
1278 } else if (unlikely(dum_hcd->udev != urb->dev))
1279 dev_err(dummy_dev(dum_hcd), "usb_device address has changed!\n");
1280
1281 list_add_tail(&urbp->urbp_list, &dum_hcd->urbp_list);
1282 urb->hcpriv = urbp;
1283 if (!dum_hcd->next_frame_urbp)
1284 dum_hcd->next_frame_urbp = urbp;
1285 if (usb_pipetype(urb->pipe) == PIPE_CONTROL)
1286 urb->error_count = 1; /* mark as a new urb */
1287
1288 /* kick the scheduler, it'll do the rest */
1289 if (!timer_pending(&dum_hcd->timer))
1290 mod_timer(&dum_hcd->timer, jiffies + 1);
1291
1292 done:
1293 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1294 return rc;
1295 }
1296
dummy_urb_dequeue(struct usb_hcd * hcd,struct urb * urb,int status)1297 static int dummy_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status)
1298 {
1299 struct dummy_hcd *dum_hcd;
1300 unsigned long flags;
1301 int rc;
1302
1303 /* giveback happens automatically in timer callback,
1304 * so make sure the callback happens */
1305 dum_hcd = hcd_to_dummy_hcd(hcd);
1306 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
1307
1308 rc = usb_hcd_check_unlink_urb(hcd, urb, status);
1309 if (!rc && dum_hcd->rh_state != DUMMY_RH_RUNNING &&
1310 !list_empty(&dum_hcd->urbp_list))
1311 mod_timer(&dum_hcd->timer, jiffies);
1312
1313 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
1314 return rc;
1315 }
1316
dummy_perform_transfer(struct urb * urb,struct dummy_request * req,u32 len)1317 static int dummy_perform_transfer(struct urb *urb, struct dummy_request *req,
1318 u32 len)
1319 {
1320 void *ubuf, *rbuf;
1321 struct urbp *urbp = urb->hcpriv;
1322 int to_host;
1323 struct sg_mapping_iter *miter = &urbp->miter;
1324 u32 trans = 0;
1325 u32 this_sg;
1326 bool next_sg;
1327
1328 to_host = usb_urb_dir_in(urb);
1329 rbuf = req->req.buf + req->req.actual;
1330
1331 if (!urb->num_sgs) {
1332 ubuf = urb->transfer_buffer + urb->actual_length;
1333 if (to_host)
1334 memcpy(ubuf, rbuf, len);
1335 else
1336 memcpy(rbuf, ubuf, len);
1337 return len;
1338 }
1339
1340 if (!urbp->miter_started) {
1341 u32 flags = SG_MITER_ATOMIC;
1342
1343 if (to_host)
1344 flags |= SG_MITER_TO_SG;
1345 else
1346 flags |= SG_MITER_FROM_SG;
1347
1348 sg_miter_start(miter, urb->sg, urb->num_sgs, flags);
1349 urbp->miter_started = 1;
1350 }
1351 next_sg = sg_miter_next(miter);
1352 if (next_sg == false) {
1353 WARN_ON_ONCE(1);
1354 return -EINVAL;
1355 }
1356 do {
1357 ubuf = miter->addr;
1358 this_sg = min_t(u32, len, miter->length);
1359 miter->consumed = this_sg;
1360 trans += this_sg;
1361
1362 if (to_host)
1363 memcpy(ubuf, rbuf, this_sg);
1364 else
1365 memcpy(rbuf, ubuf, this_sg);
1366 len -= this_sg;
1367
1368 if (!len)
1369 break;
1370 next_sg = sg_miter_next(miter);
1371 if (next_sg == false) {
1372 WARN_ON_ONCE(1);
1373 return -EINVAL;
1374 }
1375
1376 rbuf += this_sg;
1377 } while (1);
1378
1379 sg_miter_stop(miter);
1380 return trans;
1381 }
1382
1383 /* 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)1384 static int transfer(struct dummy_hcd *dum_hcd, struct urb *urb,
1385 struct dummy_ep *ep, int limit, int *status)
1386 {
1387 struct dummy *dum = dum_hcd->dum;
1388 struct dummy_request *req;
1389 int sent = 0;
1390
1391 top:
1392 /* if there's no request queued, the device is NAKing; return */
1393 list_for_each_entry(req, &ep->queue, queue) {
1394 unsigned host_len, dev_len, len;
1395 int is_short, to_host;
1396 int rescan = 0;
1397
1398 if (dummy_ep_stream_en(dum_hcd, urb)) {
1399 if ((urb->stream_id != req->req.stream_id))
1400 continue;
1401 }
1402
1403 /* 1..N packets of ep->ep.maxpacket each ... the last one
1404 * may be short (including zero length).
1405 *
1406 * writer can send a zlp explicitly (length 0) or implicitly
1407 * (length mod maxpacket zero, and 'zero' flag); they always
1408 * terminate reads.
1409 */
1410 host_len = urb->transfer_buffer_length - urb->actual_length;
1411 dev_len = req->req.length - req->req.actual;
1412 len = min(host_len, dev_len);
1413
1414 /* FIXME update emulated data toggle too */
1415
1416 to_host = usb_urb_dir_in(urb);
1417 if (unlikely(len == 0))
1418 is_short = 1;
1419 else {
1420 /* not enough bandwidth left? */
1421 if (limit < ep->ep.maxpacket && limit < len)
1422 break;
1423 len = min_t(unsigned, len, limit);
1424 if (len == 0)
1425 break;
1426
1427 /* send multiple of maxpacket first, then remainder */
1428 if (len >= ep->ep.maxpacket) {
1429 is_short = 0;
1430 if (len % ep->ep.maxpacket)
1431 rescan = 1;
1432 len -= len % ep->ep.maxpacket;
1433 } else {
1434 is_short = 1;
1435 }
1436
1437 len = dummy_perform_transfer(urb, req, len);
1438
1439 ep->last_io = jiffies;
1440 if ((int)len < 0) {
1441 req->req.status = len;
1442 } else {
1443 limit -= len;
1444 sent += len;
1445 urb->actual_length += len;
1446 req->req.actual += len;
1447 }
1448 }
1449
1450 /* short packets terminate, maybe with overflow/underflow.
1451 * it's only really an error to write too much.
1452 *
1453 * partially filling a buffer optionally blocks queue advances
1454 * (so completion handlers can clean up the queue) but we don't
1455 * need to emulate such data-in-flight.
1456 */
1457 if (is_short) {
1458 if (host_len == dev_len) {
1459 req->req.status = 0;
1460 *status = 0;
1461 } else if (to_host) {
1462 req->req.status = 0;
1463 if (dev_len > host_len)
1464 *status = -EOVERFLOW;
1465 else
1466 *status = 0;
1467 } else {
1468 *status = 0;
1469 if (host_len > dev_len)
1470 req->req.status = -EOVERFLOW;
1471 else
1472 req->req.status = 0;
1473 }
1474
1475 /*
1476 * many requests terminate without a short packet.
1477 * send a zlp if demanded by flags.
1478 */
1479 } else {
1480 if (req->req.length == req->req.actual) {
1481 if (req->req.zero && to_host)
1482 rescan = 1;
1483 else
1484 req->req.status = 0;
1485 }
1486 if (urb->transfer_buffer_length == urb->actual_length) {
1487 if (urb->transfer_flags & URB_ZERO_PACKET &&
1488 !to_host)
1489 rescan = 1;
1490 else
1491 *status = 0;
1492 }
1493 }
1494
1495 /* device side completion --> continuable */
1496 if (req->req.status != -EINPROGRESS) {
1497 list_del_init(&req->queue);
1498
1499 spin_unlock(&dum->lock);
1500 usb_gadget_giveback_request(&ep->ep, &req->req);
1501 spin_lock(&dum->lock);
1502
1503 /* requests might have been unlinked... */
1504 rescan = 1;
1505 }
1506
1507 /* host side completion --> terminate */
1508 if (*status != -EINPROGRESS)
1509 break;
1510
1511 /* rescan to continue with any other queued i/o */
1512 if (rescan)
1513 goto top;
1514 }
1515 return sent;
1516 }
1517
periodic_bytes(struct dummy * dum,struct dummy_ep * ep)1518 static int periodic_bytes(struct dummy *dum, struct dummy_ep *ep)
1519 {
1520 int limit = ep->ep.maxpacket;
1521
1522 if (dum->gadget.speed == USB_SPEED_HIGH) {
1523 int tmp;
1524
1525 /* high bandwidth mode */
1526 tmp = usb_endpoint_maxp_mult(ep->desc);
1527 tmp *= 8 /* applies to entire frame */;
1528 limit += limit * tmp;
1529 }
1530 if (dum->gadget.speed == USB_SPEED_SUPER) {
1531 switch (usb_endpoint_type(ep->desc)) {
1532 case USB_ENDPOINT_XFER_ISOC:
1533 /* Sec. 4.4.8.2 USB3.0 Spec */
1534 limit = 3 * 16 * 1024 * 8;
1535 break;
1536 case USB_ENDPOINT_XFER_INT:
1537 /* Sec. 4.4.7.2 USB3.0 Spec */
1538 limit = 3 * 1024 * 8;
1539 break;
1540 case USB_ENDPOINT_XFER_BULK:
1541 default:
1542 break;
1543 }
1544 }
1545 return limit;
1546 }
1547
1548 #define is_active(dum_hcd) ((dum_hcd->port_status & \
1549 (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE | \
1550 USB_PORT_STAT_SUSPEND)) \
1551 == (USB_PORT_STAT_CONNECTION | USB_PORT_STAT_ENABLE))
1552
find_endpoint(struct dummy * dum,u8 address)1553 static struct dummy_ep *find_endpoint(struct dummy *dum, u8 address)
1554 {
1555 int i;
1556
1557 if (!is_active((dum->gadget.speed == USB_SPEED_SUPER ?
1558 dum->ss_hcd : dum->hs_hcd)))
1559 return NULL;
1560 if (!dum->ints_enabled)
1561 return NULL;
1562 if ((address & ~USB_DIR_IN) == 0)
1563 return &dum->ep[0];
1564 for (i = 1; i < DUMMY_ENDPOINTS; i++) {
1565 struct dummy_ep *ep = &dum->ep[i];
1566
1567 if (!ep->desc)
1568 continue;
1569 if (ep->desc->bEndpointAddress == address)
1570 return ep;
1571 }
1572 return NULL;
1573 }
1574
1575 #undef is_active
1576
1577 #define Dev_Request (USB_TYPE_STANDARD | USB_RECIP_DEVICE)
1578 #define Dev_InRequest (Dev_Request | USB_DIR_IN)
1579 #define Intf_Request (USB_TYPE_STANDARD | USB_RECIP_INTERFACE)
1580 #define Intf_InRequest (Intf_Request | USB_DIR_IN)
1581 #define Ep_Request (USB_TYPE_STANDARD | USB_RECIP_ENDPOINT)
1582 #define Ep_InRequest (Ep_Request | USB_DIR_IN)
1583
1584
1585 /**
1586 * handle_control_request() - handles all control transfers
1587 * @dum: pointer to dummy (the_controller)
1588 * @urb: the urb request to handle
1589 * @setup: pointer to the setup data for a USB device control
1590 * request
1591 * @status: pointer to request handling status
1592 *
1593 * Return 0 - if the request was handled
1594 * 1 - if the request wasn't handles
1595 * error code on error
1596 */
handle_control_request(struct dummy_hcd * dum_hcd,struct urb * urb,struct usb_ctrlrequest * setup,int * status)1597 static int handle_control_request(struct dummy_hcd *dum_hcd, struct urb *urb,
1598 struct usb_ctrlrequest *setup,
1599 int *status)
1600 {
1601 struct dummy_ep *ep2;
1602 struct dummy *dum = dum_hcd->dum;
1603 int ret_val = 1;
1604 unsigned w_index;
1605 unsigned w_value;
1606
1607 w_index = le16_to_cpu(setup->wIndex);
1608 w_value = le16_to_cpu(setup->wValue);
1609 switch (setup->bRequest) {
1610 case USB_REQ_SET_ADDRESS:
1611 if (setup->bRequestType != Dev_Request)
1612 break;
1613 dum->address = w_value;
1614 *status = 0;
1615 dev_dbg(udc_dev(dum), "set_address = %d\n",
1616 w_value);
1617 ret_val = 0;
1618 break;
1619 case USB_REQ_SET_FEATURE:
1620 if (setup->bRequestType == Dev_Request) {
1621 ret_val = 0;
1622 switch (w_value) {
1623 case USB_DEVICE_REMOTE_WAKEUP:
1624 break;
1625 case USB_DEVICE_B_HNP_ENABLE:
1626 dum->gadget.b_hnp_enable = 1;
1627 break;
1628 case USB_DEVICE_A_HNP_SUPPORT:
1629 dum->gadget.a_hnp_support = 1;
1630 break;
1631 case USB_DEVICE_A_ALT_HNP_SUPPORT:
1632 dum->gadget.a_alt_hnp_support = 1;
1633 break;
1634 case USB_DEVICE_U1_ENABLE:
1635 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1636 HCD_USB3)
1637 w_value = USB_DEV_STAT_U1_ENABLED;
1638 else
1639 ret_val = -EOPNOTSUPP;
1640 break;
1641 case USB_DEVICE_U2_ENABLE:
1642 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1643 HCD_USB3)
1644 w_value = USB_DEV_STAT_U2_ENABLED;
1645 else
1646 ret_val = -EOPNOTSUPP;
1647 break;
1648 case USB_DEVICE_LTM_ENABLE:
1649 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1650 HCD_USB3)
1651 w_value = USB_DEV_STAT_LTM_ENABLED;
1652 else
1653 ret_val = -EOPNOTSUPP;
1654 break;
1655 default:
1656 ret_val = -EOPNOTSUPP;
1657 }
1658 if (ret_val == 0) {
1659 dum->devstatus |= (1 << w_value);
1660 *status = 0;
1661 }
1662 } else if (setup->bRequestType == Ep_Request) {
1663 /* endpoint halt */
1664 ep2 = find_endpoint(dum, w_index);
1665 if (!ep2 || ep2->ep.name == ep0name) {
1666 ret_val = -EOPNOTSUPP;
1667 break;
1668 }
1669 ep2->halted = 1;
1670 ret_val = 0;
1671 *status = 0;
1672 }
1673 break;
1674 case USB_REQ_CLEAR_FEATURE:
1675 if (setup->bRequestType == Dev_Request) {
1676 ret_val = 0;
1677 switch (w_value) {
1678 case USB_DEVICE_REMOTE_WAKEUP:
1679 w_value = USB_DEVICE_REMOTE_WAKEUP;
1680 break;
1681 case USB_DEVICE_U1_ENABLE:
1682 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1683 HCD_USB3)
1684 w_value = USB_DEV_STAT_U1_ENABLED;
1685 else
1686 ret_val = -EOPNOTSUPP;
1687 break;
1688 case USB_DEVICE_U2_ENABLE:
1689 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1690 HCD_USB3)
1691 w_value = USB_DEV_STAT_U2_ENABLED;
1692 else
1693 ret_val = -EOPNOTSUPP;
1694 break;
1695 case USB_DEVICE_LTM_ENABLE:
1696 if (dummy_hcd_to_hcd(dum_hcd)->speed ==
1697 HCD_USB3)
1698 w_value = USB_DEV_STAT_LTM_ENABLED;
1699 else
1700 ret_val = -EOPNOTSUPP;
1701 break;
1702 default:
1703 ret_val = -EOPNOTSUPP;
1704 break;
1705 }
1706 if (ret_val == 0) {
1707 dum->devstatus &= ~(1 << w_value);
1708 *status = 0;
1709 }
1710 } else if (setup->bRequestType == Ep_Request) {
1711 /* endpoint halt */
1712 ep2 = find_endpoint(dum, w_index);
1713 if (!ep2) {
1714 ret_val = -EOPNOTSUPP;
1715 break;
1716 }
1717 if (!ep2->wedged)
1718 ep2->halted = 0;
1719 ret_val = 0;
1720 *status = 0;
1721 }
1722 break;
1723 case USB_REQ_GET_STATUS:
1724 if (setup->bRequestType == Dev_InRequest
1725 || setup->bRequestType == Intf_InRequest
1726 || setup->bRequestType == Ep_InRequest) {
1727 char *buf;
1728 /*
1729 * device: remote wakeup, selfpowered
1730 * interface: nothing
1731 * endpoint: halt
1732 */
1733 buf = (char *)urb->transfer_buffer;
1734 if (urb->transfer_buffer_length > 0) {
1735 if (setup->bRequestType == Ep_InRequest) {
1736 ep2 = find_endpoint(dum, w_index);
1737 if (!ep2) {
1738 ret_val = -EOPNOTSUPP;
1739 break;
1740 }
1741 buf[0] = ep2->halted;
1742 } else if (setup->bRequestType ==
1743 Dev_InRequest) {
1744 buf[0] = (u8)dum->devstatus;
1745 } else
1746 buf[0] = 0;
1747 }
1748 if (urb->transfer_buffer_length > 1)
1749 buf[1] = 0;
1750 urb->actual_length = min_t(u32, 2,
1751 urb->transfer_buffer_length);
1752 ret_val = 0;
1753 *status = 0;
1754 }
1755 break;
1756 }
1757 return ret_val;
1758 }
1759
1760 /* drive both sides of the transfers; looks like irq handlers to
1761 * both drivers except the callbacks aren't in_irq().
1762 */
dummy_timer(unsigned long _dum_hcd)1763 static void dummy_timer(unsigned long _dum_hcd)
1764 {
1765 struct dummy_hcd *dum_hcd = (struct dummy_hcd *) _dum_hcd;
1766 struct dummy *dum = dum_hcd->dum;
1767 struct urbp *urbp, *tmp;
1768 unsigned long flags;
1769 int limit, total;
1770 int i;
1771
1772 /* simplistic model for one frame's bandwidth */
1773 switch (dum->gadget.speed) {
1774 case USB_SPEED_LOW:
1775 total = 8/*bytes*/ * 12/*packets*/;
1776 break;
1777 case USB_SPEED_FULL:
1778 total = 64/*bytes*/ * 19/*packets*/;
1779 break;
1780 case USB_SPEED_HIGH:
1781 total = 512/*bytes*/ * 13/*packets*/ * 8/*uframes*/;
1782 break;
1783 case USB_SPEED_SUPER:
1784 /* Bus speed is 500000 bytes/ms, so use a little less */
1785 total = 490000;
1786 break;
1787 default:
1788 dev_err(dummy_dev(dum_hcd), "bogus device speed\n");
1789 return;
1790 }
1791
1792 /* FIXME if HZ != 1000 this will probably misbehave ... */
1793
1794 /* look at each urb queued by the host side driver */
1795 spin_lock_irqsave(&dum->lock, flags);
1796
1797 if (!dum_hcd->udev) {
1798 dev_err(dummy_dev(dum_hcd),
1799 "timer fired with no URBs pending?\n");
1800 spin_unlock_irqrestore(&dum->lock, flags);
1801 return;
1802 }
1803 dum_hcd->next_frame_urbp = NULL;
1804
1805 for (i = 0; i < DUMMY_ENDPOINTS; i++) {
1806 if (!ep_info[i].name)
1807 break;
1808 dum->ep[i].already_seen = 0;
1809 }
1810
1811 restart:
1812 list_for_each_entry_safe(urbp, tmp, &dum_hcd->urbp_list, urbp_list) {
1813 struct urb *urb;
1814 struct dummy_request *req;
1815 u8 address;
1816 struct dummy_ep *ep = NULL;
1817 int type;
1818 int status = -EINPROGRESS;
1819
1820 /* stop when we reach URBs queued after the timer interrupt */
1821 if (urbp == dum_hcd->next_frame_urbp)
1822 break;
1823
1824 urb = urbp->urb;
1825 if (urb->unlinked)
1826 goto return_urb;
1827 else if (dum_hcd->rh_state != DUMMY_RH_RUNNING)
1828 continue;
1829 type = usb_pipetype(urb->pipe);
1830
1831 /* used up this frame's non-periodic bandwidth?
1832 * FIXME there's infinite bandwidth for control and
1833 * periodic transfers ... unrealistic.
1834 */
1835 if (total <= 0 && type == PIPE_BULK)
1836 continue;
1837
1838 /* find the gadget's ep for this request (if configured) */
1839 address = usb_pipeendpoint (urb->pipe);
1840 if (usb_urb_dir_in(urb))
1841 address |= USB_DIR_IN;
1842 ep = find_endpoint(dum, address);
1843 if (!ep) {
1844 /* set_configuration() disagreement */
1845 dev_dbg(dummy_dev(dum_hcd),
1846 "no ep configured for urb %p\n",
1847 urb);
1848 status = -EPROTO;
1849 goto return_urb;
1850 }
1851
1852 if (ep->already_seen)
1853 continue;
1854 ep->already_seen = 1;
1855 if (ep == &dum->ep[0] && urb->error_count) {
1856 ep->setup_stage = 1; /* a new urb */
1857 urb->error_count = 0;
1858 }
1859 if (ep->halted && !ep->setup_stage) {
1860 /* NOTE: must not be iso! */
1861 dev_dbg(dummy_dev(dum_hcd), "ep %s halted, urb %p\n",
1862 ep->ep.name, urb);
1863 status = -EPIPE;
1864 goto return_urb;
1865 }
1866 /* FIXME make sure both ends agree on maxpacket */
1867
1868 /* handle control requests */
1869 if (ep == &dum->ep[0] && ep->setup_stage) {
1870 struct usb_ctrlrequest setup;
1871 int value = 1;
1872
1873 setup = *(struct usb_ctrlrequest *) urb->setup_packet;
1874 /* paranoia, in case of stale queued data */
1875 list_for_each_entry(req, &ep->queue, queue) {
1876 list_del_init(&req->queue);
1877 req->req.status = -EOVERFLOW;
1878 dev_dbg(udc_dev(dum), "stale req = %p\n",
1879 req);
1880
1881 spin_unlock(&dum->lock);
1882 usb_gadget_giveback_request(&ep->ep, &req->req);
1883 spin_lock(&dum->lock);
1884 ep->already_seen = 0;
1885 goto restart;
1886 }
1887
1888 /* gadget driver never sees set_address or operations
1889 * on standard feature flags. some hardware doesn't
1890 * even expose them.
1891 */
1892 ep->last_io = jiffies;
1893 ep->setup_stage = 0;
1894 ep->halted = 0;
1895
1896 value = handle_control_request(dum_hcd, urb, &setup,
1897 &status);
1898
1899 /* gadget driver handles all other requests. block
1900 * until setup() returns; no reentrancy issues etc.
1901 */
1902 if (value > 0) {
1903 ++dum->callback_usage;
1904 spin_unlock(&dum->lock);
1905 value = dum->driver->setup(&dum->gadget,
1906 &setup);
1907 spin_lock(&dum->lock);
1908 --dum->callback_usage;
1909
1910 if (value >= 0) {
1911 /* no delays (max 64KB data stage) */
1912 limit = 64*1024;
1913 goto treat_control_like_bulk;
1914 }
1915 /* error, see below */
1916 }
1917
1918 if (value < 0) {
1919 if (value != -EOPNOTSUPP)
1920 dev_dbg(udc_dev(dum),
1921 "setup --> %d\n",
1922 value);
1923 status = -EPIPE;
1924 urb->actual_length = 0;
1925 }
1926
1927 goto return_urb;
1928 }
1929
1930 /* non-control requests */
1931 limit = total;
1932 switch (usb_pipetype(urb->pipe)) {
1933 case PIPE_ISOCHRONOUS:
1934 /* FIXME is it urb->interval since the last xfer?
1935 * use urb->iso_frame_desc[i].
1936 * complete whether or not ep has requests queued.
1937 * report random errors, to debug drivers.
1938 */
1939 limit = max(limit, periodic_bytes(dum, ep));
1940 status = -ENOSYS;
1941 break;
1942
1943 case PIPE_INTERRUPT:
1944 /* FIXME is it urb->interval since the last xfer?
1945 * this almost certainly polls too fast.
1946 */
1947 limit = max(limit, periodic_bytes(dum, ep));
1948 /* FALLTHROUGH */
1949
1950 default:
1951 treat_control_like_bulk:
1952 ep->last_io = jiffies;
1953 total -= transfer(dum_hcd, urb, ep, limit, &status);
1954 break;
1955 }
1956
1957 /* incomplete transfer? */
1958 if (status == -EINPROGRESS)
1959 continue;
1960
1961 return_urb:
1962 list_del(&urbp->urbp_list);
1963 kfree(urbp);
1964 if (ep)
1965 ep->already_seen = ep->setup_stage = 0;
1966
1967 usb_hcd_unlink_urb_from_ep(dummy_hcd_to_hcd(dum_hcd), urb);
1968 spin_unlock(&dum->lock);
1969 usb_hcd_giveback_urb(dummy_hcd_to_hcd(dum_hcd), urb, status);
1970 spin_lock(&dum->lock);
1971
1972 goto restart;
1973 }
1974
1975 if (list_empty(&dum_hcd->urbp_list)) {
1976 usb_put_dev(dum_hcd->udev);
1977 dum_hcd->udev = NULL;
1978 } else if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
1979 /* want a 1 msec delay here */
1980 mod_timer(&dum_hcd->timer, jiffies + msecs_to_jiffies(1));
1981 }
1982
1983 spin_unlock_irqrestore(&dum->lock, flags);
1984 }
1985
1986 /*-------------------------------------------------------------------------*/
1987
1988 #define PORT_C_MASK \
1989 ((USB_PORT_STAT_C_CONNECTION \
1990 | USB_PORT_STAT_C_ENABLE \
1991 | USB_PORT_STAT_C_SUSPEND \
1992 | USB_PORT_STAT_C_OVERCURRENT \
1993 | USB_PORT_STAT_C_RESET) << 16)
1994
dummy_hub_status(struct usb_hcd * hcd,char * buf)1995 static int dummy_hub_status(struct usb_hcd *hcd, char *buf)
1996 {
1997 struct dummy_hcd *dum_hcd;
1998 unsigned long flags;
1999 int retval = 0;
2000
2001 dum_hcd = hcd_to_dummy_hcd(hcd);
2002
2003 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2004 if (!HCD_HW_ACCESSIBLE(hcd))
2005 goto done;
2006
2007 if (dum_hcd->resuming && time_after_eq(jiffies, dum_hcd->re_timeout)) {
2008 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2009 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2010 set_link_state(dum_hcd);
2011 }
2012
2013 if ((dum_hcd->port_status & PORT_C_MASK) != 0) {
2014 *buf = (1 << 1);
2015 dev_dbg(dummy_dev(dum_hcd), "port status 0x%08x has changes\n",
2016 dum_hcd->port_status);
2017 retval = 1;
2018 if (dum_hcd->rh_state == DUMMY_RH_SUSPENDED)
2019 usb_hcd_resume_root_hub(hcd);
2020 }
2021 done:
2022 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2023 return retval;
2024 }
2025
2026 /* usb 3.0 root hub device descriptor */
2027 static struct {
2028 struct usb_bos_descriptor bos;
2029 struct usb_ss_cap_descriptor ss_cap;
2030 } __packed usb3_bos_desc = {
2031
2032 .bos = {
2033 .bLength = USB_DT_BOS_SIZE,
2034 .bDescriptorType = USB_DT_BOS,
2035 .wTotalLength = cpu_to_le16(sizeof(usb3_bos_desc)),
2036 .bNumDeviceCaps = 1,
2037 },
2038 .ss_cap = {
2039 .bLength = USB_DT_USB_SS_CAP_SIZE,
2040 .bDescriptorType = USB_DT_DEVICE_CAPABILITY,
2041 .bDevCapabilityType = USB_SS_CAP_TYPE,
2042 .wSpeedSupported = cpu_to_le16(USB_5GBPS_OPERATION),
2043 .bFunctionalitySupport = ilog2(USB_5GBPS_OPERATION),
2044 },
2045 };
2046
2047 static inline void
ss_hub_descriptor(struct usb_hub_descriptor * desc)2048 ss_hub_descriptor(struct usb_hub_descriptor *desc)
2049 {
2050 memset(desc, 0, sizeof *desc);
2051 desc->bDescriptorType = USB_DT_SS_HUB;
2052 desc->bDescLength = 12;
2053 desc->wHubCharacteristics = cpu_to_le16(
2054 HUB_CHAR_INDV_PORT_LPSM |
2055 HUB_CHAR_COMMON_OCPM);
2056 desc->bNbrPorts = 1;
2057 desc->u.ss.bHubHdrDecLat = 0x04; /* Worst case: 0.4 micro sec*/
2058 desc->u.ss.DeviceRemovable = 0;
2059 }
2060
hub_descriptor(struct usb_hub_descriptor * desc)2061 static inline void hub_descriptor(struct usb_hub_descriptor *desc)
2062 {
2063 memset(desc, 0, sizeof *desc);
2064 desc->bDescriptorType = USB_DT_HUB;
2065 desc->bDescLength = 9;
2066 desc->wHubCharacteristics = cpu_to_le16(
2067 HUB_CHAR_INDV_PORT_LPSM |
2068 HUB_CHAR_COMMON_OCPM);
2069 desc->bNbrPorts = 1;
2070 desc->u.hs.DeviceRemovable[0] = 0;
2071 desc->u.hs.DeviceRemovable[1] = 0xff; /* PortPwrCtrlMask */
2072 }
2073
dummy_hub_control(struct usb_hcd * hcd,u16 typeReq,u16 wValue,u16 wIndex,char * buf,u16 wLength)2074 static int dummy_hub_control(
2075 struct usb_hcd *hcd,
2076 u16 typeReq,
2077 u16 wValue,
2078 u16 wIndex,
2079 char *buf,
2080 u16 wLength
2081 ) {
2082 struct dummy_hcd *dum_hcd;
2083 int retval = 0;
2084 unsigned long flags;
2085
2086 if (!HCD_HW_ACCESSIBLE(hcd))
2087 return -ETIMEDOUT;
2088
2089 dum_hcd = hcd_to_dummy_hcd(hcd);
2090
2091 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2092 switch (typeReq) {
2093 case ClearHubFeature:
2094 break;
2095 case ClearPortFeature:
2096 switch (wValue) {
2097 case USB_PORT_FEAT_SUSPEND:
2098 if (hcd->speed == HCD_USB3) {
2099 dev_dbg(dummy_dev(dum_hcd),
2100 "USB_PORT_FEAT_SUSPEND req not "
2101 "supported for USB 3.0 roothub\n");
2102 goto error;
2103 }
2104 if (dum_hcd->port_status & USB_PORT_STAT_SUSPEND) {
2105 /* 20msec resume signaling */
2106 dum_hcd->resuming = 1;
2107 dum_hcd->re_timeout = jiffies +
2108 msecs_to_jiffies(20);
2109 }
2110 break;
2111 case USB_PORT_FEAT_POWER:
2112 dev_dbg(dummy_dev(dum_hcd), "power-off\n");
2113 if (hcd->speed == HCD_USB3)
2114 dum_hcd->port_status &= ~USB_SS_PORT_STAT_POWER;
2115 else
2116 dum_hcd->port_status &= ~USB_PORT_STAT_POWER;
2117 set_link_state(dum_hcd);
2118 break;
2119 default:
2120 dum_hcd->port_status &= ~(1 << wValue);
2121 set_link_state(dum_hcd);
2122 }
2123 break;
2124 case GetHubDescriptor:
2125 if (hcd->speed == HCD_USB3 &&
2126 (wLength < USB_DT_SS_HUB_SIZE ||
2127 wValue != (USB_DT_SS_HUB << 8))) {
2128 dev_dbg(dummy_dev(dum_hcd),
2129 "Wrong hub descriptor type for "
2130 "USB 3.0 roothub.\n");
2131 goto error;
2132 }
2133 if (hcd->speed == HCD_USB3)
2134 ss_hub_descriptor((struct usb_hub_descriptor *) buf);
2135 else
2136 hub_descriptor((struct usb_hub_descriptor *) buf);
2137 break;
2138
2139 case DeviceRequest | USB_REQ_GET_DESCRIPTOR:
2140 if (hcd->speed != HCD_USB3)
2141 goto error;
2142
2143 if ((wValue >> 8) != USB_DT_BOS)
2144 goto error;
2145
2146 memcpy(buf, &usb3_bos_desc, sizeof(usb3_bos_desc));
2147 retval = sizeof(usb3_bos_desc);
2148 break;
2149
2150 case GetHubStatus:
2151 *(__le32 *) buf = cpu_to_le32(0);
2152 break;
2153 case GetPortStatus:
2154 if (wIndex != 1)
2155 retval = -EPIPE;
2156
2157 /* whoever resets or resumes must GetPortStatus to
2158 * complete it!!
2159 */
2160 if (dum_hcd->resuming &&
2161 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2162 dum_hcd->port_status |= (USB_PORT_STAT_C_SUSPEND << 16);
2163 dum_hcd->port_status &= ~USB_PORT_STAT_SUSPEND;
2164 }
2165 if ((dum_hcd->port_status & USB_PORT_STAT_RESET) != 0 &&
2166 time_after_eq(jiffies, dum_hcd->re_timeout)) {
2167 dum_hcd->port_status |= (USB_PORT_STAT_C_RESET << 16);
2168 dum_hcd->port_status &= ~USB_PORT_STAT_RESET;
2169 if (dum_hcd->dum->pullup) {
2170 dum_hcd->port_status |= USB_PORT_STAT_ENABLE;
2171
2172 if (hcd->speed < HCD_USB3) {
2173 switch (dum_hcd->dum->gadget.speed) {
2174 case USB_SPEED_HIGH:
2175 dum_hcd->port_status |=
2176 USB_PORT_STAT_HIGH_SPEED;
2177 break;
2178 case USB_SPEED_LOW:
2179 dum_hcd->dum->gadget.ep0->
2180 maxpacket = 8;
2181 dum_hcd->port_status |=
2182 USB_PORT_STAT_LOW_SPEED;
2183 break;
2184 default:
2185 dum_hcd->dum->gadget.speed =
2186 USB_SPEED_FULL;
2187 break;
2188 }
2189 }
2190 }
2191 }
2192 set_link_state(dum_hcd);
2193 ((__le16 *) buf)[0] = cpu_to_le16(dum_hcd->port_status);
2194 ((__le16 *) buf)[1] = cpu_to_le16(dum_hcd->port_status >> 16);
2195 break;
2196 case SetHubFeature:
2197 retval = -EPIPE;
2198 break;
2199 case SetPortFeature:
2200 switch (wValue) {
2201 case USB_PORT_FEAT_LINK_STATE:
2202 if (hcd->speed != HCD_USB3) {
2203 dev_dbg(dummy_dev(dum_hcd),
2204 "USB_PORT_FEAT_LINK_STATE req not "
2205 "supported for USB 2.0 roothub\n");
2206 goto error;
2207 }
2208 /*
2209 * Since this is dummy we don't have an actual link so
2210 * there is nothing to do for the SET_LINK_STATE cmd
2211 */
2212 break;
2213 case USB_PORT_FEAT_U1_TIMEOUT:
2214 case USB_PORT_FEAT_U2_TIMEOUT:
2215 /* TODO: add suspend/resume support! */
2216 if (hcd->speed != HCD_USB3) {
2217 dev_dbg(dummy_dev(dum_hcd),
2218 "USB_PORT_FEAT_U1/2_TIMEOUT req not "
2219 "supported for USB 2.0 roothub\n");
2220 goto error;
2221 }
2222 break;
2223 case USB_PORT_FEAT_SUSPEND:
2224 /* Applicable only for USB2.0 hub */
2225 if (hcd->speed == HCD_USB3) {
2226 dev_dbg(dummy_dev(dum_hcd),
2227 "USB_PORT_FEAT_SUSPEND req not "
2228 "supported for USB 3.0 roothub\n");
2229 goto error;
2230 }
2231 if (dum_hcd->active) {
2232 dum_hcd->port_status |= USB_PORT_STAT_SUSPEND;
2233
2234 /* HNP would happen here; for now we
2235 * assume b_bus_req is always true.
2236 */
2237 set_link_state(dum_hcd);
2238 if (((1 << USB_DEVICE_B_HNP_ENABLE)
2239 & dum_hcd->dum->devstatus) != 0)
2240 dev_dbg(dummy_dev(dum_hcd),
2241 "no HNP yet!\n");
2242 }
2243 break;
2244 case USB_PORT_FEAT_POWER:
2245 if (hcd->speed == HCD_USB3)
2246 dum_hcd->port_status |= USB_SS_PORT_STAT_POWER;
2247 else
2248 dum_hcd->port_status |= USB_PORT_STAT_POWER;
2249 set_link_state(dum_hcd);
2250 break;
2251 case USB_PORT_FEAT_BH_PORT_RESET:
2252 /* Applicable only for USB3.0 hub */
2253 if (hcd->speed != HCD_USB3) {
2254 dev_dbg(dummy_dev(dum_hcd),
2255 "USB_PORT_FEAT_BH_PORT_RESET req not "
2256 "supported for USB 2.0 roothub\n");
2257 goto error;
2258 }
2259 /* FALLS THROUGH */
2260 case USB_PORT_FEAT_RESET:
2261 /* if it's already enabled, disable */
2262 if (hcd->speed == HCD_USB3) {
2263 dum_hcd->port_status = 0;
2264 dum_hcd->port_status =
2265 (USB_SS_PORT_STAT_POWER |
2266 USB_PORT_STAT_CONNECTION |
2267 USB_PORT_STAT_RESET);
2268 } else
2269 dum_hcd->port_status &= ~(USB_PORT_STAT_ENABLE
2270 | USB_PORT_STAT_LOW_SPEED
2271 | USB_PORT_STAT_HIGH_SPEED);
2272 /*
2273 * We want to reset device status. All but the
2274 * Self powered feature
2275 */
2276 dum_hcd->dum->devstatus &=
2277 (1 << USB_DEVICE_SELF_POWERED);
2278 /*
2279 * FIXME USB3.0: what is the correct reset signaling
2280 * interval? Is it still 50msec as for HS?
2281 */
2282 dum_hcd->re_timeout = jiffies + msecs_to_jiffies(50);
2283 /* FALLS THROUGH */
2284 default:
2285 if (hcd->speed == HCD_USB3) {
2286 if ((dum_hcd->port_status &
2287 USB_SS_PORT_STAT_POWER) != 0) {
2288 dum_hcd->port_status |= (1 << wValue);
2289 }
2290 } else
2291 if ((dum_hcd->port_status &
2292 USB_PORT_STAT_POWER) != 0) {
2293 dum_hcd->port_status |= (1 << wValue);
2294 }
2295 set_link_state(dum_hcd);
2296 }
2297 break;
2298 case GetPortErrorCount:
2299 if (hcd->speed != HCD_USB3) {
2300 dev_dbg(dummy_dev(dum_hcd),
2301 "GetPortErrorCount req not "
2302 "supported for USB 2.0 roothub\n");
2303 goto error;
2304 }
2305 /* We'll always return 0 since this is a dummy hub */
2306 *(__le32 *) buf = cpu_to_le32(0);
2307 break;
2308 case SetHubDepth:
2309 if (hcd->speed != HCD_USB3) {
2310 dev_dbg(dummy_dev(dum_hcd),
2311 "SetHubDepth req not supported for "
2312 "USB 2.0 roothub\n");
2313 goto error;
2314 }
2315 break;
2316 default:
2317 dev_dbg(dummy_dev(dum_hcd),
2318 "hub control req%04x v%04x i%04x l%d\n",
2319 typeReq, wValue, wIndex, wLength);
2320 error:
2321 /* "protocol stall" on error */
2322 retval = -EPIPE;
2323 }
2324 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2325
2326 if ((dum_hcd->port_status & PORT_C_MASK) != 0)
2327 usb_hcd_poll_rh_status(hcd);
2328 return retval;
2329 }
2330
dummy_bus_suspend(struct usb_hcd * hcd)2331 static int dummy_bus_suspend(struct usb_hcd *hcd)
2332 {
2333 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2334
2335 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2336
2337 spin_lock_irq(&dum_hcd->dum->lock);
2338 dum_hcd->rh_state = DUMMY_RH_SUSPENDED;
2339 set_link_state(dum_hcd);
2340 hcd->state = HC_STATE_SUSPENDED;
2341 spin_unlock_irq(&dum_hcd->dum->lock);
2342 return 0;
2343 }
2344
dummy_bus_resume(struct usb_hcd * hcd)2345 static int dummy_bus_resume(struct usb_hcd *hcd)
2346 {
2347 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2348 int rc = 0;
2349
2350 dev_dbg(&hcd->self.root_hub->dev, "%s\n", __func__);
2351
2352 spin_lock_irq(&dum_hcd->dum->lock);
2353 if (!HCD_HW_ACCESSIBLE(hcd)) {
2354 rc = -ESHUTDOWN;
2355 } else {
2356 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2357 set_link_state(dum_hcd);
2358 if (!list_empty(&dum_hcd->urbp_list))
2359 mod_timer(&dum_hcd->timer, jiffies);
2360 hcd->state = HC_STATE_RUNNING;
2361 }
2362 spin_unlock_irq(&dum_hcd->dum->lock);
2363 return rc;
2364 }
2365
2366 /*-------------------------------------------------------------------------*/
2367
show_urb(char * buf,size_t size,struct urb * urb)2368 static inline ssize_t show_urb(char *buf, size_t size, struct urb *urb)
2369 {
2370 int ep = usb_pipeendpoint(urb->pipe);
2371
2372 return snprintf(buf, size,
2373 "urb/%p %s ep%d%s%s len %d/%d\n",
2374 urb,
2375 ({ char *s;
2376 switch (urb->dev->speed) {
2377 case USB_SPEED_LOW:
2378 s = "ls";
2379 break;
2380 case USB_SPEED_FULL:
2381 s = "fs";
2382 break;
2383 case USB_SPEED_HIGH:
2384 s = "hs";
2385 break;
2386 case USB_SPEED_SUPER:
2387 s = "ss";
2388 break;
2389 default:
2390 s = "?";
2391 break;
2392 } s; }),
2393 ep, ep ? (usb_urb_dir_in(urb) ? "in" : "out") : "",
2394 ({ char *s; \
2395 switch (usb_pipetype(urb->pipe)) { \
2396 case PIPE_CONTROL: \
2397 s = ""; \
2398 break; \
2399 case PIPE_BULK: \
2400 s = "-bulk"; \
2401 break; \
2402 case PIPE_INTERRUPT: \
2403 s = "-int"; \
2404 break; \
2405 default: \
2406 s = "-iso"; \
2407 break; \
2408 } s; }),
2409 urb->actual_length, urb->transfer_buffer_length);
2410 }
2411
urbs_show(struct device * dev,struct device_attribute * attr,char * buf)2412 static ssize_t urbs_show(struct device *dev, struct device_attribute *attr,
2413 char *buf)
2414 {
2415 struct usb_hcd *hcd = dev_get_drvdata(dev);
2416 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2417 struct urbp *urbp;
2418 size_t size = 0;
2419 unsigned long flags;
2420
2421 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2422 list_for_each_entry(urbp, &dum_hcd->urbp_list, urbp_list) {
2423 size_t temp;
2424
2425 temp = show_urb(buf, PAGE_SIZE - size, urbp->urb);
2426 buf += temp;
2427 size += temp;
2428 }
2429 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2430
2431 return size;
2432 }
2433 static DEVICE_ATTR_RO(urbs);
2434
dummy_start_ss(struct dummy_hcd * dum_hcd)2435 static int dummy_start_ss(struct dummy_hcd *dum_hcd)
2436 {
2437 init_timer(&dum_hcd->timer);
2438 dum_hcd->timer.function = dummy_timer;
2439 dum_hcd->timer.data = (unsigned long)dum_hcd;
2440 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2441 dum_hcd->stream_en_ep = 0;
2442 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2443 dummy_hcd_to_hcd(dum_hcd)->power_budget = POWER_BUDGET_3;
2444 dummy_hcd_to_hcd(dum_hcd)->state = HC_STATE_RUNNING;
2445 dummy_hcd_to_hcd(dum_hcd)->uses_new_polling = 1;
2446 #ifdef CONFIG_USB_OTG
2447 dummy_hcd_to_hcd(dum_hcd)->self.otg_port = 1;
2448 #endif
2449 return 0;
2450
2451 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2452 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2453 }
2454
dummy_start(struct usb_hcd * hcd)2455 static int dummy_start(struct usb_hcd *hcd)
2456 {
2457 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2458
2459 /*
2460 * MASTER side init ... we emulate a root hub that'll only ever
2461 * talk to one device (the slave side). Also appears in sysfs,
2462 * just like more familiar pci-based HCDs.
2463 */
2464 if (!usb_hcd_is_primary_hcd(hcd))
2465 return dummy_start_ss(dum_hcd);
2466
2467 spin_lock_init(&dum_hcd->dum->lock);
2468 init_timer(&dum_hcd->timer);
2469 dum_hcd->timer.function = dummy_timer;
2470 dum_hcd->timer.data = (unsigned long)dum_hcd;
2471 dum_hcd->rh_state = DUMMY_RH_RUNNING;
2472
2473 INIT_LIST_HEAD(&dum_hcd->urbp_list);
2474
2475 hcd->power_budget = POWER_BUDGET;
2476 hcd->state = HC_STATE_RUNNING;
2477 hcd->uses_new_polling = 1;
2478
2479 #ifdef CONFIG_USB_OTG
2480 hcd->self.otg_port = 1;
2481 #endif
2482
2483 /* FIXME 'urbs' should be a per-device thing, maybe in usbcore */
2484 return device_create_file(dummy_dev(dum_hcd), &dev_attr_urbs);
2485 }
2486
dummy_stop(struct usb_hcd * hcd)2487 static void dummy_stop(struct usb_hcd *hcd)
2488 {
2489 device_remove_file(dummy_dev(hcd_to_dummy_hcd(hcd)), &dev_attr_urbs);
2490 dev_info(dummy_dev(hcd_to_dummy_hcd(hcd)), "stopped\n");
2491 }
2492
2493 /*-------------------------------------------------------------------------*/
2494
dummy_h_get_frame(struct usb_hcd * hcd)2495 static int dummy_h_get_frame(struct usb_hcd *hcd)
2496 {
2497 return dummy_g_get_frame(NULL);
2498 }
2499
dummy_setup(struct usb_hcd * hcd)2500 static int dummy_setup(struct usb_hcd *hcd)
2501 {
2502 struct dummy *dum;
2503
2504 dum = *((void **)dev_get_platdata(hcd->self.controller));
2505 hcd->self.sg_tablesize = ~0;
2506 if (usb_hcd_is_primary_hcd(hcd)) {
2507 dum->hs_hcd = hcd_to_dummy_hcd(hcd);
2508 dum->hs_hcd->dum = dum;
2509 /*
2510 * Mark the first roothub as being USB 2.0.
2511 * The USB 3.0 roothub will be registered later by
2512 * dummy_hcd_probe()
2513 */
2514 hcd->speed = HCD_USB2;
2515 hcd->self.root_hub->speed = USB_SPEED_HIGH;
2516 } else {
2517 dum->ss_hcd = hcd_to_dummy_hcd(hcd);
2518 dum->ss_hcd->dum = dum;
2519 hcd->speed = HCD_USB3;
2520 hcd->self.root_hub->speed = USB_SPEED_SUPER;
2521 }
2522 return 0;
2523 }
2524
2525 /* 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)2526 static int dummy_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
2527 struct usb_host_endpoint **eps, unsigned int num_eps,
2528 unsigned int num_streams, gfp_t mem_flags)
2529 {
2530 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2531 unsigned long flags;
2532 int max_stream;
2533 int ret_streams = num_streams;
2534 unsigned int index;
2535 unsigned int i;
2536
2537 if (!num_eps)
2538 return -EINVAL;
2539
2540 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2541 for (i = 0; i < num_eps; i++) {
2542 index = dummy_get_ep_idx(&eps[i]->desc);
2543 if ((1 << index) & dum_hcd->stream_en_ep) {
2544 ret_streams = -EINVAL;
2545 goto out;
2546 }
2547 max_stream = usb_ss_max_streams(&eps[i]->ss_ep_comp);
2548 if (!max_stream) {
2549 ret_streams = -EINVAL;
2550 goto out;
2551 }
2552 if (max_stream < ret_streams) {
2553 dev_dbg(dummy_dev(dum_hcd), "Ep 0x%x only supports %u "
2554 "stream IDs.\n",
2555 eps[i]->desc.bEndpointAddress,
2556 max_stream);
2557 ret_streams = max_stream;
2558 }
2559 }
2560
2561 for (i = 0; i < num_eps; i++) {
2562 index = dummy_get_ep_idx(&eps[i]->desc);
2563 dum_hcd->stream_en_ep |= 1 << index;
2564 set_max_streams_for_pipe(dum_hcd,
2565 usb_endpoint_num(&eps[i]->desc), ret_streams);
2566 }
2567 out:
2568 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2569 return ret_streams;
2570 }
2571
2572 /* 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)2573 static int dummy_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
2574 struct usb_host_endpoint **eps, unsigned int num_eps,
2575 gfp_t mem_flags)
2576 {
2577 struct dummy_hcd *dum_hcd = hcd_to_dummy_hcd(hcd);
2578 unsigned long flags;
2579 int ret;
2580 unsigned int index;
2581 unsigned int i;
2582
2583 spin_lock_irqsave(&dum_hcd->dum->lock, flags);
2584 for (i = 0; i < num_eps; i++) {
2585 index = dummy_get_ep_idx(&eps[i]->desc);
2586 if (!((1 << index) & dum_hcd->stream_en_ep)) {
2587 ret = -EINVAL;
2588 goto out;
2589 }
2590 }
2591
2592 for (i = 0; i < num_eps; i++) {
2593 index = dummy_get_ep_idx(&eps[i]->desc);
2594 dum_hcd->stream_en_ep &= ~(1 << index);
2595 set_max_streams_for_pipe(dum_hcd,
2596 usb_endpoint_num(&eps[i]->desc), 0);
2597 }
2598 ret = 0;
2599 out:
2600 spin_unlock_irqrestore(&dum_hcd->dum->lock, flags);
2601 return ret;
2602 }
2603
2604 static struct hc_driver dummy_hcd = {
2605 .description = (char *) driver_name,
2606 .product_desc = "Dummy host controller",
2607 .hcd_priv_size = sizeof(struct dummy_hcd),
2608
2609 .reset = dummy_setup,
2610 .start = dummy_start,
2611 .stop = dummy_stop,
2612
2613 .urb_enqueue = dummy_urb_enqueue,
2614 .urb_dequeue = dummy_urb_dequeue,
2615
2616 .get_frame_number = dummy_h_get_frame,
2617
2618 .hub_status_data = dummy_hub_status,
2619 .hub_control = dummy_hub_control,
2620 .bus_suspend = dummy_bus_suspend,
2621 .bus_resume = dummy_bus_resume,
2622
2623 .alloc_streams = dummy_alloc_streams,
2624 .free_streams = dummy_free_streams,
2625 };
2626
dummy_hcd_probe(struct platform_device * pdev)2627 static int dummy_hcd_probe(struct platform_device *pdev)
2628 {
2629 struct dummy *dum;
2630 struct usb_hcd *hs_hcd;
2631 struct usb_hcd *ss_hcd;
2632 int retval;
2633
2634 dev_info(&pdev->dev, "%s, driver " DRIVER_VERSION "\n", driver_desc);
2635 dum = *((void **)dev_get_platdata(&pdev->dev));
2636
2637 if (mod_data.is_super_speed)
2638 dummy_hcd.flags = HCD_USB3 | HCD_SHARED;
2639 else if (mod_data.is_high_speed)
2640 dummy_hcd.flags = HCD_USB2;
2641 else
2642 dummy_hcd.flags = HCD_USB11;
2643 hs_hcd = usb_create_hcd(&dummy_hcd, &pdev->dev, dev_name(&pdev->dev));
2644 if (!hs_hcd)
2645 return -ENOMEM;
2646 hs_hcd->has_tt = 1;
2647
2648 retval = usb_add_hcd(hs_hcd, 0, 0);
2649 if (retval)
2650 goto put_usb2_hcd;
2651
2652 if (mod_data.is_super_speed) {
2653 ss_hcd = usb_create_shared_hcd(&dummy_hcd, &pdev->dev,
2654 dev_name(&pdev->dev), hs_hcd);
2655 if (!ss_hcd) {
2656 retval = -ENOMEM;
2657 goto dealloc_usb2_hcd;
2658 }
2659
2660 retval = usb_add_hcd(ss_hcd, 0, 0);
2661 if (retval)
2662 goto put_usb3_hcd;
2663 }
2664 return 0;
2665
2666 put_usb3_hcd:
2667 usb_put_hcd(ss_hcd);
2668 dealloc_usb2_hcd:
2669 usb_remove_hcd(hs_hcd);
2670 put_usb2_hcd:
2671 usb_put_hcd(hs_hcd);
2672 dum->hs_hcd = dum->ss_hcd = NULL;
2673 return retval;
2674 }
2675
dummy_hcd_remove(struct platform_device * pdev)2676 static int dummy_hcd_remove(struct platform_device *pdev)
2677 {
2678 struct dummy *dum;
2679
2680 dum = hcd_to_dummy_hcd(platform_get_drvdata(pdev))->dum;
2681
2682 if (dum->ss_hcd) {
2683 usb_remove_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2684 usb_put_hcd(dummy_hcd_to_hcd(dum->ss_hcd));
2685 }
2686
2687 usb_remove_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2688 usb_put_hcd(dummy_hcd_to_hcd(dum->hs_hcd));
2689
2690 dum->hs_hcd = NULL;
2691 dum->ss_hcd = NULL;
2692
2693 return 0;
2694 }
2695
dummy_hcd_suspend(struct platform_device * pdev,pm_message_t state)2696 static int dummy_hcd_suspend(struct platform_device *pdev, pm_message_t state)
2697 {
2698 struct usb_hcd *hcd;
2699 struct dummy_hcd *dum_hcd;
2700 int rc = 0;
2701
2702 dev_dbg(&pdev->dev, "%s\n", __func__);
2703
2704 hcd = platform_get_drvdata(pdev);
2705 dum_hcd = hcd_to_dummy_hcd(hcd);
2706 if (dum_hcd->rh_state == DUMMY_RH_RUNNING) {
2707 dev_warn(&pdev->dev, "Root hub isn't suspended!\n");
2708 rc = -EBUSY;
2709 } else
2710 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2711 return rc;
2712 }
2713
dummy_hcd_resume(struct platform_device * pdev)2714 static int dummy_hcd_resume(struct platform_device *pdev)
2715 {
2716 struct usb_hcd *hcd;
2717
2718 dev_dbg(&pdev->dev, "%s\n", __func__);
2719
2720 hcd = platform_get_drvdata(pdev);
2721 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
2722 usb_hcd_poll_rh_status(hcd);
2723 return 0;
2724 }
2725
2726 static struct platform_driver dummy_hcd_driver = {
2727 .probe = dummy_hcd_probe,
2728 .remove = dummy_hcd_remove,
2729 .suspend = dummy_hcd_suspend,
2730 .resume = dummy_hcd_resume,
2731 .driver = {
2732 .name = (char *) driver_name,
2733 },
2734 };
2735
2736 /*-------------------------------------------------------------------------*/
2737 #define MAX_NUM_UDC 32
2738 static struct platform_device *the_udc_pdev[MAX_NUM_UDC];
2739 static struct platform_device *the_hcd_pdev[MAX_NUM_UDC];
2740
init(void)2741 static int __init init(void)
2742 {
2743 int retval = -ENOMEM;
2744 int i;
2745 struct dummy *dum[MAX_NUM_UDC];
2746
2747 if (usb_disabled())
2748 return -ENODEV;
2749
2750 if (!mod_data.is_high_speed && mod_data.is_super_speed)
2751 return -EINVAL;
2752
2753 if (mod_data.num < 1 || mod_data.num > MAX_NUM_UDC) {
2754 pr_err("Number of emulated UDC must be in range of 1...%d\n",
2755 MAX_NUM_UDC);
2756 return -EINVAL;
2757 }
2758
2759 for (i = 0; i < mod_data.num; i++) {
2760 the_hcd_pdev[i] = platform_device_alloc(driver_name, i);
2761 if (!the_hcd_pdev[i]) {
2762 i--;
2763 while (i >= 0)
2764 platform_device_put(the_hcd_pdev[i--]);
2765 return retval;
2766 }
2767 }
2768 for (i = 0; i < mod_data.num; i++) {
2769 the_udc_pdev[i] = platform_device_alloc(gadget_name, i);
2770 if (!the_udc_pdev[i]) {
2771 i--;
2772 while (i >= 0)
2773 platform_device_put(the_udc_pdev[i--]);
2774 goto err_alloc_udc;
2775 }
2776 }
2777 for (i = 0; i < mod_data.num; i++) {
2778 dum[i] = kzalloc(sizeof(struct dummy), GFP_KERNEL);
2779 if (!dum[i]) {
2780 retval = -ENOMEM;
2781 goto err_add_pdata;
2782 }
2783 retval = platform_device_add_data(the_hcd_pdev[i], &dum[i],
2784 sizeof(void *));
2785 if (retval)
2786 goto err_add_pdata;
2787 retval = platform_device_add_data(the_udc_pdev[i], &dum[i],
2788 sizeof(void *));
2789 if (retval)
2790 goto err_add_pdata;
2791 }
2792
2793 retval = platform_driver_register(&dummy_hcd_driver);
2794 if (retval < 0)
2795 goto err_add_pdata;
2796 retval = platform_driver_register(&dummy_udc_driver);
2797 if (retval < 0)
2798 goto err_register_udc_driver;
2799
2800 for (i = 0; i < mod_data.num; i++) {
2801 retval = platform_device_add(the_hcd_pdev[i]);
2802 if (retval < 0) {
2803 i--;
2804 while (i >= 0)
2805 platform_device_del(the_hcd_pdev[i--]);
2806 goto err_add_hcd;
2807 }
2808 }
2809 for (i = 0; i < mod_data.num; i++) {
2810 if (!dum[i]->hs_hcd ||
2811 (!dum[i]->ss_hcd && mod_data.is_super_speed)) {
2812 /*
2813 * The hcd was added successfully but its probe
2814 * function failed for some reason.
2815 */
2816 retval = -EINVAL;
2817 goto err_add_udc;
2818 }
2819 }
2820
2821 for (i = 0; i < mod_data.num; i++) {
2822 retval = platform_device_add(the_udc_pdev[i]);
2823 if (retval < 0) {
2824 i--;
2825 while (i >= 0)
2826 platform_device_del(the_udc_pdev[i--]);
2827 goto err_add_udc;
2828 }
2829 }
2830
2831 for (i = 0; i < mod_data.num; i++) {
2832 if (!platform_get_drvdata(the_udc_pdev[i])) {
2833 /*
2834 * The udc was added successfully but its probe
2835 * function failed for some reason.
2836 */
2837 retval = -EINVAL;
2838 goto err_probe_udc;
2839 }
2840 }
2841 return retval;
2842
2843 err_probe_udc:
2844 for (i = 0; i < mod_data.num; i++)
2845 platform_device_del(the_udc_pdev[i]);
2846 err_add_udc:
2847 for (i = 0; i < mod_data.num; i++)
2848 platform_device_del(the_hcd_pdev[i]);
2849 err_add_hcd:
2850 platform_driver_unregister(&dummy_udc_driver);
2851 err_register_udc_driver:
2852 platform_driver_unregister(&dummy_hcd_driver);
2853 err_add_pdata:
2854 for (i = 0; i < mod_data.num; i++)
2855 kfree(dum[i]);
2856 for (i = 0; i < mod_data.num; i++)
2857 platform_device_put(the_udc_pdev[i]);
2858 err_alloc_udc:
2859 for (i = 0; i < mod_data.num; i++)
2860 platform_device_put(the_hcd_pdev[i]);
2861 return retval;
2862 }
2863 module_init(init);
2864
cleanup(void)2865 static void __exit cleanup(void)
2866 {
2867 int i;
2868
2869 for (i = 0; i < mod_data.num; i++) {
2870 struct dummy *dum;
2871
2872 dum = *((void **)dev_get_platdata(&the_udc_pdev[i]->dev));
2873
2874 platform_device_unregister(the_udc_pdev[i]);
2875 platform_device_unregister(the_hcd_pdev[i]);
2876 kfree(dum);
2877 }
2878 platform_driver_unregister(&dummy_udc_driver);
2879 platform_driver_unregister(&dummy_hcd_driver);
2880 }
2881 module_exit(cleanup);
2882