blob: ed8890e39ad13c250991bc6d4c59f5415b09da58 [file] [log] [blame]
bellardbb36d472005-11-05 14:22:28 +00001/*
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)
pbrook4d611c92006-08-12 01:04:27 +000037#define USB_RET_ASYNC (-5)
bellardbb36d472005-11-05 14:22:28 +000038
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
bellarda594cfb2005-11-06 16:13:29 +000051#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
bellardbb36d472005-11-05 14:22:28 +000065#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)
bellard59ae5402005-11-05 16:57:08 +000082#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)
bellardbb36d472005-11-05 14:22:28 +000089
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
111typedef struct USBPort USBPort;
112typedef struct USBDevice USBDevice;
pbrook4d611c92006-08-12 01:04:27 +0000113typedef struct USBPacket USBPacket;
bellardbb36d472005-11-05 14:22:28 +0000114
115/* definition of a USB device */
116struct USBDevice {
117 void *opaque;
pbrook4d611c92006-08-12 01:04:27 +0000118 int (*handle_packet)(USBDevice *dev, USBPacket *p);
bellard059809e2006-07-19 18:06:15 +0000119 void (*handle_destroy)(USBDevice *dev);
120
bellardbb36d472005-11-05 14:22:28 +0000121 int speed;
122
123 /* The following fields are used by the generic USB device
124 layer. They are here just to avoid creating a new structure for
125 them. */
bellard059809e2006-07-19 18:06:15 +0000126 void (*handle_reset)(USBDevice *dev);
bellardbb36d472005-11-05 14:22:28 +0000127 int (*handle_control)(USBDevice *dev, int request, int value,
128 int index, int length, uint8_t *data);
pbrook4d611c92006-08-12 01:04:27 +0000129 int (*handle_data)(USBDevice *dev, USBPacket *p);
bellardbb36d472005-11-05 14:22:28 +0000130 uint8_t addr;
bellard1f6e24e2006-06-26 21:00:51 +0000131 char devname[32];
bellardbb36d472005-11-05 14:22:28 +0000132
133 int state;
134 uint8_t setup_buf[8];
135 uint8_t data_buf[1024];
136 int remote_wakeup;
137 int setup_state;
138 int setup_len;
139 int setup_index;
140};
141
pbrook0d92ed32006-05-21 16:30:15 +0000142typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
143
bellardbb36d472005-11-05 14:22:28 +0000144/* USB port on which a device can be connected */
145struct USBPort {
bellarda594cfb2005-11-06 16:13:29 +0000146 USBDevice *dev;
pbrook0d92ed32006-05-21 16:30:15 +0000147 usb_attachfn attach;
bellardbb36d472005-11-05 14:22:28 +0000148 void *opaque;
149 int index; /* internal port index, may be used with the opaque */
pbrook0d92ed32006-05-21 16:30:15 +0000150 struct USBPort *next; /* Used internally by qemu. */
bellardbb36d472005-11-05 14:22:28 +0000151};
152
pbrook4d611c92006-08-12 01:04:27 +0000153typedef void USBCallback(USBPacket * packet, void *opaque);
154
155/* Structure used to hold information about an active USB packet. */
156struct USBPacket {
157 /* Data fields for use by the driver. */
158 int pid;
159 uint8_t devaddr;
160 uint8_t devep;
161 uint8_t *data;
162 int len;
163 /* Internal use by the USB layer. */
164 USBCallback *complete_cb;
165 void *complete_opaque;
166 USBCallback *cancel_cb;
167 void * *cancel_opaque;
168};
169
170/* Defer completion of a USB packet. The hadle_packet routine should then
171 return USB_RET_ASYNC. Packets that complete immediately (before
172 handle_packet returns) should not call this method. */
173static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
174 void * opaque)
175{
176 p->cancel_cb = cancel;
177 p->cancel_opaque = opaque;
178}
179
180/* Notify the controller that an async packet is complete. This should only
181 be called for packets previously deferred with usb_defer_packet, and
182 should never be called from within handle_packet. */
183static inline void usb_packet_complete(USBPacket *p)
184{
185 p->complete_cb(p, p->complete_opaque);
186}
187
188/* Cancel an active packet. The packed must have been deferred with
189 usb_defer_packet, and not yet completed. */
190static inline void usb_cancel_packet(USBPacket * p)
191{
192 p->cancel_cb(p, p->cancel_opaque);
193}
194
bellardbb36d472005-11-05 14:22:28 +0000195void usb_attach(USBPort *port, USBDevice *dev);
pbrook4d611c92006-08-12 01:04:27 +0000196int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
bellardbb36d472005-11-05 14:22:28 +0000197int set_usb_string(uint8_t *buf, const char *str);
pbrook4d611c92006-08-12 01:04:27 +0000198void usb_send_msg(USBDevice *dev, int msg);
199
200void usb_packet_complete(USBPacket *p);
bellardbb36d472005-11-05 14:22:28 +0000201
202/* usb hub */
pbrook0d92ed32006-05-21 16:30:15 +0000203USBDevice *usb_hub_init(int nb_ports);
bellardbb36d472005-11-05 14:22:28 +0000204
205/* usb-uhci.c */
pbrook0d92ed32006-05-21 16:30:15 +0000206void usb_uhci_init(PCIBus *bus, int devfn);
207
208/* usb-ohci.c */
209void usb_ohci_init(struct PCIBus *bus, int num_ports, int devfn);
bellardbb36d472005-11-05 14:22:28 +0000210
211/* usb-linux.c */
bellarda594cfb2005-11-06 16:13:29 +0000212USBDevice *usb_host_device_open(const char *devname);
213void usb_host_info(void);
bellard59ae5402005-11-05 16:57:08 +0000214
215/* usb-hid.c */
216USBDevice *usb_mouse_init(void);
bellard09b26c52006-04-12 21:09:08 +0000217USBDevice *usb_tablet_init(void);
pbrook2e5d83b2006-05-25 23:58:51 +0000218
219/* usb-msd.c */
220USBDevice *usb_msd_init(const char *filename);