VirtualBox

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

Last change on this file since 59083 was 58126, checked in by vboxsync, 9 years ago

VMM: Fixed almost all the Doxygen warnings.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 68.4 KB
Line 
1/* $Id: PDMUsb.cpp 58126 2015-10-08 20:59:48Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device and Driver Manager, USB part.
4 */
5
6/*
7 * Copyright (C) 2006-2015 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 The cross context VM structure.
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(("PDMUsb: 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 The cross context VM structure.
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_SAVED_STATE_SUPPORTED)) == 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 The cross context VM structure.
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 The cross context VM structure.
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 The cross context VM structure.
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 * Translates a USB vesion (a bit-mask) to USB speed (enum). Picks
462 * the highest available version.
463 *
464 * @returns VUSBSPEED enum
465 *
466 * @param iUsbVersion The USB version.
467 *
468 */
469static VUSBSPEED pdmR3UsbVer2Spd(uint32_t iUsbVersion)
470{
471 VUSBSPEED enmSpd = VUSB_SPEED_UNKNOWN;
472 Assert(iUsbVersion);
473
474 if (iUsbVersion & VUSB_STDVER_30)
475 enmSpd = VUSB_SPEED_SUPER;
476 else if (iUsbVersion & VUSB_STDVER_20)
477 enmSpd = VUSB_SPEED_HIGH;
478 else if (iUsbVersion & VUSB_STDVER_11)
479 enmSpd = VUSB_SPEED_FULL; /* Can't distinguish LS vs. FS. */
480
481 return enmSpd;
482}
483
484
485/**
486 * Creates the device.
487 *
488 * @returns VBox status code.
489 * @param pVM The cross context VM structure.
490 * @param pHub The USB hub it'll be attached to.
491 * @param pUsbDev The USB device emulation.
492 * @param iInstance -1 if not called by pdmR3UsbInstantiateDevices().
493 * @param pUuid The UUID for this device.
494 * @param ppInstanceNode Pointer to the device instance pointer. This is set to NULL if inserted
495 * into the tree or cleaned up.
496 *
497 * In the pdmR3UsbInstantiateDevices() case (iInstance != -1) this is
498 * the actual instance node and will not be cleaned up.
499 *
500 * @param enmSpeed The speed the USB device is operating at.
501 * @param pszCaptureFilename Path to the file for USB traffic capturing, optional.
502 */
503static int pdmR3UsbCreateDevice(PVM pVM, PPDMUSBHUB pHub, PPDMUSB pUsbDev, int iInstance, PCRTUUID pUuid,
504 PCFGMNODE *ppInstanceNode, VUSBSPEED enmSpeed, const char *pszCaptureFilename)
505{
506 const bool fAtRuntime = iInstance == -1;
507 int rc;
508
509 AssertPtrReturn(ppInstanceNode, VERR_INVALID_POINTER);
510 AssertPtrReturn(*ppInstanceNode, VERR_INVALID_POINTER);
511
512 /*
513 * If not called by pdmR3UsbInstantiateDevices(), we'll have to fix
514 * the configuration now.
515 */
516 /* USB device node. */
517 PCFGMNODE pDevNode = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "USB/%s/", pUsbDev->pReg->szName);
518 if (!pDevNode)
519 {
520 rc = CFGMR3InsertNodeF(CFGMR3GetRoot(pVM), &pDevNode, "USB/%s/", pUsbDev->pReg->szName);
521 AssertRCReturn(rc, rc);
522 }
523
524 /* The instance node and number. */
525 PCFGMNODE pInstanceToDelete = NULL;
526 PCFGMNODE pInstanceNode = NULL;
527 if (fAtRuntime)
528 {
529 /** @todo r=bird: This code is bogus as it ASSUMES that all USB devices are
530 * capable of infinite number of instances. */
531 for (unsigned c = 0; c < _2M; c++)
532 {
533 iInstance = pUsbDev->iNextInstance++;
534 rc = CFGMR3InsertNodeF(pDevNode, &pInstanceNode, "%d/", iInstance);
535 if (rc != VERR_CFGM_NODE_EXISTS)
536 break;
537 }
538 AssertRCReturn(rc, rc);
539
540 rc = CFGMR3ReplaceSubTree(pInstanceNode, *ppInstanceNode);
541 AssertRCReturn(rc, rc);
542 *ppInstanceNode = NULL;
543 pInstanceToDelete = pInstanceNode;
544 }
545 else
546 {
547 Assert(iInstance >= 0);
548 if (iInstance >= (int)pUsbDev->iNextInstance)
549 pUsbDev->iNextInstance = iInstance + 1;
550 pInstanceNode = *ppInstanceNode;
551 }
552
553 /* Make sure the instance config node exists. */
554 PCFGMNODE pConfig = CFGMR3GetChild(pInstanceNode, "Config");
555 if (!pConfig)
556 {
557 rc = CFGMR3InsertNode(pInstanceNode, "Config", &pConfig);
558 AssertRCReturn(rc, rc);
559 }
560 Assert(CFGMR3GetChild(pInstanceNode, "Config") == pConfig);
561
562 /* The global device config node. */
563 PCFGMNODE pGlobalConfig = CFGMR3GetChild(pDevNode, "GlobalConfig");
564 if (!pGlobalConfig)
565 {
566 rc = CFGMR3InsertNode(pDevNode, "GlobalConfig", &pGlobalConfig);
567 if (RT_FAILURE(rc))
568 {
569 CFGMR3RemoveNode(pInstanceToDelete);
570 AssertRCReturn(rc, rc);
571 }
572 }
573
574 /*
575 * Allocate the device instance.
576 */
577 size_t cb = RT_OFFSETOF(PDMUSBINS, achInstanceData[pUsbDev->pReg->cbInstance]);
578 cb = RT_ALIGN_Z(cb, 16);
579 PPDMUSBINS pUsbIns;
580 rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_USB, cb, (void **)&pUsbIns);
581 if (RT_FAILURE(rc))
582 {
583 AssertMsgFailed(("Failed to allocate %d bytes of instance data for USB device '%s'. rc=%Rrc\n",
584 cb, pUsbDev->pReg->szName, rc));
585 CFGMR3RemoveNode(pInstanceToDelete);
586 return rc;
587 }
588
589 /*
590 * Initialize it.
591 */
592 pUsbIns->u32Version = PDM_USBINS_VERSION;
593 //pUsbIns->Internal.s.pNext = NULL;
594 //pUsbIns->Internal.s.pPerDeviceNext = NULL;
595 pUsbIns->Internal.s.pUsbDev = pUsbDev;
596 pUsbIns->Internal.s.pVM = pVM;
597 //pUsbIns->Internal.s.pLuns = NULL;
598 pUsbIns->Internal.s.pCfg = pInstanceNode;
599 pUsbIns->Internal.s.pCfgDelete = pInstanceToDelete;
600 pUsbIns->Internal.s.pCfgGlobal = pGlobalConfig;
601 pUsbIns->Internal.s.Uuid = *pUuid;
602 //pUsbIns->Internal.s.pHub = NULL;
603 pUsbIns->Internal.s.iPort = UINT32_MAX; /* to be determined. */
604 /* Set the flag accordingly.
605 * Oherwise VMPowerOff, VMSuspend will not be called for devices attached at runtime.
606 */
607 pUsbIns->Internal.s.fVMSuspended = !fAtRuntime;
608 //pUsbIns->Internal.s.pfnAsyncNotify = NULL;
609 pUsbIns->pHlpR3 = &g_pdmR3UsbHlp;
610 pUsbIns->pReg = pUsbDev->pReg;
611 pUsbIns->pCfg = pConfig;
612 pUsbIns->pCfgGlobal = pGlobalConfig;
613 pUsbIns->iInstance = iInstance;
614 pUsbIns->pvInstanceDataR3 = &pUsbIns->achInstanceData[0];
615 pUsbIns->pszName = RTStrDup(pUsbDev->pReg->szName);
616 //pUsbIns->fTracing = 0;
617 pUsbIns->idTracing = ++pVM->pdm.s.idTracingOther;
618 pUsbIns->enmSpeed = enmSpeed;
619
620 /*
621 * Link it into all the lists.
622 */
623 /* The global instance FIFO. */
624 PPDMUSBINS pPrev1 = pVM->pdm.s.pUsbInstances;
625 if (!pPrev1)
626 pVM->pdm.s.pUsbInstances = pUsbIns;
627 else
628 {
629 while (pPrev1->Internal.s.pNext)
630 {
631 Assert(pPrev1->u32Version == PDM_USBINS_VERSION);
632 pPrev1 = pPrev1->Internal.s.pNext;
633 }
634 pPrev1->Internal.s.pNext = pUsbIns;
635 }
636
637 /* The per device instance FIFO. */
638 PPDMUSBINS pPrev2 = pUsbDev->pInstances;
639 if (!pPrev2)
640 pUsbDev->pInstances = pUsbIns;
641 else
642 {
643 while (pPrev2->Internal.s.pPerDeviceNext)
644 {
645 Assert(pPrev2->u32Version == PDM_USBINS_VERSION);
646 pPrev2 = pPrev2->Internal.s.pPerDeviceNext;
647 }
648 pPrev2->Internal.s.pPerDeviceNext = pUsbIns;
649 }
650
651 /*
652 * Call the constructor.
653 */
654 Log(("PDM: Constructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
655 rc = pUsbIns->pReg->pfnConstruct(pUsbIns, pUsbIns->iInstance, pUsbIns->pCfg, pUsbIns->pCfgGlobal);
656 if (RT_SUCCESS(rc))
657 {
658 /*
659 * Attach it to the hub.
660 */
661 Log(("PDM: Attaching it...\n"));
662 rc = pHub->Reg.pfnAttachDevice(pHub->pDrvIns, pUsbIns, pszCaptureFilename, &pUsbIns->Internal.s.iPort);
663 if (RT_SUCCESS(rc))
664 {
665 pHub->cAvailablePorts--;
666 Assert((int32_t)pHub->cAvailablePorts >= 0 && pHub->cAvailablePorts < pHub->cPorts);
667 pUsbIns->Internal.s.pHub = pHub;
668
669 /* Send the hot-plugged notification if applicable. */
670 if (fAtRuntime && pUsbIns->pReg->pfnHotPlugged)
671 pUsbIns->pReg->pfnHotPlugged(pUsbIns);
672
673 Log(("PDM: Successfully attached USB device '%s' instance %d to hub %p\n",
674 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub));
675 return VINF_SUCCESS;
676 }
677
678 LogRel(("PDMUsb: Failed to attach USB device '%s' instance %d to hub %p: %Rrc\n",
679 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
680 }
681 else
682 {
683 AssertMsgFailed(("Failed to construct '%s'/%d! %Rra\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
684 if (rc == VERR_VERSION_MISMATCH)
685 rc = VERR_PDM_DRIVER_VERSION_MISMATCH;
686 }
687 if (fAtRuntime)
688 pdmR3UsbDestroyDevice(pVM, pUsbIns);
689 /* else: destructors are invoked later. */
690 return rc;
691}
692
693
694/**
695 * Instantiate USB devices.
696 *
697 * This is called by pdmR3DevInit() after it has instantiated the
698 * other devices and their drivers. If there aren't any hubs
699 * around, we'll silently skip the USB devices.
700 *
701 * @returns VBox status code.
702 * @param pVM The cross context VM structure.
703 */
704int pdmR3UsbInstantiateDevices(PVM pVM)
705{
706 /*
707 * Any hubs?
708 */
709 if (!pVM->pdm.s.pUsbHubs)
710 {
711 Log(("PDM: No USB hubs, skipping USB device instantiation.\n"));
712 return VINF_SUCCESS;
713 }
714
715 /*
716 * Count the device instances.
717 */
718 PCFGMNODE pCur;
719 PCFGMNODE pUsbNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "USB/");
720 PCFGMNODE pInstanceNode;
721 unsigned cUsbDevs = 0;
722 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
723 {
724 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
725 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
726 if (pInstanceNode != pGlobal)
727 cUsbDevs++;
728 }
729 if (!cUsbDevs)
730 {
731 Log(("PDM: No USB devices were configured!\n"));
732 return VINF_SUCCESS;
733 }
734 Log2(("PDM: cUsbDevs=%d!\n", cUsbDevs));
735
736 /*
737 * Collect info on each USB device instance.
738 */
739 struct USBDEVORDER
740 {
741 /** Configuration node. */
742 PCFGMNODE pNode;
743 /** Pointer to the USB device. */
744 PPDMUSB pUsbDev;
745 /** Init order. */
746 uint32_t u32Order;
747 /** VBox instance number. */
748 uint32_t iInstance;
749 /** Device UUID. */
750 RTUUID Uuid;
751 } *paUsbDevs = (struct USBDEVORDER *)alloca(sizeof(paUsbDevs[0]) * (cUsbDevs + 1)); /* (One extra for swapping) */
752 Assert(paUsbDevs);
753 int rc;
754 unsigned i = 0;
755 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
756 {
757 /* Get the device name. */
758 char szName[sizeof(paUsbDevs[0].pUsbDev->pReg->szName)];
759 rc = CFGMR3GetName(pCur, szName, sizeof(szName));
760 AssertMsgRCReturn(rc, ("Configuration error: device name is too long (or something)! rc=%Rrc\n", rc), rc);
761
762 /* Find the device. */
763 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, szName);
764 AssertMsgReturn(pUsbDev, ("Configuration error: device '%s' not found!\n", szName), VERR_PDM_DEVICE_NOT_FOUND);
765
766 /* Configured priority or use default? */
767 uint32_t u32Order;
768 rc = CFGMR3QueryU32(pCur, "Priority", &u32Order);
769 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
770 u32Order = i << 4;
771 else
772 AssertMsgRCReturn(rc, ("Configuration error: reading \"Priority\" for the '%s' USB device failed rc=%Rrc!\n", szName, rc), rc);
773
774 /* Global config. */
775 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
776 if (!pGlobal)
777 {
778 rc = CFGMR3InsertNode(pCur, "GlobalConfig/", &pGlobal);
779 AssertMsgRCReturn(rc, ("Failed to create GlobalConfig node! rc=%Rrc\n", rc), rc);
780 CFGMR3SetRestrictedRoot(pGlobal);
781 }
782
783 /* Enumerate the device instances. */
784 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
785 {
786 if (pInstanceNode == pGlobal)
787 continue;
788
789 /* Use the configured UUID if present, create our own otherwise. */
790 char *pszUuid = NULL;
791
792 RTUuidClear(&paUsbDevs[i].Uuid);
793 rc = CFGMR3QueryStringAlloc(pInstanceNode, "UUID", &pszUuid);
794 if (RT_SUCCESS(rc))
795 {
796 AssertPtr(pszUuid);
797
798 rc = RTUuidFromStr(&paUsbDevs[i].Uuid, pszUuid);
799 AssertMsgRCReturn(rc, ("Failed to convert UUID from string! rc=%Rrc\n", rc), rc);
800 MMR3HeapFree(pszUuid);
801 }
802 else if (rc == VERR_CFGM_VALUE_NOT_FOUND)
803 rc = RTUuidCreate(&paUsbDevs[i].Uuid);
804
805 AssertRCReturn(rc, rc);
806 paUsbDevs[i].pNode = pInstanceNode;
807 paUsbDevs[i].pUsbDev = pUsbDev;
808 paUsbDevs[i].u32Order = u32Order;
809
810 /* Get the instance number. */
811 char szInstance[32];
812 rc = CFGMR3GetName(pInstanceNode, szInstance, sizeof(szInstance));
813 AssertMsgRCReturn(rc, ("Configuration error: instance name is too long (or something)! rc=%Rrc\n", rc), rc);
814 char *pszNext = NULL;
815 rc = RTStrToUInt32Ex(szInstance, &pszNext, 0, &paUsbDevs[i].iInstance);
816 AssertMsgRCReturn(rc, ("Configuration error: RTStrToInt32Ex failed on the instance name '%s'! rc=%Rrc\n", szInstance, rc), rc);
817 AssertMsgReturn(!*pszNext, ("Configuration error: the instance name '%s' isn't all digits. (%s)\n", szInstance, pszNext), VERR_INVALID_PARAMETER);
818
819 /* next instance */
820 i++;
821 }
822 } /* devices */
823 Assert(i == cUsbDevs);
824
825 /*
826 * Sort the device array ascending on u32Order. (bubble)
827 */
828 unsigned c = cUsbDevs - 1;
829 while (c)
830 {
831 unsigned j = 0;
832 for (i = 0; i < c; i++)
833 if (paUsbDevs[i].u32Order > paUsbDevs[i + 1].u32Order)
834 {
835 paUsbDevs[cUsbDevs] = paUsbDevs[i + 1];
836 paUsbDevs[i + 1] = paUsbDevs[i];
837 paUsbDevs[i] = paUsbDevs[cUsbDevs];
838 j = i;
839 }
840 c = j;
841 }
842
843 /*
844 * Instantiate the devices.
845 */
846 for (i = 0; i < cUsbDevs; i++)
847 {
848 /*
849 * Make sure there is a config node and mark it as restricted.
850 */
851 PCFGMNODE pConfigNode = CFGMR3GetChild(paUsbDevs[i].pNode, "Config/");
852 if (!pConfigNode)
853 {
854 rc = CFGMR3InsertNode(paUsbDevs[i].pNode, "Config", &pConfigNode);
855 AssertMsgRCReturn(rc, ("Failed to create Config node! rc=%Rrc\n", rc), rc);
856 }
857 CFGMR3SetRestrictedRoot(pConfigNode);
858
859 /*
860 * Every emulated device must support USB 1.x hubs; optionally, high-speed USB 2.0 hubs
861 * might be also supported. This determines where to attach the device.
862 */
863 uint32_t iUsbVersion = VUSB_STDVER_11;
864
865 if (paUsbDevs[i].pUsbDev->pReg->fFlags & PDM_USBREG_HIGHSPEED_CAPABLE)
866 iUsbVersion |= VUSB_STDVER_20;
867 if (paUsbDevs[i].pUsbDev->pReg->fFlags & PDM_USBREG_SUPERSPEED_CAPABLE)
868 iUsbVersion |= VUSB_STDVER_30;
869
870 /*
871 * Find a suitable hub with free ports.
872 */
873 PPDMUSBHUB pHub;
874 rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
875 if (RT_FAILURE(rc))
876 {
877 Log(("pdmR3UsbFindHub failed %Rrc\n", rc));
878 return rc;
879 }
880
881 /*
882 * This is how we inform the device what speed it's communicating at, and hence
883 * which descriptors it should present to the guest.
884 */
885 iUsbVersion &= pHub->fVersions;
886
887 /*
888 * Create and attach the device.
889 */
890 rc = pdmR3UsbCreateDevice(pVM, pHub, paUsbDevs[i].pUsbDev, paUsbDevs[i].iInstance, &paUsbDevs[i].Uuid,
891 &paUsbDevs[i].pNode, pdmR3UsbVer2Spd(iUsbVersion), NULL);
892 if (RT_FAILURE(rc))
893 return rc;
894 } /* for device instances */
895
896 return VINF_SUCCESS;
897}
898
899
900/**
901 * Creates an emulated USB device instance at runtime.
902 *
903 * This will find an appropriate HUB for the USB device
904 * and try instantiate the emulated device.
905 *
906 * @returns VBox status code.
907 * @param pUVM The user mode VM handle.
908 * @param pszDeviceName The name of the PDM device to instantiate.
909 * @param pInstanceNode The instance CFGM node.
910 * @param pUuid The UUID to be associated with the device.
911 * @param pszCaptureFilename Path to the file for USB traffic capturing, optional.
912 *
913 * @thread EMT
914 */
915VMMR3DECL(int) PDMR3UsbCreateEmulatedDevice(PUVM pUVM, const char *pszDeviceName, PCFGMNODE pInstanceNode, PCRTUUID pUuid,
916 const char *pszCaptureFilename)
917{
918 /*
919 * Validate input.
920 */
921 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
922 PVM pVM = pUVM->pVM;
923 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
924 VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
925 AssertPtrReturn(pszDeviceName, VERR_INVALID_POINTER);
926 AssertPtrReturn(pInstanceNode, VERR_INVALID_POINTER);
927
928 /*
929 * Find the device.
930 */
931 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, pszDeviceName);
932 if (!pUsbDev)
933 {
934 LogRel(("PDMUsb: PDMR3UsbCreateEmulatedDevice: The '%s' device wasn't found\n", pszDeviceName));
935 return VERR_PDM_NO_USBPROXY;
936 }
937
938 /*
939 * Every device must support USB 1.x hubs; optionally, high-speed USB 2.0 hubs
940 * might be also supported. This determines where to attach the device.
941 */
942 uint32_t iUsbVersion = VUSB_STDVER_11;
943 if (pUsbDev->pReg->fFlags & PDM_USBREG_HIGHSPEED_CAPABLE)
944 iUsbVersion |= VUSB_STDVER_20;
945 if (pUsbDev->pReg->fFlags & PDM_USBREG_SUPERSPEED_CAPABLE)
946 iUsbVersion |= VUSB_STDVER_30;
947
948 /*
949 * Find a suitable hub with free ports.
950 */
951 PPDMUSBHUB pHub;
952 int rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
953 if (RT_FAILURE(rc))
954 {
955 Log(("pdmR3UsbFindHub: failed %Rrc\n", rc));
956 return rc;
957 }
958
959 /*
960 * This is how we inform the device what speed it's communicating at, and hence
961 * which descriptors it should present to the guest.
962 */
963 iUsbVersion &= pHub->fVersions;
964
965 /*
966 * Create and attach the device.
967 */
968 rc = pdmR3UsbCreateDevice(pVM, pHub, pUsbDev, -1, pUuid, &pInstanceNode,
969 pdmR3UsbVer2Spd(iUsbVersion), pszCaptureFilename);
970 AssertRCReturn(rc, rc);
971
972 return rc;
973}
974
975
976/**
977 * Creates a USB proxy device instance.
978 *
979 * This will find an appropriate HUB for the USB device, create the necessary CFGM stuff
980 * and try instantiate the proxy device.
981 *
982 * @returns VBox status code.
983 * @param pUVM The user mode VM handle.
984 * @param pUuid The UUID to be associated with the device.
985 * @param fRemote Whether it's a remove or local device.
986 * @param pszAddress The address string.
987 * @param pvBackend Pointer to the backend.
988 * @param iUsbVersion The preferred USB version.
989 * @param fMaskedIfs The interfaces to hide from the guest.
990 * @param pszCaptureFilename Path to the file for USB traffic capturing, optional.
991 */
992VMMR3DECL(int) PDMR3UsbCreateProxyDevice(PUVM pUVM, PCRTUUID pUuid, bool fRemote, const char *pszAddress, void *pvBackend,
993 uint32_t iUsbVersion, uint32_t fMaskedIfs, const char *pszCaptureFilename)
994{
995 /*
996 * Validate input.
997 */
998 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
999 PVM pVM = pUVM->pVM;
1000 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1001 VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
1002 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
1003 AssertPtrReturn(pszAddress, VERR_INVALID_POINTER);
1004 AssertReturn( iUsbVersion == VUSB_STDVER_30
1005 || iUsbVersion == VUSB_STDVER_20
1006 || iUsbVersion == VUSB_STDVER_11, VERR_INVALID_PARAMETER);
1007
1008 /*
1009 * Find the USBProxy driver.
1010 */
1011 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, "USBProxy");
1012 if (!pUsbDev)
1013 {
1014 LogRel(("PDMUsb: PDMR3UsbCreateProxyDevice: The USBProxy device class wasn't found\n"));
1015 return VERR_PDM_NO_USBPROXY;
1016 }
1017
1018 /*
1019 * Find a suitable hub with free ports.
1020 */
1021 PPDMUSBHUB pHub;
1022 int rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
1023 if (RT_FAILURE(rc))
1024 {
1025 Log(("pdmR3UsbFindHub: failed %Rrc\n", rc));
1026 return rc;
1027 }
1028
1029 /*
1030 * Create the CFGM instance node.
1031 */
1032 PCFGMNODE pInstance = CFGMR3CreateTree(pUVM);
1033 AssertReturn(pInstance, VERR_NO_MEMORY);
1034 do /* break loop */
1035 {
1036 PCFGMNODE pConfig;
1037 rc = CFGMR3InsertNode(pInstance, "Config", &pConfig); AssertRCBreak(rc);
1038 rc = CFGMR3InsertString(pConfig, "Address", pszAddress); AssertRCBreak(rc);
1039 char szUuid[RTUUID_STR_LENGTH];
1040 rc = RTUuidToStr(pUuid, &szUuid[0], sizeof(szUuid)); AssertRCBreak(rc);
1041 rc = CFGMR3InsertString(pConfig, "UUID", szUuid); AssertRCBreak(rc);
1042 rc = CFGMR3InsertInteger(pConfig, "Remote", fRemote); AssertRCBreak(rc);
1043 rc = CFGMR3InsertInteger(pConfig, "USBVersion", iUsbVersion); AssertRCBreak(rc);
1044 rc = CFGMR3InsertInteger(pConfig, "pvBackend", (uintptr_t)pvBackend); AssertRCBreak(rc);
1045 rc = CFGMR3InsertInteger(pConfig, "MaskedIfs", fMaskedIfs); AssertRCBreak(rc);
1046 rc = CFGMR3InsertInteger(pConfig, "Force11Device", !(pHub->fVersions & iUsbVersion)); AssertRCBreak(rc);
1047 } while (0); /* break loop */
1048 if (RT_FAILURE(rc))
1049 {
1050 CFGMR3RemoveNode(pInstance);
1051 LogRel(("PDMUsb: PDMR3UsbCreateProxyDevice: failed to setup CFGM config, rc=%Rrc\n", rc));
1052 return rc;
1053 }
1054
1055 VUSBSPEED enmSpeed = pdmR3UsbVer2Spd(iUsbVersion);
1056
1057 /*
1058 * Finally, try to create it.
1059 */
1060 rc = pdmR3UsbCreateDevice(pVM, pHub, pUsbDev, -1, pUuid, &pInstance, enmSpeed, pszCaptureFilename);
1061 if (RT_FAILURE(rc) && pInstance)
1062 CFGMR3RemoveNode(pInstance);
1063 return rc;
1064}
1065
1066
1067/**
1068 * Destroys a hot-plugged USB device.
1069 *
1070 * The device must be detached from the HUB at this point.
1071 *
1072 * @param pVM The cross context VM structure.
1073 * @param pUsbIns The USB device instance to destroy.
1074 * @thread EMT
1075 */
1076static void pdmR3UsbDestroyDevice(PVM pVM, PPDMUSBINS pUsbIns)
1077{
1078 Assert(!pUsbIns->Internal.s.pHub);
1079
1080 /*
1081 * Do the unplug notification.
1082 */
1083 /** @todo what about the drivers? */
1084 if (pUsbIns->pReg->pfnHotUnplugged)
1085 pUsbIns->pReg->pfnHotUnplugged(pUsbIns);
1086
1087 /*
1088 * Destroy the luns with their driver chains and call the device destructor.
1089 */
1090 while (pUsbIns->Internal.s.pLuns)
1091 {
1092 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
1093 pUsbIns->Internal.s.pLuns = pLun->pNext;
1094 if (pLun->pTop)
1095 pdmR3DrvDestroyChain(pLun->pTop, PDM_TACH_FLAGS_NOT_HOT_PLUG); /* Hotplugging is handled differently here atm. */
1096 MMR3HeapFree(pLun);
1097 }
1098
1099 /* finally, the device. */
1100 if (pUsbIns->pReg->pfnDestruct)
1101 {
1102 Log(("PDM: Destructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1103 pUsbIns->pReg->pfnDestruct(pUsbIns);
1104 }
1105 TMR3TimerDestroyUsb(pVM, pUsbIns);
1106 SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
1107 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
1108#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1109 pdmR3AsyncCompletionTemplateDestroyUsb(pVM, pUsbIns);
1110#endif
1111
1112 /*
1113 * Unlink it.
1114 */
1115 /* The global instance FIFO. */
1116 if (pVM->pdm.s.pUsbInstances == pUsbIns)
1117 pVM->pdm.s.pUsbInstances = pUsbIns->Internal.s.pNext;
1118 else
1119 {
1120 PPDMUSBINS pPrev = pVM->pdm.s.pUsbInstances;
1121 while (pPrev && pPrev->Internal.s.pNext != pUsbIns)
1122 {
1123 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
1124 pPrev = pPrev->Internal.s.pNext;
1125 }
1126 Assert(pPrev); Assert(pPrev != pUsbIns);
1127 if (pPrev)
1128 pPrev->Internal.s.pNext = pUsbIns->Internal.s.pNext;
1129 }
1130
1131 /* The per device instance FIFO. */
1132 PPDMUSB pUsbDev = pUsbIns->Internal.s.pUsbDev;
1133 if (pUsbDev->pInstances == pUsbIns)
1134 pUsbDev->pInstances = pUsbIns->Internal.s.pPerDeviceNext;
1135 else
1136 {
1137 PPDMUSBINS pPrev = pUsbDev->pInstances;
1138 while (pPrev && pPrev->Internal.s.pPerDeviceNext != pUsbIns)
1139 {
1140 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
1141 pPrev = pPrev->Internal.s.pPerDeviceNext;
1142 }
1143 Assert(pPrev); Assert(pPrev != pUsbIns);
1144 if (pPrev)
1145 pPrev->Internal.s.pPerDeviceNext = pUsbIns->Internal.s.pPerDeviceNext;
1146 }
1147
1148 /*
1149 * Trash it.
1150 */
1151 pUsbIns->u32Version = 0;
1152 pUsbIns->pReg = NULL;
1153 if (pUsbIns->pszName)
1154 {
1155 RTStrFree(pUsbIns->pszName);
1156 pUsbIns->pszName = NULL;
1157 }
1158 CFGMR3RemoveNode(pUsbIns->Internal.s.pCfgDelete);
1159 MMR3HeapFree(pUsbIns);
1160}
1161
1162
1163/**
1164 * Detaches and destroys a USB device.
1165 *
1166 * @returns VBox status code.
1167 * @param pUVM The user mode VM handle.
1168 * @param pUuid The UUID associated with the device to detach.
1169 * @thread EMT
1170 */
1171VMMR3DECL(int) PDMR3UsbDetachDevice(PUVM pUVM, PCRTUUID pUuid)
1172{
1173 /*
1174 * Validate input.
1175 */
1176 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1177 PVM pVM = pUVM->pVM;
1178 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1179 VM_ASSERT_EMT(pVM);
1180 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
1181
1182 /*
1183 * Search the global list for it.
1184 */
1185 PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances;
1186 for ( ; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1187 if (!RTUuidCompare(&pUsbIns->Internal.s.Uuid, pUuid))
1188 break;
1189 if (!pUsbIns)
1190 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND; /** @todo VERR_PDM_USB_INSTANCE_NOT_FOUND */
1191
1192 /*
1193 * Detach it from the HUB (if it's actually attached to one).
1194 */
1195 PPDMUSBHUB pHub = pUsbIns->Internal.s.pHub;
1196 if (pHub)
1197 {
1198 int rc = pHub->Reg.pfnDetachDevice(pHub->pDrvIns, pUsbIns, pUsbIns->Internal.s.iPort);
1199 if (RT_FAILURE(rc))
1200 {
1201 LogRel(("PDMUsb: Failed to detach USB device '%s' instance %d from %p: %Rrc\n",
1202 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
1203 return rc;
1204 }
1205
1206 pHub->cAvailablePorts++;
1207 Assert(pHub->cAvailablePorts > 0 && pHub->cAvailablePorts <= pHub->cPorts);
1208 pUsbIns->Internal.s.pHub = NULL;
1209 }
1210
1211 /*
1212 * Notify about unplugging and destroy the device with it's drivers.
1213 */
1214 pdmR3UsbDestroyDevice(pVM, pUsbIns);
1215
1216 return VINF_SUCCESS;
1217}
1218
1219
1220/**
1221 * Checks if there are any USB hubs attached.
1222 *
1223 * @returns true / false accordingly.
1224 * @param pUVM The user mode VM handle.
1225 */
1226VMMR3DECL(bool) PDMR3UsbHasHub(PUVM pUVM)
1227{
1228 UVM_ASSERT_VALID_EXT_RETURN(pUVM, false);
1229 PVM pVM = pUVM->pVM;
1230 VM_ASSERT_VALID_EXT_RETURN(pVM, false);
1231 return pVM->pdm.s.pUsbHubs != NULL;
1232}
1233
1234
1235/**
1236 * Locates a LUN.
1237 *
1238 * @returns VBox status code.
1239 * @param pVM The cross context VM structure.
1240 * @param pszDevice Device name.
1241 * @param iInstance Device instance.
1242 * @param iLun The Logical Unit to obtain the interface of.
1243 * @param ppLun Where to store the pointer to the LUN if found.
1244 * @thread Try only do this in EMT...
1245 */
1246static int pdmR3UsbFindLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPPDMLUN ppLun)
1247{
1248 /*
1249 * Iterate registered devices looking for the device.
1250 */
1251 size_t cchDevice = strlen(pszDevice);
1252 for (PPDMUSB pUsbDev = pVM->pdm.s.pUsbDevs; pUsbDev; pUsbDev = pUsbDev->pNext)
1253 {
1254 if ( pUsbDev->cchName == cchDevice
1255 && !memcmp(pUsbDev->pReg->szName, pszDevice, cchDevice))
1256 {
1257 /*
1258 * Iterate device instances.
1259 */
1260 for (PPDMUSBINS pUsbIns = pUsbDev->pInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pPerDeviceNext)
1261 {
1262 if (pUsbIns->iInstance == iInstance)
1263 {
1264 /*
1265 * Iterate luns.
1266 */
1267 for (PPDMLUN pLun = pUsbIns->Internal.s.pLuns; pLun; pLun = pLun->pNext)
1268 {
1269 if (pLun->iLun == iLun)
1270 {
1271 *ppLun = pLun;
1272 return VINF_SUCCESS;
1273 }
1274 }
1275 return VERR_PDM_LUN_NOT_FOUND;
1276 }
1277 }
1278 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND;
1279 }
1280 }
1281 return VERR_PDM_DEVICE_NOT_FOUND;
1282}
1283
1284
1285/**
1286 * Attaches a preconfigured driver to an existing device or driver instance.
1287 *
1288 * This is used to change drivers and suchlike at runtime. The driver or device
1289 * at the end of the chain will be told to attach to whatever is configured
1290 * below it.
1291 *
1292 * @returns VBox status code.
1293 * @param pUVM The user mode VM handle.
1294 * @param pszDevice Device name.
1295 * @param iDevIns Device instance.
1296 * @param iLun The Logical Unit to obtain the interface of.
1297 * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
1298 * @param ppBase Where to store the base interface pointer. Optional.
1299 *
1300 * @thread EMT
1301 */
1302VMMR3DECL(int) PDMR3UsbDriverAttach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun, uint32_t fFlags,
1303 PPPDMIBASE ppBase)
1304{
1305 LogFlow(("PDMR3UsbDriverAttach: pszDevice=%p:{%s} iDevIns=%d iLun=%d fFlags=%#x ppBase=%p\n",
1306 pszDevice, pszDevice, iDevIns, iLun, fFlags, ppBase));
1307 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1308 PVM pVM = pUVM->pVM;
1309 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1310 VM_ASSERT_EMT(pVM);
1311
1312 if (ppBase)
1313 *ppBase = NULL;
1314
1315 /*
1316 * Find the LUN in question.
1317 */
1318 PPDMLUN pLun;
1319 int rc = pdmR3UsbFindLun(pVM, pszDevice, iDevIns, iLun, &pLun);
1320 if (RT_SUCCESS(rc))
1321 {
1322 /*
1323 * Anything attached to the LUN?
1324 */
1325 PPDMDRVINS pDrvIns = pLun->pTop;
1326 if (!pDrvIns)
1327 {
1328 /* No, ask the device to attach to the new stuff. */
1329 PPDMUSBINS pUsbIns = pLun->pUsbIns;
1330 if (pUsbIns->pReg->pfnDriverAttach)
1331 {
1332 rc = pUsbIns->pReg->pfnDriverAttach(pUsbIns, iLun, fFlags);
1333 if (RT_SUCCESS(rc) && ppBase)
1334 *ppBase = pLun->pTop ? &pLun->pTop->IBase : NULL;
1335 }
1336 else
1337 rc = VERR_PDM_DEVICE_NO_RT_ATTACH;
1338 }
1339 else
1340 {
1341 /* Yes, find the bottom most driver and ask it to attach to the new stuff. */
1342 while (pDrvIns->Internal.s.pDown)
1343 pDrvIns = pDrvIns->Internal.s.pDown;
1344 if (pDrvIns->pReg->pfnAttach)
1345 {
1346 rc = pDrvIns->pReg->pfnAttach(pDrvIns, fFlags);
1347 if (RT_SUCCESS(rc) && ppBase)
1348 *ppBase = pDrvIns->Internal.s.pDown
1349 ? &pDrvIns->Internal.s.pDown->IBase
1350 : NULL;
1351 }
1352 else
1353 rc = VERR_PDM_DRIVER_NO_RT_ATTACH;
1354 }
1355 }
1356
1357 if (ppBase)
1358 LogFlow(("PDMR3UsbDriverAttach: returns %Rrc *ppBase=%p\n", rc, *ppBase));
1359 else
1360 LogFlow(("PDMR3UsbDriverAttach: returns %Rrc\n", rc));
1361 return rc;
1362}
1363
1364
1365/**
1366 * Detaches the specified driver instance.
1367 *
1368 * This is used to replumb drivers at runtime for simulating hot plugging and
1369 * media changes.
1370 *
1371 * This method allows detaching drivers from
1372 * any driver or device by specifying the driver to start detaching at. The
1373 * only prerequisite is that the driver or device above implements the
1374 * pfnDetach callback (PDMDRVREG / PDMUSBREG).
1375 *
1376 * @returns VBox status code.
1377 * @param pUVM The user mode VM handle.
1378 * @param pszDevice Device name.
1379 * @param iDevIns Device instance.
1380 * @param iLun The Logical Unit in which to look for the driver.
1381 * @param pszDriver The name of the driver which to detach. If NULL
1382 * then the entire driver chain is detatched.
1383 * @param iOccurance The occurrence of that driver in the chain. This is
1384 * usually 0.
1385 * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
1386 * @thread EMT
1387 */
1388VMMR3DECL(int) PDMR3UsbDriverDetach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
1389 const char *pszDriver, unsigned iOccurance, uint32_t fFlags)
1390{
1391 LogFlow(("PDMR3UsbDriverDetach: pszDevice=%p:{%s} iDevIns=%u iLun=%u pszDriver=%p:{%s} iOccurance=%u fFlags=%#x\n",
1392 pszDevice, pszDevice, iDevIns, iLun, pszDriver, pszDriver, iOccurance, fFlags));
1393 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1394 PVM pVM = pUVM->pVM;
1395 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1396 VM_ASSERT_EMT(pVM);
1397 AssertPtr(pszDevice);
1398 AssertPtrNull(pszDriver);
1399 Assert(iOccurance == 0 || pszDriver);
1400 Assert(!(fFlags & ~(PDM_TACH_FLAGS_NOT_HOT_PLUG)));
1401
1402 /*
1403 * Find the LUN in question.
1404 */
1405 PPDMLUN pLun;
1406 int rc = pdmR3UsbFindLun(pVM, pszDevice, iDevIns, iLun, &pLun);
1407 if (RT_SUCCESS(rc))
1408 {
1409 /*
1410 * Locate the driver.
1411 */
1412 PPDMDRVINS pDrvIns = pLun->pTop;
1413 if (pDrvIns)
1414 {
1415 if (pszDriver)
1416 {
1417 while (pDrvIns)
1418 {
1419 if (!strcmp(pDrvIns->pReg->szName, pszDriver))
1420 {
1421 if (iOccurance == 0)
1422 break;
1423 iOccurance--;
1424 }
1425 pDrvIns = pDrvIns->Internal.s.pDown;
1426 }
1427 }
1428 if (pDrvIns)
1429 rc = pdmR3DrvDetach(pDrvIns, fFlags);
1430 else
1431 rc = VERR_PDM_DRIVER_INSTANCE_NOT_FOUND;
1432 }
1433 else
1434 rc = VINF_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1435 }
1436
1437 LogFlow(("PDMR3UsbDriverDetach: returns %Rrc\n", rc));
1438 return rc;
1439}
1440
1441
1442/**
1443 * Query the interface of the top level driver on a LUN.
1444 *
1445 * @returns VBox status code.
1446 * @param pUVM The user mode VM handle.
1447 * @param pszDevice Device name.
1448 * @param iInstance Device instance.
1449 * @param iLun The Logical Unit to obtain the interface of.
1450 * @param ppBase Where to store the base interface pointer.
1451 * @remark We're not doing any locking ATM, so don't try call this at times when the
1452 * device chain is known to be updated.
1453 */
1454VMMR3DECL(int) PDMR3UsbQueryLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPDMIBASE *ppBase)
1455{
1456 LogFlow(("PDMR3UsbQueryLun: pszDevice=%p:{%s} iInstance=%u iLun=%u ppBase=%p\n",
1457 pszDevice, pszDevice, iInstance, iLun, ppBase));
1458 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1459 PVM pVM = pUVM->pVM;
1460 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1461
1462 /*
1463 * Find the LUN.
1464 */
1465 PPDMLUN pLun;
1466 int rc = pdmR3UsbFindLun(pVM, pszDevice, iInstance, iLun, &pLun);
1467 if (RT_SUCCESS(rc))
1468 {
1469 if (pLun->pTop)
1470 {
1471 *ppBase = &pLun->pTop->IBase;
1472 LogFlow(("PDMR3UsbQueryLun: return %Rrc and *ppBase=%p\n", VINF_SUCCESS, *ppBase));
1473 return VINF_SUCCESS;
1474 }
1475 rc = VERR_PDM_NO_DRIVER_ATTACHED_TO_LUN;
1476 }
1477 LogFlow(("PDMR3UsbQueryLun: returns %Rrc\n", rc));
1478 return rc;
1479}
1480
1481
1482/** @name USB Device Helpers
1483 * @{
1484 */
1485
1486/** @interface_method_impl{PDMUSBHLP,pfnDriverAttach} */
1487static DECLCALLBACK(int) pdmR3UsbHlp_DriverAttach(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface,
1488 PPDMIBASE *ppBaseInterface, const char *pszDesc)
1489{
1490 PDMUSB_ASSERT_USBINS(pUsbIns);
1491 PVM pVM = pUsbIns->Internal.s.pVM;
1492 VM_ASSERT_EMT(pVM);
1493 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: iLun=%d pBaseInterface=%p ppBaseInterface=%p pszDesc=%p:{%s}\n",
1494 pUsbIns->pReg->szName, pUsbIns->iInstance, iLun, pBaseInterface, ppBaseInterface, pszDesc, pszDesc));
1495
1496 /*
1497 * Lookup the LUN, it might already be registered.
1498 */
1499 PPDMLUN pLunPrev = NULL;
1500 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
1501 for (; pLun; pLunPrev = pLun, pLun = pLun->pNext)
1502 if (pLun->iLun == iLun)
1503 break;
1504
1505 /*
1506 * Create the LUN if if wasn't found, else check if driver is already attached to it.
1507 */
1508 if (!pLun)
1509 {
1510 if ( !pBaseInterface
1511 || !pszDesc
1512 || !*pszDesc)
1513 {
1514 Assert(pBaseInterface);
1515 Assert(pszDesc || *pszDesc);
1516 return VERR_INVALID_PARAMETER;
1517 }
1518
1519 pLun = (PPDMLUN)MMR3HeapAlloc(pVM, MM_TAG_PDM_LUN, sizeof(*pLun));
1520 if (!pLun)
1521 return VERR_NO_MEMORY;
1522
1523 pLun->iLun = iLun;
1524 pLun->pNext = pLunPrev ? pLunPrev->pNext : NULL;
1525 pLun->pTop = NULL;
1526 pLun->pBottom = NULL;
1527 pLun->pDevIns = NULL;
1528 pLun->pUsbIns = pUsbIns;
1529 pLun->pszDesc = pszDesc;
1530 pLun->pBase = pBaseInterface;
1531 if (!pLunPrev)
1532 pUsbIns->Internal.s.pLuns = pLun;
1533 else
1534 pLunPrev->pNext = pLun;
1535 Log(("pdmR3UsbHlp_DriverAttach: Registered LUN#%d '%s' with device '%s'/%d.\n",
1536 iLun, pszDesc, pUsbIns->pReg->szName, pUsbIns->iInstance));
1537 }
1538 else if (pLun->pTop)
1539 {
1540 AssertMsgFailed(("Already attached! The device should keep track of such things!\n"));
1541 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, VERR_PDM_DRIVER_ALREADY_ATTACHED));
1542 return VERR_PDM_DRIVER_ALREADY_ATTACHED;
1543 }
1544 Assert(pLun->pBase == pBaseInterface);
1545
1546
1547 /*
1548 * Get the attached driver configuration.
1549 */
1550 int rc;
1551 PCFGMNODE pNode = CFGMR3GetChildF(pUsbIns->Internal.s.pCfg, "LUN#%u", iLun);
1552 if (pNode)
1553 rc = pdmR3DrvInstantiate(pVM, pNode, pBaseInterface, NULL /*pDrvAbove*/, pLun, ppBaseInterface);
1554 else
1555 rc = VERR_PDM_NO_ATTACHED_DRIVER;
1556
1557
1558 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1559 return rc;
1560}
1561
1562
1563/** @interface_method_impl{PDMUSBHLP,pfnAssertEMT} */
1564static DECLCALLBACK(bool) pdmR3UsbHlp_AssertEMT(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1565{
1566 PDMUSB_ASSERT_USBINS(pUsbIns);
1567 if (VM_IS_EMT(pUsbIns->Internal.s.pVM))
1568 return true;
1569
1570 char szMsg[100];
1571 RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1572 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1573 AssertBreakpoint();
1574 return false;
1575}
1576
1577
1578/** @interface_method_impl{PDMUSBHLP,pfnAssertOther} */
1579static DECLCALLBACK(bool) pdmR3UsbHlp_AssertOther(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1580{
1581 PDMUSB_ASSERT_USBINS(pUsbIns);
1582 if (!VM_IS_EMT(pUsbIns->Internal.s.pVM))
1583 return true;
1584
1585 char szMsg[100];
1586 RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1587 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1588 AssertBreakpoint();
1589 return false;
1590}
1591
1592
1593/** @interface_method_impl{PDMUSBHLP,pfnDBGFStopV} */
1594static DECLCALLBACK(int) pdmR3UsbHlp_DBGFStopV(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction,
1595 const char *pszFormat, va_list va)
1596{
1597 PDMUSB_ASSERT_USBINS(pUsbIns);
1598#ifdef LOG_ENABLED
1599 va_list va2;
1600 va_copy(va2, va);
1601 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: pszFile=%p:{%s} iLine=%d pszFunction=%p:{%s} pszFormat=%p:{%s} (%N)\n",
1602 pUsbIns->pReg->szName, pUsbIns->iInstance, pszFile, pszFile, iLine, pszFunction, pszFunction, pszFormat, pszFormat, pszFormat, &va2));
1603 va_end(va2);
1604#endif
1605
1606 PVM pVM = pUsbIns->Internal.s.pVM;
1607 VM_ASSERT_EMT(pVM);
1608 int rc = DBGFR3EventSrcV(pVM, DBGFEVENT_DEV_STOP, pszFile, iLine, pszFunction, pszFormat, va);
1609 if (rc == VERR_DBGF_NOT_ATTACHED)
1610 rc = VINF_SUCCESS;
1611
1612 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1613 return rc;
1614}
1615
1616
1617/** @interface_method_impl{PDMUSBHLP,pfnDBGFInfoRegister} */
1618static DECLCALLBACK(int) pdmR3UsbHlp_DBGFInfoRegister(PPDMUSBINS pUsbIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERUSB pfnHandler)
1619{
1620 PDMUSB_ASSERT_USBINS(pUsbIns);
1621 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: pszName=%p:{%s} pszDesc=%p:{%s} pfnHandler=%p\n",
1622 pUsbIns->pReg->szName, pUsbIns->iInstance, pszName, pszName, pszDesc, pszDesc, pfnHandler));
1623
1624 PVM pVM = pUsbIns->Internal.s.pVM;
1625 VM_ASSERT_EMT(pVM);
1626 NOREF(pVM); /** @todo int rc = DBGFR3InfoRegisterUsb(pVM, pszName, pszDesc, pfnHandler, pUsbIns); */
1627 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1628
1629 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1630 return rc;
1631}
1632
1633
1634/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAlloc} */
1635static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAlloc(PPDMUSBINS pUsbIns, size_t cb)
1636{
1637 PDMUSB_ASSERT_USBINS(pUsbIns);
1638 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1639
1640 void *pv = MMR3HeapAlloc(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1641
1642 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1643 return pv;
1644}
1645
1646
1647/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAllocZ} */
1648static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAllocZ(PPDMUSBINS pUsbIns, size_t cb)
1649{
1650 PDMUSB_ASSERT_USBINS(pUsbIns);
1651 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1652
1653 void *pv = MMR3HeapAllocZ(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1654
1655 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1656 return pv;
1657}
1658
1659
1660/** @interface_method_impl{PDMUSBHLP,pfnPDMQueueCreate} */
1661static DECLCALLBACK(int) pdmR3UsbHlp_PDMQueueCreate(PPDMUSBINS pUsbIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval,
1662 PFNPDMQUEUEUSB pfnCallback, const char *pszName, PPDMQUEUE *ppQueue)
1663{
1664 PDMUSB_ASSERT_USBINS(pUsbIns);
1665 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%#x cItems=%#x cMilliesInterval=%u pfnCallback=%p pszName=%p:{%s} ppQueue=%p\n",
1666 pUsbIns->pReg->szName, pUsbIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, pszName, ppQueue));
1667
1668 PVM pVM = pUsbIns->Internal.s.pVM;
1669 VM_ASSERT_EMT(pVM);
1670
1671 if (pUsbIns->iInstance > 0)
1672 {
1673 pszName = MMR3HeapAPrintf(pVM, MM_TAG_PDM_DEVICE_DESC, "%s_%u", pszName, pUsbIns->iInstance);
1674 AssertLogRelReturn(pszName, VERR_NO_MEMORY);
1675 }
1676
1677 /** @todo int rc = PDMR3QueueCreateUsb(pVM, pUsbIns, cbItem, cItems, cMilliesInterval, pfnCallback, fGCEnabled, pszName, ppQueue); */
1678 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1679
1680 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: returns %Rrc *ppQueue=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc, *ppQueue));
1681 return rc;
1682}
1683
1684
1685/** @interface_method_impl{PDMUSBHLP,pfnSSMRegister} */
1686static DECLCALLBACK(int) pdmR3UsbHlp_SSMRegister(PPDMUSBINS pUsbIns, uint32_t uVersion, size_t cbGuess,
1687 PFNSSMUSBLIVEPREP pfnLivePrep, PFNSSMUSBLIVEEXEC pfnLiveExec, PFNSSMUSBLIVEVOTE pfnLiveVote,
1688 PFNSSMUSBSAVEPREP pfnSavePrep, PFNSSMUSBSAVEEXEC pfnSaveExec, PFNSSMUSBSAVEDONE pfnSaveDone,
1689 PFNSSMUSBLOADPREP pfnLoadPrep, PFNSSMUSBLOADEXEC pfnLoadExec, PFNSSMUSBLOADDONE pfnLoadDone)
1690{
1691 PDMUSB_ASSERT_USBINS(pUsbIns);
1692 VM_ASSERT_EMT(pUsbIns->Internal.s.pVM);
1693 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: uVersion=%#x cbGuess=%#x\n"
1694 " pfnLivePrep=%p pfnLiveExec=%p pfnLiveVote=%p pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoadDone=%p\n",
1695 pUsbIns->pReg->szName, pUsbIns->iInstance, uVersion, cbGuess,
1696 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1697 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1698 pfnLoadPrep, pfnLoadExec, pfnLoadDone));
1699
1700 int rc = SSMR3RegisterUsb(pUsbIns->Internal.s.pVM, pUsbIns, pUsbIns->pReg->szName, pUsbIns->iInstance,
1701 uVersion, cbGuess,
1702 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1703 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1704 pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1705
1706 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1707 return rc;
1708}
1709
1710
1711/** @interface_method_impl{PDMUSBHLP,pfnSTAMRegisterV} */
1712static DECLCALLBACK(void) pdmR3UsbHlp_STAMRegisterV(PPDMUSBINS pUsbIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1713 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list va)
1714{
1715 PDMUSB_ASSERT_USBINS(pUsbIns);
1716 PVM pVM = pUsbIns->Internal.s.pVM;
1717 VM_ASSERT_EMT(pVM);
1718
1719 int rc = STAMR3RegisterV(pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1720 AssertRC(rc);
1721
1722 NOREF(pVM);
1723}
1724
1725
1726/** @interface_method_impl{PDMUSBHLP,pfnTMTimerCreate} */
1727static DECLCALLBACK(int) pdmR3UsbHlp_TMTimerCreate(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
1728 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1729{
1730 PDMUSB_ASSERT_USBINS(pUsbIns);
1731 PVM pVM = pUsbIns->Internal.s.pVM;
1732 VM_ASSERT_EMT(pVM);
1733 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pvUser=%p fFlags=%#x pszDesc=%p:{%s} ppTimer=%p\n",
1734 pUsbIns->pReg->szName, pUsbIns->iInstance, enmClock, pfnCallback, pvUser, fFlags, pszDesc, pszDesc, ppTimer));
1735
1736 if (pUsbIns->iInstance > 0) /** @todo use a string cache here later. */
1737 {
1738 char *pszDesc2 = MMR3HeapAPrintf(pVM, MM_TAG_PDM_USB_DESC, "%s [%u]", pszDesc, pUsbIns->iInstance);
1739 if (pszDesc2)
1740 pszDesc = pszDesc2;
1741 }
1742
1743 int rc = TMR3TimerCreateUsb(pVM, pUsbIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
1744
1745 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1746 return rc;
1747}
1748
1749
1750/** @interface_method_impl{PDMUSBHLP,pfnVMSetErrorV} */
1751static DECLCALLBACK(int) pdmR3UsbHlp_VMSetErrorV(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
1752{
1753 PDMUSB_ASSERT_USBINS(pUsbIns);
1754 int rc2 = VMSetErrorV(pUsbIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
1755 return rc;
1756}
1757
1758
1759/** @interface_method_impl{PDMUSBHLP,pfnVMSetRuntimeErrorV} */
1760static DECLCALLBACK(int) pdmR3UsbHlp_VMSetRuntimeErrorV(PPDMUSBINS pUsbIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va)
1761{
1762 PDMUSB_ASSERT_USBINS(pUsbIns);
1763 int rc = VMSetRuntimeErrorV(pUsbIns->Internal.s.pVM, fFlags, pszErrorId, pszFormat, va);
1764 return rc;
1765}
1766
1767
1768/** @interface_method_impl{PDMUSBHLP,pfnVMState} */
1769static DECLCALLBACK(VMSTATE) pdmR3UsbHlp_VMState(PPDMUSBINS pUsbIns)
1770{
1771 PDMUSB_ASSERT_USBINS(pUsbIns);
1772
1773 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1774
1775 LogFlow(("pdmR3UsbHlp_VMState: caller='%s'/%d: returns %d (%s)\n", pUsbIns->pReg->szName, pUsbIns->iInstance,
1776 enmVMState, VMR3GetStateName(enmVMState)));
1777 return enmVMState;
1778}
1779
1780/** @interface_method_impl{PDMUSBHLP,pfnThreadCreate} */
1781static DECLCALLBACK(int) pdmR3UsbHlp_ThreadCreate(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
1782 PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1783{
1784 PDMUSB_ASSERT_USBINS(pUsbIns);
1785 VM_ASSERT_EMT(pUsbIns->Internal.s.pVM);
1786 LogFlow(("pdmR3UsbHlp_ThreadCreate: caller='%s'/%d: ppThread=%p pvUser=%p pfnThread=%p pfnWakeup=%p cbStack=%#zx enmType=%d pszName=%p:{%s}\n",
1787 pUsbIns->pReg->szName, pUsbIns->iInstance, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName, pszName));
1788
1789 int rc = pdmR3ThreadCreateUsb(pUsbIns->Internal.s.pVM, pUsbIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1790
1791 LogFlow(("pdmR3UsbHlp_ThreadCreate: caller='%s'/%d: returns %Rrc *ppThread=%RTthrd\n", pUsbIns->pReg->szName, pUsbIns->iInstance,
1792 rc, *ppThread));
1793 return rc;
1794}
1795
1796
1797/** @interface_method_impl{PDMUSBHLP,pfnSetAsyncNotification} */
1798static DECLCALLBACK(int) pdmR3UsbHlp_SetAsyncNotification(PPDMUSBINS pUsbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify)
1799{
1800 PDMUSB_ASSERT_USBINS(pUsbIns);
1801 VM_ASSERT_EMT0(pUsbIns->Internal.s.pVM);
1802 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: pfnAsyncNotify=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pfnAsyncNotify));
1803
1804 int rc = VINF_SUCCESS;
1805 AssertStmt(pfnAsyncNotify, rc = VERR_INVALID_PARAMETER);
1806 AssertStmt(!pUsbIns->Internal.s.pfnAsyncNotify, rc = VERR_WRONG_ORDER);
1807 AssertStmt(pUsbIns->Internal.s.fVMSuspended || pUsbIns->Internal.s.fVMReset, rc = VERR_WRONG_ORDER);
1808 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1809 AssertStmt( enmVMState == VMSTATE_SUSPENDING
1810 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1811 || enmVMState == VMSTATE_SUSPENDING_LS
1812 || enmVMState == VMSTATE_RESETTING
1813 || enmVMState == VMSTATE_RESETTING_LS
1814 || enmVMState == VMSTATE_POWERING_OFF
1815 || enmVMState == VMSTATE_POWERING_OFF_LS,
1816 rc = VERR_INVALID_STATE);
1817
1818 if (RT_SUCCESS(rc))
1819 pUsbIns->Internal.s.pfnAsyncNotify = pfnAsyncNotify;
1820
1821 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1822 return rc;
1823}
1824
1825
1826/** @interface_method_impl{PDMUSBHLP,pfnAsyncNotificationCompleted} */
1827static DECLCALLBACK(void) pdmR3UsbHlp_AsyncNotificationCompleted(PPDMUSBINS pUsbIns)
1828{
1829 PDMUSB_ASSERT_USBINS(pUsbIns);
1830 PVM pVM = pUsbIns->Internal.s.pVM;
1831
1832 VMSTATE enmVMState = VMR3GetState(pVM);
1833 if ( enmVMState == VMSTATE_SUSPENDING
1834 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1835 || enmVMState == VMSTATE_SUSPENDING_LS
1836 || enmVMState == VMSTATE_RESETTING
1837 || enmVMState == VMSTATE_RESETTING_LS
1838 || enmVMState == VMSTATE_POWERING_OFF
1839 || enmVMState == VMSTATE_POWERING_OFF_LS)
1840 {
1841 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d:\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1842 VMR3AsyncPdmNotificationWakeupU(pVM->pUVM);
1843 }
1844 else
1845 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d: enmVMState=%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance, enmVMState));
1846}
1847
1848
1849/** @interface_method_impl{PDMUSBHLP,pfnVMGetSuspendReason} */
1850static DECLCALLBACK(VMSUSPENDREASON) pdmR3UsbHlp_VMGetSuspendReason(PPDMUSBINS pUsbIns)
1851{
1852 PDMUSB_ASSERT_USBINS(pUsbIns);
1853 PVM pVM = pUsbIns->Internal.s.pVM;
1854 VM_ASSERT_EMT(pVM);
1855 VMSUSPENDREASON enmReason = VMR3GetSuspendReason(pVM->pUVM);
1856 LogFlow(("pdmR3UsbHlp_VMGetSuspendReason: caller='%s'/%d: returns %d\n",
1857 pUsbIns->pReg->szName, pUsbIns->iInstance, enmReason));
1858 return enmReason;
1859}
1860
1861
1862/** @interface_method_impl{PDMUSBHLP,pfnVMGetResumeReason} */
1863static DECLCALLBACK(VMRESUMEREASON) pdmR3UsbHlp_VMGetResumeReason(PPDMUSBINS pUsbIns)
1864{
1865 PDMUSB_ASSERT_USBINS(pUsbIns);
1866 PVM pVM = pUsbIns->Internal.s.pVM;
1867 VM_ASSERT_EMT(pVM);
1868 VMRESUMEREASON enmReason = VMR3GetResumeReason(pVM->pUVM);
1869 LogFlow(("pdmR3UsbHlp_VMGetResumeReason: caller='%s'/%d: returns %d\n",
1870 pUsbIns->pReg->szName, pUsbIns->iInstance, enmReason));
1871 return enmReason;
1872}
1873
1874
1875/**
1876 * The USB device helper structure.
1877 */
1878const PDMUSBHLP g_pdmR3UsbHlp =
1879{
1880 PDM_USBHLP_VERSION,
1881 pdmR3UsbHlp_DriverAttach,
1882 pdmR3UsbHlp_AssertEMT,
1883 pdmR3UsbHlp_AssertOther,
1884 pdmR3UsbHlp_DBGFStopV,
1885 pdmR3UsbHlp_DBGFInfoRegister,
1886 pdmR3UsbHlp_MMHeapAlloc,
1887 pdmR3UsbHlp_MMHeapAllocZ,
1888 pdmR3UsbHlp_PDMQueueCreate,
1889 pdmR3UsbHlp_SSMRegister,
1890 pdmR3UsbHlp_STAMRegisterV,
1891 pdmR3UsbHlp_TMTimerCreate,
1892 pdmR3UsbHlp_VMSetErrorV,
1893 pdmR3UsbHlp_VMSetRuntimeErrorV,
1894 pdmR3UsbHlp_VMState,
1895 pdmR3UsbHlp_ThreadCreate,
1896 pdmR3UsbHlp_SetAsyncNotification,
1897 pdmR3UsbHlp_AsyncNotificationCompleted,
1898 pdmR3UsbHlp_VMGetSuspendReason,
1899 pdmR3UsbHlp_VMGetResumeReason,
1900 NULL,
1901 NULL,
1902 NULL,
1903 NULL,
1904 NULL,
1905 NULL,
1906 NULL,
1907 NULL,
1908 NULL,
1909 NULL,
1910 PDM_USBHLP_VERSION
1911};
1912
1913/** @} */
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