VirtualBox

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

Last change on this file since 53055 was 53031, checked in by vboxsync, 10 years ago

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