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