1 /* 2 * USB redirector usb-guest 3 * 4 * Copyright (c) 2011-2012 Red Hat, Inc. 5 * 6 * Red Hat Authors: 7 * Hans de Goede <hdegoede@redhat.com> 8 * 9 * Permission is hereby granted, free of charge, to any person obtaining a copy 10 * of this software and associated documentation files (the "Software"), to deal 11 * in the Software without restriction, including without limitation the rights 12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 13 * copies of the Software, and to permit persons to whom the Software is 14 * furnished to do so, subject to the following conditions: 15 * 16 * The above copyright notice and this permission notice shall be included in 17 * all copies or substantial portions of the Software. 18 * 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 22 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 25 * THE SOFTWARE. 26 */ 27 28 #include "qemu/osdep.h" 29 #include "qemu-common.h" 30 #include "qemu/units.h" 31 #include "qapi/error.h" 32 #include "qemu/timer.h" 33 #include "sysemu/runstate.h" 34 #include "sysemu/sysemu.h" 35 #include "qapi/qmp/qerror.h" 36 #include "qemu/error-report.h" 37 #include "qemu/iov.h" 38 #include "qemu/module.h" 39 #include "chardev/char-fe.h" 40 41 #include <usbredirparser.h> 42 #include <usbredirfilter.h> 43 44 #include "hw/qdev-properties.h" 45 #include "hw/usb.h" 46 #include "migration/qemu-file-types.h" 47 #include "migration/vmstate.h" 48 49 /* ERROR is defined below. Remove any previous definition. */ 50 #undef ERROR 51 52 #define MAX_ENDPOINTS 32 53 #define NO_INTERFACE_INFO 255 /* Valid interface_count always <= 32 */ 54 #define EP2I(ep_address) (((ep_address & 0x80) >> 3) | (ep_address & 0x0f)) 55 #define I2EP(i) (((i & 0x10) << 3) | (i & 0x0f)) 56 #define USBEP2I(usb_ep) (((usb_ep)->pid == USB_TOKEN_IN) ? \ 57 ((usb_ep)->nr | 0x10) : ((usb_ep)->nr)) 58 #define I2USBEP(d, i) (usb_ep_get(&(d)->dev, \ 59 ((i) & 0x10) ? USB_TOKEN_IN : USB_TOKEN_OUT, \ 60 (i) & 0x0f)) 61 62 #ifndef USBREDIR_VERSION /* This is not defined in older usbredir versions */ 63 #define USBREDIR_VERSION 0 64 #endif 65 66 typedef struct USBRedirDevice USBRedirDevice; 67 68 /* Struct to hold buffered packets */ 69 struct buf_packet { 70 uint8_t *data; 71 void *free_on_destroy; 72 uint16_t len; 73 uint16_t offset; 74 uint8_t status; 75 QTAILQ_ENTRY(buf_packet)next; 76 }; 77 78 struct endp_data { 79 USBRedirDevice *dev; 80 uint8_t type; 81 uint8_t interval; 82 uint8_t interface; /* bInterfaceNumber this ep belongs to */ 83 uint16_t max_packet_size; /* In bytes, not wMaxPacketSize format !! */ 84 uint32_t max_streams; 85 uint8_t iso_started; 86 uint8_t iso_error; /* For reporting iso errors to the HC */ 87 uint8_t interrupt_started; 88 uint8_t interrupt_error; 89 uint8_t bulk_receiving_enabled; 90 uint8_t bulk_receiving_started; 91 uint8_t bufpq_prefilled; 92 uint8_t bufpq_dropping_packets; 93 QTAILQ_HEAD(, buf_packet) bufpq; 94 int32_t bufpq_size; 95 int32_t bufpq_target_size; 96 USBPacket *pending_async_packet; 97 }; 98 99 struct PacketIdQueueEntry { 100 uint64_t id; 101 QTAILQ_ENTRY(PacketIdQueueEntry)next; 102 }; 103 104 struct PacketIdQueue { 105 USBRedirDevice *dev; 106 const char *name; 107 QTAILQ_HEAD(, PacketIdQueueEntry) head; 108 int size; 109 }; 110 111 struct USBRedirDevice { 112 USBDevice dev; 113 /* Properties */ 114 CharBackend cs; 115 bool enable_streams; 116 uint8_t debug; 117 int32_t bootindex; 118 char *filter_str; 119 /* Data passed from chardev the fd_read cb to the usbredirparser read cb */ 120 const uint8_t *read_buf; 121 int read_buf_size; 122 /* Active chardev-watch-tag */ 123 guint watch; 124 /* For async handling of close / reject */ 125 QEMUBH *chardev_close_bh; 126 QEMUBH *device_reject_bh; 127 /* To delay the usb attach in case of quick chardev close + open */ 128 QEMUTimer *attach_timer; 129 int64_t next_attach_time; 130 struct usbredirparser *parser; 131 struct endp_data endpoint[MAX_ENDPOINTS]; 132 struct PacketIdQueue cancelled; 133 struct PacketIdQueue already_in_flight; 134 void (*buffered_bulk_in_complete)(USBRedirDevice *, USBPacket *, uint8_t); 135 /* Data for device filtering */ 136 struct usb_redir_device_connect_header device_info; 137 struct usb_redir_interface_info_header interface_info; 138 struct usbredirfilter_rule *filter_rules; 139 int filter_rules_count; 140 int compatible_speedmask; 141 VMChangeStateEntry *vmstate; 142 }; 143 144 #define TYPE_USB_REDIR "usb-redir" 145 #define USB_REDIRECT(obj) OBJECT_CHECK(USBRedirDevice, (obj), TYPE_USB_REDIR) 146 147 static void usbredir_hello(void *priv, struct usb_redir_hello_header *h); 148 static void usbredir_device_connect(void *priv, 149 struct usb_redir_device_connect_header *device_connect); 150 static void usbredir_device_disconnect(void *priv); 151 static void usbredir_interface_info(void *priv, 152 struct usb_redir_interface_info_header *interface_info); 153 static void usbredir_ep_info(void *priv, 154 struct usb_redir_ep_info_header *ep_info); 155 static void usbredir_configuration_status(void *priv, uint64_t id, 156 struct usb_redir_configuration_status_header *configuration_status); 157 static void usbredir_alt_setting_status(void *priv, uint64_t id, 158 struct usb_redir_alt_setting_status_header *alt_setting_status); 159 static void usbredir_iso_stream_status(void *priv, uint64_t id, 160 struct usb_redir_iso_stream_status_header *iso_stream_status); 161 static void usbredir_interrupt_receiving_status(void *priv, uint64_t id, 162 struct usb_redir_interrupt_receiving_status_header 163 *interrupt_receiving_status); 164 static void usbredir_bulk_streams_status(void *priv, uint64_t id, 165 struct usb_redir_bulk_streams_status_header *bulk_streams_status); 166 static void usbredir_bulk_receiving_status(void *priv, uint64_t id, 167 struct usb_redir_bulk_receiving_status_header *bulk_receiving_status); 168 static void usbredir_control_packet(void *priv, uint64_t id, 169 struct usb_redir_control_packet_header *control_packet, 170 uint8_t *data, int data_len); 171 static void usbredir_bulk_packet(void *priv, uint64_t id, 172 struct usb_redir_bulk_packet_header *bulk_packet, 173 uint8_t *data, int data_len); 174 static void usbredir_iso_packet(void *priv, uint64_t id, 175 struct usb_redir_iso_packet_header *iso_packet, 176 uint8_t *data, int data_len); 177 static void usbredir_interrupt_packet(void *priv, uint64_t id, 178 struct usb_redir_interrupt_packet_header *interrupt_header, 179 uint8_t *data, int data_len); 180 static void usbredir_buffered_bulk_packet(void *priv, uint64_t id, 181 struct usb_redir_buffered_bulk_packet_header *buffered_bulk_packet, 182 uint8_t *data, int data_len); 183 184 static void usbredir_handle_status(USBRedirDevice *dev, USBPacket *p, 185 int status); 186 187 #define VERSION "qemu usb-redir guest " QEMU_VERSION 188 189 /* 190 * Logging stuff 191 */ 192 193 #define ERROR(...) \ 194 do { \ 195 if (dev->debug >= usbredirparser_error) { \ 196 error_report("usb-redir error: " __VA_ARGS__); \ 197 } \ 198 } while (0) 199 #define WARNING(...) \ 200 do { \ 201 if (dev->debug >= usbredirparser_warning) { \ 202 warn_report("" __VA_ARGS__); \ 203 } \ 204 } while (0) 205 #define INFO(...) \ 206 do { \ 207 if (dev->debug >= usbredirparser_info) { \ 208 error_report("usb-redir: " __VA_ARGS__); \ 209 } \ 210 } while (0) 211 #define DPRINTF(...) \ 212 do { \ 213 if (dev->debug >= usbredirparser_debug) { \ 214 error_report("usb-redir: " __VA_ARGS__); \ 215 } \ 216 } while (0) 217 #define DPRINTF2(...) \ 218 do { \ 219 if (dev->debug >= usbredirparser_debug_data) { \ 220 error_report("usb-redir: " __VA_ARGS__); \ 221 } \ 222 } while (0) 223 224 static void usbredir_log(void *priv, int level, const char *msg) 225 { 226 USBRedirDevice *dev = priv; 227 228 if (dev->debug < level) { 229 return; 230 } 231 232 error_report("%s", msg); 233 } 234 235 static void usbredir_log_data(USBRedirDevice *dev, const char *desc, 236 const uint8_t *data, int len) 237 { 238 if (dev->debug < usbredirparser_debug_data) { 239 return; 240 } 241 qemu_hexdump((char *)data, stderr, desc, len); 242 } 243 244 /* 245 * usbredirparser io functions 246 */ 247 248 static int usbredir_read(void *priv, uint8_t *data, int count) 249 { 250 USBRedirDevice *dev = priv; 251 252 if (dev->read_buf_size < count) { 253 count = dev->read_buf_size; 254 } 255 256 memcpy(data, dev->read_buf, count); 257 258 dev->read_buf_size -= count; 259 if (dev->read_buf_size) { 260 dev->read_buf += count; 261 } else { 262 dev->read_buf = NULL; 263 } 264 265 return count; 266 } 267 268 static gboolean usbredir_write_unblocked(GIOChannel *chan, GIOCondition cond, 269 void *opaque) 270 { 271 USBRedirDevice *dev = opaque; 272 273 dev->watch = 0; 274 usbredirparser_do_write(dev->parser); 275 276 return FALSE; 277 } 278 279 static int usbredir_write(void *priv, uint8_t *data, int count) 280 { 281 USBRedirDevice *dev = priv; 282 int r; 283 284 if (!qemu_chr_fe_backend_open(&dev->cs)) { 285 return 0; 286 } 287 288 /* Don't send new data to the chardev until our state is fully synced */ 289 if (!runstate_check(RUN_STATE_RUNNING)) { 290 return 0; 291 } 292 293 r = qemu_chr_fe_write(&dev->cs, data, count); 294 if (r < count) { 295 if (!dev->watch) { 296 dev->watch = qemu_chr_fe_add_watch(&dev->cs, G_IO_OUT | G_IO_HUP, 297 usbredir_write_unblocked, dev); 298 } 299 if (r < 0) { 300 r = 0; 301 } 302 } 303 return r; 304 } 305 306 /* 307 * Cancelled and buffered packets helpers 308 */ 309 310 static void packet_id_queue_init(struct PacketIdQueue *q, 311 USBRedirDevice *dev, const char *name) 312 { 313 q->dev = dev; 314 q->name = name; 315 QTAILQ_INIT(&q->head); 316 q->size = 0; 317 } 318 319 static void packet_id_queue_add(struct PacketIdQueue *q, uint64_t id) 320 { 321 USBRedirDevice *dev = q->dev; 322 struct PacketIdQueueEntry *e; 323 324 DPRINTF("adding packet id %"PRIu64" to %s queue\n", id, q->name); 325 326 e = g_new0(struct PacketIdQueueEntry, 1); 327 e->id = id; 328 QTAILQ_INSERT_TAIL(&q->head, e, next); 329 q->size++; 330 } 331 332 static int packet_id_queue_remove(struct PacketIdQueue *q, uint64_t id) 333 { 334 USBRedirDevice *dev = q->dev; 335 struct PacketIdQueueEntry *e; 336 337 QTAILQ_FOREACH(e, &q->head, next) { 338 if (e->id == id) { 339 DPRINTF("removing packet id %"PRIu64" from %s queue\n", 340 id, q->name); 341 QTAILQ_REMOVE(&q->head, e, next); 342 q->size--; 343 g_free(e); 344 return 1; 345 } 346 } 347 return 0; 348 } 349 350 static void packet_id_queue_empty(struct PacketIdQueue *q) 351 { 352 USBRedirDevice *dev = q->dev; 353 struct PacketIdQueueEntry *e, *next_e; 354 355 DPRINTF("removing %d packet-ids from %s queue\n", q->size, q->name); 356 357 QTAILQ_FOREACH_SAFE(e, &q->head, next, next_e) { 358 QTAILQ_REMOVE(&q->head, e, next); 359 g_free(e); 360 } 361 q->size = 0; 362 } 363 364 static void usbredir_cancel_packet(USBDevice *udev, USBPacket *p) 365 { 366 USBRedirDevice *dev = USB_REDIRECT(udev); 367 int i = USBEP2I(p->ep); 368 369 if (p->combined) { 370 usb_combined_packet_cancel(udev, p); 371 return; 372 } 373 374 if (dev->endpoint[i].pending_async_packet) { 375 assert(dev->endpoint[i].pending_async_packet == p); 376 dev->endpoint[i].pending_async_packet = NULL; 377 return; 378 } 379 380 packet_id_queue_add(&dev->cancelled, p->id); 381 usbredirparser_send_cancel_data_packet(dev->parser, p->id); 382 usbredirparser_do_write(dev->parser); 383 } 384 385 static int usbredir_is_cancelled(USBRedirDevice *dev, uint64_t id) 386 { 387 if (!dev->dev.attached) { 388 return 1; /* Treat everything as cancelled after a disconnect */ 389 } 390 return packet_id_queue_remove(&dev->cancelled, id); 391 } 392 393 static void usbredir_fill_already_in_flight_from_ep(USBRedirDevice *dev, 394 struct USBEndpoint *ep) 395 { 396 static USBPacket *p; 397 398 /* async handled packets for bulk receiving eps do not count as inflight */ 399 if (dev->endpoint[USBEP2I(ep)].bulk_receiving_started) { 400 return; 401 } 402 403 QTAILQ_FOREACH(p, &ep->queue, queue) { 404 /* Skip combined packets, except for the first */ 405 if (p->combined && p != p->combined->first) { 406 continue; 407 } 408 if (p->state == USB_PACKET_ASYNC) { 409 packet_id_queue_add(&dev->already_in_flight, p->id); 410 } 411 } 412 } 413 414 static void usbredir_fill_already_in_flight(USBRedirDevice *dev) 415 { 416 int ep; 417 struct USBDevice *udev = &dev->dev; 418 419 usbredir_fill_already_in_flight_from_ep(dev, &udev->ep_ctl); 420 421 for (ep = 0; ep < USB_MAX_ENDPOINTS; ep++) { 422 usbredir_fill_already_in_flight_from_ep(dev, &udev->ep_in[ep]); 423 usbredir_fill_already_in_flight_from_ep(dev, &udev->ep_out[ep]); 424 } 425 } 426 427 static int usbredir_already_in_flight(USBRedirDevice *dev, uint64_t id) 428 { 429 return packet_id_queue_remove(&dev->already_in_flight, id); 430 } 431 432 static USBPacket *usbredir_find_packet_by_id(USBRedirDevice *dev, 433 uint8_t ep, uint64_t id) 434 { 435 USBPacket *p; 436 437 if (usbredir_is_cancelled(dev, id)) { 438 return NULL; 439 } 440 441 p = usb_ep_find_packet_by_id(&dev->dev, 442 (ep & USB_DIR_IN) ? USB_TOKEN_IN : USB_TOKEN_OUT, 443 ep & 0x0f, id); 444 if (p == NULL) { 445 ERROR("could not find packet with id %"PRIu64"\n", id); 446 } 447 return p; 448 } 449 450 static int bufp_alloc(USBRedirDevice *dev, uint8_t *data, uint16_t len, 451 uint8_t status, uint8_t ep, void *free_on_destroy) 452 { 453 struct buf_packet *bufp; 454 455 if (!dev->endpoint[EP2I(ep)].bufpq_dropping_packets && 456 dev->endpoint[EP2I(ep)].bufpq_size > 457 2 * dev->endpoint[EP2I(ep)].bufpq_target_size) { 458 DPRINTF("bufpq overflow, dropping packets ep %02X\n", ep); 459 dev->endpoint[EP2I(ep)].bufpq_dropping_packets = 1; 460 } 461 /* Since we're interupting the stream anyways, drop enough packets to get 462 back to our target buffer size */ 463 if (dev->endpoint[EP2I(ep)].bufpq_dropping_packets) { 464 if (dev->endpoint[EP2I(ep)].bufpq_size > 465 dev->endpoint[EP2I(ep)].bufpq_target_size) { 466 free(data); 467 return -1; 468 } 469 dev->endpoint[EP2I(ep)].bufpq_dropping_packets = 0; 470 } 471 472 bufp = g_new(struct buf_packet, 1); 473 bufp->data = data; 474 bufp->len = len; 475 bufp->offset = 0; 476 bufp->status = status; 477 bufp->free_on_destroy = free_on_destroy; 478 QTAILQ_INSERT_TAIL(&dev->endpoint[EP2I(ep)].bufpq, bufp, next); 479 dev->endpoint[EP2I(ep)].bufpq_size++; 480 return 0; 481 } 482 483 static void bufp_free(USBRedirDevice *dev, struct buf_packet *bufp, 484 uint8_t ep) 485 { 486 QTAILQ_REMOVE(&dev->endpoint[EP2I(ep)].bufpq, bufp, next); 487 dev->endpoint[EP2I(ep)].bufpq_size--; 488 free(bufp->free_on_destroy); 489 g_free(bufp); 490 } 491 492 static void usbredir_free_bufpq(USBRedirDevice *dev, uint8_t ep) 493 { 494 struct buf_packet *buf, *buf_next; 495 496 QTAILQ_FOREACH_SAFE(buf, &dev->endpoint[EP2I(ep)].bufpq, next, buf_next) { 497 bufp_free(dev, buf, ep); 498 } 499 } 500 501 /* 502 * USBDevice callbacks 503 */ 504 505 static void usbredir_handle_reset(USBDevice *udev) 506 { 507 USBRedirDevice *dev = USB_REDIRECT(udev); 508 509 DPRINTF("reset device\n"); 510 usbredirparser_send_reset(dev->parser); 511 usbredirparser_do_write(dev->parser); 512 } 513 514 static void usbredir_handle_iso_data(USBRedirDevice *dev, USBPacket *p, 515 uint8_t ep) 516 { 517 int status, len; 518 if (!dev->endpoint[EP2I(ep)].iso_started && 519 !dev->endpoint[EP2I(ep)].iso_error) { 520 struct usb_redir_start_iso_stream_header start_iso = { 521 .endpoint = ep, 522 }; 523 int pkts_per_sec; 524 525 if (dev->dev.speed == USB_SPEED_HIGH) { 526 pkts_per_sec = 8000 / dev->endpoint[EP2I(ep)].interval; 527 } else { 528 pkts_per_sec = 1000 / dev->endpoint[EP2I(ep)].interval; 529 } 530 /* Testing has shown that we need circa 60 ms buffer */ 531 dev->endpoint[EP2I(ep)].bufpq_target_size = (pkts_per_sec * 60) / 1000; 532 533 /* Aim for approx 100 interrupts / second on the client to 534 balance latency and interrupt load */ 535 start_iso.pkts_per_urb = pkts_per_sec / 100; 536 if (start_iso.pkts_per_urb < 1) { 537 start_iso.pkts_per_urb = 1; 538 } else if (start_iso.pkts_per_urb > 32) { 539 start_iso.pkts_per_urb = 32; 540 } 541 542 start_iso.no_urbs = DIV_ROUND_UP( 543 dev->endpoint[EP2I(ep)].bufpq_target_size, 544 start_iso.pkts_per_urb); 545 /* Output endpoints pre-fill only 1/2 of the packets, keeping the rest 546 as overflow buffer. Also see the usbredir protocol documentation */ 547 if (!(ep & USB_DIR_IN)) { 548 start_iso.no_urbs *= 2; 549 } 550 if (start_iso.no_urbs > 16) { 551 start_iso.no_urbs = 16; 552 } 553 554 /* No id, we look at the ep when receiving a status back */ 555 usbredirparser_send_start_iso_stream(dev->parser, 0, &start_iso); 556 usbredirparser_do_write(dev->parser); 557 DPRINTF("iso stream started pkts/sec %d pkts/urb %d urbs %d ep %02X\n", 558 pkts_per_sec, start_iso.pkts_per_urb, start_iso.no_urbs, ep); 559 dev->endpoint[EP2I(ep)].iso_started = 1; 560 dev->endpoint[EP2I(ep)].bufpq_prefilled = 0; 561 dev->endpoint[EP2I(ep)].bufpq_dropping_packets = 0; 562 } 563 564 if (ep & USB_DIR_IN) { 565 struct buf_packet *isop; 566 567 if (dev->endpoint[EP2I(ep)].iso_started && 568 !dev->endpoint[EP2I(ep)].bufpq_prefilled) { 569 if (dev->endpoint[EP2I(ep)].bufpq_size < 570 dev->endpoint[EP2I(ep)].bufpq_target_size) { 571 return; 572 } 573 dev->endpoint[EP2I(ep)].bufpq_prefilled = 1; 574 } 575 576 isop = QTAILQ_FIRST(&dev->endpoint[EP2I(ep)].bufpq); 577 if (isop == NULL) { 578 DPRINTF("iso-token-in ep %02X, no isop, iso_error: %d\n", 579 ep, dev->endpoint[EP2I(ep)].iso_error); 580 /* Re-fill the buffer */ 581 dev->endpoint[EP2I(ep)].bufpq_prefilled = 0; 582 /* Check iso_error for stream errors, otherwise its an underrun */ 583 status = dev->endpoint[EP2I(ep)].iso_error; 584 dev->endpoint[EP2I(ep)].iso_error = 0; 585 p->status = status ? USB_RET_IOERROR : USB_RET_SUCCESS; 586 return; 587 } 588 DPRINTF2("iso-token-in ep %02X status %d len %d queue-size: %d\n", ep, 589 isop->status, isop->len, dev->endpoint[EP2I(ep)].bufpq_size); 590 591 status = isop->status; 592 len = isop->len; 593 if (len > p->iov.size) { 594 ERROR("received iso data is larger then packet ep %02X (%d > %d)\n", 595 ep, len, (int)p->iov.size); 596 len = p->iov.size; 597 status = usb_redir_babble; 598 } 599 usb_packet_copy(p, isop->data, len); 600 bufp_free(dev, isop, ep); 601 usbredir_handle_status(dev, p, status); 602 } else { 603 /* If the stream was not started because of a pending error don't 604 send the packet to the usb-host */ 605 if (dev->endpoint[EP2I(ep)].iso_started) { 606 struct usb_redir_iso_packet_header iso_packet = { 607 .endpoint = ep, 608 .length = p->iov.size 609 }; 610 uint8_t buf[p->iov.size]; 611 /* No id, we look at the ep when receiving a status back */ 612 usb_packet_copy(p, buf, p->iov.size); 613 usbredirparser_send_iso_packet(dev->parser, 0, &iso_packet, 614 buf, p->iov.size); 615 usbredirparser_do_write(dev->parser); 616 } 617 status = dev->endpoint[EP2I(ep)].iso_error; 618 dev->endpoint[EP2I(ep)].iso_error = 0; 619 DPRINTF2("iso-token-out ep %02X status %d len %zd\n", ep, status, 620 p->iov.size); 621 usbredir_handle_status(dev, p, status); 622 } 623 } 624 625 static void usbredir_stop_iso_stream(USBRedirDevice *dev, uint8_t ep) 626 { 627 struct usb_redir_stop_iso_stream_header stop_iso_stream = { 628 .endpoint = ep 629 }; 630 if (dev->endpoint[EP2I(ep)].iso_started) { 631 usbredirparser_send_stop_iso_stream(dev->parser, 0, &stop_iso_stream); 632 DPRINTF("iso stream stopped ep %02X\n", ep); 633 dev->endpoint[EP2I(ep)].iso_started = 0; 634 } 635 dev->endpoint[EP2I(ep)].iso_error = 0; 636 usbredir_free_bufpq(dev, ep); 637 } 638 639 /* 640 * The usb-host may poll the endpoint faster then our guest, resulting in lots 641 * of smaller bulkp-s. The below buffered_bulk_in_complete* functions combine 642 * data from multiple bulkp-s into a single packet, avoiding bufpq overflows. 643 */ 644 static void usbredir_buffered_bulk_add_data_to_packet(USBRedirDevice *dev, 645 struct buf_packet *bulkp, int count, USBPacket *p, uint8_t ep) 646 { 647 usb_packet_copy(p, bulkp->data + bulkp->offset, count); 648 bulkp->offset += count; 649 if (bulkp->offset == bulkp->len) { 650 /* Store status in the last packet with data from this bulkp */ 651 usbredir_handle_status(dev, p, bulkp->status); 652 bufp_free(dev, bulkp, ep); 653 } 654 } 655 656 static void usbredir_buffered_bulk_in_complete_raw(USBRedirDevice *dev, 657 USBPacket *p, uint8_t ep) 658 { 659 struct buf_packet *bulkp; 660 int count; 661 662 while ((bulkp = QTAILQ_FIRST(&dev->endpoint[EP2I(ep)].bufpq)) && 663 p->actual_length < p->iov.size && p->status == USB_RET_SUCCESS) { 664 count = bulkp->len - bulkp->offset; 665 if (count > (p->iov.size - p->actual_length)) { 666 count = p->iov.size - p->actual_length; 667 } 668 usbredir_buffered_bulk_add_data_to_packet(dev, bulkp, count, p, ep); 669 } 670 } 671 672 static void usbredir_buffered_bulk_in_complete_ftdi(USBRedirDevice *dev, 673 USBPacket *p, uint8_t ep) 674 { 675 const int maxp = dev->endpoint[EP2I(ep)].max_packet_size; 676 uint8_t header[2] = { 0, 0 }; 677 struct buf_packet *bulkp; 678 int count; 679 680 while ((bulkp = QTAILQ_FIRST(&dev->endpoint[EP2I(ep)].bufpq)) && 681 p->actual_length < p->iov.size && p->status == USB_RET_SUCCESS) { 682 if (bulkp->len < 2) { 683 WARNING("malformed ftdi bulk in packet\n"); 684 bufp_free(dev, bulkp, ep); 685 continue; 686 } 687 688 if ((p->actual_length % maxp) == 0) { 689 usb_packet_copy(p, bulkp->data, 2); 690 memcpy(header, bulkp->data, 2); 691 } else { 692 if (bulkp->data[0] != header[0] || bulkp->data[1] != header[1]) { 693 break; /* Different header, add to next packet */ 694 } 695 } 696 697 if (bulkp->offset == 0) { 698 bulkp->offset = 2; /* Skip header */ 699 } 700 count = bulkp->len - bulkp->offset; 701 /* Must repeat the header at maxp interval */ 702 if (count > (maxp - (p->actual_length % maxp))) { 703 count = maxp - (p->actual_length % maxp); 704 } 705 usbredir_buffered_bulk_add_data_to_packet(dev, bulkp, count, p, ep); 706 } 707 } 708 709 static void usbredir_buffered_bulk_in_complete(USBRedirDevice *dev, 710 USBPacket *p, uint8_t ep) 711 { 712 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */ 713 dev->buffered_bulk_in_complete(dev, p, ep); 714 DPRINTF("bulk-token-in ep %02X status %d len %d id %"PRIu64"\n", 715 ep, p->status, p->actual_length, p->id); 716 } 717 718 static void usbredir_handle_buffered_bulk_in_data(USBRedirDevice *dev, 719 USBPacket *p, uint8_t ep) 720 { 721 /* Input bulk endpoint, buffered packet input */ 722 if (!dev->endpoint[EP2I(ep)].bulk_receiving_started) { 723 int bpt; 724 struct usb_redir_start_bulk_receiving_header start = { 725 .endpoint = ep, 726 .stream_id = 0, 727 .no_transfers = 5, 728 }; 729 /* Round bytes_per_transfer up to a multiple of max_packet_size */ 730 bpt = 512 + dev->endpoint[EP2I(ep)].max_packet_size - 1; 731 bpt /= dev->endpoint[EP2I(ep)].max_packet_size; 732 bpt *= dev->endpoint[EP2I(ep)].max_packet_size; 733 start.bytes_per_transfer = bpt; 734 /* No id, we look at the ep when receiving a status back */ 735 usbredirparser_send_start_bulk_receiving(dev->parser, 0, &start); 736 usbredirparser_do_write(dev->parser); 737 DPRINTF("bulk receiving started bytes/transfer %u count %d ep %02X\n", 738 start.bytes_per_transfer, start.no_transfers, ep); 739 dev->endpoint[EP2I(ep)].bulk_receiving_started = 1; 740 /* We don't really want to drop bulk packets ever, but 741 having some upper limit to how much we buffer is good. */ 742 dev->endpoint[EP2I(ep)].bufpq_target_size = 5000; 743 dev->endpoint[EP2I(ep)].bufpq_dropping_packets = 0; 744 } 745 746 if (QTAILQ_EMPTY(&dev->endpoint[EP2I(ep)].bufpq)) { 747 DPRINTF("bulk-token-in ep %02X, no bulkp\n", ep); 748 assert(dev->endpoint[EP2I(ep)].pending_async_packet == NULL); 749 dev->endpoint[EP2I(ep)].pending_async_packet = p; 750 p->status = USB_RET_ASYNC; 751 return; 752 } 753 usbredir_buffered_bulk_in_complete(dev, p, ep); 754 } 755 756 static void usbredir_stop_bulk_receiving(USBRedirDevice *dev, uint8_t ep) 757 { 758 struct usb_redir_stop_bulk_receiving_header stop_bulk = { 759 .endpoint = ep, 760 .stream_id = 0, 761 }; 762 if (dev->endpoint[EP2I(ep)].bulk_receiving_started) { 763 usbredirparser_send_stop_bulk_receiving(dev->parser, 0, &stop_bulk); 764 DPRINTF("bulk receiving stopped ep %02X\n", ep); 765 dev->endpoint[EP2I(ep)].bulk_receiving_started = 0; 766 } 767 usbredir_free_bufpq(dev, ep); 768 } 769 770 static void usbredir_handle_bulk_data(USBRedirDevice *dev, USBPacket *p, 771 uint8_t ep) 772 { 773 struct usb_redir_bulk_packet_header bulk_packet; 774 size_t size = usb_packet_size(p); 775 const int maxp = dev->endpoint[EP2I(ep)].max_packet_size; 776 777 if (usbredir_already_in_flight(dev, p->id)) { 778 p->status = USB_RET_ASYNC; 779 return; 780 } 781 782 if (dev->endpoint[EP2I(ep)].bulk_receiving_enabled) { 783 if (size != 0 && (size % maxp) == 0) { 784 usbredir_handle_buffered_bulk_in_data(dev, p, ep); 785 return; 786 } 787 WARNING("bulk recv invalid size %zd ep %02x, disabling\n", size, ep); 788 assert(dev->endpoint[EP2I(ep)].pending_async_packet == NULL); 789 usbredir_stop_bulk_receiving(dev, ep); 790 dev->endpoint[EP2I(ep)].bulk_receiving_enabled = 0; 791 } 792 793 DPRINTF("bulk-out ep %02X stream %u len %zd id %"PRIu64"\n", 794 ep, p->stream, size, p->id); 795 796 bulk_packet.endpoint = ep; 797 bulk_packet.length = size; 798 bulk_packet.stream_id = p->stream; 799 bulk_packet.length_high = size >> 16; 800 assert(bulk_packet.length_high == 0 || 801 usbredirparser_peer_has_cap(dev->parser, 802 usb_redir_cap_32bits_bulk_length)); 803 804 if (ep & USB_DIR_IN || size == 0) { 805 usbredirparser_send_bulk_packet(dev->parser, p->id, 806 &bulk_packet, NULL, 0); 807 } else { 808 uint8_t buf[size]; 809 usb_packet_copy(p, buf, size); 810 usbredir_log_data(dev, "bulk data out:", buf, size); 811 usbredirparser_send_bulk_packet(dev->parser, p->id, 812 &bulk_packet, buf, size); 813 } 814 usbredirparser_do_write(dev->parser); 815 p->status = USB_RET_ASYNC; 816 } 817 818 static void usbredir_handle_interrupt_in_data(USBRedirDevice *dev, 819 USBPacket *p, uint8_t ep) 820 { 821 /* Input interrupt endpoint, buffered packet input */ 822 struct buf_packet *intp; 823 int status, len; 824 825 if (!dev->endpoint[EP2I(ep)].interrupt_started && 826 !dev->endpoint[EP2I(ep)].interrupt_error) { 827 struct usb_redir_start_interrupt_receiving_header start_int = { 828 .endpoint = ep, 829 }; 830 /* No id, we look at the ep when receiving a status back */ 831 usbredirparser_send_start_interrupt_receiving(dev->parser, 0, 832 &start_int); 833 usbredirparser_do_write(dev->parser); 834 DPRINTF("interrupt recv started ep %02X\n", ep); 835 dev->endpoint[EP2I(ep)].interrupt_started = 1; 836 /* We don't really want to drop interrupt packets ever, but 837 having some upper limit to how much we buffer is good. */ 838 dev->endpoint[EP2I(ep)].bufpq_target_size = 1000; 839 dev->endpoint[EP2I(ep)].bufpq_dropping_packets = 0; 840 } 841 842 intp = QTAILQ_FIRST(&dev->endpoint[EP2I(ep)].bufpq); 843 if (intp == NULL) { 844 DPRINTF2("interrupt-token-in ep %02X, no intp\n", ep); 845 /* Check interrupt_error for stream errors */ 846 status = dev->endpoint[EP2I(ep)].interrupt_error; 847 dev->endpoint[EP2I(ep)].interrupt_error = 0; 848 if (status) { 849 usbredir_handle_status(dev, p, status); 850 } else { 851 p->status = USB_RET_NAK; 852 } 853 return; 854 } 855 DPRINTF("interrupt-token-in ep %02X status %d len %d\n", ep, 856 intp->status, intp->len); 857 858 status = intp->status; 859 len = intp->len; 860 if (len > p->iov.size) { 861 ERROR("received int data is larger then packet ep %02X\n", ep); 862 len = p->iov.size; 863 status = usb_redir_babble; 864 } 865 usb_packet_copy(p, intp->data, len); 866 bufp_free(dev, intp, ep); 867 usbredir_handle_status(dev, p, status); 868 } 869 870 /* 871 * Handle interrupt out data, the usbredir protocol expects us to do this 872 * async, so that it can report back a completion status. But guests will 873 * expect immediate completion for an interrupt endpoint, and handling this 874 * async causes migration issues. So we report success directly, counting 875 * on the fact that output interrupt packets normally always succeed. 876 */ 877 static void usbredir_handle_interrupt_out_data(USBRedirDevice *dev, 878 USBPacket *p, uint8_t ep) 879 { 880 struct usb_redir_interrupt_packet_header interrupt_packet; 881 uint8_t buf[p->iov.size]; 882 883 DPRINTF("interrupt-out ep %02X len %zd id %"PRIu64"\n", ep, 884 p->iov.size, p->id); 885 886 interrupt_packet.endpoint = ep; 887 interrupt_packet.length = p->iov.size; 888 889 usb_packet_copy(p, buf, p->iov.size); 890 usbredir_log_data(dev, "interrupt data out:", buf, p->iov.size); 891 usbredirparser_send_interrupt_packet(dev->parser, p->id, 892 &interrupt_packet, buf, p->iov.size); 893 usbredirparser_do_write(dev->parser); 894 } 895 896 static void usbredir_stop_interrupt_receiving(USBRedirDevice *dev, 897 uint8_t ep) 898 { 899 struct usb_redir_stop_interrupt_receiving_header stop_interrupt_recv = { 900 .endpoint = ep 901 }; 902 if (dev->endpoint[EP2I(ep)].interrupt_started) { 903 usbredirparser_send_stop_interrupt_receiving(dev->parser, 0, 904 &stop_interrupt_recv); 905 DPRINTF("interrupt recv stopped ep %02X\n", ep); 906 dev->endpoint[EP2I(ep)].interrupt_started = 0; 907 } 908 dev->endpoint[EP2I(ep)].interrupt_error = 0; 909 usbredir_free_bufpq(dev, ep); 910 } 911 912 static void usbredir_handle_data(USBDevice *udev, USBPacket *p) 913 { 914 USBRedirDevice *dev = USB_REDIRECT(udev); 915 uint8_t ep; 916 917 ep = p->ep->nr; 918 if (p->pid == USB_TOKEN_IN) { 919 ep |= USB_DIR_IN; 920 } 921 922 switch (dev->endpoint[EP2I(ep)].type) { 923 case USB_ENDPOINT_XFER_CONTROL: 924 ERROR("handle_data called for control transfer on ep %02X\n", ep); 925 p->status = USB_RET_NAK; 926 break; 927 case USB_ENDPOINT_XFER_BULK: 928 if (p->state == USB_PACKET_SETUP && p->pid == USB_TOKEN_IN && 929 p->ep->pipeline) { 930 p->status = USB_RET_ADD_TO_QUEUE; 931 break; 932 } 933 usbredir_handle_bulk_data(dev, p, ep); 934 break; 935 case USB_ENDPOINT_XFER_ISOC: 936 usbredir_handle_iso_data(dev, p, ep); 937 break; 938 case USB_ENDPOINT_XFER_INT: 939 if (ep & USB_DIR_IN) { 940 usbredir_handle_interrupt_in_data(dev, p, ep); 941 } else { 942 usbredir_handle_interrupt_out_data(dev, p, ep); 943 } 944 break; 945 default: 946 ERROR("handle_data ep %02X has unknown type %d\n", ep, 947 dev->endpoint[EP2I(ep)].type); 948 p->status = USB_RET_NAK; 949 } 950 } 951 952 static void usbredir_flush_ep_queue(USBDevice *dev, USBEndpoint *ep) 953 { 954 if (ep->pid == USB_TOKEN_IN && ep->pipeline) { 955 usb_ep_combine_input_packets(ep); 956 } 957 } 958 959 static void usbredir_stop_ep(USBRedirDevice *dev, int i) 960 { 961 uint8_t ep = I2EP(i); 962 963 switch (dev->endpoint[i].type) { 964 case USB_ENDPOINT_XFER_BULK: 965 if (ep & USB_DIR_IN) { 966 usbredir_stop_bulk_receiving(dev, ep); 967 } 968 break; 969 case USB_ENDPOINT_XFER_ISOC: 970 usbredir_stop_iso_stream(dev, ep); 971 break; 972 case USB_ENDPOINT_XFER_INT: 973 if (ep & USB_DIR_IN) { 974 usbredir_stop_interrupt_receiving(dev, ep); 975 } 976 break; 977 } 978 usbredir_free_bufpq(dev, ep); 979 } 980 981 static void usbredir_ep_stopped(USBDevice *udev, USBEndpoint *uep) 982 { 983 USBRedirDevice *dev = USB_REDIRECT(udev); 984 985 usbredir_stop_ep(dev, USBEP2I(uep)); 986 usbredirparser_do_write(dev->parser); 987 } 988 989 static void usbredir_set_config(USBRedirDevice *dev, USBPacket *p, 990 int config) 991 { 992 struct usb_redir_set_configuration_header set_config; 993 int i; 994 995 DPRINTF("set config %d id %"PRIu64"\n", config, p->id); 996 997 for (i = 0; i < MAX_ENDPOINTS; i++) { 998 usbredir_stop_ep(dev, i); 999 } 1000 1001 set_config.configuration = config; 1002 usbredirparser_send_set_configuration(dev->parser, p->id, &set_config); 1003 usbredirparser_do_write(dev->parser); 1004 p->status = USB_RET_ASYNC; 1005 } 1006 1007 static void usbredir_get_config(USBRedirDevice *dev, USBPacket *p) 1008 { 1009 DPRINTF("get config id %"PRIu64"\n", p->id); 1010 1011 usbredirparser_send_get_configuration(dev->parser, p->id); 1012 usbredirparser_do_write(dev->parser); 1013 p->status = USB_RET_ASYNC; 1014 } 1015 1016 static void usbredir_set_interface(USBRedirDevice *dev, USBPacket *p, 1017 int interface, int alt) 1018 { 1019 struct usb_redir_set_alt_setting_header set_alt; 1020 int i; 1021 1022 DPRINTF("set interface %d alt %d id %"PRIu64"\n", interface, alt, p->id); 1023 1024 for (i = 0; i < MAX_ENDPOINTS; i++) { 1025 if (dev->endpoint[i].interface == interface) { 1026 usbredir_stop_ep(dev, i); 1027 } 1028 } 1029 1030 set_alt.interface = interface; 1031 set_alt.alt = alt; 1032 usbredirparser_send_set_alt_setting(dev->parser, p->id, &set_alt); 1033 usbredirparser_do_write(dev->parser); 1034 p->status = USB_RET_ASYNC; 1035 } 1036 1037 static void usbredir_get_interface(USBRedirDevice *dev, USBPacket *p, 1038 int interface) 1039 { 1040 struct usb_redir_get_alt_setting_header get_alt; 1041 1042 DPRINTF("get interface %d id %"PRIu64"\n", interface, p->id); 1043 1044 get_alt.interface = interface; 1045 usbredirparser_send_get_alt_setting(dev->parser, p->id, &get_alt); 1046 usbredirparser_do_write(dev->parser); 1047 p->status = USB_RET_ASYNC; 1048 } 1049 1050 static void usbredir_handle_control(USBDevice *udev, USBPacket *p, 1051 int request, int value, int index, int length, uint8_t *data) 1052 { 1053 USBRedirDevice *dev = USB_REDIRECT(udev); 1054 struct usb_redir_control_packet_header control_packet; 1055 1056 if (usbredir_already_in_flight(dev, p->id)) { 1057 p->status = USB_RET_ASYNC; 1058 return; 1059 } 1060 1061 /* Special cases for certain standard device requests */ 1062 switch (request) { 1063 case DeviceOutRequest | USB_REQ_SET_ADDRESS: 1064 DPRINTF("set address %d\n", value); 1065 dev->dev.addr = value; 1066 return; 1067 case DeviceOutRequest | USB_REQ_SET_CONFIGURATION: 1068 usbredir_set_config(dev, p, value & 0xff); 1069 return; 1070 case DeviceRequest | USB_REQ_GET_CONFIGURATION: 1071 usbredir_get_config(dev, p); 1072 return; 1073 case InterfaceOutRequest | USB_REQ_SET_INTERFACE: 1074 usbredir_set_interface(dev, p, index, value); 1075 return; 1076 case InterfaceRequest | USB_REQ_GET_INTERFACE: 1077 usbredir_get_interface(dev, p, index); 1078 return; 1079 } 1080 1081 /* Normal ctrl requests, note request is (bRequestType << 8) | bRequest */ 1082 DPRINTF( 1083 "ctrl-out type 0x%x req 0x%x val 0x%x index %d len %d id %"PRIu64"\n", 1084 request >> 8, request & 0xff, value, index, length, p->id); 1085 1086 control_packet.request = request & 0xFF; 1087 control_packet.requesttype = request >> 8; 1088 control_packet.endpoint = control_packet.requesttype & USB_DIR_IN; 1089 control_packet.value = value; 1090 control_packet.index = index; 1091 control_packet.length = length; 1092 1093 if (control_packet.requesttype & USB_DIR_IN) { 1094 usbredirparser_send_control_packet(dev->parser, p->id, 1095 &control_packet, NULL, 0); 1096 } else { 1097 usbredir_log_data(dev, "ctrl data out:", data, length); 1098 usbredirparser_send_control_packet(dev->parser, p->id, 1099 &control_packet, data, length); 1100 } 1101 usbredirparser_do_write(dev->parser); 1102 p->status = USB_RET_ASYNC; 1103 } 1104 1105 static int usbredir_alloc_streams(USBDevice *udev, USBEndpoint **eps, 1106 int nr_eps, int streams) 1107 { 1108 USBRedirDevice *dev = USB_REDIRECT(udev); 1109 #if USBREDIR_VERSION >= 0x000700 1110 struct usb_redir_alloc_bulk_streams_header alloc_streams; 1111 int i; 1112 1113 if (!usbredirparser_peer_has_cap(dev->parser, 1114 usb_redir_cap_bulk_streams)) { 1115 ERROR("peer does not support streams\n"); 1116 goto reject; 1117 } 1118 1119 if (streams == 0) { 1120 ERROR("request to allocate 0 streams\n"); 1121 return -1; 1122 } 1123 1124 alloc_streams.no_streams = streams; 1125 alloc_streams.endpoints = 0; 1126 for (i = 0; i < nr_eps; i++) { 1127 alloc_streams.endpoints |= 1 << USBEP2I(eps[i]); 1128 } 1129 usbredirparser_send_alloc_bulk_streams(dev->parser, 0, &alloc_streams); 1130 usbredirparser_do_write(dev->parser); 1131 1132 return 0; 1133 #else 1134 ERROR("usbredir_alloc_streams not implemented\n"); 1135 goto reject; 1136 #endif 1137 reject: 1138 ERROR("streams are not available, disconnecting\n"); 1139 qemu_bh_schedule(dev->device_reject_bh); 1140 return -1; 1141 } 1142 1143 static void usbredir_free_streams(USBDevice *udev, USBEndpoint **eps, 1144 int nr_eps) 1145 { 1146 #if USBREDIR_VERSION >= 0x000700 1147 USBRedirDevice *dev = USB_REDIRECT(udev); 1148 struct usb_redir_free_bulk_streams_header free_streams; 1149 int i; 1150 1151 if (!usbredirparser_peer_has_cap(dev->parser, 1152 usb_redir_cap_bulk_streams)) { 1153 return; 1154 } 1155 1156 free_streams.endpoints = 0; 1157 for (i = 0; i < nr_eps; i++) { 1158 free_streams.endpoints |= 1 << USBEP2I(eps[i]); 1159 } 1160 usbredirparser_send_free_bulk_streams(dev->parser, 0, &free_streams); 1161 usbredirparser_do_write(dev->parser); 1162 #endif 1163 } 1164 1165 /* 1166 * Close events can be triggered by usbredirparser_do_write which gets called 1167 * from within the USBDevice data / control packet callbacks and doing a 1168 * usb_detach from within these callbacks is not a good idea. 1169 * 1170 * So we use a bh handler to take care of close events. 1171 */ 1172 static void usbredir_chardev_close_bh(void *opaque) 1173 { 1174 USBRedirDevice *dev = opaque; 1175 1176 qemu_bh_cancel(dev->device_reject_bh); 1177 usbredir_device_disconnect(dev); 1178 1179 if (dev->parser) { 1180 DPRINTF("destroying usbredirparser\n"); 1181 usbredirparser_destroy(dev->parser); 1182 dev->parser = NULL; 1183 } 1184 if (dev->watch) { 1185 g_source_remove(dev->watch); 1186 dev->watch = 0; 1187 } 1188 } 1189 1190 static void usbredir_create_parser(USBRedirDevice *dev) 1191 { 1192 uint32_t caps[USB_REDIR_CAPS_SIZE] = { 0, }; 1193 int flags = 0; 1194 1195 DPRINTF("creating usbredirparser\n"); 1196 1197 dev->parser = qemu_oom_check(usbredirparser_create()); 1198 dev->parser->priv = dev; 1199 dev->parser->log_func = usbredir_log; 1200 dev->parser->read_func = usbredir_read; 1201 dev->parser->write_func = usbredir_write; 1202 dev->parser->hello_func = usbredir_hello; 1203 dev->parser->device_connect_func = usbredir_device_connect; 1204 dev->parser->device_disconnect_func = usbredir_device_disconnect; 1205 dev->parser->interface_info_func = usbredir_interface_info; 1206 dev->parser->ep_info_func = usbredir_ep_info; 1207 dev->parser->configuration_status_func = usbredir_configuration_status; 1208 dev->parser->alt_setting_status_func = usbredir_alt_setting_status; 1209 dev->parser->iso_stream_status_func = usbredir_iso_stream_status; 1210 dev->parser->interrupt_receiving_status_func = 1211 usbredir_interrupt_receiving_status; 1212 dev->parser->bulk_streams_status_func = usbredir_bulk_streams_status; 1213 dev->parser->bulk_receiving_status_func = usbredir_bulk_receiving_status; 1214 dev->parser->control_packet_func = usbredir_control_packet; 1215 dev->parser->bulk_packet_func = usbredir_bulk_packet; 1216 dev->parser->iso_packet_func = usbredir_iso_packet; 1217 dev->parser->interrupt_packet_func = usbredir_interrupt_packet; 1218 dev->parser->buffered_bulk_packet_func = usbredir_buffered_bulk_packet; 1219 dev->read_buf = NULL; 1220 dev->read_buf_size = 0; 1221 1222 usbredirparser_caps_set_cap(caps, usb_redir_cap_connect_device_version); 1223 usbredirparser_caps_set_cap(caps, usb_redir_cap_filter); 1224 usbredirparser_caps_set_cap(caps, usb_redir_cap_ep_info_max_packet_size); 1225 usbredirparser_caps_set_cap(caps, usb_redir_cap_64bits_ids); 1226 usbredirparser_caps_set_cap(caps, usb_redir_cap_32bits_bulk_length); 1227 usbredirparser_caps_set_cap(caps, usb_redir_cap_bulk_receiving); 1228 #if USBREDIR_VERSION >= 0x000700 1229 if (dev->enable_streams) { 1230 usbredirparser_caps_set_cap(caps, usb_redir_cap_bulk_streams); 1231 } 1232 #endif 1233 1234 if (runstate_check(RUN_STATE_INMIGRATE)) { 1235 flags |= usbredirparser_fl_no_hello; 1236 } 1237 usbredirparser_init(dev->parser, VERSION, caps, USB_REDIR_CAPS_SIZE, 1238 flags); 1239 usbredirparser_do_write(dev->parser); 1240 } 1241 1242 static void usbredir_reject_device(USBRedirDevice *dev) 1243 { 1244 usbredir_device_disconnect(dev); 1245 if (usbredirparser_peer_has_cap(dev->parser, usb_redir_cap_filter)) { 1246 usbredirparser_send_filter_reject(dev->parser); 1247 usbredirparser_do_write(dev->parser); 1248 } 1249 } 1250 1251 /* 1252 * We may need to reject the device when the hcd calls alloc_streams, doing 1253 * an usb_detach from within a hcd call is not a good idea, hence this bh. 1254 */ 1255 static void usbredir_device_reject_bh(void *opaque) 1256 { 1257 USBRedirDevice *dev = opaque; 1258 1259 usbredir_reject_device(dev); 1260 } 1261 1262 static void usbredir_do_attach(void *opaque) 1263 { 1264 USBRedirDevice *dev = opaque; 1265 Error *local_err = NULL; 1266 1267 /* In order to work properly with XHCI controllers we need these caps */ 1268 if ((dev->dev.port->speedmask & USB_SPEED_MASK_SUPER) && !( 1269 usbredirparser_peer_has_cap(dev->parser, 1270 usb_redir_cap_ep_info_max_packet_size) && 1271 usbredirparser_peer_has_cap(dev->parser, 1272 usb_redir_cap_32bits_bulk_length) && 1273 usbredirparser_peer_has_cap(dev->parser, 1274 usb_redir_cap_64bits_ids))) { 1275 ERROR("usb-redir-host lacks capabilities needed for use with XHCI\n"); 1276 usbredir_reject_device(dev); 1277 return; 1278 } 1279 1280 usb_device_attach(&dev->dev, &local_err); 1281 if (local_err) { 1282 error_report_err(local_err); 1283 WARNING("rejecting device due to speed mismatch\n"); 1284 usbredir_reject_device(dev); 1285 } 1286 } 1287 1288 /* 1289 * chardev callbacks 1290 */ 1291 1292 static int usbredir_chardev_can_read(void *opaque) 1293 { 1294 USBRedirDevice *dev = opaque; 1295 1296 if (!dev->parser) { 1297 WARNING("chardev_can_read called on non open chardev!\n"); 1298 return 0; 1299 } 1300 1301 /* Don't read new data from the chardev until our state is fully synced */ 1302 if (!runstate_check(RUN_STATE_RUNNING)) { 1303 return 0; 1304 } 1305 1306 /* usbredir_parser_do_read will consume *all* data we give it */ 1307 return 1 * MiB; 1308 } 1309 1310 static void usbredir_chardev_read(void *opaque, const uint8_t *buf, int size) 1311 { 1312 USBRedirDevice *dev = opaque; 1313 1314 /* No recursion allowed! */ 1315 assert(dev->read_buf == NULL); 1316 1317 dev->read_buf = buf; 1318 dev->read_buf_size = size; 1319 1320 usbredirparser_do_read(dev->parser); 1321 /* Send any acks, etc. which may be queued now */ 1322 usbredirparser_do_write(dev->parser); 1323 } 1324 1325 static void usbredir_chardev_event(void *opaque, int event) 1326 { 1327 USBRedirDevice *dev = opaque; 1328 1329 switch (event) { 1330 case CHR_EVENT_OPENED: 1331 DPRINTF("chardev open\n"); 1332 /* Make sure any pending closes are handled (no-op if none pending) */ 1333 usbredir_chardev_close_bh(dev); 1334 qemu_bh_cancel(dev->chardev_close_bh); 1335 usbredir_create_parser(dev); 1336 break; 1337 case CHR_EVENT_CLOSED: 1338 DPRINTF("chardev close\n"); 1339 qemu_bh_schedule(dev->chardev_close_bh); 1340 break; 1341 } 1342 } 1343 1344 /* 1345 * init + destroy 1346 */ 1347 1348 static void usbredir_vm_state_change(void *priv, int running, RunState state) 1349 { 1350 USBRedirDevice *dev = priv; 1351 1352 if (state == RUN_STATE_RUNNING && dev->parser != NULL) { 1353 usbredirparser_do_write(dev->parser); /* Flush any pending writes */ 1354 } 1355 } 1356 1357 static void usbredir_init_endpoints(USBRedirDevice *dev) 1358 { 1359 int i; 1360 1361 usb_ep_init(&dev->dev); 1362 memset(dev->endpoint, 0, sizeof(dev->endpoint)); 1363 for (i = 0; i < MAX_ENDPOINTS; i++) { 1364 dev->endpoint[i].dev = dev; 1365 QTAILQ_INIT(&dev->endpoint[i].bufpq); 1366 } 1367 } 1368 1369 static void usbredir_realize(USBDevice *udev, Error **errp) 1370 { 1371 USBRedirDevice *dev = USB_REDIRECT(udev); 1372 int i; 1373 1374 if (!qemu_chr_fe_backend_connected(&dev->cs)) { 1375 error_setg(errp, QERR_MISSING_PARAMETER, "chardev"); 1376 return; 1377 } 1378 1379 if (dev->filter_str) { 1380 i = usbredirfilter_string_to_rules(dev->filter_str, ":", "|", 1381 &dev->filter_rules, 1382 &dev->filter_rules_count); 1383 if (i) { 1384 error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "filter", 1385 "a usb device filter string"); 1386 return; 1387 } 1388 } 1389 1390 dev->chardev_close_bh = qemu_bh_new(usbredir_chardev_close_bh, dev); 1391 dev->device_reject_bh = qemu_bh_new(usbredir_device_reject_bh, dev); 1392 dev->attach_timer = timer_new_ms(QEMU_CLOCK_VIRTUAL, usbredir_do_attach, dev); 1393 1394 packet_id_queue_init(&dev->cancelled, dev, "cancelled"); 1395 packet_id_queue_init(&dev->already_in_flight, dev, "already-in-flight"); 1396 usbredir_init_endpoints(dev); 1397 1398 /* We'll do the attach once we receive the speed from the usb-host */ 1399 udev->auto_attach = 0; 1400 1401 /* Will be cleared during setup when we find conflicts */ 1402 dev->compatible_speedmask = USB_SPEED_MASK_FULL | USB_SPEED_MASK_HIGH; 1403 1404 /* Let the backend know we are ready */ 1405 qemu_chr_fe_set_handlers(&dev->cs, usbredir_chardev_can_read, 1406 usbredir_chardev_read, usbredir_chardev_event, 1407 NULL, dev, NULL, true); 1408 1409 dev->vmstate = 1410 qemu_add_vm_change_state_handler(usbredir_vm_state_change, dev); 1411 } 1412 1413 static void usbredir_cleanup_device_queues(USBRedirDevice *dev) 1414 { 1415 int i; 1416 1417 packet_id_queue_empty(&dev->cancelled); 1418 packet_id_queue_empty(&dev->already_in_flight); 1419 for (i = 0; i < MAX_ENDPOINTS; i++) { 1420 usbredir_free_bufpq(dev, I2EP(i)); 1421 } 1422 } 1423 1424 static void usbredir_unrealize(USBDevice *udev, Error **errp) 1425 { 1426 USBRedirDevice *dev = USB_REDIRECT(udev); 1427 1428 qemu_chr_fe_deinit(&dev->cs, true); 1429 1430 /* Note must be done after qemu_chr_close, as that causes a close event */ 1431 qemu_bh_delete(dev->chardev_close_bh); 1432 qemu_bh_delete(dev->device_reject_bh); 1433 1434 timer_del(dev->attach_timer); 1435 timer_free(dev->attach_timer); 1436 1437 usbredir_cleanup_device_queues(dev); 1438 1439 if (dev->parser) { 1440 usbredirparser_destroy(dev->parser); 1441 } 1442 if (dev->watch) { 1443 g_source_remove(dev->watch); 1444 } 1445 1446 free(dev->filter_rules); 1447 qemu_del_vm_change_state_handler(dev->vmstate); 1448 } 1449 1450 static int usbredir_check_filter(USBRedirDevice *dev) 1451 { 1452 if (dev->interface_info.interface_count == NO_INTERFACE_INFO) { 1453 ERROR("No interface info for device\n"); 1454 goto error; 1455 } 1456 1457 if (dev->filter_rules) { 1458 if (!usbredirparser_peer_has_cap(dev->parser, 1459 usb_redir_cap_connect_device_version)) { 1460 ERROR("Device filter specified and peer does not have the " 1461 "connect_device_version capability\n"); 1462 goto error; 1463 } 1464 1465 if (usbredirfilter_check( 1466 dev->filter_rules, 1467 dev->filter_rules_count, 1468 dev->device_info.device_class, 1469 dev->device_info.device_subclass, 1470 dev->device_info.device_protocol, 1471 dev->interface_info.interface_class, 1472 dev->interface_info.interface_subclass, 1473 dev->interface_info.interface_protocol, 1474 dev->interface_info.interface_count, 1475 dev->device_info.vendor_id, 1476 dev->device_info.product_id, 1477 dev->device_info.device_version_bcd, 1478 0) != 0) { 1479 goto error; 1480 } 1481 } 1482 1483 return 0; 1484 1485 error: 1486 usbredir_reject_device(dev); 1487 return -1; 1488 } 1489 1490 static void usbredir_check_bulk_receiving(USBRedirDevice *dev) 1491 { 1492 int i, j, quirks; 1493 1494 if (!usbredirparser_peer_has_cap(dev->parser, 1495 usb_redir_cap_bulk_receiving)) { 1496 return; 1497 } 1498 1499 for (i = EP2I(USB_DIR_IN); i < MAX_ENDPOINTS; i++) { 1500 dev->endpoint[i].bulk_receiving_enabled = 0; 1501 } 1502 for (i = 0; i < dev->interface_info.interface_count; i++) { 1503 quirks = usb_get_quirks(dev->device_info.vendor_id, 1504 dev->device_info.product_id, 1505 dev->interface_info.interface_class[i], 1506 dev->interface_info.interface_subclass[i], 1507 dev->interface_info.interface_protocol[i]); 1508 if (!(quirks & USB_QUIRK_BUFFER_BULK_IN)) { 1509 continue; 1510 } 1511 if (quirks & USB_QUIRK_IS_FTDI) { 1512 dev->buffered_bulk_in_complete = 1513 usbredir_buffered_bulk_in_complete_ftdi; 1514 } else { 1515 dev->buffered_bulk_in_complete = 1516 usbredir_buffered_bulk_in_complete_raw; 1517 } 1518 1519 for (j = EP2I(USB_DIR_IN); j < MAX_ENDPOINTS; j++) { 1520 if (dev->endpoint[j].interface == 1521 dev->interface_info.interface[i] && 1522 dev->endpoint[j].type == USB_ENDPOINT_XFER_BULK && 1523 dev->endpoint[j].max_packet_size != 0) { 1524 dev->endpoint[j].bulk_receiving_enabled = 1; 1525 /* 1526 * With buffering pipelining is not necessary. Also packet 1527 * combining and bulk in buffering don't play nice together! 1528 */ 1529 I2USBEP(dev, j)->pipeline = false; 1530 break; /* Only buffer for the first ep of each intf */ 1531 } 1532 } 1533 } 1534 } 1535 1536 /* 1537 * usbredirparser packet complete callbacks 1538 */ 1539 1540 static void usbredir_handle_status(USBRedirDevice *dev, USBPacket *p, 1541 int status) 1542 { 1543 switch (status) { 1544 case usb_redir_success: 1545 p->status = USB_RET_SUCCESS; /* Clear previous ASYNC status */ 1546 break; 1547 case usb_redir_stall: 1548 p->status = USB_RET_STALL; 1549 break; 1550 case usb_redir_cancelled: 1551 /* 1552 * When the usbredir-host unredirects a device, it will report a status 1553 * of cancelled for all pending packets, followed by a disconnect msg. 1554 */ 1555 p->status = USB_RET_IOERROR; 1556 break; 1557 case usb_redir_inval: 1558 WARNING("got invalid param error from usb-host?\n"); 1559 p->status = USB_RET_IOERROR; 1560 break; 1561 case usb_redir_babble: 1562 p->status = USB_RET_BABBLE; 1563 break; 1564 case usb_redir_ioerror: 1565 case usb_redir_timeout: 1566 default: 1567 p->status = USB_RET_IOERROR; 1568 } 1569 } 1570 1571 static void usbredir_hello(void *priv, struct usb_redir_hello_header *h) 1572 { 1573 USBRedirDevice *dev = priv; 1574 1575 /* Try to send the filter info now that we've the usb-host's caps */ 1576 if (usbredirparser_peer_has_cap(dev->parser, usb_redir_cap_filter) && 1577 dev->filter_rules) { 1578 usbredirparser_send_filter_filter(dev->parser, dev->filter_rules, 1579 dev->filter_rules_count); 1580 usbredirparser_do_write(dev->parser); 1581 } 1582 } 1583 1584 static void usbredir_device_connect(void *priv, 1585 struct usb_redir_device_connect_header *device_connect) 1586 { 1587 USBRedirDevice *dev = priv; 1588 const char *speed; 1589 1590 if (timer_pending(dev->attach_timer) || dev->dev.attached) { 1591 ERROR("Received device connect while already connected\n"); 1592 return; 1593 } 1594 1595 switch (device_connect->speed) { 1596 case usb_redir_speed_low: 1597 speed = "low speed"; 1598 dev->dev.speed = USB_SPEED_LOW; 1599 dev->compatible_speedmask &= ~USB_SPEED_MASK_FULL; 1600 dev->compatible_speedmask &= ~USB_SPEED_MASK_HIGH; 1601 break; 1602 case usb_redir_speed_full: 1603 speed = "full speed"; 1604 dev->dev.speed = USB_SPEED_FULL; 1605 dev->compatible_speedmask &= ~USB_SPEED_MASK_HIGH; 1606 break; 1607 case usb_redir_speed_high: 1608 speed = "high speed"; 1609 dev->dev.speed = USB_SPEED_HIGH; 1610 break; 1611 case usb_redir_speed_super: 1612 speed = "super speed"; 1613 dev->dev.speed = USB_SPEED_SUPER; 1614 break; 1615 default: 1616 speed = "unknown speed"; 1617 dev->dev.speed = USB_SPEED_FULL; 1618 } 1619 1620 if (usbredirparser_peer_has_cap(dev->parser, 1621 usb_redir_cap_connect_device_version)) { 1622 INFO("attaching %s device %04x:%04x version %d.%d class %02x\n", 1623 speed, device_connect->vendor_id, device_connect->product_id, 1624 ((device_connect->device_version_bcd & 0xf000) >> 12) * 10 + 1625 ((device_connect->device_version_bcd & 0x0f00) >> 8), 1626 ((device_connect->device_version_bcd & 0x00f0) >> 4) * 10 + 1627 ((device_connect->device_version_bcd & 0x000f) >> 0), 1628 device_connect->device_class); 1629 } else { 1630 INFO("attaching %s device %04x:%04x class %02x\n", speed, 1631 device_connect->vendor_id, device_connect->product_id, 1632 device_connect->device_class); 1633 } 1634 1635 dev->dev.speedmask = (1 << dev->dev.speed) | dev->compatible_speedmask; 1636 dev->device_info = *device_connect; 1637 1638 if (usbredir_check_filter(dev)) { 1639 WARNING("Device %04x:%04x rejected by device filter, not attaching\n", 1640 device_connect->vendor_id, device_connect->product_id); 1641 return; 1642 } 1643 1644 usbredir_check_bulk_receiving(dev); 1645 timer_mod(dev->attach_timer, dev->next_attach_time); 1646 } 1647 1648 static void usbredir_device_disconnect(void *priv) 1649 { 1650 USBRedirDevice *dev = priv; 1651 1652 /* Stop any pending attaches */ 1653 timer_del(dev->attach_timer); 1654 1655 if (dev->dev.attached) { 1656 DPRINTF("detaching device\n"); 1657 usb_device_detach(&dev->dev); 1658 /* 1659 * Delay next usb device attach to give the guest a chance to see 1660 * see the detach / attach in case of quick close / open succession 1661 */ 1662 dev->next_attach_time = qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) + 200; 1663 } 1664 1665 /* Reset state so that the next dev connected starts with a clean slate */ 1666 usbredir_cleanup_device_queues(dev); 1667 usbredir_init_endpoints(dev); 1668 dev->interface_info.interface_count = NO_INTERFACE_INFO; 1669 dev->dev.addr = 0; 1670 dev->dev.speed = 0; 1671 dev->compatible_speedmask = USB_SPEED_MASK_FULL | USB_SPEED_MASK_HIGH; 1672 } 1673 1674 static void usbredir_interface_info(void *priv, 1675 struct usb_redir_interface_info_header *interface_info) 1676 { 1677 USBRedirDevice *dev = priv; 1678 1679 dev->interface_info = *interface_info; 1680 1681 /* 1682 * If we receive interface info after the device has already been 1683 * connected (ie on a set_config), re-check interface dependent things. 1684 */ 1685 if (timer_pending(dev->attach_timer) || dev->dev.attached) { 1686 usbredir_check_bulk_receiving(dev); 1687 if (usbredir_check_filter(dev)) { 1688 ERROR("Device no longer matches filter after interface info " 1689 "change, disconnecting!\n"); 1690 } 1691 } 1692 } 1693 1694 static void usbredir_mark_speed_incompatible(USBRedirDevice *dev, int speed) 1695 { 1696 dev->compatible_speedmask &= ~(1 << speed); 1697 dev->dev.speedmask = (1 << dev->dev.speed) | dev->compatible_speedmask; 1698 } 1699 1700 static void usbredir_set_pipeline(USBRedirDevice *dev, struct USBEndpoint *uep) 1701 { 1702 if (uep->type != USB_ENDPOINT_XFER_BULK) { 1703 return; 1704 } 1705 if (uep->pid == USB_TOKEN_OUT) { 1706 uep->pipeline = true; 1707 } 1708 if (uep->pid == USB_TOKEN_IN && uep->max_packet_size != 0 && 1709 usbredirparser_peer_has_cap(dev->parser, 1710 usb_redir_cap_32bits_bulk_length)) { 1711 uep->pipeline = true; 1712 } 1713 } 1714 1715 static void usbredir_setup_usb_eps(USBRedirDevice *dev) 1716 { 1717 struct USBEndpoint *usb_ep; 1718 int i; 1719 1720 for (i = 0; i < MAX_ENDPOINTS; i++) { 1721 usb_ep = I2USBEP(dev, i); 1722 usb_ep->type = dev->endpoint[i].type; 1723 usb_ep->ifnum = dev->endpoint[i].interface; 1724 usb_ep->max_packet_size = dev->endpoint[i].max_packet_size; 1725 usb_ep->max_streams = dev->endpoint[i].max_streams; 1726 usbredir_set_pipeline(dev, usb_ep); 1727 } 1728 } 1729 1730 static void usbredir_ep_info(void *priv, 1731 struct usb_redir_ep_info_header *ep_info) 1732 { 1733 USBRedirDevice *dev = priv; 1734 int i; 1735 1736 assert(dev != NULL); 1737 for (i = 0; i < MAX_ENDPOINTS; i++) { 1738 dev->endpoint[i].type = ep_info->type[i]; 1739 dev->endpoint[i].interval = ep_info->interval[i]; 1740 dev->endpoint[i].interface = ep_info->interface[i]; 1741 if (usbredirparser_peer_has_cap(dev->parser, 1742 usb_redir_cap_ep_info_max_packet_size)) { 1743 dev->endpoint[i].max_packet_size = ep_info->max_packet_size[i]; 1744 } 1745 #if USBREDIR_VERSION >= 0x000700 1746 if (usbredirparser_peer_has_cap(dev->parser, 1747 usb_redir_cap_bulk_streams)) { 1748 dev->endpoint[i].max_streams = ep_info->max_streams[i]; 1749 } 1750 #endif 1751 switch (dev->endpoint[i].type) { 1752 case usb_redir_type_invalid: 1753 break; 1754 case usb_redir_type_iso: 1755 usbredir_mark_speed_incompatible(dev, USB_SPEED_FULL); 1756 usbredir_mark_speed_incompatible(dev, USB_SPEED_HIGH); 1757 /* Fall through */ 1758 case usb_redir_type_interrupt: 1759 if (!usbredirparser_peer_has_cap(dev->parser, 1760 usb_redir_cap_ep_info_max_packet_size) || 1761 ep_info->max_packet_size[i] > 64) { 1762 usbredir_mark_speed_incompatible(dev, USB_SPEED_FULL); 1763 } 1764 if (!usbredirparser_peer_has_cap(dev->parser, 1765 usb_redir_cap_ep_info_max_packet_size) || 1766 ep_info->max_packet_size[i] > 1024) { 1767 usbredir_mark_speed_incompatible(dev, USB_SPEED_HIGH); 1768 } 1769 if (dev->endpoint[i].interval == 0) { 1770 ERROR("Received 0 interval for isoc or irq endpoint\n"); 1771 usbredir_reject_device(dev); 1772 return; 1773 } 1774 /* Fall through */ 1775 case usb_redir_type_control: 1776 case usb_redir_type_bulk: 1777 DPRINTF("ep: %02X type: %d interface: %d\n", I2EP(i), 1778 dev->endpoint[i].type, dev->endpoint[i].interface); 1779 break; 1780 default: 1781 ERROR("Received invalid endpoint type\n"); 1782 usbredir_reject_device(dev); 1783 return; 1784 } 1785 } 1786 /* The new ep info may have caused a speed incompatibility, recheck */ 1787 if (dev->dev.attached && 1788 !(dev->dev.port->speedmask & dev->dev.speedmask)) { 1789 ERROR("Device no longer matches speed after endpoint info change, " 1790 "disconnecting!\n"); 1791 usbredir_reject_device(dev); 1792 return; 1793 } 1794 usbredir_setup_usb_eps(dev); 1795 usbredir_check_bulk_receiving(dev); 1796 } 1797 1798 static void usbredir_configuration_status(void *priv, uint64_t id, 1799 struct usb_redir_configuration_status_header *config_status) 1800 { 1801 USBRedirDevice *dev = priv; 1802 USBPacket *p; 1803 1804 DPRINTF("set config status %d config %d id %"PRIu64"\n", 1805 config_status->status, config_status->configuration, id); 1806 1807 p = usbredir_find_packet_by_id(dev, 0, id); 1808 if (p) { 1809 if (dev->dev.setup_buf[0] & USB_DIR_IN) { 1810 dev->dev.data_buf[0] = config_status->configuration; 1811 p->actual_length = 1; 1812 } 1813 usbredir_handle_status(dev, p, config_status->status); 1814 usb_generic_async_ctrl_complete(&dev->dev, p); 1815 } 1816 } 1817 1818 static void usbredir_alt_setting_status(void *priv, uint64_t id, 1819 struct usb_redir_alt_setting_status_header *alt_setting_status) 1820 { 1821 USBRedirDevice *dev = priv; 1822 USBPacket *p; 1823 1824 DPRINTF("alt status %d intf %d alt %d id: %"PRIu64"\n", 1825 alt_setting_status->status, alt_setting_status->interface, 1826 alt_setting_status->alt, id); 1827 1828 p = usbredir_find_packet_by_id(dev, 0, id); 1829 if (p) { 1830 if (dev->dev.setup_buf[0] & USB_DIR_IN) { 1831 dev->dev.data_buf[0] = alt_setting_status->alt; 1832 p->actual_length = 1; 1833 } 1834 usbredir_handle_status(dev, p, alt_setting_status->status); 1835 usb_generic_async_ctrl_complete(&dev->dev, p); 1836 } 1837 } 1838 1839 static void usbredir_iso_stream_status(void *priv, uint64_t id, 1840 struct usb_redir_iso_stream_status_header *iso_stream_status) 1841 { 1842 USBRedirDevice *dev = priv; 1843 uint8_t ep = iso_stream_status->endpoint; 1844 1845 DPRINTF("iso status %d ep %02X id %"PRIu64"\n", iso_stream_status->status, 1846 ep, id); 1847 1848 if (!dev->dev.attached || !dev->endpoint[EP2I(ep)].iso_started) { 1849 return; 1850 } 1851 1852 dev->endpoint[EP2I(ep)].iso_error = iso_stream_status->status; 1853 if (iso_stream_status->status == usb_redir_stall) { 1854 DPRINTF("iso stream stopped by peer ep %02X\n", ep); 1855 dev->endpoint[EP2I(ep)].iso_started = 0; 1856 } 1857 } 1858 1859 static void usbredir_interrupt_receiving_status(void *priv, uint64_t id, 1860 struct usb_redir_interrupt_receiving_status_header 1861 *interrupt_receiving_status) 1862 { 1863 USBRedirDevice *dev = priv; 1864 uint8_t ep = interrupt_receiving_status->endpoint; 1865 1866 DPRINTF("interrupt recv status %d ep %02X id %"PRIu64"\n", 1867 interrupt_receiving_status->status, ep, id); 1868 1869 if (!dev->dev.attached || !dev->endpoint[EP2I(ep)].interrupt_started) { 1870 return; 1871 } 1872 1873 dev->endpoint[EP2I(ep)].interrupt_error = 1874 interrupt_receiving_status->status; 1875 if (interrupt_receiving_status->status == usb_redir_stall) { 1876 DPRINTF("interrupt receiving stopped by peer ep %02X\n", ep); 1877 dev->endpoint[EP2I(ep)].interrupt_started = 0; 1878 } 1879 } 1880 1881 static void usbredir_bulk_streams_status(void *priv, uint64_t id, 1882 struct usb_redir_bulk_streams_status_header *bulk_streams_status) 1883 { 1884 #if USBREDIR_VERSION >= 0x000700 1885 USBRedirDevice *dev = priv; 1886 1887 if (bulk_streams_status->status == usb_redir_success) { 1888 DPRINTF("bulk streams status %d eps %08x\n", 1889 bulk_streams_status->status, bulk_streams_status->endpoints); 1890 } else { 1891 ERROR("bulk streams %s failed status %d eps %08x\n", 1892 (bulk_streams_status->no_streams == 0) ? "free" : "alloc", 1893 bulk_streams_status->status, bulk_streams_status->endpoints); 1894 ERROR("usb-redir-host does not provide streams, disconnecting\n"); 1895 usbredir_reject_device(dev); 1896 } 1897 #endif 1898 } 1899 1900 static void usbredir_bulk_receiving_status(void *priv, uint64_t id, 1901 struct usb_redir_bulk_receiving_status_header *bulk_receiving_status) 1902 { 1903 USBRedirDevice *dev = priv; 1904 uint8_t ep = bulk_receiving_status->endpoint; 1905 1906 DPRINTF("bulk recv status %d ep %02X id %"PRIu64"\n", 1907 bulk_receiving_status->status, ep, id); 1908 1909 if (!dev->dev.attached || !dev->endpoint[EP2I(ep)].bulk_receiving_started) { 1910 return; 1911 } 1912 1913 if (bulk_receiving_status->status == usb_redir_stall) { 1914 DPRINTF("bulk receiving stopped by peer ep %02X\n", ep); 1915 dev->endpoint[EP2I(ep)].bulk_receiving_started = 0; 1916 } 1917 } 1918 1919 static void usbredir_control_packet(void *priv, uint64_t id, 1920 struct usb_redir_control_packet_header *control_packet, 1921 uint8_t *data, int data_len) 1922 { 1923 USBRedirDevice *dev = priv; 1924 USBPacket *p; 1925 int len = control_packet->length; 1926 1927 DPRINTF("ctrl-in status %d len %d id %"PRIu64"\n", control_packet->status, 1928 len, id); 1929 1930 /* Fix up USB-3 ep0 maxpacket size to allow superspeed connected devices 1931 * to work redirected to a not superspeed capable hcd */ 1932 if (dev->dev.speed == USB_SPEED_SUPER && 1933 !((dev->dev.port->speedmask & USB_SPEED_MASK_SUPER)) && 1934 control_packet->requesttype == 0x80 && 1935 control_packet->request == 6 && 1936 control_packet->value == 0x100 && control_packet->index == 0 && 1937 data_len >= 18 && data[7] == 9) { 1938 data[7] = 64; 1939 } 1940 1941 p = usbredir_find_packet_by_id(dev, 0, id); 1942 if (p) { 1943 usbredir_handle_status(dev, p, control_packet->status); 1944 if (data_len > 0) { 1945 usbredir_log_data(dev, "ctrl data in:", data, data_len); 1946 if (data_len > sizeof(dev->dev.data_buf)) { 1947 ERROR("ctrl buffer too small (%d > %zu)\n", 1948 data_len, sizeof(dev->dev.data_buf)); 1949 p->status = USB_RET_STALL; 1950 data_len = len = sizeof(dev->dev.data_buf); 1951 } 1952 memcpy(dev->dev.data_buf, data, data_len); 1953 } 1954 p->actual_length = len; 1955 usb_generic_async_ctrl_complete(&dev->dev, p); 1956 } 1957 free(data); 1958 } 1959 1960 static void usbredir_bulk_packet(void *priv, uint64_t id, 1961 struct usb_redir_bulk_packet_header *bulk_packet, 1962 uint8_t *data, int data_len) 1963 { 1964 USBRedirDevice *dev = priv; 1965 uint8_t ep = bulk_packet->endpoint; 1966 int len = (bulk_packet->length_high << 16) | bulk_packet->length; 1967 USBPacket *p; 1968 1969 DPRINTF("bulk-in status %d ep %02X stream %u len %d id %"PRIu64"\n", 1970 bulk_packet->status, ep, bulk_packet->stream_id, len, id); 1971 1972 p = usbredir_find_packet_by_id(dev, ep, id); 1973 if (p) { 1974 size_t size = usb_packet_size(p); 1975 usbredir_handle_status(dev, p, bulk_packet->status); 1976 if (data_len > 0) { 1977 usbredir_log_data(dev, "bulk data in:", data, data_len); 1978 if (data_len > size) { 1979 ERROR("bulk got more data then requested (%d > %zd)\n", 1980 data_len, p->iov.size); 1981 p->status = USB_RET_BABBLE; 1982 data_len = len = size; 1983 } 1984 usb_packet_copy(p, data, data_len); 1985 } 1986 p->actual_length = len; 1987 if (p->pid == USB_TOKEN_IN && p->ep->pipeline) { 1988 usb_combined_input_packet_complete(&dev->dev, p); 1989 } else { 1990 usb_packet_complete(&dev->dev, p); 1991 } 1992 } 1993 free(data); 1994 } 1995 1996 static void usbredir_iso_packet(void *priv, uint64_t id, 1997 struct usb_redir_iso_packet_header *iso_packet, 1998 uint8_t *data, int data_len) 1999 { 2000 USBRedirDevice *dev = priv; 2001 uint8_t ep = iso_packet->endpoint; 2002 2003 DPRINTF2("iso-in status %d ep %02X len %d id %"PRIu64"\n", 2004 iso_packet->status, ep, data_len, id); 2005 2006 if (dev->endpoint[EP2I(ep)].type != USB_ENDPOINT_XFER_ISOC) { 2007 ERROR("received iso packet for non iso endpoint %02X\n", ep); 2008 free(data); 2009 return; 2010 } 2011 2012 if (dev->endpoint[EP2I(ep)].iso_started == 0) { 2013 DPRINTF("received iso packet for non started stream ep %02X\n", ep); 2014 free(data); 2015 return; 2016 } 2017 2018 /* bufp_alloc also adds the packet to the ep queue */ 2019 bufp_alloc(dev, data, data_len, iso_packet->status, ep, data); 2020 } 2021 2022 static void usbredir_interrupt_packet(void *priv, uint64_t id, 2023 struct usb_redir_interrupt_packet_header *interrupt_packet, 2024 uint8_t *data, int data_len) 2025 { 2026 USBRedirDevice *dev = priv; 2027 uint8_t ep = interrupt_packet->endpoint; 2028 2029 DPRINTF("interrupt-in status %d ep %02X len %d id %"PRIu64"\n", 2030 interrupt_packet->status, ep, data_len, id); 2031 2032 if (dev->endpoint[EP2I(ep)].type != USB_ENDPOINT_XFER_INT) { 2033 ERROR("received int packet for non interrupt endpoint %02X\n", ep); 2034 free(data); 2035 return; 2036 } 2037 2038 if (ep & USB_DIR_IN) { 2039 bool q_was_empty; 2040 2041 if (dev->endpoint[EP2I(ep)].interrupt_started == 0) { 2042 DPRINTF("received int packet while not started ep %02X\n", ep); 2043 free(data); 2044 return; 2045 } 2046 2047 q_was_empty = QTAILQ_EMPTY(&dev->endpoint[EP2I(ep)].bufpq); 2048 2049 /* bufp_alloc also adds the packet to the ep queue */ 2050 bufp_alloc(dev, data, data_len, interrupt_packet->status, ep, data); 2051 2052 if (q_was_empty) { 2053 usb_wakeup(usb_ep_get(&dev->dev, USB_TOKEN_IN, ep & 0x0f), 0); 2054 } 2055 } else { 2056 /* 2057 * We report output interrupt packets as completed directly upon 2058 * submission, so all we can do here if one failed is warn. 2059 */ 2060 if (interrupt_packet->status) { 2061 WARNING("interrupt output failed status %d ep %02X id %"PRIu64"\n", 2062 interrupt_packet->status, ep, id); 2063 } 2064 } 2065 } 2066 2067 static void usbredir_buffered_bulk_packet(void *priv, uint64_t id, 2068 struct usb_redir_buffered_bulk_packet_header *buffered_bulk_packet, 2069 uint8_t *data, int data_len) 2070 { 2071 USBRedirDevice *dev = priv; 2072 uint8_t status, ep = buffered_bulk_packet->endpoint; 2073 void *free_on_destroy; 2074 int i, len; 2075 2076 DPRINTF("buffered-bulk-in status %d ep %02X len %d id %"PRIu64"\n", 2077 buffered_bulk_packet->status, ep, data_len, id); 2078 2079 if (dev->endpoint[EP2I(ep)].type != USB_ENDPOINT_XFER_BULK) { 2080 ERROR("received buffered-bulk packet for non bulk ep %02X\n", ep); 2081 free(data); 2082 return; 2083 } 2084 2085 if (dev->endpoint[EP2I(ep)].bulk_receiving_started == 0) { 2086 DPRINTF("received buffered-bulk packet on not started ep %02X\n", ep); 2087 free(data); 2088 return; 2089 } 2090 2091 /* Data must be in maxp chunks for buffered_bulk_add_*_data_to_packet */ 2092 len = dev->endpoint[EP2I(ep)].max_packet_size; 2093 status = usb_redir_success; 2094 free_on_destroy = NULL; 2095 for (i = 0; i < data_len; i += len) { 2096 int r; 2097 if (len >= (data_len - i)) { 2098 len = data_len - i; 2099 status = buffered_bulk_packet->status; 2100 free_on_destroy = data; 2101 } 2102 /* bufp_alloc also adds the packet to the ep queue */ 2103 r = bufp_alloc(dev, data + i, len, status, ep, free_on_destroy); 2104 if (r) { 2105 break; 2106 } 2107 } 2108 2109 if (dev->endpoint[EP2I(ep)].pending_async_packet) { 2110 USBPacket *p = dev->endpoint[EP2I(ep)].pending_async_packet; 2111 dev->endpoint[EP2I(ep)].pending_async_packet = NULL; 2112 usbredir_buffered_bulk_in_complete(dev, p, ep); 2113 usb_packet_complete(&dev->dev, p); 2114 } 2115 } 2116 2117 /* 2118 * Migration code 2119 */ 2120 2121 static int usbredir_pre_save(void *priv) 2122 { 2123 USBRedirDevice *dev = priv; 2124 2125 usbredir_fill_already_in_flight(dev); 2126 2127 return 0; 2128 } 2129 2130 static int usbredir_post_load(void *priv, int version_id) 2131 { 2132 USBRedirDevice *dev = priv; 2133 2134 if (dev == NULL || dev->parser == NULL) { 2135 return 0; 2136 } 2137 2138 switch (dev->device_info.speed) { 2139 case usb_redir_speed_low: 2140 dev->dev.speed = USB_SPEED_LOW; 2141 break; 2142 case usb_redir_speed_full: 2143 dev->dev.speed = USB_SPEED_FULL; 2144 break; 2145 case usb_redir_speed_high: 2146 dev->dev.speed = USB_SPEED_HIGH; 2147 break; 2148 case usb_redir_speed_super: 2149 dev->dev.speed = USB_SPEED_SUPER; 2150 break; 2151 default: 2152 dev->dev.speed = USB_SPEED_FULL; 2153 } 2154 dev->dev.speedmask = (1 << dev->dev.speed); 2155 2156 usbredir_setup_usb_eps(dev); 2157 usbredir_check_bulk_receiving(dev); 2158 2159 return 0; 2160 } 2161 2162 /* For usbredirparser migration */ 2163 static int usbredir_put_parser(QEMUFile *f, void *priv, size_t unused, 2164 const VMStateField *field, QJSON *vmdesc) 2165 { 2166 USBRedirDevice *dev = priv; 2167 uint8_t *data; 2168 int len; 2169 2170 if (dev->parser == NULL) { 2171 qemu_put_be32(f, 0); 2172 return 0; 2173 } 2174 2175 usbredirparser_serialize(dev->parser, &data, &len); 2176 qemu_oom_check(data); 2177 2178 qemu_put_be32(f, len); 2179 qemu_put_buffer(f, data, len); 2180 2181 free(data); 2182 2183 return 0; 2184 } 2185 2186 static int usbredir_get_parser(QEMUFile *f, void *priv, size_t unused, 2187 const VMStateField *field) 2188 { 2189 USBRedirDevice *dev = priv; 2190 uint8_t *data; 2191 int len, ret; 2192 2193 len = qemu_get_be32(f); 2194 if (len == 0) { 2195 return 0; 2196 } 2197 2198 /* 2199 * If our chardev is not open already at this point the usbredir connection 2200 * has been broken (non seamless migration, or restore from disk). 2201 * 2202 * In this case create a temporary parser to receive the migration data, 2203 * and schedule the close_bh to report the device as disconnected to the 2204 * guest and to destroy the parser again. 2205 */ 2206 if (dev->parser == NULL) { 2207 WARNING("usb-redir connection broken during migration\n"); 2208 usbredir_create_parser(dev); 2209 qemu_bh_schedule(dev->chardev_close_bh); 2210 } 2211 2212 data = g_malloc(len); 2213 qemu_get_buffer(f, data, len); 2214 2215 ret = usbredirparser_unserialize(dev->parser, data, len); 2216 2217 g_free(data); 2218 2219 return ret; 2220 } 2221 2222 static const VMStateInfo usbredir_parser_vmstate_info = { 2223 .name = "usb-redir-parser", 2224 .put = usbredir_put_parser, 2225 .get = usbredir_get_parser, 2226 }; 2227 2228 2229 /* For buffered packets (iso/irq) queue migration */ 2230 static int usbredir_put_bufpq(QEMUFile *f, void *priv, size_t unused, 2231 const VMStateField *field, QJSON *vmdesc) 2232 { 2233 struct endp_data *endp = priv; 2234 USBRedirDevice *dev = endp->dev; 2235 struct buf_packet *bufp; 2236 int len, i = 0; 2237 2238 qemu_put_be32(f, endp->bufpq_size); 2239 QTAILQ_FOREACH(bufp, &endp->bufpq, next) { 2240 len = bufp->len - bufp->offset; 2241 DPRINTF("put_bufpq %d/%d len %d status %d\n", i + 1, endp->bufpq_size, 2242 len, bufp->status); 2243 qemu_put_be32(f, len); 2244 qemu_put_be32(f, bufp->status); 2245 qemu_put_buffer(f, bufp->data + bufp->offset, len); 2246 i++; 2247 } 2248 assert(i == endp->bufpq_size); 2249 2250 return 0; 2251 } 2252 2253 static int usbredir_get_bufpq(QEMUFile *f, void *priv, size_t unused, 2254 const VMStateField *field) 2255 { 2256 struct endp_data *endp = priv; 2257 USBRedirDevice *dev = endp->dev; 2258 struct buf_packet *bufp; 2259 int i; 2260 2261 endp->bufpq_size = qemu_get_be32(f); 2262 for (i = 0; i < endp->bufpq_size; i++) { 2263 bufp = g_new(struct buf_packet, 1); 2264 bufp->len = qemu_get_be32(f); 2265 bufp->status = qemu_get_be32(f); 2266 bufp->offset = 0; 2267 bufp->data = qemu_oom_check(malloc(bufp->len)); /* regular malloc! */ 2268 bufp->free_on_destroy = bufp->data; 2269 qemu_get_buffer(f, bufp->data, bufp->len); 2270 QTAILQ_INSERT_TAIL(&endp->bufpq, bufp, next); 2271 DPRINTF("get_bufpq %d/%d len %d status %d\n", i + 1, endp->bufpq_size, 2272 bufp->len, bufp->status); 2273 } 2274 return 0; 2275 } 2276 2277 static const VMStateInfo usbredir_ep_bufpq_vmstate_info = { 2278 .name = "usb-redir-bufpq", 2279 .put = usbredir_put_bufpq, 2280 .get = usbredir_get_bufpq, 2281 }; 2282 2283 2284 /* For endp_data migration */ 2285 static bool usbredir_bulk_receiving_needed(void *priv) 2286 { 2287 struct endp_data *endp = priv; 2288 2289 return endp->bulk_receiving_started; 2290 } 2291 2292 static const VMStateDescription usbredir_bulk_receiving_vmstate = { 2293 .name = "usb-redir-ep/bulk-receiving", 2294 .version_id = 1, 2295 .minimum_version_id = 1, 2296 .needed = usbredir_bulk_receiving_needed, 2297 .fields = (VMStateField[]) { 2298 VMSTATE_UINT8(bulk_receiving_started, struct endp_data), 2299 VMSTATE_END_OF_LIST() 2300 } 2301 }; 2302 2303 static bool usbredir_stream_needed(void *priv) 2304 { 2305 struct endp_data *endp = priv; 2306 2307 return endp->max_streams; 2308 } 2309 2310 static const VMStateDescription usbredir_stream_vmstate = { 2311 .name = "usb-redir-ep/stream-state", 2312 .version_id = 1, 2313 .minimum_version_id = 1, 2314 .needed = usbredir_stream_needed, 2315 .fields = (VMStateField[]) { 2316 VMSTATE_UINT32(max_streams, struct endp_data), 2317 VMSTATE_END_OF_LIST() 2318 } 2319 }; 2320 2321 static const VMStateDescription usbredir_ep_vmstate = { 2322 .name = "usb-redir-ep", 2323 .version_id = 1, 2324 .minimum_version_id = 1, 2325 .fields = (VMStateField[]) { 2326 VMSTATE_UINT8(type, struct endp_data), 2327 VMSTATE_UINT8(interval, struct endp_data), 2328 VMSTATE_UINT8(interface, struct endp_data), 2329 VMSTATE_UINT16(max_packet_size, struct endp_data), 2330 VMSTATE_UINT8(iso_started, struct endp_data), 2331 VMSTATE_UINT8(iso_error, struct endp_data), 2332 VMSTATE_UINT8(interrupt_started, struct endp_data), 2333 VMSTATE_UINT8(interrupt_error, struct endp_data), 2334 VMSTATE_UINT8(bufpq_prefilled, struct endp_data), 2335 VMSTATE_UINT8(bufpq_dropping_packets, struct endp_data), 2336 { 2337 .name = "bufpq", 2338 .version_id = 0, 2339 .field_exists = NULL, 2340 .size = 0, 2341 .info = &usbredir_ep_bufpq_vmstate_info, 2342 .flags = VMS_SINGLE, 2343 .offset = 0, 2344 }, 2345 VMSTATE_INT32(bufpq_target_size, struct endp_data), 2346 VMSTATE_END_OF_LIST() 2347 }, 2348 .subsections = (const VMStateDescription*[]) { 2349 &usbredir_bulk_receiving_vmstate, 2350 &usbredir_stream_vmstate, 2351 NULL 2352 } 2353 }; 2354 2355 2356 /* For PacketIdQueue migration */ 2357 static int usbredir_put_packet_id_q(QEMUFile *f, void *priv, size_t unused, 2358 const VMStateField *field, QJSON *vmdesc) 2359 { 2360 struct PacketIdQueue *q = priv; 2361 USBRedirDevice *dev = q->dev; 2362 struct PacketIdQueueEntry *e; 2363 int remain = q->size; 2364 2365 DPRINTF("put_packet_id_q %s size %d\n", q->name, q->size); 2366 qemu_put_be32(f, q->size); 2367 QTAILQ_FOREACH(e, &q->head, next) { 2368 qemu_put_be64(f, e->id); 2369 remain--; 2370 } 2371 assert(remain == 0); 2372 2373 return 0; 2374 } 2375 2376 static int usbredir_get_packet_id_q(QEMUFile *f, void *priv, size_t unused, 2377 const VMStateField *field) 2378 { 2379 struct PacketIdQueue *q = priv; 2380 USBRedirDevice *dev = q->dev; 2381 int i, size; 2382 uint64_t id; 2383 2384 size = qemu_get_be32(f); 2385 DPRINTF("get_packet_id_q %s size %d\n", q->name, size); 2386 for (i = 0; i < size; i++) { 2387 id = qemu_get_be64(f); 2388 packet_id_queue_add(q, id); 2389 } 2390 assert(q->size == size); 2391 return 0; 2392 } 2393 2394 static const VMStateInfo usbredir_ep_packet_id_q_vmstate_info = { 2395 .name = "usb-redir-packet-id-q", 2396 .put = usbredir_put_packet_id_q, 2397 .get = usbredir_get_packet_id_q, 2398 }; 2399 2400 static const VMStateDescription usbredir_ep_packet_id_queue_vmstate = { 2401 .name = "usb-redir-packet-id-queue", 2402 .version_id = 1, 2403 .minimum_version_id = 1, 2404 .fields = (VMStateField[]) { 2405 { 2406 .name = "queue", 2407 .version_id = 0, 2408 .field_exists = NULL, 2409 .size = 0, 2410 .info = &usbredir_ep_packet_id_q_vmstate_info, 2411 .flags = VMS_SINGLE, 2412 .offset = 0, 2413 }, 2414 VMSTATE_END_OF_LIST() 2415 } 2416 }; 2417 2418 2419 /* For usb_redir_device_connect_header migration */ 2420 static const VMStateDescription usbredir_device_info_vmstate = { 2421 .name = "usb-redir-device-info", 2422 .version_id = 1, 2423 .minimum_version_id = 1, 2424 .fields = (VMStateField[]) { 2425 VMSTATE_UINT8(speed, struct usb_redir_device_connect_header), 2426 VMSTATE_UINT8(device_class, struct usb_redir_device_connect_header), 2427 VMSTATE_UINT8(device_subclass, struct usb_redir_device_connect_header), 2428 VMSTATE_UINT8(device_protocol, struct usb_redir_device_connect_header), 2429 VMSTATE_UINT16(vendor_id, struct usb_redir_device_connect_header), 2430 VMSTATE_UINT16(product_id, struct usb_redir_device_connect_header), 2431 VMSTATE_UINT16(device_version_bcd, 2432 struct usb_redir_device_connect_header), 2433 VMSTATE_END_OF_LIST() 2434 } 2435 }; 2436 2437 2438 /* For usb_redir_interface_info_header migration */ 2439 static const VMStateDescription usbredir_interface_info_vmstate = { 2440 .name = "usb-redir-interface-info", 2441 .version_id = 1, 2442 .minimum_version_id = 1, 2443 .fields = (VMStateField[]) { 2444 VMSTATE_UINT32(interface_count, 2445 struct usb_redir_interface_info_header), 2446 VMSTATE_UINT8_ARRAY(interface, 2447 struct usb_redir_interface_info_header, 32), 2448 VMSTATE_UINT8_ARRAY(interface_class, 2449 struct usb_redir_interface_info_header, 32), 2450 VMSTATE_UINT8_ARRAY(interface_subclass, 2451 struct usb_redir_interface_info_header, 32), 2452 VMSTATE_UINT8_ARRAY(interface_protocol, 2453 struct usb_redir_interface_info_header, 32), 2454 VMSTATE_END_OF_LIST() 2455 } 2456 }; 2457 2458 2459 /* And finally the USBRedirDevice vmstate itself */ 2460 static const VMStateDescription usbredir_vmstate = { 2461 .name = "usb-redir", 2462 .version_id = 1, 2463 .minimum_version_id = 1, 2464 .pre_save = usbredir_pre_save, 2465 .post_load = usbredir_post_load, 2466 .fields = (VMStateField[]) { 2467 VMSTATE_USB_DEVICE(dev, USBRedirDevice), 2468 VMSTATE_TIMER_PTR(attach_timer, USBRedirDevice), 2469 { 2470 .name = "parser", 2471 .version_id = 0, 2472 .field_exists = NULL, 2473 .size = 0, 2474 .info = &usbredir_parser_vmstate_info, 2475 .flags = VMS_SINGLE, 2476 .offset = 0, 2477 }, 2478 VMSTATE_STRUCT_ARRAY(endpoint, USBRedirDevice, MAX_ENDPOINTS, 1, 2479 usbredir_ep_vmstate, struct endp_data), 2480 VMSTATE_STRUCT(cancelled, USBRedirDevice, 1, 2481 usbredir_ep_packet_id_queue_vmstate, 2482 struct PacketIdQueue), 2483 VMSTATE_STRUCT(already_in_flight, USBRedirDevice, 1, 2484 usbredir_ep_packet_id_queue_vmstate, 2485 struct PacketIdQueue), 2486 VMSTATE_STRUCT(device_info, USBRedirDevice, 1, 2487 usbredir_device_info_vmstate, 2488 struct usb_redir_device_connect_header), 2489 VMSTATE_STRUCT(interface_info, USBRedirDevice, 1, 2490 usbredir_interface_info_vmstate, 2491 struct usb_redir_interface_info_header), 2492 VMSTATE_END_OF_LIST() 2493 } 2494 }; 2495 2496 static Property usbredir_properties[] = { 2497 DEFINE_PROP_CHR("chardev", USBRedirDevice, cs), 2498 DEFINE_PROP_UINT8("debug", USBRedirDevice, debug, usbredirparser_warning), 2499 DEFINE_PROP_STRING("filter", USBRedirDevice, filter_str), 2500 DEFINE_PROP_BOOL("streams", USBRedirDevice, enable_streams, true), 2501 DEFINE_PROP_END_OF_LIST(), 2502 }; 2503 2504 static void usbredir_class_initfn(ObjectClass *klass, void *data) 2505 { 2506 USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 2507 DeviceClass *dc = DEVICE_CLASS(klass); 2508 2509 uc->realize = usbredir_realize; 2510 uc->product_desc = "USB Redirection Device"; 2511 uc->unrealize = usbredir_unrealize; 2512 uc->cancel_packet = usbredir_cancel_packet; 2513 uc->handle_reset = usbredir_handle_reset; 2514 uc->handle_data = usbredir_handle_data; 2515 uc->handle_control = usbredir_handle_control; 2516 uc->flush_ep_queue = usbredir_flush_ep_queue; 2517 uc->ep_stopped = usbredir_ep_stopped; 2518 uc->alloc_streams = usbredir_alloc_streams; 2519 uc->free_streams = usbredir_free_streams; 2520 dc->vmsd = &usbredir_vmstate; 2521 dc->props = usbredir_properties; 2522 set_bit(DEVICE_CATEGORY_MISC, dc->categories); 2523 } 2524 2525 static void usbredir_instance_init(Object *obj) 2526 { 2527 USBDevice *udev = USB_DEVICE(obj); 2528 USBRedirDevice *dev = USB_REDIRECT(udev); 2529 2530 device_add_bootindex_property(obj, &dev->bootindex, 2531 "bootindex", NULL, 2532 &udev->qdev, NULL); 2533 } 2534 2535 static const TypeInfo usbredir_dev_info = { 2536 .name = TYPE_USB_REDIR, 2537 .parent = TYPE_USB_DEVICE, 2538 .instance_size = sizeof(USBRedirDevice), 2539 .class_init = usbredir_class_initfn, 2540 .instance_init = usbredir_instance_init, 2541 }; 2542 2543 static void usbredir_register_types(void) 2544 { 2545 type_register_static(&usbredir_dev_info); 2546 } 2547 2548 type_init(usbredir_register_types) 2549