LXR qemu/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#define USB_TOKEN_SETUP 0x2d
  25#define USB_TOKEN_IN    0x69 /* device -> host */
  26#define USB_TOKEN_OUT   0xe1 /* host -> device */
  27
  28/* specific usb messages, also sent in the 'pid' parameter */
  29#define USB_MSG_ATTACH   0x100
  30#define USB_MSG_DETACH   0x101
  31#define USB_MSG_RESET    0x102
  32
  33#define USB_RET_NODEV  (-1)
  34#define USB_RET_NAK    (-2)
  35#define USB_RET_STALL  (-3)
  36#define USB_RET_BABBLE (-4)
  37#define USB_RET_ASYNC  (-5)
  38
  39#define USB_SPEED_LOW   0
  40#define USB_SPEED_FULL  1
  41#define USB_SPEED_HIGH  2
  42
  43#define USB_STATE_NOTATTACHED 0
  44#define USB_STATE_ATTACHED    1
  45//#define USB_STATE_POWERED     2
  46#define USB_STATE_DEFAULT     3
  47//#define USB_STATE_ADDRESS     4
  48//#define       USB_STATE_CONFIGURED  5
  49#define USB_STATE_SUSPENDED   6
  50
  51#define USB_CLASS_AUDIO                 1
  52#define USB_CLASS_COMM                  2
  53#define USB_CLASS_HID                   3
  54#define USB_CLASS_PHYSICAL              5
  55#define USB_CLASS_STILL_IMAGE           6
  56#define USB_CLASS_PRINTER               7
  57#define USB_CLASS_MASS_STORAGE          8
  58#define USB_CLASS_HUB                   9
  59#define USB_CLASS_CDC_DATA              0x0a
  60#define USB_CLASS_CSCID                 0x0b
  61#define USB_CLASS_CONTENT_SEC           0x0d
  62#define USB_CLASS_APP_SPEC              0xfe
  63#define USB_CLASS_VENDOR_SPEC           0xff
  64
  65#define USB_DIR_OUT                     0
  66#define USB_DIR_IN                      0x80
  67
  68#define USB_TYPE_MASK                   (0x03 << 5)
  69#define USB_TYPE_STANDARD               (0x00 << 5)
  70#define USB_TYPE_CLASS                  (0x01 << 5)
  71#define USB_TYPE_VENDOR                 (0x02 << 5)
  72#define USB_TYPE_RESERVED               (0x03 << 5)
  73
  74#define USB_RECIP_MASK                  0x1f
  75#define USB_RECIP_DEVICE                0x00
  76#define USB_RECIP_INTERFACE             0x01
  77#define USB_RECIP_ENDPOINT              0x02
  78#define USB_RECIP_OTHER                 0x03
  79
  80#define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  81#define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  82#define InterfaceRequest \
  83        ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  84#define InterfaceOutRequest \
  85        ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  86#define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
  87#define EndpointOutRequest \
  88        ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
  89
  90#define USB_REQ_GET_STATUS              0x00
  91#define USB_REQ_CLEAR_FEATURE           0x01
  92#define USB_REQ_SET_FEATURE             0x03
  93#define USB_REQ_SET_ADDRESS             0x05
  94#define USB_REQ_GET_DESCRIPTOR          0x06
  95#define USB_REQ_SET_DESCRIPTOR          0x07
  96#define USB_REQ_GET_CONFIGURATION       0x08
  97#define USB_REQ_SET_CONFIGURATION       0x09
  98#define USB_REQ_GET_INTERFACE           0x0A
  99#define USB_REQ_SET_INTERFACE           0x0B
 100#define USB_REQ_SYNCH_FRAME             0x0C
 101
 102#define USB_DEVICE_SELF_POWERED         0
 103#define USB_DEVICE_REMOTE_WAKEUP        1
 104
 105#define USB_DT_DEVICE                   0x01
 106#define USB_DT_CONFIG                   0x02
 107#define USB_DT_STRING                   0x03
 108#define USB_DT_INTERFACE                0x04
 109#define USB_DT_ENDPOINT                 0x05
 110
 111#define USB_ENDPOINT_XFER_CONTROL       0
 112#define USB_ENDPOINT_XFER_ISOC          1
 113#define USB_ENDPOINT_XFER_BULK          2
 114#define USB_ENDPOINT_XFER_INT           3
 115
 116typedef struct USBPort USBPort;
 117typedef struct USBDevice USBDevice;
 118typedef struct USBPacket USBPacket;
 119
 120/* definition of a USB device */
 121struct USBDevice {
 122    void *opaque;
 123
 124    /* 
 125     * Process USB packet. 
 126     * Called by the HC (Host Controller).
 127     *
 128     * Returns length of the transaction 
 129     * or one of the USB_RET_XXX codes.
 130     */ 
 131    int (*handle_packet)(USBDevice *dev, USBPacket *p);
 132
 133    /* 
 134     * Called when device is destroyed.
 135     */
 136    void (*handle_destroy)(USBDevice *dev);
 137
 138    int speed;
 139
 140    /* The following fields are used by the generic USB device
 141       layer. They are here just to avoid creating a new structure 
 142       for them. */
 143
 144    /*
 145     * Reset the device
 146     */  
 147    void (*handle_reset)(USBDevice *dev);
 148
 149    /*
 150     * Process control request.
 151     * Called from handle_packet().
 152     *
 153     * Returns length or one of the USB_RET_ codes.
 154     */
 155    int (*handle_control)(USBDevice *dev, int request, int value,
 156                          int index, int length, uint8_t *data);
 157
 158    /*
 159     * Process data transfers (both BULK and ISOC).
 160     * Called from handle_packet().
 161     *
 162     * Returns length or one of the USB_RET_ codes.
 163     */
 164    int (*handle_data)(USBDevice *dev, USBPacket *p);
 165
 166    uint8_t addr;
 167    char devname[32];
 168
 169    int state;
 170    uint8_t setup_buf[8];
 171    uint8_t data_buf[1024];
 172    int remote_wakeup;
 173    int setup_state;
 174    int setup_len;
 175    int setup_index;
 176};
 177
 178typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
 179
 180/* USB port on which a device can be connected */
 181struct USBPort {
 182    USBDevice *dev;
 183    usb_attachfn attach;
 184    void *opaque;
 185    int index; /* internal port index, may be used with the opaque */
 186    struct USBPort *next; /* Used internally by qemu.  */
 187};
 188
 189typedef void USBCallback(USBPacket * packet, void *opaque);
 190
 191/* Structure used to hold information about an active USB packet.  */
 192struct USBPacket {
 193    /* Data fields for use by the driver.  */
 194    int pid;
 195    uint8_t devaddr;
 196    uint8_t devep;
 197    uint8_t *data;
 198    int len;
 199    /* Internal use by the USB layer.  */
 200    USBCallback *complete_cb;
 201    void *complete_opaque;
 202    USBCallback *cancel_cb;
 203    void *cancel_opaque;
 204};
 205
 206/* Defer completion of a USB packet.  The hadle_packet routine should then
 207   return USB_RET_ASYNC.  Packets that complete immediately (before
 208   handle_packet returns) should not call this method.  */
 209static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
 210                                    void * opaque)
 211{
 212    p->cancel_cb = cancel;
 213    p->cancel_opaque = opaque;
 214}
 215
 216/* Notify the controller that an async packet is complete.  This should only
 217   be called for packets previously deferred with usb_defer_packet, and
 218   should never be called from within handle_packet.  */
 219static inline void usb_packet_complete(USBPacket *p)
 220{
 221    p->complete_cb(p, p->complete_opaque);
 222}
 223
 224/* Cancel an active packet.  The packed must have been deferred with
 225   usb_defer_packet,  and not yet completed.  */
 226static inline void usb_cancel_packet(USBPacket * p)
 227{
 228    p->cancel_cb(p, p->cancel_opaque);
 229}
 230
 231int usb_device_add_dev(USBDevice *dev);
 232int usb_device_del_addr(int bus_num, int addr);
 233void usb_attach(USBPort *port, USBDevice *dev);
 234int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
 235int set_usb_string(uint8_t *buf, const char *str);
 236void usb_send_msg(USBDevice *dev, int msg);
 237
 238/* usb hub */
 239USBDevice *usb_hub_init(int nb_ports);
 240
 241/* usb-linux.c */
 242USBDevice *usb_host_device_open(const char *devname);
 243int usb_host_device_close(const char *devname);
 244void usb_host_info(void);
 245
 246/* usb-hid.c */
 247USBDevice *usb_mouse_init(void);
 248USBDevice *usb_tablet_init(void);
 249USBDevice *usb_keyboard_init(void);
 250void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *));
 251
 252/* usb-msd.c */
 253USBDevice *usb_msd_init(const char *filename);
 254
 255/* usb-net.c */
 256USBDevice *usb_net_init(NICInfo *nd);
 257
 258/* usb-bt.c */
 259USBDevice *usb_bt_init(HCIInfo *hci);
 260
 261/* usb-wacom.c */
 262USBDevice *usb_wacom_init(void);
 263
 264/* usb-serial.c */
 265USBDevice *usb_serial_init(const char *filename);
 266
 267/* usb ports of the VM */
 268
 269void qemu_register_usb_port(USBPort *port, void *opaque, int index,
 270                            usb_attachfn attach);
 271
 272#define VM_USB_HUB_SIZE 8
 273
 274/* usb-musb.c */
 275enum musb_irq_source_e {
 276    musb_irq_suspend = 0,
 277    musb_irq_resume,
 278    musb_irq_rst_babble,
 279    musb_irq_sof,
 280    musb_irq_connect,
 281    musb_irq_disconnect,
 282    musb_irq_vbus_request,
 283    musb_irq_vbus_error,
 284    musb_irq_rx,
 285    musb_irq_tx,
 286    musb_set_vbus,
 287    musb_set_session,
 288    __musb_irq_max,
 289};
 290
 291struct musb_s;
 292struct musb_s *musb_init(qemu_irq *irqs);
 293uint32_t musb_core_intr_get(struct musb_s *s);
 294void musb_core_intr_clear(struct musb_s *s, uint32_t mask);
 295void musb_set_size(struct musb_s *s, int epnum, int size, int is_tx);
 296