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