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
28 #include "exec/memory.h"
29 #include "hw/qdev-core.h"
31 #include "qemu/queue.h"
33 /* Constants related to the USB / PCI interaction */
34 #define USB_SBRN 0x60 /* Serial Bus Release Number Register */
35 #define USB_RELEASE_1 0x10 /* USB 1.0 */
36 #define USB_RELEASE_2 0x20 /* USB 2.0 */
37 #define USB_RELEASE_3 0x30 /* USB 3.0 */
39 #define USB_TOKEN_SETUP 0x2d
40 #define USB_TOKEN_IN 0x69 /* device -> host */
41 #define USB_TOKEN_OUT 0xe1 /* host -> device */
43 #define USB_RET_SUCCESS (0)
44 #define USB_RET_NODEV (-1)
45 #define USB_RET_NAK (-2)
46 #define USB_RET_STALL (-3)
47 #define USB_RET_BABBLE (-4)
48 #define USB_RET_IOERROR (-5)
49 #define USB_RET_ASYNC (-6)
50 #define USB_RET_ADD_TO_QUEUE (-7)
51 #define USB_RET_REMOVE_FROM_QUEUE (-8)
53 #define USB_SPEED_LOW 0
54 #define USB_SPEED_FULL 1
55 #define USB_SPEED_HIGH 2
56 #define USB_SPEED_SUPER 3
58 #define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW)
59 #define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL)
60 #define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH)
61 #define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
63 #define USB_STATE_NOTATTACHED 0
64 #define USB_STATE_ATTACHED 1
65 //#define USB_STATE_POWERED 2
66 #define USB_STATE_DEFAULT 3
67 //#define USB_STATE_ADDRESS 4
68 //#define USB_STATE_CONFIGURED 5
69 #define USB_STATE_SUSPENDED 6
71 #define USB_CLASS_AUDIO 1
72 #define USB_CLASS_COMM 2
73 #define USB_CLASS_HID 3
74 #define USB_CLASS_PHYSICAL 5
75 #define USB_CLASS_STILL_IMAGE 6
76 #define USB_CLASS_PRINTER 7
77 #define USB_CLASS_MASS_STORAGE 8
78 #define USB_CLASS_HUB 9
79 #define USB_CLASS_CDC_DATA 0x0a
80 #define USB_CLASS_CSCID 0x0b
81 #define USB_CLASS_CONTENT_SEC 0x0d
82 #define USB_CLASS_APP_SPEC 0xfe
83 #define USB_CLASS_VENDOR_SPEC 0xff
85 #define USB_SUBCLASS_UNDEFINED 0
86 #define USB_SUBCLASS_AUDIO_CONTROL 1
87 #define USB_SUBCLASS_AUDIO_STREAMING 2
88 #define USB_SUBCLASS_AUDIO_MIDISTREAMING 3
91 #define USB_DIR_IN 0x80
93 #define USB_TYPE_MASK (0x03 << 5)
94 #define USB_TYPE_STANDARD (0x00 << 5)
95 #define USB_TYPE_CLASS (0x01 << 5)
96 #define USB_TYPE_VENDOR (0x02 << 5)
97 #define USB_TYPE_RESERVED (0x03 << 5)
99 #define USB_RECIP_MASK 0x1f
100 #define USB_RECIP_DEVICE 0x00
101 #define USB_RECIP_INTERFACE 0x01
102 #define USB_RECIP_ENDPOINT 0x02
103 #define USB_RECIP_OTHER 0x03
105 #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
106 #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
107 #define VendorDeviceRequest ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
108 #define VendorDeviceOutRequest \
109 ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
111 #define InterfaceRequest \
112 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
113 #define InterfaceOutRequest \
114 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
115 #define ClassInterfaceRequest \
116 ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
117 #define ClassInterfaceOutRequest \
118 ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
119 #define VendorInterfaceRequest \
120 ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8)
121 #define VendorInterfaceOutRequest \
122 ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8)
124 #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
125 #define EndpointOutRequest \
126 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
128 #define USB_REQ_GET_STATUS 0x00
129 #define USB_REQ_CLEAR_FEATURE 0x01
130 #define USB_REQ_SET_FEATURE 0x03
131 #define USB_REQ_SET_ADDRESS 0x05
132 #define USB_REQ_GET_DESCRIPTOR 0x06
133 #define USB_REQ_SET_DESCRIPTOR 0x07
134 #define USB_REQ_GET_CONFIGURATION 0x08
135 #define USB_REQ_SET_CONFIGURATION 0x09
136 #define USB_REQ_GET_INTERFACE 0x0A
137 #define USB_REQ_SET_INTERFACE 0x0B
138 #define USB_REQ_SYNCH_FRAME 0x0C
139 #define USB_REQ_SET_SEL 0x30
140 #define USB_REQ_SET_ISOCH_DELAY 0x31
142 #define USB_DEVICE_SELF_POWERED 0
143 #define USB_DEVICE_REMOTE_WAKEUP 1
145 #define USB_DT_DEVICE 0x01
146 #define USB_DT_CONFIG 0x02
147 #define USB_DT_STRING 0x03
148 #define USB_DT_INTERFACE 0x04
149 #define USB_DT_ENDPOINT 0x05
150 #define USB_DT_DEVICE_QUALIFIER 0x06
151 #define USB_DT_OTHER_SPEED_CONFIG 0x07
152 #define USB_DT_DEBUG 0x0A
153 #define USB_DT_INTERFACE_ASSOC 0x0B
154 #define USB_DT_BOS 0x0F
155 #define USB_DT_DEVICE_CAPABILITY 0x10
156 #define USB_DT_CS_INTERFACE 0x24
157 #define USB_DT_CS_ENDPOINT 0x25
158 #define USB_DT_ENDPOINT_COMPANION 0x30
160 #define USB_DEV_CAP_WIRELESS 0x01
161 #define USB_DEV_CAP_USB2_EXT 0x02
162 #define USB_DEV_CAP_SUPERSPEED 0x03
164 #define USB_CFG_ATT_ONE (1 << 7) /* should always be set */
165 #define USB_CFG_ATT_SELFPOWER (1 << 6)
166 #define USB_CFG_ATT_WAKEUP (1 << 5)
167 #define USB_CFG_ATT_BATTERY (1 << 4)
169 #define USB_ENDPOINT_XFER_CONTROL 0
170 #define USB_ENDPOINT_XFER_ISOC 1
171 #define USB_ENDPOINT_XFER_BULK 2
172 #define USB_ENDPOINT_XFER_INT 3
173 #define USB_ENDPOINT_XFER_INVALID 255
175 #define USB_INTERFACE_INVALID 255
177 typedef struct USBBus USBBus
;
178 typedef struct USBBusOps USBBusOps
;
179 typedef struct USBPort USBPort
;
180 typedef struct USBDevice USBDevice
;
181 typedef struct USBPacket USBPacket
;
182 typedef struct USBCombinedPacket USBCombinedPacket
;
183 typedef struct USBEndpoint USBEndpoint
;
185 typedef struct USBDesc USBDesc
;
186 typedef struct USBDescID USBDescID
;
187 typedef struct USBDescDevice USBDescDevice
;
188 typedef struct USBDescConfig USBDescConfig
;
189 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc
;
190 typedef struct USBDescIface USBDescIface
;
191 typedef struct USBDescEndpoint USBDescEndpoint
;
192 typedef struct USBDescOther USBDescOther
;
193 typedef struct USBDescString USBDescString
;
194 typedef struct USBDescMSOS USBDescMSOS
;
196 struct USBDescString
{
199 QLIST_ENTRY(USBDescString
) next
;
202 #define USB_MAX_ENDPOINTS 15
203 #define USB_MAX_INTERFACES 16
215 QTAILQ_HEAD(, USBPacket
) queue
;
218 enum USBDeviceFlags
{
219 USB_DEV_FLAG_FULL_PATH
,
220 USB_DEV_FLAG_IS_HOST
,
221 USB_DEV_FLAG_MSOS_DESC_ENABLE
,
222 USB_DEV_FLAG_MSOS_DESC_IN_USE
,
225 /* definition of a USB device */
234 /* Actual connected speed */
236 /* Supported speeds, not in info because it may be variable (hostdevs) */
239 char product_desc
[32];
244 uint8_t setup_buf
[8];
245 uint8_t data_buf
[4096];
246 int32_t remote_wakeup
;
252 USBEndpoint ep_in
[USB_MAX_ENDPOINTS
];
253 USBEndpoint ep_out
[USB_MAX_ENDPOINTS
];
255 QLIST_HEAD(, USBDescString
) strings
;
256 const USBDesc
*usb_desc
; /* Overrides class usb_desc if not NULL */
257 const USBDescDevice
*device
;
261 int altsetting
[USB_MAX_INTERFACES
];
262 const USBDescConfig
*config
;
263 const USBDescIface
*ifaces
[USB_MAX_INTERFACES
];
266 #define TYPE_USB_DEVICE "usb-device"
267 #define USB_DEVICE(obj) \
268 OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
269 #define USB_DEVICE_CLASS(klass) \
270 OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
271 #define USB_DEVICE_GET_CLASS(obj) \
272 OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
274 typedef void (*USBDeviceRealize
)(USBDevice
*dev
, Error
**errp
);
275 typedef void (*USBDeviceUnrealize
)(USBDevice
*dev
);
277 typedef struct USBDeviceClass
{
278 DeviceClass parent_class
;
280 USBDeviceRealize realize
;
281 USBDeviceUnrealize unrealize
;
284 * Walk (enabled) downstream ports, check for a matching device.
285 * Only hubs implement this.
287 USBDevice
*(*find_device
)(USBDevice
*dev
, uint8_t addr
);
290 * Called when a packet is canceled.
292 void (*cancel_packet
)(USBDevice
*dev
, USBPacket
*p
);
297 void (*handle_attach
)(USBDevice
*dev
);
302 void (*handle_reset
)(USBDevice
*dev
);
305 * Process control request.
306 * Called from handle_packet().
308 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
309 * then the number of bytes transferred is stored in p->actual_length
311 void (*handle_control
)(USBDevice
*dev
, USBPacket
*p
, int request
, int value
,
312 int index
, int length
, uint8_t *data
);
315 * Process data transfers (both BULK and ISOC).
316 * Called from handle_packet().
318 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
319 * then the number of bytes transferred is stored in p->actual_length
321 void (*handle_data
)(USBDevice
*dev
, USBPacket
*p
);
323 void (*set_interface
)(USBDevice
*dev
, int interface
,
324 int alt_old
, int alt_new
);
327 * Called when the hcd is done queuing packets for an endpoint, only
328 * necessary for devices which can return USB_RET_ADD_TO_QUEUE.
330 void (*flush_ep_queue
)(USBDevice
*dev
, USBEndpoint
*ep
);
333 * Called by the hcd to let the device know the queue for an endpoint
334 * has been unlinked / stopped. Optional may be NULL.
336 void (*ep_stopped
)(USBDevice
*dev
, USBEndpoint
*ep
);
339 * Called by the hcd to alloc / free streams on a bulk endpoint.
340 * Optional may be NULL.
342 int (*alloc_streams
)(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
,
344 void (*free_streams
)(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
);
346 const char *product_desc
;
347 const USBDesc
*usb_desc
;
348 bool attached_settable
;
351 typedef struct USBPortOps
{
352 void (*attach
)(USBPort
*port
);
353 void (*detach
)(USBPort
*port
);
355 * This gets called when a device downstream from the device attached to
356 * the port (iow attached through a hub) gets detached.
358 void (*child_detach
)(USBPort
*port
, USBDevice
*child
);
359 void (*wakeup
)(USBPort
*port
);
361 * Note that port->dev will be different then the device from which
362 * the packet originated when a hub is involved.
364 void (*complete
)(USBPort
*port
, USBPacket
*p
);
367 /* USB port on which a device can be connected */
375 int index
; /* internal port index, may be used with the opaque */
376 QTAILQ_ENTRY(USBPort
) next
;
379 typedef void USBCallback(USBPacket
* packet
, void *opaque
);
381 typedef enum USBPacketState
{
382 USB_PACKET_UNDEFINED
= 0,
390 /* Structure used to hold information about an active USB packet. */
392 /* Data fields for use by the driver. */
398 uint64_t parameter
; /* control transfers */
401 int status
; /* USB_RET_* status code */
402 int actual_length
; /* Number of bytes actually transferred */
403 /* Internal use by the USB layer. */
404 USBPacketState state
;
405 USBCombinedPacket
*combined
;
406 QTAILQ_ENTRY(USBPacket
) queue
;
407 QTAILQ_ENTRY(USBPacket
) combined_entry
;
410 struct USBCombinedPacket
{
412 QTAILQ_HEAD(, USBPacket
) packets
;
416 void usb_packet_init(USBPacket
*p
);
417 void usb_packet_set_state(USBPacket
*p
, USBPacketState state
);
418 void usb_packet_check_state(USBPacket
*p
, USBPacketState expected
);
419 void usb_packet_setup(USBPacket
*p
, int pid
,
420 USBEndpoint
*ep
, unsigned int stream
,
421 uint64_t id
, bool short_not_ok
, bool int_req
);
422 void usb_packet_addbuf(USBPacket
*p
, void *ptr
, size_t len
);
423 int usb_packet_map(USBPacket
*p
, QEMUSGList
*sgl
);
424 void usb_packet_unmap(USBPacket
*p
, QEMUSGList
*sgl
);
425 void usb_packet_copy(USBPacket
*p
, void *ptr
, size_t bytes
);
426 void usb_packet_skip(USBPacket
*p
, size_t bytes
);
427 size_t usb_packet_size(USBPacket
*p
);
428 void usb_packet_cleanup(USBPacket
*p
);
430 static inline bool usb_packet_is_inflight(USBPacket
*p
)
432 return (p
->state
== USB_PACKET_QUEUED
||
433 p
->state
== USB_PACKET_ASYNC
);
436 USBDevice
*usb_find_device(USBPort
*port
, uint8_t addr
);
438 void usb_handle_packet(USBDevice
*dev
, USBPacket
*p
);
439 void usb_packet_complete(USBDevice
*dev
, USBPacket
*p
);
440 void usb_packet_complete_one(USBDevice
*dev
, USBPacket
*p
);
441 void usb_cancel_packet(USBPacket
* p
);
443 void usb_ep_init(USBDevice
*dev
);
444 void usb_ep_reset(USBDevice
*dev
);
445 void usb_ep_dump(USBDevice
*dev
);
446 struct USBEndpoint
*usb_ep_get(USBDevice
*dev
, int pid
, int ep
);
447 uint8_t usb_ep_get_type(USBDevice
*dev
, int pid
, int ep
);
448 void usb_ep_set_type(USBDevice
*dev
, int pid
, int ep
, uint8_t type
);
449 void usb_ep_set_ifnum(USBDevice
*dev
, int pid
, int ep
, uint8_t ifnum
);
450 void usb_ep_set_max_packet_size(USBDevice
*dev
, int pid
, int ep
,
452 void usb_ep_set_max_streams(USBDevice
*dev
, int pid
, int ep
, uint8_t raw
);
453 void usb_ep_set_halted(USBDevice
*dev
, int pid
, int ep
, bool halted
);
454 USBPacket
*usb_ep_find_packet_by_id(USBDevice
*dev
, int pid
, int ep
,
457 void usb_ep_combine_input_packets(USBEndpoint
*ep
);
458 void usb_combined_input_packet_complete(USBDevice
*dev
, USBPacket
*p
);
459 void usb_combined_packet_cancel(USBDevice
*dev
, USBPacket
*p
);
461 void usb_pick_speed(USBPort
*port
);
462 void usb_attach(USBPort
*port
);
463 void usb_detach(USBPort
*port
);
464 void usb_port_reset(USBPort
*port
);
465 void usb_device_reset(USBDevice
*dev
);
466 void usb_wakeup(USBEndpoint
*ep
, unsigned int stream
);
467 void usb_generic_async_ctrl_complete(USBDevice
*s
, USBPacket
*p
);
470 void hmp_info_usbhost(Monitor
*mon
, const QDict
*qdict
);
471 bool usb_host_dev_is_scsi_storage(USBDevice
*usbdev
);
473 /* usb ports of the VM */
475 #define VM_USB_HUB_SIZE 8
479 #define TYPE_USB_BUS "usb-bus"
480 #define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
488 QTAILQ_HEAD(, USBPort
) free
;
489 QTAILQ_HEAD(, USBPort
) used
;
490 QTAILQ_ENTRY(USBBus
) next
;
494 void (*register_companion
)(USBBus
*bus
, USBPort
*ports
[],
495 uint32_t portcount
, uint32_t firstport
,
497 void (*wakeup_endpoint
)(USBBus
*bus
, USBEndpoint
*ep
, unsigned int stream
);
500 void usb_bus_new(USBBus
*bus
, size_t bus_size
,
501 USBBusOps
*ops
, DeviceState
*host
);
502 void usb_bus_release(USBBus
*bus
);
503 USBBus
*usb_bus_find(int busnr
);
504 void usb_legacy_register(const char *typename
, const char *usbdevice_name
,
505 USBDevice
*(*usbdevice_init
)(const char *params
));
506 USBDevice
*usb_new(const char *name
);
507 bool usb_realize_and_unref(USBDevice
*dev
, USBBus
*bus
, Error
**errp
);
508 USBDevice
*usb_create_simple(USBBus
*bus
, const char *name
);
509 USBDevice
*usbdevice_create(const char *cmdline
);
510 void usb_register_port(USBBus
*bus
, USBPort
*port
, void *opaque
, int index
,
511 USBPortOps
*ops
, int speedmask
);
512 void usb_register_companion(const char *masterbus
, USBPort
*ports
[],
513 uint32_t portcount
, uint32_t firstport
,
514 void *opaque
, USBPortOps
*ops
, int speedmask
,
516 void usb_port_location(USBPort
*downstream
, USBPort
*upstream
, int portnr
);
517 void usb_unregister_port(USBBus
*bus
, USBPort
*port
);
518 void usb_claim_port(USBDevice
*dev
, Error
**errp
);
519 void usb_release_port(USBDevice
*dev
);
520 void usb_device_attach(USBDevice
*dev
, Error
**errp
);
521 int usb_device_detach(USBDevice
*dev
);
522 void usb_check_attach(USBDevice
*dev
, Error
**errp
);
524 static inline USBBus
*usb_bus_from_device(USBDevice
*d
)
526 return DO_UPCAST(USBBus
, qbus
, d
->qdev
.parent_bus
);
529 extern const VMStateDescription vmstate_usb_device
;
531 #define VMSTATE_USB_DEVICE(_field, _state) { \
532 .name = (stringify(_field)), \
533 .size = sizeof(USBDevice), \
534 .vmsd = &vmstate_usb_device, \
535 .flags = VMS_STRUCT, \
536 .offset = vmstate_offset_value(_state, _field, USBDevice), \
539 USBDevice
*usb_device_find_device(USBDevice
*dev
, uint8_t addr
);
541 void usb_device_cancel_packet(USBDevice
*dev
, USBPacket
*p
);
543 void usb_device_handle_attach(USBDevice
*dev
);
545 void usb_device_handle_reset(USBDevice
*dev
);
547 void usb_device_handle_control(USBDevice
*dev
, USBPacket
*p
, int request
,
548 int val
, int index
, int length
, uint8_t *data
);
550 void usb_device_handle_data(USBDevice
*dev
, USBPacket
*p
);
552 void usb_device_set_interface(USBDevice
*dev
, int interface
,
553 int alt_old
, int alt_new
);
555 void usb_device_flush_ep_queue(USBDevice
*dev
, USBEndpoint
*ep
);
557 void usb_device_ep_stopped(USBDevice
*dev
, USBEndpoint
*ep
);
559 int usb_device_alloc_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
,
561 void usb_device_free_streams(USBDevice
*dev
, USBEndpoint
**eps
, int nr_eps
);
563 const char *usb_device_get_product_desc(USBDevice
*dev
);
565 const USBDesc
*usb_device_get_usb_desc(USBDevice
*dev
);
569 /* In bulk endpoints are streaming data sources (iow behave like isoc eps) */
570 #define USB_QUIRK_BUFFER_BULK_IN 0x01
571 /* Bulk pkts in FTDI format, need special handling when combining packets */
572 #define USB_QUIRK_IS_FTDI 0x02
574 int usb_get_quirks(uint16_t vendor_id
, uint16_t product_id
,
575 uint8_t interface_class
, uint8_t interface_subclass
,
576 uint8_t interface_protocol
);