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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
/* $Id$ */
/** @file
* USB device proxy - the VRDP backend, calls the RemoteUSBBackend methods.
*/
/*
* Copyright (C) 2006-2022 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#define LOG_GROUP LOG_GROUP_DRV_USBPROXY
#include <VBox/log.h>
#include <VBox/err.h>
#include <VBox/vrdpusb.h>
#include <VBox/vmm/pdm.h>
#include <iprt/assert.h>
#include <iprt/alloc.h>
#include <iprt/string.h>
#include <iprt/uuid.h>
#include "../USBProxyDevice.h"
/**
* Backend data for the VRDP USB Proxy device backend.
*/
typedef struct USBPROXYDEVVRDP
{
REMOTEUSBCALLBACK *pCallback;
PREMOTEUSBDEVICE pDevice;
} USBPROXYDEVVRDP, *PUSBPROXYDEVVRDP;
/*
* The USB proxy device functions.
*/
static DECLCALLBACK(int) usbProxyVrdpOpen(PUSBPROXYDEV pProxyDev, const char *pszAddress)
{
LogFlow(("usbProxyVrdpOpen: pProxyDev=%p pszAddress=%s\n", pProxyDev, pszAddress));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
PPDMUSBINS pUsbIns = pProxyDev->pUsbIns;
PCPDMUSBHLP pHlp = pUsbIns->pHlpR3;
PCFGMNODE pCfgBackend = pHlp->pfnCFGMGetChild(pUsbIns->pCfg, "BackendCfg");
AssertPtrReturn(pCfgBackend, VERR_NOT_FOUND);
uint32_t idClient = 0;
int rc = pHlp->pfnCFGMQueryU32(pCfgBackend, "ClientId", &idClient);
AssertRCReturn(rc, rc);
RTUUID UuidDev;
char *pszUuid = NULL;
rc = pHlp->pfnCFGMQueryStringAlloc(pUsbIns->pCfg, "UUID", &pszUuid);
AssertRCReturn(rc, rc);
rc = RTUuidFromStr(&UuidDev, pszUuid);
pHlp->pfnMMHeapFree(pUsbIns, pszUuid);
AssertMsgRCReturn(rc, ("Failed to convert UUID from string! rc=%Rrc\n", rc), rc);
if (strncmp (pszAddress, REMOTE_USB_BACKEND_PREFIX_S, REMOTE_USB_BACKEND_PREFIX_LEN) == 0)
{
RTUUID UuidRemoteUsbIf;
rc = RTUuidFromStr(&UuidRemoteUsbIf, REMOTEUSBIF_OID); AssertRC(rc);
PREMOTEUSBIF pRemoteUsbIf = (PREMOTEUSBIF)PDMUsbHlpQueryGenericUserObject(pUsbIns, &UuidRemoteUsbIf);
AssertPtrReturn(pRemoteUsbIf, VERR_INVALID_PARAMETER);
REMOTEUSBCALLBACK *pCallback = pRemoteUsbIf->pfnQueryRemoteUsbBackend(pRemoteUsbIf->pvUser, &UuidDev, idClient);
AssertPtrReturn(pCallback, VERR_INVALID_PARAMETER);
PREMOTEUSBDEVICE pDevice = NULL;
rc = pCallback->pfnOpen(pCallback->pInstance, pszAddress, strlen (pszAddress) + 1, &pDevice);
if (RT_SUCCESS(rc))
{
pDevVrdp->pCallback = pCallback;
pDevVrdp->pDevice = pDevice;
pProxyDev->iActiveCfg = 1; /** @todo that may not be always true. */
pProxyDev->cIgnoreSetConfigs = 1;
return VINF_SUCCESS;
}
}
else
{
AssertFailed();
rc = VERR_INVALID_PARAMETER;
}
return rc;
}
static DECLCALLBACK(void) usbProxyVrdpClose(PUSBPROXYDEV pProxyDev)
{
LogFlow(("usbProxyVrdpClose: pProxyDev = %p\n", pProxyDev));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
pDevVrdp->pCallback->pfnClose (pDevVrdp->pDevice);
}
static DECLCALLBACK(int) usbProxyVrdpReset(PUSBPROXYDEV pProxyDev, bool fResetOnLinux)
{
RT_NOREF(fResetOnLinux);
LogFlow(("usbProxyVrdpReset: pProxyDev = %p\n", pProxyDev));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
int rc = pDevVrdp->pCallback->pfnReset (pDevVrdp->pDevice);
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
pProxyDev->iActiveCfg = -1;
pProxyDev->cIgnoreSetConfigs = 2;
return rc;
}
static DECLCALLBACK(int) usbProxyVrdpSetConfig(PUSBPROXYDEV pProxyDev, int cfg)
{
LogFlow(("usbProxyVrdpSetConfig: pProxyDev=%s cfg=%#x\n", pProxyDev->pUsbIns->pszName, cfg));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
int rc = pDevVrdp->pCallback->pfnSetConfig (pDevVrdp->pDevice, (uint8_t)cfg);
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
return rc;
}
static DECLCALLBACK(int) usbProxyVrdpClaimInterface(PUSBPROXYDEV pProxyDev, int ifnum)
{
LogFlow(("usbProxyVrdpClaimInterface: pProxyDev=%s ifnum=%#x\n", pProxyDev->pUsbIns->pszName, ifnum));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
int rc = pDevVrdp->pCallback->pfnClaimInterface (pDevVrdp->pDevice, (uint8_t)ifnum);
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
return rc;
}
static DECLCALLBACK(int) usbProxyVrdpReleaseInterface(PUSBPROXYDEV pProxyDev, int ifnum)
{
LogFlow(("usbProxyVrdpReleaseInterface: pProxyDev=%s ifnum=%#x\n", pProxyDev->pUsbIns->pszName, ifnum));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
int rc = pDevVrdp->pCallback->pfnReleaseInterface (pDevVrdp->pDevice, (uint8_t)ifnum);
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
return rc;
}
static DECLCALLBACK(int) usbProxyVrdpSetInterface(PUSBPROXYDEV pProxyDev, int ifnum, int setting)
{
LogFlow(("usbProxyVrdpSetInterface: pProxyDev=%p ifnum=%#x setting=%#x\n", pProxyDev, ifnum, setting));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
int rc = pDevVrdp->pCallback->pfnInterfaceSetting (pDevVrdp->pDevice, (uint8_t)ifnum, (uint8_t)setting);
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
return rc;
}
static DECLCALLBACK(int) usbProxyVrdpClearHaltedEp(PUSBPROXYDEV pProxyDev, unsigned int ep)
{
LogFlow(("usbProxyVrdpClearHaltedEp: pProxyDev=%s ep=%u\n", pProxyDev->pUsbIns->pszName, ep));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
int rc = pDevVrdp->pCallback->pfnClearHaltedEP (pDevVrdp->pDevice, (uint8_t)ep);
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
return rc;
}
static DECLCALLBACK(int) usbProxyVrdpUrbQueue(PUSBPROXYDEV pProxyDev, PVUSBURB pUrb)
{
LogFlow(("usbProxyVrdpUrbQueue: pUrb=%p\n", pUrb));
/** @todo implement isochronous transfers for USB over VRDP. */
if (pUrb->enmType == VUSBXFERTYPE_ISOC)
{
Log(("usbproxy: isochronous transfers aren't implemented yet.\n"));
return VERR_NOT_IMPLEMENTED;
}
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
int rc = pDevVrdp->pCallback->pfnQueueURB (pDevVrdp->pDevice, pUrb->enmType, pUrb->EndPt, pUrb->enmDir, pUrb->cbData,
pUrb->abData, pUrb, (PREMOTEUSBQURB *)&pUrb->Dev.pvPrivate);
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
return rc;
}
static DECLCALLBACK(PVUSBURB) usbProxyVrdpUrbReap(PUSBPROXYDEV pProxyDev, RTMSINTERVAL cMillies)
{
LogFlow(("usbProxyVrdpUrbReap: pProxyDev=%s\n", pProxyDev->pUsbIns->pszName));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
PVUSBURB pUrb = NULL;
uint32_t cbData = 0;
uint32_t u32Err = VUSBSTATUS_OK;
int rc = pDevVrdp->pCallback->pfnReapURB (pDevVrdp->pDevice, cMillies, (void **)&pUrb, &cbData, &u32Err);
LogFlow(("usbProxyVrdpUrbReap: rc = %Rrc, pUrb = %p\n", rc, pUrb));
if (RT_SUCCESS(rc) && pUrb)
{
pUrb->enmStatus = (VUSBSTATUS)u32Err;
pUrb->cbData = cbData;
pUrb->Dev.pvPrivate = NULL;
}
if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
{
Log(("usb-vrdp: remote device %p unplugged!!\n", pDevVrdp->pDevice));
pProxyDev->fDetached = true;
}
return pUrb;
}
static DECLCALLBACK(int) usbProxyVrdpUrbCancel(PUSBPROXYDEV pProxyDev, PVUSBURB pUrb)
{
LogFlow(("usbProxyVrdpUrbCancel: pUrb=%p\n", pUrb));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
pDevVrdp->pCallback->pfnCancelURB (pDevVrdp->pDevice, (PREMOTEUSBQURB)pUrb->Dev.pvPrivate);
return VINF_SUCCESS; /** @todo Enhance remote interface to pass a status code. */
}
static DECLCALLBACK(int) usbProxyVrdpWakeup(PUSBPROXYDEV pProxyDev)
{
LogFlow(("usbProxyVrdpWakeup: pProxyDev=%s\n", pProxyDev->pUsbIns->pszName));
PUSBPROXYDEVVRDP pDevVrdp = USBPROXYDEV_2_DATA(pProxyDev, PUSBPROXYDEVVRDP);
return pDevVrdp->pCallback->pfnWakeup (pDevVrdp->pDevice);
}
/**
* The VRDP USB Proxy Backend operations.
*/
extern const USBPROXYBACK g_USBProxyDeviceVRDP =
{
/* pszName */
"vrdp",
/* cbBackend */
sizeof(USBPROXYDEVVRDP),
usbProxyVrdpOpen,
NULL,
usbProxyVrdpClose,
usbProxyVrdpReset,
usbProxyVrdpSetConfig,
usbProxyVrdpClaimInterface,
usbProxyVrdpReleaseInterface,
usbProxyVrdpSetInterface,
usbProxyVrdpClearHaltedEp,
usbProxyVrdpUrbQueue,
usbProxyVrdpUrbCancel,
usbProxyVrdpUrbReap,
usbProxyVrdpWakeup,
0
};
|
