xref: /openbmc/qemu/include/hw/usb.h (revision b8bcf811)
1 #ifndef QEMU_USB_H
2 #define QEMU_USB_H
3 
4 /*
5  * QEMU USB API
6  *
7  * Copyright (c) 2005 Fabrice Bellard
8  *
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  */
27 
28 #include "hw/qdev.h"
29 #include "qemu/queue.h"
30 
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 
37 #define USB_TOKEN_SETUP 0x2d
38 #define USB_TOKEN_IN    0x69 /* device -> host */
39 #define USB_TOKEN_OUT   0xe1 /* host -> device */
40 
41 #define USB_RET_SUCCESS           (0)
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)
49 #define USB_RET_REMOVE_FROM_QUEUE (-8)
50 
51 #define USB_SPEED_LOW   0
52 #define USB_SPEED_FULL  1
53 #define USB_SPEED_HIGH  2
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)
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 
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 
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 
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)
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                                        \
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)
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)
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)
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
146 #define USB_DT_DEVICE_QUALIFIER         0x06
147 #define USB_DT_OTHER_SPEED_CONFIG       0x07
148 #define USB_DT_DEBUG                    0x0A
149 #define USB_DT_INTERFACE_ASSOC          0x0B
150 #define USB_DT_BOS                      0x0F
151 #define USB_DT_DEVICE_CAPABILITY        0x10
152 #define USB_DT_CS_INTERFACE             0x24
153 #define USB_DT_CS_ENDPOINT              0x25
154 #define USB_DT_ENDPOINT_COMPANION       0x30
155 
156 #define USB_DEV_CAP_WIRELESS            0x01
157 #define USB_DEV_CAP_USB2_EXT            0x02
158 #define USB_DEV_CAP_SUPERSPEED          0x03
159 
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
164 #define USB_ENDPOINT_XFER_INVALID     255
165 
166 #define USB_INTERFACE_INVALID         255
167 
168 typedef struct USBBus USBBus;
169 typedef struct USBBusOps USBBusOps;
170 typedef struct USBPort USBPort;
171 typedef struct USBDevice USBDevice;
172 typedef struct USBPacket USBPacket;
173 typedef struct USBCombinedPacket USBCombinedPacket;
174 typedef struct USBEndpoint USBEndpoint;
175 
176 typedef struct USBDesc USBDesc;
177 typedef struct USBDescID USBDescID;
178 typedef struct USBDescDevice USBDescDevice;
179 typedef struct USBDescConfig USBDescConfig;
180 typedef struct USBDescIfaceAssoc USBDescIfaceAssoc;
181 typedef struct USBDescIface USBDescIface;
182 typedef struct USBDescEndpoint USBDescEndpoint;
183 typedef struct USBDescOther USBDescOther;
184 typedef struct USBDescString USBDescString;
185 typedef struct USBDescMSOS USBDescMSOS;
186 
187 struct USBDescString {
188     uint8_t index;
189     char *str;
190     QLIST_ENTRY(USBDescString) next;
191 };
192 
193 #define USB_MAX_ENDPOINTS  15
194 #define USB_MAX_INTERFACES 16
195 
196 struct USBEndpoint {
197     uint8_t nr;
198     uint8_t pid;
199     uint8_t type;
200     uint8_t ifnum;
201     int max_packet_size;
202     int max_streams;
203     bool pipeline;
204     bool halted;
205     USBDevice *dev;
206     QTAILQ_HEAD(, USBPacket) queue;
207 };
208 
209 enum USBDeviceFlags {
210     USB_DEV_FLAG_FULL_PATH,
211     USB_DEV_FLAG_IS_HOST,
212     USB_DEV_FLAG_MSOS_DESC_ENABLE,
213     USB_DEV_FLAG_MSOS_DESC_IN_USE,
214 };
215 
216 /* definition of a USB device */
217 struct USBDevice {
218     DeviceState qdev;
219     USBPort *port;
220     char *port_path;
221     char *serial;
222     void *opaque;
223     uint32_t flags;
224 
225     /* Actual connected speed */
226     int speed;
227     /* Supported speeds, not in info because it may be variable (hostdevs) */
228     int speedmask;
229     uint8_t addr;
230     char product_desc[32];
231     int auto_attach;
232     int attached;
233 
234     int32_t state;
235     uint8_t setup_buf[8];
236     uint8_t data_buf[4096];
237     int32_t remote_wakeup;
238     int32_t setup_state;
239     int32_t setup_len;
240     int32_t setup_index;
241 
242     USBEndpoint ep_ctl;
243     USBEndpoint ep_in[USB_MAX_ENDPOINTS];
244     USBEndpoint ep_out[USB_MAX_ENDPOINTS];
245 
246     QLIST_HEAD(, USBDescString) strings;
247     const USBDesc *usb_desc; /* Overrides class usb_desc if not NULL */
248     const USBDescDevice *device;
249 
250     int configuration;
251     int ninterfaces;
252     int altsetting[USB_MAX_INTERFACES];
253     const USBDescConfig *config;
254     const USBDescIface  *ifaces[USB_MAX_INTERFACES];
255 };
256 
257 #define TYPE_USB_DEVICE "usb-device"
258 #define USB_DEVICE(obj) \
259      OBJECT_CHECK(USBDevice, (obj), TYPE_USB_DEVICE)
260 #define USB_DEVICE_CLASS(klass) \
261      OBJECT_CLASS_CHECK(USBDeviceClass, (klass), TYPE_USB_DEVICE)
262 #define USB_DEVICE_GET_CLASS(obj) \
263      OBJECT_GET_CLASS(USBDeviceClass, (obj), TYPE_USB_DEVICE)
264 
265 typedef struct USBDeviceClass {
266     DeviceClass parent_class;
267 
268     int (*init)(USBDevice *dev);
269 
270     /*
271      * Walk (enabled) downstream ports, check for a matching device.
272      * Only hubs implement this.
273      */
274     USBDevice *(*find_device)(USBDevice *dev, uint8_t addr);
275 
276     /*
277      * Called when a packet is canceled.
278      */
279     void (*cancel_packet)(USBDevice *dev, USBPacket *p);
280 
281     /*
282      * Called when device is destroyed.
283      */
284     void (*handle_destroy)(USBDevice *dev);
285 
286     /*
287      * Attach the device
288      */
289     void (*handle_attach)(USBDevice *dev);
290 
291     /*
292      * Reset the device
293      */
294     void (*handle_reset)(USBDevice *dev);
295 
296     /*
297      * Process control request.
298      * Called from handle_packet().
299      *
300      * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
301      * then the number of bytes transferred is stored in p->actual_length
302      */
303     void (*handle_control)(USBDevice *dev, USBPacket *p, int request, int value,
304                            int index, int length, uint8_t *data);
305 
306     /*
307      * Process data transfers (both BULK and ISOC).
308      * Called from handle_packet().
309      *
310      * Status gets stored in p->status, and if p->status == USB_RET_SUCCESS
311      * then the number of bytes transferred is stored in p->actual_length
312      */
313     void (*handle_data)(USBDevice *dev, USBPacket *p);
314 
315     void (*set_interface)(USBDevice *dev, int interface,
316                           int alt_old, int alt_new);
317 
318     /*
319      * Called when the hcd is done queuing packets for an endpoint, only
320      * necessary for devices which can return USB_RET_ADD_TO_QUEUE.
321      */
322     void (*flush_ep_queue)(USBDevice *dev, USBEndpoint *ep);
323 
324     /*
325      * Called by the hcd to let the device know the queue for an endpoint
326      * has been unlinked / stopped. Optional may be NULL.
327      */
328     void (*ep_stopped)(USBDevice *dev, USBEndpoint *ep);
329 
330     /*
331      * Called by the hcd to alloc / free streams on a bulk endpoint.
332      * Optional may be NULL.
333      */
334     int (*alloc_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps,
335                          int streams);
336     void (*free_streams)(USBDevice *dev, USBEndpoint **eps, int nr_eps);
337 
338     const char *product_desc;
339     const USBDesc *usb_desc;
340 } USBDeviceClass;
341 
342 typedef struct USBPortOps {
343     void (*attach)(USBPort *port);
344     void (*detach)(USBPort *port);
345     /*
346      * This gets called when a device downstream from the device attached to
347      * the port (iow attached through a hub) gets detached.
348      */
349     void (*child_detach)(USBPort *port, USBDevice *child);
350     void (*wakeup)(USBPort *port);
351     /*
352      * Note that port->dev will be different then the device from which
353      * the packet originated when a hub is involved.
354      */
355     void (*complete)(USBPort *port, USBPacket *p);
356 } USBPortOps;
357 
358 /* USB port on which a device can be connected */
359 struct USBPort {
360     USBDevice *dev;
361     int speedmask;
362     int hubcount;
363     char path[16];
364     USBPortOps *ops;
365     void *opaque;
366     int index; /* internal port index, may be used with the opaque */
367     QTAILQ_ENTRY(USBPort) next;
368 };
369 
370 typedef void USBCallback(USBPacket * packet, void *opaque);
371 
372 typedef enum USBPacketState {
373     USB_PACKET_UNDEFINED = 0,
374     USB_PACKET_SETUP,
375     USB_PACKET_QUEUED,
376     USB_PACKET_ASYNC,
377     USB_PACKET_COMPLETE,
378     USB_PACKET_CANCELED,
379 } USBPacketState;
380 
381 /* Structure used to hold information about an active USB packet.  */
382 struct USBPacket {
383     /* Data fields for use by the driver.  */
384     int pid;
385     uint64_t id;
386     USBEndpoint *ep;
387     unsigned int stream;
388     QEMUIOVector iov;
389     uint64_t parameter; /* control transfers */
390     bool short_not_ok;
391     bool int_req;
392     int status; /* USB_RET_* status code */
393     int actual_length; /* Number of bytes actually transferred */
394     /* Internal use by the USB layer.  */
395     USBPacketState state;
396     USBCombinedPacket *combined;
397     QTAILQ_ENTRY(USBPacket) queue;
398     QTAILQ_ENTRY(USBPacket) combined_entry;
399 };
400 
401 struct USBCombinedPacket {
402     USBPacket *first;
403     QTAILQ_HEAD(packets_head, USBPacket) packets;
404     QEMUIOVector iov;
405 };
406 
407 void usb_packet_init(USBPacket *p);
408 void usb_packet_set_state(USBPacket *p, USBPacketState state);
409 void usb_packet_check_state(USBPacket *p, USBPacketState expected);
410 void usb_packet_setup(USBPacket *p, int pid,
411                       USBEndpoint *ep, unsigned int stream,
412                       uint64_t id, bool short_not_ok, bool int_req);
413 void usb_packet_addbuf(USBPacket *p, void *ptr, size_t len);
414 int usb_packet_map(USBPacket *p, QEMUSGList *sgl);
415 void usb_packet_unmap(USBPacket *p, QEMUSGList *sgl);
416 void usb_packet_copy(USBPacket *p, void *ptr, size_t bytes);
417 void usb_packet_skip(USBPacket *p, size_t bytes);
418 size_t usb_packet_size(USBPacket *p);
419 void usb_packet_cleanup(USBPacket *p);
420 
421 static inline bool usb_packet_is_inflight(USBPacket *p)
422 {
423     return (p->state == USB_PACKET_QUEUED ||
424             p->state == USB_PACKET_ASYNC);
425 }
426 
427 USBDevice *usb_find_device(USBPort *port, uint8_t addr);
428 
429 void usb_handle_packet(USBDevice *dev, USBPacket *p);
430 void usb_packet_complete(USBDevice *dev, USBPacket *p);
431 void usb_packet_complete_one(USBDevice *dev, USBPacket *p);
432 void usb_cancel_packet(USBPacket * p);
433 
434 void usb_ep_init(USBDevice *dev);
435 void usb_ep_reset(USBDevice *dev);
436 void usb_ep_dump(USBDevice *dev);
437 struct USBEndpoint *usb_ep_get(USBDevice *dev, int pid, int ep);
438 uint8_t usb_ep_get_type(USBDevice *dev, int pid, int ep);
439 uint8_t usb_ep_get_ifnum(USBDevice *dev, int pid, int ep);
440 void usb_ep_set_type(USBDevice *dev, int pid, int ep, uint8_t type);
441 void usb_ep_set_ifnum(USBDevice *dev, int pid, int ep, uint8_t ifnum);
442 void usb_ep_set_max_packet_size(USBDevice *dev, int pid, int ep,
443                                 uint16_t raw);
444 int usb_ep_get_max_packet_size(USBDevice *dev, int pid, int ep);
445 void usb_ep_set_max_streams(USBDevice *dev, int pid, int ep, uint8_t raw);
446 int usb_ep_get_max_streams(USBDevice *dev, int pid, int ep);
447 void usb_ep_set_pipeline(USBDevice *dev, int pid, int ep, bool enabled);
448 void usb_ep_set_halted(USBDevice *dev, int pid, int ep, bool halted);
449 USBPacket *usb_ep_find_packet_by_id(USBDevice *dev, int pid, int ep,
450                                     uint64_t id);
451 
452 void usb_ep_combine_input_packets(USBEndpoint *ep);
453 void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p);
454 void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p);
455 
456 void usb_attach(USBPort *port);
457 void usb_detach(USBPort *port);
458 void usb_port_reset(USBPort *port);
459 void usb_device_reset(USBDevice *dev);
460 void usb_wakeup(USBEndpoint *ep, unsigned int stream);
461 void usb_generic_async_ctrl_complete(USBDevice *s, USBPacket *p);
462 int set_usb_string(uint8_t *buf, const char *str);
463 
464 /* usb-linux.c */
465 USBDevice *usb_host_device_open(USBBus *bus, const char *devname);
466 void usb_host_info(Monitor *mon, const QDict *qdict);
467 
468 /* usb ports of the VM */
469 
470 #define VM_USB_HUB_SIZE 8
471 
472 /* usb-musb.c */
473 enum musb_irq_source_e {
474     musb_irq_suspend = 0,
475     musb_irq_resume,
476     musb_irq_rst_babble,
477     musb_irq_sof,
478     musb_irq_connect,
479     musb_irq_disconnect,
480     musb_irq_vbus_request,
481     musb_irq_vbus_error,
482     musb_irq_rx,
483     musb_irq_tx,
484     musb_set_vbus,
485     musb_set_session,
486     /* Add new interrupts here */
487     musb_irq_max, /* total number of interrupts defined */
488 };
489 
490 typedef struct MUSBState MUSBState;
491 MUSBState *musb_init(DeviceState *parent_device, int gpio_base);
492 void musb_reset(MUSBState *s);
493 uint32_t musb_core_intr_get(MUSBState *s);
494 void musb_core_intr_clear(MUSBState *s, uint32_t mask);
495 void musb_set_size(MUSBState *s, int epnum, int size, int is_tx);
496 
497 /* usb-bus.c */
498 
499 #define TYPE_USB_BUS "usb-bus"
500 #define USB_BUS(obj) OBJECT_CHECK(USBBus, (obj), TYPE_USB_BUS)
501 
502 struct USBBus {
503     BusState qbus;
504     USBBusOps *ops;
505     int busnr;
506     int nfree;
507     int nused;
508     QTAILQ_HEAD(, USBPort) free;
509     QTAILQ_HEAD(, USBPort) used;
510     QTAILQ_ENTRY(USBBus) next;
511 };
512 
513 struct USBBusOps {
514     int (*register_companion)(USBBus *bus, USBPort *ports[],
515                               uint32_t portcount, uint32_t firstport);
516     void (*wakeup_endpoint)(USBBus *bus, USBEndpoint *ep, unsigned int stream);
517 };
518 
519 void usb_bus_new(USBBus *bus, size_t bus_size,
520                  USBBusOps *ops, DeviceState *host);
521 USBBus *usb_bus_find(int busnr);
522 void usb_legacy_register(const char *typename, const char *usbdevice_name,
523                          USBDevice *(*usbdevice_init)(USBBus *bus,
524                                                       const char *params));
525 USBDevice *usb_create(USBBus *bus, const char *name);
526 USBDevice *usb_create_simple(USBBus *bus, const char *name);
527 USBDevice *usbdevice_create(const char *cmdline);
528 void usb_register_port(USBBus *bus, USBPort *port, void *opaque, int index,
529                        USBPortOps *ops, int speedmask);
530 int usb_register_companion(const char *masterbus, USBPort *ports[],
531                            uint32_t portcount, uint32_t firstport,
532                            void *opaque, USBPortOps *ops, int speedmask);
533 void usb_port_location(USBPort *downstream, USBPort *upstream, int portnr);
534 void usb_unregister_port(USBBus *bus, USBPort *port);
535 int usb_claim_port(USBDevice *dev);
536 void usb_release_port(USBDevice *dev);
537 int usb_device_attach(USBDevice *dev);
538 int usb_device_detach(USBDevice *dev);
539 int usb_device_delete_addr(int busnr, int addr);
540 
541 static inline USBBus *usb_bus_from_device(USBDevice *d)
542 {
543     return DO_UPCAST(USBBus, qbus, d->qdev.parent_bus);
544 }
545 
546 extern const VMStateDescription vmstate_usb_device;
547 
548 #define VMSTATE_USB_DEVICE(_field, _state) {                         \
549     .name       = (stringify(_field)),                               \
550     .size       = sizeof(USBDevice),                                 \
551     .vmsd       = &vmstate_usb_device,                               \
552     .flags      = VMS_STRUCT,                                        \
553     .offset     = vmstate_offset_value(_state, _field, USBDevice),   \
554 }
555 
556 USBDevice *usb_device_find_device(USBDevice *dev, uint8_t addr);
557 
558 void usb_device_cancel_packet(USBDevice *dev, USBPacket *p);
559 
560 void usb_device_handle_attach(USBDevice *dev);
561 
562 void usb_device_handle_reset(USBDevice *dev);
563 
564 void usb_device_handle_control(USBDevice *dev, USBPacket *p, int request,
565                                int val, int index, int length, uint8_t *data);
566 
567 void usb_device_handle_data(USBDevice *dev, USBPacket *p);
568 
569 void usb_device_set_interface(USBDevice *dev, int interface,
570                               int alt_old, int alt_new);
571 
572 void usb_device_flush_ep_queue(USBDevice *dev, USBEndpoint *ep);
573 
574 void usb_device_ep_stopped(USBDevice *dev, USBEndpoint *ep);
575 
576 int usb_device_alloc_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps,
577                              int streams);
578 void usb_device_free_streams(USBDevice *dev, USBEndpoint **eps, int nr_eps);
579 
580 const char *usb_device_get_product_desc(USBDevice *dev);
581 
582 const USBDesc *usb_device_get_usb_desc(USBDevice *dev);
583 
584 int ehci_create_ich9_with_companions(PCIBus *bus, int slot);
585 
586 /* quirks.c */
587 
588 /* In bulk endpoints are streaming data sources (iow behave like isoc eps) */
589 #define USB_QUIRK_BUFFER_BULK_IN	0x01
590 /* Bulk pkts in FTDI format, need special handling when combining packets */
591 #define USB_QUIRK_IS_FTDI		0x02
592 
593 int usb_get_quirks(uint16_t vendor_id, uint16_t product_id,
594                    uint8_t interface_class, uint8_t interface_subclass,
595                    uint8_t interface_protocol);
596 
597 #endif
598