1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
|
USB Network Redirection protocol description version 0.7 (19 May 2014)
Revisions
---------
Version 0.1
-Initial version (released as initial RFC without a version number)
Version 0.2
-Version demo-ed at FOSDEM 2011
-Remove usb_redir_report_descriptor packet, as it is not possible to get
the cached descriptors from the OS on all platforms and we can do without
-Replace vm-host with usb-guest
-Replace the synchroneous / asynchroneous commands nomenclature with
control / data packets
-Move the packet id to the main packet header shared by all packets
-Add note: "All integers in the protocol are send over the pipe in least
significant byte first order."
-Add note: "All structs are packed"
-s/data_size/length/
-Add an usb_redir_cancel_data_packet packet
-Add usb_redir_reset and usb_redir_reset_status packets
Version 0.3, released 14 July 2011
-First "stable" version, all later versions should be compatible with this
version
-Add an usb_redir_device_connect packet
-Add an usb_redir_device_disconnect packet
-Add an usb_redir_interface_info packet
-Add an usb_redir_ep_info packet
-Add support for interrupt transfers, add the following packets:
usb_redir_start_interrupt_receiving
usb_redir_stop_interrupt_receiving
usb_redir_interrupt_receiving_status
usb_redir_interrupt_packet
-Add a list with the possible values for the status field
-Report usb_redir_stall as iso status error to indicate a stream stop
-Drop usb_redir_disconnect status, instead the usb-host should always
send a usb_redir_device_disconnect packet on device disconnection. The
reason behind this is that having to handle disconnection from data packet
handlers make things unnecessarily hard for the usb-guest
-Drop usb_redir_reset_status, instead if reconnecting to the device fails
after reset the usb-host will send a usb_redir_device_disconnect packet
Version 0.3.1, released 18 August 2011
- No protocol changes
Version 0.3.2, released 3 January 2012
-The usb_redir_device_connect_header has been extended with a
device_version_bcd field. This is only send / received if both sides
have the usb_redir_cap_connect_device_version capability
Version 0.3.3, released 12 January 2012
- No protocol changes
Version 0.4, released 22 February 2012
- Add usb_redir_filter_reject and usb_redir_filter_filter packets and
an usb_redir_cap_filter capability flag
- Add an usb_redir_device_disconnect_ack packet and
an usb_redir_cap_device_disconnect_ack capability flag
Version 0.4.1, released 25 February 2012
- No protocol changes
Version 0.4.2, released 6 March 2012
- Add usb_redir_babble status code
- The usb_redir_ep_info_header has been extended with a max_packet_size field
This is only send / received if both sides have the
usb_redir_cap_ep_info_max_packet_size capability
Version 0.5, released 7 September 2012
- Add the posibility to use 64 bits packet ids
Version 0.5.3, released 7 October 2012
- Extend the length field in bulk packets headers to 32 bits, the extra 16
bits are only send / received if both sides have the
usb_redir_cap_32bits_bulk_length capability
Version 0.6, released 13 December 2012
- Add support for buffered bulk input, new packets:
usb_redir_start_bulk_receiving, usb_redir_stop_bulk_receiving,
usb_redir_bulk_receiving_status, usb_redir_buffered_bulk_packet
New capability: usb_redir_cap_bulk_receiving
Version 0.7, released 19 May 2014
- The usb_redir_ep_info_header has been extended with a max_streams field
This is only send / received if both sides have the
usb_redir_cap_bulk_streams capability.
- Change bulk_stream packet definitions to allow allocating / freeing
streams on multiple endpoints in one go, technically this is a protocol
change, but no-one has implemented usb_redir_cap_bulk_streams so far, so
we can safely do this
USB redirection protocol version 0.7
------------------------------------
The protocol described in this document is meant for tunneling usb transfers
to a single usb device. Note: not an entire hub, only a single device.
The most significant use case for this is taking a usb device attached to
some machine "a" which acts as a client / viewer to a virtual machine "v"
hosted on another machine "b", and make the usb device show up inside the
virtual machine as if it were attached directly to the virtual machine "v".
The described protocol assumes a reliable ordered bidirectional transport is
available, for example a tcp socket. All integers in the protocol are send
over the pipe in least significant byte first order. All structs send over
the pipe are packed (no padding).
Definitions:
usb-device: The usb-device whose usb transfers are being tunneled.
usb-guest: The entity connecting to the usb-device and using it as if
connected directly to it. For example a virtual machine running a guest
os which accesses a usb-device over the network as if it is part of the
virtual machine.
usb-host: The entity making the usb-device available for use by a usb-guest.
For example a deamon on a machine which "exports" the usb-device over the
network which then "appears" inside a virtual machine on another machine.
Basic packet structure / communication
--------------------------------------
Each packet exchanged between the usb-guest and the usb-host starts with a
usb_redir_header, followed by an optional packet type specific header
follow by optional additional data.
The usb_redir_header each packet starts with looks as follows:
struct usb_redir_header {
uint32_t type;
uint32_t length;
uint32_t id;
}
Or, if both sides have the usb_redir_cap_64bits_ids capability, it looks as
follows! :
struct usb_redir_header {
uint32_t type;
uint32_t length;
uint64_t id;
}
type: This identifies the type of packet, from the type enum
length: Length of the optional type specific packet header + the optional
additional data. Can be 0.
id: A unique id, generated by the usb-guest when sending a packet,
the usb-host will use the same id in its response packet, allowing
the usb-guest to match responses to its original requests.
There are 2 types of packets:
1) control packets
2) data packets
Control packets are handled synchroneously inside the usb-host, it will hand
the request over to the host os and then *wait* for a response. The usb-host
will thus stop processing further packets. Where as for data packets the
usb-host hands them over to the host os with the request to let the usb-host
process know when there is a respone from the usb-device.
Note that control packets should only be send to the usb-host when no data
packets are pending on the device / interface / endpoint affected by the
control packet. Any pending data packets will get dropped, and any active
iso streams / allocated bulk streams will get stopped / free-ed.
Packet type list
----------------
control packets:
usb_redir_hello
usb_redir_device_connect
usb_redir_device_disconnect
usb_redir_reset
usb_redir_interface_info
usb_redir_ep_info
usb_redir_set_configuration
usb_redir_get_configuration
usb_redir_configuration_status
usb_redir_set_alt_setting
usb_redir_get_alt_setting
usb_redir_alt_setting_status
usb_redir_start_iso_stream
usb_redir_stop_iso_stream
usb_redir_iso_stream_status
usb_redir_start_interrupt_receiving
usb_redir_stop_interrupt_receiving
usb_redir_interrupt_receiving_status
usb_redir_alloc_bulk_streams
usb_redir_free_bulk_streams
usb_redir_bulk_streams_status
usb_redir_cancel_data_packet
usb_redir_filter_reject
usb_redir_filter_filter
usb_redir_device_disconnect_ack
usb_redir_start_bulk_receiving
usb_redir_stop_bulk_receiving
usb_redir_bulk_receiving_status
data packets:
usb_redir_control_packet
usb_redir_bulk_packet
usb_redir_iso_packet
usb_redir_interrupt_packet
usb_redir_buffered_bulk_packet
Status code list
----------------
Many usb-host replies have a status field, this field can have the following
values:
enum {
usb_redir_success,
usb_redir_cancelled, /* The transfer was cancelled */
usb_redir_inval, /* Invalid packet type / length / ep, etc. */
usb_redir_ioerror, /* IO error */
usb_redir_stall, /* Stalled */
usb_redir_timeout, /* Request timed out */
usb_redir_babble, /* The device has "babbled" */
};
Note that in future versions there may be additional status codes to signal
new / other *error* conditions. So any unknown status value should be
interpreted as an error.
usb_redir_hello
---------------
usb_redir_header.type: usb_redir_hello
usb_redir_header.length: <see description>
usb_redir_header.id: 0 (always as this is an unsolicited packet)
struct usb_redir_hello_header {
char version[64];
uint32_t capabilities[0];
}
No packet type specific additional data.
A packet of this type is send by both sides as soon as a connection is
establised. It is mandatory that this packet is the first packet send by
both sides! This packet contains:
version: A free form 0 terminated version string, useful for logging
should not be parsed! Suggested format: "qemu 0.13",
"usb-redir-daemon 0.1", etc.
capabilities: A variable length array for announcing capabilities.
Note that since the peer caps are not known until the usb_redir_hello
packet is received, the hello packet always has 32 bits id fields!
The value of the length field depends on the size of the capabilities array.
If we cross the 32 capabilities count, it will go from 1 uint32_t to 2,
etc. the value is 64 + capabilities-array-size * sizeof(uint32_t).
Currently the following capabilities are defined:
enum {
/* Supports USB 3 bulk streams */
usb_redir_cap_bulk_streams,
/* The device_connect packet has the device_version_bcd field */
usb_redir_cap_connect_device_version,
/* Supports usb_redir_filter_reject and usb_redir_filter_filter pkts */
usb_redir_cap_filter,
/* Supports the usb_redir_device_disconnect_ack packet */
usb_redir_cap_device_disconnect_ack,
/* The ep_info packet has the max_packet_size field */
usb_redir_cap_ep_info_max_packet_size,
/* Supports 64 bits ids in usb_redir_header */
usb_redir_cap_64bits_ids,
/* Supports 32 bits length in usb_redir_bulk_packet_header */
usb_redir_cap_32bits_bulk_length,
/* Supports bulk receiving / buffered bulk input */
usb_redir_cap_bulk_receiving,
};
usb_redir_device_connect
------------------------
usb_redir_header.type: usb_redir_device_connect
usb_redir_header.length: sizeof(usb_redir_device_connect_header)
usb_redir_header.id: 0 (always as this is an unsolicited packet)
enum {
usb_redir_speed_low,
usb_redir_speed_full,
usb_redir_speed_high,
usb_redir_speed_super,
usb_redir_speed_unknown = 255
}
struct usb_redir_device_connect_header {
uint8_t speed;
uint8_t device_class;
uint8_t device_subclass;
uint8_t device_protocol;
uint16_t vendor_id;
uint16_t product_id;
uint16_t device_version_bcd;
}
No packet type specific additional data.
This packet gets send by the usb-host when a device becomes available (it is
possible for the usb-host to wait for a device to get plugged in).
The device_version_bcd field should only be send (and expected on receive)
when both sides have the usb_redir_cap_connect_device_version capability.
If this is not the case the length of the packet will be 2 bytes less!
Note that a usb-host may re-use the existing connection for a new / re-plugged
device in this case this packet can be send after a usb_redir_device_disconnect
message to notify the usb-guest that a new device is available.
Note the usbredir-host *must* first send usb_redir_ep_info followed by
usb_redir_interface_info before sending the usb_redir_device_connect_info!
usb_redir_device_disconnect
---------------------------
usb_redir_header.type: usb_redir_device_disconnect
usb_redir_header.length: 0
usb_redir_header.id: 0 (always as this is an unsolicited packet)
No packet type specific header.
No packet type specific additional data.
This packet may be send by the usb-host to indicate that the device has been
disconnect (unplugged). Note on some platforms the usb-host may not become
aware of the disconnection until a usb packet is send to the device.
usb_redir_reset
---------------
usb_redir_header.type: usb_redir_reset
usb_redir_header.length: 0
No packet type specific header.
No packet type specific additional data.
This packet can be send by the usb-guest to cause a reset of the usb
device. Note that of things go wrong the usb-host may be unable to re-connect
to the device after the reset! If this happens a usb_redir_device_disconnect
packet will be send by the usb-host.
usb_redir_interface_info
------------------------
usb_redir_header.type: usb_redir_interface_info
usb_redir_header.length: sizeof(usb_redir_interface_info_header)
usb_redir_header.id: 0 (always as this is an unsolicited packet)
struct usb_redir_interface_info_header {
uint32_t interface_count;
uint8_t interface[32];
uint8_t interface_class[32];
uint8_t interface_subclass[32];
uint8_t interface_protocol[32];
}
No packet type specific additional data.
This packet gets send by the usb-host to inform the usb-guest about the
interfaces of the device. It contains the interface number, class and protocol
info for interface_count interfaces. This gets send after a (successful)
initial connection, set_config and set_alt_setting.
usb_redir_ep_info
-----------------
usb_redir_header.type: usb_redir_ep_info
usb_redir_header.length: sizeof(usb_redir_ep_info_header)
usb_redir_header.id: 0 (always as this is an unsolicited packet)
enum {
/* Note these 4 match the usb spec! */
usb_redir_type_control,
usb_redir_type_iso,
usb_redir_type_bulk,
usb_redir_type_interrupt,
usb_redir_type_invalid = 255
}
struct usb_redir_ep_info_header {
uint8_t type[32];
uint8_t interval[32];
uint8_t interface[32];
uint16_t max_packet_size[32];
uint32_t max_streams[32];
}
No packet type specific additional data.
This packet gets send by the usb-host to let the usb-guest know the endpoint
type, interval and interface it belongs to for all possible endpoints,
first 0-15 out, then 0-15 in. This gets send after a (successful) initial
connection, set_config and set_alt_setting.
The max_packet_size field should only be send (and expected on receive)
when both sides have the usb_redir_cap_ep_info_max_packet_size capability.
If this is not the case the length of the packet will be 64 bytes less!
The max_streams field should only be send (and expected on receive)
when both sides have the usb_redir_cap_bulk_streams capability. If this is
not the case the length of the packet will be 128 bytes less!
Note implementations with the usb_redir_cap_bulk_streams capability must
always also have the usb_redir_cap_ep_info_max_packet_size capability.
Advertising usb_redir_cap_bulk_streams without
usb_redir_cap_ep_info_max_packet_size is not allowed!
usb_redir_set_configuration
---------------------------
usb_redir_header.type: usb_redir_set_configuration
usb_redir_header.length: sizeof(usb_redir_set_configuration_header)
struct usb_redir_set_configuration_header {
uint8_t configuration;
}
No packet type specific additional data.
This packet can be send by the usb-guest to set (change) the active
configuration of the usb-device.
usb_redir_get_configuration
---------------------------
usb_redir_header.type: usb_redir_get_configuration
usb_redir_header.length: 0
No packet type specific header.
No packet type specific additional data.
This packet can be send by the usb-guest to get (query) the active
configuration of the usb-device.
usb_redir_configuration_status
------------------------------
usb_redir_header.type: usb_redir_configuration_status
usb_redir_header.length: sizeof(usb_redir_configuration_status_header)
struct usb_redir_configuration_status_header {
uint8_t status;
uint8_t configuration;
}
No packet type specific additional data.
This is send by the usb-host in response to a usb_redir_set_configuration /
usb_redir_get_configuration packet. It reports a status code and on success
the resulting / active configuration.
Note that after a successful usb_redir_set_configuration command the
usbredir-host *must* first send usb_redir_ep_info followed by
usb_redir_interface_info before sending the usb_redir_configuration_status,
to ensure the usb-guest has the new info when it starts using the new
configuration.
usb_redir_set_alt_setting
-------------------------
usb_redir_header.type: usb_redir_set_alt_setting
usb_redir_header.length: sizeof(usb_redir_set_alt_setting_header)
struct usb_redir_set_alt_setting_header {
uint8_t interface;
uint8_t alt;
}
No packet type specific additional data.
This packet can be send by the usb-guest to set (change) the alt_setting of
interface <interface> to <alt>.
usb_redir_get_alt_setting
---------------------------
usb_redir_header.type: usb_redir_get_alt_setting
usb_redir_header.length: sizeof(usb_redir_get_alt_setting_header)
struct usb_redir_get_alt_setting_header {
uint8_t interface;
}
No packet type specific additional data.
This packet can be send by the usb-guest to get (query) the active
alt_setting of an interface of the usb-device.
usb_redir_alt_setting_status
----------------------------
usb_redir_header.type: usb_redir_alt_setting_status
usb_redir_header.length: sizeof(usb_redir_alt_setting_status_header)
struct usb_redir_alt_setting_status_header {
uint8_t status;
uint8_t interface;
uint8_t alt;
}
No packet type specific additional data.
This is send by the usb-host in response to a usb_redir_set_alt_setting /
usb_redir_get_alt_setting packet. It reports a status code, the affected
interface and on success the resulting / active alt_setting for that interface.
Note that after a successful usb_redir_set_alt_setting command the
usbredir-host *must* first send usb_redir_ep_info followed by
usb_redir_interface_info before sending the usb_redir_alt_setting_status,
to ensure the usb-guest has the new info when it starts using the new
alt setting.
usb_redir_start_iso_stream
--------------------------
usb_redir_header.type: usb_redir_start_iso_stream
usb_redir_header.length: sizeof(usb_redir_start_iso_stream_header)
struct usb_redir_start_iso_stream_header {
uint8_t endpoint;
uint8_t pkts_per_urb;
uint8_t no_urbs;
}
No packet type specific additional data.
This packet can be send by the usb-guest to start a iso stream on the
designated endpoint of the usb-device.
This function allocates no_urbs urbs with pkts_per_urb iso packets/frames
per urb. For iso input endpoints these urbs will get submitted to the
device *immediately*, for iso output endpoints the usb-host will wait till
it has received (pkts_per_urb * no_urbs / 2) packets to fill its buffers,
before submitting the first urb.
usb_redir_stop_iso_stream
-------------------------
usb_redir_header.type: usb_redir_stop_iso_stream
usb_redir_header.length: sizeof(struct usb_redir_start_iso_stream_header)
struct usb_redir_stop_iso_stream_header {
uint8_t endpoint;
}
No packet type specific additional data.
This packet can be send by the usb-guest to stop an iso stream on the
designated endpoint. This will cancel all pending urbs, flush the usb-host's
buffers and free all relevant resources. Note that the usb-guest can still
receive isoc data packets from an isoc in endpoint after sending this, as
some data packets may already be inside the transport pipe.
usb_redir_iso_stream_status
---------------------------
usb_redir_header.type: usb_redir_iso_stream_status
usb_redir_header.length: sizeof(usb_redir_iso_stream_status_header)
struct usb_redir_iso_stream_status_header {
uint8_t status;
uint8_t endpoint;
}
No packet type specific additional data.
This packet is send by the usb-host in response to a
usb_redir_start_iso_stream or usb_redir_stop_iso_stream packet. Note that
for the starting of output iso streams a success status only indicates that
all the buffers were successfully allocated, the actual stream is not
started until enough packets are buffered.
Note that this can also be send unsolicited by a usb-host in case of an
error with an iso output stream, see usb_redir_iso_packet.
To allow the usb-guest to detect if the stream was adversely stopped, the
usb-host will always report usb_redir_stall as status if the stream was
stopped for any reason other then an usb_redir_stop_iso_stream.
usb_redir_start_interrupt_receiving
-----------------------------------
usb_redir_header.type: usb_redir_start_interrupt_receiving
usb_redir_header.length: sizeof(usb_redir_start_interrupt_receiving_header)
struct usb_redir_start_interrupt_receiving_header {
uint8_t endpoint;
}
No packet type specific additional data.
This packet can be send by the usb-guest to start receiving interrupts
from the designated endpoint of the usb-device.
This function is for *input* interrupt endpoints only. Input interrupt
endpoints need to be polled timely otherwise data may get lost. So for
input interrupt endpoints the usb-host takes care of the submitting and
re-submitting of urbs.
On receiving this packet the usb-host will start an interrupt transfer
to the endpoint using the interval and maxPacketSize from the descriptors.
When this transfer completes, the usb-host will send an
usb_redir_interrupt_packet to the usb-guest, and will re-submit the urb.
usb_redir_stop_interrupt_receiving
----------------------------------
usb_redir_header.type: usb_redir_stop_interrupt_receiving
usb_redir_header.length: sizeof(struct usb_redir_start_interrupt_receiving_header)
struct usb_redir_stop_interrupt_receiving_header {
uint8_t endpoint;
}
No packet type specific additional data.
This packet can be send by the usb-guest to stop interrupt receiving on the
designated endpoint. This will cancel the pending urb. Note that the usb-guest
can still receive usb_redir_interrupt_packet-s after sending this, as
some data packets may already be inside the transport pipe.
usb_redir_interrupt_receiving_status
------------------------------------
usb_redir_header.type: usb_redir_interrupt_receiving_status
usb_redir_header.length: sizeof(usb_redir_interrupt_receiving_status_header)
struct usb_redir_interrupt_receiving_status_header {
uint8_t status;
uint8_t endpoint;
}
No packet type specific additional data.
This packet is send by the usb-host in response to a
usb_redir_start_interrupt_receiving or usb_redir_stop_interrupt_receiving
packet.
Note that this can also be send unsolicited by a usb-host in case of an
error re-submitting the interrupt urb.
To allow the usb-guest to detect if the stream was adversely stopped, the
usb-host will always report usb_redir_stall as status if the stream was
stopped for any reason other then an usb_redir_stop_interrupt_receiving.
usb_redir_alloc_bulk_streams
----------------------------
usb_redir_header.type: usb_redir_alloc_bulk_streams
usb_redir_header.length: sizeof(usb_redir_alloc_bulk_streams_header)
struct usb_redir_alloc_bulk_streams_header {
uint32_t endpoints; /* bitmask indicating on which eps to alloc streams */
uint32_t no_streams;
}
No packet type specific additional data.
This packet can be send by the usb-guest to the usb-host to request
that the usb-host allocates IDs so the usb-guest can use up to no_streams
stream IDs on the endpoints indicated by the endpoints bitmask. Endpoints in
the bitmask are indicated by bit number (0-31) using the same numbering as
in usb_redir_ep_info_header.
usb_redir_free_bulk_streams
----------------------------
usb_redir_header.type: usb_redir_free_bulk_streams
usb_redir_header.length: sizeof(usb_redir_free_bulk_streams_header)
struct usb_redir_free_bulk_streams_header {
uint32_t endpoints; /* bitmask indicating on which eps to free streams */
}
No packet type specific additional data.
This packet can be send by the usb-guest to the usb-host to free any
bulk streams previously allocated on the endpoints indicated by the
endpoints bitmask.
usb_redir_bulk_streams_status
-----------------------------
usb_redir_header.type: usb_redir_bulk_streams_status
usb_redir_header.length: sizeof(usb_redir_bulk_streams_status_header)
struct usb_redir_bulk_streams_status_header {
uint32_t endpoints; /* bitmask indicating eps this status message is for */
uint32_t no_streams;
uint8_t status;
}
No packet type specific additional data.
This packet is send by the usb-host in response to a
usb_redir_alloc_bulk_streams or usb_redir_free_bulk_streams packet.
For usb_redir_alloc_bulk_streams responses no_streams will be the no_streams
passed to the usb_redir_alloc_bulk_streams packet. usb-hosts are not allowed
to return less streams then requested! For usb_redir_free_bulk_streams
responses no_streams will be 0.
On a success status in response to a usb_redir_alloc_bulk_streams
the usb-guest may use stream ids 1 through no_streams.
usb_redir_start_bulk_receiving
------------------------------
usb_redir_header.type: usb_redir_start_bulk_receiving
usb_redir_header.length: sizeof(usb_redir_start_bulk_receiving_header)
struct usb_redir_start_bulk_receiving_header {
uint32_t stream_id;
uint32_t bytes_per_transfer;
uint8_t endpoint;
uint8_t no_transfers;
}
No packet type specific additional data.
This packet can be send by the usb-guest to start buffered reading from a
bulk endpoint.
Upon receiving this packet the usb-host will submit no_transfers bulk in
transfer of bytes_per_transfer each to the designated endpoint of the
usb-device. Upon completion of a transfer the usb-host will send an
usb_redir_buffered_bulk_packet with the received data to the usb-guest,
and immediately re-submit the completed transfer.
Note bytes_per_transfer must be a multiple of the endpoints max_packet_size.
Note this packet should only be send to usb-hosts with the
usb_redir_cap_bulk_receiving capability.
usb_redir_stop_bulk_receiving
-----------------------------
usb_redir_header.type: usb_redir_stop_bulk_receiving
usb_redir_header.length: sizeof(usb_redir_stop_bulk_receiving_header)
struct usb_redir_stop_bulk_receiving_header {
uint32_t stream_id;
uint8_t endpoint;
}
No packet type specific additional data.
This packet can be send by the usb-guest to stop bulk receiving on the
designated endpoint. This will cancel all pending transfers. Note that the
usb-guest can still receive usb_redir_bulk_packet-s after sending this, as
some data packets may already be inside the transport pipe.
Note this packet should only be send to usb-hosts with the
usb_redir_cap_bulk_receiving capability.
usb_redir_bulk_receiving_status
-------------------------------
usb_redir_header.type: usb_redir_bulk_receiving_status
usb_redir_header.length: sizeof(usb_redir_bulk_receiving_status_header)
struct usb_redir_bulk_receiving_status_header {
uint32_t stream_id;
uint8_t endpoint;
uint8_t status;
}
No packet type specific additional data.
This packet is send by the usb-host in response to a
usb_redir_start_bulk_receiving or usb_redir_stop_bulk_receiving packet.
Note that this can also be send unsolicited by an usb-host in case of an
error re-submitting the bulk transfer.
To allow the usb-guest to detect if the stream was adversely stopped, the
usb-host will always report usb_redir_stall as status if the stream was
stopped for any reason other then an usb_redir_stop_interrupt_receiving.
Note this packet should only be send to usb-guests with the
usb_redir_cap_bulk_receiving capability.
usb_redir_cancel_data_packet
----------------------------
usb_redir_header.type: usb_redir_cancel_data_packet
usb_redir_header.id <id of packet to cancel>
usb_redir_header.length: 0
No packet type specific header.
No packet type specific additional data.
This packet can be send by the usb-guest to cancel an earlier send data
packet, the id should be set to the id used when sending the packet the
guest now wishes to cancel.
Note that the usb-guest will always receive back a data packet of the same type
and with the same id, the usb-guest can check if the packet completed
normally (before the cancel packet was processed by the usb-host), or was
cancelled by looking at the return data packet's status field.
usb_redir_filter_reject
-----------------------
usb_redir_header.type: usb_redir_filter_reject
usb_redir_header.length: 0
usb_redir_header.id: 0 (always as this is an unsolicited packet)
No packet type specific header.
No packet type specific additional data.
This packet is send by the usb-guest after receiving a usb_redir_device_connect
or usb_redir_interface_info packet which was rejected by an usb-guest side
device filter. This packet should only be send to usb-hosts with the
usb_redir_cap_filter capability.
usb_redir_filter_filter
-----------------------
usb_redir_header.type: usb_redir_filter_filter
usb_redir_header.length: string-length + 1 (for 0 termination)
usb_redir_header.id: 0 (always as this is an unsolicited packet)
No packet type specific header.
The additional data contains a 0 terminated usredirfilter string.
This packet can be send directly after the hello packet to inform the other
side that a filter is in place and some devices may be rejected.
An usredirfilter consists of one or more rules, where in string form each rule
has the following format:
<class>,<vendor>,<product>,<version>,<allow>
Values can be either in decimal format, or in hexadecimal format pre-fixed
with 0x, a value of -1 can be used to allow any value.
All rules of a filter are concatonated, separated by the '|' character
to form a single usredirfilter string:
<rule1>|<rule2>|<rule3>
If a device matches none of the rules the result of the filter is deny and
the device will be rejected.
For more info on filtering see usbredirfilter.h
This packet should only be send to peers with the usb_redir_cap_filter
capability.
usb_redir_device_disconnect_ack
-------------------------------
usb_redir_header.type: usb_redir_device_disconnect_ack
usb_redir_header.length: 0
usb_redir_header.id: 0 (as the id of the device_disconnect is always 0)
No packet type specific header.
No packet type specific additional data.
This packet is send by the usb-guest after having processed a
usb_redir_device_disconnect packet send by the usb-host. This allows an
usb-host which wants to re-use an existing connection to know that the
usb-guest has seen the disconnect and will not send any more packets intended
for the disconnected device. Without this there is a race where the usb-host
may have a new device available, but it is still receiving packets intended for
the old device as the usb-guest has not yet seen the disconnect.
Note this packet is only send if both sides have the
usb_redir_cap_device_disconnect_ack capability.
usb_redir_control_packet
------------------------
usb_redir_header.type: usb_redir_control_packet
usb_redir_header.length: sizeof(usb_redir_control_packet_header) [+ length]
struct usb_redir_control_packet_header {
uint8_t endpoint;
uint8_t request;
uint8_t requesttype;
uint8_t status;
uint16_t value;
uint16_t index;
uint16_t length;
}
The additional data contains the control msg data to be send / received.
Packets of this type can be send by the usb-guest to the usb-host to
initiate a control transfer on the usb-device. endpoint, request, requesttype,
value and index have their standard meaning for usb control messages.
The status field is only used in the usb-host's response.
length is the amount of data the usb-guest is sending / expects to read
(in the USB_DIR_IN case). Note that the length should only be added
to usb_redir_header.length in one direction (and the actual packet
length should match).
When the control msg has been processed by the usb-device the usb-host sends
a usb_redir_control_packet back to the usb-guest, with all fields unchanged
except for the status field and length which get updated to match the
actual results.
usb_redir_bulk_packet
---------------------
usb_redir_header.type: usb_redir_bulk_packet
usb_redir_header.length: sizeof(usb_redir_bulk_packet_header) [+ length]
struct usb_redir_bulk_packet_header {
uint8_t endpoint;
uint8_t status;
uint16_t length;
uint32_t stream_id;
uint16_t length_high; /* High 16 bits of the packet length */
}
The additional data contains the bulk msg data to be send / received.
Packets of this type can be send by the usb-guest to the usb-host to
initiate a bulk transfer on the usb-device. endpoint and stream_id have
their standard meaning for usb bulk messages. The status field is only used
in the usb-host's response. length is the amount of data the usb-guest is
sending / expects to read (depending on the direction of the endpoint).
length_high contains the 16 high bits of length to allow packets larger
then 65535 bytes, it is only send/received if both sides have the
usb_redir_cap_32bits_bulk_length capability.
When the bulk msg has been processed by the usb-device the usb-host sends
a usb_redir_bulk_packet back to the usb-guest, with the status field and
length updated to match the actual results.
Note just as usb_redir_control_packet this packet only has additional data
in one direction depending on the direction of the endpoint.
Note see usb_redir_buffered_bulk_packet for an alternative for receiving data
from bulk endpoints.
usb_redir_iso_packet
--------------------
usb_redir_header.type: usb_redir_iso_packet
usb_redir_header.length: sizeof(usb_redir_iso_packet_header) + length
struct usb_redir_iso_packet_header {
uint8_t endpoint;
uint8_t status;
uint16_t length;
}
The additional data contains the iso msg data to be send / received.
Packets of this type should be send continuesly (at the endpoint interval
speed) as soon as an iso stream is started using usb_redir_start_iso_stream
the direction in which they gets send depends on the endpoints direction.
The status field only has meaning for packets send from the usb-host to
the usb-guest (for iso input endpoints). Due to buffering it is not possibly
to timely notify the usb-guest of transfer errors for iso output packets. The
usb-host will try to clear any error conditions itself. If it fails to do
so it will send a usb_redir_iso_stream_status to the usb-guest indicating
there is a problem with the iso stream.
Since usb_redir_iso_packet's are send continuously by the usb-host once
a stream is started on an iso input endpoint, the usb-host cannot set the
usb_redir_header.id to the id of the corresponding received packet. So for
usb_redir_iso_packet's the usb-host simply starts with an id of 0 and
increments this every packet. Note that when the usb-host has recovered from
a stall the id will restart at 0!
usb_redir_interrupt_packet
--------------------------
usb_redir_header.type: usb_redir_interrupt_packet
usb_redir_header.length: sizeof(usb_redir_interrupt_packet_header) [+ length]
struct usb_redir_interrupt_packet_header {
uint8_t endpoint;
uint8_t status;
uint16_t length;
}
The additional data contains the interrupt msg data to be send / received.
The handling of interrupt endpoints differs significantly depending on wether
the endpoint is an input or output endpoint.
Input endpoints:
================
Input interrupt endpoints need to
be polled timely otherwise data may get lost. So for input interrupt endpoints
the usb-host takes care of the submitting and re-submitting of urbs, the
usb-guest can start / stop the receiving of interrupt packets using the
usb_redir_start_interrupt_receiving / usb_redir_stop_interrupt_receiving
packets. Note that for an input interrupt endpoint usb_redir_interrupt_packet-s
are only send in one direction, from the usb-host to the usb-guest!
Since usb_redir_interrupt_packet's are send unsolicited by the usb-host once
interrupt receiving has started, the usb-host cannot set the
usb_redir_header.id to the id of the corresponding received packet. So for
usb_redir_interrupt_packet's the usb-host simply starts with an id of 0 and
increments this every packet. Note that when the usb-host has recovered from
a stall the id will restart at 0!
Output endpoints:
=================
For interrupt output endpoints the normal asynchroneous mechanism also used
for control and bulk transfers is used:
The usb-guest sends a usb_redir_interrupt_packet to the usb-host. When the
interrupt msg has been processed by the usb-device the usb-host sends
a usb_redir_interrupt_packet back to the usb-guest, with the status field and
length updated to match the actual results. This packet only has additional
data (the data to output) when send from usb-guest to usb-host.
Note that since unlike with iso data there is usually no notion of a stream
with interrupt data, buffering makes no sense for output interrupt packets,
instead they are delivered asap. Despite this asap delivery it is likely
that the timing constraints which apply to interrupt output transfers will
not be met. The consequences of this will vary from device to device.
usb_redir_buffered_bulk_packet
------------------------------
usb_redir_header.type: usb_redir_bulk_packet
usb_redir_header.length: sizeof(usb_redir_bulk_packet_header) + length
usb_redir_header.id: starts at 0, incremented by 1 per send packet
struct usb_redir_buffered_bulk_packet_header {
uint32_t stream_id;
uint32_t length;
uint8_t endpoint;
uint8_t status;
}
The additional data contains the bulk msg data received.
Buffered bulk mode is intended for bulk *input* endpoints, where the data is
of a streaming nature (not part of a command-response protocol). These
endpoints' input buffer may overflow if data is not read quickly enough.
So in buffered bulk mode the usb-host takes care of the submitting and
re-submitting of bulk transfers. The usb-guest can start / stop the receiving
of buffered bulk data using the usb_redir_start_bulk_receiving /
usb_redir_stop_bulk_receiving packets.
Note that usb_redir_buffered_bulk_packet-s are only send in one direction,
from the usb-host to the usb-guest!
Since usb_redir_buffered_bulk_packet-s are send unsolicited by the usb-host
once bulk receiving has started, the usb-host cannot set the
usb_redir_header.id to the id of the corresponding received packet. So for
usb_redir_buffered_bulk_packet-s the usb-host simply starts with an id of 0 and
increments this every packet. Note that when the usb-host has recovered from
a stall the id will restart at 0!
A typical example where buffered bulk mode should be used is with the bulk in
endpoints of usb to serial convertors.
Note buffered bulk mode can only be used when both sides have the
usb_redir_cap_bulk_receiving capability.
|