root / hw / usb.h @ e8ee3c72
History | View | Annotate | Download (8.4 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 | 942ac052 | balrog | #define USB_ENDPOINT_XFER_CONTROL 0 |
112 | 942ac052 | balrog | #define USB_ENDPOINT_XFER_ISOC 1 |
113 | 942ac052 | balrog | #define USB_ENDPOINT_XFER_BULK 2 |
114 | 942ac052 | balrog | #define USB_ENDPOINT_XFER_INT 3 |
115 | 942ac052 | balrog | |
116 | bb36d470 | bellard | typedef struct USBPort USBPort; |
117 | bb36d470 | bellard | typedef struct USBDevice USBDevice; |
118 | 4d611c9a | pbrook | typedef struct USBPacket USBPacket; |
119 | bb36d470 | bellard | |
120 | bb36d470 | bellard | /* definition of a USB device */
|
121 | bb36d470 | bellard | struct USBDevice {
|
122 | bb36d470 | bellard | void *opaque;
|
123 | 89b9b79f | aliguori | |
124 | 89b9b79f | aliguori | /*
|
125 | 89b9b79f | aliguori | * Process USB packet.
|
126 | 89b9b79f | aliguori | * Called by the HC (Host Controller).
|
127 | 89b9b79f | aliguori | *
|
128 | 89b9b79f | aliguori | * Returns length of the transaction
|
129 | 89b9b79f | aliguori | * or one of the USB_RET_XXX codes.
|
130 | 89b9b79f | aliguori | */
|
131 | 4d611c9a | pbrook | int (*handle_packet)(USBDevice *dev, USBPacket *p);
|
132 | 89b9b79f | aliguori | |
133 | 89b9b79f | aliguori | /*
|
134 | 89b9b79f | aliguori | * Called when device is destroyed.
|
135 | 89b9b79f | aliguori | */
|
136 | 059809e4 | bellard | void (*handle_destroy)(USBDevice *dev);
|
137 | 059809e4 | bellard | |
138 | bb36d470 | bellard | int speed;
|
139 | 3b46e624 | ths | |
140 | bb36d470 | bellard | /* The following fields are used by the generic USB device
|
141 | 89b9b79f | aliguori | layer. They are here just to avoid creating a new structure
|
142 | 89b9b79f | aliguori | for them. */
|
143 | 89b9b79f | aliguori | |
144 | 89b9b79f | aliguori | /*
|
145 | 89b9b79f | aliguori | * Reset the device
|
146 | 89b9b79f | aliguori | */
|
147 | 059809e4 | bellard | void (*handle_reset)(USBDevice *dev);
|
148 | 89b9b79f | aliguori | |
149 | 89b9b79f | aliguori | /*
|
150 | 89b9b79f | aliguori | * Process control request.
|
151 | 89b9b79f | aliguori | * Called from handle_packet().
|
152 | 89b9b79f | aliguori | *
|
153 | 89b9b79f | aliguori | * Returns length or one of the USB_RET_ codes.
|
154 | 89b9b79f | aliguori | */
|
155 | bb36d470 | bellard | int (*handle_control)(USBDevice *dev, int request, int value, |
156 | bb36d470 | bellard | int index, int length, uint8_t *data); |
157 | 89b9b79f | aliguori | |
158 | 89b9b79f | aliguori | /*
|
159 | 89b9b79f | aliguori | * Process data transfers (both BULK and ISOC).
|
160 | 89b9b79f | aliguori | * Called from handle_packet().
|
161 | 89b9b79f | aliguori | *
|
162 | 89b9b79f | aliguori | * Returns length or one of the USB_RET_ codes.
|
163 | 89b9b79f | aliguori | */
|
164 | 4d611c9a | pbrook | int (*handle_data)(USBDevice *dev, USBPacket *p);
|
165 | 89b9b79f | aliguori | |
166 | bb36d470 | bellard | uint8_t addr; |
167 | 1f6e24e7 | bellard | char devname[32]; |
168 | 3b46e624 | ths | |
169 | bb36d470 | bellard | int state;
|
170 | bb36d470 | bellard | uint8_t setup_buf[8];
|
171 | bb36d470 | bellard | uint8_t data_buf[1024];
|
172 | bb36d470 | bellard | int remote_wakeup;
|
173 | bb36d470 | bellard | int setup_state;
|
174 | bb36d470 | bellard | int setup_len;
|
175 | bb36d470 | bellard | int setup_index;
|
176 | bb36d470 | bellard | }; |
177 | bb36d470 | bellard | |
178 | 0d92ed30 | pbrook | typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev); |
179 | 0d92ed30 | pbrook | |
180 | bb36d470 | bellard | /* USB port on which a device can be connected */
|
181 | bb36d470 | bellard | struct USBPort {
|
182 | a594cfbf | bellard | USBDevice *dev; |
183 | 0d92ed30 | pbrook | usb_attachfn attach; |
184 | bb36d470 | bellard | void *opaque;
|
185 | bb36d470 | bellard | int index; /* internal port index, may be used with the opaque */ |
186 | 0d92ed30 | pbrook | struct USBPort *next; /* Used internally by qemu. */ |
187 | bb36d470 | bellard | }; |
188 | bb36d470 | bellard | |
189 | 4d611c9a | pbrook | typedef void USBCallback(USBPacket * packet, void *opaque); |
190 | 4d611c9a | pbrook | |
191 | 4d611c9a | pbrook | /* Structure used to hold information about an active USB packet. */
|
192 | 4d611c9a | pbrook | struct USBPacket {
|
193 | 4d611c9a | pbrook | /* Data fields for use by the driver. */
|
194 | 4d611c9a | pbrook | int pid;
|
195 | 4d611c9a | pbrook | uint8_t devaddr; |
196 | 4d611c9a | pbrook | uint8_t devep; |
197 | 4d611c9a | pbrook | uint8_t *data; |
198 | 4d611c9a | pbrook | int len;
|
199 | 4d611c9a | pbrook | /* Internal use by the USB layer. */
|
200 | 4d611c9a | pbrook | USBCallback *complete_cb; |
201 | 4d611c9a | pbrook | void *complete_opaque;
|
202 | 4d611c9a | pbrook | USBCallback *cancel_cb; |
203 | b63891a0 | ths | void *cancel_opaque;
|
204 | 4d611c9a | pbrook | }; |
205 | 4d611c9a | pbrook | |
206 | 4d611c9a | pbrook | /* Defer completion of a USB packet. The hadle_packet routine should then
|
207 | 4d611c9a | pbrook | return USB_RET_ASYNC. Packets that complete immediately (before
|
208 | 4d611c9a | pbrook | handle_packet returns) should not call this method. */
|
209 | 4d611c9a | pbrook | static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel, |
210 | 4d611c9a | pbrook | void * opaque)
|
211 | 4d611c9a | pbrook | { |
212 | 4d611c9a | pbrook | p->cancel_cb = cancel; |
213 | 4d611c9a | pbrook | p->cancel_opaque = opaque; |
214 | 4d611c9a | pbrook | } |
215 | 4d611c9a | pbrook | |
216 | 4d611c9a | pbrook | /* Notify the controller that an async packet is complete. This should only
|
217 | 4d611c9a | pbrook | be called for packets previously deferred with usb_defer_packet, and
|
218 | 4d611c9a | pbrook | should never be called from within handle_packet. */
|
219 | 4d611c9a | pbrook | static inline void usb_packet_complete(USBPacket *p) |
220 | 4d611c9a | pbrook | { |
221 | 4d611c9a | pbrook | p->complete_cb(p, p->complete_opaque); |
222 | 4d611c9a | pbrook | } |
223 | 4d611c9a | pbrook | |
224 | 4d611c9a | pbrook | /* Cancel an active packet. The packed must have been deferred with
|
225 | 4d611c9a | pbrook | usb_defer_packet, and not yet completed. */
|
226 | 4d611c9a | pbrook | static inline void usb_cancel_packet(USBPacket * p) |
227 | 4d611c9a | pbrook | { |
228 | 4d611c9a | pbrook | p->cancel_cb(p, p->cancel_opaque); |
229 | 4d611c9a | pbrook | } |
230 | 4d611c9a | pbrook | |
231 | 4b096fc9 | aliguori | int usb_device_add_dev(USBDevice *dev);
|
232 | 1f3870ab | aliguori | int usb_device_del_addr(int bus_num, int addr); |
233 | bb36d470 | bellard | void usb_attach(USBPort *port, USBDevice *dev);
|
234 | 4d611c9a | pbrook | int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
|
235 | bb36d470 | bellard | int set_usb_string(uint8_t *buf, const char *str); |
236 | 4d611c9a | pbrook | void usb_send_msg(USBDevice *dev, int msg); |
237 | 4d611c9a | pbrook | |
238 | 4d611c9a | pbrook | void usb_packet_complete(USBPacket *p);
|
239 | bb36d470 | bellard | |
240 | bb36d470 | bellard | /* usb hub */
|
241 | 0d92ed30 | pbrook | USBDevice *usb_hub_init(int nb_ports);
|
242 | bb36d470 | bellard | |
243 | bb36d470 | bellard | /* usb-linux.c */
|
244 | a594cfbf | bellard | USBDevice *usb_host_device_open(const char *devname); |
245 | a594cfbf | bellard | void usb_host_info(void); |
246 | 59ae540c | bellard | |
247 | 59ae540c | bellard | /* usb-hid.c */
|
248 | 59ae540c | bellard | USBDevice *usb_mouse_init(void);
|
249 | 09b26c5e | bellard | USBDevice *usb_tablet_init(void);
|
250 | 47b2d338 | balrog | USBDevice *usb_keyboard_init(void);
|
251 | 2e5d83bb | pbrook | |
252 | 2e5d83bb | pbrook | /* usb-msd.c */
|
253 | 2e5d83bb | pbrook | USBDevice *usb_msd_init(const char *filename); |
254 | f6d2a316 | balrog | |
255 | 6c9f886c | balrog | /* usb-net.c */
|
256 | 6c9f886c | balrog | USBDevice *usb_net_init(NICInfo *nd); |
257 | 6c9f886c | balrog | |
258 | f6d2a316 | balrog | /* usb-wacom.c */
|
259 | f6d2a316 | balrog | USBDevice *usb_wacom_init(void);
|
260 | 87ecb68b | pbrook | |
261 | a7954218 | balrog | /* usb-serial.c */
|
262 | a7954218 | balrog | USBDevice *usb_serial_init(const char *filename); |
263 | a7954218 | balrog | |
264 | 87ecb68b | pbrook | /* usb ports of the VM */
|
265 | 87ecb68b | pbrook | |
266 | 87ecb68b | pbrook | void qemu_register_usb_port(USBPort *port, void *opaque, int index, |
267 | 87ecb68b | pbrook | usb_attachfn attach); |
268 | 87ecb68b | pbrook | |
269 | 87ecb68b | pbrook | #define VM_USB_HUB_SIZE 8 |
270 | 87ecb68b | pbrook | |
271 | 942ac052 | balrog | /* usb-musb.c */
|
272 | 942ac052 | balrog | enum musb_irq_source_e {
|
273 | 942ac052 | balrog | musb_irq_suspend = 0,
|
274 | 942ac052 | balrog | musb_irq_resume, |
275 | 942ac052 | balrog | musb_irq_rst_babble, |
276 | 942ac052 | balrog | musb_irq_sof, |
277 | 942ac052 | balrog | musb_irq_connect, |
278 | 942ac052 | balrog | musb_irq_disconnect, |
279 | 942ac052 | balrog | musb_irq_vbus_request, |
280 | 942ac052 | balrog | musb_irq_vbus_error, |
281 | 942ac052 | balrog | musb_irq_rx, |
282 | 942ac052 | balrog | musb_irq_tx, |
283 | 942ac052 | balrog | musb_set_vbus, |
284 | 942ac052 | balrog | musb_set_session, |
285 | 942ac052 | balrog | __musb_irq_max, |
286 | 942ac052 | balrog | }; |
287 | 942ac052 | balrog | |
288 | 942ac052 | balrog | struct musb_s;
|
289 | 942ac052 | balrog | struct musb_s *musb_init(qemu_irq *irqs);
|
290 | 942ac052 | balrog | uint32_t musb_core_intr_get(struct musb_s *s);
|
291 | 942ac052 | balrog | void musb_core_intr_clear(struct musb_s *s, uint32_t mask); |
292 | 942ac052 | balrog | void musb_set_size(struct musb_s *s, int epnum, int size, int is_tx); |