qemu/hw/usb/core.c

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