2 * USB redirector usb-guest
4 * Copyright (c) 2011-2012 Red Hat, Inc.
7 * Hans de Goede <hdegoede@redhat.com>
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:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
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
28 #include "qemu-common.h"
29 #include "qemu-timer.h"
35 #include <sys/ioctl.h>
37 #include <usbredirparser.h>
38 #include <usbredirfilter.h>
42 #define MAX_ENDPOINTS 32
43 #define NO_INTERFACE_INFO 255 /* Valid interface_count always <= 32 */
44 #define EP2I(ep_address) (((ep_address & 0x80) >> 3) | (ep_address & 0x0f))
45 #define I2EP(i) (((i & 0x10) << 3) | (i & 0x0f))
47 typedef struct USBRedirDevice USBRedirDevice
;
49 /* Struct to hold buffered packets (iso or int input packets) */
54 QTAILQ_ENTRY(buf_packet
)next
;
60 uint8_t interface
; /* bInterfaceNumber this ep belongs to */
61 uint16_t max_packet_size
; /* In bytes, not wMaxPacketSize format !! */
63 uint8_t iso_error
; /* For reporting iso errors to the HC */
64 uint8_t interrupt_started
;
65 uint8_t interrupt_error
;
66 uint8_t bufpq_prefilled
;
67 uint8_t bufpq_dropping_packets
;
68 QTAILQ_HEAD(, buf_packet
) bufpq
;
70 int32_t bufpq_target_size
;
73 struct PacketIdQueueEntry
{
75 QTAILQ_ENTRY(PacketIdQueueEntry
)next
;
78 struct PacketIdQueue
{
81 QTAILQ_HEAD(, PacketIdQueueEntry
) head
;
85 struct USBRedirDevice
{
92 /* Data passed from chardev the fd_read cb to the usbredirparser read cb */
93 const uint8_t *read_buf
;
95 /* For async handling of close */
96 QEMUBH
*chardev_close_bh
;
97 /* To delay the usb attach in case of quick chardev close + open */
98 QEMUTimer
*attach_timer
;
99 int64_t next_attach_time
;
100 struct usbredirparser
*parser
;
101 struct endp_data endpoint
[MAX_ENDPOINTS
];
102 struct PacketIdQueue cancelled
;
103 struct PacketIdQueue already_in_flight
;
104 /* Data for device filtering */
105 struct usb_redir_device_connect_header device_info
;
106 struct usb_redir_interface_info_header interface_info
;
107 struct usbredirfilter_rule
*filter_rules
;
108 int filter_rules_count
;
109 int compatible_speedmask
;
112 static void usbredir_hello(void *priv
, struct usb_redir_hello_header
*h
);
113 static void usbredir_device_connect(void *priv
,
114 struct usb_redir_device_connect_header
*device_connect
);
115 static void usbredir_device_disconnect(void *priv
);
116 static void usbredir_interface_info(void *priv
,
117 struct usb_redir_interface_info_header
*interface_info
);
118 static void usbredir_ep_info(void *priv
,
119 struct usb_redir_ep_info_header
*ep_info
);
120 static void usbredir_configuration_status(void *priv
, uint64_t id
,
121 struct usb_redir_configuration_status_header
*configuration_status
);
122 static void usbredir_alt_setting_status(void *priv
, uint64_t id
,
123 struct usb_redir_alt_setting_status_header
*alt_setting_status
);
124 static void usbredir_iso_stream_status(void *priv
, uint64_t id
,
125 struct usb_redir_iso_stream_status_header
*iso_stream_status
);
126 static void usbredir_interrupt_receiving_status(void *priv
, uint64_t id
,
127 struct usb_redir_interrupt_receiving_status_header
128 *interrupt_receiving_status
);
129 static void usbredir_bulk_streams_status(void *priv
, uint64_t id
,
130 struct usb_redir_bulk_streams_status_header
*bulk_streams_status
);
131 static void usbredir_control_packet(void *priv
, uint64_t id
,
132 struct usb_redir_control_packet_header
*control_packet
,
133 uint8_t *data
, int data_len
);
134 static void usbredir_bulk_packet(void *priv
, uint64_t id
,
135 struct usb_redir_bulk_packet_header
*bulk_packet
,
136 uint8_t *data
, int data_len
);
137 static void usbredir_iso_packet(void *priv
, uint64_t id
,
138 struct usb_redir_iso_packet_header
*iso_packet
,
139 uint8_t *data
, int data_len
);
140 static void usbredir_interrupt_packet(void *priv
, uint64_t id
,
141 struct usb_redir_interrupt_packet_header
*interrupt_header
,
142 uint8_t *data
, int data_len
);
144 static void usbredir_handle_status(USBRedirDevice
*dev
, USBPacket
*p
,
147 #define VERSION "qemu usb-redir guest " QEMU_VERSION
155 if (dev->debug >= usbredirparser_error) { \
156 error_report("usb-redir error: " __VA_ARGS__); \
159 #define WARNING(...) \
161 if (dev->debug >= usbredirparser_warning) { \
162 error_report("usb-redir warning: " __VA_ARGS__); \
167 if (dev->debug >= usbredirparser_info) { \
168 error_report("usb-redir: " __VA_ARGS__); \
171 #define DPRINTF(...) \
173 if (dev->debug >= usbredirparser_debug) { \
174 error_report("usb-redir: " __VA_ARGS__); \
177 #define DPRINTF2(...) \
179 if (dev->debug >= usbredirparser_debug_data) { \
180 error_report("usb-redir: " __VA_ARGS__); \
184 static void usbredir_log(void *priv
, int level
, const char *msg
)
186 USBRedirDevice
*dev
= priv
;
188 if (dev
->debug
< level
) {
192 error_report("%s", msg
);
195 static void usbredir_log_data(USBRedirDevice
*dev
, const char *desc
,
196 const uint8_t *data
, int len
)
200 if (dev
->debug
< usbredirparser_debug_data
) {
204 for (i
= 0; i
< len
; i
+= j
) {
207 n
= sprintf(buf
, "%s", desc
);
208 for (j
= 0; j
< 8 && i
+ j
< len
; j
++) {
209 n
+= sprintf(buf
+ n
, " %02X", data
[i
+ j
]);
211 error_report("%s", buf
);
216 * usbredirparser io functions
219 static int usbredir_read(void *priv
, uint8_t *data
, int count
)
221 USBRedirDevice
*dev
= priv
;
223 if (dev
->read_buf_size
< count
) {
224 count
= dev
->read_buf_size
;
227 memcpy(data
, dev
->read_buf
, count
);
229 dev
->read_buf_size
-= count
;
230 if (dev
->read_buf_size
) {
231 dev
->read_buf
+= count
;
233 dev
->read_buf
= NULL
;
239 static int usbredir_write(void *priv
, uint8_t *data
, int count
)
241 USBRedirDevice
*dev
= priv
;
243 if (!dev
->cs
->opened
) {
247 /* Don't send new data to the chardev until our state is fully synced */
248 if (!runstate_check(RUN_STATE_RUNNING
)) {
252 return qemu_chr_fe_write(dev
->cs
, data
, count
);
256 * Cancelled and buffered packets helpers
259 static void packet_id_queue_init(struct PacketIdQueue
*q
,
260 USBRedirDevice
*dev
, const char *name
)
264 QTAILQ_INIT(&q
->head
);
268 static void packet_id_queue_add(struct PacketIdQueue
*q
, uint64_t id
)
270 USBRedirDevice
*dev
= q
->dev
;
271 struct PacketIdQueueEntry
*e
;
273 DPRINTF("adding packet id %"PRIu64
" to %s queue\n", id
, q
->name
);
275 e
= g_malloc0(sizeof(struct PacketIdQueueEntry
));
277 QTAILQ_INSERT_TAIL(&q
->head
, e
, next
);
281 static int packet_id_queue_remove(struct PacketIdQueue
*q
, uint64_t id
)
283 USBRedirDevice
*dev
= q
->dev
;
284 struct PacketIdQueueEntry
*e
;
286 QTAILQ_FOREACH(e
, &q
->head
, next
) {
288 DPRINTF("removing packet id %"PRIu64
" from %s queue\n",
290 QTAILQ_REMOVE(&q
->head
, e
, next
);
299 static void packet_id_queue_empty(struct PacketIdQueue
*q
)
301 USBRedirDevice
*dev
= q
->dev
;
302 struct PacketIdQueueEntry
*e
, *next_e
;
304 DPRINTF("removing %d packet-ids from %s queue\n", q
->size
, q
->name
);
306 QTAILQ_FOREACH_SAFE(e
, &q
->head
, next
, next_e
) {
307 QTAILQ_REMOVE(&q
->head
, e
, next
);
313 static void usbredir_cancel_packet(USBDevice
*udev
, USBPacket
*p
)
315 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
318 usb_combined_packet_cancel(udev
, p
);
322 packet_id_queue_add(&dev
->cancelled
, p
->id
);
323 usbredirparser_send_cancel_data_packet(dev
->parser
, p
->id
);
324 usbredirparser_do_write(dev
->parser
);
327 static int usbredir_is_cancelled(USBRedirDevice
*dev
, uint64_t id
)
329 if (!dev
->dev
.attached
) {
330 return 1; /* Treat everything as cancelled after a disconnect */
332 return packet_id_queue_remove(&dev
->cancelled
, id
);
335 static void usbredir_fill_already_in_flight_from_ep(USBRedirDevice
*dev
,
336 struct USBEndpoint
*ep
)
340 QTAILQ_FOREACH(p
, &ep
->queue
, queue
) {
341 /* Skip combined packets, except for the first */
342 if (p
->combined
&& p
!= p
->combined
->first
) {
345 packet_id_queue_add(&dev
->already_in_flight
, p
->id
);
349 static void usbredir_fill_already_in_flight(USBRedirDevice
*dev
)
352 struct USBDevice
*udev
= &dev
->dev
;
354 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_ctl
);
356 for (ep
= 0; ep
< USB_MAX_ENDPOINTS
; ep
++) {
357 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_in
[ep
]);
358 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_out
[ep
]);
362 static int usbredir_already_in_flight(USBRedirDevice
*dev
, uint64_t id
)
364 return packet_id_queue_remove(&dev
->already_in_flight
, id
);
367 static USBPacket
*usbredir_find_packet_by_id(USBRedirDevice
*dev
,
368 uint8_t ep
, uint64_t id
)
372 if (usbredir_is_cancelled(dev
, id
)) {
376 p
= usb_ep_find_packet_by_id(&dev
->dev
,
377 (ep
& USB_DIR_IN
) ? USB_TOKEN_IN
: USB_TOKEN_OUT
,
380 ERROR("could not find packet with id %"PRIu64
"\n", id
);
385 static void bufp_alloc(USBRedirDevice
*dev
,
386 uint8_t *data
, int len
, int status
, uint8_t ep
)
388 struct buf_packet
*bufp
;
390 if (!dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
&&
391 dev
->endpoint
[EP2I(ep
)].bufpq_size
>
392 2 * dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
393 DPRINTF("bufpq overflow, dropping packets ep %02X\n", ep
);
394 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 1;
396 /* Since we're interupting the stream anyways, drop enough packets to get
397 back to our target buffer size */
398 if (dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
) {
399 if (dev
->endpoint
[EP2I(ep
)].bufpq_size
>
400 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
404 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
407 bufp
= g_malloc(sizeof(struct buf_packet
));
410 bufp
->status
= status
;
411 QTAILQ_INSERT_TAIL(&dev
->endpoint
[EP2I(ep
)].bufpq
, bufp
, next
);
412 dev
->endpoint
[EP2I(ep
)].bufpq_size
++;
415 static void bufp_free(USBRedirDevice
*dev
, struct buf_packet
*bufp
,
418 QTAILQ_REMOVE(&dev
->endpoint
[EP2I(ep
)].bufpq
, bufp
, next
);
419 dev
->endpoint
[EP2I(ep
)].bufpq_size
--;
424 static void usbredir_free_bufpq(USBRedirDevice
*dev
, uint8_t ep
)
426 struct buf_packet
*buf
, *buf_next
;
428 QTAILQ_FOREACH_SAFE(buf
, &dev
->endpoint
[EP2I(ep
)].bufpq
, next
, buf_next
) {
429 bufp_free(dev
, buf
, ep
);
434 * USBDevice callbacks
437 static void usbredir_handle_reset(USBDevice
*udev
)
439 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
441 DPRINTF("reset device\n");
442 usbredirparser_send_reset(dev
->parser
);
443 usbredirparser_do_write(dev
->parser
);
446 static void usbredir_handle_iso_data(USBRedirDevice
*dev
, USBPacket
*p
,
450 if (!dev
->endpoint
[EP2I(ep
)].iso_started
&&
451 !dev
->endpoint
[EP2I(ep
)].iso_error
) {
452 struct usb_redir_start_iso_stream_header start_iso
= {
457 if (dev
->dev
.speed
== USB_SPEED_HIGH
) {
458 pkts_per_sec
= 8000 / dev
->endpoint
[EP2I(ep
)].interval
;
460 pkts_per_sec
= 1000 / dev
->endpoint
[EP2I(ep
)].interval
;
462 /* Testing has shown that we need circa 60 ms buffer */
463 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= (pkts_per_sec
* 60) / 1000;
465 /* Aim for approx 100 interrupts / second on the client to
466 balance latency and interrupt load */
467 start_iso
.pkts_per_urb
= pkts_per_sec
/ 100;
468 if (start_iso
.pkts_per_urb
< 1) {
469 start_iso
.pkts_per_urb
= 1;
470 } else if (start_iso
.pkts_per_urb
> 32) {
471 start_iso
.pkts_per_urb
= 32;
474 start_iso
.no_urbs
= (dev
->endpoint
[EP2I(ep
)].bufpq_target_size
+
475 start_iso
.pkts_per_urb
- 1) /
476 start_iso
.pkts_per_urb
;
477 /* Output endpoints pre-fill only 1/2 of the packets, keeping the rest
478 as overflow buffer. Also see the usbredir protocol documentation */
479 if (!(ep
& USB_DIR_IN
)) {
480 start_iso
.no_urbs
*= 2;
482 if (start_iso
.no_urbs
> 16) {
483 start_iso
.no_urbs
= 16;
486 /* No id, we look at the ep when receiving a status back */
487 usbredirparser_send_start_iso_stream(dev
->parser
, 0, &start_iso
);
488 usbredirparser_do_write(dev
->parser
);
489 DPRINTF("iso stream started pkts/sec %d pkts/urb %d urbs %d ep %02X\n",
490 pkts_per_sec
, start_iso
.pkts_per_urb
, start_iso
.no_urbs
, ep
);
491 dev
->endpoint
[EP2I(ep
)].iso_started
= 1;
492 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 0;
493 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
496 if (ep
& USB_DIR_IN
) {
497 struct buf_packet
*isop
;
499 if (dev
->endpoint
[EP2I(ep
)].iso_started
&&
500 !dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
) {
501 if (dev
->endpoint
[EP2I(ep
)].bufpq_size
<
502 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
505 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 1;
508 isop
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
);
510 DPRINTF("iso-token-in ep %02X, no isop, iso_error: %d\n",
511 ep
, dev
->endpoint
[EP2I(ep
)].iso_error
);
512 /* Re-fill the buffer */
513 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 0;
514 /* Check iso_error for stream errors, otherwise its an underrun */
515 status
= dev
->endpoint
[EP2I(ep
)].iso_error
;
516 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
517 p
->status
= status
? USB_RET_IOERROR
: USB_RET_SUCCESS
;
520 DPRINTF2("iso-token-in ep %02X status %d len %d queue-size: %d\n", ep
,
521 isop
->status
, isop
->len
, dev
->endpoint
[EP2I(ep
)].bufpq_size
);
523 status
= isop
->status
;
525 if (len
> p
->iov
.size
) {
526 ERROR("received iso data is larger then packet ep %02X (%d > %d)\n",
527 ep
, len
, (int)p
->iov
.size
);
529 status
= usb_redir_babble
;
531 usb_packet_copy(p
, isop
->data
, len
);
532 bufp_free(dev
, isop
, ep
);
533 usbredir_handle_status(dev
, p
, status
);
535 /* If the stream was not started because of a pending error don't
536 send the packet to the usb-host */
537 if (dev
->endpoint
[EP2I(ep
)].iso_started
) {
538 struct usb_redir_iso_packet_header iso_packet
= {
540 .length
= p
->iov
.size
542 uint8_t buf
[p
->iov
.size
];
543 /* No id, we look at the ep when receiving a status back */
544 usb_packet_copy(p
, buf
, p
->iov
.size
);
545 usbredirparser_send_iso_packet(dev
->parser
, 0, &iso_packet
,
547 usbredirparser_do_write(dev
->parser
);
549 status
= dev
->endpoint
[EP2I(ep
)].iso_error
;
550 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
551 DPRINTF2("iso-token-out ep %02X status %d len %zd\n", ep
, status
,
553 usbredir_handle_status(dev
, p
, status
);
557 static void usbredir_stop_iso_stream(USBRedirDevice
*dev
, uint8_t ep
)
559 struct usb_redir_stop_iso_stream_header stop_iso_stream
= {
562 if (dev
->endpoint
[EP2I(ep
)].iso_started
) {
563 usbredirparser_send_stop_iso_stream(dev
->parser
, 0, &stop_iso_stream
);
564 DPRINTF("iso stream stopped ep %02X\n", ep
);
565 dev
->endpoint
[EP2I(ep
)].iso_started
= 0;
567 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
568 usbredir_free_bufpq(dev
, ep
);
571 static void usbredir_handle_bulk_data(USBRedirDevice
*dev
, USBPacket
*p
,
574 struct usb_redir_bulk_packet_header bulk_packet
;
575 size_t size
= (p
->combined
) ? p
->combined
->iov
.size
: p
->iov
.size
;
577 DPRINTF("bulk-out ep %02X len %zd id %"PRIu64
"\n", ep
, size
, p
->id
);
579 if (usbredir_already_in_flight(dev
, p
->id
)) {
580 p
->status
= USB_RET_ASYNC
;
584 bulk_packet
.endpoint
= ep
;
585 bulk_packet
.length
= size
;
586 bulk_packet
.stream_id
= 0;
587 bulk_packet
.length_high
= size
>> 16;
588 assert(bulk_packet
.length_high
== 0 ||
589 usbredirparser_peer_has_cap(dev
->parser
,
590 usb_redir_cap_32bits_bulk_length
));
592 if (ep
& USB_DIR_IN
) {
593 usbredirparser_send_bulk_packet(dev
->parser
, p
->id
,
594 &bulk_packet
, NULL
, 0);
598 iov_to_buf(p
->combined
->iov
.iov
, p
->combined
->iov
.niov
,
601 usb_packet_copy(p
, buf
, size
);
603 usbredir_log_data(dev
, "bulk data out:", buf
, size
);
604 usbredirparser_send_bulk_packet(dev
->parser
, p
->id
,
605 &bulk_packet
, buf
, size
);
607 usbredirparser_do_write(dev
->parser
);
608 p
->status
= USB_RET_ASYNC
;
611 static void usbredir_handle_interrupt_data(USBRedirDevice
*dev
,
612 USBPacket
*p
, uint8_t ep
)
614 if (ep
& USB_DIR_IN
) {
615 /* Input interrupt endpoint, buffered packet input */
616 struct buf_packet
*intp
;
619 if (!dev
->endpoint
[EP2I(ep
)].interrupt_started
&&
620 !dev
->endpoint
[EP2I(ep
)].interrupt_error
) {
621 struct usb_redir_start_interrupt_receiving_header start_int
= {
624 /* No id, we look at the ep when receiving a status back */
625 usbredirparser_send_start_interrupt_receiving(dev
->parser
, 0,
627 usbredirparser_do_write(dev
->parser
);
628 DPRINTF("interrupt recv started ep %02X\n", ep
);
629 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 1;
630 /* We don't really want to drop interrupt packets ever, but
631 having some upper limit to how much we buffer is good. */
632 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= 1000;
633 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
636 intp
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
);
638 DPRINTF2("interrupt-token-in ep %02X, no intp\n", ep
);
639 /* Check interrupt_error for stream errors */
640 status
= dev
->endpoint
[EP2I(ep
)].interrupt_error
;
641 dev
->endpoint
[EP2I(ep
)].interrupt_error
= 0;
643 usbredir_handle_status(dev
, p
, status
);
645 p
->status
= USB_RET_NAK
;
649 DPRINTF("interrupt-token-in ep %02X status %d len %d\n", ep
,
650 intp
->status
, intp
->len
);
652 status
= intp
->status
;
654 if (len
> p
->iov
.size
) {
655 ERROR("received int data is larger then packet ep %02X\n", ep
);
657 status
= usb_redir_babble
;
659 usb_packet_copy(p
, intp
->data
, len
);
660 bufp_free(dev
, intp
, ep
);
661 usbredir_handle_status(dev
, p
, status
);
663 /* Output interrupt endpoint, normal async operation */
664 struct usb_redir_interrupt_packet_header interrupt_packet
;
665 uint8_t buf
[p
->iov
.size
];
667 DPRINTF("interrupt-out ep %02X len %zd id %"PRIu64
"\n", ep
,
670 if (usbredir_already_in_flight(dev
, p
->id
)) {
671 p
->status
= USB_RET_ASYNC
;
675 interrupt_packet
.endpoint
= ep
;
676 interrupt_packet
.length
= p
->iov
.size
;
678 usb_packet_copy(p
, buf
, p
->iov
.size
);
679 usbredir_log_data(dev
, "interrupt data out:", buf
, p
->iov
.size
);
680 usbredirparser_send_interrupt_packet(dev
->parser
, p
->id
,
681 &interrupt_packet
, buf
, p
->iov
.size
);
682 usbredirparser_do_write(dev
->parser
);
683 p
->status
= USB_RET_ASYNC
;
687 static void usbredir_stop_interrupt_receiving(USBRedirDevice
*dev
,
690 struct usb_redir_stop_interrupt_receiving_header stop_interrupt_recv
= {
693 if (dev
->endpoint
[EP2I(ep
)].interrupt_started
) {
694 usbredirparser_send_stop_interrupt_receiving(dev
->parser
, 0,
695 &stop_interrupt_recv
);
696 DPRINTF("interrupt recv stopped ep %02X\n", ep
);
697 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 0;
699 dev
->endpoint
[EP2I(ep
)].interrupt_error
= 0;
700 usbredir_free_bufpq(dev
, ep
);
703 static void usbredir_handle_data(USBDevice
*udev
, USBPacket
*p
)
705 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
709 if (p
->pid
== USB_TOKEN_IN
) {
713 switch (dev
->endpoint
[EP2I(ep
)].type
) {
714 case USB_ENDPOINT_XFER_CONTROL
:
715 ERROR("handle_data called for control transfer on ep %02X\n", ep
);
716 p
->status
= USB_RET_NAK
;
718 case USB_ENDPOINT_XFER_ISOC
:
719 usbredir_handle_iso_data(dev
, p
, ep
);
721 case USB_ENDPOINT_XFER_BULK
:
722 if (p
->state
== USB_PACKET_SETUP
&& p
->pid
== USB_TOKEN_IN
&&
724 p
->status
= USB_RET_ADD_TO_QUEUE
;
727 usbredir_handle_bulk_data(dev
, p
, ep
);
729 case USB_ENDPOINT_XFER_INT
:
730 usbredir_handle_interrupt_data(dev
, p
, ep
);
733 ERROR("handle_data ep %02X has unknown type %d\n", ep
,
734 dev
->endpoint
[EP2I(ep
)].type
);
735 p
->status
= USB_RET_NAK
;
739 static void usbredir_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
)
741 if (ep
->pid
== USB_TOKEN_IN
&& ep
->pipeline
) {
742 usb_ep_combine_input_packets(ep
);
746 static void usbredir_set_config(USBRedirDevice
*dev
, USBPacket
*p
,
749 struct usb_redir_set_configuration_header set_config
;
752 DPRINTF("set config %d id %"PRIu64
"\n", config
, p
->id
);
754 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
755 switch (dev
->endpoint
[i
].type
) {
756 case USB_ENDPOINT_XFER_ISOC
:
757 usbredir_stop_iso_stream(dev
, I2EP(i
));
759 case USB_ENDPOINT_XFER_INT
:
761 usbredir_stop_interrupt_receiving(dev
, I2EP(i
));
765 usbredir_free_bufpq(dev
, I2EP(i
));
768 set_config
.configuration
= config
;
769 usbredirparser_send_set_configuration(dev
->parser
, p
->id
, &set_config
);
770 usbredirparser_do_write(dev
->parser
);
771 p
->status
= USB_RET_ASYNC
;
774 static void usbredir_get_config(USBRedirDevice
*dev
, USBPacket
*p
)
776 DPRINTF("get config id %"PRIu64
"\n", p
->id
);
778 usbredirparser_send_get_configuration(dev
->parser
, p
->id
);
779 usbredirparser_do_write(dev
->parser
);
780 p
->status
= USB_RET_ASYNC
;
783 static void usbredir_set_interface(USBRedirDevice
*dev
, USBPacket
*p
,
784 int interface
, int alt
)
786 struct usb_redir_set_alt_setting_header set_alt
;
789 DPRINTF("set interface %d alt %d id %"PRIu64
"\n", interface
, alt
, p
->id
);
791 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
792 if (dev
->endpoint
[i
].interface
== interface
) {
793 switch (dev
->endpoint
[i
].type
) {
794 case USB_ENDPOINT_XFER_ISOC
:
795 usbredir_stop_iso_stream(dev
, I2EP(i
));
797 case USB_ENDPOINT_XFER_INT
:
799 usbredir_stop_interrupt_receiving(dev
, I2EP(i
));
803 usbredir_free_bufpq(dev
, I2EP(i
));
807 set_alt
.interface
= interface
;
809 usbredirparser_send_set_alt_setting(dev
->parser
, p
->id
, &set_alt
);
810 usbredirparser_do_write(dev
->parser
);
811 p
->status
= USB_RET_ASYNC
;
814 static void usbredir_get_interface(USBRedirDevice
*dev
, USBPacket
*p
,
817 struct usb_redir_get_alt_setting_header get_alt
;
819 DPRINTF("get interface %d id %"PRIu64
"\n", interface
, p
->id
);
821 get_alt
.interface
= interface
;
822 usbredirparser_send_get_alt_setting(dev
->parser
, p
->id
, &get_alt
);
823 usbredirparser_do_write(dev
->parser
);
824 p
->status
= USB_RET_ASYNC
;
827 static void usbredir_handle_control(USBDevice
*udev
, USBPacket
*p
,
828 int request
, int value
, int index
, int length
, uint8_t *data
)
830 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
831 struct usb_redir_control_packet_header control_packet
;
833 if (usbredir_already_in_flight(dev
, p
->id
)) {
834 p
->status
= USB_RET_ASYNC
;
838 /* Special cases for certain standard device requests */
840 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
841 DPRINTF("set address %d\n", value
);
842 dev
->dev
.addr
= value
;
844 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
845 usbredir_set_config(dev
, p
, value
& 0xff);
847 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
848 usbredir_get_config(dev
, p
);
850 case InterfaceOutRequest
| USB_REQ_SET_INTERFACE
:
851 usbredir_set_interface(dev
, p
, index
, value
);
853 case InterfaceRequest
| USB_REQ_GET_INTERFACE
:
854 usbredir_get_interface(dev
, p
, index
);
858 /* Normal ctrl requests, note request is (bRequestType << 8) | bRequest */
860 "ctrl-out type 0x%x req 0x%x val 0x%x index %d len %d id %"PRIu64
"\n",
861 request
>> 8, request
& 0xff, value
, index
, length
, p
->id
);
863 control_packet
.request
= request
& 0xFF;
864 control_packet
.requesttype
= request
>> 8;
865 control_packet
.endpoint
= control_packet
.requesttype
& USB_DIR_IN
;
866 control_packet
.value
= value
;
867 control_packet
.index
= index
;
868 control_packet
.length
= length
;
870 if (control_packet
.requesttype
& USB_DIR_IN
) {
871 usbredirparser_send_control_packet(dev
->parser
, p
->id
,
872 &control_packet
, NULL
, 0);
874 usbredir_log_data(dev
, "ctrl data out:", data
, length
);
875 usbredirparser_send_control_packet(dev
->parser
, p
->id
,
876 &control_packet
, data
, length
);
878 usbredirparser_do_write(dev
->parser
);
879 p
->status
= USB_RET_ASYNC
;
883 * Close events can be triggered by usbredirparser_do_write which gets called
884 * from within the USBDevice data / control packet callbacks and doing a
885 * usb_detach from within these callbacks is not a good idea.
887 * So we use a bh handler to take care of close events.
889 static void usbredir_chardev_close_bh(void *opaque
)
891 USBRedirDevice
*dev
= opaque
;
893 usbredir_device_disconnect(dev
);
896 DPRINTF("destroying usbredirparser\n");
897 usbredirparser_destroy(dev
->parser
);
902 static void usbredir_create_parser(USBRedirDevice
*dev
)
904 uint32_t caps
[USB_REDIR_CAPS_SIZE
] = { 0, };
907 DPRINTF("creating usbredirparser\n");
909 dev
->parser
= qemu_oom_check(usbredirparser_create());
910 dev
->parser
->priv
= dev
;
911 dev
->parser
->log_func
= usbredir_log
;
912 dev
->parser
->read_func
= usbredir_read
;
913 dev
->parser
->write_func
= usbredir_write
;
914 dev
->parser
->hello_func
= usbredir_hello
;
915 dev
->parser
->device_connect_func
= usbredir_device_connect
;
916 dev
->parser
->device_disconnect_func
= usbredir_device_disconnect
;
917 dev
->parser
->interface_info_func
= usbredir_interface_info
;
918 dev
->parser
->ep_info_func
= usbredir_ep_info
;
919 dev
->parser
->configuration_status_func
= usbredir_configuration_status
;
920 dev
->parser
->alt_setting_status_func
= usbredir_alt_setting_status
;
921 dev
->parser
->iso_stream_status_func
= usbredir_iso_stream_status
;
922 dev
->parser
->interrupt_receiving_status_func
=
923 usbredir_interrupt_receiving_status
;
924 dev
->parser
->bulk_streams_status_func
= usbredir_bulk_streams_status
;
925 dev
->parser
->control_packet_func
= usbredir_control_packet
;
926 dev
->parser
->bulk_packet_func
= usbredir_bulk_packet
;
927 dev
->parser
->iso_packet_func
= usbredir_iso_packet
;
928 dev
->parser
->interrupt_packet_func
= usbredir_interrupt_packet
;
929 dev
->read_buf
= NULL
;
930 dev
->read_buf_size
= 0;
932 usbredirparser_caps_set_cap(caps
, usb_redir_cap_connect_device_version
);
933 usbredirparser_caps_set_cap(caps
, usb_redir_cap_filter
);
934 usbredirparser_caps_set_cap(caps
, usb_redir_cap_ep_info_max_packet_size
);
935 usbredirparser_caps_set_cap(caps
, usb_redir_cap_64bits_ids
);
936 usbredirparser_caps_set_cap(caps
, usb_redir_cap_32bits_bulk_length
);
938 if (runstate_check(RUN_STATE_INMIGRATE
)) {
939 flags
|= usbredirparser_fl_no_hello
;
941 usbredirparser_init(dev
->parser
, VERSION
, caps
, USB_REDIR_CAPS_SIZE
,
943 usbredirparser_do_write(dev
->parser
);
946 static void usbredir_reject_device(USBRedirDevice
*dev
)
948 usbredir_device_disconnect(dev
);
949 if (usbredirparser_peer_has_cap(dev
->parser
, usb_redir_cap_filter
)) {
950 usbredirparser_send_filter_reject(dev
->parser
);
951 usbredirparser_do_write(dev
->parser
);
955 static void usbredir_do_attach(void *opaque
)
957 USBRedirDevice
*dev
= opaque
;
959 /* In order to work properly with XHCI controllers we need these caps */
960 if ((dev
->dev
.port
->speedmask
& USB_SPEED_MASK_SUPER
) && !(
961 usbredirparser_peer_has_cap(dev
->parser
,
962 usb_redir_cap_ep_info_max_packet_size
) &&
963 usbredirparser_peer_has_cap(dev
->parser
,
964 usb_redir_cap_64bits_ids
))) {
965 ERROR("usb-redir-host lacks capabilities needed for use with XHCI\n");
966 usbredir_reject_device(dev
);
970 if (usb_device_attach(&dev
->dev
) != 0) {
971 WARNING("rejecting device due to speed mismatch\n");
972 usbredir_reject_device(dev
);
980 static int usbredir_chardev_can_read(void *opaque
)
982 USBRedirDevice
*dev
= opaque
;
985 WARNING("chardev_can_read called on non open chardev!\n");
989 /* Don't read new data from the chardev until our state is fully synced */
990 if (!runstate_check(RUN_STATE_RUNNING
)) {
994 /* usbredir_parser_do_read will consume *all* data we give it */
998 static void usbredir_chardev_read(void *opaque
, const uint8_t *buf
, int size
)
1000 USBRedirDevice
*dev
= opaque
;
1002 /* No recursion allowed! */
1003 assert(dev
->read_buf
== NULL
);
1005 dev
->read_buf
= buf
;
1006 dev
->read_buf_size
= size
;
1008 usbredirparser_do_read(dev
->parser
);
1009 /* Send any acks, etc. which may be queued now */
1010 usbredirparser_do_write(dev
->parser
);
1013 static void usbredir_chardev_event(void *opaque
, int event
)
1015 USBRedirDevice
*dev
= opaque
;
1018 case CHR_EVENT_OPENED
:
1019 DPRINTF("chardev open\n");
1020 /* Make sure any pending closes are handled (no-op if none pending) */
1021 usbredir_chardev_close_bh(dev
);
1022 qemu_bh_cancel(dev
->chardev_close_bh
);
1023 usbredir_create_parser(dev
);
1025 case CHR_EVENT_CLOSED
:
1026 DPRINTF("chardev close\n");
1027 qemu_bh_schedule(dev
->chardev_close_bh
);
1036 static void usbredir_vm_state_change(void *priv
, int running
, RunState state
)
1038 USBRedirDevice
*dev
= priv
;
1040 if (state
== RUN_STATE_RUNNING
&& dev
->parser
!= NULL
) {
1041 usbredirparser_do_write(dev
->parser
); /* Flush any pending writes */
1045 static int usbredir_initfn(USBDevice
*udev
)
1047 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
1050 if (dev
->cs
== NULL
) {
1051 qerror_report(QERR_MISSING_PARAMETER
, "chardev");
1055 if (dev
->filter_str
) {
1056 i
= usbredirfilter_string_to_rules(dev
->filter_str
, ":", "|",
1058 &dev
->filter_rules_count
);
1060 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "filter",
1061 "a usb device filter string");
1066 dev
->chardev_close_bh
= qemu_bh_new(usbredir_chardev_close_bh
, dev
);
1067 dev
->attach_timer
= qemu_new_timer_ms(vm_clock
, usbredir_do_attach
, dev
);
1069 packet_id_queue_init(&dev
->cancelled
, dev
, "cancelled");
1070 packet_id_queue_init(&dev
->already_in_flight
, dev
, "already-in-flight");
1071 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1072 QTAILQ_INIT(&dev
->endpoint
[i
].bufpq
);
1075 /* We'll do the attach once we receive the speed from the usb-host */
1076 udev
->auto_attach
= 0;
1078 /* Will be cleared during setup when we find conflicts */
1079 dev
->compatible_speedmask
= USB_SPEED_MASK_FULL
| USB_SPEED_MASK_HIGH
;
1081 /* Let the backend know we are ready */
1082 qemu_chr_fe_open(dev
->cs
);
1083 qemu_chr_add_handlers(dev
->cs
, usbredir_chardev_can_read
,
1084 usbredir_chardev_read
, usbredir_chardev_event
, dev
);
1086 qemu_add_vm_change_state_handler(usbredir_vm_state_change
, dev
);
1087 add_boot_device_path(dev
->bootindex
, &udev
->qdev
, NULL
);
1091 static void usbredir_cleanup_device_queues(USBRedirDevice
*dev
)
1095 packet_id_queue_empty(&dev
->cancelled
);
1096 packet_id_queue_empty(&dev
->already_in_flight
);
1097 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1098 usbredir_free_bufpq(dev
, I2EP(i
));
1102 static void usbredir_handle_destroy(USBDevice
*udev
)
1104 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
1106 qemu_chr_fe_close(dev
->cs
);
1107 qemu_chr_delete(dev
->cs
);
1108 /* Note must be done after qemu_chr_close, as that causes a close event */
1109 qemu_bh_delete(dev
->chardev_close_bh
);
1111 qemu_del_timer(dev
->attach_timer
);
1112 qemu_free_timer(dev
->attach_timer
);
1114 usbredir_cleanup_device_queues(dev
);
1117 usbredirparser_destroy(dev
->parser
);
1120 free(dev
->filter_rules
);
1123 static int usbredir_check_filter(USBRedirDevice
*dev
)
1125 if (dev
->interface_info
.interface_count
== NO_INTERFACE_INFO
) {
1126 ERROR("No interface info for device\n");
1130 if (dev
->filter_rules
) {
1131 if (!usbredirparser_peer_has_cap(dev
->parser
,
1132 usb_redir_cap_connect_device_version
)) {
1133 ERROR("Device filter specified and peer does not have the "
1134 "connect_device_version capability\n");
1138 if (usbredirfilter_check(
1140 dev
->filter_rules_count
,
1141 dev
->device_info
.device_class
,
1142 dev
->device_info
.device_subclass
,
1143 dev
->device_info
.device_protocol
,
1144 dev
->interface_info
.interface_class
,
1145 dev
->interface_info
.interface_subclass
,
1146 dev
->interface_info
.interface_protocol
,
1147 dev
->interface_info
.interface_count
,
1148 dev
->device_info
.vendor_id
,
1149 dev
->device_info
.product_id
,
1150 dev
->device_info
.device_version_bcd
,
1159 usbredir_reject_device(dev
);
1164 * usbredirparser packet complete callbacks
1167 static void usbredir_handle_status(USBRedirDevice
*dev
, USBPacket
*p
,
1171 case usb_redir_success
:
1172 p
->status
= USB_RET_SUCCESS
; /* Clear previous ASYNC status */
1174 case usb_redir_stall
:
1175 p
->status
= USB_RET_STALL
;
1177 case usb_redir_cancelled
:
1179 * When the usbredir-host unredirects a device, it will report a status
1180 * of cancelled for all pending packets, followed by a disconnect msg.
1182 p
->status
= USB_RET_IOERROR
;
1184 case usb_redir_inval
:
1185 WARNING("got invalid param error from usb-host?\n");
1186 p
->status
= USB_RET_IOERROR
;
1188 case usb_redir_babble
:
1189 p
->status
= USB_RET_BABBLE
;
1191 case usb_redir_ioerror
:
1192 case usb_redir_timeout
:
1194 p
->status
= USB_RET_IOERROR
;
1198 static void usbredir_hello(void *priv
, struct usb_redir_hello_header
*h
)
1200 USBRedirDevice
*dev
= priv
;
1202 /* Try to send the filter info now that we've the usb-host's caps */
1203 if (usbredirparser_peer_has_cap(dev
->parser
, usb_redir_cap_filter
) &&
1204 dev
->filter_rules
) {
1205 usbredirparser_send_filter_filter(dev
->parser
, dev
->filter_rules
,
1206 dev
->filter_rules_count
);
1207 usbredirparser_do_write(dev
->parser
);
1211 static void usbredir_device_connect(void *priv
,
1212 struct usb_redir_device_connect_header
*device_connect
)
1214 USBRedirDevice
*dev
= priv
;
1217 if (qemu_timer_pending(dev
->attach_timer
) || dev
->dev
.attached
) {
1218 ERROR("Received device connect while already connected\n");
1222 switch (device_connect
->speed
) {
1223 case usb_redir_speed_low
:
1224 speed
= "low speed";
1225 dev
->dev
.speed
= USB_SPEED_LOW
;
1226 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_FULL
;
1227 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_HIGH
;
1229 case usb_redir_speed_full
:
1230 speed
= "full speed";
1231 dev
->dev
.speed
= USB_SPEED_FULL
;
1232 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_HIGH
;
1234 case usb_redir_speed_high
:
1235 speed
= "high speed";
1236 dev
->dev
.speed
= USB_SPEED_HIGH
;
1238 case usb_redir_speed_super
:
1239 speed
= "super speed";
1240 dev
->dev
.speed
= USB_SPEED_SUPER
;
1243 speed
= "unknown speed";
1244 dev
->dev
.speed
= USB_SPEED_FULL
;
1247 if (usbredirparser_peer_has_cap(dev
->parser
,
1248 usb_redir_cap_connect_device_version
)) {
1249 INFO("attaching %s device %04x:%04x version %d.%d class %02x\n",
1250 speed
, device_connect
->vendor_id
, device_connect
->product_id
,
1251 ((device_connect
->device_version_bcd
& 0xf000) >> 12) * 10 +
1252 ((device_connect
->device_version_bcd
& 0x0f00) >> 8),
1253 ((device_connect
->device_version_bcd
& 0x00f0) >> 4) * 10 +
1254 ((device_connect
->device_version_bcd
& 0x000f) >> 0),
1255 device_connect
->device_class
);
1257 INFO("attaching %s device %04x:%04x class %02x\n", speed
,
1258 device_connect
->vendor_id
, device_connect
->product_id
,
1259 device_connect
->device_class
);
1262 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
) | dev
->compatible_speedmask
;
1263 dev
->device_info
= *device_connect
;
1265 if (usbredir_check_filter(dev
)) {
1266 WARNING("Device %04x:%04x rejected by device filter, not attaching\n",
1267 device_connect
->vendor_id
, device_connect
->product_id
);
1271 qemu_mod_timer(dev
->attach_timer
, dev
->next_attach_time
);
1274 static void usbredir_device_disconnect(void *priv
)
1276 USBRedirDevice
*dev
= priv
;
1279 /* Stop any pending attaches */
1280 qemu_del_timer(dev
->attach_timer
);
1282 if (dev
->dev
.attached
) {
1283 DPRINTF("detaching device\n");
1284 usb_device_detach(&dev
->dev
);
1286 * Delay next usb device attach to give the guest a chance to see
1287 * see the detach / attach in case of quick close / open succession
1289 dev
->next_attach_time
= qemu_get_clock_ms(vm_clock
) + 200;
1292 /* Reset state so that the next dev connected starts with a clean slate */
1293 usbredir_cleanup_device_queues(dev
);
1294 memset(dev
->endpoint
, 0, sizeof(dev
->endpoint
));
1295 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1296 QTAILQ_INIT(&dev
->endpoint
[i
].bufpq
);
1298 usb_ep_init(&dev
->dev
);
1299 dev
->interface_info
.interface_count
= NO_INTERFACE_INFO
;
1302 dev
->compatible_speedmask
= USB_SPEED_MASK_FULL
| USB_SPEED_MASK_HIGH
;
1305 static void usbredir_interface_info(void *priv
,
1306 struct usb_redir_interface_info_header
*interface_info
)
1308 USBRedirDevice
*dev
= priv
;
1310 dev
->interface_info
= *interface_info
;
1313 * If we receive interface info after the device has already been
1314 * connected (ie on a set_config), re-check the filter.
1316 if (qemu_timer_pending(dev
->attach_timer
) || dev
->dev
.attached
) {
1317 if (usbredir_check_filter(dev
)) {
1318 ERROR("Device no longer matches filter after interface info "
1319 "change, disconnecting!\n");
1324 static void usbredir_mark_speed_incompatible(USBRedirDevice
*dev
, int speed
)
1326 dev
->compatible_speedmask
&= ~(1 << speed
);
1327 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
) | dev
->compatible_speedmask
;
1330 static void usbredir_set_pipeline(USBRedirDevice
*dev
, struct USBEndpoint
*uep
)
1332 if (uep
->type
!= USB_ENDPOINT_XFER_BULK
) {
1335 if (uep
->pid
== USB_TOKEN_OUT
) {
1336 uep
->pipeline
= true;
1338 if (uep
->pid
== USB_TOKEN_IN
&& uep
->max_packet_size
!= 0 &&
1339 usbredirparser_peer_has_cap(dev
->parser
,
1340 usb_redir_cap_32bits_bulk_length
)) {
1341 uep
->pipeline
= true;
1345 static void usbredir_setup_usb_eps(USBRedirDevice
*dev
)
1347 struct USBEndpoint
*usb_ep
;
1350 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1351 pid
= (i
& 0x10) ? USB_TOKEN_IN
: USB_TOKEN_OUT
;
1352 usb_ep
= usb_ep_get(&dev
->dev
, pid
, i
& 0x0f);
1353 usb_ep
->type
= dev
->endpoint
[i
].type
;
1354 usb_ep
->ifnum
= dev
->endpoint
[i
].interface
;
1355 usb_ep
->max_packet_size
= dev
->endpoint
[i
].max_packet_size
;
1356 usbredir_set_pipeline(dev
, usb_ep
);
1360 static void usbredir_ep_info(void *priv
,
1361 struct usb_redir_ep_info_header
*ep_info
)
1363 USBRedirDevice
*dev
= priv
;
1366 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1367 dev
->endpoint
[i
].type
= ep_info
->type
[i
];
1368 dev
->endpoint
[i
].interval
= ep_info
->interval
[i
];
1369 dev
->endpoint
[i
].interface
= ep_info
->interface
[i
];
1370 if (usbredirparser_peer_has_cap(dev
->parser
,
1371 usb_redir_cap_ep_info_max_packet_size
)) {
1372 dev
->endpoint
[i
].max_packet_size
= ep_info
->max_packet_size
[i
];
1374 switch (dev
->endpoint
[i
].type
) {
1375 case usb_redir_type_invalid
:
1377 case usb_redir_type_iso
:
1378 usbredir_mark_speed_incompatible(dev
, USB_SPEED_FULL
);
1379 usbredir_mark_speed_incompatible(dev
, USB_SPEED_HIGH
);
1381 case usb_redir_type_interrupt
:
1382 if (!usbredirparser_peer_has_cap(dev
->parser
,
1383 usb_redir_cap_ep_info_max_packet_size
) ||
1384 ep_info
->max_packet_size
[i
] > 64) {
1385 usbredir_mark_speed_incompatible(dev
, USB_SPEED_FULL
);
1387 if (!usbredirparser_peer_has_cap(dev
->parser
,
1388 usb_redir_cap_ep_info_max_packet_size
) ||
1389 ep_info
->max_packet_size
[i
] > 1024) {
1390 usbredir_mark_speed_incompatible(dev
, USB_SPEED_HIGH
);
1392 if (dev
->endpoint
[i
].interval
== 0) {
1393 ERROR("Received 0 interval for isoc or irq endpoint\n");
1394 usbredir_reject_device(dev
);
1398 case usb_redir_type_control
:
1399 case usb_redir_type_bulk
:
1400 DPRINTF("ep: %02X type: %d interface: %d\n", I2EP(i
),
1401 dev
->endpoint
[i
].type
, dev
->endpoint
[i
].interface
);
1404 ERROR("Received invalid endpoint type\n");
1405 usbredir_reject_device(dev
);
1409 /* The new ep info may have caused a speed incompatibility, recheck */
1410 if (dev
->dev
.attached
&&
1411 !(dev
->dev
.port
->speedmask
& dev
->dev
.speedmask
)) {
1412 ERROR("Device no longer matches speed after endpoint info change, "
1413 "disconnecting!\n");
1414 usbredir_reject_device(dev
);
1417 usbredir_setup_usb_eps(dev
);
1420 static void usbredir_configuration_status(void *priv
, uint64_t id
,
1421 struct usb_redir_configuration_status_header
*config_status
)
1423 USBRedirDevice
*dev
= priv
;
1426 DPRINTF("set config status %d config %d id %"PRIu64
"\n",
1427 config_status
->status
, config_status
->configuration
, id
);
1429 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1431 if (dev
->dev
.setup_buf
[0] & USB_DIR_IN
) {
1432 dev
->dev
.data_buf
[0] = config_status
->configuration
;
1433 p
->actual_length
= 1;
1435 usbredir_handle_status(dev
, p
, config_status
->status
);
1436 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1440 static void usbredir_alt_setting_status(void *priv
, uint64_t id
,
1441 struct usb_redir_alt_setting_status_header
*alt_setting_status
)
1443 USBRedirDevice
*dev
= priv
;
1446 DPRINTF("alt status %d intf %d alt %d id: %"PRIu64
"\n",
1447 alt_setting_status
->status
, alt_setting_status
->interface
,
1448 alt_setting_status
->alt
, id
);
1450 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1452 if (dev
->dev
.setup_buf
[0] & USB_DIR_IN
) {
1453 dev
->dev
.data_buf
[0] = alt_setting_status
->alt
;
1454 p
->actual_length
= 1;
1456 usbredir_handle_status(dev
, p
, alt_setting_status
->status
);
1457 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1461 static void usbredir_iso_stream_status(void *priv
, uint64_t id
,
1462 struct usb_redir_iso_stream_status_header
*iso_stream_status
)
1464 USBRedirDevice
*dev
= priv
;
1465 uint8_t ep
= iso_stream_status
->endpoint
;
1467 DPRINTF("iso status %d ep %02X id %"PRIu64
"\n", iso_stream_status
->status
,
1470 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].iso_started
) {
1474 dev
->endpoint
[EP2I(ep
)].iso_error
= iso_stream_status
->status
;
1475 if (iso_stream_status
->status
== usb_redir_stall
) {
1476 DPRINTF("iso stream stopped by peer ep %02X\n", ep
);
1477 dev
->endpoint
[EP2I(ep
)].iso_started
= 0;
1481 static void usbredir_interrupt_receiving_status(void *priv
, uint64_t id
,
1482 struct usb_redir_interrupt_receiving_status_header
1483 *interrupt_receiving_status
)
1485 USBRedirDevice
*dev
= priv
;
1486 uint8_t ep
= interrupt_receiving_status
->endpoint
;
1488 DPRINTF("interrupt recv status %d ep %02X id %"PRIu64
"\n",
1489 interrupt_receiving_status
->status
, ep
, id
);
1491 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].interrupt_started
) {
1495 dev
->endpoint
[EP2I(ep
)].interrupt_error
=
1496 interrupt_receiving_status
->status
;
1497 if (interrupt_receiving_status
->status
== usb_redir_stall
) {
1498 DPRINTF("interrupt receiving stopped by peer ep %02X\n", ep
);
1499 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 0;
1503 static void usbredir_bulk_streams_status(void *priv
, uint64_t id
,
1504 struct usb_redir_bulk_streams_status_header
*bulk_streams_status
)
1508 static void usbredir_control_packet(void *priv
, uint64_t id
,
1509 struct usb_redir_control_packet_header
*control_packet
,
1510 uint8_t *data
, int data_len
)
1512 USBRedirDevice
*dev
= priv
;
1514 int len
= control_packet
->length
;
1516 DPRINTF("ctrl-in status %d len %d id %"PRIu64
"\n", control_packet
->status
,
1519 /* Fix up USB-3 ep0 maxpacket size to allow superspeed connected devices
1520 * to work redirected to a not superspeed capable hcd */
1521 if (dev
->dev
.speed
== USB_SPEED_SUPER
&&
1522 !((dev
->dev
.port
->speedmask
& USB_SPEED_MASK_SUPER
)) &&
1523 control_packet
->requesttype
== 0x80 &&
1524 control_packet
->request
== 6 &&
1525 control_packet
->value
== 0x100 && control_packet
->index
== 0 &&
1526 data_len
>= 18 && data
[7] == 9) {
1530 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1532 usbredir_handle_status(dev
, p
, control_packet
->status
);
1534 usbredir_log_data(dev
, "ctrl data in:", data
, data_len
);
1535 if (data_len
> sizeof(dev
->dev
.data_buf
)) {
1536 ERROR("ctrl buffer too small (%d > %zu)\n",
1537 data_len
, sizeof(dev
->dev
.data_buf
));
1538 p
->status
= USB_RET_STALL
;
1539 data_len
= len
= sizeof(dev
->dev
.data_buf
);
1541 memcpy(dev
->dev
.data_buf
, data
, data_len
);
1543 p
->actual_length
= len
;
1544 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1549 static void usbredir_bulk_packet(void *priv
, uint64_t id
,
1550 struct usb_redir_bulk_packet_header
*bulk_packet
,
1551 uint8_t *data
, int data_len
)
1553 USBRedirDevice
*dev
= priv
;
1554 uint8_t ep
= bulk_packet
->endpoint
;
1555 int len
= (bulk_packet
->length_high
<< 16) | bulk_packet
->length
;
1558 DPRINTF("bulk-in status %d ep %02X len %d id %"PRIu64
"\n",
1559 bulk_packet
->status
, ep
, len
, id
);
1561 p
= usbredir_find_packet_by_id(dev
, ep
, id
);
1563 size_t size
= (p
->combined
) ? p
->combined
->iov
.size
: p
->iov
.size
;
1564 usbredir_handle_status(dev
, p
, bulk_packet
->status
);
1566 usbredir_log_data(dev
, "bulk data in:", data
, data_len
);
1567 if (data_len
> size
) {
1568 ERROR("bulk got more data then requested (%d > %zd)\n",
1569 data_len
, p
->iov
.size
);
1570 p
->status
= USB_RET_BABBLE
;
1571 data_len
= len
= size
;
1574 iov_from_buf(p
->combined
->iov
.iov
, p
->combined
->iov
.niov
,
1577 usb_packet_copy(p
, data
, data_len
);
1580 p
->actual_length
= len
;
1581 if (p
->pid
== USB_TOKEN_IN
&& p
->ep
->pipeline
) {
1582 usb_combined_input_packet_complete(&dev
->dev
, p
);
1584 usb_packet_complete(&dev
->dev
, p
);
1590 static void usbredir_iso_packet(void *priv
, uint64_t id
,
1591 struct usb_redir_iso_packet_header
*iso_packet
,
1592 uint8_t *data
, int data_len
)
1594 USBRedirDevice
*dev
= priv
;
1595 uint8_t ep
= iso_packet
->endpoint
;
1597 DPRINTF2("iso-in status %d ep %02X len %d id %"PRIu64
"\n",
1598 iso_packet
->status
, ep
, data_len
, id
);
1600 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_ISOC
) {
1601 ERROR("received iso packet for non iso endpoint %02X\n", ep
);
1606 if (dev
->endpoint
[EP2I(ep
)].iso_started
== 0) {
1607 DPRINTF("received iso packet for non started stream ep %02X\n", ep
);
1612 /* bufp_alloc also adds the packet to the ep queue */
1613 bufp_alloc(dev
, data
, data_len
, iso_packet
->status
, ep
);
1616 static void usbredir_interrupt_packet(void *priv
, uint64_t id
,
1617 struct usb_redir_interrupt_packet_header
*interrupt_packet
,
1618 uint8_t *data
, int data_len
)
1620 USBRedirDevice
*dev
= priv
;
1621 uint8_t ep
= interrupt_packet
->endpoint
;
1623 DPRINTF("interrupt-in status %d ep %02X len %d id %"PRIu64
"\n",
1624 interrupt_packet
->status
, ep
, data_len
, id
);
1626 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_INT
) {
1627 ERROR("received int packet for non interrupt endpoint %02X\n", ep
);
1632 if (ep
& USB_DIR_IN
) {
1633 if (dev
->endpoint
[EP2I(ep
)].interrupt_started
== 0) {
1634 DPRINTF("received int packet while not started ep %02X\n", ep
);
1639 /* bufp_alloc also adds the packet to the ep queue */
1640 bufp_alloc(dev
, data
, data_len
, interrupt_packet
->status
, ep
);
1642 USBPacket
*p
= usbredir_find_packet_by_id(dev
, ep
, id
);
1644 usbredir_handle_status(dev
, p
, interrupt_packet
->status
);
1645 p
->actual_length
= interrupt_packet
->length
;
1646 usb_packet_complete(&dev
->dev
, p
);
1655 static void usbredir_pre_save(void *priv
)
1657 USBRedirDevice
*dev
= priv
;
1659 usbredir_fill_already_in_flight(dev
);
1662 static int usbredir_post_load(void *priv
, int version_id
)
1664 USBRedirDevice
*dev
= priv
;
1666 switch (dev
->device_info
.speed
) {
1667 case usb_redir_speed_low
:
1668 dev
->dev
.speed
= USB_SPEED_LOW
;
1670 case usb_redir_speed_full
:
1671 dev
->dev
.speed
= USB_SPEED_FULL
;
1673 case usb_redir_speed_high
:
1674 dev
->dev
.speed
= USB_SPEED_HIGH
;
1676 case usb_redir_speed_super
:
1677 dev
->dev
.speed
= USB_SPEED_SUPER
;
1680 dev
->dev
.speed
= USB_SPEED_FULL
;
1682 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
);
1684 usbredir_setup_usb_eps(dev
);
1689 /* For usbredirparser migration */
1690 static void usbredir_put_parser(QEMUFile
*f
, void *priv
, size_t unused
)
1692 USBRedirDevice
*dev
= priv
;
1696 if (dev
->parser
== NULL
) {
1697 qemu_put_be32(f
, 0);
1701 usbredirparser_serialize(dev
->parser
, &data
, &len
);
1702 qemu_oom_check(data
);
1704 qemu_put_be32(f
, len
);
1705 qemu_put_buffer(f
, data
, len
);
1710 static int usbredir_get_parser(QEMUFile
*f
, void *priv
, size_t unused
)
1712 USBRedirDevice
*dev
= priv
;
1716 len
= qemu_get_be32(f
);
1722 * If our chardev is not open already at this point the usbredir connection
1723 * has been broken (non seamless migration, or restore from disk).
1725 * In this case create a temporary parser to receive the migration data,
1726 * and schedule the close_bh to report the device as disconnected to the
1727 * guest and to destroy the parser again.
1729 if (dev
->parser
== NULL
) {
1730 WARNING("usb-redir connection broken during migration\n");
1731 usbredir_create_parser(dev
);
1732 qemu_bh_schedule(dev
->chardev_close_bh
);
1735 data
= g_malloc(len
);
1736 qemu_get_buffer(f
, data
, len
);
1738 ret
= usbredirparser_unserialize(dev
->parser
, data
, len
);
1745 static const VMStateInfo usbredir_parser_vmstate_info
= {
1746 .name
= "usb-redir-parser",
1747 .put
= usbredir_put_parser
,
1748 .get
= usbredir_get_parser
,
1752 /* For buffered packets (iso/irq) queue migration */
1753 static void usbredir_put_bufpq(QEMUFile
*f
, void *priv
, size_t unused
)
1755 struct endp_data
*endp
= priv
;
1756 struct buf_packet
*bufp
;
1757 int remain
= endp
->bufpq_size
;
1759 qemu_put_be32(f
, endp
->bufpq_size
);
1760 QTAILQ_FOREACH(bufp
, &endp
->bufpq
, next
) {
1761 qemu_put_be32(f
, bufp
->len
);
1762 qemu_put_be32(f
, bufp
->status
);
1763 qemu_put_buffer(f
, bufp
->data
, bufp
->len
);
1766 assert(remain
== 0);
1769 static int usbredir_get_bufpq(QEMUFile
*f
, void *priv
, size_t unused
)
1771 struct endp_data
*endp
= priv
;
1772 struct buf_packet
*bufp
;
1775 endp
->bufpq_size
= qemu_get_be32(f
);
1776 for (i
= 0; i
< endp
->bufpq_size
; i
++) {
1777 bufp
= g_malloc(sizeof(struct buf_packet
));
1778 bufp
->len
= qemu_get_be32(f
);
1779 bufp
->status
= qemu_get_be32(f
);
1780 bufp
->data
= qemu_oom_check(malloc(bufp
->len
)); /* regular malloc! */
1781 qemu_get_buffer(f
, bufp
->data
, bufp
->len
);
1782 QTAILQ_INSERT_TAIL(&endp
->bufpq
, bufp
, next
);
1787 static const VMStateInfo usbredir_ep_bufpq_vmstate_info
= {
1788 .name
= "usb-redir-bufpq",
1789 .put
= usbredir_put_bufpq
,
1790 .get
= usbredir_get_bufpq
,
1794 /* For endp_data migration */
1795 static const VMStateDescription usbredir_ep_vmstate
= {
1796 .name
= "usb-redir-ep",
1798 .minimum_version_id
= 1,
1799 .fields
= (VMStateField
[]) {
1800 VMSTATE_UINT8(type
, struct endp_data
),
1801 VMSTATE_UINT8(interval
, struct endp_data
),
1802 VMSTATE_UINT8(interface
, struct endp_data
),
1803 VMSTATE_UINT16(max_packet_size
, struct endp_data
),
1804 VMSTATE_UINT8(iso_started
, struct endp_data
),
1805 VMSTATE_UINT8(iso_error
, struct endp_data
),
1806 VMSTATE_UINT8(interrupt_started
, struct endp_data
),
1807 VMSTATE_UINT8(interrupt_error
, struct endp_data
),
1808 VMSTATE_UINT8(bufpq_prefilled
, struct endp_data
),
1809 VMSTATE_UINT8(bufpq_dropping_packets
, struct endp_data
),
1813 .field_exists
= NULL
,
1815 .info
= &usbredir_ep_bufpq_vmstate_info
,
1816 .flags
= VMS_SINGLE
,
1819 VMSTATE_INT32(bufpq_target_size
, struct endp_data
),
1820 VMSTATE_END_OF_LIST()
1825 /* For PacketIdQueue migration */
1826 static void usbredir_put_packet_id_q(QEMUFile
*f
, void *priv
, size_t unused
)
1828 struct PacketIdQueue
*q
= priv
;
1829 USBRedirDevice
*dev
= q
->dev
;
1830 struct PacketIdQueueEntry
*e
;
1831 int remain
= q
->size
;
1833 DPRINTF("put_packet_id_q %s size %d\n", q
->name
, q
->size
);
1834 qemu_put_be32(f
, q
->size
);
1835 QTAILQ_FOREACH(e
, &q
->head
, next
) {
1836 qemu_put_be64(f
, e
->id
);
1839 assert(remain
== 0);
1842 static int usbredir_get_packet_id_q(QEMUFile
*f
, void *priv
, size_t unused
)
1844 struct PacketIdQueue
*q
= priv
;
1845 USBRedirDevice
*dev
= q
->dev
;
1849 size
= qemu_get_be32(f
);
1850 DPRINTF("get_packet_id_q %s size %d\n", q
->name
, size
);
1851 for (i
= 0; i
< size
; i
++) {
1852 id
= qemu_get_be64(f
);
1853 packet_id_queue_add(q
, id
);
1855 assert(q
->size
== size
);
1859 static const VMStateInfo usbredir_ep_packet_id_q_vmstate_info
= {
1860 .name
= "usb-redir-packet-id-q",
1861 .put
= usbredir_put_packet_id_q
,
1862 .get
= usbredir_get_packet_id_q
,
1865 static const VMStateDescription usbredir_ep_packet_id_queue_vmstate
= {
1866 .name
= "usb-redir-packet-id-queue",
1868 .minimum_version_id
= 1,
1869 .fields
= (VMStateField
[]) {
1873 .field_exists
= NULL
,
1875 .info
= &usbredir_ep_packet_id_q_vmstate_info
,
1876 .flags
= VMS_SINGLE
,
1879 VMSTATE_END_OF_LIST()
1884 /* For usb_redir_device_connect_header migration */
1885 static const VMStateDescription usbredir_device_info_vmstate
= {
1886 .name
= "usb-redir-device-info",
1888 .minimum_version_id
= 1,
1889 .fields
= (VMStateField
[]) {
1890 VMSTATE_UINT8(speed
, struct usb_redir_device_connect_header
),
1891 VMSTATE_UINT8(device_class
, struct usb_redir_device_connect_header
),
1892 VMSTATE_UINT8(device_subclass
, struct usb_redir_device_connect_header
),
1893 VMSTATE_UINT8(device_protocol
, struct usb_redir_device_connect_header
),
1894 VMSTATE_UINT16(vendor_id
, struct usb_redir_device_connect_header
),
1895 VMSTATE_UINT16(product_id
, struct usb_redir_device_connect_header
),
1896 VMSTATE_UINT16(device_version_bcd
,
1897 struct usb_redir_device_connect_header
),
1898 VMSTATE_END_OF_LIST()
1903 /* For usb_redir_interface_info_header migration */
1904 static const VMStateDescription usbredir_interface_info_vmstate
= {
1905 .name
= "usb-redir-interface-info",
1907 .minimum_version_id
= 1,
1908 .fields
= (VMStateField
[]) {
1909 VMSTATE_UINT32(interface_count
,
1910 struct usb_redir_interface_info_header
),
1911 VMSTATE_UINT8_ARRAY(interface
,
1912 struct usb_redir_interface_info_header
, 32),
1913 VMSTATE_UINT8_ARRAY(interface_class
,
1914 struct usb_redir_interface_info_header
, 32),
1915 VMSTATE_UINT8_ARRAY(interface_subclass
,
1916 struct usb_redir_interface_info_header
, 32),
1917 VMSTATE_UINT8_ARRAY(interface_protocol
,
1918 struct usb_redir_interface_info_header
, 32),
1919 VMSTATE_END_OF_LIST()
1924 /* And finally the USBRedirDevice vmstate itself */
1925 static const VMStateDescription usbredir_vmstate
= {
1926 .name
= "usb-redir",
1928 .minimum_version_id
= 1,
1929 .pre_save
= usbredir_pre_save
,
1930 .post_load
= usbredir_post_load
,
1931 .fields
= (VMStateField
[]) {
1932 VMSTATE_USB_DEVICE(dev
, USBRedirDevice
),
1933 VMSTATE_TIMER(attach_timer
, USBRedirDevice
),
1937 .field_exists
= NULL
,
1939 .info
= &usbredir_parser_vmstate_info
,
1940 .flags
= VMS_SINGLE
,
1943 VMSTATE_STRUCT_ARRAY(endpoint
, USBRedirDevice
, MAX_ENDPOINTS
, 1,
1944 usbredir_ep_vmstate
, struct endp_data
),
1945 VMSTATE_STRUCT(cancelled
, USBRedirDevice
, 1,
1946 usbredir_ep_packet_id_queue_vmstate
,
1947 struct PacketIdQueue
),
1948 VMSTATE_STRUCT(already_in_flight
, USBRedirDevice
, 1,
1949 usbredir_ep_packet_id_queue_vmstate
,
1950 struct PacketIdQueue
),
1951 VMSTATE_STRUCT(device_info
, USBRedirDevice
, 1,
1952 usbredir_device_info_vmstate
,
1953 struct usb_redir_device_connect_header
),
1954 VMSTATE_STRUCT(interface_info
, USBRedirDevice
, 1,
1955 usbredir_interface_info_vmstate
,
1956 struct usb_redir_interface_info_header
),
1957 VMSTATE_END_OF_LIST()
1961 static Property usbredir_properties
[] = {
1962 DEFINE_PROP_CHR("chardev", USBRedirDevice
, cs
),
1963 DEFINE_PROP_UINT8("debug", USBRedirDevice
, debug
, 0),
1964 DEFINE_PROP_STRING("filter", USBRedirDevice
, filter_str
),
1965 DEFINE_PROP_INT32("bootindex", USBRedirDevice
, bootindex
, -1),
1966 DEFINE_PROP_END_OF_LIST(),
1969 static void usbredir_class_initfn(ObjectClass
*klass
, void *data
)
1971 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
1972 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1974 uc
->init
= usbredir_initfn
;
1975 uc
->product_desc
= "USB Redirection Device";
1976 uc
->handle_destroy
= usbredir_handle_destroy
;
1977 uc
->cancel_packet
= usbredir_cancel_packet
;
1978 uc
->handle_reset
= usbredir_handle_reset
;
1979 uc
->handle_data
= usbredir_handle_data
;
1980 uc
->handle_control
= usbredir_handle_control
;
1981 uc
->flush_ep_queue
= usbredir_flush_ep_queue
;
1982 dc
->vmsd
= &usbredir_vmstate
;
1983 dc
->props
= usbredir_properties
;
1986 static TypeInfo usbredir_dev_info
= {
1987 .name
= "usb-redir",
1988 .parent
= TYPE_USB_DEVICE
,
1989 .instance_size
= sizeof(USBRedirDevice
),
1990 .class_init
= usbredir_class_initfn
,
1993 static void usbredir_register_types(void)
1995 type_register_static(&usbredir_dev_info
);
1998 type_init(usbredir_register_types
)