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"
30 #include "monitor/monitor.h"
31 #include "sysemu/sysemu.h"
33 #include "sysemu/char.h"
36 #include <sys/ioctl.h>
38 #include <usbredirparser.h>
39 #include <usbredirfilter.h>
43 #define MAX_ENDPOINTS 32
44 #define NO_INTERFACE_INFO 255 /* Valid interface_count always <= 32 */
45 #define EP2I(ep_address) (((ep_address & 0x80) >> 3) | (ep_address & 0x0f))
46 #define I2EP(i) (((i & 0x10) << 3) | (i & 0x0f))
47 #define USBEP2I(usb_ep) (((usb_ep)->pid == USB_TOKEN_IN) ? \
48 ((usb_ep)->nr | 0x10) : ((usb_ep)->nr))
49 #define I2USBEP(d, i) (usb_ep_get(&(d)->dev, \
50 ((i) & 0x10) ? USB_TOKEN_IN : USB_TOKEN_OUT, \
53 #ifndef USBREDIR_VERSION /* This is not defined in older usbredir versions */
54 #define USBREDIR_VERSION 0
57 typedef struct USBRedirDevice USBRedirDevice
;
59 /* Struct to hold buffered packets */
62 void *free_on_destroy
;
66 QTAILQ_ENTRY(buf_packet
)next
;
73 uint8_t interface
; /* bInterfaceNumber this ep belongs to */
74 uint16_t max_packet_size
; /* In bytes, not wMaxPacketSize format !! */
77 uint8_t iso_error
; /* For reporting iso errors to the HC */
78 uint8_t interrupt_started
;
79 uint8_t interrupt_error
;
80 uint8_t bulk_receiving_enabled
;
81 uint8_t bulk_receiving_started
;
82 uint8_t bufpq_prefilled
;
83 uint8_t bufpq_dropping_packets
;
84 QTAILQ_HEAD(, buf_packet
) bufpq
;
86 int32_t bufpq_target_size
;
87 USBPacket
*pending_async_packet
;
90 struct PacketIdQueueEntry
{
92 QTAILQ_ENTRY(PacketIdQueueEntry
)next
;
95 struct PacketIdQueue
{
98 QTAILQ_HEAD(, PacketIdQueueEntry
) head
;
102 struct USBRedirDevice
{
109 /* Data passed from chardev the fd_read cb to the usbredirparser read cb */
110 const uint8_t *read_buf
;
112 /* Active chardev-watch-tag */
114 /* For async handling of close / reject */
115 QEMUBH
*chardev_close_bh
;
116 QEMUBH
*device_reject_bh
;
117 /* To delay the usb attach in case of quick chardev close + open */
118 QEMUTimer
*attach_timer
;
119 int64_t next_attach_time
;
120 struct usbredirparser
*parser
;
121 struct endp_data endpoint
[MAX_ENDPOINTS
];
122 struct PacketIdQueue cancelled
;
123 struct PacketIdQueue already_in_flight
;
124 void (*buffered_bulk_in_complete
)(USBRedirDevice
*, USBPacket
*, uint8_t);
125 /* Data for device filtering */
126 struct usb_redir_device_connect_header device_info
;
127 struct usb_redir_interface_info_header interface_info
;
128 struct usbredirfilter_rule
*filter_rules
;
129 int filter_rules_count
;
130 int compatible_speedmask
;
133 static void usbredir_hello(void *priv
, struct usb_redir_hello_header
*h
);
134 static void usbredir_device_connect(void *priv
,
135 struct usb_redir_device_connect_header
*device_connect
);
136 static void usbredir_device_disconnect(void *priv
);
137 static void usbredir_interface_info(void *priv
,
138 struct usb_redir_interface_info_header
*interface_info
);
139 static void usbredir_ep_info(void *priv
,
140 struct usb_redir_ep_info_header
*ep_info
);
141 static void usbredir_configuration_status(void *priv
, uint64_t id
,
142 struct usb_redir_configuration_status_header
*configuration_status
);
143 static void usbredir_alt_setting_status(void *priv
, uint64_t id
,
144 struct usb_redir_alt_setting_status_header
*alt_setting_status
);
145 static void usbredir_iso_stream_status(void *priv
, uint64_t id
,
146 struct usb_redir_iso_stream_status_header
*iso_stream_status
);
147 static void usbredir_interrupt_receiving_status(void *priv
, uint64_t id
,
148 struct usb_redir_interrupt_receiving_status_header
149 *interrupt_receiving_status
);
150 static void usbredir_bulk_streams_status(void *priv
, uint64_t id
,
151 struct usb_redir_bulk_streams_status_header
*bulk_streams_status
);
152 static void usbredir_bulk_receiving_status(void *priv
, uint64_t id
,
153 struct usb_redir_bulk_receiving_status_header
*bulk_receiving_status
);
154 static void usbredir_control_packet(void *priv
, uint64_t id
,
155 struct usb_redir_control_packet_header
*control_packet
,
156 uint8_t *data
, int data_len
);
157 static void usbredir_bulk_packet(void *priv
, uint64_t id
,
158 struct usb_redir_bulk_packet_header
*bulk_packet
,
159 uint8_t *data
, int data_len
);
160 static void usbredir_iso_packet(void *priv
, uint64_t id
,
161 struct usb_redir_iso_packet_header
*iso_packet
,
162 uint8_t *data
, int data_len
);
163 static void usbredir_interrupt_packet(void *priv
, uint64_t id
,
164 struct usb_redir_interrupt_packet_header
*interrupt_header
,
165 uint8_t *data
, int data_len
);
166 static void usbredir_buffered_bulk_packet(void *priv
, uint64_t id
,
167 struct usb_redir_buffered_bulk_packet_header
*buffered_bulk_packet
,
168 uint8_t *data
, int data_len
);
170 static void usbredir_handle_status(USBRedirDevice
*dev
, USBPacket
*p
,
173 #define VERSION "qemu usb-redir guest " QEMU_VERSION
181 if (dev->debug >= usbredirparser_error) { \
182 error_report("usb-redir error: " __VA_ARGS__); \
185 #define WARNING(...) \
187 if (dev->debug >= usbredirparser_warning) { \
188 error_report("usb-redir warning: " __VA_ARGS__); \
193 if (dev->debug >= usbredirparser_info) { \
194 error_report("usb-redir: " __VA_ARGS__); \
197 #define DPRINTF(...) \
199 if (dev->debug >= usbredirparser_debug) { \
200 error_report("usb-redir: " __VA_ARGS__); \
203 #define DPRINTF2(...) \
205 if (dev->debug >= usbredirparser_debug_data) { \
206 error_report("usb-redir: " __VA_ARGS__); \
210 static void usbredir_log(void *priv
, int level
, const char *msg
)
212 USBRedirDevice
*dev
= priv
;
214 if (dev
->debug
< level
) {
218 error_report("%s", msg
);
221 static void usbredir_log_data(USBRedirDevice
*dev
, const char *desc
,
222 const uint8_t *data
, int len
)
226 if (dev
->debug
< usbredirparser_debug_data
) {
230 for (i
= 0; i
< len
; i
+= j
) {
233 n
= sprintf(buf
, "%s", desc
);
234 for (j
= 0; j
< 8 && i
+ j
< len
; j
++) {
235 n
+= sprintf(buf
+ n
, " %02X", data
[i
+ j
]);
237 error_report("%s", buf
);
242 * usbredirparser io functions
245 static int usbredir_read(void *priv
, uint8_t *data
, int count
)
247 USBRedirDevice
*dev
= priv
;
249 if (dev
->read_buf_size
< count
) {
250 count
= dev
->read_buf_size
;
253 memcpy(data
, dev
->read_buf
, count
);
255 dev
->read_buf_size
-= count
;
256 if (dev
->read_buf_size
) {
257 dev
->read_buf
+= count
;
259 dev
->read_buf
= NULL
;
265 static gboolean
usbredir_write_unblocked(GIOChannel
*chan
, GIOCondition cond
,
268 USBRedirDevice
*dev
= opaque
;
271 usbredirparser_do_write(dev
->parser
);
276 static int usbredir_write(void *priv
, uint8_t *data
, int count
)
278 USBRedirDevice
*dev
= priv
;
281 if (!dev
->cs
->be_open
) {
285 /* Don't send new data to the chardev until our state is fully synced */
286 if (!runstate_check(RUN_STATE_RUNNING
)) {
290 r
= qemu_chr_fe_write(dev
->cs
, data
, count
);
293 dev
->watch
= qemu_chr_fe_add_watch(dev
->cs
, G_IO_OUT
|G_IO_HUP
,
294 usbredir_write_unblocked
, dev
);
304 * Cancelled and buffered packets helpers
307 static void packet_id_queue_init(struct PacketIdQueue
*q
,
308 USBRedirDevice
*dev
, const char *name
)
312 QTAILQ_INIT(&q
->head
);
316 static void packet_id_queue_add(struct PacketIdQueue
*q
, uint64_t id
)
318 USBRedirDevice
*dev
= q
->dev
;
319 struct PacketIdQueueEntry
*e
;
321 DPRINTF("adding packet id %"PRIu64
" to %s queue\n", id
, q
->name
);
323 e
= g_malloc0(sizeof(struct PacketIdQueueEntry
));
325 QTAILQ_INSERT_TAIL(&q
->head
, e
, next
);
329 static int packet_id_queue_remove(struct PacketIdQueue
*q
, uint64_t id
)
331 USBRedirDevice
*dev
= q
->dev
;
332 struct PacketIdQueueEntry
*e
;
334 QTAILQ_FOREACH(e
, &q
->head
, next
) {
336 DPRINTF("removing packet id %"PRIu64
" from %s queue\n",
338 QTAILQ_REMOVE(&q
->head
, e
, next
);
347 static void packet_id_queue_empty(struct PacketIdQueue
*q
)
349 USBRedirDevice
*dev
= q
->dev
;
350 struct PacketIdQueueEntry
*e
, *next_e
;
352 DPRINTF("removing %d packet-ids from %s queue\n", q
->size
, q
->name
);
354 QTAILQ_FOREACH_SAFE(e
, &q
->head
, next
, next_e
) {
355 QTAILQ_REMOVE(&q
->head
, e
, next
);
361 static void usbredir_cancel_packet(USBDevice
*udev
, USBPacket
*p
)
363 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
364 int i
= USBEP2I(p
->ep
);
367 usb_combined_packet_cancel(udev
, p
);
371 if (dev
->endpoint
[i
].pending_async_packet
) {
372 assert(dev
->endpoint
[i
].pending_async_packet
== p
);
373 dev
->endpoint
[i
].pending_async_packet
= NULL
;
377 packet_id_queue_add(&dev
->cancelled
, p
->id
);
378 usbredirparser_send_cancel_data_packet(dev
->parser
, p
->id
);
379 usbredirparser_do_write(dev
->parser
);
382 static int usbredir_is_cancelled(USBRedirDevice
*dev
, uint64_t id
)
384 if (!dev
->dev
.attached
) {
385 return 1; /* Treat everything as cancelled after a disconnect */
387 return packet_id_queue_remove(&dev
->cancelled
, id
);
390 static void usbredir_fill_already_in_flight_from_ep(USBRedirDevice
*dev
,
391 struct USBEndpoint
*ep
)
395 /* async handled packets for bulk receiving eps do not count as inflight */
396 if (dev
->endpoint
[USBEP2I(ep
)].bulk_receiving_started
) {
400 QTAILQ_FOREACH(p
, &ep
->queue
, queue
) {
401 /* Skip combined packets, except for the first */
402 if (p
->combined
&& p
!= p
->combined
->first
) {
405 if (p
->state
== USB_PACKET_ASYNC
) {
406 packet_id_queue_add(&dev
->already_in_flight
, p
->id
);
411 static void usbredir_fill_already_in_flight(USBRedirDevice
*dev
)
414 struct USBDevice
*udev
= &dev
->dev
;
416 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_ctl
);
418 for (ep
= 0; ep
< USB_MAX_ENDPOINTS
; ep
++) {
419 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_in
[ep
]);
420 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_out
[ep
]);
424 static int usbredir_already_in_flight(USBRedirDevice
*dev
, uint64_t id
)
426 return packet_id_queue_remove(&dev
->already_in_flight
, id
);
429 static USBPacket
*usbredir_find_packet_by_id(USBRedirDevice
*dev
,
430 uint8_t ep
, uint64_t id
)
434 if (usbredir_is_cancelled(dev
, id
)) {
438 p
= usb_ep_find_packet_by_id(&dev
->dev
,
439 (ep
& USB_DIR_IN
) ? USB_TOKEN_IN
: USB_TOKEN_OUT
,
442 ERROR("could not find packet with id %"PRIu64
"\n", id
);
447 static void bufp_alloc(USBRedirDevice
*dev
, uint8_t *data
, uint16_t len
,
448 uint8_t status
, uint8_t ep
, void *free_on_destroy
)
450 struct buf_packet
*bufp
;
452 if (!dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
&&
453 dev
->endpoint
[EP2I(ep
)].bufpq_size
>
454 2 * dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
455 DPRINTF("bufpq overflow, dropping packets ep %02X\n", ep
);
456 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 1;
458 /* Since we're interupting the stream anyways, drop enough packets to get
459 back to our target buffer size */
460 if (dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
) {
461 if (dev
->endpoint
[EP2I(ep
)].bufpq_size
>
462 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
466 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
469 bufp
= g_malloc(sizeof(struct buf_packet
));
473 bufp
->status
= status
;
474 bufp
->free_on_destroy
= free_on_destroy
;
475 QTAILQ_INSERT_TAIL(&dev
->endpoint
[EP2I(ep
)].bufpq
, bufp
, next
);
476 dev
->endpoint
[EP2I(ep
)].bufpq_size
++;
479 static void bufp_free(USBRedirDevice
*dev
, struct buf_packet
*bufp
,
482 QTAILQ_REMOVE(&dev
->endpoint
[EP2I(ep
)].bufpq
, bufp
, next
);
483 dev
->endpoint
[EP2I(ep
)].bufpq_size
--;
484 free(bufp
->free_on_destroy
);
488 static void usbredir_free_bufpq(USBRedirDevice
*dev
, uint8_t ep
)
490 struct buf_packet
*buf
, *buf_next
;
492 QTAILQ_FOREACH_SAFE(buf
, &dev
->endpoint
[EP2I(ep
)].bufpq
, next
, buf_next
) {
493 bufp_free(dev
, buf
, ep
);
498 * USBDevice callbacks
501 static void usbredir_handle_reset(USBDevice
*udev
)
503 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
505 DPRINTF("reset device\n");
506 usbredirparser_send_reset(dev
->parser
);
507 usbredirparser_do_write(dev
->parser
);
510 static void usbredir_handle_iso_data(USBRedirDevice
*dev
, USBPacket
*p
,
514 if (!dev
->endpoint
[EP2I(ep
)].iso_started
&&
515 !dev
->endpoint
[EP2I(ep
)].iso_error
) {
516 struct usb_redir_start_iso_stream_header start_iso
= {
521 if (dev
->dev
.speed
== USB_SPEED_HIGH
) {
522 pkts_per_sec
= 8000 / dev
->endpoint
[EP2I(ep
)].interval
;
524 pkts_per_sec
= 1000 / dev
->endpoint
[EP2I(ep
)].interval
;
526 /* Testing has shown that we need circa 60 ms buffer */
527 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= (pkts_per_sec
* 60) / 1000;
529 /* Aim for approx 100 interrupts / second on the client to
530 balance latency and interrupt load */
531 start_iso
.pkts_per_urb
= pkts_per_sec
/ 100;
532 if (start_iso
.pkts_per_urb
< 1) {
533 start_iso
.pkts_per_urb
= 1;
534 } else if (start_iso
.pkts_per_urb
> 32) {
535 start_iso
.pkts_per_urb
= 32;
538 start_iso
.no_urbs
= (dev
->endpoint
[EP2I(ep
)].bufpq_target_size
+
539 start_iso
.pkts_per_urb
- 1) /
540 start_iso
.pkts_per_urb
;
541 /* Output endpoints pre-fill only 1/2 of the packets, keeping the rest
542 as overflow buffer. Also see the usbredir protocol documentation */
543 if (!(ep
& USB_DIR_IN
)) {
544 start_iso
.no_urbs
*= 2;
546 if (start_iso
.no_urbs
> 16) {
547 start_iso
.no_urbs
= 16;
550 /* No id, we look at the ep when receiving a status back */
551 usbredirparser_send_start_iso_stream(dev
->parser
, 0, &start_iso
);
552 usbredirparser_do_write(dev
->parser
);
553 DPRINTF("iso stream started pkts/sec %d pkts/urb %d urbs %d ep %02X\n",
554 pkts_per_sec
, start_iso
.pkts_per_urb
, start_iso
.no_urbs
, ep
);
555 dev
->endpoint
[EP2I(ep
)].iso_started
= 1;
556 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 0;
557 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
560 if (ep
& USB_DIR_IN
) {
561 struct buf_packet
*isop
;
563 if (dev
->endpoint
[EP2I(ep
)].iso_started
&&
564 !dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
) {
565 if (dev
->endpoint
[EP2I(ep
)].bufpq_size
<
566 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
569 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 1;
572 isop
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
);
574 DPRINTF("iso-token-in ep %02X, no isop, iso_error: %d\n",
575 ep
, dev
->endpoint
[EP2I(ep
)].iso_error
);
576 /* Re-fill the buffer */
577 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 0;
578 /* Check iso_error for stream errors, otherwise its an underrun */
579 status
= dev
->endpoint
[EP2I(ep
)].iso_error
;
580 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
581 p
->status
= status
? USB_RET_IOERROR
: USB_RET_SUCCESS
;
584 DPRINTF2("iso-token-in ep %02X status %d len %d queue-size: %d\n", ep
,
585 isop
->status
, isop
->len
, dev
->endpoint
[EP2I(ep
)].bufpq_size
);
587 status
= isop
->status
;
589 if (len
> p
->iov
.size
) {
590 ERROR("received iso data is larger then packet ep %02X (%d > %d)\n",
591 ep
, len
, (int)p
->iov
.size
);
593 status
= usb_redir_babble
;
595 usb_packet_copy(p
, isop
->data
, len
);
596 bufp_free(dev
, isop
, ep
);
597 usbredir_handle_status(dev
, p
, status
);
599 /* If the stream was not started because of a pending error don't
600 send the packet to the usb-host */
601 if (dev
->endpoint
[EP2I(ep
)].iso_started
) {
602 struct usb_redir_iso_packet_header iso_packet
= {
604 .length
= p
->iov
.size
606 uint8_t buf
[p
->iov
.size
];
607 /* No id, we look at the ep when receiving a status back */
608 usb_packet_copy(p
, buf
, p
->iov
.size
);
609 usbredirparser_send_iso_packet(dev
->parser
, 0, &iso_packet
,
611 usbredirparser_do_write(dev
->parser
);
613 status
= dev
->endpoint
[EP2I(ep
)].iso_error
;
614 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
615 DPRINTF2("iso-token-out ep %02X status %d len %zd\n", ep
, status
,
617 usbredir_handle_status(dev
, p
, status
);
621 static void usbredir_stop_iso_stream(USBRedirDevice
*dev
, uint8_t ep
)
623 struct usb_redir_stop_iso_stream_header stop_iso_stream
= {
626 if (dev
->endpoint
[EP2I(ep
)].iso_started
) {
627 usbredirparser_send_stop_iso_stream(dev
->parser
, 0, &stop_iso_stream
);
628 DPRINTF("iso stream stopped ep %02X\n", ep
);
629 dev
->endpoint
[EP2I(ep
)].iso_started
= 0;
631 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
632 usbredir_free_bufpq(dev
, ep
);
636 * The usb-host may poll the endpoint faster then our guest, resulting in lots
637 * of smaller bulkp-s. The below buffered_bulk_in_complete* functions combine
638 * data from multiple bulkp-s into a single packet, avoiding bufpq overflows.
640 static void usbredir_buffered_bulk_add_data_to_packet(USBRedirDevice
*dev
,
641 struct buf_packet
*bulkp
, int count
, USBPacket
*p
, uint8_t ep
)
643 usb_packet_copy(p
, bulkp
->data
+ bulkp
->offset
, count
);
644 bulkp
->offset
+= count
;
645 if (bulkp
->offset
== bulkp
->len
) {
646 /* Store status in the last packet with data from this bulkp */
647 usbredir_handle_status(dev
, p
, bulkp
->status
);
648 bufp_free(dev
, bulkp
, ep
);
652 static void usbredir_buffered_bulk_in_complete_raw(USBRedirDevice
*dev
,
653 USBPacket
*p
, uint8_t ep
)
655 struct buf_packet
*bulkp
;
658 while ((bulkp
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
)) &&
659 p
->actual_length
< p
->iov
.size
&& p
->status
== USB_RET_SUCCESS
) {
660 count
= bulkp
->len
- bulkp
->offset
;
661 if (count
> (p
->iov
.size
- p
->actual_length
)) {
662 count
= p
->iov
.size
- p
->actual_length
;
664 usbredir_buffered_bulk_add_data_to_packet(dev
, bulkp
, count
, p
, ep
);
668 static void usbredir_buffered_bulk_in_complete_ftdi(USBRedirDevice
*dev
,
669 USBPacket
*p
, uint8_t ep
)
671 const int maxp
= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
672 uint8_t header
[2] = { 0, 0 };
673 struct buf_packet
*bulkp
;
676 while ((bulkp
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
)) &&
677 p
->actual_length
< p
->iov
.size
&& p
->status
== USB_RET_SUCCESS
) {
678 if (bulkp
->len
< 2) {
679 WARNING("malformed ftdi bulk in packet\n");
680 bufp_free(dev
, bulkp
, ep
);
684 if ((p
->actual_length
% maxp
) == 0) {
685 usb_packet_copy(p
, bulkp
->data
, 2);
686 memcpy(header
, bulkp
->data
, 2);
688 if (bulkp
->data
[0] != header
[0] || bulkp
->data
[1] != header
[1]) {
689 break; /* Different header, add to next packet */
693 if (bulkp
->offset
== 0) {
694 bulkp
->offset
= 2; /* Skip header */
696 count
= bulkp
->len
- bulkp
->offset
;
697 /* Must repeat the header at maxp interval */
698 if (count
> (maxp
- (p
->actual_length
% maxp
))) {
699 count
= maxp
- (p
->actual_length
% maxp
);
701 usbredir_buffered_bulk_add_data_to_packet(dev
, bulkp
, count
, p
, ep
);
705 static void usbredir_buffered_bulk_in_complete(USBRedirDevice
*dev
,
706 USBPacket
*p
, uint8_t ep
)
708 p
->status
= USB_RET_SUCCESS
; /* Clear previous ASYNC status */
709 dev
->buffered_bulk_in_complete(dev
, p
, ep
);
710 DPRINTF("bulk-token-in ep %02X status %d len %d id %"PRIu64
"\n",
711 ep
, p
->status
, p
->actual_length
, p
->id
);
714 static void usbredir_handle_buffered_bulk_in_data(USBRedirDevice
*dev
,
715 USBPacket
*p
, uint8_t ep
)
717 /* Input bulk endpoint, buffered packet input */
718 if (!dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
) {
720 struct usb_redir_start_bulk_receiving_header start
= {
725 /* Round bytes_per_transfer up to a multiple of max_packet_size */
726 bpt
= 512 + dev
->endpoint
[EP2I(ep
)].max_packet_size
- 1;
727 bpt
/= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
728 bpt
*= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
729 start
.bytes_per_transfer
= bpt
;
730 /* No id, we look at the ep when receiving a status back */
731 usbredirparser_send_start_bulk_receiving(dev
->parser
, 0, &start
);
732 usbredirparser_do_write(dev
->parser
);
733 DPRINTF("bulk receiving started bytes/transfer %u count %d ep %02X\n",
734 start
.bytes_per_transfer
, start
.no_transfers
, ep
);
735 dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
= 1;
736 /* We don't really want to drop bulk packets ever, but
737 having some upper limit to how much we buffer is good. */
738 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= 5000;
739 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
742 if (QTAILQ_EMPTY(&dev
->endpoint
[EP2I(ep
)].bufpq
)) {
743 DPRINTF("bulk-token-in ep %02X, no bulkp\n", ep
);
744 assert(dev
->endpoint
[EP2I(ep
)].pending_async_packet
== NULL
);
745 dev
->endpoint
[EP2I(ep
)].pending_async_packet
= p
;
746 p
->status
= USB_RET_ASYNC
;
749 usbredir_buffered_bulk_in_complete(dev
, p
, ep
);
752 static void usbredir_stop_bulk_receiving(USBRedirDevice
*dev
, uint8_t ep
)
754 struct usb_redir_stop_bulk_receiving_header stop_bulk
= {
758 if (dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
) {
759 usbredirparser_send_stop_bulk_receiving(dev
->parser
, 0, &stop_bulk
);
760 DPRINTF("bulk receiving stopped ep %02X\n", ep
);
761 dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
= 0;
763 usbredir_free_bufpq(dev
, ep
);
766 static void usbredir_handle_bulk_data(USBRedirDevice
*dev
, USBPacket
*p
,
769 struct usb_redir_bulk_packet_header bulk_packet
;
770 size_t size
= usb_packet_size(p
);
771 const int maxp
= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
773 if (usbredir_already_in_flight(dev
, p
->id
)) {
774 p
->status
= USB_RET_ASYNC
;
778 if (dev
->endpoint
[EP2I(ep
)].bulk_receiving_enabled
) {
779 if (size
!= 0 && (size
% maxp
) == 0) {
780 usbredir_handle_buffered_bulk_in_data(dev
, p
, ep
);
783 WARNING("bulk recv invalid size %zd ep %02x, disabling\n", size
, ep
);
784 assert(dev
->endpoint
[EP2I(ep
)].pending_async_packet
== NULL
);
785 usbredir_stop_bulk_receiving(dev
, ep
);
786 dev
->endpoint
[EP2I(ep
)].bulk_receiving_enabled
= 0;
789 DPRINTF("bulk-out ep %02X stream %u len %zd id %"PRIu64
"\n",
790 ep
, p
->stream
, size
, p
->id
);
792 bulk_packet
.endpoint
= ep
;
793 bulk_packet
.length
= size
;
794 bulk_packet
.stream_id
= p
->stream
;
795 bulk_packet
.length_high
= size
>> 16;
796 assert(bulk_packet
.length_high
== 0 ||
797 usbredirparser_peer_has_cap(dev
->parser
,
798 usb_redir_cap_32bits_bulk_length
));
800 if (ep
& USB_DIR_IN
) {
801 usbredirparser_send_bulk_packet(dev
->parser
, p
->id
,
802 &bulk_packet
, NULL
, 0);
805 usb_packet_copy(p
, buf
, size
);
806 usbredir_log_data(dev
, "bulk data out:", buf
, size
);
807 usbredirparser_send_bulk_packet(dev
->parser
, p
->id
,
808 &bulk_packet
, buf
, size
);
810 usbredirparser_do_write(dev
->parser
);
811 p
->status
= USB_RET_ASYNC
;
814 static void usbredir_handle_interrupt_in_data(USBRedirDevice
*dev
,
815 USBPacket
*p
, uint8_t ep
)
817 /* Input interrupt endpoint, buffered packet input */
818 struct buf_packet
*intp
;
821 if (!dev
->endpoint
[EP2I(ep
)].interrupt_started
&&
822 !dev
->endpoint
[EP2I(ep
)].interrupt_error
) {
823 struct usb_redir_start_interrupt_receiving_header start_int
= {
826 /* No id, we look at the ep when receiving a status back */
827 usbredirparser_send_start_interrupt_receiving(dev
->parser
, 0,
829 usbredirparser_do_write(dev
->parser
);
830 DPRINTF("interrupt recv started ep %02X\n", ep
);
831 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 1;
832 /* We don't really want to drop interrupt packets ever, but
833 having some upper limit to how much we buffer is good. */
834 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= 1000;
835 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
838 intp
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
);
840 DPRINTF2("interrupt-token-in ep %02X, no intp\n", ep
);
841 /* Check interrupt_error for stream errors */
842 status
= dev
->endpoint
[EP2I(ep
)].interrupt_error
;
843 dev
->endpoint
[EP2I(ep
)].interrupt_error
= 0;
845 usbredir_handle_status(dev
, p
, status
);
847 p
->status
= USB_RET_NAK
;
851 DPRINTF("interrupt-token-in ep %02X status %d len %d\n", ep
,
852 intp
->status
, intp
->len
);
854 status
= intp
->status
;
856 if (len
> p
->iov
.size
) {
857 ERROR("received int data is larger then packet ep %02X\n", ep
);
859 status
= usb_redir_babble
;
861 usb_packet_copy(p
, intp
->data
, len
);
862 bufp_free(dev
, intp
, ep
);
863 usbredir_handle_status(dev
, p
, status
);
867 * Handle interrupt out data, the usbredir protocol expects us to do this
868 * async, so that it can report back a completion status. But guests will
869 * expect immediate completion for an interrupt endpoint, and handling this
870 * async causes migration issues. So we report success directly, counting
871 * on the fact that output interrupt packets normally always succeed.
873 static void usbredir_handle_interrupt_out_data(USBRedirDevice
*dev
,
874 USBPacket
*p
, uint8_t ep
)
876 struct usb_redir_interrupt_packet_header interrupt_packet
;
877 uint8_t buf
[p
->iov
.size
];
879 DPRINTF("interrupt-out ep %02X len %zd id %"PRIu64
"\n", ep
,
882 interrupt_packet
.endpoint
= ep
;
883 interrupt_packet
.length
= p
->iov
.size
;
885 usb_packet_copy(p
, buf
, p
->iov
.size
);
886 usbredir_log_data(dev
, "interrupt data out:", buf
, p
->iov
.size
);
887 usbredirparser_send_interrupt_packet(dev
->parser
, p
->id
,
888 &interrupt_packet
, buf
, p
->iov
.size
);
889 usbredirparser_do_write(dev
->parser
);
892 static void usbredir_stop_interrupt_receiving(USBRedirDevice
*dev
,
895 struct usb_redir_stop_interrupt_receiving_header stop_interrupt_recv
= {
898 if (dev
->endpoint
[EP2I(ep
)].interrupt_started
) {
899 usbredirparser_send_stop_interrupt_receiving(dev
->parser
, 0,
900 &stop_interrupt_recv
);
901 DPRINTF("interrupt recv stopped ep %02X\n", ep
);
902 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 0;
904 dev
->endpoint
[EP2I(ep
)].interrupt_error
= 0;
905 usbredir_free_bufpq(dev
, ep
);
908 static void usbredir_handle_data(USBDevice
*udev
, USBPacket
*p
)
910 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
914 if (p
->pid
== USB_TOKEN_IN
) {
918 switch (dev
->endpoint
[EP2I(ep
)].type
) {
919 case USB_ENDPOINT_XFER_CONTROL
:
920 ERROR("handle_data called for control transfer on ep %02X\n", ep
);
921 p
->status
= USB_RET_NAK
;
923 case USB_ENDPOINT_XFER_BULK
:
924 if (p
->state
== USB_PACKET_SETUP
&& p
->pid
== USB_TOKEN_IN
&&
926 p
->status
= USB_RET_ADD_TO_QUEUE
;
929 usbredir_handle_bulk_data(dev
, p
, ep
);
931 case USB_ENDPOINT_XFER_ISOC
:
932 usbredir_handle_iso_data(dev
, p
, ep
);
934 case USB_ENDPOINT_XFER_INT
:
935 if (ep
& USB_DIR_IN
) {
936 usbredir_handle_interrupt_in_data(dev
, p
, ep
);
938 usbredir_handle_interrupt_out_data(dev
, p
, ep
);
942 ERROR("handle_data ep %02X has unknown type %d\n", ep
,
943 dev
->endpoint
[EP2I(ep
)].type
);
944 p
->status
= USB_RET_NAK
;
948 static void usbredir_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
)
950 if (ep
->pid
== USB_TOKEN_IN
&& ep
->pipeline
) {
951 usb_ep_combine_input_packets(ep
);
955 static void usbredir_stop_ep(USBRedirDevice
*dev
, int i
)
957 uint8_t ep
= I2EP(i
);
959 switch (dev
->endpoint
[i
].type
) {
960 case USB_ENDPOINT_XFER_BULK
:
961 if (ep
& USB_DIR_IN
) {
962 usbredir_stop_bulk_receiving(dev
, ep
);
965 case USB_ENDPOINT_XFER_ISOC
:
966 usbredir_stop_iso_stream(dev
, ep
);
968 case USB_ENDPOINT_XFER_INT
:
969 if (ep
& USB_DIR_IN
) {
970 usbredir_stop_interrupt_receiving(dev
, ep
);
974 usbredir_free_bufpq(dev
, ep
);
977 static void usbredir_ep_stopped(USBDevice
*udev
, USBEndpoint
*uep
)
979 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
981 usbredir_stop_ep(dev
, USBEP2I(uep
));
982 usbredirparser_do_write(dev
->parser
);
985 static void usbredir_set_config(USBRedirDevice
*dev
, USBPacket
*p
,
988 struct usb_redir_set_configuration_header set_config
;
991 DPRINTF("set config %d id %"PRIu64
"\n", config
, p
->id
);
993 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
994 usbredir_stop_ep(dev
, i
);
997 set_config
.configuration
= config
;
998 usbredirparser_send_set_configuration(dev
->parser
, p
->id
, &set_config
);
999 usbredirparser_do_write(dev
->parser
);
1000 p
->status
= USB_RET_ASYNC
;
1003 static void usbredir_get_config(USBRedirDevice
*dev
, USBPacket
*p
)
1005 DPRINTF("get config id %"PRIu64
"\n", p
->id
);
1007 usbredirparser_send_get_configuration(dev
->parser
, p
->id
);
1008 usbredirparser_do_write(dev
->parser
);
1009 p
->status
= USB_RET_ASYNC
;
1012 static void usbredir_set_interface(USBRedirDevice
*dev
, USBPacket
*p
,
1013 int interface
, int alt
)
1015 struct usb_redir_set_alt_setting_header set_alt
;
1018 DPRINTF("set interface %d alt %d id %"PRIu64
"\n", interface
, alt
, p
->id
);
1020 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1021 if (dev
->endpoint
[i
].interface
== interface
) {
1022 usbredir_stop_ep(dev
, i
);
1026 set_alt
.interface
= interface
;
1028 usbredirparser_send_set_alt_setting(dev
->parser
, p
->id
, &set_alt
);
1029 usbredirparser_do_write(dev
->parser
);
1030 p
->status
= USB_RET_ASYNC
;
1033 static void usbredir_get_interface(USBRedirDevice
*dev
, USBPacket
*p
,
1036 struct usb_redir_get_alt_setting_header get_alt
;
1038 DPRINTF("get interface %d id %"PRIu64
"\n", interface
, p
->id
);
1040 get_alt
.interface
= interface
;
1041 usbredirparser_send_get_alt_setting(dev
->parser
, p
->id
, &get_alt
);
1042 usbredirparser_do_write(dev
->parser
);
1043 p
->status
= USB_RET_ASYNC
;
1046 static void usbredir_handle_control(USBDevice
*udev
, USBPacket
*p
,
1047 int request
, int value
, int index
, int length
, uint8_t *data
)
1049 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
1050 struct usb_redir_control_packet_header control_packet
;
1052 if (usbredir_already_in_flight(dev
, p
->id
)) {
1053 p
->status
= USB_RET_ASYNC
;
1057 /* Special cases for certain standard device requests */
1059 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
1060 DPRINTF("set address %d\n", value
);
1061 dev
->dev
.addr
= value
;
1063 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
1064 usbredir_set_config(dev
, p
, value
& 0xff);
1066 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
1067 usbredir_get_config(dev
, p
);
1069 case InterfaceOutRequest
| USB_REQ_SET_INTERFACE
:
1070 usbredir_set_interface(dev
, p
, index
, value
);
1072 case InterfaceRequest
| USB_REQ_GET_INTERFACE
:
1073 usbredir_get_interface(dev
, p
, index
);
1077 /* Normal ctrl requests, note request is (bRequestType << 8) | bRequest */
1079 "ctrl-out type 0x%x req 0x%x val 0x%x index %d len %d id %"PRIu64
"\n",
1080 request
>> 8, request
& 0xff, value
, index
, length
, p
->id
);
1082 control_packet
.request
= request
& 0xFF;
1083 control_packet
.requesttype
= request
>> 8;
1084 control_packet
.endpoint
= control_packet
.requesttype
& USB_DIR_IN
;
1085 control_packet
.value
= value
;
1086 control_packet
.index
= index
;
1087 control_packet
.length
= length
;
1089 if (control_packet
.requesttype
& USB_DIR_IN
) {
1090 usbredirparser_send_control_packet(dev
->parser
, p
->id
,
1091 &control_packet
, NULL
, 0);
1093 usbredir_log_data(dev
, "ctrl data out:", data
, length
);
1094 usbredirparser_send_control_packet(dev
->parser
, p
->id
,
1095 &control_packet
, data
, length
);
1097 usbredirparser_do_write(dev
->parser
);
1098 p
->status
= USB_RET_ASYNC
;
1101 static int usbredir_alloc_streams(USBDevice
*udev
, USBEndpoint
**eps
,
1102 int nr_eps
, int streams
)
1104 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
1105 #if USBREDIR_VERSION >= 0x000700
1106 struct usb_redir_alloc_bulk_streams_header alloc_streams
;
1109 if (!usbredirparser_peer_has_cap(dev
->parser
,
1110 usb_redir_cap_bulk_streams
)) {
1111 ERROR("peer does not support streams\n");
1116 ERROR("request to allocate 0 streams\n");
1120 alloc_streams
.no_streams
= streams
;
1121 alloc_streams
.endpoints
= 0;
1122 for (i
= 0; i
< nr_eps
; i
++) {
1123 alloc_streams
.endpoints
|= 1 << USBEP2I(eps
[i
]);
1125 usbredirparser_send_alloc_bulk_streams(dev
->parser
, 0, &alloc_streams
);
1126 usbredirparser_do_write(dev
->parser
);
1130 ERROR("usbredir_alloc_streams not implemented\n");
1134 ERROR("streams are not available, disconnecting\n");
1135 qemu_bh_schedule(dev
->device_reject_bh
);
1139 static void usbredir_free_streams(USBDevice
*udev
, USBEndpoint
**eps
,
1142 #if USBREDIR_VERSION >= 0x000700
1143 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
1144 struct usb_redir_free_bulk_streams_header free_streams
;
1147 if (!usbredirparser_peer_has_cap(dev
->parser
,
1148 usb_redir_cap_bulk_streams
)) {
1152 free_streams
.endpoints
= 0;
1153 for (i
= 0; i
< nr_eps
; i
++) {
1154 free_streams
.endpoints
|= 1 << USBEP2I(eps
[i
]);
1156 usbredirparser_send_free_bulk_streams(dev
->parser
, 0, &free_streams
);
1157 usbredirparser_do_write(dev
->parser
);
1162 * Close events can be triggered by usbredirparser_do_write which gets called
1163 * from within the USBDevice data / control packet callbacks and doing a
1164 * usb_detach from within these callbacks is not a good idea.
1166 * So we use a bh handler to take care of close events.
1168 static void usbredir_chardev_close_bh(void *opaque
)
1170 USBRedirDevice
*dev
= opaque
;
1172 qemu_bh_cancel(dev
->device_reject_bh
);
1173 usbredir_device_disconnect(dev
);
1176 DPRINTF("destroying usbredirparser\n");
1177 usbredirparser_destroy(dev
->parser
);
1181 g_source_remove(dev
->watch
);
1186 static void usbredir_create_parser(USBRedirDevice
*dev
)
1188 uint32_t caps
[USB_REDIR_CAPS_SIZE
] = { 0, };
1191 DPRINTF("creating usbredirparser\n");
1193 dev
->parser
= qemu_oom_check(usbredirparser_create());
1194 dev
->parser
->priv
= dev
;
1195 dev
->parser
->log_func
= usbredir_log
;
1196 dev
->parser
->read_func
= usbredir_read
;
1197 dev
->parser
->write_func
= usbredir_write
;
1198 dev
->parser
->hello_func
= usbredir_hello
;
1199 dev
->parser
->device_connect_func
= usbredir_device_connect
;
1200 dev
->parser
->device_disconnect_func
= usbredir_device_disconnect
;
1201 dev
->parser
->interface_info_func
= usbredir_interface_info
;
1202 dev
->parser
->ep_info_func
= usbredir_ep_info
;
1203 dev
->parser
->configuration_status_func
= usbredir_configuration_status
;
1204 dev
->parser
->alt_setting_status_func
= usbredir_alt_setting_status
;
1205 dev
->parser
->iso_stream_status_func
= usbredir_iso_stream_status
;
1206 dev
->parser
->interrupt_receiving_status_func
=
1207 usbredir_interrupt_receiving_status
;
1208 dev
->parser
->bulk_streams_status_func
= usbredir_bulk_streams_status
;
1209 dev
->parser
->bulk_receiving_status_func
= usbredir_bulk_receiving_status
;
1210 dev
->parser
->control_packet_func
= usbredir_control_packet
;
1211 dev
->parser
->bulk_packet_func
= usbredir_bulk_packet
;
1212 dev
->parser
->iso_packet_func
= usbredir_iso_packet
;
1213 dev
->parser
->interrupt_packet_func
= usbredir_interrupt_packet
;
1214 dev
->parser
->buffered_bulk_packet_func
= usbredir_buffered_bulk_packet
;
1215 dev
->read_buf
= NULL
;
1216 dev
->read_buf_size
= 0;
1218 usbredirparser_caps_set_cap(caps
, usb_redir_cap_connect_device_version
);
1219 usbredirparser_caps_set_cap(caps
, usb_redir_cap_filter
);
1220 usbredirparser_caps_set_cap(caps
, usb_redir_cap_ep_info_max_packet_size
);
1221 usbredirparser_caps_set_cap(caps
, usb_redir_cap_64bits_ids
);
1222 usbredirparser_caps_set_cap(caps
, usb_redir_cap_32bits_bulk_length
);
1223 usbredirparser_caps_set_cap(caps
, usb_redir_cap_bulk_receiving
);
1224 #if USBREDIR_VERSION >= 0x000700
1225 usbredirparser_caps_set_cap(caps
, usb_redir_cap_bulk_streams
);
1228 if (runstate_check(RUN_STATE_INMIGRATE
)) {
1229 flags
|= usbredirparser_fl_no_hello
;
1231 usbredirparser_init(dev
->parser
, VERSION
, caps
, USB_REDIR_CAPS_SIZE
,
1233 usbredirparser_do_write(dev
->parser
);
1236 static void usbredir_reject_device(USBRedirDevice
*dev
)
1238 usbredir_device_disconnect(dev
);
1239 if (usbredirparser_peer_has_cap(dev
->parser
, usb_redir_cap_filter
)) {
1240 usbredirparser_send_filter_reject(dev
->parser
);
1241 usbredirparser_do_write(dev
->parser
);
1246 * We may need to reject the device when the hcd calls alloc_streams, doing
1247 * an usb_detach from within a hcd call is not a good idea, hence this bh.
1249 static void usbredir_device_reject_bh(void *opaque
)
1251 USBRedirDevice
*dev
= opaque
;
1253 usbredir_reject_device(dev
);
1256 static void usbredir_do_attach(void *opaque
)
1258 USBRedirDevice
*dev
= opaque
;
1259 Error
*local_err
= NULL
;
1261 /* In order to work properly with XHCI controllers we need these caps */
1262 if ((dev
->dev
.port
->speedmask
& USB_SPEED_MASK_SUPER
) && !(
1263 usbredirparser_peer_has_cap(dev
->parser
,
1264 usb_redir_cap_ep_info_max_packet_size
) &&
1265 usbredirparser_peer_has_cap(dev
->parser
,
1266 usb_redir_cap_32bits_bulk_length
) &&
1267 usbredirparser_peer_has_cap(dev
->parser
,
1268 usb_redir_cap_64bits_ids
))) {
1269 ERROR("usb-redir-host lacks capabilities needed for use with XHCI\n");
1270 usbredir_reject_device(dev
);
1274 usb_device_attach(&dev
->dev
, &local_err
);
1276 error_report("%s", error_get_pretty(local_err
));
1277 error_free(local_err
);
1278 WARNING("rejecting device due to speed mismatch\n");
1279 usbredir_reject_device(dev
);
1287 static int usbredir_chardev_can_read(void *opaque
)
1289 USBRedirDevice
*dev
= opaque
;
1292 WARNING("chardev_can_read called on non open chardev!\n");
1296 /* Don't read new data from the chardev until our state is fully synced */
1297 if (!runstate_check(RUN_STATE_RUNNING
)) {
1301 /* usbredir_parser_do_read will consume *all* data we give it */
1305 static void usbredir_chardev_read(void *opaque
, const uint8_t *buf
, int size
)
1307 USBRedirDevice
*dev
= opaque
;
1309 /* No recursion allowed! */
1310 assert(dev
->read_buf
== NULL
);
1312 dev
->read_buf
= buf
;
1313 dev
->read_buf_size
= size
;
1315 usbredirparser_do_read(dev
->parser
);
1316 /* Send any acks, etc. which may be queued now */
1317 usbredirparser_do_write(dev
->parser
);
1320 static void usbredir_chardev_event(void *opaque
, int event
)
1322 USBRedirDevice
*dev
= opaque
;
1325 case CHR_EVENT_OPENED
:
1326 DPRINTF("chardev open\n");
1327 /* Make sure any pending closes are handled (no-op if none pending) */
1328 usbredir_chardev_close_bh(dev
);
1329 qemu_bh_cancel(dev
->chardev_close_bh
);
1330 usbredir_create_parser(dev
);
1332 case CHR_EVENT_CLOSED
:
1333 DPRINTF("chardev close\n");
1334 qemu_bh_schedule(dev
->chardev_close_bh
);
1343 static void usbredir_vm_state_change(void *priv
, int running
, RunState state
)
1345 USBRedirDevice
*dev
= priv
;
1347 if (state
== RUN_STATE_RUNNING
&& dev
->parser
!= NULL
) {
1348 usbredirparser_do_write(dev
->parser
); /* Flush any pending writes */
1352 static void usbredir_init_endpoints(USBRedirDevice
*dev
)
1356 usb_ep_init(&dev
->dev
);
1357 memset(dev
->endpoint
, 0, sizeof(dev
->endpoint
));
1358 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1359 dev
->endpoint
[i
].dev
= dev
;
1360 QTAILQ_INIT(&dev
->endpoint
[i
].bufpq
);
1364 static void usbredir_realize(USBDevice
*udev
, Error
**errp
)
1366 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
1369 if (dev
->cs
== NULL
) {
1370 error_set(errp
, QERR_MISSING_PARAMETER
, "chardev");
1374 if (dev
->filter_str
) {
1375 i
= usbredirfilter_string_to_rules(dev
->filter_str
, ":", "|",
1377 &dev
->filter_rules_count
);
1379 error_set(errp
, QERR_INVALID_PARAMETER_VALUE
, "filter",
1380 "a usb device filter string");
1385 dev
->chardev_close_bh
= qemu_bh_new(usbredir_chardev_close_bh
, dev
);
1386 dev
->device_reject_bh
= qemu_bh_new(usbredir_device_reject_bh
, dev
);
1387 dev
->attach_timer
= timer_new_ms(QEMU_CLOCK_VIRTUAL
, usbredir_do_attach
, dev
);
1389 packet_id_queue_init(&dev
->cancelled
, dev
, "cancelled");
1390 packet_id_queue_init(&dev
->already_in_flight
, dev
, "already-in-flight");
1391 usbredir_init_endpoints(dev
);
1393 /* We'll do the attach once we receive the speed from the usb-host */
1394 udev
->auto_attach
= 0;
1396 /* Will be cleared during setup when we find conflicts */
1397 dev
->compatible_speedmask
= USB_SPEED_MASK_FULL
| USB_SPEED_MASK_HIGH
;
1399 /* Let the backend know we are ready */
1400 qemu_chr_add_handlers(dev
->cs
, usbredir_chardev_can_read
,
1401 usbredir_chardev_read
, usbredir_chardev_event
, dev
);
1403 qemu_add_vm_change_state_handler(usbredir_vm_state_change
, dev
);
1404 add_boot_device_path(dev
->bootindex
, &udev
->qdev
, NULL
);
1407 static void usbredir_cleanup_device_queues(USBRedirDevice
*dev
)
1411 packet_id_queue_empty(&dev
->cancelled
);
1412 packet_id_queue_empty(&dev
->already_in_flight
);
1413 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1414 usbredir_free_bufpq(dev
, I2EP(i
));
1418 static void usbredir_handle_destroy(USBDevice
*udev
)
1420 USBRedirDevice
*dev
= DO_UPCAST(USBRedirDevice
, dev
, udev
);
1422 qemu_chr_delete(dev
->cs
);
1424 /* Note must be done after qemu_chr_close, as that causes a close event */
1425 qemu_bh_delete(dev
->chardev_close_bh
);
1426 qemu_bh_delete(dev
->device_reject_bh
);
1428 timer_del(dev
->attach_timer
);
1429 timer_free(dev
->attach_timer
);
1431 usbredir_cleanup_device_queues(dev
);
1434 usbredirparser_destroy(dev
->parser
);
1437 g_source_remove(dev
->watch
);
1440 free(dev
->filter_rules
);
1443 static int usbredir_check_filter(USBRedirDevice
*dev
)
1445 if (dev
->interface_info
.interface_count
== NO_INTERFACE_INFO
) {
1446 ERROR("No interface info for device\n");
1450 if (dev
->filter_rules
) {
1451 if (!usbredirparser_peer_has_cap(dev
->parser
,
1452 usb_redir_cap_connect_device_version
)) {
1453 ERROR("Device filter specified and peer does not have the "
1454 "connect_device_version capability\n");
1458 if (usbredirfilter_check(
1460 dev
->filter_rules_count
,
1461 dev
->device_info
.device_class
,
1462 dev
->device_info
.device_subclass
,
1463 dev
->device_info
.device_protocol
,
1464 dev
->interface_info
.interface_class
,
1465 dev
->interface_info
.interface_subclass
,
1466 dev
->interface_info
.interface_protocol
,
1467 dev
->interface_info
.interface_count
,
1468 dev
->device_info
.vendor_id
,
1469 dev
->device_info
.product_id
,
1470 dev
->device_info
.device_version_bcd
,
1479 usbredir_reject_device(dev
);
1483 static void usbredir_check_bulk_receiving(USBRedirDevice
*dev
)
1487 if (!usbredirparser_peer_has_cap(dev
->parser
,
1488 usb_redir_cap_bulk_receiving
)) {
1492 for (i
= EP2I(USB_DIR_IN
); i
< MAX_ENDPOINTS
; i
++) {
1493 dev
->endpoint
[i
].bulk_receiving_enabled
= 0;
1495 for (i
= 0; i
< dev
->interface_info
.interface_count
; i
++) {
1496 quirks
= usb_get_quirks(dev
->device_info
.vendor_id
,
1497 dev
->device_info
.product_id
,
1498 dev
->interface_info
.interface_class
[i
],
1499 dev
->interface_info
.interface_subclass
[i
],
1500 dev
->interface_info
.interface_protocol
[i
]);
1501 if (!(quirks
& USB_QUIRK_BUFFER_BULK_IN
)) {
1504 if (quirks
& USB_QUIRK_IS_FTDI
) {
1505 dev
->buffered_bulk_in_complete
=
1506 usbredir_buffered_bulk_in_complete_ftdi
;
1508 dev
->buffered_bulk_in_complete
=
1509 usbredir_buffered_bulk_in_complete_raw
;
1512 for (j
= EP2I(USB_DIR_IN
); j
< MAX_ENDPOINTS
; j
++) {
1513 if (dev
->endpoint
[j
].interface
==
1514 dev
->interface_info
.interface
[i
] &&
1515 dev
->endpoint
[j
].type
== USB_ENDPOINT_XFER_BULK
&&
1516 dev
->endpoint
[j
].max_packet_size
!= 0) {
1517 dev
->endpoint
[j
].bulk_receiving_enabled
= 1;
1519 * With buffering pipelining is not necessary. Also packet
1520 * combining and bulk in buffering don't play nice together!
1522 I2USBEP(dev
, j
)->pipeline
= false;
1523 break; /* Only buffer for the first ep of each intf */
1530 * usbredirparser packet complete callbacks
1533 static void usbredir_handle_status(USBRedirDevice
*dev
, USBPacket
*p
,
1537 case usb_redir_success
:
1538 p
->status
= USB_RET_SUCCESS
; /* Clear previous ASYNC status */
1540 case usb_redir_stall
:
1541 p
->status
= USB_RET_STALL
;
1543 case usb_redir_cancelled
:
1545 * When the usbredir-host unredirects a device, it will report a status
1546 * of cancelled for all pending packets, followed by a disconnect msg.
1548 p
->status
= USB_RET_IOERROR
;
1550 case usb_redir_inval
:
1551 WARNING("got invalid param error from usb-host?\n");
1552 p
->status
= USB_RET_IOERROR
;
1554 case usb_redir_babble
:
1555 p
->status
= USB_RET_BABBLE
;
1557 case usb_redir_ioerror
:
1558 case usb_redir_timeout
:
1560 p
->status
= USB_RET_IOERROR
;
1564 static void usbredir_hello(void *priv
, struct usb_redir_hello_header
*h
)
1566 USBRedirDevice
*dev
= priv
;
1568 /* Try to send the filter info now that we've the usb-host's caps */
1569 if (usbredirparser_peer_has_cap(dev
->parser
, usb_redir_cap_filter
) &&
1570 dev
->filter_rules
) {
1571 usbredirparser_send_filter_filter(dev
->parser
, dev
->filter_rules
,
1572 dev
->filter_rules_count
);
1573 usbredirparser_do_write(dev
->parser
);
1577 static void usbredir_device_connect(void *priv
,
1578 struct usb_redir_device_connect_header
*device_connect
)
1580 USBRedirDevice
*dev
= priv
;
1583 if (timer_pending(dev
->attach_timer
) || dev
->dev
.attached
) {
1584 ERROR("Received device connect while already connected\n");
1588 switch (device_connect
->speed
) {
1589 case usb_redir_speed_low
:
1590 speed
= "low speed";
1591 dev
->dev
.speed
= USB_SPEED_LOW
;
1592 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_FULL
;
1593 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_HIGH
;
1595 case usb_redir_speed_full
:
1596 speed
= "full speed";
1597 dev
->dev
.speed
= USB_SPEED_FULL
;
1598 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_HIGH
;
1600 case usb_redir_speed_high
:
1601 speed
= "high speed";
1602 dev
->dev
.speed
= USB_SPEED_HIGH
;
1604 case usb_redir_speed_super
:
1605 speed
= "super speed";
1606 dev
->dev
.speed
= USB_SPEED_SUPER
;
1609 speed
= "unknown speed";
1610 dev
->dev
.speed
= USB_SPEED_FULL
;
1613 if (usbredirparser_peer_has_cap(dev
->parser
,
1614 usb_redir_cap_connect_device_version
)) {
1615 INFO("attaching %s device %04x:%04x version %d.%d class %02x\n",
1616 speed
, device_connect
->vendor_id
, device_connect
->product_id
,
1617 ((device_connect
->device_version_bcd
& 0xf000) >> 12) * 10 +
1618 ((device_connect
->device_version_bcd
& 0x0f00) >> 8),
1619 ((device_connect
->device_version_bcd
& 0x00f0) >> 4) * 10 +
1620 ((device_connect
->device_version_bcd
& 0x000f) >> 0),
1621 device_connect
->device_class
);
1623 INFO("attaching %s device %04x:%04x class %02x\n", speed
,
1624 device_connect
->vendor_id
, device_connect
->product_id
,
1625 device_connect
->device_class
);
1628 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
) | dev
->compatible_speedmask
;
1629 dev
->device_info
= *device_connect
;
1631 if (usbredir_check_filter(dev
)) {
1632 WARNING("Device %04x:%04x rejected by device filter, not attaching\n",
1633 device_connect
->vendor_id
, device_connect
->product_id
);
1637 usbredir_check_bulk_receiving(dev
);
1638 timer_mod(dev
->attach_timer
, dev
->next_attach_time
);
1641 static void usbredir_device_disconnect(void *priv
)
1643 USBRedirDevice
*dev
= priv
;
1645 /* Stop any pending attaches */
1646 timer_del(dev
->attach_timer
);
1648 if (dev
->dev
.attached
) {
1649 DPRINTF("detaching device\n");
1650 usb_device_detach(&dev
->dev
);
1652 * Delay next usb device attach to give the guest a chance to see
1653 * see the detach / attach in case of quick close / open succession
1655 dev
->next_attach_time
= qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL
) + 200;
1658 /* Reset state so that the next dev connected starts with a clean slate */
1659 usbredir_cleanup_device_queues(dev
);
1660 usbredir_init_endpoints(dev
);
1661 dev
->interface_info
.interface_count
= NO_INTERFACE_INFO
;
1664 dev
->compatible_speedmask
= USB_SPEED_MASK_FULL
| USB_SPEED_MASK_HIGH
;
1667 static void usbredir_interface_info(void *priv
,
1668 struct usb_redir_interface_info_header
*interface_info
)
1670 USBRedirDevice
*dev
= priv
;
1672 dev
->interface_info
= *interface_info
;
1675 * If we receive interface info after the device has already been
1676 * connected (ie on a set_config), re-check interface dependent things.
1678 if (timer_pending(dev
->attach_timer
) || dev
->dev
.attached
) {
1679 usbredir_check_bulk_receiving(dev
);
1680 if (usbredir_check_filter(dev
)) {
1681 ERROR("Device no longer matches filter after interface info "
1682 "change, disconnecting!\n");
1687 static void usbredir_mark_speed_incompatible(USBRedirDevice
*dev
, int speed
)
1689 dev
->compatible_speedmask
&= ~(1 << speed
);
1690 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
) | dev
->compatible_speedmask
;
1693 static void usbredir_set_pipeline(USBRedirDevice
*dev
, struct USBEndpoint
*uep
)
1695 if (uep
->type
!= USB_ENDPOINT_XFER_BULK
) {
1698 if (uep
->pid
== USB_TOKEN_OUT
) {
1699 uep
->pipeline
= true;
1701 if (uep
->pid
== USB_TOKEN_IN
&& uep
->max_packet_size
!= 0 &&
1702 usbredirparser_peer_has_cap(dev
->parser
,
1703 usb_redir_cap_32bits_bulk_length
)) {
1704 uep
->pipeline
= true;
1708 static void usbredir_setup_usb_eps(USBRedirDevice
*dev
)
1710 struct USBEndpoint
*usb_ep
;
1713 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1714 usb_ep
= I2USBEP(dev
, i
);
1715 usb_ep
->type
= dev
->endpoint
[i
].type
;
1716 usb_ep
->ifnum
= dev
->endpoint
[i
].interface
;
1717 usb_ep
->max_packet_size
= dev
->endpoint
[i
].max_packet_size
;
1718 usb_ep
->max_streams
= dev
->endpoint
[i
].max_streams
;
1719 usbredir_set_pipeline(dev
, usb_ep
);
1723 static void usbredir_ep_info(void *priv
,
1724 struct usb_redir_ep_info_header
*ep_info
)
1726 USBRedirDevice
*dev
= priv
;
1729 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1730 dev
->endpoint
[i
].type
= ep_info
->type
[i
];
1731 dev
->endpoint
[i
].interval
= ep_info
->interval
[i
];
1732 dev
->endpoint
[i
].interface
= ep_info
->interface
[i
];
1733 if (usbredirparser_peer_has_cap(dev
->parser
,
1734 usb_redir_cap_ep_info_max_packet_size
)) {
1735 dev
->endpoint
[i
].max_packet_size
= ep_info
->max_packet_size
[i
];
1737 #if USBREDIR_VERSION >= 0x000700
1738 if (usbredirparser_peer_has_cap(dev
->parser
,
1739 usb_redir_cap_bulk_streams
)) {
1740 dev
->endpoint
[i
].max_streams
= ep_info
->max_streams
[i
];
1743 switch (dev
->endpoint
[i
].type
) {
1744 case usb_redir_type_invalid
:
1746 case usb_redir_type_iso
:
1747 usbredir_mark_speed_incompatible(dev
, USB_SPEED_FULL
);
1748 usbredir_mark_speed_incompatible(dev
, USB_SPEED_HIGH
);
1750 case usb_redir_type_interrupt
:
1751 if (!usbredirparser_peer_has_cap(dev
->parser
,
1752 usb_redir_cap_ep_info_max_packet_size
) ||
1753 ep_info
->max_packet_size
[i
] > 64) {
1754 usbredir_mark_speed_incompatible(dev
, USB_SPEED_FULL
);
1756 if (!usbredirparser_peer_has_cap(dev
->parser
,
1757 usb_redir_cap_ep_info_max_packet_size
) ||
1758 ep_info
->max_packet_size
[i
] > 1024) {
1759 usbredir_mark_speed_incompatible(dev
, USB_SPEED_HIGH
);
1761 if (dev
->endpoint
[i
].interval
== 0) {
1762 ERROR("Received 0 interval for isoc or irq endpoint\n");
1763 usbredir_reject_device(dev
);
1767 case usb_redir_type_control
:
1768 case usb_redir_type_bulk
:
1769 DPRINTF("ep: %02X type: %d interface: %d\n", I2EP(i
),
1770 dev
->endpoint
[i
].type
, dev
->endpoint
[i
].interface
);
1773 ERROR("Received invalid endpoint type\n");
1774 usbredir_reject_device(dev
);
1778 /* The new ep info may have caused a speed incompatibility, recheck */
1779 if (dev
->dev
.attached
&&
1780 !(dev
->dev
.port
->speedmask
& dev
->dev
.speedmask
)) {
1781 ERROR("Device no longer matches speed after endpoint info change, "
1782 "disconnecting!\n");
1783 usbredir_reject_device(dev
);
1786 usbredir_setup_usb_eps(dev
);
1787 usbredir_check_bulk_receiving(dev
);
1790 static void usbredir_configuration_status(void *priv
, uint64_t id
,
1791 struct usb_redir_configuration_status_header
*config_status
)
1793 USBRedirDevice
*dev
= priv
;
1796 DPRINTF("set config status %d config %d id %"PRIu64
"\n",
1797 config_status
->status
, config_status
->configuration
, id
);
1799 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1801 if (dev
->dev
.setup_buf
[0] & USB_DIR_IN
) {
1802 dev
->dev
.data_buf
[0] = config_status
->configuration
;
1803 p
->actual_length
= 1;
1805 usbredir_handle_status(dev
, p
, config_status
->status
);
1806 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1810 static void usbredir_alt_setting_status(void *priv
, uint64_t id
,
1811 struct usb_redir_alt_setting_status_header
*alt_setting_status
)
1813 USBRedirDevice
*dev
= priv
;
1816 DPRINTF("alt status %d intf %d alt %d id: %"PRIu64
"\n",
1817 alt_setting_status
->status
, alt_setting_status
->interface
,
1818 alt_setting_status
->alt
, id
);
1820 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1822 if (dev
->dev
.setup_buf
[0] & USB_DIR_IN
) {
1823 dev
->dev
.data_buf
[0] = alt_setting_status
->alt
;
1824 p
->actual_length
= 1;
1826 usbredir_handle_status(dev
, p
, alt_setting_status
->status
);
1827 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1831 static void usbredir_iso_stream_status(void *priv
, uint64_t id
,
1832 struct usb_redir_iso_stream_status_header
*iso_stream_status
)
1834 USBRedirDevice
*dev
= priv
;
1835 uint8_t ep
= iso_stream_status
->endpoint
;
1837 DPRINTF("iso status %d ep %02X id %"PRIu64
"\n", iso_stream_status
->status
,
1840 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].iso_started
) {
1844 dev
->endpoint
[EP2I(ep
)].iso_error
= iso_stream_status
->status
;
1845 if (iso_stream_status
->status
== usb_redir_stall
) {
1846 DPRINTF("iso stream stopped by peer ep %02X\n", ep
);
1847 dev
->endpoint
[EP2I(ep
)].iso_started
= 0;
1851 static void usbredir_interrupt_receiving_status(void *priv
, uint64_t id
,
1852 struct usb_redir_interrupt_receiving_status_header
1853 *interrupt_receiving_status
)
1855 USBRedirDevice
*dev
= priv
;
1856 uint8_t ep
= interrupt_receiving_status
->endpoint
;
1858 DPRINTF("interrupt recv status %d ep %02X id %"PRIu64
"\n",
1859 interrupt_receiving_status
->status
, ep
, id
);
1861 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].interrupt_started
) {
1865 dev
->endpoint
[EP2I(ep
)].interrupt_error
=
1866 interrupt_receiving_status
->status
;
1867 if (interrupt_receiving_status
->status
== usb_redir_stall
) {
1868 DPRINTF("interrupt receiving stopped by peer ep %02X\n", ep
);
1869 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 0;
1873 static void usbredir_bulk_streams_status(void *priv
, uint64_t id
,
1874 struct usb_redir_bulk_streams_status_header
*bulk_streams_status
)
1876 #if USBREDIR_VERSION >= 0x000700
1877 USBRedirDevice
*dev
= priv
;
1879 if (bulk_streams_status
->status
== usb_redir_success
) {
1880 DPRINTF("bulk streams status %d eps %08x\n",
1881 bulk_streams_status
->status
, bulk_streams_status
->endpoints
);
1883 ERROR("bulk streams %s failed status %d eps %08x\n",
1884 (bulk_streams_status
->no_streams
== 0) ? "free" : "alloc",
1885 bulk_streams_status
->status
, bulk_streams_status
->endpoints
);
1886 ERROR("usb-redir-host does not provide streams, disconnecting\n");
1887 usbredir_reject_device(dev
);
1892 static void usbredir_bulk_receiving_status(void *priv
, uint64_t id
,
1893 struct usb_redir_bulk_receiving_status_header
*bulk_receiving_status
)
1895 USBRedirDevice
*dev
= priv
;
1896 uint8_t ep
= bulk_receiving_status
->endpoint
;
1898 DPRINTF("bulk recv status %d ep %02X id %"PRIu64
"\n",
1899 bulk_receiving_status
->status
, ep
, id
);
1901 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
) {
1905 if (bulk_receiving_status
->status
== usb_redir_stall
) {
1906 DPRINTF("bulk receiving stopped by peer ep %02X\n", ep
);
1907 dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
= 0;
1911 static void usbredir_control_packet(void *priv
, uint64_t id
,
1912 struct usb_redir_control_packet_header
*control_packet
,
1913 uint8_t *data
, int data_len
)
1915 USBRedirDevice
*dev
= priv
;
1917 int len
= control_packet
->length
;
1919 DPRINTF("ctrl-in status %d len %d id %"PRIu64
"\n", control_packet
->status
,
1922 /* Fix up USB-3 ep0 maxpacket size to allow superspeed connected devices
1923 * to work redirected to a not superspeed capable hcd */
1924 if (dev
->dev
.speed
== USB_SPEED_SUPER
&&
1925 !((dev
->dev
.port
->speedmask
& USB_SPEED_MASK_SUPER
)) &&
1926 control_packet
->requesttype
== 0x80 &&
1927 control_packet
->request
== 6 &&
1928 control_packet
->value
== 0x100 && control_packet
->index
== 0 &&
1929 data_len
>= 18 && data
[7] == 9) {
1933 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1935 usbredir_handle_status(dev
, p
, control_packet
->status
);
1937 usbredir_log_data(dev
, "ctrl data in:", data
, data_len
);
1938 if (data_len
> sizeof(dev
->dev
.data_buf
)) {
1939 ERROR("ctrl buffer too small (%d > %zu)\n",
1940 data_len
, sizeof(dev
->dev
.data_buf
));
1941 p
->status
= USB_RET_STALL
;
1942 data_len
= len
= sizeof(dev
->dev
.data_buf
);
1944 memcpy(dev
->dev
.data_buf
, data
, data_len
);
1946 p
->actual_length
= len
;
1947 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1952 static void usbredir_bulk_packet(void *priv
, uint64_t id
,
1953 struct usb_redir_bulk_packet_header
*bulk_packet
,
1954 uint8_t *data
, int data_len
)
1956 USBRedirDevice
*dev
= priv
;
1957 uint8_t ep
= bulk_packet
->endpoint
;
1958 int len
= (bulk_packet
->length_high
<< 16) | bulk_packet
->length
;
1961 DPRINTF("bulk-in status %d ep %02X stream %u len %d id %"PRIu64
"\n",
1962 bulk_packet
->status
, ep
, bulk_packet
->stream_id
, len
, id
);
1964 p
= usbredir_find_packet_by_id(dev
, ep
, id
);
1966 size_t size
= usb_packet_size(p
);
1967 usbredir_handle_status(dev
, p
, bulk_packet
->status
);
1969 usbredir_log_data(dev
, "bulk data in:", data
, data_len
);
1970 if (data_len
> size
) {
1971 ERROR("bulk got more data then requested (%d > %zd)\n",
1972 data_len
, p
->iov
.size
);
1973 p
->status
= USB_RET_BABBLE
;
1974 data_len
= len
= size
;
1976 usb_packet_copy(p
, data
, data_len
);
1978 p
->actual_length
= len
;
1979 if (p
->pid
== USB_TOKEN_IN
&& p
->ep
->pipeline
) {
1980 usb_combined_input_packet_complete(&dev
->dev
, p
);
1982 usb_packet_complete(&dev
->dev
, p
);
1988 static void usbredir_iso_packet(void *priv
, uint64_t id
,
1989 struct usb_redir_iso_packet_header
*iso_packet
,
1990 uint8_t *data
, int data_len
)
1992 USBRedirDevice
*dev
= priv
;
1993 uint8_t ep
= iso_packet
->endpoint
;
1995 DPRINTF2("iso-in status %d ep %02X len %d id %"PRIu64
"\n",
1996 iso_packet
->status
, ep
, data_len
, id
);
1998 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_ISOC
) {
1999 ERROR("received iso packet for non iso endpoint %02X\n", ep
);
2004 if (dev
->endpoint
[EP2I(ep
)].iso_started
== 0) {
2005 DPRINTF("received iso packet for non started stream ep %02X\n", ep
);
2010 /* bufp_alloc also adds the packet to the ep queue */
2011 bufp_alloc(dev
, data
, data_len
, iso_packet
->status
, ep
, data
);
2014 static void usbredir_interrupt_packet(void *priv
, uint64_t id
,
2015 struct usb_redir_interrupt_packet_header
*interrupt_packet
,
2016 uint8_t *data
, int data_len
)
2018 USBRedirDevice
*dev
= priv
;
2019 uint8_t ep
= interrupt_packet
->endpoint
;
2021 DPRINTF("interrupt-in status %d ep %02X len %d id %"PRIu64
"\n",
2022 interrupt_packet
->status
, ep
, data_len
, id
);
2024 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_INT
) {
2025 ERROR("received int packet for non interrupt endpoint %02X\n", ep
);
2030 if (ep
& USB_DIR_IN
) {
2031 if (dev
->endpoint
[EP2I(ep
)].interrupt_started
== 0) {
2032 DPRINTF("received int packet while not started ep %02X\n", ep
);
2037 if (QTAILQ_EMPTY(&dev
->endpoint
[EP2I(ep
)].bufpq
)) {
2038 usb_wakeup(usb_ep_get(&dev
->dev
, USB_TOKEN_IN
, ep
& 0x0f), 0);
2041 /* bufp_alloc also adds the packet to the ep queue */
2042 bufp_alloc(dev
, data
, data_len
, interrupt_packet
->status
, ep
, data
);
2045 * We report output interrupt packets as completed directly upon
2046 * submission, so all we can do here if one failed is warn.
2048 if (interrupt_packet
->status
) {
2049 WARNING("interrupt output failed status %d ep %02X id %"PRIu64
"\n",
2050 interrupt_packet
->status
, ep
, id
);
2055 static void usbredir_buffered_bulk_packet(void *priv
, uint64_t id
,
2056 struct usb_redir_buffered_bulk_packet_header
*buffered_bulk_packet
,
2057 uint8_t *data
, int data_len
)
2059 USBRedirDevice
*dev
= priv
;
2060 uint8_t status
, ep
= buffered_bulk_packet
->endpoint
;
2061 void *free_on_destroy
;
2064 DPRINTF("buffered-bulk-in status %d ep %02X len %d id %"PRIu64
"\n",
2065 buffered_bulk_packet
->status
, ep
, data_len
, id
);
2067 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_BULK
) {
2068 ERROR("received buffered-bulk packet for non bulk ep %02X\n", ep
);
2073 if (dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
== 0) {
2074 DPRINTF("received buffered-bulk packet on not started ep %02X\n", ep
);
2079 /* Data must be in maxp chunks for buffered_bulk_add_*_data_to_packet */
2080 len
= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
2081 status
= usb_redir_success
;
2082 free_on_destroy
= NULL
;
2083 for (i
= 0; i
< data_len
; i
+= len
) {
2084 if (len
>= (data_len
- i
)) {
2086 status
= buffered_bulk_packet
->status
;
2087 free_on_destroy
= data
;
2089 /* bufp_alloc also adds the packet to the ep queue */
2090 bufp_alloc(dev
, data
+ i
, len
, status
, ep
, free_on_destroy
);
2093 if (dev
->endpoint
[EP2I(ep
)].pending_async_packet
) {
2094 USBPacket
*p
= dev
->endpoint
[EP2I(ep
)].pending_async_packet
;
2095 dev
->endpoint
[EP2I(ep
)].pending_async_packet
= NULL
;
2096 usbredir_buffered_bulk_in_complete(dev
, p
, ep
);
2097 usb_packet_complete(&dev
->dev
, p
);
2105 static void usbredir_pre_save(void *priv
)
2107 USBRedirDevice
*dev
= priv
;
2109 usbredir_fill_already_in_flight(dev
);
2112 static int usbredir_post_load(void *priv
, int version_id
)
2114 USBRedirDevice
*dev
= priv
;
2116 if (dev
->parser
== NULL
) {
2120 switch (dev
->device_info
.speed
) {
2121 case usb_redir_speed_low
:
2122 dev
->dev
.speed
= USB_SPEED_LOW
;
2124 case usb_redir_speed_full
:
2125 dev
->dev
.speed
= USB_SPEED_FULL
;
2127 case usb_redir_speed_high
:
2128 dev
->dev
.speed
= USB_SPEED_HIGH
;
2130 case usb_redir_speed_super
:
2131 dev
->dev
.speed
= USB_SPEED_SUPER
;
2134 dev
->dev
.speed
= USB_SPEED_FULL
;
2136 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
);
2138 usbredir_setup_usb_eps(dev
);
2139 usbredir_check_bulk_receiving(dev
);
2144 /* For usbredirparser migration */
2145 static void usbredir_put_parser(QEMUFile
*f
, void *priv
, size_t unused
)
2147 USBRedirDevice
*dev
= priv
;
2151 if (dev
->parser
== NULL
) {
2152 qemu_put_be32(f
, 0);
2156 usbredirparser_serialize(dev
->parser
, &data
, &len
);
2157 qemu_oom_check(data
);
2159 qemu_put_be32(f
, len
);
2160 qemu_put_buffer(f
, data
, len
);
2165 static int usbredir_get_parser(QEMUFile
*f
, void *priv
, size_t unused
)
2167 USBRedirDevice
*dev
= priv
;
2171 len
= qemu_get_be32(f
);
2177 * If our chardev is not open already at this point the usbredir connection
2178 * has been broken (non seamless migration, or restore from disk).
2180 * In this case create a temporary parser to receive the migration data,
2181 * and schedule the close_bh to report the device as disconnected to the
2182 * guest and to destroy the parser again.
2184 if (dev
->parser
== NULL
) {
2185 WARNING("usb-redir connection broken during migration\n");
2186 usbredir_create_parser(dev
);
2187 qemu_bh_schedule(dev
->chardev_close_bh
);
2190 data
= g_malloc(len
);
2191 qemu_get_buffer(f
, data
, len
);
2193 ret
= usbredirparser_unserialize(dev
->parser
, data
, len
);
2200 static const VMStateInfo usbredir_parser_vmstate_info
= {
2201 .name
= "usb-redir-parser",
2202 .put
= usbredir_put_parser
,
2203 .get
= usbredir_get_parser
,
2207 /* For buffered packets (iso/irq) queue migration */
2208 static void usbredir_put_bufpq(QEMUFile
*f
, void *priv
, size_t unused
)
2210 struct endp_data
*endp
= priv
;
2211 USBRedirDevice
*dev
= endp
->dev
;
2212 struct buf_packet
*bufp
;
2215 qemu_put_be32(f
, endp
->bufpq_size
);
2216 QTAILQ_FOREACH(bufp
, &endp
->bufpq
, next
) {
2217 len
= bufp
->len
- bufp
->offset
;
2218 DPRINTF("put_bufpq %d/%d len %d status %d\n", i
+ 1, endp
->bufpq_size
,
2220 qemu_put_be32(f
, len
);
2221 qemu_put_be32(f
, bufp
->status
);
2222 qemu_put_buffer(f
, bufp
->data
+ bufp
->offset
, len
);
2225 assert(i
== endp
->bufpq_size
);
2228 static int usbredir_get_bufpq(QEMUFile
*f
, void *priv
, size_t unused
)
2230 struct endp_data
*endp
= priv
;
2231 USBRedirDevice
*dev
= endp
->dev
;
2232 struct buf_packet
*bufp
;
2235 endp
->bufpq_size
= qemu_get_be32(f
);
2236 for (i
= 0; i
< endp
->bufpq_size
; i
++) {
2237 bufp
= g_malloc(sizeof(struct buf_packet
));
2238 bufp
->len
= qemu_get_be32(f
);
2239 bufp
->status
= qemu_get_be32(f
);
2241 bufp
->data
= qemu_oom_check(malloc(bufp
->len
)); /* regular malloc! */
2242 bufp
->free_on_destroy
= bufp
->data
;
2243 qemu_get_buffer(f
, bufp
->data
, bufp
->len
);
2244 QTAILQ_INSERT_TAIL(&endp
->bufpq
, bufp
, next
);
2245 DPRINTF("get_bufpq %d/%d len %d status %d\n", i
+ 1, endp
->bufpq_size
,
2246 bufp
->len
, bufp
->status
);
2251 static const VMStateInfo usbredir_ep_bufpq_vmstate_info
= {
2252 .name
= "usb-redir-bufpq",
2253 .put
= usbredir_put_bufpq
,
2254 .get
= usbredir_get_bufpq
,
2258 /* For endp_data migration */
2259 static const VMStateDescription usbredir_bulk_receiving_vmstate
= {
2260 .name
= "usb-redir-ep/bulk-receiving",
2262 .minimum_version_id
= 1,
2263 .fields
= (VMStateField
[]) {
2264 VMSTATE_UINT8(bulk_receiving_started
, struct endp_data
),
2265 VMSTATE_END_OF_LIST()
2269 static bool usbredir_bulk_receiving_needed(void *priv
)
2271 struct endp_data
*endp
= priv
;
2273 return endp
->bulk_receiving_started
;
2276 static const VMStateDescription usbredir_stream_vmstate
= {
2277 .name
= "usb-redir-ep/stream-state",
2279 .minimum_version_id
= 1,
2280 .fields
= (VMStateField
[]) {
2281 VMSTATE_UINT32(max_streams
, struct endp_data
),
2282 VMSTATE_END_OF_LIST()
2286 static bool usbredir_stream_needed(void *priv
)
2288 struct endp_data
*endp
= priv
;
2290 return endp
->max_streams
;
2293 static const VMStateDescription usbredir_ep_vmstate
= {
2294 .name
= "usb-redir-ep",
2296 .minimum_version_id
= 1,
2297 .fields
= (VMStateField
[]) {
2298 VMSTATE_UINT8(type
, struct endp_data
),
2299 VMSTATE_UINT8(interval
, struct endp_data
),
2300 VMSTATE_UINT8(interface
, struct endp_data
),
2301 VMSTATE_UINT16(max_packet_size
, struct endp_data
),
2302 VMSTATE_UINT8(iso_started
, struct endp_data
),
2303 VMSTATE_UINT8(iso_error
, struct endp_data
),
2304 VMSTATE_UINT8(interrupt_started
, struct endp_data
),
2305 VMSTATE_UINT8(interrupt_error
, struct endp_data
),
2306 VMSTATE_UINT8(bufpq_prefilled
, struct endp_data
),
2307 VMSTATE_UINT8(bufpq_dropping_packets
, struct endp_data
),
2311 .field_exists
= NULL
,
2313 .info
= &usbredir_ep_bufpq_vmstate_info
,
2314 .flags
= VMS_SINGLE
,
2317 VMSTATE_INT32(bufpq_target_size
, struct endp_data
),
2318 VMSTATE_END_OF_LIST()
2320 .subsections
= (VMStateSubsection
[]) {
2322 .vmsd
= &usbredir_bulk_receiving_vmstate
,
2323 .needed
= usbredir_bulk_receiving_needed
,
2325 .vmsd
= &usbredir_stream_vmstate
,
2326 .needed
= usbredir_stream_needed
,
2334 /* For PacketIdQueue migration */
2335 static void usbredir_put_packet_id_q(QEMUFile
*f
, void *priv
, size_t unused
)
2337 struct PacketIdQueue
*q
= priv
;
2338 USBRedirDevice
*dev
= q
->dev
;
2339 struct PacketIdQueueEntry
*e
;
2340 int remain
= q
->size
;
2342 DPRINTF("put_packet_id_q %s size %d\n", q
->name
, q
->size
);
2343 qemu_put_be32(f
, q
->size
);
2344 QTAILQ_FOREACH(e
, &q
->head
, next
) {
2345 qemu_put_be64(f
, e
->id
);
2348 assert(remain
== 0);
2351 static int usbredir_get_packet_id_q(QEMUFile
*f
, void *priv
, size_t unused
)
2353 struct PacketIdQueue
*q
= priv
;
2354 USBRedirDevice
*dev
= q
->dev
;
2358 size
= qemu_get_be32(f
);
2359 DPRINTF("get_packet_id_q %s size %d\n", q
->name
, size
);
2360 for (i
= 0; i
< size
; i
++) {
2361 id
= qemu_get_be64(f
);
2362 packet_id_queue_add(q
, id
);
2364 assert(q
->size
== size
);
2368 static const VMStateInfo usbredir_ep_packet_id_q_vmstate_info
= {
2369 .name
= "usb-redir-packet-id-q",
2370 .put
= usbredir_put_packet_id_q
,
2371 .get
= usbredir_get_packet_id_q
,
2374 static const VMStateDescription usbredir_ep_packet_id_queue_vmstate
= {
2375 .name
= "usb-redir-packet-id-queue",
2377 .minimum_version_id
= 1,
2378 .fields
= (VMStateField
[]) {
2382 .field_exists
= NULL
,
2384 .info
= &usbredir_ep_packet_id_q_vmstate_info
,
2385 .flags
= VMS_SINGLE
,
2388 VMSTATE_END_OF_LIST()
2393 /* For usb_redir_device_connect_header migration */
2394 static const VMStateDescription usbredir_device_info_vmstate
= {
2395 .name
= "usb-redir-device-info",
2397 .minimum_version_id
= 1,
2398 .fields
= (VMStateField
[]) {
2399 VMSTATE_UINT8(speed
, struct usb_redir_device_connect_header
),
2400 VMSTATE_UINT8(device_class
, struct usb_redir_device_connect_header
),
2401 VMSTATE_UINT8(device_subclass
, struct usb_redir_device_connect_header
),
2402 VMSTATE_UINT8(device_protocol
, struct usb_redir_device_connect_header
),
2403 VMSTATE_UINT16(vendor_id
, struct usb_redir_device_connect_header
),
2404 VMSTATE_UINT16(product_id
, struct usb_redir_device_connect_header
),
2405 VMSTATE_UINT16(device_version_bcd
,
2406 struct usb_redir_device_connect_header
),
2407 VMSTATE_END_OF_LIST()
2412 /* For usb_redir_interface_info_header migration */
2413 static const VMStateDescription usbredir_interface_info_vmstate
= {
2414 .name
= "usb-redir-interface-info",
2416 .minimum_version_id
= 1,
2417 .fields
= (VMStateField
[]) {
2418 VMSTATE_UINT32(interface_count
,
2419 struct usb_redir_interface_info_header
),
2420 VMSTATE_UINT8_ARRAY(interface
,
2421 struct usb_redir_interface_info_header
, 32),
2422 VMSTATE_UINT8_ARRAY(interface_class
,
2423 struct usb_redir_interface_info_header
, 32),
2424 VMSTATE_UINT8_ARRAY(interface_subclass
,
2425 struct usb_redir_interface_info_header
, 32),
2426 VMSTATE_UINT8_ARRAY(interface_protocol
,
2427 struct usb_redir_interface_info_header
, 32),
2428 VMSTATE_END_OF_LIST()
2433 /* And finally the USBRedirDevice vmstate itself */
2434 static const VMStateDescription usbredir_vmstate
= {
2435 .name
= "usb-redir",
2437 .minimum_version_id
= 1,
2438 .pre_save
= usbredir_pre_save
,
2439 .post_load
= usbredir_post_load
,
2440 .fields
= (VMStateField
[]) {
2441 VMSTATE_USB_DEVICE(dev
, USBRedirDevice
),
2442 VMSTATE_TIMER(attach_timer
, USBRedirDevice
),
2446 .field_exists
= NULL
,
2448 .info
= &usbredir_parser_vmstate_info
,
2449 .flags
= VMS_SINGLE
,
2452 VMSTATE_STRUCT_ARRAY(endpoint
, USBRedirDevice
, MAX_ENDPOINTS
, 1,
2453 usbredir_ep_vmstate
, struct endp_data
),
2454 VMSTATE_STRUCT(cancelled
, USBRedirDevice
, 1,
2455 usbredir_ep_packet_id_queue_vmstate
,
2456 struct PacketIdQueue
),
2457 VMSTATE_STRUCT(already_in_flight
, USBRedirDevice
, 1,
2458 usbredir_ep_packet_id_queue_vmstate
,
2459 struct PacketIdQueue
),
2460 VMSTATE_STRUCT(device_info
, USBRedirDevice
, 1,
2461 usbredir_device_info_vmstate
,
2462 struct usb_redir_device_connect_header
),
2463 VMSTATE_STRUCT(interface_info
, USBRedirDevice
, 1,
2464 usbredir_interface_info_vmstate
,
2465 struct usb_redir_interface_info_header
),
2466 VMSTATE_END_OF_LIST()
2470 static Property usbredir_properties
[] = {
2471 DEFINE_PROP_CHR("chardev", USBRedirDevice
, cs
),
2472 DEFINE_PROP_UINT8("debug", USBRedirDevice
, debug
, usbredirparser_warning
),
2473 DEFINE_PROP_STRING("filter", USBRedirDevice
, filter_str
),
2474 DEFINE_PROP_INT32("bootindex", USBRedirDevice
, bootindex
, -1),
2475 DEFINE_PROP_END_OF_LIST(),
2478 static void usbredir_class_initfn(ObjectClass
*klass
, void *data
)
2480 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
2481 DeviceClass
*dc
= DEVICE_CLASS(klass
);
2483 uc
->realize
= usbredir_realize
;
2484 uc
->product_desc
= "USB Redirection Device";
2485 uc
->handle_destroy
= usbredir_handle_destroy
;
2486 uc
->cancel_packet
= usbredir_cancel_packet
;
2487 uc
->handle_reset
= usbredir_handle_reset
;
2488 uc
->handle_data
= usbredir_handle_data
;
2489 uc
->handle_control
= usbredir_handle_control
;
2490 uc
->flush_ep_queue
= usbredir_flush_ep_queue
;
2491 uc
->ep_stopped
= usbredir_ep_stopped
;
2492 uc
->alloc_streams
= usbredir_alloc_streams
;
2493 uc
->free_streams
= usbredir_free_streams
;
2494 dc
->vmsd
= &usbredir_vmstate
;
2495 dc
->props
= usbredir_properties
;
2496 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
2499 static const TypeInfo usbredir_dev_info
= {
2500 .name
= "usb-redir",
2501 .parent
= TYPE_USB_DEVICE
,
2502 .instance_size
= sizeof(USBRedirDevice
),
2503 .class_init
= usbredir_class_initfn
,
2506 static void usbredir_register_types(void)
2508 type_register_static(&usbredir_dev_info
);
2511 type_init(usbredir_register_types
)