]> git.proxmox.com Git - mirror_qemu.git/blame - include/hw/usb.h
projects / mirror_qemu.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Include exec/memory.h slightly less
[mirror_qemu.git] / include / hw / usb.h
CommitLineData
62aed765
AL		 1#ifndef QEMU_USB_H
2#define QEMU_USB_H
3
bb36d470
FB		 4/*
5 * QEMU USB API
5fafdf24 6 *
bb36d470 7 * Copyright (c) 2005 Fabrice Bellard
5fafdf24 8 *
bb36d470
FB		 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:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
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
25 * THE SOFTWARE.
26 */
c0f4ce77 27
d4842052 28#include "exec/memory.h"
83c9f4ca 29#include "hw/qdev.h"
daf015ef 30#include "qemu/iov.h"
1de7afc9 31#include "qemu/queue.h"
c0f4ce77 32
8e257816
BH		 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 */
38
bb36d470
FB		 39#define USB_TOKEN_SETUP 0x2d
40#define USB_TOKEN_IN 0x69 /* device -> host */
41#define USB_TOKEN_OUT 0xe1 /* host -> device */
42
9a77a0f5 43#define USB_RET_SUCCESS (0)
36dfe324
HG		 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)
0cae7b1a 51#define USB_RET_REMOVE_FROM_QUEUE (-8)
bb36d470
FB		 52
53#define USB_SPEED_LOW 0
54#define USB_SPEED_FULL 1
55#define USB_SPEED_HIGH 2
843d4e0c
GH		 56#define USB_SPEED_SUPER 3
57
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)
bb36d470
FB		 62
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
70
a594cfbf
FB		 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
84
b870472d
PA		 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
89
bb36d470
FB		 90#define USB_DIR_OUT 0
91#define USB_DIR_IN 0x80
92
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)
98
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
104
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)
2b81ba53
GH		 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)
110
111#define InterfaceRequest \
59ae540c
FB		 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)
f3571b1a
MR		 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)
2b81ba53
GH		 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)
123
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)
bb36d470
FB		 127
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
811ad5d8
GH		 139#define USB_REQ_SET_SEL 0x30
140#define USB_REQ_SET_ISOCH_DELAY 0x31
bb36d470
FB		 141
142#define USB_DEVICE_SELF_POWERED 0
143#define USB_DEVICE_REMOTE_WAKEUP 1
144
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
25620cba
GH		 150#define USB_DT_DEVICE_QUALIFIER 0x06
151#define USB_DT_OTHER_SPEED_CONFIG 0x07
a7fb71d1 152#define USB_DT_DEBUG 0x0A
c6d3ad0f 153#define USB_DT_INTERFACE_ASSOC 0x0B
2077469b
GH		 154#define USB_DT_BOS 0x0F
155#define USB_DT_DEVICE_CAPABILITY 0x10
b870472d
PA		 156#define USB_DT_CS_INTERFACE 0x24
157#define USB_DT_CS_ENDPOINT 0x25
b43a2851 158#define USB_DT_ENDPOINT_COMPANION 0x30
bb36d470 159
2077469b
GH		 160#define USB_DEV_CAP_WIRELESS 0x01
161#define USB_DEV_CAP_USB2_EXT 0x02
162#define USB_DEV_CAP_SUPERSPEED 0x03
163
bd93976a
PK		 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)
168
942ac052
AZ		 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
d8e17efd 173#define USB_ENDPOINT_XFER_INVALID 255
942ac052 174
7c37e6a4
GH		 175#define USB_INTERFACE_INVALID 255
176
806b6024 177typedef struct USBBus USBBus;
07771f6f 178typedef struct USBBusOps USBBusOps;
bb36d470
FB		 179typedef struct USBPort USBPort;
180typedef struct USBDevice USBDevice;
4d611c9a 181typedef struct USBPacket USBPacket;
a552a966 182typedef struct USBCombinedPacket USBCombinedPacket;
d8e17efd 183typedef struct USBEndpoint USBEndpoint;
bb36d470 184
37fb59d3
GH		 185typedef struct USBDesc USBDesc;
186typedef struct USBDescID USBDescID;
187typedef struct USBDescDevice USBDescDevice;
188typedef struct USBDescConfig USBDescConfig;
6e625fc7 189typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
37fb59d3
GH		 190typedef struct USBDescIface USBDescIface;
191typedef struct USBDescEndpoint USBDescEndpoint;
192typedef struct USBDescOther USBDescOther;
132a3f55 193typedef struct USBDescString USBDescString;
5319dc7b 194typedef struct USBDescMSOS USBDescMSOS;
132a3f55
GH		 195
196struct USBDescString {
197 uint8_t index;
198 char *str;
199 QLIST_ENTRY(USBDescString) next;
200};
37fb59d3 201
1de14d43
GH		 202#define USB_MAX_ENDPOINTS 15
203#define USB_MAX_INTERFACES 16
204
d8e17efd 205struct USBEndpoint {
63095ab5
GH		 206 uint8_t nr;
207 uint8_t pid;
d8e17efd 208 uint8_t type;
82f02fe9 209 uint8_t ifnum;
f003397c 210 int max_packet_size;
04b300f8 211 int max_streams;
7936e0f0 212 bool pipeline;
0132b4b6 213 bool halted;
25d5de7d 214 USBDevice *dev;
db4be873 215 QTAILQ_HEAD(, USBPacket) queue;
d8e17efd
GH		 216};
217
eeb0cf9a
GH		 218enum USBDeviceFlags {
219 USB_DEV_FLAG_FULL_PATH,
be41efde 220 USB_DEV_FLAG_IS_HOST,
5319dc7b
GH		 221 USB_DEV_FLAG_MSOS_DESC_ENABLE,
222 USB_DEV_FLAG_MSOS_DESC_IN_USE,
eeb0cf9a
GH		 223};
224
bb36d470
FB		 225/* definition of a USB device */
226struct USBDevice {
806b6024 227 DeviceState qdev;
618c169b 228 USBPort *port;
5f69076b 229 char *port_path;
71938a09 230 char *serial;
bb36d470 231 void *opaque;
eeb0cf9a 232 uint32_t flags;
89b9b79f 233
ba3f9bfb 234 /* Actual connected speed */
806b6024 235 int speed;
ba3f9bfb
HG		 236 /* Supported speeds, not in info because it may be variable (hostdevs) */
237 int speedmask;
806b6024 238 uint8_t addr;
0fe6d12e 239 char product_desc[32];
61e094c0 240 int auto_attach;
eb19d2b9 241 bool attached;
806b6024 242
c1ecb40a 243 int32_t state;
806b6024 244 uint8_t setup_buf[8];
19f33223 245 uint8_t data_buf[4096];
c1ecb40a
GH		 246 int32_t remote_wakeup;
247 int32_t setup_state;
248 int32_t setup_len;
249 int32_t setup_index;
132a3f55 250
25d5de7d 251 USBEndpoint ep_ctl;
d8e17efd
GH		 252 USBEndpoint ep_in[USB_MAX_ENDPOINTS];
253 USBEndpoint ep_out[USB_MAX_ENDPOINTS];
254
132a3f55 255 QLIST_HEAD(, USBDescString) strings;
386ab487 256 const USBDesc *usb_desc; /* Overrides class usb_desc if not NULL */
a980a065 257 const USBDescDevice *device;
65360511
GH		 258
259 int configuration;
260 int ninterfaces;
1de14d43 261 int altsetting[USB_MAX_INTERFACES];
a980a065 262 const USBDescConfig *config;
1de14d43 263 const USBDescIface *ifaces[USB_MAX_INTERFACES];
806b6024
GH		 264};
265
62aed765
AL		 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)
273
7d553f27
GA		 274typedef void (*USBDeviceRealize)(USBDevice *dev, Error **errp);
275typedef void (*USBDeviceUnrealize)(USBDevice *dev, Error **errp);
276
62aed765
AL		 277typedef struct USBDeviceClass {
278 DeviceClass parent_class;
279
7d553f27
GA		 280 USBDeviceRealize realize;
281 USBDeviceUnrealize unrealize;
282
73796fe6
GH		 283 /*
284 * Walk (enabled) downstream ports, check for a matching device.
285 * Only hubs implement this.
286 */
287 USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
288
eb5e680a
GH		 289 /*
290 * Called when a packet is canceled.
291 */
292 void (*cancel_packet)(USBDevice *dev, USBPacket *p);
293
b6f77fbe
GH		 294 /*
295 * Attach the device
296 */
297 void (*handle_attach)(USBDevice *dev);
298
89b9b79f
AL		 299 /*
300 * Reset the device
806b6024 301 */
059809e4 302 void (*handle_reset)(USBDevice *dev);
89b9b79f
AL		 303
304 /*
305 * Process control request.
306 * Called from handle_packet().
307 *
9a77a0f5 308 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
993d46ce 309 * then the number of bytes transferred is stored in p->actual_length
89b9b79f 310 */
9a77a0f5
HG		 311 void (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
312 int index, int length, uint8_t *data);
89b9b79f
AL		 313
314 /*
315 * Process data transfers (both BULK and ISOC).
316 * Called from handle_packet().
317 *
9a77a0f5 318 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
993d46ce 319 * then the number of bytes transferred is stored in p->actual_length
89b9b79f 320 */
9a77a0f5 321 void (*handle_data)(USBDevice *dev, USBPacket *p);
0958b4cc 322
1de14d43
GH		 323 void (*set_interface)(USBDevice *dev, int interface,
324 int alt_old, int alt_new);
325
36dfe324
HG		 326 /*
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.
329 */
330 void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);
331
f79738b0
HG		 332 /*
333 * Called by the hcd to let the device know the queue for an endpoint
334 * has been unlinked / stopped. Optional may be NULL.
335 */
336 void (*ep_stopped)(USBDevice *dev, USBEndpoint *ep);
337
3b444ead
HG		 338 /*
339 * Called by the hcd to alloc / free streams on a bulk endpoint.
340 * Optional may be NULL.
341 */
342 int (*alloc_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps,
343 int streams);
344 void (*free_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps);
345
06384698 346 const char *product_desc;
37fb59d3 347 const USBDesc *usb_desc;
1e351dc3 348 bool attached_settable;
62aed765 349} USBDeviceClass;
bb36d470 350
0d86d2be 351typedef struct USBPortOps {
618c169b
GH		 352 void (*attach)(USBPort *port);
353 void (*detach)(USBPort *port);
4706ab6c
HG		 354 /*
355 * This gets called when a device downstream from the device attached to
356 * the port (iow attached through a hub) gets detached.
357 */
358 void (*child_detach)(USBPort *port, USBDevice *child);
d47e59b8
HG		 359 void (*wakeup)(USBPort *port);
360 /*
361 * Note that port->dev will be different then the device from which
f53c398a 362 * the packet originated when a hub is involved.
d47e59b8
HG		 363 */
364 void (*complete)(USBPort *port, USBPacket *p);
0d86d2be 365} USBPortOps;
0d92ed30 366
bb36d470
FB		 367/* USB port on which a device can be connected */
368struct USBPort {
a594cfbf 369 USBDevice *dev;
843d4e0c 370 int speedmask;
c24e4aac 371 int hubcount;
c7a2196a 372 char path[16];
0d86d2be 373 USBPortOps *ops;
bb36d470
FB		 374 void *opaque;
375 int index; /* internal port index, may be used with the opaque */
72cf2d4f 376 QTAILQ_ENTRY(USBPort) next;
bb36d470
FB		 377};
378
4d611c9a
PB		 379typedef void USBCallback(USBPacket * packet, void *opaque);
380
f53c398a
GH		 381typedef enum USBPacketState {
382 USB_PACKET_UNDEFINED = 0,
383 USB_PACKET_SETUP,
db4be873 384 USB_PACKET_QUEUED,
f53c398a
GH		 385 USB_PACKET_ASYNC,
386 USB_PACKET_COMPLETE,
387 USB_PACKET_CANCELED,
388} USBPacketState;
389
db4be873 390/* Structure used to hold information about an active USB packet. */
4d611c9a
PB		 391struct USBPacket {
392 /* Data fields for use by the driver. */
393 int pid;
e983395d 394 uint64_t id;
f53c398a 395 USBEndpoint *ep;
8550a02d 396 unsigned int stream;
4f4321c1 397 QEMUIOVector iov;
1b4b29a1 398 uint64_t parameter; /* control transfers */
6ba43f1f 399 bool short_not_ok;
a6fb2ddb 400 bool int_req;
9a77a0f5 401 int status; /* USB_RET_* status code */
993d46ce 402 int actual_length; /* Number of bytes actually transferred */
4d611c9a 403 /* Internal use by the USB layer. */
f53c398a 404 USBPacketState state;
a552a966 405 USBCombinedPacket *combined;
db4be873 406 QTAILQ_ENTRY(USBPacket) queue;
a552a966
HG		 407 QTAILQ_ENTRY(USBPacket) combined_entry;
408};
409
410struct USBCombinedPacket {
411 USBPacket *first;
eae3eb3e 412 QTAILQ_HEAD(, USBPacket) packets;
a552a966 413 QEMUIOVector iov;
4d611c9a
PB		 414};
415
4f4321c1 416void usb_packet_init(USBPacket *p);
db4be873 417void usb_packet_set_state(USBPacket *p, USBPacketState state);
5ac2731c 418void usb_packet_check_state(USBPacket *p, USBPacketState expected);
8550a02d
GH		 419void usb_packet_setup(USBPacket *p, int pid,
420 USBEndpoint *ep, unsigned int stream,
421 uint64_t id, bool short_not_ok, bool int_req);
4f4321c1
GH		 422void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
423int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
e2f89926 424void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
4f4321c1
GH		 425void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
426void usb_packet_skip(USBPacket *p, size_t bytes);
6a98d1c0 427size_t usb_packet_size(USBPacket *p);
4f4321c1
GH		 428void usb_packet_cleanup(USBPacket *p);
429
f53c398a
GH		 430static inline bool usb_packet_is_inflight(USBPacket *p)
431{
db4be873
GH		 432 return (p->state == USB_PACKET_QUEUED ||
433 p->state == USB_PACKET_ASYNC);
f53c398a
GH		 434}
435
73796fe6
GH		 436USBDevice *usb_find_device(USBPort *port, uint8_t addr);
437
9a77a0f5 438void usb_handle_packet(USBDevice *dev, USBPacket *p);
4ff658fb 439void usb_packet_complete(USBDevice *dev, USBPacket *p);
d0ff81b8 440void usb_packet_complete_one(USBDevice *dev, USBPacket *p);
4ff658fb 441void usb_cancel_packet(USBPacket * p);
53aa8c0e 442
d8e17efd 443void usb_ep_init(USBDevice *dev);
19deaa08 444void usb_ep_reset(USBDevice *dev);
5b6780d0 445void usb_ep_dump(USBDevice *dev);
d8e17efd
GH		 446struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
447uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
448void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
82f02fe9 449void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
f003397c
GH		 450void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
451 uint16_t raw);
04b300f8 452void usb_ep_set_max_streams(USBDevice *dev, int pid, int ep, uint8_t raw);
e382d966 453void usb_ep_set_halted(USBDevice *dev, int pid, int ep, bool halted);
c13a9e61
HG		 454USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
455 uint64_t id);
d8e17efd 456
a552a966
HG		 457void usb_ep_combine_input_packets(USBEndpoint *ep);
458void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p);
459void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p);
460
b791c3b3 461void usb_pick_speed(USBPort *port);
891fb2cd
GH		 462void usb_attach(USBPort *port);
463void usb_detach(USBPort *port);
d28f4e2d
GH		 464void usb_port_reset(USBPort *port);
465void usb_device_reset(USBDevice *dev);
8550a02d 466void usb_wakeup(USBEndpoint *ep, unsigned int stream);
50b7963e 467void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
4d611c9a 468
bb36d470 469/* usb-linux.c */
1ce6be24 470void hmp_info_usbhost(Monitor *mon, const QDict *qdict);
b99260eb 471bool usb_host_dev_is_scsi_storage(USBDevice *usbdev);
59ae540c 472
87ecb68b
PB		 473/* usb ports of the VM */
474
87ecb68b
PB		 475#define VM_USB_HUB_SIZE 8
476
f13bef95
SW		 477/* hw/usb/hdc-musb.c */
478
942ac052
AZ		 479enum musb_irq_source_e {
480 musb_irq_suspend = 0,
481 musb_irq_resume,
482 musb_irq_rst_babble,
483 musb_irq_sof,
484 musb_irq_connect,
485 musb_irq_disconnect,
486 musb_irq_vbus_request,
487 musb_irq_vbus_error,
488 musb_irq_rx,
489 musb_irq_tx,
490 musb_set_vbus,
491 musb_set_session,
9147b752
PM		 492 /* Add new interrupts here */
493 musb_irq_max, /* total number of interrupts defined */
942ac052
AZ		 494};
495
bc24a225 496typedef struct MUSBState MUSBState;
f13bef95
SW		 497
498extern CPUReadMemoryFunc * const musb_read[];
499extern CPUWriteMemoryFunc * const musb_write[];
500
406c2075 501MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
5b1cdb4e 502void musb_reset(MUSBState *s);
bc24a225
PB		 503uint32_t musb_core_intr_get(MUSBState *s);
504void musb_core_intr_clear(MUSBState *s, uint32_t mask);
505void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
806b6024
GH		 506
507/* usb-bus.c */
508
0d936928
AL		 509#define TYPE_USB_BUS "usb-bus"
510#define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
511
806b6024
GH		 512struct USBBus {
513 BusState qbus;
07771f6f 514 USBBusOps *ops;
806b6024
GH		 515 int busnr;
516 int nfree;
517 int nused;
72cf2d4f
BS		 518 QTAILQ_HEAD(, USBPort) free;
519 QTAILQ_HEAD(, USBPort) used;
520 QTAILQ_ENTRY(USBBus) next;
806b6024
GH		 521};
522
07771f6f 523struct USBBusOps {
f4bbaaf5
MA		 524 void (*register_companion)(USBBus *bus, USBPort *ports[],
525 uint32_t portcount, uint32_t firstport,
526 Error **errp);
8550a02d 527 void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep, unsigned int stream);
07771f6f
GH		 528};
529
c889b3a5
AF		 530void usb_bus_new(USBBus *bus, size_t bus_size,
531 USBBusOps *ops, DeviceState *host);
e5a9bece 532void usb_bus_release(USBBus *bus);
806b6024 533USBBus *usb_bus_find(int busnr);
ba02430f 534void usb_legacy_register(const char *typename, const char *usbdevice_name,
3741715c
JK		 535 USBDevice *(*usbdevice_init)(USBBus *bus,
536 const char *params));
a5d2f727 537USBDevice *usb_create(USBBus *bus, const char *name);
806b6024 538USBDevice *usb_create_simple(USBBus *bus, const char *name);
0958b4cc 539USBDevice *usbdevice_create(const char *cmdline);
a5d2f727 540void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
ace1318b 541 USBPortOps *ops, int speedmask);
f4bbaaf5
MA		 542void usb_register_companion(const char *masterbus, USBPort *ports[],
543 uint32_t portcount, uint32_t firstport,
544 void *opaque, USBPortOps *ops, int speedmask,
545 Error **errp);
c7a2196a 546void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
a8e662b5 547void usb_unregister_port(USBBus *bus, USBPort *port);
7d553f27 548void usb_claim_port(USBDevice *dev, Error **errp);
891fb2cd 549void usb_release_port(USBDevice *dev);
7d553f27 550void usb_device_attach(USBDevice *dev, Error **errp);
a8e662b5 551int usb_device_detach(USBDevice *dev);
594a5360 552void usb_check_attach(USBDevice *dev, Error **errp);
a5d2f727
GH		 553
554static inline USBBus *usb_bus_from_device(USBDevice *d)
555{
556 return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
557}
701a8f76
PB		 558
559extern const VMStateDescription vmstate_usb_device;
560
561#define VMSTATE_USB_DEVICE(_field, _state) { \
562 .name = (stringify(_field)), \
563 .size = sizeof(USBDevice), \
564 .vmsd = &vmstate_usb_device, \
565 .flags = VMS_STRUCT, \
566 .offset = vmstate_offset_value(_state, _field, USBDevice), \
567}
568
73796fe6
GH		 569USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
570
62aed765
AL		 571void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
572
573void usb_device_handle_attach(USBDevice *dev);
574
575void usb_device_handle_reset(USBDevice *dev);
576
9a77a0f5
HG		 577void usb_device_handle_control(USBDevice *dev, USBPacket *p, int request,
578 int val, int index, int length, uint8_t *data);
62aed765 579
9a77a0f5 580void usb_device_handle_data(USBDevice *dev, USBPacket *p);
62aed765
AL		 581
582void usb_device_set_interface(USBDevice *dev, int interface,
583 int alt_old, int alt_new);
584
36dfe324
HG		 585void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);
586
f79738b0
HG		 587void usb_device_ep_stopped(USBDevice *dev, USBEndpoint *ep);
588
3b444ead
HG		 589int usb_device_alloc_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps,
590 int streams);
591void usb_device_free_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps);
592
62aed765
AL		 593const char *usb_device_get_product_desc(USBDevice *dev);
594
595const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
596
b2d1fe67
HG		 597/* quirks.c */
598
599/* In bulk endpoints are streaming data sources (iow behave like isoc eps) */
600#define USB_QUIRK_BUFFER_BULK_IN 0x01
601/* Bulk pkts in FTDI format, need special handling when combining packets */
602#define USB_QUIRK_IS_FTDI 0x02
701a8f76 603
b2d1fe67
HG		 604int usb_get_quirks(uint16_t vendor_id, uint16_t product_id,
605 uint8_t interface_class, uint8_t interface_subclass,
606 uint8_t interface_protocol);
607
608#endif
QEMU mirror