root / hw / usb.h @ 5228c2d3
History | View | Annotate | Download (7.1 kB)
1 | bb36d470 | bellard | /*
|
---|---|---|---|
2 | bb36d470 | bellard | * QEMU USB API
|
3 | 5fafdf24 | ths | *
|
4 | bb36d470 | bellard | * Copyright (c) 2005 Fabrice Bellard
|
5 | 5fafdf24 | ths | *
|
6 | bb36d470 | bellard | * Permission is hereby granted, free of charge, to any person obtaining a copy
|
7 | bb36d470 | bellard | * of this software and associated documentation files (the "Software"), to deal
|
8 | bb36d470 | bellard | * in the Software without restriction, including without limitation the rights
|
9 | bb36d470 | bellard | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
10 | bb36d470 | bellard | * copies of the Software, and to permit persons to whom the Software is
|
11 | bb36d470 | bellard | * furnished to do so, subject to the following conditions:
|
12 | bb36d470 | bellard | *
|
13 | bb36d470 | bellard | * The above copyright notice and this permission notice shall be included in
|
14 | bb36d470 | bellard | * all copies or substantial portions of the Software.
|
15 | bb36d470 | bellard | *
|
16 | bb36d470 | bellard | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
17 | bb36d470 | bellard | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
18 | bb36d470 | bellard | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
19 | bb36d470 | bellard | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
20 | bb36d470 | bellard | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
21 | bb36d470 | bellard | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
22 | bb36d470 | bellard | * THE SOFTWARE.
|
23 | bb36d470 | bellard | */
|
24 | bb36d470 | bellard | #define USB_TOKEN_SETUP 0x2d |
25 | bb36d470 | bellard | #define USB_TOKEN_IN 0x69 /* device -> host */ |
26 | bb36d470 | bellard | #define USB_TOKEN_OUT 0xe1 /* host -> device */ |
27 | bb36d470 | bellard | |
28 | bb36d470 | bellard | /* specific usb messages, also sent in the 'pid' parameter */
|
29 | bb36d470 | bellard | #define USB_MSG_ATTACH 0x100 |
30 | bb36d470 | bellard | #define USB_MSG_DETACH 0x101 |
31 | bb36d470 | bellard | #define USB_MSG_RESET 0x102 |
32 | bb36d470 | bellard | |
33 | 5fafdf24 | ths | #define USB_RET_NODEV (-1) |
34 | bb36d470 | bellard | #define USB_RET_NAK (-2) |
35 | bb36d470 | bellard | #define USB_RET_STALL (-3) |
36 | bb36d470 | bellard | #define USB_RET_BABBLE (-4) |
37 | 4d611c9a | pbrook | #define USB_RET_ASYNC (-5) |
38 | bb36d470 | bellard | |
39 | bb36d470 | bellard | #define USB_SPEED_LOW 0 |
40 | bb36d470 | bellard | #define USB_SPEED_FULL 1 |
41 | bb36d470 | bellard | #define USB_SPEED_HIGH 2 |
42 | bb36d470 | bellard | |
43 | bb36d470 | bellard | #define USB_STATE_NOTATTACHED 0 |
44 | bb36d470 | bellard | #define USB_STATE_ATTACHED 1 |
45 | bb36d470 | bellard | //#define USB_STATE_POWERED 2
|
46 | bb36d470 | bellard | #define USB_STATE_DEFAULT 3 |
47 | bb36d470 | bellard | //#define USB_STATE_ADDRESS 4
|
48 | bb36d470 | bellard | //#define USB_STATE_CONFIGURED 5
|
49 | bb36d470 | bellard | #define USB_STATE_SUSPENDED 6 |
50 | bb36d470 | bellard | |
51 | a594cfbf | bellard | #define USB_CLASS_AUDIO 1 |
52 | a594cfbf | bellard | #define USB_CLASS_COMM 2 |
53 | a594cfbf | bellard | #define USB_CLASS_HID 3 |
54 | a594cfbf | bellard | #define USB_CLASS_PHYSICAL 5 |
55 | a594cfbf | bellard | #define USB_CLASS_STILL_IMAGE 6 |
56 | a594cfbf | bellard | #define USB_CLASS_PRINTER 7 |
57 | a594cfbf | bellard | #define USB_CLASS_MASS_STORAGE 8 |
58 | a594cfbf | bellard | #define USB_CLASS_HUB 9 |
59 | a594cfbf | bellard | #define USB_CLASS_CDC_DATA 0x0a |
60 | a594cfbf | bellard | #define USB_CLASS_CSCID 0x0b |
61 | a594cfbf | bellard | #define USB_CLASS_CONTENT_SEC 0x0d |
62 | a594cfbf | bellard | #define USB_CLASS_APP_SPEC 0xfe |
63 | a594cfbf | bellard | #define USB_CLASS_VENDOR_SPEC 0xff |
64 | a594cfbf | bellard | |
65 | bb36d470 | bellard | #define USB_DIR_OUT 0 |
66 | bb36d470 | bellard | #define USB_DIR_IN 0x80 |
67 | bb36d470 | bellard | |
68 | bb36d470 | bellard | #define USB_TYPE_MASK (0x03 << 5) |
69 | bb36d470 | bellard | #define USB_TYPE_STANDARD (0x00 << 5) |
70 | bb36d470 | bellard | #define USB_TYPE_CLASS (0x01 << 5) |
71 | bb36d470 | bellard | #define USB_TYPE_VENDOR (0x02 << 5) |
72 | bb36d470 | bellard | #define USB_TYPE_RESERVED (0x03 << 5) |
73 | bb36d470 | bellard | |
74 | bb36d470 | bellard | #define USB_RECIP_MASK 0x1f |
75 | bb36d470 | bellard | #define USB_RECIP_DEVICE 0x00 |
76 | bb36d470 | bellard | #define USB_RECIP_INTERFACE 0x01 |
77 | bb36d470 | bellard | #define USB_RECIP_ENDPOINT 0x02 |
78 | bb36d470 | bellard | #define USB_RECIP_OTHER 0x03 |
79 | bb36d470 | bellard | |
80 | bb36d470 | bellard | #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) |
81 | bb36d470 | bellard | #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) |
82 | 59ae540c | bellard | #define InterfaceRequest \
|
83 | 59ae540c | bellard | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
|
84 | 59ae540c | bellard | #define InterfaceOutRequest \
|
85 | 59ae540c | bellard | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
|
86 | 59ae540c | bellard | #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) |
87 | 59ae540c | bellard | #define EndpointOutRequest \
|
88 | 59ae540c | bellard | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
|
89 | bb36d470 | bellard | |
90 | bb36d470 | bellard | #define USB_REQ_GET_STATUS 0x00 |
91 | bb36d470 | bellard | #define USB_REQ_CLEAR_FEATURE 0x01 |
92 | bb36d470 | bellard | #define USB_REQ_SET_FEATURE 0x03 |
93 | bb36d470 | bellard | #define USB_REQ_SET_ADDRESS 0x05 |
94 | bb36d470 | bellard | #define USB_REQ_GET_DESCRIPTOR 0x06 |
95 | bb36d470 | bellard | #define USB_REQ_SET_DESCRIPTOR 0x07 |
96 | bb36d470 | bellard | #define USB_REQ_GET_CONFIGURATION 0x08 |
97 | bb36d470 | bellard | #define USB_REQ_SET_CONFIGURATION 0x09 |
98 | bb36d470 | bellard | #define USB_REQ_GET_INTERFACE 0x0A |
99 | bb36d470 | bellard | #define USB_REQ_SET_INTERFACE 0x0B |
100 | bb36d470 | bellard | #define USB_REQ_SYNCH_FRAME 0x0C |
101 | bb36d470 | bellard | |
102 | bb36d470 | bellard | #define USB_DEVICE_SELF_POWERED 0 |
103 | bb36d470 | bellard | #define USB_DEVICE_REMOTE_WAKEUP 1 |
104 | bb36d470 | bellard | |
105 | bb36d470 | bellard | #define USB_DT_DEVICE 0x01 |
106 | bb36d470 | bellard | #define USB_DT_CONFIG 0x02 |
107 | bb36d470 | bellard | #define USB_DT_STRING 0x03 |
108 | bb36d470 | bellard | #define USB_DT_INTERFACE 0x04 |
109 | bb36d470 | bellard | #define USB_DT_ENDPOINT 0x05 |
110 | bb36d470 | bellard | |
111 | bb36d470 | bellard | typedef struct USBPort USBPort; |
112 | bb36d470 | bellard | typedef struct USBDevice USBDevice; |
113 | 4d611c9a | pbrook | typedef struct USBPacket USBPacket; |
114 | bb36d470 | bellard | |
115 | bb36d470 | bellard | /* definition of a USB device */
|
116 | bb36d470 | bellard | struct USBDevice {
|
117 | bb36d470 | bellard | void *opaque;
|
118 | 4d611c9a | pbrook | int (*handle_packet)(USBDevice *dev, USBPacket *p);
|
119 | 059809e4 | bellard | void (*handle_destroy)(USBDevice *dev);
|
120 | 059809e4 | bellard | |
121 | bb36d470 | bellard | int speed;
|
122 | 3b46e624 | ths | |
123 | bb36d470 | bellard | /* The following fields are used by the generic USB device
|
124 | bb36d470 | bellard | layer. They are here just to avoid creating a new structure for
|
125 | bb36d470 | bellard | them. */
|
126 | 059809e4 | bellard | void (*handle_reset)(USBDevice *dev);
|
127 | bb36d470 | bellard | int (*handle_control)(USBDevice *dev, int request, int value, |
128 | bb36d470 | bellard | int index, int length, uint8_t *data); |
129 | 4d611c9a | pbrook | int (*handle_data)(USBDevice *dev, USBPacket *p);
|
130 | bb36d470 | bellard | uint8_t addr; |
131 | 1f6e24e7 | bellard | char devname[32]; |
132 | 3b46e624 | ths | |
133 | bb36d470 | bellard | int state;
|
134 | bb36d470 | bellard | uint8_t setup_buf[8];
|
135 | bb36d470 | bellard | uint8_t data_buf[1024];
|
136 | bb36d470 | bellard | int remote_wakeup;
|
137 | bb36d470 | bellard | int setup_state;
|
138 | bb36d470 | bellard | int setup_len;
|
139 | bb36d470 | bellard | int setup_index;
|
140 | bb36d470 | bellard | }; |
141 | bb36d470 | bellard | |
142 | 0d92ed30 | pbrook | typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev); |
143 | 0d92ed30 | pbrook | |
144 | bb36d470 | bellard | /* USB port on which a device can be connected */
|
145 | bb36d470 | bellard | struct USBPort {
|
146 | a594cfbf | bellard | USBDevice *dev; |
147 | 0d92ed30 | pbrook | usb_attachfn attach; |
148 | bb36d470 | bellard | void *opaque;
|
149 | bb36d470 | bellard | int index; /* internal port index, may be used with the opaque */ |
150 | 0d92ed30 | pbrook | struct USBPort *next; /* Used internally by qemu. */ |
151 | bb36d470 | bellard | }; |
152 | bb36d470 | bellard | |
153 | 4d611c9a | pbrook | typedef void USBCallback(USBPacket * packet, void *opaque); |
154 | 4d611c9a | pbrook | |
155 | 4d611c9a | pbrook | /* Structure used to hold information about an active USB packet. */
|
156 | 4d611c9a | pbrook | struct USBPacket {
|
157 | 4d611c9a | pbrook | /* Data fields for use by the driver. */
|
158 | 4d611c9a | pbrook | int pid;
|
159 | 4d611c9a | pbrook | uint8_t devaddr; |
160 | 4d611c9a | pbrook | uint8_t devep; |
161 | 4d611c9a | pbrook | uint8_t *data; |
162 | 4d611c9a | pbrook | int len;
|
163 | 4d611c9a | pbrook | /* Internal use by the USB layer. */
|
164 | 4d611c9a | pbrook | USBCallback *complete_cb; |
165 | 4d611c9a | pbrook | void *complete_opaque;
|
166 | 4d611c9a | pbrook | USBCallback *cancel_cb; |
167 | b63891a0 | ths | void *cancel_opaque;
|
168 | 4d611c9a | pbrook | }; |
169 | 4d611c9a | pbrook | |
170 | 4d611c9a | pbrook | /* Defer completion of a USB packet. The hadle_packet routine should then
|
171 | 4d611c9a | pbrook | return USB_RET_ASYNC. Packets that complete immediately (before
|
172 | 4d611c9a | pbrook | handle_packet returns) should not call this method. */
|
173 | 4d611c9a | pbrook | static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel, |
174 | 4d611c9a | pbrook | void * opaque)
|
175 | 4d611c9a | pbrook | { |
176 | 4d611c9a | pbrook | p->cancel_cb = cancel; |
177 | 4d611c9a | pbrook | p->cancel_opaque = opaque; |
178 | 4d611c9a | pbrook | } |
179 | 4d611c9a | pbrook | |
180 | 4d611c9a | pbrook | /* Notify the controller that an async packet is complete. This should only
|
181 | 4d611c9a | pbrook | be called for packets previously deferred with usb_defer_packet, and
|
182 | 4d611c9a | pbrook | should never be called from within handle_packet. */
|
183 | 4d611c9a | pbrook | static inline void usb_packet_complete(USBPacket *p) |
184 | 4d611c9a | pbrook | { |
185 | 4d611c9a | pbrook | p->complete_cb(p, p->complete_opaque); |
186 | 4d611c9a | pbrook | } |
187 | 4d611c9a | pbrook | |
188 | 4d611c9a | pbrook | /* Cancel an active packet. The packed must have been deferred with
|
189 | 4d611c9a | pbrook | usb_defer_packet, and not yet completed. */
|
190 | 4d611c9a | pbrook | static inline void usb_cancel_packet(USBPacket * p) |
191 | 4d611c9a | pbrook | { |
192 | 4d611c9a | pbrook | p->cancel_cb(p, p->cancel_opaque); |
193 | 4d611c9a | pbrook | } |
194 | 4d611c9a | pbrook | |
195 | bb36d470 | bellard | void usb_attach(USBPort *port, USBDevice *dev);
|
196 | 4d611c9a | pbrook | int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
|
197 | bb36d470 | bellard | int set_usb_string(uint8_t *buf, const char *str); |
198 | 4d611c9a | pbrook | void usb_send_msg(USBDevice *dev, int msg); |
199 | 4d611c9a | pbrook | |
200 | 4d611c9a | pbrook | void usb_packet_complete(USBPacket *p);
|
201 | bb36d470 | bellard | |
202 | bb36d470 | bellard | /* usb hub */
|
203 | 0d92ed30 | pbrook | USBDevice *usb_hub_init(int nb_ports);
|
204 | bb36d470 | bellard | |
205 | bb36d470 | bellard | /* usb-linux.c */
|
206 | a594cfbf | bellard | USBDevice *usb_host_device_open(const char *devname); |
207 | a594cfbf | bellard | void usb_host_info(void); |
208 | 59ae540c | bellard | |
209 | 59ae540c | bellard | /* usb-hid.c */
|
210 | 59ae540c | bellard | USBDevice *usb_mouse_init(void);
|
211 | 09b26c5e | bellard | USBDevice *usb_tablet_init(void);
|
212 | 47b2d338 | balrog | USBDevice *usb_keyboard_init(void);
|
213 | 2e5d83bb | pbrook | |
214 | 2e5d83bb | pbrook | /* usb-msd.c */
|
215 | 2e5d83bb | pbrook | USBDevice *usb_msd_init(const char *filename); |
216 | f6d2a316 | balrog | |
217 | f6d2a316 | balrog | /* usb-wacom.c */
|
218 | f6d2a316 | balrog | USBDevice *usb_wacom_init(void);
|
219 | 87ecb68b | pbrook | |
220 | a7954218 | balrog | /* usb-serial.c */
|
221 | a7954218 | balrog | USBDevice *usb_serial_init(const char *filename); |
222 | a7954218 | balrog | |
223 | 87ecb68b | pbrook | /* usb ports of the VM */
|
224 | 87ecb68b | pbrook | |
225 | 87ecb68b | pbrook | void qemu_register_usb_port(USBPort *port, void *opaque, int index, |
226 | 87ecb68b | pbrook | usb_attachfn attach); |
227 | 87ecb68b | pbrook | |
228 | 87ecb68b | pbrook | #define VM_USB_HUB_SIZE 8 |