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 "block.h"
  29 #include "qdev.h"
  30 #include "qemu-queue.h"
  31
  32 /* Constants related to the USB / PCI interaction */
  33 #define USB_SBRN    0x60 /* Serial Bus Release Number Register */
  34 #define USB_RELEASE_1  0x10 /* USB 1.0 */
  35 #define USB_RELEASE_2  0x20 /* USB 2.0 */
  36 #define USB_RELEASE_3  0x30 /* USB 3.0 */
  37
  38 #define USB_TOKEN_SETUP 0x2d
  39 #define USB_TOKEN_IN    0x69 /* device -> host */
  40 #define USB_TOKEN_OUT   0xe1 /* host -> device */
  41
  42 /* specific usb messages, also sent in the 'pid' parameter */
  43 #define USB_MSG_ATTACH   0x100
  44 #define USB_MSG_DETACH   0x101
  45 #define USB_MSG_RESET    0x102
  46
  47 #define USB_RET_NODEV  (-1)
  48 #define USB_RET_NAK    (-2)
  49 #define USB_RET_STALL  (-3)
  50 #define USB_RET_BABBLE (-4)
  51 #define USB_RET_ASYNC  (-5)
  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 InterfaceRequest \
 108         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 109 #define InterfaceOutRequest \
 110         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
 111 #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
 112 #define EndpointOutRequest \
 113         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
 114 #define ClassInterfaceRequest \
 115         ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
 116 #define ClassInterfaceOutRequest \
 117         ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
 118
 119 #define USB_REQ_GET_STATUS              0x00
 120 #define USB_REQ_CLEAR_FEATURE           0x01
 121 #define USB_REQ_SET_FEATURE             0x03
 122 #define USB_REQ_SET_ADDRESS             0x05
 123 #define USB_REQ_GET_DESCRIPTOR          0x06
 124 #define USB_REQ_SET_DESCRIPTOR          0x07
 125 #define USB_REQ_GET_CONFIGURATION       0x08
 126 #define USB_REQ_SET_CONFIGURATION       0x09
 127 #define USB_REQ_GET_INTERFACE           0x0A
 128 #define USB_REQ_SET_INTERFACE           0x0B
 129 #define USB_REQ_SYNCH_FRAME             0x0C
 130
 131 #define USB_DEVICE_SELF_POWERED         0
 132 #define USB_DEVICE_REMOTE_WAKEUP        1
 133
 134 #define USB_DT_DEVICE                   0x01
 135 #define USB_DT_CONFIG                   0x02
 136 #define USB_DT_STRING                   0x03
 137 #define USB_DT_INTERFACE                0x04
 138 #define USB_DT_ENDPOINT                 0x05
 139 #define USB_DT_DEVICE_QUALIFIER         0x06
 140 #define USB_DT_OTHER_SPEED_CONFIG       0x07
 141 #define USB_DT_DEBUG                    0x0A
 142 #define USB_DT_INTERFACE_ASSOC          0x0B
 143 #define USB_DT_CS_INTERFACE             0x24
 144 #define USB_DT_CS_ENDPOINT              0x25
 145
 146 #define USB_ENDPOINT_XFER_CONTROL       0
 147 #define USB_ENDPOINT_XFER_ISOC          1
 148 #define USB_ENDPOINT_XFER_BULK          2
 149 #define USB_ENDPOINT_XFER_INT           3
 150 #define USB_ENDPOINT_XFER_INVALID     255
 151
 152 typedef struct USBBus USBBus;
 153 typedef struct USBBusOps USBBusOps;
 154 typedef struct USBPort USBPort;
 155 typedef struct USBDevice USBDevice;
 156 typedef struct USBPacket USBPacket;
 157 typedef struct USBEndpoint USBEndpoint;
 158
 159 typedef struct USBDesc USBDesc;
 160 typedef struct USBDescID USBDescID;
 161 typedef struct USBDescDevice USBDescDevice;
 162 typedef struct USBDescConfig USBDescConfig;
 163 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
 164 typedef struct USBDescIface USBDescIface;
 165 typedef struct USBDescEndpoint USBDescEndpoint;
 166 typedef struct USBDescOther USBDescOther;
 167 typedef struct USBDescString USBDescString;
 168
 169 struct USBDescString {
 170     uint8_t index;
 171     char *str;
 172     QLIST_ENTRY(USBDescString) next;
 173 };
 174
 175 #define USB_MAX_ENDPOINTS  15
 176 #define USB_MAX_INTERFACES 16
 177
 178 struct USBEndpoint {
 179     uint8_t type;
 180     uint8_t ifnum;
 181     int max_packet_size;
 182     USBDevice *dev;
 183 };
 184
 185 /* definition of a USB device */
 186 struct USBDevice {
 187     DeviceState qdev;
 188     USBPort *port;
 189     char *port_path;
 190     void *opaque;
 191
 192     /* Actual connected speed */
 193     int speed;
 194     /* Supported speeds, not in info because it may be variable (hostdevs) */
 195     int speedmask;
 196     uint8_t addr;
 197     char product_desc[32];
 198     int auto_attach;
 199     int attached;
 200
 201     int32_t state;
 202     uint8_t setup_buf[8];
 203     uint8_t data_buf[4096];
 204     int32_t remote_wakeup;
 205     int32_t setup_state;
 206     int32_t setup_len;
 207     int32_t setup_index;
 208
 209     USBEndpoint ep_ctl;
 210     USBEndpoint ep_in[USB_MAX_ENDPOINTS];
 211     USBEndpoint ep_out[USB_MAX_ENDPOINTS];
 212
 213     QLIST_HEAD(, USBDescString) strings;
 214     const USBDescDevice *device;
 215
 216     int configuration;
 217     int ninterfaces;
 218     int altsetting[USB_MAX_INTERFACES];
 219     const USBDescConfig *config;
 220     const USBDescIface  *ifaces[USB_MAX_INTERFACES];
 221 };
 222
 223 #define TYPE_USB_DEVICE "usb-device"
 224 #define USB_DEVICE(obj) \
 225      OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
 226 #define USB_DEVICE_CLASS(klass) \
 227      OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
 228 #define USB_DEVICE_GET_CLASS(obj) \
 229      OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
 230
 231 typedef struct USBDeviceClass {
 232     DeviceClass parent_class;
 233
 234     int (*init)(USBDevice *dev);
 235
 236     /*
 237      * Process USB packet.
 238      * Called by the HC (Host Controller).
 239      *
 240      * Returns length of the transaction
 241      * or one of the USB_RET_XXX codes.
 242      */
 243     int (*handle_packet)(USBDevice *dev, USBPacket *p);
 244
 245     /*
 246      * Called when a packet is canceled.
 247      */
 248     void (*cancel_packet)(USBDevice *dev, USBPacket *p);
 249
 250     /*
 251      * Called when device is destroyed.
 252      */
 253     void (*handle_destroy)(USBDevice *dev);
 254
 255     /*
 256      * Attach the device
 257      */
 258     void (*handle_attach)(USBDevice *dev);
 259
 260     /*
 261      * Reset the device
 262      */
 263     void (*handle_reset)(USBDevice *dev);
 264
 265     /*
 266      * Process control request.
 267      * Called from handle_packet().
 268      *
 269      * Returns length or one of the USB_RET_ codes.
 270      */
 271     int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
 272                           int index, int length, uint8_t *data);
 273
 274     /*
 275      * Process data transfers (both BULK and ISOC).
 276      * Called from handle_packet().
 277      *
 278      * Returns length or one of the USB_RET_ codes.
 279      */
 280     int (*handle_data)(USBDevice *dev, USBPacket *p);
 281
 282     void (*set_interface)(USBDevice *dev, int interface,
 283                           int alt_old, int alt_new);
 284
 285     const char *product_desc;
 286     const USBDesc *usb_desc;
 287 } USBDeviceClass;
 288
 289 typedef struct USBPortOps {
 290     void (*attach)(USBPort *port);
 291     void (*detach)(USBPort *port);
 292     /*
 293      * This gets called when a device downstream from the device attached to
 294      * the port (iow attached through a hub) gets detached.
 295      */
 296     void (*child_detach)(USBPort *port, USBDevice *child);
 297     void (*wakeup)(USBPort *port);
 298     /*
 299      * Note that port->dev will be different then the device from which
 300      * the packet originated when a hub is involved, if you want the orginating
 301      * device use p->owner
 302      */
 303     void (*complete)(USBPort *port, USBPacket *p);
 304 } USBPortOps;
 305
 306 /* USB port on which a device can be connected */
 307 struct USBPort {
 308     USBDevice *dev;
 309     int speedmask;
 310     char path[16];
 311     USBPortOps *ops;
 312     void *opaque;
 313     int index; /* internal port index, may be used with the opaque */
 314     QTAILQ_ENTRY(USBPort) next;
 315 };
 316
 317 typedef void USBCallback(USBPacket * packet, void *opaque);
 318
 319 /* Structure used to hold information about an active USB packet.  */
 320 struct USBPacket {
 321     /* Data fields for use by the driver.  */
 322     int pid;
 323     uint8_t devaddr;
 324     uint8_t devep;
 325     QEMUIOVector iov;
 326     int result; /* transfer length or USB_RET_* status code */
 327     /* Internal use by the USB layer.  */
 328     USBEndpoint *owner;
 329 };
 330
 331 void usb_packet_init(USBPacket *p);
 332 void usb_packet_setup(USBPacket *p, int pid, uint8_t addr, uint8_t ep);
 333 void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
 334 int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
 335 void usb_packet_unmap(USBPacket *p);
 336 void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
 337 void usb_packet_skip(USBPacket *p, size_t bytes);
 338 void usb_packet_cleanup(USBPacket *p);
 339
 340 int usb_handle_packet(USBDevice *dev, USBPacket *p);
 341 void usb_packet_complete(USBDevice *dev, USBPacket *p);
 342 void usb_cancel_packet(USBPacket * p);
 343
 344 void usb_ep_init(USBDevice *dev);
 345 void usb_ep_dump(USBDevice *dev);
 346 struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
 347 uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
 348 uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
 349 void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
 350 void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
 351 void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
 352                                 uint16_t raw);
 353 int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
 354
 355 void usb_attach(USBPort *port);
 356 void usb_detach(USBPort *port);
 357 void usb_reset(USBPort *port);
 358 void usb_wakeup(USBDevice *dev);
 359 int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
 360 void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
 361 int set_usb_string(uint8_t *buf, const char *str);
 362 void usb_send_msg(USBDevice *dev, int msg);
 363
 364 /* usb-linux.c */
 365 USBDevice *usb_host_device_open(const char *devname);
 366 int usb_host_device_close(const char *devname);
 367 void usb_host_info(Monitor *mon);
 368
 369 /* usb-bt.c */
 370 USBDevice *usb_bt_init(HCIInfo *hci);
 371
 372 /* usb ports of the VM */
 373
 374 #define VM_USB_HUB_SIZE 8
 375
 376 /* usb-musb.c */
 377 enum musb_irq_source_e {
 378     musb_irq_suspend = 0,
 379     musb_irq_resume,
 380     musb_irq_rst_babble,
 381     musb_irq_sof,
 382     musb_irq_connect,
 383     musb_irq_disconnect,
 384     musb_irq_vbus_request,
 385     musb_irq_vbus_error,
 386     musb_irq_rx,
 387     musb_irq_tx,
 388     musb_set_vbus,
 389     musb_set_session,
 390     /* Add new interrupts here */
 391     musb_irq_max, /* total number of interrupts defined */
 392 };
 393
 394 typedef struct MUSBState MUSBState;
 395 MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
 396 void musb_reset(MUSBState *s);
 397 uint32_t musb_core_intr_get(MUSBState *s);
 398 void musb_core_intr_clear(MUSBState *s, uint32_t mask);
 399 void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
 400
 401 /* usb-bus.c */
 402
 403 struct USBBus {
 404     BusState qbus;
 405     USBBusOps *ops;
 406     int busnr;
 407     int nfree;
 408     int nused;
 409     QTAILQ_HEAD(, USBPort) free;
 410     QTAILQ_HEAD(, USBPort) used;
 411     QTAILQ_ENTRY(USBBus) next;
 412 };
 413
 414 struct USBBusOps {
 415     int (*register_companion)(USBBus *bus, USBPort *ports[],
 416                               uint32_t portcount, uint32_t firstport);
 417 };
 418
 419 void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
 420 USBBus *usb_bus_find(int busnr);
 421 void usb_qdev_register(DeviceInfo *info,
 422                        const char *usbdevice_name,
 423                        USBDevice *(*usbdevice_init)(const char *params));
 424 USBDevice *usb_create(USBBus *bus, const char *name);
 425 USBDevice *usb_create_simple(USBBus *bus, const char *name);
 426 USBDevice *usbdevice_create(const char *cmdline);
 427 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
 428                        USBPortOps *ops, int speedmask);
 429 int usb_register_companion(const char *masterbus, USBPort *ports[],
 430                            uint32_t portcount, uint32_t firstport,
 431                            void *opaque, USBPortOps *ops, int speedmask);
 432 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
 433 void usb_unregister_port(USBBus *bus, USBPort *port);
 434 int usb_claim_port(USBDevice *dev);
 435 void usb_release_port(USBDevice *dev);
 436 int usb_device_attach(USBDevice *dev);
 437 int usb_device_detach(USBDevice *dev);
 438 int usb_device_delete_addr(int busnr, int addr);
 439
 440 static inline USBBus *usb_bus_from_device(USBDevice *d)
 441 {
 442     return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
 443 }
 444
 445 extern const VMStateDescription vmstate_usb_device;
 446
 447 #define VMSTATE_USB_DEVICE(_field, _state) {                         \
 448     .name       = (stringify(_field)),                               \
 449     .size       = sizeof(USBDevice),                                 \
 450     .vmsd       = &vmstate_usb_device,                               \
 451     .flags      = VMS_STRUCT,                                        \
 452     .offset     = vmstate_offset_value(_state, _field, USBDevice),   \
 453 }
 454
 455 int usb_device_handle_packet(USBDevice *dev, USBPacket *p);
 456
 457 void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
 458
 459 void usb_device_handle_attach(USBDevice *dev);
 460
 461 void usb_device_handle_reset(USBDevice *dev);
 462
 463 int usb_device_handle_control(USBDevice *dev, USBPacket *p, int request, int value,
 464                               int index, int length, uint8_t *data);
 465
 466 int usb_device_handle_data(USBDevice *dev, USBPacket *p);
 467
 468 void usb_device_set_interface(USBDevice *dev, int interface,
 469                               int alt_old, int alt_new);
 470
 471 const char *usb_device_get_product_desc(USBDevice *dev);
 472
 473 const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
 474
 475 #endif
 476