1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
|
/* $Id: USBProxyDevice.h $ */
/** @file
* USBPROXY - USB proxy header
*/
/*
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
#ifndef VBOX_INCLUDED_SRC_USB_USBProxyDevice_h
#define VBOX_INCLUDED_SRC_USB_USBProxyDevice_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/cdefs.h>
#include <VBox/vusb.h>
RT_C_DECLS_BEGIN
/** Pointer to a USB proxy device. */
typedef struct USBPROXYDEV *PUSBPROXYDEV;
/**
* USB Proxy Device Backend
*/
typedef struct USBPROXYBACK
{
/** Name of the backend. */
const char *pszName;
/** Size of the backend specific data. */
size_t cbBackend;
/**
* Opens the USB device specfied by pszAddress.
*
* This method will initialize backend private data. If the backend has
* already selected a configuration for the device, this must be indicated
* in USBPROXYDEV::iActiveCfg.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param pszAddress Host specific USB device address.
*/
DECLR3CALLBACKMEMBER(int, pfnOpen, (PUSBPROXYDEV pProxyDev, const char *pszAddress));
/**
* Optional callback for initializing the device after the configuration
* has been established.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
*/
DECLR3CALLBACKMEMBER(int, pfnInit, (PUSBPROXYDEV pProxyDev));
/**
* Closes handle to the host USB device.
*
* @param pProxyDev The USB Proxy Device instance.
*/
DECLR3CALLBACKMEMBER(void, pfnClose, (PUSBPROXYDEV pProxyDev));
/**
* Reset a device.
*
* The backend must update iActualCfg and fIgnoreEqualSetConfig.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param fResetOnLinux It's safe to do reset on linux, we can deal with devices
* being logically reconnected.
*/
DECLR3CALLBACKMEMBER(int, pfnReset, (PUSBPROXYDEV pProxyDev, bool fResetOnLinux));
/**
* Sets the given configuration of the device.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param iCfg The configuration to set.
*/
DECLR3CALLBACKMEMBER(int, pfnSetConfig, (PUSBPROXYDEV pProxyDev, int iCfg));
/**
* Claim an interface for use by the prox device.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param iIf Interface number to claim.
*/
DECLR3CALLBACKMEMBER(int, pfnClaimInterface, (PUSBPROXYDEV pProxyDev, int iIf));
/**
* Releases an interface which was claimed before.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param iIf Interface number to release.
*/
DECLR3CALLBACKMEMBER(int, pfnReleaseInterface, (PUSBPROXYDEV pProxyDev, int iIf));
/**
* Sets the given alternate interface for the device.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param iIf Interface to use.
* @param iSetting The alternate setting to use.
*/
DECLR3CALLBACKMEMBER(int, pfnSetInterface, (PUSBPROXYDEV pProxyDev, int iIf, int iSetting));
/**
* Clears the given halted endpoint.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param iEp The endpoint to clear.
*/
DECLR3CALLBACKMEMBER(int, pfnClearHaltedEndpoint, (PUSBPROXYDEV pDev, unsigned int iEp));
/**
* Queue a new URB.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param pUrb The URB to queue.
*/
DECLR3CALLBACKMEMBER(int, pfnUrbQueue, (PUSBPROXYDEV pProxyDev, PVUSBURB pUrb));
/**
* Cancel an in-flight URB.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
* @param pUrb The URB to cancel.
*/
DECLR3CALLBACKMEMBER(int, pfnUrbCancel, (PUSBPROXYDEV pProxyDev, PVUSBURB pUrb));
/**
* Reap URBs in-flight on a device.
*
* @returns Pointer to a completed URB.
* @returns NULL if no URB was completed.
* @param pProxyDev The USB Proxy Device instance.
* @param cMillies Number of milliseconds to wait. Use 0 to not
* wait at all.
*/
DECLR3CALLBACKMEMBER(PVUSBURB, pfnUrbReap, (PUSBPROXYDEV pProxyDev, RTMSINTERVAL cMillies));
/**
* Kicks the thread waiting in pfnUrbReap to make it return.
*
* @returns VBox status code.
* @param pProxyDev The USB Proxy Device instance.
*/
DECLR3CALLBACKMEMBER(int, pfnWakeup, (PUSBPROXYDEV pProxyDev));
/** Dummy entry for making sure we've got all members initialized. */
uint32_t uDummy;
} USBPROXYBACK;
/** Pointer to a USB Proxy Device Backend. */
typedef USBPROXYBACK *PUSBPROXYBACK;
/** Pointer to a const USB Proxy Device Backend. */
typedef const USBPROXYBACK *PCUSBPROXYBACK;
/** The Host backend. */
extern const USBPROXYBACK g_USBProxyDeviceHost;
/** The remote desktop backend. */
extern const USBPROXYBACK g_USBProxyDeviceVRDP;
/** The USB/IP backend. */
extern const USBPROXYBACK g_USBProxyDeviceUsbIp;
#ifdef RDESKTOP
typedef struct VUSBDEV
{
char* pszName;
} VUSBDEV, *PVUSBDEV;
#endif
/**
* USB Proxy device.
*/
typedef struct USBPROXYDEV
{
/** The device descriptor. */
VUSBDESCDEVICE DevDesc;
/** The configuration descriptor array. */
PVUSBDESCCONFIGEX paCfgDescs;
#ifndef RDESKTOP
/** The descriptor cache.
* Contains &DevDesc and paConfigDescs. */
PDMUSBDESCCACHE DescCache;
/** Pointer to the PDM USB device instance. */
PPDMUSBINS pUsbIns;
#endif
/** Pointer to the backend. */
PCUSBPROXYBACK pOps;
/** The currently active configuration.
* It's -1 if no configuration is active. This is set to -1 before open and reset,
* the backend will change it if open or reset implies SET_CONFIGURATION. */
int iActiveCfg;
/** Ignore one or two SET_CONFIGURATION operation.
* See usbProxyDevSetCfg for details. */
int cIgnoreSetConfigs;
/** Mask of the interfaces that the guest shall not see. */
uint32_t fMaskedIfs;
/** Whether we've opened the device or not.
* For dealing with failed construction (the destruct method is always called). */
bool fOpened;
/** Whether we've called pfnInit or not.
* For dealing with failed construction (the destruct method is always called). */
bool fInited;
/** Whether the device has been detached.
* This is hack for making PDMUSBREG::pfnUsbQueue return the right status code. */
bool fDetached;
/** Backend specific data, the size is stored in pOps::cbBackend. */
void *pvInstanceDataR3;
#ifdef RDESKTOP
/** @name VRDP client (rdesktop) related members.
* @{ */
/** The vrdp device ID. */
uint32_t idVrdp;
/** The VUSB device structure - must be the first structure member. */
VUSBDEV Dev;
/** The next device in rdesktop-vrdp's linked list. */
PUSBPROXYDEV pNext;
/** The previous device in rdesktop-vrdp's linked list. */
PUSBPROXYDEV pPrev;
/** Linked list of in-flight URBs */
PVUSBURB pUrbs;
/** @} */
#endif
} USBPROXYDEV;
/** @def USBPROXYDEV_2_DATA
* Converts a USB proxy Device, pointer to a pointer to the backend specific instance data.
*/
#define USBPROXYDEV_2_DATA(a_pProxyDev, a_Type) ( (a_Type)(a_pProxyDev)->pvInstanceDataR3 )
DECLINLINE(const char *) usbProxyGetName(PUSBPROXYDEV pProxyDev)
{
#ifndef RDESKTOP
return pProxyDev->pUsbIns->pszName;
#else
return pProxyDev->Dev.pszName;
#endif
}
#ifdef RDESKTOP
DECLINLINE(PUSBPROXYDEV) usbProxyFromVusbDev(PVUSBDEV pDev)
{
return RT_FROM_MEMBER(pDev, USBPROXYDEV, Dev);
}
#endif
#ifdef RT_OS_LINUX
RTDECL(int) USBProxyDeviceLinuxGetFD(PUSBPROXYDEV pProxyDev);
#endif
RT_C_DECLS_END
#endif /* !VBOX_INCLUDED_SRC_USB_USBProxyDevice_h */
|
