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/osdep.h"
29 #include "qemu-common.h"
30 #include "qemu/units.h"
31 #include "qapi/error.h"
32 #include "qemu/timer.h"
33 #include "sysemu/runstate.h"
34 #include "sysemu/sysemu.h"
35 #include "qapi/qmp/qerror.h"
36 #include "qemu/error-report.h"
38 #include "qemu/module.h"
39 #include "chardev/char-fe.h"
41 #include <usbredirparser.h>
42 #include <usbredirfilter.h>
44 #include "hw/qdev-properties.h"
46 #include "migration/qemu-file-types.h"
47 #include "migration/vmstate.h"
49 /* ERROR is defined below. Remove any previous definition. */
52 #define MAX_ENDPOINTS 32
53 #define NO_INTERFACE_INFO 255 /* Valid interface_count always <= 32 */
54 #define EP2I(ep_address) (((ep_address & 0x80) >> 3) | (ep_address & 0x0f))
55 #define I2EP(i) (((i & 0x10) << 3) | (i & 0x0f))
56 #define USBEP2I(usb_ep) (((usb_ep)->pid == USB_TOKEN_IN) ? \
57 ((usb_ep)->nr | 0x10) : ((usb_ep)->nr))
58 #define I2USBEP(d, i) (usb_ep_get(&(d)->dev, \
59 ((i) & 0x10) ? USB_TOKEN_IN : USB_TOKEN_OUT, \
62 #ifndef USBREDIR_VERSION /* This is not defined in older usbredir versions */
63 #define USBREDIR_VERSION 0
66 typedef struct USBRedirDevice USBRedirDevice
;
68 /* Struct to hold buffered packets */
71 void *free_on_destroy
;
75 QTAILQ_ENTRY(buf_packet
)next
;
82 uint8_t interface
; /* bInterfaceNumber this ep belongs to */
83 uint16_t max_packet_size
; /* In bytes, not wMaxPacketSize format !! */
86 uint8_t iso_error
; /* For reporting iso errors to the HC */
87 uint8_t interrupt_started
;
88 uint8_t interrupt_error
;
89 uint8_t bulk_receiving_enabled
;
90 uint8_t bulk_receiving_started
;
91 uint8_t bufpq_prefilled
;
92 uint8_t bufpq_dropping_packets
;
93 QTAILQ_HEAD(, buf_packet
) bufpq
;
95 int32_t bufpq_target_size
;
96 USBPacket
*pending_async_packet
;
99 struct PacketIdQueueEntry
{
101 QTAILQ_ENTRY(PacketIdQueueEntry
)next
;
104 struct PacketIdQueue
{
107 QTAILQ_HEAD(, PacketIdQueueEntry
) head
;
111 struct USBRedirDevice
{
116 bool suppress_remote_wake
;
120 /* Data passed from chardev the fd_read cb to the usbredirparser read cb */
121 const uint8_t *read_buf
;
123 /* Active chardev-watch-tag */
125 /* For async handling of close / reject */
126 QEMUBH
*chardev_close_bh
;
127 QEMUBH
*device_reject_bh
;
128 /* To delay the usb attach in case of quick chardev close + open */
129 QEMUTimer
*attach_timer
;
130 int64_t next_attach_time
;
131 struct usbredirparser
*parser
;
132 struct endp_data endpoint
[MAX_ENDPOINTS
];
133 struct PacketIdQueue cancelled
;
134 struct PacketIdQueue already_in_flight
;
135 void (*buffered_bulk_in_complete
)(USBRedirDevice
*, USBPacket
*, uint8_t);
136 /* Data for device filtering */
137 struct usb_redir_device_connect_header device_info
;
138 struct usb_redir_interface_info_header interface_info
;
139 struct usbredirfilter_rule
*filter_rules
;
140 int filter_rules_count
;
141 int compatible_speedmask
;
142 VMChangeStateEntry
*vmstate
;
145 #define TYPE_USB_REDIR "usb-redir"
146 #define USB_REDIRECT(obj) OBJECT_CHECK(USBRedirDevice, (obj), TYPE_USB_REDIR)
148 static void usbredir_hello(void *priv
, struct usb_redir_hello_header
*h
);
149 static void usbredir_device_connect(void *priv
,
150 struct usb_redir_device_connect_header
*device_connect
);
151 static void usbredir_device_disconnect(void *priv
);
152 static void usbredir_interface_info(void *priv
,
153 struct usb_redir_interface_info_header
*interface_info
);
154 static void usbredir_ep_info(void *priv
,
155 struct usb_redir_ep_info_header
*ep_info
);
156 static void usbredir_configuration_status(void *priv
, uint64_t id
,
157 struct usb_redir_configuration_status_header
*configuration_status
);
158 static void usbredir_alt_setting_status(void *priv
, uint64_t id
,
159 struct usb_redir_alt_setting_status_header
*alt_setting_status
);
160 static void usbredir_iso_stream_status(void *priv
, uint64_t id
,
161 struct usb_redir_iso_stream_status_header
*iso_stream_status
);
162 static void usbredir_interrupt_receiving_status(void *priv
, uint64_t id
,
163 struct usb_redir_interrupt_receiving_status_header
164 *interrupt_receiving_status
);
165 static void usbredir_bulk_streams_status(void *priv
, uint64_t id
,
166 struct usb_redir_bulk_streams_status_header
*bulk_streams_status
);
167 static void usbredir_bulk_receiving_status(void *priv
, uint64_t id
,
168 struct usb_redir_bulk_receiving_status_header
*bulk_receiving_status
);
169 static void usbredir_control_packet(void *priv
, uint64_t id
,
170 struct usb_redir_control_packet_header
*control_packet
,
171 uint8_t *data
, int data_len
);
172 static void usbredir_bulk_packet(void *priv
, uint64_t id
,
173 struct usb_redir_bulk_packet_header
*bulk_packet
,
174 uint8_t *data
, int data_len
);
175 static void usbredir_iso_packet(void *priv
, uint64_t id
,
176 struct usb_redir_iso_packet_header
*iso_packet
,
177 uint8_t *data
, int data_len
);
178 static void usbredir_interrupt_packet(void *priv
, uint64_t id
,
179 struct usb_redir_interrupt_packet_header
*interrupt_header
,
180 uint8_t *data
, int data_len
);
181 static void usbredir_buffered_bulk_packet(void *priv
, uint64_t id
,
182 struct usb_redir_buffered_bulk_packet_header
*buffered_bulk_packet
,
183 uint8_t *data
, int data_len
);
185 static void usbredir_handle_status(USBRedirDevice
*dev
, USBPacket
*p
,
188 #define VERSION "qemu usb-redir guest " QEMU_VERSION
196 if (dev->debug >= usbredirparser_error) { \
197 error_report("usb-redir error: " __VA_ARGS__); \
200 #define WARNING(...) \
202 if (dev->debug >= usbredirparser_warning) { \
203 warn_report("" __VA_ARGS__); \
208 if (dev->debug >= usbredirparser_info) { \
209 error_report("usb-redir: " __VA_ARGS__); \
212 #define DPRINTF(...) \
214 if (dev->debug >= usbredirparser_debug) { \
215 error_report("usb-redir: " __VA_ARGS__); \
218 #define DPRINTF2(...) \
220 if (dev->debug >= usbredirparser_debug_data) { \
221 error_report("usb-redir: " __VA_ARGS__); \
225 static void usbredir_log(void *priv
, int level
, const char *msg
)
227 USBRedirDevice
*dev
= priv
;
229 if (dev
->debug
< level
) {
233 error_report("%s", msg
);
236 static void usbredir_log_data(USBRedirDevice
*dev
, const char *desc
,
237 const uint8_t *data
, int len
)
239 if (dev
->debug
< usbredirparser_debug_data
) {
242 qemu_hexdump((char *)data
, stderr
, desc
, len
);
246 * usbredirparser io functions
249 static int usbredir_read(void *priv
, uint8_t *data
, int count
)
251 USBRedirDevice
*dev
= priv
;
253 if (dev
->read_buf_size
< count
) {
254 count
= dev
->read_buf_size
;
257 memcpy(data
, dev
->read_buf
, count
);
259 dev
->read_buf_size
-= count
;
260 if (dev
->read_buf_size
) {
261 dev
->read_buf
+= count
;
263 dev
->read_buf
= NULL
;
269 static gboolean
usbredir_write_unblocked(GIOChannel
*chan
, GIOCondition cond
,
272 USBRedirDevice
*dev
= opaque
;
275 usbredirparser_do_write(dev
->parser
);
280 static int usbredir_write(void *priv
, uint8_t *data
, int count
)
282 USBRedirDevice
*dev
= priv
;
285 if (!qemu_chr_fe_backend_open(&dev
->cs
)) {
289 /* Don't send new data to the chardev until our state is fully synced */
290 if (!runstate_check(RUN_STATE_RUNNING
)) {
294 r
= qemu_chr_fe_write(&dev
->cs
, data
, count
);
297 dev
->watch
= qemu_chr_fe_add_watch(&dev
->cs
, G_IO_OUT
| G_IO_HUP
,
298 usbredir_write_unblocked
, dev
);
308 * Cancelled and buffered packets helpers
311 static void packet_id_queue_init(struct PacketIdQueue
*q
,
312 USBRedirDevice
*dev
, const char *name
)
316 QTAILQ_INIT(&q
->head
);
320 static void packet_id_queue_add(struct PacketIdQueue
*q
, uint64_t id
)
322 USBRedirDevice
*dev
= q
->dev
;
323 struct PacketIdQueueEntry
*e
;
325 DPRINTF("adding packet id %"PRIu64
" to %s queue\n", id
, q
->name
);
327 e
= g_new0(struct PacketIdQueueEntry
, 1);
329 QTAILQ_INSERT_TAIL(&q
->head
, e
, next
);
333 static int packet_id_queue_remove(struct PacketIdQueue
*q
, uint64_t id
)
335 USBRedirDevice
*dev
= q
->dev
;
336 struct PacketIdQueueEntry
*e
;
338 QTAILQ_FOREACH(e
, &q
->head
, next
) {
340 DPRINTF("removing packet id %"PRIu64
" from %s queue\n",
342 QTAILQ_REMOVE(&q
->head
, e
, next
);
351 static void packet_id_queue_empty(struct PacketIdQueue
*q
)
353 USBRedirDevice
*dev
= q
->dev
;
354 struct PacketIdQueueEntry
*e
, *next_e
;
356 DPRINTF("removing %d packet-ids from %s queue\n", q
->size
, q
->name
);
358 QTAILQ_FOREACH_SAFE(e
, &q
->head
, next
, next_e
) {
359 QTAILQ_REMOVE(&q
->head
, e
, next
);
365 static void usbredir_cancel_packet(USBDevice
*udev
, USBPacket
*p
)
367 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
368 int i
= USBEP2I(p
->ep
);
371 usb_combined_packet_cancel(udev
, p
);
375 if (dev
->endpoint
[i
].pending_async_packet
) {
376 assert(dev
->endpoint
[i
].pending_async_packet
== p
);
377 dev
->endpoint
[i
].pending_async_packet
= NULL
;
381 packet_id_queue_add(&dev
->cancelled
, p
->id
);
382 usbredirparser_send_cancel_data_packet(dev
->parser
, p
->id
);
383 usbredirparser_do_write(dev
->parser
);
386 static int usbredir_is_cancelled(USBRedirDevice
*dev
, uint64_t id
)
388 if (!dev
->dev
.attached
) {
389 return 1; /* Treat everything as cancelled after a disconnect */
391 return packet_id_queue_remove(&dev
->cancelled
, id
);
394 static void usbredir_fill_already_in_flight_from_ep(USBRedirDevice
*dev
,
395 struct USBEndpoint
*ep
)
399 /* async handled packets for bulk receiving eps do not count as inflight */
400 if (dev
->endpoint
[USBEP2I(ep
)].bulk_receiving_started
) {
404 QTAILQ_FOREACH(p
, &ep
->queue
, queue
) {
405 /* Skip combined packets, except for the first */
406 if (p
->combined
&& p
!= p
->combined
->first
) {
409 if (p
->state
== USB_PACKET_ASYNC
) {
410 packet_id_queue_add(&dev
->already_in_flight
, p
->id
);
415 static void usbredir_fill_already_in_flight(USBRedirDevice
*dev
)
418 struct USBDevice
*udev
= &dev
->dev
;
420 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_ctl
);
422 for (ep
= 0; ep
< USB_MAX_ENDPOINTS
; ep
++) {
423 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_in
[ep
]);
424 usbredir_fill_already_in_flight_from_ep(dev
, &udev
->ep_out
[ep
]);
428 static int usbredir_already_in_flight(USBRedirDevice
*dev
, uint64_t id
)
430 return packet_id_queue_remove(&dev
->already_in_flight
, id
);
433 static USBPacket
*usbredir_find_packet_by_id(USBRedirDevice
*dev
,
434 uint8_t ep
, uint64_t id
)
438 if (usbredir_is_cancelled(dev
, id
)) {
442 p
= usb_ep_find_packet_by_id(&dev
->dev
,
443 (ep
& USB_DIR_IN
) ? USB_TOKEN_IN
: USB_TOKEN_OUT
,
446 ERROR("could not find packet with id %"PRIu64
"\n", id
);
451 static int bufp_alloc(USBRedirDevice
*dev
, uint8_t *data
, uint16_t len
,
452 uint8_t status
, uint8_t ep
, void *free_on_destroy
)
454 struct buf_packet
*bufp
;
456 if (!dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
&&
457 dev
->endpoint
[EP2I(ep
)].bufpq_size
>
458 2 * dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
459 DPRINTF("bufpq overflow, dropping packets ep %02X\n", ep
);
460 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 1;
462 /* Since we're interupting the stream anyways, drop enough packets to get
463 back to our target buffer size */
464 if (dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
) {
465 if (dev
->endpoint
[EP2I(ep
)].bufpq_size
>
466 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
470 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
473 bufp
= g_new(struct buf_packet
, 1);
477 bufp
->status
= status
;
478 bufp
->free_on_destroy
= free_on_destroy
;
479 QTAILQ_INSERT_TAIL(&dev
->endpoint
[EP2I(ep
)].bufpq
, bufp
, next
);
480 dev
->endpoint
[EP2I(ep
)].bufpq_size
++;
484 static void bufp_free(USBRedirDevice
*dev
, struct buf_packet
*bufp
,
487 QTAILQ_REMOVE(&dev
->endpoint
[EP2I(ep
)].bufpq
, bufp
, next
);
488 dev
->endpoint
[EP2I(ep
)].bufpq_size
--;
489 free(bufp
->free_on_destroy
);
493 static void usbredir_free_bufpq(USBRedirDevice
*dev
, uint8_t ep
)
495 struct buf_packet
*buf
, *buf_next
;
497 QTAILQ_FOREACH_SAFE(buf
, &dev
->endpoint
[EP2I(ep
)].bufpq
, next
, buf_next
) {
498 bufp_free(dev
, buf
, ep
);
503 * USBDevice callbacks
506 static void usbredir_handle_reset(USBDevice
*udev
)
508 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
510 DPRINTF("reset device\n");
511 usbredirparser_send_reset(dev
->parser
);
512 usbredirparser_do_write(dev
->parser
);
515 static void usbredir_handle_iso_data(USBRedirDevice
*dev
, USBPacket
*p
,
519 if (!dev
->endpoint
[EP2I(ep
)].iso_started
&&
520 !dev
->endpoint
[EP2I(ep
)].iso_error
) {
521 struct usb_redir_start_iso_stream_header start_iso
= {
526 if (dev
->dev
.speed
== USB_SPEED_HIGH
) {
527 pkts_per_sec
= 8000 / dev
->endpoint
[EP2I(ep
)].interval
;
529 pkts_per_sec
= 1000 / dev
->endpoint
[EP2I(ep
)].interval
;
531 /* Testing has shown that we need circa 60 ms buffer */
532 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= (pkts_per_sec
* 60) / 1000;
534 /* Aim for approx 100 interrupts / second on the client to
535 balance latency and interrupt load */
536 start_iso
.pkts_per_urb
= pkts_per_sec
/ 100;
537 if (start_iso
.pkts_per_urb
< 1) {
538 start_iso
.pkts_per_urb
= 1;
539 } else if (start_iso
.pkts_per_urb
> 32) {
540 start_iso
.pkts_per_urb
= 32;
543 start_iso
.no_urbs
= DIV_ROUND_UP(
544 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
,
545 start_iso
.pkts_per_urb
);
546 /* Output endpoints pre-fill only 1/2 of the packets, keeping the rest
547 as overflow buffer. Also see the usbredir protocol documentation */
548 if (!(ep
& USB_DIR_IN
)) {
549 start_iso
.no_urbs
*= 2;
551 if (start_iso
.no_urbs
> 16) {
552 start_iso
.no_urbs
= 16;
555 /* No id, we look at the ep when receiving a status back */
556 usbredirparser_send_start_iso_stream(dev
->parser
, 0, &start_iso
);
557 usbredirparser_do_write(dev
->parser
);
558 DPRINTF("iso stream started pkts/sec %d pkts/urb %d urbs %d ep %02X\n",
559 pkts_per_sec
, start_iso
.pkts_per_urb
, start_iso
.no_urbs
, ep
);
560 dev
->endpoint
[EP2I(ep
)].iso_started
= 1;
561 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 0;
562 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
565 if (ep
& USB_DIR_IN
) {
566 struct buf_packet
*isop
;
568 if (dev
->endpoint
[EP2I(ep
)].iso_started
&&
569 !dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
) {
570 if (dev
->endpoint
[EP2I(ep
)].bufpq_size
<
571 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
) {
574 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 1;
577 isop
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
);
579 DPRINTF("iso-token-in ep %02X, no isop, iso_error: %d\n",
580 ep
, dev
->endpoint
[EP2I(ep
)].iso_error
);
581 /* Re-fill the buffer */
582 dev
->endpoint
[EP2I(ep
)].bufpq_prefilled
= 0;
583 /* Check iso_error for stream errors, otherwise its an underrun */
584 status
= dev
->endpoint
[EP2I(ep
)].iso_error
;
585 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
586 p
->status
= status
? USB_RET_IOERROR
: USB_RET_SUCCESS
;
589 DPRINTF2("iso-token-in ep %02X status %d len %d queue-size: %d\n", ep
,
590 isop
->status
, isop
->len
, dev
->endpoint
[EP2I(ep
)].bufpq_size
);
592 status
= isop
->status
;
594 if (len
> p
->iov
.size
) {
595 ERROR("received iso data is larger then packet ep %02X (%d > %d)\n",
596 ep
, len
, (int)p
->iov
.size
);
598 status
= usb_redir_babble
;
600 usb_packet_copy(p
, isop
->data
, len
);
601 bufp_free(dev
, isop
, ep
);
602 usbredir_handle_status(dev
, p
, status
);
604 /* If the stream was not started because of a pending error don't
605 send the packet to the usb-host */
606 if (dev
->endpoint
[EP2I(ep
)].iso_started
) {
607 struct usb_redir_iso_packet_header iso_packet
= {
609 .length
= p
->iov
.size
611 uint8_t buf
[p
->iov
.size
];
612 /* No id, we look at the ep when receiving a status back */
613 usb_packet_copy(p
, buf
, p
->iov
.size
);
614 usbredirparser_send_iso_packet(dev
->parser
, 0, &iso_packet
,
616 usbredirparser_do_write(dev
->parser
);
618 status
= dev
->endpoint
[EP2I(ep
)].iso_error
;
619 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
620 DPRINTF2("iso-token-out ep %02X status %d len %zd\n", ep
, status
,
622 usbredir_handle_status(dev
, p
, status
);
626 static void usbredir_stop_iso_stream(USBRedirDevice
*dev
, uint8_t ep
)
628 struct usb_redir_stop_iso_stream_header stop_iso_stream
= {
631 if (dev
->endpoint
[EP2I(ep
)].iso_started
) {
632 usbredirparser_send_stop_iso_stream(dev
->parser
, 0, &stop_iso_stream
);
633 DPRINTF("iso stream stopped ep %02X\n", ep
);
634 dev
->endpoint
[EP2I(ep
)].iso_started
= 0;
636 dev
->endpoint
[EP2I(ep
)].iso_error
= 0;
637 usbredir_free_bufpq(dev
, ep
);
641 * The usb-host may poll the endpoint faster then our guest, resulting in lots
642 * of smaller bulkp-s. The below buffered_bulk_in_complete* functions combine
643 * data from multiple bulkp-s into a single packet, avoiding bufpq overflows.
645 static void usbredir_buffered_bulk_add_data_to_packet(USBRedirDevice
*dev
,
646 struct buf_packet
*bulkp
, int count
, USBPacket
*p
, uint8_t ep
)
648 usb_packet_copy(p
, bulkp
->data
+ bulkp
->offset
, count
);
649 bulkp
->offset
+= count
;
650 if (bulkp
->offset
== bulkp
->len
) {
651 /* Store status in the last packet with data from this bulkp */
652 usbredir_handle_status(dev
, p
, bulkp
->status
);
653 bufp_free(dev
, bulkp
, ep
);
657 static void usbredir_buffered_bulk_in_complete_raw(USBRedirDevice
*dev
,
658 USBPacket
*p
, uint8_t ep
)
660 struct buf_packet
*bulkp
;
663 while ((bulkp
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
)) &&
664 p
->actual_length
< p
->iov
.size
&& p
->status
== USB_RET_SUCCESS
) {
665 count
= bulkp
->len
- bulkp
->offset
;
666 if (count
> (p
->iov
.size
- p
->actual_length
)) {
667 count
= p
->iov
.size
- p
->actual_length
;
669 usbredir_buffered_bulk_add_data_to_packet(dev
, bulkp
, count
, p
, ep
);
673 static void usbredir_buffered_bulk_in_complete_ftdi(USBRedirDevice
*dev
,
674 USBPacket
*p
, uint8_t ep
)
676 const int maxp
= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
677 uint8_t header
[2] = { 0, 0 };
678 struct buf_packet
*bulkp
;
681 while ((bulkp
= QTAILQ_FIRST(&dev
->endpoint
[EP2I(ep
)].bufpq
)) &&
682 p
->actual_length
< p
->iov
.size
&& p
->status
== USB_RET_SUCCESS
) {
683 if (bulkp
->len
< 2) {
684 WARNING("malformed ftdi bulk in packet\n");
685 bufp_free(dev
, bulkp
, ep
);
689 if ((p
->actual_length
% maxp
) == 0) {
690 usb_packet_copy(p
, bulkp
->data
, 2);
691 memcpy(header
, bulkp
->data
, 2);
693 if (bulkp
->data
[0] != header
[0] || bulkp
->data
[1] != header
[1]) {
694 break; /* Different header, add to next packet */
698 if (bulkp
->offset
== 0) {
699 bulkp
->offset
= 2; /* Skip header */
701 count
= bulkp
->len
- bulkp
->offset
;
702 /* Must repeat the header at maxp interval */
703 if (count
> (maxp
- (p
->actual_length
% maxp
))) {
704 count
= maxp
- (p
->actual_length
% maxp
);
706 usbredir_buffered_bulk_add_data_to_packet(dev
, bulkp
, count
, p
, ep
);
710 static void usbredir_buffered_bulk_in_complete(USBRedirDevice
*dev
,
711 USBPacket
*p
, uint8_t ep
)
713 p
->status
= USB_RET_SUCCESS
; /* Clear previous ASYNC status */
714 dev
->buffered_bulk_in_complete(dev
, p
, ep
);
715 DPRINTF("bulk-token-in ep %02X status %d len %d id %"PRIu64
"\n",
716 ep
, p
->status
, p
->actual_length
, p
->id
);
719 static void usbredir_handle_buffered_bulk_in_data(USBRedirDevice
*dev
,
720 USBPacket
*p
, uint8_t ep
)
722 /* Input bulk endpoint, buffered packet input */
723 if (!dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
) {
725 struct usb_redir_start_bulk_receiving_header start
= {
730 /* Round bytes_per_transfer up to a multiple of max_packet_size */
731 bpt
= 512 + dev
->endpoint
[EP2I(ep
)].max_packet_size
- 1;
732 bpt
/= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
733 bpt
*= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
734 start
.bytes_per_transfer
= bpt
;
735 /* No id, we look at the ep when receiving a status back */
736 usbredirparser_send_start_bulk_receiving(dev
->parser
, 0, &start
);
737 usbredirparser_do_write(dev
->parser
);
738 DPRINTF("bulk receiving started bytes/transfer %u count %d ep %02X\n",
739 start
.bytes_per_transfer
, start
.no_transfers
, ep
);
740 dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
= 1;
741 /* We don't really want to drop bulk packets ever, but
742 having some upper limit to how much we buffer is good. */
743 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= 5000;
744 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
747 if (QTAILQ_EMPTY(&dev
->endpoint
[EP2I(ep
)].bufpq
)) {
748 DPRINTF("bulk-token-in ep %02X, no bulkp\n", ep
);
749 assert(dev
->endpoint
[EP2I(ep
)].pending_async_packet
== NULL
);
750 dev
->endpoint
[EP2I(ep
)].pending_async_packet
= p
;
751 p
->status
= USB_RET_ASYNC
;
754 usbredir_buffered_bulk_in_complete(dev
, p
, ep
);
757 static void usbredir_stop_bulk_receiving(USBRedirDevice
*dev
, uint8_t ep
)
759 struct usb_redir_stop_bulk_receiving_header stop_bulk
= {
763 if (dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
) {
764 usbredirparser_send_stop_bulk_receiving(dev
->parser
, 0, &stop_bulk
);
765 DPRINTF("bulk receiving stopped ep %02X\n", ep
);
766 dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
= 0;
768 usbredir_free_bufpq(dev
, ep
);
771 static void usbredir_handle_bulk_data(USBRedirDevice
*dev
, USBPacket
*p
,
774 struct usb_redir_bulk_packet_header bulk_packet
;
775 size_t size
= usb_packet_size(p
);
776 const int maxp
= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
778 if (usbredir_already_in_flight(dev
, p
->id
)) {
779 p
->status
= USB_RET_ASYNC
;
783 if (dev
->endpoint
[EP2I(ep
)].bulk_receiving_enabled
) {
784 if (size
!= 0 && (size
% maxp
) == 0) {
785 usbredir_handle_buffered_bulk_in_data(dev
, p
, ep
);
788 WARNING("bulk recv invalid size %zd ep %02x, disabling\n", size
, ep
);
789 assert(dev
->endpoint
[EP2I(ep
)].pending_async_packet
== NULL
);
790 usbredir_stop_bulk_receiving(dev
, ep
);
791 dev
->endpoint
[EP2I(ep
)].bulk_receiving_enabled
= 0;
794 DPRINTF("bulk-out ep %02X stream %u len %zd id %"PRIu64
"\n",
795 ep
, p
->stream
, size
, p
->id
);
797 bulk_packet
.endpoint
= ep
;
798 bulk_packet
.length
= size
;
799 bulk_packet
.stream_id
= p
->stream
;
800 bulk_packet
.length_high
= size
>> 16;
801 assert(bulk_packet
.length_high
== 0 ||
802 usbredirparser_peer_has_cap(dev
->parser
,
803 usb_redir_cap_32bits_bulk_length
));
805 if (ep
& USB_DIR_IN
|| size
== 0) {
806 usbredirparser_send_bulk_packet(dev
->parser
, p
->id
,
807 &bulk_packet
, NULL
, 0);
810 usb_packet_copy(p
, buf
, size
);
811 usbredir_log_data(dev
, "bulk data out:", buf
, size
);
812 usbredirparser_send_bulk_packet(dev
->parser
, p
->id
,
813 &bulk_packet
, buf
, size
);
815 usbredirparser_do_write(dev
->parser
);
816 p
->status
= USB_RET_ASYNC
;
819 static void usbredir_handle_interrupt_in_data(USBRedirDevice
*dev
,
820 USBPacket
*p
, uint8_t ep
)
822 /* Input interrupt endpoint, buffered packet input */
823 struct buf_packet
*intp
, *intp_to_free
;
824 int status
, len
, sum
;
826 if (!dev
->endpoint
[EP2I(ep
)].interrupt_started
&&
827 !dev
->endpoint
[EP2I(ep
)].interrupt_error
) {
828 struct usb_redir_start_interrupt_receiving_header start_int
= {
831 /* No id, we look at the ep when receiving a status back */
832 usbredirparser_send_start_interrupt_receiving(dev
->parser
, 0,
834 usbredirparser_do_write(dev
->parser
);
835 DPRINTF("interrupt recv started ep %02X\n", ep
);
836 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 1;
837 /* We don't really want to drop interrupt packets ever, but
838 having some upper limit to how much we buffer is good. */
839 dev
->endpoint
[EP2I(ep
)].bufpq_target_size
= 1000;
840 dev
->endpoint
[EP2I(ep
)].bufpq_dropping_packets
= 0;
843 /* check for completed interrupt message (with all fragments) */
845 QTAILQ_FOREACH(intp
, &dev
->endpoint
[EP2I(ep
)].bufpq
, next
) {
847 if (intp
->len
< dev
->endpoint
[EP2I(ep
)].max_packet_size
||
853 DPRINTF2("interrupt-token-in ep %02X, no intp, buffered %d\n", ep
, sum
);
854 /* Check interrupt_error for stream errors */
855 status
= dev
->endpoint
[EP2I(ep
)].interrupt_error
;
856 dev
->endpoint
[EP2I(ep
)].interrupt_error
= 0;
858 usbredir_handle_status(dev
, p
, status
);
860 p
->status
= USB_RET_NAK
;
865 /* copy of completed interrupt message */
867 status
= usb_redir_success
;
869 QTAILQ_FOREACH(intp
, &dev
->endpoint
[EP2I(ep
)].bufpq
, next
) {
871 bufp_free(dev
, intp_to_free
, ep
);
873 DPRINTF("interrupt-token-in ep %02X fragment status %d len %d\n", ep
,
874 intp
->status
, intp
->len
);
878 if (status
== usb_redir_success
) {
879 status
= intp
->status
;
881 if (sum
> p
->iov
.size
) {
882 ERROR("received int data is larger then packet ep %02X\n", ep
);
883 len
-= (sum
- p
->iov
.size
);
885 status
= usb_redir_babble
;
888 usb_packet_copy(p
, intp
->data
, len
);
891 if (intp
->len
< dev
->endpoint
[EP2I(ep
)].max_packet_size
||
896 bufp_free(dev
, intp_to_free
, ep
);
898 DPRINTF("interrupt-token-in ep %02X summary status %d len %d\n", ep
,
900 usbredir_handle_status(dev
, p
, status
);
904 * Handle interrupt out data, the usbredir protocol expects us to do this
905 * async, so that it can report back a completion status. But guests will
906 * expect immediate completion for an interrupt endpoint, and handling this
907 * async causes migration issues. So we report success directly, counting
908 * on the fact that output interrupt packets normally always succeed.
910 static void usbredir_handle_interrupt_out_data(USBRedirDevice
*dev
,
911 USBPacket
*p
, uint8_t ep
)
913 struct usb_redir_interrupt_packet_header interrupt_packet
;
914 uint8_t buf
[p
->iov
.size
];
916 DPRINTF("interrupt-out ep %02X len %zd id %"PRIu64
"\n", ep
,
919 interrupt_packet
.endpoint
= ep
;
920 interrupt_packet
.length
= p
->iov
.size
;
922 usb_packet_copy(p
, buf
, p
->iov
.size
);
923 usbredir_log_data(dev
, "interrupt data out:", buf
, p
->iov
.size
);
924 usbredirparser_send_interrupt_packet(dev
->parser
, p
->id
,
925 &interrupt_packet
, buf
, p
->iov
.size
);
926 usbredirparser_do_write(dev
->parser
);
929 static void usbredir_stop_interrupt_receiving(USBRedirDevice
*dev
,
932 struct usb_redir_stop_interrupt_receiving_header stop_interrupt_recv
= {
935 if (dev
->endpoint
[EP2I(ep
)].interrupt_started
) {
936 usbredirparser_send_stop_interrupt_receiving(dev
->parser
, 0,
937 &stop_interrupt_recv
);
938 DPRINTF("interrupt recv stopped ep %02X\n", ep
);
939 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 0;
941 dev
->endpoint
[EP2I(ep
)].interrupt_error
= 0;
942 usbredir_free_bufpq(dev
, ep
);
945 static void usbredir_handle_data(USBDevice
*udev
, USBPacket
*p
)
947 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
951 if (p
->pid
== USB_TOKEN_IN
) {
955 switch (dev
->endpoint
[EP2I(ep
)].type
) {
956 case USB_ENDPOINT_XFER_CONTROL
:
957 ERROR("handle_data called for control transfer on ep %02X\n", ep
);
958 p
->status
= USB_RET_NAK
;
960 case USB_ENDPOINT_XFER_BULK
:
961 if (p
->state
== USB_PACKET_SETUP
&& p
->pid
== USB_TOKEN_IN
&&
963 p
->status
= USB_RET_ADD_TO_QUEUE
;
966 usbredir_handle_bulk_data(dev
, p
, ep
);
968 case USB_ENDPOINT_XFER_ISOC
:
969 usbredir_handle_iso_data(dev
, p
, ep
);
971 case USB_ENDPOINT_XFER_INT
:
972 if (ep
& USB_DIR_IN
) {
973 usbredir_handle_interrupt_in_data(dev
, p
, ep
);
975 usbredir_handle_interrupt_out_data(dev
, p
, ep
);
979 ERROR("handle_data ep %02X has unknown type %d\n", ep
,
980 dev
->endpoint
[EP2I(ep
)].type
);
981 p
->status
= USB_RET_NAK
;
985 static void usbredir_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
)
987 if (ep
->pid
== USB_TOKEN_IN
&& ep
->pipeline
) {
988 usb_ep_combine_input_packets(ep
);
992 static void usbredir_stop_ep(USBRedirDevice
*dev
, int i
)
994 uint8_t ep
= I2EP(i
);
996 switch (dev
->endpoint
[i
].type
) {
997 case USB_ENDPOINT_XFER_BULK
:
998 if (ep
& USB_DIR_IN
) {
999 usbredir_stop_bulk_receiving(dev
, ep
);
1002 case USB_ENDPOINT_XFER_ISOC
:
1003 usbredir_stop_iso_stream(dev
, ep
);
1005 case USB_ENDPOINT_XFER_INT
:
1006 if (ep
& USB_DIR_IN
) {
1007 usbredir_stop_interrupt_receiving(dev
, ep
);
1011 usbredir_free_bufpq(dev
, ep
);
1014 static void usbredir_ep_stopped(USBDevice
*udev
, USBEndpoint
*uep
)
1016 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
1018 usbredir_stop_ep(dev
, USBEP2I(uep
));
1019 usbredirparser_do_write(dev
->parser
);
1022 static void usbredir_set_config(USBRedirDevice
*dev
, USBPacket
*p
,
1025 struct usb_redir_set_configuration_header set_config
;
1028 DPRINTF("set config %d id %"PRIu64
"\n", config
, p
->id
);
1030 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1031 usbredir_stop_ep(dev
, i
);
1034 set_config
.configuration
= config
;
1035 usbredirparser_send_set_configuration(dev
->parser
, p
->id
, &set_config
);
1036 usbredirparser_do_write(dev
->parser
);
1037 p
->status
= USB_RET_ASYNC
;
1040 static void usbredir_get_config(USBRedirDevice
*dev
, USBPacket
*p
)
1042 DPRINTF("get config id %"PRIu64
"\n", p
->id
);
1044 usbredirparser_send_get_configuration(dev
->parser
, p
->id
);
1045 usbredirparser_do_write(dev
->parser
);
1046 p
->status
= USB_RET_ASYNC
;
1049 static void usbredir_set_interface(USBRedirDevice
*dev
, USBPacket
*p
,
1050 int interface
, int alt
)
1052 struct usb_redir_set_alt_setting_header set_alt
;
1055 DPRINTF("set interface %d alt %d id %"PRIu64
"\n", interface
, alt
, p
->id
);
1057 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1058 if (dev
->endpoint
[i
].interface
== interface
) {
1059 usbredir_stop_ep(dev
, i
);
1063 set_alt
.interface
= interface
;
1065 usbredirparser_send_set_alt_setting(dev
->parser
, p
->id
, &set_alt
);
1066 usbredirparser_do_write(dev
->parser
);
1067 p
->status
= USB_RET_ASYNC
;
1070 static void usbredir_get_interface(USBRedirDevice
*dev
, USBPacket
*p
,
1073 struct usb_redir_get_alt_setting_header get_alt
;
1075 DPRINTF("get interface %d id %"PRIu64
"\n", interface
, p
->id
);
1077 get_alt
.interface
= interface
;
1078 usbredirparser_send_get_alt_setting(dev
->parser
, p
->id
, &get_alt
);
1079 usbredirparser_do_write(dev
->parser
);
1080 p
->status
= USB_RET_ASYNC
;
1083 static void usbredir_handle_control(USBDevice
*udev
, USBPacket
*p
,
1084 int request
, int value
, int index
, int length
, uint8_t *data
)
1086 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
1087 struct usb_redir_control_packet_header control_packet
;
1089 if (usbredir_already_in_flight(dev
, p
->id
)) {
1090 p
->status
= USB_RET_ASYNC
;
1094 /* Special cases for certain standard device requests */
1096 case DeviceOutRequest
| USB_REQ_SET_ADDRESS
:
1097 DPRINTF("set address %d\n", value
);
1098 dev
->dev
.addr
= value
;
1100 case DeviceOutRequest
| USB_REQ_SET_CONFIGURATION
:
1101 usbredir_set_config(dev
, p
, value
& 0xff);
1103 case DeviceRequest
| USB_REQ_GET_CONFIGURATION
:
1104 usbredir_get_config(dev
, p
);
1106 case InterfaceOutRequest
| USB_REQ_SET_INTERFACE
:
1107 usbredir_set_interface(dev
, p
, index
, value
);
1109 case InterfaceRequest
| USB_REQ_GET_INTERFACE
:
1110 usbredir_get_interface(dev
, p
, index
);
1114 /* Normal ctrl requests, note request is (bRequestType << 8) | bRequest */
1116 "ctrl-out type 0x%x req 0x%x val 0x%x index %d len %d id %"PRIu64
"\n",
1117 request
>> 8, request
& 0xff, value
, index
, length
, p
->id
);
1119 control_packet
.request
= request
& 0xFF;
1120 control_packet
.requesttype
= request
>> 8;
1121 control_packet
.endpoint
= control_packet
.requesttype
& USB_DIR_IN
;
1122 control_packet
.value
= value
;
1123 control_packet
.index
= index
;
1124 control_packet
.length
= length
;
1126 if (control_packet
.requesttype
& USB_DIR_IN
) {
1127 usbredirparser_send_control_packet(dev
->parser
, p
->id
,
1128 &control_packet
, NULL
, 0);
1130 usbredir_log_data(dev
, "ctrl data out:", data
, length
);
1131 usbredirparser_send_control_packet(dev
->parser
, p
->id
,
1132 &control_packet
, data
, length
);
1134 usbredirparser_do_write(dev
->parser
);
1135 p
->status
= USB_RET_ASYNC
;
1138 static int usbredir_alloc_streams(USBDevice
*udev
, USBEndpoint
**eps
,
1139 int nr_eps
, int streams
)
1141 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
1142 #if USBREDIR_VERSION >= 0x000700
1143 struct usb_redir_alloc_bulk_streams_header alloc_streams
;
1146 if (!usbredirparser_peer_has_cap(dev
->parser
,
1147 usb_redir_cap_bulk_streams
)) {
1148 ERROR("peer does not support streams\n");
1153 ERROR("request to allocate 0 streams\n");
1157 alloc_streams
.no_streams
= streams
;
1158 alloc_streams
.endpoints
= 0;
1159 for (i
= 0; i
< nr_eps
; i
++) {
1160 alloc_streams
.endpoints
|= 1 << USBEP2I(eps
[i
]);
1162 usbredirparser_send_alloc_bulk_streams(dev
->parser
, 0, &alloc_streams
);
1163 usbredirparser_do_write(dev
->parser
);
1167 ERROR("usbredir_alloc_streams not implemented\n");
1171 ERROR("streams are not available, disconnecting\n");
1172 qemu_bh_schedule(dev
->device_reject_bh
);
1176 static void usbredir_free_streams(USBDevice
*udev
, USBEndpoint
**eps
,
1179 #if USBREDIR_VERSION >= 0x000700
1180 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
1181 struct usb_redir_free_bulk_streams_header free_streams
;
1184 if (!usbredirparser_peer_has_cap(dev
->parser
,
1185 usb_redir_cap_bulk_streams
)) {
1189 free_streams
.endpoints
= 0;
1190 for (i
= 0; i
< nr_eps
; i
++) {
1191 free_streams
.endpoints
|= 1 << USBEP2I(eps
[i
]);
1193 usbredirparser_send_free_bulk_streams(dev
->parser
, 0, &free_streams
);
1194 usbredirparser_do_write(dev
->parser
);
1199 * Close events can be triggered by usbredirparser_do_write which gets called
1200 * from within the USBDevice data / control packet callbacks and doing a
1201 * usb_detach from within these callbacks is not a good idea.
1203 * So we use a bh handler to take care of close events.
1205 static void usbredir_chardev_close_bh(void *opaque
)
1207 USBRedirDevice
*dev
= opaque
;
1209 qemu_bh_cancel(dev
->device_reject_bh
);
1210 usbredir_device_disconnect(dev
);
1213 DPRINTF("destroying usbredirparser\n");
1214 usbredirparser_destroy(dev
->parser
);
1218 g_source_remove(dev
->watch
);
1223 static void usbredir_create_parser(USBRedirDevice
*dev
)
1225 uint32_t caps
[USB_REDIR_CAPS_SIZE
] = { 0, };
1228 DPRINTF("creating usbredirparser\n");
1230 dev
->parser
= qemu_oom_check(usbredirparser_create());
1231 dev
->parser
->priv
= dev
;
1232 dev
->parser
->log_func
= usbredir_log
;
1233 dev
->parser
->read_func
= usbredir_read
;
1234 dev
->parser
->write_func
= usbredir_write
;
1235 dev
->parser
->hello_func
= usbredir_hello
;
1236 dev
->parser
->device_connect_func
= usbredir_device_connect
;
1237 dev
->parser
->device_disconnect_func
= usbredir_device_disconnect
;
1238 dev
->parser
->interface_info_func
= usbredir_interface_info
;
1239 dev
->parser
->ep_info_func
= usbredir_ep_info
;
1240 dev
->parser
->configuration_status_func
= usbredir_configuration_status
;
1241 dev
->parser
->alt_setting_status_func
= usbredir_alt_setting_status
;
1242 dev
->parser
->iso_stream_status_func
= usbredir_iso_stream_status
;
1243 dev
->parser
->interrupt_receiving_status_func
=
1244 usbredir_interrupt_receiving_status
;
1245 dev
->parser
->bulk_streams_status_func
= usbredir_bulk_streams_status
;
1246 dev
->parser
->bulk_receiving_status_func
= usbredir_bulk_receiving_status
;
1247 dev
->parser
->control_packet_func
= usbredir_control_packet
;
1248 dev
->parser
->bulk_packet_func
= usbredir_bulk_packet
;
1249 dev
->parser
->iso_packet_func
= usbredir_iso_packet
;
1250 dev
->parser
->interrupt_packet_func
= usbredir_interrupt_packet
;
1251 dev
->parser
->buffered_bulk_packet_func
= usbredir_buffered_bulk_packet
;
1252 dev
->read_buf
= NULL
;
1253 dev
->read_buf_size
= 0;
1255 usbredirparser_caps_set_cap(caps
, usb_redir_cap_connect_device_version
);
1256 usbredirparser_caps_set_cap(caps
, usb_redir_cap_filter
);
1257 usbredirparser_caps_set_cap(caps
, usb_redir_cap_ep_info_max_packet_size
);
1258 usbredirparser_caps_set_cap(caps
, usb_redir_cap_64bits_ids
);
1259 usbredirparser_caps_set_cap(caps
, usb_redir_cap_32bits_bulk_length
);
1260 usbredirparser_caps_set_cap(caps
, usb_redir_cap_bulk_receiving
);
1261 #if USBREDIR_VERSION >= 0x000700
1262 if (dev
->enable_streams
) {
1263 usbredirparser_caps_set_cap(caps
, usb_redir_cap_bulk_streams
);
1267 if (runstate_check(RUN_STATE_INMIGRATE
)) {
1268 flags
|= usbredirparser_fl_no_hello
;
1270 usbredirparser_init(dev
->parser
, VERSION
, caps
, USB_REDIR_CAPS_SIZE
,
1272 usbredirparser_do_write(dev
->parser
);
1275 static void usbredir_reject_device(USBRedirDevice
*dev
)
1277 usbredir_device_disconnect(dev
);
1278 if (usbredirparser_peer_has_cap(dev
->parser
, usb_redir_cap_filter
)) {
1279 usbredirparser_send_filter_reject(dev
->parser
);
1280 usbredirparser_do_write(dev
->parser
);
1285 * We may need to reject the device when the hcd calls alloc_streams, doing
1286 * an usb_detach from within a hcd call is not a good idea, hence this bh.
1288 static void usbredir_device_reject_bh(void *opaque
)
1290 USBRedirDevice
*dev
= opaque
;
1292 usbredir_reject_device(dev
);
1295 static void usbredir_do_attach(void *opaque
)
1297 USBRedirDevice
*dev
= opaque
;
1298 Error
*local_err
= NULL
;
1300 /* In order to work properly with XHCI controllers we need these caps */
1301 if ((dev
->dev
.port
->speedmask
& USB_SPEED_MASK_SUPER
) && !(
1302 usbredirparser_peer_has_cap(dev
->parser
,
1303 usb_redir_cap_ep_info_max_packet_size
) &&
1304 usbredirparser_peer_has_cap(dev
->parser
,
1305 usb_redir_cap_32bits_bulk_length
) &&
1306 usbredirparser_peer_has_cap(dev
->parser
,
1307 usb_redir_cap_64bits_ids
))) {
1308 ERROR("usb-redir-host lacks capabilities needed for use with XHCI\n");
1309 usbredir_reject_device(dev
);
1313 usb_device_attach(&dev
->dev
, &local_err
);
1315 error_report_err(local_err
);
1316 WARNING("rejecting device due to speed mismatch\n");
1317 usbredir_reject_device(dev
);
1325 static int usbredir_chardev_can_read(void *opaque
)
1327 USBRedirDevice
*dev
= opaque
;
1330 WARNING("chardev_can_read called on non open chardev!\n");
1334 /* Don't read new data from the chardev until our state is fully synced */
1335 if (!runstate_check(RUN_STATE_RUNNING
)) {
1339 /* usbredir_parser_do_read will consume *all* data we give it */
1343 static void usbredir_chardev_read(void *opaque
, const uint8_t *buf
, int size
)
1345 USBRedirDevice
*dev
= opaque
;
1347 /* No recursion allowed! */
1348 assert(dev
->read_buf
== NULL
);
1350 dev
->read_buf
= buf
;
1351 dev
->read_buf_size
= size
;
1353 usbredirparser_do_read(dev
->parser
);
1354 /* Send any acks, etc. which may be queued now */
1355 usbredirparser_do_write(dev
->parser
);
1358 static void usbredir_chardev_event(void *opaque
, int event
)
1360 USBRedirDevice
*dev
= opaque
;
1363 case CHR_EVENT_OPENED
:
1364 DPRINTF("chardev open\n");
1365 /* Make sure any pending closes are handled (no-op if none pending) */
1366 usbredir_chardev_close_bh(dev
);
1367 qemu_bh_cancel(dev
->chardev_close_bh
);
1368 usbredir_create_parser(dev
);
1370 case CHR_EVENT_CLOSED
:
1371 DPRINTF("chardev close\n");
1372 qemu_bh_schedule(dev
->chardev_close_bh
);
1381 static void usbredir_vm_state_change(void *priv
, int running
, RunState state
)
1383 USBRedirDevice
*dev
= priv
;
1385 if (state
== RUN_STATE_RUNNING
&& dev
->parser
!= NULL
) {
1386 usbredirparser_do_write(dev
->parser
); /* Flush any pending writes */
1390 static void usbredir_init_endpoints(USBRedirDevice
*dev
)
1394 usb_ep_init(&dev
->dev
);
1395 memset(dev
->endpoint
, 0, sizeof(dev
->endpoint
));
1396 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1397 dev
->endpoint
[i
].dev
= dev
;
1398 QTAILQ_INIT(&dev
->endpoint
[i
].bufpq
);
1402 static void usbredir_realize(USBDevice
*udev
, Error
**errp
)
1404 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
1407 if (!qemu_chr_fe_backend_connected(&dev
->cs
)) {
1408 error_setg(errp
, QERR_MISSING_PARAMETER
, "chardev");
1412 if (dev
->filter_str
) {
1413 i
= usbredirfilter_string_to_rules(dev
->filter_str
, ":", "|",
1415 &dev
->filter_rules_count
);
1417 error_setg(errp
, QERR_INVALID_PARAMETER_VALUE
, "filter",
1418 "a usb device filter string");
1423 dev
->chardev_close_bh
= qemu_bh_new(usbredir_chardev_close_bh
, dev
);
1424 dev
->device_reject_bh
= qemu_bh_new(usbredir_device_reject_bh
, dev
);
1425 dev
->attach_timer
= timer_new_ms(QEMU_CLOCK_VIRTUAL
, usbredir_do_attach
, dev
);
1427 packet_id_queue_init(&dev
->cancelled
, dev
, "cancelled");
1428 packet_id_queue_init(&dev
->already_in_flight
, dev
, "already-in-flight");
1429 usbredir_init_endpoints(dev
);
1431 /* We'll do the attach once we receive the speed from the usb-host */
1432 udev
->auto_attach
= 0;
1434 /* Will be cleared during setup when we find conflicts */
1435 dev
->compatible_speedmask
= USB_SPEED_MASK_FULL
| USB_SPEED_MASK_HIGH
;
1437 /* Let the backend know we are ready */
1438 qemu_chr_fe_set_handlers(&dev
->cs
, usbredir_chardev_can_read
,
1439 usbredir_chardev_read
, usbredir_chardev_event
,
1440 NULL
, dev
, NULL
, true);
1443 qemu_add_vm_change_state_handler(usbredir_vm_state_change
, dev
);
1446 static void usbredir_cleanup_device_queues(USBRedirDevice
*dev
)
1450 packet_id_queue_empty(&dev
->cancelled
);
1451 packet_id_queue_empty(&dev
->already_in_flight
);
1452 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1453 usbredir_free_bufpq(dev
, I2EP(i
));
1457 static void usbredir_unrealize(USBDevice
*udev
, Error
**errp
)
1459 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
1461 qemu_chr_fe_deinit(&dev
->cs
, true);
1463 /* Note must be done after qemu_chr_close, as that causes a close event */
1464 qemu_bh_delete(dev
->chardev_close_bh
);
1465 qemu_bh_delete(dev
->device_reject_bh
);
1467 timer_del(dev
->attach_timer
);
1468 timer_free(dev
->attach_timer
);
1470 usbredir_cleanup_device_queues(dev
);
1473 usbredirparser_destroy(dev
->parser
);
1476 g_source_remove(dev
->watch
);
1479 free(dev
->filter_rules
);
1480 qemu_del_vm_change_state_handler(dev
->vmstate
);
1483 static int usbredir_check_filter(USBRedirDevice
*dev
)
1485 if (dev
->interface_info
.interface_count
== NO_INTERFACE_INFO
) {
1486 ERROR("No interface info for device\n");
1490 if (dev
->filter_rules
) {
1491 if (!usbredirparser_peer_has_cap(dev
->parser
,
1492 usb_redir_cap_connect_device_version
)) {
1493 ERROR("Device filter specified and peer does not have the "
1494 "connect_device_version capability\n");
1498 if (usbredirfilter_check(
1500 dev
->filter_rules_count
,
1501 dev
->device_info
.device_class
,
1502 dev
->device_info
.device_subclass
,
1503 dev
->device_info
.device_protocol
,
1504 dev
->interface_info
.interface_class
,
1505 dev
->interface_info
.interface_subclass
,
1506 dev
->interface_info
.interface_protocol
,
1507 dev
->interface_info
.interface_count
,
1508 dev
->device_info
.vendor_id
,
1509 dev
->device_info
.product_id
,
1510 dev
->device_info
.device_version_bcd
,
1519 usbredir_reject_device(dev
);
1523 static void usbredir_check_bulk_receiving(USBRedirDevice
*dev
)
1527 if (!usbredirparser_peer_has_cap(dev
->parser
,
1528 usb_redir_cap_bulk_receiving
)) {
1532 for (i
= EP2I(USB_DIR_IN
); i
< MAX_ENDPOINTS
; i
++) {
1533 dev
->endpoint
[i
].bulk_receiving_enabled
= 0;
1536 if (dev
->interface_info
.interface_count
== NO_INTERFACE_INFO
) {
1540 for (i
= 0; i
< dev
->interface_info
.interface_count
; i
++) {
1541 quirks
= usb_get_quirks(dev
->device_info
.vendor_id
,
1542 dev
->device_info
.product_id
,
1543 dev
->interface_info
.interface_class
[i
],
1544 dev
->interface_info
.interface_subclass
[i
],
1545 dev
->interface_info
.interface_protocol
[i
]);
1546 if (!(quirks
& USB_QUIRK_BUFFER_BULK_IN
)) {
1549 if (quirks
& USB_QUIRK_IS_FTDI
) {
1550 dev
->buffered_bulk_in_complete
=
1551 usbredir_buffered_bulk_in_complete_ftdi
;
1553 dev
->buffered_bulk_in_complete
=
1554 usbredir_buffered_bulk_in_complete_raw
;
1557 for (j
= EP2I(USB_DIR_IN
); j
< MAX_ENDPOINTS
; j
++) {
1558 if (dev
->endpoint
[j
].interface
==
1559 dev
->interface_info
.interface
[i
] &&
1560 dev
->endpoint
[j
].type
== USB_ENDPOINT_XFER_BULK
&&
1561 dev
->endpoint
[j
].max_packet_size
!= 0) {
1562 dev
->endpoint
[j
].bulk_receiving_enabled
= 1;
1564 * With buffering pipelining is not necessary. Also packet
1565 * combining and bulk in buffering don't play nice together!
1567 I2USBEP(dev
, j
)->pipeline
= false;
1568 break; /* Only buffer for the first ep of each intf */
1575 * usbredirparser packet complete callbacks
1578 static void usbredir_handle_status(USBRedirDevice
*dev
, USBPacket
*p
,
1582 case usb_redir_success
:
1583 p
->status
= USB_RET_SUCCESS
; /* Clear previous ASYNC status */
1585 case usb_redir_stall
:
1586 p
->status
= USB_RET_STALL
;
1588 case usb_redir_cancelled
:
1590 * When the usbredir-host unredirects a device, it will report a status
1591 * of cancelled for all pending packets, followed by a disconnect msg.
1593 p
->status
= USB_RET_IOERROR
;
1595 case usb_redir_inval
:
1596 WARNING("got invalid param error from usb-host?\n");
1597 p
->status
= USB_RET_IOERROR
;
1599 case usb_redir_babble
:
1600 p
->status
= USB_RET_BABBLE
;
1602 case usb_redir_ioerror
:
1603 case usb_redir_timeout
:
1605 p
->status
= USB_RET_IOERROR
;
1609 static void usbredir_hello(void *priv
, struct usb_redir_hello_header
*h
)
1611 USBRedirDevice
*dev
= priv
;
1613 /* Try to send the filter info now that we've the usb-host's caps */
1614 if (usbredirparser_peer_has_cap(dev
->parser
, usb_redir_cap_filter
) &&
1615 dev
->filter_rules
) {
1616 usbredirparser_send_filter_filter(dev
->parser
, dev
->filter_rules
,
1617 dev
->filter_rules_count
);
1618 usbredirparser_do_write(dev
->parser
);
1622 static void usbredir_device_connect(void *priv
,
1623 struct usb_redir_device_connect_header
*device_connect
)
1625 USBRedirDevice
*dev
= priv
;
1628 if (timer_pending(dev
->attach_timer
) || dev
->dev
.attached
) {
1629 ERROR("Received device connect while already connected\n");
1633 switch (device_connect
->speed
) {
1634 case usb_redir_speed_low
:
1635 speed
= "low speed";
1636 dev
->dev
.speed
= USB_SPEED_LOW
;
1637 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_FULL
;
1638 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_HIGH
;
1640 case usb_redir_speed_full
:
1641 speed
= "full speed";
1642 dev
->dev
.speed
= USB_SPEED_FULL
;
1643 dev
->compatible_speedmask
&= ~USB_SPEED_MASK_HIGH
;
1645 case usb_redir_speed_high
:
1646 speed
= "high speed";
1647 dev
->dev
.speed
= USB_SPEED_HIGH
;
1649 case usb_redir_speed_super
:
1650 speed
= "super speed";
1651 dev
->dev
.speed
= USB_SPEED_SUPER
;
1654 speed
= "unknown speed";
1655 dev
->dev
.speed
= USB_SPEED_FULL
;
1658 if (usbredirparser_peer_has_cap(dev
->parser
,
1659 usb_redir_cap_connect_device_version
)) {
1660 INFO("attaching %s device %04x:%04x version %d.%d class %02x\n",
1661 speed
, device_connect
->vendor_id
, device_connect
->product_id
,
1662 ((device_connect
->device_version_bcd
& 0xf000) >> 12) * 10 +
1663 ((device_connect
->device_version_bcd
& 0x0f00) >> 8),
1664 ((device_connect
->device_version_bcd
& 0x00f0) >> 4) * 10 +
1665 ((device_connect
->device_version_bcd
& 0x000f) >> 0),
1666 device_connect
->device_class
);
1668 INFO("attaching %s device %04x:%04x class %02x\n", speed
,
1669 device_connect
->vendor_id
, device_connect
->product_id
,
1670 device_connect
->device_class
);
1673 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
) | dev
->compatible_speedmask
;
1674 dev
->device_info
= *device_connect
;
1676 if (usbredir_check_filter(dev
)) {
1677 WARNING("Device %04x:%04x rejected by device filter, not attaching\n",
1678 device_connect
->vendor_id
, device_connect
->product_id
);
1682 usbredir_check_bulk_receiving(dev
);
1683 timer_mod(dev
->attach_timer
, dev
->next_attach_time
);
1686 static void usbredir_device_disconnect(void *priv
)
1688 USBRedirDevice
*dev
= priv
;
1690 /* Stop any pending attaches */
1691 timer_del(dev
->attach_timer
);
1693 if (dev
->dev
.attached
) {
1694 DPRINTF("detaching device\n");
1695 usb_device_detach(&dev
->dev
);
1697 * Delay next usb device attach to give the guest a chance to see
1698 * see the detach / attach in case of quick close / open succession
1700 dev
->next_attach_time
= qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL
) + 200;
1703 /* Reset state so that the next dev connected starts with a clean slate */
1704 usbredir_cleanup_device_queues(dev
);
1705 usbredir_init_endpoints(dev
);
1706 dev
->interface_info
.interface_count
= NO_INTERFACE_INFO
;
1709 dev
->compatible_speedmask
= USB_SPEED_MASK_FULL
| USB_SPEED_MASK_HIGH
;
1712 static void usbredir_interface_info(void *priv
,
1713 struct usb_redir_interface_info_header
*interface_info
)
1715 USBRedirDevice
*dev
= priv
;
1717 dev
->interface_info
= *interface_info
;
1720 * If we receive interface info after the device has already been
1721 * connected (ie on a set_config), re-check interface dependent things.
1723 if (timer_pending(dev
->attach_timer
) || dev
->dev
.attached
) {
1724 usbredir_check_bulk_receiving(dev
);
1725 if (usbredir_check_filter(dev
)) {
1726 ERROR("Device no longer matches filter after interface info "
1727 "change, disconnecting!\n");
1732 static void usbredir_mark_speed_incompatible(USBRedirDevice
*dev
, int speed
)
1734 dev
->compatible_speedmask
&= ~(1 << speed
);
1735 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
) | dev
->compatible_speedmask
;
1738 static void usbredir_set_pipeline(USBRedirDevice
*dev
, struct USBEndpoint
*uep
)
1740 if (uep
->type
!= USB_ENDPOINT_XFER_BULK
) {
1743 if (uep
->pid
== USB_TOKEN_OUT
) {
1744 uep
->pipeline
= true;
1746 if (uep
->pid
== USB_TOKEN_IN
&& uep
->max_packet_size
!= 0 &&
1747 usbredirparser_peer_has_cap(dev
->parser
,
1748 usb_redir_cap_32bits_bulk_length
)) {
1749 uep
->pipeline
= true;
1753 static void usbredir_setup_usb_eps(USBRedirDevice
*dev
)
1755 struct USBEndpoint
*usb_ep
;
1758 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1759 usb_ep
= I2USBEP(dev
, i
);
1760 usb_ep
->type
= dev
->endpoint
[i
].type
;
1761 usb_ep
->ifnum
= dev
->endpoint
[i
].interface
;
1762 usb_ep
->max_packet_size
= dev
->endpoint
[i
].max_packet_size
;
1763 usb_ep
->max_streams
= dev
->endpoint
[i
].max_streams
;
1764 usbredir_set_pipeline(dev
, usb_ep
);
1768 static void usbredir_ep_info(void *priv
,
1769 struct usb_redir_ep_info_header
*ep_info
)
1771 USBRedirDevice
*dev
= priv
;
1774 assert(dev
!= NULL
);
1775 for (i
= 0; i
< MAX_ENDPOINTS
; i
++) {
1776 dev
->endpoint
[i
].type
= ep_info
->type
[i
];
1777 dev
->endpoint
[i
].interval
= ep_info
->interval
[i
];
1778 dev
->endpoint
[i
].interface
= ep_info
->interface
[i
];
1779 if (usbredirparser_peer_has_cap(dev
->parser
,
1780 usb_redir_cap_ep_info_max_packet_size
)) {
1781 dev
->endpoint
[i
].max_packet_size
= ep_info
->max_packet_size
[i
];
1783 #if USBREDIR_VERSION >= 0x000700
1784 if (usbredirparser_peer_has_cap(dev
->parser
,
1785 usb_redir_cap_bulk_streams
)) {
1786 dev
->endpoint
[i
].max_streams
= ep_info
->max_streams
[i
];
1789 switch (dev
->endpoint
[i
].type
) {
1790 case usb_redir_type_invalid
:
1792 case usb_redir_type_iso
:
1793 usbredir_mark_speed_incompatible(dev
, USB_SPEED_FULL
);
1794 usbredir_mark_speed_incompatible(dev
, USB_SPEED_HIGH
);
1796 case usb_redir_type_interrupt
:
1797 if (!usbredirparser_peer_has_cap(dev
->parser
,
1798 usb_redir_cap_ep_info_max_packet_size
) ||
1799 ep_info
->max_packet_size
[i
] > 64) {
1800 usbredir_mark_speed_incompatible(dev
, USB_SPEED_FULL
);
1802 if (!usbredirparser_peer_has_cap(dev
->parser
,
1803 usb_redir_cap_ep_info_max_packet_size
) ||
1804 ep_info
->max_packet_size
[i
] > 1024) {
1805 usbredir_mark_speed_incompatible(dev
, USB_SPEED_HIGH
);
1807 if (dev
->endpoint
[i
].interval
== 0) {
1808 ERROR("Received 0 interval for isoc or irq endpoint\n");
1809 usbredir_reject_device(dev
);
1813 case usb_redir_type_control
:
1814 case usb_redir_type_bulk
:
1815 DPRINTF("ep: %02X type: %d interface: %d\n", I2EP(i
),
1816 dev
->endpoint
[i
].type
, dev
->endpoint
[i
].interface
);
1819 ERROR("Received invalid endpoint type\n");
1820 usbredir_reject_device(dev
);
1824 /* The new ep info may have caused a speed incompatibility, recheck */
1825 if (dev
->dev
.attached
&&
1826 !(dev
->dev
.port
->speedmask
& dev
->dev
.speedmask
)) {
1827 ERROR("Device no longer matches speed after endpoint info change, "
1828 "disconnecting!\n");
1829 usbredir_reject_device(dev
);
1832 usbredir_setup_usb_eps(dev
);
1833 usbredir_check_bulk_receiving(dev
);
1836 static void usbredir_configuration_status(void *priv
, uint64_t id
,
1837 struct usb_redir_configuration_status_header
*config_status
)
1839 USBRedirDevice
*dev
= priv
;
1842 DPRINTF("set config status %d config %d id %"PRIu64
"\n",
1843 config_status
->status
, config_status
->configuration
, id
);
1845 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1847 if (dev
->dev
.setup_buf
[0] & USB_DIR_IN
) {
1848 dev
->dev
.data_buf
[0] = config_status
->configuration
;
1849 p
->actual_length
= 1;
1851 usbredir_handle_status(dev
, p
, config_status
->status
);
1852 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1856 static void usbredir_alt_setting_status(void *priv
, uint64_t id
,
1857 struct usb_redir_alt_setting_status_header
*alt_setting_status
)
1859 USBRedirDevice
*dev
= priv
;
1862 DPRINTF("alt status %d intf %d alt %d id: %"PRIu64
"\n",
1863 alt_setting_status
->status
, alt_setting_status
->interface
,
1864 alt_setting_status
->alt
, id
);
1866 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1868 if (dev
->dev
.setup_buf
[0] & USB_DIR_IN
) {
1869 dev
->dev
.data_buf
[0] = alt_setting_status
->alt
;
1870 p
->actual_length
= 1;
1872 usbredir_handle_status(dev
, p
, alt_setting_status
->status
);
1873 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
1877 static void usbredir_iso_stream_status(void *priv
, uint64_t id
,
1878 struct usb_redir_iso_stream_status_header
*iso_stream_status
)
1880 USBRedirDevice
*dev
= priv
;
1881 uint8_t ep
= iso_stream_status
->endpoint
;
1883 DPRINTF("iso status %d ep %02X id %"PRIu64
"\n", iso_stream_status
->status
,
1886 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].iso_started
) {
1890 dev
->endpoint
[EP2I(ep
)].iso_error
= iso_stream_status
->status
;
1891 if (iso_stream_status
->status
== usb_redir_stall
) {
1892 DPRINTF("iso stream stopped by peer ep %02X\n", ep
);
1893 dev
->endpoint
[EP2I(ep
)].iso_started
= 0;
1897 static void usbredir_interrupt_receiving_status(void *priv
, uint64_t id
,
1898 struct usb_redir_interrupt_receiving_status_header
1899 *interrupt_receiving_status
)
1901 USBRedirDevice
*dev
= priv
;
1902 uint8_t ep
= interrupt_receiving_status
->endpoint
;
1904 DPRINTF("interrupt recv status %d ep %02X id %"PRIu64
"\n",
1905 interrupt_receiving_status
->status
, ep
, id
);
1907 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].interrupt_started
) {
1911 dev
->endpoint
[EP2I(ep
)].interrupt_error
=
1912 interrupt_receiving_status
->status
;
1913 if (interrupt_receiving_status
->status
== usb_redir_stall
) {
1914 DPRINTF("interrupt receiving stopped by peer ep %02X\n", ep
);
1915 dev
->endpoint
[EP2I(ep
)].interrupt_started
= 0;
1919 static void usbredir_bulk_streams_status(void *priv
, uint64_t id
,
1920 struct usb_redir_bulk_streams_status_header
*bulk_streams_status
)
1922 #if USBREDIR_VERSION >= 0x000700
1923 USBRedirDevice
*dev
= priv
;
1925 if (bulk_streams_status
->status
== usb_redir_success
) {
1926 DPRINTF("bulk streams status %d eps %08x\n",
1927 bulk_streams_status
->status
, bulk_streams_status
->endpoints
);
1929 ERROR("bulk streams %s failed status %d eps %08x\n",
1930 (bulk_streams_status
->no_streams
== 0) ? "free" : "alloc",
1931 bulk_streams_status
->status
, bulk_streams_status
->endpoints
);
1932 ERROR("usb-redir-host does not provide streams, disconnecting\n");
1933 usbredir_reject_device(dev
);
1938 static void usbredir_bulk_receiving_status(void *priv
, uint64_t id
,
1939 struct usb_redir_bulk_receiving_status_header
*bulk_receiving_status
)
1941 USBRedirDevice
*dev
= priv
;
1942 uint8_t ep
= bulk_receiving_status
->endpoint
;
1944 DPRINTF("bulk recv status %d ep %02X id %"PRIu64
"\n",
1945 bulk_receiving_status
->status
, ep
, id
);
1947 if (!dev
->dev
.attached
|| !dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
) {
1951 if (bulk_receiving_status
->status
== usb_redir_stall
) {
1952 DPRINTF("bulk receiving stopped by peer ep %02X\n", ep
);
1953 dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
= 0;
1957 static void usbredir_control_packet(void *priv
, uint64_t id
,
1958 struct usb_redir_control_packet_header
*control_packet
,
1959 uint8_t *data
, int data_len
)
1961 USBRedirDevice
*dev
= priv
;
1963 int len
= control_packet
->length
;
1965 DPRINTF("ctrl-in status %d len %d id %"PRIu64
"\n", control_packet
->status
,
1968 /* Fix up USB-3 ep0 maxpacket size to allow superspeed connected devices
1969 * to work redirected to a not superspeed capable hcd */
1970 if (dev
->dev
.speed
== USB_SPEED_SUPER
&&
1971 !((dev
->dev
.port
->speedmask
& USB_SPEED_MASK_SUPER
)) &&
1972 control_packet
->requesttype
== 0x80 &&
1973 control_packet
->request
== 6 &&
1974 control_packet
->value
== 0x100 && control_packet
->index
== 0 &&
1975 data_len
>= 18 && data
[7] == 9) {
1979 p
= usbredir_find_packet_by_id(dev
, 0, id
);
1981 usbredir_handle_status(dev
, p
, control_packet
->status
);
1983 usbredir_log_data(dev
, "ctrl data in:", data
, data_len
);
1984 if (data_len
> sizeof(dev
->dev
.data_buf
)) {
1985 ERROR("ctrl buffer too small (%d > %zu)\n",
1986 data_len
, sizeof(dev
->dev
.data_buf
));
1987 p
->status
= USB_RET_STALL
;
1988 data_len
= len
= sizeof(dev
->dev
.data_buf
);
1990 memcpy(dev
->dev
.data_buf
, data
, data_len
);
1992 p
->actual_length
= len
;
1994 * If this is GET_DESCRIPTOR request for configuration descriptor,
1995 * remove 'remote wakeup' flag from it to prevent idle power down
1998 if (dev
->suppress_remote_wake
&&
1999 control_packet
->requesttype
== USB_DIR_IN
&&
2000 control_packet
->request
== USB_REQ_GET_DESCRIPTOR
&&
2001 control_packet
->value
== (USB_DT_CONFIG
<< 8) &&
2002 control_packet
->index
== 0 &&
2003 /* bmAttributes field of config descriptor */
2004 len
> 7 && (dev
->dev
.data_buf
[7] & USB_CFG_ATT_WAKEUP
)) {
2005 DPRINTF("Removed remote wake %04X:%04X\n",
2006 dev
->device_info
.vendor_id
,
2007 dev
->device_info
.product_id
);
2008 dev
->dev
.data_buf
[7] &= ~USB_CFG_ATT_WAKEUP
;
2010 usb_generic_async_ctrl_complete(&dev
->dev
, p
);
2015 static void usbredir_bulk_packet(void *priv
, uint64_t id
,
2016 struct usb_redir_bulk_packet_header
*bulk_packet
,
2017 uint8_t *data
, int data_len
)
2019 USBRedirDevice
*dev
= priv
;
2020 uint8_t ep
= bulk_packet
->endpoint
;
2021 int len
= (bulk_packet
->length_high
<< 16) | bulk_packet
->length
;
2024 DPRINTF("bulk-in status %d ep %02X stream %u len %d id %"PRIu64
"\n",
2025 bulk_packet
->status
, ep
, bulk_packet
->stream_id
, len
, id
);
2027 p
= usbredir_find_packet_by_id(dev
, ep
, id
);
2029 size_t size
= usb_packet_size(p
);
2030 usbredir_handle_status(dev
, p
, bulk_packet
->status
);
2032 usbredir_log_data(dev
, "bulk data in:", data
, data_len
);
2033 if (data_len
> size
) {
2034 ERROR("bulk got more data then requested (%d > %zd)\n",
2035 data_len
, p
->iov
.size
);
2036 p
->status
= USB_RET_BABBLE
;
2037 data_len
= len
= size
;
2039 usb_packet_copy(p
, data
, data_len
);
2041 p
->actual_length
= len
;
2042 if (p
->pid
== USB_TOKEN_IN
&& p
->ep
->pipeline
) {
2043 usb_combined_input_packet_complete(&dev
->dev
, p
);
2045 usb_packet_complete(&dev
->dev
, p
);
2051 static void usbredir_iso_packet(void *priv
, uint64_t id
,
2052 struct usb_redir_iso_packet_header
*iso_packet
,
2053 uint8_t *data
, int data_len
)
2055 USBRedirDevice
*dev
= priv
;
2056 uint8_t ep
= iso_packet
->endpoint
;
2058 DPRINTF2("iso-in status %d ep %02X len %d id %"PRIu64
"\n",
2059 iso_packet
->status
, ep
, data_len
, id
);
2061 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_ISOC
) {
2062 ERROR("received iso packet for non iso endpoint %02X\n", ep
);
2067 if (dev
->endpoint
[EP2I(ep
)].iso_started
== 0) {
2068 DPRINTF("received iso packet for non started stream ep %02X\n", ep
);
2073 /* bufp_alloc also adds the packet to the ep queue */
2074 bufp_alloc(dev
, data
, data_len
, iso_packet
->status
, ep
, data
);
2077 static void usbredir_interrupt_packet(void *priv
, uint64_t id
,
2078 struct usb_redir_interrupt_packet_header
*interrupt_packet
,
2079 uint8_t *data
, int data_len
)
2081 USBRedirDevice
*dev
= priv
;
2082 uint8_t ep
= interrupt_packet
->endpoint
;
2084 DPRINTF("interrupt-in status %d ep %02X len %d id %"PRIu64
"\n",
2085 interrupt_packet
->status
, ep
, data_len
, id
);
2087 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_INT
) {
2088 ERROR("received int packet for non interrupt endpoint %02X\n", ep
);
2093 if (ep
& USB_DIR_IN
) {
2094 if (dev
->endpoint
[EP2I(ep
)].interrupt_started
== 0) {
2095 DPRINTF("received int packet while not started ep %02X\n", ep
);
2100 /* bufp_alloc also adds the packet to the ep queue */
2101 bufp_alloc(dev
, data
, data_len
, interrupt_packet
->status
, ep
, data
);
2103 /* insufficient data solved with USB_RET_NAK */
2104 usb_wakeup(usb_ep_get(&dev
->dev
, USB_TOKEN_IN
, ep
& 0x0f), 0);
2107 * We report output interrupt packets as completed directly upon
2108 * submission, so all we can do here if one failed is warn.
2110 if (interrupt_packet
->status
) {
2111 WARNING("interrupt output failed status %d ep %02X id %"PRIu64
"\n",
2112 interrupt_packet
->status
, ep
, id
);
2117 static void usbredir_buffered_bulk_packet(void *priv
, uint64_t id
,
2118 struct usb_redir_buffered_bulk_packet_header
*buffered_bulk_packet
,
2119 uint8_t *data
, int data_len
)
2121 USBRedirDevice
*dev
= priv
;
2122 uint8_t status
, ep
= buffered_bulk_packet
->endpoint
;
2123 void *free_on_destroy
;
2126 DPRINTF("buffered-bulk-in status %d ep %02X len %d id %"PRIu64
"\n",
2127 buffered_bulk_packet
->status
, ep
, data_len
, id
);
2129 if (dev
->endpoint
[EP2I(ep
)].type
!= USB_ENDPOINT_XFER_BULK
) {
2130 ERROR("received buffered-bulk packet for non bulk ep %02X\n", ep
);
2135 if (dev
->endpoint
[EP2I(ep
)].bulk_receiving_started
== 0) {
2136 DPRINTF("received buffered-bulk packet on not started ep %02X\n", ep
);
2141 /* Data must be in maxp chunks for buffered_bulk_add_*_data_to_packet */
2142 len
= dev
->endpoint
[EP2I(ep
)].max_packet_size
;
2143 status
= usb_redir_success
;
2144 free_on_destroy
= NULL
;
2145 for (i
= 0; i
< data_len
; i
+= len
) {
2147 if (len
>= (data_len
- i
)) {
2149 status
= buffered_bulk_packet
->status
;
2150 free_on_destroy
= data
;
2152 /* bufp_alloc also adds the packet to the ep queue */
2153 r
= bufp_alloc(dev
, data
+ i
, len
, status
, ep
, free_on_destroy
);
2159 if (dev
->endpoint
[EP2I(ep
)].pending_async_packet
) {
2160 USBPacket
*p
= dev
->endpoint
[EP2I(ep
)].pending_async_packet
;
2161 dev
->endpoint
[EP2I(ep
)].pending_async_packet
= NULL
;
2162 usbredir_buffered_bulk_in_complete(dev
, p
, ep
);
2163 usb_packet_complete(&dev
->dev
, p
);
2171 static int usbredir_pre_save(void *priv
)
2173 USBRedirDevice
*dev
= priv
;
2175 usbredir_fill_already_in_flight(dev
);
2180 static int usbredir_post_load(void *priv
, int version_id
)
2182 USBRedirDevice
*dev
= priv
;
2184 if (dev
== NULL
|| dev
->parser
== NULL
) {
2188 switch (dev
->device_info
.speed
) {
2189 case usb_redir_speed_low
:
2190 dev
->dev
.speed
= USB_SPEED_LOW
;
2192 case usb_redir_speed_full
:
2193 dev
->dev
.speed
= USB_SPEED_FULL
;
2195 case usb_redir_speed_high
:
2196 dev
->dev
.speed
= USB_SPEED_HIGH
;
2198 case usb_redir_speed_super
:
2199 dev
->dev
.speed
= USB_SPEED_SUPER
;
2202 dev
->dev
.speed
= USB_SPEED_FULL
;
2204 dev
->dev
.speedmask
= (1 << dev
->dev
.speed
);
2206 usbredir_setup_usb_eps(dev
);
2207 usbredir_check_bulk_receiving(dev
);
2212 /* For usbredirparser migration */
2213 static int usbredir_put_parser(QEMUFile
*f
, void *priv
, size_t unused
,
2214 const VMStateField
*field
, QJSON
*vmdesc
)
2216 USBRedirDevice
*dev
= priv
;
2220 if (dev
->parser
== NULL
) {
2221 qemu_put_be32(f
, 0);
2225 usbredirparser_serialize(dev
->parser
, &data
, &len
);
2226 qemu_oom_check(data
);
2228 qemu_put_be32(f
, len
);
2229 qemu_put_buffer(f
, data
, len
);
2236 static int usbredir_get_parser(QEMUFile
*f
, void *priv
, size_t unused
,
2237 const VMStateField
*field
)
2239 USBRedirDevice
*dev
= priv
;
2243 len
= qemu_get_be32(f
);
2249 * If our chardev is not open already at this point the usbredir connection
2250 * has been broken (non seamless migration, or restore from disk).
2252 * In this case create a temporary parser to receive the migration data,
2253 * and schedule the close_bh to report the device as disconnected to the
2254 * guest and to destroy the parser again.
2256 if (dev
->parser
== NULL
) {
2257 WARNING("usb-redir connection broken during migration\n");
2258 usbredir_create_parser(dev
);
2259 qemu_bh_schedule(dev
->chardev_close_bh
);
2262 data
= g_malloc(len
);
2263 qemu_get_buffer(f
, data
, len
);
2265 ret
= usbredirparser_unserialize(dev
->parser
, data
, len
);
2272 static const VMStateInfo usbredir_parser_vmstate_info
= {
2273 .name
= "usb-redir-parser",
2274 .put
= usbredir_put_parser
,
2275 .get
= usbredir_get_parser
,
2279 /* For buffered packets (iso/irq) queue migration */
2280 static int usbredir_put_bufpq(QEMUFile
*f
, void *priv
, size_t unused
,
2281 const VMStateField
*field
, QJSON
*vmdesc
)
2283 struct endp_data
*endp
= priv
;
2284 USBRedirDevice
*dev
= endp
->dev
;
2285 struct buf_packet
*bufp
;
2288 qemu_put_be32(f
, endp
->bufpq_size
);
2289 QTAILQ_FOREACH(bufp
, &endp
->bufpq
, next
) {
2290 len
= bufp
->len
- bufp
->offset
;
2291 DPRINTF("put_bufpq %d/%d len %d status %d\n", i
+ 1, endp
->bufpq_size
,
2293 qemu_put_be32(f
, len
);
2294 qemu_put_be32(f
, bufp
->status
);
2295 qemu_put_buffer(f
, bufp
->data
+ bufp
->offset
, len
);
2298 assert(i
== endp
->bufpq_size
);
2303 static int usbredir_get_bufpq(QEMUFile
*f
, void *priv
, size_t unused
,
2304 const VMStateField
*field
)
2306 struct endp_data
*endp
= priv
;
2307 USBRedirDevice
*dev
= endp
->dev
;
2308 struct buf_packet
*bufp
;
2311 endp
->bufpq_size
= qemu_get_be32(f
);
2312 for (i
= 0; i
< endp
->bufpq_size
; i
++) {
2313 bufp
= g_new(struct buf_packet
, 1);
2314 bufp
->len
= qemu_get_be32(f
);
2315 bufp
->status
= qemu_get_be32(f
);
2317 bufp
->data
= qemu_oom_check(malloc(bufp
->len
)); /* regular malloc! */
2318 bufp
->free_on_destroy
= bufp
->data
;
2319 qemu_get_buffer(f
, bufp
->data
, bufp
->len
);
2320 QTAILQ_INSERT_TAIL(&endp
->bufpq
, bufp
, next
);
2321 DPRINTF("get_bufpq %d/%d len %d status %d\n", i
+ 1, endp
->bufpq_size
,
2322 bufp
->len
, bufp
->status
);
2327 static const VMStateInfo usbredir_ep_bufpq_vmstate_info
= {
2328 .name
= "usb-redir-bufpq",
2329 .put
= usbredir_put_bufpq
,
2330 .get
= usbredir_get_bufpq
,
2334 /* For endp_data migration */
2335 static bool usbredir_bulk_receiving_needed(void *priv
)
2337 struct endp_data
*endp
= priv
;
2339 return endp
->bulk_receiving_started
;
2342 static const VMStateDescription usbredir_bulk_receiving_vmstate
= {
2343 .name
= "usb-redir-ep/bulk-receiving",
2345 .minimum_version_id
= 1,
2346 .needed
= usbredir_bulk_receiving_needed
,
2347 .fields
= (VMStateField
[]) {
2348 VMSTATE_UINT8(bulk_receiving_started
, struct endp_data
),
2349 VMSTATE_END_OF_LIST()
2353 static bool usbredir_stream_needed(void *priv
)
2355 struct endp_data
*endp
= priv
;
2357 return endp
->max_streams
;
2360 static const VMStateDescription usbredir_stream_vmstate
= {
2361 .name
= "usb-redir-ep/stream-state",
2363 .minimum_version_id
= 1,
2364 .needed
= usbredir_stream_needed
,
2365 .fields
= (VMStateField
[]) {
2366 VMSTATE_UINT32(max_streams
, struct endp_data
),
2367 VMSTATE_END_OF_LIST()
2371 static const VMStateDescription usbredir_ep_vmstate
= {
2372 .name
= "usb-redir-ep",
2374 .minimum_version_id
= 1,
2375 .fields
= (VMStateField
[]) {
2376 VMSTATE_UINT8(type
, struct endp_data
),
2377 VMSTATE_UINT8(interval
, struct endp_data
),
2378 VMSTATE_UINT8(interface
, struct endp_data
),
2379 VMSTATE_UINT16(max_packet_size
, struct endp_data
),
2380 VMSTATE_UINT8(iso_started
, struct endp_data
),
2381 VMSTATE_UINT8(iso_error
, struct endp_data
),
2382 VMSTATE_UINT8(interrupt_started
, struct endp_data
),
2383 VMSTATE_UINT8(interrupt_error
, struct endp_data
),
2384 VMSTATE_UINT8(bufpq_prefilled
, struct endp_data
),
2385 VMSTATE_UINT8(bufpq_dropping_packets
, struct endp_data
),
2389 .field_exists
= NULL
,
2391 .info
= &usbredir_ep_bufpq_vmstate_info
,
2392 .flags
= VMS_SINGLE
,
2395 VMSTATE_INT32(bufpq_target_size
, struct endp_data
),
2396 VMSTATE_END_OF_LIST()
2398 .subsections
= (const VMStateDescription
*[]) {
2399 &usbredir_bulk_receiving_vmstate
,
2400 &usbredir_stream_vmstate
,
2406 /* For PacketIdQueue migration */
2407 static int usbredir_put_packet_id_q(QEMUFile
*f
, void *priv
, size_t unused
,
2408 const VMStateField
*field
, QJSON
*vmdesc
)
2410 struct PacketIdQueue
*q
= priv
;
2411 USBRedirDevice
*dev
= q
->dev
;
2412 struct PacketIdQueueEntry
*e
;
2413 int remain
= q
->size
;
2415 DPRINTF("put_packet_id_q %s size %d\n", q
->name
, q
->size
);
2416 qemu_put_be32(f
, q
->size
);
2417 QTAILQ_FOREACH(e
, &q
->head
, next
) {
2418 qemu_put_be64(f
, e
->id
);
2421 assert(remain
== 0);
2426 static int usbredir_get_packet_id_q(QEMUFile
*f
, void *priv
, size_t unused
,
2427 const VMStateField
*field
)
2429 struct PacketIdQueue
*q
= priv
;
2430 USBRedirDevice
*dev
= q
->dev
;
2434 size
= qemu_get_be32(f
);
2435 DPRINTF("get_packet_id_q %s size %d\n", q
->name
, size
);
2436 for (i
= 0; i
< size
; i
++) {
2437 id
= qemu_get_be64(f
);
2438 packet_id_queue_add(q
, id
);
2440 assert(q
->size
== size
);
2444 static const VMStateInfo usbredir_ep_packet_id_q_vmstate_info
= {
2445 .name
= "usb-redir-packet-id-q",
2446 .put
= usbredir_put_packet_id_q
,
2447 .get
= usbredir_get_packet_id_q
,
2450 static const VMStateDescription usbredir_ep_packet_id_queue_vmstate
= {
2451 .name
= "usb-redir-packet-id-queue",
2453 .minimum_version_id
= 1,
2454 .fields
= (VMStateField
[]) {
2458 .field_exists
= NULL
,
2460 .info
= &usbredir_ep_packet_id_q_vmstate_info
,
2461 .flags
= VMS_SINGLE
,
2464 VMSTATE_END_OF_LIST()
2469 /* For usb_redir_device_connect_header migration */
2470 static const VMStateDescription usbredir_device_info_vmstate
= {
2471 .name
= "usb-redir-device-info",
2473 .minimum_version_id
= 1,
2474 .fields
= (VMStateField
[]) {
2475 VMSTATE_UINT8(speed
, struct usb_redir_device_connect_header
),
2476 VMSTATE_UINT8(device_class
, struct usb_redir_device_connect_header
),
2477 VMSTATE_UINT8(device_subclass
, struct usb_redir_device_connect_header
),
2478 VMSTATE_UINT8(device_protocol
, struct usb_redir_device_connect_header
),
2479 VMSTATE_UINT16(vendor_id
, struct usb_redir_device_connect_header
),
2480 VMSTATE_UINT16(product_id
, struct usb_redir_device_connect_header
),
2481 VMSTATE_UINT16(device_version_bcd
,
2482 struct usb_redir_device_connect_header
),
2483 VMSTATE_END_OF_LIST()
2488 /* For usb_redir_interface_info_header migration */
2489 static const VMStateDescription usbredir_interface_info_vmstate
= {
2490 .name
= "usb-redir-interface-info",
2492 .minimum_version_id
= 1,
2493 .fields
= (VMStateField
[]) {
2494 VMSTATE_UINT32(interface_count
,
2495 struct usb_redir_interface_info_header
),
2496 VMSTATE_UINT8_ARRAY(interface
,
2497 struct usb_redir_interface_info_header
, 32),
2498 VMSTATE_UINT8_ARRAY(interface_class
,
2499 struct usb_redir_interface_info_header
, 32),
2500 VMSTATE_UINT8_ARRAY(interface_subclass
,
2501 struct usb_redir_interface_info_header
, 32),
2502 VMSTATE_UINT8_ARRAY(interface_protocol
,
2503 struct usb_redir_interface_info_header
, 32),
2504 VMSTATE_END_OF_LIST()
2509 /* And finally the USBRedirDevice vmstate itself */
2510 static const VMStateDescription usbredir_vmstate
= {
2511 .name
= "usb-redir",
2513 .minimum_version_id
= 1,
2514 .pre_save
= usbredir_pre_save
,
2515 .post_load
= usbredir_post_load
,
2516 .fields
= (VMStateField
[]) {
2517 VMSTATE_USB_DEVICE(dev
, USBRedirDevice
),
2518 VMSTATE_TIMER_PTR(attach_timer
, USBRedirDevice
),
2522 .field_exists
= NULL
,
2524 .info
= &usbredir_parser_vmstate_info
,
2525 .flags
= VMS_SINGLE
,
2528 VMSTATE_STRUCT_ARRAY(endpoint
, USBRedirDevice
, MAX_ENDPOINTS
, 1,
2529 usbredir_ep_vmstate
, struct endp_data
),
2530 VMSTATE_STRUCT(cancelled
, USBRedirDevice
, 1,
2531 usbredir_ep_packet_id_queue_vmstate
,
2532 struct PacketIdQueue
),
2533 VMSTATE_STRUCT(already_in_flight
, USBRedirDevice
, 1,
2534 usbredir_ep_packet_id_queue_vmstate
,
2535 struct PacketIdQueue
),
2536 VMSTATE_STRUCT(device_info
, USBRedirDevice
, 1,
2537 usbredir_device_info_vmstate
,
2538 struct usb_redir_device_connect_header
),
2539 VMSTATE_STRUCT(interface_info
, USBRedirDevice
, 1,
2540 usbredir_interface_info_vmstate
,
2541 struct usb_redir_interface_info_header
),
2542 VMSTATE_END_OF_LIST()
2546 static Property usbredir_properties
[] = {
2547 DEFINE_PROP_CHR("chardev", USBRedirDevice
, cs
),
2548 DEFINE_PROP_UINT8("debug", USBRedirDevice
, debug
, usbredirparser_warning
),
2549 DEFINE_PROP_STRING("filter", USBRedirDevice
, filter_str
),
2550 DEFINE_PROP_BOOL("streams", USBRedirDevice
, enable_streams
, true),
2551 DEFINE_PROP_BOOL("suppress-remote-wake", USBRedirDevice
,
2552 suppress_remote_wake
, true),
2553 DEFINE_PROP_END_OF_LIST(),
2556 static void usbredir_class_initfn(ObjectClass
*klass
, void *data
)
2558 USBDeviceClass
*uc
= USB_DEVICE_CLASS(klass
);
2559 DeviceClass
*dc
= DEVICE_CLASS(klass
);
2561 uc
->realize
= usbredir_realize
;
2562 uc
->product_desc
= "USB Redirection Device";
2563 uc
->unrealize
= usbredir_unrealize
;
2564 uc
->cancel_packet
= usbredir_cancel_packet
;
2565 uc
->handle_reset
= usbredir_handle_reset
;
2566 uc
->handle_data
= usbredir_handle_data
;
2567 uc
->handle_control
= usbredir_handle_control
;
2568 uc
->flush_ep_queue
= usbredir_flush_ep_queue
;
2569 uc
->ep_stopped
= usbredir_ep_stopped
;
2570 uc
->alloc_streams
= usbredir_alloc_streams
;
2571 uc
->free_streams
= usbredir_free_streams
;
2572 dc
->vmsd
= &usbredir_vmstate
;
2573 dc
->props
= usbredir_properties
;
2574 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
2577 static void usbredir_instance_init(Object
*obj
)
2579 USBDevice
*udev
= USB_DEVICE(obj
);
2580 USBRedirDevice
*dev
= USB_REDIRECT(udev
);
2582 device_add_bootindex_property(obj
, &dev
->bootindex
,
2587 static const TypeInfo usbredir_dev_info
= {
2588 .name
= TYPE_USB_REDIR
,
2589 .parent
= TYPE_USB_DEVICE
,
2590 .instance_size
= sizeof(USBRedirDevice
),
2591 .class_init
= usbredir_class_initfn
,
2592 .instance_init
= usbredir_instance_init
,
2595 static void usbredir_register_types(void)
2597 type_register_static(&usbredir_dev_info
);
2600 type_init(usbredir_register_types
)