hw/usb.h

   1 /*
   2  * QEMU USB API
   3  *
   4  * Copyright (c) 2005 Fabrice Bellard
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #include "block.h"
  26 #include "qdev.h"
  27 #include "qemu-queue.h"
  28
  29 #define USB_TOKEN_SETUP 0x2d
  30 #define USB_TOKEN_IN    0x69 /* device -> host */
  31 #define USB_TOKEN_OUT   0xe1 /* host -> device */
  32
  33 /* specific usb messages, also sent in the 'pid' parameter */
  34 #define USB_MSG_ATTACH   0x100
  35 #define USB_MSG_DETACH   0x101
  36 #define USB_MSG_RESET    0x102
  37
  38 #define USB_RET_NODEV  (-1)
  39 #define USB_RET_NAK    (-2)
  40 #define USB_RET_STALL  (-3)
  41 #define USB_RET_BABBLE (-4)
  42 #define USB_RET_ASYNC  (-5)
  43
  44 #define USB_SPEED_LOW   0
  45 #define USB_SPEED_FULL  1
  46 #define USB_SPEED_HIGH  2
  47 #define USB_SPEED_SUPER 3
  48
  49 #define USB_SPEED_MASK_LOW   (1 << USB_SPEED_LOW)
  50 #define USB_SPEED_MASK_FULL  (1 << USB_SPEED_FULL)
  51 #define USB_SPEED_MASK_HIGH  (1 << USB_SPEED_HIGH)
  52 #define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
  53
  54 #define USB_STATE_NOTATTACHED 0
  55 #define USB_STATE_ATTACHED    1
  56 //#define USB_STATE_POWERED     2
  57 #define USB_STATE_DEFAULT     3
  58 //#define USB_STATE_ADDRESS     4
  59 //#define       USB_STATE_CONFIGURED  5
  60 #define USB_STATE_SUSPENDED   6
  61
  62 #define USB_CLASS_AUDIO                 1
  63 #define USB_CLASS_COMM                  2
  64 #define USB_CLASS_HID                   3
  65 #define USB_CLASS_PHYSICAL              5
  66 #define USB_CLASS_STILL_IMAGE           6
  67 #define USB_CLASS_PRINTER               7
  68 #define USB_CLASS_MASS_STORAGE          8
  69 #define USB_CLASS_HUB                   9
  70 #define USB_CLASS_CDC_DATA              0x0a
  71 #define USB_CLASS_CSCID                 0x0b
  72 #define USB_CLASS_CONTENT_SEC           0x0d
  73 #define USB_CLASS_APP_SPEC              0xfe
  74 #define USB_CLASS_VENDOR_SPEC           0xff
  75
  76 #define USB_DIR_OUT                     0
  77 #define USB_DIR_IN                      0x80
  78
  79 #define USB_TYPE_MASK                   (0x03 << 5)
  80 #define USB_TYPE_STANDARD               (0x00 << 5)
  81 #define USB_TYPE_CLASS                  (0x01 << 5)
  82 #define USB_TYPE_VENDOR                 (0x02 << 5)
  83 #define USB_TYPE_RESERVED               (0x03 << 5)
  84
  85 #define USB_RECIP_MASK                  0x1f
  86 #define USB_RECIP_DEVICE                0x00
  87 #define USB_RECIP_INTERFACE             0x01
  88 #define USB_RECIP_ENDPOINT              0x02
  89 #define USB_RECIP_OTHER                 0x03
  90
  91 #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  92 #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  93 #define InterfaceRequest \
  94         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  95 #define InterfaceOutRequest \
  96         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  97 #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
  98 #define EndpointOutRequest \
  99         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
 100 #define ClassInterfaceRequest \
 101         ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
 102 #define ClassInterfaceOutRequest \
 103         ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
 104
 105 #define USB_REQ_GET_STATUS              0x00
 106 #define USB_REQ_CLEAR_FEATURE           0x01
 107 #define USB_REQ_SET_FEATURE             0x03
 108 #define USB_REQ_SET_ADDRESS             0x05
 109 #define USB_REQ_GET_DESCRIPTOR          0x06
 110 #define USB_REQ_SET_DESCRIPTOR          0x07
 111 #define USB_REQ_GET_CONFIGURATION       0x08
 112 #define USB_REQ_SET_CONFIGURATION       0x09
 113 #define USB_REQ_GET_INTERFACE           0x0A
 114 #define USB_REQ_SET_INTERFACE           0x0B
 115 #define USB_REQ_SYNCH_FRAME             0x0C
 116
 117 #define USB_DEVICE_SELF_POWERED         0
 118 #define USB_DEVICE_REMOTE_WAKEUP        1
 119
 120 #define USB_DT_DEVICE                   0x01
 121 #define USB_DT_CONFIG                   0x02
 122 #define USB_DT_STRING                   0x03
 123 #define USB_DT_INTERFACE                0x04
 124 #define USB_DT_ENDPOINT                 0x05
 125 #define USB_DT_DEVICE_QUALIFIER         0x06
 126 #define USB_DT_OTHER_SPEED_CONFIG       0x07
 127 #define USB_DT_INTERFACE_ASSOC          0x0B
 128
 129 #define USB_ENDPOINT_XFER_CONTROL       0
 130 #define USB_ENDPOINT_XFER_ISOC          1
 131 #define USB_ENDPOINT_XFER_BULK          2
 132 #define USB_ENDPOINT_XFER_INT           3
 133
 134 typedef struct USBBus USBBus;
 135 typedef struct USBPort USBPort;
 136 typedef struct USBDevice USBDevice;
 137 typedef struct USBDeviceInfo USBDeviceInfo;
 138 typedef struct USBPacket USBPacket;
 139
 140 typedef struct USBDesc USBDesc;
 141 typedef struct USBDescID USBDescID;
 142 typedef struct USBDescDevice USBDescDevice;
 143 typedef struct USBDescConfig USBDescConfig;
 144 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
 145 typedef struct USBDescIface USBDescIface;
 146 typedef struct USBDescEndpoint USBDescEndpoint;
 147 typedef struct USBDescOther USBDescOther;
 148 typedef struct USBDescString USBDescString;
 149
 150 struct USBDescString {
 151     uint8_t index;
 152     char *str;
 153     QLIST_ENTRY(USBDescString) next;
 154 };
 155
 156 /* definition of a USB device */
 157 struct USBDevice {
 158     DeviceState qdev;
 159     USBDeviceInfo *info;
 160     USBPort *port;
 161     char *port_path;
 162     void *opaque;
 163
 164     int speed;
 165     uint8_t addr;
 166     char product_desc[32];
 167     int auto_attach;
 168     int attached;
 169
 170     int32_t state;
 171     uint8_t setup_buf[8];
 172     uint8_t data_buf[4096];
 173     int32_t remote_wakeup;
 174     int32_t setup_state;
 175     int32_t setup_len;
 176     int32_t setup_index;
 177
 178     QLIST_HEAD(, USBDescString) strings;
 179     const USBDescDevice *device;
 180     const USBDescConfig *config;
 181 };
 182
 183 struct USBDeviceInfo {
 184     DeviceInfo qdev;
 185     int (*init)(USBDevice *dev);
 186
 187     /*
 188      * Process USB packet.
 189      * Called by the HC (Host Controller).
 190      *
 191      * Returns length of the transaction
 192      * or one of the USB_RET_XXX codes.
 193      */
 194     int (*handle_packet)(USBDevice *dev, USBPacket *p);
 195
 196     /*
 197      * Called when device is destroyed.
 198      */
 199     void (*handle_destroy)(USBDevice *dev);
 200
 201     /*
 202      * Attach the device
 203      */
 204     void (*handle_attach)(USBDevice *dev);
 205
 206     /*
 207      * Reset the device
 208      */
 209     void (*handle_reset)(USBDevice *dev);
 210
 211     /*
 212      * Process control request.
 213      * Called from handle_packet().
 214      *
 215      * Returns length or one of the USB_RET_ codes.
 216      */
 217     int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
 218                           int index, int length, uint8_t *data);
 219
 220     /*
 221      * Process data transfers (both BULK and ISOC).
 222      * Called from handle_packet().
 223      *
 224      * Returns length or one of the USB_RET_ codes.
 225      */
 226     int (*handle_data)(USBDevice *dev, USBPacket *p);
 227
 228     const char *product_desc;
 229     const USBDesc *usb_desc;
 230
 231     /* handle legacy -usbdevice command line options */
 232     const char *usbdevice_name;
 233     USBDevice *(*usbdevice_init)(const char *params);
 234 };
 235
 236 typedef struct USBPortOps {
 237     void (*attach)(USBPort *port);
 238     void (*detach)(USBPort *port);
 239     void (*wakeup)(USBDevice *dev);
 240     void (*complete)(USBDevice *dev, USBPacket *p);
 241 } USBPortOps;
 242
 243 /* USB port on which a device can be connected */
 244 struct USBPort {
 245     USBDevice *dev;
 246     int speedmask;
 247     char path[16];
 248     USBPortOps *ops;
 249     void *opaque;
 250     int index; /* internal port index, may be used with the opaque */
 251     QTAILQ_ENTRY(USBPort) next;
 252 };
 253
 254 typedef void USBCallback(USBPacket * packet, void *opaque);
 255
 256 /* Structure used to hold information about an active USB packet.  */
 257 struct USBPacket {
 258     /* Data fields for use by the driver.  */
 259     int pid;
 260     uint8_t devaddr;
 261     uint8_t devep;
 262     uint8_t *data;
 263     int len;
 264     /* Internal use by the USB layer.  */
 265     USBCallback *cancel_cb;
 266     void *cancel_opaque;
 267 };
 268
 269 int usb_handle_packet(USBDevice *dev, USBPacket *p);
 270
 271 /* Defer completion of a USB packet.  The hadle_packet routine should then
 272    return USB_RET_ASYNC.  Packets that complete immediately (before
 273    handle_packet returns) should not call this method.  */
 274 static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
 275                                     void * opaque)
 276 {
 277     p->cancel_cb = cancel;
 278     p->cancel_opaque = opaque;
 279 }
 280
 281 /* Notify the controller that an async packet is complete.  This should only
 282    be called for packets previously deferred with usb_defer_packet, and
 283    should never be called from within handle_packet.  */
 284 static inline void usb_packet_complete(USBDevice *dev, USBPacket *p)
 285 {
 286     dev->port->ops->complete(dev, p);
 287 }
 288
 289 /* Cancel an active packet.  The packed must have been deferred with
 290    usb_defer_packet,  and not yet completed.  */
 291 static inline void usb_cancel_packet(USBPacket * p)
 292 {
 293     p->cancel_cb(p, p->cancel_opaque);
 294 }
 295
 296 void usb_attach(USBPort *port, USBDevice *dev);
 297 void usb_wakeup(USBDevice *dev);
 298 int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
 299 void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
 300 int set_usb_string(uint8_t *buf, const char *str);
 301 void usb_send_msg(USBDevice *dev, int msg);
 302
 303 /* usb-linux.c */
 304 USBDevice *usb_host_device_open(const char *devname);
 305 int usb_host_device_close(const char *devname);
 306 void usb_host_info(Monitor *mon);
 307
 308 /* usb-hid.c */
 309 void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));
 310
 311 /* usb-bt.c */
 312 USBDevice *usb_bt_init(HCIInfo *hci);
 313
 314 /* usb ports of the VM */
 315
 316 #define VM_USB_HUB_SIZE 8
 317
 318 /* usb-musb.c */
 319 enum musb_irq_source_e {
 320     musb_irq_suspend = 0,
 321     musb_irq_resume,
 322     musb_irq_rst_babble,
 323     musb_irq_sof,
 324     musb_irq_connect,
 325     musb_irq_disconnect,
 326     musb_irq_vbus_request,
 327     musb_irq_vbus_error,
 328     musb_irq_rx,
 329     musb_irq_tx,
 330     musb_set_vbus,
 331     musb_set_session,
 332     __musb_irq_max,
 333 };
 334
 335 typedef struct MUSBState MUSBState;
 336 MUSBState *musb_init(qemu_irq *irqs);
 337 uint32_t musb_core_intr_get(MUSBState *s);
 338 void musb_core_intr_clear(MUSBState *s, uint32_t mask);
 339 void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
 340
 341 /* usb-bus.c */
 342
 343 struct USBBus {
 344     BusState qbus;
 345     int busnr;
 346     int nfree;
 347     int nused;
 348     QTAILQ_HEAD(, USBPort) free;
 349     QTAILQ_HEAD(, USBPort) used;
 350     QTAILQ_ENTRY(USBBus) next;
 351 };
 352
 353 void usb_bus_new(USBBus *bus, DeviceState *host);
 354 USBBus *usb_bus_find(int busnr);
 355 void usb_qdev_register(USBDeviceInfo *info);
 356 void usb_qdev_register_many(USBDeviceInfo *info);
 357 USBDevice *usb_create(USBBus *bus, const char *name);
 358 USBDevice *usb_create_simple(USBBus *bus, const char *name);
 359 USBDevice *usbdevice_create(const char *cmdline);
 360 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
 361                        USBPortOps *ops, int speedmask);
 362 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
 363 void usb_unregister_port(USBBus *bus, USBPort *port);
 364 int usb_device_attach(USBDevice *dev);
 365 int usb_device_detach(USBDevice *dev);
 366 int usb_device_delete_addr(int busnr, int addr);
 367
 368 static inline USBBus *usb_bus_from_device(USBDevice *d)
 369 {
 370     return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
 371 }