include/hw/usb.h

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