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_CS_INTERFACE             0x24
 139 #define USB_DT_CS_ENDPOINT              0x25
 140
 141 #define USB_ENDPOINT_XFER_CONTROL       0
 142 #define USB_ENDPOINT_XFER_ISOC          1
 143 #define USB_ENDPOINT_XFER_BULK          2
 144 #define USB_ENDPOINT_XFER_INT           3
 145 #define USB_ENDPOINT_XFER_INVALID     255
 146
 147 #define USB_INTERFACE_INVALID         255
 148
 149 typedef struct USBBus USBBus;
 150 typedef struct USBBusOps USBBusOps;
 151 typedef struct USBPort USBPort;
 152 typedef struct USBDevice USBDevice;
 153 typedef struct USBPacket USBPacket;
 154 typedef struct USBEndpoint USBEndpoint;
 155
 156 typedef struct USBDesc USBDesc;
 157 typedef struct USBDescID USBDescID;
 158 typedef struct USBDescDevice USBDescDevice;
 159 typedef struct USBDescConfig USBDescConfig;
 160 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
 161 typedef struct USBDescIface USBDescIface;
 162 typedef struct USBDescEndpoint USBDescEndpoint;
 163 typedef struct USBDescOther USBDescOther;
 164 typedef struct USBDescString USBDescString;
 165
 166 struct USBDescString {
 167     uint8_t index;
 168     char *str;
 169     QLIST_ENTRY(USBDescString) next;
 170 };
 171
 172 #define USB_MAX_ENDPOINTS  15
 173 #define USB_MAX_INTERFACES 16
 174
 175 struct USBEndpoint {
 176     uint8_t nr;
 177     uint8_t pid;
 178     uint8_t type;
 179     uint8_t ifnum;
 180     int max_packet_size;
 181     bool pipeline;
 182     USBDevice *dev;
 183     QTAILQ_HEAD(, USBPacket) queue;
 184 };
 185
 186 enum USBDeviceFlags {
 187     USB_DEV_FLAG_FULL_PATH,
 188 };
 189
 190 /* definition of a USB device */
 191 struct USBDevice {
 192     DeviceState qdev;
 193     USBPort *port;
 194     char *port_path;
 195     void *opaque;
 196     uint32_t flags;
 197
 198     /* Actual connected speed */
 199     int speed;
 200     /* Supported speeds, not in info because it may be variable (hostdevs) */
 201     int speedmask;
 202     uint8_t addr;
 203     char product_desc[32];
 204     int auto_attach;
 205     int attached;
 206
 207     int32_t state;
 208     uint8_t setup_buf[8];
 209     uint8_t data_buf[4096];
 210     int32_t remote_wakeup;
 211     int32_t setup_state;
 212     int32_t setup_len;
 213     int32_t setup_index;
 214
 215     USBEndpoint ep_ctl;
 216     USBEndpoint ep_in[USB_MAX_ENDPOINTS];
 217     USBEndpoint ep_out[USB_MAX_ENDPOINTS];
 218
 219     QLIST_HEAD(, USBDescString) strings;
 220     const USBDescDevice *device;
 221
 222     int configuration;
 223     int ninterfaces;
 224     int altsetting[USB_MAX_INTERFACES];
 225     const USBDescConfig *config;
 226     const USBDescIface  *ifaces[USB_MAX_INTERFACES];
 227 };
 228
 229 #define TYPE_USB_DEVICE "usb-device"
 230 #define USB_DEVICE(obj) \
 231      OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
 232 #define USB_DEVICE_CLASS(klass) \
 233      OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
 234 #define USB_DEVICE_GET_CLASS(obj) \
 235      OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
 236
 237 typedef struct USBDeviceClass {
 238     DeviceClass parent_class;
 239
 240     int (*init)(USBDevice *dev);
 241
 242     /*
 243      * Walk (enabled) downstream ports, check for a matching device.
 244      * Only hubs implement this.
 245      */
 246     USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
 247
 248     /*
 249      * Called when a packet is canceled.
 250      */
 251     void (*cancel_packet)(USBDevice *dev, USBPacket *p);
 252
 253     /*
 254      * Called when device is destroyed.
 255      */
 256     void (*handle_destroy)(USBDevice *dev);
 257
 258     /*
 259      * Attach the device
 260      */
 261     void (*handle_attach)(USBDevice *dev);
 262
 263     /*
 264      * Reset the device
 265      */
 266     void (*handle_reset)(USBDevice *dev);
 267
 268     /*
 269      * Process control request.
 270      * Called from handle_packet().
 271      *
 272      * Returns length or one of the USB_RET_ codes.
 273      */
 274     int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
 275                           int index, int length, uint8_t *data);
 276
 277     /*
 278      * Process data transfers (both BULK and ISOC).
 279      * Called from handle_packet().
 280      *
 281      * Returns length or one of the USB_RET_ codes.
 282      */
 283     int (*handle_data)(USBDevice *dev, USBPacket *p);
 284
 285     void (*set_interface)(USBDevice *dev, int interface,
 286                           int alt_old, int alt_new);
 287
 288     const char *product_desc;
 289     const USBDesc *usb_desc;
 290 } USBDeviceClass;
 291
 292 typedef struct USBPortOps {
 293     void (*attach)(USBPort *port);
 294     void (*detach)(USBPort *port);
 295     /*
 296      * This gets called when a device downstream from the device attached to
 297      * the port (iow attached through a hub) gets detached.
 298      */
 299     void (*child_detach)(USBPort *port, USBDevice *child);
 300     void (*wakeup)(USBPort *port);
 301     /*
 302      * Note that port->dev will be different then the device from which
 303      * the packet originated when a hub is involved.
 304      */
 305     void (*complete)(USBPort *port, USBPacket *p);
 306 } USBPortOps;
 307
 308 /* USB port on which a device can be connected */
 309 struct USBPort {
 310     USBDevice *dev;
 311     int speedmask;
 312     char path[16];
 313     USBPortOps *ops;
 314     void *opaque;
 315     int index; /* internal port index, may be used with the opaque */
 316     QTAILQ_ENTRY(USBPort) next;
 317 };
 318
 319 typedef void USBCallback(USBPacket * packet, void *opaque);
 320
 321 typedef enum USBPacketState {
 322     USB_PACKET_UNDEFINED = 0,
 323     USB_PACKET_SETUP,
 324     USB_PACKET_QUEUED,
 325     USB_PACKET_ASYNC,
 326     USB_PACKET_COMPLETE,
 327     USB_PACKET_CANCELED,
 328 } USBPacketState;
 329
 330 /* Structure used to hold information about an active USB packet.  */
 331 struct USBPacket {
 332     /* Data fields for use by the driver.  */
 333     int pid;
 334     USBEndpoint *ep;
 335     QEMUIOVector iov;
 336     uint64_t parameter; /* control transfers */
 337     int result; /* transfer length or USB_RET_* status code */
 338     /* Internal use by the USB layer.  */
 339     USBPacketState state;
 340     QTAILQ_ENTRY(USBPacket) queue;
 341 };
 342
 343 void usb_packet_init(USBPacket *p);
 344 void usb_packet_set_state(USBPacket *p, USBPacketState state);
 345 void usb_packet_check_state(USBPacket *p, USBPacketState expected);
 346 void usb_packet_setup(USBPacket *p, int pid, USBEndpoint *ep);
 347 void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
 348 int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
 349 void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
 350 void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
 351 void usb_packet_skip(USBPacket *p, size_t bytes);
 352 void usb_packet_cleanup(USBPacket *p);
 353
 354 static inline bool usb_packet_is_inflight(USBPacket *p)
 355 {
 356     return (p->state == USB_PACKET_QUEUED ||
 357             p->state == USB_PACKET_ASYNC);
 358 }
 359
 360 USBDevice *usb_find_device(USBPort *port, uint8_t addr);
 361
 362 int usb_handle_packet(USBDevice *dev, USBPacket *p);
 363 void usb_packet_complete(USBDevice *dev, USBPacket *p);
 364 void usb_cancel_packet(USBPacket * p);
 365
 366 void usb_ep_init(USBDevice *dev);
 367 void usb_ep_reset(USBDevice *dev);
 368 void usb_ep_dump(USBDevice *dev);
 369 struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
 370 uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
 371 uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
 372 void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
 373 void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
 374 void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
 375                                 uint16_t raw);
 376 int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
 377 void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);
 378
 379 void usb_attach(USBPort *port);
 380 void usb_detach(USBPort *port);
 381 void usb_port_reset(USBPort *port);
 382 void usb_device_reset(USBDevice *dev);
 383 void usb_wakeup(USBEndpoint *ep);
 384 void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
 385 int set_usb_string(uint8_t *buf, const char *str);
 386
 387 /* usb-linux.c */
 388 USBDevice *usb_host_device_open(USBBus *bus, const char *devname);
 389 int usb_host_device_close(const char *devname);
 390 void usb_host_info(Monitor *mon);
 391
 392 /* usb-bt.c */
 393 USBDevice *usb_bt_init(USBBus *bus, HCIInfo *hci);
 394
 395 /* usb ports of the VM */
 396
 397 #define VM_USB_HUB_SIZE 8
 398
 399 /* usb-musb.c */
 400 enum musb_irq_source_e {
 401     musb_irq_suspend = 0,
 402     musb_irq_resume,
 403     musb_irq_rst_babble,
 404     musb_irq_sof,
 405     musb_irq_connect,
 406     musb_irq_disconnect,
 407     musb_irq_vbus_request,
 408     musb_irq_vbus_error,
 409     musb_irq_rx,
 410     musb_irq_tx,
 411     musb_set_vbus,
 412     musb_set_session,
 413     /* Add new interrupts here */
 414     musb_irq_max, /* total number of interrupts defined */
 415 };
 416
 417 typedef struct MUSBState MUSBState;
 418 MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
 419 void musb_reset(MUSBState *s);
 420 uint32_t musb_core_intr_get(MUSBState *s);
 421 void musb_core_intr_clear(MUSBState *s, uint32_t mask);
 422 void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
 423
 424 /* usb-bus.c */
 425
 426 #define TYPE_USB_BUS "usb-bus"
 427 #define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
 428
 429 struct USBBus {
 430     BusState qbus;
 431     USBBusOps *ops;
 432     int busnr;
 433     int nfree;
 434     int nused;
 435     QTAILQ_HEAD(, USBPort) free;
 436     QTAILQ_HEAD(, USBPort) used;
 437     QTAILQ_ENTRY(USBBus) next;
 438 };
 439
 440 struct USBBusOps {
 441     int (*register_companion)(USBBus *bus, USBPort *ports[],
 442                               uint32_t portcount, uint32_t firstport);
 443     void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep);
 444 };
 445
 446 void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
 447 USBBus *usb_bus_find(int busnr);
 448 void usb_legacy_register(const char *typename, const char *usbdevice_name,
 449                          USBDevice *(*usbdevice_init)(USBBus *bus,
 450                                                       const char *params));
 451 USBDevice *usb_create(USBBus *bus, const char *name);
 452 USBDevice *usb_create_simple(USBBus *bus, const char *name);
 453 USBDevice *usbdevice_create(const char *cmdline);
 454 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
 455                        USBPortOps *ops, int speedmask);
 456 int usb_register_companion(const char *masterbus, USBPort *ports[],
 457                            uint32_t portcount, uint32_t firstport,
 458                            void *opaque, USBPortOps *ops, int speedmask);
 459 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
 460 void usb_unregister_port(USBBus *bus, USBPort *port);
 461 int usb_claim_port(USBDevice *dev);
 462 void usb_release_port(USBDevice *dev);
 463 int usb_device_attach(USBDevice *dev);
 464 int usb_device_detach(USBDevice *dev);
 465 int usb_device_delete_addr(int busnr, int addr);
 466
 467 static inline USBBus *usb_bus_from_device(USBDevice *d)
 468 {
 469     return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
 470 }
 471
 472 extern const VMStateDescription vmstate_usb_device;
 473
 474 #define VMSTATE_USB_DEVICE(_field, _state) {                         \
 475     .name       = (stringify(_field)),                               \
 476     .size       = sizeof(USBDevice),                                 \
 477     .vmsd       = &vmstate_usb_device,                               \
 478     .flags      = VMS_STRUCT,                                        \
 479     .offset     = vmstate_offset_value(_state, _field, USBDevice),   \
 480 }
 481
 482 USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
 483
 484 void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
 485
 486 void usb_device_handle_attach(USBDevice *dev);
 487
 488 void usb_device_handle_reset(USBDevice *dev);
 489
 490 int usb_device_handle_control(USBDevice *dev, USBPacket *p, int request, int value,
 491                               int index, int length, uint8_t *data);
 492
 493 int usb_device_handle_data(USBDevice *dev, USBPacket *p);
 494
 495 void usb_device_set_interface(USBDevice *dev, int interface,
 496                               int alt_old, int alt_new);
 497
 498 const char *usb_device_get_product_desc(USBDevice *dev);
 499
 500 const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
 501
 502 #endif
 503