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