VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMR3/PDMUsb.cpp@ 53152

Last change on this file since 53152 was 53097, checked in by vboxsync, 10 years ago

USB: Beginnings of emulated USB3 devices.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 66.7 KB
Line 
1/* $Id: PDMUsb.cpp 53097 2014-10-20 17:37:27Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device and Driver Manager, USB part.
4 */
5
6/*
7 * Copyright (C) 2006-2014 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18
19/*******************************************************************************
20* Header Files *
21*******************************************************************************/
22#define LOG_GROUP LOG_GROUP_PDM_DRIVER
23#include "PDMInternal.h"
24#include <VBox/vmm/pdm.h>
25#include <VBox/vusb.h>
26#include <VBox/vmm/mm.h>
27#include <VBox/vmm/cfgm.h>
28#include <VBox/vmm/vmm.h>
29#include <VBox/sup.h>
30#include <VBox/vmm/vm.h>
31#include <VBox/vmm/uvm.h>
32#include <VBox/version.h>
33#include <VBox/err.h>
34
35#include <VBox/log.h>
36#include <iprt/assert.h>
37#include <iprt/thread.h>
38#include <iprt/string.h>
39#include <iprt/asm.h>
40#include <iprt/alloc.h>
41#include <iprt/alloca.h>
42#include <iprt/path.h>
43#include <iprt/uuid.h>
44
45
46/*******************************************************************************
47* Structures and Typedefs *
48*******************************************************************************/
49/**
50 * Internal callback structure pointer.
51 *
52 * The main purpose is to define the extra data we associate
53 * with PDMUSBREGCB so we can find the VM instance and so on.
54 */
55typedef struct PDMUSBREGCBINT
56{
57 /** The callback structure. */
58 PDMUSBREGCB Core;
59 /** A bit of padding. */
60 uint32_t u32[4];
61 /** VM Handle. */
62 PVM pVM;
63} PDMUSBREGCBINT, *PPDMUSBREGCBINT;
64typedef const PDMUSBREGCBINT *PCPDMUSBREGCBINT;
65
66
67/*******************************************************************************
68* Defined Constants And Macros *
69*******************************************************************************/
70/** @def PDMUSB_ASSERT_USBINS
71 * Asserts the validity of the USB device instance.
72 */
73#ifdef VBOX_STRICT
74# define PDMUSB_ASSERT_USBINS(pUsbIns) \
75 do { \
76 AssertPtr(pUsbIns); \
77 Assert(pUsbIns->u32Version == PDM_USBINS_VERSION); \
78 Assert(pUsbIns->pvInstanceDataR3 == (void *)&pUsbIns->achInstanceData[0]); \
79 } while (0)
80#else
81# define PDMUSB_ASSERT_USBINS(pUsbIns) do { } while (0)
82#endif
83
84
85/*******************************************************************************
86* Internal Functions *
87*******************************************************************************/
88static void pdmR3UsbDestroyDevice(PVM pVM, PPDMUSBINS pUsbIns);
89
90
91/*******************************************************************************
92* Global Variables *
93*******************************************************************************/
94extern const PDMUSBHLP g_pdmR3UsbHlp;
95
96
97AssertCompile(sizeof(PDMUSBINSINT) <= RT_SIZEOFMEMB(PDMUSBINS, Internal.padding));
98
99
100/**
101 * Registers a USB hub driver.
102 *
103 * @returns VBox status code.
104 * @param pVM Pointer to the VM.
105 * @param pDrvIns The driver instance of the hub.
106 * @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
107 * @param cPorts The number of ports.
108 * @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
109 * @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
110 * @thread EMT
111 */
112int pdmR3UsbRegisterHub(PVM pVM, PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
113{
114 /*
115 * Validate input.
116 */
117 /* The driver must be in the USB class. */
118 if (!(pDrvIns->pReg->fClass & PDM_DRVREG_CLASS_USB))
119 {
120 LogRel(("pdmR3UsbRegisterHub: fClass=%#x expected %#x to be set\n", pDrvIns->pReg->fClass, PDM_DRVREG_CLASS_USB));
121 return VERR_INVALID_PARAMETER;
122 }
123 AssertMsgReturn(!(fVersions & ~(VUSB_STDVER_11 | VUSB_STDVER_20 | VUSB_STDVER_30)), ("%#x\n", fVersions), VERR_INVALID_PARAMETER);
124 AssertPtrReturn(ppUsbHubHlp, VERR_INVALID_POINTER);
125 AssertPtrReturn(pUsbHubReg, VERR_INVALID_POINTER);
126 AssertReturn(pUsbHubReg->u32Version == PDM_USBHUBREG_VERSION, VERR_INVALID_MAGIC);
127 AssertReturn(pUsbHubReg->u32TheEnd == PDM_USBHUBREG_VERSION, VERR_INVALID_MAGIC);
128 AssertPtrReturn(pUsbHubReg->pfnAttachDevice, VERR_INVALID_PARAMETER);
129 AssertPtrReturn(pUsbHubReg->pfnDetachDevice, VERR_INVALID_PARAMETER);
130
131 /*
132 * Check for duplicate registration and find the last hub for FIFO registration.
133 */
134 PPDMUSBHUB pPrev = NULL;
135 for (PPDMUSBHUB pCur = pVM->pdm.s.pUsbHubs; pCur; pCur = pCur->pNext)
136 {
137 if (pCur->pDrvIns == pDrvIns)
138 return VERR_PDM_USB_HUB_EXISTS;
139 pPrev = pCur;
140 }
141
142 /*
143 * Create an internal USB hub structure.
144 */
145 PPDMUSBHUB pHub = (PPDMUSBHUB)MMR3HeapAlloc(pVM, MM_TAG_PDM_DRIVER, sizeof(*pHub));
146 if (!pHub)
147 return VERR_NO_MEMORY;
148
149 pHub->fVersions = fVersions;
150 pHub->cPorts = cPorts;
151 pHub->cAvailablePorts = cPorts;
152 pHub->pDrvIns = pDrvIns;
153 pHub->Reg = *pUsbHubReg;
154 pHub->pNext = NULL;
155
156 /* link it */
157 if (pPrev)
158 pPrev->pNext = pHub;
159 else
160 pVM->pdm.s.pUsbHubs = pHub;
161
162 Log(("PDM: Registered USB hub %p/%s\n", pDrvIns, pDrvIns->pReg->szName));
163 return VINF_SUCCESS;
164}
165
166
167/**
168 * Loads one device module and call the registration entry point.
169 *
170 * @returns VBox status code.
171 * @param pVM Pointer to the VM.
172 * @param pRegCB The registration callback stuff.
173 * @param pszFilename Module filename.
174 * @param pszName Module name.
175 */
176static int pdmR3UsbLoad(PVM pVM, PCPDMUSBREGCBINT pRegCB, const char *pszFilename, const char *pszName)
177{
178 /*
179 * Load it.
180 */
181 int rc = pdmR3LoadR3U(pVM->pUVM, pszFilename, pszName);
182 if (RT_SUCCESS(rc))
183 {
184 /*
185 * Get the registration export and call it.
186 */
187 FNPDMVBOXUSBREGISTER *pfnVBoxUsbRegister;
188 rc = PDMR3LdrGetSymbolR3(pVM, pszName, "VBoxUsbRegister", (void **)&pfnVBoxUsbRegister);
189 if (RT_SUCCESS(rc))
190 {
191 Log(("PDM: Calling VBoxUsbRegister (%p) of %s (%s)\n", pfnVBoxUsbRegister, pszName, pszFilename));
192 rc = pfnVBoxUsbRegister(&pRegCB->Core, VBOX_VERSION);
193 if (RT_SUCCESS(rc))
194 Log(("PDM: Successfully loaded device module %s (%s).\n", pszName, pszFilename));
195 else
196 AssertMsgFailed(("VBoxDevicesRegister failed with rc=%Rrc for module %s (%s)\n", rc, pszName, pszFilename));
197 }
198 else
199 {
200 AssertMsgFailed(("Failed to locate 'VBoxUsbRegister' in %s (%s) rc=%Rrc\n", pszName, pszFilename, rc));
201 if (rc == VERR_SYMBOL_NOT_FOUND)
202 rc = VERR_PDM_NO_REGISTRATION_EXPORT;
203 }
204 }
205 else
206 AssertMsgFailed(("Failed to load VBoxDD!\n"));
207 return rc;
208}
209
210
211
212/**
213 * @interface_method_impl{PDMUSBREGCB,pfnRegister}
214 */
215static DECLCALLBACK(int) pdmR3UsbReg_Register(PCPDMUSBREGCB pCallbacks, PCPDMUSBREG pReg)
216{
217 /*
218 * Validate the registration structure.
219 */
220 Assert(pReg);
221 AssertMsgReturn(pReg->u32Version == PDM_USBREG_VERSION,
222 ("Unknown struct version %#x!\n", pReg->u32Version),
223 VERR_PDM_UNKNOWN_USBREG_VERSION);
224 AssertMsgReturn( pReg->szName[0]
225 && strlen(pReg->szName) < sizeof(pReg->szName)
226 && pdmR3IsValidName(pReg->szName),
227 ("Invalid name '%.s'\n", sizeof(pReg->szName), pReg->szName),
228 VERR_PDM_INVALID_USB_REGISTRATION);
229 AssertMsgReturn((pReg->fFlags & ~(PDM_USBREG_HIGHSPEED_CAPABLE | PDM_USBREG_SUPERSPEED_CAPABLE | PDM_USBREG_EMULATED_DEVICE)) == 0,
230 ("fFlags=%#x\n", pReg->fFlags), VERR_PDM_INVALID_USB_REGISTRATION);
231 AssertMsgReturn(pReg->cMaxInstances > 0,
232 ("Max instances %u! (USB Device %s)\n", pReg->cMaxInstances, pReg->szName),
233 VERR_PDM_INVALID_USB_REGISTRATION);
234 AssertMsgReturn(pReg->cbInstance <= _1M,
235 ("Instance size %d bytes! (USB Device %s)\n", pReg->cbInstance, pReg->szName),
236 VERR_PDM_INVALID_USB_REGISTRATION);
237 AssertMsgReturn(pReg->pfnConstruct, ("No constructor! (USB Device %s)\n", pReg->szName),
238 VERR_PDM_INVALID_USB_REGISTRATION);
239
240 /*
241 * Check for duplicate and find FIFO entry at the same time.
242 */
243 PCPDMUSBREGCBINT pRegCB = (PCPDMUSBREGCBINT)pCallbacks;
244 PPDMUSB pUsbPrev = NULL;
245 PPDMUSB pUsb = pRegCB->pVM->pdm.s.pUsbDevs;
246 for (; pUsb; pUsbPrev = pUsb, pUsb = pUsb->pNext)
247 AssertMsgReturn(strcmp(pUsb->pReg->szName, pReg->szName),
248 ("USB Device '%s' already exists\n", pReg->szName),
249 VERR_PDM_USB_NAME_CLASH);
250
251 /*
252 * Allocate new device structure and insert it into the list.
253 */
254 pUsb = (PPDMUSB)MMR3HeapAlloc(pRegCB->pVM, MM_TAG_PDM_DEVICE, sizeof(*pUsb));
255 if (pUsb)
256 {
257 pUsb->pNext = NULL;
258 pUsb->iNextInstance = 0;
259 pUsb->pInstances = NULL;
260 pUsb->pReg = pReg;
261 pUsb->cchName = (RTUINT)strlen(pReg->szName);
262
263 if (pUsbPrev)
264 pUsbPrev->pNext = pUsb;
265 else
266 pRegCB->pVM->pdm.s.pUsbDevs = pUsb;
267 Log(("PDM: Registered USB device '%s'\n", pReg->szName));
268 return VINF_SUCCESS;
269 }
270 return VERR_NO_MEMORY;
271}
272
273
274/**
275 * Load USB Device modules.
276 *
277 * This is called by pdmR3DevInit() after it has loaded it's device modules.
278 *
279 * @returns VBox status code.
280 * @param pVM Pointer to the VM.
281 */
282int pdmR3UsbLoadModules(PVM pVM)
283{
284 LogFlow(("pdmR3UsbLoadModules:\n"));
285
286 AssertRelease(!(RT_OFFSETOF(PDMUSBINS, achInstanceData) & 15));
287 AssertRelease(sizeof(pVM->pdm.s.pUsbInstances->Internal.s) <= sizeof(pVM->pdm.s.pUsbInstances->Internal.padding));
288
289 /*
290 * Initialize the callback structure.
291 */
292 PDMUSBREGCBINT RegCB;
293 RegCB.Core.u32Version = PDM_USBREG_CB_VERSION;
294 RegCB.Core.pfnRegister = pdmR3UsbReg_Register;
295 RegCB.pVM = pVM;
296
297 /*
298 * Load the builtin module
299 */
300 PCFGMNODE pUsbNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/USB/");
301 bool fLoadBuiltin;
302 int rc = CFGMR3QueryBool(pUsbNode, "LoadBuiltin", &fLoadBuiltin);
303 if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
304 fLoadBuiltin = true;
305 else if (RT_FAILURE(rc))
306 {
307 AssertMsgFailed(("Configuration error: Querying boolean \"LoadBuiltin\" failed with %Rrc\n", rc));
308 return rc;
309 }
310 if (fLoadBuiltin)
311 {
312 /* make filename */
313 char *pszFilename = pdmR3FileR3("VBoxDD", true /*fShared*/);
314 if (!pszFilename)
315 return VERR_NO_TMP_MEMORY;
316 rc = pdmR3UsbLoad(pVM, &RegCB, pszFilename, "VBoxDD");
317 RTMemTmpFree(pszFilename);
318 if (RT_FAILURE(rc))
319 return rc;
320 }
321
322 /*
323 * Load additional device modules.
324 */
325 PCFGMNODE pCur;
326 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
327 {
328 /*
329 * Get the name and path.
330 */
331 char szName[PDMMOD_NAME_LEN];
332 rc = CFGMR3GetName(pCur, &szName[0], sizeof(szName));
333 if (rc == VERR_CFGM_NOT_ENOUGH_SPACE)
334 {
335 AssertMsgFailed(("configuration error: The module name is too long, cchName=%zu.\n", CFGMR3GetNameLen(pCur)));
336 return VERR_PDM_MODULE_NAME_TOO_LONG;
337 }
338 else if (RT_FAILURE(rc))
339 {
340 AssertMsgFailed(("CFGMR3GetName -> %Rrc.\n", rc));
341 return rc;
342 }
343
344 /* the path is optional, if no path the module name + path is used. */
345 char szFilename[RTPATH_MAX];
346 rc = CFGMR3QueryString(pCur, "Path", &szFilename[0], sizeof(szFilename));
347 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
348 strcpy(szFilename, szName);
349 else if (RT_FAILURE(rc))
350 {
351 AssertMsgFailed(("configuration error: Failure to query the module path, rc=%Rrc.\n", rc));
352 return rc;
353 }
354
355 /* prepend path? */
356 if (!RTPathHavePath(szFilename))
357 {
358 char *psz = pdmR3FileR3(szFilename, false /*fShared*/);
359 if (!psz)
360 return VERR_NO_TMP_MEMORY;
361 size_t cch = strlen(psz) + 1;
362 if (cch > sizeof(szFilename))
363 {
364 RTMemTmpFree(psz);
365 AssertMsgFailed(("Filename too long! cch=%d '%s'\n", cch, psz));
366 return VERR_FILENAME_TOO_LONG;
367 }
368 memcpy(szFilename, psz, cch);
369 RTMemTmpFree(psz);
370 }
371
372 /*
373 * Load the module and register it's devices.
374 */
375 rc = pdmR3UsbLoad(pVM, &RegCB, szFilename, szName);
376 if (RT_FAILURE(rc))
377 return rc;
378 }
379
380 return VINF_SUCCESS;
381}
382
383
384/**
385 * Send the init-complete notification to all the USB devices.
386 *
387 * This is called from pdmR3DevInit() after it has do its notification round.
388 *
389 * @returns VBox status code.
390 * @param pVM Pointer to the VM.
391 */
392int pdmR3UsbVMInitComplete(PVM pVM)
393{
394 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
395 {
396 if (pUsbIns->pReg->pfnVMInitComplete)
397 {
398 int rc = pUsbIns->pReg->pfnVMInitComplete(pUsbIns);
399 if (RT_FAILURE(rc))
400 {
401 AssertMsgFailed(("InitComplete on USB device '%s'/%d failed with rc=%Rrc\n",
402 pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
403 return rc;
404 }
405 }
406 }
407 return VINF_SUCCESS;
408}
409
410
411/**
412 * Lookups a device structure by name.
413 * @internal
414 */
415PPDMUSB pdmR3UsbLookup(PVM pVM, const char *pszName)
416{
417 size_t cchName = strlen(pszName);
418 for (PPDMUSB pUsb = pVM->pdm.s.pUsbDevs; pUsb; pUsb = pUsb->pNext)
419 if ( pUsb->cchName == cchName
420 && !strcmp(pUsb->pReg->szName, pszName))
421 return pUsb;
422 return NULL;
423}
424
425
426/**
427 * Locates a suitable hub for the specified kind of device.
428 *
429 * @returns VINF_SUCCESS and *ppHub on success.
430 * VERR_PDM_NO_USB_HUBS or VERR_PDM_NO_USB_PORTS on failure.
431 * @param pVM Pointer to the VM.
432 * @param iUsbVersion The USB device version.
433 * @param ppHub Where to store the pointer to the USB hub.
434 */
435static int pdmR3UsbFindHub(PVM pVM, uint32_t iUsbVersion, PPDMUSBHUB *ppHub)
436{
437 *ppHub = NULL;
438 if (!pVM->pdm.s.pUsbHubs)
439 return VERR_PDM_NO_USB_HUBS;
440
441 for (PPDMUSBHUB pCur = pVM->pdm.s.pUsbHubs; pCur; pCur = pCur->pNext)
442 if (pCur->cAvailablePorts > 0)
443 {
444 /* First check for an exact match. */
445 if (pCur->fVersions & iUsbVersion)
446 {
447 *ppHub = pCur;
448 break;
449 }
450 /* For high-speed USB 2.0 devices only, allow USB 1.1 fallback. */
451 if ((iUsbVersion & VUSB_STDVER_20) && (pCur->fVersions == VUSB_STDVER_11))
452 *ppHub = pCur;
453 }
454 if (*ppHub)
455 return VINF_SUCCESS;
456 return VERR_PDM_NO_USB_PORTS;
457}
458
459
460/**
461 * Creates the device.
462 *
463 * @returns VBox status code.
464 * @param pVM Pointer to the VM.
465 * @param pUsbDev The USB device emulation.
466 * @param iInstance -1 if not called by pdmR3UsbInstantiateDevices().
467 * @param pUuid The UUID for this device.
468 * @param ppInstanceNode Pointer to the device instance pointer. This is set to NULL if inserted
469 * into the tree or cleaned up.
470 *
471 * In the pdmR3UsbInstantiateDevices() case (iInstance != -1) this is
472 * the actual instance node and will not be cleaned up.
473 *
474 * @param iUsbVersion The USB version preferred by the device.
475 * @param pszCaptureFilename Path to the file for USB traffic capturing, optional.
476 */
477static int pdmR3UsbCreateDevice(PVM pVM, PPDMUSBHUB pHub, PPDMUSB pUsbDev, int iInstance, PCRTUUID pUuid,
478 PCFGMNODE *ppInstanceNode, uint32_t iUsbVersion, const char *pszCaptureFilename)
479{
480 const bool fAtRuntime = iInstance == -1;
481 int rc;
482
483 AssertPtrReturn(ppInstanceNode, VERR_INVALID_POINTER);
484 AssertPtrReturn(*ppInstanceNode, VERR_INVALID_POINTER);
485
486 /*
487 * If not called by pdmR3UsbInstantiateDevices(), we'll have to fix
488 * the configuration now.
489 */
490 /* USB device node. */
491 PCFGMNODE pDevNode = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "USB/%s/", pUsbDev->pReg->szName);
492 if (!pDevNode)
493 {
494 rc = CFGMR3InsertNodeF(CFGMR3GetRoot(pVM), &pDevNode, "USB/%s/", pUsbDev->pReg->szName);
495 AssertRCReturn(rc, rc);
496 }
497
498 /* The instance node and number. */
499 PCFGMNODE pInstanceToDelete = NULL;
500 PCFGMNODE pInstanceNode = NULL;
501 if (fAtRuntime)
502 {
503 /** @todo r=bird: This code is bogus as it ASSUMES that all USB devices are
504 * capable of infinite number of instances. */
505 for (unsigned c = 0; c < _2M; c++)
506 {
507 iInstance = pUsbDev->iNextInstance++;
508 rc = CFGMR3InsertNodeF(pDevNode, &pInstanceNode, "%d/", iInstance);
509 if (rc != VERR_CFGM_NODE_EXISTS)
510 break;
511 }
512 AssertRCReturn(rc, rc);
513
514 rc = CFGMR3ReplaceSubTree(pInstanceNode, *ppInstanceNode);
515 AssertRCReturn(rc, rc);
516 *ppInstanceNode = NULL;
517 pInstanceToDelete = pInstanceNode;
518 }
519 else
520 {
521 Assert(iInstance >= 0);
522 if (iInstance >= (int)pUsbDev->iNextInstance)
523 pUsbDev->iNextInstance = iInstance + 1;
524 pInstanceNode = *ppInstanceNode;
525 }
526
527 /* Make sure the instance config node exists. */
528 PCFGMNODE pConfig = CFGMR3GetChild(pInstanceNode, "Config");
529 if (!pConfig)
530 {
531 rc = CFGMR3InsertNode(pInstanceNode, "Config", &pConfig);
532 AssertRCReturn(rc, rc);
533 }
534 Assert(CFGMR3GetChild(pInstanceNode, "Config") == pConfig);
535
536 /* The global device config node. */
537 PCFGMNODE pGlobalConfig = CFGMR3GetChild(pDevNode, "GlobalConfig");
538 if (!pGlobalConfig)
539 {
540 rc = CFGMR3InsertNode(pDevNode, "GlobalConfig", &pGlobalConfig);
541 if (RT_FAILURE(rc))
542 {
543 CFGMR3RemoveNode(pInstanceToDelete);
544 AssertRCReturn(rc, rc);
545 }
546 }
547
548 /*
549 * Allocate the device instance.
550 */
551 size_t cb = RT_OFFSETOF(PDMUSBINS, achInstanceData[pUsbDev->pReg->cbInstance]);
552 cb = RT_ALIGN_Z(cb, 16);
553 PPDMUSBINS pUsbIns;
554 rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_USB, cb, (void **)&pUsbIns);
555 if (RT_FAILURE(rc))
556 {
557 AssertMsgFailed(("Failed to allocate %d bytes of instance data for USB device '%s'. rc=%Rrc\n",
558 cb, pUsbDev->pReg->szName, rc));
559 CFGMR3RemoveNode(pInstanceToDelete);
560 return rc;
561 }
562
563 /*
564 * Initialize it.
565 */
566 pUsbIns->u32Version = PDM_USBINS_VERSION;
567 //pUsbIns->Internal.s.pNext = NULL;
568 //pUsbIns->Internal.s.pPerDeviceNext = NULL;
569 pUsbIns->Internal.s.pUsbDev = pUsbDev;
570 pUsbIns->Internal.s.pVM = pVM;
571 //pUsbIns->Internal.s.pLuns = NULL;
572 pUsbIns->Internal.s.pCfg = pInstanceNode;
573 pUsbIns->Internal.s.pCfgDelete = pInstanceToDelete;
574 pUsbIns->Internal.s.pCfgGlobal = pGlobalConfig;
575 pUsbIns->Internal.s.Uuid = *pUuid;
576 //pUsbIns->Internal.s.pHub = NULL;
577 pUsbIns->Internal.s.iPort = UINT32_MAX; /* to be determined. */
578 /* Set the flag accordingly.
579 * Oherwise VMPowerOff, VMSuspend will not be called for devices attached at runtime.
580 */
581 pUsbIns->Internal.s.fVMSuspended = !fAtRuntime;
582 //pUsbIns->Internal.s.pfnAsyncNotify = NULL;
583 pUsbIns->pHlpR3 = &g_pdmR3UsbHlp;
584 pUsbIns->pReg = pUsbDev->pReg;
585 pUsbIns->pCfg = pConfig;
586 pUsbIns->pCfgGlobal = pGlobalConfig;
587 pUsbIns->iInstance = iInstance;
588 pUsbIns->pvInstanceDataR3 = &pUsbIns->achInstanceData[0];
589 pUsbIns->pszName = RTStrDup(pUsbDev->pReg->szName);
590 //pUsbIns->fTracing = 0;
591 pUsbIns->idTracing = ++pVM->pdm.s.idTracingOther;
592 pUsbIns->iUsbHubVersion = iUsbVersion;
593
594 /*
595 * Link it into all the lists.
596 */
597 /* The global instance FIFO. */
598 PPDMUSBINS pPrev1 = pVM->pdm.s.pUsbInstances;
599 if (!pPrev1)
600 pVM->pdm.s.pUsbInstances = pUsbIns;
601 else
602 {
603 while (pPrev1->Internal.s.pNext)
604 {
605 Assert(pPrev1->u32Version == PDM_USBINS_VERSION);
606 pPrev1 = pPrev1->Internal.s.pNext;
607 }
608 pPrev1->Internal.s.pNext = pUsbIns;
609 }
610
611 /* The per device instance FIFO. */
612 PPDMUSBINS pPrev2 = pUsbDev->pInstances;
613 if (!pPrev2)
614 pUsbDev->pInstances = pUsbIns;
615 else
616 {
617 while (pPrev2->Internal.s.pPerDeviceNext)
618 {
619 Assert(pPrev2->u32Version == PDM_USBINS_VERSION);
620 pPrev2 = pPrev2->Internal.s.pPerDeviceNext;
621 }
622 pPrev2->Internal.s.pPerDeviceNext = pUsbIns;
623 }
624
625 /*
626 * Call the constructor.
627 */
628 Log(("PDM: Constructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
629 rc = pUsbIns->pReg->pfnConstruct(pUsbIns, pUsbIns->iInstance, pUsbIns->pCfg, pUsbIns->pCfgGlobal);
630 if (RT_SUCCESS(rc))
631 {
632 /*
633 * Attach it to the hub.
634 */
635 Log(("PDM: Attaching it...\n"));
636 rc = pHub->Reg.pfnAttachDevice(pHub->pDrvIns, pUsbIns, pszCaptureFilename, &pUsbIns->Internal.s.iPort);
637 if (RT_SUCCESS(rc))
638 {
639 pHub->cAvailablePorts--;
640 Assert((int32_t)pHub->cAvailablePorts >= 0 && pHub->cAvailablePorts < pHub->cPorts);
641 pUsbIns->Internal.s.pHub = pHub;
642
643 /* Send the hot-plugged notification if applicable. */
644 if (fAtRuntime && pUsbIns->pReg->pfnHotPlugged)
645 pUsbIns->pReg->pfnHotPlugged(pUsbIns);
646
647 Log(("PDM: Successfully attached USB device '%s' instance %d to hub %p\n",
648 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub));
649 return VINF_SUCCESS;
650 }
651
652 LogRel(("PDM: Failed to attach USB device '%s' instance %d to hub %p: %Rrc\n",
653 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
654 }
655 else
656 {
657 AssertMsgFailed(("Failed to construct '%s'/%d! %Rra\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
658 if (rc == VERR_VERSION_MISMATCH)
659 rc = VERR_PDM_DRIVER_VERSION_MISMATCH;
660 }
661 if (fAtRuntime)
662 pdmR3UsbDestroyDevice(pVM, pUsbIns);
663 /* else: destructors are invoked later. */
664 return rc;
665}
666
667
668/**
669 * Instantiate USB devices.
670 *
671 * This is called by pdmR3DevInit() after it has instantiated the
672 * other devices and their drivers. If there aren't any hubs
673 * around, we'll silently skip the USB devices.
674 *
675 * @returns VBox status code.
676 * @param pVM
677 */
678int pdmR3UsbInstantiateDevices(PVM pVM)
679{
680 /*
681 * Any hubs?
682 */
683 if (!pVM->pdm.s.pUsbHubs)
684 {
685 Log(("PDM: No USB hubs, skipping USB device instantiation.\n"));
686 return VINF_SUCCESS;
687 }
688
689 /*
690 * Count the device instances.
691 */
692 PCFGMNODE pCur;
693 PCFGMNODE pUsbNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "USB/");
694 PCFGMNODE pInstanceNode;
695 unsigned cUsbDevs = 0;
696 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
697 {
698 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
699 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
700 if (pInstanceNode != pGlobal)
701 cUsbDevs++;
702 }
703 if (!cUsbDevs)
704 {
705 Log(("PDM: No USB devices were configured!\n"));
706 return VINF_SUCCESS;
707 }
708 Log2(("PDM: cUsbDevs=%d!\n", cUsbDevs));
709
710 /*
711 * Collect info on each USB device instance.
712 */
713 struct USBDEVORDER
714 {
715 /** Configuration node. */
716 PCFGMNODE pNode;
717 /** Pointer to the USB device. */
718 PPDMUSB pUsbDev;
719 /** Init order. */
720 uint32_t u32Order;
721 /** VBox instance number. */
722 uint32_t iInstance;
723 /** Device UUID. */
724 RTUUID Uuid;
725 } *paUsbDevs = (struct USBDEVORDER *)alloca(sizeof(paUsbDevs[0]) * (cUsbDevs + 1)); /* (One extra for swapping) */
726 Assert(paUsbDevs);
727 int rc;
728 unsigned i = 0;
729 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
730 {
731 /* Get the device name. */
732 char szName[sizeof(paUsbDevs[0].pUsbDev->pReg->szName)];
733 rc = CFGMR3GetName(pCur, szName, sizeof(szName));
734 AssertMsgRCReturn(rc, ("Configuration error: device name is too long (or something)! rc=%Rrc\n", rc), rc);
735
736 /* Find the device. */
737 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, szName);
738 AssertMsgReturn(pUsbDev, ("Configuration error: device '%s' not found!\n", szName), VERR_PDM_DEVICE_NOT_FOUND);
739
740 /* Configured priority or use default? */
741 uint32_t u32Order;
742 rc = CFGMR3QueryU32(pCur, "Priority", &u32Order);
743 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
744 u32Order = i << 4;
745 else
746 AssertMsgRCReturn(rc, ("Configuration error: reading \"Priority\" for the '%s' USB device failed rc=%Rrc!\n", szName, rc), rc);
747
748 /* Global config. */
749 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
750 if (!pGlobal)
751 {
752 rc = CFGMR3InsertNode(pCur, "GlobalConfig/", &pGlobal);
753 AssertMsgRCReturn(rc, ("Failed to create GlobalConfig node! rc=%Rrc\n", rc), rc);
754 CFGMR3SetRestrictedRoot(pGlobal);
755 }
756
757 /* Enumerate the device instances. */
758 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
759 {
760 if (pInstanceNode == pGlobal)
761 continue;
762
763 /* Use the configured UUID if present, create our own otherwise. */
764 char *pszUuid = NULL;
765
766 RTUuidClear(&paUsbDevs[i].Uuid);
767 rc = CFGMR3QueryStringAlloc(pInstanceNode, "UUID", &pszUuid);
768 if (RT_SUCCESS(rc))
769 {
770 AssertPtr(pszUuid);
771
772 rc = RTUuidFromStr(&paUsbDevs[i].Uuid, pszUuid);
773 AssertMsgRCReturn(rc, ("Failed to convert UUID from string! rc=%Rrc\n", rc), rc);
774 MMR3HeapFree(pszUuid);
775 }
776 else if (rc == VERR_CFGM_VALUE_NOT_FOUND)
777 rc = RTUuidCreate(&paUsbDevs[i].Uuid);
778
779 AssertRCReturn(rc, rc);
780 paUsbDevs[i].pNode = pInstanceNode;
781 paUsbDevs[i].pUsbDev = pUsbDev;
782 paUsbDevs[i].u32Order = u32Order;
783
784 /* Get the instance number. */
785 char szInstance[32];
786 rc = CFGMR3GetName(pInstanceNode, szInstance, sizeof(szInstance));
787 AssertMsgRCReturn(rc, ("Configuration error: instance name is too long (or something)! rc=%Rrc\n", rc), rc);
788 char *pszNext = NULL;
789 rc = RTStrToUInt32Ex(szInstance, &pszNext, 0, &paUsbDevs[i].iInstance);
790 AssertMsgRCReturn(rc, ("Configuration error: RTStrToInt32Ex failed on the instance name '%s'! rc=%Rrc\n", szInstance, rc), rc);
791 AssertMsgReturn(!*pszNext, ("Configuration error: the instance name '%s' isn't all digits. (%s)\n", szInstance, pszNext), VERR_INVALID_PARAMETER);
792
793 /* next instance */
794 i++;
795 }
796 } /* devices */
797 Assert(i == cUsbDevs);
798
799 /*
800 * Sort the device array ascending on u32Order. (bubble)
801 */
802 unsigned c = cUsbDevs - 1;
803 while (c)
804 {
805 unsigned j = 0;
806 for (i = 0; i < c; i++)
807 if (paUsbDevs[i].u32Order > paUsbDevs[i + 1].u32Order)
808 {
809 paUsbDevs[cUsbDevs] = paUsbDevs[i + 1];
810 paUsbDevs[i + 1] = paUsbDevs[i];
811 paUsbDevs[i] = paUsbDevs[cUsbDevs];
812 j = i;
813 }
814 c = j;
815 }
816
817 /*
818 * Instantiate the devices.
819 */
820 for (i = 0; i < cUsbDevs; i++)
821 {
822 /*
823 * Make sure there is a config node and mark it as restricted.
824 */
825 PCFGMNODE pConfigNode = CFGMR3GetChild(paUsbDevs[i].pNode, "Config/");
826 if (!pConfigNode)
827 {
828 rc = CFGMR3InsertNode(paUsbDevs[i].pNode, "Config", &pConfigNode);
829 AssertMsgRCReturn(rc, ("Failed to create Config node! rc=%Rrc\n", rc), rc);
830 }
831 CFGMR3SetRestrictedRoot(pConfigNode);
832
833 /*
834 * Every emulated device must support USB 1.x hubs; optionally, high-speed USB 2.0 hubs
835 * might be also supported. This determines where to attach the device.
836 */
837 uint32_t iUsbVersion = VUSB_STDVER_11;
838
839 if (paUsbDevs[i].pUsbDev->pReg->fFlags & PDM_USBREG_HIGHSPEED_CAPABLE)
840 iUsbVersion |= VUSB_STDVER_20;
841 if (paUsbDevs[i].pUsbDev->pReg->fFlags & PDM_USBREG_SUPERSPEED_CAPABLE)
842 iUsbVersion |= VUSB_STDVER_30;
843
844 /*
845 * Find a suitable hub with free ports.
846 */
847 PPDMUSBHUB pHub;
848 rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
849 if (RT_FAILURE(rc))
850 {
851 Log(("pdmR3UsbFindHub failed %Rrc\n", rc));
852 return rc;
853 }
854
855 /*
856 * This is how we inform the device what speed it's communicating at, and hence
857 * which descriptors it should present to the guest.
858 */
859 iUsbVersion &= pHub->fVersions;
860
861 /*
862 * Create and attach the device.
863 */
864 rc = pdmR3UsbCreateDevice(pVM, pHub, paUsbDevs[i].pUsbDev, paUsbDevs[i].iInstance, &paUsbDevs[i].Uuid,
865 &paUsbDevs[i].pNode, iUsbVersion, NULL);
866 if (RT_FAILURE(rc))
867 return rc;
868 } /* for device instances */
869
870 return VINF_SUCCESS;
871}
872
873
874/**
875 * Creates an emulated USB device instance at runtime.
876 *
877 * This will find an appropriate HUB for the USB device
878 * and try instantiate the emulated device.
879 *
880 * @returns VBox status code.
881 * @param pUVM The user mode VM handle.
882 * @param pszDeviceName The name of the PDM device to instantiate.
883 * @param pInstanceNode The instance CFGM node.
884 * @param pUuid The UUID to be associated with the device.
885 * @param pszCaptureFilename Path to the file for USB traffic capturing, optional.
886 *
887 * @thread EMT
888 */
889VMMR3DECL(int) PDMR3UsbCreateEmulatedDevice(PUVM pUVM, const char *pszDeviceName, PCFGMNODE pInstanceNode, PCRTUUID pUuid,
890 const char *pszCaptureFilename)
891{
892 /*
893 * Validate input.
894 */
895 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
896 PVM pVM = pUVM->pVM;
897 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
898 VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
899 AssertPtrReturn(pszDeviceName, VERR_INVALID_POINTER);
900 AssertPtrReturn(pInstanceNode, VERR_INVALID_POINTER);
901
902 /*
903 * Find the device.
904 */
905 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, pszDeviceName);
906 if (!pUsbDev)
907 {
908 LogRel(("PDMR3UsbCreateEmulatedDevice: The '%s' device wasn't found\n", pszDeviceName));
909 return VERR_PDM_NO_USBPROXY;
910 }
911
912 /*
913 * Every device must support USB 1.x hubs; optionally, high-speed USB 2.0 hubs
914 * might be also supported. This determines where to attach the device.
915 */
916 uint32_t iUsbVersion = VUSB_STDVER_11;
917 if (pUsbDev->pReg->fFlags & PDM_USBREG_HIGHSPEED_CAPABLE)
918 iUsbVersion |= VUSB_STDVER_20;
919 if (pUsbDev->pReg->fFlags & PDM_USBREG_SUPERSPEED_CAPABLE)
920 iUsbVersion |= VUSB_STDVER_30;
921
922 /*
923 * Find a suitable hub with free ports.
924 */
925 PPDMUSBHUB pHub;
926 int rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
927 if (RT_FAILURE(rc))
928 {
929 Log(("pdmR3UsbFindHub: failed %Rrc\n", rc));
930 return rc;
931 }
932
933 /*
934 * This is how we inform the device what speed it's communicating at, and hence
935 * which descriptors it should present to the guest.
936 */
937 iUsbVersion &= pHub->fVersions;
938
939 /*
940 * Create and attach the device.
941 */
942 rc = pdmR3UsbCreateDevice(pVM, pHub, pUsbDev, -1, pUuid, &pInstanceNode, iUsbVersion, pszCaptureFilename);
943 AssertRCReturn(rc, rc);
944
945 return rc;
946}
947
948
949/**
950 * Creates a USB proxy device instance.
951 *
952 * This will find an appropriate HUB for the USB device, create the necessary CFGM stuff
953 * and try instantiate the proxy device.
954 *
955 * @returns VBox status code.
956 * @param pUVM The user mode VM handle.
957 * @param pUuid The UUID to be associated with the device.
958 * @param fRemote Whether it's a remove or local device.
959 * @param pszAddress The address string.
960 * @param pvBackend Pointer to the backend.
961 * @param iUsbVersion The preferred USB version.
962 * @param fMaskedIfs The interfaces to hide from the guest.
963 * @param pszCaptureFilename Path to the file for USB traffic capturing, optional.
964 */
965VMMR3DECL(int) PDMR3UsbCreateProxyDevice(PUVM pUVM, PCRTUUID pUuid, bool fRemote, const char *pszAddress, void *pvBackend,
966 uint32_t iUsbVersion, uint32_t fMaskedIfs, const char *pszCaptureFilename)
967{
968 /*
969 * Validate input.
970 */
971 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
972 PVM pVM = pUVM->pVM;
973 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
974 VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
975 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
976 AssertPtrReturn(pszAddress, VERR_INVALID_POINTER);
977 AssertReturn( iUsbVersion == VUSB_STDVER_30
978 || iUsbVersion == VUSB_STDVER_20
979 || iUsbVersion == VUSB_STDVER_11, VERR_INVALID_PARAMETER);
980
981 /*
982 * Find the USBProxy driver.
983 */
984 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, "USBProxy");
985 if (!pUsbDev)
986 {
987 LogRel(("PDMR3UsbCreateProxyDevice: The USBProxy device class wasn't found\n"));
988 return VERR_PDM_NO_USBPROXY;
989 }
990
991 /*
992 * Find a suitable hub with free ports.
993 */
994 PPDMUSBHUB pHub;
995 int rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
996 if (RT_FAILURE(rc))
997 {
998 Log(("pdmR3UsbFindHub: failed %Rrc\n", rc));
999 return rc;
1000 }
1001
1002 /*
1003 * Create the CFGM instance node.
1004 */
1005 PCFGMNODE pInstance = CFGMR3CreateTree(pUVM);
1006 AssertReturn(pInstance, VERR_NO_MEMORY);
1007 do /* break loop */
1008 {
1009 PCFGMNODE pConfig;
1010 rc = CFGMR3InsertNode(pInstance, "Config", &pConfig); AssertRCBreak(rc);
1011 rc = CFGMR3InsertString(pConfig, "Address", pszAddress); AssertRCBreak(rc);
1012 char szUuid[RTUUID_STR_LENGTH];
1013 rc = RTUuidToStr(pUuid, &szUuid[0], sizeof(szUuid)); AssertRCBreak(rc);
1014 rc = CFGMR3InsertString(pConfig, "UUID", szUuid); AssertRCBreak(rc);
1015 rc = CFGMR3InsertInteger(pConfig, "Remote", fRemote); AssertRCBreak(rc);
1016 rc = CFGMR3InsertInteger(pConfig, "USBVersion", iUsbVersion); AssertRCBreak(rc);
1017 rc = CFGMR3InsertInteger(pConfig, "pvBackend", (uintptr_t)pvBackend); AssertRCBreak(rc);
1018 rc = CFGMR3InsertInteger(pConfig, "MaskedIfs", fMaskedIfs); AssertRCBreak(rc);
1019 rc = CFGMR3InsertInteger(pConfig, "Force11Device", !(pHub->fVersions & iUsbVersion)); AssertRCBreak(rc);
1020 } while (0); /* break loop */
1021 if (RT_FAILURE(rc))
1022 {
1023 CFGMR3RemoveNode(pInstance);
1024 LogRel(("PDMR3UsbCreateProxyDevice: failed to setup CFGM config, rc=%Rrc\n", rc));
1025 return rc;
1026 }
1027
1028 /*
1029 * Finally, try to create it.
1030 */
1031 rc = pdmR3UsbCreateDevice(pVM, pHub, pUsbDev, -1, pUuid, &pInstance, iUsbVersion, pszCaptureFilename);
1032 if (RT_FAILURE(rc) && pInstance)
1033 CFGMR3RemoveNode(pInstance);
1034 return rc;
1035}
1036
1037
1038/**
1039 * Destroys a hot-plugged USB device.
1040 *
1041 * The device must be detached from the HUB at this point.
1042 *
1043 * @param pVM Pointer to the VM.
1044 * @param pUsbIns The USB device instance to destroy.
1045 * @thread EMT
1046 */
1047static void pdmR3UsbDestroyDevice(PVM pVM, PPDMUSBINS pUsbIns)
1048{
1049 Assert(!pUsbIns->Internal.s.pHub);
1050
1051 /*
1052 * Do the unplug notification.
1053 */
1054 /** @todo what about the drivers? */
1055 if (pUsbIns->pReg->pfnHotUnplugged)
1056 pUsbIns->pReg->pfnHotUnplugged(pUsbIns);
1057
1058 /*
1059 * Destroy the luns with their driver chains and call the device destructor.
1060 */
1061 while (pUsbIns->Internal.s.pLuns)
1062 {
1063 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
1064 pUsbIns->Internal.s.pLuns = pLun->pNext;
1065 if (pLun->pTop)
1066 pdmR3DrvDestroyChain(pLun->pTop, PDM_TACH_FLAGS_NOT_HOT_PLUG); /* Hotplugging is handled differently here atm. */
1067 MMR3HeapFree(pLun);
1068 }
1069
1070 /* finally, the device. */
1071 if (pUsbIns->pReg->pfnDestruct)
1072 {
1073 Log(("PDM: Destructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1074 pUsbIns->pReg->pfnDestruct(pUsbIns);
1075 }
1076 TMR3TimerDestroyUsb(pVM, pUsbIns);
1077 SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
1078 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
1079#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1080 pdmR3AsyncCompletionTemplateDestroyUsb(pVM, pUsbIns);
1081#endif
1082
1083 /*
1084 * Unlink it.
1085 */
1086 /* The global instance FIFO. */
1087 if (pVM->pdm.s.pUsbInstances == pUsbIns)
1088 pVM->pdm.s.pUsbInstances = pUsbIns->Internal.s.pNext;
1089 else
1090 {
1091 PPDMUSBINS pPrev = pVM->pdm.s.pUsbInstances;
1092 while (pPrev && pPrev->Internal.s.pNext != pUsbIns)
1093 {
1094 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
1095 pPrev = pPrev->Internal.s.pNext;
1096 }
1097 Assert(pPrev); Assert(pPrev != pUsbIns);
1098 if (pPrev)
1099 pPrev->Internal.s.pNext = pUsbIns->Internal.s.pNext;
1100 }
1101
1102 /* The per device instance FIFO. */
1103 PPDMUSB pUsbDev = pUsbIns->Internal.s.pUsbDev;
1104 if (pUsbDev->pInstances == pUsbIns)
1105 pUsbDev->pInstances = pUsbIns->Internal.s.pPerDeviceNext;
1106 else
1107 {
1108 PPDMUSBINS pPrev = pUsbDev->pInstances;
1109 while (pPrev && pPrev->Internal.s.pPerDeviceNext != pUsbIns)
1110 {
1111 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
1112 pPrev = pPrev->Internal.s.pPerDeviceNext;
1113 }
1114 Assert(pPrev); Assert(pPrev != pUsbIns);
1115 if (pPrev)
1116 pPrev->Internal.s.pPerDeviceNext = pUsbIns->Internal.s.pPerDeviceNext;
1117 }
1118
1119 /*
1120 * Trash it.
1121 */
1122 pUsbIns->u32Version = 0;
1123 pUsbIns->pReg = NULL;
1124 if (pUsbIns->pszName)
1125 {
1126 RTStrFree(pUsbIns->pszName);
1127 pUsbIns->pszName = NULL;
1128 }
1129 CFGMR3RemoveNode(pUsbIns->Internal.s.pCfgDelete);
1130 MMR3HeapFree(pUsbIns);
1131}
1132
1133
1134/**
1135 * Detaches and destroys a USB device.
1136 *
1137 * @returns VBox status code.
1138 * @param pUVM The user mode VM handle.
1139 * @param pUuid The UUID associated with the device to detach.
1140 * @thread EMT
1141 */
1142VMMR3DECL(int) PDMR3UsbDetachDevice(PUVM pUVM, PCRTUUID pUuid)
1143{
1144 /*
1145 * Validate input.
1146 */
1147 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1148 PVM pVM = pUVM->pVM;
1149 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1150 VM_ASSERT_EMT(pVM);
1151 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
1152
1153 /*
1154 * Search the global list for it.
1155 */
1156 PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances;
1157 for ( ; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1158 if (!RTUuidCompare(&pUsbIns->Internal.s.Uuid, pUuid))
1159 break;
1160 if (!pUsbIns)
1161 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND; /** @todo VERR_PDM_USB_INSTANCE_NOT_FOUND */
1162
1163 /*
1164 * Detach it from the HUB (if it's actually attached to one).
1165 */
1166 PPDMUSBHUB pHub = pUsbIns->Internal.s.pHub;
1167 if (pHub)
1168 {
1169 int rc = pHub->Reg.pfnDetachDevice(pHub->pDrvIns, pUsbIns, pUsbIns->Internal.s.iPort);
1170 if (RT_FAILURE(rc))
1171 {
1172 LogRel(("PDM: Failed to detach USB device '%s' instance %d from %p: %Rrc\n",
1173 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
1174 return rc;
1175 }
1176
1177 pHub->cAvailablePorts++;
1178 Assert(pHub->cAvailablePorts > 0 && pHub->cAvailablePorts <= pHub->cPorts);
1179 pUsbIns->Internal.s.pHub = NULL;
1180 }
1181
1182 /*
1183 * Notify about unplugging and destroy the device with it's drivers.
1184 */
1185 pdmR3UsbDestroyDevice(pVM, pUsbIns);
1186
1187 return VINF_SUCCESS;
1188}
1189
1190
1191/**
1192 * Checks if there are any USB hubs attached.
1193 *
1194 * @returns true / false accordingly.
1195 * @param pUVM The user mode VM handle.
1196 */
1197VMMR3DECL(bool) PDMR3UsbHasHub(PUVM pUVM)
1198{
1199 UVM_ASSERT_VALID_EXT_RETURN(pUVM, false);
1200 PVM pVM = pUVM->pVM;
1201 VM_ASSERT_VALID_EXT_RETURN(pVM, false);
1202 return pVM->pdm.s.pUsbHubs != NULL;
1203}
1204
1205
1206/**
1207 * Locates a LUN.
1208 *
1209 * @returns VBox status code.
1210 * @param pVM Pointer to the VM.
1211 * @param pszDevice Device name.
1212 * @param iInstance Device instance.
1213 * @param iLun The Logical Unit to obtain the interface of.
1214 * @param ppLun Where to store the pointer to the LUN if found.
1215 * @thread Try only do this in EMT...
1216 */
1217static int pdmR3UsbFindLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPPDMLUN ppLun)
1218{
1219 /*
1220 * Iterate registered devices looking for the device.
1221 */
1222 size_t cchDevice = strlen(pszDevice);
1223 for (PPDMUSB pUsbDev = pVM->pdm.s.pUsbDevs; pUsbDev; pUsbDev = pUsbDev->pNext)
1224 {
1225 if ( pUsbDev->cchName == cchDevice
1226 && !memcmp(pUsbDev->pReg->szName, pszDevice, cchDevice))
1227 {
1228 /*
1229 * Iterate device instances.
1230 */
1231 for (PPDMUSBINS pUsbIns = pUsbDev->pInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pPerDeviceNext)
1232 {
1233 if (pUsbIns->iInstance == iInstance)
1234 {
1235 /*
1236 * Iterate luns.
1237 */
1238 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1239 {
1240 if (pLun->iLun == iLun)
1241 {
1242 *ppLun = pLun;
1243 return VINF_SUCCESS;
1244 }
1245 }
1246 return VERR_PDM_LUN_NOT_FOUND;
1247 }
1248 }
1249 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
1250 }
1251 }
1252 return VERR_PDM_DEVICE_NOT_FOUND;
1253}
1254
1255
1256/**
1257 * Attaches a preconfigured driver to an existing device or driver instance.
1258 *
1259 * This is used to change drivers and suchlike at runtime. The driver or device
1260 * at the end of the chain will be told to attach to whatever is configured
1261 * below it.
1262 *
1263 * @returns VBox status code.
1264 * @param pUVM The user mode VM handle.
1265 * @param pszDevice Device name.
1266 * @param iInstance Device instance.
1267 * @param iLun The Logical Unit to obtain the interface of.
1268 * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
1269 * @param ppBase Where to store the base interface pointer. Optional.
1270 *
1271 * @thread EMT
1272 */
1273VMMR3DECL(int) PDMR3UsbDriverAttach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun, uint32_t fFlags,
1274 PPPDMIBASE ppBase)
1275{
1276 LogFlow(("PDMR3UsbDriverAttach: pszDevice=%p:{%s} iDevIns=%d iLun=%d fFlags=%#x ppBase=%p\n",
1277 pszDevice, pszDevice, iDevIns, iLun, fFlags, ppBase));
1278 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1279 PVM pVM = pUVM->pVM;
1280 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1281 VM_ASSERT_EMT(pVM);
1282
1283 if (ppBase)
1284 *ppBase = NULL;
1285
1286 /*
1287 * Find the LUN in question.
1288 */
1289 PPDMLUN pLun;
1290 int rc = pdmR3UsbFindLun(pVM, pszDevice, iDevIns, iLun, &pLun);
1291 if (RT_SUCCESS(rc))
1292 {
1293 /*
1294 * Anything attached to the LUN?
1295 */
1296 PPDMDRVINS pDrvIns = pLun->pTop;
1297 if (!pDrvIns)
1298 {
1299 /* No, ask the device to attach to the new stuff. */
1300 PPDMUSBINS pUsbIns = pLun->pUsbIns;
1301 if (pUsbIns->pReg->pfnDriverAttach)
1302 {
1303 rc = pUsbIns->pReg->pfnDriverAttach(pUsbIns, iLun, fFlags);
1304 if (RT_SUCCESS(rc) && ppBase)
1305 *ppBase = pLun->pTop ? &pLun->pTop->IBase : NULL;
1306 }
1307 else
1308 rc = VERR_PDM_DEVICE_NO_RT_ATTACH;
1309 }
1310 else
1311 {
1312 /* Yes, find the bottom most driver and ask it to attach to the new stuff. */
1313 while (pDrvIns->Internal.s.pDown)
1314 pDrvIns = pDrvIns->Internal.s.pDown;
1315 if (pDrvIns->pReg->pfnAttach)
1316 {
1317 rc = pDrvIns->pReg->pfnAttach(pDrvIns, fFlags);
1318 if (RT_SUCCESS(rc) && ppBase)
1319 *ppBase = pDrvIns->Internal.s.pDown
1320 ? &pDrvIns->Internal.s.pDown->IBase
1321 : NULL;
1322 }
1323 else
1324 rc = VERR_PDM_DRIVER_NO_RT_ATTACH;
1325 }
1326 }
1327
1328 if (ppBase)
1329 LogFlow(("PDMR3UsbDriverAttach: returns %Rrc *ppBase=%p\n", rc, *ppBase));
1330 else
1331 LogFlow(("PDMR3UsbDriverAttach: returns %Rrc\n", rc));
1332 return rc;
1333}
1334
1335
1336/**
1337 * Detaches the specified driver instance.
1338 *
1339 * This is used to replumb drivers at runtime for simulating hot plugging and
1340 * media changes.
1341 *
1342 * This method allows detaching drivers from
1343 * any driver or device by specifying the driver to start detaching at. The
1344 * only prerequisite is that the driver or device above implements the
1345 * pfnDetach callback (PDMDRVREG / PDMUSBREG).
1346 *
1347 * @returns VBox status code.
1348 * @param pUVM The user mode VM handle.
1349 * @param pszDevice Device name.
1350 * @param iDevIns Device instance.
1351 * @param iLun The Logical Unit in which to look for the driver.
1352 * @param pszDriver The name of the driver which to detach. If NULL
1353 * then the entire driver chain is detatched.
1354 * @param iOccurance The occurrence of that driver in the chain. This is
1355 * usually 0.
1356 * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
1357 * @thread EMT
1358 */
1359VMMR3DECL(int) PDMR3UsbDriverDetach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
1360 const char *pszDriver, unsigned iOccurance, uint32_t fFlags)
1361{
1362 LogFlow(("PDMR3UsbDriverDetach: pszDevice=%p:{%s} iDevIns=%u iLun=%u pszDriver=%p:{%s} iOccurance=%u fFlags=%#x\n",
1363 pszDevice, pszDevice, iDevIns, iLun, pszDriver, iOccurance, fFlags));
1364 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1365 PVM pVM = pUVM->pVM;
1366 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1367 VM_ASSERT_EMT(pVM);
1368 AssertPtr(pszDevice);
1369 AssertPtrNull(pszDriver);
1370 Assert(iOccurance == 0 || pszDriver);
1371 Assert(!(fFlags & ~(PDM_TACH_FLAGS_NOT_HOT_PLUG)));
1372
1373 /*
1374 * Find the LUN in question.
1375 */
1376 PPDMLUN pLun;
1377 int rc = pdmR3UsbFindLun(pVM, pszDevice, iDevIns, iLun, &pLun);
1378 if (RT_SUCCESS(rc))
1379 {
1380 /*
1381 * Locate the driver.
1382 */
1383 PPDMDRVINS pDrvIns = pLun->pTop;
1384 if (pDrvIns)
1385 {
1386 if (pszDriver)
1387 {
1388 while (pDrvIns)
1389 {
1390 if (!strcmp(pDrvIns->pReg->szName, pszDriver))
1391 {
1392 if (iOccurance == 0)
1393 break;
1394 iOccurance--;
1395 }
1396 pDrvIns = pDrvIns->Internal.s.pDown;
1397 }
1398 }
1399 if (pDrvIns)
1400 rc = pdmR3DrvDetach(pDrvIns, fFlags);
1401 else
1402 rc = VERR_PDM_DRIVER_INSTANCE_NOT_FOUND;
1403 }
1404 else
1405 rc = VINF_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1406 }
1407
1408 LogFlow(("PDMR3UsbDriverDetach: returns %Rrc\n", rc));
1409 return rc;
1410}
1411
1412
1413/**
1414 * Query the interface of the top level driver on a LUN.
1415 *
1416 * @returns VBox status code.
1417 * @param pUVM The user mode VM handle.
1418 * @param pszDevice Device name.
1419 * @param iInstance Device instance.
1420 * @param iLun The Logical Unit to obtain the interface of.
1421 * @param ppBase Where to store the base interface pointer.
1422 * @remark We're not doing any locking ATM, so don't try call this at times when the
1423 * device chain is known to be updated.
1424 */
1425VMMR3DECL(int) PDMR3UsbQueryLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1426{
1427 LogFlow(("PDMR3UsbQueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1428 pszDevice, pszDevice, iInstance, iLun, ppBase));
1429 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1430 PVM pVM = pUVM->pVM;
1431 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1432
1433 /*
1434 * Find the LUN.
1435 */
1436 PPDMLUN pLun;
1437 int rc = pdmR3UsbFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1438 if (RT_SUCCESS(rc))
1439 {
1440 if (pLun->pTop)
1441 {
1442 *ppBase = &pLun->pTop->IBase;
1443 LogFlow(("PDMR3UsbQueryLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
1444 return VINF_SUCCESS;
1445 }
1446 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1447 }
1448 LogFlow(("PDMR3UsbQueryLun: returns %Rrc\n", rc));
1449 return rc;
1450}
1451
1452
1453/** @name USB Device Helpers
1454 * @{
1455 */
1456
1457/** @interface_method_impl{PDMUSBHLPR3,pfnDriverAttach} */
1458static DECLCALLBACK(int) pdmR3UsbHlp_DriverAttach(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface,
1459 PPDMIBASE *ppBaseInterface, const char *pszDesc)
1460{
1461 PDMUSB_ASSERT_USBINS(pUsbIns);
1462 PVM pVM = pUsbIns->Internal.s.pVM;
1463 VM_ASSERT_EMT(pVM);
1464 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: iLun=%d pBaseInterface=%p ppBaseInterface=%p pszDesc=%p:{%s}\n",
1465 pUsbIns->pReg->szName, pUsbIns->iInstance, iLun, pBaseInterface, ppBaseInterface, pszDesc, pszDesc));
1466
1467 /*
1468 * Lookup the LUN, it might already be registered.
1469 */
1470 PPDMLUN pLunPrev = NULL;
1471 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
1472 for (; pLun; pLunPrev = pLun, pLun = pLun->pNext)
1473 if (pLun->iLun == iLun)
1474 break;
1475
1476 /*
1477 * Create the LUN if if wasn't found, else check if driver is already attached to it.
1478 */
1479 if (!pLun)
1480 {
1481 if ( !pBaseInterface
1482 || !pszDesc
1483 || !*pszDesc)
1484 {
1485 Assert(pBaseInterface);
1486 Assert(pszDesc || *pszDesc);
1487 return VERR_INVALID_PARAMETER;
1488 }
1489
1490 pLun = (PPDMLUN)MMR3HeapAlloc(pVM, MM_TAG_PDM_LUN, sizeof(*pLun));
1491 if (!pLun)
1492 return VERR_NO_MEMORY;
1493
1494 pLun->iLun = iLun;
1495 pLun->pNext = pLunPrev ? pLunPrev->pNext : NULL;
1496 pLun->pTop = NULL;
1497 pLun->pBottom = NULL;
1498 pLun->pDevIns = NULL;
1499 pLun->pUsbIns = pUsbIns;
1500 pLun->pszDesc = pszDesc;
1501 pLun->pBase = pBaseInterface;
1502 if (!pLunPrev)
1503 pUsbIns->Internal.s.pLuns = pLun;
1504 else
1505 pLunPrev->pNext = pLun;
1506 Log(("pdmR3UsbHlp_DriverAttach: Registered LUN#%d '%s' with device '%s'/%d.\n",
1507 iLun, pszDesc, pUsbIns->pReg->szName, pUsbIns->iInstance));
1508 }
1509 else if (pLun->pTop)
1510 {
1511 AssertMsgFailed(("Already attached! The device should keep track of such things!\n"));
1512 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, VERR_PDM_DRIVER_ALREADY_ATTACHED));
1513 return VERR_PDM_DRIVER_ALREADY_ATTACHED;
1514 }
1515 Assert(pLun->pBase == pBaseInterface);
1516
1517
1518 /*
1519 * Get the attached driver configuration.
1520 */
1521 int rc;
1522 PCFGMNODE pNode = CFGMR3GetChildF(pUsbIns->Internal.s.pCfg, "LUN#%u", iLun);
1523 if (pNode)
1524 rc = pdmR3DrvInstantiate(pVM, pNode, pBaseInterface, NULL /*pDrvAbove*/, pLun, ppBaseInterface);
1525 else
1526 rc = VERR_PDM_NO_ATTACHED_DRIVER;
1527
1528
1529 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1530 return rc;
1531}
1532
1533
1534/** @interface_method_impl{PDMUSBHLP,pfnAssertEMT} */
1535static DECLCALLBACK(bool) pdmR3UsbHlp_AssertEMT(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1536{
1537 PDMUSB_ASSERT_USBINS(pUsbIns);
1538 if (VM_IS_EMT(pUsbIns->Internal.s.pVM))
1539 return true;
1540
1541 char szMsg[100];
1542 RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1543 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1544 AssertBreakpoint();
1545 return false;
1546}
1547
1548
1549/** @interface_method_impl{PDMUSBHLP,pfnAssertOther} */
1550static DECLCALLBACK(bool) pdmR3UsbHlp_AssertOther(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1551{
1552 PDMUSB_ASSERT_USBINS(pUsbIns);
1553 if (!VM_IS_EMT(pUsbIns->Internal.s.pVM))
1554 return true;
1555
1556 char szMsg[100];
1557 RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1558 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1559 AssertBreakpoint();
1560 return false;
1561}
1562
1563
1564/** @interface_method_impl{PDMUSBHLP,pfnDBGFStopV} */
1565static DECLCALLBACK(int) pdmR3UsbHlp_DBGFStopV(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction, const char *pszFormat, va_list args)
1566{
1567 PDMUSB_ASSERT_USBINS(pUsbIns);
1568#ifdef LOG_ENABLED
1569 va_list va2;
1570 va_copy(va2, args);
1571 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: pszFile=%p:{%s} iLine=%d pszFunction=%p:{%s} pszFormat=%p:{%s} (%N)\n",
1572 pUsbIns->pReg->szName, pUsbIns->iInstance, pszFile, pszFile, iLine, pszFunction, pszFunction, pszFormat, pszFormat, pszFormat, &va2));
1573 va_end(va2);
1574#endif
1575
1576 PVM pVM = pUsbIns->Internal.s.pVM;
1577 VM_ASSERT_EMT(pVM);
1578 int rc = DBGFR3EventSrcV(pVM, DBGFEVENT_DEV_STOP, pszFile, iLine, pszFunction, pszFormat, args);
1579 if (rc == VERR_DBGF_NOT_ATTACHED)
1580 rc = VINF_SUCCESS;
1581
1582 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1583 return rc;
1584}
1585
1586
1587/** @interface_method_impl{PDMUSBHLP,pfnDBGFInfoRegister} */
1588static DECLCALLBACK(int) pdmR3UsbHlp_DBGFInfoRegister(PPDMUSBINS pUsbIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERUSB pfnHandler)
1589{
1590 PDMUSB_ASSERT_USBINS(pUsbIns);
1591 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: pszName=%p:{%s} pszDesc=%p:{%s} pfnHandler=%p\n",
1592 pUsbIns->pReg->szName, pUsbIns->iInstance, pszName, pszName, pszDesc, pszDesc, pfnHandler));
1593
1594 PVM pVM = pUsbIns->Internal.s.pVM;
1595 VM_ASSERT_EMT(pVM);
1596 NOREF(pVM); /** @todo int rc = DBGFR3InfoRegisterUsb(pVM, pszName, pszDesc, pfnHandler, pUsbIns); */
1597 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1598
1599 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1600 return rc;
1601}
1602
1603
1604/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAlloc} */
1605static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAlloc(PPDMUSBINS pUsbIns, size_t cb)
1606{
1607 PDMUSB_ASSERT_USBINS(pUsbIns);
1608 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1609
1610 void *pv = MMR3HeapAlloc(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1611
1612 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1613 return pv;
1614}
1615
1616
1617/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAllocZ} */
1618static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAllocZ(PPDMUSBINS pUsbIns, size_t cb)
1619{
1620 PDMUSB_ASSERT_USBINS(pUsbIns);
1621 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1622
1623 void *pv = MMR3HeapAllocZ(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1624
1625 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1626 return pv;
1627}
1628
1629
1630/** @interface_method_impl{PDMUSBHLP,pfnPDMQueueCreate} */
1631static DECLCALLBACK(int) pdmR3UsbHlp_PDMQueueCreate(PPDMUSBINS pUsbIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval,
1632 PFNPDMQUEUEUSB pfnCallback, const char *pszName, PPDMQUEUE *ppQueue)
1633{
1634 PDMUSB_ASSERT_USBINS(pUsbIns);
1635 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%#x cItems=%#x cMilliesInterval=%u pfnCallback=%p pszName=%p:{%s} ppQueue=%p\n",
1636 pUsbIns->pReg->szName, pUsbIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, pszName, ppQueue));
1637
1638 PVM pVM = pUsbIns->Internal.s.pVM;
1639 VM_ASSERT_EMT(pVM);
1640
1641 if (pUsbIns->iInstance > 0)
1642 {
1643 pszName = MMR3HeapAPrintf(pVM, MM_TAG_PDM_DEVICE_DESC, "%s_%u", pszName, pUsbIns->iInstance);
1644 AssertLogRelReturn(pszName, VERR_NO_MEMORY);
1645 }
1646
1647 /** @todo int rc = PDMR3QueueCreateUsb(pVM, pUsbIns, cbItem, cItems, cMilliesInterval, pfnCallback, fGCEnabled, pszName, ppQueue); */
1648 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1649
1650 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: returns %Rrc *ppQueue=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc, *ppQueue));
1651 return rc;
1652}
1653
1654
1655/** @interface_method_impl{PDMUSBHLP,pfnSSMRegister} */
1656static DECLCALLBACK(int) pdmR3UsbHlp_SSMRegister(PPDMUSBINS pUsbIns, uint32_t uVersion, size_t cbGuess,
1657 PFNSSMUSBLIVEPREP pfnLivePrep, PFNSSMUSBLIVEEXEC pfnLiveExec, PFNSSMUSBLIVEVOTE pfnLiveVote,
1658 PFNSSMUSBSAVEPREP pfnSavePrep, PFNSSMUSBSAVEEXEC pfnSaveExec, PFNSSMUSBSAVEDONE pfnSaveDone,
1659 PFNSSMUSBLOADPREP pfnLoadPrep, PFNSSMUSBLOADEXEC pfnLoadExec, PFNSSMUSBLOADDONE pfnLoadDone)
1660{
1661 PDMUSB_ASSERT_USBINS(pUsbIns);
1662 VM_ASSERT_EMT(pUsbIns->Internal.s.pVM);
1663 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: uVersion=#x cbGuess=%#x\n"
1664 " pfnLivePrep=%p pfnLiveExec=%p pfnLiveVote=%p pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoadDone=%p\n",
1665 pUsbIns->pReg->szName, pUsbIns->iInstance, uVersion, cbGuess,
1666 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1667 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1668 pfnLoadPrep, pfnLoadExec, pfnLoadDone));
1669
1670 int rc = SSMR3RegisterUsb(pUsbIns->Internal.s.pVM, pUsbIns, pUsbIns->pReg->szName, pUsbIns->iInstance,
1671 uVersion, cbGuess,
1672 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1673 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1674 pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1675
1676 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1677 return rc;
1678}
1679
1680
1681/** @interface_method_impl{PDMUSBHLP,pfnSTAMRegisterV} */
1682static DECLCALLBACK(void) pdmR3UsbHlp_STAMRegisterV(PPDMUSBINS pUsbIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1683 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list args)
1684{
1685 PDMUSB_ASSERT_USBINS(pUsbIns);
1686 PVM pVM = pUsbIns->Internal.s.pVM;
1687 VM_ASSERT_EMT(pVM);
1688
1689 int rc = STAMR3RegisterV(pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1690 AssertRC(rc);
1691
1692 NOREF(pVM);
1693}
1694
1695
1696/** @interface_method_impl{PDMUSBHLP,pfnTMTimerCreate} */
1697static DECLCALLBACK(int) pdmR3UsbHlp_TMTimerCreate(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
1698 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1699{
1700 PDMUSB_ASSERT_USBINS(pUsbIns);
1701 PVM pVM = pUsbIns->Internal.s.pVM;
1702 VM_ASSERT_EMT(pVM);
1703 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pvUser=%p fFlags=%#x pszDesc=%p:{%s} ppTimer=%p\n",
1704 pUsbIns->pReg->szName, pUsbIns->iInstance, enmClock, pfnCallback, pvUser, fFlags, pszDesc, pszDesc, ppTimer));
1705
1706 if (pUsbIns->iInstance > 0) /** @todo use a string cache here later. */
1707 {
1708 char *pszDesc2 = MMR3HeapAPrintf(pVM, MM_TAG_PDM_USB_DESC, "%s [%u]", pszDesc, pUsbIns->iInstance);
1709 if (pszDesc2)
1710 pszDesc = pszDesc2;
1711 }
1712
1713 int rc = TMR3TimerCreateUsb(pVM, pUsbIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
1714
1715 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1716 return rc;
1717}
1718
1719
1720/** @interface_method_impl{PDMUSBHLP,pfnVMSetErrorV} */
1721static DECLCALLBACK(int) pdmR3UsbHlp_VMSetErrorV(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
1722{
1723 PDMUSB_ASSERT_USBINS(pUsbIns);
1724 int rc2 = VMSetErrorV(pUsbIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
1725 return rc;
1726}
1727
1728
1729/** @interface_method_impl{PDMUSBHLP,pfnVMSetRuntimeErrorV} */
1730static DECLCALLBACK(int) pdmR3UsbHlp_VMSetRuntimeErrorV(PPDMUSBINS pUsbIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va)
1731{
1732 PDMUSB_ASSERT_USBINS(pUsbIns);
1733 int rc = VMSetRuntimeErrorV(pUsbIns->Internal.s.pVM, fFlags, pszErrorId, pszFormat, va);
1734 return rc;
1735}
1736
1737
1738/** @interface_method_impl{PDMUSBHLP,pfnVMState} */
1739static DECLCALLBACK(VMSTATE) pdmR3UsbHlp_VMState(PPDMUSBINS pUsbIns)
1740{
1741 PDMUSB_ASSERT_USBINS(pUsbIns);
1742
1743 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1744
1745 LogFlow(("pdmR3UsbHlp_VMState: caller='%s'/%d: returns %d (%s)\n", pUsbIns->pReg->szName, pUsbIns->iInstance,
1746 enmVMState, VMR3GetStateName(enmVMState)));
1747 return enmVMState;
1748}
1749
1750/** @interface_method_impl{PDMUSBHLP,pfnThreadCreate} */
1751static DECLCALLBACK(int) pdmR3UsbHlp_ThreadCreate(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
1752 PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1753{
1754 PDMUSB_ASSERT_USBINS(pUsbIns);
1755 VM_ASSERT_EMT(pUsbIns->Internal.s.pVM);
1756 LogFlow(("pdmR3UsbHlp_ThreadCreate: caller='%s'/%d: ppThread=%p pvUser=%p pfnThread=%p pfnWakeup=%p cbStack=%#zx enmType=%d pszName=%p:{%s}\n",
1757 pUsbIns->pReg->szName, pUsbIns->iInstance, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName, pszName));
1758
1759 int rc = pdmR3ThreadCreateUsb(pUsbIns->Internal.s.pVM, pUsbIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1760
1761 LogFlow(("pdmR3UsbHlp_ThreadCreate: caller='%s'/%d: returns %Rrc *ppThread=%RTthrd\n", pUsbIns->pReg->szName, pUsbIns->iInstance,
1762 rc, *ppThread));
1763 return rc;
1764}
1765
1766
1767/** @interface_method_impl{PDMUSBHLP,pfnSetAsyncNotification} */
1768static DECLCALLBACK(int) pdmR3UsbHlp_SetAsyncNotification(PPDMUSBINS pUsbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify)
1769{
1770 PDMUSB_ASSERT_USBINS(pUsbIns);
1771 VM_ASSERT_EMT0(pUsbIns->Internal.s.pVM);
1772 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: pfnAsyncNotify=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pfnAsyncNotify));
1773
1774 int rc = VINF_SUCCESS;
1775 AssertStmt(pfnAsyncNotify, rc = VERR_INVALID_PARAMETER);
1776 AssertStmt(!pUsbIns->Internal.s.pfnAsyncNotify, rc = VERR_WRONG_ORDER);
1777 AssertStmt(pUsbIns->Internal.s.fVMSuspended || pUsbIns->Internal.s.fVMReset, rc = VERR_WRONG_ORDER);
1778 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1779 AssertStmt( enmVMState == VMSTATE_SUSPENDING
1780 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1781 || enmVMState == VMSTATE_SUSPENDING_LS
1782 || enmVMState == VMSTATE_RESETTING
1783 || enmVMState == VMSTATE_RESETTING_LS
1784 || enmVMState == VMSTATE_POWERING_OFF
1785 || enmVMState == VMSTATE_POWERING_OFF_LS,
1786 rc = VERR_INVALID_STATE);
1787
1788 if (RT_SUCCESS(rc))
1789 pUsbIns->Internal.s.pfnAsyncNotify = pfnAsyncNotify;
1790
1791 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1792 return rc;
1793}
1794
1795
1796/** @interface_method_impl{PDMUSBHLP,pfnAsyncNotificationCompleted} */
1797static DECLCALLBACK(void) pdmR3UsbHlp_AsyncNotificationCompleted(PPDMUSBINS pUsbIns)
1798{
1799 PDMUSB_ASSERT_USBINS(pUsbIns);
1800 PVM pVM = pUsbIns->Internal.s.pVM;
1801
1802 VMSTATE enmVMState = VMR3GetState(pVM);
1803 if ( enmVMState == VMSTATE_SUSPENDING
1804 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1805 || enmVMState == VMSTATE_SUSPENDING_LS
1806 || enmVMState == VMSTATE_RESETTING
1807 || enmVMState == VMSTATE_RESETTING_LS
1808 || enmVMState == VMSTATE_POWERING_OFF
1809 || enmVMState == VMSTATE_POWERING_OFF_LS)
1810 {
1811 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d:\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1812 VMR3AsyncPdmNotificationWakeupU(pVM->pUVM);
1813 }
1814 else
1815 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d: enmVMState=%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance, enmVMState));
1816}
1817
1818
1819/** @interface_method_impl{PDMUSBHLP,pfnVMGetSuspendReason} */
1820static DECLCALLBACK(VMSUSPENDREASON) pdmR3UsbHlp_VMGetSuspendReason(PPDMUSBINS pUsbIns)
1821{
1822 PDMUSB_ASSERT_USBINS(pUsbIns);
1823 PVM pVM = pUsbIns->Internal.s.pVM;
1824 VM_ASSERT_EMT(pVM);
1825 VMSUSPENDREASON enmReason = VMR3GetSuspendReason(pVM->pUVM);
1826 LogFlow(("pdmR3UsbHlp_VMGetSuspendReason: caller='%s'/%d: returns %d\n",
1827 pUsbIns->pReg->szName, pUsbIns->iInstance, enmReason));
1828 return enmReason;
1829}
1830
1831
1832/** @interface_method_impl{PDMUSBHLP,pfnVMGetResumeReason} */
1833static DECLCALLBACK(VMRESUMEREASON) pdmR3UsbHlp_VMGetResumeReason(PPDMUSBINS pUsbIns)
1834{
1835 PDMUSB_ASSERT_USBINS(pUsbIns);
1836 PVM pVM = pUsbIns->Internal.s.pVM;
1837 VM_ASSERT_EMT(pVM);
1838 VMRESUMEREASON enmReason = VMR3GetResumeReason(pVM->pUVM);
1839 LogFlow(("pdmR3UsbHlp_VMGetResumeReason: caller='%s'/%d: returns %d\n",
1840 pUsbIns->pReg->szName, pUsbIns->iInstance, enmReason));
1841 return enmReason;
1842}
1843
1844
1845/**
1846 * The USB device helper structure.
1847 */
1848const PDMUSBHLP g_pdmR3UsbHlp =
1849{
1850 PDM_USBHLP_VERSION,
1851 pdmR3UsbHlp_DriverAttach,
1852 pdmR3UsbHlp_AssertEMT,
1853 pdmR3UsbHlp_AssertOther,
1854 pdmR3UsbHlp_DBGFStopV,
1855 pdmR3UsbHlp_DBGFInfoRegister,
1856 pdmR3UsbHlp_MMHeapAlloc,
1857 pdmR3UsbHlp_MMHeapAllocZ,
1858 pdmR3UsbHlp_PDMQueueCreate,
1859 pdmR3UsbHlp_SSMRegister,
1860 pdmR3UsbHlp_STAMRegisterV,
1861 pdmR3UsbHlp_TMTimerCreate,
1862 pdmR3UsbHlp_VMSetErrorV,
1863 pdmR3UsbHlp_VMSetRuntimeErrorV,
1864 pdmR3UsbHlp_VMState,
1865 pdmR3UsbHlp_ThreadCreate,
1866 pdmR3UsbHlp_SetAsyncNotification,
1867 pdmR3UsbHlp_AsyncNotificationCompleted,
1868 pdmR3UsbHlp_VMGetSuspendReason,
1869 pdmR3UsbHlp_VMGetResumeReason,
1870 NULL,
1871 NULL,
1872 NULL,
1873 NULL,
1874 NULL,
1875 NULL,
1876 NULL,
1877 NULL,
1878 NULL,
1879 NULL,
1880 PDM_USBHLP_VERSION
1881};
1882
1883/** @} */
Note: See TracBrowser for help on using the repository browser.

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