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