xref: /qemu/hw/usb/core.c (revision a552a966f16b7b39c5df16fc17e12d02c4fa5954)
1 /*
2  * QEMU USB emulation
3  *
4  * Copyright (c) 2005 Fabrice Bellard
5  *
6  * 2008 Generic packet handler rewrite by Max Krasnyansky
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 #include "qemu-common.h"
27 #include "hw/usb.h"
28 #include "iov.h"
29 #include "trace.h"
30 
31 void usb_attach(USBPort *port)
32 {
33     USBDevice *dev = port->dev;
34 
35     assert(dev != NULL);
36     assert(dev->attached);
37     assert(dev->state == USB_STATE_NOTATTACHED);
38     port->ops->attach(port);
39     dev->state = USB_STATE_ATTACHED;
40     usb_device_handle_attach(dev);
41 }
42 
43 void usb_detach(USBPort *port)
44 {
45     USBDevice *dev = port->dev;
46 
47     assert(dev != NULL);
48     assert(dev->state != USB_STATE_NOTATTACHED);
49     port->ops->detach(port);
50     dev->state = USB_STATE_NOTATTACHED;
51 }
52 
53 void usb_port_reset(USBPort *port)
54 {
55     USBDevice *dev = port->dev;
56 
57     assert(dev != NULL);
58     usb_detach(port);
59     usb_attach(port);
60     usb_device_reset(dev);
61 }
62 
63 void usb_device_reset(USBDevice *dev)
64 {
65     if (dev == NULL || !dev->attached) {
66         return;
67     }
68     dev->remote_wakeup = 0;
69     dev->addr = 0;
70     dev->state = USB_STATE_DEFAULT;
71     usb_device_handle_reset(dev);
72 }
73 
74 void usb_wakeup(USBEndpoint *ep)
75 {
76     USBDevice *dev = ep->dev;
77     USBBus *bus = usb_bus_from_device(dev);
78 
79     if (dev->remote_wakeup && dev->port && dev->port->ops->wakeup) {
80         dev->port->ops->wakeup(dev->port);
81     }
82     if (bus->ops->wakeup_endpoint) {
83         bus->ops->wakeup_endpoint(bus, ep);
84     }
85 }
86 
87 /**********************/
88 
89 /* generic USB device helpers (you are not forced to use them when
90    writing your USB device driver, but they help handling the
91    protocol)
92 */
93 
94 #define SETUP_STATE_IDLE  0
95 #define SETUP_STATE_SETUP 1
96 #define SETUP_STATE_DATA  2
97 #define SETUP_STATE_ACK   3
98 #define SETUP_STATE_PARAM 4
99 
100 static int do_token_setup(USBDevice *s, USBPacket *p)
101 {
102     int request, value, index;
103     int ret = 0;
104 
105     if (p->iov.size != 8) {
106         return USB_RET_STALL;
107     }
108 
109     usb_packet_copy(p, s->setup_buf, p->iov.size);
110     p->result = 0;
111     s->setup_len   = (s->setup_buf[7] << 8) | s->setup_buf[6];
112     s->setup_index = 0;
113 
114     request = (s->setup_buf[0] << 8) | s->setup_buf[1];
115     value   = (s->setup_buf[3] << 8) | s->setup_buf[2];
116     index   = (s->setup_buf[5] << 8) | s->setup_buf[4];
117 
118     if (s->setup_buf[0] & USB_DIR_IN) {
119         ret = usb_device_handle_control(s, p, request, value, index,
120                                         s->setup_len, s->data_buf);
121         if (ret == USB_RET_ASYNC) {
122              s->setup_state = SETUP_STATE_SETUP;
123              return USB_RET_ASYNC;
124         }
125         if (ret < 0)
126             return ret;
127 
128         if (ret < s->setup_len)
129             s->setup_len = ret;
130         s->setup_state = SETUP_STATE_DATA;
131     } else {
132         if (s->setup_len > sizeof(s->data_buf)) {
133             fprintf(stderr,
134                 "usb_generic_handle_packet: ctrl buffer too small (%d > %zu)\n",
135                 s->setup_len, sizeof(s->data_buf));
136             return USB_RET_STALL;
137         }
138         if (s->setup_len == 0)
139             s->setup_state = SETUP_STATE_ACK;
140         else
141             s->setup_state = SETUP_STATE_DATA;
142     }
143 
144     return ret;
145 }
146 
147 static int do_token_in(USBDevice *s, USBPacket *p)
148 {
149     int request, value, index;
150     int ret = 0;
151 
152     assert(p->ep->nr == 0);
153 
154     request = (s->setup_buf[0] << 8) | s->setup_buf[1];
155     value   = (s->setup_buf[3] << 8) | s->setup_buf[2];
156     index   = (s->setup_buf[5] << 8) | s->setup_buf[4];
157 
158     switch(s->setup_state) {
159     case SETUP_STATE_ACK:
160         if (!(s->setup_buf[0] & USB_DIR_IN)) {
161             ret = usb_device_handle_control(s, p, request, value, index,
162                                             s->setup_len, s->data_buf);
163             if (ret == USB_RET_ASYNC) {
164                 return USB_RET_ASYNC;
165             }
166             s->setup_state = SETUP_STATE_IDLE;
167             if (ret > 0)
168                 return 0;
169             return ret;
170         }
171 
172         /* return 0 byte */
173         return 0;
174 
175     case SETUP_STATE_DATA:
176         if (s->setup_buf[0] & USB_DIR_IN) {
177             int len = s->setup_len - s->setup_index;
178             if (len > p->iov.size) {
179                 len = p->iov.size;
180             }
181             usb_packet_copy(p, s->data_buf + s->setup_index, len);
182             s->setup_index += len;
183             if (s->setup_index >= s->setup_len)
184                 s->setup_state = SETUP_STATE_ACK;
185             return len;
186         }
187 
188         s->setup_state = SETUP_STATE_IDLE;
189         return USB_RET_STALL;
190 
191     default:
192         return USB_RET_STALL;
193     }
194 }
195 
196 static int do_token_out(USBDevice *s, USBPacket *p)
197 {
198     assert(p->ep->nr == 0);
199 
200     switch(s->setup_state) {
201     case SETUP_STATE_ACK:
202         if (s->setup_buf[0] & USB_DIR_IN) {
203             s->setup_state = SETUP_STATE_IDLE;
204             /* transfer OK */
205         } else {
206             /* ignore additional output */
207         }
208         return 0;
209 
210     case SETUP_STATE_DATA:
211         if (!(s->setup_buf[0] & USB_DIR_IN)) {
212             int len = s->setup_len - s->setup_index;
213             if (len > p->iov.size) {
214                 len = p->iov.size;
215             }
216             usb_packet_copy(p, s->data_buf + s->setup_index, len);
217             s->setup_index += len;
218             if (s->setup_index >= s->setup_len)
219                 s->setup_state = SETUP_STATE_ACK;
220             return len;
221         }
222 
223         s->setup_state = SETUP_STATE_IDLE;
224         return USB_RET_STALL;
225 
226     default:
227         return USB_RET_STALL;
228     }
229 }
230 
231 static int do_parameter(USBDevice *s, USBPacket *p)
232 {
233     int request, value, index;
234     int i, ret = 0;
235 
236     for (i = 0; i < 8; i++) {
237         s->setup_buf[i] = p->parameter >> (i*8);
238     }
239 
240     s->setup_state = SETUP_STATE_PARAM;
241     s->setup_len   = (s->setup_buf[7] << 8) | s->setup_buf[6];
242     s->setup_index = 0;
243 
244     request = (s->setup_buf[0] << 8) | s->setup_buf[1];
245     value   = (s->setup_buf[3] << 8) | s->setup_buf[2];
246     index   = (s->setup_buf[5] << 8) | s->setup_buf[4];
247 
248     if (s->setup_len > sizeof(s->data_buf)) {
249         fprintf(stderr,
250                 "usb_generic_handle_packet: ctrl buffer too small (%d > %zu)\n",
251                 s->setup_len, sizeof(s->data_buf));
252         return USB_RET_STALL;
253     }
254 
255     if (p->pid == USB_TOKEN_OUT) {
256         usb_packet_copy(p, s->data_buf, s->setup_len);
257     }
258 
259     ret = usb_device_handle_control(s, p, request, value, index,
260                                     s->setup_len, s->data_buf);
261     if (ret < 0) {
262         return ret;
263     }
264 
265     if (ret < s->setup_len) {
266         s->setup_len = ret;
267     }
268     if (p->pid == USB_TOKEN_IN) {
269         usb_packet_copy(p, s->data_buf, s->setup_len);
270     }
271 
272     return ret;
273 }
274 
275 /* ctrl complete function for devices which use usb_generic_handle_packet and
276    may return USB_RET_ASYNC from their handle_control callback. Device code
277    which does this *must* call this function instead of the normal
278    usb_packet_complete to complete their async control packets. */
279 void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p)
280 {
281     if (p->result < 0) {
282         s->setup_state = SETUP_STATE_IDLE;
283     }
284 
285     switch (s->setup_state) {
286     case SETUP_STATE_SETUP:
287         if (p->result < s->setup_len) {
288             s->setup_len = p->result;
289         }
290         s->setup_state = SETUP_STATE_DATA;
291         p->result = 8;
292         break;
293 
294     case SETUP_STATE_ACK:
295         s->setup_state = SETUP_STATE_IDLE;
296         p->result = 0;
297         break;
298 
299     case SETUP_STATE_PARAM:
300         if (p->result < s->setup_len) {
301             s->setup_len = p->result;
302         }
303         if (p->pid == USB_TOKEN_IN) {
304             p->result = 0;
305             usb_packet_copy(p, s->data_buf, s->setup_len);
306         }
307         break;
308 
309     default:
310         break;
311     }
312     usb_packet_complete(s, p);
313 }
314 
315 /* XXX: fix overflow */
316 int set_usb_string(uint8_t *buf, const char *str)
317 {
318     int len, i;
319     uint8_t *q;
320 
321     q = buf;
322     len = strlen(str);
323     *q++ = 2 * len + 2;
324     *q++ = 3;
325     for(i = 0; i < len; i++) {
326         *q++ = str[i];
327         *q++ = 0;
328     }
329     return q - buf;
330 }
331 
332 USBDevice *usb_find_device(USBPort *port, uint8_t addr)
333 {
334     USBDevice *dev = port->dev;
335 
336     if (dev == NULL || !dev->attached || dev->state != USB_STATE_DEFAULT) {
337         return NULL;
338     }
339     if (dev->addr == addr) {
340         return dev;
341     }
342     return usb_device_find_device(dev, addr);
343 }
344 
345 static int usb_process_one(USBPacket *p)
346 {
347     USBDevice *dev = p->ep->dev;
348 
349     if (p->ep->nr == 0) {
350         /* control pipe */
351         if (p->parameter) {
352             return do_parameter(dev, p);
353         }
354         switch (p->pid) {
355         case USB_TOKEN_SETUP:
356             return do_token_setup(dev, p);
357         case USB_TOKEN_IN:
358             return do_token_in(dev, p);
359         case USB_TOKEN_OUT:
360             return do_token_out(dev, p);
361         default:
362             return USB_RET_STALL;
363         }
364     } else {
365         /* data pipe */
366         return usb_device_handle_data(dev, p);
367     }
368 }
369 
370 /* Hand over a packet to a device for processing.  Return value
371    USB_RET_ASYNC indicates the processing isn't finished yet, the
372    driver will call usb_packet_complete() when done processing it. */
373 int usb_handle_packet(USBDevice *dev, USBPacket *p)
374 {
375     int ret;
376 
377     if (dev == NULL) {
378         return USB_RET_NODEV;
379     }
380     assert(dev == p->ep->dev);
381     assert(dev->state == USB_STATE_DEFAULT);
382     usb_packet_check_state(p, USB_PACKET_SETUP);
383     assert(p->ep != NULL);
384 
385     /* Submitting a new packet clears halt */
386     if (p->ep->halted) {
387         assert(QTAILQ_EMPTY(&p->ep->queue));
388         p->ep->halted = false;
389     }
390 
391     if (QTAILQ_EMPTY(&p->ep->queue) || p->ep->pipeline) {
392         ret = usb_process_one(p);
393         if (ret == USB_RET_ASYNC) {
394             assert(p->ep->type != USB_ENDPOINT_XFER_ISOC);
395             usb_packet_set_state(p, USB_PACKET_ASYNC);
396             QTAILQ_INSERT_TAIL(&p->ep->queue, p, queue);
397         } else if (ret == USB_RET_ADD_TO_QUEUE) {
398             usb_packet_set_state(p, USB_PACKET_QUEUED);
399             QTAILQ_INSERT_TAIL(&p->ep->queue, p, queue);
400             ret = USB_RET_ASYNC;
401         } else {
402             /*
403              * When pipelining is enabled usb-devices must always return async,
404              * otherwise packets can complete out of order!
405              */
406             assert(!p->ep->pipeline || QTAILQ_EMPTY(&p->ep->queue));
407             if (ret != USB_RET_NAK) {
408                 p->result = ret;
409                 usb_packet_set_state(p, USB_PACKET_COMPLETE);
410             }
411         }
412     } else {
413         ret = USB_RET_ASYNC;
414         usb_packet_set_state(p, USB_PACKET_QUEUED);
415         QTAILQ_INSERT_TAIL(&p->ep->queue, p, queue);
416     }
417     return ret;
418 }
419 
420 void usb_packet_complete_one(USBDevice *dev, USBPacket *p)
421 {
422     USBEndpoint *ep = p->ep;
423 
424     assert(QTAILQ_FIRST(&ep->queue) == p);
425     assert(p->result != USB_RET_ASYNC && p->result != USB_RET_NAK);
426 
427     if (p->result < 0 || (p->short_not_ok && (p->result < p->iov.size))) {
428         ep->halted = true;
429     }
430     usb_packet_set_state(p, USB_PACKET_COMPLETE);
431     QTAILQ_REMOVE(&ep->queue, p, queue);
432     dev->port->ops->complete(dev->port, p);
433 }
434 
435 /* Notify the controller that an async packet is complete.  This should only
436    be called for packets previously deferred by returning USB_RET_ASYNC from
437    handle_packet. */
438 void usb_packet_complete(USBDevice *dev, USBPacket *p)
439 {
440     USBEndpoint *ep = p->ep;
441     int ret;
442 
443     usb_packet_check_state(p, USB_PACKET_ASYNC);
444     usb_packet_complete_one(dev, p);
445 
446     while (!QTAILQ_EMPTY(&ep->queue)) {
447         p = QTAILQ_FIRST(&ep->queue);
448         if (ep->halted) {
449             /* Empty the queue on a halt */
450             p->result = USB_RET_REMOVE_FROM_QUEUE;
451             dev->port->ops->complete(dev->port, p);
452             continue;
453         }
454         if (p->state == USB_PACKET_ASYNC) {
455             break;
456         }
457         usb_packet_check_state(p, USB_PACKET_QUEUED);
458         ret = usb_process_one(p);
459         if (ret == USB_RET_ASYNC) {
460             usb_packet_set_state(p, USB_PACKET_ASYNC);
461             break;
462         }
463         p->result = ret;
464         usb_packet_complete_one(ep->dev, p);
465     }
466 }
467 
468 /* Cancel an active packet.  The packed must have been deferred by
469    returning USB_RET_ASYNC from handle_packet, and not yet
470    completed.  */
471 void usb_cancel_packet(USBPacket * p)
472 {
473     bool callback = (p->state == USB_PACKET_ASYNC);
474     assert(usb_packet_is_inflight(p));
475     usb_packet_set_state(p, USB_PACKET_CANCELED);
476     QTAILQ_REMOVE(&p->ep->queue, p, queue);
477     if (callback) {
478         usb_device_cancel_packet(p->ep->dev, p);
479     }
480 }
481 
482 
483 void usb_packet_init(USBPacket *p)
484 {
485     qemu_iovec_init(&p->iov, 1);
486 }
487 
488 static const char *usb_packet_state_name(USBPacketState state)
489 {
490     static const char *name[] = {
491         [USB_PACKET_UNDEFINED] = "undef",
492         [USB_PACKET_SETUP]     = "setup",
493         [USB_PACKET_QUEUED]    = "queued",
494         [USB_PACKET_ASYNC]     = "async",
495         [USB_PACKET_COMPLETE]  = "complete",
496         [USB_PACKET_CANCELED]  = "canceled",
497     };
498     if (state < ARRAY_SIZE(name)) {
499         return name[state];
500     }
501     return "INVALID";
502 }
503 
504 void usb_packet_check_state(USBPacket *p, USBPacketState expected)
505 {
506     USBDevice *dev;
507     USBBus *bus;
508 
509     if (p->state == expected) {
510         return;
511     }
512     dev = p->ep->dev;
513     bus = usb_bus_from_device(dev);
514     trace_usb_packet_state_fault(bus->busnr, dev->port->path, p->ep->nr, p,
515                                  usb_packet_state_name(p->state),
516                                  usb_packet_state_name(expected));
517     assert(!"usb packet state check failed");
518 }
519 
520 void usb_packet_set_state(USBPacket *p, USBPacketState state)
521 {
522     if (p->ep) {
523         USBDevice *dev = p->ep->dev;
524         USBBus *bus = usb_bus_from_device(dev);
525         trace_usb_packet_state_change(bus->busnr, dev->port->path, p->ep->nr, p,
526                                       usb_packet_state_name(p->state),
527                                       usb_packet_state_name(state));
528     } else {
529         trace_usb_packet_state_change(-1, "", -1, p,
530                                       usb_packet_state_name(p->state),
531                                       usb_packet_state_name(state));
532     }
533     p->state = state;
534 }
535 
536 void usb_packet_setup(USBPacket *p, int pid, USBEndpoint *ep, uint64_t id,
537                       bool short_not_ok, bool int_req)
538 {
539     assert(!usb_packet_is_inflight(p));
540     assert(p->iov.iov != NULL);
541     p->id = id;
542     p->pid = pid;
543     p->ep = ep;
544     p->result = 0;
545     p->parameter = 0;
546     p->short_not_ok = short_not_ok;
547     p->int_req = int_req;
548     p->combined = NULL;
549     qemu_iovec_reset(&p->iov);
550     usb_packet_set_state(p, USB_PACKET_SETUP);
551 }
552 
553 void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len)
554 {
555     qemu_iovec_add(&p->iov, ptr, len);
556 }
557 
558 void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes)
559 {
560     assert(p->result >= 0);
561     assert(p->result + bytes <= p->iov.size);
562     switch (p->pid) {
563     case USB_TOKEN_SETUP:
564     case USB_TOKEN_OUT:
565         iov_to_buf(p->iov.iov, p->iov.niov, p->result, ptr, bytes);
566         break;
567     case USB_TOKEN_IN:
568         iov_from_buf(p->iov.iov, p->iov.niov, p->result, ptr, bytes);
569         break;
570     default:
571         fprintf(stderr, "%s: invalid pid: %x\n", __func__, p->pid);
572         abort();
573     }
574     p->result += bytes;
575 }
576 
577 void usb_packet_skip(USBPacket *p, size_t bytes)
578 {
579     assert(p->result >= 0);
580     assert(p->result + bytes <= p->iov.size);
581     if (p->pid == USB_TOKEN_IN) {
582         iov_memset(p->iov.iov, p->iov.niov, p->result, 0, bytes);
583     }
584     p->result += bytes;
585 }
586 
587 void usb_packet_cleanup(USBPacket *p)
588 {
589     assert(!usb_packet_is_inflight(p));
590     qemu_iovec_destroy(&p->iov);
591 }
592 
593 void usb_ep_reset(USBDevice *dev)
594 {
595     int ep;
596 
597     dev->ep_ctl.nr = 0;
598     dev->ep_ctl.type = USB_ENDPOINT_XFER_CONTROL;
599     dev->ep_ctl.ifnum = 0;
600     dev->ep_ctl.dev = dev;
601     dev->ep_ctl.pipeline = false;
602     for (ep = 0; ep < USB_MAX_ENDPOINTS; ep++) {
603         dev->ep_in[ep].nr = ep + 1;
604         dev->ep_out[ep].nr = ep + 1;
605         dev->ep_in[ep].pid = USB_TOKEN_IN;
606         dev->ep_out[ep].pid = USB_TOKEN_OUT;
607         dev->ep_in[ep].type = USB_ENDPOINT_XFER_INVALID;
608         dev->ep_out[ep].type = USB_ENDPOINT_XFER_INVALID;
609         dev->ep_in[ep].ifnum = USB_INTERFACE_INVALID;
610         dev->ep_out[ep].ifnum = USB_INTERFACE_INVALID;
611         dev->ep_in[ep].dev = dev;
612         dev->ep_out[ep].dev = dev;
613         dev->ep_in[ep].pipeline = false;
614         dev->ep_out[ep].pipeline = false;
615     }
616 }
617 
618 void usb_ep_init(USBDevice *dev)
619 {
620     int ep;
621 
622     usb_ep_reset(dev);
623     QTAILQ_INIT(&dev->ep_ctl.queue);
624     for (ep = 0; ep < USB_MAX_ENDPOINTS; ep++) {
625         QTAILQ_INIT(&dev->ep_in[ep].queue);
626         QTAILQ_INIT(&dev->ep_out[ep].queue);
627     }
628 }
629 
630 void usb_ep_dump(USBDevice *dev)
631 {
632     static const char *tname[] = {
633         [USB_ENDPOINT_XFER_CONTROL] = "control",
634         [USB_ENDPOINT_XFER_ISOC]    = "isoc",
635         [USB_ENDPOINT_XFER_BULK]    = "bulk",
636         [USB_ENDPOINT_XFER_INT]     = "int",
637     };
638     int ifnum, ep, first;
639 
640     fprintf(stderr, "Device \"%s\", config %d\n",
641             dev->product_desc, dev->configuration);
642     for (ifnum = 0; ifnum < 16; ifnum++) {
643         first = 1;
644         for (ep = 0; ep < USB_MAX_ENDPOINTS; ep++) {
645             if (dev->ep_in[ep].type != USB_ENDPOINT_XFER_INVALID &&
646                 dev->ep_in[ep].ifnum == ifnum) {
647                 if (first) {
648                     first = 0;
649                     fprintf(stderr, "  Interface %d, alternative %d\n",
650                             ifnum, dev->altsetting[ifnum]);
651                 }
652                 fprintf(stderr, "    Endpoint %d, IN, %s, %d max\n", ep,
653                         tname[dev->ep_in[ep].type],
654                         dev->ep_in[ep].max_packet_size);
655             }
656             if (dev->ep_out[ep].type != USB_ENDPOINT_XFER_INVALID &&
657                 dev->ep_out[ep].ifnum == ifnum) {
658                 if (first) {
659                     first = 0;
660                     fprintf(stderr, "  Interface %d, alternative %d\n",
661                             ifnum, dev->altsetting[ifnum]);
662                 }
663                 fprintf(stderr, "    Endpoint %d, OUT, %s, %d max\n", ep,
664                         tname[dev->ep_out[ep].type],
665                         dev->ep_out[ep].max_packet_size);
666             }
667         }
668     }
669     fprintf(stderr, "--\n");
670 }
671 
672 struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep)
673 {
674     struct USBEndpoint *eps;
675 
676     if (dev == NULL) {
677         return NULL;
678     }
679     eps = (pid == USB_TOKEN_IN) ? dev->ep_in : dev->ep_out;
680     if (ep == 0) {
681         return &dev->ep_ctl;
682     }
683     assert(pid == USB_TOKEN_IN || pid == USB_TOKEN_OUT);
684     assert(ep > 0 && ep <= USB_MAX_ENDPOINTS);
685     return eps + ep - 1;
686 }
687 
688 uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep)
689 {
690     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
691     return uep->type;
692 }
693 
694 void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type)
695 {
696     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
697     uep->type = type;
698 }
699 
700 uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep)
701 {
702     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
703     return uep->ifnum;
704 }
705 
706 void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum)
707 {
708     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
709     uep->ifnum = ifnum;
710 }
711 
712 void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
713                                 uint16_t raw)
714 {
715     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
716     int size, microframes;
717 
718     size = raw & 0x7ff;
719     switch ((raw >> 11) & 3) {
720     case 1:
721         microframes = 2;
722         break;
723     case 2:
724         microframes = 3;
725         break;
726     default:
727         microframes = 1;
728         break;
729     }
730     uep->max_packet_size = size * microframes;
731 }
732 
733 int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep)
734 {
735     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
736     return uep->max_packet_size;
737 }
738 
739 void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled)
740 {
741     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
742     uep->pipeline = enabled;
743 }
744 
745 USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
746                                     uint64_t id)
747 {
748     struct USBEndpoint *uep = usb_ep_get(dev, pid, ep);
749     USBPacket *p;
750 
751     while ((p = QTAILQ_FIRST(&uep->queue)) != NULL) {
752         if (p->id == id) {
753             return p;
754         }
755     }
756 
757     return NULL;
758 }
759