vcs.maemo.org Git - qemu/blob - 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
  38 #define USB_SPEED_LOW   0
  39 #define USB_SPEED_FULL  1
  40 #define USB_SPEED_HIGH  2
  41
  42 #define USB_STATE_NOTATTACHED 0
  43 #define USB_STATE_ATTACHED    1
  44 //#define USB_STATE_POWERED     2
  45 #define USB_STATE_DEFAULT     3
  46 //#define USB_STATE_ADDRESS     4
  47 //#define       USB_STATE_CONFIGURED  5
  48 #define USB_STATE_SUSPENDED   6
  49
  50 #define USB_DIR_OUT                     0
  51 #define USB_DIR_IN                      0x80
  52
  53 #define USB_TYPE_MASK                   (0x03 << 5)
  54 #define USB_TYPE_STANDARD               (0x00 << 5)
  55 #define USB_TYPE_CLASS                  (0x01 << 5)
  56 #define USB_TYPE_VENDOR                 (0x02 << 5)
  57 #define USB_TYPE_RESERVED               (0x03 << 5)
  58
  59 #define USB_RECIP_MASK                  0x1f
  60 #define USB_RECIP_DEVICE                0x00
  61 #define USB_RECIP_INTERFACE             0x01
  62 #define USB_RECIP_ENDPOINT              0x02
  63 #define USB_RECIP_OTHER                 0x03
  64
  65 #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  66 #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
  67 #define InterfaceRequest \
  68         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  69 #define InterfaceOutRequest \
  70         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
  71 #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
  72 #define EndpointOutRequest \
  73         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
  74
  75 #define USB_REQ_GET_STATUS              0x00
  76 #define USB_REQ_CLEAR_FEATURE           0x01
  77 #define USB_REQ_SET_FEATURE             0x03
  78 #define USB_REQ_SET_ADDRESS             0x05
  79 #define USB_REQ_GET_DESCRIPTOR          0x06
  80 #define USB_REQ_SET_DESCRIPTOR          0x07
  81 #define USB_REQ_GET_CONFIGURATION       0x08
  82 #define USB_REQ_SET_CONFIGURATION       0x09
  83 #define USB_REQ_GET_INTERFACE           0x0A
  84 #define USB_REQ_SET_INTERFACE           0x0B
  85 #define USB_REQ_SYNCH_FRAME             0x0C
  86
  87 #define USB_DEVICE_SELF_POWERED         0
  88 #define USB_DEVICE_REMOTE_WAKEUP        1
  89
  90 #define USB_DT_DEVICE                   0x01
  91 #define USB_DT_CONFIG                   0x02
  92 #define USB_DT_STRING                   0x03
  93 #define USB_DT_INTERFACE                0x04
  94 #define USB_DT_ENDPOINT                 0x05
  95
  96 typedef struct USBPort USBPort;
  97 typedef struct USBDevice USBDevice;
  98
  99 /* definition of a USB device */
 100 struct USBDevice {
 101     void *opaque;
 102     int (*handle_packet)(USBDevice *dev, int pid,
 103                          uint8_t devaddr, uint8_t devep,
 104                          uint8_t *data, int len);
 105     int speed;
 106
 107     /* The following fields are used by the generic USB device
 108        layer. They are here just to avoid creating a new structure for
 109        them. */
 110     void (*handle_reset)(USBDevice *dev);
 111     int (*handle_control)(USBDevice *dev, int request, int value,
 112                           int index, int length, uint8_t *data);
 113     int (*handle_data)(USBDevice *dev, int pid, uint8_t devep,
 114                        uint8_t *data, int len);
 115     uint8_t addr;
 116
 117     int state;
 118     uint8_t setup_buf[8];
 119     uint8_t data_buf[1024];
 120     int remote_wakeup;
 121     int setup_state;
 122     int setup_len;
 123     int setup_index;
 124 };
 125
 126 /* USB port on which a device can be connected */
 127 struct USBPort {
 128     void (*attach)(USBPort *port, USBDevice *dev);
 129     void *opaque;
 130     int index; /* internal port index, may be used with the opaque */
 131 };
 132
 133 void usb_attach(USBPort *port, USBDevice *dev);
 134 int usb_generic_handle_packet(USBDevice *s, int pid,
 135                               uint8_t devaddr, uint8_t devep,
 136                               uint8_t *data, int len);
 137 int set_usb_string(uint8_t *buf, const char *str);
 138
 139 /* usb hub */
 140 USBDevice *usb_hub_init(USBPort **usb_ports, int nb_ports);
 141
 142 /* usb-uhci.c */
 143 void usb_uhci_init(PCIBus *bus, USBPort **usb_ports);
 144
 145 /* usb-linux.c */
 146 USBDevice *usb_host_hub_init(void);
 147
 148 /* usb-hid.c */
 149 USBDevice *usb_mouse_init(void);