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
30 #include "qemu-queue.h"
32 /* Constants related to the USB / PCI interaction */
33 #define USB_SBRN 0x60 /* Serial Bus Release Number Register */
34 #define USB_RELEASE_1 0x10 /* USB 1.0 */
35 #define USB_RELEASE_2 0x20 /* USB 2.0 */
36 #define USB_RELEASE_3 0x30 /* USB 3.0 */
38 #define USB_TOKEN_SETUP 0x2d
39 #define USB_TOKEN_IN 0x69 /* device -> host */
40 #define USB_TOKEN_OUT 0xe1 /* host -> device */
42 /* specific usb messages, also sent in the 'pid' parameter */
43 #define USB_MSG_RESET 0x102
45 #define USB_RET_NODEV (-1)
46 #define USB_RET_NAK (-2)
47 #define USB_RET_STALL (-3)
48 #define USB_RET_BABBLE (-4)
49 #define USB_RET_ASYNC (-5)
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_CS_INTERFACE 0x24
142 #define USB_DT_CS_ENDPOINT 0x25
144 #define USB_ENDPOINT_XFER_CONTROL 0
145 #define USB_ENDPOINT_XFER_ISOC 1
146 #define USB_ENDPOINT_XFER_BULK 2
147 #define USB_ENDPOINT_XFER_INT 3
148 #define USB_ENDPOINT_XFER_INVALID 255
150 typedef struct USBBus USBBus
;
151 typedef struct USBBusOps USBBusOps
;
152 typedef struct USBPort USBPort
;
153 typedef struct USBDevice USBDevice
;
154 typedef struct USBPacket USBPacket
;
155 typedef struct USBEndpoint USBEndpoint
;
157 typedef struct USBDesc USBDesc
;
158 typedef struct USBDescID USBDescID
;
159 typedef struct USBDescDevice USBDescDevice
;
160 typedef struct USBDescConfig USBDescConfig
;
161 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc
;
162 typedef struct USBDescIface USBDescIface
;
163 typedef struct USBDescEndpoint USBDescEndpoint
;
164 typedef struct USBDescOther USBDescOther
;
165 typedef struct USBDescString USBDescString
;
167 struct USBDescString
{
170 QLIST_ENTRY(USBDescString
) next
;
173 #define USB_MAX_ENDPOINTS 15
174 #define USB_MAX_INTERFACES 16
183 /* definition of a USB device */
190 /* Actual connected speed */
192 /* Supported speeds, not in info because it may be variable (hostdevs) */
195 char product_desc
[32];
200 uint8_t setup_buf
[8];
201 uint8_t data_buf
[4096];
202 int32_t remote_wakeup
;
208 USBEndpoint ep_in
[USB_MAX_ENDPOINTS
];
209 USBEndpoint ep_out
[USB_MAX_ENDPOINTS
];
211 QLIST_HEAD(, USBDescString
) strings
;
212 const USBDescDevice
*device
;
216 int altsetting
[USB_MAX_INTERFACES
];
217 const USBDescConfig
*config
;
218 const USBDescIface
*ifaces
[USB_MAX_INTERFACES
];
221 #define TYPE_USB_DEVICE "usb-device"
222 #define USB_DEVICE(obj) \
223 OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
224 #define USB_DEVICE_CLASS(klass) \
225 OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
226 #define USB_DEVICE_GET_CLASS(obj) \
227 OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
229 typedef struct USBDeviceClass
{
230 DeviceClass parent_class
;
232 int (*init
)(USBDevice
*dev
);
235 * Process USB packet.
236 * Called by the HC (Host Controller).
238 * Returns length of the transaction
239 * or one of the USB_RET_XXX codes.
241 int (*handle_packet
)(USBDevice
*dev
, USBPacket
*p
);
244 * Called when a packet is canceled.
246 void (*cancel_packet
)(USBDevice
*dev
, USBPacket
*p
);
249 * Called when device is destroyed.
251 void (*handle_destroy
)(USBDevice
*dev
);
256 void (*handle_attach
)(USBDevice
*dev
);
261 void (*handle_reset
)(USBDevice
*dev
);
264 * Process control request.
265 * Called from handle_packet().
267 * Returns length or one of the USB_RET_ codes.
269 int (*handle_control
)(USBDevice
*dev
, USBPacket
*p
, int request
, int value
,
270 int index
, int length
, uint8_t *data
);
273 * Process data transfers (both BULK and ISOC).
274 * Called from handle_packet().
276 * Returns length or one of the USB_RET_ codes.
278 int (*handle_data
)(USBDevice
*dev
, USBPacket
*p
);
280 void (*set_interface
)(USBDevice
*dev
, int interface
,
281 int alt_old
, int alt_new
);
283 const char *product_desc
;
284 const USBDesc
*usb_desc
;
287 typedef struct USBPortOps
{
288 void (*attach
)(USBPort
*port
);
289 void (*detach
)(USBPort
*port
);
291 * This gets called when a device downstream from the device attached to
292 * the port (iow attached through a hub) gets detached.
294 void (*child_detach
)(USBPort
*port
, USBDevice
*child
);
295 void (*wakeup
)(USBPort
*port
);
297 * Note that port->dev will be different then the device from which
298 * the packet originated when a hub is involved, if you want the orginating
299 * device use p->owner
301 void (*complete
)(USBPort
*port
, USBPacket
*p
);
304 /* USB port on which a device can be connected */
311 int index
; /* internal port index, may be used with the opaque */
312 QTAILQ_ENTRY(USBPort
) next
;
315 typedef void USBCallback(USBPacket
* packet
, void *opaque
);
317 /* Structure used to hold information about an active USB packet. */
319 /* Data fields for use by the driver. */
324 int result
; /* transfer length or USB_RET_* status code */
325 /* Internal use by the USB layer. */
329 void usb_packet_init(USBPacket
*p
);
330 void usb_packet_setup(USBPacket
*p
, int pid
, uint8_t addr
, uint8_t ep
);
331 void usb_packet_addbuf(USBPacket
*p
, void *ptr
, size_t len
);
332 int usb_packet_map(USBPacket
*p
, QEMUSGList
*sgl
);
333 void usb_packet_unmap(USBPacket
*p
);
334 void usb_packet_copy(USBPacket
*p
, void *ptr
, size_t bytes
);
335 void usb_packet_skip(USBPacket
*p
, size_t bytes
);
336 void usb_packet_cleanup(USBPacket
*p
);
338 int usb_handle_packet(USBDevice
*dev
, USBPacket
*p
);
339 void usb_packet_complete(USBDevice
*dev
, USBPacket
*p
);
340 void usb_cancel_packet(USBPacket
* p
);
342 void usb_ep_init(USBDevice
*dev
);
343 void usb_ep_dump(USBDevice
*dev
);
344 struct USBEndpoint
*usb_ep_get(USBDevice
*dev
, int pid
, int ep
);
345 uint8_t usb_ep_get_type(USBDevice
*dev
, int pid
, int ep
);
346 uint8_t usb_ep_get_ifnum(USBDevice
*dev
, int pid
, int ep
);
347 void usb_ep_set_type(USBDevice
*dev
, int pid
, int ep
, uint8_t type
);
348 void usb_ep_set_ifnum(USBDevice
*dev
, int pid
, int ep
, uint8_t ifnum
);
349 void usb_ep_set_max_packet_size(USBDevice
*dev
, int pid
, int ep
,
351 int usb_ep_get_max_packet_size(USBDevice
*dev
, int pid
, int ep
);
353 void usb_attach(USBPort
*port
);
354 void usb_detach(USBPort
*port
);
355 void usb_reset(USBPort
*port
);
356 void usb_wakeup(USBDevice
*dev
);
357 int usb_generic_handle_packet(USBDevice
*s
, USBPacket
*p
);
358 void usb_generic_async_ctrl_complete(USBDevice
*s
, USBPacket
*p
);
359 int set_usb_string(uint8_t *buf
, const char *str
);
360 void usb_send_msg(USBDevice
*dev
, int msg
);
363 USBDevice
*usb_host_device_open(const char *devname
);
364 int usb_host_device_close(const char *devname
);
365 void usb_host_info(Monitor
*mon
);
368 USBDevice
*usb_bt_init(HCIInfo
*hci
);
370 /* usb ports of the VM */
372 #define VM_USB_HUB_SIZE 8
375 enum musb_irq_source_e
{
376 musb_irq_suspend
= 0,
382 musb_irq_vbus_request
,
388 /* Add new interrupts here */
389 musb_irq_max
, /* total number of interrupts defined */
392 typedef struct MUSBState MUSBState
;
393 MUSBState
*musb_init(DeviceState
*parent_device
, int gpio_base
);
394 void musb_reset(MUSBState
*s
);
395 uint32_t musb_core_intr_get(MUSBState
*s
);
396 void musb_core_intr_clear(MUSBState
*s
, uint32_t mask
);
397 void musb_set_size(MUSBState
*s
, int epnum
, int size
, int is_tx
);
407 QTAILQ_HEAD(, USBPort
) free
;
408 QTAILQ_HEAD(, USBPort
) used
;
409 QTAILQ_ENTRY(USBBus
) next
;
413 int (*register_companion
)(USBBus
*bus
, USBPort
*ports
[],
414 uint32_t portcount
, uint32_t firstport
);
417 void usb_bus_new(USBBus
*bus
, USBBusOps
*ops
, DeviceState
*host
);
418 USBBus
*usb_bus_find(int busnr
);
419 void usb_legacy_register(const char *typename
, const char *usbdevice_name
,
420 USBDevice
*(*usbdevice_init
)(const char *params
));
421 USBDevice
*usb_create(USBBus
*bus
, const char *name
);
422 USBDevice
*usb_create_simple(USBBus
*bus
, const char *name
);
423 USBDevice
*usbdevice_create(const char *cmdline
);
424 void usb_register_port(USBBus
*bus
, USBPort
*port
, void *opaque
, int index
,
425 USBPortOps
*ops
, int speedmask
);
426 int usb_register_companion(const char *masterbus
, USBPort
*ports
[],
427 uint32_t portcount
, uint32_t firstport
,
428 void *opaque
, USBPortOps
*ops
, int speedmask
);
429 void usb_port_location(USBPort
*downstream
, USBPort
*upstream
, int portnr
);
430 void usb_unregister_port(USBBus
*bus
, USBPort
*port
);
431 int usb_claim_port(USBDevice
*dev
);
432 void usb_release_port(USBDevice
*dev
);
433 int usb_device_attach(USBDevice
*dev
);
434 int usb_device_detach(USBDevice
*dev
);
435 int usb_device_delete_addr(int busnr
, int addr
);
437 static inline USBBus
*usb_bus_from_device(USBDevice
*d
)
439 return DO_UPCAST(USBBus
, qbus
, d
->qdev
.parent_bus
);
442 extern const VMStateDescription vmstate_usb_device
;
444 #define VMSTATE_USB_DEVICE(_field, _state) { \
445 .name = (stringify(_field)), \
446 .size = sizeof(USBDevice), \
447 .vmsd = &vmstate_usb_device, \
448 .flags = VMS_STRUCT, \
449 .offset = vmstate_offset_value(_state, _field, USBDevice), \
452 int usb_device_handle_packet(USBDevice
*dev
, USBPacket
*p
);
454 void usb_device_cancel_packet(USBDevice
*dev
, USBPacket
*p
);
456 void usb_device_handle_attach(USBDevice
*dev
);
458 void usb_device_handle_reset(USBDevice
*dev
);
460 int usb_device_handle_control(USBDevice
*dev
, USBPacket
*p
, int request
, int value
,
461 int index
, int length
, uint8_t *data
);
463 int usb_device_handle_data(USBDevice
*dev
, USBPacket
*p
);
465 void usb_device_set_interface(USBDevice
*dev
, int interface
,
466 int alt_old
, int alt_new
);
468 const char *usb_device_get_product_desc(USBDevice
*dev
);
470 const USBDesc
*usb_device_get_usb_desc(USBDevice
*dev
);