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 VendorDeviceRequest ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
106 #define VendorDeviceOutRequest \
107 ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
109 #define InterfaceRequest \
110 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
111 #define InterfaceOutRequest \
112 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
113 #define ClassInterfaceRequest \
114 ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
115 #define ClassInterfaceOutRequest \
116 ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
117 #define VendorInterfaceRequest \
118 ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8)
119 #define VendorInterfaceOutRequest \
120 ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8)
122 #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
123 #define EndpointOutRequest \
124 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
126 #define USB_REQ_GET_STATUS 0x00
127 #define USB_REQ_CLEAR_FEATURE 0x01
128 #define USB_REQ_SET_FEATURE 0x03
129 #define USB_REQ_SET_ADDRESS 0x05
130 #define USB_REQ_GET_DESCRIPTOR 0x06
131 #define USB_REQ_SET_DESCRIPTOR 0x07
132 #define USB_REQ_GET_CONFIGURATION 0x08
133 #define USB_REQ_SET_CONFIGURATION 0x09
134 #define USB_REQ_GET_INTERFACE 0x0A
135 #define USB_REQ_SET_INTERFACE 0x0B
136 #define USB_REQ_SYNCH_FRAME 0x0C
138 #define USB_DEVICE_SELF_POWERED 0
139 #define USB_DEVICE_REMOTE_WAKEUP 1
141 #define USB_DT_DEVICE 0x01
142 #define USB_DT_CONFIG 0x02
143 #define USB_DT_STRING 0x03
144 #define USB_DT_INTERFACE 0x04
145 #define USB_DT_ENDPOINT 0x05
146 #define USB_DT_DEVICE_QUALIFIER 0x06
147 #define USB_DT_OTHER_SPEED_CONFIG 0x07
148 #define USB_DT_DEBUG 0x0A
149 #define USB_DT_INTERFACE_ASSOC 0x0B
150 #define USB_DT_BOS 0x0F
151 #define USB_DT_DEVICE_CAPABILITY 0x10
152 #define USB_DT_CS_INTERFACE 0x24
153 #define USB_DT_CS_ENDPOINT 0x25
154 #define USB_DT_ENDPOINT_COMPANION 0x30
156 #define USB_DEV_CAP_WIRELESS 0x01
157 #define USB_DEV_CAP_USB2_EXT 0x02
158 #define USB_DEV_CAP_SUPERSPEED 0x03
160 #define USB_ENDPOINT_XFER_CONTROL 0
161 #define USB_ENDPOINT_XFER_ISOC 1
162 #define USB_ENDPOINT_XFER_BULK 2
163 #define USB_ENDPOINT_XFER_INT 3
164 #define USB_ENDPOINT_XFER_INVALID 255
166 #define USB_INTERFACE_INVALID 255
168 typedef struct USBBus USBBus
;
169 typedef struct USBBusOps USBBusOps
;
170 typedef struct USBPort USBPort
;
171 typedef struct USBDevice USBDevice
;
172 typedef struct USBPacket USBPacket
;
173 typedef struct USBCombinedPacket USBCombinedPacket
;
174 typedef struct USBEndpoint USBEndpoint
;
176 typedef struct USBDesc USBDesc
;
177 typedef struct USBDescID USBDescID
;
178 typedef struct USBDescDevice USBDescDevice
;
179 typedef struct USBDescConfig USBDescConfig
;
180 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc
;
181 typedef struct USBDescIface USBDescIface
;
182 typedef struct USBDescEndpoint USBDescEndpoint
;
183 typedef struct USBDescOther USBDescOther
;
184 typedef struct USBDescString USBDescString
;
186 struct USBDescString
{
189 QLIST_ENTRY(USBDescString
) next
;
192 #define USB_MAX_ENDPOINTS 15
193 #define USB_MAX_INTERFACES 16
205 QTAILQ_HEAD(, USBPacket
) queue
;
208 enum USBDeviceFlags
{
209 USB_DEV_FLAG_FULL_PATH
,
210 USB_DEV_FLAG_IS_HOST
,
213 /* definition of a USB device */
222 /* Actual connected speed */
224 /* Supported speeds, not in info because it may be variable (hostdevs) */
227 char product_desc
[32];
232 uint8_t setup_buf
[8];
233 uint8_t data_buf
[4096];
234 int32_t remote_wakeup
;
240 USBEndpoint ep_in
[USB_MAX_ENDPOINTS
];
241 USBEndpoint ep_out
[USB_MAX_ENDPOINTS
];
243 QLIST_HEAD(, USBDescString
) strings
;
244 const USBDesc
*usb_desc
; /* Overrides class usb_desc if not NULL */
245 const USBDescDevice
*device
;
249 int altsetting
[USB_MAX_INTERFACES
];
250 const USBDescConfig
*config
;
251 const USBDescIface
*ifaces
[USB_MAX_INTERFACES
];
254 #define TYPE_USB_DEVICE "usb-device"
255 #define USB_DEVICE(obj) \
256 OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
257 #define USB_DEVICE_CLASS(klass) \
258 OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
259 #define USB_DEVICE_GET_CLASS(obj) \
260 OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
262 typedef struct USBDeviceClass
{
263 DeviceClass parent_class
;
265 int (*init
)(USBDevice
*dev
);
268 * Walk (enabled) downstream ports, check for a matching device.
269 * Only hubs implement this.
271 USBDevice
*(*find_device
)(USBDevice
*dev
, uint8_t addr
);
274 * Called when a packet is canceled.
276 void (*cancel_packet
)(USBDevice
*dev
, USBPacket
*p
);
279 * Called when device is destroyed.
281 void (*handle_destroy
)(USBDevice
*dev
);
286 void (*handle_attach
)(USBDevice
*dev
);
291 void (*handle_reset
)(USBDevice
*dev
);
294 * Process control request.
295 * Called from handle_packet().
297 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
298 * then the number of bytes transferred is stored in p->actual_length
300 void (*handle_control
)(USBDevice
*dev
, USBPacket
*p
, int request
, int value
,
301 int index
, int length
, uint8_t *data
);
304 * Process data transfers (both BULK and ISOC).
305 * Called from handle_packet().
307 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
308 * then the number of bytes transferred is stored in p->actual_length
310 void (*handle_data
)(USBDevice
*dev
, USBPacket
*p
);
312 void (*set_interface
)(USBDevice
*dev
, int interface
,
313 int alt_old
, int alt_new
);
316 * Called when the hcd is done queuing packets for an endpoint, only
317 * necessary for devices which can return USB_RET_ADD_TO_QUEUE.
319 void (*flush_ep_queue
)(USBDevice
*dev
, USBEndpoint
*ep
);
322 * Called by the hcd to let the device know the queue for an endpoint
323 * has been unlinked / stopped. Optional may be NULL.
325 void (*ep_stopped
)(USBDevice
*dev
, USBEndpoint
*ep
);
328 * Called by the hcd to alloc / free streams on a bulk endpoint.
329 * Optional may be NULL.
331 int (*alloc_streams
)(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
,
333 void (*free_streams
)(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
);
335 const char *product_desc
;
336 const USBDesc
*usb_desc
;
339 typedef struct USBPortOps
{
340 void (*attach
)(USBPort
*port
);
341 void (*detach
)(USBPort
*port
);
343 * This gets called when a device downstream from the device attached to
344 * the port (iow attached through a hub) gets detached.
346 void (*child_detach
)(USBPort
*port
, USBDevice
*child
);
347 void (*wakeup
)(USBPort
*port
);
349 * Note that port->dev will be different then the device from which
350 * the packet originated when a hub is involved.
352 void (*complete
)(USBPort
*port
, USBPacket
*p
);
355 /* USB port on which a device can be connected */
363 int index
; /* internal port index, may be used with the opaque */
364 QTAILQ_ENTRY(USBPort
) next
;
367 typedef void USBCallback(USBPacket
* packet
, void *opaque
);
369 typedef enum USBPacketState
{
370 USB_PACKET_UNDEFINED
= 0,
378 /* Structure used to hold information about an active USB packet. */
380 /* Data fields for use by the driver. */
386 uint64_t parameter
; /* control transfers */
389 int status
; /* USB_RET_* status code */
390 int actual_length
; /* Number of bytes actually transferred */
391 /* Internal use by the USB layer. */
392 USBPacketState state
;
393 USBCombinedPacket
*combined
;
394 QTAILQ_ENTRY(USBPacket
) queue
;
395 QTAILQ_ENTRY(USBPacket
) combined_entry
;
398 struct USBCombinedPacket
{
400 QTAILQ_HEAD(packets_head
, USBPacket
) packets
;
404 void usb_packet_init(USBPacket
*p
);
405 void usb_packet_set_state(USBPacket
*p
, USBPacketState state
);
406 void usb_packet_check_state(USBPacket
*p
, USBPacketState expected
);
407 void usb_packet_setup(USBPacket
*p
, int pid
,
408 USBEndpoint
*ep
, unsigned int stream
,
409 uint64_t id
, bool short_not_ok
, bool int_req
);
410 void usb_packet_addbuf(USBPacket
*p
, void *ptr
, size_t len
);
411 int usb_packet_map(USBPacket
*p
, QEMUSGList
*sgl
);
412 void usb_packet_unmap(USBPacket
*p
, QEMUSGList
*sgl
);
413 void usb_packet_copy(USBPacket
*p
, void *ptr
, size_t bytes
);
414 void usb_packet_skip(USBPacket
*p
, size_t bytes
);
415 size_t usb_packet_size(USBPacket
*p
);
416 void usb_packet_cleanup(USBPacket
*p
);
418 static inline bool usb_packet_is_inflight(USBPacket
*p
)
420 return (p
->state
== USB_PACKET_QUEUED
||
421 p
->state
== USB_PACKET_ASYNC
);
424 USBDevice
*usb_find_device(USBPort
*port
, uint8_t addr
);
426 void usb_handle_packet(USBDevice
*dev
, USBPacket
*p
);
427 void usb_packet_complete(USBDevice
*dev
, USBPacket
*p
);
428 void usb_packet_complete_one(USBDevice
*dev
, USBPacket
*p
);
429 void usb_cancel_packet(USBPacket
* p
);
431 void usb_ep_init(USBDevice
*dev
);
432 void usb_ep_reset(USBDevice
*dev
);
433 void usb_ep_dump(USBDevice
*dev
);
434 struct USBEndpoint
*usb_ep_get(USBDevice
*dev
, int pid
, int ep
);
435 uint8_t usb_ep_get_type(USBDevice
*dev
, int pid
, int ep
);
436 uint8_t usb_ep_get_ifnum(USBDevice
*dev
, int pid
, int ep
);
437 void usb_ep_set_type(USBDevice
*dev
, int pid
, int ep
, uint8_t type
);
438 void usb_ep_set_ifnum(USBDevice
*dev
, int pid
, int ep
, uint8_t ifnum
);
439 void usb_ep_set_max_packet_size(USBDevice
*dev
, int pid
, int ep
,
441 int usb_ep_get_max_packet_size(USBDevice
*dev
, int pid
, int ep
);
442 void usb_ep_set_max_streams(USBDevice
*dev
, int pid
, int ep
, uint8_t raw
);
443 int usb_ep_get_max_streams(USBDevice
*dev
, int pid
, int ep
);
444 void usb_ep_set_pipeline(USBDevice
*dev
, int pid
, int ep
, bool enabled
);
445 void usb_ep_set_halted(USBDevice
*dev
, int pid
, int ep
, bool halted
);
446 USBPacket
*usb_ep_find_packet_by_id(USBDevice
*dev
, int pid
, int ep
,
449 void usb_ep_combine_input_packets(USBEndpoint
*ep
);
450 void usb_combined_input_packet_complete(USBDevice
*dev
, USBPacket
*p
);
451 void usb_combined_packet_cancel(USBDevice
*dev
, USBPacket
*p
);
453 void usb_attach(USBPort
*port
);
454 void usb_detach(USBPort
*port
);
455 void usb_port_reset(USBPort
*port
);
456 void usb_device_reset(USBDevice
*dev
);
457 void usb_wakeup(USBEndpoint
*ep
, unsigned int stream
);
458 void usb_generic_async_ctrl_complete(USBDevice
*s
, USBPacket
*p
);
459 int set_usb_string(uint8_t *buf
, const char *str
);
462 USBDevice
*usb_host_device_open(USBBus
*bus
, const char *devname
);
463 void usb_host_info(Monitor
*mon
, const QDict
*qdict
);
465 /* usb ports of the VM */
467 #define VM_USB_HUB_SIZE 8
470 enum musb_irq_source_e
{
471 musb_irq_suspend
= 0,
477 musb_irq_vbus_request
,
483 /* Add new interrupts here */
484 musb_irq_max
, /* total number of interrupts defined */
487 typedef struct MUSBState MUSBState
;
488 MUSBState
*musb_init(DeviceState
*parent_device
, int gpio_base
);
489 void musb_reset(MUSBState
*s
);
490 uint32_t musb_core_intr_get(MUSBState
*s
);
491 void musb_core_intr_clear(MUSBState
*s
, uint32_t mask
);
492 void musb_set_size(MUSBState
*s
, int epnum
, int size
, int is_tx
);
496 #define TYPE_USB_BUS "usb-bus"
497 #define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
505 QTAILQ_HEAD(, USBPort
) free
;
506 QTAILQ_HEAD(, USBPort
) used
;
507 QTAILQ_ENTRY(USBBus
) next
;
511 int (*register_companion
)(USBBus
*bus
, USBPort
*ports
[],
512 uint32_t portcount
, uint32_t firstport
);
513 void (*wakeup_endpoint
)(USBBus
*bus
, USBEndpoint
*ep
, unsigned int stream
);
516 void usb_bus_new(USBBus
*bus
, size_t bus_size
,
517 USBBusOps
*ops
, DeviceState
*host
);
518 USBBus
*usb_bus_find(int busnr
);
519 void usb_legacy_register(const char *typename
, const char *usbdevice_name
,
520 USBDevice
*(*usbdevice_init
)(USBBus
*bus
,
521 const char *params
));
522 USBDevice
*usb_create(USBBus
*bus
, const char *name
);
523 USBDevice
*usb_create_simple(USBBus
*bus
, const char *name
);
524 USBDevice
*usbdevice_create(const char *cmdline
);
525 void usb_register_port(USBBus
*bus
, USBPort
*port
, void *opaque
, int index
,
526 USBPortOps
*ops
, int speedmask
);
527 int usb_register_companion(const char *masterbus
, USBPort
*ports
[],
528 uint32_t portcount
, uint32_t firstport
,
529 void *opaque
, USBPortOps
*ops
, int speedmask
);
530 void usb_port_location(USBPort
*downstream
, USBPort
*upstream
, int portnr
);
531 void usb_unregister_port(USBBus
*bus
, USBPort
*port
);
532 int usb_claim_port(USBDevice
*dev
);
533 void usb_release_port(USBDevice
*dev
);
534 int usb_device_attach(USBDevice
*dev
);
535 int usb_device_detach(USBDevice
*dev
);
536 int usb_device_delete_addr(int busnr
, int addr
);
538 static inline USBBus
*usb_bus_from_device(USBDevice
*d
)
540 return DO_UPCAST(USBBus
, qbus
, d
->qdev
.parent_bus
);
543 extern const VMStateDescription vmstate_usb_device
;
545 #define VMSTATE_USB_DEVICE(_field, _state) { \
546 .name = (stringify(_field)), \
547 .size = sizeof(USBDevice), \
548 .vmsd = &vmstate_usb_device, \
549 .flags = VMS_STRUCT, \
550 .offset = vmstate_offset_value(_state, _field, USBDevice), \
553 USBDevice
*usb_device_find_device(USBDevice
*dev
, uint8_t addr
);
555 void usb_device_cancel_packet(USBDevice
*dev
, USBPacket
*p
);
557 void usb_device_handle_attach(USBDevice
*dev
);
559 void usb_device_handle_reset(USBDevice
*dev
);
561 void usb_device_handle_control(USBDevice
*dev
, USBPacket
*p
, int request
,
562 int val
, int index
, int length
, uint8_t *data
);
564 void usb_device_handle_data(USBDevice
*dev
, USBPacket
*p
);
566 void usb_device_set_interface(USBDevice
*dev
, int interface
,
567 int alt_old
, int alt_new
);
569 void usb_device_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
);
571 void usb_device_ep_stopped(USBDevice
*dev
, USBEndpoint
*ep
);
573 int usb_device_alloc_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
,
575 void usb_device_free_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
);
577 const char *usb_device_get_product_desc(USBDevice
*dev
);
579 const USBDesc
*usb_device_get_usb_desc(USBDevice
*dev
);
581 int ehci_create_ich9_with_companions(PCIBus
*bus
, int slot
);
585 /* In bulk endpoints are streaming data sources (iow behave like isoc eps) */
586 #define USB_QUIRK_BUFFER_BULK_IN 0x01
587 /* Bulk pkts in FTDI format, need special handling when combining packets */
588 #define USB_QUIRK_IS_FTDI 0x02
590 int usb_get_quirks(uint16_t vendor_id
, uint16_t product_id
,
591 uint8_t interface_class
, uint8_t interface_subclass
,
592 uint8_t interface_protocol
);