VirtualBox

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

Last change on this file since 42640 was 42139, checked in by vboxsync, 12 years ago

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