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