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