| 1 | #ifndef QEMU_USB_H |
| 2 | #define QEMU_USB_H |
| 3 | |
| 4 | /* |
| 5 | * QEMU USB API |
| 6 | * |
| 7 | * Copyright (c) 2005 Fabrice Bellard |
| 8 | * |
| 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 10 | * of this software and associated documentation files (the "Software"), to deal |
| 11 | * in the Software without restriction, including without limitation the rights |
| 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 13 | * copies of the Software, and to permit persons to whom the Software is |
| 14 | * furnished to do so, subject to the following conditions: |
| 15 | * |
| 16 | * The above copyright notice and this permission notice shall be included in |
| 17 | * all copies or substantial portions of the Software. |
| 18 | * |
| 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 22 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 25 | * THE SOFTWARE. |
| 26 | */ |
| 27 | |
| 28 | #include "system/memory.h" |
| 29 | #include "hw/core/qdev.h" |
| 30 | #include "qemu/iov.h" |
| 31 | #include "qemu/queue.h" |
| 32 | #include "qom/object.h" |
| 33 | #include "qapi/error.h" |
| 34 | #include "monitor/hmp.h" |
| 35 | |
| 36 | /* Constants related to the USB / PCI interaction */ |
| 37 | #define USB_SBRN 0x60 /* Serial Bus Release Number Register */ |
| 38 | #define USB_RELEASE_1 0x10 /* USB 1.0 */ |
| 39 | #define USB_RELEASE_2 0x20 /* USB 2.0 */ |
| 40 | #define USB_RELEASE_3 0x30 /* USB 3.0 */ |
| 41 | |
| 42 | #define USB_TOKEN_SETUP 0x2d |
| 43 | #define USB_TOKEN_IN 0x69 /* device -> host */ |
| 44 | #define USB_TOKEN_OUT 0xe1 /* host -> device */ |
| 45 | |
| 46 | #define USB_RET_SUCCESS (0) |
| 47 | #define USB_RET_NODEV (-1) |
| 48 | #define USB_RET_NAK (-2) |
| 49 | #define USB_RET_STALL (-3) |
| 50 | #define USB_RET_BABBLE (-4) |
| 51 | #define USB_RET_IOERROR (-5) |
| 52 | #define USB_RET_ASYNC (-6) |
| 53 | #define USB_RET_ADD_TO_QUEUE (-7) |
| 54 | #define USB_RET_REMOVE_FROM_QUEUE (-8) |
| 55 | |
| 56 | #define USB_SPEED_LOW 0 |
| 57 | #define USB_SPEED_FULL 1 |
| 58 | #define USB_SPEED_HIGH 2 |
| 59 | #define USB_SPEED_SUPER 3 |
| 60 | |
| 61 | #define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW) |
| 62 | #define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL) |
| 63 | #define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH) |
| 64 | #define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER) |
| 65 | |
| 66 | #define USB_STATE_NOTATTACHED 0 |
| 67 | #define USB_STATE_ATTACHED 1 |
| 68 | //#define USB_STATE_POWERED 2 |
| 69 | #define USB_STATE_DEFAULT 3 |
| 70 | //#define USB_STATE_ADDRESS 4 |
| 71 | //#define USB_STATE_CONFIGURED 5 |
| 72 | #define USB_STATE_SUSPENDED 6 |
| 73 | |
| 74 | #define USB_CLASS_AUDIO 1 |
| 75 | #define USB_CLASS_COMM 2 |
| 76 | #define USB_CLASS_HID 3 |
| 77 | #define USB_CLASS_PHYSICAL 5 |
| 78 | #define USB_CLASS_STILL_IMAGE 6 |
| 79 | #define USB_CLASS_PRINTER 7 |
| 80 | #define USB_CLASS_MASS_STORAGE 8 |
| 81 | #define USB_CLASS_HUB 9 |
| 82 | #define USB_CLASS_CDC_DATA 0x0a |
| 83 | #define USB_CLASS_CSCID 0x0b |
| 84 | #define USB_CLASS_CONTENT_SEC 0x0d |
| 85 | #define USB_CLASS_APP_SPEC 0xfe |
| 86 | #define USB_CLASS_VENDOR_SPEC 0xff |
| 87 | |
| 88 | #define USB_SUBCLASS_UNDEFINED 0 |
| 89 | #define USB_SUBCLASS_AUDIO_CONTROL 1 |
| 90 | #define USB_SUBCLASS_AUDIO_STREAMING 2 |
| 91 | #define USB_SUBCLASS_AUDIO_MIDISTREAMING 3 |
| 92 | |
| 93 | #define USB_DIR_OUT 0 |
| 94 | #define USB_DIR_IN 0x80 |
| 95 | |
| 96 | #define USB_TYPE_MASK (0x03 << 5) |
| 97 | #define USB_TYPE_STANDARD (0x00 << 5) |
| 98 | #define USB_TYPE_CLASS (0x01 << 5) |
| 99 | #define USB_TYPE_VENDOR (0x02 << 5) |
| 100 | #define USB_TYPE_RESERVED (0x03 << 5) |
| 101 | |
| 102 | #define USB_RECIP_MASK 0x1f |
| 103 | #define USB_RECIP_DEVICE 0x00 |
| 104 | #define USB_RECIP_INTERFACE 0x01 |
| 105 | #define USB_RECIP_ENDPOINT 0x02 |
| 106 | #define USB_RECIP_OTHER 0x03 |
| 107 | |
| 108 | #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) |
| 109 | #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) |
| 110 | #define VendorDeviceRequest ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) |
| 111 | #define VendorDeviceOutRequest \ |
| 112 | ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8) |
| 113 | |
| 114 | #define InterfaceRequest \ |
| 115 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) |
| 116 | #define InterfaceOutRequest \ |
| 117 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) |
| 118 | #define ClassInterfaceRequest \ |
| 119 | ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8) |
| 120 | #define ClassInterfaceOutRequest \ |
| 121 | ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8) |
| 122 | #define VendorInterfaceRequest \ |
| 123 | ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8) |
| 124 | #define VendorInterfaceOutRequest \ |
| 125 | ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8) |
| 126 | |
| 127 | #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) |
| 128 | #define EndpointOutRequest \ |
| 129 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) |
| 130 | |
| 131 | #define USB_REQ_GET_STATUS 0x00 |
| 132 | #define USB_REQ_CLEAR_FEATURE 0x01 |
| 133 | #define USB_REQ_SET_FEATURE 0x03 |
| 134 | #define USB_REQ_SET_ADDRESS 0x05 |
| 135 | #define USB_REQ_GET_DESCRIPTOR 0x06 |
| 136 | #define USB_REQ_SET_DESCRIPTOR 0x07 |
| 137 | #define USB_REQ_GET_CONFIGURATION 0x08 |
| 138 | #define USB_REQ_SET_CONFIGURATION 0x09 |
| 139 | #define USB_REQ_GET_INTERFACE 0x0A |
| 140 | #define USB_REQ_SET_INTERFACE 0x0B |
| 141 | #define USB_REQ_SYNCH_FRAME 0x0C |
| 142 | #define USB_REQ_SET_SEL 0x30 |
| 143 | #define USB_REQ_SET_ISOCH_DELAY 0x31 |
| 144 | |
| 145 | #define USB_DEVICE_SELF_POWERED 0 |
| 146 | #define USB_DEVICE_REMOTE_WAKEUP 1 |
| 147 | |
| 148 | #define USB_DT_DEVICE 0x01 |
| 149 | #define USB_DT_CONFIG 0x02 |
| 150 | #define USB_DT_STRING 0x03 |
| 151 | #define USB_DT_INTERFACE 0x04 |
| 152 | #define USB_DT_ENDPOINT 0x05 |
| 153 | #define USB_DT_DEVICE_QUALIFIER 0x06 |
| 154 | #define USB_DT_OTHER_SPEED_CONFIG 0x07 |
| 155 | #define USB_DT_DEBUG 0x0A |
| 156 | #define USB_DT_INTERFACE_ASSOC 0x0B |
| 157 | #define USB_DT_BOS 0x0F |
| 158 | #define USB_DT_DEVICE_CAPABILITY 0x10 |
| 159 | #define USB_DT_CS_INTERFACE 0x24 |
| 160 | #define USB_DT_CS_ENDPOINT 0x25 |
| 161 | #define USB_DT_ENDPOINT_COMPANION 0x30 |
| 162 | |
| 163 | #define USB_DEV_CAP_WIRELESS 0x01 |
| 164 | #define USB_DEV_CAP_USB2_EXT 0x02 |
| 165 | #define USB_DEV_CAP_SUPERSPEED 0x03 |
| 166 | |
| 167 | #define USB_CFG_ATT_ONE (1 << 7) /* should always be set */ |
| 168 | #define USB_CFG_ATT_SELFPOWER (1 << 6) |
| 169 | #define USB_CFG_ATT_WAKEUP (1 << 5) |
| 170 | #define USB_CFG_ATT_BATTERY (1 << 4) |
| 171 | |
| 172 | #define USB_ENDPOINT_XFER_CONTROL 0 |
| 173 | #define USB_ENDPOINT_XFER_ISOC 1 |
| 174 | #define USB_ENDPOINT_XFER_BULK 2 |
| 175 | #define USB_ENDPOINT_XFER_INT 3 |
| 176 | #define USB_ENDPOINT_XFER_INVALID 255 |
| 177 | |
| 178 | #define USB_INTERFACE_INVALID 255 |
| 179 | |
| 180 | typedef struct USBBusOps USBBusOps; |
| 181 | typedef struct USBPort USBPort; |
| 182 | typedef struct USBDevice USBDevice; |
| 183 | typedef struct USBPacket USBPacket; |
| 184 | typedef struct USBCombinedPacket USBCombinedPacket; |
| 185 | typedef struct USBEndpoint USBEndpoint; |
| 186 | |
| 187 | typedef struct USBDesc USBDesc; |
| 188 | typedef struct USBDescID USBDescID; |
| 189 | typedef struct USBDescDevice USBDescDevice; |
| 190 | typedef struct USBDescConfig USBDescConfig; |
| 191 | typedef struct USBDescIfaceAssoc USBDescIfaceAssoc; |
| 192 | typedef struct USBDescIface USBDescIface; |
| 193 | typedef struct USBDescEndpoint USBDescEndpoint; |
| 194 | typedef struct USBDescOther USBDescOther; |
| 195 | typedef struct USBDescString USBDescString; |
| 196 | typedef struct USBDescMSOS USBDescMSOS; |
| 197 | |
| 198 | struct USBDescString { |
| 199 | uint8_t index; |
| 200 | char *str; |
| 201 | QLIST_ENTRY(USBDescString) next; |
| 202 | }; |
| 203 | |
| 204 | #define USB_MAX_ENDPOINTS 15 |
| 205 | #define USB_MAX_INTERFACES 16 |
| 206 | |
| 207 | struct USBEndpoint { |
| 208 | uint8_t nr; |
| 209 | uint8_t pid; |
| 210 | uint8_t type; |
| 211 | uint8_t ifnum; |
| 212 | int max_packet_size; |
| 213 | int max_streams; |
| 214 | bool pipeline; |
| 215 | bool halted; |
| 216 | USBDevice *dev; |
| 217 | QTAILQ_HEAD(, USBPacket) queue; |
| 218 | }; |
| 219 | |
| 220 | enum USBDeviceFlags { |
| 221 | USB_DEV_FLAG_IS_HOST, |
| 222 | USB_DEV_FLAG_MSOS_DESC_ENABLE, |
| 223 | USB_DEV_FLAG_MSOS_DESC_IN_USE, |
| 224 | USB_DEV_FLAG_IS_SCSI_STORAGE, |
| 225 | }; |
| 226 | |
| 227 | /* definition of a USB device */ |
| 228 | struct USBDevice { |
| 229 | DeviceState qdev; |
| 230 | USBPort *port; |
| 231 | char *port_path; |
| 232 | char *serial; |
| 233 | void *opaque; |
| 234 | uint32_t flags; |
| 235 | |
| 236 | char *pcap_filename; |
| 237 | FILE *pcap; |
| 238 | |
| 239 | /* Actual connected speed */ |
| 240 | int speed; |
| 241 | /* Supported speeds, not in info because it may be variable (hostdevs) */ |
| 242 | int speedmask; |
| 243 | uint8_t addr; |
| 244 | char product_desc[32]; |
| 245 | int auto_attach; |
| 246 | bool attached; |
| 247 | |
| 248 | int32_t state; |
| 249 | uint8_t setup_buf[8]; |
| 250 | uint8_t data_buf[4096]; |
| 251 | int32_t remote_wakeup; |
| 252 | int32_t setup_state; |
| 253 | int32_t setup_len; |
| 254 | int32_t setup_index; |
| 255 | |
| 256 | USBEndpoint ep_ctl; |
| 257 | USBEndpoint ep_in[USB_MAX_ENDPOINTS]; |
| 258 | USBEndpoint ep_out[USB_MAX_ENDPOINTS]; |
| 259 | |
| 260 | QLIST_HEAD(, USBDescString) strings; |
| 261 | const USBDesc *usb_desc; /* Overrides class usb_desc if not NULL */ |
| 262 | const USBDescDevice *device; |
| 263 | |
| 264 | int configuration; |
| 265 | int ninterfaces; |
| 266 | int altsetting[USB_MAX_INTERFACES]; |
| 267 | const USBDescConfig *config; |
| 268 | const USBDescIface *ifaces[USB_MAX_INTERFACES]; |
| 269 | }; |
| 270 | |
| 271 | #define TYPE_USB_DEVICE "usb-device" |
| 272 | OBJECT_DECLARE_TYPE(USBDevice, USBDeviceClass, USB_DEVICE) |
| 273 | |
| 274 | typedef void (*USBDeviceRealize)(USBDevice *dev, Error **errp); |
| 275 | typedef void (*USBDeviceUnrealize)(USBDevice *dev); |
| 276 | |
| 277 | struct USBDeviceClass { |
| 278 | DeviceClass parent_class; |
| 279 | |
| 280 | USBDeviceRealize realize; |
| 281 | USBDeviceUnrealize unrealize; |
| 282 | |
| 283 | /* |
| 284 | * Walk (enabled) downstream ports, check for a matching device. |
| 285 | * Only hubs implement this. |
| 286 | */ |
| 287 | USBDevice *(*find_device)(USBDevice *dev, uint8_t addr); |
| 288 | |
| 289 | /* |
| 290 | * Called when a packet is canceled. |
| 291 | */ |
| 292 | void (*cancel_packet)(USBDevice *dev, USBPacket *p); |
| 293 | |
| 294 | /* |
| 295 | * Attach the device |
| 296 | */ |
| 297 | void (*handle_attach)(USBDevice *dev); |
| 298 | |
| 299 | /* |
| 300 | * Reset the device |
| 301 | */ |
| 302 | void (*handle_reset)(USBDevice *dev); |
| 303 | |
| 304 | /* |
| 305 | * Process control request. |
| 306 | * Called from handle_packet(). |
| 307 | * |
| 308 | * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS |
| 309 | * then the number of bytes transferred is stored in p->actual_length |
| 310 | */ |
| 311 | void (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value, |
| 312 | int index, int length, uint8_t *data); |
| 313 | |
| 314 | /* |
| 315 | * Process data transfers (both BULK and ISOC). |
| 316 | * Called from handle_packet(). |
| 317 | * |
| 318 | * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS |
| 319 | * then the number of bytes transferred is stored in p->actual_length |
| 320 | */ |
| 321 | void (*handle_data)(USBDevice *dev, USBPacket *p); |
| 322 | |
| 323 | void (*set_interface)(USBDevice *dev, int interface, |
| 324 | int alt_old, int alt_new); |
| 325 | |
| 326 | /* |
| 327 | * Called when the hcd is done queuing packets for an endpoint, only |
| 328 | * necessary for devices which can return USB_RET_ADD_TO_QUEUE. |
| 329 | */ |
| 330 | void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep); |
| 331 | |
| 332 | /* |
| 333 | * Called by the hcd to let the device know the queue for an endpoint |
| 334 | * has been unlinked / stopped. Optional may be NULL. |
| 335 | */ |
| 336 | void (*ep_stopped)(USBDevice *dev, USBEndpoint *ep); |
| 337 | |
| 338 | /* |
| 339 | * Called by the hcd to alloc / free streams on a bulk endpoint. |
| 340 | * Optional may be NULL. |
| 341 | */ |
| 342 | int (*alloc_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps, |
| 343 | int streams); |
| 344 | void (*free_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps); |
| 345 | |
| 346 | const char *product_desc; |
| 347 | const USBDesc *usb_desc; |
| 348 | bool attached_settable; |
| 349 | }; |
| 350 | |
| 351 | typedef struct USBPortOps { |
| 352 | void (*attach)(USBPort *port); |
| 353 | void (*detach)(USBPort *port); |
| 354 | /* |
| 355 | * This gets called when a device downstream from the device attached to |
| 356 | * the port (iow attached through a hub) gets detached. |
| 357 | */ |
| 358 | void (*child_detach)(USBPort *port, USBDevice *child); |
| 359 | void (*wakeup)(USBPort *port); |
| 360 | /* |
| 361 | * Note that port->dev will be different then the device from which |
| 362 | * the packet originated when a hub is involved. |
| 363 | */ |
| 364 | void (*complete)(USBPort *port, USBPacket *p); |
| 365 | } USBPortOps; |
| 366 | |
| 367 | /* USB port on which a device can be connected */ |
| 368 | struct USBPort { |
| 369 | USBDevice *dev; |
| 370 | int speedmask; |
| 371 | int hubcount; |
| 372 | char path[16]; |
| 373 | USBPortOps *ops; |
| 374 | void *opaque; |
| 375 | int index; /* internal port index, may be used with the opaque */ |
| 376 | QTAILQ_ENTRY(USBPort) next; |
| 377 | }; |
| 378 | |
| 379 | typedef void USBCallback(USBPacket * packet, void *opaque); |
| 380 | |
| 381 | typedef enum USBPacketState { |
| 382 | USB_PACKET_UNDEFINED = 0, |
| 383 | USB_PACKET_SETUP, |
| 384 | USB_PACKET_QUEUED, |
| 385 | USB_PACKET_ASYNC, |
| 386 | USB_PACKET_COMPLETE, |
| 387 | USB_PACKET_CANCELED, |
| 388 | } USBPacketState; |
| 389 | |
| 390 | /* Structure used to hold information about an active USB packet. */ |
| 391 | struct USBPacket { |
| 392 | /* Data fields for use by the driver. */ |
| 393 | int pid; |
| 394 | uint64_t id; |
| 395 | USBEndpoint *ep; |
| 396 | unsigned int stream; |
| 397 | QEMUIOVector iov; |
| 398 | uint64_t parameter; /* control transfers */ |
| 399 | bool short_not_ok; |
| 400 | bool int_req; |
| 401 | int status; /* USB_RET_* status code */ |
| 402 | int actual_length; /* Number of bytes actually transferred */ |
| 403 | /* Internal use by the USB layer. */ |
| 404 | USBPacketState state; |
| 405 | USBCombinedPacket *combined; |
| 406 | QTAILQ_ENTRY(USBPacket) queue; |
| 407 | QTAILQ_ENTRY(USBPacket) combined_entry; |
| 408 | }; |
| 409 | |
| 410 | struct USBCombinedPacket { |
| 411 | USBPacket *first; |
| 412 | QTAILQ_HEAD(, USBPacket) packets; |
| 413 | QEMUIOVector iov; |
| 414 | }; |
| 415 | |
| 416 | void usb_packet_init(USBPacket *p); |
| 417 | void usb_packet_set_state(USBPacket *p, USBPacketState state); |
| 418 | void usb_packet_check_state(USBPacket *p, USBPacketState expected); |
| 419 | void usb_packet_setup(USBPacket *p, int pid, |
| 420 | USBEndpoint *ep, unsigned int stream, |
| 421 | uint64_t id, bool short_not_ok, bool int_req); |
| 422 | void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len); |
| 423 | int usb_packet_map(USBPacket *p, QEMUSGList *sgl); |
| 424 | void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl); |
| 425 | void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes); |
| 426 | void usb_packet_skip(USBPacket *p, size_t bytes); |
| 427 | size_t usb_packet_size(USBPacket *p); |
| 428 | void usb_packet_cleanup(USBPacket *p); |
| 429 | |
| 430 | static inline bool usb_packet_is_inflight(USBPacket *p) |
| 431 | { |
| 432 | return (p->state == USB_PACKET_QUEUED || |
| 433 | p->state == USB_PACKET_ASYNC); |
| 434 | } |
| 435 | |
| 436 | USBDevice *usb_find_device(USBPort *port, uint8_t addr); |
| 437 | |
| 438 | void usb_handle_packet(USBDevice *dev, USBPacket *p); |
| 439 | void usb_packet_complete(USBDevice *dev, USBPacket *p); |
| 440 | void usb_packet_complete_one(USBDevice *dev, USBPacket *p); |
| 441 | void usb_cancel_packet(USBPacket * p); |
| 442 | |
| 443 | void usb_ep_init(USBDevice *dev); |
| 444 | void usb_ep_reset(USBDevice *dev); |
| 445 | void usb_ep_dump(USBDevice *dev); |
| 446 | struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep); |
| 447 | uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep); |
| 448 | void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type); |
| 449 | void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum); |
| 450 | void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep, |
| 451 | uint16_t raw); |
| 452 | void usb_ep_set_max_streams(USBDevice *dev, int pid, int ep, uint8_t raw); |
| 453 | void usb_ep_set_halted(USBDevice *dev, int pid, int ep, bool halted); |
| 454 | USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep, |
| 455 | uint64_t id); |
| 456 | |
| 457 | void usb_ep_combine_input_packets(USBEndpoint *ep); |
| 458 | void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p); |
| 459 | void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p); |
| 460 | |
| 461 | void usb_pick_speed(USBPort *port); |
| 462 | void usb_attach(USBPort *port); |
| 463 | void usb_detach(USBPort *port); |
| 464 | void usb_port_reset(USBPort *port); |
| 465 | void usb_device_reset(USBDevice *dev); |
| 466 | void usb_wakeup(USBEndpoint *ep, unsigned int stream); |
| 467 | void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p); |
| 468 | |
| 469 | /* usb-linux.c */ |
| 470 | void hmp_info_usbhost(MonitorHMP *hmp, const QDict *qdict); |
| 471 | |
| 472 | /* usb ports of the VM */ |
| 473 | |
| 474 | #define VM_USB_HUB_SIZE 8 |
| 475 | |
| 476 | /* usb-bus.c */ |
| 477 | |
| 478 | #define TYPE_USB_BUS "usb-bus" |
| 479 | OBJECT_DECLARE_SIMPLE_TYPE(USBBus, USB_BUS) |
| 480 | |
| 481 | struct USBBus { |
| 482 | BusState qbus; |
| 483 | USBBusOps *ops; |
| 484 | int busnr; |
| 485 | int nfree; |
| 486 | int nused; |
| 487 | QTAILQ_HEAD(, USBPort) free; |
| 488 | QTAILQ_HEAD(, USBPort) used; |
| 489 | QTAILQ_ENTRY(USBBus) next; |
| 490 | }; |
| 491 | |
| 492 | struct USBBusOps { |
| 493 | void (*register_companion)(USBBus *bus, USBPort *ports[], |
| 494 | uint32_t portcount, uint32_t firstport, |
| 495 | Error **errp); |
| 496 | void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep, unsigned int stream); |
| 497 | }; |
| 498 | |
| 499 | void usb_bus_new(USBBus *bus, size_t bus_size, |
| 500 | USBBusOps *ops, DeviceState *host); |
| 501 | void usb_bus_release(USBBus *bus); |
| 502 | void usb_legacy_register(const char *typename, const char *usbdevice_name, |
| 503 | USBDevice *(*usbdevice_init)(void)); |
| 504 | USBDevice *usbdevice_create(const char *cmdline); |
| 505 | void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index, |
| 506 | USBPortOps *ops, int speedmask); |
| 507 | void usb_register_companion(const char *masterbus, USBPort *ports[], |
| 508 | uint32_t portcount, uint32_t firstport, |
| 509 | void *opaque, USBPortOps *ops, int speedmask, |
| 510 | Error **errp); |
| 511 | void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr); |
| 512 | void usb_unregister_port(USBBus *bus, USBPort *port); |
| 513 | void usb_claim_port(USBDevice *dev, Error **errp); |
| 514 | void usb_release_port(USBDevice *dev); |
| 515 | void usb_device_attach(USBDevice *dev, Error **errp); |
| 516 | int usb_device_detach(USBDevice *dev); |
| 517 | void usb_check_attach(USBDevice *dev, Error **errp); |
| 518 | |
| 519 | static inline USBBus *usb_bus_from_device(USBDevice *d) |
| 520 | { |
| 521 | return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus); |
| 522 | } |
| 523 | |
| 524 | extern const VMStateDescription vmstate_usb_device; |
| 525 | |
| 526 | #define VMSTATE_USB_DEVICE(_field, _state) { \ |
| 527 | .name = (stringify(_field)), \ |
| 528 | .size = sizeof(USBDevice), \ |
| 529 | .vmsd = &vmstate_usb_device, \ |
| 530 | .flags = VMS_STRUCT, \ |
| 531 | .offset = vmstate_offset_value(_state, _field, USBDevice), \ |
| 532 | } |
| 533 | |
| 534 | USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr); |
| 535 | |
| 536 | void usb_device_cancel_packet(USBDevice *dev, USBPacket *p); |
| 537 | |
| 538 | void usb_device_handle_attach(USBDevice *dev); |
| 539 | |
| 540 | void usb_device_handle_reset(USBDevice *dev); |
| 541 | |
| 542 | void usb_device_handle_control(USBDevice *dev, USBPacket *p, int request, |
| 543 | int val, int index, int length, uint8_t *data); |
| 544 | |
| 545 | void usb_device_handle_data(USBDevice *dev, USBPacket *p); |
| 546 | |
| 547 | void usb_device_set_interface(USBDevice *dev, int interface, |
| 548 | int alt_old, int alt_new); |
| 549 | |
| 550 | void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep); |
| 551 | |
| 552 | void usb_device_ep_stopped(USBDevice *dev, USBEndpoint *ep); |
| 553 | |
| 554 | int usb_device_alloc_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps, |
| 555 | int streams); |
| 556 | void usb_device_free_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps); |
| 557 | |
| 558 | const char *usb_device_get_product_desc(USBDevice *dev); |
| 559 | |
| 560 | const USBDesc *usb_device_get_usb_desc(USBDevice *dev); |
| 561 | |
| 562 | static inline bool usb_device_is_scsi_storage(USBDevice *dev) |
| 563 | { |
| 564 | return dev->flags & (1 << USB_DEV_FLAG_IS_SCSI_STORAGE); |
| 565 | } |
| 566 | |
| 567 | /* quirks.c */ |
| 568 | |
| 569 | /* In bulk endpoints are streaming data sources (iow behave like isoc eps) */ |
| 570 | #define USB_QUIRK_BUFFER_BULK_IN 0x01 |
| 571 | /* Bulk pkts in FTDI format, need special handling when combining packets */ |
| 572 | #define USB_QUIRK_IS_FTDI 0x02 |
| 573 | |
| 574 | int usb_get_quirks(uint16_t vendor_id, uint16_t product_id, |
| 575 | uint8_t interface_class, uint8_t interface_subclass, |
| 576 | uint8_t interface_protocol); |
| 577 | |
| 578 | /* pcap.c */ |
| 579 | void usb_pcap_init(FILE *fp); |
| 580 | void usb_pcap_ctrl(USBPacket *p, bool setup); |
| 581 | void usb_pcap_data(USBPacket *p, bool setup); |
| 582 | |
| 583 | static inline bool usb_realize_and_unref(USBDevice *dev, USBBus *bus, Error **errp) |
| 584 | { |
| 585 | return qdev_realize_and_unref(&dev->qdev, &bus->qbus, errp); |
| 586 | } |
| 587 | |
| 588 | static inline USBDevice *usb_create_simple(USBBus *bus, const char *name) |
| 589 | { |
| 590 | USBDevice *dev = USB_DEVICE(qdev_new(name)); |
| 591 | |
| 592 | usb_realize_and_unref(dev, bus, &error_abort); |
| 593 | return dev; |
| 594 | } |
| 595 | |
| 596 | #endif |