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 #define USB_MSG_DESTROY  0x103
  33
  34 #define USB_RET_NODEV  (-1)
  35 #define USB_RET_NAK    (-2)
  36 #define USB_RET_STALL  (-3)
  37 #define USB_RET_BABBLE (-4)
  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 typedef struct USBPort USBPort;
 112 typedef struct USBDevice USBDevice;
 113
 114 /* definition of a USB device */
 115 struct USBDevice {
 116     void *opaque;
 117     int (*handle_packet)(USBDevice *dev, int pid,
 118                          uint8_t devaddr, uint8_t devep,
 119                          uint8_t *data, int len);
 120     int speed;
 121
 122     /* The following fields are used by the generic USB device
 123        layer. They are here just to avoid creating a new structure for
 124        them. */
 125     void (*handle_reset)(USBDevice *dev, int destroy);
 126     int (*handle_control)(USBDevice *dev, int request, int value,
 127                           int index, int length, uint8_t *data);
 128     int (*handle_data)(USBDevice *dev, int pid, uint8_t devep,
 129                        uint8_t *data, int len);
 130     uint8_t addr;
 131
 132     int state;
 133     uint8_t setup_buf[8];
 134     uint8_t data_buf[1024];
 135     int remote_wakeup;
 136     int setup_state;
 137     int setup_len;
 138     int setup_index;
 139 };
 140
 141 typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
 142
 143 /* USB port on which a device can be connected */
 144 struct USBPort {
 145     USBDevice *dev;
 146     usb_attachfn attach;
 147     void *opaque;
 148     int index; /* internal port index, may be used with the opaque */
 149     struct USBPort *next; /* Used internally by qemu.  */
 150 };
 151
 152 void usb_attach(USBPort *port, USBDevice *dev);
 153 int usb_generic_handle_packet(USBDevice *s, int pid,
 154                               uint8_t devaddr, uint8_t devep,
 155                               uint8_t *data, int len);
 156 int set_usb_string(uint8_t *buf, const char *str);
 157
 158 /* usb hub */
 159 USBDevice *usb_hub_init(int nb_ports);
 160
 161 /* usb-uhci.c */
 162 void usb_uhci_init(PCIBus *bus, int devfn);
 163
 164 /* usb-ohci.c */
 165 void usb_ohci_init(struct PCIBus *bus, int num_ports, int devfn);
 166
 167 /* usb-linux.c */
 168 USBDevice *usb_host_device_open(const char *devname);
 169 void usb_host_info(void);
 170
 171 /* usb-hid.c */
 172 USBDevice *usb_mouse_init(void);
 173 USBDevice *usb_tablet_init(void);
 174
 175 /* usb-msd.c */
 176 USBDevice *usb_msd_init(const char *filename);