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