VirtualBox

source: vbox/trunk/include/VBox/vmm/pdmdrv.h@ 41788

Last change on this file since 41788 was 40907, checked in by vboxsync, 13 years ago

Working on tracking IRQs for tracing and logging purposes.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 70.5 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Drivers.
3 */
4
5/*
6 * Copyright (C) 2006-2010 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_vmm_pdmdrv_h
27#define ___VBox_vmm_pdmdrv_h
28
29#include <VBox/vmm/pdmqueue.h>
30#include <VBox/vmm/pdmcritsect.h>
31#include <VBox/vmm/pdmthread.h>
32#include <VBox/vmm/pdmifs.h>
33#include <VBox/vmm/pdmins.h>
34#include <VBox/vmm/pdmcommon.h>
35#include <VBox/vmm/pdmasynccompletion.h>
36#ifdef VBOX_WITH_NETSHAPER
37#include <VBox/vmm/pdmnetshaper.h>
38#endif /* VBOX_WITH_NETSHAPER */
39#include <VBox/vmm/pdmblkcache.h>
40#include <VBox/vmm/tm.h>
41#include <VBox/vmm/ssm.h>
42#include <VBox/vmm/cfgm.h>
43#include <VBox/vmm/dbgf.h>
44#include <VBox/vmm/mm.h>
45#include <VBox/vmm/ftm.h>
46#include <VBox/err.h>
47#include <iprt/stdarg.h>
48
49
50RT_C_DECLS_BEGIN
51
52/** @defgroup grp_pdm_driver The PDM Drivers API
53 * @ingroup grp_pdm
54 * @{
55 */
56
57/** Pointer const PDM Driver API, ring-3. */
58typedef R3PTRTYPE(struct PDMDRVHLPR3 const *) PCPDMDRVHLPR3;
59/** Pointer const PDM Driver API, ring-0. */
60typedef R0PTRTYPE(struct PDMDRVHLPR0 const *) PCPDMDRVHLPR0;
61/** Pointer const PDM Driver API, raw-mode context. */
62typedef RCPTRTYPE(struct PDMDRVHLPRC const *) PCPDMDRVHLPRC;
63
64
65/**
66 * Construct a driver instance for a VM.
67 *
68 * @returns VBox status.
69 * @param pDrvIns The driver instance data. If the registration structure
70 * is needed, it can be accessed thru pDrvIns->pReg.
71 * @param pCfg Configuration node handle for the driver. This is
72 * expected to be in high demand in the constructor and is
73 * therefore passed as an argument. When using it at other
74 * times, it can be accessed via pDrvIns->pCfg.
75 * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
76 */
77typedef DECLCALLBACK(int) FNPDMDRVCONSTRUCT(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags);
78/** Pointer to a FNPDMDRVCONSTRUCT() function. */
79typedef FNPDMDRVCONSTRUCT *PFNPDMDRVCONSTRUCT;
80
81/**
82 * Destruct a driver instance.
83 *
84 * Most VM resources are freed by the VM. This callback is provided so that
85 * any non-VM resources can be freed correctly.
86 *
87 * @param pDrvIns The driver instance data.
88 */
89typedef DECLCALLBACK(void) FNPDMDRVDESTRUCT(PPDMDRVINS pDrvIns);
90/** Pointer to a FNPDMDRVDESTRUCT() function. */
91typedef FNPDMDRVDESTRUCT *PFNPDMDRVDESTRUCT;
92
93/**
94 * Driver relocation callback.
95 *
96 * This is called when the instance data has been relocated in raw-mode context
97 * (RC). It is also called when the RC hypervisor selects changes. The driver
98 * must fixup all necessary pointers and re-query all interfaces to other RC
99 * devices and drivers.
100 *
101 * Before the RC code is executed the first time, this function will be called
102 * with a 0 delta so RC pointer calculations can be one in one place.
103 *
104 * @param pDrvIns Pointer to the driver instance.
105 * @param offDelta The relocation delta relative to the old location.
106 *
107 * @remark A relocation CANNOT fail.
108 */
109typedef DECLCALLBACK(void) FNPDMDRVRELOCATE(PPDMDRVINS pDrvIns, RTGCINTPTR offDelta);
110/** Pointer to a FNPDMDRVRELOCATE() function. */
111typedef FNPDMDRVRELOCATE *PFNPDMDRVRELOCATE;
112
113/**
114 * Driver I/O Control interface.
115 *
116 * This is used by external components, such as the COM interface, to
117 * communicate with a driver using a driver specific interface. Generally,
118 * the driver interfaces are used for this task.
119 *
120 * @returns VBox status code.
121 * @param pDrvIns Pointer to the driver instance.
122 * @param uFunction Function to perform.
123 * @param pvIn Pointer to input data.
124 * @param cbIn Size of input data.
125 * @param pvOut Pointer to output data.
126 * @param cbOut Size of output data.
127 * @param pcbOut Where to store the actual size of the output data.
128 */
129typedef DECLCALLBACK(int) FNPDMDRVIOCTL(PPDMDRVINS pDrvIns, uint32_t uFunction,
130 void *pvIn, uint32_t cbIn,
131 void *pvOut, uint32_t cbOut, uint32_t *pcbOut);
132/** Pointer to a FNPDMDRVIOCTL() function. */
133typedef FNPDMDRVIOCTL *PFNPDMDRVIOCTL;
134
135/**
136 * Power On notification.
137 *
138 * @param pDrvIns The driver instance data.
139 */
140typedef DECLCALLBACK(void) FNPDMDRVPOWERON(PPDMDRVINS pDrvIns);
141/** Pointer to a FNPDMDRVPOWERON() function. */
142typedef FNPDMDRVPOWERON *PFNPDMDRVPOWERON;
143
144/**
145 * Reset notification.
146 *
147 * @returns VBox status.
148 * @param pDrvIns The driver instance data.
149 */
150typedef DECLCALLBACK(void) FNPDMDRVRESET(PPDMDRVINS pDrvIns);
151/** Pointer to a FNPDMDRVRESET() function. */
152typedef FNPDMDRVRESET *PFNPDMDRVRESET;
153
154/**
155 * Suspend notification.
156 *
157 * @returns VBox status.
158 * @param pDrvIns The driver instance data.
159 */
160typedef DECLCALLBACK(void) FNPDMDRVSUSPEND(PPDMDRVINS pDrvIns);
161/** Pointer to a FNPDMDRVSUSPEND() function. */
162typedef FNPDMDRVSUSPEND *PFNPDMDRVSUSPEND;
163
164/**
165 * Resume notification.
166 *
167 * @returns VBox status.
168 * @param pDrvIns The driver instance data.
169 */
170typedef DECLCALLBACK(void) FNPDMDRVRESUME(PPDMDRVINS pDrvIns);
171/** Pointer to a FNPDMDRVRESUME() function. */
172typedef FNPDMDRVRESUME *PFNPDMDRVRESUME;
173
174/**
175 * Power Off notification.
176 *
177 * This is only called when the VMR3PowerOff call is made on a running VM. This
178 * means that there is no notification if the VM was suspended before being
179 * powered of. There will also be no callback when hot plugging devices or when
180 * replumbing the driver stack.
181 *
182 * @param pDrvIns The driver instance data.
183 */
184typedef DECLCALLBACK(void) FNPDMDRVPOWEROFF(PPDMDRVINS pDrvIns);
185/** Pointer to a FNPDMDRVPOWEROFF() function. */
186typedef FNPDMDRVPOWEROFF *PFNPDMDRVPOWEROFF;
187
188/**
189 * Attach command.
190 *
191 * This is called to let the drive attach to a driver at runtime. This is not
192 * called during VM construction, the driver constructor have to do this by
193 * calling PDMDrvHlpAttach.
194 *
195 * This is like plugging in the keyboard or mouse after turning on the PC.
196 *
197 * @returns VBox status code.
198 * @param pDrvIns The driver instance.
199 * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
200 */
201typedef DECLCALLBACK(int) FNPDMDRVATTACH(PPDMDRVINS pDrvIns, uint32_t fFlags);
202/** Pointer to a FNPDMDRVATTACH() function. */
203typedef FNPDMDRVATTACH *PFNPDMDRVATTACH;
204
205/**
206 * Detach notification.
207 *
208 * This is called when a driver below it in the chain is detaching itself
209 * from it. The driver should adjust it's state to reflect this.
210 *
211 * This is like ejecting a cdrom or floppy.
212 *
213 * @param pDrvIns The driver instance.
214 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
215 */
216typedef DECLCALLBACK(void) FNPDMDRVDETACH(PPDMDRVINS pDrvIns, uint32_t fFlags);
217/** Pointer to a FNPDMDRVDETACH() function. */
218typedef FNPDMDRVDETACH *PFNPDMDRVDETACH;
219
220
221
222/**
223 * PDM Driver Registration Structure.
224 *
225 * This structure is used when registering a driver from VBoxInitDrivers() (in
226 * host ring-3 context). PDM will continue use till the VM is terminated.
227 */
228typedef struct PDMDRVREG
229{
230 /** Structure version. PDM_DRVREG_VERSION defines the current version. */
231 uint32_t u32Version;
232 /** Driver name. */
233 char szName[32];
234 /** Name of the raw-mode context module (no path).
235 * Only evalutated if PDM_DRVREG_FLAGS_RC is set. */
236 char szRCMod[32];
237 /** Name of the ring-0 module (no path).
238 * Only evalutated if PDM_DRVREG_FLAGS_R0 is set. */
239 char szR0Mod[32];
240 /** The description of the driver. The UTF-8 string pointed to shall, like this structure,
241 * remain unchanged from registration till VM destruction. */
242 const char *pszDescription;
243
244 /** Flags, combination of the PDM_DRVREG_FLAGS_* \#defines. */
245 uint32_t fFlags;
246 /** Driver class(es), combination of the PDM_DRVREG_CLASS_* \#defines. */
247 uint32_t fClass;
248 /** Maximum number of instances (per VM). */
249 uint32_t cMaxInstances;
250 /** Size of the instance data. */
251 uint32_t cbInstance;
252
253 /** Construct instance - required. */
254 PFNPDMDRVCONSTRUCT pfnConstruct;
255 /** Destruct instance - optional. */
256 PFNPDMDRVDESTRUCT pfnDestruct;
257 /** Relocation command - optional. */
258 PFNPDMDRVRELOCATE pfnRelocate;
259 /** I/O control - optional. */
260 PFNPDMDRVIOCTL pfnIOCtl;
261 /** Power on notification - optional. */
262 PFNPDMDRVPOWERON pfnPowerOn;
263 /** Reset notification - optional. */
264 PFNPDMDRVRESET pfnReset;
265 /** Suspend notification - optional. */
266 PFNPDMDRVSUSPEND pfnSuspend;
267 /** Resume notification - optional. */
268 PFNPDMDRVRESUME pfnResume;
269 /** Attach command - optional. */
270 PFNPDMDRVATTACH pfnAttach;
271 /** Detach notification - optional. */
272 PFNPDMDRVDETACH pfnDetach;
273 /** Power off notification - optional. */
274 PFNPDMDRVPOWEROFF pfnPowerOff;
275 /** @todo */
276 PFNRT pfnSoftReset;
277 /** Initialization safty marker. */
278 uint32_t u32VersionEnd;
279} PDMDRVREG;
280/** Pointer to a PDM Driver Structure. */
281typedef PDMDRVREG *PPDMDRVREG;
282/** Const pointer to a PDM Driver Structure. */
283typedef PDMDRVREG const *PCPDMDRVREG;
284
285/** Current DRVREG version number. */
286#define PDM_DRVREG_VERSION PDM_VERSION_MAKE(0xf0ff, 1, 0)
287
288/** PDM Driver Flags.
289 * @{ */
290/** @def PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT
291 * The bit count for the current host. */
292#if HC_ARCH_BITS == 32
293# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT UINT32_C(0x00000001)
294#elif HC_ARCH_BITS == 64
295# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT UINT32_C(0x00000002)
296#else
297# error Unsupported HC_ARCH_BITS value.
298#endif
299/** The host bit count mask. */
300#define PDM_DRVREG_FLAGS_HOST_BITS_MASK UINT32_C(0x00000003)
301/** This flag is used to indicate that the driver has a RC component. */
302#define PDM_DRVREG_FLAGS_RC UINT32_C(0x00000010)
303/** This flag is used to indicate that the driver has a R0 component. */
304#define PDM_DRVREG_FLAGS_R0 UINT32_C(0x00000020)
305
306/** @} */
307
308
309/** PDM Driver Classes.
310 * @{ */
311/** Mouse input driver. */
312#define PDM_DRVREG_CLASS_MOUSE RT_BIT(0)
313/** Keyboard input driver. */
314#define PDM_DRVREG_CLASS_KEYBOARD RT_BIT(1)
315/** Display driver. */
316#define PDM_DRVREG_CLASS_DISPLAY RT_BIT(2)
317/** Network transport driver. */
318#define PDM_DRVREG_CLASS_NETWORK RT_BIT(3)
319/** Block driver. */
320#define PDM_DRVREG_CLASS_BLOCK RT_BIT(4)
321/** Media driver. */
322#define PDM_DRVREG_CLASS_MEDIA RT_BIT(5)
323/** Mountable driver. */
324#define PDM_DRVREG_CLASS_MOUNTABLE RT_BIT(6)
325/** Audio driver. */
326#define PDM_DRVREG_CLASS_AUDIO RT_BIT(7)
327/** VMMDev driver. */
328#define PDM_DRVREG_CLASS_VMMDEV RT_BIT(8)
329/** Status driver. */
330#define PDM_DRVREG_CLASS_STATUS RT_BIT(9)
331/** ACPI driver. */
332#define PDM_DRVREG_CLASS_ACPI RT_BIT(10)
333/** USB related driver. */
334#define PDM_DRVREG_CLASS_USB RT_BIT(11)
335/** ISCSI Transport related driver. */
336#define PDM_DRVREG_CLASS_ISCSITRANSPORT RT_BIT(12)
337/** Char driver. */
338#define PDM_DRVREG_CLASS_CHAR RT_BIT(13)
339/** Stream driver. */
340#define PDM_DRVREG_CLASS_STREAM RT_BIT(14)
341/** SCSI driver. */
342#define PDM_DRVREG_CLASS_SCSI RT_BIT(15)
343/** Generic raw PCI device driver. */
344#define PDM_DRVREG_CLASS_PCIRAW RT_BIT(16)
345/** @} */
346
347
348/**
349 * PDM Driver Instance.
350 *
351 * @implements PDMIBASE
352 */
353typedef struct PDMDRVINS
354{
355 /** Structure version. PDM_DRVINS_VERSION defines the current version. */
356 uint32_t u32Version;
357 /** Driver instance number. */
358 uint32_t iInstance;
359
360 /** Pointer the PDM Driver API. */
361 RCPTRTYPE(PCPDMDRVHLPRC) pHlpRC;
362 /** Pointer to driver instance data. */
363 RCPTRTYPE(void *) pvInstanceDataRC;
364
365 /** Pointer the PDM Driver API. */
366 R0PTRTYPE(PCPDMDRVHLPR0) pHlpR0;
367 /** Pointer to driver instance data. */
368 R0PTRTYPE(void *) pvInstanceDataR0;
369
370 /** Pointer the PDM Driver API. */
371 R3PTRTYPE(PCPDMDRVHLPR3) pHlpR3;
372 /** Pointer to driver instance data. */
373 R3PTRTYPE(void *) pvInstanceDataR3;
374
375 /** Pointer to driver registration structure. */
376 R3PTRTYPE(PCPDMDRVREG) pReg;
377 /** Configuration handle. */
378 R3PTRTYPE(PCFGMNODE) pCfg;
379
380 /** Pointer to the base interface of the device/driver instance above. */
381 R3PTRTYPE(PPDMIBASE) pUpBase;
382 /** Pointer to the base interface of the driver instance below. */
383 R3PTRTYPE(PPDMIBASE) pDownBase;
384
385 /** The base interface of the driver.
386 * The driver constructor initializes this. */
387 PDMIBASE IBase;
388
389 /** Tracing indicator. */
390 uint32_t fTracing;
391 /** The tracing ID of this device. */
392 uint32_t idTracing;
393#if HC_ARCH_BITS == 32
394 /** Align the internal data more naturally. */
395 uint32_t au32Padding[HC_ARCH_BITS == 32 ? 7 : 0];
396#endif
397
398 /** Internal data. */
399 union
400 {
401#ifdef PDMDRVINSINT_DECLARED
402 PDMDRVINSINT s;
403#endif
404 uint8_t padding[HC_ARCH_BITS == 32 ? 40 + 32 : 72 + 24];
405 } Internal;
406
407 /** Driver instance data. The size of this area is defined
408 * in the PDMDRVREG::cbInstanceData field. */
409 char achInstanceData[4];
410} PDMDRVINS;
411
412/** Current DRVREG version number. */
413#define PDM_DRVINS_VERSION PDM_VERSION_MAKE(0xf0fe, 2, 0)
414
415/** Converts a pointer to the PDMDRVINS::IBase to a pointer to PDMDRVINS. */
416#define PDMIBASE_2_PDMDRV(pInterface) ( (PPDMDRVINS)((char *)(pInterface) - RT_OFFSETOF(PDMDRVINS, IBase)) )
417
418/** @def PDMDRVINS_2_RCPTR
419 * Converts a PDM Driver instance pointer a RC PDM Driver instance pointer.
420 */
421#define PDMDRVINS_2_RCPTR(pDrvIns) ( (RCPTRTYPE(PPDMDRVINS))((RTGCUINTPTR)(pDrvIns)->pvInstanceDataRC - RT_OFFSETOF(PDMDRVINS, achInstanceData)) )
422
423/** @def PDMDRVINS_2_R3PTR
424 * Converts a PDM Driver instance pointer a R3 PDM Driver instance pointer.
425 */
426#define PDMDRVINS_2_R3PTR(pDrvIns) ( (R3PTRTYPE(PPDMDRVINS))((RTHCUINTPTR)(pDrvIns)->pvInstanceDataR3 - RT_OFFSETOF(PDMDRVINS, achInstanceData)) )
427
428/** @def PDMDRVINS_2_R0PTR
429 * Converts a PDM Driver instance pointer a R0 PDM Driver instance pointer.
430 */
431#define PDMDRVINS_2_R0PTR(pDrvIns) ( (R0PTRTYPE(PPDMDRVINS))((RTR0UINTPTR)(pDrvIns)->pvInstanceDataR0 - RT_OFFSETOF(PDMDRVINS, achInstanceData)) )
432
433
434
435/**
436 * Checks the structure versions of the drive instance and driver helpers,
437 * returning if they are incompatible.
438 *
439 * Intended for the constructor.
440 *
441 * @param pDrvIns Pointer to the PDM driver instance.
442 */
443#define PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns) \
444 do \
445 { \
446 PPDMDRVINS pDrvInsTypeCheck = (pDrvIns); NOREF(pDrvInsTypeCheck); \
447 AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->u32Version, PDM_DRVINS_VERSION), \
448 ("DrvIns=%#x mine=%#x\n", (pDrvIns)->u32Version, PDM_DRVINS_VERSION), \
449 VERR_PDM_DRVINS_VERSION_MISMATCH); \
450 AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION), \
451 ("DrvHlp=%#x mine=%#x\n", (pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION), \
452 VERR_PDM_DRVHLPR3_VERSION_MISMATCH); \
453 } while (0)
454
455/**
456 * Quietly checks the structure versions of the drive instance and driver
457 * helpers, returning if they are incompatible.
458 *
459 * Intended for the destructor.
460 *
461 * @param pDrvIns Pointer to the PDM driver instance.
462 */
463#define PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns) \
464 do \
465 { \
466 PPDMDRVINS pDrvInsTypeCheck = (pDrvIns); NOREF(pDrvInsTypeCheck); \
467 if (RT_UNLIKELY( !PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->u32Version, PDM_DRVINS_VERSION) \
468 || !PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION)) ) \
469 return; \
470 } while (0)
471
472/**
473 * Wrapper around CFGMR3ValidateConfig for the root config for use in the
474 * constructor - returns on failure.
475 *
476 * This should be invoked after having initialized the instance data
477 * sufficiently for the correct operation of the destructor. The destructor is
478 * always called!
479 *
480 * @param pDrvIns Pointer to the PDM driver instance.
481 * @param pszValidValues Patterns describing the valid value names. See
482 * RTStrSimplePatternMultiMatch for details on the
483 * pattern syntax.
484 * @param pszValidNodes Patterns describing the valid node (key) names.
485 * Pass empty string if no valid nodess.
486 */
487#define PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, pszValidValues, pszValidNodes) \
488 do \
489 { \
490 int rcValCfg = CFGMR3ValidateConfig((pDrvIns)->pCfg, "/", pszValidValues, pszValidNodes, \
491 (pDrvIns)->pReg->szName, (pDrvIns)->iInstance); \
492 if (RT_FAILURE(rcValCfg)) \
493 return rcValCfg; \
494 } while (0)
495
496
497
498/**
499 * USB hub registration structure.
500 */
501typedef struct PDMUSBHUBREG
502{
503 /** Structure version number. PDM_USBHUBREG_VERSION defines the current version. */
504 uint32_t u32Version;
505
506 /**
507 * Request the hub to attach of the specified device.
508 *
509 * @returns VBox status code.
510 * @param pDrvIns The hub instance.
511 * @param pUsbIns The device to attach.
512 * @param piPort Where to store the port number the device was attached to.
513 * @thread EMT.
514 */
515 DECLR3CALLBACKMEMBER(int, pfnAttachDevice,(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, uint32_t *piPort));
516
517 /**
518 * Request the hub to detach of the specified device.
519 *
520 * The device has previously been attached to the hub with the
521 * pfnAttachDevice call. This call is not currently expected to
522 * fail.
523 *
524 * @returns VBox status code.
525 * @param pDrvIns The hub instance.
526 * @param pUsbIns The device to detach.
527 * @param iPort The port number returned by the attach call.
528 * @thread EMT.
529 */
530 DECLR3CALLBACKMEMBER(int, pfnDetachDevice,(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, uint32_t iPort));
531
532 /** Counterpart to u32Version, same value. */
533 uint32_t u32TheEnd;
534} PDMUSBHUBREG;
535/** Pointer to a const USB hub registration structure. */
536typedef const PDMUSBHUBREG *PCPDMUSBHUBREG;
537
538/** Current PDMUSBHUBREG version number. */
539#define PDM_USBHUBREG_VERSION PDM_VERSION_MAKE(0xf0fd, 1, 0)
540
541
542/**
543 * USB hub helpers.
544 * This is currently just a place holder.
545 */
546typedef struct PDMUSBHUBHLP
547{
548 /** Structure version. PDM_USBHUBHLP_VERSION defines the current version. */
549 uint32_t u32Version;
550
551 /** Just a safety precaution. */
552 uint32_t u32TheEnd;
553} PDMUSBHUBHLP;
554/** Pointer to PCI helpers. */
555typedef PDMUSBHUBHLP *PPDMUSBHUBHLP;
556/** Pointer to const PCI helpers. */
557typedef const PDMUSBHUBHLP *PCPDMUSBHUBHLP;
558/** Pointer to const PCI helpers pointer. */
559typedef PCPDMUSBHUBHLP *PPCPDMUSBHUBHLP;
560
561/** Current PDMUSBHUBHLP version number. */
562#define PDM_USBHUBHLP_VERSION PDM_VERSION_MAKE(0xf0fc, 1, 0)
563
564
565/**
566 * PDM Driver API - raw-mode context variant.
567 */
568typedef struct PDMDRVHLPRC
569{
570 /** Structure version. PDM_DRVHLPRC_VERSION defines the current version. */
571 uint32_t u32Version;
572
573 /**
574 * Set the VM error message
575 *
576 * @returns rc.
577 * @param pDrvIns Driver instance.
578 * @param rc VBox status code.
579 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
580 * @param pszFormat Error message format string.
581 * @param ... Error message arguments.
582 */
583 DECLRCCALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...));
584
585 /**
586 * Set the VM error message
587 *
588 * @returns rc.
589 * @param pDrvIns Driver instance.
590 * @param rc VBox status code.
591 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
592 * @param pszFormat Error message format string.
593 * @param va Error message arguments.
594 */
595 DECLRCCALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
596
597 /**
598 * Set the VM runtime error message
599 *
600 * @returns VBox status code.
601 * @param pDrvIns Driver instance.
602 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
603 * @param pszErrorId Error ID string.
604 * @param pszFormat Error message format string.
605 * @param ... Error message arguments.
606 */
607 DECLRCCALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, ...));
608
609 /**
610 * Set the VM runtime error message
611 *
612 * @returns VBox status code.
613 * @param pDrvIns Driver instance.
614 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
615 * @param pszErrorId Error ID string.
616 * @param pszFormat Error message format string.
617 * @param va Error message arguments.
618 */
619 DECLRCCALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va));
620
621 /**
622 * Assert that the current thread is the emulation thread.
623 *
624 * @returns True if correct.
625 * @returns False if wrong.
626 * @param pDrvIns Driver instance.
627 * @param pszFile Filename of the assertion location.
628 * @param iLine Linenumber of the assertion location.
629 * @param pszFunction Function of the assertion location.
630 */
631 DECLRCCALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
632
633 /**
634 * Assert that the current thread is NOT the emulation thread.
635 *
636 * @returns True if correct.
637 * @returns False if wrong.
638 * @param pDrvIns Driver instance.
639 * @param pszFile Filename of the assertion location.
640 * @param iLine Linenumber of the assertion location.
641 * @param pszFunction Function of the assertion location.
642 */
643 DECLRCCALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
644
645 /**
646 * Notify FTM about a checkpoint occurrence
647 *
648 * @param pDrvIns The driver instance.
649 * @param enmType Checkpoint type
650 * @thread Any
651 */
652 DECLRCCALLBACKMEMBER(int, pfnFTSetCheckpoint,(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType));
653
654 /** Just a safety precaution. */
655 uint32_t u32TheEnd;
656} PDMDRVHLPRC;
657/** Current PDMDRVHLPRC version number. */
658#define PDM_DRVHLPRC_VERSION PDM_VERSION_MAKE(0xf0f9, 2, 0)
659
660
661/**
662 * PDM Driver API, ring-0 context.
663 */
664typedef struct PDMDRVHLPR0
665{
666 /** Structure version. PDM_DRVHLPR0_VERSION defines the current version. */
667 uint32_t u32Version;
668
669 /**
670 * Set the VM error message
671 *
672 * @returns rc.
673 * @param pDrvIns Driver instance.
674 * @param rc VBox status code.
675 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
676 * @param pszFormat Error message format string.
677 * @param ... Error message arguments.
678 */
679 DECLR0CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...));
680
681 /**
682 * Set the VM error message
683 *
684 * @returns rc.
685 * @param pDrvIns Driver instance.
686 * @param rc VBox status code.
687 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
688 * @param pszFormat Error message format string.
689 * @param va Error message arguments.
690 */
691 DECLR0CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
692
693 /**
694 * Set the VM runtime error message
695 *
696 * @returns VBox status code.
697 * @param pDrvIns Driver instance.
698 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
699 * @param pszErrorId Error ID string.
700 * @param pszFormat Error message format string.
701 * @param ... Error message arguments.
702 */
703 DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, ...));
704
705 /**
706 * Set the VM runtime error message
707 *
708 * @returns VBox status code.
709 * @param pDrvIns Driver instance.
710 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
711 * @param pszErrorId Error ID string.
712 * @param pszFormat Error message format string.
713 * @param va Error message arguments.
714 */
715 DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va));
716
717 /**
718 * Assert that the current thread is the emulation thread.
719 *
720 * @returns True if correct.
721 * @returns False if wrong.
722 * @param pDrvIns Driver instance.
723 * @param pszFile Filename of the assertion location.
724 * @param iLine Linenumber of the assertion location.
725 * @param pszFunction Function of the assertion location.
726 */
727 DECLR0CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
728
729 /**
730 * Assert that the current thread is NOT the emulation thread.
731 *
732 * @returns True if correct.
733 * @returns False if wrong.
734 * @param pDrvIns Driver instance.
735 * @param pszFile Filename of the assertion location.
736 * @param iLine Linenumber of the assertion location.
737 * @param pszFunction Function of the assertion location.
738 */
739 DECLR0CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
740
741 /**
742 * Notify FTM about a checkpoint occurrence
743 *
744 * @param pDrvIns The driver instance.
745 * @param enmType Checkpoint type
746 * @thread Any
747 */
748 DECLR0CALLBACKMEMBER(int, pfnFTSetCheckpoint,(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType));
749
750 /** Just a safety precaution. */
751 uint32_t u32TheEnd;
752} PDMDRVHLPR0;
753/** Current DRVHLP version number. */
754#define PDM_DRVHLPR0_VERSION PDM_VERSION_MAKE(0xf0f8, 2, 0)
755
756
757#ifdef IN_RING3
758
759/**
760 * PDM Driver API.
761 */
762typedef struct PDMDRVHLPR3
763{
764 /** Structure version. PDM_DRVHLPR3_VERSION defines the current version. */
765 uint32_t u32Version;
766
767 /**
768 * Attaches a driver (chain) to the driver.
769 *
770 * @returns VBox status code.
771 * @param pDrvIns Driver instance.
772 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
773 * @param ppBaseInterface Where to store the pointer to the base interface.
774 */
775 DECLR3CALLBACKMEMBER(int, pfnAttach,(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface));
776
777 /**
778 * Detach the driver the drivers below us.
779 *
780 * @returns VBox status code.
781 * @param pDrvIns Driver instance.
782 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
783 */
784 DECLR3CALLBACKMEMBER(int, pfnDetach,(PPDMDRVINS pDrvIns, uint32_t fFlags));
785
786 /**
787 * Detach the driver from the driver above it and destroy this
788 * driver and all drivers below it.
789 *
790 * @returns VBox status code.
791 * @param pDrvIns Driver instance.
792 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
793 */
794 DECLR3CALLBACKMEMBER(int, pfnDetachSelf,(PPDMDRVINS pDrvIns, uint32_t fFlags));
795
796 /**
797 * Prepare a media mount.
798 *
799 * The driver must not have anything attached to itself
800 * when calling this function as the purpose is to set up the configuration
801 * of an future attachment.
802 *
803 * @returns VBox status code
804 * @param pDrvIns Driver instance.
805 * @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
806 * constructed a configuration which can be attached to the bottom driver.
807 * @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
808 */
809 DECLR3CALLBACKMEMBER(int, pfnMountPrepare,(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver));
810
811 /**
812 * Assert that the current thread is the emulation thread.
813 *
814 * @returns True if correct.
815 * @returns False if wrong.
816 * @param pDrvIns Driver instance.
817 * @param pszFile Filename of the assertion location.
818 * @param iLine Linenumber of the assertion location.
819 * @param pszFunction Function of the assertion location.
820 */
821 DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
822
823 /**
824 * Assert that the current thread is NOT the emulation thread.
825 *
826 * @returns True if correct.
827 * @returns False if wrong.
828 * @param pDrvIns Driver instance.
829 * @param pszFile Filename of the assertion location.
830 * @param iLine Linenumber of the assertion location.
831 * @param pszFunction Function of the assertion location.
832 */
833 DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
834
835 /**
836 * Set the VM error message
837 *
838 * @returns rc.
839 * @param pDrvIns Driver instance.
840 * @param rc VBox status code.
841 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
842 * @param pszFormat Error message format string.
843 * @param ... Error message arguments.
844 */
845 DECLR3CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...));
846
847 /**
848 * Set the VM error message
849 *
850 * @returns rc.
851 * @param pDrvIns Driver instance.
852 * @param rc VBox status code.
853 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
854 * @param pszFormat Error message format string.
855 * @param va Error message arguments.
856 */
857 DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
858
859 /**
860 * Set the VM runtime error message
861 *
862 * @returns VBox status code.
863 * @param pDrvIns Driver instance.
864 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
865 * @param pszErrorId Error ID string.
866 * @param pszFormat Error message format string.
867 * @param ... Error message arguments.
868 */
869 DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, ...));
870
871 /**
872 * Set the VM runtime error message
873 *
874 * @returns VBox status code.
875 * @param pDrvIns Driver instance.
876 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
877 * @param pszErrorId Error ID string.
878 * @param pszFormat Error message format string.
879 * @param va Error message arguments.
880 */
881 DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va));
882
883 /**
884 * Gets the VM state.
885 *
886 * @returns VM state.
887 * @param pDrvIns The driver instance.
888 * @thread Any thread (just keep in mind that it's volatile info).
889 */
890 DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMDRVINS pDrvIns));
891
892 /**
893 * Checks if the VM was teleported and hasn't been fully resumed yet.
894 *
895 * @returns true / false.
896 * @param pDrvIns The driver instance.
897 * @thread Any thread.
898 */
899 DECLR3CALLBACKMEMBER(bool, pfnVMTeleportedAndNotFullyResumedYet,(PPDMDRVINS pDrvIns));
900
901 /**
902 * Gets the support driver session.
903 *
904 * This is intended for working using the semaphore API.
905 *
906 * @returns Support driver session handle.
907 * @param pDrvIns The driver instance.
908 */
909 DECLR3CALLBACKMEMBER(PSUPDRVSESSION, pfnGetSupDrvSession,(PPDMDRVINS pDrvIns));
910
911 /**
912 * Create a queue.
913 *
914 * @returns VBox status code.
915 * @param pDrvIns Driver instance.
916 * @param cbItem Size a queue item.
917 * @param cItems Number of items in the queue.
918 * @param cMilliesInterval Number of milliseconds between polling the queue.
919 * If 0 then the emulation thread will be notified whenever an item arrives.
920 * @param pfnCallback The consumer function.
921 * @param pszName The queue base name. The instance number will be
922 * appended automatically.
923 * @param ppQueue Where to store the queue handle on success.
924 * @thread The emulation thread.
925 */
926 DECLR3CALLBACKMEMBER(int, pfnQueueCreate,(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
927 PFNPDMQUEUEDRV pfnCallback, const char *pszName, PPDMQUEUE *ppQueue));
928
929 /**
930 * Query the virtual timer frequency.
931 *
932 * @returns Frequency in Hz.
933 * @param pDrvIns Driver instance.
934 * @thread Any thread.
935 */
936 DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualFreq,(PPDMDRVINS pDrvIns));
937
938 /**
939 * Query the virtual time.
940 *
941 * @returns The current virtual time.
942 * @param pDrvIns Driver instance.
943 * @thread Any thread.
944 */
945 DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualTime,(PPDMDRVINS pDrvIns));
946
947 /**
948 * Creates a timer.
949 *
950 * @returns VBox status.
951 * @param pDrvIns Driver instance.
952 * @param enmClock The clock to use on this timer.
953 * @param pfnCallback Callback function.
954 * @param pvUser The user argument to the callback.
955 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
956 * @param pszDesc Pointer to description string which must stay around
957 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
958 * @param ppTimer Where to store the timer on success.
959 * @thread EMT
960 */
961 DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer));
962
963 /**
964 * Register a save state data unit.
965 *
966 * @returns VBox status.
967 * @param pDrvIns Driver instance.
968 * @param uVersion Data layout version number.
969 * @param cbGuess The approximate amount of data in the unit.
970 * Only for progress indicators.
971 *
972 * @param pfnLivePrep Prepare live save callback, optional.
973 * @param pfnLiveExec Execute live save callback, optional.
974 * @param pfnLiveVote Vote live save callback, optional.
975 *
976 * @param pfnSavePrep Prepare save callback, optional.
977 * @param pfnSaveExec Execute save callback, optional.
978 * @param pfnSaveDone Done save callback, optional.
979 *
980 * @param pfnLoadPrep Prepare load callback, optional.
981 * @param pfnLoadExec Execute load callback, optional.
982 * @param pfnLoadDone Done load callback, optional.
983 */
984 DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
985 PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
986 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
987 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
988
989 /**
990 * Deregister a save state data unit.
991 *
992 * @returns VBox status.
993 * @param pDrvIns Driver instance.
994 * @param pszName Data unit name.
995 * @param uInstance The instance identifier of the data unit.
996 * This must together with the name be unique.
997 */
998 DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance));
999
1000 /**
1001 * Register an info handler with DBGF.
1002 *
1003 * @returns VBox status code.
1004 * @param pDrvIns Driver instance.
1005 * @param pszName Data unit name.
1006 * @param pszDesc The description of the info and any arguments
1007 * the handler may take.
1008 * @param pfnHandler The handler function to be called to display the
1009 * info.
1010 */
1011 DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler));
1012
1013 /**
1014 * Deregister an info handler from DBGF.
1015 *
1016 * @returns VBox status code.
1017 * @param pDrvIns Driver instance.
1018 * @param pszName Data unit name.
1019 */
1020 DECLR3CALLBACKMEMBER(int, pfnDBGFInfoDeregister,(PPDMDRVINS pDrvIns, const char *pszName));
1021
1022 /**
1023 * Registers a statistics sample if statistics are enabled.
1024 *
1025 * @param pDrvIns Driver instance.
1026 * @param pvSample Pointer to the sample.
1027 * @param enmType Sample type. This indicates what pvSample is pointing at.
1028 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
1029 * Further nesting is possible.
1030 * @param enmUnit Sample unit.
1031 * @param pszDesc Sample description.
1032 */
1033 DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName,
1034 STAMUNIT enmUnit, const char *pszDesc));
1035
1036 /**
1037 * Same as pfnSTAMRegister except that the name is specified in a
1038 * RTStrPrintf like fashion.
1039 *
1040 * @param pDrvIns Driver instance.
1041 * @param pvSample Pointer to the sample.
1042 * @param enmType Sample type. This indicates what pvSample is pointing at.
1043 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1044 * @param enmUnit Sample unit.
1045 * @param pszDesc Sample description.
1046 * @param pszName The sample name format string.
1047 * @param ... Arguments to the format string.
1048 */
1049 DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1050 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, ...));
1051
1052 /**
1053 * Same as pfnSTAMRegister except that the name is specified in a
1054 * RTStrPrintfV like fashion.
1055 *
1056 * @param pDrvIns Driver instance.
1057 * @param pvSample Pointer to the sample.
1058 * @param enmType Sample type. This indicates what pvSample is pointing at.
1059 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1060 * @param enmUnit Sample unit.
1061 * @param pszDesc Sample description.
1062 * @param pszName The sample name format string.
1063 * @param args Arguments to the format string.
1064 */
1065 DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1066 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list args));
1067
1068 /**
1069 * Deregister a statistic item previously registered with pfnSTAMRegister,
1070 * pfnSTAMRegisterF or pfnSTAMRegisterV
1071 *
1072 * @returns VBox status.
1073 * @param pDrvIns Driver instance.
1074 * @param pvSample Pointer to the sample.
1075 */
1076 DECLR3CALLBACKMEMBER(int, pfnSTAMDeregister,(PPDMDRVINS pDrvIns, void *pvSample));
1077
1078 /**
1079 * Calls the HC R0 VMM entry point, in a safer but slower manner than
1080 * SUPR3CallVMMR0.
1081 *
1082 * When entering using this call the R0 components can call into the host kernel
1083 * (i.e. use the SUPR0 and RT APIs).
1084 *
1085 * See VMMR0Entry() for more details.
1086 *
1087 * @returns error code specific to uFunction.
1088 * @param pDrvIns The driver instance.
1089 * @param uOperation Operation to execute.
1090 * This is limited to services.
1091 * @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
1092 * @param cbArg The size of the argument. This is used to copy whatever the argument
1093 * points at into a kernel buffer to avoid problems like the user page
1094 * being invalidated while we're executing the call.
1095 */
1096 DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
1097
1098 /**
1099 * Registers a USB HUB.
1100 *
1101 * @returns VBox status code.
1102 * @param pDrvIns The driver instance.
1103 * @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
1104 * @param cPorts The number of ports.
1105 * @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
1106 * @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
1107 *
1108 * @thread EMT.
1109 */
1110 DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
1111
1112 /**
1113 * Set up asynchronous handling of a suspend, reset or power off notification.
1114 *
1115 * This shall only be called when getting the notification. It must be called
1116 * for each one.
1117 *
1118 * @returns VBox status code.
1119 * @param pDrvIns The driver instance.
1120 * @param pfnAsyncNotify The callback.
1121 * @thread EMT(0)
1122 */
1123 DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
1124
1125 /**
1126 * Notify EMT(0) that the driver has completed the asynchronous notification
1127 * handling.
1128 *
1129 * This can be called at any time, spurious calls will simply be ignored.
1130 *
1131 * @param pDrvIns The driver instance.
1132 * @thread Any
1133 */
1134 DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMDRVINS pDrvIns));
1135
1136 /**
1137 * Creates a PDM thread.
1138 *
1139 * This differs from the RTThreadCreate() API in that PDM takes care of suspending,
1140 * resuming, and destroying the thread as the VM state changes.
1141 *
1142 * @returns VBox status code.
1143 * @param pDrvIns The driver instance.
1144 * @param ppThread Where to store the thread 'handle'.
1145 * @param pvUser The user argument to the thread function.
1146 * @param pfnThread The thread function.
1147 * @param pfnWakeup The wakup callback. This is called on the EMT thread when
1148 * a state change is pending.
1149 * @param cbStack See RTThreadCreate.
1150 * @param enmType See RTThreadCreate.
1151 * @param pszName See RTThreadCreate.
1152 */
1153 DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1154 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
1155
1156 /**
1157 * Creates an async completion template for a driver instance.
1158 *
1159 * The template is used when creating new completion tasks.
1160 *
1161 * @returns VBox status code.
1162 * @param pDrvIns The driver instance.
1163 * @param ppTemplate Where to store the template pointer on success.
1164 * @param pfnCompleted The completion callback routine.
1165 * @param pvTemplateUser Template user argument.
1166 * @param pszDesc Description.
1167 */
1168 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1169 PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1170 const char *pszDesc));
1171
1172#ifdef VBOX_WITH_NETSHAPER
1173 /**
1174 * Attaches network filter driver to a bandwidth group.
1175 *
1176 * @returns VBox status code.
1177 * @param pDrvIns The driver instance.
1178 * @param pcszBwGroup Name of the bandwidth group to attach to.
1179 * @param pFilter Pointer to the filter we attach.
1180 */
1181 DECLR3CALLBACKMEMBER(int, pfnNetShaperAttach,(PPDMDRVINS pDrvIns, const char *pszBwGroup,
1182 PPDMNSFILTER pFilter));
1183
1184
1185 /**
1186 * Detaches network filter driver to a bandwidth group.
1187 *
1188 * @returns VBox status code.
1189 * @param pDrvIns The driver instance.
1190 * @param pFilter Pointer to the filter we attach.
1191 */
1192 DECLR3CALLBACKMEMBER(int, pfnNetShaperDetach,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter));
1193#endif /* VBOX_WITH_NETSHAPER */
1194
1195
1196 /**
1197 * Resolves the symbol for a raw-mode context interface.
1198 *
1199 * @returns VBox status code.
1200 * @param pDrvIns The driver instance.
1201 * @param pvInterface The interface structure.
1202 * @param cbInterface The size of the interface structure.
1203 * @param pszSymPrefix What to prefix the symbols in the list with before
1204 * resolving them. This must start with 'drv' and
1205 * contain the driver name.
1206 * @param pszSymList List of symbols corresponding to the interface.
1207 * There is generally a there is generally a define
1208 * holding this list associated with the interface
1209 * definition (INTERFACE_SYM_LIST). For more details
1210 * see PDMR3LdrGetInterfaceSymbols.
1211 * @thread EMT
1212 */
1213 DECLR3CALLBACKMEMBER(int, pfnLdrGetRCInterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1214 const char *pszSymPrefix, const char *pszSymList));
1215
1216 /**
1217 * Resolves the symbol for a ring-0 context interface.
1218 *
1219 * @returns VBox status code.
1220 * @param pDrvIns The driver instance.
1221 * @param pvInterface The interface structure.
1222 * @param cbInterface The size of the interface structure.
1223 * @param pszSymPrefix What to prefix the symbols in the list with before
1224 * resolving them. This must start with 'drv' and
1225 * contain the driver name.
1226 * @param pszSymList List of symbols corresponding to the interface.
1227 * There is generally a there is generally a define
1228 * holding this list associated with the interface
1229 * definition (INTERFACE_SYM_LIST). For more details
1230 * see PDMR3LdrGetInterfaceSymbols.
1231 * @thread EMT
1232 */
1233 DECLR3CALLBACKMEMBER(int, pfnLdrGetR0InterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1234 const char *pszSymPrefix, const char *pszSymList));
1235 /**
1236 * Initializes a PDM critical section.
1237 *
1238 * The PDM critical sections are derived from the IPRT critical sections, but
1239 * works in both RC and R0 as well as R3.
1240 *
1241 * @returns VBox status code.
1242 * @param pDrvIns The driver instance.
1243 * @param pCritSect Pointer to the critical section.
1244 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
1245 * @param pszName The base name of the critical section. Will be
1246 * mangeled with the instance number. For
1247 * statistics and lock validation.
1248 * @param va Arguments for the format string.
1249 * @thread EMT
1250 */
1251 DECLR3CALLBACKMEMBER(int, pfnCritSectInit,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect,
1252 RT_SRC_POS_DECL, const char *pszName));
1253
1254 /**
1255 * Call the ring-0 request handler routine of the driver.
1256 *
1257 * For this to work, the driver must be ring-0 enabled and export a request
1258 * handler function. The name of the function must be the driver name in the
1259 * PDMDRVREG struct prefixed with 'drvR0' and suffixed with 'ReqHandler'.
1260 * The driver name will be capitalized. It shall take the exact same
1261 * arguments as this function and be declared using PDMBOTHCBDECL. See
1262 * FNPDMDRVREQHANDLERR0.
1263 *
1264 * @returns VBox status code.
1265 * @retval VERR_SYMBOL_NOT_FOUND if the driver doesn't export the required
1266 * handler function.
1267 * @retval VERR_ACCESS_DENIED if the driver isn't ring-0 capable.
1268 *
1269 * @param pDrvIns The driver instance.
1270 * @param uOperation The operation to perform.
1271 * @param u64Arg 64-bit integer argument.
1272 * @thread Any
1273 */
1274 DECLR3CALLBACKMEMBER(int, pfnCallR0,(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg));
1275
1276 /**
1277 * Notify FTM about a checkpoint occurrence
1278 *
1279 * @param pDrvIns The driver instance.
1280 * @param enmType Checkpoint type
1281 * @thread Any
1282 */
1283 DECLR3CALLBACKMEMBER(int, pfnFTSetCheckpoint,(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType));
1284
1285 /**
1286 * Creates a block cache for a driver driver instance.
1287 *
1288 * @returns VBox status code.
1289 * @param pDrvIns The driver instance.
1290 * @param ppBlkCache Where to store the handle to the block cache.
1291 * @param pfnXferComplete The I/O transfer complete callback.
1292 * @param pfnXferEnqueue The I/O request enqueue callback.
1293 * @param pcszId Unique ID used to identify the user.
1294 */
1295 DECLR3CALLBACKMEMBER(int, pfnBlkCacheRetain, (PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1296 PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1297 PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1298 PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1299 const char *pcszId));
1300
1301 /** Just a safety precaution. */
1302 uint32_t u32TheEnd;
1303} PDMDRVHLPR3;
1304/** Current DRVHLP version number. */
1305#define PDM_DRVHLPR3_VERSION PDM_VERSION_MAKE(0xf0fb, 2, 0)
1306
1307#endif /* IN_RING3 */
1308
1309
1310/**
1311 * @copydoc PDMDRVHLP::pfnVMSetError
1312 */
1313DECLINLINE(int) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
1314{
1315 va_list va;
1316 va_start(va, pszFormat);
1317 pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1318 va_end(va);
1319 return rc;
1320}
1321
1322/** @def PDMDRV_SET_ERROR
1323 * Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
1324 */
1325#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
1326 PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
1327
1328/**
1329 * @copydoc PDMDRVHLP::pfnVMSetErrorV
1330 */
1331DECLINLINE(int) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
1332{
1333 return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1334}
1335
1336
1337/**
1338 * @copydoc PDMDRVHLP::pfnVMSetRuntimeError
1339 */
1340DECLINLINE(int) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, ...)
1341{
1342 va_list va;
1343 int rc;
1344 va_start(va, pszFormat);
1345 rc = pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1346 va_end(va);
1347 return rc;
1348}
1349
1350/** @def PDMDRV_SET_RUNTIME_ERROR
1351 * Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
1352 */
1353#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFlags, pszErrorId, pszError) \
1354 PDMDrvHlpVMSetRuntimeError(pDrvIns, fFlags, pszErrorId, "%s", pszError)
1355
1356/**
1357 * @copydoc PDMDRVHLP::pfnVMSetRuntimeErrorV
1358 */
1359DECLINLINE(int) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va)
1360{
1361 return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1362}
1363
1364
1365
1366/** @def PDMDRV_ASSERT_EMT
1367 * Assert that the current thread is the emulation thread.
1368 */
1369#ifdef VBOX_STRICT
1370# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1371#else
1372# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
1373#endif
1374
1375/** @def PDMDRV_ASSERT_OTHER
1376 * Assert that the current thread is NOT the emulation thread.
1377 */
1378#ifdef VBOX_STRICT
1379# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1380#else
1381# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
1382#endif
1383
1384/**
1385 * @copydoc PDMDRVHLP::pfnFTSetCheckpoint
1386 */
1387DECLINLINE(int) PDMDrvHlpFTSetCheckpoint(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType)
1388{
1389 return pDrvIns->CTX_SUFF(pHlp)->pfnFTSetCheckpoint(pDrvIns, enmType);
1390}
1391
1392
1393#ifdef IN_RING3
1394
1395/**
1396 * @copydoc PDMDRVHLP::pfnAttach
1397 */
1398DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
1399{
1400 return pDrvIns->pHlpR3->pfnAttach(pDrvIns, fFlags, ppBaseInterface);
1401}
1402
1403/**
1404 * Check that there is no driver below the us that we should attach to.
1405 *
1406 * @returns VERR_PDM_NO_ATTACHED_DRIVER if there is no driver.
1407 * @param pDrvIns The driver instance.
1408 */
1409DECLINLINE(int) PDMDrvHlpNoAttach(PPDMDRVINS pDrvIns)
1410{
1411 return pDrvIns->pHlpR3->pfnAttach(pDrvIns, 0, NULL);
1412}
1413
1414/**
1415 * @copydoc PDMDRVHLP::pfnDetach
1416 */
1417DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1418{
1419 return pDrvIns->pHlpR3->pfnDetach(pDrvIns, fFlags);
1420}
1421
1422/**
1423 * @copydoc PDMDRVHLP::pfnDetachSelf
1424 */
1425DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1426{
1427 return pDrvIns->pHlpR3->pfnDetachSelf(pDrvIns, fFlags);
1428}
1429
1430/**
1431 * @copydoc PDMDRVHLP::pfnMountPrepare
1432 */
1433DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver)
1434{
1435 return pDrvIns->pHlpR3->pfnMountPrepare(pDrvIns, pszFilename, pszCoreDriver);
1436}
1437
1438/**
1439 * @copydoc PDMDRVHLP::pfnVMState
1440 */
1441DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
1442{
1443 return pDrvIns->CTX_SUFF(pHlp)->pfnVMState(pDrvIns);
1444}
1445
1446/**
1447 * @copydoc PDMDRVHLP::pfnVMTeleportedAndNotFullyResumedYet
1448 */
1449DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1450{
1451 return pDrvIns->pHlpR3->pfnVMTeleportedAndNotFullyResumedYet(pDrvIns);
1452}
1453
1454/**
1455 * @copydoc PDMDRVHLP::pfnGetSupDrvSession
1456 */
1457DECLINLINE(PSUPDRVSESSION) PDMDrvHlpGetSupDrvSession(PPDMDRVINS pDrvIns)
1458{
1459 return pDrvIns->pHlpR3->pfnGetSupDrvSession(pDrvIns);
1460}
1461
1462/**
1463 * @copydoc PDMDRVHLP::pfnQueueCreate
1464 */
1465DECLINLINE(int) PDMDrvHlpQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1466 PFNPDMQUEUEDRV pfnCallback, const char *pszName, PPDMQUEUE *ppQueue)
1467{
1468 return pDrvIns->pHlpR3->pfnQueueCreate(pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
1469}
1470
1471/**
1472 * @copydoc PDMDRVHLP::pfnTMGetVirtualFreq
1473 */
1474DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
1475{
1476 return pDrvIns->pHlpR3->pfnTMGetVirtualFreq(pDrvIns);
1477}
1478
1479/**
1480 * @copydoc PDMDRVHLP::pfnTMGetVirtualTime
1481 */
1482DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
1483{
1484 return pDrvIns->pHlpR3->pfnTMGetVirtualTime(pDrvIns);
1485}
1486
1487/**
1488 * @copydoc PDMDRVHLP::pfnTMTimerCreate
1489 */
1490DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser, uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
1491{
1492 return pDrvIns->pHlpR3->pfnTMTimerCreate(pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
1493}
1494
1495/**
1496 * Register a save state data unit.
1497 *
1498 * @returns VBox status.
1499 * @param pDrvIns Driver instance.
1500 * @param uVersion Data layout version number.
1501 * @param cbGuess The approximate amount of data in the unit.
1502 * Only for progress indicators.
1503 * @param pfnSaveExec Execute save callback, optional.
1504 * @param pfnLoadExec Execute load callback, optional.
1505 */
1506DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1507 PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVLOADEXEC pfnLoadExec)
1508{
1509 return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1510 NULL /*pfnLivePrep*/, NULL /*pfnLiveExec*/, NULL /*pfnLiveVote*/,
1511 NULL /*pfnSavePrep*/, pfnSaveExec, NULL /*pfnSaveDone*/,
1512 NULL /*pfnLoadPrep*/, pfnLoadExec, NULL /*pfnLoadDone*/);
1513}
1514
1515/**
1516 * @copydoc PDMDRVHLP::pfnSSMRegister
1517 */
1518DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1519 PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1520 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1521 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1522{
1523 return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1524 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1525 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1526 pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1527}
1528
1529/**
1530 * Register a load done callback.
1531 *
1532 * @returns VBox status.
1533 * @param pDrvIns Driver instance.
1534 * @param pfnLoadDone Done load callback, optional.
1535 */
1536DECLINLINE(int) PDMDrvHlpSSMRegisterLoadDone(PPDMDRVINS pDrvIns, PFNSSMDRVLOADDONE pfnLoadDone)
1537{
1538 return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, 0 /*uVersion*/, 0 /*cbGuess*/,
1539 NULL /*pfnLivePrep*/, NULL /*pfnLiveExec*/, NULL /*pfnLiveVote*/,
1540 NULL /*pfnSavePrep*/, NULL /*pfnSaveExec*/, NULL /*pfnSaveDone*/,
1541 NULL /*pfnLoadPrep*/, NULL /*pfnLoadExec*/, pfnLoadDone);
1542}
1543
1544/**
1545 * @copydoc PDMDRVHLP::pfnDBGFInfoRegister
1546 */
1547DECLINLINE(int) PDMDrvHlpDBGFInfoRegister(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1548{
1549 return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1550}
1551
1552/**
1553 * @copydoc PDMDRVHLP::pfnDBGFInfoDeregister
1554 */
1555DECLINLINE(int) PDMDrvHlpDBGFInfoDeregister(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1556{
1557 return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1558}
1559
1560/**
1561 * @copydoc PDMDRVHLP::pfnSTAMRegister
1562 */
1563DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1564{
1565 pDrvIns->pHlpR3->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
1566}
1567
1568/**
1569 * @copydoc PDMDRVHLP::pfnSTAMRegisterF
1570 */
1571DECLINLINE(void) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1572 const char *pszDesc, const char *pszName, ...)
1573{
1574 va_list va;
1575 va_start(va, pszName);
1576 pDrvIns->pHlpR3->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1577 va_end(va);
1578}
1579
1580/**
1581 * Convenience wrapper that registers counter which is always visible.
1582 *
1583 * @param pDrvIns The driver instance.
1584 * @param pCounter Pointer to the counter variable.
1585 * @param pszName The name of the sample. This is prefixed with
1586 * "/Drivers/<drivername>-<instance no>/".
1587 * @param enmUnit The unit.
1588 * @param pszDesc The description.
1589 */
1590DECLINLINE(void) PDMDrvHlpSTAMRegCounterEx(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1591{
1592 pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pCounter, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1593 "/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1594}
1595
1596/**
1597 * Convenience wrapper that registers counter which is always visible and has
1598 * the STAMUNIT_COUNT unit.
1599 *
1600 * @param pDrvIns The driver instance.
1601 * @param pCounter Pointer to the counter variable.
1602 * @param pszName The name of the sample. This is prefixed with
1603 * "/Drivers/<drivername>-<instance no>/".
1604 * @param pszDesc The description.
1605 */
1606DECLINLINE(void) PDMDrvHlpSTAMRegCounter(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char *pszName, const char *pszDesc)
1607{
1608 PDMDrvHlpSTAMRegCounterEx(pDrvIns, pCounter, pszName, STAMUNIT_COUNT, pszDesc);
1609}
1610
1611/**
1612 * Convenience wrapper that registers profiling sample which is always visible.
1613 *
1614 * @param pDrvIns The driver instance.
1615 * @param pProfile Pointer to the profiling variable.
1616 * @param pszName The name of the sample. This is prefixed with
1617 * "/Drivers/<drivername>-<instance no>/".
1618 * @param enmUnit The unit.
1619 * @param pszDesc The description.
1620 */
1621DECLINLINE(void) PDMDrvHlpSTAMRegProfileEx(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1622{
1623 pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1624 "/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1625}
1626
1627/**
1628 * Convenience wrapper that registers profiling sample which is always visible
1629 * hand counts ticks per call (STAMUNIT_TICKS_PER_CALL).
1630 *
1631 * @param pDrvIns The driver instance.
1632 * @param pProfile Pointer to the profiling variable.
1633 * @param pszName The name of the sample. This is prefixed with
1634 * "/Drivers/<drivername>-<instance no>/".
1635 * @param pszDesc The description.
1636 */
1637DECLINLINE(void) PDMDrvHlpSTAMRegProfile(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char *pszName, const char *pszDesc)
1638{
1639 PDMDrvHlpSTAMRegProfileEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1640}
1641
1642/**
1643 * Convenience wrapper that registers an advanced profiling sample which is
1644 * always visible.
1645 *
1646 * @param pDrvIns The driver instance.
1647 * @param pProfile Pointer to the profiling variable.
1648 * @param enmUnit The unit.
1649 * @param pszName The name of the sample. This is prefixed with
1650 * "/Drivers/<drivername>-<instance no>/".
1651 * @param pszDesc The description.
1652 */
1653DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdvEx(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1654{
1655 pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1656 "/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1657}
1658
1659/**
1660 * Convenience wrapper that registers an advanced profiling sample which is
1661 * always visible.
1662 *
1663 * @param pDrvIns The driver instance.
1664 * @param pProfile Pointer to the profiling variable.
1665 * @param pszName The name of the sample. This is prefixed with
1666 * "/Drivers/<drivername>-<instance no>/".
1667 * @param pszDesc The description.
1668 */
1669DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdv(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char *pszName, const char *pszDesc)
1670{
1671 PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1672}
1673
1674/**
1675 * @copydoc PDMDRVHLP::pfnSTAMDeregister
1676 */
1677DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1678{
1679 return pDrvIns->pHlpR3->pfnSTAMDeregister(pDrvIns, pvSample);
1680}
1681
1682/**
1683 * @copydoc PDMDRVHLP::pfnSUPCallVMMR0Ex
1684 */
1685DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1686{
1687 return pDrvIns->pHlpR3->pfnSUPCallVMMR0Ex(pDrvIns, uOperation, pvArg, cbArg);
1688}
1689
1690/**
1691 * @copydoc PDMDRVHLP::pfnUSBRegisterHub
1692 */
1693DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1694{
1695 return pDrvIns->pHlpR3->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1696}
1697
1698/**
1699 * @copydoc PDMDRVHLP::pfnSetAsyncNotification
1700 */
1701DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1702{
1703 return pDrvIns->pHlpR3->pfnSetAsyncNotification(pDrvIns, pfnAsyncNotify);
1704}
1705
1706/**
1707 * @copydoc PDMDRVHLP::pfnAsyncNotificationCompleted
1708 */
1709DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1710{
1711 pDrvIns->pHlpR3->pfnAsyncNotificationCompleted(pDrvIns);
1712}
1713
1714/**
1715 * @copydoc PDMDRVHLP::pfnThreadCreate
1716 */
1717DECLINLINE(int) PDMDrvHlpThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1718 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1719{
1720 return pDrvIns->pHlpR3->pfnThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1721}
1722
1723# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1724/**
1725 * @copydoc PDMDRVHLP::pfnAsyncCompletionTemplateCreate
1726 */
1727DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1728 PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser, const char *pszDesc)
1729{
1730 return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1731}
1732# endif
1733
1734# ifdef VBOX_WITH_NETSHAPER
1735/**
1736 * @copydoc PDMDRVHLP::pfnNetShaperAttach
1737 */
1738DECLINLINE(int) PDMDrvHlpNetShaperAttach(PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter)
1739{
1740 return pDrvIns->pHlpR3->pfnNetShaperAttach(pDrvIns, pcszBwGroup, pFilter);
1741}
1742
1743/**
1744 * @copydoc PDMDRVHLP::pfnNetShaperDetach
1745 */
1746DECLINLINE(int) PDMDrvHlpNetShaperDetach(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
1747{
1748 return pDrvIns->pHlpR3->pfnNetShaperDetach(pDrvIns, pFilter);
1749}
1750# endif
1751
1752/**
1753 * @copydoc PDMDRVHLP::pfnCritSectInit
1754 */
1755DECLINLINE(int) PDMDrvHlpCritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName)
1756{
1757 return pDrvIns->pHlpR3->pfnCritSectInit(pDrvIns, pCritSect, RT_SRC_POS_ARGS, pszName);
1758}
1759
1760/**
1761 * @copydoc PDMDRVHLP::pfnCallR0
1762 */
1763DECLINLINE(int) PDMDrvHlpCallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
1764{
1765 return pDrvIns->pHlpR3->pfnCallR0(pDrvIns, uOperation, u64Arg);
1766}
1767
1768/**
1769 * @copydoc PDMDRVHLP::pfnBlkCacheRetain
1770 */
1771DECLINLINE(int) PDMDrvHlpBlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1772 PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1773 PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1774 PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1775 const char *pcszId)
1776{
1777 return pDrvIns->pHlpR3->pfnBlkCacheRetain(pDrvIns, ppBlkCache, pfnXferComplete, pfnXferEnqueue, pfnXferEnqueueDiscard, pcszId);
1778}
1779
1780/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
1781typedef struct PDMDRVREGCB *PPDMDRVREGCB;
1782/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
1783typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
1784
1785/**
1786 * Callbacks for VBoxDriverRegister().
1787 */
1788typedef struct PDMDRVREGCB
1789{
1790 /** Interface version.
1791 * This is set to PDM_DRVREG_CB_VERSION. */
1792 uint32_t u32Version;
1793
1794 /**
1795 * Registers a driver with the current VM instance.
1796 *
1797 * @returns VBox status code.
1798 * @param pCallbacks Pointer to the callback table.
1799 * @param pReg Pointer to the driver registration record.
1800 * This data must be permanent and readonly.
1801 */
1802 DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg));
1803} PDMDRVREGCB;
1804
1805/** Current version of the PDMDRVREGCB structure. */
1806#define PDM_DRVREG_CB_VERSION PDM_VERSION_MAKE(0xf0fa, 1, 0)
1807
1808
1809/**
1810 * The VBoxDriverRegister callback function.
1811 *
1812 * PDM will invoke this function after loading a driver module and letting
1813 * the module decide which drivers to register and how to handle conflicts.
1814 *
1815 * @returns VBox status code.
1816 * @param pCallbacks Pointer to the callback table.
1817 * @param u32Version VBox version number.
1818 */
1819typedef DECLCALLBACK(int) FNPDMVBOXDRIVERSREGISTER(PCPDMDRVREGCB pCallbacks, uint32_t u32Version);
1820
1821VMMR3DECL(int) PDMR3DrvStaticRegistration(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
1822
1823#endif /* IN_RING3 */
1824
1825/** @} */
1826
1827RT_C_DECLS_END
1828
1829#endif
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