VirtualBox

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

Last change on this file since 94425 was 94369, checked in by vboxsync, 3 years ago

VMM,CFGM: Drop CFGMR3QueryPtr and CFGMR3QueryPtrDef, bugref:10053

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 106.6 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Drivers.
3 */
4
5/*
6 * Copyright (C) 2006-2022 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_INCLUDED_vmm_pdmdrv_h
27#define VBOX_INCLUDED_vmm_pdmdrv_h
28#ifndef RT_WITHOUT_PRAGMA_ONCE
29# pragma once
30#endif
31
32#include <VBox/vmm/pdmqueue.h>
33#include <VBox/vmm/pdmcritsect.h>
34#include <VBox/vmm/pdmifs.h>
35#include <VBox/vmm/pdmins.h>
36#include <VBox/vmm/pdmcommon.h>
37#ifdef IN_RING3
38# include <VBox/vmm/pdmthread.h>
39# include <VBox/vmm/pdmasynccompletion.h>
40# include <VBox/vmm/pdmblkcache.h>
41#endif
42#include <VBox/vmm/tm.h>
43#include <VBox/vmm/ssm.h>
44#include <VBox/vmm/cfgm.h>
45#include <VBox/vmm/dbgf.h>
46#include <VBox/vmm/mm.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 DECLCALLBACKTYPE(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 DECLCALLBACKTYPE(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 DECLCALLBACKTYPE(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 DECLCALLBACKTYPE(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 DECLCALLBACKTYPE(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 DECLCALLBACKTYPE(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 DECLCALLBACKTYPE(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 DECLCALLBACKTYPE(void, FNPDMDRVRESUME,(PPDMDRVINS pDrvIns));
171/** Pointer to a FNPDMDRVRESUME() function. */
172typedef FNPDMDRVRESUME *PFNPDMDRVRESUME;
173
174/**
175 * Power Off notification.
176 *
177 * This is always called when VMR3PowerOff is called.
178 * There will be no callback when hot plugging devices or when replumbing the driver
179 * stack.
180 *
181 * @param pDrvIns The driver instance data.
182 */
183typedef DECLCALLBACKTYPE(void, FNPDMDRVPOWEROFF,(PPDMDRVINS pDrvIns));
184/** Pointer to a FNPDMDRVPOWEROFF() function. */
185typedef FNPDMDRVPOWEROFF *PFNPDMDRVPOWEROFF;
186
187/**
188 * Attach command.
189 *
190 * This is called to let the driver attach to a driver at runtime. This is not
191 * called during VM construction, the driver constructor have to do this by
192 * calling PDMDrvHlpAttach.
193 *
194 * This is like plugging in the keyboard or mouse after turning on the PC.
195 *
196 * @returns VBox status code.
197 * @param pDrvIns The driver instance.
198 * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
199 */
200typedef DECLCALLBACKTYPE(int, FNPDMDRVATTACH,(PPDMDRVINS pDrvIns, uint32_t fFlags));
201/** Pointer to a FNPDMDRVATTACH() function. */
202typedef FNPDMDRVATTACH *PFNPDMDRVATTACH;
203
204/**
205 * Detach notification.
206 *
207 * This is called when a driver below it in the chain is detaching itself
208 * from it. The driver should adjust it's state to reflect this.
209 *
210 * This is like ejecting a cdrom or floppy.
211 *
212 * @param pDrvIns The driver instance.
213 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
214 */
215typedef DECLCALLBACKTYPE(void, FNPDMDRVDETACH,(PPDMDRVINS pDrvIns, uint32_t fFlags));
216/** Pointer to a FNPDMDRVDETACH() function. */
217typedef FNPDMDRVDETACH *PFNPDMDRVDETACH;
218
219
220
221/**
222 * PDM Driver Registration Structure.
223 *
224 * This structure is used when registering a driver from VBoxInitDrivers() (in
225 * host ring-3 context). PDM will continue use till the VM is terminated.
226 */
227typedef struct PDMDRVREG
228{
229 /** Structure version. PDM_DRVREG_VERSION defines the current version. */
230 uint32_t u32Version;
231 /** Driver name. */
232 char szName[32];
233 /** Name of the raw-mode context module (no path).
234 * Only evalutated if PDM_DRVREG_FLAGS_RC is set. */
235 char szRCMod[32];
236 /** Name of the ring-0 module (no path).
237 * Only evalutated if PDM_DRVREG_FLAGS_R0 is set. */
238 char szR0Mod[32];
239 /** The description of the driver. The UTF-8 string pointed to shall, like this structure,
240 * remain unchanged from registration till VM destruction. */
241 const char *pszDescription;
242
243 /** Flags, combination of the PDM_DRVREG_FLAGS_* \#defines. */
244 uint32_t fFlags;
245 /** Driver class(es), combination of the PDM_DRVREG_CLASS_* \#defines. */
246 uint32_t fClass;
247 /** Maximum number of instances (per VM). */
248 uint32_t cMaxInstances;
249 /** Size of the instance data. */
250 uint32_t cbInstance;
251
252 /** Construct instance - required. */
253 PFNPDMDRVCONSTRUCT pfnConstruct;
254 /** Destruct instance - optional. */
255 PFNPDMDRVDESTRUCT pfnDestruct;
256 /** Relocation command - optional. */
257 PFNPDMDRVRELOCATE pfnRelocate;
258 /** I/O control - optional. */
259 PFNPDMDRVIOCTL pfnIOCtl;
260 /** Power on notification - optional. */
261 PFNPDMDRVPOWERON pfnPowerOn;
262 /** Reset notification - optional. */
263 PFNPDMDRVRESET pfnReset;
264 /** Suspend notification - optional. */
265 PFNPDMDRVSUSPEND pfnSuspend;
266 /** Resume notification - optional. */
267 PFNPDMDRVRESUME pfnResume;
268 /** Attach command - optional. */
269 PFNPDMDRVATTACH pfnAttach;
270 /** Detach notification - optional. */
271 PFNPDMDRVDETACH pfnDetach;
272 /** Power off notification - optional. */
273 PFNPDMDRVPOWEROFF pfnPowerOff;
274 /** @todo */
275 PFNRT pfnSoftReset;
276 /** Initialization safty marker. */
277 uint32_t u32VersionEnd;
278} PDMDRVREG;
279/** Pointer to a PDM Driver Structure. */
280typedef PDMDRVREG *PPDMDRVREG;
281/** Const pointer to a PDM Driver Structure. */
282typedef PDMDRVREG const *PCPDMDRVREG;
283
284/** Current DRVREG version number. */
285#define PDM_DRVREG_VERSION PDM_VERSION_MAKE(0xf0ff, 1, 0)
286
287/** PDM Driver Flags.
288 * @{ */
289/** @def PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT
290 * The bit count for the current host. */
291#if HC_ARCH_BITS == 32
292# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT UINT32_C(0x00000001)
293#elif HC_ARCH_BITS == 64
294# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT UINT32_C(0x00000002)
295#else
296# error Unsupported HC_ARCH_BITS value.
297#endif
298/** The host bit count mask. */
299#define PDM_DRVREG_FLAGS_HOST_BITS_MASK UINT32_C(0x00000003)
300/** This flag is used to indicate that the driver has a RC component. */
301#define PDM_DRVREG_FLAGS_RC UINT32_C(0x00000010)
302/** This flag is used to indicate that the driver has a R0 component. */
303#define PDM_DRVREG_FLAGS_R0 UINT32_C(0x00000020)
304
305/** @} */
306
307
308/** PDM Driver Classes.
309 * @{ */
310/** Mouse input driver. */
311#define PDM_DRVREG_CLASS_MOUSE RT_BIT(0)
312/** Keyboard input driver. */
313#define PDM_DRVREG_CLASS_KEYBOARD RT_BIT(1)
314/** Display driver. */
315#define PDM_DRVREG_CLASS_DISPLAY RT_BIT(2)
316/** Network transport driver. */
317#define PDM_DRVREG_CLASS_NETWORK RT_BIT(3)
318/** Block driver. */
319#define PDM_DRVREG_CLASS_BLOCK RT_BIT(4)
320/** Media driver. */
321#define PDM_DRVREG_CLASS_MEDIA RT_BIT(5)
322/** Mountable driver. */
323#define PDM_DRVREG_CLASS_MOUNTABLE RT_BIT(6)
324/** Audio driver. */
325#define PDM_DRVREG_CLASS_AUDIO RT_BIT(7)
326/** VMMDev driver. */
327#define PDM_DRVREG_CLASS_VMMDEV RT_BIT(8)
328/** Status driver. */
329#define PDM_DRVREG_CLASS_STATUS RT_BIT(9)
330/** ACPI driver. */
331#define PDM_DRVREG_CLASS_ACPI RT_BIT(10)
332/** USB related driver. */
333#define PDM_DRVREG_CLASS_USB RT_BIT(11)
334/** ISCSI Transport related driver. */
335#define PDM_DRVREG_CLASS_ISCSITRANSPORT RT_BIT(12)
336/** Char driver. */
337#define PDM_DRVREG_CLASS_CHAR RT_BIT(13)
338/** Stream driver. */
339#define PDM_DRVREG_CLASS_STREAM RT_BIT(14)
340/** SCSI driver. */
341#define PDM_DRVREG_CLASS_SCSI RT_BIT(15)
342/** Generic raw PCI device driver. */
343#define PDM_DRVREG_CLASS_PCIRAW RT_BIT(16)
344/** @} */
345
346
347/**
348 * PDM Driver Instance.
349 *
350 * @implements PDMIBASE
351 */
352typedef struct PDMDRVINS
353{
354 /** Structure version. PDM_DRVINS_VERSION defines the current version. */
355 uint32_t u32Version;
356 /** Driver instance number. */
357 uint32_t iInstance;
358
359 /** Pointer the PDM Driver API. */
360 RCPTRTYPE(PCPDMDRVHLPRC) pHlpRC;
361 /** Pointer to driver instance data. */
362 RCPTRTYPE(void *) pvInstanceDataRC;
363
364 /** Pointer the PDM Driver API. */
365 R0PTRTYPE(PCPDMDRVHLPR0) pHlpR0;
366 /** Pointer to driver instance data. */
367 R0PTRTYPE(void *) pvInstanceDataR0;
368
369 /** Pointer the PDM Driver API. */
370 R3PTRTYPE(PCPDMDRVHLPR3) pHlpR3;
371 /** Pointer to driver instance data. */
372 R3PTRTYPE(void *) pvInstanceDataR3;
373
374 /** Pointer to driver registration structure. */
375 R3PTRTYPE(PCPDMDRVREG) pReg;
376 /** Configuration handle. */
377 R3PTRTYPE(PCFGMNODE) pCfg;
378
379 /** Pointer to the base interface of the device/driver instance above. */
380 R3PTRTYPE(PPDMIBASE) pUpBase;
381 /** Pointer to the base interface of the driver instance below. */
382 R3PTRTYPE(PPDMIBASE) pDownBase;
383
384 /** The base interface of the driver.
385 * The driver constructor initializes this. */
386 PDMIBASE IBase;
387
388 /** Tracing indicator. */
389 uint32_t fTracing;
390 /** The tracing ID of this device. */
391 uint32_t idTracing;
392#if HC_ARCH_BITS == 32
393 /** Align the internal data more naturally. */
394 uint32_t au32Padding[HC_ARCH_BITS == 32 ? 7 : 0];
395#endif
396
397 /** Internal data. */
398 union
399 {
400#ifdef PDMDRVINSINT_DECLARED
401 PDMDRVINSINT s;
402#endif
403 uint8_t padding[HC_ARCH_BITS == 32 ? 40 + 32 : 72 + 24];
404 } Internal;
405
406 /** Driver instance data. The size of this area is defined
407 * in the PDMDRVREG::cbInstanceData field. */
408 char achInstanceData[4];
409} PDMDRVINS;
410
411/** Current DRVREG version number. */
412#define PDM_DRVINS_VERSION PDM_VERSION_MAKE(0xf0fe, 2, 0)
413
414/** Converts a pointer to the PDMDRVINS::IBase to a pointer to PDMDRVINS. */
415#define PDMIBASE_2_PDMDRV(pInterface) ( (PPDMDRVINS)((char *)(pInterface) - RT_UOFFSETOF(PDMDRVINS, IBase)) )
416
417/** @def PDMDRVINS_2_RCPTR
418 * Converts a PDM Driver instance pointer a RC PDM Driver instance pointer.
419 */
420#define PDMDRVINS_2_RCPTR(pDrvIns) ( (RCPTRTYPE(PPDMDRVINS))((RTRCUINTPTR)(pDrvIns)->pvInstanceDataRC - (RTRCUINTPTR)RT_UOFFSETOF(PDMDRVINS, achInstanceData)) )
421
422/** @def PDMDRVINS_2_R3PTR
423 * Converts a PDM Driver instance pointer a R3 PDM Driver instance pointer.
424 */
425#define PDMDRVINS_2_R3PTR(pDrvIns) ( (R3PTRTYPE(PPDMDRVINS))((RTHCUINTPTR)(pDrvIns)->pvInstanceDataR3 - RT_UOFFSETOF(PDMDRVINS, achInstanceData)) )
426
427/** @def PDMDRVINS_2_R0PTR
428 * Converts a PDM Driver instance pointer a R0 PDM Driver instance pointer.
429 */
430#define PDMDRVINS_2_R0PTR(pDrvIns) ( (R0PTRTYPE(PPDMDRVINS))((RTR0UINTPTR)(pDrvIns)->pvInstanceDataR0 - RT_UOFFSETOF(PDMDRVINS, achInstanceData)) )
431
432
433
434/**
435 * Checks the structure versions of the drive instance and driver helpers,
436 * returning if they are incompatible.
437 *
438 * Intended for the constructor.
439 *
440 * @param pDrvIns Pointer to the PDM driver instance.
441 */
442#define PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns) \
443 do \
444 { \
445 PPDMDRVINS pDrvInsTypeCheck = (pDrvIns); NOREF(pDrvInsTypeCheck); \
446 AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->u32Version, PDM_DRVINS_VERSION), \
447 ("DrvIns=%#x mine=%#x\n", (pDrvIns)->u32Version, PDM_DRVINS_VERSION), \
448 VERR_PDM_DRVINS_VERSION_MISMATCH); \
449 AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION), \
450 ("DrvHlp=%#x mine=%#x\n", (pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION), \
451 VERR_PDM_DRVHLPR3_VERSION_MISMATCH); \
452 } while (0)
453
454/**
455 * Quietly checks the structure versions of the drive instance and driver
456 * helpers, returning if they are incompatible.
457 *
458 * Intended for the destructor.
459 *
460 * @param pDrvIns Pointer to the PDM driver instance.
461 */
462#define PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns) \
463 do \
464 { \
465 PPDMDRVINS pDrvInsTypeCheck = (pDrvIns); NOREF(pDrvInsTypeCheck); \
466 if (RT_LIKELY( PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->u32Version, PDM_DRVINS_VERSION) \
467 && PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION)) ) \
468 { /* likely */ } else return; \
469 } while (0)
470
471/**
472 * Wrapper around CFGMR3ValidateConfig for the root config for use in the
473 * constructor - returns on failure.
474 *
475 * This should be invoked after having initialized the instance data
476 * sufficiently for the correct operation of the destructor. The destructor is
477 * always called!
478 *
479 * @param pDrvIns Pointer to the PDM driver instance.
480 * @param pszValidValues Patterns describing the valid value names. See
481 * RTStrSimplePatternMultiMatch for details on the
482 * pattern syntax.
483 * @param pszValidNodes Patterns describing the valid node (key) names.
484 * Pass empty string if no valid nodess.
485 */
486#define PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, pszValidValues, pszValidNodes) \
487 do \
488 { \
489 int rcValCfg = pDrvIns->pHlpR3->pfnCFGMValidateConfig((pDrvIns)->pCfg, "/", pszValidValues, pszValidNodes, \
490 (pDrvIns)->pReg->szName, (pDrvIns)->iInstance); \
491 if (RT_SUCCESS(rcValCfg)) \
492 { /* likely */ } else return rcValCfg; \
493 } while (0)
494
495
496
497/**
498 * USB hub registration structure.
499 */
500typedef struct PDMUSBHUBREG
501{
502 /** Structure version number. PDM_USBHUBREG_VERSION defines the current version. */
503 uint32_t u32Version;
504
505 /**
506 * Request the hub to attach of the specified device.
507 *
508 * @returns VBox status code.
509 * @param pDrvIns The hub instance.
510 * @param pUsbIns The device to attach.
511 * @param pszCaptureFilename Path to the file for USB traffic capturing, optional.
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, const char *pszCaptureFilename, 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, 2, 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 * Assert that the current thread is the emulation thread.
575 *
576 * @returns True if correct.
577 * @returns False if wrong.
578 * @param pDrvIns Driver instance.
579 * @param pszFile Filename of the assertion location.
580 * @param iLine Linenumber of the assertion location.
581 * @param pszFunction Function of the assertion location.
582 */
583 DECLRCCALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
584
585 /**
586 * Assert that the current thread is NOT the emulation thread.
587 *
588 * @returns True if correct.
589 * @returns False if wrong.
590 * @param pDrvIns Driver instance.
591 * @param pszFile Filename of the assertion location.
592 * @param iLine Linenumber of the assertion location.
593 * @param pszFunction Function of the assertion location.
594 */
595 DECLRCCALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
596
597 /** @name Exported PDM Critical Section Functions
598 * @{ */
599 DECLRCCALLBACKMEMBER(int, pfnCritSectEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy));
600 DECLRCCALLBACKMEMBER(int, pfnCritSectEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL));
601 DECLRCCALLBACKMEMBER(int, pfnCritSectTryEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
602 DECLRCCALLBACKMEMBER(int, pfnCritSectTryEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL));
603 DECLRCCALLBACKMEMBER(int, pfnCritSectLeave,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
604 DECLRCCALLBACKMEMBER(bool, pfnCritSectIsOwner,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
605 DECLRCCALLBACKMEMBER(bool, pfnCritSectIsInitialized,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
606 DECLRCCALLBACKMEMBER(bool, pfnCritSectHasWaiters,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
607 DECLRCCALLBACKMEMBER(uint32_t, pfnCritSectGetRecursion,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
608 /** @} */
609
610 /**
611 * Obtains bandwidth in a bandwidth group.
612 *
613 * @returns True if bandwidth was allocated, false if not.
614 * @param pDrvIns The driver instance.
615 * @param pFilter Pointer to the filter that allocates bandwidth.
616 * @param cbTransfer Number of bytes to allocate.
617 */
618 DECLRCCALLBACKMEMBER(bool, pfnNetShaperAllocateBandwidth,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer));
619
620 /** Just a safety precaution. */
621 uint32_t u32TheEnd;
622} PDMDRVHLPRC;
623/** Current PDMDRVHLPRC version number. */
624#define PDM_DRVHLPRC_VERSION PDM_VERSION_MAKE(0xf0f9, 6, 0)
625
626
627/**
628 * PDM Driver API, ring-0 context.
629 */
630typedef struct PDMDRVHLPR0
631{
632 /** Structure version. PDM_DRVHLPR0_VERSION defines the current version. */
633 uint32_t u32Version;
634
635 /**
636 * Assert that the current thread is the emulation thread.
637 *
638 * @returns True if correct.
639 * @returns False if wrong.
640 * @param pDrvIns Driver instance.
641 * @param pszFile Filename of the assertion location.
642 * @param iLine Linenumber of the assertion location.
643 * @param pszFunction Function of the assertion location.
644 */
645 DECLR0CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
646
647 /**
648 * Assert that the current thread is NOT the emulation thread.
649 *
650 * @returns True if correct.
651 * @returns False if wrong.
652 * @param pDrvIns Driver instance.
653 * @param pszFile Filename of the assertion location.
654 * @param iLine Linenumber of the assertion location.
655 * @param pszFunction Function of the assertion location.
656 */
657 DECLR0CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
658
659 /** @name Exported PDM Critical Section Functions
660 * @{ */
661 DECLR0CALLBACKMEMBER(int, pfnCritSectEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy));
662 DECLR0CALLBACKMEMBER(int, pfnCritSectEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL));
663 DECLR0CALLBACKMEMBER(int, pfnCritSectTryEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
664 DECLR0CALLBACKMEMBER(int, pfnCritSectTryEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL));
665 DECLR0CALLBACKMEMBER(int, pfnCritSectLeave,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
666 DECLR0CALLBACKMEMBER(bool, pfnCritSectIsOwner,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
667 DECLR0CALLBACKMEMBER(bool, pfnCritSectIsInitialized,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
668 DECLR0CALLBACKMEMBER(bool, pfnCritSectHasWaiters,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
669 DECLR0CALLBACKMEMBER(uint32_t, pfnCritSectGetRecursion,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
670 DECLR0CALLBACKMEMBER(int, pfnCritSectScheduleExitEvent,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal));
671 /** @} */
672
673 /**
674 * Obtains bandwidth in a bandwidth group.
675 *
676 * @returns True if bandwidth was allocated, false if not.
677 * @param pDrvIns The driver instance.
678 * @param pFilter Pointer to the filter that allocates bandwidth.
679 * @param cbTransfer Number of bytes to allocate.
680 */
681 DECLR0CALLBACKMEMBER(bool, pfnNetShaperAllocateBandwidth,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer));
682
683 /** Just a safety precaution. */
684 uint32_t u32TheEnd;
685} PDMDRVHLPR0;
686/** Current DRVHLP version number. */
687#define PDM_DRVHLPR0_VERSION PDM_VERSION_MAKE(0xf0f8, 6, 0)
688
689
690#ifdef IN_RING3
691
692/**
693 * PDM Driver API.
694 */
695typedef struct PDMDRVHLPR3
696{
697 /** Structure version. PDM_DRVHLPR3_VERSION defines the current version. */
698 uint32_t u32Version;
699
700 /**
701 * Attaches a driver (chain) to the driver.
702 *
703 * @returns VBox status code.
704 * @param pDrvIns Driver instance.
705 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
706 * @param ppBaseInterface Where to store the pointer to the base interface.
707 */
708 DECLR3CALLBACKMEMBER(int, pfnAttach,(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface));
709
710 /**
711 * Detach the driver the drivers below us.
712 *
713 * @returns VBox status code.
714 * @param pDrvIns Driver instance.
715 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
716 */
717 DECLR3CALLBACKMEMBER(int, pfnDetach,(PPDMDRVINS pDrvIns, uint32_t fFlags));
718
719 /**
720 * Detach the driver from the driver above it and destroy this
721 * driver and all drivers below it.
722 *
723 * @returns VBox status code.
724 * @param pDrvIns Driver instance.
725 * @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
726 */
727 DECLR3CALLBACKMEMBER(int, pfnDetachSelf,(PPDMDRVINS pDrvIns, uint32_t fFlags));
728
729 /**
730 * Prepare a media mount.
731 *
732 * The driver must not have anything attached to itself
733 * when calling this function as the purpose is to set up the configuration
734 * of an future attachment.
735 *
736 * @returns VBox status code
737 * @param pDrvIns Driver instance.
738 * @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
739 * constructed a configuration which can be attached to the bottom driver.
740 * @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
741 */
742 DECLR3CALLBACKMEMBER(int, pfnMountPrepare,(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver));
743
744 /**
745 * Assert that the current thread is the emulation thread.
746 *
747 * @returns True if correct.
748 * @returns False if wrong.
749 * @param pDrvIns Driver instance.
750 * @param pszFile Filename of the assertion location.
751 * @param iLine Linenumber of the assertion location.
752 * @param pszFunction Function of the assertion location.
753 */
754 DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
755
756 /**
757 * Assert that the current thread is NOT the emulation thread.
758 *
759 * @returns True if correct.
760 * @returns False if wrong.
761 * @param pDrvIns Driver instance.
762 * @param pszFile Filename of the assertion location.
763 * @param iLine Linenumber of the assertion location.
764 * @param pszFunction Function of the assertion location.
765 */
766 DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
767
768 /**
769 * Set the VM error message
770 *
771 * @returns rc.
772 * @param pDrvIns Driver instance.
773 * @param rc VBox status code.
774 * @param SRC_POS Use RT_SRC_POS.
775 * @param pszFormat Error message format string.
776 * @param va Error message arguments.
777 */
778 DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
779 const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
780
781 /**
782 * Set the VM runtime error message
783 *
784 * @returns VBox status code.
785 * @param pDrvIns Driver instance.
786 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
787 * @param pszErrorId Error ID string.
788 * @param pszFormat Error message format string.
789 * @param va Error message arguments.
790 */
791 DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
792 const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0));
793
794 /**
795 * Gets the VM state.
796 *
797 * @returns VM state.
798 * @param pDrvIns The driver instance.
799 * @thread Any thread (just keep in mind that it's volatile info).
800 */
801 DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMDRVINS pDrvIns));
802
803 /**
804 * Checks if the VM was teleported and hasn't been fully resumed yet.
805 *
806 * @returns true / false.
807 * @param pDrvIns The driver instance.
808 * @thread Any thread.
809 */
810 DECLR3CALLBACKMEMBER(bool, pfnVMTeleportedAndNotFullyResumedYet,(PPDMDRVINS pDrvIns));
811
812 /**
813 * Gets the support driver session.
814 *
815 * This is intended for working using the semaphore API.
816 *
817 * @returns Support driver session handle.
818 * @param pDrvIns The driver instance.
819 */
820 DECLR3CALLBACKMEMBER(PSUPDRVSESSION, pfnGetSupDrvSession,(PPDMDRVINS pDrvIns));
821
822 /** @name Exported PDM Queue Functions
823 * @{ */
824 /**
825 * Create a queue.
826 *
827 * @returns VBox status code.
828 * @param pDrvIns Driver instance.
829 * @param cbItem Size a queue item.
830 * @param cItems Number of items in the queue.
831 * @param cMilliesInterval Number of milliseconds between polling the queue.
832 * If 0 then the emulation thread will be notified whenever an item arrives.
833 * @param pfnCallback The consumer function.
834 * @param pszName The queue base name. The instance number will be
835 * appended automatically.
836 * @param phQueue Where to store the queue handle on success.
837 * @thread The emulation thread.
838 */
839 DECLR3CALLBACKMEMBER(int, pfnQueueCreate,(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
840 PFNPDMQUEUEDRV pfnCallback, const char *pszName, PDMQUEUEHANDLE *phQueue));
841
842 DECLR3CALLBACKMEMBER(PPDMQUEUEITEMCORE, pfnQueueAlloc,(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue));
843 DECLR3CALLBACKMEMBER(int, pfnQueueInsert,(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue, PPDMQUEUEITEMCORE pItem));
844 DECLR3CALLBACKMEMBER(bool, pfnQueueFlushIfNecessary,(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue));
845 /** @} */
846
847 /**
848 * Query the virtual timer frequency.
849 *
850 * @returns Frequency in Hz.
851 * @param pDrvIns Driver instance.
852 * @thread Any thread.
853 */
854 DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualFreq,(PPDMDRVINS pDrvIns));
855
856 /**
857 * Query the virtual time.
858 *
859 * @returns The current virtual time.
860 * @param pDrvIns Driver instance.
861 * @thread Any thread.
862 */
863 DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualTime,(PPDMDRVINS pDrvIns));
864
865 /**
866 * Creates a timer.
867 *
868 * @returns VBox status.
869 * @param pDrvIns Driver instance.
870 * @param enmClock The clock to use on this timer.
871 * @param pfnCallback Callback function.
872 * @param pvUser The user argument to the callback.
873 * @param fFlags Timer creation flags, see grp_tm_timer_flags.
874 * @param pszDesc Pointer to description string which must stay around
875 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
876 * @param phTimer Where to store the timer handle on success.
877 * @thread EMT
878 *
879 * @todo Need to add a bunch of timer helpers for this to be useful again.
880 * Will do when required.
881 */
882 DECLR3CALLBACKMEMBER(int, pfnTimerCreate,(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
883 uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer));
884
885 /**
886 * Destroys a timer.
887 *
888 * @returns VBox status.
889 * @param pDrvIns Driver instance.
890 * @param hTimer The timer handle to destroy.
891 */
892 DECLR3CALLBACKMEMBER(int, pfnTimerDestroy,(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer));
893
894 /**
895 * Register a save state data unit.
896 *
897 * @returns VBox status.
898 * @param pDrvIns Driver instance.
899 * @param uVersion Data layout version number.
900 * @param cbGuess The approximate amount of data in the unit.
901 * Only for progress indicators.
902 *
903 * @param pfnLivePrep Prepare live save callback, optional.
904 * @param pfnLiveExec Execute live save callback, optional.
905 * @param pfnLiveVote Vote live save callback, optional.
906 *
907 * @param pfnSavePrep Prepare save callback, optional.
908 * @param pfnSaveExec Execute save callback, optional.
909 * @param pfnSaveDone Done save callback, optional.
910 *
911 * @param pfnLoadPrep Prepare load callback, optional.
912 * @param pfnLoadExec Execute load callback, optional.
913 * @param pfnLoadDone Done load callback, optional.
914 */
915 DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
916 PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
917 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
918 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
919
920 /**
921 * Deregister a save state data unit.
922 *
923 * @returns VBox status.
924 * @param pDrvIns Driver instance.
925 * @param pszName Data unit name.
926 * @param uInstance The instance identifier of the data unit.
927 * This must together with the name be unique.
928 */
929 DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance));
930
931 /** @name Exported SSM Functions
932 * @{ */
933 DECLR3CALLBACKMEMBER(int, pfnSSMPutStruct,(PSSMHANDLE pSSM, const void *pvStruct, PCSSMFIELD paFields));
934 DECLR3CALLBACKMEMBER(int, pfnSSMPutStructEx,(PSSMHANDLE pSSM, const void *pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void *pvUser));
935 DECLR3CALLBACKMEMBER(int, pfnSSMPutBool,(PSSMHANDLE pSSM, bool fBool));
936 DECLR3CALLBACKMEMBER(int, pfnSSMPutU8,(PSSMHANDLE pSSM, uint8_t u8));
937 DECLR3CALLBACKMEMBER(int, pfnSSMPutS8,(PSSMHANDLE pSSM, int8_t i8));
938 DECLR3CALLBACKMEMBER(int, pfnSSMPutU16,(PSSMHANDLE pSSM, uint16_t u16));
939 DECLR3CALLBACKMEMBER(int, pfnSSMPutS16,(PSSMHANDLE pSSM, int16_t i16));
940 DECLR3CALLBACKMEMBER(int, pfnSSMPutU32,(PSSMHANDLE pSSM, uint32_t u32));
941 DECLR3CALLBACKMEMBER(int, pfnSSMPutS32,(PSSMHANDLE pSSM, int32_t i32));
942 DECLR3CALLBACKMEMBER(int, pfnSSMPutU64,(PSSMHANDLE pSSM, uint64_t u64));
943 DECLR3CALLBACKMEMBER(int, pfnSSMPutS64,(PSSMHANDLE pSSM, int64_t i64));
944 DECLR3CALLBACKMEMBER(int, pfnSSMPutU128,(PSSMHANDLE pSSM, uint128_t u128));
945 DECLR3CALLBACKMEMBER(int, pfnSSMPutS128,(PSSMHANDLE pSSM, int128_t i128));
946 DECLR3CALLBACKMEMBER(int, pfnSSMPutUInt,(PSSMHANDLE pSSM, RTUINT u));
947 DECLR3CALLBACKMEMBER(int, pfnSSMPutSInt,(PSSMHANDLE pSSM, RTINT i));
948 DECLR3CALLBACKMEMBER(int, pfnSSMPutGCUInt,(PSSMHANDLE pSSM, RTGCUINT u));
949 DECLR3CALLBACKMEMBER(int, pfnSSMPutGCUIntReg,(PSSMHANDLE pSSM, RTGCUINTREG u));
950 DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPhys32,(PSSMHANDLE pSSM, RTGCPHYS32 GCPhys));
951 DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPhys64,(PSSMHANDLE pSSM, RTGCPHYS64 GCPhys));
952 DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPhys,(PSSMHANDLE pSSM, RTGCPHYS GCPhys));
953 DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPtr,(PSSMHANDLE pSSM, RTGCPTR GCPtr));
954 DECLR3CALLBACKMEMBER(int, pfnSSMPutGCUIntPtr,(PSSMHANDLE pSSM, RTGCUINTPTR GCPtr));
955 DECLR3CALLBACKMEMBER(int, pfnSSMPutRCPtr,(PSSMHANDLE pSSM, RTRCPTR RCPtr));
956 DECLR3CALLBACKMEMBER(int, pfnSSMPutIOPort,(PSSMHANDLE pSSM, RTIOPORT IOPort));
957 DECLR3CALLBACKMEMBER(int, pfnSSMPutSel,(PSSMHANDLE pSSM, RTSEL Sel));
958 DECLR3CALLBACKMEMBER(int, pfnSSMPutMem,(PSSMHANDLE pSSM, const void *pv, size_t cb));
959 DECLR3CALLBACKMEMBER(int, pfnSSMPutStrZ,(PSSMHANDLE pSSM, const char *psz));
960 DECLR3CALLBACKMEMBER(int, pfnSSMGetStruct,(PSSMHANDLE pSSM, void *pvStruct, PCSSMFIELD paFields));
961 DECLR3CALLBACKMEMBER(int, pfnSSMGetStructEx,(PSSMHANDLE pSSM, void *pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void *pvUser));
962 DECLR3CALLBACKMEMBER(int, pfnSSMGetBool,(PSSMHANDLE pSSM, bool *pfBool));
963 DECLR3CALLBACKMEMBER(int, pfnSSMGetBoolV,(PSSMHANDLE pSSM, bool volatile *pfBool));
964 DECLR3CALLBACKMEMBER(int, pfnSSMGetU8,(PSSMHANDLE pSSM, uint8_t *pu8));
965 DECLR3CALLBACKMEMBER(int, pfnSSMGetU8V,(PSSMHANDLE pSSM, uint8_t volatile *pu8));
966 DECLR3CALLBACKMEMBER(int, pfnSSMGetS8,(PSSMHANDLE pSSM, int8_t *pi8));
967 DECLR3CALLBACKMEMBER(int, pfnSSMGetS8V,(PSSMHANDLE pSSM, int8_t volatile *pi8));
968 DECLR3CALLBACKMEMBER(int, pfnSSMGetU16,(PSSMHANDLE pSSM, uint16_t *pu16));
969 DECLR3CALLBACKMEMBER(int, pfnSSMGetU16V,(PSSMHANDLE pSSM, uint16_t volatile *pu16));
970 DECLR3CALLBACKMEMBER(int, pfnSSMGetS16,(PSSMHANDLE pSSM, int16_t *pi16));
971 DECLR3CALLBACKMEMBER(int, pfnSSMGetS16V,(PSSMHANDLE pSSM, int16_t volatile *pi16));
972 DECLR3CALLBACKMEMBER(int, pfnSSMGetU32,(PSSMHANDLE pSSM, uint32_t *pu32));
973 DECLR3CALLBACKMEMBER(int, pfnSSMGetU32V,(PSSMHANDLE pSSM, uint32_t volatile *pu32));
974 DECLR3CALLBACKMEMBER(int, pfnSSMGetS32,(PSSMHANDLE pSSM, int32_t *pi32));
975 DECLR3CALLBACKMEMBER(int, pfnSSMGetS32V,(PSSMHANDLE pSSM, int32_t volatile *pi32));
976 DECLR3CALLBACKMEMBER(int, pfnSSMGetU64,(PSSMHANDLE pSSM, uint64_t *pu64));
977 DECLR3CALLBACKMEMBER(int, pfnSSMGetU64V,(PSSMHANDLE pSSM, uint64_t volatile *pu64));
978 DECLR3CALLBACKMEMBER(int, pfnSSMGetS64,(PSSMHANDLE pSSM, int64_t *pi64));
979 DECLR3CALLBACKMEMBER(int, pfnSSMGetS64V,(PSSMHANDLE pSSM, int64_t volatile *pi64));
980 DECLR3CALLBACKMEMBER(int, pfnSSMGetU128,(PSSMHANDLE pSSM, uint128_t *pu128));
981 DECLR3CALLBACKMEMBER(int, pfnSSMGetU128V,(PSSMHANDLE pSSM, uint128_t volatile *pu128));
982 DECLR3CALLBACKMEMBER(int, pfnSSMGetS128,(PSSMHANDLE pSSM, int128_t *pi128));
983 DECLR3CALLBACKMEMBER(int, pfnSSMGetS128V,(PSSMHANDLE pSSM, int128_t volatile *pi128));
984 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys32,(PSSMHANDLE pSSM, PRTGCPHYS32 pGCPhys));
985 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys32V,(PSSMHANDLE pSSM, RTGCPHYS32 volatile *pGCPhys));
986 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys64,(PSSMHANDLE pSSM, PRTGCPHYS64 pGCPhys));
987 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys64V,(PSSMHANDLE pSSM, RTGCPHYS64 volatile *pGCPhys));
988 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys,(PSSMHANDLE pSSM, PRTGCPHYS pGCPhys));
989 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhysV,(PSSMHANDLE pSSM, RTGCPHYS volatile *pGCPhys));
990 DECLR3CALLBACKMEMBER(int, pfnSSMGetUInt,(PSSMHANDLE pSSM, PRTUINT pu));
991 DECLR3CALLBACKMEMBER(int, pfnSSMGetSInt,(PSSMHANDLE pSSM, PRTINT pi));
992 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCUInt,(PSSMHANDLE pSSM, PRTGCUINT pu));
993 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCUIntReg,(PSSMHANDLE pSSM, PRTGCUINTREG pu));
994 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPtr,(PSSMHANDLE pSSM, PRTGCPTR pGCPtr));
995 DECLR3CALLBACKMEMBER(int, pfnSSMGetGCUIntPtr,(PSSMHANDLE pSSM, PRTGCUINTPTR pGCPtr));
996 DECLR3CALLBACKMEMBER(int, pfnSSMGetRCPtr,(PSSMHANDLE pSSM, PRTRCPTR pRCPtr));
997 DECLR3CALLBACKMEMBER(int, pfnSSMGetIOPort,(PSSMHANDLE pSSM, PRTIOPORT pIOPort));
998 DECLR3CALLBACKMEMBER(int, pfnSSMGetSel,(PSSMHANDLE pSSM, PRTSEL pSel));
999 DECLR3CALLBACKMEMBER(int, pfnSSMGetMem,(PSSMHANDLE pSSM, void *pv, size_t cb));
1000 DECLR3CALLBACKMEMBER(int, pfnSSMGetStrZ,(PSSMHANDLE pSSM, char *psz, size_t cbMax));
1001 DECLR3CALLBACKMEMBER(int, pfnSSMGetStrZEx,(PSSMHANDLE pSSM, char *psz, size_t cbMax, size_t *pcbStr));
1002 DECLR3CALLBACKMEMBER(int, pfnSSMSkip,(PSSMHANDLE pSSM, size_t cb));
1003 DECLR3CALLBACKMEMBER(int, pfnSSMSkipToEndOfUnit,(PSSMHANDLE pSSM));
1004 DECLR3CALLBACKMEMBER(int, pfnSSMSetLoadError,(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(6, 7));
1005 DECLR3CALLBACKMEMBER(int, pfnSSMSetLoadErrorV,(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
1006 DECLR3CALLBACKMEMBER(int, pfnSSMSetCfgError,(PSSMHANDLE pSSM, RT_SRC_POS_DECL, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(5, 6));
1007 DECLR3CALLBACKMEMBER(int, pfnSSMSetCfgErrorV,(PSSMHANDLE pSSM, RT_SRC_POS_DECL, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(5, 0));
1008 DECLR3CALLBACKMEMBER(int, pfnSSMHandleGetStatus,(PSSMHANDLE pSSM));
1009 DECLR3CALLBACKMEMBER(SSMAFTER, pfnSSMHandleGetAfter,(PSSMHANDLE pSSM));
1010 DECLR3CALLBACKMEMBER(bool, pfnSSMHandleIsLiveSave,(PSSMHANDLE pSSM));
1011 DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleMaxDowntime,(PSSMHANDLE pSSM));
1012 DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleHostBits,(PSSMHANDLE pSSM));
1013 DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleRevision,(PSSMHANDLE pSSM));
1014 DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleVersion,(PSSMHANDLE pSSM));
1015 DECLR3CALLBACKMEMBER(const char *, pfnSSMHandleHostOSAndArch,(PSSMHANDLE pSSM));
1016 /** @} */
1017
1018 /** @name Exported CFGM Functions.
1019 * @{ */
1020 DECLR3CALLBACKMEMBER(bool, pfnCFGMExists,( PCFGMNODE pNode, const char *pszName));
1021 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryType,( PCFGMNODE pNode, const char *pszName, PCFGMVALUETYPE penmType));
1022 DECLR3CALLBACKMEMBER(int, pfnCFGMQuerySize,( PCFGMNODE pNode, const char *pszName, size_t *pcb));
1023 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryInteger,( PCFGMNODE pNode, const char *pszName, uint64_t *pu64));
1024 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryIntegerDef,( PCFGMNODE pNode, const char *pszName, uint64_t *pu64, uint64_t u64Def));
1025 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryString,( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString));
1026 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryStringDef,( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString, const char *pszDef));
1027 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPassword,( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString));
1028 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPasswordDef,( PCFGMNODE pNode, const char *pszName, char *pszString, size_t cchString, const char *pszDef));
1029 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryBytes,( PCFGMNODE pNode, const char *pszName, void *pvData, size_t cbData));
1030 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU64,( PCFGMNODE pNode, const char *pszName, uint64_t *pu64));
1031 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU64Def,( PCFGMNODE pNode, const char *pszName, uint64_t *pu64, uint64_t u64Def));
1032 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS64,( PCFGMNODE pNode, const char *pszName, int64_t *pi64));
1033 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS64Def,( PCFGMNODE pNode, const char *pszName, int64_t *pi64, int64_t i64Def));
1034 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU32,( PCFGMNODE pNode, const char *pszName, uint32_t *pu32));
1035 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU32Def,( PCFGMNODE pNode, const char *pszName, uint32_t *pu32, uint32_t u32Def));
1036 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS32,( PCFGMNODE pNode, const char *pszName, int32_t *pi32));
1037 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS32Def,( PCFGMNODE pNode, const char *pszName, int32_t *pi32, int32_t i32Def));
1038 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU16,( PCFGMNODE pNode, const char *pszName, uint16_t *pu16));
1039 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU16Def,( PCFGMNODE pNode, const char *pszName, uint16_t *pu16, uint16_t u16Def));
1040 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS16,( PCFGMNODE pNode, const char *pszName, int16_t *pi16));
1041 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS16Def,( PCFGMNODE pNode, const char *pszName, int16_t *pi16, int16_t i16Def));
1042 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU8,( PCFGMNODE pNode, const char *pszName, uint8_t *pu8));
1043 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU8Def,( PCFGMNODE pNode, const char *pszName, uint8_t *pu8, uint8_t u8Def));
1044 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS8,( PCFGMNODE pNode, const char *pszName, int8_t *pi8));
1045 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS8Def,( PCFGMNODE pNode, const char *pszName, int8_t *pi8, int8_t i8Def));
1046 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryBool,( PCFGMNODE pNode, const char *pszName, bool *pf));
1047 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryBoolDef,( PCFGMNODE pNode, const char *pszName, bool *pf, bool fDef));
1048 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPort,( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort));
1049 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPortDef,( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort, RTIOPORT PortDef));
1050 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryUInt,( PCFGMNODE pNode, const char *pszName, unsigned int *pu));
1051 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryUIntDef,( PCFGMNODE pNode, const char *pszName, unsigned int *pu, unsigned int uDef));
1052 DECLR3CALLBACKMEMBER(int, pfnCFGMQuerySInt,( PCFGMNODE pNode, const char *pszName, signed int *pi));
1053 DECLR3CALLBACKMEMBER(int, pfnCFGMQuerySIntDef,( PCFGMNODE pNode, const char *pszName, signed int *pi, signed int iDef));
1054 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtr,( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr));
1055 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrDef,( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr, RTGCPTR GCPtrDef));
1056 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrU,( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr));
1057 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrUDef,( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr, RTGCUINTPTR GCPtrDef));
1058 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrS,( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr));
1059 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrSDef,( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr, RTGCINTPTR GCPtrDef));
1060 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryStringAlloc,( PCFGMNODE pNode, const char *pszName, char **ppszString));
1061 DECLR3CALLBACKMEMBER(int, pfnCFGMQueryStringAllocDef,(PCFGMNODE pNode, const char *pszName, char **ppszString, const char *pszDef));
1062 DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetParent,(PCFGMNODE pNode));
1063 DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetChild,(PCFGMNODE pNode, const char *pszPath));
1064 DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetChildF,(PCFGMNODE pNode, const char *pszPathFormat, ...) RT_IPRT_FORMAT_ATTR(2, 3));
1065 DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetChildFV,(PCFGMNODE pNode, const char *pszPathFormat, va_list Args) RT_IPRT_FORMAT_ATTR(3, 0));
1066 DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetFirstChild,(PCFGMNODE pNode));
1067 DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetNextChild,(PCFGMNODE pCur));
1068 DECLR3CALLBACKMEMBER(int, pfnCFGMGetName,(PCFGMNODE pCur, char *pszName, size_t cchName));
1069 DECLR3CALLBACKMEMBER(size_t, pfnCFGMGetNameLen,(PCFGMNODE pCur));
1070 DECLR3CALLBACKMEMBER(bool, pfnCFGMAreChildrenValid,(PCFGMNODE pNode, const char *pszzValid));
1071 DECLR3CALLBACKMEMBER(PCFGMLEAF, pfnCFGMGetFirstValue,(PCFGMNODE pCur));
1072 DECLR3CALLBACKMEMBER(PCFGMLEAF, pfnCFGMGetNextValue,(PCFGMLEAF pCur));
1073 DECLR3CALLBACKMEMBER(int, pfnCFGMGetValueName,(PCFGMLEAF pCur, char *pszName, size_t cchName));
1074 DECLR3CALLBACKMEMBER(size_t, pfnCFGMGetValueNameLen,(PCFGMLEAF pCur));
1075 DECLR3CALLBACKMEMBER(CFGMVALUETYPE, pfnCFGMGetValueType,(PCFGMLEAF pCur));
1076 DECLR3CALLBACKMEMBER(bool, pfnCFGMAreValuesValid,(PCFGMNODE pNode, const char *pszzValid));
1077 DECLR3CALLBACKMEMBER(int, pfnCFGMValidateConfig,(PCFGMNODE pNode, const char *pszNode,
1078 const char *pszValidValues, const char *pszValidNodes,
1079 const char *pszWho, uint32_t uInstance));
1080 /** @} */
1081
1082 /**
1083 * Free memory allocated with pfnMMHeapAlloc() and pfnMMHeapAllocZ().
1084 *
1085 * @param pDrvIns Driver instance.
1086 * @param pv Pointer to the memory to free.
1087 */
1088 DECLR3CALLBACKMEMBER(void, pfnMMHeapFree,(PPDMDRVINS pDrvIns, void *pv));
1089
1090 /**
1091 * Register an info handler with DBGF.
1092 *
1093 * @returns VBox status code.
1094 * @param pDrvIns Driver instance.
1095 * @param pszName Data unit name.
1096 * @param pszDesc The description of the info and any arguments
1097 * the handler may take.
1098 * @param pfnHandler The handler function to be called to display the
1099 * info.
1100 */
1101 DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler));
1102
1103 /**
1104 * Register an info handler with DBGF, argv style.
1105 *
1106 * @returns VBox status code.
1107 * @param pDrvIns Driver instance.
1108 * @param pszName Data unit name.
1109 * @param pszDesc The description of the info and any arguments
1110 * the handler may take.
1111 * @param pfnHandler The handler function to be called to display the
1112 * info.
1113 */
1114 DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegisterArgv,(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFINFOARGVDRV pfnHandler));
1115
1116 /**
1117 * Deregister an info handler from DBGF.
1118 *
1119 * @returns VBox status code.
1120 * @param pDrvIns Driver instance.
1121 * @param pszName Data unit name.
1122 */
1123 DECLR3CALLBACKMEMBER(int, pfnDBGFInfoDeregister,(PPDMDRVINS pDrvIns, const char *pszName));
1124
1125 /**
1126 * Registers a statistics sample if statistics are enabled.
1127 *
1128 * @param pDrvIns Driver instance.
1129 * @param pvSample Pointer to the sample.
1130 * @param enmType Sample type. This indicates what pvSample is pointing at.
1131 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
1132 * Further nesting is possible. If this does not start
1133 * with a '/', the default prefix will be prepended,
1134 * otherwise it will be used as-is.
1135 * @param enmUnit Sample unit.
1136 * @param pszDesc Sample description.
1137 */
1138 DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName,
1139 STAMUNIT enmUnit, const char *pszDesc));
1140
1141 /**
1142 * Same as pfnSTAMRegister except that the name is specified in a
1143 * RTStrPrintf like fashion.
1144 *
1145 * @param pDrvIns Driver instance.
1146 * @param pvSample Pointer to the sample.
1147 * @param enmType Sample type. This indicates what pvSample is pointing at.
1148 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1149 * @param enmUnit Sample unit.
1150 * @param pszDesc Sample description.
1151 * @param pszName The sample name format string. If this does not start
1152 * with a '/', the default prefix will be prepended,
1153 * otherwise it will be used as-is.
1154 * @param ... Arguments to the format string.
1155 */
1156 DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1157 STAMUNIT enmUnit, const char *pszDesc,
1158 const char *pszName, ...) RT_IPRT_FORMAT_ATTR(7, 8));
1159
1160 /**
1161 * Same as pfnSTAMRegister except that the name is specified in a
1162 * RTStrPrintfV like fashion.
1163 *
1164 * @param pDrvIns Driver instance.
1165 * @param pvSample Pointer to the sample.
1166 * @param enmType Sample type. This indicates what pvSample is pointing at.
1167 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1168 * @param enmUnit Sample unit.
1169 * @param pszDesc Sample description.
1170 * @param pszName The sample name format string. If this does not
1171 * start with a '/', the default prefix will be prepended,
1172 * otherwise it will be used as-is.
1173 * @param args Arguments to the format string.
1174 */
1175 DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1176 STAMUNIT enmUnit, const char *pszDesc,
1177 const char *pszName, va_list args) RT_IPRT_FORMAT_ATTR(7, 0));
1178
1179 /**
1180 * Deregister a statistic item previously registered with pfnSTAMRegister,
1181 * pfnSTAMRegisterF or pfnSTAMRegisterV
1182 *
1183 * @returns VBox status.
1184 * @param pDrvIns Driver instance.
1185 * @param pvSample Pointer to the sample.
1186 */
1187 DECLR3CALLBACKMEMBER(int, pfnSTAMDeregister,(PPDMDRVINS pDrvIns, void *pvSample));
1188
1189 /**
1190 * Calls the HC R0 VMM entry point, in a safer but slower manner than
1191 * SUPR3CallVMMR0.
1192 *
1193 * When entering using this call the R0 components can call into the host kernel
1194 * (i.e. use the SUPR0 and RT APIs).
1195 *
1196 * See VMMR0Entry() for more details.
1197 *
1198 * @returns error code specific to uFunction.
1199 * @param pDrvIns The driver instance.
1200 * @param uOperation Operation to execute.
1201 * This is limited to services.
1202 * @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
1203 * @param cbArg The size of the argument. This is used to copy whatever the argument
1204 * points at into a kernel buffer to avoid problems like the user page
1205 * being invalidated while we're executing the call.
1206 */
1207 DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
1208
1209 /**
1210 * Registers a USB HUB.
1211 *
1212 * @returns VBox status code.
1213 * @param pDrvIns The driver instance.
1214 * @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
1215 * @param cPorts The number of ports.
1216 * @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
1217 * @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
1218 *
1219 * @thread EMT.
1220 */
1221 DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
1222
1223 /**
1224 * Set up asynchronous handling of a suspend, reset or power off notification.
1225 *
1226 * This shall only be called when getting the notification. It must be called
1227 * for each one.
1228 *
1229 * @returns VBox status code.
1230 * @param pDrvIns The driver instance.
1231 * @param pfnAsyncNotify The callback.
1232 * @thread EMT(0)
1233 */
1234 DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
1235
1236 /**
1237 * Notify EMT(0) that the driver has completed the asynchronous notification
1238 * handling.
1239 *
1240 * This can be called at any time, spurious calls will simply be ignored.
1241 *
1242 * @param pDrvIns The driver instance.
1243 * @thread Any
1244 */
1245 DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMDRVINS pDrvIns));
1246
1247 /**
1248 * Creates a PDM thread.
1249 *
1250 * This differs from the RTThreadCreate() API in that PDM takes care of suspending,
1251 * resuming, and destroying the thread as the VM state changes.
1252 *
1253 * @returns VBox status code.
1254 * @param pDrvIns The driver instance.
1255 * @param ppThread Where to store the thread 'handle'.
1256 * @param pvUser The user argument to the thread function.
1257 * @param pfnThread The thread function.
1258 * @param pfnWakeup The wakup callback. This is called on the EMT thread when
1259 * a state change is pending.
1260 * @param cbStack See RTThreadCreate.
1261 * @param enmType See RTThreadCreate.
1262 * @param pszName See RTThreadCreate.
1263 */
1264 DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1265 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
1266
1267 /** @name Exported PDM Thread Functions
1268 * @{ */
1269 DECLR3CALLBACKMEMBER(int, pfnThreadDestroy,(PPDMTHREAD pThread, int *pRcThread));
1270 DECLR3CALLBACKMEMBER(int, pfnThreadIAmSuspending,(PPDMTHREAD pThread));
1271 DECLR3CALLBACKMEMBER(int, pfnThreadIAmRunning,(PPDMTHREAD pThread));
1272 DECLR3CALLBACKMEMBER(int, pfnThreadSleep,(PPDMTHREAD pThread, RTMSINTERVAL cMillies));
1273 DECLR3CALLBACKMEMBER(int, pfnThreadSuspend,(PPDMTHREAD pThread));
1274 DECLR3CALLBACKMEMBER(int, pfnThreadResume,(PPDMTHREAD pThread));
1275 /** @} */
1276
1277 /**
1278 * Creates an async completion template for a driver instance.
1279 *
1280 * The template is used when creating new completion tasks.
1281 *
1282 * @returns VBox status code.
1283 * @param pDrvIns The driver instance.
1284 * @param ppTemplate Where to store the template pointer on success.
1285 * @param pfnCompleted The completion callback routine.
1286 * @param pvTemplateUser Template user argument.
1287 * @param pszDesc Description.
1288 */
1289 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1290 PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1291 const char *pszDesc));
1292
1293 /** @name Exported PDM Async Completion Functions
1294 * @{ */
1295 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateDestroy,(PPDMASYNCCOMPLETIONTEMPLATE pTemplate));
1296 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpCreateForFile,(PPPDMASYNCCOMPLETIONENDPOINT ppEndpoint,
1297 const char *pszFilename, uint32_t fFlags,
1298 PPDMASYNCCOMPLETIONTEMPLATE pTemplate));
1299 DECLR3CALLBACKMEMBER(void, pfnAsyncCompletionEpClose,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint));
1300 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpGetSize,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t *pcbSize));
1301 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpSetSize,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t cbSize));
1302 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpSetBwMgr,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, const char *pszBwMgr));
1303 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpFlush,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, void *pvUser, PPPDMASYNCCOMPLETIONTASK ppTask));
1304 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpRead,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
1305 PCRTSGSEG paSegments, unsigned cSegments,
1306 size_t cbRead, void *pvUser,
1307 PPPDMASYNCCOMPLETIONTASK ppTask));
1308 DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpWrite,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
1309 PCRTSGSEG paSegments, unsigned cSegments,
1310 size_t cbWrite, void *pvUser,
1311 PPPDMASYNCCOMPLETIONTASK ppTask));
1312 /** @} */
1313
1314
1315 /**
1316 * Attaches a network filter driver to a named bandwidth group.
1317 *
1318 * @returns VBox status code.
1319 * @retval VERR_ALREADY_INITIALIZED if already attached to a group.
1320 * @param pDrvIns The driver instance.
1321 * @param pszBwGroup Name of the bandwidth group to attach to.
1322 * @param pFilter Pointer to the filter we attach.
1323 */
1324 DECLR3CALLBACKMEMBER(int, pfnNetShaperAttach,(PPDMDRVINS pDrvIns, const char *pszBwGroup, PPDMNSFILTER pFilter));
1325
1326 /**
1327 * Detaches a network filter driver from its current bandwidth group (if any).
1328 *
1329 * @returns VBox status code.
1330 * @param pDrvIns The driver instance.
1331 * @param pFilter Pointer to the filter we attach.
1332 */
1333 DECLR3CALLBACKMEMBER(int, pfnNetShaperDetach,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter));
1334
1335 /**
1336 * Obtains bandwidth in a bandwidth group.
1337 *
1338 * @returns True if bandwidth was allocated, false if not.
1339 * @param pDrvIns The driver instance.
1340 * @param pFilter Pointer to the filter that allocates bandwidth.
1341 * @param cbTransfer Number of bytes to allocate.
1342 */
1343 DECLR3CALLBACKMEMBER(bool, pfnNetShaperAllocateBandwidth,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer));
1344
1345 /**
1346 * Resolves the symbol for a raw-mode context interface.
1347 *
1348 * @returns VBox status code.
1349 * @param pDrvIns The driver instance.
1350 * @param pvInterface The interface structure.
1351 * @param cbInterface The size of the interface structure.
1352 * @param pszSymPrefix What to prefix the symbols in the list with before
1353 * resolving them. This must start with 'drv' and
1354 * contain the driver name.
1355 * @param pszSymList List of symbols corresponding to the interface.
1356 * There is generally a there is generally a define
1357 * holding this list associated with the interface
1358 * definition (INTERFACE_SYM_LIST). For more details
1359 * see PDMR3LdrGetInterfaceSymbols.
1360 * @thread EMT
1361 */
1362 DECLR3CALLBACKMEMBER(int, pfnLdrGetRCInterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1363 const char *pszSymPrefix, const char *pszSymList));
1364
1365 /**
1366 * Resolves the symbol for a ring-0 context interface.
1367 *
1368 * @returns VBox status code.
1369 * @param pDrvIns The driver instance.
1370 * @param pvInterface The interface structure.
1371 * @param cbInterface The size of the interface structure.
1372 * @param pszSymPrefix What to prefix the symbols in the list with before
1373 * resolving them. This must start with 'drv' and
1374 * contain the driver name.
1375 * @param pszSymList List of symbols corresponding to the interface.
1376 * There is generally a there is generally a define
1377 * holding this list associated with the interface
1378 * definition (INTERFACE_SYM_LIST). For more details
1379 * see PDMR3LdrGetInterfaceSymbols.
1380 * @thread EMT
1381 */
1382 DECLR3CALLBACKMEMBER(int, pfnLdrGetR0InterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1383 const char *pszSymPrefix, const char *pszSymList));
1384 /**
1385 * Initializes a PDM critical section.
1386 *
1387 * The PDM critical sections are derived from the IPRT critical sections, but
1388 * works in both RC and R0 as well as R3.
1389 *
1390 * @returns VBox status code.
1391 * @param pDrvIns The driver instance.
1392 * @param pCritSect Pointer to the critical section.
1393 * @param SRC_POS Use RT_SRC_POS.
1394 * @param pszName The base name of the critical section. Will be
1395 * mangeled with the instance number. For
1396 * statistics and lock validation.
1397 * @thread EMT
1398 */
1399 DECLR3CALLBACKMEMBER(int, pfnCritSectInit,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName));
1400
1401 /** @name Exported PDM Critical Section Functions
1402 * @{ */
1403 DECLR3CALLBACKMEMBER(bool, pfnCritSectYield,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1404 DECLR3CALLBACKMEMBER(int, pfnCritSectEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy));
1405 DECLR3CALLBACKMEMBER(int, pfnCritSectEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL));
1406 DECLR3CALLBACKMEMBER(int, pfnCritSectTryEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1407 DECLR3CALLBACKMEMBER(int, pfnCritSectTryEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL));
1408 DECLR3CALLBACKMEMBER(int, pfnCritSectLeave,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1409 DECLR3CALLBACKMEMBER(bool, pfnCritSectIsOwner,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1410 DECLR3CALLBACKMEMBER(bool, pfnCritSectIsInitialized,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1411 DECLR3CALLBACKMEMBER(bool, pfnCritSectHasWaiters,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1412 DECLR3CALLBACKMEMBER(uint32_t, pfnCritSectGetRecursion,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1413 DECLR3CALLBACKMEMBER(int, pfnCritSectScheduleExitEvent,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal));
1414 DECLR3CALLBACKMEMBER(int, pfnCritSectDelete,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1415 /** @} */
1416
1417 /**
1418 * Call the ring-0 request handler routine of the driver.
1419 *
1420 * For this to work, the driver must be ring-0 enabled and export a request
1421 * handler function. The name of the function must be the driver name in the
1422 * PDMDRVREG struct prefixed with 'drvR0' and suffixed with 'ReqHandler'.
1423 * The driver name will be capitalized. It shall take the exact same
1424 * arguments as this function and be declared using PDMBOTHCBDECL. See
1425 * FNPDMDRVREQHANDLERR0.
1426 *
1427 * @returns VBox status code.
1428 * @retval VERR_SYMBOL_NOT_FOUND if the driver doesn't export the required
1429 * handler function.
1430 * @retval VERR_ACCESS_DENIED if the driver isn't ring-0 capable.
1431 *
1432 * @param pDrvIns The driver instance.
1433 * @param uOperation The operation to perform.
1434 * @param u64Arg 64-bit integer argument.
1435 * @thread Any
1436 */
1437 DECLR3CALLBACKMEMBER(int, pfnCallR0,(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg));
1438
1439 /**
1440 * Creates a block cache for a driver driver instance.
1441 *
1442 * @returns VBox status code.
1443 * @param pDrvIns The driver instance.
1444 * @param ppBlkCache Where to store the handle to the block cache.
1445 * @param pfnXferComplete The I/O transfer complete callback.
1446 * @param pfnXferEnqueue The I/O request enqueue callback.
1447 * @param pfnXferEnqueueDiscard The discard request enqueue callback.
1448 * @param pcszId Unique ID used to identify the user.
1449 */
1450 DECLR3CALLBACKMEMBER(int, pfnBlkCacheRetain, (PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1451 PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1452 PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1453 PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1454 const char *pcszId));
1455
1456 /** @name Exported PDM Block Cache Functions
1457 * @{ */
1458 DECLR3CALLBACKMEMBER(void, pfnBlkCacheRelease,(PPDMBLKCACHE pBlkCache));
1459 DECLR3CALLBACKMEMBER(int, pfnBlkCacheClear,(PPDMBLKCACHE pBlkCache));
1460 DECLR3CALLBACKMEMBER(int, pfnBlkCacheSuspend,(PPDMBLKCACHE pBlkCache));
1461 DECLR3CALLBACKMEMBER(int, pfnBlkCacheResume,(PPDMBLKCACHE pBlkCache));
1462 DECLR3CALLBACKMEMBER(void, pfnBlkCacheIoXferComplete,(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer));
1463 DECLR3CALLBACKMEMBER(int, pfnBlkCacheRead,(PPDMBLKCACHE pBlkCache, uint64_t off, PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser));
1464 DECLR3CALLBACKMEMBER(int, pfnBlkCacheWrite,(PPDMBLKCACHE pBlkCache, uint64_t off, PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser));
1465 DECLR3CALLBACKMEMBER(int, pfnBlkCacheFlush,(PPDMBLKCACHE pBlkCache, void *pvUser));
1466 DECLR3CALLBACKMEMBER(int, pfnBlkCacheDiscard,(PPDMBLKCACHE pBlkCache, PCRTRANGE paRanges, unsigned cRanges, void *pvUser));
1467 /** @} */
1468
1469 /**
1470 * Gets the reason for the most recent VM suspend.
1471 *
1472 * @returns The suspend reason. VMSUSPENDREASON_INVALID is returned if no
1473 * suspend has been made or if the pDrvIns is invalid.
1474 * @param pDrvIns The driver instance.
1475 */
1476 DECLR3CALLBACKMEMBER(VMSUSPENDREASON, pfnVMGetSuspendReason,(PPDMDRVINS pDrvIns));
1477
1478 /**
1479 * Gets the reason for the most recent VM resume.
1480 *
1481 * @returns The resume reason. VMRESUMEREASON_INVALID is returned if no
1482 * resume has been made or if the pDrvIns is invalid.
1483 * @param pDrvIns The driver instance.
1484 */
1485 DECLR3CALLBACKMEMBER(VMRESUMEREASON, pfnVMGetResumeReason,(PPDMDRVINS pDrvIns));
1486
1487 /** @name Space reserved for minor interface changes.
1488 * @{ */
1489 DECLR3CALLBACKMEMBER(int, pfnTimerSetMillies,(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext));
1490
1491 /**
1492 * Deregister zero or more samples given their name prefix.
1493 *
1494 * @returns VBox status code.
1495 * @param pDrvIns The driver instance.
1496 * @param pszPrefix The name prefix of the samples to remove. If this does
1497 * not start with a '/', the default prefix will be
1498 * prepended, otherwise it will be used as-is.
1499 */
1500 DECLR3CALLBACKMEMBER(int, pfnSTAMDeregisterByPrefix,(PPDMDRVINS pDrvIns, const char *pszPrefix));
1501
1502 /**
1503 * Queries a generic object from the VMM user.
1504 *
1505 * @returns Pointer to the object if found, NULL if not.
1506 * @param pDrvIns The driver instance.
1507 * @param pUuid The UUID of what's being queried. The UUIDs and
1508 * the usage conventions are defined by the user.
1509 */
1510 DECLR3CALLBACKMEMBER(void *, pfnQueryGenericUserObject,(PPDMDRVINS pDrvIns, PCRTUUID pUuid));
1511
1512 DECLR3CALLBACKMEMBER(void, pfnReserved0,(PPDMDRVINS pDrvIns));
1513 DECLR3CALLBACKMEMBER(void, pfnReserved1,(PPDMDRVINS pDrvIns));
1514 DECLR3CALLBACKMEMBER(void, pfnReserved2,(PPDMDRVINS pDrvIns));
1515 DECLR3CALLBACKMEMBER(void, pfnReserved3,(PPDMDRVINS pDrvIns));
1516 DECLR3CALLBACKMEMBER(void, pfnReserved4,(PPDMDRVINS pDrvIns));
1517 DECLR3CALLBACKMEMBER(void, pfnReserved5,(PPDMDRVINS pDrvIns));
1518 DECLR3CALLBACKMEMBER(void, pfnReserved6,(PPDMDRVINS pDrvIns));
1519 DECLR3CALLBACKMEMBER(void, pfnReserved7,(PPDMDRVINS pDrvIns));
1520 DECLR3CALLBACKMEMBER(void, pfnReserved8,(PPDMDRVINS pDrvIns));
1521 /** @} */
1522
1523 /** Just a safety precaution. */
1524 uint32_t u32TheEnd;
1525} PDMDRVHLPR3;
1526/** Current DRVHLP version number. */
1527#define PDM_DRVHLPR3_VERSION PDM_VERSION_MAKE(0xf0fb, 16, 0)
1528
1529
1530/**
1531 * Set the VM error message
1532 *
1533 * @returns rc.
1534 * @param pDrvIns Driver instance.
1535 * @param rc VBox status code.
1536 * @param SRC_POS Use RT_SRC_POS.
1537 * @param pszFormat Error message format string.
1538 * @param ... Error message arguments.
1539 * @sa PDMDRV_SET_ERROR, PDMDrvHlpVMSetErrorV, VMSetError
1540 */
1541DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 7) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1542 const char *pszFormat, ...)
1543{
1544 va_list va;
1545 va_start(va, pszFormat);
1546 pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1547 va_end(va);
1548 return rc;
1549}
1550
1551/** @def PDMDRV_SET_ERROR
1552 * Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
1553 */
1554#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
1555 PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
1556
1557/**
1558 * @copydoc PDMDRVHLPR3::pfnVMSetErrorV
1559 */
1560DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 0) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1561 const char *pszFormat, va_list va)
1562{
1563 return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1564}
1565
1566
1567/**
1568 * Set the VM runtime error message
1569 *
1570 * @returns VBox status code.
1571 * @param pDrvIns Driver instance.
1572 * @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
1573 * @param pszErrorId Error ID string.
1574 * @param pszFormat Error message format string.
1575 * @param ... Error message arguments.
1576 * @sa PDMDRV_SET_RUNTIME_ERROR, PDMDrvHlpVMSetRuntimeErrorV,
1577 * VMSetRuntimeError
1578 */
1579DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 5) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
1580 const char *pszFormat, ...)
1581{
1582 va_list va;
1583 int rc;
1584 va_start(va, pszFormat);
1585 rc = pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1586 va_end(va);
1587 return rc;
1588}
1589
1590/** @def PDMDRV_SET_RUNTIME_ERROR
1591 * Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
1592 */
1593#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFlags, pszErrorId, pszError) \
1594 PDMDrvHlpVMSetRuntimeError(pDrvIns, fFlags, pszErrorId, "%s", pszError)
1595
1596/**
1597 * @copydoc PDMDRVHLPR3::pfnVMSetRuntimeErrorV
1598 */
1599DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 0) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags,
1600 const char *pszErrorId, const char *pszFormat, va_list va)
1601{
1602 return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1603}
1604
1605#endif /* IN_RING3 */
1606
1607/** @def PDMDRV_ASSERT_EMT
1608 * Assert that the current thread is the emulation thread.
1609 */
1610#ifdef VBOX_STRICT
1611# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1612#else
1613# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
1614#endif
1615
1616/** @def PDMDRV_ASSERT_OTHER
1617 * Assert that the current thread is NOT the emulation thread.
1618 */
1619#ifdef VBOX_STRICT
1620# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1621#else
1622# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
1623#endif
1624
1625
1626#ifdef IN_RING3
1627
1628/**
1629 * @copydoc PDMDRVHLPR3::pfnAttach
1630 */
1631DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
1632{
1633 return pDrvIns->pHlpR3->pfnAttach(pDrvIns, fFlags, ppBaseInterface);
1634}
1635
1636/**
1637 * Check that there is no driver below the us that we should attach to.
1638 *
1639 * @returns VERR_PDM_NO_ATTACHED_DRIVER if there is no driver.
1640 * @param pDrvIns The driver instance.
1641 */
1642DECLINLINE(int) PDMDrvHlpNoAttach(PPDMDRVINS pDrvIns)
1643{
1644 return pDrvIns->pHlpR3->pfnAttach(pDrvIns, 0, NULL);
1645}
1646
1647/**
1648 * @copydoc PDMDRVHLPR3::pfnDetach
1649 */
1650DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1651{
1652 return pDrvIns->pHlpR3->pfnDetach(pDrvIns, fFlags);
1653}
1654
1655/**
1656 * @copydoc PDMDRVHLPR3::pfnDetachSelf
1657 */
1658DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1659{
1660 return pDrvIns->pHlpR3->pfnDetachSelf(pDrvIns, fFlags);
1661}
1662
1663/**
1664 * @copydoc PDMDRVHLPR3::pfnMountPrepare
1665 */
1666DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver)
1667{
1668 return pDrvIns->pHlpR3->pfnMountPrepare(pDrvIns, pszFilename, pszCoreDriver);
1669}
1670
1671/**
1672 * @copydoc PDMDRVHLPR3::pfnVMState
1673 */
1674DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
1675{
1676 return pDrvIns->CTX_SUFF(pHlp)->pfnVMState(pDrvIns);
1677}
1678
1679/**
1680 * @copydoc PDMDRVHLPR3::pfnVMTeleportedAndNotFullyResumedYet
1681 */
1682DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1683{
1684 return pDrvIns->pHlpR3->pfnVMTeleportedAndNotFullyResumedYet(pDrvIns);
1685}
1686
1687/**
1688 * @copydoc PDMDRVHLPR3::pfnGetSupDrvSession
1689 */
1690DECLINLINE(PSUPDRVSESSION) PDMDrvHlpGetSupDrvSession(PPDMDRVINS pDrvIns)
1691{
1692 return pDrvIns->pHlpR3->pfnGetSupDrvSession(pDrvIns);
1693}
1694
1695/**
1696 * @copydoc PDMDRVHLPR3::pfnQueueCreate
1697 */
1698DECLINLINE(int) PDMDrvHlpQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1699 PFNPDMQUEUEDRV pfnCallback, const char *pszName, PDMQUEUEHANDLE *phQueue)
1700{
1701 return pDrvIns->pHlpR3->pfnQueueCreate(pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, phQueue);
1702}
1703
1704/**
1705 * @copydoc PDMDRVHLPR3::pfnQueueAlloc
1706 */
1707DECLINLINE(PPDMQUEUEITEMCORE) PDMDrvHlpQueueAlloc(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue)
1708{
1709 return pDrvIns->CTX_SUFF(pHlp)->pfnQueueAlloc(pDrvIns, hQueue);
1710}
1711
1712/**
1713 * @copydoc PDMDRVHLPR3::pfnQueueInsert
1714 */
1715DECLINLINE(int) PDMDrvHlpQueueInsert(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue, PPDMQUEUEITEMCORE pItem)
1716{
1717 return pDrvIns->CTX_SUFF(pHlp)->pfnQueueInsert(pDrvIns, hQueue, pItem);
1718}
1719
1720/**
1721 * @copydoc PDMDRVHLPR3::pfnQueueFlushIfNecessary
1722 */
1723DECLINLINE(bool) PDMDrvHlpQueueFlushIfNecessary(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue)
1724{
1725 return pDrvIns->CTX_SUFF(pHlp)->pfnQueueFlushIfNecessary(pDrvIns, hQueue);
1726}
1727
1728/**
1729 * @copydoc PDMDRVHLPR3::pfnTMGetVirtualFreq
1730 */
1731DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
1732{
1733 return pDrvIns->pHlpR3->pfnTMGetVirtualFreq(pDrvIns);
1734}
1735
1736/**
1737 * @copydoc PDMDRVHLPR3::pfnTMGetVirtualTime
1738 */
1739DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
1740{
1741 return pDrvIns->pHlpR3->pfnTMGetVirtualTime(pDrvIns);
1742}
1743
1744/**
1745 * @copydoc PDMDRVHLPR3::pfnTimerCreate
1746 */
1747DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
1748 uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1749
1750{
1751 return pDrvIns->pHlpR3->pfnTimerCreate(pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, phTimer);
1752}
1753
1754/**
1755 * @copydoc PDMDRVHLPR3::pfnTimerDestroy
1756 */
1757DECLINLINE(int) PDMDrvHlpTimerDestroy(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer)
1758
1759{
1760 return pDrvIns->pHlpR3->pfnTimerDestroy(pDrvIns, hTimer);
1761}
1762
1763/**
1764 * @copydoc PDMDRVHLPR3::pfnTimerSetMillies
1765 */
1766DECLINLINE(int) PDMDrvHlpTimerSetMillies(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext)
1767
1768{
1769 return pDrvIns->pHlpR3->pfnTimerSetMillies(pDrvIns, hTimer, cMilliesToNext);
1770}
1771
1772/**
1773 * Register a save state data unit.
1774 *
1775 * @returns VBox status.
1776 * @param pDrvIns Driver instance.
1777 * @param uVersion Data layout version number.
1778 * @param cbGuess The approximate amount of data in the unit.
1779 * Only for progress indicators.
1780 * @param pfnSaveExec Execute save callback, optional.
1781 * @param pfnLoadExec Execute load callback, optional.
1782 */
1783DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1784 PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVLOADEXEC pfnLoadExec)
1785{
1786 return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1787 NULL /*pfnLivePrep*/, NULL /*pfnLiveExec*/, NULL /*pfnLiveVote*/,
1788 NULL /*pfnSavePrep*/, pfnSaveExec, NULL /*pfnSaveDone*/,
1789 NULL /*pfnLoadPrep*/, pfnLoadExec, NULL /*pfnLoadDone*/);
1790}
1791
1792/**
1793 * @copydoc PDMDRVHLPR3::pfnSSMRegister
1794 */
1795DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1796 PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1797 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1798 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1799{
1800 return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1801 pfnLivePrep, pfnLiveExec, pfnLiveVote,
1802 pfnSavePrep, pfnSaveExec, pfnSaveDone,
1803 pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1804}
1805
1806/**
1807 * Register a load done callback.
1808 *
1809 * @returns VBox status.
1810 * @param pDrvIns Driver instance.
1811 * @param pfnLoadDone Done load callback, optional.
1812 */
1813DECLINLINE(int) PDMDrvHlpSSMRegisterLoadDone(PPDMDRVINS pDrvIns, PFNSSMDRVLOADDONE pfnLoadDone)
1814{
1815 return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, 0 /*uVersion*/, 0 /*cbGuess*/,
1816 NULL /*pfnLivePrep*/, NULL /*pfnLiveExec*/, NULL /*pfnLiveVote*/,
1817 NULL /*pfnSavePrep*/, NULL /*pfnSaveExec*/, NULL /*pfnSaveDone*/,
1818 NULL /*pfnLoadPrep*/, NULL /*pfnLoadExec*/, pfnLoadDone);
1819}
1820
1821/**
1822 * @copydoc PDMDRVHLPR3::pfnMMHeapFree
1823 */
1824DECLINLINE(void) PDMDrvHlpMMHeapFree(PPDMDRVINS pDrvIns, void *pv)
1825{
1826 pDrvIns->pHlpR3->pfnMMHeapFree(pDrvIns, pv);
1827}
1828
1829/**
1830 * @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1831 */
1832DECLINLINE(int) PDMDrvHlpDBGFInfoRegister(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1833{
1834 return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1835}
1836
1837/**
1838 * @copydoc PDMDRVHLPR3::pfnDBGFInfoRegisterArgv
1839 */
1840DECLINLINE(int) PDMDrvHlpDBGFInfoRegisterArgv(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFINFOARGVDRV pfnHandler)
1841{
1842 return pDrvIns->pHlpR3->pfnDBGFInfoRegisterArgv(pDrvIns, pszName, pszDesc, pfnHandler);
1843}
1844
1845/**
1846 * @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1847 */
1848DECLINLINE(int) PDMDrvHlpDBGFInfoDeregister(PPDMDRVINS pDrvIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1849{
1850 return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1851}
1852
1853/**
1854 * @copydoc PDMDRVHLPR3::pfnSTAMRegister
1855 */
1856DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1857{
1858 pDrvIns->pHlpR3->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
1859}
1860
1861/**
1862 * @copydoc PDMDRVHLPR3::pfnSTAMRegisterF
1863 */
1864DECLINLINE(void) RT_IPRT_FORMAT_ATTR(7, 8) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType,
1865 STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1866 const char *pszDesc, const char *pszName, ...)
1867{
1868 va_list va;
1869 va_start(va, pszName);
1870 pDrvIns->pHlpR3->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1871 va_end(va);
1872}
1873
1874/**
1875 * Convenience wrapper that registers counter which is always visible.
1876 *
1877 * @param pDrvIns The driver instance.
1878 * @param pCounter Pointer to the counter variable.
1879 * @param pszName The name of the sample. This is prefixed with
1880 * "/Drivers/<drivername>-<instance no>/".
1881 * @param enmUnit The unit.
1882 * @param pszDesc The description.
1883 */
1884DECLINLINE(void) PDMDrvHlpSTAMRegCounterEx(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1885{
1886 pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pCounter, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1887 "/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1888}
1889
1890/**
1891 * Convenience wrapper that registers counter which is always visible and has
1892 * the STAMUNIT_COUNT unit.
1893 *
1894 * @param pDrvIns The driver instance.
1895 * @param pCounter Pointer to the counter variable.
1896 * @param pszName The name of the sample. This is prefixed with
1897 * "/Drivers/<drivername>-<instance no>/".
1898 * @param pszDesc The description.
1899 */
1900DECLINLINE(void) PDMDrvHlpSTAMRegCounter(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char *pszName, const char *pszDesc)
1901{
1902 PDMDrvHlpSTAMRegCounterEx(pDrvIns, pCounter, pszName, STAMUNIT_COUNT, pszDesc);
1903}
1904
1905/**
1906 * Convenience wrapper that registers profiling sample which is always visible.
1907 *
1908 * @param pDrvIns The driver instance.
1909 * @param pProfile Pointer to the profiling variable.
1910 * @param pszName The name of the sample. This is prefixed with
1911 * "/Drivers/<drivername>-<instance no>/".
1912 * @param enmUnit The unit.
1913 * @param pszDesc The description.
1914 */
1915DECLINLINE(void) PDMDrvHlpSTAMRegProfileEx(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1916{
1917 pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1918 "/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1919}
1920
1921/**
1922 * Convenience wrapper that registers profiling sample which is always visible
1923 * hand counts ticks per call (STAMUNIT_TICKS_PER_CALL).
1924 *
1925 * @param pDrvIns The driver instance.
1926 * @param pProfile Pointer to the profiling variable.
1927 * @param pszName The name of the sample. This is prefixed with
1928 * "/Drivers/<drivername>-<instance no>/".
1929 * @param pszDesc The description.
1930 */
1931DECLINLINE(void) PDMDrvHlpSTAMRegProfile(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char *pszName, const char *pszDesc)
1932{
1933 PDMDrvHlpSTAMRegProfileEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1934}
1935
1936/**
1937 * Convenience wrapper that registers an advanced profiling sample which is
1938 * always visible.
1939 *
1940 * @param pDrvIns The driver instance.
1941 * @param pProfile Pointer to the profiling variable.
1942 * @param enmUnit The unit.
1943 * @param pszName The name of the sample. This is prefixed with
1944 * "/Drivers/<drivername>-<instance no>/".
1945 * @param pszDesc The description.
1946 */
1947DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdvEx(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
1948{
1949 pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1950 "/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1951}
1952
1953/**
1954 * Convenience wrapper that registers an advanced profiling sample which is
1955 * always visible.
1956 *
1957 * @param pDrvIns The driver instance.
1958 * @param pProfile Pointer to the profiling variable.
1959 * @param pszName The name of the sample. This is prefixed with
1960 * "/Drivers/<drivername>-<instance no>/".
1961 * @param pszDesc The description.
1962 */
1963DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdv(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char *pszName, const char *pszDesc)
1964{
1965 PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1966}
1967
1968/**
1969 * @copydoc PDMDRVHLPR3::pfnSTAMDeregister
1970 */
1971DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1972{
1973 return pDrvIns->pHlpR3->pfnSTAMDeregister(pDrvIns, pvSample);
1974}
1975
1976/**
1977 * @copydoc PDMDRVHLPR3::pfnSTAMDeregisterByPrefix
1978 */
1979DECLINLINE(int) PDMDrvHlpSTAMDeregisterByPrefix(PPDMDRVINS pDrvIns, const char *pszPrefix)
1980{
1981 return pDrvIns->pHlpR3->pfnSTAMDeregisterByPrefix(pDrvIns, pszPrefix);
1982}
1983
1984/**
1985 * @copydoc PDMDRVHLPR3::pfnSUPCallVMMR0Ex
1986 */
1987DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1988{
1989 return pDrvIns->pHlpR3->pfnSUPCallVMMR0Ex(pDrvIns, uOperation, pvArg, cbArg);
1990}
1991
1992/**
1993 * @copydoc PDMDRVHLPR3::pfnUSBRegisterHub
1994 */
1995DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1996{
1997 return pDrvIns->pHlpR3->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1998}
1999
2000/**
2001 * @copydoc PDMDRVHLPR3::pfnSetAsyncNotification
2002 */
2003DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
2004{
2005 return pDrvIns->pHlpR3->pfnSetAsyncNotification(pDrvIns, pfnAsyncNotify);
2006}
2007
2008/**
2009 * @copydoc PDMDRVHLPR3::pfnAsyncNotificationCompleted
2010 */
2011DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
2012{
2013 pDrvIns->pHlpR3->pfnAsyncNotificationCompleted(pDrvIns);
2014}
2015
2016/**
2017 * @copydoc PDMDRVHLPR3::pfnThreadCreate
2018 */
2019DECLINLINE(int) PDMDrvHlpThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
2020 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
2021{
2022 return pDrvIns->pHlpR3->pfnThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
2023}
2024
2025/**
2026 * @copydoc PDMR3ThreadDestroy
2027 * @param pDrvIns The driver instance.
2028 */
2029DECLINLINE(int) PDMDrvHlpThreadDestroy(PPDMDRVINS pDrvIns, PPDMTHREAD pThread, int *pRcThread)
2030{
2031 return pDrvIns->pHlpR3->pfnThreadDestroy(pThread, pRcThread);
2032}
2033
2034/**
2035 * @copydoc PDMR3ThreadIAmSuspending
2036 * @param pDrvIns The driver instance.
2037 */
2038DECLINLINE(int) PDMDrvHlpThreadIAmSuspending(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2039{
2040 return pDrvIns->pHlpR3->pfnThreadIAmSuspending(pThread);
2041}
2042
2043/**
2044 * @copydoc PDMR3ThreadIAmRunning
2045 * @param pDrvIns The driver instance.
2046 */
2047DECLINLINE(int) PDMDrvHlpThreadIAmRunning(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2048{
2049 return pDrvIns->pHlpR3->pfnThreadIAmRunning(pThread);
2050}
2051
2052/**
2053 * @copydoc PDMR3ThreadSleep
2054 * @param pDrvIns The driver instance.
2055 */
2056DECLINLINE(int) PDMDrvHlpThreadSleep(PPDMDRVINS pDrvIns, PPDMTHREAD pThread, RTMSINTERVAL cMillies)
2057{
2058 return pDrvIns->pHlpR3->pfnThreadSleep(pThread, cMillies);
2059}
2060
2061/**
2062 * @copydoc PDMR3ThreadSuspend
2063 * @param pDrvIns The driver instance.
2064 */
2065DECLINLINE(int) PDMDrvHlpThreadSuspend(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2066{
2067 return pDrvIns->pHlpR3->pfnThreadSuspend(pThread);
2068}
2069
2070/**
2071 * @copydoc PDMR3ThreadResume
2072 * @param pDrvIns The driver instance.
2073 */
2074DECLINLINE(int) PDMDrvHlpThreadResume(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2075{
2076 return pDrvIns->pHlpR3->pfnThreadResume(pThread);
2077}
2078
2079# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
2080/**
2081 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateCreate
2082 */
2083DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
2084 PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser, const char *pszDesc)
2085{
2086 return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
2087}
2088
2089/**
2090 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateDestroy
2091 */
2092DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateDestroy(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONTEMPLATE pTemplate)
2093{
2094 return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateDestroy(pTemplate);
2095}
2096
2097/**
2098 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpCreateForFile
2099 */
2100DECLINLINE(int) PDMDrvHlpAsyncCompletionEpCreateForFile(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONENDPOINT ppEndpoint,
2101 const char *pszFilename, uint32_t fFlags,
2102 PPDMASYNCCOMPLETIONTEMPLATE pTemplate)
2103{
2104 return pDrvIns->pHlpR3->pfnAsyncCompletionEpCreateForFile(ppEndpoint, pszFilename, fFlags, pTemplate);
2105}
2106
2107/**
2108 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpClose
2109 */
2110DECLINLINE(void) PDMDrvHlpAsyncCompletionEpClose(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint)
2111{
2112 pDrvIns->pHlpR3->pfnAsyncCompletionEpClose(pEndpoint);
2113}
2114
2115/**
2116 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpGetSize
2117 */
2118DECLINLINE(int) PDMDrvHlpAsyncCompletionEpGetSize(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t *pcbSize)
2119{
2120 return pDrvIns->pHlpR3->pfnAsyncCompletionEpGetSize(pEndpoint, pcbSize);
2121}
2122
2123/**
2124 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpSetSize
2125 */
2126DECLINLINE(int) PDMDrvHlpAsyncCompletionEpSetSize(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t cbSize)
2127{
2128 return pDrvIns->pHlpR3->pfnAsyncCompletionEpSetSize(pEndpoint, cbSize);
2129}
2130
2131/**
2132 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpSetBwMgr
2133 */
2134DECLINLINE(int) PDMDrvHlpAsyncCompletionEpSetBwMgr(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, const char *pszBwMgr)
2135{
2136 return pDrvIns->pHlpR3->pfnAsyncCompletionEpSetBwMgr(pEndpoint, pszBwMgr);
2137}
2138
2139/**
2140 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpFlush
2141 */
2142DECLINLINE(int) PDMDrvHlpAsyncCompletionEpFlush(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, void *pvUser,
2143 PPPDMASYNCCOMPLETIONTASK ppTask)
2144{
2145 return pDrvIns->pHlpR3->pfnAsyncCompletionEpFlush(pEndpoint, pvUser, ppTask);
2146}
2147
2148/**
2149 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpRead
2150 */
2151DECLINLINE(int) PDMDrvHlpAsyncCompletionEpRead(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
2152 PCRTSGSEG paSegments, unsigned cSegments,
2153 size_t cbRead, void *pvUser,
2154 PPPDMASYNCCOMPLETIONTASK ppTask)
2155{
2156 return pDrvIns->pHlpR3->pfnAsyncCompletionEpRead(pEndpoint, off, paSegments, cSegments, cbRead, pvUser, ppTask);
2157}
2158
2159/**
2160 * @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpWrite
2161 */
2162DECLINLINE(int) PDMDrvHlpAsyncCompletionEpWrite(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
2163 PCRTSGSEG paSegments, unsigned cSegments,
2164 size_t cbWrite, void *pvUser,
2165 PPPDMASYNCCOMPLETIONTASK ppTask)
2166{
2167 return pDrvIns->pHlpR3->pfnAsyncCompletionEpWrite(pEndpoint, off, paSegments, cSegments, cbWrite, pvUser, ppTask);
2168}
2169# endif
2170
2171#endif /* IN_RING3 */
2172
2173#ifdef VBOX_WITH_NETSHAPER
2174# ifdef IN_RING3
2175
2176/**
2177 * @copydoc PDMDRVHLPR3::pfnNetShaperAttach
2178 */
2179DECLINLINE(int) PDMDrvHlpNetShaperAttach(PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter)
2180{
2181 return pDrvIns->pHlpR3->pfnNetShaperAttach(pDrvIns, pcszBwGroup, pFilter);
2182}
2183
2184/**
2185 * @copydoc PDMDRVHLPR3::pfnNetShaperDetach
2186 */
2187DECLINLINE(int) PDMDrvHlpNetShaperDetach(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
2188{
2189 return pDrvIns->pHlpR3->pfnNetShaperDetach(pDrvIns, pFilter);
2190}
2191
2192# endif /* IN_RING3 */
2193
2194/**
2195 * @copydoc PDMDRVHLPR3::pfnNetShaperAllocateBandwidth
2196 */
2197DECLINLINE(bool) PDMDrvHlpNetShaperAllocateBandwidth(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer)
2198{
2199 return pDrvIns->CTX_SUFF(pHlp)->pfnNetShaperAllocateBandwidth(pDrvIns, pFilter, cbTransfer);
2200}
2201
2202#endif /* VBOX_WITH_NETSHAPER*/
2203
2204#ifdef IN_RING3
2205/**
2206 * @copydoc PDMDRVHLPR3::pfnCritSectInit
2207 */
2208DECLINLINE(int) PDMDrvHlpCritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName)
2209{
2210 return pDrvIns->pHlpR3->pfnCritSectInit(pDrvIns, pCritSect, RT_SRC_POS_ARGS, pszName);
2211}
2212#endif /* IN_RING3 */
2213
2214/**
2215 * @see PDMCritSectEnter
2216 */
2217DECLINLINE(int) PDMDrvHlpCritSectEnter(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy)
2218{
2219 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectEnter(pDrvIns, pCritSect, rcBusy);
2220}
2221
2222/**
2223 * @see PDMCritSectEnterDebug
2224 */
2225DECLINLINE(int) PDMDrvHlpCritSectEnterDebug(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL)
2226{
2227 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectEnterDebug(pDrvIns, pCritSect, rcBusy, uId, RT_SRC_POS_ARGS);
2228}
2229
2230/**
2231 * @see PDMCritSectTryEnter
2232 */
2233DECLINLINE(int) PDMDrvHlpCritSectTryEnter(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
2234{
2235 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectTryEnter(pDrvIns, pCritSect);
2236}
2237
2238/**
2239 * @see PDMCritSectTryEnterDebug
2240 */
2241DECLINLINE(int) PDMDrvHlpCritSectTryEnterDebug(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL)
2242{
2243 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectTryEnterDebug(pDrvIns, pCritSect, uId, RT_SRC_POS_ARGS);
2244}
2245
2246/**
2247 * @see PDMCritSectLeave
2248 */
2249DECLINLINE(int) PDMDrvHlpCritSectLeave(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
2250{
2251 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectLeave(pDrvIns, pCritSect);
2252}
2253
2254/**
2255 * @see PDMCritSectIsOwner
2256 */
2257DECLINLINE(bool) PDMDrvHlpCritSectIsOwner(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2258{
2259 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectIsOwner(pDrvIns, pCritSect);
2260}
2261
2262/**
2263 * @see PDMCritSectIsInitialized
2264 */
2265DECLINLINE(bool) PDMDrvHlpCritSectIsInitialized(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2266{
2267 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectIsInitialized(pDrvIns, pCritSect);
2268}
2269
2270/**
2271 * @see PDMCritSectHasWaiters
2272 */
2273DECLINLINE(bool) PDMDrvHlpCritSectHasWaiters(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2274{
2275 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectHasWaiters(pDrvIns, pCritSect);
2276}
2277
2278/**
2279 * @see PDMCritSectGetRecursion
2280 */
2281DECLINLINE(uint32_t) PDMDrvHlpCritSectGetRecursion(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2282{
2283 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectGetRecursion(pDrvIns, pCritSect);
2284}
2285
2286#if defined(IN_RING3) || defined(IN_RING0)
2287/**
2288 * @see PDMHCCritSectScheduleExitEvent
2289 */
2290DECLINLINE(int) PDMDrvHlpCritSectScheduleExitEvent(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal)
2291{
2292 return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectScheduleExitEvent(pDrvIns, pCritSect, hEventToSignal);
2293}
2294#endif
2295
2296/* Strict build: Remap the two enter calls to the debug versions. */
2297#ifdef VBOX_STRICT
2298# ifdef IPRT_INCLUDED_asm_h
2299# define PDMDrvHlpCritSectEnter(pDrvIns, pCritSect, rcBusy) PDMDrvHlpCritSectEnterDebug((pDrvIns), (pCritSect), (rcBusy), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
2300# define PDMDrvHlpCritSectTryEnter(pDrvIns, pCritSect) PDMDrvHlpCritSectTryEnterDebug((pDrvIns), (pCritSect), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
2301# else
2302# define PDMDrvHlpCritSectEnter(pDrvIns, pCritSect, rcBusy) PDMDrvHlpCritSectEnterDebug((pDrvIns), (pCritSect), (rcBusy), 0, RT_SRC_POS)
2303# define PDMDrvHlpCritSectTryEnter(pDrvIns, pCritSect) PDMDrvHlpCritSectTryEnterDebug((pDrvIns), (pCritSect), 0, RT_SRC_POS)
2304# endif
2305#endif
2306
2307#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
2308
2309/**
2310 * @see PDMR3CritSectDelete
2311 */
2312DECLINLINE(int) PDMDrvHlpCritSectDelete(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
2313{
2314 return pDrvIns->pHlpR3->pfnCritSectDelete(pDrvIns, pCritSect);
2315}
2316
2317/**
2318 * @copydoc PDMDRVHLPR3::pfnCallR0
2319 */
2320DECLINLINE(int) PDMDrvHlpCallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
2321{
2322 return pDrvIns->pHlpR3->pfnCallR0(pDrvIns, uOperation, u64Arg);
2323}
2324
2325/**
2326 * @copydoc PDMDRVHLPR3::pfnBlkCacheRetain
2327 */
2328DECLINLINE(int) PDMDrvHlpBlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
2329 PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
2330 PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
2331 PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
2332 const char *pcszId)
2333{
2334 return pDrvIns->pHlpR3->pfnBlkCacheRetain(pDrvIns, ppBlkCache, pfnXferComplete, pfnXferEnqueue, pfnXferEnqueueDiscard, pcszId);
2335}
2336
2337/**
2338 * @copydoc PDMDRVHLPR3::pfnBlkCacheRelease
2339 */
2340DECLINLINE(void) PDMDrvHlpBlkCacheRelease(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2341{
2342 pDrvIns->pHlpR3->pfnBlkCacheRelease(pBlkCache);
2343}
2344
2345/**
2346 * @copydoc PDMDRVHLPR3::pfnBlkCacheClear
2347 */
2348DECLINLINE(int) PDMDrvHlpBlkCacheClear(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2349{
2350 return pDrvIns->pHlpR3->pfnBlkCacheClear(pBlkCache);
2351}
2352
2353/**
2354 * @copydoc PDMDRVHLPR3::pfnBlkCacheSuspend
2355 */
2356DECLINLINE(int) PDMDrvHlpBlkCacheSuspend(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2357{
2358 return pDrvIns->pHlpR3->pfnBlkCacheSuspend(pBlkCache);
2359}
2360
2361/**
2362 * @copydoc PDMDRVHLPR3::pfnBlkCacheResume
2363 */
2364DECLINLINE(int) PDMDrvHlpBlkCacheResume(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2365{
2366 return pDrvIns->pHlpR3->pfnBlkCacheResume(pBlkCache);
2367}
2368
2369/**
2370 * @copydoc PDMDRVHLPR3::pfnBlkCacheIoXferComplete
2371 */
2372DECLINLINE(void) PDMDrvHlpBlkCacheIoXferComplete(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache,
2373 PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer)
2374{
2375 pDrvIns->pHlpR3->pfnBlkCacheIoXferComplete(pBlkCache, hIoXfer, rcIoXfer);
2376}
2377
2378/**
2379 * @copydoc PDMDRVHLPR3::pfnBlkCacheRead
2380 */
2381DECLINLINE(int) PDMDrvHlpBlkCacheRead(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, uint64_t off,
2382 PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser)
2383{
2384 return pDrvIns->pHlpR3->pfnBlkCacheRead(pBlkCache, off, pSgBuf, cbRead, pvUser);
2385}
2386
2387/**
2388 * @copydoc PDMDRVHLPR3::pfnBlkCacheWrite
2389 */
2390DECLINLINE(int) PDMDrvHlpBlkCacheWrite(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, uint64_t off,
2391 PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser)
2392{
2393 return pDrvIns->pHlpR3->pfnBlkCacheWrite(pBlkCache, off, pSgBuf, cbRead, pvUser);
2394}
2395
2396/**
2397 * @copydoc PDMDRVHLPR3::pfnBlkCacheFlush
2398 */
2399DECLINLINE(int) PDMDrvHlpBlkCacheFlush(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, void *pvUser)
2400{
2401 return pDrvIns->pHlpR3->pfnBlkCacheFlush(pBlkCache, pvUser);
2402}
2403
2404/**
2405 * @copydoc PDMDRVHLPR3::pfnBlkCacheDiscard
2406 */
2407DECLINLINE(int) PDMDrvHlpBlkCacheDiscard(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, PCRTRANGE paRanges,
2408 unsigned cRanges, void *pvUser)
2409{
2410 return pDrvIns->pHlpR3->pfnBlkCacheDiscard(pBlkCache, paRanges, cRanges, pvUser);
2411}
2412
2413/**
2414 * @copydoc PDMDRVHLPR3::pfnVMGetSuspendReason
2415 */
2416DECLINLINE(VMSUSPENDREASON) PDMDrvHlpVMGetSuspendReason(PPDMDRVINS pDrvIns)
2417{
2418 return pDrvIns->pHlpR3->pfnVMGetSuspendReason(pDrvIns);
2419}
2420
2421/**
2422 * @copydoc PDMDRVHLPR3::pfnVMGetResumeReason
2423 */
2424DECLINLINE(VMRESUMEREASON) PDMDrvHlpVMGetResumeReason(PPDMDRVINS pDrvIns)
2425{
2426 return pDrvIns->pHlpR3->pfnVMGetResumeReason(pDrvIns);
2427}
2428
2429/**
2430 * @copydoc PDMDRVHLPR3::pfnQueryGenericUserObject
2431 */
2432DECLINLINE(void *) PDMDrvHlpQueryGenericUserObject(PPDMDRVINS pDrvIns, PCRTUUID pUuid)
2433{
2434 return pDrvIns->pHlpR3->pfnQueryGenericUserObject(pDrvIns, pUuid);
2435}
2436
2437
2438/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
2439typedef struct PDMDRVREGCB *PPDMDRVREGCB;
2440/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
2441typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
2442
2443/**
2444 * Callbacks for VBoxDriverRegister().
2445 */
2446typedef struct PDMDRVREGCB
2447{
2448 /** Interface version.
2449 * This is set to PDM_DRVREG_CB_VERSION. */
2450 uint32_t u32Version;
2451
2452 /**
2453 * Registers a driver with the current VM instance.
2454 *
2455 * @returns VBox status code.
2456 * @param pCallbacks Pointer to the callback table.
2457 * @param pReg Pointer to the driver registration record.
2458 * This data must be permanent and readonly.
2459 */
2460 DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg));
2461} PDMDRVREGCB;
2462
2463/** Current version of the PDMDRVREGCB structure. */
2464#define PDM_DRVREG_CB_VERSION PDM_VERSION_MAKE(0xf0fa, 1, 0)
2465
2466
2467/**
2468 * The VBoxDriverRegister callback function.
2469 *
2470 * PDM will invoke this function after loading a driver module and letting
2471 * the module decide which drivers to register and how to handle conflicts.
2472 *
2473 * @returns VBox status code.
2474 * @param pCallbacks Pointer to the callback table.
2475 * @param u32Version VBox version number.
2476 */
2477typedef DECLCALLBACKTYPE(int, FNPDMVBOXDRIVERSREGISTER,(PCPDMDRVREGCB pCallbacks, uint32_t u32Version));
2478
2479VMMR3DECL(int) PDMR3DrvStaticRegistration(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
2480
2481#endif /* IN_RING3 */
2482
2483/** @} */
2484
2485RT_C_DECLS_END
2486
2487#endif /* !VBOX_INCLUDED_vmm_pdmdrv_h */
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette