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