]>
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 | |
8e257816 BH |
29 | /* Constants related to the USB / PCI interaction */ |
30 | #define USB_SBRN 0x60 /* Serial Bus Release Number Register */ | |
31 | #define USB_RELEASE_1 0x10 /* USB 1.0 */ | |
32 | #define USB_RELEASE_2 0x20 /* USB 2.0 */ | |
33 | #define USB_RELEASE_3 0x30 /* USB 3.0 */ | |
34 | ||
bb36d470 FB |
35 | #define USB_TOKEN_SETUP 0x2d |
36 | #define USB_TOKEN_IN 0x69 /* device -> host */ | |
37 | #define USB_TOKEN_OUT 0xe1 /* host -> device */ | |
38 | ||
39 | /* specific usb messages, also sent in the 'pid' parameter */ | |
40 | #define USB_MSG_ATTACH 0x100 | |
41 | #define USB_MSG_DETACH 0x101 | |
42 | #define USB_MSG_RESET 0x102 | |
43 | ||
5fafdf24 | 44 | #define USB_RET_NODEV (-1) |
bb36d470 FB |
45 | #define USB_RET_NAK (-2) |
46 | #define USB_RET_STALL (-3) | |
47 | #define USB_RET_BABBLE (-4) | |
4d611c9a | 48 | #define USB_RET_ASYNC (-5) |
bb36d470 FB |
49 | |
50 | #define USB_SPEED_LOW 0 | |
51 | #define USB_SPEED_FULL 1 | |
52 | #define USB_SPEED_HIGH 2 | |
843d4e0c GH |
53 | #define USB_SPEED_SUPER 3 |
54 | ||
55 | #define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW) | |
56 | #define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL) | |
57 | #define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH) | |
58 | #define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER) | |
bb36d470 FB |
59 | |
60 | #define USB_STATE_NOTATTACHED 0 | |
61 | #define USB_STATE_ATTACHED 1 | |
62 | //#define USB_STATE_POWERED 2 | |
63 | #define USB_STATE_DEFAULT 3 | |
64 | //#define USB_STATE_ADDRESS 4 | |
65 | //#define USB_STATE_CONFIGURED 5 | |
66 | #define USB_STATE_SUSPENDED 6 | |
67 | ||
a594cfbf FB |
68 | #define USB_CLASS_AUDIO 1 |
69 | #define USB_CLASS_COMM 2 | |
70 | #define USB_CLASS_HID 3 | |
71 | #define USB_CLASS_PHYSICAL 5 | |
72 | #define USB_CLASS_STILL_IMAGE 6 | |
73 | #define USB_CLASS_PRINTER 7 | |
74 | #define USB_CLASS_MASS_STORAGE 8 | |
75 | #define USB_CLASS_HUB 9 | |
76 | #define USB_CLASS_CDC_DATA 0x0a | |
77 | #define USB_CLASS_CSCID 0x0b | |
78 | #define USB_CLASS_CONTENT_SEC 0x0d | |
79 | #define USB_CLASS_APP_SPEC 0xfe | |
80 | #define USB_CLASS_VENDOR_SPEC 0xff | |
81 | ||
bb36d470 FB |
82 | #define USB_DIR_OUT 0 |
83 | #define USB_DIR_IN 0x80 | |
84 | ||
85 | #define USB_TYPE_MASK (0x03 << 5) | |
86 | #define USB_TYPE_STANDARD (0x00 << 5) | |
87 | #define USB_TYPE_CLASS (0x01 << 5) | |
88 | #define USB_TYPE_VENDOR (0x02 << 5) | |
89 | #define USB_TYPE_RESERVED (0x03 << 5) | |
90 | ||
91 | #define USB_RECIP_MASK 0x1f | |
92 | #define USB_RECIP_DEVICE 0x00 | |
93 | #define USB_RECIP_INTERFACE 0x01 | |
94 | #define USB_RECIP_ENDPOINT 0x02 | |
95 | #define USB_RECIP_OTHER 0x03 | |
96 | ||
97 | #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | |
98 | #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8) | |
59ae540c FB |
99 | #define InterfaceRequest \ |
100 | ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | |
101 | #define InterfaceOutRequest \ | |
102 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8) | |
103 | #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) | |
104 | #define EndpointOutRequest \ | |
105 | ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8) | |
f3571b1a MR |
106 | #define ClassInterfaceRequest \ |
107 | ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8) | |
108 | #define ClassInterfaceOutRequest \ | |
109 | ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8) | |
bb36d470 FB |
110 | |
111 | #define USB_REQ_GET_STATUS 0x00 | |
112 | #define USB_REQ_CLEAR_FEATURE 0x01 | |
113 | #define USB_REQ_SET_FEATURE 0x03 | |
114 | #define USB_REQ_SET_ADDRESS 0x05 | |
115 | #define USB_REQ_GET_DESCRIPTOR 0x06 | |
116 | #define USB_REQ_SET_DESCRIPTOR 0x07 | |
117 | #define USB_REQ_GET_CONFIGURATION 0x08 | |
118 | #define USB_REQ_SET_CONFIGURATION 0x09 | |
119 | #define USB_REQ_GET_INTERFACE 0x0A | |
120 | #define USB_REQ_SET_INTERFACE 0x0B | |
121 | #define USB_REQ_SYNCH_FRAME 0x0C | |
122 | ||
123 | #define USB_DEVICE_SELF_POWERED 0 | |
124 | #define USB_DEVICE_REMOTE_WAKEUP 1 | |
125 | ||
126 | #define USB_DT_DEVICE 0x01 | |
127 | #define USB_DT_CONFIG 0x02 | |
128 | #define USB_DT_STRING 0x03 | |
129 | #define USB_DT_INTERFACE 0x04 | |
130 | #define USB_DT_ENDPOINT 0x05 | |
25620cba GH |
131 | #define USB_DT_DEVICE_QUALIFIER 0x06 |
132 | #define USB_DT_OTHER_SPEED_CONFIG 0x07 | |
c6d3ad0f | 133 | #define USB_DT_INTERFACE_ASSOC 0x0B |
bb36d470 | 134 | |
942ac052 AZ |
135 | #define USB_ENDPOINT_XFER_CONTROL 0 |
136 | #define USB_ENDPOINT_XFER_ISOC 1 | |
137 | #define USB_ENDPOINT_XFER_BULK 2 | |
138 | #define USB_ENDPOINT_XFER_INT 3 | |
139 | ||
806b6024 | 140 | typedef struct USBBus USBBus; |
07771f6f | 141 | typedef struct USBBusOps USBBusOps; |
bb36d470 FB |
142 | typedef struct USBPort USBPort; |
143 | typedef struct USBDevice USBDevice; | |
806b6024 | 144 | typedef struct USBDeviceInfo USBDeviceInfo; |
4d611c9a | 145 | typedef struct USBPacket USBPacket; |
bb36d470 | 146 | |
37fb59d3 GH |
147 | typedef struct USBDesc USBDesc; |
148 | typedef struct USBDescID USBDescID; | |
149 | typedef struct USBDescDevice USBDescDevice; | |
150 | typedef struct USBDescConfig USBDescConfig; | |
6e625fc7 | 151 | typedef struct USBDescIfaceAssoc USBDescIfaceAssoc; |
37fb59d3 GH |
152 | typedef struct USBDescIface USBDescIface; |
153 | typedef struct USBDescEndpoint USBDescEndpoint; | |
154 | typedef struct USBDescOther USBDescOther; | |
132a3f55 GH |
155 | typedef struct USBDescString USBDescString; |
156 | ||
157 | struct USBDescString { | |
158 | uint8_t index; | |
159 | char *str; | |
160 | QLIST_ENTRY(USBDescString) next; | |
161 | }; | |
37fb59d3 | 162 | |
bb36d470 FB |
163 | /* definition of a USB device */ |
164 | struct USBDevice { | |
806b6024 GH |
165 | DeviceState qdev; |
166 | USBDeviceInfo *info; | |
618c169b | 167 | USBPort *port; |
5f69076b | 168 | char *port_path; |
bb36d470 | 169 | void *opaque; |
89b9b79f | 170 | |
806b6024 GH |
171 | int speed; |
172 | uint8_t addr; | |
0fe6d12e | 173 | char product_desc[32]; |
61e094c0 | 174 | int auto_attach; |
a5d2f727 | 175 | int attached; |
806b6024 | 176 | |
c1ecb40a | 177 | int32_t state; |
806b6024 | 178 | uint8_t setup_buf[8]; |
19f33223 | 179 | uint8_t data_buf[4096]; |
c1ecb40a GH |
180 | int32_t remote_wakeup; |
181 | int32_t setup_state; | |
182 | int32_t setup_len; | |
183 | int32_t setup_index; | |
132a3f55 GH |
184 | |
185 | QLIST_HEAD(, USBDescString) strings; | |
a980a065 GH |
186 | const USBDescDevice *device; |
187 | const USBDescConfig *config; | |
806b6024 GH |
188 | }; |
189 | ||
190 | struct USBDeviceInfo { | |
191 | DeviceInfo qdev; | |
192 | int (*init)(USBDevice *dev); | |
193 | ||
194 | /* | |
195 | * Process USB packet. | |
89b9b79f AL |
196 | * Called by the HC (Host Controller). |
197 | * | |
806b6024 | 198 | * Returns length of the transaction |
89b9b79f | 199 | * or one of the USB_RET_XXX codes. |
806b6024 | 200 | */ |
4d611c9a | 201 | int (*handle_packet)(USBDevice *dev, USBPacket *p); |
89b9b79f | 202 | |
eb5e680a GH |
203 | /* |
204 | * Called when a packet is canceled. | |
205 | */ | |
206 | void (*cancel_packet)(USBDevice *dev, USBPacket *p); | |
207 | ||
806b6024 | 208 | /* |
89b9b79f AL |
209 | * Called when device is destroyed. |
210 | */ | |
059809e4 FB |
211 | void (*handle_destroy)(USBDevice *dev); |
212 | ||
b6f77fbe GH |
213 | /* |
214 | * Attach the device | |
215 | */ | |
216 | void (*handle_attach)(USBDevice *dev); | |
217 | ||
89b9b79f AL |
218 | /* |
219 | * Reset the device | |
806b6024 | 220 | */ |
059809e4 | 221 | void (*handle_reset)(USBDevice *dev); |
89b9b79f AL |
222 | |
223 | /* | |
224 | * Process control request. | |
225 | * Called from handle_packet(). | |
226 | * | |
227 | * Returns length or one of the USB_RET_ codes. | |
228 | */ | |
007fd62f | 229 | int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value, |
bb36d470 | 230 | int index, int length, uint8_t *data); |
89b9b79f AL |
231 | |
232 | /* | |
233 | * Process data transfers (both BULK and ISOC). | |
234 | * Called from handle_packet(). | |
235 | * | |
236 | * Returns length or one of the USB_RET_ codes. | |
237 | */ | |
4d611c9a | 238 | int (*handle_data)(USBDevice *dev, USBPacket *p); |
0958b4cc | 239 | |
06384698 | 240 | const char *product_desc; |
37fb59d3 | 241 | const USBDesc *usb_desc; |
06384698 | 242 | |
0958b4cc GH |
243 | /* handle legacy -usbdevice command line options */ |
244 | const char *usbdevice_name; | |
245 | USBDevice *(*usbdevice_init)(const char *params); | |
bb36d470 FB |
246 | }; |
247 | ||
0d86d2be | 248 | typedef struct USBPortOps { |
618c169b GH |
249 | void (*attach)(USBPort *port); |
250 | void (*detach)(USBPort *port); | |
01eacab6 | 251 | void (*wakeup)(USBDevice *dev); |
13a9a0d3 | 252 | void (*complete)(USBDevice *dev, USBPacket *p); |
0d86d2be | 253 | } USBPortOps; |
0d92ed30 | 254 | |
bb36d470 FB |
255 | /* USB port on which a device can be connected */ |
256 | struct USBPort { | |
a594cfbf | 257 | USBDevice *dev; |
843d4e0c | 258 | int speedmask; |
c7a2196a | 259 | char path[16]; |
0d86d2be | 260 | USBPortOps *ops; |
bb36d470 FB |
261 | void *opaque; |
262 | int index; /* internal port index, may be used with the opaque */ | |
72cf2d4f | 263 | QTAILQ_ENTRY(USBPort) next; |
bb36d470 FB |
264 | }; |
265 | ||
4d611c9a PB |
266 | typedef void USBCallback(USBPacket * packet, void *opaque); |
267 | ||
268 | /* Structure used to hold information about an active USB packet. */ | |
269 | struct USBPacket { | |
270 | /* Data fields for use by the driver. */ | |
271 | int pid; | |
272 | uint8_t devaddr; | |
273 | uint8_t devep; | |
274 | uint8_t *data; | |
275 | int len; | |
276 | /* Internal use by the USB layer. */ | |
4ff658fb | 277 | USBDevice *owner; |
4d611c9a PB |
278 | }; |
279 | ||
53aa8c0e | 280 | int usb_handle_packet(USBDevice *dev, USBPacket *p); |
4ff658fb GH |
281 | void usb_packet_complete(USBDevice *dev, USBPacket *p); |
282 | void usb_cancel_packet(USBPacket * p); | |
53aa8c0e | 283 | |
bb36d470 | 284 | void usb_attach(USBPort *port, USBDevice *dev); |
01eacab6 | 285 | void usb_wakeup(USBDevice *dev); |
4d611c9a | 286 | int usb_generic_handle_packet(USBDevice *s, USBPacket *p); |
50b7963e | 287 | void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p); |
bb36d470 | 288 | int set_usb_string(uint8_t *buf, const char *str); |
4d611c9a PB |
289 | void usb_send_msg(USBDevice *dev, int msg); |
290 | ||
bb36d470 | 291 | /* usb-linux.c */ |
a594cfbf | 292 | USBDevice *usb_host_device_open(const char *devname); |
5d0c5750 | 293 | int usb_host_device_close(const char *devname); |
376253ec | 294 | void usb_host_info(Monitor *mon); |
59ae540c FB |
295 | |
296 | /* usb-hid.c */ | |
47e699dc | 297 | void usb_hid_datain_cb(USBDevice *dev, void *opaque, void (*datain)(void *)); |
2e5d83bb | 298 | |
e6a6d5ab AZ |
299 | /* usb-bt.c */ |
300 | USBDevice *usb_bt_init(HCIInfo *hci); | |
301 | ||
87ecb68b PB |
302 | /* usb ports of the VM */ |
303 | ||
87ecb68b PB |
304 | #define VM_USB_HUB_SIZE 8 |
305 | ||
942ac052 AZ |
306 | /* usb-musb.c */ |
307 | enum musb_irq_source_e { | |
308 | musb_irq_suspend = 0, | |
309 | musb_irq_resume, | |
310 | musb_irq_rst_babble, | |
311 | musb_irq_sof, | |
312 | musb_irq_connect, | |
313 | musb_irq_disconnect, | |
314 | musb_irq_vbus_request, | |
315 | musb_irq_vbus_error, | |
316 | musb_irq_rx, | |
317 | musb_irq_tx, | |
318 | musb_set_vbus, | |
319 | musb_set_session, | |
320 | __musb_irq_max, | |
321 | }; | |
322 | ||
bc24a225 PB |
323 | typedef struct MUSBState MUSBState; |
324 | MUSBState *musb_init(qemu_irq *irqs); | |
325 | uint32_t musb_core_intr_get(MUSBState *s); | |
326 | void musb_core_intr_clear(MUSBState *s, uint32_t mask); | |
327 | void musb_set_size(MUSBState *s, int epnum, int size, int is_tx); | |
806b6024 GH |
328 | |
329 | /* usb-bus.c */ | |
330 | ||
331 | struct USBBus { | |
332 | BusState qbus; | |
07771f6f | 333 | USBBusOps *ops; |
806b6024 GH |
334 | int busnr; |
335 | int nfree; | |
336 | int nused; | |
72cf2d4f BS |
337 | QTAILQ_HEAD(, USBPort) free; |
338 | QTAILQ_HEAD(, USBPort) used; | |
339 | QTAILQ_ENTRY(USBBus) next; | |
806b6024 GH |
340 | }; |
341 | ||
07771f6f GH |
342 | struct USBBusOps { |
343 | void (*device_destroy)(USBBus *bus, USBDevice *dev); | |
344 | }; | |
345 | ||
346 | void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host); | |
806b6024 GH |
347 | USBBus *usb_bus_find(int busnr); |
348 | void usb_qdev_register(USBDeviceInfo *info); | |
349 | void usb_qdev_register_many(USBDeviceInfo *info); | |
a5d2f727 | 350 | USBDevice *usb_create(USBBus *bus, const char *name); |
806b6024 | 351 | USBDevice *usb_create_simple(USBBus *bus, const char *name); |
0958b4cc | 352 | USBDevice *usbdevice_create(const char *cmdline); |
a5d2f727 | 353 | void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index, |
ace1318b | 354 | USBPortOps *ops, int speedmask); |
c7a2196a | 355 | void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr); |
a8e662b5 | 356 | void usb_unregister_port(USBBus *bus, USBPort *port); |
a5d2f727 | 357 | int usb_device_attach(USBDevice *dev); |
a8e662b5 | 358 | int usb_device_detach(USBDevice *dev); |
a5d2f727 GH |
359 | int usb_device_delete_addr(int busnr, int addr); |
360 | ||
361 | static inline USBBus *usb_bus_from_device(USBDevice *d) | |
362 | { | |
363 | return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus); | |
364 | } |