host-libusb: remove bootindex property from qdev to qom
[qemu.git] / hw / usb / host-libusb.c
blob906e4298e909545915803791c203addef9bdc5d9
1 /*
2 * Linux host USB redirector
4 * Copyright (c) 2005 Fabrice Bellard
6 * Copyright (c) 2008 Max Krasnyansky
7 * Support for host device auto connect & disconnect
8 * Major rewrite to support fully async operation
10 * Copyright 2008 TJ <linux@tjworld.net>
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
14 * (c) 2012 Gerd Hoffmann <kraxel@redhat.com>
15 * Completely rewritten to use libusb instead of usbfs ioctls.
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:
24 * The above copyright notice and this permission notice shall be included in
25 * all copies or substantial portions of the Software.
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.
36 #include <poll.h>
37 #include <libusb.h>
39 #include "qemu-common.h"
40 #include "monitor/monitor.h"
41 #include "sysemu/sysemu.h"
42 #include "trace.h"
44 #include "hw/usb.h"
46 /* ------------------------------------------------------------------------ */
48 #define TYPE_USB_HOST_DEVICE "usb-host"
49 #define USB_HOST_DEVICE(obj) \
50 OBJECT_CHECK(USBHostDevice, (obj), TYPE_USB_HOST_DEVICE)
52 typedef struct USBHostDevice USBHostDevice;
53 typedef struct USBHostRequest USBHostRequest;
54 typedef struct USBHostIsoXfer USBHostIsoXfer;
55 typedef struct USBHostIsoRing USBHostIsoRing;
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;
65 enum USBHostDeviceOptions {
66 USB_HOST_OPT_PIPELINE,
69 struct USBHostDevice {
70 USBDevice parent_obj;
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;
80 /* state */
81 QTAILQ_ENTRY(USBHostDevice) next;
82 int seen, errcount;
83 int bus_num;
84 int addr;
85 char port[16];
87 libusb_device *dev;
88 libusb_device_handle *dh;
89 struct libusb_device_descriptor ddesc;
91 struct {
92 bool detached;
93 bool claimed;
94 } ifs[USB_MAX_INTERFACES];
96 /* callbacks & friends */
97 QEMUBH *bh_nodev;
98 QEMUBH *bh_postld;
99 Notifier exit;
101 /* request queues */
102 QTAILQ_HEAD(, USBHostRequest) requests;
103 QTAILQ_HEAD(, USBHostIsoRing) isorings;
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;
118 struct USBHostIsoXfer {
119 USBHostIsoRing *ring;
120 struct libusb_transfer *xfer;
121 bool copy_complete;
122 unsigned int packet;
123 QTAILQ_ENTRY(USBHostIsoXfer) next;
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;
135 static QTAILQ_HEAD(, USBHostDevice) hostdevs =
136 QTAILQ_HEAD_INITIALIZER(hostdevs);
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);
144 /* ------------------------------------------------------------------------ */
146 #define CONTROL_TIMEOUT 10000 /* 10 sec */
147 #define BULK_TIMEOUT 0 /* unlimited */
148 #define INTR_TIMEOUT 0 /* unlimited */
150 #if LIBUSBX_API_VERSION >= 0x01000103
151 # define HAVE_STREAMS 1
152 #endif
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",
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,
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,
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",
195 static libusb_context *ctx;
196 static uint32_t loglevel;
198 static void usb_host_handle_fd(void *opaque)
200 struct timeval tv = { 0, 0 };
201 libusb_handle_events_timeout(ctx, &tv);
204 static void usb_host_add_fd(int fd, short events, void *user_data)
206 qemu_set_fd_handler(fd,
207 (events & POLLIN) ? usb_host_handle_fd : NULL,
208 (events & POLLOUT) ? usb_host_handle_fd : NULL,
209 ctx);
212 static void usb_host_del_fd(int fd, void *user_data)
214 qemu_set_fd_handler(fd, NULL, NULL, NULL);
217 static int usb_host_init(void)
219 const struct libusb_pollfd **poll;
220 int i, rc;
222 if (ctx) {
223 return 0;
225 rc = libusb_init(&ctx);
226 if (rc != 0) {
227 return -1;
229 libusb_set_debug(ctx, loglevel);
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);
240 free(poll);
241 return 0;
244 static int usb_host_get_port(libusb_device *dev, char *port, size_t len)
246 uint8_t path[7];
247 size_t off;
248 int rc, i;
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;
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]);
262 return off;
265 static void usb_host_libusb_error(const char *func, int rc)
267 const char *errname;
269 if (rc >= 0) {
270 return;
273 if (-rc < ARRAY_SIZE(err_names) && err_names[-rc]) {
274 errname = err_names[-rc];
275 } else {
276 errname = "?";
278 error_report("%s: %d [%s]", func, rc, errname);
281 /* ------------------------------------------------------------------------ */
283 static bool usb_host_use_combining(USBEndpoint *ep)
285 int type;
287 if (!ep->pipeline) {
288 return false;
290 if (ep->pid != USB_TOKEN_IN) {
291 return false;
293 type = usb_ep_get_type(ep->dev, ep->pid, ep->nr);
294 if (type != USB_ENDPOINT_XFER_BULK) {
295 return false;
297 return true;
300 /* ------------------------------------------------------------------------ */
302 static USBHostRequest *usb_host_req_alloc(USBHostDevice *s, USBPacket *p,
303 bool in, size_t bufsize)
305 USBHostRequest *r = g_new0(USBHostRequest, 1);
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);
314 QTAILQ_INSERT_TAIL(&s->requests, r, next);
315 return r;
318 static void usb_host_req_free(USBHostRequest *r)
320 if (r->host) {
321 QTAILQ_REMOVE(&r->host->requests, r, next);
323 libusb_free_transfer(r->xfer);
324 g_free(r->buffer);
325 g_free(r);
328 static USBHostRequest *usb_host_req_find(USBHostDevice *s, USBPacket *p)
330 USBHostRequest *r;
332 QTAILQ_FOREACH(r, &s->requests, next) {
333 if (r->p == p) {
334 return r;
337 return NULL;
340 static void usb_host_req_complete_ctrl(struct libusb_transfer *xfer)
342 USBHostRequest *r = xfer->user_data;
343 USBHostDevice *s = r->host;
344 bool disconnect = (xfer->status == LIBUSB_TRANSFER_NO_DEVICE);
346 if (r->p == NULL) {
347 goto out; /* request was canceled */
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);
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;
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);
366 out:
367 usb_host_req_free(r);
368 if (disconnect) {
369 usb_host_nodev(s);
373 static void usb_host_req_complete_data(struct libusb_transfer *xfer)
375 USBHostRequest *r = xfer->user_data;
376 USBHostDevice *s = r->host;
377 bool disconnect = (xfer->status == LIBUSB_TRANSFER_NO_DEVICE);
379 if (r->p == NULL) {
380 goto out; /* request was canceled */
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);
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);
395 out:
396 usb_host_req_free(r);
397 if (disconnect) {
398 usb_host_nodev(s);
402 static void usb_host_req_abort(USBHostRequest *r)
404 USBHostDevice *s = r->host;
405 bool inflight = (r->p && r->p->state == USB_PACKET_ASYNC);
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);
416 r->p = NULL;
419 QTAILQ_REMOVE(&r->host->requests, r, next);
420 r->host = NULL;
422 if (inflight) {
423 libusb_cancel_transfer(r->xfer);
427 /* ------------------------------------------------------------------------ */
429 static void usb_host_req_complete_iso(struct libusb_transfer *transfer)
431 USBHostIsoXfer *xfer = transfer->user_data;
433 if (!xfer) {
434 /* USBHostIsoXfer released while inflight */
435 g_free(transfer->buffer);
436 libusb_free_transfer(transfer);
437 return;
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);
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);
452 static USBHostIsoRing *usb_host_iso_alloc(USBHostDevice *s, USBEndpoint *ep)
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;
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);
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;
474 xfer->xfer->endpoint = ring->ep->nr;
475 if (ring->ep->pid == USB_TOKEN_IN) {
476 xfer->xfer->endpoint |= USB_DIR_IN;
478 xfer->xfer->callback = usb_host_req_complete_iso;
479 xfer->xfer->user_data = xfer;
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);
485 QTAILQ_INSERT_TAIL(&ring->unused, xfer, next);
488 return ring;
491 static USBHostIsoRing *usb_host_iso_find(USBHostDevice *s, USBEndpoint *ep)
493 USBHostIsoRing *ring;
495 QTAILQ_FOREACH(ring, &s->isorings, next) {
496 if (ring->ep == ep) {
497 return ring;
500 return NULL;
503 static void usb_host_iso_reset_xfer(USBHostIsoXfer *xfer)
505 libusb_set_iso_packet_lengths(xfer->xfer,
506 xfer->ring->ep->max_packet_size);
507 xfer->packet = 0;
508 xfer->copy_complete = false;
511 static void usb_host_iso_free_xfer(USBHostIsoXfer *xfer, bool inflight)
513 if (inflight) {
514 xfer->xfer->user_data = NULL;
515 } else {
516 g_free(xfer->xfer->buffer);
517 libusb_free_transfer(xfer->xfer);
519 g_free(xfer);
522 static void usb_host_iso_free(USBHostIsoRing *ring)
524 USBHostIsoXfer *xfer;
526 while ((xfer = QTAILQ_FIRST(&ring->inflight)) != NULL) {
527 QTAILQ_REMOVE(&ring->inflight, xfer, next);
528 usb_host_iso_free_xfer(xfer, true);
530 while ((xfer = QTAILQ_FIRST(&ring->unused)) != NULL) {
531 QTAILQ_REMOVE(&ring->unused, xfer, next);
532 usb_host_iso_free_xfer(xfer, false);
534 while ((xfer = QTAILQ_FIRST(&ring->copy)) != NULL) {
535 QTAILQ_REMOVE(&ring->copy, xfer, next);
536 usb_host_iso_free_xfer(xfer, false);
539 QTAILQ_REMOVE(&ring->host->isorings, ring, next);
540 g_free(ring);
543 static void usb_host_iso_free_all(USBHostDevice *s)
545 USBHostIsoRing *ring;
547 while ((ring = QTAILQ_FIRST(&s->isorings)) != NULL) {
548 usb_host_iso_free(ring);
552 static bool usb_host_iso_data_copy(USBHostIsoXfer *xfer, USBPacket *p)
554 unsigned int psize;
555 unsigned char *buf;
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;
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;
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;
578 static void usb_host_iso_data_in(USBHostDevice *s, USBPacket *p)
580 USBHostIsoRing *ring;
581 USBHostIsoXfer *xfer;
582 bool disconnect = false;
583 int rc;
585 ring = usb_host_iso_find(s, p->ep);
586 if (ring == NULL) {
587 ring = usb_host_iso_alloc(s, p->ep);
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);
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;
610 break;
612 if (QTAILQ_EMPTY(&ring->inflight)) {
613 trace_usb_host_iso_start(s->bus_num, s->addr, p->ep->nr);
615 QTAILQ_INSERT_TAIL(&ring->inflight, xfer, next);
618 if (disconnect) {
619 usb_host_nodev(s);
623 static void usb_host_iso_data_out(USBHostDevice *s, USBPacket *p)
625 USBHostIsoRing *ring;
626 USBHostIsoXfer *xfer;
627 bool disconnect = false;
628 int rc, filled = 0;
630 ring = usb_host_iso_find(s, p->ep);
631 if (ring == NULL) {
632 ring = usb_host_iso_alloc(s, p->ep);
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);
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;
647 QTAILQ_REMOVE(&ring->unused, xfer, next);
648 usb_host_iso_reset_xfer(xfer);
649 QTAILQ_INSERT_TAIL(&ring->copy, xfer, next);
651 usb_host_iso_data_copy(xfer, p);
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;
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;
672 break;
674 if (QTAILQ_EMPTY(&ring->inflight)) {
675 trace_usb_host_iso_start(s->bus_num, s->addr, p->ep->nr);
677 QTAILQ_INSERT_TAIL(&ring->inflight, xfer, next);
680 if (disconnect) {
681 usb_host_nodev(s);
685 /* ------------------------------------------------------------------------ */
687 static void usb_host_speed_compat(USBHostDevice *s)
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;
701 for (c = 0;; c++) {
702 rc = libusb_get_config_descriptor(s->dev, c, &conf);
703 if (rc != 0) {
704 break;
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;
727 #endif
728 break;
729 case 0x03: /* INTERRUPT */
730 if (endp->wMaxPacketSize > 64) {
731 compat_full = false;
733 if (endp->wMaxPacketSize > 1024) {
734 compat_high = false;
736 break;
741 libusb_free_config_descriptor(conf);
744 udev->speedmask = (1 << udev->speed);
745 if (udev->speed == USB_SPEED_SUPER && compat_high) {
746 udev->speedmask |= USB_SPEED_HIGH;
748 if (udev->speed == USB_SPEED_SUPER && compat_full) {
749 udev->speedmask |= USB_SPEED_FULL;
751 if (udev->speed == USB_SPEED_HIGH && compat_full) {
752 udev->speedmask |= USB_SPEED_FULL;
756 static void usb_host_ep_update(USBHostDevice *s)
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",
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;
775 usb_ep_reset(udev);
776 rc = libusb_get_active_config_descriptor(s->dev, &conf);
777 if (rc != 0) {
778 return;
780 trace_usb_host_parse_config(s->bus_num, s->addr,
781 conf->bConfigurationValue, true);
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];
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;
797 if (ep == 0) {
798 trace_usb_host_parse_error(s->bus_num, s->addr,
799 "invalid endpoint address");
800 return;
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;
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);
824 #endif
828 libusb_free_config_descriptor(conf);
831 static int usb_host_open(USBHostDevice *s, libusb_device *dev)
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 Error *local_err = NULL;
839 trace_usb_host_open_started(bus_num, addr);
841 if (s->dh != NULL) {
842 goto fail;
844 rc = libusb_open(dev, &s->dh);
845 if (rc != 0) {
846 goto fail;
849 s->dev = dev;
850 s->bus_num = bus_num;
851 s->addr = addr;
853 usb_host_detach_kernel(s);
855 libusb_get_device_descriptor(dev, &s->ddesc);
856 usb_host_get_port(s->dev, s->port, sizeof(s->port));
858 usb_ep_init(udev);
859 usb_host_ep_update(s);
861 udev->speed = speed_map[libusb_get_device_speed(dev)];
862 usb_host_speed_compat(s);
864 if (s->ddesc.iProduct) {
865 libusb_get_string_descriptor_ascii(s->dh, s->ddesc.iProduct,
866 (unsigned char *)udev->product_desc,
867 sizeof(udev->product_desc));
868 } else {
869 snprintf(udev->product_desc, sizeof(udev->product_desc),
870 "host:%d.%d", bus_num, addr);
873 usb_device_attach(udev, &local_err);
874 if (local_err) {
875 error_report("%s", error_get_pretty(local_err));
876 error_free(local_err);
877 goto fail;
880 trace_usb_host_open_success(bus_num, addr);
881 return 0;
883 fail:
884 trace_usb_host_open_failure(bus_num, addr);
885 if (s->dh != NULL) {
886 libusb_close(s->dh);
887 s->dh = NULL;
888 s->dev = NULL;
890 return -1;
893 static void usb_host_abort_xfers(USBHostDevice *s)
895 USBHostRequest *r, *rtmp;
897 QTAILQ_FOREACH_SAFE(r, &s->requests, next, rtmp) {
898 usb_host_req_abort(r);
902 static int usb_host_close(USBHostDevice *s)
904 USBDevice *udev = USB_DEVICE(s);
906 if (s->dh == NULL) {
907 return -1;
910 trace_usb_host_close(s->bus_num, s->addr);
912 usb_host_abort_xfers(s);
913 usb_host_iso_free_all(s);
915 if (udev->attached) {
916 usb_device_detach(udev);
919 usb_host_release_interfaces(s);
920 libusb_reset_device(s->dh);
921 usb_host_attach_kernel(s);
922 libusb_close(s->dh);
923 s->dh = NULL;
924 s->dev = NULL;
926 usb_host_auto_check(NULL);
927 return 0;
930 static void usb_host_nodev_bh(void *opaque)
932 USBHostDevice *s = opaque;
933 usb_host_close(s);
936 static void usb_host_nodev(USBHostDevice *s)
938 if (!s->bh_nodev) {
939 s->bh_nodev = qemu_bh_new(usb_host_nodev_bh, s);
941 qemu_bh_schedule(s->bh_nodev);
944 static void usb_host_exit_notifier(struct Notifier *n, void *data)
946 USBHostDevice *s = container_of(n, USBHostDevice, exit);
948 if (s->dh) {
949 usb_host_release_interfaces(s);
950 usb_host_attach_kernel(s);
954 static void usb_host_realize(USBDevice *udev, Error **errp)
956 USBHostDevice *s = USB_HOST_DEVICE(udev);
958 if (s->match.vendor_id > 0xffff) {
959 error_setg(errp, "vendorid out of range");
960 return;
962 if (s->match.product_id > 0xffff) {
963 error_setg(errp, "productid out of range");
964 return;
966 if (s->match.addr > 127) {
967 error_setg(errp, "hostaddr out of range");
968 return;
971 loglevel = s->loglevel;
972 udev->flags |= (1 << USB_DEV_FLAG_IS_HOST);
973 udev->auto_attach = 0;
974 QTAILQ_INIT(&s->requests);
975 QTAILQ_INIT(&s->isorings);
977 s->exit.notify = usb_host_exit_notifier;
978 qemu_add_exit_notifier(&s->exit);
980 QTAILQ_INSERT_TAIL(&hostdevs, s, next);
981 add_boot_device_path(s->bootindex, &udev->qdev, NULL);
982 usb_host_auto_check(NULL);
985 static void usb_host_instance_init(Object *obj)
987 USBDevice *udev = USB_DEVICE(obj);
988 USBHostDevice *s = USB_HOST_DEVICE(udev);
990 device_add_bootindex_property(obj, &s->bootindex,
991 "bootindex", NULL,
992 &udev->qdev, NULL);
995 static void usb_host_handle_destroy(USBDevice *udev)
997 USBHostDevice *s = USB_HOST_DEVICE(udev);
999 qemu_remove_exit_notifier(&s->exit);
1000 QTAILQ_REMOVE(&hostdevs, s, next);
1001 usb_host_close(s);
1004 static void usb_host_cancel_packet(USBDevice *udev, USBPacket *p)
1006 USBHostDevice *s = USB_HOST_DEVICE(udev);
1007 USBHostRequest *r;
1009 if (p->combined) {
1010 usb_combined_packet_cancel(udev, p);
1011 return;
1014 trace_usb_host_req_canceled(s->bus_num, s->addr, p);
1016 r = usb_host_req_find(s, p);
1017 if (r && r->p) {
1018 r->p = NULL; /* mark as dead */
1019 libusb_cancel_transfer(r->xfer);
1023 static void usb_host_detach_kernel(USBHostDevice *s)
1025 struct libusb_config_descriptor *conf;
1026 int rc, i;
1028 rc = libusb_get_active_config_descriptor(s->dev, &conf);
1029 if (rc != 0) {
1030 return;
1032 for (i = 0; i < conf->bNumInterfaces; i++) {
1033 rc = libusb_kernel_driver_active(s->dh, i);
1034 usb_host_libusb_error("libusb_kernel_driver_active", rc);
1035 if (rc != 1) {
1036 continue;
1038 trace_usb_host_detach_kernel(s->bus_num, s->addr, i);
1039 rc = libusb_detach_kernel_driver(s->dh, i);
1040 usb_host_libusb_error("libusb_detach_kernel_driver", rc);
1041 s->ifs[i].detached = true;
1043 libusb_free_config_descriptor(conf);
1046 static void usb_host_attach_kernel(USBHostDevice *s)
1048 struct libusb_config_descriptor *conf;
1049 int rc, i;
1051 rc = libusb_get_active_config_descriptor(s->dev, &conf);
1052 if (rc != 0) {
1053 return;
1055 for (i = 0; i < conf->bNumInterfaces; i++) {
1056 if (!s->ifs[i].detached) {
1057 continue;
1059 trace_usb_host_attach_kernel(s->bus_num, s->addr, i);
1060 libusb_attach_kernel_driver(s->dh, i);
1061 s->ifs[i].detached = false;
1063 libusb_free_config_descriptor(conf);
1066 static int usb_host_claim_interfaces(USBHostDevice *s, int configuration)
1068 USBDevice *udev = USB_DEVICE(s);
1069 struct libusb_config_descriptor *conf;
1070 int rc, i;
1072 for (i = 0; i < USB_MAX_INTERFACES; i++) {
1073 udev->altsetting[i] = 0;
1075 udev->ninterfaces = 0;
1076 udev->configuration = 0;
1078 usb_host_detach_kernel(s);
1080 rc = libusb_get_active_config_descriptor(s->dev, &conf);
1081 if (rc != 0) {
1082 if (rc == LIBUSB_ERROR_NOT_FOUND) {
1083 /* address state - ignore */
1084 return USB_RET_SUCCESS;
1086 return USB_RET_STALL;
1089 for (i = 0; i < conf->bNumInterfaces; i++) {
1090 trace_usb_host_claim_interface(s->bus_num, s->addr, configuration, i);
1091 rc = libusb_claim_interface(s->dh, i);
1092 usb_host_libusb_error("libusb_claim_interface", rc);
1093 if (rc != 0) {
1094 return USB_RET_STALL;
1096 s->ifs[i].claimed = true;
1099 udev->ninterfaces = conf->bNumInterfaces;
1100 udev->configuration = configuration;
1102 libusb_free_config_descriptor(conf);
1103 return USB_RET_SUCCESS;
1106 static void usb_host_release_interfaces(USBHostDevice *s)
1108 USBDevice *udev = USB_DEVICE(s);
1109 int i, rc;
1111 for (i = 0; i < udev->ninterfaces; i++) {
1112 if (!s->ifs[i].claimed) {
1113 continue;
1115 trace_usb_host_release_interface(s->bus_num, s->addr, i);
1116 rc = libusb_release_interface(s->dh, i);
1117 usb_host_libusb_error("libusb_release_interface", rc);
1118 s->ifs[i].claimed = false;
1122 static void usb_host_set_address(USBHostDevice *s, int addr)
1124 USBDevice *udev = USB_DEVICE(s);
1126 trace_usb_host_set_address(s->bus_num, s->addr, addr);
1127 udev->addr = addr;
1130 static void usb_host_set_config(USBHostDevice *s, int config, USBPacket *p)
1132 int rc;
1134 trace_usb_host_set_config(s->bus_num, s->addr, config);
1136 usb_host_release_interfaces(s);
1137 rc = libusb_set_configuration(s->dh, config);
1138 if (rc != 0) {
1139 usb_host_libusb_error("libusb_set_configuration", rc);
1140 p->status = USB_RET_STALL;
1141 if (rc == LIBUSB_ERROR_NO_DEVICE) {
1142 usb_host_nodev(s);
1144 return;
1146 p->status = usb_host_claim_interfaces(s, config);
1147 if (p->status != USB_RET_SUCCESS) {
1148 return;
1150 usb_host_ep_update(s);
1153 static void usb_host_set_interface(USBHostDevice *s, int iface, int alt,
1154 USBPacket *p)
1156 USBDevice *udev = USB_DEVICE(s);
1157 int rc;
1159 trace_usb_host_set_interface(s->bus_num, s->addr, iface, alt);
1161 usb_host_iso_free_all(s);
1163 if (iface >= USB_MAX_INTERFACES) {
1164 p->status = USB_RET_STALL;
1165 return;
1168 rc = libusb_set_interface_alt_setting(s->dh, iface, alt);
1169 if (rc != 0) {
1170 usb_host_libusb_error("libusb_set_interface_alt_setting", rc);
1171 p->status = USB_RET_STALL;
1172 if (rc == LIBUSB_ERROR_NO_DEVICE) {
1173 usb_host_nodev(s);
1175 return;
1178 udev->altsetting[iface] = alt;
1179 usb_host_ep_update(s);
1182 static void usb_host_handle_control(USBDevice *udev, USBPacket *p,
1183 int request, int value, int index,
1184 int length, uint8_t *data)
1186 USBHostDevice *s = USB_HOST_DEVICE(udev);
1187 USBHostRequest *r;
1188 int rc;
1190 trace_usb_host_req_control(s->bus_num, s->addr, p, request, value, index);
1192 if (s->dh == NULL) {
1193 p->status = USB_RET_NODEV;
1194 trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1195 return;
1198 switch (request) {
1199 case DeviceOutRequest | USB_REQ_SET_ADDRESS:
1200 usb_host_set_address(s, value);
1201 trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1202 return;
1204 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION:
1205 usb_host_set_config(s, value & 0xff, p);
1206 trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1207 return;
1209 case InterfaceOutRequest | USB_REQ_SET_INTERFACE:
1210 usb_host_set_interface(s, index, value, p);
1211 trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1212 return;
1214 case EndpointOutRequest | USB_REQ_CLEAR_FEATURE:
1215 if (value == 0) { /* clear halt */
1216 int pid = (index & USB_DIR_IN) ? USB_TOKEN_IN : USB_TOKEN_OUT;
1217 libusb_clear_halt(s->dh, index);
1218 usb_ep_set_halted(udev, pid, index & 0x0f, 0);
1219 trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1220 return;
1224 r = usb_host_req_alloc(s, p, (request >> 8) & USB_DIR_IN, length + 8);
1225 r->cbuf = data;
1226 r->clen = length;
1227 memcpy(r->buffer, udev->setup_buf, 8);
1228 if (!r->in) {
1229 memcpy(r->buffer + 8, r->cbuf, r->clen);
1232 /* Fix up USB-3 ep0 maxpacket size to allow superspeed connected devices
1233 * to work redirected to a not superspeed capable hcd */
1234 if (udev->speed == USB_SPEED_SUPER &&
1235 !((udev->port->speedmask & USB_SPEED_MASK_SUPER)) &&
1236 request == 0x8006 && value == 0x100 && index == 0) {
1237 r->usb3ep0quirk = true;
1240 libusb_fill_control_transfer(r->xfer, s->dh, r->buffer,
1241 usb_host_req_complete_ctrl, r,
1242 CONTROL_TIMEOUT);
1243 rc = libusb_submit_transfer(r->xfer);
1244 if (rc != 0) {
1245 p->status = USB_RET_NODEV;
1246 trace_usb_host_req_complete(s->bus_num, s->addr, p,
1247 p->status, p->actual_length);
1248 if (rc == LIBUSB_ERROR_NO_DEVICE) {
1249 usb_host_nodev(s);
1251 return;
1254 p->status = USB_RET_ASYNC;
1257 static void usb_host_handle_data(USBDevice *udev, USBPacket *p)
1259 USBHostDevice *s = USB_HOST_DEVICE(udev);
1260 USBHostRequest *r;
1261 size_t size;
1262 int ep, rc;
1264 if (usb_host_use_combining(p->ep) && p->state == USB_PACKET_SETUP) {
1265 p->status = USB_RET_ADD_TO_QUEUE;
1266 return;
1269 trace_usb_host_req_data(s->bus_num, s->addr, p,
1270 p->pid == USB_TOKEN_IN,
1271 p->ep->nr, p->iov.size);
1273 if (s->dh == NULL) {
1274 p->status = USB_RET_NODEV;
1275 trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1276 return;
1278 if (p->ep->halted) {
1279 p->status = USB_RET_STALL;
1280 trace_usb_host_req_emulated(s->bus_num, s->addr, p, p->status);
1281 return;
1284 switch (usb_ep_get_type(udev, p->pid, p->ep->nr)) {
1285 case USB_ENDPOINT_XFER_BULK:
1286 size = usb_packet_size(p);
1287 r = usb_host_req_alloc(s, p, p->pid == USB_TOKEN_IN, size);
1288 if (!r->in) {
1289 usb_packet_copy(p, r->buffer, size);
1291 ep = p->ep->nr | (r->in ? USB_DIR_IN : 0);
1292 if (p->stream) {
1293 #ifdef HAVE_STREAMS
1294 libusb_fill_bulk_stream_transfer(r->xfer, s->dh, ep, p->stream,
1295 r->buffer, size,
1296 usb_host_req_complete_data, r,
1297 BULK_TIMEOUT);
1298 #else
1299 usb_host_req_free(r);
1300 p->status = USB_RET_STALL;
1301 return;
1302 #endif
1303 } else {
1304 libusb_fill_bulk_transfer(r->xfer, s->dh, ep,
1305 r->buffer, size,
1306 usb_host_req_complete_data, r,
1307 BULK_TIMEOUT);
1309 break;
1310 case USB_ENDPOINT_XFER_INT:
1311 r = usb_host_req_alloc(s, p, p->pid == USB_TOKEN_IN, p->iov.size);
1312 if (!r->in) {
1313 usb_packet_copy(p, r->buffer, p->iov.size);
1315 ep = p->ep->nr | (r->in ? USB_DIR_IN : 0);
1316 libusb_fill_interrupt_transfer(r->xfer, s->dh, ep,
1317 r->buffer, p->iov.size,
1318 usb_host_req_complete_data, r,
1319 INTR_TIMEOUT);
1320 break;
1321 case USB_ENDPOINT_XFER_ISOC:
1322 if (p->pid == USB_TOKEN_IN) {
1323 usb_host_iso_data_in(s, p);
1324 } else {
1325 usb_host_iso_data_out(s, p);
1327 trace_usb_host_req_complete(s->bus_num, s->addr, p,
1328 p->status, p->actual_length);
1329 return;
1330 default:
1331 p->status = USB_RET_STALL;
1332 trace_usb_host_req_complete(s->bus_num, s->addr, p,
1333 p->status, p->actual_length);
1334 return;
1337 rc = libusb_submit_transfer(r->xfer);
1338 if (rc != 0) {
1339 p->status = USB_RET_NODEV;
1340 trace_usb_host_req_complete(s->bus_num, s->addr, p,
1341 p->status, p->actual_length);
1342 if (rc == LIBUSB_ERROR_NO_DEVICE) {
1343 usb_host_nodev(s);
1345 return;
1348 p->status = USB_RET_ASYNC;
1351 static void usb_host_flush_ep_queue(USBDevice *dev, USBEndpoint *ep)
1353 if (usb_host_use_combining(ep)) {
1354 usb_ep_combine_input_packets(ep);
1358 static void usb_host_handle_reset(USBDevice *udev)
1360 USBHostDevice *s = USB_HOST_DEVICE(udev);
1361 int rc;
1363 trace_usb_host_reset(s->bus_num, s->addr);
1365 rc = libusb_reset_device(s->dh);
1366 if (rc != 0) {
1367 usb_host_nodev(s);
1371 static int usb_host_alloc_streams(USBDevice *udev, USBEndpoint **eps,
1372 int nr_eps, int streams)
1374 #ifdef HAVE_STREAMS
1375 USBHostDevice *s = USB_HOST_DEVICE(udev);
1376 unsigned char endpoints[30];
1377 int i, rc;
1379 for (i = 0; i < nr_eps; i++) {
1380 endpoints[i] = eps[i]->nr;
1381 if (eps[i]->pid == USB_TOKEN_IN) {
1382 endpoints[i] |= 0x80;
1385 rc = libusb_alloc_streams(s->dh, streams, endpoints, nr_eps);
1386 if (rc < 0) {
1387 usb_host_libusb_error("libusb_alloc_streams", rc);
1388 } else if (rc != streams) {
1389 error_report("libusb_alloc_streams: got less streams "
1390 "then requested %d < %d", rc, streams);
1393 return (rc == streams) ? 0 : -1;
1394 #else
1395 error_report("libusb_alloc_streams: error not implemented");
1396 return -1;
1397 #endif
1400 static void usb_host_free_streams(USBDevice *udev, USBEndpoint **eps,
1401 int nr_eps)
1403 #ifdef HAVE_STREAMS
1404 USBHostDevice *s = USB_HOST_DEVICE(udev);
1405 unsigned char endpoints[30];
1406 int i;
1408 for (i = 0; i < nr_eps; i++) {
1409 endpoints[i] = eps[i]->nr;
1410 if (eps[i]->pid == USB_TOKEN_IN) {
1411 endpoints[i] |= 0x80;
1414 libusb_free_streams(s->dh, endpoints, nr_eps);
1415 #endif
1419 * This is *NOT* about restoring state. We have absolutely no idea
1420 * what state the host device is in at the moment and whenever it is
1421 * still present in the first place. Attemping to contine where we
1422 * left off is impossible.
1424 * What we are going to to to here is emulate a surprise removal of
1425 * the usb device passed through, then kick host scan so the device
1426 * will get re-attached (and re-initialized by the guest) in case it
1427 * is still present.
1429 * As the device removal will change the state of other devices (usb
1430 * host controller, most likely interrupt controller too) we have to
1431 * wait with it until *all* vmstate is loaded. Thus post_load just
1432 * kicks a bottom half which then does the actual work.
1434 static void usb_host_post_load_bh(void *opaque)
1436 USBHostDevice *dev = opaque;
1437 USBDevice *udev = USB_DEVICE(dev);
1439 if (dev->dh != NULL) {
1440 usb_host_close(dev);
1442 if (udev->attached) {
1443 usb_device_detach(udev);
1445 usb_host_auto_check(NULL);
1448 static int usb_host_post_load(void *opaque, int version_id)
1450 USBHostDevice *dev = opaque;
1452 if (!dev->bh_postld) {
1453 dev->bh_postld = qemu_bh_new(usb_host_post_load_bh, dev);
1455 qemu_bh_schedule(dev->bh_postld);
1456 return 0;
1459 static const VMStateDescription vmstate_usb_host = {
1460 .name = "usb-host",
1461 .version_id = 1,
1462 .minimum_version_id = 1,
1463 .post_load = usb_host_post_load,
1464 .fields = (VMStateField[]) {
1465 VMSTATE_USB_DEVICE(parent_obj, USBHostDevice),
1466 VMSTATE_END_OF_LIST()
1470 static Property usb_host_dev_properties[] = {
1471 DEFINE_PROP_UINT32("hostbus", USBHostDevice, match.bus_num, 0),
1472 DEFINE_PROP_UINT32("hostaddr", USBHostDevice, match.addr, 0),
1473 DEFINE_PROP_STRING("hostport", USBHostDevice, match.port),
1474 DEFINE_PROP_UINT32("vendorid", USBHostDevice, match.vendor_id, 0),
1475 DEFINE_PROP_UINT32("productid", USBHostDevice, match.product_id, 0),
1476 DEFINE_PROP_UINT32("isobufs", USBHostDevice, iso_urb_count, 4),
1477 DEFINE_PROP_UINT32("isobsize", USBHostDevice, iso_urb_frames, 32),
1478 DEFINE_PROP_UINT32("loglevel", USBHostDevice, loglevel,
1479 LIBUSB_LOG_LEVEL_WARNING),
1480 DEFINE_PROP_BIT("pipeline", USBHostDevice, options,
1481 USB_HOST_OPT_PIPELINE, true),
1482 DEFINE_PROP_END_OF_LIST(),
1485 static void usb_host_class_initfn(ObjectClass *klass, void *data)
1487 DeviceClass *dc = DEVICE_CLASS(klass);
1488 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
1490 uc->realize = usb_host_realize;
1491 uc->product_desc = "USB Host Device";
1492 uc->cancel_packet = usb_host_cancel_packet;
1493 uc->handle_data = usb_host_handle_data;
1494 uc->handle_control = usb_host_handle_control;
1495 uc->handle_reset = usb_host_handle_reset;
1496 uc->handle_destroy = usb_host_handle_destroy;
1497 uc->flush_ep_queue = usb_host_flush_ep_queue;
1498 uc->alloc_streams = usb_host_alloc_streams;
1499 uc->free_streams = usb_host_free_streams;
1500 dc->vmsd = &vmstate_usb_host;
1501 dc->props = usb_host_dev_properties;
1502 set_bit(DEVICE_CATEGORY_BRIDGE, dc->categories);
1505 static TypeInfo usb_host_dev_info = {
1506 .name = TYPE_USB_HOST_DEVICE,
1507 .parent = TYPE_USB_DEVICE,
1508 .instance_size = sizeof(USBHostDevice),
1509 .class_init = usb_host_class_initfn,
1510 .instance_init = usb_host_instance_init,
1513 static void usb_host_register_types(void)
1515 type_register_static(&usb_host_dev_info);
1518 type_init(usb_host_register_types)
1520 /* ------------------------------------------------------------------------ */
1522 static QEMUTimer *usb_auto_timer;
1523 static VMChangeStateEntry *usb_vmstate;
1525 static void usb_host_vm_state(void *unused, int running, RunState state)
1527 if (running) {
1528 usb_host_auto_check(unused);
1532 static void usb_host_auto_check(void *unused)
1534 struct USBHostDevice *s;
1535 struct USBAutoFilter *f;
1536 libusb_device **devs = NULL;
1537 struct libusb_device_descriptor ddesc;
1538 int unconnected = 0;
1539 int i, n;
1541 if (usb_host_init() != 0) {
1542 return;
1545 if (runstate_is_running()) {
1546 n = libusb_get_device_list(ctx, &devs);
1547 for (i = 0; i < n; i++) {
1548 if (libusb_get_device_descriptor(devs[i], &ddesc) != 0) {
1549 continue;
1551 if (ddesc.bDeviceClass == LIBUSB_CLASS_HUB) {
1552 continue;
1554 QTAILQ_FOREACH(s, &hostdevs, next) {
1555 f = &s->match;
1556 if (f->bus_num > 0 &&
1557 f->bus_num != libusb_get_bus_number(devs[i])) {
1558 continue;
1560 if (f->addr > 0 &&
1561 f->addr != libusb_get_device_address(devs[i])) {
1562 continue;
1564 if (f->port != NULL) {
1565 char port[16] = "-";
1566 usb_host_get_port(devs[i], port, sizeof(port));
1567 if (strcmp(f->port, port) != 0) {
1568 continue;
1571 if (f->vendor_id > 0 &&
1572 f->vendor_id != ddesc.idVendor) {
1573 continue;
1575 if (f->product_id > 0 &&
1576 f->product_id != ddesc.idProduct) {
1577 continue;
1580 /* We got a match */
1581 s->seen++;
1582 if (s->errcount >= 3) {
1583 continue;
1585 if (s->dh != NULL) {
1586 continue;
1588 if (usb_host_open(s, devs[i]) < 0) {
1589 s->errcount++;
1590 continue;
1592 break;
1595 libusb_free_device_list(devs, 1);
1597 QTAILQ_FOREACH(s, &hostdevs, next) {
1598 if (s->dh == NULL) {
1599 unconnected++;
1601 if (s->seen == 0) {
1602 if (s->dh) {
1603 usb_host_close(s);
1605 s->errcount = 0;
1607 s->seen = 0;
1610 #if 0
1611 if (unconnected == 0) {
1612 /* nothing to watch */
1613 if (usb_auto_timer) {
1614 timer_del(usb_auto_timer);
1615 trace_usb_host_auto_scan_disabled();
1617 return;
1619 #endif
1622 if (!usb_vmstate) {
1623 usb_vmstate = qemu_add_vm_change_state_handler(usb_host_vm_state, NULL);
1625 if (!usb_auto_timer) {
1626 usb_auto_timer = timer_new_ms(QEMU_CLOCK_REALTIME, usb_host_auto_check, NULL);
1627 if (!usb_auto_timer) {
1628 return;
1630 trace_usb_host_auto_scan_enabled();
1632 timer_mod(usb_auto_timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + 2000);
1635 void usb_host_info(Monitor *mon, const QDict *qdict)
1637 libusb_device **devs = NULL;
1638 struct libusb_device_descriptor ddesc;
1639 char port[16];
1640 int i, n;
1642 if (usb_host_init() != 0) {
1643 return;
1646 n = libusb_get_device_list(ctx, &devs);
1647 for (i = 0; i < n; i++) {
1648 if (libusb_get_device_descriptor(devs[i], &ddesc) != 0) {
1649 continue;
1651 if (ddesc.bDeviceClass == LIBUSB_CLASS_HUB) {
1652 continue;
1654 usb_host_get_port(devs[i], port, sizeof(port));
1655 monitor_printf(mon, " Bus %d, Addr %d, Port %s, Speed %s Mb/s\n",
1656 libusb_get_bus_number(devs[i]),
1657 libusb_get_device_address(devs[i]),
1658 port,
1659 speed_name[libusb_get_device_speed(devs[i])]);
1660 monitor_printf(mon, " Class %02x:", ddesc.bDeviceClass);
1661 monitor_printf(mon, " USB device %04x:%04x",
1662 ddesc.idVendor, ddesc.idProduct);
1663 if (ddesc.iProduct) {
1664 libusb_device_handle *handle;
1665 if (libusb_open(devs[i], &handle) == 0) {
1666 unsigned char name[64] = "";
1667 libusb_get_string_descriptor_ascii(handle,
1668 ddesc.iProduct,
1669 name, sizeof(name));
1670 libusb_close(handle);
1671 monitor_printf(mon, ", %s", name);
1674 monitor_printf(mon, "\n");
1676 libusb_free_device_list(devs, 1);