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