VirtualBox

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

Last change on this file since 28800 was 28800, checked in by vboxsync, 14 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 50.3 KB
Line 
1/* $Id: PDMUsb.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2/** @file
3 * PDM - Pluggable Device and Driver Manager, USB part.
4 */
5
6/*
7 * Copyright (C) 2006-2007 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/pdm.h>
25#include <VBox/vusb.h>
26#include <VBox/mm.h>
27#include <VBox/cfgm.h>
28#include <VBox/vmm.h>
29#include <VBox/sup.h>
30#include <VBox/vm.h>
31#include <VBox/version.h>
32#include <VBox/err.h>
33
34#include <VBox/log.h>
35#include <iprt/assert.h>
36#include <iprt/thread.h>
37#include <iprt/string.h>
38#include <iprt/asm.h>
39#include <iprt/alloc.h>
40#include <iprt/alloca.h>
41#include <iprt/path.h>
42#include <iprt/uuid.h>
43
44
45/*******************************************************************************
46* Structures and Typedefs *
47*******************************************************************************/
48/**
49 * Internal callback structure pointer.
50 *
51 * The main purpose is to define the extra data we associate
52 * with PDMUSBREGCB so we can find the VM instance and so on.
53 */
54typedef struct PDMUSBREGCBINT
55{
56 /** The callback structure. */
57 PDMUSBREGCB Core;
58 /** A bit of padding. */
59 uint32_t u32[4];
60 /** VM Handle. */
61 PVM pVM;
62} PDMUSBREGCBINT, *PPDMUSBREGCBINT;
63typedef const PDMUSBREGCBINT *PCPDMUSBREGCBINT;
64
65
66/*******************************************************************************
67* Defined Constants And Macros *
68*******************************************************************************/
69/** @def PDMUSB_ASSERT_USBINS
70 * Asserts the validity of the USB device instance.
71 */
72#ifdef VBOX_STRICT
73# define PDMUSB_ASSERT_USBINS(pUsbIns) \
74 do { \
75 AssertPtr(pUsbIns); \
76 Assert(pUsbIns->u32Version == PDM_USBINS_VERSION); \
77 Assert(pUsbIns->pvInstanceDataR3 == (void *)&pUsbIns->achInstanceData[0]); \
78 } while (0)
79#else
80# define PDMUSB_ASSERT_USBINS(pUsbIns) do { } while (0)
81#endif
82
83
84/*******************************************************************************
85* Internal Functions *
86*******************************************************************************/
87static void pdmR3UsbDestroyDevice(PVM pVM, PPDMUSBINS pUsbIns);
88
89
90/*******************************************************************************
91* Global Variables *
92*******************************************************************************/
93extern const PDMUSBHLP g_pdmR3UsbHlp;
94
95
96AssertCompile(sizeof(PDMUSBINSINT) <= RT_SIZEOFMEMB(PDMUSBINS, Internal.padding));
97
98
99/**
100 * Registers a USB hub driver.
101 *
102 * @returns VBox status code.
103 * @param pVM The VM handle.
104 * @param pDrvIns The driver instance of the hub.
105 * @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
106 * @param cPorts The number of ports.
107 * @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
108 * @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
109 * @thread EMT
110 */
111int pdmR3UsbRegisterHub(PVM pVM, PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
112{
113 /*
114 * Validate input.
115 */
116 /* The driver must be in the USB class. */
117 if (!(pDrvIns->pReg->fClass & PDM_DRVREG_CLASS_USB))
118 {
119 LogRel(("pdmR3UsbRegisterHub: fClass=%#x expected %#x to be set\n", pDrvIns->pReg->fClass, PDM_DRVREG_CLASS_USB));
120 return VERR_INVALID_PARAMETER;
121 }
122 AssertMsgReturn(!(fVersions & ~(VUSB_STDVER_11 | VUSB_STDVER_20)), ("%#x\n", fVersions), VERR_INVALID_PARAMETER);
123 AssertPtrReturn(ppUsbHubHlp, VERR_INVALID_POINTER);
124 AssertPtrReturn(pUsbHubReg, VERR_INVALID_POINTER);
125 AssertReturn(pUsbHubReg->u32Version == PDM_USBHUBREG_VERSION, VERR_INVALID_MAGIC);
126 AssertReturn(pUsbHubReg->u32TheEnd == PDM_USBHUBREG_VERSION, VERR_INVALID_MAGIC);
127 AssertPtrReturn(pUsbHubReg->pfnAttachDevice, VERR_INVALID_PARAMETER);
128 AssertPtrReturn(pUsbHubReg->pfnDetachDevice, VERR_INVALID_PARAMETER);
129
130 /*
131 * Check for duplicate registration and find the last hub for FIFO registration.
132 */
133 PPDMUSBHUB pPrev = NULL;
134 for (PPDMUSBHUB pCur = pVM->pdm.s.pUsbHubs; pCur; pCur = pCur->pNext)
135 {
136 if (pCur->pDrvIns == pDrvIns)
137 return VERR_PDM_USB_HUB_EXISTS;
138 pPrev = pCur;
139 }
140
141 /*
142 * Create an internal USB hub structure.
143 */
144 PPDMUSBHUB pHub = (PPDMUSBHUB)MMR3HeapAlloc(pVM, MM_TAG_PDM_DRIVER, sizeof(*pHub));
145 if (!pHub)
146 return VERR_NO_MEMORY;
147
148 pHub->fVersions = fVersions;
149 pHub->cPorts = cPorts;
150 pHub->cAvailablePorts = cPorts;
151 pHub->pDrvIns = pDrvIns;
152 pHub->Reg = *pUsbHubReg;
153 pHub->pNext = NULL;
154
155 /* link it */
156 if (pPrev)
157 pPrev->pNext = pHub;
158 else
159 pVM->pdm.s.pUsbHubs = pHub;
160
161 Log(("PDM: Registered USB hub %p/%s\n", pDrvIns, pDrvIns->pReg->szName));
162 return VINF_SUCCESS;
163}
164
165
166/**
167 * Loads one device module and call the registration entry point.
168 *
169 * @returns VBox status code.
170 * @param pVM VM handle.
171 * @param pRegCB The registration callback stuff.
172 * @param pszFilename Module filename.
173 * @param pszName Module name.
174 */
175static int pdmR3UsbLoad(PVM pVM, PCPDMUSBREGCBINT pRegCB, const char *pszFilename, const char *pszName)
176{
177 /*
178 * Load it.
179 */
180 int rc = pdmR3LoadR3U(pVM->pUVM, pszFilename, pszName);
181 if (RT_SUCCESS(rc))
182 {
183 /*
184 * Get the registration export and call it.
185 */
186 FNPDMVBOXUSBREGISTER *pfnVBoxUsbRegister;
187 rc = PDMR3LdrGetSymbolR3(pVM, pszName, "VBoxUsbRegister", (void **)&pfnVBoxUsbRegister);
188 if (RT_SUCCESS(rc))
189 {
190 Log(("PDM: Calling VBoxUsbRegister (%p) of %s (%s)\n", pfnVBoxUsbRegister, pszName, pszFilename));
191 rc = pfnVBoxUsbRegister(&pRegCB->Core, VBOX_VERSION);
192 if (RT_SUCCESS(rc))
193 Log(("PDM: Successfully loaded device module %s (%s).\n", pszName, pszFilename));
194 else
195 AssertMsgFailed(("VBoxDevicesRegister failed with rc=%Rrc for module %s (%s)\n", rc, pszName, pszFilename));
196 }
197 else
198 {
199 AssertMsgFailed(("Failed to locate 'VBoxUsbRegister' in %s (%s) rc=%Rrc\n", pszName, pszFilename, rc));
200 if (rc == VERR_SYMBOL_NOT_FOUND)
201 rc = VERR_PDM_NO_REGISTRATION_EXPORT;
202 }
203 }
204 else
205 AssertMsgFailed(("Failed to load VBoxDD!\n"));
206 return rc;
207}
208
209
210
211/**
212 * @interface_method_impl{PDMUSBREGCB,pfnRegister}
213 */
214static DECLCALLBACK(int) pdmR3UsbReg_Register(PCPDMUSBREGCB pCallbacks, PCPDMUSBREG pReg)
215{
216 /*
217 * Validate the registration structure.
218 */
219 Assert(pReg);
220 AssertMsgReturn(pReg->u32Version == PDM_USBREG_VERSION,
221 ("Unknown struct version %#x!\n", pReg->u32Version),
222 VERR_PDM_UNKNOWN_USBREG_VERSION);
223 AssertMsgReturn( pReg->szName[0]
224 && strlen(pReg->szName) < sizeof(pReg->szName),
225 ("Invalid name '%s'\n", pReg->szName),
226 VERR_PDM_INVALID_USB_REGISTRATION);
227 AssertMsgReturn(pReg->fFlags == 0, ("fFlags=%#x\n", pReg->fFlags), VERR_PDM_INVALID_USB_REGISTRATION);
228 AssertMsgReturn(pReg->cMaxInstances > 0,
229 ("Max instances %u! (USB Device %s)\n", pReg->cMaxInstances, pReg->szName),
230 VERR_PDM_INVALID_USB_REGISTRATION);
231 AssertMsgReturn(pReg->cbInstance <= _1M,
232 ("Instance size %d bytes! (USB Device %s)\n", pReg->cbInstance, pReg->szName),
233 VERR_PDM_INVALID_USB_REGISTRATION);
234 AssertMsgReturn(pReg->pfnConstruct, ("No constructore! (USB Device %s)\n", pReg->szName),
235 VERR_PDM_INVALID_USB_REGISTRATION);
236
237 /*
238 * Check for duplicate and find FIFO entry at the same time.
239 */
240 PCPDMUSBREGCBINT pRegCB = (PCPDMUSBREGCBINT)pCallbacks;
241 PPDMUSB pUsbPrev = NULL;
242 PPDMUSB pUsb = pRegCB->pVM->pdm.s.pUsbDevs;
243 for (; pUsb; pUsbPrev = pUsb, pUsb = pUsb->pNext)
244 AssertMsgReturn(strcmp(pUsb->pReg->szName, pReg->szName),
245 ("USB Device '%s' already exists\n", pReg->szName),
246 VERR_PDM_USB_NAME_CLASH);
247
248 /*
249 * Allocate new device structure and insert it into the list.
250 */
251 pUsb = (PPDMUSB)MMR3HeapAlloc(pRegCB->pVM, MM_TAG_PDM_DEVICE, sizeof(*pUsb));
252 if (pUsb)
253 {
254 pUsb->pNext = NULL;
255 pUsb->iNextInstance = 0;
256 pUsb->pInstances = NULL;
257 pUsb->pReg = pReg;
258 pUsb->cchName = (RTUINT)strlen(pReg->szName);
259
260 if (pUsbPrev)
261 pUsbPrev->pNext = pUsb;
262 else
263 pRegCB->pVM->pdm.s.pUsbDevs = pUsb;
264 Log(("PDM: Registered USB device '%s'\n", pReg->szName));
265 return VINF_SUCCESS;
266 }
267 return VERR_NO_MEMORY;
268}
269
270
271/**
272 * Load USB Device modules.
273 *
274 * This is called by pdmR3DevInit() after it has loaded it's device modules.
275 *
276 * @returns VBox status code.
277 * @param pVM The VM handle.
278 */
279int pdmR3UsbLoadModules(PVM pVM)
280{
281 LogFlow(("pdmR3UsbLoadModules:\n"));
282
283 AssertRelease(!(RT_OFFSETOF(PDMUSBINS, achInstanceData) & 15));
284 AssertRelease(sizeof(pVM->pdm.s.pUsbInstances->Internal.s) <= sizeof(pVM->pdm.s.pUsbInstances->Internal.padding));
285
286 /*
287 * Initialize the callback structure.
288 */
289 PDMUSBREGCBINT RegCB;
290 RegCB.Core.u32Version = PDM_USBREG_CB_VERSION;
291 RegCB.Core.pfnRegister = pdmR3UsbReg_Register;
292 RegCB.pVM = pVM;
293
294 /*
295 * Load the builtin module
296 */
297 PCFGMNODE pUsbNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/USB/");
298 bool fLoadBuiltin;
299 int rc = CFGMR3QueryBool(pUsbNode, "LoadBuiltin", &fLoadBuiltin);
300 if (rc == VERR_CFGM_VALUE_NOT_FOUND || rc == VERR_CFGM_NO_PARENT)
301 fLoadBuiltin = true;
302 else if (RT_FAILURE(rc))
303 {
304 AssertMsgFailed(("Configuration error: Querying boolean \"LoadBuiltin\" failed with %Rrc\n", rc));
305 return rc;
306 }
307 if (fLoadBuiltin)
308 {
309 /* make filename */
310 char *pszFilename = pdmR3FileR3("VBoxDD", /* fShared = */ true);
311 if (!pszFilename)
312 return VERR_NO_TMP_MEMORY;
313 rc = pdmR3UsbLoad(pVM, &RegCB, pszFilename, "VBoxDD");
314 RTMemTmpFree(pszFilename);
315 if (RT_FAILURE(rc))
316 return rc;
317 }
318
319 /*
320 * Load additional device modules.
321 */
322 PCFGMNODE pCur;
323 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
324 {
325 /*
326 * Get the name and path.
327 */
328 char szName[PDMMOD_NAME_LEN];
329 rc = CFGMR3GetName(pCur, &szName[0], sizeof(szName));
330 if (rc == VERR_CFGM_NOT_ENOUGH_SPACE)
331 {
332 AssertMsgFailed(("configuration error: The module name is too long, cchName=%zu.\n", CFGMR3GetNameLen(pCur)));
333 return VERR_PDM_MODULE_NAME_TOO_LONG;
334 }
335 else if (RT_FAILURE(rc))
336 {
337 AssertMsgFailed(("CFGMR3GetName -> %Rrc.\n", rc));
338 return rc;
339 }
340
341 /* the path is optional, if no path the module name + path is used. */
342 char szFilename[RTPATH_MAX];
343 rc = CFGMR3QueryString(pCur, "Path", &szFilename[0], sizeof(szFilename));
344 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
345 strcpy(szFilename, szName);
346 else if (RT_FAILURE(rc))
347 {
348 AssertMsgFailed(("configuration error: Failure to query the module path, rc=%Rrc.\n", rc));
349 return rc;
350 }
351
352 /* prepend path? */
353 if (!RTPathHavePath(szFilename))
354 {
355 char *psz = pdmR3FileR3(szFilename);
356 if (!psz)
357 return VERR_NO_TMP_MEMORY;
358 size_t cch = strlen(psz) + 1;
359 if (cch > sizeof(szFilename))
360 {
361 RTMemTmpFree(psz);
362 AssertMsgFailed(("Filename too long! cch=%d '%s'\n", cch, psz));
363 return VERR_FILENAME_TOO_LONG;
364 }
365 memcpy(szFilename, psz, cch);
366 RTMemTmpFree(psz);
367 }
368
369 /*
370 * Load the module and register it's devices.
371 */
372 rc = pdmR3UsbLoad(pVM, &RegCB, szFilename, szName);
373 if (RT_FAILURE(rc))
374 return rc;
375 }
376
377 return VINF_SUCCESS;
378}
379
380
381/**
382 * Send the init-complete notification to all the USB devices.
383 *
384 * This is called from pdmR3DevInit() after it has do its noficiation round.
385 *
386 * @returns VBox status code.
387 * @param pVM The VM handle.
388 */
389int pdmR3UsbVMInitComplete(PVM pVM)
390{
391 for (PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
392 {
393 if (pUsbIns->pReg->pfnVMInitComplete)
394 {
395 int rc = pUsbIns->pReg->pfnVMInitComplete(pUsbIns);
396 if (RT_FAILURE(rc))
397 {
398 AssertMsgFailed(("InitComplete on USB device '%s'/%d failed with rc=%Rrc\n",
399 pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
400 return rc;
401 }
402 }
403 }
404 return VINF_SUCCESS;
405}
406
407
408/**
409 * Lookups a device structure by name.
410 * @internal
411 */
412PPDMUSB pdmR3UsbLookup(PVM pVM, const char *pszName)
413{
414 size_t cchName = strlen(pszName);
415 for (PPDMUSB pUsb = pVM->pdm.s.pUsbDevs; pUsb; pUsb = pUsb->pNext)
416 if ( pUsb->cchName == cchName
417 && !strcmp(pUsb->pReg->szName, pszName))
418 return pUsb;
419 return NULL;
420}
421
422
423/**
424 * Locates a suitable hub for the specified kind of device.
425 *
426 * @returns VINF_SUCCESS and *ppHub on success.
427 * VERR_PDM_NO_USB_HUBS or VERR_PDM_NO_USB_PORTS on failure.
428 * @param pVM The VM handle.
429 * @param iUsbVersion The USB device version.
430 * @param ppHub Where to store the pointer to the USB hub.
431 */
432static int pdmR3UsbFindHub(PVM pVM, uint32_t iUsbVersion, PPDMUSBHUB *ppHub)
433{
434 *ppHub = NULL;
435 if (!pVM->pdm.s.pUsbHubs)
436 return VERR_PDM_NO_USB_HUBS;
437
438 for (PPDMUSBHUB pCur = pVM->pdm.s.pUsbHubs; pCur; pCur = pCur->pNext)
439 if ( pCur->cAvailablePorts > 0
440 && ( (pCur->fVersions & iUsbVersion)
441 || pCur->fVersions == VUSB_STDVER_11))
442 {
443 *ppHub = pCur;
444 if (pCur->fVersions & iUsbVersion)
445 break;
446 }
447 if (*ppHub)
448 return VINF_SUCCESS;
449 return VERR_PDM_NO_USB_PORTS;
450}
451
452
453/**
454 * Creates the device.
455 *
456 * @returns VBox status code.
457 * @param pVM The VM handle.
458 * @param pUsbDev The USB device emulation.
459 * @param iInstance -1 if not called by pdmR3UsbInstantiateDevices().
460 * @param pUuid The UUID for this device.
461 * @param pInstanceNode The instance CFGM node. NULL if not called by pdmR3UsbInstantiateDevices().
462 * @param ppConfig Pointer to the device configuration pointer. This is set to NULL if inserted
463 * into the tree or cleaned up.
464 *
465 * In the pdmR3UsbInstantiateDevices() case (pInstanceNode != NULL) this is
466 * the actual config node and will not be cleaned up.
467 *
468 * @parma iUsbVersion The USB version prefered by the device.
469 */
470static int pdmR3UsbCreateDevice(PVM pVM, PPDMUSBHUB pHub, PPDMUSB pUsbDev, int iInstance, PCRTUUID pUuid, PCFGMNODE pInstanceNode, PCFGMNODE *ppConfig, uint32_t iUsbVersion)
471{
472 const bool fAtRuntime = pInstanceNode == NULL;
473 int rc;
474
475 /*
476 * If not called by pdmR3UsbInstantiateDevices(), we'll have to fix
477 * the configuration now.
478 */
479 /* USB device node. */
480 PCFGMNODE pDevNode = CFGMR3GetChildF(CFGMR3GetRoot(pVM), "USB/%s/", pUsbDev->pReg->szName);
481 if (!pDevNode)
482 {
483 rc = CFGMR3InsertNodeF(CFGMR3GetRoot(pVM), &pDevNode, "USB/%s/", pUsbDev->pReg->szName);
484 AssertRCReturn(rc, rc);
485 }
486
487 /* The instance node and number. */
488 if (!pInstanceNode)
489 {
490 for (unsigned c = 0; c < _2M; c++)
491 {
492 iInstance = pUsbDev->iNextInstance++;
493 rc = CFGMR3InsertNodeF(pDevNode, &pInstanceNode, "%d/", iInstance);
494 if (rc != VERR_CFGM_NODE_EXISTS)
495 break;
496 }
497 AssertRCReturn(rc, rc);
498 }
499 else
500 {
501 Assert(iInstance >= 0);
502 if (iInstance >= (int)pUsbDev->iNextInstance)
503 pUsbDev->iNextInstance = iInstance + 1;
504 }
505
506 /* The instance config node. */
507 PCFGMNODE pConfigToDelete = NULL;
508 PCFGMNODE pConfig = NULL;
509 if (!ppConfig || !*ppConfig)
510 {
511 rc = CFGMR3InsertNode(pInstanceNode, "Config", &pConfig);
512 AssertRCReturn(rc, rc);
513 }
514 else if (fAtRuntime)
515 {
516 rc = CFGMR3InsertSubTree(pInstanceNode, "Config", *ppConfig, &pConfig);
517 AssertRCReturn(rc, rc);
518 *ppConfig = NULL;
519 pConfigToDelete = pConfig;
520 }
521 else
522 pConfig = *ppConfig;
523 Assert(CFGMR3GetChild(pInstanceNode, "Config") == pConfig);
524
525 /* The global device config node. */
526 PCFGMNODE pGlobalConfig = CFGMR3GetChild(pDevNode, "GlobalConfig");
527 if (!pGlobalConfig)
528 {
529 rc = CFGMR3InsertNode(pDevNode, "GlobalConfig", &pGlobalConfig);
530 if (RT_FAILURE(rc))
531 {
532 CFGMR3RemoveNode(pConfigToDelete);
533 AssertRCReturn(rc, rc);
534 }
535 }
536
537 /*
538 * Allocate the device instance.
539 */
540 size_t cb = RT_OFFSETOF(PDMUSBINS, achInstanceData[pUsbDev->pReg->cbInstance]);
541 cb = RT_ALIGN_Z(cb, 16);
542 PPDMUSBINS pUsbIns;
543 rc = MMR3HeapAllocZEx(pVM, MM_TAG_PDM_USB, cb, (void **)&pUsbIns);
544 if (RT_FAILURE(rc))
545 {
546 AssertMsgFailed(("Failed to allocate %d bytes of instance data for USB device '%s'. rc=%Rrc\n",
547 cb, pUsbDev->pReg->szName, rc));
548 CFGMR3RemoveNode(pConfigToDelete);
549 return rc;
550 }
551
552 /*
553 * Initialize it.
554 */
555 pUsbIns->u32Version = PDM_USBINS_VERSION;
556 //pUsbIns->Internal.s.pNext = NULL;
557 //pUsbIns->Internal.s.pPerDeviceNext = NULL;
558 pUsbIns->Internal.s.pUsbDev = pUsbDev;
559 pUsbIns->Internal.s.pVM = pVM;
560 //pUsbIns->Internal.s.pLuns = NULL;
561 pUsbIns->Internal.s.pCfg = pInstanceNode;
562 pUsbIns->Internal.s.pCfgDelete = pConfigToDelete;
563 pUsbIns->Internal.s.pCfgGlobal = pGlobalConfig;
564 pUsbIns->Internal.s.Uuid = *pUuid;
565 //pUsbIns->Internal.s.pHub = NULL;
566 pUsbIns->Internal.s.iPort = UINT32_MAX; /* to be determined. */
567 pUsbIns->Internal.s.fVMSuspended = true;
568 //pUsbIns->Internal.s.pfnAsyncNotify = NULL;
569 pUsbIns->pHlpR3 = &g_pdmR3UsbHlp;
570 pUsbIns->pReg = pUsbDev->pReg;
571 pUsbIns->pCfg = pConfig;
572 pUsbIns->pCfgGlobal = pGlobalConfig;
573 pUsbIns->iInstance = iInstance;
574 pUsbIns->pvInstanceDataR3 = &pUsbIns->achInstanceData[0];
575
576 /*
577 * Link it into all the lists.
578 */
579 /* The global instance FIFO. */
580 PPDMUSBINS pPrev1 = pVM->pdm.s.pUsbInstances;
581 if (!pPrev1)
582 pVM->pdm.s.pUsbInstances = pUsbIns;
583 else
584 {
585 while (pPrev1->Internal.s.pNext)
586 {
587 Assert(pPrev1->u32Version == PDM_USBINS_VERSION);
588 pPrev1 = pPrev1->Internal.s.pNext;
589 }
590 pPrev1->Internal.s.pNext = pUsbIns;
591 }
592
593 /* The per device instance FIFO. */
594 PPDMUSBINS pPrev2 = pUsbDev->pInstances;
595 if (!pPrev2)
596 pUsbDev->pInstances = pUsbIns;
597 else
598 {
599 while (pPrev2->Internal.s.pPerDeviceNext)
600 {
601 Assert(pPrev2->u32Version == PDM_USBINS_VERSION);
602 pPrev2 = pPrev2->Internal.s.pPerDeviceNext;
603 }
604 pPrev2->Internal.s.pPerDeviceNext = pUsbIns;
605 }
606
607 /*
608 * Call the constructor.
609 */
610 Log(("PDM: Constructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
611 rc = pUsbIns->pReg->pfnConstruct(pUsbIns, pUsbIns->iInstance, pUsbIns->pCfg, pUsbIns->pCfgGlobal);
612 if (RT_SUCCESS(rc))
613 {
614 /*
615 * Attach it to the hub.
616 */
617 Log(("PDM: Attaching it...\n"));
618 rc = pHub->Reg.pfnAttachDevice(pHub->pDrvIns, pUsbIns, &pUsbIns->Internal.s.iPort);
619 if (RT_SUCCESS(rc))
620 {
621 pHub->cAvailablePorts--;
622 Assert((int32_t)pHub->cAvailablePorts >= 0 && pHub->cAvailablePorts < pHub->cPorts);
623 pUsbIns->Internal.s.pHub = pHub;
624
625 /* Send the hot-plugged notification if applicable. */
626 if (fAtRuntime && pUsbIns->pReg->pfnHotPlugged)
627 pUsbIns->pReg->pfnHotPlugged(pUsbIns);
628
629 Log(("PDM: Successfully attached USB device '%s' instance %d to hub %p\n",
630 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub));
631 return VINF_SUCCESS;
632 }
633
634 LogRel(("PDM: Failed to attach USB device '%s' instance %d to hub %p: %Rrc\n",
635 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
636 }
637 else
638 AssertMsgFailed(("Failed to construct '%s'/%d! %Rra\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
639 if (fAtRuntime)
640 pdmR3UsbDestroyDevice(pVM, pUsbIns);
641 /* else: destructors are invoked later. */
642 return rc;
643}
644
645
646/**
647 * Instantiate USB devices.
648 *
649 * This is called by pdmR3DevInit() after it has instantiated the
650 * other devices and their drivers. If there aren't any hubs
651 * around, we'll silently skip the USB devices.
652 *
653 * @returns VBox status code.
654 * @param pVM
655 */
656int pdmR3UsbInstantiateDevices(PVM pVM)
657{
658 /*
659 * Any hubs?
660 */
661 if (!pVM->pdm.s.pUsbHubs)
662 {
663 Log(("PDM: No USB hubs, skipping USB device instantiation.\n"));
664 return VINF_SUCCESS;
665 }
666
667 /*
668 * Count the device instances.
669 */
670 PCFGMNODE pCur;
671 PCFGMNODE pUsbNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "USB/");
672 PCFGMNODE pInstanceNode;
673 unsigned cUsbDevs = 0;
674 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
675 {
676 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
677 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
678 if (pInstanceNode != pGlobal)
679 cUsbDevs++;
680 }
681 if (!cUsbDevs)
682 {
683 Log(("PDM: No USB devices were configured!\n"));
684 return VINF_SUCCESS;
685 }
686 Log2(("PDM: cUsbDevs=%d!\n", cUsbDevs));
687
688 /*
689 * Collect info on each USB device instance.
690 */
691 struct USBDEVORDER
692 {
693 /** Configuration node. */
694 PCFGMNODE pNode;
695 /** Pointer to the USB device. */
696 PPDMUSB pUsbDev;
697 /** Init order. */
698 uint32_t u32Order;
699 /** VBox instance number. */
700 uint32_t iInstance;
701 } *paUsbDevs = (struct USBDEVORDER *)alloca(sizeof(paUsbDevs[0]) * (cUsbDevs + 1)); /* (One extra for swapping) */
702 Assert(paUsbDevs);
703 int rc;
704 unsigned i = 0;
705 for (pCur = CFGMR3GetFirstChild(pUsbNode); pCur; pCur = CFGMR3GetNextChild(pCur))
706 {
707 /* Get the device name. */
708 char szName[sizeof(paUsbDevs[0].pUsbDev->pReg->szName)];
709 rc = CFGMR3GetName(pCur, szName, sizeof(szName));
710 AssertMsgRCReturn(rc, ("Configuration error: device name is too long (or something)! rc=%Rrc\n", rc), rc);
711
712 /* Find the device. */
713 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, szName);
714 AssertMsgReturn(pUsbDev, ("Configuration error: device '%s' not found!\n", szName), VERR_PDM_DEVICE_NOT_FOUND);
715
716 /* Configured priority or use default? */
717 uint32_t u32Order;
718 rc = CFGMR3QueryU32(pCur, "Priority", &u32Order);
719 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
720 u32Order = i << 4;
721 else
722 AssertMsgRCReturn(rc, ("Configuration error: reading \"Priority\" for the '%s' USB device failed rc=%Rrc!\n", szName, rc), rc);
723
724 /* Global config. */
725 PCFGMNODE pGlobal = CFGMR3GetChild(pCur, "GlobalConfig/");
726 if (!pGlobal)
727 {
728 rc = CFGMR3InsertNode(pCur, "GlobalConfig/", &pGlobal);
729 AssertMsgRCReturn(rc, ("Failed to create GlobalConfig node! rc=%Rrc\n", rc), rc);
730 CFGMR3SetRestrictedRoot(pGlobal);
731 }
732
733 /* Enumerate the device instances. */
734 for (pInstanceNode = CFGMR3GetFirstChild(pCur); pInstanceNode; pInstanceNode = CFGMR3GetNextChild(pInstanceNode))
735 {
736 if (pInstanceNode == pGlobal)
737 continue;
738
739 paUsbDevs[i].pNode = pInstanceNode;
740 paUsbDevs[i].pUsbDev = pUsbDev;
741 paUsbDevs[i].u32Order = u32Order;
742
743 /* Get the instance number. */
744 char szInstance[32];
745 rc = CFGMR3GetName(pInstanceNode, szInstance, sizeof(szInstance));
746 AssertMsgRCReturn(rc, ("Configuration error: instance name is too long (or something)! rc=%Rrc\n", rc), rc);
747 char *pszNext = NULL;
748 rc = RTStrToUInt32Ex(szInstance, &pszNext, 0, &paUsbDevs[i].iInstance);
749 AssertMsgRCReturn(rc, ("Configuration error: RTStrToInt32Ex failed on the instance name '%s'! rc=%Rrc\n", szInstance, rc), rc);
750 AssertMsgReturn(!*pszNext, ("Configuration error: the instance name '%s' isn't all digits. (%s)\n", szInstance, pszNext), VERR_INVALID_PARAMETER);
751
752 /* next instance */
753 i++;
754 }
755 } /* devices */
756 Assert(i == cUsbDevs);
757
758 /*
759 * Sort the device array ascending on u32Order. (bubble)
760 */
761 unsigned c = cUsbDevs - 1;
762 while (c)
763 {
764 unsigned j = 0;
765 for (i = 0; i < c; i++)
766 if (paUsbDevs[i].u32Order > paUsbDevs[i + 1].u32Order)
767 {
768 paUsbDevs[cUsbDevs] = paUsbDevs[i + 1];
769 paUsbDevs[i + 1] = paUsbDevs[i];
770 paUsbDevs[i] = paUsbDevs[cUsbDevs];
771 j = i;
772 }
773 c = j;
774 }
775
776 /*
777 * Instantiate the devices.
778 */
779 for (i = 0; i < cUsbDevs; i++)
780 {
781 /*
782 * Make sure there is a config node and mark it as restricted.
783 */
784 PCFGMNODE pConfigNode = CFGMR3GetChild(paUsbDevs[i].pNode, "Config/");
785 if (!pConfigNode)
786 {
787 rc = CFGMR3InsertNode(paUsbDevs[i].pNode, "Config", &pConfigNode);
788 AssertMsgRCReturn(rc, ("Failed to create Config node! rc=%Rrc\n", rc), rc);
789 }
790 CFGMR3SetRestrictedRoot(pConfigNode);
791
792 /** @todo
793 * Figure out the USB version from the USB device registration and the configuration.
794 */
795 uint32_t iUsbVersion = VUSB_STDVER_11;
796
797 /*
798 * Find a suitable hub with free ports.
799 */
800 PPDMUSBHUB pHub;
801 rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
802 if (RT_FAILURE(rc))
803 {
804 Log(("pdmR3UsbFindHub failed %Rrc\n", rc));
805 return rc;
806 }
807
808 /*
809 * Create and attach the device.
810 */
811 RTUUID Uuid;
812 rc = RTUuidCreate(&Uuid);
813 AssertRCReturn(rc, rc);
814 rc = pdmR3UsbCreateDevice(pVM, pHub, paUsbDevs[i].pUsbDev, paUsbDevs[i].iInstance, &Uuid, paUsbDevs[i].pNode, &pConfigNode, iUsbVersion);
815 if (RT_FAILURE(rc))
816 return rc;
817 } /* for device instances */
818
819 return VINF_SUCCESS;
820}
821
822
823/**
824 * Creates a USB proxy device instance.
825 *
826 * This will find an appropriate HUB for the USB device, create the necessary CFGM stuff
827 * and try instantiate the proxy device.
828 *
829 * @returns VBox status code.
830 * @param pVM The VM handle.
831 * @param pUuid The UUID thats to be associated with the device.
832 * @param fRemote Whether it's a remove or local device.
833 * @param pszAddress The address string.
834 * @param pvBackend Pointer to the backend.
835 * @param iUsbVersion The preferred USB version.
836 * @param fMaskedIfs The interfaces to hide from the guest.
837 */
838VMMR3DECL(int) PDMR3USBCreateProxyDevice(PVM pVM, PCRTUUID pUuid, bool fRemote, const char *pszAddress, void *pvBackend,
839 uint32_t iUsbVersion, uint32_t fMaskedIfs)
840{
841 /*
842 * Validate input.
843 */
844 VM_ASSERT_EMT(pVM);
845 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
846 AssertPtrReturn(pszAddress, VERR_INVALID_POINTER);
847 AssertReturn( iUsbVersion == VUSB_STDVER_20
848 || iUsbVersion == VUSB_STDVER_11, VERR_INVALID_PARAMETER);
849
850 /*
851 * Find the USBProxy driver.
852 */
853 PPDMUSB pUsbDev = pdmR3UsbLookup(pVM, "USBProxy");
854 if (!pUsbDev)
855 {
856 LogRel(("PDMR3USBCreateProxyDevice: The USBProxy device class wasn't found\n"));
857 return VERR_PDM_NO_USBPROXY;
858 }
859
860 /*
861 * Find a suitable hub with free ports.
862 */
863 PPDMUSBHUB pHub;
864 int rc = pdmR3UsbFindHub(pVM, iUsbVersion, &pHub);
865 if (RT_FAILURE(rc))
866 {
867 Log(("pdmR3UsbFindHub: failed %Rrc\n", rc));
868 return rc;
869 }
870
871 /*
872 * Create the CFGM configuration node.
873 */
874 PCFGMNODE pConfig = CFGMR3CreateTree(pVM);
875 AssertReturn(pConfig, VERR_NO_MEMORY);
876 do /* break loop */
877 {
878 rc = CFGMR3InsertString(pConfig, "Address", pszAddress); AssertRCBreak(rc);
879 char szUuid[RTUUID_STR_LENGTH];
880 rc = RTUuidToStr(pUuid, &szUuid[0], sizeof(szUuid)); AssertRCBreak(rc);
881 rc = CFGMR3InsertString(pConfig, "UUID", szUuid); AssertRCBreak(rc);
882 rc = CFGMR3InsertInteger(pConfig, "Remote", fRemote); AssertRCBreak(rc);
883 rc = CFGMR3InsertInteger(pConfig, "USBVersion", iUsbVersion); AssertRCBreak(rc);
884 rc = CFGMR3InsertInteger(pConfig, "pvBackend", (uintptr_t)pvBackend); AssertRCBreak(rc);
885 rc = CFGMR3InsertInteger(pConfig, "MaskedIfs", fMaskedIfs); AssertRCBreak(rc);
886 rc = CFGMR3InsertInteger(pConfig, "Force11Device", !(pHub->fVersions & iUsbVersion)); AssertRCBreak(rc);
887 } while (0); /* break loop */
888 if (RT_FAILURE(rc))
889 {
890 CFGMR3RemoveNode(pConfig);
891 LogRel(("PDMR3USBCreateProxyDevice: failed to setup CFGM config, rc=%Rrc\n", rc));
892 return rc;
893 }
894
895 /*
896 * Finally, try create it.
897 */
898 rc = pdmR3UsbCreateDevice(pVM, pHub, pUsbDev, -1, pUuid, NULL, &pConfig, iUsbVersion);
899 if (RT_FAILURE(rc) && pConfig)
900 CFGMR3RemoveNode(pConfig);
901 return rc;
902}
903
904
905/**
906 * Destroys a hot-plugged USB device.
907 *
908 * The device must be detached from the HUB at this point.
909 *
910 * @param pVM Pointer to the stahred VM structure.
911 * @param pUsbIns The USB device instance to destroy.
912 * @thread EMT
913 */
914static void pdmR3UsbDestroyDevice(PVM pVM, PPDMUSBINS pUsbIns)
915{
916 Assert(!pUsbIns->Internal.s.pHub);
917
918 /*
919 * Do the unplug notification.
920 */
921 /** @todo what about the drivers? */
922 if (pUsbIns->pReg->pfnHotUnplugged)
923 pUsbIns->pReg->pfnHotUnplugged(pUsbIns);
924
925 /*
926 * Destroy the luns with their driver chains and call the device destructor.
927 */
928 while (pUsbIns->Internal.s.pLuns)
929 {
930 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
931 pUsbIns->Internal.s.pLuns = pLun->pNext;
932 if (pLun->pTop)
933 pdmR3DrvDestroyChain(pLun->pTop, PDM_TACH_FLAGS_NOT_HOT_PLUG); /* Hotplugging is handled differently here atm. */
934 MMR3HeapFree(pLun);
935 }
936
937 /* finally, the device. */
938 if (pUsbIns->pReg->pfnDestruct)
939 {
940 Log(("PDM: Destructing USB device '%s' instance %d...\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
941 pUsbIns->pReg->pfnDestruct(pUsbIns);
942 }
943 //TMR3TimerDestroyUsb(pVM, pUsbIns);
944 //SSMR3DeregisterUsb(pVM, pUsbIns, NULL, 0);
945 pdmR3ThreadDestroyUsb(pVM, pUsbIns);
946
947 /*
948 * Unlink it.
949 */
950 /* The global instance FIFO. */
951 if (pVM->pdm.s.pUsbInstances == pUsbIns)
952 pVM->pdm.s.pUsbInstances = pUsbIns->Internal.s.pNext;
953 else
954 {
955 PPDMUSBINS pPrev = pVM->pdm.s.pUsbInstances;
956 while (pPrev && pPrev->Internal.s.pNext != pUsbIns)
957 {
958 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
959 pPrev = pPrev->Internal.s.pNext;
960 }
961 Assert(pPrev); Assert(pPrev != pUsbIns);
962 if (pPrev)
963 pPrev->Internal.s.pNext = pUsbIns->Internal.s.pNext;
964 }
965
966 /* The per device instance FIFO. */
967 PPDMUSB pUsbDev = pUsbIns->Internal.s.pUsbDev;
968 if (pUsbDev->pInstances == pUsbIns)
969 pUsbDev->pInstances = pUsbIns->Internal.s.pPerDeviceNext;
970 else
971 {
972 PPDMUSBINS pPrev = pUsbDev->pInstances;
973 while (pPrev && pPrev->Internal.s.pPerDeviceNext != pUsbIns)
974 {
975 Assert(pPrev->u32Version == PDM_USBINS_VERSION);
976 pPrev = pPrev->Internal.s.pPerDeviceNext;
977 }
978 Assert(pPrev); Assert(pPrev != pUsbIns);
979 if (pPrev)
980 pPrev->Internal.s.pPerDeviceNext = pUsbIns->Internal.s.pPerDeviceNext;
981 }
982
983 /*
984 * Trash it.
985 */
986 pUsbIns->u32Version = 0;
987 pUsbIns->pReg = NULL;
988 CFGMR3RemoveNode(pUsbIns->Internal.s.pCfgDelete);
989 MMR3HeapFree(pUsbIns);
990}
991
992
993/**
994 * Detaches and destroys a USB device.
995 *
996 * @returns VBox status code.
997 * @param pVM The VM handle.
998 * @param pUuid The UUID associated with the device to detach.
999 * @thread EMT
1000 */
1001VMMR3DECL(int) PDMR3USBDetachDevice(PVM pVM, PCRTUUID pUuid)
1002{
1003 /*
1004 * Validate input.
1005 */
1006 VM_ASSERT_EMT(pVM);
1007 AssertPtrReturn(pUuid, VERR_INVALID_POINTER);
1008 AssertPtrReturn(pVM, VERR_INVALID_POINTER);
1009
1010 /*
1011 * Search the global list for it.
1012 */
1013 PPDMUSBINS pUsbIns = pVM->pdm.s.pUsbInstances;
1014 for ( ; pUsbIns; pUsbIns = pUsbIns->Internal.s.pNext)
1015 if (!RTUuidCompare(&pUsbIns->Internal.s.Uuid, pUuid))
1016 break;
1017 if (!pUsbIns)
1018 return VERR_PDM_DEVICE_INSTANCE_NOT_FOUND; /** @todo VERR_PDM_USB_INSTANCE_NOT_FOUND */
1019
1020 /*
1021 * Detach it from the HUB (if it's actually attached to one).
1022 */
1023 PPDMUSBHUB pHub = pUsbIns->Internal.s.pHub;
1024 if (pHub)
1025 {
1026 int rc = pHub->Reg.pfnDetachDevice(pHub->pDrvIns, pUsbIns, pUsbIns->Internal.s.iPort);
1027 if (RT_FAILURE(rc))
1028 {
1029 LogRel(("PDM: Failed to detach USB device '%s' instance %d from %p: %Rrc\n",
1030 pUsbIns->pReg->szName, pUsbIns->iInstance, pHub, rc));
1031 return rc;
1032 }
1033
1034 pHub->cAvailablePorts++;
1035 Assert(pHub->cAvailablePorts > 0 && pHub->cAvailablePorts <= pHub->cPorts);
1036 pUsbIns->Internal.s.pHub = NULL;
1037 }
1038
1039 /*
1040 * Notify about unplugging and destroy the device with it's drivers.
1041 */
1042 pdmR3UsbDestroyDevice(pVM, pUsbIns);
1043
1044 return VINF_SUCCESS;
1045}
1046
1047
1048/**
1049 * Checks if there are any USB hubs attached.
1050 *
1051 * @returns true / false accordingly.
1052 * @param pVM Pointer to the shared VM structure.
1053 */
1054VMMR3DECL(bool) PDMR3USBHasHub(PVM pVM)
1055{
1056 return pVM->pdm.s.pUsbHubs != NULL;
1057}
1058
1059
1060/** @name USB Device Helpers
1061 * @{
1062 */
1063
1064/** @interface_method_impl{PDMUSBHLPR3,pfnDriverAttach} */
1065static DECLCALLBACK(int) pdmR3UsbHlp_DriverAttach(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface, PPDMIBASE *ppBaseInterface, const char *pszDesc)
1066{
1067 PDMUSB_ASSERT_USBINS(pUsbIns);
1068 PVM pVM = pUsbIns->Internal.s.pVM;
1069 VM_ASSERT_EMT(pVM);
1070 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: iLun=%d pBaseInterface=%p ppBaseInterface=%p pszDesc=%p:{%s}\n",
1071 pUsbIns->pReg->szName, pUsbIns->iInstance, iLun, pBaseInterface, ppBaseInterface, pszDesc, pszDesc));
1072
1073 /*
1074 * Lookup the LUN, it might already be registered.
1075 */
1076 PPDMLUN pLunPrev = NULL;
1077 PPDMLUN pLun = pUsbIns->Internal.s.pLuns;
1078 for (; pLun; pLunPrev = pLun, pLun = pLun->pNext)
1079 if (pLun->iLun == iLun)
1080 break;
1081
1082 /*
1083 * Create the LUN if if wasn't found, else check if driver is already attached to it.
1084 */
1085 if (!pLun)
1086 {
1087 if ( !pBaseInterface
1088 || !pszDesc
1089 || !*pszDesc)
1090 {
1091 Assert(pBaseInterface);
1092 Assert(pszDesc || *pszDesc);
1093 return VERR_INVALID_PARAMETER;
1094 }
1095
1096 pLun = (PPDMLUN)MMR3HeapAlloc(pVM, MM_TAG_PDM_LUN, sizeof(*pLun));
1097 if (!pLun)
1098 return VERR_NO_MEMORY;
1099
1100 pLun->iLun = iLun;
1101 pLun->pNext = pLunPrev ? pLunPrev->pNext : NULL;
1102 pLun->pTop = NULL;
1103 pLun->pBottom = NULL;
1104 pLun->pDevIns = NULL;
1105 pLun->pUsbIns = pUsbIns;
1106 pLun->pszDesc = pszDesc;
1107 pLun->pBase = pBaseInterface;
1108 if (!pLunPrev)
1109 pUsbIns->Internal.s.pLuns = pLun;
1110 else
1111 pLunPrev->pNext = pLun;
1112 Log(("pdmR3UsbHlp_DriverAttach: Registered LUN#%d '%s' with device '%s'/%d.\n",
1113 iLun, pszDesc, pUsbIns->pReg->szName, pUsbIns->iInstance));
1114 }
1115 else if (pLun->pTop)
1116 {
1117 AssertMsgFailed(("Already attached! The device should keep track of such things!\n"));
1118 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, VERR_PDM_DRIVER_ALREADY_ATTACHED));
1119 return VERR_PDM_DRIVER_ALREADY_ATTACHED;
1120 }
1121 Assert(pLun->pBase == pBaseInterface);
1122
1123
1124 /*
1125 * Get the attached driver configuration.
1126 */
1127 int rc;
1128 PCFGMNODE pNode = CFGMR3GetChildF(pUsbIns->Internal.s.pCfg, "LUN#%u", iLun);
1129 if (pNode)
1130 rc = pdmR3DrvInstantiate(pVM, pNode, pBaseInterface, NULL /*pDrvAbove*/, pLun, ppBaseInterface);
1131 else
1132 rc = VERR_PDM_NO_ATTACHED_DRIVER;
1133
1134
1135 LogFlow(("pdmR3UsbHlp_DriverAttach: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1136 return rc;
1137}
1138
1139
1140/** @interface_method_impl{PDMUSBHLP,pfnAssertEMT} */
1141static DECLCALLBACK(bool) pdmR3UsbHlp_AssertEMT(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1142{
1143 PDMUSB_ASSERT_USBINS(pUsbIns);
1144 if (VM_IS_EMT(pUsbIns->Internal.s.pVM))
1145 return true;
1146
1147 char szMsg[100];
1148 RTStrPrintf(szMsg, sizeof(szMsg), "AssertEMT '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1149 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1150 AssertBreakpoint();
1151 return false;
1152}
1153
1154
1155/** @interface_method_impl{PDMUSBHLP,pfnAssertOther} */
1156static DECLCALLBACK(bool) pdmR3UsbHlp_AssertOther(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction)
1157{
1158 PDMUSB_ASSERT_USBINS(pUsbIns);
1159 if (!VM_IS_EMT(pUsbIns->Internal.s.pVM))
1160 return true;
1161
1162 char szMsg[100];
1163 RTStrPrintf(szMsg, sizeof(szMsg), "AssertOther '%s'/%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance);
1164 RTAssertMsg1Weak(szMsg, iLine, pszFile, pszFunction);
1165 AssertBreakpoint();
1166 return false;
1167}
1168
1169
1170/** @interface_method_impl{PDMUSBHLP,pfnDBGFStopV} */
1171static DECLCALLBACK(int) pdmR3UsbHlp_DBGFStopV(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction, const char *pszFormat, va_list args)
1172{
1173 PDMUSB_ASSERT_USBINS(pUsbIns);
1174#ifdef LOG_ENABLED
1175 va_list va2;
1176 va_copy(va2, args);
1177 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: pszFile=%p:{%s} iLine=%d pszFunction=%p:{%s} pszFormat=%p:{%s} (%N)\n",
1178 pUsbIns->pReg->szName, pUsbIns->iInstance, pszFile, pszFile, iLine, pszFunction, pszFunction, pszFormat, pszFormat, pszFormat, &va2));
1179 va_end(va2);
1180#endif
1181
1182 PVM pVM = pUsbIns->Internal.s.pVM;
1183 VM_ASSERT_EMT(pVM);
1184 int rc = DBGFR3EventSrcV(pVM, DBGFEVENT_DEV_STOP, pszFile, iLine, pszFunction, pszFormat, args);
1185 if (rc == VERR_DBGF_NOT_ATTACHED)
1186 rc = VINF_SUCCESS;
1187
1188 LogFlow(("pdmR3UsbHlp_DBGFStopV: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1189 return rc;
1190}
1191
1192
1193/** @interface_method_impl{PDMUSBHLP,pfnDBGFInfoRegister} */
1194static DECLCALLBACK(int) pdmR3UsbHlp_DBGFInfoRegister(PPDMUSBINS pUsbIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERUSB pfnHandler)
1195{
1196 PDMUSB_ASSERT_USBINS(pUsbIns);
1197 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: pszName=%p:{%s} pszDesc=%p:{%s} pfnHandler=%p\n",
1198 pUsbIns->pReg->szName, pUsbIns->iInstance, pszName, pszName, pszDesc, pszDesc, pfnHandler));
1199
1200 PVM pVM = pUsbIns->Internal.s.pVM;
1201 VM_ASSERT_EMT(pVM);
1202 /** @todo int rc = DBGFR3InfoRegisterUsb(pVM, pszName, pszDesc, pfnHandler, pUsbIns); */
1203 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1204
1205 LogFlow(("pdmR3UsbHlp_DBGFInfoRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1206 return rc;
1207}
1208
1209
1210/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAlloc} */
1211static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAlloc(PPDMUSBINS pUsbIns, size_t cb)
1212{
1213 PDMUSB_ASSERT_USBINS(pUsbIns);
1214 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1215
1216 void *pv = MMR3HeapAlloc(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1217
1218 LogFlow(("pdmR3UsbHlp_MMHeapAlloc: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1219 return pv;
1220}
1221
1222
1223/** @interface_method_impl{PDMUSBHLP,pfnMMHeapAllocZ} */
1224static DECLCALLBACK(void *) pdmR3UsbHlp_MMHeapAllocZ(PPDMUSBINS pUsbIns, size_t cb)
1225{
1226 PDMUSB_ASSERT_USBINS(pUsbIns);
1227 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: cb=%#x\n", pUsbIns->pReg->szName, pUsbIns->iInstance, cb));
1228
1229 void *pv = MMR3HeapAllocZ(pUsbIns->Internal.s.pVM, MM_TAG_PDM_USB_USER, cb);
1230
1231 LogFlow(("pdmR3UsbHlp_MMHeapAllocZ: caller='%s'/%d: returns %p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pv));
1232 return pv;
1233}
1234
1235
1236/** @interface_method_impl{PDMUSBHLP,pfnPDMQueueCreate} */
1237static DECLCALLBACK(int) pdmR3UsbHlp_PDMQueueCreate(PPDMUSBINS pUsbIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval,
1238 PFNPDMQUEUEUSB pfnCallback, const char *pszName, PPDMQUEUE *ppQueue)
1239{
1240 PDMUSB_ASSERT_USBINS(pUsbIns);
1241 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: cbItem=%#x cItems=%#x cMilliesInterval=%u pfnCallback=%p pszName=%p:{%s} ppQueue=%p\n",
1242 pUsbIns->pReg->szName, pUsbIns->iInstance, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, pszName, ppQueue));
1243
1244 PVM pVM = pUsbIns->Internal.s.pVM;
1245 VM_ASSERT_EMT(pVM);
1246
1247 if (pUsbIns->iInstance > 0)
1248 {
1249 pszName = MMR3HeapAPrintf(pVM, MM_TAG_PDM_DEVICE_DESC, "%s_%u", pszName, pUsbIns->iInstance);
1250 AssertLogRelReturn(pszName, VERR_NO_MEMORY);
1251 }
1252
1253 /** @todo int rc = PDMR3QueueCreateUsb(pVM, pUsbIns, cbItem, cItems, cMilliesInterval, pfnCallback, fGCEnabled, pszName, ppQueue); */
1254 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1255
1256 LogFlow(("pdmR3UsbHlp_PDMQueueCreate: caller='%s'/%d: returns %Rrc *ppQueue=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc, *ppQueue));
1257 return rc;
1258}
1259
1260
1261/** @interface_method_impl{PDMUSBHLP,pfnSSMRegister} */
1262static DECLCALLBACK(int) pdmR3UsbHlp_SSMRegister(PPDMUSBINS pUsbIns, uint32_t uVersion, size_t cbGuess,
1263 PFNSSMUSBLIVEPREP pfnLivePrep, PFNSSMUSBLIVEEXEC pfnLiveExec, PFNSSMUSBLIVEVOTE pfnLiveVote,
1264 PFNSSMUSBSAVEPREP pfnSavePrep, PFNSSMUSBSAVEEXEC pfnSaveExec, PFNSSMUSBSAVEDONE pfnSaveDone,
1265 PFNSSMUSBLOADPREP pfnLoadPrep, PFNSSMUSBLOADEXEC pfnLoadExec, PFNSSMUSBLOADDONE pfnLoadDone)
1266{
1267 PDMUSB_ASSERT_USBINS(pUsbIns);
1268 VM_ASSERT_EMT(pUsbIns->Internal.s.pVM);
1269 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: uVersion=#x cbGuess=%#x\n"
1270 " pfnLivePrep=%p pfnLiveExec=%p pfnLiveVote=%p pfnSavePrep=%p pfnSaveExec=%p pfnSaveDone=%p pszLoadPrep=%p pfnLoadExec=%p pfnLoadDone=%p\n",
1271 pUsbIns->pReg->szName, pUsbIns->iInstance, uVersion, cbGuess,
1272 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1273 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1274 pfnLoadPrep, pfnLoadExec, pfnLoadDone));
1275
1276 /** @todo
1277 int rc = SSMR3RegisterUsb(pUsbIns->Internal.s.pVM, pUsbIns, pUsbIns->pReg->szName, pUsbIns->iInstance,
1278 uVersion, cbGuess,
1279 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1280 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1281 pfnLoadPrep, pfnLoadExec, pfnLoadDone); */
1282 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1283
1284 LogFlow(("pdmR3UsbHlp_SSMRegister: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1285 return rc;
1286}
1287
1288
1289/** @interface_method_impl{PDMUSBHLP,pfnSTAMRegisterV} */
1290static DECLCALLBACK(void) pdmR3UsbHlp_STAMRegisterV(PPDMUSBINS pUsbIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1291 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list args)
1292{
1293 PDMUSB_ASSERT_USBINS(pUsbIns);
1294 PVM pVM = pUsbIns->Internal.s.pVM;
1295 VM_ASSERT_EMT(pVM);
1296
1297 int rc = STAMR3RegisterV(pVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
1298 AssertRC(rc);
1299
1300 NOREF(pVM);
1301}
1302
1303
1304/** @interface_method_impl{PDMUSBHLP,pfnTMTimerCreate} */
1305static DECLCALLBACK(int) pdmR3UsbHlp_TMTimerCreate(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
1306 uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1307{
1308 PDMUSB_ASSERT_USBINS(pUsbIns);
1309 PVM pVM = pUsbIns->Internal.s.pVM;
1310 VM_ASSERT_EMT(pVM);
1311 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: enmClock=%d pfnCallback=%p pvUser=%p fFlags=%#x pszDesc=%p:{%s} ppTimer=%p\n",
1312 pUsbIns->pReg->szName, pUsbIns->iInstance, enmClock, pfnCallback, pvUser, fFlags, pszDesc, pszDesc, ppTimer));
1313
1314 if (pUsbIns->iInstance > 0) /** @todo use a string cache here later. */
1315 {
1316 char *pszDesc2 = MMR3HeapAPrintf(pVM, MM_TAG_PDM_USB_DESC, "%s [%u]", pszDesc, pUsbIns->iInstance);
1317 if (pszDesc2)
1318 pszDesc = pszDesc2;
1319 }
1320
1321 /** @todo
1322 int rc = TMR3TimerCreateUsb(pVM, pUsbIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer); */
1323 int rc = VERR_NOT_IMPLEMENTED; AssertFailed();
1324
1325 LogFlow(("pdmR3UsbHlp_TMTimerCreate: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1326 return rc;
1327}
1328
1329
1330/** @interface_method_impl{PDMUSBHLP,pfnVMSetErrorV} */
1331static DECLCALLBACK(int) pdmR3UsbHlp_VMSetErrorV(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
1332{
1333 PDMUSB_ASSERT_USBINS(pUsbIns);
1334 int rc2 = VMSetErrorV(pUsbIns->Internal.s.pVM, rc, RT_SRC_POS_ARGS, pszFormat, va); Assert(rc2 == rc); NOREF(rc2);
1335 return rc;
1336}
1337
1338
1339/** @interface_method_impl{PDMUSBHLP,pfnVMSetRuntimeErrorV} */
1340static DECLCALLBACK(int) pdmR3UsbHlp_VMSetRuntimeErrorV(PPDMUSBINS pUsbIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va)
1341{
1342 PDMUSB_ASSERT_USBINS(pUsbIns);
1343 int rc = VMSetRuntimeErrorV(pUsbIns->Internal.s.pVM, fFlags, pszErrorId, pszFormat, va);
1344 return rc;
1345}
1346
1347
1348/** @interface_method_impl{PDMUSBHLP,pfnVMState} */
1349static DECLCALLBACK(VMSTATE) pdmR3UsbHlp_VMState(PPDMUSBINS pUsbIns)
1350{
1351 PDMUSB_ASSERT_USBINS(pUsbIns);
1352
1353 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1354
1355 LogFlow(("pdmR3UsbHlp_VMState: caller='%s'/%d: returns %d (%s)\n", pUsbIns->pReg->szName, pUsbIns->iInstance,
1356 enmVMState, VMR3GetStateName(enmVMState)));
1357 return enmVMState;
1358}
1359
1360
1361/** @interface_method_impl{PDMUSBHLP,pfnSetAsyncNotification} */
1362static DECLCALLBACK(int) pdmR3UsbHlp_SetAsyncNotification(PPDMUSBINS pUsbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify)
1363{
1364 PDMUSB_ASSERT_USBINS(pUsbIns);
1365 VM_ASSERT_EMT0(pUsbIns->Internal.s.pVM);
1366 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: pfnAsyncNotify=%p\n", pUsbIns->pReg->szName, pUsbIns->iInstance, pfnAsyncNotify));
1367
1368 int rc = VINF_SUCCESS;
1369 AssertStmt(pfnAsyncNotify, rc = VERR_INVALID_PARAMETER);
1370 AssertStmt(!pUsbIns->Internal.s.pfnAsyncNotify, rc = VERR_WRONG_ORDER);
1371 AssertStmt(pUsbIns->Internal.s.fVMSuspended || pUsbIns->Internal.s.fVMReset, rc = VERR_WRONG_ORDER);
1372 VMSTATE enmVMState = VMR3GetState(pUsbIns->Internal.s.pVM);
1373 AssertStmt( enmVMState == VMSTATE_SUSPENDING
1374 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1375 || enmVMState == VMSTATE_SUSPENDING_LS
1376 || enmVMState == VMSTATE_RESETTING
1377 || enmVMState == VMSTATE_RESETTING_LS
1378 || enmVMState == VMSTATE_POWERING_OFF
1379 || enmVMState == VMSTATE_POWERING_OFF_LS,
1380 rc = VERR_INVALID_STATE);
1381
1382 if (RT_SUCCESS(rc))
1383 pUsbIns->Internal.s.pfnAsyncNotify = pfnAsyncNotify;
1384
1385 LogFlow(("pdmR3UsbHlp_SetAsyncNotification: caller='%s'/%d: returns %Rrc\n", pUsbIns->pReg->szName, pUsbIns->iInstance, rc));
1386 return rc;
1387}
1388
1389
1390/** @interface_method_impl{PDMUSBHLP,pfnAsyncNotificationCompleted} */
1391static DECLCALLBACK(void) pdmR3UsbHlp_AsyncNotificationCompleted(PPDMUSBINS pUsbIns)
1392{
1393 PDMUSB_ASSERT_USBINS(pUsbIns);
1394 PVM pVM = pUsbIns->Internal.s.pVM;
1395
1396 VMSTATE enmVMState = VMR3GetState(pVM);
1397 if ( enmVMState == VMSTATE_SUSPENDING
1398 || enmVMState == VMSTATE_SUSPENDING_EXT_LS
1399 || enmVMState == VMSTATE_SUSPENDING_LS
1400 || enmVMState == VMSTATE_RESETTING
1401 || enmVMState == VMSTATE_RESETTING_LS
1402 || enmVMState == VMSTATE_POWERING_OFF
1403 || enmVMState == VMSTATE_POWERING_OFF_LS)
1404 {
1405 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d:\n", pUsbIns->pReg->szName, pUsbIns->iInstance));
1406 VMR3AsyncPdmNotificationWakeupU(pVM->pUVM);
1407 }
1408 else
1409 LogFlow(("pdmR3UsbHlp_AsyncNotificationCompleted: caller='%s'/%d: enmVMState=%d\n", pUsbIns->pReg->szName, pUsbIns->iInstance, enmVMState));
1410}
1411
1412
1413/**
1414 * The USB device helper structure.
1415 */
1416const PDMUSBHLP g_pdmR3UsbHlp =
1417{
1418 PDM_USBHLP_VERSION,
1419 pdmR3UsbHlp_DriverAttach,
1420 pdmR3UsbHlp_AssertEMT,
1421 pdmR3UsbHlp_AssertOther,
1422 pdmR3UsbHlp_DBGFStopV,
1423 pdmR3UsbHlp_DBGFInfoRegister,
1424 pdmR3UsbHlp_MMHeapAlloc,
1425 pdmR3UsbHlp_MMHeapAllocZ,
1426 pdmR3UsbHlp_PDMQueueCreate,
1427 pdmR3UsbHlp_SSMRegister,
1428 pdmR3UsbHlp_STAMRegisterV,
1429 pdmR3UsbHlp_TMTimerCreate,
1430 pdmR3UsbHlp_VMSetErrorV,
1431 pdmR3UsbHlp_VMSetRuntimeErrorV,
1432 pdmR3UsbHlp_VMState,
1433 pdmR3UsbHlp_SetAsyncNotification,
1434 pdmR3UsbHlp_AsyncNotificationCompleted,
1435 PDM_USBHLP_VERSION
1436};
1437
1438/** @} */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use