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