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
  48 #define USB_STATE_NOTATTACHED 0
  49 #define USB_STATE_ATTACHED    1
  50 //#define USB_STATE_POWERED     2
  51 #define USB_STATE_DEFAULT     3
  52 //#define USB_STATE_ADDRESS     4
  53 //#define       USB_STATE_CONFIGURED  5
  54 #define USB_STATE_SUSPENDED   6
  55
  56 #define USB_CLASS_AUDIO                 1
  57 #define USB_CLASS_COMM                  2
  58 #define USB_CLASS_HID                   3
  59 #define USB_CLASS_PHYSICAL              5
  60 #define USB_CLASS_STILL_IMAGE           6
  61 #define USB_CLASS_PRINTER               7
  62 #define USB_CLASS_MASS_STORAGE          8
  63 #define USB_CLASS_HUB                   9
  64 #define USB_CLASS_CDC_DATA              0x0a
  65 #define USB_CLASS_CSCID                 0x0b
  66 #define USB_CLASS_CONTENT_SEC           0x0d
  67 #define USB_CLASS_APP_SPEC              0xfe
  68 #define USB_CLASS_VENDOR_SPEC           0xff
  69
  70 #define USB_DIR_OUT                     0
  71 #define USB_DIR_IN                      0x80
  72
  73 #define USB_TYPE_MASK                   (0x03 << 5)
  74 #define USB_TYPE_STANDARD               (0x00 << 5)
  75 #define USB_TYPE_CLASS                  (0x01 << 5)
  76 #define USB_TYPE_VENDOR                 (0x02 << 5)
  77 #define USB_TYPE_RESERVED               (0x03 << 5)
  78
  79 #define USB_RECIP_MASK                  0x1f
  80 #define USB_RECIP_DEVICE                0x00
  81 #define USB_RECIP_INTERFACE             0x01
  82 #define USB_RECIP_ENDPOINT              0x02
  83 #define USB_RECIP_OTHER                 0x03
  84
  85 #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  86 #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  87 #define InterfaceRequest \
  88         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  89 #define InterfaceOutRequest \
  90         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  91 #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
  92 #define EndpointOutRequest \
  93         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
  94 #define ClassInterfaceRequest \
  95         ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
  96 #define ClassInterfaceOutRequest \
  97         ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
  98
  99 #define USB_REQ_GET_STATUS              0x00
 100 #define USB_REQ_CLEAR_FEATURE           0x01
 101 #define USB_REQ_SET_FEATURE             0x03
 102 #define USB_REQ_SET_ADDRESS             0x05
 103 #define USB_REQ_GET_DESCRIPTOR          0x06
 104 #define USB_REQ_SET_DESCRIPTOR          0x07
 105 #define USB_REQ_GET_CONFIGURATION       0x08
 106 #define USB_REQ_SET_CONFIGURATION       0x09
 107 #define USB_REQ_GET_INTERFACE           0x0A
 108 #define USB_REQ_SET_INTERFACE           0x0B
 109 #define USB_REQ_SYNCH_FRAME             0x0C
 110
 111 #define USB_DEVICE_SELF_POWERED         0
 112 #define USB_DEVICE_REMOTE_WAKEUP        1
 113
 114 #define USB_DT_DEVICE                   0x01
 115 #define USB_DT_CONFIG                   0x02
 116 #define USB_DT_STRING                   0x03
 117 #define USB_DT_INTERFACE                0x04
 118 #define USB_DT_ENDPOINT                 0x05
 119
 120 #define USB_ENDPOINT_XFER_CONTROL       0
 121 #define USB_ENDPOINT_XFER_ISOC          1
 122 #define USB_ENDPOINT_XFER_BULK          2
 123 #define USB_ENDPOINT_XFER_INT           3
 124
 125 typedef struct USBBus USBBus;
 126 typedef struct USBPort USBPort;
 127 typedef struct USBDevice USBDevice;
 128 typedef struct USBDeviceInfo USBDeviceInfo;
 129 typedef struct USBPacket USBPacket;
 130
 131 typedef struct USBDesc USBDesc;
 132 typedef struct USBDescID USBDescID;
 133 typedef struct USBDescDevice USBDescDevice;
 134 typedef struct USBDescConfig USBDescConfig;
 135 typedef struct USBDescIface USBDescIface;
 136 typedef struct USBDescEndpoint USBDescEndpoint;
 137 typedef struct USBDescOther USBDescOther;
 138 typedef struct USBDescString USBDescString;
 139
 140 struct USBDescString {
 141     uint8_t index;
 142     char *str;
 143     QLIST_ENTRY(USBDescString) next;
 144 };
 145
 146 /* definition of a USB device */
 147 struct USBDevice {
 148     DeviceState qdev;
 149     USBDeviceInfo *info;
 150     void *opaque;
 151
 152     int speed;
 153     uint8_t addr;
 154     char product_desc[32];
 155     int auto_attach;
 156     int attached;
 157
 158     int state;
 159     uint8_t setup_buf[8];
 160     uint8_t data_buf[1024];
 161     int remote_wakeup;
 162     int setup_state;
 163     int setup_len;
 164     int setup_index;
 165
 166     QLIST_HEAD(, USBDescString) strings;
 167     const USBDescDevice *device;
 168     const USBDescConfig *config;
 169 };
 170
 171 struct USBDeviceInfo {
 172     DeviceInfo qdev;
 173     int (*init)(USBDevice *dev);
 174
 175     /*
 176      * Process USB packet.
 177      * Called by the HC (Host Controller).
 178      *
 179      * Returns length of the transaction
 180      * or one of the USB_RET_XXX codes.
 181      */
 182     int (*handle_packet)(USBDevice *dev, USBPacket *p);
 183
 184     /*
 185      * Called when device is destroyed.
 186      */
 187     void (*handle_destroy)(USBDevice *dev);
 188
 189     /*
 190      * Reset the device
 191      */
 192     void (*handle_reset)(USBDevice *dev);
 193
 194     /*
 195      * Process control request.
 196      * Called from handle_packet().
 197      *
 198      * Returns length or one of the USB_RET_ codes.
 199      */
 200     int (*handle_control)(USBDevice *dev, int request, int value,
 201                           int index, int length, uint8_t *data);
 202
 203     /*
 204      * Process data transfers (both BULK and ISOC).
 205      * Called from handle_packet().
 206      *
 207      * Returns length or one of the USB_RET_ codes.
 208      */
 209     int (*handle_data)(USBDevice *dev, USBPacket *p);
 210
 211     const char *product_desc;
 212     const USBDesc *usb_desc;
 213
 214     /* handle legacy -usbdevice command line options */
 215     const char *usbdevice_name;
 216     USBDevice *(*usbdevice_init)(const char *params);
 217 };
 218
 219 typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
 220
 221 /* USB port on which a device can be connected */
 222 struct USBPort {
 223     USBDevice *dev;
 224     usb_attachfn attach;
 225     void *opaque;
 226     USBDevice *pdev;
 227     int index; /* internal port index, may be used with the opaque */
 228     QTAILQ_ENTRY(USBPort) next;
 229 };
 230
 231 typedef void USBCallback(USBPacket * packet, void *opaque);
 232
 233 /* Structure used to hold information about an active USB packet.  */
 234 struct USBPacket {
 235     /* Data fields for use by the driver.  */
 236     int pid;
 237     uint8_t devaddr;
 238     uint8_t devep;
 239     uint8_t *data;
 240     int len;
 241     /* Internal use by the USB layer.  */
 242     USBCallback *complete_cb;
 243     void *complete_opaque;
 244     USBCallback *cancel_cb;
 245     void *cancel_opaque;
 246 };
 247
 248 /* Defer completion of a USB packet.  The hadle_packet routine should then
 249    return USB_RET_ASYNC.  Packets that complete immediately (before
 250    handle_packet returns) should not call this method.  */
 251 static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
 252                                     void * opaque)
 253 {
 254     p->cancel_cb = cancel;
 255     p->cancel_opaque = opaque;
 256 }
 257
 258 /* Notify the controller that an async packet is complete.  This should only
 259    be called for packets previously deferred with usb_defer_packet, and
 260    should never be called from within handle_packet.  */
 261 static inline void usb_packet_complete(USBPacket *p)
 262 {
 263     p->complete_cb(p, p->complete_opaque);
 264 }
 265
 266 /* Cancel an active packet.  The packed must have been deferred with
 267    usb_defer_packet,  and not yet completed.  */
 268 static inline void usb_cancel_packet(USBPacket * p)
 269 {
 270     p->cancel_cb(p, p->cancel_opaque);
 271 }
 272
 273 void usb_attach(USBPort *port, USBDevice *dev);
 274 int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
 275 int set_usb_string(uint8_t *buf, const char *str);
 276 void usb_send_msg(USBDevice *dev, int msg);
 277
 278 /* usb-linux.c */
 279 USBDevice *usb_host_device_open(const char *devname);
 280 int usb_host_device_close(const char *devname);
 281 void usb_host_info(Monitor *mon);
 282
 283 /* usb-hid.c */
 284 void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));
 285
 286 /* usb-bt.c */
 287 USBDevice *usb_bt_init(HCIInfo *hci);
 288
 289 /* usb ports of the VM */
 290
 291 #define VM_USB_HUB_SIZE 8
 292
 293 /* usb-musb.c */
 294 enum musb_irq_source_e {
 295     musb_irq_suspend = 0,
 296     musb_irq_resume,
 297     musb_irq_rst_babble,
 298     musb_irq_sof,
 299     musb_irq_connect,
 300     musb_irq_disconnect,
 301     musb_irq_vbus_request,
 302     musb_irq_vbus_error,
 303     musb_irq_rx,
 304     musb_irq_tx,
 305     musb_set_vbus,
 306     musb_set_session,
 307     __musb_irq_max,
 308 };
 309
 310 typedef struct MUSBState MUSBState;
 311 MUSBState *musb_init(qemu_irq *irqs);
 312 uint32_t musb_core_intr_get(MUSBState *s);
 313 void musb_core_intr_clear(MUSBState *s, uint32_t mask);
 314 void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
 315
 316 /* usb-bus.c */
 317
 318 struct USBBus {
 319     BusState qbus;
 320     int busnr;
 321     int nfree;
 322     int nused;
 323     QTAILQ_HEAD(, USBPort) free;
 324     QTAILQ_HEAD(, USBPort) used;
 325     QTAILQ_ENTRY(USBBus) next;
 326 };
 327
 328 void usb_bus_new(USBBus *bus, DeviceState *host);
 329 USBBus *usb_bus_find(int busnr);
 330 void usb_qdev_register(USBDeviceInfo *info);
 331 void usb_qdev_register_many(USBDeviceInfo *info);
 332 USBDevice *usb_create(USBBus *bus, const char *name);
 333 USBDevice *usb_create_simple(USBBus *bus, const char *name);
 334 USBDevice *usbdevice_create(const char *cmdline);
 335 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
 336                        USBDevice *pdev, usb_attachfn attach);
 337 void usb_unregister_port(USBBus *bus, USBPort *port);
 338 int usb_device_attach(USBDevice *dev);
 339 int usb_device_detach(USBDevice *dev);
 340 int usb_device_delete_addr(int busnr, int addr);
 341
 342 static inline USBBus *usb_bus_from_device(USBDevice *d)
 343 {
 344     return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
 345 }