]>
Commit | Line | Data |
---|---|---|
bb36d470 FB |
1 | /* |
2 | * QEMU USB API | |
5fafdf24 | 3 | * |
bb36d470 | 4 | * Copyright (c) 2005 Fabrice Bellard |
5fafdf24 | 5 | * |
bb36d470 FB |
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 | */ | |
c0f4ce77 AL |
24 | |
25 | #include "block.h" | |
806b6024 | 26 | #include "qdev.h" |
72cf2d4f | 27 | #include "qemu-queue.h" |
c0f4ce77 | 28 | |
bb36d470 FB |
29 | #define USB_TOKEN_SETUP 0x2d |
30 | #define USB_TOKEN_IN 0x69 /* device -> host */ | |
31 | #define USB_TOKEN_OUT 0xe1 /* host -> device */ | |
32 | ||
33 | /* specific usb messages, also sent in the 'pid' parameter */ | |
34 | #define USB_MSG_ATTACH 0x100 | |
35 | #define USB_MSG_DETACH 0x101 | |
36 | #define USB_MSG_RESET 0x102 | |
37 | ||
5fafdf24 | 38 | #define USB_RET_NODEV (-1) |
bb36d470 FB |
39 | #define USB_RET_NAK (-2) |
40 | #define USB_RET_STALL (-3) | |
41 | #define USB_RET_BABBLE (-4) | |
4d611c9a | 42 | #define USB_RET_ASYNC (-5) |
bb36d470 FB |
43 | |
44 | #define USB_SPEED_LOW 0 | |
45 | #define USB_SPEED_FULL 1 | |
46 | #define USB_SPEED_HIGH 2 | |
47 | ||
48 | #define USB_STATE_NOTATTACHED 0 | |
49 | #define USB_STATE_ATTACHED 1 | |
50 | //#define USB_STATE_POWERED 2 | |
51 | #define USB_STATE_DEFAULT 3 | |
52 | //#define USB_STATE_ADDRESS 4 | |
53 | //#define USB_STATE_CONFIGURED 5 | |
54 | #define USB_STATE_SUSPENDED 6 | |
55 | ||
a594cfbf FB |
56 | #define USB_CLASS_AUDIO 1 |
57 | #define USB_CLASS_COMM 2 | |
58 | #define USB_CLASS_HID 3 | |
59 | #define USB_CLASS_PHYSICAL 5 | |
60 | #define USB_CLASS_STILL_IMAGE 6 | |
61 | #define USB_CLASS_PRINTER 7 | |
62 | #define USB_CLASS_MASS_STORAGE 8 | |
63 | #define USB_CLASS_HUB 9 | |
64 | #define USB_CLASS_CDC_DATA 0x0a | |
65 | #define USB_CLASS_CSCID 0x0b | |
66 | #define USB_CLASS_CONTENT_SEC 0x0d | |
67 | #define USB_CLASS_APP_SPEC 0xfe | |
68 | #define USB_CLASS_VENDOR_SPEC 0xff | |
69 | ||
bb36d470 FB |
70 | #define USB_DIR_OUT 0 |
71 | #define USB_DIR_IN 0x80 | |
72 | ||
73 | #define USB_TYPE_MASK (0x03 << 5) | |
74 | #define USB_TYPE_STANDARD (0x00 << 5) | |
75 | #define USB_TYPE_CLASS (0x01 << 5) | |
76 | #define USB_TYPE_VENDOR (0x02 << 5) | |
77 | #define USB_TYPE_RESERVED (0x03 << 5) | |
78 | ||
79 | #define USB_RECIP_MASK 0x1f | |
80 | #define USB_RECIP_DEVICE 0x00 | |
81 | #define USB_RECIP_INTERFACE 0x01 | |
82 | #define USB_RECIP_ENDPOINT 0x02 | |
83 | #define USB_RECIP_OTHER 0x03 | |
84 | ||
85 | #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | |
86 | #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | |
59ae540c FB |
87 | #define InterfaceRequest \ |
88 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | |
89 | #define InterfaceOutRequest \ | |
90 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | |
91 | #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) | |
92 | #define EndpointOutRequest \ | |
93 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) | |
f3571b1a MR |
94 | #define ClassInterfaceRequest \ |
95 | ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8) | |
96 | #define ClassInterfaceOutRequest \ | |
97 | ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8) | |
bb36d470 FB |
98 | |
99 | #define USB_REQ_GET_STATUS 0x00 | |
100 | #define USB_REQ_CLEAR_FEATURE 0x01 | |
101 | #define USB_REQ_SET_FEATURE 0x03 | |
102 | #define USB_REQ_SET_ADDRESS 0x05 | |
103 | #define USB_REQ_GET_DESCRIPTOR 0x06 | |
104 | #define USB_REQ_SET_DESCRIPTOR 0x07 | |
105 | #define USB_REQ_GET_CONFIGURATION 0x08 | |
106 | #define USB_REQ_SET_CONFIGURATION 0x09 | |
107 | #define USB_REQ_GET_INTERFACE 0x0A | |
108 | #define USB_REQ_SET_INTERFACE 0x0B | |
109 | #define USB_REQ_SYNCH_FRAME 0x0C | |
110 | ||
111 | #define USB_DEVICE_SELF_POWERED 0 | |
112 | #define USB_DEVICE_REMOTE_WAKEUP 1 | |
113 | ||
114 | #define USB_DT_DEVICE 0x01 | |
115 | #define USB_DT_CONFIG 0x02 | |
116 | #define USB_DT_STRING 0x03 | |
117 | #define USB_DT_INTERFACE 0x04 | |
118 | #define USB_DT_ENDPOINT 0x05 | |
119 | ||
942ac052 AZ |
120 | #define USB_ENDPOINT_XFER_CONTROL 0 |
121 | #define USB_ENDPOINT_XFER_ISOC 1 | |
122 | #define USB_ENDPOINT_XFER_BULK 2 | |
123 | #define USB_ENDPOINT_XFER_INT 3 | |
124 | ||
806b6024 | 125 | typedef struct USBBus USBBus; |
bb36d470 FB |
126 | typedef struct USBPort USBPort; |
127 | typedef struct USBDevice USBDevice; | |
806b6024 | 128 | typedef struct USBDeviceInfo USBDeviceInfo; |
4d611c9a | 129 | typedef struct USBPacket USBPacket; |
bb36d470 FB |
130 | |
131 | /* definition of a USB device */ | |
132 | struct USBDevice { | |
806b6024 GH |
133 | DeviceState qdev; |
134 | USBDeviceInfo *info; | |
bb36d470 | 135 | void *opaque; |
89b9b79f | 136 | |
806b6024 GH |
137 | int speed; |
138 | uint8_t addr; | |
0fe6d12e | 139 | char product_desc[32]; |
61e094c0 | 140 | int auto_attach; |
a5d2f727 | 141 | int attached; |
806b6024 GH |
142 | |
143 | int state; | |
144 | uint8_t setup_buf[8]; | |
145 | uint8_t data_buf[1024]; | |
146 | int remote_wakeup; | |
147 | int setup_state; | |
148 | int setup_len; | |
149 | int setup_index; | |
150 | }; | |
151 | ||
152 | struct USBDeviceInfo { | |
153 | DeviceInfo qdev; | |
154 | int (*init)(USBDevice *dev); | |
155 | ||
156 | /* | |
157 | * Process USB packet. | |
89b9b79f AL |
158 | * Called by the HC (Host Controller). |
159 | * | |
806b6024 | 160 | * Returns length of the transaction |
89b9b79f | 161 | * or one of the USB_RET_XXX codes. |
806b6024 | 162 | */ |
4d611c9a | 163 | int (*handle_packet)(USBDevice *dev, USBPacket *p); |
89b9b79f | 164 | |
806b6024 | 165 | /* |
89b9b79f AL |
166 | * Called when device is destroyed. |
167 | */ | |
059809e4 FB |
168 | void (*handle_destroy)(USBDevice *dev); |
169 | ||
89b9b79f AL |
170 | /* |
171 | * Reset the device | |
806b6024 | 172 | */ |
059809e4 | 173 | void (*handle_reset)(USBDevice *dev); |
89b9b79f AL |
174 | |
175 | /* | |
176 | * Process control request. | |
177 | * Called from handle_packet(). | |
178 | * | |
179 | * Returns length or one of the USB_RET_ codes. | |
180 | */ | |
bb36d470 FB |
181 | int (*handle_control)(USBDevice *dev, int request, int value, |
182 | int index, int length, uint8_t *data); | |
89b9b79f AL |
183 | |
184 | /* | |
185 | * Process data transfers (both BULK and ISOC). | |
186 | * Called from handle_packet(). | |
187 | * | |
188 | * Returns length or one of the USB_RET_ codes. | |
189 | */ | |
4d611c9a | 190 | int (*handle_data)(USBDevice *dev, USBPacket *p); |
0958b4cc | 191 | |
06384698 MA |
192 | const char *product_desc; |
193 | ||
0958b4cc GH |
194 | /* handle legacy -usbdevice command line options */ |
195 | const char *usbdevice_name; | |
196 | USBDevice *(*usbdevice_init)(const char *params); | |
bb36d470 FB |
197 | }; |
198 | ||
0d92ed30 PB |
199 | typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev); |
200 | ||
bb36d470 FB |
201 | /* USB port on which a device can be connected */ |
202 | struct USBPort { | |
a594cfbf | 203 | USBDevice *dev; |
0d92ed30 | 204 | usb_attachfn attach; |
bb36d470 FB |
205 | void *opaque; |
206 | int index; /* internal port index, may be used with the opaque */ | |
72cf2d4f | 207 | QTAILQ_ENTRY(USBPort) next; |
bb36d470 FB |
208 | }; |
209 | ||
4d611c9a PB |
210 | typedef void USBCallback(USBPacket * packet, void *opaque); |
211 | ||
212 | /* Structure used to hold information about an active USB packet. */ | |
213 | struct USBPacket { | |
214 | /* Data fields for use by the driver. */ | |
215 | int pid; | |
216 | uint8_t devaddr; | |
217 | uint8_t devep; | |
218 | uint8_t *data; | |
219 | int len; | |
220 | /* Internal use by the USB layer. */ | |
221 | USBCallback *complete_cb; | |
222 | void *complete_opaque; | |
223 | USBCallback *cancel_cb; | |
b63891a0 | 224 | void *cancel_opaque; |
4d611c9a PB |
225 | }; |
226 | ||
227 | /* Defer completion of a USB packet. The hadle_packet routine should then | |
228 | return USB_RET_ASYNC. Packets that complete immediately (before | |
229 | handle_packet returns) should not call this method. */ | |
230 | static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel, | |
231 | void * opaque) | |
232 | { | |
233 | p->cancel_cb = cancel; | |
234 | p->cancel_opaque = opaque; | |
235 | } | |
236 | ||
237 | /* Notify the controller that an async packet is complete. This should only | |
238 | be called for packets previously deferred with usb_defer_packet, and | |
239 | should never be called from within handle_packet. */ | |
240 | static inline void usb_packet_complete(USBPacket *p) | |
241 | { | |
242 | p->complete_cb(p, p->complete_opaque); | |
243 | } | |
244 | ||
245 | /* Cancel an active packet. The packed must have been deferred with | |
246 | usb_defer_packet, and not yet completed. */ | |
247 | static inline void usb_cancel_packet(USBPacket * p) | |
248 | { | |
249 | p->cancel_cb(p, p->cancel_opaque); | |
250 | } | |
251 | ||
bb36d470 | 252 | void usb_attach(USBPort *port, USBDevice *dev); |
4d611c9a | 253 | int usb_generic_handle_packet(USBDevice *s, USBPacket *p); |
bb36d470 | 254 | int set_usb_string(uint8_t *buf, const char *str); |
4d611c9a PB |
255 | void usb_send_msg(USBDevice *dev, int msg); |
256 | ||
bb36d470 | 257 | /* usb-linux.c */ |
a594cfbf | 258 | USBDevice *usb_host_device_open(const char *devname); |
5d0c5750 | 259 | int usb_host_device_close(const char *devname); |
376253ec | 260 | void usb_host_info(Monitor *mon); |
59ae540c FB |
261 | |
262 | /* usb-hid.c */ | |
47e699dc | 263 | void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *)); |
2e5d83bb | 264 | |
e6a6d5ab AZ |
265 | /* usb-bt.c */ |
266 | USBDevice *usb_bt_init(HCIInfo *hci); | |
267 | ||
87ecb68b PB |
268 | /* usb ports of the VM */ |
269 | ||
87ecb68b PB |
270 | #define VM_USB_HUB_SIZE 8 |
271 | ||
942ac052 AZ |
272 | /* usb-musb.c */ |
273 | enum musb_irq_source_e { | |
274 | musb_irq_suspend = 0, | |
275 | musb_irq_resume, | |
276 | musb_irq_rst_babble, | |
277 | musb_irq_sof, | |
278 | musb_irq_connect, | |
279 | musb_irq_disconnect, | |
280 | musb_irq_vbus_request, | |
281 | musb_irq_vbus_error, | |
282 | musb_irq_rx, | |
283 | musb_irq_tx, | |
284 | musb_set_vbus, | |
285 | musb_set_session, | |
286 | __musb_irq_max, | |
287 | }; | |
288 | ||
bc24a225 PB |
289 | typedef struct MUSBState MUSBState; |
290 | MUSBState *musb_init(qemu_irq *irqs); | |
291 | uint32_t musb_core_intr_get(MUSBState *s); | |
292 | void musb_core_intr_clear(MUSBState *s, uint32_t mask); | |
293 | void musb_set_size(MUSBState *s, int epnum, int size, int is_tx); | |
806b6024 GH |
294 | |
295 | /* usb-bus.c */ | |
296 | ||
297 | struct USBBus { | |
298 | BusState qbus; | |
299 | int busnr; | |
300 | int nfree; | |
301 | int nused; | |
72cf2d4f BS |
302 | QTAILQ_HEAD(, USBPort) free; |
303 | QTAILQ_HEAD(, USBPort) used; | |
304 | QTAILQ_ENTRY(USBBus) next; | |
806b6024 GH |
305 | }; |
306 | ||
b2317837 | 307 | void usb_bus_new(USBBus *bus, DeviceState *host); |
806b6024 GH |
308 | USBBus *usb_bus_find(int busnr); |
309 | void usb_qdev_register(USBDeviceInfo *info); | |
310 | void usb_qdev_register_many(USBDeviceInfo *info); | |
a5d2f727 | 311 | USBDevice *usb_create(USBBus *bus, const char *name); |
806b6024 | 312 | USBDevice *usb_create_simple(USBBus *bus, const char *name); |
0958b4cc | 313 | USBDevice *usbdevice_create(const char *cmdline); |
a5d2f727 GH |
314 | void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index, |
315 | usb_attachfn attach); | |
a8e662b5 | 316 | void usb_unregister_port(USBBus *bus, USBPort *port); |
a5d2f727 | 317 | int usb_device_attach(USBDevice *dev); |
a8e662b5 | 318 | int usb_device_detach(USBDevice *dev); |
a5d2f727 GH |
319 | int usb_device_delete_addr(int busnr, int addr); |
320 | ||
321 | static inline USBBus *usb_bus_from_device(USBDevice *d) | |
322 | { | |
323 | return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus); | |
324 | } |