VirtualBox

source: vbox/trunk/include/VBox/vusb.h@ 53294

Last change on this file since 53294 was 53210, checked in by vboxsync, 10 years ago

PDM/VUSB: Provide port/device speed to HCs (and emulated devices).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 39.8 KB
Line 
1/** @file
2 * VUSB - VirtualBox USB. (DEV,VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2012 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_vusb_h
27#define ___VBox_vusb_h
28
29#include <VBox/cdefs.h>
30#include <VBox/types.h>
31
32#include <iprt/queueatomic.h>
33
34struct PDMLED;
35
36RT_C_DECLS_BEGIN
37
38/** @defgroup grp_vusb VBox USB API
39 * @{
40 */
41
42/** @defgroup grp_vusb_std Standard Stuff
43 * @{ */
44
45/** Frequency of USB bus (from spec). */
46#define VUSB_BUS_HZ 12000000
47
48
49/** @name USB Descriptor types (from spec)
50 * @{ */
51#define VUSB_DT_DEVICE 0x01
52#define VUSB_DT_CONFIG 0x02
53#define VUSB_DT_STRING 0x03
54#define VUSB_DT_INTERFACE 0x04
55#define VUSB_DT_ENDPOINT 0x05
56#define VUSB_DT_DEVICE_QUALIFIER 0x06
57#define VUSB_DT_OTHER_SPEED_CFG 0x07
58#define VUSB_DT_INTERFACE_POWER 0x08
59#define VUSB_DT_INTERFACE_ASSOCIATION 0x0B
60#define VUSB_DT_BOS 0x0F
61#define VUSB_DT_DEVICE_CAPABILITY 0x10
62#define VUSB_DT_SS_ENDPOINT_COMPANION 0x30
63/** @} */
64
65/** @name USB Descriptor minimum sizes (from spec)
66 * @{ */
67#define VUSB_DT_DEVICE_MIN_LEN 18
68#define VUSB_DT_CONFIG_MIN_LEN 9
69#define VUSB_DT_CONFIG_STRING_MIN_LEN 2
70#define VUSB_DT_INTERFACE_MIN_LEN 9
71#define VUSB_DT_ENDPOINT_MIN_LEN 7
72/** @} */
73
74/** @name USB Device Capability Type Codes (from spec)
75 * @{ */
76#define VUSB_DCT_WIRELESS_USB 0x01
77#define VUSB_DCT_USB_20_EXTENSION 0x02
78#define VUSB_DCT_SUPERSPEED_USB 0x03
79#define VUSB_DCT_CONTAINER_ID 0x04
80/** @} */
81
82
83#pragma pack(1) /* ensure byte packing of the descriptors. */
84
85/**
86 * USB language id descriptor (from specs).
87 */
88typedef struct VUSBDESCLANGID
89{
90 uint8_t bLength;
91 uint8_t bDescriptorType;
92} VUSBDESCLANGID;
93/** Pointer to a USB language id descriptor. */
94typedef VUSBDESCLANGID *PVUSBDESCLANGID;
95/** Pointer to a const USB language id descriptor. */
96typedef const VUSBDESCLANGID *PCVUSBDESCLANGID;
97
98
99/**
100 * USB string descriptor (from specs).
101 */
102typedef struct VUSBDESCSTRING
103{
104 uint8_t bLength;
105 uint8_t bDescriptorType;
106} VUSBDESCSTRING;
107/** Pointer to a USB string descriptor. */
108typedef VUSBDESCSTRING *PVUSBDESCSTRING;
109/** Pointer to a const USB string descriptor. */
110typedef const VUSBDESCSTRING *PCVUSBDESCSTRING;
111
112
113/**
114 * USB device descriptor (from spec)
115 */
116typedef struct VUSBDESCDEVICE
117{
118 uint8_t bLength;
119 uint8_t bDescriptorType;
120 uint16_t bcdUSB;
121 uint8_t bDeviceClass;
122 uint8_t bDeviceSubClass;
123 uint8_t bDeviceProtocol;
124 uint8_t bMaxPacketSize0;
125 uint16_t idVendor;
126 uint16_t idProduct;
127 uint16_t bcdDevice;
128 uint8_t iManufacturer;
129 uint8_t iProduct;
130 uint8_t iSerialNumber;
131 uint8_t bNumConfigurations;
132} VUSBDESCDEVICE;
133/** Pointer to a USB device descriptor. */
134typedef VUSBDESCDEVICE *PVUSBDESCDEVICE;
135/** Pointer to a const USB device descriptor. */
136typedef const VUSBDESCDEVICE *PCVUSBDESCDEVICE;
137
138/**
139 * USB device qualifier (from spec 9.6.2)
140 */
141struct VUSBDEVICEQUALIFIER
142{
143 uint8_t bLength;
144 uint8_t bDescriptorType;
145 uint16_t bcdUsb;
146 uint8_t bDeviceClass;
147 uint8_t bDeviceSubClass;
148 uint8_t bDeviceProtocol;
149 uint8_t bMaxPacketSize0;
150 uint8_t bNumConfigurations;
151 uint8_t bReserved;
152};
153
154typedef struct VUSBDEVICEQUALIFIER VUSBDEVICEQUALIFIER;
155typedef VUSBDEVICEQUALIFIER *PVUSBDEVICEQUALIFIER;
156
157
158/**
159 * USB configuration descriptor (from spec).
160 */
161typedef struct VUSBDESCCONFIG
162{
163 uint8_t bLength;
164 uint8_t bDescriptorType;
165 uint16_t wTotalLength; /**< recalculated by VUSB when involved in URB. */
166 uint8_t bNumInterfaces;
167 uint8_t bConfigurationValue;
168 uint8_t iConfiguration;
169 uint8_t bmAttributes;
170 uint8_t MaxPower;
171} VUSBDESCCONFIG;
172/** Pointer to a USB configuration descriptor. */
173typedef VUSBDESCCONFIG *PVUSBDESCCONFIG;
174/** Pointer to a readonly USB configuration descriptor. */
175typedef const VUSBDESCCONFIG *PCVUSBDESCCONFIG;
176
177
178/**
179 * USB interface association descriptor (from USB ECN Interface Association Descriptors)
180 */
181typedef struct VUSBDESCIAD
182{
183 uint8_t bLength;
184 uint8_t bDescriptorType;
185 uint8_t bFirstInterface;
186 uint8_t bInterfaceCount;
187 uint8_t bFunctionClass;
188 uint8_t bFunctionSubClass;
189 uint8_t bFunctionProtocol;
190 uint8_t iFunction;
191} VUSBDESCIAD;
192/** Pointer to a USB interface association descriptor. */
193typedef VUSBDESCIAD *PVUSBDESCIAD;
194/** Pointer to a readonly USB interface association descriptor. */
195typedef const VUSBDESCIAD *PCVUSBDESCIAD;
196
197
198/**
199 * USB interface descriptor (from spec)
200 */
201typedef struct VUSBDESCINTERFACE
202{
203 uint8_t bLength;
204 uint8_t bDescriptorType;
205 uint8_t bInterfaceNumber;
206 uint8_t bAlternateSetting;
207 uint8_t bNumEndpoints;
208 uint8_t bInterfaceClass;
209 uint8_t bInterfaceSubClass;
210 uint8_t bInterfaceProtocol;
211 uint8_t iInterface;
212} VUSBDESCINTERFACE;
213/** Pointer to a USB interface descriptor. */
214typedef VUSBDESCINTERFACE *PVUSBDESCINTERFACE;
215/** Pointer to a const USB interface descriptor. */
216typedef const VUSBDESCINTERFACE *PCVUSBDESCINTERFACE;
217
218
219/**
220 * USB endpoint descriptor (from spec)
221 */
222typedef struct VUSBDESCENDPOINT
223{
224 uint8_t bLength;
225 uint8_t bDescriptorType;
226 uint8_t bEndpointAddress;
227 uint8_t bmAttributes;
228 uint16_t wMaxPacketSize;
229 uint8_t bInterval;
230} VUSBDESCENDPOINT;
231/** Pointer to a USB endpoint descriptor. */
232typedef VUSBDESCENDPOINT *PVUSBDESCENDPOINT;
233/** Pointer to a const USB endpoint descriptor. */
234typedef const VUSBDESCENDPOINT *PCVUSBDESCENDPOINT;
235
236
237/**
238 * USB SuperSpeed endpoint companion descriptor (from USB3 spec)
239 */
240typedef struct VUSBDESCSSEPCOMPANION
241{
242 uint8_t bLength;
243 uint8_t bDescriptorType;
244 uint8_t bMaxBurst;
245 uint8_t bmAttributes;
246 uint16_t wBytesPerInterval;
247} VUSBDESCSSEPCOMPANION;
248/** Pointer to a USB endpoint companion descriptor. */
249typedef VUSBDESCSSEPCOMPANION *PVUSBDESCSSEPCOMPANION;
250/** Pointer to a const USB endpoint companion descriptor. */
251typedef const VUSBDESCSSEPCOMPANION *PCVUSBDESCSSEPCOMPANION;
252
253
254/**
255 * USB Binary Device Object Store, aka BOS (from USB3 spec)
256 */
257typedef struct VUSBDESCBOS
258{
259 uint8_t bLength;
260 uint8_t bDescriptorType;
261 uint16_t wTotalLength;
262 uint8_t bNumDeviceCaps;
263} VUSBDESCBOS;
264/** Pointer to a USB BOS descriptor. */
265typedef VUSBDESCBOS *PVUSBDESCBOS;
266/** Pointer to a const USB BOS descriptor. */
267typedef const VUSBDESCBOS *PCVUSBDESCBOS;
268
269
270/**
271 * Generic USB Device Capability Descriptor within BOS (from USB3 spec)
272 */
273typedef struct VUSBDESCDEVICECAP
274{
275 uint8_t bLength;
276 uint8_t bDescriptorType;
277 uint8_t bDevCapabilityType;
278 uint8_t aCapSpecific[1];
279} VUSBDESCDEVICECAP;
280/** Pointer to a USB device capability descriptor. */
281typedef VUSBDESCDEVICECAP *PVUSBDESCDEVICECAP;
282/** Pointer to a const USB device capability descriptor. */
283typedef const VUSBDESCDEVICECAP *PCVUSBDESCDEVICECAP;
284
285
286/**
287 * SuperSpeed USB Device Capability Descriptor within BOS
288 */
289typedef struct VUSBDESCSSDEVCAP
290{
291 uint8_t bLength;
292 uint8_t bDescriptorType; /* DEVICE CAPABILITY */
293 uint8_t bDevCapabilityType; /* SUPERSPEED_USB */
294 uint8_t bmAttributes;
295 uint16_t wSpeedsSupported;
296 uint8_t bFunctionalitySupport;
297 uint8_t bU1DevExitLat;
298 uint16_t wU2DevExitLat;
299} VUSBDESCSSDEVCAP;
300/** Pointer to an SS USB device capability descriptor. */
301typedef VUSBDESCSSDEVCAP *PVUSBDESCSSDEVCAP;
302/** Pointer to a const SS USB device capability descriptor. */
303typedef const VUSBDESCSSDEVCAP *PCVUSBDESCSSDEVCAP;
304
305
306/**
307 * USB 2.0 Extension Descriptor within BOS
308 */
309typedef struct VUSBDESCUSB2EXT
310{
311 uint8_t bLength;
312 uint8_t bDescriptorType; /* DEVICE CAPABILITY */
313 uint8_t bDevCapabilityType; /* USB 2.0 EXTENSION */
314 uint8_t bmAttributes;
315} VUSBDESCUSB2EXT;
316/** Pointer to a USB 2.0 extension capability descriptor. */
317typedef VUSBDESCUSB2EXT *PVUSBDESCUSB2EXT;
318/** Pointer to a const USB 2.0 extension capability descriptor. */
319typedef const VUSBDESCUSB2EXT *PCVUSBDESCUSB2EXT;
320
321
322#pragma pack() /* end of the byte packing. */
323
324
325/**
326 * USB configuration descriptor, the parsed variant used by VUSB.
327 */
328typedef struct VUSBDESCCONFIGEX
329{
330 /** The USB descriptor data.
331 * @remark The wTotalLength member is recalculated before the data is passed to the guest. */
332 VUSBDESCCONFIG Core;
333 /** Pointer to additional descriptor bytes following what's covered by VUSBDESCCONFIG. */
334 void *pvMore;
335 /** Pointer to an array of the interfaces referenced in the configuration.
336 * Core.bNumInterfaces in size. */
337 const struct VUSBINTERFACE *paIfs;
338 /** Pointer to the original descriptor data read from the device. */
339 const void *pvOriginal;
340} VUSBDESCCONFIGEX;
341/** Pointer to a parsed USB configuration descriptor. */
342typedef VUSBDESCCONFIGEX *PVUSBDESCCONFIGEX;
343/** Pointer to a const parsed USB configuration descriptor. */
344typedef const VUSBDESCCONFIGEX *PCVUSBDESCCONFIGEX;
345
346
347/**
348 * For tracking the alternate interface settings of a configuration.
349 */
350typedef struct VUSBINTERFACE
351{
352 /** Pointer to an array of interfaces. */
353 const struct VUSBDESCINTERFACEEX *paSettings;
354 /** The number of entries in the array. */
355 uint32_t cSettings;
356} VUSBINTERFACE;
357/** Pointer to a VUSBINTERFACE. */
358typedef VUSBINTERFACE *PVUSBINTERFACE;
359/** Pointer to a const VUSBINTERFACE. */
360typedef const VUSBINTERFACE *PCVUSBINTERFACE;
361
362
363/**
364 * USB interface descriptor, the parsed variant used by VUSB.
365 */
366typedef struct VUSBDESCINTERFACEEX
367{
368 /** The USB descriptor data. */
369 VUSBDESCINTERFACE Core;
370 /** Pointer to additional descriptor bytes following what's covered by VUSBDESCINTERFACE. */
371 const void *pvMore;
372 /** Pointer to additional class- or vendor-specific interface descriptors. */
373 const void *pvClass;
374 /** Size of class- or vendor-specific descriptors. */
375 uint16_t cbClass;
376 /** Pointer to an array of the endpoints referenced by the interface.
377 * Core.bNumEndpoints in size. */
378 const struct VUSBDESCENDPOINTEX *paEndpoints;
379 /** Interface association descriptor, which prepends a group of interfaces,
380 * starting with this interface. */
381 PCVUSBDESCIAD pIAD;
382 /** Size of interface association descriptor. */
383 uint16_t cbIAD;
384} VUSBDESCINTERFACEEX;
385/** Pointer to an prased USB interface descriptor. */
386typedef VUSBDESCINTERFACEEX *PVUSBDESCINTERFACEEX;
387/** Pointer to a const parsed USB interface descriptor. */
388typedef const VUSBDESCINTERFACEEX *PCVUSBDESCINTERFACEEX;
389
390
391/**
392 * USB endpoint descriptor, the parsed variant used by VUSB.
393 */
394typedef struct VUSBDESCENDPOINTEX
395{
396 /** The USB descriptor data.
397 * @remark The wMaxPacketSize member is converted to native endian. */
398 VUSBDESCENDPOINT Core;
399 /** Pointer to additional descriptor bytes following what's covered by VUSBDESCENDPOINT. */
400 const void *pvMore;
401 /** Pointer to additional class- or vendor-specific interface descriptors. */
402 const void *pvClass;
403 /** Size of class- or vendor-specific descriptors. */
404 uint16_t cbClass;
405} VUSBDESCENDPOINTEX;
406/** Pointer to a parsed USB endpoint descriptor. */
407typedef VUSBDESCENDPOINTEX *PVUSBDESCENDPOINTEX;
408/** Pointer to a const parsed USB endpoint descriptor. */
409typedef const VUSBDESCENDPOINTEX *PCVUSBDESCENDPOINTEX;
410
411
412/** @name USB Control message recipient codes (from spec)
413 * @{ */
414#define VUSB_TO_DEVICE 0x0
415#define VUSB_TO_INTERFACE 0x1
416#define VUSB_TO_ENDPOINT 0x2
417#define VUSB_TO_OTHER 0x3
418#define VUSB_RECIP_MASK 0x1f
419/** @} */
420
421/** @name USB control pipe setup packet structure (from spec)
422 * @{ */
423#define VUSB_REQ_SHIFT (5)
424#define VUSB_REQ_STANDARD (0x0 << VUSB_REQ_SHIFT)
425#define VUSB_REQ_CLASS (0x1 << VUSB_REQ_SHIFT)
426#define VUSB_REQ_VENDOR (0x2 << VUSB_REQ_SHIFT)
427#define VUSB_REQ_RESERVED (0x3 << VUSB_REQ_SHIFT)
428#define VUSB_REQ_MASK (0x3 << VUSB_REQ_SHIFT)
429/** @} */
430
431#define VUSB_DIR_TO_DEVICE 0x00
432#define VUSB_DIR_TO_HOST 0x80
433#define VUSB_DIR_MASK 0x80
434
435/**
436 * USB Setup request (from spec)
437 */
438typedef struct vusb_setup
439{
440 uint8_t bmRequestType;
441 uint8_t bRequest;
442 uint16_t wValue;
443 uint16_t wIndex;
444 uint16_t wLength;
445} VUSBSETUP;
446/** Pointer to a setup request. */
447typedef VUSBSETUP *PVUSBSETUP;
448/** Pointer to a const setup request. */
449typedef const VUSBSETUP *PCVUSBSETUP;
450
451/** @name USB Standard device requests (from spec)
452 * @{ */
453#define VUSB_REQ_GET_STATUS 0x00
454#define VUSB_REQ_CLEAR_FEATURE 0x01
455#define VUSB_REQ_SET_FEATURE 0x03
456#define VUSB_REQ_SET_ADDRESS 0x05
457#define VUSB_REQ_GET_DESCRIPTOR 0x06
458#define VUSB_REQ_SET_DESCRIPTOR 0x07
459#define VUSB_REQ_GET_CONFIGURATION 0x08
460#define VUSB_REQ_SET_CONFIGURATION 0x09
461#define VUSB_REQ_GET_INTERFACE 0x0a
462#define VUSB_REQ_SET_INTERFACE 0x0b
463#define VUSB_REQ_SYNCH_FRAME 0x0c
464#define VUSB_REQ_MAX 0x0d
465/** @} */
466
467/** @} */ /* end of grp_vusb_std */
468
469
470
471/** @name USB Standard version flags.
472 * @{ */
473/** Indicates USB 1.1 support. */
474#define VUSB_STDVER_11 RT_BIT(1)
475/** Indicates USB 2.0 support. */
476#define VUSB_STDVER_20 RT_BIT(2)
477/** Indicates USB 3.0 support. */
478#define VUSB_STDVER_30 RT_BIT(3)
479/** @} */
480
481/**
482 * USB port/device speeds.
483 */
484typedef enum VUSBSPEED
485{
486 /** Undetermined/unknown speed. */
487 VUSB_SPEED_UNKNOWN = 0,
488 /** Low-speed (LS), 1.5 Mbit/s, USB 1.0. */
489 VUSB_SPEED_LOW,
490 /** Full-speed (FS), 12 Mbit/s, USB 1.1. */
491 VUSB_SPEED_FULL,
492 /** High-speed (HS), 480 Mbit/s, USB 2.0. */
493 VUSB_SPEED_HIGH,
494 /** Variable speed, wireless USB 2.5. */
495 VUSB_SPEED_VARIABLE,
496 /** SuperSpeed (SS), 5.0 Gbit/s, USB 3.0. */
497 VUSB_SPEED_SUPER,
498 /** SuperSpeed+ (SS+), 10.0 Gbit/s, USB 3.1. */
499 VUSB_SPEED_SUPERPLUS,
500 /** The usual 32-bit hack. */
501 VUSB_SPEED_32BIT_HACK = 0x7fffffff
502} VUSBSPEED;
503
504/** Pointer to a VBox USB device interface. */
505typedef struct VUSBIDEVICE *PVUSBIDEVICE;
506
507/** Pointer to a VUSB RootHub port interface. */
508typedef struct VUSBIROOTHUBPORT *PVUSBIROOTHUBPORT;
509
510/** Pointer to an USB request descriptor. */
511typedef struct VUSBURB *PVUSBURB;
512
513
514
515/**
516 * VBox USB port bitmap.
517 *
518 * Bit 0 == Port 0, ... , Bit 127 == Port 127.
519 */
520typedef struct VUSBPORTBITMAP
521{
522 /** 128 bits */
523 char ach[16];
524} VUSBPORTBITMAP;
525/** Pointer to a VBox USB port bitmap. */
526typedef VUSBPORTBITMAP *PVUSBPORTBITMAP;
527
528#ifndef RDESKTOP
529
530/**
531 * The VUSB RootHub port interface provided by the HCI (down).
532 * Pair with VUSBIROOTCONNECTOR
533 */
534typedef struct VUSBIROOTHUBPORT
535{
536 /**
537 * Get the number of available ports in the hub.
538 *
539 * @returns The number of ports available.
540 * @param pInterface Pointer to this structure.
541 * @param pAvailable Bitmap indicating the available ports. Set bit == available port.
542 */
543 DECLR3CALLBACKMEMBER(unsigned, pfnGetAvailablePorts,(PVUSBIROOTHUBPORT pInterface, PVUSBPORTBITMAP pAvailable));
544
545 /**
546 * Gets the supported USB versions.
547 *
548 * @returns The mask of supported USB versions.
549 * @param pInterface Pointer to this structure.
550 */
551 DECLR3CALLBACKMEMBER(uint32_t, pfnGetUSBVersions,(PVUSBIROOTHUBPORT pInterface));
552
553 /**
554 * A device is being attached to a port in the roothub.
555 *
556 * @param pInterface Pointer to this structure.
557 * @param pDev Pointer to the device being attached.
558 * @param uPort The port number assigned to the device.
559 */
560 DECLR3CALLBACKMEMBER(int, pfnAttach,(PVUSBIROOTHUBPORT pInterface, PVUSBIDEVICE pDev, unsigned uPort));
561
562 /**
563 * A device is being detached from a port in the roothub.
564 *
565 * @param pInterface Pointer to this structure.
566 * @param pDev Pointer to the device being detached.
567 * @param uPort The port number assigned to the device.
568 */
569 DECLR3CALLBACKMEMBER(void, pfnDetach,(PVUSBIROOTHUBPORT pInterface, PVUSBIDEVICE pDev, unsigned uPort));
570
571 /**
572 * Reset the root hub.
573 *
574 * @returns VBox status code.
575 * @param pInterface Pointer to this structure.
576 * @param pResetOnLinux Whether or not to do real reset on linux.
577 */
578 DECLR3CALLBACKMEMBER(int, pfnReset,(PVUSBIROOTHUBPORT pInterface, bool fResetOnLinux));
579
580 /**
581 * Transfer completion callback routine.
582 *
583 * VUSB will call this when a transfer have been completed
584 * in a one or another way.
585 *
586 * @param pInterface Pointer to this structure.
587 * @param pUrb Pointer to the URB in question.
588 */
589 DECLR3CALLBACKMEMBER(void, pfnXferCompletion,(PVUSBIROOTHUBPORT pInterface, PVUSBURB urb));
590
591 /**
592 * Handle transfer errors.
593 *
594 * VUSB calls this when a transfer attempt failed. This function will respond
595 * indicating whether to retry or complete the URB with failure.
596 *
597 * @returns Retry indicator.
598 * @param pInterface Pointer to this structure.
599 * @param pUrb Pointer to the URB in question.
600 */
601 DECLR3CALLBACKMEMBER(bool, pfnXferError,(PVUSBIROOTHUBPORT pInterface, PVUSBURB pUrb));
602
603 /** Alignment dummy. */
604 RTR3PTR Alignment;
605
606} VUSBIROOTHUBPORT;
607/** VUSBIROOTHUBPORT interface ID. */
608#define VUSBIROOTHUBPORT_IID "e38e2978-7aa2-4860-94b6-9ef4a066d8a0"
609
610
611/** Pointer to a VUSB RootHub connector interface. */
612typedef struct VUSBIROOTHUBCONNECTOR *PVUSBIROOTHUBCONNECTOR;
613/**
614 * The VUSB RootHub connector interface provided by the VBox USB RootHub driver
615 * (up).
616 * Pair with VUSBIROOTHUBPORT.
617 */
618typedef struct VUSBIROOTHUBCONNECTOR
619{
620 /**
621 * Allocates a new URB for a transfer.
622 *
623 * Either submit using pfnSubmitUrb or free using VUSBUrbFree().
624 *
625 * @returns Pointer to a new URB.
626 * @returns NULL on failure - try again later.
627 * This will not fail if the device wasn't found. We'll fail it
628 * at submit time, since that makes the usage of this api simpler.
629 * @param pInterface Pointer to this struct.
630 * @param DstAddress The destination address of the URB.
631 * @param cbData The amount of data space required.
632 * @param cTds The amount of TD space.
633 */
634 DECLR3CALLBACKMEMBER(PVUSBURB, pfnNewUrb,(PVUSBIROOTHUBCONNECTOR pInterface, uint8_t DstAddress, uint32_t cbData, uint32_t cTds));
635
636 /**
637 * Submits a URB for transfer.
638 * The transfer will do asynchronously if possible.
639 *
640 * @returns VBox status code.
641 * @param pInterface Pointer to this struct.
642 * @param pUrb Pointer to the URB returned by pfnNewUrb.
643 * The URB will be freed in case of failure.
644 * @param pLed Pointer to USB Status LED
645 */
646 DECLR3CALLBACKMEMBER(int, pfnSubmitUrb,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb, struct PDMLED *pLed));
647
648 /**
649 * Call to service asynchronous URB completions in a polling fashion.
650 *
651 * Reaped URBs will be finished by calling the completion callback,
652 * thus there is no return code or input or anything from this function
653 * except for potential state changes elsewhere.
654 *
655 * @returns VINF_SUCCESS if no URBs are pending upon return.
656 * @returns VERR_TIMEOUT if one or more URBs are still in flight upon returning.
657 * @returns Other VBox status code.
658 *
659 * @param pInterface Pointer to this struct.
660 * @param cMillies Number of milliseconds to poll for completion.
661 */
662 DECLR3CALLBACKMEMBER(void, pfnReapAsyncUrbs,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice, RTMSINTERVAL cMillies));
663
664 /**
665 * Cancels and completes - with CRC failure - all URBs queued on an endpoint.
666 * This is done in response to guest URB cancellation.
667 *
668 * @returns VBox status code.
669 * @param pInterface Pointer to this struct.
670 * @param pUrb Pointer to a previously submitted URB.
671 */
672 DECLR3CALLBACKMEMBER(int, pfnCancelUrbsEp,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb));
673
674 /**
675 * Cancels and completes - with CRC failure - all in-flight async URBs.
676 * This is typically done before saving a state.
677 *
678 * @param pInterface Pointer to this struct.
679 */
680 DECLR3CALLBACKMEMBER(void, pfnCancelAllUrbs,(PVUSBIROOTHUBCONNECTOR pInterface));
681
682 /**
683 * Attach the device to the root hub.
684 * The device must not be attached to any hub for this call to succeed.
685 *
686 * @returns VBox status code.
687 * @param pInterface Pointer to this struct.
688 * @param pDevice Pointer to the device (interface) attach.
689 */
690 DECLR3CALLBACKMEMBER(int, pfnAttachDevice,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice));
691
692 /**
693 * Detach the device from the root hub.
694 * The device must already be attached for this call to succeed.
695 *
696 * @returns VBox status code.
697 * @param pInterface Pointer to this struct.
698 * @param pDevice Pointer to the device (interface) to detach.
699 */
700 DECLR3CALLBACKMEMBER(int, pfnDetachDevice,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice));
701
702} VUSBIROOTHUBCONNECTOR;
703/** VUSBIROOTHUBCONNECTOR interface ID. */
704#define VUSBIROOTHUBCONNECTOR_IID "d9a90c59-e3ff-4dff-9754-844557c3f7a0"
705
706
707#ifdef IN_RING3
708/** @copydoc VUSBIROOTHUBCONNECTOR::pfnNewUrb */
709DECLINLINE(PVUSBURB) VUSBIRhNewUrb(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t DstAddress, uint32_t cbData, uint32_t cTds)
710{
711 return pInterface->pfnNewUrb(pInterface, DstAddress, cbData, cTds);
712}
713
714/** @copydoc VUSBIROOTHUBCONNECTOR::pfnSubmitUrb */
715DECLINLINE(int) VUSBIRhSubmitUrb(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb, struct PDMLED *pLed)
716{
717 return pInterface->pfnSubmitUrb(pInterface, pUrb, pLed);
718}
719
720/** @copydoc VUSBIROOTHUBCONNECTOR::pfnReapAsyncUrbs */
721DECLINLINE(void) VUSBIRhReapAsyncUrbs(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice, RTMSINTERVAL cMillies)
722{
723 pInterface->pfnReapAsyncUrbs(pInterface, pDevice, cMillies);
724}
725
726/** @copydoc VUSBIROOTHUBCONNECTOR::pfnCancelAllUrbs */
727DECLINLINE(void) VUSBIRhCancelAllUrbs(PVUSBIROOTHUBCONNECTOR pInterface)
728{
729 pInterface->pfnCancelAllUrbs(pInterface);
730}
731
732/** @copydoc VUSBIROOTHUBCONNECTOR::pfnAttachDevice */
733DECLINLINE(int) VUSBIRhAttachDevice(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice)
734{
735 return pInterface->pfnAttachDevice(pInterface, pDevice);
736}
737
738/** @copydoc VUSBIROOTHUBCONNECTOR::pfnDetachDevice */
739DECLINLINE(int) VUSBIRhDetachDevice(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice)
740{
741 return pInterface->pfnDetachDevice(pInterface, pDevice);
742}
743#endif /* IN_RING3 */
744
745
746
747/** Pointer to a Root Hub Configuration Interface. */
748typedef struct VUSBIRHCONFIG *PVUSBIRHCONFIG;
749/**
750 * Root Hub Configuration Interface (intended for MAIN).
751 * No interface pair.
752 */
753typedef struct VUSBIRHCONFIG
754{
755 /**
756 * Creates a USB proxy device and attaches it to the root hub.
757 *
758 * @returns VBox status code.
759 * @param pInterface Pointer to the root hub configuration interface structure.
760 * @param pUuid Pointer to the UUID for the new device.
761 * @param fRemote Whether the device must use the VRDP backend.
762 * @param pszAddress OS specific device address.
763 * @param pvBackend An opaque pointer for the backend. Only used by
764 * the VRDP backend so far.
765 */
766 DECLR3CALLBACKMEMBER(int, pfnCreateProxyDevice,(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid, bool fRemote, const char *pszAddress, void *pvBackend));
767
768 /**
769 * Removes a USB proxy device from the root hub and destroys it.
770 *
771 * @returns VBox status code.
772 * @param pInterface Pointer to the root hub configuration interface structure.
773 * @param pUuid Pointer to the UUID for the device.
774 */
775 DECLR3CALLBACKMEMBER(int, pfnDestroyProxyDevice,(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid));
776
777} VUSBIRHCONFIG;
778/** VUSBIRHCONFIG interface ID. */
779#define VUSBIRHCONFIG_IID "c354cd97-e85f-465e-bc12-b58798465f52"
780
781
782#ifdef IN_RING3
783/** @copydoc VUSBIRHCONFIG::pfnCreateProxyDevice */
784DECLINLINE(int) VUSBIRhCreateProxyDevice(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid, bool fRemote, const char *pszAddress, void *pvBackend)
785{
786 return pInterface->pfnCreateProxyDevice(pInterface, pUuid, fRemote, pszAddress, pvBackend);
787}
788
789/** @copydoc VUSBIRHCONFIG::pfnDestroyProxyDevice */
790DECLINLINE(int) VUSBIRhDestroyProxyDevice(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid)
791{
792 return pInterface->pfnDestroyProxyDevice(pInterface, pUuid);
793}
794#endif /* IN_RING3 */
795
796#endif /* ! RDESKTOP */
797
798
799/**
800 * VUSB device reset completion callback function.
801 * This is called by the reset thread when the reset has been completed.
802 *
803 * @param pDev Pointer to the virtual USB device core.
804 * @param rc The VBox status code of the reset operation.
805 * @param pvUser User specific argument.
806 *
807 * @thread The reset thread or EMT.
808 */
809typedef DECLCALLBACK(void) FNVUSBRESETDONE(PVUSBIDEVICE pDevice, int rc, void *pvUser);
810/** Pointer to a device reset completion callback function (FNUSBRESETDONE). */
811typedef FNVUSBRESETDONE *PFNVUSBRESETDONE;
812
813/**
814 * The state of a VUSB Device.
815 *
816 * @remark The order of these states is vital.
817 */
818typedef enum VUSBDEVICESTATE
819{
820 VUSB_DEVICE_STATE_INVALID = 0,
821 VUSB_DEVICE_STATE_DETACHED,
822 VUSB_DEVICE_STATE_ATTACHED,
823 VUSB_DEVICE_STATE_POWERED,
824 VUSB_DEVICE_STATE_DEFAULT,
825 VUSB_DEVICE_STATE_ADDRESS,
826 VUSB_DEVICE_STATE_CONFIGURED,
827 VUSB_DEVICE_STATE_SUSPENDED,
828 /** The device is being reset. Don't mess with it.
829 * Next states: VUSB_DEVICE_STATE_DEFAULT, VUSB_DEVICE_STATE_DESTROYED
830 */
831 VUSB_DEVICE_STATE_RESET,
832 /** The device has been destroyed. */
833 VUSB_DEVICE_STATE_DESTROYED,
834 /** The usual 32-bit hack. */
835 VUSB_DEVICE_STATE_32BIT_HACK = 0x7fffffff
836} VUSBDEVICESTATE;
837
838#ifndef RDESKTOP
839
840/**
841 * USB Device Interface (up).
842 * No interface pair.
843 */
844typedef struct VUSBIDEVICE
845{
846 /**
847 * Resets the device.
848 *
849 * Since a device reset shall take at least 10ms from the guest point of view,
850 * it must be performed asynchronously. We create a thread which performs this
851 * operation and ensures it will take at least 10ms.
852 *
853 * At times - like init - a synchronous reset is required, this can be done
854 * by passing NULL for pfnDone.
855 *
856 * -- internal stuff, move it --
857 * While the device is being reset it is in the VUSB_DEVICE_STATE_RESET state.
858 * On completion it will be in the VUSB_DEVICE_STATE_DEFAULT state if successful,
859 * or in the VUSB_DEVICE_STATE_DETACHED state if the rest failed.
860 * -- internal stuff, move it --
861 *
862 * @returns VBox status code.
863 * @param pInterface Pointer to this structure.
864 * @param fResetOnLinux Set if we can permit a real reset and a potential logical
865 * device reconnect on linux hosts.
866 * @param pfnDone Pointer to the completion routine. If NULL a synchronous
867 * reset is preformed not respecting the 10ms.
868 * @param pvUser User argument to the completion routine.
869 * @param pVM Pointer to the VM handle if callback in EMT is required. (optional)
870 */
871 DECLR3CALLBACKMEMBER(int, pfnReset,(PVUSBIDEVICE pInterface, bool fResetOnLinux,
872 PFNVUSBRESETDONE pfnDone, void *pvUser, PVM pVM));
873
874 /**
875 * Powers on the device.
876 *
877 * @returns VBox status code.
878 * @param pInterface Pointer to the device interface structure.
879 */
880 DECLR3CALLBACKMEMBER(int, pfnPowerOn,(PVUSBIDEVICE pInterface));
881
882 /**
883 * Powers off the device.
884 *
885 * @returns VBox status code.
886 * @param pInterface Pointer to the device interface structure.
887 */
888 DECLR3CALLBACKMEMBER(int, pfnPowerOff,(PVUSBIDEVICE pInterface));
889
890 /**
891 * Get the state of the device.
892 *
893 * @returns Device state.
894 * @param pInterface Pointer to the device interface structure.
895 */
896 DECLR3CALLBACKMEMBER(VUSBDEVICESTATE, pfnGetState,(PVUSBIDEVICE pInterface));
897
898 /**
899 * Returns whether the device is completely emulated.
900 *
901 * @returns true if the device is fully emulated and doesn't pass through
902 * a host device, false otherwise.
903 * @param pInterface Pointer to the device interface structure.
904 */
905 DECLR3CALLBACKMEMBER(bool, pfnIsEmulated,(PVUSBIDEVICE pInterface));
906
907 /**
908 * Get the speed the device is operating at.
909 *
910 * @returns Device state.
911 * @param pInterface Pointer to the device interface structure.
912 */
913 DECLR3CALLBACKMEMBER(VUSBSPEED, pfnGetSpeed,(PVUSBIDEVICE pInterface));
914
915} VUSBIDEVICE;
916/** VUSBIDEVICE interface ID. */
917#define VUSBIDEVICE_IID "f3facb2b-edd3-4b5b-b07e-2cc4d52a471e"
918
919
920#ifdef IN_RING3
921/**
922 * Resets the device.
923 *
924 * Since a device reset shall take at least 10ms from the guest point of view,
925 * it must be performed asynchronously. We create a thread which performs this
926 * operation and ensures it will take at least 10ms.
927 *
928 * At times - like init - a synchronous reset is required, this can be done
929 * by passing NULL for pfnDone.
930 *
931 * -- internal stuff, move it --
932 * While the device is being reset it is in the VUSB_DEVICE_STATE_RESET state.
933 * On completion it will be in the VUSB_DEVICE_STATE_DEFAULT state if successful,
934 * or in the VUSB_DEVICE_STATE_DETACHED state if the rest failed.
935 * -- internal stuff, move it --
936 *
937 * @returns VBox status code.
938 * @param pInterface Pointer to the device interface structure.
939 * @param fResetOnLinux Set if we can permit a real reset and a potential logical
940 * device reconnect on linux hosts.
941 * @param pfnDone Pointer to the completion routine. If NULL a synchronous
942 * reset is preformed not respecting the 10ms.
943 * @param pvUser User argument to the completion routine.
944 * @param pVM Pointer to the VM handle if callback in EMT is required. (optional)
945 */
946DECLINLINE(int) VUSBIDevReset(PVUSBIDEVICE pInterface, bool fResetOnLinux, PFNVUSBRESETDONE pfnDone, void *pvUser, PVM pVM)
947{
948 return pInterface->pfnReset(pInterface, fResetOnLinux, pfnDone, pvUser, pVM);
949}
950
951/**
952 * Powers on the device.
953 *
954 * @returns VBox status code.
955 * @param pInterface Pointer to the device interface structure.
956 */
957DECLINLINE(int) VUSBIDevPowerOn(PVUSBIDEVICE pInterface)
958{
959 return pInterface->pfnPowerOn(pInterface);
960}
961
962/**
963 * Powers off the device.
964 *
965 * @returns VBox status code.
966 * @param pInterface Pointer to the device interface structure.
967 */
968DECLINLINE(int) VUSBIDevPowerOff(PVUSBIDEVICE pInterface)
969{
970 return pInterface->pfnPowerOff(pInterface);
971}
972
973/**
974 * Get the state of the device.
975 *
976 * @returns Device state.
977 * @param pInterface Pointer to the device interface structure.
978 */
979DECLINLINE(VUSBDEVICESTATE) VUSBIDevGetState(PVUSBIDEVICE pInterface)
980{
981 return pInterface->pfnGetState(pInterface);
982}
983
984/**
985 * Returns whether the device is completely emulated.
986 *
987 * @returns true if the device is fully emulated and doesn't pass through
988 * a host device, false otherwise.
989 * @param pInterface Pointer to the device interface structure.
990 */
991DECLINLINE(bool) VUSBIDevIsEmulated(PVUSBIDEVICE pInterface)
992{
993 return pInterface->pfnIsEmulated(pInterface);
994}
995#endif /* IN_RING3 */
996
997#endif /* ! RDESKTOP */
998
999/** @name URB
1000 * @{ */
1001
1002/**
1003 * VUSB Transfer status codes.
1004 */
1005typedef enum VUSBSTATUS
1006{
1007 /** Transer was ok. */
1008 VUSBSTATUS_OK = 0,
1009 /** Transfer stalled, endpoint halted. */
1010 VUSBSTATUS_STALL,
1011 /** Device not responding. */
1012 VUSBSTATUS_DNR,
1013 /** CRC error. */
1014 VUSBSTATUS_CRC,
1015 /** Data overrun error. */
1016 VUSBSTATUS_DATA_UNDERRUN,
1017 /** Data overrun error. */
1018 VUSBSTATUS_DATA_OVERRUN,
1019 /** The isochronous buffer hasn't been touched. */
1020 VUSBSTATUS_NOT_ACCESSED,
1021 /** Canceled/undone URB (VUSB internal). */
1022 VUSBSTATUS_UNDO,
1023 /** Invalid status. */
1024 VUSBSTATUS_INVALID = 0x7f
1025} VUSBSTATUS;
1026
1027
1028/**
1029 * VUSB Transfer types.
1030 */
1031typedef enum VUSBXFERTYPE
1032{
1033 /** Control message. Used to represent a single control transfer. */
1034 VUSBXFERTYPE_CTRL = 0,
1035 /* Isochronous transfer. */
1036 VUSBXFERTYPE_ISOC,
1037 /** Bulk transfer. */
1038 VUSBXFERTYPE_BULK,
1039 /** Interrupt transfer. */
1040 VUSBXFERTYPE_INTR,
1041 /** Complete control message. Used to represent an entire control message. */
1042 VUSBXFERTYPE_MSG,
1043 /** Invalid transfer type. */
1044 VUSBXFERTYPE_INVALID = 0x7f
1045} VUSBXFERTYPE;
1046
1047
1048/**
1049 * VUSB transfer direction.
1050 */
1051typedef enum VUSBDIRECTION
1052{
1053 /** Setup */
1054 VUSBDIRECTION_SETUP = 0,
1055#define VUSB_DIRECTION_SETUP VUSBDIRECTION_SETUP
1056 /** In - Device to host. */
1057 VUSBDIRECTION_IN = 1,
1058#define VUSB_DIRECTION_IN VUSBDIRECTION_IN
1059 /** Out - Host to device. */
1060 VUSBDIRECTION_OUT = 2,
1061#define VUSB_DIRECTION_OUT VUSBDIRECTION_OUT
1062 /** Invalid direction */
1063 VUSBDIRECTION_INVALID = 0x7f
1064} VUSBDIRECTION;
1065
1066/**
1067 * The URB states
1068 */
1069typedef enum VUSBURBSTATE
1070{
1071 /** The usual invalid state. */
1072 VUSBURBSTATE_INVALID = 0,
1073 /** The URB is free, i.e. not in use.
1074 * Next state: ALLOCATED */
1075 VUSBURBSTATE_FREE,
1076 /** The URB is allocated, i.e. being prepared for submission.
1077 * Next state: FREE, IN_FLIGHT */
1078 VUSBURBSTATE_ALLOCATED,
1079 /** The URB is in flight.
1080 * Next state: REAPED, CANCELLED */
1081 VUSBURBSTATE_IN_FLIGHT,
1082 /** The URB has been reaped and is being completed.
1083 * Next state: FREE */
1084 VUSBURBSTATE_REAPED,
1085 /** The URB has been cancelled and is awaiting reaping and immediate freeing.
1086 * Next state: FREE */
1087 VUSBURBSTATE_CANCELLED,
1088 /** The end of the valid states (exclusive). */
1089 VUSBURBSTATE_END,
1090 /** The usual 32-bit blow up. */
1091 VUSBURBSTATE_32BIT_HACK = 0x7fffffff
1092} VUSBURBSTATE;
1093
1094
1095/**
1096 * Information about a isochronous packet.
1097 */
1098typedef struct VUSBURBISOCPKT
1099{
1100 /** The size of the packet.
1101 * IN: The packet size. I.e. the number of bytes to the next packet or end of buffer.
1102 * OUT: The actual size transferred. */
1103 uint16_t cb;
1104 /** The offset of the packet. (Relative to VUSBURB::abData[0].)
1105 * OUT: This can be changed by the USB device if it does some kind of buffer squeezing. */
1106 uint16_t off;
1107 /** The status of the transfer.
1108 * IN: VUSBSTATUS_INVALID
1109 * OUT: VUSBSTATUS_INVALID if nothing was done, otherwise the correct status. */
1110 VUSBSTATUS enmStatus;
1111} VUSBURBISOCPKT;
1112/** Pointer to a isochronous packet. */
1113typedef VUSBURBISOCPKT *PVUSBURBISOCPTK;
1114/** Pointer to a const isochronous packet. */
1115typedef const VUSBURBISOCPKT *PCVUSBURBISOCPKT;
1116
1117/**
1118 * Asynchronous USB request descriptor
1119 */
1120typedef struct VUSBURB
1121{
1122 /** URB magic value. */
1123 uint32_t u32Magic;
1124 /** The USR state. */
1125 VUSBURBSTATE enmState;
1126 /** URB description, can be null. intended for logging. */
1127 char *pszDesc;
1128
1129#ifdef RDESKTOP
1130 /** The next URB in rdesktop-vrdp's linked list */
1131 PVUSBURB pNext;
1132 /** The previous URB in rdesktop-vrdp's linked list */
1133 PVUSBURB pPrev;
1134 /** The vrdp handle for the URB */
1135 uint32_t handle;
1136 /** Pointer used to find the usb proxy device */
1137 struct VUSBDEV *pDev;
1138#endif
1139
1140 /** The VUSB data. */
1141 struct VUSBURBVUSB
1142 {
1143 /** URB chain pointer. */
1144 PVUSBURB pNext;
1145 /** URB chain pointer. */
1146 PVUSBURB *ppPrev;
1147 /** Pointer to the original for control messages. */
1148 PVUSBURB pCtrlUrb;
1149 /** Pointer to the VUSB device.
1150 * This may be NULL if the destination address is invalid. */
1151 struct VUSBDEV *pDev;
1152 /** Sepcific to the pfnFree function. */
1153 void *pvFreeCtx;
1154 /**
1155 * Callback which will free the URB once it's reaped and completed.
1156 * @param pUrb The URB.
1157 */
1158 DECLCALLBACKMEMBER(void, pfnFree)(PVUSBURB pUrb);
1159 /** Submit timestamp. (logging only) */
1160 uint64_t u64SubmitTS;
1161 /** The allocated data length. */
1162 uint32_t cbDataAllocated;
1163 /** The allocated TD length. */
1164 uint32_t cTdsAllocated;
1165 } VUsb;
1166
1167 /** The host controller data. */
1168 struct VUSBURBHCI
1169 {
1170 /** The endpoint descriptor address. */
1171 RTGCPHYS32 EdAddr;
1172 /** Number of Tds in the array. */
1173 uint32_t cTds;
1174 /** Pointer to an array of TD info items.*/
1175 struct VUSBURBHCITD
1176 {
1177 /** Type of TD (private) */
1178 uint32_t TdType;
1179 /** The address of the */
1180 RTGCPHYS32 TdAddr;
1181 /** A copy of the TD. */
1182 uint32_t TdCopy[16];
1183 } *paTds;
1184 /** URB chain pointer. */
1185 PVUSBURB pNext;
1186 /** When this URB was created.
1187 * (Used for isochronous frames and for logging.) */
1188 uint32_t u32FrameNo;
1189 /** Flag indicating that the TDs have been unlinked. */
1190 bool fUnlinked;
1191 RTQUEUEATOMICITEM QueueItem;
1192 } Hci;
1193
1194 /** The device data. */
1195 struct VUSBURBDEV
1196 {
1197 /** Pointer to private device specific data. */
1198 void *pvPrivate;
1199 /** Used by the device when linking the URB in some list of its own. */
1200 PVUSBURB pNext;
1201 } Dev;
1202
1203#ifndef RDESKTOP
1204 /** The USB device instance this belongs to.
1205 * This is NULL if the device address is invalid, in which case this belongs to the hub. */
1206 PPDMUSBINS pUsbIns;
1207#endif
1208 /** The device address.
1209 * This is set at allocation time. */
1210 uint8_t DstAddress;
1211
1212 /** The endpoint.
1213 * IN: Must be set before submitting the URB.
1214 * @remark This does not have the high bit (direction) set! */
1215 uint8_t EndPt;
1216 /** The transfer type.
1217 * IN: Must be set before submitting the URB. */
1218 VUSBXFERTYPE enmType;
1219 /** The transfer direction.
1220 * IN: Must be set before submitting the URB. */
1221 VUSBDIRECTION enmDir;
1222 /** Indicates whether it is OK to receive/send less data than requested.
1223 * IN: Must be initialized before submitting the URB. */
1224 bool fShortNotOk;
1225 /** The transfer status.
1226 * OUT: This is set when reaping the URB. */
1227 VUSBSTATUS enmStatus;
1228
1229 /** The number of isochronous packets describe in aIsocPkts.
1230 * This is ignored when enmType isn't VUSBXFERTYPE_ISOC. */
1231 uint32_t cIsocPkts;
1232 /** The iso packets within abData.
1233 * This is ignored when enmType isn't VUSBXFERTYPE_ISOC. */
1234 VUSBURBISOCPKT aIsocPkts[8];
1235
1236 /** The message length.
1237 * IN: The amount of data to send / receive - set at allocation time.
1238 * OUT: The amount of data sent / received. */
1239 uint32_t cbData;
1240 /** The message data.
1241 * IN: On host to device transfers, the data to send.
1242 * OUT: On device to host transfers, the data to received.
1243 * This array has actually a size of VUsb.cbDataAllocated, not 8KB! */
1244 uint8_t abData[8*_1K];
1245} VUSBURB;
1246
1247/** The magic value of a valid VUSBURB. (Murakami Haruki) */
1248#define VUSBURB_MAGIC UINT32_C(0x19490112)
1249
1250/** @} */
1251
1252
1253/** @} */
1254
1255RT_C_DECLS_END
1256
1257#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette