1#ifndef QEMU_USB_H
2#define QEMU_USB_H
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28#include "qdev.h"
29#include "qemu/queue.h"
30
31
32#define USB_SBRN 0x60
33#define USB_RELEASE_1 0x10
34#define USB_RELEASE_2 0x20
35#define USB_RELEASE_3 0x30
36
37#define USB_TOKEN_SETUP 0x2d
38#define USB_TOKEN_IN 0x69
39#define USB_TOKEN_OUT 0xe1
40
41#define USB_RET_SUCCESS (0)
42#define USB_RET_NODEV (-1)
43#define USB_RET_NAK (-2)
44#define USB_RET_STALL (-3)
45#define USB_RET_BABBLE (-4)
46#define USB_RET_IOERROR (-5)
47#define USB_RET_ASYNC (-6)
48#define USB_RET_ADD_TO_QUEUE (-7)
49#define USB_RET_REMOVE_FROM_QUEUE (-8)
50
51#define USB_SPEED_LOW 0
52#define USB_SPEED_FULL 1
53#define USB_SPEED_HIGH 2
54#define USB_SPEED_SUPER 3
55
56#define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW)
57#define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL)
58#define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH)
59#define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
60
61#define USB_STATE_NOTATTACHED 0
62#define USB_STATE_ATTACHED 1
63
64#define USB_STATE_DEFAULT 3
65
66
67#define USB_STATE_SUSPENDED 6
68
69#define USB_CLASS_AUDIO 1
70#define USB_CLASS_COMM 2
71#define USB_CLASS_HID 3
72#define USB_CLASS_PHYSICAL 5
73#define USB_CLASS_STILL_IMAGE 6
74#define USB_CLASS_PRINTER 7
75#define USB_CLASS_MASS_STORAGE 8
76#define USB_CLASS_HUB 9
77#define USB_CLASS_CDC_DATA 0x0a
78#define USB_CLASS_CSCID 0x0b
79#define USB_CLASS_CONTENT_SEC 0x0d
80#define USB_CLASS_APP_SPEC 0xfe
81#define USB_CLASS_VENDOR_SPEC 0xff
82
83#define USB_SUBCLASS_UNDEFINED 0
84#define USB_SUBCLASS_AUDIO_CONTROL 1
85#define USB_SUBCLASS_AUDIO_STREAMING 2
86#define USB_SUBCLASS_AUDIO_MIDISTREAMING 3
87
88#define USB_DIR_OUT 0
89#define USB_DIR_IN 0x80
90
91#define USB_TYPE_MASK (0x03 << 5)
92#define USB_TYPE_STANDARD (0x00 << 5)
93#define USB_TYPE_CLASS (0x01 << 5)
94#define USB_TYPE_VENDOR (0x02 << 5)
95#define USB_TYPE_RESERVED (0x03 << 5)
96
97#define USB_RECIP_MASK 0x1f
98#define USB_RECIP_DEVICE 0x00
99#define USB_RECIP_INTERFACE 0x01
100#define USB_RECIP_ENDPOINT 0x02
101#define USB_RECIP_OTHER 0x03
102
103#define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
104#define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
105#define InterfaceRequest \
106 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
107#define InterfaceOutRequest \
108 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
109#define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
110#define EndpointOutRequest \
111 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
112#define ClassInterfaceRequest \
113 ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
114#define ClassInterfaceOutRequest \
115 ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
116
117#define USB_REQ_GET_STATUS 0x00
118#define USB_REQ_CLEAR_FEATURE 0x01
119#define USB_REQ_SET_FEATURE 0x03
120#define USB_REQ_SET_ADDRESS 0x05
121#define USB_REQ_GET_DESCRIPTOR 0x06
122#define USB_REQ_SET_DESCRIPTOR 0x07
123#define USB_REQ_GET_CONFIGURATION 0x08
124#define USB_REQ_SET_CONFIGURATION 0x09
125#define USB_REQ_GET_INTERFACE 0x0A
126#define USB_REQ_SET_INTERFACE 0x0B
127#define USB_REQ_SYNCH_FRAME 0x0C
128
129#define USB_DEVICE_SELF_POWERED 0
130#define USB_DEVICE_REMOTE_WAKEUP 1
131
132#define USB_DT_DEVICE 0x01
133#define USB_DT_CONFIG 0x02
134#define USB_DT_STRING 0x03
135#define USB_DT_INTERFACE 0x04
136#define USB_DT_ENDPOINT 0x05
137#define USB_DT_DEVICE_QUALIFIER 0x06
138#define USB_DT_OTHER_SPEED_CONFIG 0x07
139#define USB_DT_DEBUG 0x0A
140#define USB_DT_INTERFACE_ASSOC 0x0B
141#define USB_DT_BOS 0x0F
142#define USB_DT_DEVICE_CAPABILITY 0x10
143#define USB_DT_CS_INTERFACE 0x24
144#define USB_DT_CS_ENDPOINT 0x25
145#define USB_DT_ENDPOINT_COMPANION 0x30
146
147#define USB_DEV_CAP_WIRELESS 0x01
148#define USB_DEV_CAP_USB2_EXT 0x02
149#define USB_DEV_CAP_SUPERSPEED 0x03
150
151#define USB_ENDPOINT_XFER_CONTROL 0
152#define USB_ENDPOINT_XFER_ISOC 1
153#define USB_ENDPOINT_XFER_BULK 2
154#define USB_ENDPOINT_XFER_INT 3
155#define USB_ENDPOINT_XFER_INVALID 255
156
157#define USB_INTERFACE_INVALID 255
158
159typedef struct USBBus USBBus;
160typedef struct USBBusOps USBBusOps;
161typedef struct USBPort USBPort;
162typedef struct USBDevice USBDevice;
163typedef struct USBPacket USBPacket;
164typedef struct USBCombinedPacket USBCombinedPacket;
165typedef struct USBEndpoint USBEndpoint;
166
167typedef struct USBDesc USBDesc;
168typedef struct USBDescID USBDescID;
169typedef struct USBDescDevice USBDescDevice;
170typedef struct USBDescConfig USBDescConfig;
171typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
172typedef struct USBDescIface USBDescIface;
173typedef struct USBDescEndpoint USBDescEndpoint;
174typedef struct USBDescOther USBDescOther;
175typedef struct USBDescString USBDescString;
176
177struct USBDescString {
178 uint8_t index;
179 char *str;
180 QLIST_ENTRY(USBDescString) next;
181};
182
183#define USB_MAX_ENDPOINTS 15
184#define USB_MAX_INTERFACES 16
185
186struct USBEndpoint {
187 uint8_t nr;
188 uint8_t pid;
189 uint8_t type;
190 uint8_t ifnum;
191 int max_packet_size;
192 bool pipeline;
193 bool halted;
194 USBDevice *dev;
195 QTAILQ_HEAD(, USBPacket) queue;
196};
197
198enum USBDeviceFlags {
199 USB_DEV_FLAG_FULL_PATH,
200 USB_DEV_FLAG_IS_HOST,
201};
202
203
204struct USBDevice {
205 DeviceState qdev;
206 USBPort *port;
207 char *port_path;
208 void *opaque;
209 uint32_t flags;
210
211
212 int speed;
213
214 int speedmask;
215 uint8_t addr;
216 char product_desc[32];
217 int auto_attach;
218 int attached;
219
220 int32_t state;
221 uint8_t setup_buf[8];
222 uint8_t data_buf[4096];
223 int32_t remote_wakeup;
224 int32_t setup_state;
225 int32_t setup_len;
226 int32_t setup_index;
227
228 USBEndpoint ep_ctl;
229 USBEndpoint ep_in[USB_MAX_ENDPOINTS];
230 USBEndpoint ep_out[USB_MAX_ENDPOINTS];
231
232 QLIST_HEAD(, USBDescString) strings;
233 const USBDesc *usb_desc;
234 const USBDescDevice *device;
235
236 int configuration;
237 int ninterfaces;
238 int altsetting[USB_MAX_INTERFACES];
239 const USBDescConfig *config;
240 const USBDescIface *ifaces[USB_MAX_INTERFACES];
241};
242
243#define TYPE_USB_DEVICE "usb-device"
244#define USB_DEVICE(obj) \
245 OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
246#define USB_DEVICE_CLASS(klass) \
247 OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
248#define USB_DEVICE_GET_CLASS(obj) \
249 OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
250
251typedef struct USBDeviceClass {
252 DeviceClass parent_class;
253
254 int (*init)(USBDevice *dev);
255
256
257
258
259
260 USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
261
262
263
264
265 void (*cancel_packet)(USBDevice *dev, USBPacket *p);
266
267
268
269
270 void (*handle_destroy)(USBDevice *dev);
271
272
273
274
275 void (*handle_attach)(USBDevice *dev);
276
277
278
279
280 void (*handle_reset)(USBDevice *dev);
281
282
283
284
285
286
287
288
289 void (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
290 int index, int length, uint8_t *data);
291
292
293
294
295
296
297
298
299 void (*handle_data)(USBDevice *dev, USBPacket *p);
300
301 void (*set_interface)(USBDevice *dev, int interface,
302 int alt_old, int alt_new);
303
304
305
306
307
308 void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);
309
310
311
312
313
314 void (*ep_stopped)(USBDevice *dev, USBEndpoint *ep);
315
316 const char *product_desc;
317 const USBDesc *usb_desc;
318} USBDeviceClass;
319
320typedef struct USBPortOps {
321 void (*attach)(USBPort *port);
322 void (*detach)(USBPort *port);
323
324
325
326
327 void (*child_detach)(USBPort *port, USBDevice *child);
328 void (*wakeup)(USBPort *port);
329
330
331
332
333 void (*complete)(USBPort *port, USBPacket *p);
334} USBPortOps;
335
336
337struct USBPort {
338 USBDevice *dev;
339 int speedmask;
340 char path[16];
341 USBPortOps *ops;
342 void *opaque;
343 int index;
344 QTAILQ_ENTRY(USBPort) next;
345};
346
347typedef void USBCallback(USBPacket * packet, void *opaque);
348
349typedef enum USBPacketState {
350 USB_PACKET_UNDEFINED = 0,
351 USB_PACKET_SETUP,
352 USB_PACKET_QUEUED,
353 USB_PACKET_ASYNC,
354 USB_PACKET_COMPLETE,
355 USB_PACKET_CANCELED,
356} USBPacketState;
357
358
359struct USBPacket {
360
361 int pid;
362 uint64_t id;
363 USBEndpoint *ep;
364 QEMUIOVector iov;
365 uint64_t parameter;
366 bool short_not_ok;
367 bool int_req;
368 int status;
369 int actual_length;
370
371 USBPacketState state;
372 USBCombinedPacket *combined;
373 QTAILQ_ENTRY(USBPacket) queue;
374 QTAILQ_ENTRY(USBPacket) combined_entry;
375};
376
377struct USBCombinedPacket {
378 USBPacket *first;
379 QTAILQ_HEAD(packets_head, USBPacket) packets;
380 QEMUIOVector iov;
381};
382
383void usb_packet_init(USBPacket *p);
384void usb_packet_set_state(USBPacket *p, USBPacketState state);
385void usb_packet_check_state(USBPacket *p, USBPacketState expected);
386void usb_packet_setup(USBPacket *p, int pid, USBEndpoint *ep, uint64_t id,
387 bool short_not_ok, bool int_req);
388void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
389int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
390void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
391void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
392void usb_packet_skip(USBPacket *p, size_t bytes);
393void usb_packet_cleanup(USBPacket *p);
394
395static inline bool usb_packet_is_inflight(USBPacket *p)
396{
397 return (p->state == USB_PACKET_QUEUED ||
398 p->state == USB_PACKET_ASYNC);
399}
400
401USBDevice *usb_find_device(USBPort *port, uint8_t addr);
402
403void usb_handle_packet(USBDevice *dev, USBPacket *p);
404void usb_packet_complete(USBDevice *dev, USBPacket *p);
405void usb_packet_complete_one(USBDevice *dev, USBPacket *p);
406void usb_cancel_packet(USBPacket * p);
407
408void usb_ep_init(USBDevice *dev);
409void usb_ep_reset(USBDevice *dev);
410void usb_ep_dump(USBDevice *dev);
411struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
412uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
413uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
414void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
415void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
416void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
417 uint16_t raw);
418int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
419void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);
420USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
421 uint64_t id);
422
423void usb_ep_combine_input_packets(USBEndpoint *ep);
424void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p);
425void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p);
426
427void usb_attach(USBPort *port);
428void usb_detach(USBPort *port);
429void usb_port_reset(USBPort *port);
430void usb_device_reset(USBDevice *dev);
431void usb_wakeup(USBEndpoint *ep);
432void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
433int set_usb_string(uint8_t *buf, const char *str);
434
435
436USBDevice *usb_host_device_open(USBBus *bus, const char *devname);
437int usb_host_device_close(const char *devname);
438void usb_host_info(Monitor *mon, const QDict *qdict);
439
440
441USBDevice *usb_bt_init(USBBus *bus, HCIInfo *hci);
442
443
444
445#define VM_USB_HUB_SIZE 8
446
447
448enum musb_irq_source_e {
449 musb_irq_suspend = 0,
450 musb_irq_resume,
451 musb_irq_rst_babble,
452 musb_irq_sof,
453 musb_irq_connect,
454 musb_irq_disconnect,
455 musb_irq_vbus_request,
456 musb_irq_vbus_error,
457 musb_irq_rx,
458 musb_irq_tx,
459 musb_set_vbus,
460 musb_set_session,
461
462 musb_irq_max,
463};
464
465typedef struct MUSBState MUSBState;
466MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
467void musb_reset(MUSBState *s);
468uint32_t musb_core_intr_get(MUSBState *s);
469void musb_core_intr_clear(MUSBState *s, uint32_t mask);
470void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
471
472
473
474#define TYPE_USB_BUS "usb-bus"
475#define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
476
477struct USBBus {
478 BusState qbus;
479 USBBusOps *ops;
480 int busnr;
481 int nfree;
482 int nused;
483 QTAILQ_HEAD(, USBPort) free;
484 QTAILQ_HEAD(, USBPort) used;
485 QTAILQ_ENTRY(USBBus) next;
486};
487
488struct USBBusOps {
489 int (*register_companion)(USBBus *bus, USBPort *ports[],
490 uint32_t portcount, uint32_t firstport);
491 void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep);
492};
493
494void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
495USBBus *usb_bus_find(int busnr);
496void usb_legacy_register(const char *typename, const char *usbdevice_name,
497 USBDevice *(*usbdevice_init)(USBBus *bus,
498 const char *params));
499USBDevice *usb_create(USBBus *bus, const char *name);
500USBDevice *usb_create_simple(USBBus *bus, const char *name);
501USBDevice *usbdevice_create(const char *cmdline);
502void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
503 USBPortOps *ops, int speedmask);
504int usb_register_companion(const char *masterbus, USBPort *ports[],
505 uint32_t portcount, uint32_t firstport,
506 void *opaque, USBPortOps *ops, int speedmask);
507void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
508void usb_unregister_port(USBBus *bus, USBPort *port);
509int usb_claim_port(USBDevice *dev);
510void usb_release_port(USBDevice *dev);
511int usb_device_attach(USBDevice *dev);
512int usb_device_detach(USBDevice *dev);
513int usb_device_delete_addr(int busnr, int addr);
514
515static inline USBBus *usb_bus_from_device(USBDevice *d)
516{
517 return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
518}
519
520extern const VMStateDescription vmstate_usb_device;
521
522#define VMSTATE_USB_DEVICE(_field, _state) { \
523 .name = (stringify(_field)), \
524 .size = sizeof(USBDevice), \
525 .vmsd = &vmstate_usb_device, \
526 .flags = VMS_STRUCT, \
527 .offset = vmstate_offset_value(_state, _field, USBDevice), \
528}
529
530USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
531
532void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
533
534void usb_device_handle_attach(USBDevice *dev);
535
536void usb_device_handle_reset(USBDevice *dev);
537
538void usb_device_handle_control(USBDevice *dev, USBPacket *p, int request,
539 int val, int index, int length, uint8_t *data);
540
541void usb_device_handle_data(USBDevice *dev, USBPacket *p);
542
543void usb_device_set_interface(USBDevice *dev, int interface,
544 int alt_old, int alt_new);
545
546void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);
547
548void usb_device_ep_stopped(USBDevice *dev, USBEndpoint *ep);
549
550const char *usb_device_get_product_desc(USBDevice *dev);
551
552const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
553
554int ehci_create_ich9_with_companions(PCIBus *bus, int slot);
555
556
557
558
559#define USB_QUIRK_BUFFER_BULK_IN 0x01
560
561#define USB_QUIRK_IS_FTDI 0x02
562
563int usb_get_quirks(uint16_t vendor_id, uint16_t product_id,
564 uint8_t interface_class, uint8_t interface_subclass,
565 uint8_t interface_protocol);
566
567#endif
568