VirtualBox

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

Last change on this file since 48234 was 48234, checked in by vboxsync, 11 years ago

VMM: PDMR3UsbCreateEmulatedDevice
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 56.5 KB
Line 
1/* $Id: PDMUsb.cpp 48234 2013-09-02 17:09:24Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device and Driver Manager, USB part.
4 */
5
6/*
7 * Copyright (C) 2006-2013 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)), ("%#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)) == 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 && ( (pCur->fVersions & iUsbVersion)
444 || pCur->fVersions == VUSB_STDVER_11))
445 {
446 *ppHub = pCur;
447 if (pCur->fVersions & iUsbVersion)
448 break;
449 }
450 if (*ppHub)
451 return VINF_SUCCESS;
452 return VERR_PDM_NO_USB_PORTS;
453}
454
455
456/**
457 * Creates the device.
458 *
459 * @returns VBox status code.
460 * @param pVM Pointer to the VM.
461 * @param pUsbDev The USB device emulation.
462 * @param iInstance -1 if not called by pdmR3UsbInstantiateDevices().
463 * @param pUuid The UUID for this device.
464 * @param ppInstanceNode Pointer to the device instance pointer. This is set to NULL if inserted
465 * into the tree or cleaned up.
466 *
467 * In the pdmR3UsbInstantiateDevices() case (iInstance != -1) this is
468 * the actual instance node and will not be cleaned up.
469 *
470 * @parma iUsbVersion The USB version preferred by the device.
471 */
472static int pdmR3UsbCreateDevice(PVM pVM, PPDMUSBHUB pHub, PPDMUSB pUsbDev, int iInstance, PCRTUUID pUuid,
473 PCFGMNODE *ppInstanceNode, uint32_t iUsbVersion)
474{
475 const bool fAtRuntime = iInstance == -1;
476 int rc;
477
478 AssertPtrReturn(ppInstanceNode, VERR_INVALID_POINTER);
479 AssertPtrReturn(*ppInstanceNode, VERR_INVALID_POINTER);
480
481 /*
482 * If not called by pdmR3UsbInstantiateDevices(), we'll have to fix
483 * the configuration now.
484 */
485 /* USB device node. */
486 PCFGMNODE pDevNode = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "USB/%s/", pUsbDev->pReg->szName);
487 if (!pDevNode)
488 {
489 rc = CFGMR3InsertNodeF(CFGMR3GetRoot(pVM), &pDevNode, "USB/%s/", pUsbDev->pReg->szName);
490 AssertRCReturn(rc, rc);
491 }
492
493 /* The instance node and number. */
494 PCFGMNODE pInstanceToDelete = NULL;
495 PCFGMNODE pInstanceNode = NULL;
496 if (fAtRuntime)
497 {
498 /** @todo r=bird: This code is bogus as it ASSUMES that all USB devices are
499 * capable of infinite number of instances. */
500 for (unsigned c = 0; c < _2M; c++)
501 {
502 iInstance = pUsbDev->iNextInstance++;
503 rc = CFGMR3InsertNodeF(pDevNode, &pInstanceNode, "%d/", iInstance);
504 if (rc != VERR_CFGM_NODE_EXISTS)
505 break;
506 }
507 AssertRCReturn(rc, rc);
508
509 rc = CFGMR3ReplaceSubTree(pInstanceNode, *ppInstanceNode);
510 AssertRCReturn(rc, rc);
511 *ppInstanceNode = NULL;
512 pInstanceToDelete = pInstanceNode;
513 }
514 else
515 {
516 Assert(iInstance >= 0);
517 if (iInstance >= (int)pUsbDev->iNextInstance)
518 pUsbDev->iNextInstance = iInstance + 1;
519 pInstanceNode = *ppInstanceNode;
520 }
521
522 /* Make sure the instance config node exists. */
523 PCFGMNODE pConfig = CFGMR3GetChild(pInstanceNode, "Config");
524 if (!pConfig)
525 {
526 rc = CFGMR3InsertNode(pInstanceNode, "Config", &pConfig);
527 AssertRCReturn(rc, rc);
528 }
529 Assert(CFGMR3GetChild(pInstanceNode, "Config") == pConfig);
530
531 /* The global device config node. */
532 PCFGMNODE pGlobalConfig = CFGMR3GetChild(pDevNode, "GlobalConfig");
533 if (!pGlobalConfig)
534 {
535 rc = CFGMR3InsertNode(pDevNode, "GlobalConfig", &pGlobalConfig);
536 if (RT_FAILURE(rc))
537 {
538 CFGMR3RemoveNode(pInstanceToDelete);
539 AssertRCReturn(rc, rc);
540 }
541 }
542
543 /*
544 * Allocate the device instance.
545 */
546 size_t cb = RT_OFFSETOF(PDMUSBINS, achInstanceData[pUsbDev->pReg->cbInstance]);
547 cb = RT_ALIGN_Z(cb, 16);
548 PPDMUSBINS pUsbIns;
549 rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_USB, cb, (void **)&pUsbIns);
550 if (RT_FAILURE(rc))
551 {
552 AssertMsgFailed(("Failed to allocate %d bytes of instance data for USB device '%s'. rc=%Rrc\n",
553 cb, pUsbDev->pReg->szName, rc));
554 CFGMR3RemoveNode(pInstanceToDelete);
555 return rc;
556 }
557
558 /*
559 * Initialize it.
560 */
561 pUsbIns->u32Version = PDM_USBINS_VERSION;
562 //pUsbIns->Internal.s.pNext = NULL;
563 //pUsbIns->Internal.s.pPerDeviceNext = NULL;
564 pUsbIns->Internal.s.pUsbDev = pUsbDev;
565 pUsbIns->Internal.s.pVM = pVM;
566 //pUsbIns->Internal.s.pLuns = NULL;
567 pUsbIns->Internal.s.pCfg = pInstanceNode;
568 pUsbIns->Internal.s.pCfgDelete = pInstanceToDelete;
569 pUsbIns->Internal.s.pCfgGlobal = pGlobalConfig;
570 pUsbIns->Internal.s.Uuid = *pUuid;
571 //pUsbIns->Internal.s.pHub = NULL;
572 pUsbIns->Internal.s.iPort = UINT32_MAX; /* to be determined. */
573 pUsbIns->Internal.s.fVMSuspended = true;
574 //pUsbIns->Internal.s.pfnAsyncNotify = NULL;
575 pUsbIns->pHlpR3 = &g_pdmR3UsbHlp;
576 pUsbIns->pReg = pUsbDev->pReg;
577 pUsbIns->pCfg = pConfig;
578 pUsbIns->pCfgGlobal = pGlobalConfig;
579 pUsbIns->iInstance = iInstance;
580 pUsbIns->pvInstanceDataR3 = &pUsbIns->achInstanceData[0];
581 pUsbIns->pszName = RTStrDup(pUsbDev->pReg->szName);
582 //pUsbIns->fTracing = 0;
583 pUsbIns->idTracing = ++pVM->pdm.s.idTracingOther;
584 pUsbIns->iUsbHubVersion = iUsbVersion;
585
586 /*
587 * Link it into all the lists.
588 */
589 /* The global instance FIFO. */
590 PPDMUSBINS pPrev1 = pVM->pdm.s.pUsbInstances;
591 if (!pPrev1)
592 pVM->pdm.s.pUsbInstances = pUsbIns;
593 else
594 {
595 while (pPrev1->Internal.s.pNext)
596 {
597 Assert(pPrev1->u32Version == PDM_USBINS_VERSION);
598 pPrev1 = pPrev1->Internal.s.pNext;
599 }
600 pPrev1->Internal.s.pNext = pUsbIns;
601 }
602
603 /* The per device instance FIFO. */
604 PPDMUSBINS pPrev2 = pUsbDev->pInstances;
605 if (!pPrev2)
606 pUsbDev->pInstances = pUsbIns;
607 else
608 {
609 while (pPrev2->Internal.s.pPerDeviceNext)
610 {
611 Assert(pPrev2->u32Version == PDM_USBINS_VERSION);
612 pPrev2 = pPrev2->Internal.s.pPerDeviceNext;
613 }
614 pPrev2->Internal.s.pPerDeviceNext = pUsbIns;
615 }
616
617 /*
618 * Call the constructor.
619 */
620 Log(("PDM: Constructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
621 rc = pUsbIns->pReg->pfnConstruct(pUsbIns, pUsbIns->iInstance, pUsbIns->pCfg, pUsbIns->pCfgGlobal);
622 if (RT_SUCCESS(rc))
623 {
624 /*
625 * Attach it to the hub.
626 */
627 Log(("PDM: Attaching it...\n"));
628 rc = pHub->Reg.pfnAttachDevice(pHub->pDrvIns, pUsbIns, &pUsbIns->Internal.s.iPort);
629 if (RT_SUCCESS(rc))
630 {
631 pHub->cAvailablePorts--;
632 Assert((int32_t)pHub->cAvailablePorts >= 0 && pHub->cAvailablePorts < pHub->cPorts);
633 pUsbIns->Internal.s.pHub = pHub;
634
635 /* Send the hot-plugged notification if applicable. */
636 if (fAtRuntime && pUsbIns->pReg->pfnHotPlugged)
637 pUsbIns->pReg->pfnHotPlugged(pUsbIns);
638
639 Log(("PDM: Successfully attached USB device '%s' instance %d to hub %p\n",
640 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub));
641 return VINF_SUCCESS;
642 }
643
644 LogRel(("PDM: Failed to attach USB device '%s' instance %d to hub %p: %Rrc\n",
645 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
646 }
647 else
648 {
649 AssertMsgFailed(("Failed to construct '%s'/%d! %Rra\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
650 if (rc == VERR_VERSION_MISMATCH)
651 rc = VERR_PDM_DRIVER_VERSION_MISMATCH;
652 }
653 if (fAtRuntime)
654 pdmR3UsbDestroyDevice(pVM, pUsbIns);
655 /* else: destructors are invoked later. */
656 return rc;
657}
658
659
660/**
661 * Instantiate USB devices.
662 *
663 * This is called by pdmR3DevInit() after it has instantiated the
664 * other devices and their drivers. If there aren't any hubs
665 * around, we'll silently skip the USB devices.
666 *
667 * @returns VBox status code.
668 * @param pVM
669 */
670int pdmR3UsbInstantiateDevices(PVM pVM)
671{
672 /*
673 * Any hubs?
674 */
675 if (!pVM->pdm.s.pUsbHubs)
676 {
677 Log(("PDM: No USB hubs, skipping USB device instantiation.\n"));
678 return VINF_SUCCESS;
679 }
680
681 /*
682 * Count the device instances.
683 */
684 PCFGMNODE pCur;
685 PCFGMNODE pUsbNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "USB/");
686 PCFGMNODE pInstanceNode;
687 unsigned cUsbDevs = 0;
688 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
689 {
690 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
691 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
692 if (pInstanceNode != pGlobal)
693 cUsbDevs++;
694 }
695 if (!cUsbDevs)
696 {
697 Log(("PDM: No USB devices were configured!\n"));
698 return VINF_SUCCESS;
699 }
700 Log2(("PDM: cUsbDevs=%d!\n", cUsbDevs));
701
702 /*
703 * Collect info on each USB device instance.
704 */
705 struct USBDEVORDER
706 {
707 /** Configuration node. */
708 PCFGMNODE pNode;
709 /** Pointer to the USB device. */
710 PPDMUSB pUsbDev;
711 /** Init order. */
712 uint32_t u32Order;
713 /** VBox instance number. */
714 uint32_t iInstance;
715 } *paUsbDevs = (struct USBDEVORDER *)alloca(sizeof(paUsbDevs[0]) * (cUsbDevs + 1)); /* (One extra for swapping) */
716 Assert(paUsbDevs);
717 int rc;
718 unsigned i = 0;
719 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
720 {
721 /* Get the device name. */
722 char szName[sizeof(paUsbDevs[0].pUsbDev->pReg->szName)];
723 rc = CFGMR3GetName(pCur, szName, sizeof(szName));
724 AssertMsgRCReturn(rc, ("Configuration error: device name is too long (or something)! rc=%Rrc\n", rc), rc);
725
726 /* Find the device. */
727 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, szName);
728 AssertMsgReturn(pUsbDev, ("Configuration error: device '%s' not found!\n", szName), VERR_PDM_DEVICE_NOT_FOUND);
729
730 /* Configured priority or use default? */
731 uint32_t u32Order;
732 rc = CFGMR3QueryU32(pCur, "Priority", &u32Order);
733 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
734 u32Order = i << 4;
735 else
736 AssertMsgRCReturn(rc, ("Configuration error: reading \"Priority\" for the '%s' USB device failed rc=%Rrc!\n", szName, rc), rc);
737
738 /* Global config. */
739 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
740 if (!pGlobal)
741 {
742 rc = CFGMR3InsertNode(pCur, "GlobalConfig/", &pGlobal);
743 AssertMsgRCReturn(rc, ("Failed to create GlobalConfig node! rc=%Rrc\n", rc), rc);
744 CFGMR3SetRestrictedRoot(pGlobal);
745 }
746
747 /* Enumerate the device instances. */
748 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
749 {
750 if (pInstanceNode == pGlobal)
751 continue;
752
753 paUsbDevs[i].pNode = pInstanceNode;
754 paUsbDevs[i].pUsbDev = pUsbDev;
755 paUsbDevs[i].u32Order = u32Order;
756
757 /* Get the instance number. */
758 char szInstance[32];
759 rc = CFGMR3GetName(pInstanceNode, szInstance, sizeof(szInstance));
760 AssertMsgRCReturn(rc, ("Configuration error: instance name is too long (or something)! rc=%Rrc\n", rc), rc);
761 char *pszNext = NULL;
762 rc = RTStrToUInt32Ex(szInstance, &pszNext, 0, &paUsbDevs[i].iInstance);
763 AssertMsgRCReturn(rc, ("Configuration error: RTStrToInt32Ex failed on the instance name '%s'! rc=%Rrc\n", szInstance, rc), rc);
764 AssertMsgReturn(!*pszNext, ("Configuration error: the instance name '%s' isn't all digits. (%s)\n", szInstance, pszNext), VERR_INVALID_PARAMETER);
765
766 /* next instance */
767 i++;
768 }
769 } /* devices */
770 Assert(i == cUsbDevs);
771
772 /*
773 * Sort the device array ascending on u32Order. (bubble)
774 */
775 unsigned c = cUsbDevs - 1;
776 while (c)
777 {
778 unsigned j = 0;
779 for (i = 0; i < c; i++)
780 if (paUsbDevs[i].u32Order > paUsbDevs[i + 1].u32Order)
781 {
782 paUsbDevs[cUsbDevs] = paUsbDevs[i + 1];
783 paUsbDevs[i + 1] = paUsbDevs[i];
784 paUsbDevs[i] = paUsbDevs[cUsbDevs];
785 j = i;
786 }
787 c = j;
788 }
789
790 /*
791 * Instantiate the devices.
792 */
793 for (i = 0; i < cUsbDevs; i++)
794 {
795 /*
796 * Make sure there is a config node and mark it as restricted.
797 */
798 PCFGMNODE pConfigNode = CFGMR3GetChild(paUsbDevs[i].pNode, "Config/");
799 if (!pConfigNode)
800 {
801 rc = CFGMR3InsertNode(paUsbDevs[i].pNode, "Config", &pConfigNode);
802 AssertMsgRCReturn(rc, ("Failed to create Config node! rc=%Rrc\n", rc), rc);
803 }
804 CFGMR3SetRestrictedRoot(pConfigNode);
805
806 /*
807 * Every device must support USB 1.x hubs; optionally, high-speed USB 2.0 hubs
808 * might be also supported. This determines where to attach the device.
809 */
810 uint32_t iUsbVersion = VUSB_STDVER_11;
811
812 if (paUsbDevs[i].pUsbDev->pReg->fFlags & PDM_USBREG_HIGHSPEED_CAPABLE)
813 iUsbVersion |= VUSB_STDVER_20;
814
815 /*
816 * Find a suitable hub with free ports.
817 */
818 PPDMUSBHUB pHub;
819 rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
820 if (RT_FAILURE(rc))
821 {
822 Log(("pdmR3UsbFindHub failed %Rrc\n", rc));
823 return rc;
824 }
825
826 /*
827 * This is how we inform the device what speed it's communicating at, and hence
828 * which descriptors it should present to the guest.
829 */
830 iUsbVersion &= pHub->fVersions;
831
832 /*
833 * Create and attach the device.
834 */
835 RTUUID Uuid;
836 rc = RTUuidCreate(&Uuid);
837 AssertRCReturn(rc, rc);
838 rc = pdmR3UsbCreateDevice(pVM, pHub, paUsbDevs[i].pUsbDev, paUsbDevs[i].iInstance, &Uuid, &paUsbDevs[i].pNode, iUsbVersion);
839 if (RT_FAILURE(rc))
840 return rc;
841 } /* for device instances */
842
843 return VINF_SUCCESS;
844}
845
846
847/**
848 * Creates an emulated USB device instance at runtime.
849 *
850 * This will find an appropriate HUB for the USB device
851 * and try instantiate the emulated device.
852 *
853 * @returns VBox status code.
854 * @param pUVM The user mode VM handle.
855 * @param pszDeviceName The name of the PDM device to instantiate.
856 * @param pInstanceNode The instance CFGM node.
857 * @param pUuid Where to store the UUID of the created device.
858 *
859 * @thread EMT
860 */
861VMMR3DECL(int) PDMR3UsbCreateEmulatedDevice(PUVM pUVM, const char *pszDeviceName, PCFGMNODE pInstanceNode, PRTUUID pUuid)
862{
863 /*
864 * Validate input.
865 */
866 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
867 PVM pVM = pUVM->pVM;
868 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
869 VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
870 AssertPtrReturn(pszDeviceName, VERR_INVALID_POINTER);
871 AssertPtrReturn(pInstanceNode, VERR_INVALID_POINTER);
872
873 /*
874 * Find the device.
875 */
876 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, pszDeviceName);
877 if (!pUsbDev)
878 {
879 LogRel(("PDMR3UsbCreateEmulatedDevice: The '%s' device wasn't found\n", pszDeviceName));
880 return VERR_PDM_NO_USBPROXY;
881 }
882
883 /*
884 * Every device must support USB 1.x hubs; optionally, high-speed USB 2.0 hubs
885 * might be also supported. This determines where to attach the device.
886 */
887 uint32_t iUsbVersion = VUSB_STDVER_11;
888 if (pUsbDev->pReg->fFlags & PDM_USBREG_HIGHSPEED_CAPABLE)
889 iUsbVersion |= VUSB_STDVER_20;
890
891 /*
892 * Find a suitable hub with free ports.
893 */
894 PPDMUSBHUB pHub;
895 int rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
896 if (RT_FAILURE(rc))
897 {
898 Log(("pdmR3UsbFindHub: failed %Rrc\n", rc));
899 return rc;
900 }
901
902 /*
903 * This is how we inform the device what speed it's communicating at, and hence
904 * which descriptors it should present to the guest.
905 */
906 iUsbVersion &= pHub->fVersions;
907
908 /*
909 * Create and attach the device.
910 */
911 rc = RTUuidCreate(pUuid);
912 AssertRCReturn(rc, rc);
913
914 rc = pdmR3UsbCreateDevice(pVM, pHub, pUsbDev, -1, pUuid, &pInstanceNode, iUsbVersion);
915 AssertRCReturn(rc, rc);
916
917 return rc;
918}
919
920
921/**
922 * Creates a USB proxy device instance.
923 *
924 * This will find an appropriate HUB for the USB device, create the necessary CFGM stuff
925 * and try instantiate the proxy device.
926 *
927 * @returns VBox status code.
928 * @param pUVM The user mode VM handle.
929 * @param pUuid The UUID to be associated with the device.
930 * @param fRemote Whether it's a remove or local device.
931 * @param pszAddress The address string.
932 * @param pvBackend Pointer to the backend.
933 * @param iUsbVersion The preferred USB version.
934 * @param fMaskedIfs The interfaces to hide from the guest.
935 */
936VMMR3DECL(int) PDMR3UsbCreateProxyDevice(PUVM pUVM, PCRTUUID pUuid, bool fRemote, const char *pszAddress, void *pvBackend,
937 uint32_t iUsbVersion, uint32_t fMaskedIfs)
938{
939 /*
940 * Validate input.
941 */
942 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
943 PVM pVM = pUVM->pVM;
944 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
945 VM_ASSERT_EMT_RETURN(pVM, VERR_VM_THREAD_NOT_EMT);
946 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
947 AssertPtrReturn(pszAddress, VERR_INVALID_POINTER);
948 AssertReturn( iUsbVersion == VUSB_STDVER_20
949 || iUsbVersion == VUSB_STDVER_11, VERR_INVALID_PARAMETER);
950
951 /*
952 * Find the USBProxy driver.
953 */
954 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, "USBProxy");
955 if (!pUsbDev)
956 {
957 LogRel(("PDMR3UsbCreateProxyDevice: The USBProxy device class wasn't found\n"));
958 return VERR_PDM_NO_USBPROXY;
959 }
960
961 /*
962 * Find a suitable hub with free ports.
963 */
964 PPDMUSBHUB pHub;
965 int rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
966 if (RT_FAILURE(rc))
967 {
968 Log(("pdmR3UsbFindHub: failed %Rrc\n", rc));
969 return rc;
970 }
971
972 /*
973 * Create the CFGM instance node.
974 */
975 PCFGMNODE pInstance = CFGMR3CreateTree(pUVM);
976 AssertReturn(pInstance, VERR_NO_MEMORY);
977 do /* break loop */
978 {
979 PCFGMNODE pConfig;
980 rc = CFGMR3InsertNode(pInstance, "Config", &pConfig); AssertRCBreak(rc);
981 rc = CFGMR3InsertString(pConfig, "Address", pszAddress); AssertRCBreak(rc);
982 char szUuid[RTUUID_STR_LENGTH];
983 rc = RTUuidToStr(pUuid, &szUuid[0], sizeof(szUuid)); AssertRCBreak(rc);
984 rc = CFGMR3InsertString(pConfig, "UUID", szUuid); AssertRCBreak(rc);
985 rc = CFGMR3InsertInteger(pConfig, "Remote", fRemote); AssertRCBreak(rc);
986 rc = CFGMR3InsertInteger(pConfig, "USBVersion", iUsbVersion); AssertRCBreak(rc);
987 rc = CFGMR3InsertInteger(pConfig, "pvBackend", (uintptr_t)pvBackend); AssertRCBreak(rc);
988 rc = CFGMR3InsertInteger(pConfig, "MaskedIfs", fMaskedIfs); AssertRCBreak(rc);
989 rc = CFGMR3InsertInteger(pConfig, "Force11Device", !(pHub->fVersions & iUsbVersion)); AssertRCBreak(rc);
990 } while (0); /* break loop */
991 if (RT_FAILURE(rc))
992 {
993 CFGMR3RemoveNode(pInstance);
994 LogRel(("PDMR3UsbCreateProxyDevice: failed to setup CFGM config, rc=%Rrc\n", rc));
995 return rc;
996 }
997
998 /*
999 * Finally, try to create it.
1000 */
1001 rc = pdmR3UsbCreateDevice(pVM, pHub, pUsbDev, -1, pUuid, &pInstance, iUsbVersion);
1002 if (RT_FAILURE(rc) && pInstance)
1003 CFGMR3RemoveNode(pInstance);
1004 return rc;
1005}
1006
1007
1008/**
1009 * Destroys a hot-plugged USB device.
1010 *
1011 * The device must be detached from the HUB at this point.
1012 *
1013 * @param pVM Pointer to the VM.
1014 * @param pUsbIns The USB device instance to destroy.
1015 * @thread EMT
1016 */
1017static void pdmR3UsbDestroyDevice(PVM pVM, PPDMUSBINS pUsbIns)
1018{
1019 Assert(!pUsbIns->Internal.s.pHub);
1020
1021 /*
1022 * Do the unplug notification.
1023 */
1024 /** @todo what about the drivers? */
1025 if (pUsbIns->pReg->pfnHotUnplugged)
1026 pUsbIns->pReg->pfnHotUnplugged(pUsbIns);
1027
1028 /*
1029 * Destroy the luns with their driver chains and call the device destructor.
1030 */
1031 while (pUsbIns->Internal.s.pLuns)
1032 {
1033 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
1034 pUsbIns->Internal.s.pLuns = pLun->pNext;
1035 if (pLun->pTop)
1036 pdmR3DrvDestroyChain(pLun->pTop, PDM_TACH_FLAGS_NOT_HOT_PLUG); /* Hotplugging is handled differently here atm. */
1037 MMR3HeapFree(pLun);
1038 }
1039
1040 /* finally, the device. */
1041 if (pUsbIns->pReg->pfnDestruct)
1042 {
1043 Log(("PDM: Destructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1044 pUsbIns->pReg->pfnDestruct(pUsbIns);
1045 }
1046 TMR3TimerDestroyUsb(pVM, pUsbIns);
1047 //SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
1048 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
1049#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1050 pdmR3AsyncCompletionTemplateDestroyUsb(pVM, pUsbIns);
1051#endif
1052
1053 /*
1054 * Unlink it.
1055 */
1056 /* The global instance FIFO. */
1057 if (pVM->pdm.s.pUsbInstances == pUsbIns)
1058 pVM->pdm.s.pUsbInstances = pUsbIns->Internal.s.pNext;
1059 else
1060 {
1061 PPDMUSBINS pPrev = pVM->pdm.s.pUsbInstances;
1062 while (pPrev && pPrev->Internal.s.pNext != pUsbIns)
1063 {
1064 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
1065 pPrev = pPrev->Internal.s.pNext;
1066 }
1067 Assert(pPrev); Assert(pPrev != pUsbIns);
1068 if (pPrev)
1069 pPrev->Internal.s.pNext = pUsbIns->Internal.s.pNext;
1070 }
1071
1072 /* The per device instance FIFO. */
1073 PPDMUSB pUsbDev = pUsbIns->Internal.s.pUsbDev;
1074 if (pUsbDev->pInstances == pUsbIns)
1075 pUsbDev->pInstances = pUsbIns->Internal.s.pPerDeviceNext;
1076 else
1077 {
1078 PPDMUSBINS pPrev = pUsbDev->pInstances;
1079 while (pPrev && pPrev->Internal.s.pPerDeviceNext != pUsbIns)
1080 {
1081 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
1082 pPrev = pPrev->Internal.s.pPerDeviceNext;
1083 }
1084 Assert(pPrev); Assert(pPrev != pUsbIns);
1085 if (pPrev)
1086 pPrev->Internal.s.pPerDeviceNext = pUsbIns->Internal.s.pPerDeviceNext;
1087 }
1088
1089 /*
1090 * Trash it.
1091 */
1092 pUsbIns->u32Version = 0;
1093 pUsbIns->pReg = NULL;
1094 if (pUsbIns->pszName)
1095 {
1096 RTStrFree(pUsbIns->pszName);
1097 pUsbIns->pszName = NULL;
1098 }
1099 CFGMR3RemoveNode(pUsbIns->Internal.s.pCfgDelete);
1100 MMR3HeapFree(pUsbIns);
1101}
1102
1103
1104/**
1105 * Detaches and destroys a USB device.
1106 *
1107 * @returns VBox status code.
1108 * @param pUVM The user mode VM handle.
1109 * @param pUuid The UUID associated with the device to detach.
1110 * @thread EMT
1111 */
1112VMMR3DECL(int) PDMR3UsbDetachDevice(PUVM pUVM, PCRTUUID pUuid)
1113{
1114 /*
1115 * Validate input.
1116 */
1117 UVM_ASSERT_VALID_EXT_RETURN(pUVM, VERR_INVALID_VM_HANDLE);
1118 PVM pVM = pUVM->pVM;
1119 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
1120 VM_ASSERT_EMT(pVM);
1121 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
1122
1123 /*
1124 * Search the global list for it.
1125 */
1126 PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances;
1127 for ( ; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1128 if (!RTUuidCompare(&pUsbIns->Internal.s.Uuid, pUuid))
1129 break;
1130 if (!pUsbIns)
1131 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND; /** @todo VERR_PDM_USB_INSTANCE_NOT_FOUND */
1132
1133 /*
1134 * Detach it from the HUB (if it's actually attached to one).
1135 */
1136 PPDMUSBHUB pHub = pUsbIns->Internal.s.pHub;
1137 if (pHub)
1138 {
1139 int rc = pHub->Reg.pfnDetachDevice(pHub->pDrvIns, pUsbIns, pUsbIns->Internal.s.iPort);
1140 if (RT_FAILURE(rc))
1141 {
1142 LogRel(("PDM: Failed to detach USB device '%s' instance %d from %p: %Rrc\n",
1143 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
1144 return rc;
1145 }
1146
1147 pHub->cAvailablePorts++;
1148 Assert(pHub->cAvailablePorts > 0 && pHub->cAvailablePorts <= pHub->cPorts);
1149 pUsbIns->Internal.s.pHub = NULL;
1150 }
1151
1152 /*
1153 * Notify about unplugging and destroy the device with it's drivers.
1154 */
1155 pdmR3UsbDestroyDevice(pVM, pUsbIns);
1156
1157 return VINF_SUCCESS;
1158}
1159
1160
1161/**
1162 * Checks if there are any USB hubs attached.
1163 *
1164 * @returns true / false accordingly.
1165 * @param pUVM The user mode VM handle.
1166 */
1167VMMR3DECL(bool) PDMR3UsbHasHub(PUVM pUVM)
1168{
1169 UVM_ASSERT_VALID_EXT_RETURN(pUVM, false);
1170 PVM pVM = pUVM->pVM;
1171 VM_ASSERT_VALID_EXT_RETURN(pVM, false);
1172 return pVM->pdm.s.pUsbHubs != NULL;
1173}
1174
1175
1176/** @name USB Device Helpers
1177 * @{
1178 */
1179
1180/** @interface_method_impl{PDMUSBHLPR3,pfnDriverAttach} */
1181static DECLCALLBACK(int) pdmR3UsbHlp_DriverAttach(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface,
1182 PPDMIBASE *ppBaseInterface, const char *pszDesc)
1183{
1184 PDMUSB_ASSERT_USBINS(pUsbIns);
1185 PVM pVM = pUsbIns->Internal.s.pVM;
1186 VM_ASSERT_EMT(pVM);
1187 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: iLun=%d pBaseInterface=%p ppBaseInterface=%p pszDesc=%p:{%s}\n",
1188 pUsbIns->pReg->szName, pUsbIns->iInstance, iLun, pBaseInterface, ppBaseInterface, pszDesc, pszDesc));
1189
1190 /*
1191 * Lookup the LUN, it might already be registered.
1192 */
1193 PPDMLUN pLunPrev = NULL;
1194 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
1195 for (; pLun; pLunPrev = pLun, pLun = pLun->pNext)
1196 if (pLun->iLun == iLun)
1197 break;
1198
1199 /*
1200 * Create the LUN if if wasn't found, else check if driver is already attached to it.
1201 */
1202 if (!pLun)
1203 {
1204 if ( !pBaseInterface
1205 || !pszDesc
1206 || !*pszDesc)
1207 {
1208 Assert(pBaseInterface);
1209 Assert(pszDesc || *pszDesc);
1210 return VERR_INVALID_PARAMETER;
1211 }
1212
1213 pLun = (PPDMLUN)MMR3HeapAlloc(pVM, MM_TAG_PDM_LUN, sizeof(*pLun));
1214 if (!pLun)
1215 return VERR_NO_MEMORY;
1216
1217 pLun->iLun = iLun;
1218 pLun->pNext = pLunPrev ? pLunPrev->pNext : NULL;
1219 pLun->pTop = NULL;
1220 pLun->pBottom = NULL;
1221 pLun->pDevIns = NULL;
1222 pLun->pUsbIns = pUsbIns;
1223 pLun->pszDesc = pszDesc;
1224 pLun->pBase = pBaseInterface;
1225 if (!pLunPrev)
1226 pUsbIns->Internal.s.pLuns = pLun;
1227 else
1228 pLunPrev->pNext = pLun;
1229 Log(("pdmR3UsbHlp_DriverAttach: Registered LUN#%d '%s' with device '%s'/%d.\n",
1230 iLun, pszDesc, pUsbIns->pReg->szName, pUsbIns->iInstance));
1231 }
1232 else if (pLun->pTop)
1233 {
1234 AssertMsgFailed(("Already attached! The device should keep track of such things!\n"));
1235 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, VERR_PDM_DRIVER_ALREADY_ATTACHED));
1236 return VERR_PDM_DRIVER_ALREADY_ATTACHED;
1237 }
1238 Assert(pLun->pBase == pBaseInterface);
1239
1240
1241 /*
1242 * Get the attached driver configuration.
1243 */
1244 int rc;
1245 PCFGMNODE pNode = CFGMR3GetChildF(pUsbIns->Internal.s.pCfg, "LUN#%u", iLun);
1246 if (pNode)
1247 rc = pdmR3DrvInstantiate(pVM, pNode, pBaseInterface, NULL /*pDrvAbove*/, pLun, ppBaseInterface);
1248 else
1249 rc = VERR_PDM_NO_ATTACHED_DRIVER;
1250
1251
1252 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1253 return rc;
1254}
1255
1256
1257/** @interface_method_impl{PDMUSBHLP,pfnAssertEMT} */
1258static DECLCALLBACK(bool) pdmR3UsbHlp_AssertEMT(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1259{
1260 PDMUSB_ASSERT_USBINS(pUsbIns);
1261 if (VM_IS_EMT(pUsbIns->Internal.s.pVM))
1262 return true;
1263
1264 char szMsg[100];
1265 RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1266 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1267 AssertBreakpoint();
1268 return false;
1269}
1270
1271
1272/** @interface_method_impl{PDMUSBHLP,pfnAssertOther} */
1273static DECLCALLBACK(bool) pdmR3UsbHlp_AssertOther(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1274{
1275 PDMUSB_ASSERT_USBINS(pUsbIns);
1276 if (!VM_IS_EMT(pUsbIns->Internal.s.pVM))
1277 return true;
1278
1279 char szMsg[100];
1280 RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1281 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1282 AssertBreakpoint();
1283 return false;
1284}
1285
1286
1287/** @interface_method_impl{PDMUSBHLP,pfnDBGFStopV} */
1288static DECLCALLBACK(int) pdmR3UsbHlp_DBGFStopV(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction, const char *pszFormat, va_list args)
1289{
1290 PDMUSB_ASSERT_USBINS(pUsbIns);
1291#ifdef LOG_ENABLED
1292 va_list va2;
1293 va_copy(va2, args);
1294 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: pszFile=%p:{%s} iLine=%d pszFunction=%p:{%s} pszFormat=%p:{%s} (%N)\n",
1295 pUsbIns->pReg->szName, pUsbIns->iInstance, pszFile, pszFile, iLine, pszFunction, pszFunction, pszFormat, pszFormat, pszFormat, &va2));
1296 va_end(va2);
1297#endif
1298
1299 PVM pVM = pUsbIns->Internal.s.pVM;
1300 VM_ASSERT_EMT(pVM);
1301 int rc = DBGFR3EventSrcV(pVM, DBGFEVENT_DEV_STOP, pszFile, iLine, pszFunction, pszFormat, args);
1302 if (rc == VERR_DBGF_NOT_ATTACHED)
1303 rc = VINF_SUCCESS;
1304
1305 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1306 return rc;
1307}
1308
1309
1310/** @interface_method_impl{PDMUSBHLP,pfnDBGFInfoRegister} */
1311static DECLCALLBACK(int) pdmR3UsbHlp_DBGFInfoRegister(PPDMUSBINS pUsbIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERUSB pfnHandler)
1312{
1313 PDMUSB_ASSERT_USBINS(pUsbIns);
1314 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: pszName=%p:{%s} pszDesc=%p:{%s} pfnHandler=%p\n",
1315 pUsbIns->pReg->szName, pUsbIns->iInstance, pszName, pszName, pszDesc, pszDesc, pfnHandler));
1316
1317 PVM pVM = pUsbIns->Internal.s.pVM;
1318 VM_ASSERT_EMT(pVM);
1319 NOREF(pVM); /** @todo int rc = DBGFR3InfoRegisterUsb(pVM, pszName, pszDesc, pfnHandler, pUsbIns); */
1320 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1321
1322 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1323 return rc;
1324}
1325
1326
1327/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAlloc} */
1328static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAlloc(PPDMUSBINS pUsbIns, size_t cb)
1329{
1330 PDMUSB_ASSERT_USBINS(pUsbIns);
1331 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1332
1333 void *pv = MMR3HeapAlloc(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1334
1335 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1336 return pv;
1337}
1338
1339
1340/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAllocZ} */
1341static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAllocZ(PPDMUSBINS pUsbIns, size_t cb)
1342{
1343 PDMUSB_ASSERT_USBINS(pUsbIns);
1344 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1345
1346 void *pv = MMR3HeapAllocZ(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1347
1348 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1349 return pv;
1350}
1351
1352
1353/** @interface_method_impl{PDMUSBHLP,pfnPDMQueueCreate} */
1354static DECLCALLBACK(int) pdmR3UsbHlp_PDMQueueCreate(PPDMUSBINS pUsbIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval,
1355 PFNPDMQUEUEUSB pfnCallback, const char *pszName, PPDMQUEUE *ppQueue)
1356{
1357 PDMUSB_ASSERT_USBINS(pUsbIns);
1358 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%#x cItems=%#x cMilliesInterval=%u pfnCallback=%p pszName=%p:{%s} ppQueue=%p\n",
1359 pUsbIns->pReg->szName, pUsbIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, pszName, ppQueue));
1360
1361 PVM pVM = pUsbIns->Internal.s.pVM;
1362 VM_ASSERT_EMT(pVM);
1363
1364 if (pUsbIns->iInstance > 0)
1365 {
1366 pszName = MMR3HeapAPrintf(pVM, MM_TAG_PDM_DEVICE_DESC, "%s_%u", pszName, pUsbIns->iInstance);
1367 AssertLogRelReturn(pszName, VERR_NO_MEMORY);
1368 }
1369
1370 /** @todo int rc = PDMR3QueueCreateUsb(pVM, pUsbIns, cbItem, cItems, cMilliesInterval, pfnCallback, fGCEnabled, pszName, ppQueue); */
1371 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1372
1373 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: returns %Rrc *ppQueue=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc, *ppQueue));
1374 return rc;
1375}
1376
1377
1378/** @interface_method_impl{PDMUSBHLP,pfnSSMRegister} */
1379static DECLCALLBACK(int) pdmR3UsbHlp_SSMRegister(PPDMUSBINS pUsbIns, uint32_t uVersion, size_t cbGuess,
1380 PFNSSMUSBLIVEPREP pfnLivePrep, PFNSSMUSBLIVEEXEC pfnLiveExec, PFNSSMUSBLIVEVOTE pfnLiveVote,
1381 PFNSSMUSBSAVEPREP pfnSavePrep, PFNSSMUSBSAVEEXEC pfnSaveExec, PFNSSMUSBSAVEDONE pfnSaveDone,
1382 PFNSSMUSBLOADPREP pfnLoadPrep, PFNSSMUSBLOADEXEC pfnLoadExec, PFNSSMUSBLOADDONE pfnLoadDone)
1383{
1384 PDMUSB_ASSERT_USBINS(pUsbIns);
1385 VM_ASSERT_EMT(pUsbIns->Internal.s.pVM);
1386 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: uVersion=#x cbGuess=%#x\n"
1387 " pfnLivePrep=%p pfnLiveExec=%p pfnLiveVote=%p pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoadDone=%p\n",
1388 pUsbIns->pReg->szName, pUsbIns->iInstance, uVersion, cbGuess,
1389 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1390 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1391 pfnLoadPrep, pfnLoadExec, pfnLoadDone));
1392
1393 /** @todo
1394 int rc = SSMR3RegisterUsb(pUsbIns->Internal.s.pVM, pUsbIns, pUsbIns->pReg->szName, pUsbIns->iInstance,
1395 uVersion, cbGuess,
1396 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1397 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1398 pfnLoadPrep, pfnLoadExec, pfnLoadDone); */
1399 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1400
1401 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1402 return rc;
1403}
1404
1405
1406/** @interface_method_impl{PDMUSBHLP,pfnSTAMRegisterV} */
1407static DECLCALLBACK(void) pdmR3UsbHlp_STAMRegisterV(PPDMUSBINS pUsbIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1408 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list args)
1409{
1410 PDMUSB_ASSERT_USBINS(pUsbIns);
1411 PVM pVM = pUsbIns->Internal.s.pVM;
1412 VM_ASSERT_EMT(pVM);
1413
1414 int rc = STAMR3RegisterV(pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1415 AssertRC(rc);
1416
1417 NOREF(pVM);
1418}
1419
1420
1421/** @interface_method_impl{PDMUSBHLP,pfnTMTimerCreate} */
1422static DECLCALLBACK(int) pdmR3UsbHlp_TMTimerCreate(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
1423 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1424{
1425 PDMUSB_ASSERT_USBINS(pUsbIns);
1426 PVM pVM = pUsbIns->Internal.s.pVM;
1427 VM_ASSERT_EMT(pVM);
1428 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pvUser=%p fFlags=%#x pszDesc=%p:{%s} ppTimer=%p\n",
1429 pUsbIns->pReg->szName, pUsbIns->iInstance, enmClock, pfnCallback, pvUser, fFlags, pszDesc, pszDesc, ppTimer));
1430
1431 if (pUsbIns->iInstance > 0) /** @todo use a string cache here later. */
1432 {
1433 char *pszDesc2 = MMR3HeapAPrintf(pVM, MM_TAG_PDM_USB_DESC, "%s [%u]", pszDesc, pUsbIns->iInstance);
1434 if (pszDesc2)
1435 pszDesc = pszDesc2;
1436 }
1437
1438 int rc = TMR3TimerCreateUsb(pVM, pUsbIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
1439
1440 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1441 return rc;
1442}
1443
1444
1445/** @interface_method_impl{PDMUSBHLP,pfnVMSetErrorV} */
1446static DECLCALLBACK(int) pdmR3UsbHlp_VMSetErrorV(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
1447{
1448 PDMUSB_ASSERT_USBINS(pUsbIns);
1449 int rc2 = VMSetErrorV(pUsbIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
1450 return rc;
1451}
1452
1453
1454/** @interface_method_impl{PDMUSBHLP,pfnVMSetRuntimeErrorV} */
1455static DECLCALLBACK(int) pdmR3UsbHlp_VMSetRuntimeErrorV(PPDMUSBINS pUsbIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va)
1456{
1457 PDMUSB_ASSERT_USBINS(pUsbIns);
1458 int rc = VMSetRuntimeErrorV(pUsbIns->Internal.s.pVM, fFlags, pszErrorId, pszFormat, va);
1459 return rc;
1460}
1461
1462
1463/** @interface_method_impl{PDMUSBHLP,pfnVMState} */
1464static DECLCALLBACK(VMSTATE) pdmR3UsbHlp_VMState(PPDMUSBINS pUsbIns)
1465{
1466 PDMUSB_ASSERT_USBINS(pUsbIns);
1467
1468 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1469
1470 LogFlow(("pdmR3UsbHlp_VMState: caller='%s'/%d: returns %d (%s)\n", pUsbIns->pReg->szName, pUsbIns->iInstance,
1471 enmVMState, VMR3GetStateName(enmVMState)));
1472 return enmVMState;
1473}
1474
1475/** @interface_method_impl{PDMUSBHLP,pfnThreadCreate} */
1476static DECLCALLBACK(int) pdmR3UsbHlp_ThreadCreate(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
1477 PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1478{
1479 PDMUSB_ASSERT_USBINS(pUsbIns);
1480 VM_ASSERT_EMT(pUsbIns->Internal.s.pVM);
1481 LogFlow(("pdmR3UsbHlp_ThreadCreate: caller='%s'/%d: ppThread=%p pvUser=%p pfnThread=%p pfnWakeup=%p cbStack=%#zx enmType=%d pszName=%p:{%s}\n",
1482 pUsbIns->pReg->szName, pUsbIns->iInstance, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName, pszName));
1483
1484 int rc = pdmR3ThreadCreateUsb(pUsbIns->Internal.s.pVM, pUsbIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1485
1486 LogFlow(("pdmR3UsbHlp_ThreadCreate: caller='%s'/%d: returns %Rrc *ppThread=%RTthrd\n", pUsbIns->pReg->szName, pUsbIns->iInstance,
1487 rc, *ppThread));
1488 return rc;
1489}
1490
1491
1492/** @interface_method_impl{PDMUSBHLP,pfnSetAsyncNotification} */
1493static DECLCALLBACK(int) pdmR3UsbHlp_SetAsyncNotification(PPDMUSBINS pUsbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify)
1494{
1495 PDMUSB_ASSERT_USBINS(pUsbIns);
1496 VM_ASSERT_EMT0(pUsbIns->Internal.s.pVM);
1497 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: pfnAsyncNotify=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pfnAsyncNotify));
1498
1499 int rc = VINF_SUCCESS;
1500 AssertStmt(pfnAsyncNotify, rc = VERR_INVALID_PARAMETER);
1501 AssertStmt(!pUsbIns->Internal.s.pfnAsyncNotify, rc = VERR_WRONG_ORDER);
1502 AssertStmt(pUsbIns->Internal.s.fVMSuspended || pUsbIns->Internal.s.fVMReset, rc = VERR_WRONG_ORDER);
1503 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1504 AssertStmt( enmVMState == VMSTATE_SUSPENDING
1505 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1506 || enmVMState == VMSTATE_SUSPENDING_LS
1507 || enmVMState == VMSTATE_RESETTING
1508 || enmVMState == VMSTATE_RESETTING_LS
1509 || enmVMState == VMSTATE_POWERING_OFF
1510 || enmVMState == VMSTATE_POWERING_OFF_LS,
1511 rc = VERR_INVALID_STATE);
1512
1513 if (RT_SUCCESS(rc))
1514 pUsbIns->Internal.s.pfnAsyncNotify = pfnAsyncNotify;
1515
1516 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1517 return rc;
1518}
1519
1520
1521/** @interface_method_impl{PDMUSBHLP,pfnAsyncNotificationCompleted} */
1522static DECLCALLBACK(void) pdmR3UsbHlp_AsyncNotificationCompleted(PPDMUSBINS pUsbIns)
1523{
1524 PDMUSB_ASSERT_USBINS(pUsbIns);
1525 PVM pVM = pUsbIns->Internal.s.pVM;
1526
1527 VMSTATE enmVMState = VMR3GetState(pVM);
1528 if ( enmVMState == VMSTATE_SUSPENDING
1529 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1530 || enmVMState == VMSTATE_SUSPENDING_LS
1531 || enmVMState == VMSTATE_RESETTING
1532 || enmVMState == VMSTATE_RESETTING_LS
1533 || enmVMState == VMSTATE_POWERING_OFF
1534 || enmVMState == VMSTATE_POWERING_OFF_LS)
1535 {
1536 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d:\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1537 VMR3AsyncPdmNotificationWakeupU(pVM->pUVM);
1538 }
1539 else
1540 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d: enmVMState=%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance, enmVMState));
1541}
1542
1543
1544/** @interface_method_impl{PDMUSBHLP,pfnVMGetSuspendReason} */
1545static DECLCALLBACK(VMSUSPENDREASON) pdmR3UsbHlp_VMGetSuspendReason(PPDMUSBINS pUsbIns)
1546{
1547 PDMUSB_ASSERT_USBINS(pUsbIns);
1548 PVM pVM = pUsbIns->Internal.s.pVM;
1549 VM_ASSERT_EMT(pVM);
1550 VMSUSPENDREASON enmReason = VMR3GetSuspendReason(pVM->pUVM);
1551 LogFlow(("pdmR3UsbHlp_VMGetSuspendReason: caller='%s'/%d: returns %d\n",
1552 pUsbIns->pReg->szName, pUsbIns->iInstance, enmReason));
1553 return enmReason;
1554}
1555
1556
1557/** @interface_method_impl{PDMUSBHLP,pfnVMGetResumeReason} */
1558static DECLCALLBACK(VMRESUMEREASON) pdmR3UsbHlp_VMGetResumeReason(PPDMUSBINS pUsbIns)
1559{
1560 PDMUSB_ASSERT_USBINS(pUsbIns);
1561 PVM pVM = pUsbIns->Internal.s.pVM;
1562 VM_ASSERT_EMT(pVM);
1563 VMRESUMEREASON enmReason = VMR3GetResumeReason(pVM->pUVM);
1564 LogFlow(("pdmR3UsbHlp_VMGetResumeReason: caller='%s'/%d: returns %d\n",
1565 pUsbIns->pReg->szName, pUsbIns->iInstance, enmReason));
1566 return enmReason;
1567}
1568
1569
1570/**
1571 * The USB device helper structure.
1572 */
1573const PDMUSBHLP g_pdmR3UsbHlp =
1574{
1575 PDM_USBHLP_VERSION,
1576 pdmR3UsbHlp_DriverAttach,
1577 pdmR3UsbHlp_AssertEMT,
1578 pdmR3UsbHlp_AssertOther,
1579 pdmR3UsbHlp_DBGFStopV,
1580 pdmR3UsbHlp_DBGFInfoRegister,
1581 pdmR3UsbHlp_MMHeapAlloc,
1582 pdmR3UsbHlp_MMHeapAllocZ,
1583 pdmR3UsbHlp_PDMQueueCreate,
1584 pdmR3UsbHlp_SSMRegister,
1585 pdmR3UsbHlp_STAMRegisterV,
1586 pdmR3UsbHlp_TMTimerCreate,
1587 pdmR3UsbHlp_VMSetErrorV,
1588 pdmR3UsbHlp_VMSetRuntimeErrorV,
1589 pdmR3UsbHlp_VMState,
1590 pdmR3UsbHlp_ThreadCreate,
1591 pdmR3UsbHlp_SetAsyncNotification,
1592 pdmR3UsbHlp_AsyncNotificationCompleted,
1593 pdmR3UsbHlp_VMGetSuspendReason,
1594 pdmR3UsbHlp_VMGetResumeReason,
1595 NULL,
1596 NULL,
1597 NULL,
1598 NULL,
1599 NULL,
1600 NULL,
1601 NULL,
1602 NULL,
1603 NULL,
1604 NULL,
1605 PDM_USBHLP_VERSION
1606};
1607
1608/** @} */
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