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