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 "hw/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 char *serial;
209 void *opaque;
210 uint32_t flags;
211
212
213 int speed;
214
215 int speedmask;
216 uint8_t addr;
217 char product_desc[32];
218 int auto_attach;
219 int attached;
220
221 int32_t state;
222 uint8_t setup_buf[8];
223 uint8_t data_buf[4096];
224 int32_t remote_wakeup;
225 int32_t setup_state;
226 int32_t setup_len;
227 int32_t setup_index;
228
229 USBEndpoint ep_ctl;
230 USBEndpoint ep_in[USB_MAX_ENDPOINTS];
231 USBEndpoint ep_out[USB_MAX_ENDPOINTS];
232
233 QLIST_HEAD(, USBDescString) strings;
234 const USBDesc *usb_desc;
235 const USBDescDevice *device;
236
237 int configuration;
238 int ninterfaces;
239 int altsetting[USB_MAX_INTERFACES];
240 const USBDescConfig *config;
241 const USBDescIface *ifaces[USB_MAX_INTERFACES];
242};
243
244#define TYPE_USB_DEVICE "usb-device"
245#define USB_DEVICE(obj) \
246 OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
247#define USB_DEVICE_CLASS(klass) \
248 OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
249#define USB_DEVICE_GET_CLASS(obj) \
250 OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
251
252typedef struct USBDeviceClass {
253 DeviceClass parent_class;
254
255 int (*init)(USBDevice *dev);
256
257
258
259
260
261 USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
262
263
264
265
266 void (*cancel_packet)(USBDevice *dev, USBPacket *p);
267
268
269
270
271 void (*handle_destroy)(USBDevice *dev);
272
273
274
275
276 void (*handle_attach)(USBDevice *dev);
277
278
279
280
281 void (*handle_reset)(USBDevice *dev);
282
283
284
285
286
287
288
289
290 void (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
291 int index, int length, uint8_t *data);
292
293
294
295
296
297
298
299
300 void (*handle_data)(USBDevice *dev, USBPacket *p);
301
302 void (*set_interface)(USBDevice *dev, int interface,
303 int alt_old, int alt_new);
304
305
306
307
308
309 void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);
310
311
312
313
314
315 void (*ep_stopped)(USBDevice *dev, USBEndpoint *ep);
316
317 const char *product_desc;
318 const USBDesc *usb_desc;
319} USBDeviceClass;
320
321typedef struct USBPortOps {
322 void (*attach)(USBPort *port);
323 void (*detach)(USBPort *port);
324
325
326
327
328 void (*child_detach)(USBPort *port, USBDevice *child);
329 void (*wakeup)(USBPort *port);
330
331
332
333
334 void (*complete)(USBPort *port, USBPacket *p);
335} USBPortOps;
336
337
338struct USBPort {
339 USBDevice *dev;
340 int speedmask;
341 int hubcount;
342 char path[16];
343 USBPortOps *ops;
344 void *opaque;
345 int index;
346 QTAILQ_ENTRY(USBPort) next;
347};
348
349typedef void USBCallback(USBPacket * packet, void *opaque);
350
351typedef enum USBPacketState {
352 USB_PACKET_UNDEFINED = 0,
353 USB_PACKET_SETUP,
354 USB_PACKET_QUEUED,
355 USB_PACKET_ASYNC,
356 USB_PACKET_COMPLETE,
357 USB_PACKET_CANCELED,
358} USBPacketState;
359
360
361struct USBPacket {
362
363 int pid;
364 uint64_t id;
365 USBEndpoint *ep;
366 unsigned int stream;
367 QEMUIOVector iov;
368 uint64_t parameter;
369 bool short_not_ok;
370 bool int_req;
371 int status;
372 int actual_length;
373
374 USBPacketState state;
375 USBCombinedPacket *combined;
376 QTAILQ_ENTRY(USBPacket) queue;
377 QTAILQ_ENTRY(USBPacket) combined_entry;
378};
379
380struct USBCombinedPacket {
381 USBPacket *first;
382 QTAILQ_HEAD(packets_head, USBPacket) packets;
383 QEMUIOVector iov;
384};
385
386void usb_packet_init(USBPacket *p);
387void usb_packet_set_state(USBPacket *p, USBPacketState state);
388void usb_packet_check_state(USBPacket *p, USBPacketState expected);
389void usb_packet_setup(USBPacket *p, int pid,
390 USBEndpoint *ep, unsigned int stream,
391 uint64_t id, bool short_not_ok, bool int_req);
392void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
393int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
394void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
395void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
396void usb_packet_skip(USBPacket *p, size_t bytes);
397size_t usb_packet_size(USBPacket *p);
398void usb_packet_cleanup(USBPacket *p);
399
400static inline bool usb_packet_is_inflight(USBPacket *p)
401{
402 return (p->state == USB_PACKET_QUEUED ||
403 p->state == USB_PACKET_ASYNC);
404}
405
406USBDevice *usb_find_device(USBPort *port, uint8_t addr);
407
408void usb_handle_packet(USBDevice *dev, USBPacket *p);
409void usb_packet_complete(USBDevice *dev, USBPacket *p);
410void usb_packet_complete_one(USBDevice *dev, USBPacket *p);
411void usb_cancel_packet(USBPacket * p);
412
413void usb_ep_init(USBDevice *dev);
414void usb_ep_reset(USBDevice *dev);
415void usb_ep_dump(USBDevice *dev);
416struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
417uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
418uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
419void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
420void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
421void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
422 uint16_t raw);
423int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
424void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);
425void usb_ep_set_halted(USBDevice *dev, int pid, int ep, bool halted);
426USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
427 uint64_t id);
428
429void usb_ep_combine_input_packets(USBEndpoint *ep);
430void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p);
431void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p);
432
433void usb_attach(USBPort *port);
434void usb_detach(USBPort *port);
435void usb_port_reset(USBPort *port);
436void usb_device_reset(USBDevice *dev);
437void usb_wakeup(USBEndpoint *ep, unsigned int stream);
438void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
439int set_usb_string(uint8_t *buf, const char *str);
440
441
442USBDevice *usb_host_device_open(USBBus *bus, const char *devname);
443void usb_host_info(Monitor *mon, const QDict *qdict);
444
445
446USBDevice *usb_bt_init(USBBus *bus, HCIInfo *hci);
447
448
449
450#define VM_USB_HUB_SIZE 8
451
452
453enum musb_irq_source_e {
454 musb_irq_suspend = 0,
455 musb_irq_resume,
456 musb_irq_rst_babble,
457 musb_irq_sof,
458 musb_irq_connect,
459 musb_irq_disconnect,
460 musb_irq_vbus_request,
461 musb_irq_vbus_error,
462 musb_irq_rx,
463 musb_irq_tx,
464 musb_set_vbus,
465 musb_set_session,
466
467 musb_irq_max,
468};
469
470typedef struct MUSBState MUSBState;
471MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
472void musb_reset(MUSBState *s);
473uint32_t musb_core_intr_get(MUSBState *s);
474void musb_core_intr_clear(MUSBState *s, uint32_t mask);
475void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
476
477
478
479#define TYPE_USB_BUS "usb-bus"
480#define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
481
482struct USBBus {
483 BusState qbus;
484 USBBusOps *ops;
485 int busnr;
486 int nfree;
487 int nused;
488 QTAILQ_HEAD(, USBPort) free;
489 QTAILQ_HEAD(, USBPort) used;
490 QTAILQ_ENTRY(USBBus) next;
491};
492
493struct USBBusOps {
494 int (*register_companion)(USBBus *bus, USBPort *ports[],
495 uint32_t portcount, uint32_t firstport);
496 void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep, unsigned int stream);
497};
498
499void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
500USBBus *usb_bus_find(int busnr);
501void usb_legacy_register(const char *typename, const char *usbdevice_name,
502 USBDevice *(*usbdevice_init)(USBBus *bus,
503 const char *params));
504USBDevice *usb_create(USBBus *bus, const char *name);
505USBDevice *usb_create_simple(USBBus *bus, const char *name);
506USBDevice *usbdevice_create(const char *cmdline);
507void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
508 USBPortOps *ops, int speedmask);
509int usb_register_companion(const char *masterbus, USBPort *ports[],
510 uint32_t portcount, uint32_t firstport,
511 void *opaque, USBPortOps *ops, int speedmask);
512void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
513void usb_unregister_port(USBBus *bus, USBPort *port);
514int usb_claim_port(USBDevice *dev);
515void usb_release_port(USBDevice *dev);
516int usb_device_attach(USBDevice *dev);
517int usb_device_detach(USBDevice *dev);
518int usb_device_delete_addr(int busnr, int addr);
519
520static inline USBBus *usb_bus_from_device(USBDevice *d)
521{
522 return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
523}
524
525extern const VMStateDescription vmstate_usb_device;
526
527#define VMSTATE_USB_DEVICE(_field, _state) { \
528 .name = (stringify(_field)), \
529 .size = sizeof(USBDevice), \
530 .vmsd = &vmstate_usb_device, \
531 .flags = VMS_STRUCT, \
532 .offset = vmstate_offset_value(_state, _field, USBDevice), \
533}
534
535USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
536
537void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
538
539void usb_device_handle_attach(USBDevice *dev);
540
541void usb_device_handle_reset(USBDevice *dev);
542
543void usb_device_handle_control(USBDevice *dev, USBPacket *p, int request,
544 int val, int index, int length, uint8_t *data);
545
546void usb_device_handle_data(USBDevice *dev, USBPacket *p);
547
548void usb_device_set_interface(USBDevice *dev, int interface,
549 int alt_old, int alt_new);
550
551void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);
552
553void usb_device_ep_stopped(USBDevice *dev, USBEndpoint *ep);
554
555const char *usb_device_get_product_desc(USBDevice *dev);
556
557const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
558
559int ehci_create_ich9_with_companions(PCIBus *bus, int slot);
560
561
562
563
564#define USB_QUIRK_BUFFER_BULK_IN 0x01
565
566#define USB_QUIRK_IS_FTDI 0x02
567
568int usb_get_quirks(uint16_t vendor_id, uint16_t product_id,
569 uint8_t interface_class, uint8_t interface_subclass,
570 uint8_t interface_protocol);
571
572#endif
573