]> 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
Use DECLARE_*CHECKER* macros
[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"
a27bd6c7 29#include "hw/qdev-core.h"
daf015ef 30#include "qemu/iov.h"
1de7afc9 31#include "qemu/queue.h"
db1015e9 32#include "qom/object.h"
c0f4ce77 33
8e257816
BH		 34/* Constants related to the USB / PCI interaction */
35#define USB_SBRN 0x60 /* Serial Bus Release Number Register */
36#define USB_RELEASE_1 0x10 /* USB 1.0 */
37#define USB_RELEASE_2 0x20 /* USB 2.0 */
38#define USB_RELEASE_3 0x30 /* USB 3.0 */
39
bb36d470
FB		 40#define USB_TOKEN_SETUP 0x2d
41#define USB_TOKEN_IN 0x69 /* device -> host */
42#define USB_TOKEN_OUT 0xe1 /* host -> device */
43
9a77a0f5 44#define USB_RET_SUCCESS (0)
36dfe324
HG		 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_IOERROR (-5)
50#define USB_RET_ASYNC (-6)
51#define USB_RET_ADD_TO_QUEUE (-7)
0cae7b1a 52#define USB_RET_REMOVE_FROM_QUEUE (-8)
bb36d470
FB		 53
54#define USB_SPEED_LOW 0
55#define USB_SPEED_FULL 1
56#define USB_SPEED_HIGH 2
843d4e0c
GH		 57#define USB_SPEED_SUPER 3
58
59#define USB_SPEED_MASK_LOW (1 << USB_SPEED_LOW)
60#define USB_SPEED_MASK_FULL (1 << USB_SPEED_FULL)
61#define USB_SPEED_MASK_HIGH (1 << USB_SPEED_HIGH)
62#define USB_SPEED_MASK_SUPER (1 << USB_SPEED_SUPER)
bb36d470
FB		 63
64#define USB_STATE_NOTATTACHED 0
65#define USB_STATE_ATTACHED 1
66//#define USB_STATE_POWERED 2
67#define USB_STATE_DEFAULT 3
68//#define USB_STATE_ADDRESS 4
69//#define USB_STATE_CONFIGURED 5
70#define USB_STATE_SUSPENDED 6
71
a594cfbf
FB		 72#define USB_CLASS_AUDIO 1
73#define USB_CLASS_COMM 2
74#define USB_CLASS_HID 3
75#define USB_CLASS_PHYSICAL 5
76#define USB_CLASS_STILL_IMAGE 6
77#define USB_CLASS_PRINTER 7
78#define USB_CLASS_MASS_STORAGE 8
79#define USB_CLASS_HUB 9
80#define USB_CLASS_CDC_DATA 0x0a
81#define USB_CLASS_CSCID 0x0b
82#define USB_CLASS_CONTENT_SEC 0x0d
83#define USB_CLASS_APP_SPEC 0xfe
84#define USB_CLASS_VENDOR_SPEC 0xff
85
b870472d
PA		 86#define USB_SUBCLASS_UNDEFINED 0
87#define USB_SUBCLASS_AUDIO_CONTROL 1
88#define USB_SUBCLASS_AUDIO_STREAMING 2
89#define USB_SUBCLASS_AUDIO_MIDISTREAMING 3
90
bb36d470
FB		 91#define USB_DIR_OUT 0
92#define USB_DIR_IN 0x80
93
94#define USB_TYPE_MASK (0x03 << 5)
95#define USB_TYPE_STANDARD (0x00 << 5)
96#define USB_TYPE_CLASS (0x01 << 5)
97#define USB_TYPE_VENDOR (0x02 << 5)
98#define USB_TYPE_RESERVED (0x03 << 5)
99
100#define USB_RECIP_MASK 0x1f
101#define USB_RECIP_DEVICE 0x00
102#define USB_RECIP_INTERFACE 0x01
103#define USB_RECIP_ENDPOINT 0x02
104#define USB_RECIP_OTHER 0x03
105
106#define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
107#define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
2b81ba53
GH		 108#define VendorDeviceRequest ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
109#define VendorDeviceOutRequest \
110 ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_DEVICE)<<8)
111
112#define InterfaceRequest \
59ae540c
FB		 113 ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
114#define InterfaceOutRequest \
115 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
f3571b1a
MR		 116#define ClassInterfaceRequest \
117 ((USB_DIR_IN|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
118#define ClassInterfaceOutRequest \
119 ((USB_DIR_OUT|USB_TYPE_CLASS|USB_RECIP_INTERFACE)<<8)
2b81ba53
GH		 120#define VendorInterfaceRequest \
121 ((USB_DIR_IN|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8)
122#define VendorInterfaceOutRequest \
123 ((USB_DIR_OUT|USB_TYPE_VENDOR|USB_RECIP_INTERFACE)<<8)
124
125#define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
126#define EndpointOutRequest \
127 ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
bb36d470
FB		 128
129#define USB_REQ_GET_STATUS 0x00
130#define USB_REQ_CLEAR_FEATURE 0x01
131#define USB_REQ_SET_FEATURE 0x03
132#define USB_REQ_SET_ADDRESS 0x05
133#define USB_REQ_GET_DESCRIPTOR 0x06
134#define USB_REQ_SET_DESCRIPTOR 0x07
135#define USB_REQ_GET_CONFIGURATION 0x08
136#define USB_REQ_SET_CONFIGURATION 0x09
137#define USB_REQ_GET_INTERFACE 0x0A
138#define USB_REQ_SET_INTERFACE 0x0B
139#define USB_REQ_SYNCH_FRAME 0x0C
811ad5d8
GH		 140#define USB_REQ_SET_SEL 0x30
141#define USB_REQ_SET_ISOCH_DELAY 0x31
bb36d470
FB		 142
143#define USB_DEVICE_SELF_POWERED 0
144#define USB_DEVICE_REMOTE_WAKEUP 1
145
146#define USB_DT_DEVICE 0x01
147#define USB_DT_CONFIG 0x02
148#define USB_DT_STRING 0x03
149#define USB_DT_INTERFACE 0x04
150#define USB_DT_ENDPOINT 0x05
25620cba
GH		 151#define USB_DT_DEVICE_QUALIFIER 0x06
152#define USB_DT_OTHER_SPEED_CONFIG 0x07
a7fb71d1 153#define USB_DT_DEBUG 0x0A
c6d3ad0f 154#define USB_DT_INTERFACE_ASSOC 0x0B
2077469b
GH		 155#define USB_DT_BOS 0x0F
156#define USB_DT_DEVICE_CAPABILITY 0x10
b870472d
PA		 157#define USB_DT_CS_INTERFACE 0x24
158#define USB_DT_CS_ENDPOINT 0x25
b43a2851 159#define USB_DT_ENDPOINT_COMPANION 0x30
bb36d470 160
2077469b
GH		 161#define USB_DEV_CAP_WIRELESS 0x01
162#define USB_DEV_CAP_USB2_EXT 0x02
163#define USB_DEV_CAP_SUPERSPEED 0x03
164
bd93976a
PK		 165#define USB_CFG_ATT_ONE (1 << 7) /* should always be set */
166#define USB_CFG_ATT_SELFPOWER (1 << 6)
167#define USB_CFG_ATT_WAKEUP (1 << 5)
168#define USB_CFG_ATT_BATTERY (1 << 4)
169
942ac052
AZ		 170#define USB_ENDPOINT_XFER_CONTROL 0
171#define USB_ENDPOINT_XFER_ISOC 1
172#define USB_ENDPOINT_XFER_BULK 2
173#define USB_ENDPOINT_XFER_INT 3
d8e17efd 174#define USB_ENDPOINT_XFER_INVALID 255
942ac052 175
7c37e6a4
GH		 176#define USB_INTERFACE_INVALID 255
177
806b6024 178typedef struct USBBus USBBus;
07771f6f 179typedef struct USBBusOps USBBusOps;
bb36d470
FB		 180typedef struct USBPort USBPort;
181typedef struct USBDevice USBDevice;
4d611c9a 182typedef struct USBPacket USBPacket;
a552a966 183typedef struct USBCombinedPacket USBCombinedPacket;
d8e17efd 184typedef struct USBEndpoint USBEndpoint;
bb36d470 185
37fb59d3
GH		 186typedef struct USBDesc USBDesc;
187typedef struct USBDescID USBDescID;
188typedef struct USBDescDevice USBDescDevice;
189typedef struct USBDescConfig USBDescConfig;
6e625fc7 190typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
37fb59d3
GH		 191typedef struct USBDescIface USBDescIface;
192typedef struct USBDescEndpoint USBDescEndpoint;
193typedef struct USBDescOther USBDescOther;
132a3f55 194typedef struct USBDescString USBDescString;
5319dc7b 195typedef struct USBDescMSOS USBDescMSOS;
132a3f55
GH		 196
197struct USBDescString {
198 uint8_t index;
199 char *str;
200 QLIST_ENTRY(USBDescString) next;
201};
37fb59d3 202
1de14d43
GH		 203#define USB_MAX_ENDPOINTS 15
204#define USB_MAX_INTERFACES 16
205
d8e17efd 206struct USBEndpoint {
63095ab5
GH		 207 uint8_t nr;
208 uint8_t pid;
d8e17efd 209 uint8_t type;
82f02fe9 210 uint8_t ifnum;
f003397c 211 int max_packet_size;
04b300f8 212 int max_streams;
7936e0f0 213 bool pipeline;
0132b4b6 214 bool halted;
25d5de7d 215 USBDevice *dev;
db4be873 216 QTAILQ_HEAD(, USBPacket) queue;
d8e17efd
GH		 217};
218
eeb0cf9a
GH		 219enum USBDeviceFlags {
220 USB_DEV_FLAG_FULL_PATH,
be41efde 221 USB_DEV_FLAG_IS_HOST,
5319dc7b
GH		 222 USB_DEV_FLAG_MSOS_DESC_ENABLE,
223 USB_DEV_FLAG_MSOS_DESC_IN_USE,
eeb0cf9a
GH		 224};
225
bb36d470
FB		 226/* definition of a USB device */
227struct USBDevice {
806b6024 228 DeviceState qdev;
618c169b 229 USBPort *port;
5f69076b 230 char *port_path;
71938a09 231 char *serial;
bb36d470 232 void *opaque;
eeb0cf9a 233 uint32_t flags;
89b9b79f 234
ba3f9bfb 235 /* Actual connected speed */
806b6024 236 int speed;
ba3f9bfb
HG		 237 /* Supported speeds, not in info because it may be variable (hostdevs) */
238 int speedmask;
806b6024 239 uint8_t addr;
0fe6d12e 240 char product_desc[32];
61e094c0 241 int auto_attach;
eb19d2b9 242 bool attached;
806b6024 243
c1ecb40a 244 int32_t state;
806b6024 245 uint8_t setup_buf[8];
19f33223 246 uint8_t data_buf[4096];
c1ecb40a
GH		 247 int32_t remote_wakeup;
248 int32_t setup_state;
249 int32_t setup_len;
250 int32_t setup_index;
132a3f55 251
25d5de7d 252 USBEndpoint ep_ctl;
d8e17efd
GH		 253 USBEndpoint ep_in[USB_MAX_ENDPOINTS];
254 USBEndpoint ep_out[USB_MAX_ENDPOINTS];
255
132a3f55 256 QLIST_HEAD(, USBDescString) strings;
386ab487 257 const USBDesc *usb_desc; /* Overrides class usb_desc if not NULL */
a980a065 258 const USBDescDevice *device;
65360511
GH		 259
260 int configuration;
261 int ninterfaces;
1de14d43 262 int altsetting[USB_MAX_INTERFACES];
a980a065 263 const USBDescConfig *config;
1de14d43 264 const USBDescIface *ifaces[USB_MAX_INTERFACES];
806b6024
GH		 265};
266
62aed765 267#define TYPE_USB_DEVICE "usb-device"
db1015e9 268typedef struct USBDeviceClass USBDeviceClass;
8110fa1d
EH		 269DECLARE_OBJ_CHECKERS(USBDevice, USBDeviceClass,
270 USB_DEVICE, TYPE_USB_DEVICE)
62aed765 271
7d553f27 272typedef void (*USBDeviceRealize)(USBDevice *dev, Error **errp);
b69c3c21 273typedef void (*USBDeviceUnrealize)(USBDevice *dev);
7d553f27 274
db1015e9 275struct USBDeviceClass {
62aed765
AL		 276 DeviceClass parent_class;
277
7d553f27
GA		 278 USBDeviceRealize realize;
279 USBDeviceUnrealize unrealize;
280
73796fe6
GH		 281 /*
282 * Walk (enabled) downstream ports, check for a matching device.
283 * Only hubs implement this.
284 */
285 USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
286
eb5e680a
GH		 287 /*
288 * Called when a packet is canceled.
289 */
290 void (*cancel_packet)(USBDevice *dev, USBPacket *p);
291
b6f77fbe
GH		 292 /*
293 * Attach the device
294 */
295 void (*handle_attach)(USBDevice *dev);
296
89b9b79f
AL		 297 /*
298 * Reset the device
806b6024 299 */
059809e4 300 void (*handle_reset)(USBDevice *dev);
89b9b79f
AL		 301
302 /*
303 * Process control request.
304 * Called from handle_packet().
305 *
9a77a0f5 306 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
993d46ce 307 * then the number of bytes transferred is stored in p->actual_length
89b9b79f 308 */
9a77a0f5
HG		 309 void (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
310 int index, int length, uint8_t *data);
89b9b79f
AL		 311
312 /*
313 * Process data transfers (both BULK and ISOC).
314 * Called from handle_packet().
315 *
9a77a0f5 316 * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
993d46ce 317 * then the number of bytes transferred is stored in p->actual_length
89b9b79f 318 */
9a77a0f5 319 void (*handle_data)(USBDevice *dev, USBPacket *p);
0958b4cc 320
1de14d43
GH		 321 void (*set_interface)(USBDevice *dev, int interface,
322 int alt_old, int alt_new);
323
36dfe324
HG		 324 /*
325 * Called when the hcd is done queuing packets for an endpoint, only
326 * necessary for devices which can return USB_RET_ADD_TO_QUEUE.
327 */
328 void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);
329
f79738b0
HG		 330 /*
331 * Called by the hcd to let the device know the queue for an endpoint
332 * has been unlinked / stopped. Optional may be NULL.
333 */
334 void (*ep_stopped)(USBDevice *dev, USBEndpoint *ep);
335
3b444ead
HG		 336 /*
337 * Called by the hcd to alloc / free streams on a bulk endpoint.
338 * Optional may be NULL.
339 */
340 int (*alloc_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps,
341 int streams);
342 void (*free_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps);
343
06384698 344 const char *product_desc;
37fb59d3 345 const USBDesc *usb_desc;
1e351dc3 346 bool attached_settable;
db1015e9 347};
bb36d470 348
0d86d2be 349typedef struct USBPortOps {
618c169b
GH		 350 void (*attach)(USBPort *port);
351 void (*detach)(USBPort *port);
4706ab6c
HG		 352 /*
353 * This gets called when a device downstream from the device attached to
354 * the port (iow attached through a hub) gets detached.
355 */
356 void (*child_detach)(USBPort *port, USBDevice *child);
d47e59b8
HG		 357 void (*wakeup)(USBPort *port);
358 /*
359 * Note that port->dev will be different then the device from which
f53c398a 360 * the packet originated when a hub is involved.
d47e59b8
HG		 361 */
362 void (*complete)(USBPort *port, USBPacket *p);
0d86d2be 363} USBPortOps;
0d92ed30 364
bb36d470
FB		 365/* USB port on which a device can be connected */
366struct USBPort {
a594cfbf 367 USBDevice *dev;
843d4e0c 368 int speedmask;
c24e4aac 369 int hubcount;
c7a2196a 370 char path[16];
0d86d2be 371 USBPortOps *ops;
bb36d470
FB		 372 void *opaque;
373 int index; /* internal port index, may be used with the opaque */
72cf2d4f 374 QTAILQ_ENTRY(USBPort) next;
bb36d470
FB		 375};
376
4d611c9a
PB		 377typedef void USBCallback(USBPacket * packet, void *opaque);
378
f53c398a
GH		 379typedef enum USBPacketState {
380 USB_PACKET_UNDEFINED = 0,
381 USB_PACKET_SETUP,
db4be873 382 USB_PACKET_QUEUED,
f53c398a
GH		 383 USB_PACKET_ASYNC,
384 USB_PACKET_COMPLETE,
385 USB_PACKET_CANCELED,
386} USBPacketState;
387
db4be873 388/* Structure used to hold information about an active USB packet. */
4d611c9a
PB		 389struct USBPacket {
390 /* Data fields for use by the driver. */
391 int pid;
e983395d 392 uint64_t id;
f53c398a 393 USBEndpoint *ep;
8550a02d 394 unsigned int stream;
4f4321c1 395 QEMUIOVector iov;
1b4b29a1 396 uint64_t parameter; /* control transfers */
6ba43f1f 397 bool short_not_ok;
a6fb2ddb 398 bool int_req;
9a77a0f5 399 int status; /* USB_RET_* status code */
993d46ce 400 int actual_length; /* Number of bytes actually transferred */
4d611c9a 401 /* Internal use by the USB layer. */
f53c398a 402 USBPacketState state;
a552a966 403 USBCombinedPacket *combined;
db4be873 404 QTAILQ_ENTRY(USBPacket) queue;
a552a966
HG		 405 QTAILQ_ENTRY(USBPacket) combined_entry;
406};
407
408struct USBCombinedPacket {
409 USBPacket *first;
eae3eb3e 410 QTAILQ_HEAD(, USBPacket) packets;
a552a966 411 QEMUIOVector iov;
4d611c9a
PB		 412};
413
4f4321c1 414void usb_packet_init(USBPacket *p);
db4be873 415void usb_packet_set_state(USBPacket *p, USBPacketState state);
5ac2731c 416void usb_packet_check_state(USBPacket *p, USBPacketState expected);
8550a02d
GH		 417void usb_packet_setup(USBPacket *p, int pid,
418 USBEndpoint *ep, unsigned int stream,
419 uint64_t id, bool short_not_ok, bool int_req);
4f4321c1
GH		 420void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
421int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
e2f89926 422void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
4f4321c1
GH		 423void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
424void usb_packet_skip(USBPacket *p, size_t bytes);
6a98d1c0 425size_t usb_packet_size(USBPacket *p);
4f4321c1
GH		 426void usb_packet_cleanup(USBPacket *p);
427
f53c398a
GH		 428static inline bool usb_packet_is_inflight(USBPacket *p)
429{
db4be873
GH		 430 return (p->state == USB_PACKET_QUEUED ||
431 p->state == USB_PACKET_ASYNC);
f53c398a
GH		 432}
433
73796fe6
GH		 434USBDevice *usb_find_device(USBPort *port, uint8_t addr);
435
9a77a0f5 436void usb_handle_packet(USBDevice *dev, USBPacket *p);
4ff658fb 437void usb_packet_complete(USBDevice *dev, USBPacket *p);
d0ff81b8 438void usb_packet_complete_one(USBDevice *dev, USBPacket *p);
4ff658fb 439void usb_cancel_packet(USBPacket * p);
53aa8c0e 440
d8e17efd 441void usb_ep_init(USBDevice *dev);
19deaa08 442void usb_ep_reset(USBDevice *dev);
5b6780d0 443void usb_ep_dump(USBDevice *dev);
d8e17efd
GH		 444struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
445uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
446void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
82f02fe9 447void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
f003397c
GH		 448void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
449 uint16_t raw);
04b300f8 450void usb_ep_set_max_streams(USBDevice *dev, int pid, int ep, uint8_t raw);
e382d966 451void usb_ep_set_halted(USBDevice *dev, int pid, int ep, bool halted);
c13a9e61
HG		 452USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
453 uint64_t id);
d8e17efd 454
a552a966
HG		 455void usb_ep_combine_input_packets(USBEndpoint *ep);
456void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p);
457void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p);
458
b791c3b3 459void usb_pick_speed(USBPort *port);
891fb2cd
GH		 460void usb_attach(USBPort *port);
461void usb_detach(USBPort *port);
d28f4e2d
GH		 462void usb_port_reset(USBPort *port);
463void usb_device_reset(USBDevice *dev);
8550a02d 464void usb_wakeup(USBEndpoint *ep, unsigned int stream);
50b7963e 465void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
4d611c9a 466
bb36d470 467/* usb-linux.c */
1ce6be24 468void hmp_info_usbhost(Monitor *mon, const QDict *qdict);
b99260eb 469bool usb_host_dev_is_scsi_storage(USBDevice *usbdev);
59ae540c 470
87ecb68b
PB		 471/* usb ports of the VM */
472
87ecb68b
PB		 473#define VM_USB_HUB_SIZE 8
474
806b6024
GH		 475/* usb-bus.c */
476
0d936928 477#define TYPE_USB_BUS "usb-bus"
8110fa1d
EH		 478DECLARE_INSTANCE_CHECKER(USBBus, USB_BUS,
479 TYPE_USB_BUS)
0d936928 480
806b6024
GH		 481struct USBBus {
482 BusState qbus;
07771f6f 483 USBBusOps *ops;
806b6024
GH		 484 int busnr;
485 int nfree;
486 int nused;
72cf2d4f
BS		 487 QTAILQ_HEAD(, USBPort) free;
488 QTAILQ_HEAD(, USBPort) used;
489 QTAILQ_ENTRY(USBBus) next;
806b6024
GH		 490};
491
07771f6f 492struct USBBusOps {
f4bbaaf5
MA		 493 void (*register_companion)(USBBus *bus, USBPort *ports[],
494 uint32_t portcount, uint32_t firstport,
495 Error **errp);
8550a02d 496 void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep, unsigned int stream);
07771f6f
GH		 497};
498
c889b3a5
AF		 499void usb_bus_new(USBBus *bus, size_t bus_size,
500 USBBusOps *ops, DeviceState *host);
e5a9bece 501void usb_bus_release(USBBus *bus);
806b6024 502USBBus *usb_bus_find(int busnr);
ba02430f 503void usb_legacy_register(const char *typename, const char *usbdevice_name,
590ce74a 504 USBDevice *(*usbdevice_init)(const char *params));
32aaaebe
MA		 505USBDevice *usb_new(const char *name);
506bool usb_realize_and_unref(USBDevice *dev, USBBus *bus, Error **errp);
806b6024 507USBDevice *usb_create_simple(USBBus *bus, const char *name);
0958b4cc 508USBDevice *usbdevice_create(const char *cmdline);
a5d2f727 509void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
ace1318b 510 USBPortOps *ops, int speedmask);
f4bbaaf5
MA		 511void usb_register_companion(const char *masterbus, USBPort *ports[],
512 uint32_t portcount, uint32_t firstport,
513 void *opaque, USBPortOps *ops, int speedmask,
514 Error **errp);
c7a2196a 515void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
a8e662b5 516void usb_unregister_port(USBBus *bus, USBPort *port);
7d553f27 517void usb_claim_port(USBDevice *dev, Error **errp);
891fb2cd 518void usb_release_port(USBDevice *dev);
7d553f27 519void usb_device_attach(USBDevice *dev, Error **errp);
a8e662b5 520int usb_device_detach(USBDevice *dev);
594a5360 521void usb_check_attach(USBDevice *dev, Error **errp);
a5d2f727
GH		 522
523static inline USBBus *usb_bus_from_device(USBDevice *d)
524{
525 return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
526}
701a8f76
PB		 527
528extern const VMStateDescription vmstate_usb_device;
529
530#define VMSTATE_USB_DEVICE(_field, _state) { \
531 .name = (stringify(_field)), \
532 .size = sizeof(USBDevice), \
533 .vmsd = &vmstate_usb_device, \
534 .flags = VMS_STRUCT, \
535 .offset = vmstate_offset_value(_state, _field, USBDevice), \
536}
537
73796fe6
GH		 538USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
539
62aed765
AL		 540void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
541
542void usb_device_handle_attach(USBDevice *dev);
543
544void usb_device_handle_reset(USBDevice *dev);
545
9a77a0f5
HG		 546void usb_device_handle_control(USBDevice *dev, USBPacket *p, int request,
547 int val, int index, int length, uint8_t *data);
62aed765 548
9a77a0f5 549void usb_device_handle_data(USBDevice *dev, USBPacket *p);
62aed765
AL		 550
551void usb_device_set_interface(USBDevice *dev, int interface,
552 int alt_old, int alt_new);
553
36dfe324
HG		 554void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);
555
f79738b0
HG		 556void usb_device_ep_stopped(USBDevice *dev, USBEndpoint *ep);
557
3b444ead
HG		 558int usb_device_alloc_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps,
559 int streams);
560void usb_device_free_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps);
561
62aed765
AL		 562const char *usb_device_get_product_desc(USBDevice *dev);
563
564const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
565
b2d1fe67
HG		 566/* quirks.c */
567
568/* In bulk endpoints are streaming data sources (iow behave like isoc eps) */
569#define USB_QUIRK_BUFFER_BULK_IN 0x01
570/* Bulk pkts in FTDI format, need special handling when combining packets */
571#define USB_QUIRK_IS_FTDI 0x02
701a8f76 572
b2d1fe67
HG		 573int usb_get_quirks(uint16_t vendor_id, uint16_t product_id,
574 uint8_t interface_class, uint8_t interface_subclass,
575 uint8_t interface_protocol);
576
577#endif
QEMU mirror