hw/usb/host-libusb.c

   1 /*
   2  * Linux host USB redirector
   3  *
   4  * Copyright (c) 2005 Fabrice Bellard
   5  *
   6  * Copyright (c) 2008 Max Krasnyansky
   7  *      Support for host device auto connect & disconnect
   8  *      Major rewrite to support fully async operation
   9  *
  10  * Copyright 2008 TJ <[email protected]>
  11  *      Added flexible support for /dev/bus/usb /sys/bus/usb/devices in addition
  12  *      to the legacy /proc/bus/usb USB device discovery and handling
  13  *
  14  * (c) 2012 Gerd Hoffmann <[email protected]>
  15  *      Completely rewritten to use libusb instead of usbfs ioctls.
  16  *
  17  * Permission is hereby granted, free of charge, to any person obtaining a copy
  18  * of this software and associated documentation files (the "Software"), to deal
  19  * in the Software without restriction, including without limitation the rights
  20  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  21  * copies of the Software, and to permit persons to whom the Software is
  22  * furnished to do so, subject to the following conditions:
  23  *
  24  * The above copyright notice and this permission notice shall be included in
  25  * all copies or substantial portions of the Software.
  26  *
  27  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  28  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  29  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  30  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  31  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  32  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  33  * THE SOFTWARE.
  34  */
  35
  36 #include <poll.h>
  37 #include <libusb.h>
  38
  39 #include "qemu-common.h"
  40 #include "monitor/monitor.h"
  41 #include "sysemu/sysemu.h"
  42 #include "trace.h"
  43
  44 #include "hw/usb.h"
  45
  46 /* ------------------------------------------------------------------------ */
  47
  48 #define TYPE_USB_HOST_DEVICE "usb-host"
  49 #define USB_HOST_DEVICE(obj) \
  50      OBJECT_CHECK(USBHostDevice, (obj), TYPE_USB_HOST_DEVICE)
  51
  52 typedef struct USBHostDevice USBHostDevice;
  53 typedef struct USBHostRequest USBHostRequest;
  54 typedef struct USBHostIsoXfer USBHostIsoXfer;
  55 typedef struct USBHostIsoRing USBHostIsoRing;
  56
  57 struct USBAutoFilter {
  58     uint32_t bus_num;
  59     uint32_t addr;
  60     char     *port;
  61     uint32_t vendor_id;
  62     uint32_t product_id;
  63 };
  64
  65 enum USBHostDeviceOptions {
  66     USB_HOST_OPT_PIPELINE,
  67 };
  68
  69 struct USBHostDevice {
  70     USBDevice parent_obj;
  71
  72     /* properties */
  73     struct USBAutoFilter             match;
  74     int32_t                          bootindex;
  75     uint32_t                         iso_urb_count;
  76     uint32_t                         iso_urb_frames;
  77     uint32_t                         options;
  78     uint32_t                         loglevel;
  79
  80     /* state */
  81     QTAILQ_ENTRY(USBHostDevice)      next;
  82     int                              seen, errcount;
  83     int                              bus_num;
  84     int                              addr;
  85     char                             port[16];
  86
  87     libusb_device                    *dev;
  88     libusb_device_handle             *dh;
  89     struct libusb_device_descriptor  ddesc;
  90
  91     struct {
  92         bool                         detached;
  93         bool                         claimed;
  94     } ifs[USB_MAX_INTERFACES];
  95
  96     /* callbacks & friends */
  97     QEMUBH                           *bh_nodev;
  98     QEMUBH                           *bh_postld;
  99     Notifier                         exit;
 100
 101     /* request queues */
 102     QTAILQ_HEAD(, USBHostRequest)    requests;
 103     QTAILQ_HEAD(, USBHostIsoRing)    isorings;
 104 };
 105
 106 struct USBHostRequest {
 107     USBHostDevice                    *host;
 108     USBPacket                        *p;
 109     bool                             in;
 110     struct libusb_transfer           *xfer;
 111     unsigned char                    *buffer;
 112     unsigned char                    *cbuf;
 113     unsigned int                     clen;
 114     bool                             usb3ep0quirk;
 115     QTAILQ_ENTRY(USBHostRequest)     next;
 116 };
 117
 118 struct USBHostIsoXfer {
 119     USBHostIsoRing                   *ring;
 120     struct libusb_transfer           *xfer;
 121     bool                             copy_complete;
 122     unsigned int                     packet;
 123     QTAILQ_ENTRY(USBHostIsoXfer)     next;
 124 };
 125
 126 struct USBHostIsoRing {
 127     USBHostDevice                    *host;
 128     USBEndpoint                      *ep;
 129     QTAILQ_HEAD(, USBHostIsoXfer)    unused;
 130     QTAILQ_HEAD(, USBHostIsoXfer)    inflight;
 131     QTAILQ_HEAD(, USBHostIsoXfer)    copy;
 132     QTAILQ_ENTRY(USBHostIsoRing)     next;
 133 };
 134
 135 static QTAILQ_HEAD(, USBHostDevice) hostdevs =
 136     QTAILQ_HEAD_INITIALIZER(hostdevs);
 137
 138 static void usb_host_auto_check(void *unused);
 139 static void usb_host_release_interfaces(USBHostDevice *s);
 140 static void usb_host_nodev(USBHostDevice *s);
 141 static void usb_host_detach_kernel(USBHostDevice *s);
 142 static void usb_host_attach_kernel(USBHostDevice *s);
 143
 144 /* ------------------------------------------------------------------------ */
 145
 146 #define CONTROL_TIMEOUT  10000        /* 10 sec    */
 147 #define BULK_TIMEOUT         0        /* unlimited */
 148 #define INTR_TIMEOUT         0        /* unlimited */
 149
 150 #if LIBUSBX_API_VERSION >= 0x01000103
 151 # define HAVE_STREAMS 1
 152 #endif
 153
 154 static const char *speed_name[] = {
 155     [LIBUSB_SPEED_UNKNOWN] = "?",
 156     [LIBUSB_SPEED_LOW]     = "1.5",
 157     [LIBUSB_SPEED_FULL]    = "12",
 158     [LIBUSB_SPEED_HIGH]    = "480",
 159     [LIBUSB_SPEED_SUPER]   = "5000",
 160 };
 161
 162 static const unsigned int speed_map[] = {
 163     [LIBUSB_SPEED_LOW]     = USB_SPEED_LOW,
 164     [LIBUSB_SPEED_FULL]    = USB_SPEED_FULL,
 165     [LIBUSB_SPEED_HIGH]    = USB_SPEED_HIGH,
 166     [LIBUSB_SPEED_SUPER]   = USB_SPEED_SUPER,
 167 };
 168
 169 static const unsigned int status_map[] = {
 170     [LIBUSB_TRANSFER_COMPLETED] = USB_RET_SUCCESS,
 171     [LIBUSB_TRANSFER_ERROR]     = USB_RET_IOERROR,
 172     [LIBUSB_TRANSFER_TIMED_OUT] = USB_RET_IOERROR,
 173     [LIBUSB_TRANSFER_CANCELLED] = USB_RET_IOERROR,
 174     [LIBUSB_TRANSFER_STALL]     = USB_RET_STALL,
 175     [LIBUSB_TRANSFER_NO_DEVICE] = USB_RET_NODEV,
 176     [LIBUSB_TRANSFER_OVERFLOW]  = USB_RET_BABBLE,
 177 };
 178
 179 static const char *err_names[] = {
 180     [-LIBUSB_ERROR_IO]               = "IO",
 181     [-LIBUSB_ERROR_INVALID_PARAM]    = "INVALID_PARAM",
 182     [-LIBUSB_ERROR_ACCESS]           = "ACCESS",
 183     [-LIBUSB_ERROR_NO_DEVICE]        = "NO_DEVICE",
 184     [-LIBUSB_ERROR_NOT_FOUND]        = "NOT_FOUND",
 185     [-LIBUSB_ERROR_BUSY]             = "BUSY",
 186     [-LIBUSB_ERROR_TIMEOUT]          = "TIMEOUT",
 187     [-LIBUSB_ERROR_OVERFLOW]         = "OVERFLOW",
 188     [-LIBUSB_ERROR_PIPE]             = "PIPE",
 189     [-LIBUSB_ERROR_INTERRUPTED]      = "INTERRUPTED",
 190     [-LIBUSB_ERROR_NO_MEM]           = "NO_MEM",
 191     [-LIBUSB_ERROR_NOT_SUPPORTED]    = "NOT_SUPPORTED",
 192     [-LIBUSB_ERROR_OTHER]            = "OTHER",
 193 };
 194
 195 static libusb_context *ctx;
 196 static uint32_t loglevel;
 197
 198 static void usb_host_handle_fd(void *opaque)
 199 {
 200     struct timeval tv = { 0, 0 };
 201     libusb_handle_events_timeout(ctx, &tv);
 202 }
 203
 204 static void usb_host_add_fd(int fd, short events, void *user_data)
 205 {
 206     qemu_set_fd_handler(fd,
 207                         (events & POLLIN)  ? usb_host_handle_fd : NULL,
 208                         (events & POLLOUT) ? usb_host_handle_fd : NULL,
 209                         ctx);
 210 }
 211
 212 static void usb_host_del_fd(int fd, void *user_data)
 213 {
 214     qemu_set_fd_handler(fd, NULL, NULL, NULL);
 215 }
 216
 217 static int usb_host_init(void)
 218 {
 219     const struct libusb_pollfd **poll;
 220     int i, rc;
 221
 222     if (ctx) {
 223         return 0;
 224     }
 225     rc = libusb_init(&ctx);
 226     if (rc != 0) {
 227         return -1;
 228     }
 229     libusb_set_debug(ctx, loglevel);
 230
 231     libusb_set_pollfd_notifiers(ctx, usb_host_add_fd,
 232                                 usb_host_del_fd,
 233                                 ctx);
 234     poll = libusb_get_pollfds(ctx);
 235     if (poll) {
 236         for (i = 0; poll[i] != NULL; i++) {
 237             usb_host_add_fd(poll[i]->fd, poll[i]->events, ctx);
 238         }
 239     }
 240     free(poll);
 241     return 0;
 242 }
 243
 244 static int usb_host_get_port(libusb_device *dev, char *port, size_t len)
 245 {
 246     uint8_t path[7];
 247     size_t off;
 248     int rc, i;
 249
 250 #if LIBUSBX_API_VERSION >= 0x01000102
 251     rc = libusb_get_port_numbers(dev, path, 7);
 252 #else
 253     rc = libusb_get_port_path(ctx, dev, path, 7);
 254 #endif
 255     if (rc < 0) {
 256         return 0;
 257     }
 258     off = snprintf(port, len, "%d", path[0]);
 259     for (i = 1; i < rc; i++) {
 260         off += snprintf(port+off, len-off, ".%d", path[i]);
 261     }
 262     return off;
 263 }
 264
 265 static void usb_host_libusb_error(const char *func, int rc)
 266 {
 267     const char *errname;
 268
 269     if (rc >= 0) {
 270         return;
 271     }
 272
 273     if (-rc < ARRAY_SIZE(err_names) && err_names[-rc]) {
 274         errname = err_names[-rc];
 275     } else {
 276         errname = "?";
 277     }
 278     fprintf(stderr, "%s: %d [%s]\n", func, rc, errname);
 279 }
 280
 281 /* ------------------------------------------------------------------------ */
 282
 283 static bool usb_host_use_combining(USBEndpoint *ep)
 284 {
 285     int type;
 286
 287     if (!ep->pipeline) {
 288         return false;
 289     }
 290     if (ep->pid != USB_TOKEN_IN) {
 291         return false;
 292     }
 293     type = usb_ep_get_type(ep->dev, ep->pid, ep->nr);
 294     if (type != USB_ENDPOINT_XFER_BULK) {
 295         return false;
 296     }
 297     return true;
 298 }
 299
 300 /* ------------------------------------------------------------------------ */
 301
 302 static USBHostRequest *usb_host_req_alloc(USBHostDevice *s, USBPacket *p,
 303                                           bool in, size_t bufsize)
 304 {
 305     USBHostRequest *r = g_new0(USBHostRequest, 1);
 306
 307     r->host = s;
 308     r->p = p;
 309     r->in = in;
 310     r->xfer = libusb_alloc_transfer(0);
 311     if (bufsize) {
 312         r->buffer = g_malloc(bufsize);
 313     }
 314     QTAILQ_INSERT_TAIL(&s->requests, r, next);
 315     return r;
 316 }
 317
 318 static void usb_host_req_free(USBHostRequest *r)
 319 {
 320     if (r->host) {
 321         QTAILQ_REMOVE(&r->host->requests, r, next);
 322     }
 323     libusb_free_transfer(r->xfer);
 324     g_free(r->buffer);
 325     g_free(r);
 326 }
 327
 328 static USBHostRequest *usb_host_req_find(USBHostDevice *s, USBPacket *p)
 329 {
 330     USBHostRequest *r;
 331
 332     QTAILQ_FOREACH(r, &s->requests, next) {
 333         if (r->p == p) {
 334             return r;
 335         }
 336     }
 337     return NULL;
 338 }
 339
 340 static void usb_host_req_complete_ctrl(struct libusb_transfer *xfer)
 341 {
 342     USBHostRequest *r = xfer->user_data;
 343     USBHostDevice  *s = r->host;
 344     bool disconnect = (xfer->status == LIBUSB_TRANSFER_NO_DEVICE);
 345
 346     if (r->p == NULL) {
 347         goto out; /* request was canceled */
 348     }
 349
 350     r->p->status = status_map[xfer->status];
 351     r->p->actual_length = xfer->actual_length;
 352     if (r->in && xfer->actual_length) {
 353         memcpy(r->cbuf, r->buffer + 8, xfer->actual_length);
 354
 355         /* Fix up USB-3 ep0 maxpacket size to allow superspeed connected devices
 356          * to work redirected to a not superspeed capable hcd */
 357         if (r->usb3ep0quirk && xfer->actual_length >= 18 &&
 358             r->cbuf[7] == 9) {
 359             r->cbuf[7] = 64;
 360         }
 361     }
 362     trace_usb_host_req_complete(s->bus_num, s->addr, r->p,
 363                                 r->p->status, r->p->actual_length);
 364     usb_generic_async_ctrl_complete(USB_DEVICE(s), r->p);
 365
 366 out:
 367     usb_host_req_free(r);
 368     if (disconnect) {
 369         usb_host_nodev(s);
 370     }
 371 }
 372
 373 static void usb_host_req_complete_data(struct libusb_transfer *xfer)
 374 {
 375     USBHostRequest *r = xfer->user_data;
 376     USBHostDevice  *s = r->host;
 377     bool disconnect = (xfer->status == LIBUSB_TRANSFER_NO_DEVICE);
 378
 379     if (r->p == NULL) {
 380         goto out; /* request was canceled */
 381     }
 382
 383     r->p->status = status_map[xfer->status];
 384     if (r->in && xfer->actual_length) {
 385         usb_packet_copy(r->p, r->buffer, xfer->actual_length);
 386     }
 387     trace_usb_host_req_complete(s->bus_num, s->addr, r->p,
 388                                 r->p->status, r->p->actual_length);
 389     if (usb_host_use_combining(r->p->ep)) {
 390         usb_combined_input_packet_complete(USB_DEVICE(s), r->p);
 391     } else {
 392         usb_packet_complete(USB_DEVICE(s), r->p);
 393     }
 394
 395 out:
 396     usb_host_req_free(r);
 397     if (disconnect) {
 398         usb_host_nodev(s);
 399     }
 400 }
 401
 402 static void usb_host_req_abort(USBHostRequest *r)
 403 {
 404     USBHostDevice  *s = r->host;
 405     bool inflight = (r->p && r->p->state == USB_PACKET_ASYNC);
 406
 407     if (inflight) {
 408         r->p->status = USB_RET_NODEV;
 409         trace_usb_host_req_complete(s->bus_num, s->addr, r->p,
 410                                     r->p->status, r->p->actual_length);
 411         if (r->p->ep->nr == 0) {
 412             usb_generic_async_ctrl_complete(USB_DEVICE(s), r->p);
 413         } else {
 414             usb_packet_complete(USB_DEVICE(s), r->p);
 415         }
 416         r->p = NULL;
 417     }
 418
 419     QTAILQ_REMOVE(&r->host->requests, r, next);
 420     r->host = NULL;
 421
 422     if (inflight) {
 423         libusb_cancel_transfer(r->xfer);
 424     }
 425 }
 426
 427 /* ------------------------------------------------------------------------ */
 428
 429 static void usb_host_req_complete_iso(struct libusb_transfer *transfer)
 430 {
 431     USBHostIsoXfer *xfer = transfer->user_data;
 432
 433     if (!xfer) {
 434         /* USBHostIsoXfer released while inflight */
 435         g_free(transfer->buffer);
 436         libusb_free_transfer(transfer);
 437         return;
 438     }
 439
 440     QTAILQ_REMOVE(&xfer->ring->inflight, xfer, next);
 441     if (QTAILQ_EMPTY(&xfer->ring->inflight)) {
 442         USBHostDevice *s = xfer->ring->host;
 443         trace_usb_host_iso_stop(s->bus_num, s->addr, xfer->ring->ep->nr);
 444     }
 445     if (xfer->ring->ep->pid == USB_TOKEN_IN) {
 446         QTAILQ_INSERT_TAIL(&xfer->ring->copy, xfer, next);
 447     } else {
 448         QTAILQ_INSERT_TAIL(&xfer->ring->unused, xfer, next);
 449     }
 450 }
 451
 452 static USBHostIsoRing *usb_host_iso_alloc(USBHostDevice *s, USBEndpoint *ep)
 453 {
 454     USBHostIsoRing *ring = g_new0(USBHostIsoRing, 1);
 455     USBHostIsoXfer *xfer;
 456     /* FIXME: check interval (for now assume one xfer per frame) */
 457     int packets = s->iso_urb_frames;
 458     int i;
 459
 460     ring->host = s;
 461     ring->ep = ep;
 462     QTAILQ_INIT(&ring->unused);
 463     QTAILQ_INIT(&ring->inflight);
 464     QTAILQ_INIT(&ring->copy);
 465     QTAILQ_INSERT_TAIL(&s->isorings, ring, next);
 466
 467     for (i = 0; i < s->iso_urb_count; i++) {
 468         xfer = g_new0(USBHostIsoXfer, 1);
 469         xfer->ring = ring;
 470         xfer->xfer = libusb_alloc_transfer(packets);
 471         xfer->xfer->dev_handle = s->dh;
 472         xfer->xfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
 473
 474         xfer->xfer->endpoint = ring->ep->nr;
 475         if (ring->ep->pid == USB_TOKEN_IN) {
 476             xfer->xfer->endpoint |= USB_DIR_IN;
 477         }
 478         xfer->xfer->callback = usb_host_req_complete_iso;
 479         xfer->xfer->user_data = xfer;
 480
 481         xfer->xfer->num_iso_packets = packets;
 482         xfer->xfer->length = ring->ep->max_packet_size * packets;
 483         xfer->xfer->buffer = g_malloc0(xfer->xfer->length);
 484
 485         QTAILQ_INSERT_TAIL(&ring->unused, xfer, next);
 486     }
 487
 488     return ring;
 489 }
 490
 491 static USBHostIsoRing *usb_host_iso_find(USBHostDevice *s, USBEndpoint *ep)
 492 {
 493     USBHostIsoRing *ring;
 494
 495     QTAILQ_FOREACH(ring, &s->isorings, next) {
 496         if (ring->ep == ep) {
 497             return ring;
 498         }
 499     }
 500     return NULL;
 501 }
 502
 503 static void usb_host_iso_reset_xfer(USBHostIsoXfer *xfer)
 504 {
 505     libusb_set_iso_packet_lengths(xfer->xfer,
 506                                   xfer->ring->ep->max_packet_size);
 507     xfer->packet = 0;
 508     xfer->copy_complete = false;
 509 }
 510
 511 static void usb_host_iso_free_xfer(USBHostIsoXfer *xfer, bool inflight)
 512 {
 513     if (inflight) {
 514         xfer->xfer->user_data = NULL;
 515     } else {
 516         g_free(xfer->xfer->buffer);
 517         libusb_free_transfer(xfer->xfer);
 518     }
 519     g_free(xfer);
 520 }
 521
 522 static void usb_host_iso_free(USBHostIsoRing *ring)
 523 {
 524     USBHostIsoXfer *xfer;
 525
 526     while ((xfer = QTAILQ_FIRST(&ring->inflight)) != NULL) {
 527         QTAILQ_REMOVE(&ring->inflight, xfer, next);
 528         usb_host_iso_free_xfer(xfer, true);
 529     }
 530     while ((xfer = QTAILQ_FIRST(&ring->unused)) != NULL) {
 531         QTAILQ_REMOVE(&ring->unused, xfer, next);
 532         usb_host_iso_free_xfer(xfer, false);
 533     }
 534     while ((xfer = QTAILQ_FIRST(&ring->copy)) != NULL) {
 535         QTAILQ_REMOVE(&ring->copy, xfer, next);
 536         usb_host_iso_free_xfer(xfer, false);
 537     }
 538
 539     QTAILQ_REMOVE(&ring->host->isorings, ring, next);
 540     g_free(ring);
 541 }
 542
 543 static void usb_host_iso_free_all(USBHostDevice *s)
 544 {
 545     USBHostIsoRing *ring;
 546
 547     while ((ring = QTAILQ_FIRST(&s->isorings)) != NULL) {
 548         usb_host_iso_free(ring);
 549     }
 550 }
 551
 552 static bool usb_host_iso_data_copy(USBHostIsoXfer *xfer, USBPacket *p)
 553 {
 554     unsigned int psize;
 555     unsigned char *buf;
 556
 557     buf = libusb_get_iso_packet_buffer_simple(xfer->xfer, xfer->packet);
 558     if (p->pid == USB_TOKEN_OUT) {
 559         psize = p->iov.size;
 560         if (psize > xfer->ring->ep->max_packet_size) {
 561             /* should not happen (guest bug) */
 562             psize = xfer->ring->ep->max_packet_size;
 563         }
 564         xfer->xfer->iso_packet_desc[xfer->packet].length = psize;
 565     } else {
 566         psize = xfer->xfer->iso_packet_desc[xfer->packet].actual_length;
 567         if (psize > p->iov.size) {
 568             /* should not happen (guest bug) */
 569             psize = p->iov.size;
 570         }
 571     }
 572     usb_packet_copy(p, buf, psize);
 573     xfer->packet++;
 574     xfer->copy_complete = (xfer->packet == xfer->xfer->num_iso_packets);
 575     return xfer->copy_complete;
 576 }
 577
 578 static void usb_host_iso_data_in(USBHostDevice *s, USBPacket *p)
 579 {
 580     USBHostIsoRing *ring;
 581     USBHostIsoXfer *xfer;
 582     bool disconnect = false;
 583     int rc;
 584
 585     ring = usb_host_iso_find(s, p->ep);
 586     if (ring == NULL) {
 587         ring = usb_host_iso_alloc(s, p->ep);
 588     }
 589
 590     /* copy data to guest */
 591     xfer = QTAILQ_FIRST(&ring->copy);
 592     if (xfer != NULL) {
 593         if (usb_host_iso_data_copy(xfer, p)) {
 594             QTAILQ_REMOVE(&ring->copy, xfer, next);
 595             QTAILQ_INSERT_TAIL(&ring->unused, xfer, next);
 596         }
 597     }
 598
 599     /* submit empty bufs to host */
 600     while ((xfer = QTAILQ_FIRST(&ring->unused)) != NULL) {
 601         QTAILQ_REMOVE(&ring->unused, xfer, next);
 602         usb_host_iso_reset_xfer(xfer);
 603         rc = libusb_submit_transfer(xfer->xfer);
 604         if (rc != 0) {
 605             usb_host_libusb_error("libusb_submit_transfer [iso]", rc);
 606             QTAILQ_INSERT_TAIL(&ring->unused, xfer, next);
 607             if (rc == LIBUSB_ERROR_NO_DEVICE) {
 608                 disconnect = true;
 609             }
 610             break;
 611         }
 612         if (QTAILQ_EMPTY(&ring->inflight)) {
 613             trace_usb_host_iso_start(s->bus_num, s->addr, p->ep->nr);
 614         }
 615         QTAILQ_INSERT_TAIL(&ring->inflight, xfer, next);
 616     }
 617
 618     if (disconnect) {
 619         usb_host_nodev(s);
 620     }
 621 }
 622
 623 static void usb_host_iso_data_out(USBHostDevice *s, USBPacket *p)
 624 {
 625     USBHostIsoRing *ring;
 626     USBHostIsoXfer *xfer;
 627     bool disconnect = false;
 628     int rc, filled = 0;
 629
 630     ring = usb_host_iso_find(s, p->ep);
 631     if (ring == NULL) {
 632         ring = usb_host_iso_alloc(s, p->ep);
 633     }
 634
 635     /* copy data from guest */
 636     xfer = QTAILQ_FIRST(&ring->copy);
 637     while (xfer != NULL && xfer->copy_complete) {
 638         filled++;
 639         xfer = QTAILQ_NEXT(xfer, next);
 640     }
 641     if (xfer == NULL) {
 642         xfer = QTAILQ_FIRST(&ring->unused);
 643         if (xfer == NULL) {
 644             trace_usb_host_iso_out_of_bufs(s->bus_num, s->addr, p->ep->nr);
 645             return;
 646         }
 647         QTAILQ_REMOVE(&ring->unused, xfer, next);
 648         usb_host_iso_reset_xfer(xfer);
 649         QTAILQ_INSERT_TAIL(&ring->copy, xfer, next);
 650     }
 651     usb_host_iso_data_copy(xfer, p);
 652
 653     if (QTAILQ_EMPTY(&ring->inflight)) {
 654         /* wait until half of our buffers are filled
 655            before kicking the iso out stream */
 656         if (filled*2 < s->iso_urb_count) {
 657             return;
 658         }
 659     }
 660
 661     /* submit filled bufs to host */
 662     while ((xfer = QTAILQ_FIRST(&ring->copy)) != NULL &&
 663            xfer->copy_complete) {
 664         QTAILQ_REMOVE(&ring->copy, xfer, next);
 665         rc = libusb_submit_transfer(xfer->xfer);
 666         if (rc != 0) {
 667             usb_host_libusb_error("libusb_submit_transfer [iso]", rc);
 668             QTAILQ_INSERT_TAIL(&ring->unused, xfer, next);
 669             if (rc == LIBUSB_ERROR_NO_DEVICE) {
 670                 disconnect = true;
 671             }
 672             break;
 673         }
 674         if (QTAILQ_EMPTY(&ring->inflight)) {
 675             trace_usb_host_iso_start(s->bus_num, s->addr, p->ep->nr);
 676         }
 677         QTAILQ_INSERT_TAIL(&ring->inflight, xfer, next);
 678     }
 679
 680     if (disconnect) {
 681         usb_host_nodev(s);
 682     }
 683 }
 684
 685 /* ------------------------------------------------------------------------ */
 686
 687 static void usb_host_speed_compat(USBHostDevice *s)
 688 {
 689     USBDevice *udev = USB_DEVICE(s);
 690     struct libusb_config_descriptor *conf;
 691     const struct libusb_interface_descriptor *intf;
 692     const struct libusb_endpoint_descriptor *endp;
 693 #ifdef HAVE_STREAMS
 694     struct libusb_ss_endpoint_companion_descriptor *endp_ss_comp;
 695 #endif
 696     bool compat_high = true;
 697     bool compat_full = true;
 698     uint8_t type;
 699     int rc, c, i, a, e;
 700
 701     for (c = 0;; c++) {
 702         rc = libusb_get_config_descriptor(s->dev, c, &conf);
 703         if (rc != 0) {
 704             break;
 705         }
 706         for (i = 0; i < conf->bNumInterfaces; i++) {
 707             for (a = 0; a < conf->interface[i].num_altsetting; a++) {
 708                 intf = &conf->interface[i].altsetting[a];
 709                 for (e = 0; e < intf->bNumEndpoints; e++) {
 710                     endp = &intf->endpoint[e];
 711                     type = endp->bmAttributes & 0x3;
 712                     switch (type) {
 713                     case 0x01: /* ISO */
 714                         compat_full = false;
 715                         compat_high = false;
 716                         break;
 717                     case 0x02: /* BULK */
 718 #ifdef HAVE_STREAMS
 719                         rc = libusb_get_ss_endpoint_companion_descriptor
 720                             (ctx, endp, &endp_ss_comp);
 721                         if (rc == LIBUSB_SUCCESS) {
 722                             libusb_free_ss_endpoint_companion_descriptor
 723                                 (endp_ss_comp);
 724                             compat_full = false;
 725                             compat_high = false;
 726                         }
 727 #endif
 728                         break;
 729                     case 0x03: /* INTERRUPT */
 730                         if (endp->wMaxPacketSize > 64) {
 731                             compat_full = false;
 732                         }
 733                         if (endp->wMaxPacketSize > 1024) {
 734                             compat_high = false;
 735                         }
 736                         break;
 737                     }
 738                 }
 739             }
 740         }
 741         libusb_free_config_descriptor(conf);
 742     }
 743
 744     udev->speedmask = (1 << udev->speed);
 745     if (udev->speed == USB_SPEED_SUPER && compat_high) {
 746         udev->speedmask |= USB_SPEED_HIGH;
 747     }
 748     if (udev->speed == USB_SPEED_SUPER && compat_full) {
 749         udev->speedmask |= USB_SPEED_FULL;
 750     }
 751     if (udev->speed == USB_SPEED_HIGH && compat_full) {
 752         udev->speedmask |= USB_SPEED_FULL;
 753     }
 754 }
 755
 756 static void usb_host_ep_update(USBHostDevice *s)
 757 {
 758     static const char *tname[] = {
 759         [USB_ENDPOINT_XFER_CONTROL] = "control",
 760         [USB_ENDPOINT_XFER_ISOC]    = "isoc",
 761         [USB_ENDPOINT_XFER_BULK]    = "bulk",
 762         [USB_ENDPOINT_XFER_INT]     = "int",
 763     };
 764     USBDevice *udev = USB_DEVICE(s);
 765     struct libusb_config_descriptor *conf;
 766     const struct libusb_interface_descriptor *intf;
 767     const struct libusb_endpoint_descriptor *endp;
 768 #ifdef HAVE_STREAMS
 769     struct libusb_ss_endpoint_companion_descriptor *endp_ss_comp;
 770 #endif
 771     uint8_t devep, type;
 772     int pid, ep;
 773     int rc, i, e;
 774
 775     usb_ep_reset(udev);
 776     rc = libusb_get_active_config_descriptor(s->dev, &conf);
 777     if (rc != 0) {
 778         return;
 779     }
 780     trace_usb_host_parse_config(s->bus_num, s->addr,
 781                                 conf->bConfigurationValue, true);
 782
 783     for (i = 0; i < conf->bNumInterfaces; i++) {
 784         assert(udev->altsetting[i] < conf->interface[i].num_altsetting);
 785         intf = &conf->interface[i].altsetting[udev->altsetting[i]];
 786         trace_usb_host_parse_interface(s->bus_num, s->addr,
 787                                        intf->bInterfaceNumber,
 788                                        intf->bAlternateSetting, true);
 789         for (e = 0; e < intf->bNumEndpoints; e++) {
 790             endp = &intf->endpoint[e];
 791
 792             devep = endp->bEndpointAddress;
 793             pid = (devep & USB_DIR_IN) ? USB_TOKEN_IN : USB_TOKEN_OUT;
 794             ep = devep & 0xf;
 795             type = endp->bmAttributes & 0x3;
 796
 797             if (ep == 0) {
 798                 trace_usb_host_parse_error(s->bus_num, s->addr,
 799                                            "invalid endpoint address");
 800                 return;
 801             }
 802             if (usb_ep_get_type(udev, pid, ep) != USB_ENDPOINT_XFER_INVALID) {
 803                 trace_usb_host_parse_error(s->bus_num, s->addr,
 804                                            "duplicate endpoint address");
 805                 return;
 806             }
 807
 808             trace_usb_host_parse_endpoint(s->bus_num, s->addr, ep,
 809                                           (devep & USB_DIR_IN) ? "in" : "out",
 810                                           tname[type], true);
 811             usb_ep_set_max_packet_size(udev, pid, ep,
 812                                        endp->wMaxPacketSize);
 813             usb_ep_set_type(udev, pid, ep, type);
 814             usb_ep_set_ifnum(udev, pid, ep, i);
 815             usb_ep_set_halted(udev, pid, ep, 0);
 816 #ifdef HAVE_STREAMS
 817             if (type == LIBUSB_TRANSFER_TYPE_BULK &&
 818                     libusb_get_ss_endpoint_companion_descriptor(ctx, endp,
 819                         &endp_ss_comp) == LIBUSB_SUCCESS) {
 820                 usb_ep_set_max_streams(udev, pid, ep,
 821                                        endp_ss_comp->bmAttributes);
 822                 libusb_free_ss_endpoint_companion_descriptor(endp_ss_comp);
 823             }
 824 #endif
 825         }
 826     }
 827
 828     libusb_free_config_descriptor(conf);
 829 }
 830
 831 static int usb_host_open(USBHostDevice *s, libusb_device *dev)
 832 {
 833     USBDevice *udev = USB_DEVICE(s);
 834     int bus_num = libusb_get_bus_number(dev);
 835     int addr    = libusb_get_device_address(dev);
 836     int rc;
 837
 838     trace_usb_host_open_started(bus_num, addr);
 839
 840     if (s->dh != NULL) {
 841         goto fail;
 842     }
 843     rc = libusb_open(dev, &s->dh);
 844     if (rc != 0) {
 845         goto fail;
 846     }
 847
 848     s->dev     = dev;
 849     s->bus_num = bus_num;
 850     s->addr    = addr;
 851
 852     usb_host_detach_kernel(s);
 853
 854     libusb_get_device_descriptor(dev, &s->ddesc);
 855     usb_host_get_port(s->dev, s->port, sizeof(s->port));
 856
 857     usb_ep_init(udev);
 858     usb_host_ep_update(s);
 859
 860     udev->speed     = speed_map[libusb_get_device_speed(dev)];
 861     usb_host_speed_compat(s);
 862
 863     if (s->ddesc.iProduct) {
 864         libusb_get_string_descriptor_ascii(s->dh, s->ddesc.iProduct,
 865                                            (unsigned char *)udev->product_desc,
 866                                            sizeof(udev->product_desc));
 867     } else {
 868         snprintf(udev->product_desc, sizeof(udev->product_desc),
 869                  "host:%d.%d", bus_num, addr);
 870     }
 871
 872     rc = usb_device_attach(udev);
 873     if (rc) {
 874         goto fail;
 875     }
 876
 877     trace_usb_host_open_success(bus_num, addr);
 878     return 0;
 879
 880 fail:
 881     trace_usb_host_open_failure(bus_num, addr);
 882     if (s->dh != NULL) {
 883         libusb_close(s->dh);
 884         s->dh = NULL;
 885         s->dev = NULL;
 886     }
 887     return -1;
 888 }
 889
 890 static void usb_host_abort_xfers(USBHostDevice *s)
 891 {
 892     USBHostRequest *r, *rtmp;
 893
 894     QTAILQ_FOREACH_SAFE(r, &s->requests, next, rtmp) {
 895         usb_host_req_abort(r);
 896     }
 897 }
 898
 899 static int usb_host_close(USBHostDevice *s)
 900 {
 901     USBDevice *udev = USB_DEVICE(s);
 902
 903     if (s->dh == NULL) {
 904         return -1;
 905     }
 906
 907     trace_usb_host_close(s->bus_num, s->addr);
 908
 909     usb_host_abort_xfers(s);
 910     usb_host_iso_free_all(s);
 911
 912     if (udev->attached) {
 913         usb_device_detach(udev);
 914     }
 915
 916     usb_host_release_interfaces(s);
 917     libusb_reset_device(s->dh);
 918     usb_host_attach_kernel(s);
 919     libusb_close(s->dh);
 920     s->dh = NULL;
 921     s->dev = NULL;
 922
 923     usb_host_auto_check(NULL);
 924     return 0;
 925 }
 926
 927 static void usb_host_nodev_bh(void *opaque)
 928 {
 929     USBHostDevice *s = opaque;
 930     usb_host_close(s);
 931 }
 932
 933 static void usb_host_nodev(USBHostDevice *s)
 934 {
 935     if (!s->bh_nodev) {
 936         s->bh_nodev = qemu_bh_new(usb_host_nodev_bh, s);
 937     }
 938     qemu_bh_schedule(s->bh_nodev);
 939 }
 940
 941 static void usb_host_exit_notifier(struct Notifier *n, void *data)
 942 {
 943     USBHostDevice *s = container_of(n, USBHostDevice, exit);
 944
 945     if (s->dh) {
 946         usb_host_release_interfaces(s);
 947         usb_host_attach_kernel(s);
 948     }
 949 }
 950
 951 static int usb_host_initfn(USBDevice *udev)
 952 {
 953     USBHostDevice *s = USB_HOST_DEVICE(udev);
 954
 955     if (s->match.vendor_id > 0xffff) {
 956         error_report("vendorid out of range");
 957         return -1;
 958     }
 959     if (s->match.product_id > 0xffff) {
 960         error_report("productid out of range");
 961         return -1;
 962     }
 963     if (s->match.addr > 127) {
 964         error_report("hostaddr out of range");
 965         return -1;
 966     }
 967
 968     loglevel = s->loglevel;
 969     udev->flags |= (1 << USB_DEV_FLAG_IS_HOST);
 970     udev->auto_attach = 0;
 971     QTAILQ_INIT(&s->requests);
 972     QTAILQ_INIT(&s->isorings);
 973
 974     s->exit.notify = usb_host_exit_notifier;
 975     qemu_add_exit_notifier(&s->exit);
 976
 977     QTAILQ_INSERT_TAIL(&hostdevs, s, next);
 978     add_boot_device_path(s->bootindex, &udev->qdev, NULL);
 979     usb_host_auto_check(NULL);
 980     return 0;
 981 }
 982
 983 static void usb_host_handle_destroy(USBDevice *udev)
 984 {
 985     USBHostDevice *s = USB_HOST_DEVICE(udev);
 986
 987     qemu_remove_exit_notifier(&s->exit);
 988     QTAILQ_REMOVE(&hostdevs, s, next);
 989     usb_host_close(s);
 990 }
 991
 992 static void usb_host_cancel_packet(USBDevice *udev, USBPacket *p)
 993 {
 994     USBHostDevice *s = USB_HOST_DEVICE(udev);
 995     USBHostRequest *r;
 996
 997     if (p->combined) {
 998         usb_combined_packet_cancel(udev, p);
 999         return;
1000     }
1001
1002     trace_usb_host_req_canceled(s->bus_num, s->addr, p);
1003
1004     r = usb_host_req_find(s, p);
1005     if (r && r->p) {
1006         r->p = NULL; /* mark as dead */
1007         libusb_cancel_transfer(r->xfer);
1008     }
1009 }
1010
1011 static void usb_host_detach_kernel(USBHostDevice *s)
1012 {
1013     struct libusb_config_descriptor *conf;
1014     int rc, i;
1015
1016     rc = libusb_get_active_config_descriptor(s->dev, &conf);
1017     if (rc != 0) {
1018         return;
1019     }
1020     for (i = 0; i < conf->bNumInterfaces; i++) {
1021         rc = libusb_kernel_driver_active(s->dh, i);
1022         usb_host_libusb_error("libusb_kernel_driver_active", rc);
1023         if (rc != 1) {
1024             continue;
1025         }
1026         trace_usb_host_detach_kernel(s->bus_num, s->addr, i);
1027         rc = libusb_detach_kernel_driver(s->dh, i);
1028         usb_host_libusb_error("libusb_detach_kernel_driver", rc);
1029         s->ifs[i].detached = true;
1030     }
1031     libusb_free_config_descriptor(conf);
1032 }
1033
1034 static void usb_host_attach_kernel(USBHostDevice *s)
1035 {
1036     struct libusb_config_descriptor *conf;
1037     int rc, i;
1038
1039     rc = libusb_get_active_config_descriptor(s->dev, &conf);
1040     if (rc != 0) {
1041         return;
1042     }
1043     for (i = 0; i < conf->bNumInterfaces; i++) {
1044         if (!s->ifs[i].detached) {
1045             continue;
1046         }
1047         trace_usb_host_attach_kernel(s->bus_num, s->addr, i);
1048         libusb_attach_kernel_driver(s->dh, i);
1049         s->ifs[i].detached = false;
1050     }
1051     libusb_free_config_descriptor(conf);
1052 }
1053
1054 static int usb_host_claim_interfaces(USBHostDevice *s, int configuration)
1055 {
1056     USBDevice *udev = USB_DEVICE(s);
1057     struct libusb_config_descriptor *conf;
1058     int rc, i;
1059
1060     for (i = 0; i < USB_MAX_INTERFACES; i++) {
1061         udev->altsetting[i] = 0;
1062     }
1063     udev->ninterfaces   = 0;
1064     udev->configuration = 0;
1065
1066     usb_host_detach_kernel(s);
1067
1068     rc = libusb_get_active_config_descriptor(s->dev, &conf);
1069     if (rc != 0) {
1070         if (rc == LIBUSB_ERROR_NOT_FOUND) {
1071             /* address state - ignore */
1072             return USB_RET_SUCCESS;
1073         }
1074         return USB_RET_STALL;
1075     }
1076
1077     for (i = 0; i < conf->bNumInterfaces; i++) {
1078         trace_usb_host_claim_interface(s->bus_num, s->addr, configuration, i);
1079         rc = libusb_claim_interface(s->dh, i);
1080         usb_host_libusb_error("libusb_claim_interface", rc);
1081         if (rc != 0) {
1082             return USB_RET_STALL;
1083         }
1084         s->ifs[i].claimed = true;
1085     }
1086
1087     udev->ninterfaces   = conf->bNumInterfaces;
1088     udev->configuration = configuration;
1089
1090     libusb_free_config_descriptor(conf);
1091     return USB_RET_SUCCESS;
1092 }
1093
1094 static void usb_host_release_interfaces(USBHostDevice *s)
1095 {
1096     USBDevice *udev = USB_DEVICE(s);
1097     int i, rc;
1098
1099     for (i = 0; i < udev->ninterfaces; i++) {
1100         if (!s->ifs[i].claimed) {
1101             continue;
1102         }
1103         trace_usb_host_release_interface(s->bus_num, s->addr, i);
1104         rc = libusb_release_interface(s->dh, i);
1105         usb_host_libusb_error("libusb_release_interface", rc);
1106         s->ifs[i].claimed = false;
1107     }
1108 }
1109
1110 static void usb_host_set_address(USBHostDevice *s, int addr)
1111 {
1112     USBDevice *udev = USB_DEVICE(s);
1113
1114     trace_usb_host_set_address(s->bus_num, s->addr, addr);
1115     udev->addr = addr;
1116 }
1117
1118 static void usb_host_set_config(USBHostDevice *s, int config, USBPacket *p)
1119 {
1120     int rc;
1121
1122     trace_usb_host_set_config(s->bus_num, s->addr, config);
1123
1124     usb_host_release_interfaces(s);
1125     rc = libusb_set_configuration(s->dh, config);
1126     if (rc != 0) {
1127         usb_host_libusb_error("libusb_set_configuration", rc);
1128         p->status = USB_RET_STALL;
1129         if (rc == LIBUSB_ERROR_NO_DEVICE) {
1130             usb_host_nodev(s);
1131         }
1132         return;
1133     }
1134     p->status = usb_host_claim_interfaces(s, config);
1135     if (p->status != USB_RET_SUCCESS) {
1136         return;
1137     }
1138     usb_host_ep_update(s);
1139 }
1140
1141 static void usb_host_set_interface(USBHostDevice *s, int iface, int alt,
1142                                    USBPacket *p)
1143 {
1144     USBDevice *udev = USB_DEVICE(s);
1145     int rc;
1146
1147     trace_usb_host_set_interface(s->bus_num, s->addr, iface, alt);
1148
1149     usb_host_iso_free_all(s);
1150
1151     if (iface >= USB_MAX_INTERFACES) {
1152         p->status = USB_RET_STALL;
1153         return;
1154     }
1155
1156     rc = libusb_set_interface_alt_setting(s->dh, iface, alt);
1157     if (rc != 0) {
1158         usb_host_libusb_error("libusb_set_interface_alt_setting", rc);
1159         p->status = USB_RET_STALL;
1160         if (rc == LIBUSB_ERROR_NO_DEVICE) {
1161             usb_host_nodev(s);
1162         }
1163         return;
1164     }
1165
1166     udev->altsetting[iface] = alt;
1167     usb_host_ep_update(s);
1168 }
1169
1170 static void usb_host_handle_control(USBDevice *udev, USBPacket *p,
1171                                     int request, int value, int index,
1172                                     int length, uint8_t *data)
1173 {
1174     USBHostDevice *s = USB_HOST_DEVICE(udev);
1175     USBHostRequest *r;
1176     int rc;
1177
1178     trace_usb_host_req_control(s->bus_num, s->addr, p, request, value, index);
1179
1180     if (s->dh == NULL) {
1181         p->status = USB_RET_NODEV;
1182         trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1183         return;
1184     }
1185
1186     switch (request) {
1187     case DeviceOutRequest | USB_REQ_SET_ADDRESS:
1188         usb_host_set_address(s, value);
1189         trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1190         return;
1191
1192     case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
1193         usb_host_set_config(s, value & 0xff, p);
1194         trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1195         return;
1196
1197     case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
1198         usb_host_set_interface(s, index, value, p);
1199         trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1200         return;
1201
1202     case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
1203         if (value == 0) { /* clear halt */
1204             int pid = (index & USB_DIR_IN) ? USB_TOKEN_IN : USB_TOKEN_OUT;
1205             libusb_clear_halt(s->dh, index);
1206             usb_ep_set_halted(udev, pid, index & 0x0f, 0);
1207             trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1208             return;
1209         }
1210     }
1211
1212     r = usb_host_req_alloc(s, p, (request >> 8) & USB_DIR_IN, length + 8);
1213     r->cbuf = data;
1214     r->clen = length;
1215     memcpy(r->buffer, udev->setup_buf, 8);
1216     if (!r->in) {
1217         memcpy(r->buffer + 8, r->cbuf, r->clen);
1218     }
1219
1220     /* Fix up USB-3 ep0 maxpacket size to allow superspeed connected devices
1221      * to work redirected to a not superspeed capable hcd */
1222     if (udev->speed == USB_SPEED_SUPER &&
1223         !((udev->port->speedmask & USB_SPEED_MASK_SUPER)) &&
1224         request == 0x8006 && value == 0x100 && index == 0) {
1225         r->usb3ep0quirk = true;
1226     }
1227
1228     libusb_fill_control_transfer(r->xfer, s->dh, r->buffer,
1229                                  usb_host_req_complete_ctrl, r,
1230                                  CONTROL_TIMEOUT);
1231     rc = libusb_submit_transfer(r->xfer);
1232     if (rc != 0) {
1233         p->status = USB_RET_NODEV;
1234         trace_usb_host_req_complete(s->bus_num, s->addr, p,
1235                                     p->status, p->actual_length);
1236         if (rc == LIBUSB_ERROR_NO_DEVICE) {
1237             usb_host_nodev(s);
1238         }
1239         return;
1240     }
1241
1242     p->status = USB_RET_ASYNC;
1243 }
1244
1245 static void usb_host_handle_data(USBDevice *udev, USBPacket *p)
1246 {
1247     USBHostDevice *s = USB_HOST_DEVICE(udev);
1248     USBHostRequest *r;
1249     size_t size;
1250     int ep, rc;
1251
1252     if (usb_host_use_combining(p->ep) && p->state == USB_PACKET_SETUP) {
1253         p->status = USB_RET_ADD_TO_QUEUE;
1254         return;
1255     }
1256
1257     trace_usb_host_req_data(s->bus_num, s->addr, p,
1258                             p->pid == USB_TOKEN_IN,
1259                             p->ep->nr, p->iov.size);
1260
1261     if (s->dh == NULL) {
1262         p->status = USB_RET_NODEV;
1263         trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1264         return;
1265     }
1266     if (p->ep->halted) {
1267         p->status = USB_RET_STALL;
1268         trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1269         return;
1270     }
1271
1272     switch (usb_ep_get_type(udev, p->pid, p->ep->nr)) {
1273     case USB_ENDPOINT_XFER_BULK:
1274         size = usb_packet_size(p);
1275         r = usb_host_req_alloc(s, p, p->pid == USB_TOKEN_IN, size);
1276         if (!r->in) {
1277             usb_packet_copy(p, r->buffer, size);
1278         }
1279         ep = p->ep->nr | (r->in ? USB_DIR_IN : 0);
1280         if (p->stream) {
1281 #ifdef HAVE_STREAMS
1282             libusb_fill_bulk_stream_transfer(r->xfer, s->dh, ep, p->stream,
1283                                              r->buffer, size,
1284                                              usb_host_req_complete_data, r,
1285                                              BULK_TIMEOUT);
1286 #else
1287             usb_host_req_free(r);
1288             p->status = USB_RET_STALL;
1289             return;
1290 #endif
1291         } else {
1292             libusb_fill_bulk_transfer(r->xfer, s->dh, ep,
1293                                       r->buffer, size,
1294                                       usb_host_req_complete_data, r,
1295                                       BULK_TIMEOUT);
1296         }
1297         break;
1298     case USB_ENDPOINT_XFER_INT:
1299         r = usb_host_req_alloc(s, p, p->pid == USB_TOKEN_IN, p->iov.size);
1300         if (!r->in) {
1301             usb_packet_copy(p, r->buffer, p->iov.size);
1302         }
1303         ep = p->ep->nr | (r->in ? USB_DIR_IN : 0);
1304         libusb_fill_interrupt_transfer(r->xfer, s->dh, ep,
1305                                        r->buffer, p->iov.size,
1306                                        usb_host_req_complete_data, r,
1307                                        INTR_TIMEOUT);
1308         break;
1309     case USB_ENDPOINT_XFER_ISOC:
1310         if (p->pid == USB_TOKEN_IN) {
1311             usb_host_iso_data_in(s, p);
1312         } else {
1313             usb_host_iso_data_out(s, p);
1314         }
1315         trace_usb_host_req_complete(s->bus_num, s->addr, p,
1316                                     p->status, p->actual_length);
1317         return;
1318     default:
1319         p->status = USB_RET_STALL;
1320         trace_usb_host_req_complete(s->bus_num, s->addr, p,
1321                                     p->status, p->actual_length);
1322         return;
1323     }
1324
1325     rc = libusb_submit_transfer(r->xfer);
1326     if (rc != 0) {
1327         p->status = USB_RET_NODEV;
1328         trace_usb_host_req_complete(s->bus_num, s->addr, p,
1329                                     p->status, p->actual_length);
1330         if (rc == LIBUSB_ERROR_NO_DEVICE) {
1331             usb_host_nodev(s);
1332         }
1333         return;
1334     }
1335
1336     p->status = USB_RET_ASYNC;
1337 }
1338
1339 static void usb_host_flush_ep_queue(USBDevice *dev, USBEndpoint *ep)
1340 {
1341     if (usb_host_use_combining(ep)) {
1342         usb_ep_combine_input_packets(ep);
1343     }
1344 }
1345
1346 static void usb_host_handle_reset(USBDevice *udev)
1347 {
1348     USBHostDevice *s = USB_HOST_DEVICE(udev);
1349     int rc;
1350
1351     trace_usb_host_reset(s->bus_num, s->addr);
1352
1353     rc = libusb_reset_device(s->dh);
1354     if (rc != 0) {
1355         usb_host_nodev(s);
1356     }
1357 }
1358
1359 static int usb_host_alloc_streams(USBDevice *udev, USBEndpoint **eps,
1360                                   int nr_eps, int streams)
1361 {
1362 #ifdef HAVE_STREAMS
1363     USBHostDevice *s = USB_HOST_DEVICE(udev);
1364     unsigned char endpoints[30];
1365     int i, rc;
1366
1367     for (i = 0; i < nr_eps; i++) {
1368         endpoints[i] = eps[i]->nr;
1369         if (eps[i]->pid == USB_TOKEN_IN) {
1370             endpoints[i] |= 0x80;
1371         }
1372     }
1373     rc = libusb_alloc_streams(s->dh, streams, endpoints, nr_eps);
1374     if (rc < 0) {
1375         usb_host_libusb_error("libusb_alloc_streams", rc);
1376     } else if (rc != streams) {
1377         fprintf(stderr,
1378             "libusb_alloc_streams: got less streams then requested %d < %d\n",
1379             rc, streams);
1380     }
1381
1382     return (rc == streams) ? 0 : -1;
1383 #else
1384     fprintf(stderr, "libusb_alloc_streams: error not implemented\n");
1385     return -1;
1386 #endif
1387 }
1388
1389 static void usb_host_free_streams(USBDevice *udev, USBEndpoint **eps,
1390                                   int nr_eps)
1391 {
1392 #ifdef HAVE_STREAMS
1393     USBHostDevice *s = USB_HOST_DEVICE(udev);
1394     unsigned char endpoints[30];
1395     int i;
1396
1397     for (i = 0; i < nr_eps; i++) {
1398         endpoints[i] = eps[i]->nr;
1399         if (eps[i]->pid == USB_TOKEN_IN) {
1400             endpoints[i] |= 0x80;
1401         }
1402     }
1403     libusb_free_streams(s->dh, endpoints, nr_eps);
1404 #endif
1405 }
1406
1407 /*
1408  * This is *NOT* about restoring state.  We have absolutely no idea
1409  * what state the host device is in at the moment and whenever it is
1410  * still present in the first place.  Attemping to contine where we
1411  * left off is impossible.
1412  *
1413  * What we are going to to to here is emulate a surprise removal of
1414  * the usb device passed through, then kick host scan so the device
1415  * will get re-attached (and re-initialized by the guest) in case it
1416  * is still present.
1417  *
1418  * As the device removal will change the state of other devices (usb
1419  * host controller, most likely interrupt controller too) we have to
1420  * wait with it until *all* vmstate is loaded.  Thus post_load just
1421  * kicks a bottom half which then does the actual work.
1422  */
1423 static void usb_host_post_load_bh(void *opaque)
1424 {
1425     USBHostDevice *dev = opaque;
1426     USBDevice *udev = USB_DEVICE(dev);
1427
1428     if (dev->dh != NULL) {
1429         usb_host_close(dev);
1430     }
1431     if (udev->attached) {
1432         usb_device_detach(udev);
1433     }
1434     usb_host_auto_check(NULL);
1435 }
1436
1437 static int usb_host_post_load(void *opaque, int version_id)
1438 {
1439     USBHostDevice *dev = opaque;
1440
1441     if (!dev->bh_postld) {
1442         dev->bh_postld = qemu_bh_new(usb_host_post_load_bh, dev);
1443     }
1444     qemu_bh_schedule(dev->bh_postld);
1445     return 0;
1446 }
1447
1448 static const VMStateDescription vmstate_usb_host = {
1449     .name = "usb-host",
1450     .version_id = 1,
1451     .minimum_version_id = 1,
1452     .post_load = usb_host_post_load,
1453     .fields = (VMStateField[]) {
1454         VMSTATE_USB_DEVICE(parent_obj, USBHostDevice),
1455         VMSTATE_END_OF_LIST()
1456     }
1457 };
1458
1459 static Property usb_host_dev_properties[] = {
1460     DEFINE_PROP_UINT32("hostbus",  USBHostDevice, match.bus_num,    0),
1461     DEFINE_PROP_UINT32("hostaddr", USBHostDevice, match.addr,       0),
1462     DEFINE_PROP_STRING("hostport", USBHostDevice, match.port),
1463     DEFINE_PROP_UINT32("vendorid",  USBHostDevice, match.vendor_id,  0),
1464     DEFINE_PROP_UINT32("productid", USBHostDevice, match.product_id, 0),
1465     DEFINE_PROP_UINT32("isobufs",  USBHostDevice, iso_urb_count,    4),
1466     DEFINE_PROP_UINT32("isobsize", USBHostDevice, iso_urb_frames,   32),
1467     DEFINE_PROP_INT32("bootindex", USBHostDevice, bootindex,        -1),
1468     DEFINE_PROP_UINT32("loglevel",  USBHostDevice, loglevel,
1469                        LIBUSB_LOG_LEVEL_WARNING),
1470     DEFINE_PROP_BIT("pipeline",    USBHostDevice, options,
1471                     USB_HOST_OPT_PIPELINE, true),
1472     DEFINE_PROP_END_OF_LIST(),
1473 };
1474
1475 static void usb_host_class_initfn(ObjectClass *klass, void *data)
1476 {
1477     DeviceClass *dc = DEVICE_CLASS(klass);
1478     USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
1479
1480     uc->init           = usb_host_initfn;
1481     uc->product_desc   = "USB Host Device";
1482     uc->cancel_packet  = usb_host_cancel_packet;
1483     uc->handle_data    = usb_host_handle_data;
1484     uc->handle_control = usb_host_handle_control;
1485     uc->handle_reset   = usb_host_handle_reset;
1486     uc->handle_destroy = usb_host_handle_destroy;
1487     uc->flush_ep_queue = usb_host_flush_ep_queue;
1488     uc->alloc_streams  = usb_host_alloc_streams;
1489     uc->free_streams   = usb_host_free_streams;
1490     dc->vmsd = &vmstate_usb_host;
1491     dc->props = usb_host_dev_properties;
1492     set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
1493 }
1494
1495 static TypeInfo usb_host_dev_info = {
1496     .name          = TYPE_USB_HOST_DEVICE,
1497     .parent        = TYPE_USB_DEVICE,
1498     .instance_size = sizeof(USBHostDevice),
1499     .class_init    = usb_host_class_initfn,
1500 };
1501
1502 static void usb_host_register_types(void)
1503 {
1504     type_register_static(&usb_host_dev_info);
1505 }
1506
1507 type_init(usb_host_register_types)
1508
1509 /* ------------------------------------------------------------------------ */
1510
1511 static QEMUTimer *usb_auto_timer;
1512 static VMChangeStateEntry *usb_vmstate;
1513
1514 static void usb_host_vm_state(void *unused, int running, RunState state)
1515 {
1516     if (running) {
1517         usb_host_auto_check(unused);
1518     }
1519 }
1520
1521 static void usb_host_auto_check(void *unused)
1522 {
1523     struct USBHostDevice *s;
1524     struct USBAutoFilter *f;
1525     libusb_device **devs;
1526     struct libusb_device_descriptor ddesc;
1527     int unconnected = 0;
1528     int i, n;
1529
1530     if (usb_host_init() != 0) {
1531         return;
1532     }
1533
1534     if (runstate_is_running()) {
1535         n = libusb_get_device_list(ctx, &devs);
1536         for (i = 0; i < n; i++) {
1537             if (libusb_get_device_descriptor(devs[i], &ddesc) != 0) {
1538                 continue;
1539             }
1540             if (ddesc.bDeviceClass == LIBUSB_CLASS_HUB) {
1541                 continue;
1542             }
1543             QTAILQ_FOREACH(s, &hostdevs, next) {
1544                 f = &s->match;
1545                 if (f->bus_num > 0 &&
1546                     f->bus_num != libusb_get_bus_number(devs[i])) {
1547                     continue;
1548                 }
1549                 if (f->addr > 0 &&
1550                     f->addr != libusb_get_device_address(devs[i])) {
1551                     continue;
1552                 }
1553                 if (f->port != NULL) {
1554                     char port[16] = "-";
1555                     usb_host_get_port(devs[i], port, sizeof(port));
1556                     if (strcmp(f->port, port) != 0) {
1557                         continue;
1558                     }
1559                 }
1560                 if (f->vendor_id > 0 &&
1561                     f->vendor_id != ddesc.idVendor) {
1562                     continue;
1563                 }
1564                 if (f->product_id > 0 &&
1565                     f->product_id != ddesc.idProduct) {
1566                     continue;
1567                 }
1568
1569                 /* We got a match */
1570                 s->seen++;
1571                 if (s->errcount >= 3) {
1572                     continue;
1573                 }
1574                 if (s->dh != NULL) {
1575                     continue;
1576                 }
1577                 if (usb_host_open(s, devs[i]) < 0) {
1578                     s->errcount++;
1579                     continue;
1580                 }
1581                 break;
1582             }
1583         }
1584         libusb_free_device_list(devs, 1);
1585
1586         QTAILQ_FOREACH(s, &hostdevs, next) {
1587             if (s->dh == NULL) {
1588                 unconnected++;
1589             }
1590             if (s->seen == 0) {
1591                 if (s->dh) {
1592                     usb_host_close(s);
1593                 }
1594                 s->errcount = 0;
1595             }
1596             s->seen = 0;
1597         }
1598
1599 #if 0
1600         if (unconnected == 0) {
1601             /* nothing to watch */
1602             if (usb_auto_timer) {
1603                 timer_del(usb_auto_timer);
1604                 trace_usb_host_auto_scan_disabled();
1605             }
1606             return;
1607         }
1608 #endif
1609     }
1610
1611     if (!usb_vmstate) {
1612         usb_vmstate = qemu_add_vm_change_state_handler(usb_host_vm_state, NULL);
1613     }
1614     if (!usb_auto_timer) {
1615         usb_auto_timer = timer_new_ms(QEMU_CLOCK_REALTIME, usb_host_auto_check, NULL);
1616         if (!usb_auto_timer) {
1617             return;
1618         }
1619         trace_usb_host_auto_scan_enabled();
1620     }
1621     timer_mod(usb_auto_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + 2000);
1622 }
1623
1624 void usb_host_info(Monitor *mon, const QDict *qdict)
1625 {
1626     libusb_device **devs;
1627     struct libusb_device_descriptor ddesc;
1628     char port[16];
1629     int i, n;
1630
1631     if (usb_host_init() != 0) {
1632         return;
1633     }
1634
1635     n = libusb_get_device_list(ctx, &devs);
1636     for (i = 0; i < n; i++) {
1637         if (libusb_get_device_descriptor(devs[i], &ddesc) != 0) {
1638             continue;
1639         }
1640         if (ddesc.bDeviceClass == LIBUSB_CLASS_HUB) {
1641             continue;
1642         }
1643         usb_host_get_port(devs[i], port, sizeof(port));
1644         monitor_printf(mon, "  Bus %d, Addr %d, Port %s, Speed %s Mb/s\n",
1645                        libusb_get_bus_number(devs[i]),
1646                        libusb_get_device_address(devs[i]),
1647                        port,
1648                        speed_name[libusb_get_device_speed(devs[i])]);
1649         monitor_printf(mon, "    Class %02x:", ddesc.bDeviceClass);
1650         monitor_printf(mon, " USB device %04x:%04x",
1651                        ddesc.idVendor, ddesc.idProduct);
1652         if (ddesc.iProduct) {
1653             libusb_device_handle *handle;
1654             if (libusb_open(devs[i], &handle) == 0) {
1655                 unsigned char name[64] = "";
1656                 libusb_get_string_descriptor_ascii(handle,
1657                                                    ddesc.iProduct,
1658                                                    name, sizeof(name));
1659                 libusb_close(handle);
1660                 monitor_printf(mon, ", %s", name);
1661             }
1662         }
1663         monitor_printf(mon, "\n");
1664     }
1665     libusb_free_device_list(devs, 1);
1666 }