7
* Copyright (c) 2005 Fabrice Bellard
9
* Permission is hereby granted, free of charge, to any person obtaining a copy
10
* of this software and associated documentation files (the "Software"), to deal
11
* in the Software without restriction, including without limitation the rights
12
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
* copies of the Software, and to permit persons to whom the Software is
14
* furnished to do so, subject to the following conditions:
16
* The above copyright notice and this permission notice shall be included in
17
* all copies or substantial portions of the Software.
19
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29
#include "qemu/queue.h"
31
/* Constants related to the USB / PCI interaction */
32
#define USB_SBRN 0x60 /* Serial Bus Release Number Register */
33
#define USB_RELEASE_1 0x10 /* USB 1.0 */
34
#define USB_RELEASE_2 0x20 /* USB 2.0 */
35
#define USB_RELEASE_3 0x30 /* USB 3.0 */
37
#define USB_TOKEN_SETUP 0x2d
38
#define USB_TOKEN_IN 0x69 /* device -> host */
39
#define USB_TOKEN_OUT 0xe1 /* host -> device */
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)
51
#define USB_SPEED_LOW 0
52
#define USB_SPEED_FULL 1
53
#define USB_SPEED_HIGH 2
54
#define USB_SPEED_SUPER 3
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)
61
#define USB_STATE_NOTATTACHED 0
62
#define USB_STATE_ATTACHED 1
63
//#define USB_STATE_POWERED 2
64
#define USB_STATE_DEFAULT 3
65
//#define USB_STATE_ADDRESS 4
66
//#define USB_STATE_CONFIGURED 5
67
#define USB_STATE_SUSPENDED 6
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
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
89
#define USB_DIR_IN 0x80
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)
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
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)
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
129
#define USB_DEVICE_SELF_POWERED 0
130
#define USB_DEVICE_REMOTE_WAKEUP 1
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
147
#define USB_DEV_CAP_WIRELESS 0x01
148
#define USB_DEV_CAP_USB2_EXT 0x02
149
#define USB_DEV_CAP_SUPERSPEED 0x03
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
157
#define USB_INTERFACE_INVALID 255
159
typedef struct USBBus USBBus;
160
typedef struct USBBusOps USBBusOps;
161
typedef struct USBPort USBPort;
162
typedef struct USBDevice USBDevice;
163
typedef struct USBPacket USBPacket;
164
typedef struct USBCombinedPacket USBCombinedPacket;
165
typedef struct USBEndpoint USBEndpoint;
167
typedef struct USBDesc USBDesc;
168
typedef struct USBDescID USBDescID;
169
typedef struct USBDescDevice USBDescDevice;
170
typedef struct USBDescConfig USBDescConfig;
171
typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
172
typedef struct USBDescIface USBDescIface;
173
typedef struct USBDescEndpoint USBDescEndpoint;
174
typedef struct USBDescOther USBDescOther;
175
typedef struct USBDescString USBDescString;
177
struct USBDescString {
180
QLIST_ENTRY(USBDescString) next;
183
#define USB_MAX_ENDPOINTS 15
184
#define USB_MAX_INTERFACES 16
195
QTAILQ_HEAD(, USBPacket) queue;
198
enum USBDeviceFlags {
199
USB_DEV_FLAG_FULL_PATH,
200
USB_DEV_FLAG_IS_HOST,
203
/* definition of a USB device */
211
/* Actual connected speed */
213
/* Supported speeds, not in info because it may be variable (hostdevs) */
216
char product_desc[32];
221
uint8_t setup_buf[8];
222
uint8_t data_buf[4096];
223
int32_t remote_wakeup;
229
USBEndpoint ep_in[USB_MAX_ENDPOINTS];
230
USBEndpoint ep_out[USB_MAX_ENDPOINTS];
232
QLIST_HEAD(, USBDescString) strings;
233
const USBDesc *usb_desc; /* Overrides class usb_desc if not NULL */
234
const USBDescDevice *device;
238
int altsetting[USB_MAX_INTERFACES];
239
const USBDescConfig *config;
240
const USBDescIface *ifaces[USB_MAX_INTERFACES];
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)
251
typedef struct USBDeviceClass {
252
DeviceClass parent_class;
254
int (*init)(USBDevice *dev);
257
* Walk (enabled) downstream ports, check for a matching device.
258
* Only hubs implement this.
260
USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
263
* Called when a packet is canceled.
265
void (*cancel_packet)(USBDevice *dev, USBPacket *p);
268
* Called when device is destroyed.
270
void (*handle_destroy)(USBDevice *dev);
275
void (*handle_attach)(USBDevice *dev);
280
void (*handle_reset)(USBDevice *dev);
283
* Process control request.
284
* Called from handle_packet().
286
* Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
287
* then the number of bytes transferred is stored in p->actual_length
289
void (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
290
int index, int length, uint8_t *data);
293
* Process data transfers (both BULK and ISOC).
294
* Called from handle_packet().
296
* Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
297
* then the number of bytes transferred is stored in p->actual_length
299
void (*handle_data)(USBDevice *dev, USBPacket *p);
301
void (*set_interface)(USBDevice *dev, int interface,
302
int alt_old, int alt_new);
305
* Called when the hcd is done queuing packets for an endpoint, only
306
* necessary for devices which can return USB_RET_ADD_TO_QUEUE.
308
void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);
311
* Called by the hcd to let the device know the queue for an endpoint
312
* has been unlinked / stopped. Optional may be NULL.
314
void (*ep_stopped)(USBDevice *dev, USBEndpoint *ep);
316
const char *product_desc;
317
const USBDesc *usb_desc;
320
typedef struct USBPortOps {
321
void (*attach)(USBPort *port);
322
void (*detach)(USBPort *port);
324
* This gets called when a device downstream from the device attached to
325
* the port (iow attached through a hub) gets detached.
327
void (*child_detach)(USBPort *port, USBDevice *child);
328
void (*wakeup)(USBPort *port);
330
* Note that port->dev will be different then the device from which
331
* the packet originated when a hub is involved.
333
void (*complete)(USBPort *port, USBPacket *p);
336
/* USB port on which a device can be connected */
344
int index; /* internal port index, may be used with the opaque */
345
QTAILQ_ENTRY(USBPort) next;
348
typedef void USBCallback(USBPacket * packet, void *opaque);
350
typedef enum USBPacketState {
351
USB_PACKET_UNDEFINED = 0,
359
/* Structure used to hold information about an active USB packet. */
361
/* Data fields for use by the driver. */
367
uint64_t parameter; /* control transfers */
370
int status; /* USB_RET_* status code */
371
int actual_length; /* Number of bytes actually transferred */
372
/* Internal use by the USB layer. */
373
USBPacketState state;
374
USBCombinedPacket *combined;
375
QTAILQ_ENTRY(USBPacket) queue;
376
QTAILQ_ENTRY(USBPacket) combined_entry;
379
struct USBCombinedPacket {
381
QTAILQ_HEAD(packets_head, USBPacket) packets;
385
void usb_packet_init(USBPacket *p);
386
void usb_packet_set_state(USBPacket *p, USBPacketState state);
387
void usb_packet_check_state(USBPacket *p, USBPacketState expected);
388
void usb_packet_setup(USBPacket *p, int pid,
389
USBEndpoint *ep, unsigned int stream,
390
uint64_t id, bool short_not_ok, bool int_req);
391
void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
392
int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
393
void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
394
void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
395
void usb_packet_skip(USBPacket *p, size_t bytes);
396
size_t usb_packet_size(USBPacket *p);
397
void usb_packet_cleanup(USBPacket *p);
399
static inline bool usb_packet_is_inflight(USBPacket *p)
401
return (p->state == USB_PACKET_QUEUED ||
402
p->state == USB_PACKET_ASYNC);
405
USBDevice *usb_find_device(USBPort *port, uint8_t addr);
407
void usb_handle_packet(USBDevice *dev, USBPacket *p);
408
void usb_packet_complete(USBDevice *dev, USBPacket *p);
409
void usb_packet_complete_one(USBDevice *dev, USBPacket *p);
410
void usb_cancel_packet(USBPacket * p);
412
void usb_ep_init(USBDevice *dev);
413
void usb_ep_reset(USBDevice *dev);
414
void usb_ep_dump(USBDevice *dev);
415
struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
416
uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
417
uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
418
void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
419
void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
420
void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
422
int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
423
void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);
424
void usb_ep_set_halted(USBDevice *dev, int pid, int ep, bool halted);
425
USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
428
void usb_ep_combine_input_packets(USBEndpoint *ep);
429
void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p);
430
void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p);
432
void usb_attach(USBPort *port);
433
void usb_detach(USBPort *port);
434
void usb_port_reset(USBPort *port);
435
void usb_device_reset(USBDevice *dev);
436
void usb_wakeup(USBEndpoint *ep, unsigned int stream);
437
void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
438
int set_usb_string(uint8_t *buf, const char *str);
441
USBDevice *usb_host_device_open(USBBus *bus, const char *devname);
442
void usb_host_info(Monitor *mon, const QDict *qdict);
445
USBDevice *usb_bt_init(USBBus *bus, HCIInfo *hci);
447
/* usb ports of the VM */
449
#define VM_USB_HUB_SIZE 8
452
enum musb_irq_source_e {
453
musb_irq_suspend = 0,
459
musb_irq_vbus_request,
465
/* Add new interrupts here */
466
musb_irq_max, /* total number of interrupts defined */
469
typedef struct MUSBState MUSBState;
470
MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
471
void musb_reset(MUSBState *s);
472
uint32_t musb_core_intr_get(MUSBState *s);
473
void musb_core_intr_clear(MUSBState *s, uint32_t mask);
474
void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
478
#define TYPE_USB_BUS "usb-bus"
479
#define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
487
QTAILQ_HEAD(, USBPort) free;
488
QTAILQ_HEAD(, USBPort) used;
489
QTAILQ_ENTRY(USBBus) next;
493
int (*register_companion)(USBBus *bus, USBPort *ports[],
494
uint32_t portcount, uint32_t firstport);
495
void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep, unsigned int stream);
498
void usb_bus_new(USBBus *bus, USBBusOps *ops, DeviceState *host);
499
USBBus *usb_bus_find(int busnr);
500
void usb_legacy_register(const char *typename, const char *usbdevice_name,
501
USBDevice *(*usbdevice_init)(USBBus *bus,
502
const char *params));
503
USBDevice *usb_create(USBBus *bus, const char *name);
504
USBDevice *usb_create_simple(USBBus *bus, const char *name);
505
USBDevice *usbdevice_create(const char *cmdline);
506
void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
507
USBPortOps *ops, int speedmask);
508
int usb_register_companion(const char *masterbus, USBPort *ports[],
509
uint32_t portcount, uint32_t firstport,
510
void *opaque, USBPortOps *ops, int speedmask);
511
void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
512
void usb_unregister_port(USBBus *bus, USBPort *port);
513
int usb_claim_port(USBDevice *dev);
514
void usb_release_port(USBDevice *dev);
515
int usb_device_attach(USBDevice *dev);
516
int usb_device_detach(USBDevice *dev);
517
int usb_device_delete_addr(int busnr, int addr);
519
static inline USBBus *usb_bus_from_device(USBDevice *d)
521
return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
524
extern const VMStateDescription vmstate_usb_device;
526
#define VMSTATE_USB_DEVICE(_field, _state) { \
527
.name = (stringify(_field)), \
528
.size = sizeof(USBDevice), \
529
.vmsd = &vmstate_usb_device, \
530
.flags = VMS_STRUCT, \
531
.offset = vmstate_offset_value(_state, _field, USBDevice), \
534
USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
536
void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
538
void usb_device_handle_attach(USBDevice *dev);
540
void usb_device_handle_reset(USBDevice *dev);
542
void usb_device_handle_control(USBDevice *dev, USBPacket *p, int request,
543
int val, int index, int length, uint8_t *data);
545
void usb_device_handle_data(USBDevice *dev, USBPacket *p);
547
void usb_device_set_interface(USBDevice *dev, int interface,
548
int alt_old, int alt_new);
550
void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);
552
void usb_device_ep_stopped(USBDevice *dev, USBEndpoint *ep);
554
const char *usb_device_get_product_desc(USBDevice *dev);
556
const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
558
int ehci_create_ich9_with_companions(PCIBus *bus, int slot);
562
/* In bulk endpoints are streaming data sources (iow behave like isoc eps) */
563
#define USB_QUIRK_BUFFER_BULK_IN 0x01
564
/* Bulk pkts in FTDI format, need special handling when combining packets */
565
#define USB_QUIRK_IS_FTDI 0x02
567
int usb_get_quirks(uint16_t vendor_id, uint16_t product_id,
568
uint8_t interface_class, uint8_t interface_subclass,
569
uint8_t interface_protocol);