]>
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 | |
a7fb71d1 | 133 | #define USB_DT_DEBUG 0x0A |
c6d3ad0f | 134 | #define USB_DT_INTERFACE_ASSOC 0x0B |
bb36d470 | 135 | |
942ac052 AZ |
136 | #define USB_ENDPOINT_XFER_CONTROL 0 |
137 | #define USB_ENDPOINT_XFER_ISOC 1 | |
138 | #define USB_ENDPOINT_XFER_BULK 2 | |
139 | #define USB_ENDPOINT_XFER_INT 3 | |
140 | ||
806b6024 | 141 | typedef struct USBBus USBBus; |
07771f6f | 142 | typedef struct USBBusOps USBBusOps; |
bb36d470 FB |
143 | typedef struct USBPort USBPort; |
144 | typedef struct USBDevice USBDevice; | |
806b6024 | 145 | typedef struct USBDeviceInfo USBDeviceInfo; |
4d611c9a | 146 | typedef struct USBPacket USBPacket; |
bb36d470 | 147 | |
37fb59d3 GH |
148 | typedef struct USBDesc USBDesc; |
149 | typedef struct USBDescID USBDescID; | |
150 | typedef struct USBDescDevice USBDescDevice; | |
151 | typedef struct USBDescConfig USBDescConfig; | |
6e625fc7 | 152 | typedef struct USBDescIfaceAssoc USBDescIfaceAssoc; |
37fb59d3 GH |
153 | typedef struct USBDescIface USBDescIface; |
154 | typedef struct USBDescEndpoint USBDescEndpoint; | |
155 | typedef struct USBDescOther USBDescOther; | |
132a3f55 GH |
156 | typedef struct USBDescString USBDescString; |
157 | ||
158 | struct USBDescString { | |
159 | uint8_t index; | |
160 | char *str; | |
161 | QLIST_ENTRY(USBDescString) next; | |
162 | }; | |
37fb59d3 | 163 | |
1de14d43 GH |
164 | #define USB_MAX_ENDPOINTS 15 |
165 | #define USB_MAX_INTERFACES 16 | |
166 | ||
bb36d470 FB |
167 | /* definition of a USB device */ |
168 | struct USBDevice { | |
806b6024 GH |
169 | DeviceState qdev; |
170 | USBDeviceInfo *info; | |
618c169b | 171 | USBPort *port; |
5f69076b | 172 | char *port_path; |
bb36d470 | 173 | void *opaque; |
89b9b79f | 174 | |
ba3f9bfb | 175 | /* Actual connected speed */ |
806b6024 | 176 | int speed; |
ba3f9bfb HG |
177 | /* Supported speeds, not in info because it may be variable (hostdevs) */ |
178 | int speedmask; | |
806b6024 | 179 | uint8_t addr; |
0fe6d12e | 180 | char product_desc[32]; |
61e094c0 | 181 | int auto_attach; |
a5d2f727 | 182 | int attached; |
806b6024 | 183 | |
c1ecb40a | 184 | int32_t state; |
806b6024 | 185 | uint8_t setup_buf[8]; |
19f33223 | 186 | uint8_t data_buf[4096]; |
c1ecb40a GH |
187 | int32_t remote_wakeup; |
188 | int32_t setup_state; | |
189 | int32_t setup_len; | |
190 | int32_t setup_index; | |
132a3f55 GH |
191 | |
192 | QLIST_HEAD(, USBDescString) strings; | |
a980a065 | 193 | const USBDescDevice *device; |
65360511 GH |
194 | |
195 | int configuration; | |
196 | int ninterfaces; | |
1de14d43 | 197 | int altsetting[USB_MAX_INTERFACES]; |
a980a065 | 198 | const USBDescConfig *config; |
1de14d43 | 199 | const USBDescIface *ifaces[USB_MAX_INTERFACES]; |
806b6024 GH |
200 | }; |
201 | ||
202 | struct USBDeviceInfo { | |
203 | DeviceInfo qdev; | |
204 | int (*init)(USBDevice *dev); | |
205 | ||
206 | /* | |
207 | * Process USB packet. | |
89b9b79f AL |
208 | * Called by the HC (Host Controller). |
209 | * | |
806b6024 | 210 | * Returns length of the transaction |
89b9b79f | 211 | * or one of the USB_RET_XXX codes. |
806b6024 | 212 | */ |
4d611c9a | 213 | int (*handle_packet)(USBDevice *dev, USBPacket *p); |
89b9b79f | 214 | |
eb5e680a GH |
215 | /* |
216 | * Called when a packet is canceled. | |
217 | */ | |
218 | void (*cancel_packet)(USBDevice *dev, USBPacket *p); | |
219 | ||
806b6024 | 220 | /* |
89b9b79f AL |
221 | * Called when device is destroyed. |
222 | */ | |
059809e4 FB |
223 | void (*handle_destroy)(USBDevice *dev); |
224 | ||
b6f77fbe GH |
225 | /* |
226 | * Attach the device | |
227 | */ | |
228 | void (*handle_attach)(USBDevice *dev); | |
229 | ||
89b9b79f AL |
230 | /* |
231 | * Reset the device | |
806b6024 | 232 | */ |
059809e4 | 233 | void (*handle_reset)(USBDevice *dev); |
89b9b79f AL |
234 | |
235 | /* | |
236 | * Process control request. | |
237 | * Called from handle_packet(). | |
238 | * | |
239 | * Returns length or one of the USB_RET_ codes. | |
240 | */ | |
007fd62f | 241 | int (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value, |
bb36d470 | 242 | int index, int length, uint8_t *data); |
89b9b79f AL |
243 | |
244 | /* | |
245 | * Process data transfers (both BULK and ISOC). | |
246 | * Called from handle_packet(). | |
247 | * | |
248 | * Returns length or one of the USB_RET_ codes. | |
249 | */ | |
4d611c9a | 250 | int (*handle_data)(USBDevice *dev, USBPacket *p); |
0958b4cc | 251 | |
1de14d43 GH |
252 | void (*set_interface)(USBDevice *dev, int interface, |
253 | int alt_old, int alt_new); | |
254 | ||
06384698 | 255 | const char *product_desc; |
37fb59d3 | 256 | const USBDesc *usb_desc; |
06384698 | 257 | |
0958b4cc GH |
258 | /* handle legacy -usbdevice command line options */ |
259 | const char *usbdevice_name; | |
260 | USBDevice *(*usbdevice_init)(const char *params); | |
bb36d470 FB |
261 | }; |
262 | ||
0d86d2be | 263 | typedef struct USBPortOps { |
618c169b GH |
264 | void (*attach)(USBPort *port); |
265 | void (*detach)(USBPort *port); | |
4706ab6c HG |
266 | /* |
267 | * This gets called when a device downstream from the device attached to | |
268 | * the port (iow attached through a hub) gets detached. | |
269 | */ | |
270 | void (*child_detach)(USBPort *port, USBDevice *child); | |
d47e59b8 HG |
271 | void (*wakeup)(USBPort *port); |
272 | /* | |
273 | * Note that port->dev will be different then the device from which | |
274 | * the packet originated when a hub is involved, if you want the orginating | |
275 | * device use p->owner | |
276 | */ | |
277 | void (*complete)(USBPort *port, USBPacket *p); | |
0d86d2be | 278 | } USBPortOps; |
0d92ed30 | 279 | |
bb36d470 FB |
280 | /* USB port on which a device can be connected */ |
281 | struct USBPort { | |
a594cfbf | 282 | USBDevice *dev; |
843d4e0c | 283 | int speedmask; |
c7a2196a | 284 | char path[16]; |
0d86d2be | 285 | USBPortOps *ops; |
bb36d470 FB |
286 | void *opaque; |
287 | int index; /* internal port index, may be used with the opaque */ | |
72cf2d4f | 288 | QTAILQ_ENTRY(USBPort) next; |
bb36d470 FB |
289 | }; |
290 | ||
4d611c9a PB |
291 | typedef void USBCallback(USBPacket * packet, void *opaque); |
292 | ||
293 | /* Structure used to hold information about an active USB packet. */ | |
294 | struct USBPacket { | |
295 | /* Data fields for use by the driver. */ | |
296 | int pid; | |
297 | uint8_t devaddr; | |
298 | uint8_t devep; | |
4f4321c1 GH |
299 | QEMUIOVector iov; |
300 | int result; /* transfer length or USB_RET_* status code */ | |
4d611c9a | 301 | /* Internal use by the USB layer. */ |
4ff658fb | 302 | USBDevice *owner; |
4d611c9a PB |
303 | }; |
304 | ||
4f4321c1 GH |
305 | void usb_packet_init(USBPacket *p); |
306 | void usb_packet_setup(USBPacket *p, int pid, uint8_t addr, uint8_t ep); | |
307 | void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len); | |
308 | int usb_packet_map(USBPacket *p, QEMUSGList *sgl); | |
309 | void usb_packet_unmap(USBPacket *p); | |
310 | void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes); | |
311 | void usb_packet_skip(USBPacket *p, size_t bytes); | |
312 | void usb_packet_cleanup(USBPacket *p); | |
313 | ||
53aa8c0e | 314 | int usb_handle_packet(USBDevice *dev, USBPacket *p); |
4ff658fb GH |
315 | void usb_packet_complete(USBDevice *dev, USBPacket *p); |
316 | void usb_cancel_packet(USBPacket * p); | |
53aa8c0e | 317 | |
891fb2cd GH |
318 | void usb_attach(USBPort *port); |
319 | void usb_detach(USBPort *port); | |
e0b8e72d | 320 | void usb_reset(USBPort *port); |
01eacab6 | 321 | void usb_wakeup(USBDevice *dev); |
4d611c9a | 322 | int usb_generic_handle_packet(USBDevice *s, USBPacket *p); |
50b7963e | 323 | void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p); |
bb36d470 | 324 | int set_usb_string(uint8_t *buf, const char *str); |
4d611c9a PB |
325 | void usb_send_msg(USBDevice *dev, int msg); |
326 | ||
bb36d470 | 327 | /* usb-linux.c */ |
a594cfbf | 328 | USBDevice *usb_host_device_open(const char *devname); |
5d0c5750 | 329 | int usb_host_device_close(const char *devname); |
376253ec | 330 | void usb_host_info(Monitor *mon); |
59ae540c | 331 | |
e6a6d5ab AZ |
332 | /* usb-bt.c */ |
333 | USBDevice *usb_bt_init(HCIInfo *hci); | |
334 | ||
87ecb68b PB |
335 | /* usb ports of the VM */ |
336 | ||
87ecb68b PB |
337 | #define VM_USB_HUB_SIZE 8 |
338 | ||
942ac052 AZ |
339 | /* usb-musb.c */ |
340 | enum musb_irq_source_e { | |
341 | musb_irq_suspend = 0, | |
342 | musb_irq_resume, | |
343 | musb_irq_rst_babble, | |
344 | musb_irq_sof, | |
345 | musb_irq_connect, | |
346 | musb_irq_disconnect, | |
347 | musb_irq_vbus_request, | |
348 | musb_irq_vbus_error, | |
349 | musb_irq_rx, | |
350 | musb_irq_tx, | |
351 | musb_set_vbus, | |
352 | musb_set_session, | |
9147b752 PM |
353 | /* Add new interrupts here */ |
354 | musb_irq_max, /* total number of interrupts defined */ | |
942ac052 AZ |
355 | }; |
356 | ||
bc24a225 | 357 | typedef struct MUSBState MUSBState; |
406c2075 | 358 | MUSBState *musb_init(DeviceState *parent_device, int gpio_base); |
5b1cdb4e | 359 | void musb_reset(MUSBState *s); |
bc24a225 PB |
360 | uint32_t musb_core_intr_get(MUSBState *s); |
361 | void musb_core_intr_clear(MUSBState *s, uint32_t mask); | |
362 | void musb_set_size(MUSBState *s, int epnum, int size, int is_tx); | |
806b6024 GH |
363 | |
364 | /* usb-bus.c */ | |
365 | ||
366 | struct USBBus { | |
367 | BusState qbus; | |
07771f6f | 368 | USBBusOps *ops; |
806b6024 GH |
369 | int busnr; |
370 | int nfree; | |
371 | int nused; | |
72cf2d4f BS |
372 | QTAILQ_HEAD(, USBPort) free; |
373 | QTAILQ_HEAD(, USBPort) used; | |
374 | QTAILQ_ENTRY(USBBus) next; | |
806b6024 GH |
375 | }; |
376 | ||
07771f6f | 377 | struct USBBusOps { |
ae60fea9 HG |
378 | int (*register_companion)(USBBus *bus, USBPort *ports[], |
379 | uint32_t portcount, uint32_t firstport); | |
07771f6f GH |
380 | }; |
381 | ||
382 | void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host); | |
806b6024 GH |
383 | USBBus *usb_bus_find(int busnr); |
384 | void usb_qdev_register(USBDeviceInfo *info); | |
385 | void usb_qdev_register_many(USBDeviceInfo *info); | |
a5d2f727 | 386 | USBDevice *usb_create(USBBus *bus, const char *name); |
806b6024 | 387 | USBDevice *usb_create_simple(USBBus *bus, const char *name); |
0958b4cc | 388 | USBDevice *usbdevice_create(const char *cmdline); |
a5d2f727 | 389 | void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index, |
ace1318b | 390 | USBPortOps *ops, int speedmask); |
ae60fea9 HG |
391 | int usb_register_companion(const char *masterbus, USBPort *ports[], |
392 | uint32_t portcount, uint32_t firstport, | |
393 | void *opaque, USBPortOps *ops, int speedmask); | |
c7a2196a | 394 | void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr); |
a8e662b5 | 395 | void usb_unregister_port(USBBus *bus, USBPort *port); |
891fb2cd GH |
396 | int usb_claim_port(USBDevice *dev); |
397 | void usb_release_port(USBDevice *dev); | |
a5d2f727 | 398 | int usb_device_attach(USBDevice *dev); |
a8e662b5 | 399 | int usb_device_detach(USBDevice *dev); |
a5d2f727 GH |
400 | int usb_device_delete_addr(int busnr, int addr); |
401 | ||
402 | static inline USBBus *usb_bus_from_device(USBDevice *d) | |
403 | { | |
404 | return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus); | |
405 | } |