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