pdmdrv.h@ 92070

Last change on this file since 92070 was 91972, checked in by vboxsync, 3 years ago
VMM,Devices: Eliminate direct calls to PDMR3AsyncCompletion* and PDMR3BlkCache* and use the device helper callbacks, bugref:10074 [build fix]
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 106.0 KB

Line
1	/** @file
2	* PDM - Pluggable Device Manager, Drivers.
3	*/
4
5	/*
6	* Copyright (C) 2006-2020 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
50	RT_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. */
58	typedef R3PTRTYPE(struct PDMDRVHLPR3 const *) PCPDMDRVHLPR3;
59	/** Pointer const PDM Driver API, ring-0. */
60	typedef R0PTRTYPE(struct PDMDRVHLPR0 const *) PCPDMDRVHLPR0;
61	/** Pointer const PDM Driver API, raw-mode context. */
62	typedef 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	*/
77	typedef DECLCALLBACKTYPE(int, FNPDMDRVCONSTRUCT,(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags));
78	/** Pointer to a FNPDMDRVCONSTRUCT() function. */
79	typedef 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	*/
89	typedef DECLCALLBACKTYPE(void, FNPDMDRVDESTRUCT,(PPDMDRVINS pDrvIns));
90	/** Pointer to a FNPDMDRVDESTRUCT() function. */
91	typedef 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	*/
109	typedef DECLCALLBACKTYPE(void, FNPDMDRVRELOCATE,(PPDMDRVINS pDrvIns, RTGCINTPTR offDelta));
110	/** Pointer to a FNPDMDRVRELOCATE() function. */
111	typedef 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	*/
129	typedef 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. */
133	typedef FNPDMDRVIOCTL *PFNPDMDRVIOCTL;
134
135	/**
136	* Power On notification.
137	*
138	* @param pDrvIns The driver instance data.
139	*/
140	typedef DECLCALLBACKTYPE(void, FNPDMDRVPOWERON,(PPDMDRVINS pDrvIns));
141	/** Pointer to a FNPDMDRVPOWERON() function. */
142	typedef FNPDMDRVPOWERON *PFNPDMDRVPOWERON;
143
144	/**
145	* Reset notification.
146	*
147	* @returns VBox status.
148	* @param pDrvIns The driver instance data.
149	*/
150	typedef DECLCALLBACKTYPE(void, FNPDMDRVRESET,(PPDMDRVINS pDrvIns));
151	/** Pointer to a FNPDMDRVRESET() function. */
152	typedef FNPDMDRVRESET *PFNPDMDRVRESET;
153
154	/**
155	* Suspend notification.
156	*
157	* @returns VBox status.
158	* @param pDrvIns The driver instance data.
159	*/
160	typedef DECLCALLBACKTYPE(void, FNPDMDRVSUSPEND,(PPDMDRVINS pDrvIns));
161	/** Pointer to a FNPDMDRVSUSPEND() function. */
162	typedef FNPDMDRVSUSPEND *PFNPDMDRVSUSPEND;
163
164	/**
165	* Resume notification.
166	*
167	* @returns VBox status.
168	* @param pDrvIns The driver instance data.
169	*/
170	typedef DECLCALLBACKTYPE(void, FNPDMDRVRESUME,(PPDMDRVINS pDrvIns));
171	/** Pointer to a FNPDMDRVRESUME() function. */
172	typedef 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	*/
183	typedef DECLCALLBACKTYPE(void, FNPDMDRVPOWEROFF,(PPDMDRVINS pDrvIns));
184	/** Pointer to a FNPDMDRVPOWEROFF() function. */
185	typedef 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	*/
200	typedef DECLCALLBACKTYPE(int, FNPDMDRVATTACH,(PPDMDRVINS pDrvIns, uint32_t fFlags));
201	/** Pointer to a FNPDMDRVATTACH() function. */
202	typedef 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	*/
215	typedef DECLCALLBACKTYPE(void, FNPDMDRVDETACH,(PPDMDRVINS pDrvIns, uint32_t fFlags));
216	/** Pointer to a FNPDMDRVDETACH() function. */
217	typedef 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	*/
227	typedef 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. */
280	typedef PDMDRVREG *PPDMDRVREG;
281	/** Const pointer to a PDM Driver Structure. */
282	typedef 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	*/
352	typedef 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	*/
500	typedef 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. */
536	typedef 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	*/
546	typedef 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. */
555	typedef PDMUSBHUBHLP *PPDMUSBHUBHLP;
556	/** Pointer to const PCI helpers. */
557	typedef const PDMUSBHUBHLP *PCPDMUSBHUBHLP;
558	/** Pointer to const PCI helpers pointer. */
559	typedef 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	*/
568	typedef 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	*/
630	typedef 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	*/
695	typedef 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(void, 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	* Register a save state data unit.
887	*
888	* @returns VBox status.
889	* @param pDrvIns Driver instance.
890	* @param uVersion Data layout version number.
891	* @param cbGuess The approximate amount of data in the unit.
892	* Only for progress indicators.
893	*
894	* @param pfnLivePrep Prepare live save callback, optional.
895	* @param pfnLiveExec Execute live save callback, optional.
896	* @param pfnLiveVote Vote live save callback, optional.
897	*
898	* @param pfnSavePrep Prepare save callback, optional.
899	* @param pfnSaveExec Execute save callback, optional.
900	* @param pfnSaveDone Done save callback, optional.
901	*
902	* @param pfnLoadPrep Prepare load callback, optional.
903	* @param pfnLoadExec Execute load callback, optional.
904	* @param pfnLoadDone Done load callback, optional.
905	*/
906	DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
907	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
908	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
909	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
910
911	/**
912	* Deregister a save state data unit.
913	*
914	* @returns VBox status.
915	* @param pDrvIns Driver instance.
916	* @param pszName Data unit name.
917	* @param uInstance The instance identifier of the data unit.
918	* This must together with the name be unique.
919	*/
920	DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance));
921
922	/** @name Exported SSM Functions
923	* @{ */
924	DECLR3CALLBACKMEMBER(int, pfnSSMPutStruct,(PSSMHANDLE pSSM, const void *pvStruct, PCSSMFIELD paFields));
925	DECLR3CALLBACKMEMBER(int, pfnSSMPutStructEx,(PSSMHANDLE pSSM, const void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser));
926	DECLR3CALLBACKMEMBER(int, pfnSSMPutBool,(PSSMHANDLE pSSM, bool fBool));
927	DECLR3CALLBACKMEMBER(int, pfnSSMPutU8,(PSSMHANDLE pSSM, uint8_t u8));
928	DECLR3CALLBACKMEMBER(int, pfnSSMPutS8,(PSSMHANDLE pSSM, int8_t i8));
929	DECLR3CALLBACKMEMBER(int, pfnSSMPutU16,(PSSMHANDLE pSSM, uint16_t u16));
930	DECLR3CALLBACKMEMBER(int, pfnSSMPutS16,(PSSMHANDLE pSSM, int16_t i16));
931	DECLR3CALLBACKMEMBER(int, pfnSSMPutU32,(PSSMHANDLE pSSM, uint32_t u32));
932	DECLR3CALLBACKMEMBER(int, pfnSSMPutS32,(PSSMHANDLE pSSM, int32_t i32));
933	DECLR3CALLBACKMEMBER(int, pfnSSMPutU64,(PSSMHANDLE pSSM, uint64_t u64));
934	DECLR3CALLBACKMEMBER(int, pfnSSMPutS64,(PSSMHANDLE pSSM, int64_t i64));
935	DECLR3CALLBACKMEMBER(int, pfnSSMPutU128,(PSSMHANDLE pSSM, uint128_t u128));
936	DECLR3CALLBACKMEMBER(int, pfnSSMPutS128,(PSSMHANDLE pSSM, int128_t i128));
937	DECLR3CALLBACKMEMBER(int, pfnSSMPutUInt,(PSSMHANDLE pSSM, RTUINT u));
938	DECLR3CALLBACKMEMBER(int, pfnSSMPutSInt,(PSSMHANDLE pSSM, RTINT i));
939	DECLR3CALLBACKMEMBER(int, pfnSSMPutGCUInt,(PSSMHANDLE pSSM, RTGCUINT u));
940	DECLR3CALLBACKMEMBER(int, pfnSSMPutGCUIntReg,(PSSMHANDLE pSSM, RTGCUINTREG u));
941	DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPhys32,(PSSMHANDLE pSSM, RTGCPHYS32 GCPhys));
942	DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPhys64,(PSSMHANDLE pSSM, RTGCPHYS64 GCPhys));
943	DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPhys,(PSSMHANDLE pSSM, RTGCPHYS GCPhys));
944	DECLR3CALLBACKMEMBER(int, pfnSSMPutGCPtr,(PSSMHANDLE pSSM, RTGCPTR GCPtr));
945	DECLR3CALLBACKMEMBER(int, pfnSSMPutGCUIntPtr,(PSSMHANDLE pSSM, RTGCUINTPTR GCPtr));
946	DECLR3CALLBACKMEMBER(int, pfnSSMPutRCPtr,(PSSMHANDLE pSSM, RTRCPTR RCPtr));
947	DECLR3CALLBACKMEMBER(int, pfnSSMPutIOPort,(PSSMHANDLE pSSM, RTIOPORT IOPort));
948	DECLR3CALLBACKMEMBER(int, pfnSSMPutSel,(PSSMHANDLE pSSM, RTSEL Sel));
949	DECLR3CALLBACKMEMBER(int, pfnSSMPutMem,(PSSMHANDLE pSSM, const void *pv, size_t cb));
950	DECLR3CALLBACKMEMBER(int, pfnSSMPutStrZ,(PSSMHANDLE pSSM, const char *psz));
951	DECLR3CALLBACKMEMBER(int, pfnSSMGetStruct,(PSSMHANDLE pSSM, void *pvStruct, PCSSMFIELD paFields));
952	DECLR3CALLBACKMEMBER(int, pfnSSMGetStructEx,(PSSMHANDLE pSSM, void pvStruct, size_t cbStruct, uint32_t fFlags, PCSSMFIELD paFields, void pvUser));
953	DECLR3CALLBACKMEMBER(int, pfnSSMGetBool,(PSSMHANDLE pSSM, bool *pfBool));
954	DECLR3CALLBACKMEMBER(int, pfnSSMGetBoolV,(PSSMHANDLE pSSM, bool volatile *pfBool));
955	DECLR3CALLBACKMEMBER(int, pfnSSMGetU8,(PSSMHANDLE pSSM, uint8_t *pu8));
956	DECLR3CALLBACKMEMBER(int, pfnSSMGetU8V,(PSSMHANDLE pSSM, uint8_t volatile *pu8));
957	DECLR3CALLBACKMEMBER(int, pfnSSMGetS8,(PSSMHANDLE pSSM, int8_t *pi8));
958	DECLR3CALLBACKMEMBER(int, pfnSSMGetS8V,(PSSMHANDLE pSSM, int8_t volatile *pi8));
959	DECLR3CALLBACKMEMBER(int, pfnSSMGetU16,(PSSMHANDLE pSSM, uint16_t *pu16));
960	DECLR3CALLBACKMEMBER(int, pfnSSMGetU16V,(PSSMHANDLE pSSM, uint16_t volatile *pu16));
961	DECLR3CALLBACKMEMBER(int, pfnSSMGetS16,(PSSMHANDLE pSSM, int16_t *pi16));
962	DECLR3CALLBACKMEMBER(int, pfnSSMGetS16V,(PSSMHANDLE pSSM, int16_t volatile *pi16));
963	DECLR3CALLBACKMEMBER(int, pfnSSMGetU32,(PSSMHANDLE pSSM, uint32_t *pu32));
964	DECLR3CALLBACKMEMBER(int, pfnSSMGetU32V,(PSSMHANDLE pSSM, uint32_t volatile *pu32));
965	DECLR3CALLBACKMEMBER(int, pfnSSMGetS32,(PSSMHANDLE pSSM, int32_t *pi32));
966	DECLR3CALLBACKMEMBER(int, pfnSSMGetS32V,(PSSMHANDLE pSSM, int32_t volatile *pi32));
967	DECLR3CALLBACKMEMBER(int, pfnSSMGetU64,(PSSMHANDLE pSSM, uint64_t *pu64));
968	DECLR3CALLBACKMEMBER(int, pfnSSMGetU64V,(PSSMHANDLE pSSM, uint64_t volatile *pu64));
969	DECLR3CALLBACKMEMBER(int, pfnSSMGetS64,(PSSMHANDLE pSSM, int64_t *pi64));
970	DECLR3CALLBACKMEMBER(int, pfnSSMGetS64V,(PSSMHANDLE pSSM, int64_t volatile *pi64));
971	DECLR3CALLBACKMEMBER(int, pfnSSMGetU128,(PSSMHANDLE pSSM, uint128_t *pu128));
972	DECLR3CALLBACKMEMBER(int, pfnSSMGetU128V,(PSSMHANDLE pSSM, uint128_t volatile *pu128));
973	DECLR3CALLBACKMEMBER(int, pfnSSMGetS128,(PSSMHANDLE pSSM, int128_t *pi128));
974	DECLR3CALLBACKMEMBER(int, pfnSSMGetS128V,(PSSMHANDLE pSSM, int128_t volatile *pi128));
975	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys32,(PSSMHANDLE pSSM, PRTGCPHYS32 pGCPhys));
976	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys32V,(PSSMHANDLE pSSM, RTGCPHYS32 volatile *pGCPhys));
977	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys64,(PSSMHANDLE pSSM, PRTGCPHYS64 pGCPhys));
978	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys64V,(PSSMHANDLE pSSM, RTGCPHYS64 volatile *pGCPhys));
979	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhys,(PSSMHANDLE pSSM, PRTGCPHYS pGCPhys));
980	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPhysV,(PSSMHANDLE pSSM, RTGCPHYS volatile *pGCPhys));
981	DECLR3CALLBACKMEMBER(int, pfnSSMGetUInt,(PSSMHANDLE pSSM, PRTUINT pu));
982	DECLR3CALLBACKMEMBER(int, pfnSSMGetSInt,(PSSMHANDLE pSSM, PRTINT pi));
983	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCUInt,(PSSMHANDLE pSSM, PRTGCUINT pu));
984	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCUIntReg,(PSSMHANDLE pSSM, PRTGCUINTREG pu));
985	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCPtr,(PSSMHANDLE pSSM, PRTGCPTR pGCPtr));
986	DECLR3CALLBACKMEMBER(int, pfnSSMGetGCUIntPtr,(PSSMHANDLE pSSM, PRTGCUINTPTR pGCPtr));
987	DECLR3CALLBACKMEMBER(int, pfnSSMGetRCPtr,(PSSMHANDLE pSSM, PRTRCPTR pRCPtr));
988	DECLR3CALLBACKMEMBER(int, pfnSSMGetIOPort,(PSSMHANDLE pSSM, PRTIOPORT pIOPort));
989	DECLR3CALLBACKMEMBER(int, pfnSSMGetSel,(PSSMHANDLE pSSM, PRTSEL pSel));
990	DECLR3CALLBACKMEMBER(int, pfnSSMGetMem,(PSSMHANDLE pSSM, void *pv, size_t cb));
991	DECLR3CALLBACKMEMBER(int, pfnSSMGetStrZ,(PSSMHANDLE pSSM, char *psz, size_t cbMax));
992	DECLR3CALLBACKMEMBER(int, pfnSSMGetStrZEx,(PSSMHANDLE pSSM, char psz, size_t cbMax, size_t pcbStr));
993	DECLR3CALLBACKMEMBER(int, pfnSSMSkip,(PSSMHANDLE pSSM, size_t cb));
994	DECLR3CALLBACKMEMBER(int, pfnSSMSkipToEndOfUnit,(PSSMHANDLE pSSM));
995	DECLR3CALLBACKMEMBER(int, pfnSSMSetLoadError,(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(6, 7));
996	DECLR3CALLBACKMEMBER(int, pfnSSMSetLoadErrorV,(PSSMHANDLE pSSM, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
997	DECLR3CALLBACKMEMBER(int, pfnSSMSetCfgError,(PSSMHANDLE pSSM, RT_SRC_POS_DECL, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(5, 6));
998	DECLR3CALLBACKMEMBER(int, pfnSSMSetCfgErrorV,(PSSMHANDLE pSSM, RT_SRC_POS_DECL, const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(5, 0));
999	DECLR3CALLBACKMEMBER(int, pfnSSMHandleGetStatus,(PSSMHANDLE pSSM));
1000	DECLR3CALLBACKMEMBER(SSMAFTER, pfnSSMHandleGetAfter,(PSSMHANDLE pSSM));
1001	DECLR3CALLBACKMEMBER(bool, pfnSSMHandleIsLiveSave,(PSSMHANDLE pSSM));
1002	DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleMaxDowntime,(PSSMHANDLE pSSM));
1003	DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleHostBits,(PSSMHANDLE pSSM));
1004	DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleRevision,(PSSMHANDLE pSSM));
1005	DECLR3CALLBACKMEMBER(uint32_t, pfnSSMHandleVersion,(PSSMHANDLE pSSM));
1006	DECLR3CALLBACKMEMBER(const char *, pfnSSMHandleHostOSAndArch,(PSSMHANDLE pSSM));
1007	/** @} */
1008
1009	/** @name Exported CFGM Functions.
1010	* @{ */
1011	DECLR3CALLBACKMEMBER(bool, pfnCFGMExists,( PCFGMNODE pNode, const char *pszName));
1012	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryType,( PCFGMNODE pNode, const char *pszName, PCFGMVALUETYPE penmType));
1013	DECLR3CALLBACKMEMBER(int, pfnCFGMQuerySize,( PCFGMNODE pNode, const char pszName, size_t pcb));
1014	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryInteger,( PCFGMNODE pNode, const char pszName, uint64_t pu64));
1015	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryIntegerDef,( PCFGMNODE pNode, const char pszName, uint64_t pu64, uint64_t u64Def));
1016	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryString,( PCFGMNODE pNode, const char pszName, char pszString, size_t cchString));
1017	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryStringDef,( PCFGMNODE pNode, const char pszName, char pszString, size_t cchString, const char *pszDef));
1018	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryBytes,( PCFGMNODE pNode, const char pszName, void pvData, size_t cbData));
1019	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU64,( PCFGMNODE pNode, const char pszName, uint64_t pu64));
1020	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU64Def,( PCFGMNODE pNode, const char pszName, uint64_t pu64, uint64_t u64Def));
1021	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS64,( PCFGMNODE pNode, const char pszName, int64_t pi64));
1022	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS64Def,( PCFGMNODE pNode, const char pszName, int64_t pi64, int64_t i64Def));
1023	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU32,( PCFGMNODE pNode, const char pszName, uint32_t pu32));
1024	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU32Def,( PCFGMNODE pNode, const char pszName, uint32_t pu32, uint32_t u32Def));
1025	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS32,( PCFGMNODE pNode, const char pszName, int32_t pi32));
1026	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS32Def,( PCFGMNODE pNode, const char pszName, int32_t pi32, int32_t i32Def));
1027	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU16,( PCFGMNODE pNode, const char pszName, uint16_t pu16));
1028	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU16Def,( PCFGMNODE pNode, const char pszName, uint16_t pu16, uint16_t u16Def));
1029	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS16,( PCFGMNODE pNode, const char pszName, int16_t pi16));
1030	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS16Def,( PCFGMNODE pNode, const char pszName, int16_t pi16, int16_t i16Def));
1031	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU8,( PCFGMNODE pNode, const char pszName, uint8_t pu8));
1032	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryU8Def,( PCFGMNODE pNode, const char pszName, uint8_t pu8, uint8_t u8Def));
1033	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS8,( PCFGMNODE pNode, const char pszName, int8_t pi8));
1034	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryS8Def,( PCFGMNODE pNode, const char pszName, int8_t pi8, int8_t i8Def));
1035	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryBool,( PCFGMNODE pNode, const char pszName, bool pf));
1036	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryBoolDef,( PCFGMNODE pNode, const char pszName, bool pf, bool fDef));
1037	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPort,( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort));
1038	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPortDef,( PCFGMNODE pNode, const char *pszName, PRTIOPORT pPort, RTIOPORT PortDef));
1039	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryUInt,( PCFGMNODE pNode, const char pszName, unsigned int pu));
1040	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryUIntDef,( PCFGMNODE pNode, const char pszName, unsigned int pu, unsigned int uDef));
1041	DECLR3CALLBACKMEMBER(int, pfnCFGMQuerySInt,( PCFGMNODE pNode, const char pszName, signed int pi));
1042	DECLR3CALLBACKMEMBER(int, pfnCFGMQuerySIntDef,( PCFGMNODE pNode, const char pszName, signed int pi, signed int iDef));
1043	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPtr,( PCFGMNODE pNode, const char pszName, void *ppv));
1044	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryPtrDef,( PCFGMNODE pNode, const char pszName, void ppv, void pvDef));
1045	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtr,( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr));
1046	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrDef,( PCFGMNODE pNode, const char *pszName, PRTGCPTR pGCPtr, RTGCPTR GCPtrDef));
1047	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrU,( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr));
1048	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrUDef,( PCFGMNODE pNode, const char *pszName, PRTGCUINTPTR pGCPtr, RTGCUINTPTR GCPtrDef));
1049	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrS,( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr));
1050	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryGCPtrSDef,( PCFGMNODE pNode, const char *pszName, PRTGCINTPTR pGCPtr, RTGCINTPTR GCPtrDef));
1051	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryStringAlloc,( PCFGMNODE pNode, const char pszName, char *ppszString));
1052	DECLR3CALLBACKMEMBER(int, pfnCFGMQueryStringAllocDef,(PCFGMNODE pNode, const char pszName, char ppszString, const char pszDef));
1053	DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetParent,(PCFGMNODE pNode));
1054	DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetChild,(PCFGMNODE pNode, const char *pszPath));
1055	DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetChildF,(PCFGMNODE pNode, const char *pszPathFormat, ...) RT_IPRT_FORMAT_ATTR(2, 3));
1056	DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetChildFV,(PCFGMNODE pNode, const char *pszPathFormat, va_list Args) RT_IPRT_FORMAT_ATTR(3, 0));
1057	DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetFirstChild,(PCFGMNODE pNode));
1058	DECLR3CALLBACKMEMBER(PCFGMNODE, pfnCFGMGetNextChild,(PCFGMNODE pCur));
1059	DECLR3CALLBACKMEMBER(int, pfnCFGMGetName,(PCFGMNODE pCur, char *pszName, size_t cchName));
1060	DECLR3CALLBACKMEMBER(size_t, pfnCFGMGetNameLen,(PCFGMNODE pCur));
1061	DECLR3CALLBACKMEMBER(bool, pfnCFGMAreChildrenValid,(PCFGMNODE pNode, const char *pszzValid));
1062	DECLR3CALLBACKMEMBER(PCFGMLEAF, pfnCFGMGetFirstValue,(PCFGMNODE pCur));
1063	DECLR3CALLBACKMEMBER(PCFGMLEAF, pfnCFGMGetNextValue,(PCFGMLEAF pCur));
1064	DECLR3CALLBACKMEMBER(int, pfnCFGMGetValueName,(PCFGMLEAF pCur, char *pszName, size_t cchName));
1065	DECLR3CALLBACKMEMBER(size_t, pfnCFGMGetValueNameLen,(PCFGMLEAF pCur));
1066	DECLR3CALLBACKMEMBER(CFGMVALUETYPE, pfnCFGMGetValueType,(PCFGMLEAF pCur));
1067	DECLR3CALLBACKMEMBER(bool, pfnCFGMAreValuesValid,(PCFGMNODE pNode, const char *pszzValid));
1068	DECLR3CALLBACKMEMBER(int, pfnCFGMValidateConfig,(PCFGMNODE pNode, const char *pszNode,
1069	const char pszValidValues, const char pszValidNodes,
1070	const char *pszWho, uint32_t uInstance));
1071	/** @} */
1072
1073	/**
1074	* Free memory allocated with pfnMMHeapAlloc() and pfnMMHeapAllocZ().
1075	*
1076	* @param pDrvIns Driver instance.
1077	* @param pv Pointer to the memory to free.
1078	*/
1079	DECLR3CALLBACKMEMBER(void, pfnMMHeapFree,(PPDMDRVINS pDrvIns, void *pv));
1080
1081	/**
1082	* Register an info handler with DBGF.
1083	*
1084	* @returns VBox status code.
1085	* @param pDrvIns Driver instance.
1086	* @param pszName Data unit name.
1087	* @param pszDesc The description of the info and any arguments
1088	* the handler may take.
1089	* @param pfnHandler The handler function to be called to display the
1090	* info.
1091	*/
1092	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler));
1093
1094	/**
1095	* Register an info handler with DBGF, argv style.
1096	*
1097	* @returns VBox status code.
1098	* @param pDrvIns Driver instance.
1099	* @param pszName Data unit name.
1100	* @param pszDesc The description of the info and any arguments
1101	* the handler may take.
1102	* @param pfnHandler The handler function to be called to display the
1103	* info.
1104	*/
1105	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegisterArgv,(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFINFOARGVDRV pfnHandler));
1106
1107	/**
1108	* Deregister an info handler from DBGF.
1109	*
1110	* @returns VBox status code.
1111	* @param pDrvIns Driver instance.
1112	* @param pszName Data unit name.
1113	*/
1114	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoDeregister,(PPDMDRVINS pDrvIns, const char *pszName));
1115
1116	/**
1117	* Registers a statistics sample if statistics are enabled.
1118	*
1119	* @param pDrvIns Driver instance.
1120	* @param pvSample Pointer to the sample.
1121	* @param enmType Sample type. This indicates what pvSample is pointing at.
1122	* @param pszName Sample name. The name is on this form "/<component>/<sample>".
1123	* Further nesting is possible. If this does not start
1124	* with a '/', the default prefix will be prepended,
1125	* otherwise it will be used as-is.
1126	* @param enmUnit Sample unit.
1127	* @param pszDesc Sample description.
1128	*/
1129	DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName,
1130	STAMUNIT enmUnit, const char *pszDesc));
1131
1132	/**
1133	* Same as pfnSTAMRegister except that the name is specified in a
1134	* RTStrPrintf like fashion.
1135	*
1136	* @param pDrvIns Driver instance.
1137	* @param pvSample Pointer to the sample.
1138	* @param enmType Sample type. This indicates what pvSample is pointing at.
1139	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1140	* @param enmUnit Sample unit.
1141	* @param pszDesc Sample description.
1142	* @param pszName The sample name format string. If this does not start
1143	* with a '/', the default prefix will be prepended,
1144	* otherwise it will be used as-is.
1145	* @param ... Arguments to the format string.
1146	*/
1147	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1148	STAMUNIT enmUnit, const char *pszDesc,
1149	const char *pszName, ...) RT_IPRT_FORMAT_ATTR(7, 8));
1150
1151	/**
1152	* Same as pfnSTAMRegister except that the name is specified in a
1153	* RTStrPrintfV like fashion.
1154	*
1155	* @param pDrvIns Driver instance.
1156	* @param pvSample Pointer to the sample.
1157	* @param enmType Sample type. This indicates what pvSample is pointing at.
1158	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1159	* @param enmUnit Sample unit.
1160	* @param pszDesc Sample description.
1161	* @param pszName The sample name format string. If this does not
1162	* start with a '/', the default prefix will be prepended,
1163	* otherwise it will be used as-is.
1164	* @param args Arguments to the format string.
1165	*/
1166	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1167	STAMUNIT enmUnit, const char *pszDesc,
1168	const char *pszName, va_list args) RT_IPRT_FORMAT_ATTR(7, 0));
1169
1170	/**
1171	* Deregister a statistic item previously registered with pfnSTAMRegister,
1172	* pfnSTAMRegisterF or pfnSTAMRegisterV
1173	*
1174	* @returns VBox status.
1175	* @param pDrvIns Driver instance.
1176	* @param pvSample Pointer to the sample.
1177	*/
1178	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregister,(PPDMDRVINS pDrvIns, void *pvSample));
1179
1180	/**
1181	* Calls the HC R0 VMM entry point, in a safer but slower manner than
1182	* SUPR3CallVMMR0.
1183	*
1184	* When entering using this call the R0 components can call into the host kernel
1185	* (i.e. use the SUPR0 and RT APIs).
1186	*
1187	* See VMMR0Entry() for more details.
1188	*
1189	* @returns error code specific to uFunction.
1190	* @param pDrvIns The driver instance.
1191	* @param uOperation Operation to execute.
1192	* This is limited to services.
1193	* @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
1194	* @param cbArg The size of the argument. This is used to copy whatever the argument
1195	* points at into a kernel buffer to avoid problems like the user page
1196	* being invalidated while we're executing the call.
1197	*/
1198	DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
1199
1200	/**
1201	* Registers a USB HUB.
1202	*
1203	* @returns VBox status code.
1204	* @param pDrvIns The driver instance.
1205	* @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
1206	* @param cPorts The number of ports.
1207	* @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
1208	* @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
1209	*
1210	* @thread EMT.
1211	*/
1212	DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
1213
1214	/**
1215	* Set up asynchronous handling of a suspend, reset or power off notification.
1216	*
1217	* This shall only be called when getting the notification. It must be called
1218	* for each one.
1219	*
1220	* @returns VBox status code.
1221	* @param pDrvIns The driver instance.
1222	* @param pfnAsyncNotify The callback.
1223	* @thread EMT(0)
1224	*/
1225	DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
1226
1227	/**
1228	* Notify EMT(0) that the driver has completed the asynchronous notification
1229	* handling.
1230	*
1231	* This can be called at any time, spurious calls will simply be ignored.
1232	*
1233	* @param pDrvIns The driver instance.
1234	* @thread Any
1235	*/
1236	DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMDRVINS pDrvIns));
1237
1238	/**
1239	* Creates a PDM thread.
1240	*
1241	* This differs from the RTThreadCreate() API in that PDM takes care of suspending,
1242	* resuming, and destroying the thread as the VM state changes.
1243	*
1244	* @returns VBox status code.
1245	* @param pDrvIns The driver instance.
1246	* @param ppThread Where to store the thread 'handle'.
1247	* @param pvUser The user argument to the thread function.
1248	* @param pfnThread The thread function.
1249	* @param pfnWakeup The wakup callback. This is called on the EMT thread when
1250	* a state change is pending.
1251	* @param cbStack See RTThreadCreate.
1252	* @param enmType See RTThreadCreate.
1253	* @param pszName See RTThreadCreate.
1254	*/
1255	DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1256	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
1257
1258	/** @name Exported PDM Thread Functions
1259	* @{ */
1260	DECLR3CALLBACKMEMBER(int, pfnThreadDestroy,(PPDMTHREAD pThread, int *pRcThread));
1261	DECLR3CALLBACKMEMBER(int, pfnThreadIAmSuspending,(PPDMTHREAD pThread));
1262	DECLR3CALLBACKMEMBER(int, pfnThreadIAmRunning,(PPDMTHREAD pThread));
1263	DECLR3CALLBACKMEMBER(int, pfnThreadSleep,(PPDMTHREAD pThread, RTMSINTERVAL cMillies));
1264	DECLR3CALLBACKMEMBER(int, pfnThreadSuspend,(PPDMTHREAD pThread));
1265	DECLR3CALLBACKMEMBER(int, pfnThreadResume,(PPDMTHREAD pThread));
1266	/** @} */
1267
1268	/**
1269	* Creates an async completion template for a driver instance.
1270	*
1271	* The template is used when creating new completion tasks.
1272	*
1273	* @returns VBox status code.
1274	* @param pDrvIns The driver instance.
1275	* @param ppTemplate Where to store the template pointer on success.
1276	* @param pfnCompleted The completion callback routine.
1277	* @param pvTemplateUser Template user argument.
1278	* @param pszDesc Description.
1279	*/
1280	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1281	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1282	const char *pszDesc));
1283
1284	/** @name Exported PDM Async Completion Functions
1285	* @{ */
1286	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateDestroy,(PPDMASYNCCOMPLETIONTEMPLATE pTemplate));
1287	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpCreateForFile,(PPPDMASYNCCOMPLETIONENDPOINT ppEndpoint,
1288	const char *pszFilename, uint32_t fFlags,
1289	PPDMASYNCCOMPLETIONTEMPLATE pTemplate));
1290	DECLR3CALLBACKMEMBER(void, pfnAsyncCompletionEpClose,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint));
1291	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpGetSize,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t *pcbSize));
1292	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpSetSize,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t cbSize));
1293	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpSetBwMgr,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, const char *pszBwMgr));
1294	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpFlush,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, void *pvUser, PPPDMASYNCCOMPLETIONTASK ppTask));
1295	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpRead,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
1296	PCRTSGSEG paSegments, unsigned cSegments,
1297	size_t cbRead, void *pvUser,
1298	PPPDMASYNCCOMPLETIONTASK ppTask));
1299	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionEpWrite,(PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
1300	PCRTSGSEG paSegments, unsigned cSegments,
1301	size_t cbWrite, void *pvUser,
1302	PPPDMASYNCCOMPLETIONTASK ppTask));
1303	/** @} */
1304
1305
1306	/**
1307	* Attaches network filter driver to a bandwidth group.
1308	*
1309	* @returns VBox status code.
1310	* @param pDrvIns The driver instance.
1311	* @param pszBwGroup Name of the bandwidth group to attach to.
1312	* @param pFilter Pointer to the filter we attach.
1313	*/
1314	DECLR3CALLBACKMEMBER(int, pfnNetShaperAttach,(PPDMDRVINS pDrvIns, const char *pszBwGroup, PPDMNSFILTER pFilter));
1315
1316	/**
1317	* Detaches network filter driver to a bandwidth group.
1318	*
1319	* @returns VBox status code.
1320	* @param pDrvIns The driver instance.
1321	* @param pFilter Pointer to the filter we attach.
1322	*/
1323	DECLR3CALLBACKMEMBER(int, pfnNetShaperDetach,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter));
1324
1325	/**
1326	* Obtains bandwidth in a bandwidth group.
1327	*
1328	* @returns True if bandwidth was allocated, false if not.
1329	* @param pDrvIns The driver instance.
1330	* @param pFilter Pointer to the filter that allocates bandwidth.
1331	* @param cbTransfer Number of bytes to allocate.
1332	*/
1333	DECLR3CALLBACKMEMBER(bool, pfnNetShaperAllocateBandwidth,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer));
1334
1335	/**
1336	* Resolves the symbol for a raw-mode context interface.
1337	*
1338	* @returns VBox status code.
1339	* @param pDrvIns The driver instance.
1340	* @param pvInterface The interface structure.
1341	* @param cbInterface The size of the interface structure.
1342	* @param pszSymPrefix What to prefix the symbols in the list with before
1343	* resolving them. This must start with 'drv' and
1344	* contain the driver name.
1345	* @param pszSymList List of symbols corresponding to the interface.
1346	* There is generally a there is generally a define
1347	* holding this list associated with the interface
1348	* definition (INTERFACE_SYM_LIST). For more details
1349	* see PDMR3LdrGetInterfaceSymbols.
1350	* @thread EMT
1351	*/
1352	DECLR3CALLBACKMEMBER(int, pfnLdrGetRCInterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1353	const char pszSymPrefix, const char pszSymList));
1354
1355	/**
1356	* Resolves the symbol for a ring-0 context interface.
1357	*
1358	* @returns VBox status code.
1359	* @param pDrvIns The driver instance.
1360	* @param pvInterface The interface structure.
1361	* @param cbInterface The size of the interface structure.
1362	* @param pszSymPrefix What to prefix the symbols in the list with before
1363	* resolving them. This must start with 'drv' and
1364	* contain the driver name.
1365	* @param pszSymList List of symbols corresponding to the interface.
1366	* There is generally a there is generally a define
1367	* holding this list associated with the interface
1368	* definition (INTERFACE_SYM_LIST). For more details
1369	* see PDMR3LdrGetInterfaceSymbols.
1370	* @thread EMT
1371	*/
1372	DECLR3CALLBACKMEMBER(int, pfnLdrGetR0InterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1373	const char pszSymPrefix, const char pszSymList));
1374	/**
1375	* Initializes a PDM critical section.
1376	*
1377	* The PDM critical sections are derived from the IPRT critical sections, but
1378	* works in both RC and R0 as well as R3.
1379	*
1380	* @returns VBox status code.
1381	* @param pDrvIns The driver instance.
1382	* @param pCritSect Pointer to the critical section.
1383	* @param SRC_POS Use RT_SRC_POS.
1384	* @param pszName The base name of the critical section. Will be
1385	* mangeled with the instance number. For
1386	* statistics and lock validation.
1387	* @thread EMT
1388	*/
1389	DECLR3CALLBACKMEMBER(int, pfnCritSectInit,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName));
1390
1391	/** @name Exported PDM Critical Section Functions
1392	* @{ */
1393	DECLR3CALLBACKMEMBER(bool, pfnCritSectYield,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1394	DECLR3CALLBACKMEMBER(int, pfnCritSectEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy));
1395	DECLR3CALLBACKMEMBER(int, pfnCritSectEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL));
1396	DECLR3CALLBACKMEMBER(int, pfnCritSectTryEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1397	DECLR3CALLBACKMEMBER(int, pfnCritSectTryEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL));
1398	DECLR3CALLBACKMEMBER(int, pfnCritSectLeave,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1399	DECLR3CALLBACKMEMBER(bool, pfnCritSectIsOwner,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1400	DECLR3CALLBACKMEMBER(bool, pfnCritSectIsInitialized,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1401	DECLR3CALLBACKMEMBER(bool, pfnCritSectHasWaiters,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1402	DECLR3CALLBACKMEMBER(uint32_t, pfnCritSectGetRecursion,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1403	DECLR3CALLBACKMEMBER(int, pfnCritSectScheduleExitEvent,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal));
1404	DECLR3CALLBACKMEMBER(int, pfnCritSectDelete,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1405	/** @} */
1406
1407	/**
1408	* Call the ring-0 request handler routine of the driver.
1409	*
1410	* For this to work, the driver must be ring-0 enabled and export a request
1411	* handler function. The name of the function must be the driver name in the
1412	* PDMDRVREG struct prefixed with 'drvR0' and suffixed with 'ReqHandler'.
1413	* The driver name will be capitalized. It shall take the exact same
1414	* arguments as this function and be declared using PDMBOTHCBDECL. See
1415	* FNPDMDRVREQHANDLERR0.
1416	*
1417	* @returns VBox status code.
1418	* @retval VERR_SYMBOL_NOT_FOUND if the driver doesn't export the required
1419	* handler function.
1420	* @retval VERR_ACCESS_DENIED if the driver isn't ring-0 capable.
1421	*
1422	* @param pDrvIns The driver instance.
1423	* @param uOperation The operation to perform.
1424	* @param u64Arg 64-bit integer argument.
1425	* @thread Any
1426	*/
1427	DECLR3CALLBACKMEMBER(int, pfnCallR0,(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg));
1428
1429	/**
1430	* Creates a block cache for a driver driver instance.
1431	*
1432	* @returns VBox status code.
1433	* @param pDrvIns The driver instance.
1434	* @param ppBlkCache Where to store the handle to the block cache.
1435	* @param pfnXferComplete The I/O transfer complete callback.
1436	* @param pfnXferEnqueue The I/O request enqueue callback.
1437	* @param pfnXferEnqueueDiscard The discard request enqueue callback.
1438	* @param pcszId Unique ID used to identify the user.
1439	*/
1440	DECLR3CALLBACKMEMBER(int, pfnBlkCacheRetain, (PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1441	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1442	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1443	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1444	const char *pcszId));
1445
1446	/** @name Exported PDM Block Cache Functions
1447	* @{ */
1448	DECLR3CALLBACKMEMBER(void, pfnBlkCacheRelease,(PPDMBLKCACHE pBlkCache));
1449	DECLR3CALLBACKMEMBER(int, pfnBlkCacheClear,(PPDMBLKCACHE pBlkCache));
1450	DECLR3CALLBACKMEMBER(int, pfnBlkCacheSuspend,(PPDMBLKCACHE pBlkCache));
1451	DECLR3CALLBACKMEMBER(int, pfnBlkCacheResume,(PPDMBLKCACHE pBlkCache));
1452	DECLR3CALLBACKMEMBER(void, pfnBlkCacheIoXferComplete,(PPDMBLKCACHE pBlkCache, PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer));
1453	DECLR3CALLBACKMEMBER(int, pfnBlkCacheRead,(PPDMBLKCACHE pBlkCache, uint64_t off, PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser));
1454	DECLR3CALLBACKMEMBER(int, pfnBlkCacheWrite,(PPDMBLKCACHE pBlkCache, uint64_t off, PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser));
1455	DECLR3CALLBACKMEMBER(int, pfnBlkCacheFlush,(PPDMBLKCACHE pBlkCache, void *pvUser));
1456	DECLR3CALLBACKMEMBER(int, pfnBlkCacheDiscard,(PPDMBLKCACHE pBlkCache, PCRTRANGE paRanges, unsigned cRanges, void *pvUser));
1457	/** @} */
1458
1459	/**
1460	* Gets the reason for the most recent VM suspend.
1461	*
1462	* @returns The suspend reason. VMSUSPENDREASON_INVALID is returned if no
1463	* suspend has been made or if the pDrvIns is invalid.
1464	* @param pDrvIns The driver instance.
1465	*/
1466	DECLR3CALLBACKMEMBER(VMSUSPENDREASON, pfnVMGetSuspendReason,(PPDMDRVINS pDrvIns));
1467
1468	/**
1469	* Gets the reason for the most recent VM resume.
1470	*
1471	* @returns The resume reason. VMRESUMEREASON_INVALID is returned if no
1472	* resume has been made or if the pDrvIns is invalid.
1473	* @param pDrvIns The driver instance.
1474	*/
1475	DECLR3CALLBACKMEMBER(VMRESUMEREASON, pfnVMGetResumeReason,(PPDMDRVINS pDrvIns));
1476
1477	/** @name Space reserved for minor interface changes.
1478	* @{ */
1479	DECLR3CALLBACKMEMBER(int, pfnTimerSetMillies,(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext));
1480
1481	/**
1482	* Deregister zero or more samples given their name prefix.
1483	*
1484	* @returns VBox status code.
1485	* @param pDrvIns The driver instance.
1486	* @param pszPrefix The name prefix of the samples to remove. If this does
1487	* not start with a '/', the default prefix will be
1488	* prepended, otherwise it will be used as-is.
1489	*/
1490	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregisterByPrefix,(PPDMDRVINS pDrvIns, const char *pszPrefix));
1491
1492	/**
1493	* Queries a generic object from the VMM user.
1494	*
1495	* @returns Pointer to the object if found, NULL if not.
1496	* @param pDrvIns The driver instance.
1497	* @param pUuid The UUID of what's being queried. The UUIDs and
1498	* the usage conventions are defined by the user.
1499	*/
1500	DECLR3CALLBACKMEMBER(void *, pfnQueryGenericUserObject,(PPDMDRVINS pDrvIns, PCRTUUID pUuid));
1501
1502	DECLR3CALLBACKMEMBER(void, pfnReserved0,(PPDMDRVINS pDrvIns));
1503	DECLR3CALLBACKMEMBER(void, pfnReserved1,(PPDMDRVINS pDrvIns));
1504	DECLR3CALLBACKMEMBER(void, pfnReserved2,(PPDMDRVINS pDrvIns));
1505	DECLR3CALLBACKMEMBER(void, pfnReserved3,(PPDMDRVINS pDrvIns));
1506	DECLR3CALLBACKMEMBER(void, pfnReserved4,(PPDMDRVINS pDrvIns));
1507	DECLR3CALLBACKMEMBER(void, pfnReserved5,(PPDMDRVINS pDrvIns));
1508	DECLR3CALLBACKMEMBER(void, pfnReserved6,(PPDMDRVINS pDrvIns));
1509	DECLR3CALLBACKMEMBER(void, pfnReserved7,(PPDMDRVINS pDrvIns));
1510	DECLR3CALLBACKMEMBER(void, pfnReserved8,(PPDMDRVINS pDrvIns));
1511	/** @} */
1512
1513	/** Just a safety precaution. */
1514	uint32_t u32TheEnd;
1515	} PDMDRVHLPR3;
1516	/** Current DRVHLP version number. */
1517	#define PDM_DRVHLPR3_VERSION PDM_VERSION_MAKE(0xf0fb, 13, 0)
1518
1519
1520	/**
1521	* Set the VM error message
1522	*
1523	* @returns rc.
1524	* @param pDrvIns Driver instance.
1525	* @param rc VBox status code.
1526	* @param SRC_POS Use RT_SRC_POS.
1527	* @param pszFormat Error message format string.
1528	* @param ... Error message arguments.
1529	* @sa PDMDRV_SET_ERROR, PDMDrvHlpVMSetErrorV, VMSetError
1530	*/
1531	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 7) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1532	const char *pszFormat, ...)
1533	{
1534	va_list va;
1535	va_start(va, pszFormat);
1536	pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1537	va_end(va);
1538	return rc;
1539	}
1540
1541	/** @def PDMDRV_SET_ERROR
1542	* Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
1543	*/
1544	#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
1545	PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
1546
1547	/**
1548	* @copydoc PDMDRVHLPR3::pfnVMSetErrorV
1549	*/
1550	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 0) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1551	const char *pszFormat, va_list va)
1552	{
1553	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1554	}
1555
1556
1557	/**
1558	* Set the VM runtime error message
1559	*
1560	* @returns VBox status code.
1561	* @param pDrvIns Driver instance.
1562	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
1563	* @param pszErrorId Error ID string.
1564	* @param pszFormat Error message format string.
1565	* @param ... Error message arguments.
1566	* @sa PDMDRV_SET_RUNTIME_ERROR, PDMDrvHlpVMSetRuntimeErrorV,
1567	* VMSetRuntimeError
1568	*/
1569	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 5) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
1570	const char *pszFormat, ...)
1571	{
1572	va_list va;
1573	int rc;
1574	va_start(va, pszFormat);
1575	rc = pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1576	va_end(va);
1577	return rc;
1578	}
1579
1580	/** @def PDMDRV_SET_RUNTIME_ERROR
1581	* Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
1582	*/
1583	#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFlags, pszErrorId, pszError) \
1584	PDMDrvHlpVMSetRuntimeError(pDrvIns, fFlags, pszErrorId, "%s", pszError)
1585
1586	/**
1587	* @copydoc PDMDRVHLPR3::pfnVMSetRuntimeErrorV
1588	*/
1589	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 0) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags,
1590	const char pszErrorId, const char pszFormat, va_list va)
1591	{
1592	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1593	}
1594
1595	#endif /* IN_RING3 */
1596
1597	/** @def PDMDRV_ASSERT_EMT
1598	* Assert that the current thread is the emulation thread.
1599	*/
1600	#ifdef VBOX_STRICT
1601	# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1602	#else
1603	# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
1604	#endif
1605
1606	/** @def PDMDRV_ASSERT_OTHER
1607	* Assert that the current thread is NOT the emulation thread.
1608	*/
1609	#ifdef VBOX_STRICT
1610	# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1611	#else
1612	# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
1613	#endif
1614
1615
1616	#ifdef IN_RING3
1617
1618	/**
1619	* @copydoc PDMDRVHLPR3::pfnAttach
1620	*/
1621	DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
1622	{
1623	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, fFlags, ppBaseInterface);
1624	}
1625
1626	/**
1627	* Check that there is no driver below the us that we should attach to.
1628	*
1629	* @returns VERR_PDM_NO_ATTACHED_DRIVER if there is no driver.
1630	* @param pDrvIns The driver instance.
1631	*/
1632	DECLINLINE(int) PDMDrvHlpNoAttach(PPDMDRVINS pDrvIns)
1633	{
1634	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, 0, NULL);
1635	}
1636
1637	/**
1638	* @copydoc PDMDRVHLPR3::pfnDetach
1639	*/
1640	DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1641	{
1642	return pDrvIns->pHlpR3->pfnDetach(pDrvIns, fFlags);
1643	}
1644
1645	/**
1646	* @copydoc PDMDRVHLPR3::pfnDetachSelf
1647	*/
1648	DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1649	{
1650	return pDrvIns->pHlpR3->pfnDetachSelf(pDrvIns, fFlags);
1651	}
1652
1653	/**
1654	* @copydoc PDMDRVHLPR3::pfnMountPrepare
1655	*/
1656	DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
1657	{
1658	return pDrvIns->pHlpR3->pfnMountPrepare(pDrvIns, pszFilename, pszCoreDriver);
1659	}
1660
1661	/**
1662	* @copydoc PDMDRVHLPR3::pfnVMState
1663	*/
1664	DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
1665	{
1666	return pDrvIns->CTX_SUFF(pHlp)->pfnVMState(pDrvIns);
1667	}
1668
1669	/**
1670	* @copydoc PDMDRVHLPR3::pfnVMTeleportedAndNotFullyResumedYet
1671	*/
1672	DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1673	{
1674	return pDrvIns->pHlpR3->pfnVMTeleportedAndNotFullyResumedYet(pDrvIns);
1675	}
1676
1677	/**
1678	* @copydoc PDMDRVHLPR3::pfnGetSupDrvSession
1679	*/
1680	DECLINLINE(PSUPDRVSESSION) PDMDrvHlpGetSupDrvSession(PPDMDRVINS pDrvIns)
1681	{
1682	return pDrvIns->pHlpR3->pfnGetSupDrvSession(pDrvIns);
1683	}
1684
1685	/**
1686	* @copydoc PDMDRVHLPR3::pfnQueueCreate
1687	*/
1688	DECLINLINE(int) PDMDrvHlpQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1689	PFNPDMQUEUEDRV pfnCallback, const char pszName, PDMQUEUEHANDLE phQueue)
1690	{
1691	return pDrvIns->pHlpR3->pfnQueueCreate(pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, phQueue);
1692	}
1693
1694	/**
1695	* @copydoc PDMDRVHLPR3::pfnQueueAlloc
1696	*/
1697	DECLINLINE(PPDMQUEUEITEMCORE) PDMDrvHlpQueueAlloc(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue)
1698	{
1699	return pDrvIns->CTX_SUFF(pHlp)->pfnQueueAlloc(pDrvIns, hQueue);
1700	}
1701
1702	/**
1703	* @copydoc PDMDRVHLPR3::pfnQueueInsert
1704	*/
1705	DECLINLINE(void) PDMDrvHlpQueueInsert(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue, PPDMQUEUEITEMCORE pItem)
1706	{
1707	pDrvIns->CTX_SUFF(pHlp)->pfnQueueInsert(pDrvIns, hQueue, pItem);
1708	}
1709
1710	/**
1711	* @copydoc PDMDRVHLPR3::pfnQueueFlushIfNecessary
1712	*/
1713	DECLINLINE(bool) PDMDrvHlpQueueFlushIfNecessary(PPDMDRVINS pDrvIns, PDMQUEUEHANDLE hQueue)
1714	{
1715	return pDrvIns->CTX_SUFF(pHlp)->pfnQueueFlushIfNecessary(pDrvIns, hQueue);
1716	}
1717
1718	/**
1719	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualFreq
1720	*/
1721	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
1722	{
1723	return pDrvIns->pHlpR3->pfnTMGetVirtualFreq(pDrvIns);
1724	}
1725
1726	/**
1727	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualTime
1728	*/
1729	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
1730	{
1731	return pDrvIns->pHlpR3->pfnTMGetVirtualTime(pDrvIns);
1732	}
1733
1734	/**
1735	* @copydoc PDMDRVHLPR3::pfnTimerCreate
1736	*/
1737	DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
1738	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1739
1740	{
1741	return pDrvIns->pHlpR3->pfnTimerCreate(pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, phTimer);
1742	}
1743
1744	/**
1745	* @copydoc PDMDRVHLPR3::pfnTimerSetMillies
1746	*/
1747	DECLINLINE(int) PDMDrvHlpTimerSetMillies(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext)
1748
1749	{
1750	return pDrvIns->pHlpR3->pfnTimerSetMillies(pDrvIns, hTimer, cMilliesToNext);
1751	}
1752
1753	/**
1754	* Register a save state data unit.
1755	*
1756	* @returns VBox status.
1757	* @param pDrvIns Driver instance.
1758	* @param uVersion Data layout version number.
1759	* @param cbGuess The approximate amount of data in the unit.
1760	* Only for progress indicators.
1761	* @param pfnSaveExec Execute save callback, optional.
1762	* @param pfnLoadExec Execute load callback, optional.
1763	*/
1764	DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1765	PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVLOADEXEC pfnLoadExec)
1766	{
1767	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1768	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1769	NULL /pfnSavePrep/, pfnSaveExec, NULL /pfnSaveDone/,
1770	NULL /pfnLoadPrep/, pfnLoadExec, NULL /pfnLoadDone/);
1771	}
1772
1773	/**
1774	* @copydoc PDMDRVHLPR3::pfnSSMRegister
1775	*/
1776	DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1777	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1778	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1779	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1780	{
1781	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1782	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1783	pfnSavePrep, pfnSaveExec, pfnSaveDone,
1784	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1785	}
1786
1787	/**
1788	* Register a load done callback.
1789	*
1790	* @returns VBox status.
1791	* @param pDrvIns Driver instance.
1792	* @param pfnLoadDone Done load callback, optional.
1793	*/
1794	DECLINLINE(int) PDMDrvHlpSSMRegisterLoadDone(PPDMDRVINS pDrvIns, PFNSSMDRVLOADDONE pfnLoadDone)
1795	{
1796	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, 0 /uVersion/, 0 /cbGuess/,
1797	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1798	NULL /pfnSavePrep/, NULL /pfnSaveExec/, NULL /pfnSaveDone/,
1799	NULL /pfnLoadPrep/, NULL /pfnLoadExec/, pfnLoadDone);
1800	}
1801
1802	/**
1803	* @copydoc PDMDRVHLPR3::pfnMMHeapFree
1804	*/
1805	DECLINLINE(void) PDMDrvHlpMMHeapFree(PPDMDRVINS pDrvIns, void *pv)
1806	{
1807	pDrvIns->pHlpR3->pfnMMHeapFree(pDrvIns, pv);
1808	}
1809
1810	/**
1811	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1812	*/
1813	DECLINLINE(int) PDMDrvHlpDBGFInfoRegister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1814	{
1815	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1816	}
1817
1818	/**
1819	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegisterArgv
1820	*/
1821	DECLINLINE(int) PDMDrvHlpDBGFInfoRegisterArgv(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFINFOARGVDRV pfnHandler)
1822	{
1823	return pDrvIns->pHlpR3->pfnDBGFInfoRegisterArgv(pDrvIns, pszName, pszDesc, pfnHandler);
1824	}
1825
1826	/**
1827	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1828	*/
1829	DECLINLINE(int) PDMDrvHlpDBGFInfoDeregister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1830	{
1831	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1832	}
1833
1834	/**
1835	* @copydoc PDMDRVHLPR3::pfnSTAMRegister
1836	*/
1837	DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
1838	{
1839	pDrvIns->pHlpR3->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
1840	}
1841
1842	/**
1843	* @copydoc PDMDRVHLPR3::pfnSTAMRegisterF
1844	*/
1845	DECLINLINE(void) RT_IPRT_FORMAT_ATTR(7, 8) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType,
1846	STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1847	const char pszDesc, const char pszName, ...)
1848	{
1849	va_list va;
1850	va_start(va, pszName);
1851	pDrvIns->pHlpR3->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1852	va_end(va);
1853	}
1854
1855	/**
1856	* Convenience wrapper that registers counter which is always visible.
1857	*
1858	* @param pDrvIns The driver instance.
1859	* @param pCounter Pointer to the counter variable.
1860	* @param pszName The name of the sample. This is prefixed with
1861	* "/Drivers/<drivername>-<instance no>/".
1862	* @param enmUnit The unit.
1863	* @param pszDesc The description.
1864	*/
1865	DECLINLINE(void) PDMDrvHlpSTAMRegCounterEx(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1866	{
1867	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pCounter, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1868	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1869	}
1870
1871	/**
1872	* Convenience wrapper that registers counter which is always visible and has
1873	* the STAMUNIT_COUNT unit.
1874	*
1875	* @param pDrvIns The driver instance.
1876	* @param pCounter Pointer to the counter variable.
1877	* @param pszName The name of the sample. This is prefixed with
1878	* "/Drivers/<drivername>-<instance no>/".
1879	* @param pszDesc The description.
1880	*/
1881	DECLINLINE(void) PDMDrvHlpSTAMRegCounter(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, const char pszDesc)
1882	{
1883	PDMDrvHlpSTAMRegCounterEx(pDrvIns, pCounter, pszName, STAMUNIT_COUNT, pszDesc);
1884	}
1885
1886	/**
1887	* Convenience wrapper that registers profiling sample which is always visible.
1888	*
1889	* @param pDrvIns The driver instance.
1890	* @param pProfile Pointer to the profiling variable.
1891	* @param pszName The name of the sample. This is prefixed with
1892	* "/Drivers/<drivername>-<instance no>/".
1893	* @param enmUnit The unit.
1894	* @param pszDesc The description.
1895	*/
1896	DECLINLINE(void) PDMDrvHlpSTAMRegProfileEx(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1897	{
1898	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1899	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1900	}
1901
1902	/**
1903	* Convenience wrapper that registers profiling sample which is always visible
1904	* hand counts ticks per call (STAMUNIT_TICKS_PER_CALL).
1905	*
1906	* @param pDrvIns The driver instance.
1907	* @param pProfile Pointer to the profiling variable.
1908	* @param pszName The name of the sample. This is prefixed with
1909	* "/Drivers/<drivername>-<instance no>/".
1910	* @param pszDesc The description.
1911	*/
1912	DECLINLINE(void) PDMDrvHlpSTAMRegProfile(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, const char pszDesc)
1913	{
1914	PDMDrvHlpSTAMRegProfileEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1915	}
1916
1917	/**
1918	* Convenience wrapper that registers an advanced profiling sample which is
1919	* always visible.
1920	*
1921	* @param pDrvIns The driver instance.
1922	* @param pProfile Pointer to the profiling variable.
1923	* @param enmUnit The unit.
1924	* @param pszName The name of the sample. This is prefixed with
1925	* "/Drivers/<drivername>-<instance no>/".
1926	* @param pszDesc The description.
1927	*/
1928	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdvEx(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1929	{
1930	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1931	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1932	}
1933
1934	/**
1935	* Convenience wrapper that registers an advanced profiling sample which is
1936	* always visible.
1937	*
1938	* @param pDrvIns The driver instance.
1939	* @param pProfile Pointer to the profiling variable.
1940	* @param pszName The name of the sample. This is prefixed with
1941	* "/Drivers/<drivername>-<instance no>/".
1942	* @param pszDesc The description.
1943	*/
1944	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdv(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, const char pszDesc)
1945	{
1946	PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1947	}
1948
1949	/**
1950	* @copydoc PDMDRVHLPR3::pfnSTAMDeregister
1951	*/
1952	DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1953	{
1954	return pDrvIns->pHlpR3->pfnSTAMDeregister(pDrvIns, pvSample);
1955	}
1956
1957	/**
1958	* @copydoc PDMDRVHLPR3::pfnSTAMDeregisterByPrefix
1959	*/
1960	DECLINLINE(int) PDMDrvHlpSTAMDeregisterByPrefix(PPDMDRVINS pDrvIns, const char *pszPrefix)
1961	{
1962	return pDrvIns->pHlpR3->pfnSTAMDeregisterByPrefix(pDrvIns, pszPrefix);
1963	}
1964
1965	/**
1966	* @copydoc PDMDRVHLPR3::pfnSUPCallVMMR0Ex
1967	*/
1968	DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1969	{
1970	return pDrvIns->pHlpR3->pfnSUPCallVMMR0Ex(pDrvIns, uOperation, pvArg, cbArg);
1971	}
1972
1973	/**
1974	* @copydoc PDMDRVHLPR3::pfnUSBRegisterHub
1975	*/
1976	DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1977	{
1978	return pDrvIns->pHlpR3->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1979	}
1980
1981	/**
1982	* @copydoc PDMDRVHLPR3::pfnSetAsyncNotification
1983	*/
1984	DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1985	{
1986	return pDrvIns->pHlpR3->pfnSetAsyncNotification(pDrvIns, pfnAsyncNotify);
1987	}
1988
1989	/**
1990	* @copydoc PDMDRVHLPR3::pfnAsyncNotificationCompleted
1991	*/
1992	DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1993	{
1994	pDrvIns->pHlpR3->pfnAsyncNotificationCompleted(pDrvIns);
1995	}
1996
1997	/**
1998	* @copydoc PDMDRVHLPR3::pfnThreadCreate
1999	*/
2000	DECLINLINE(int) PDMDrvHlpThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
2001	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
2002	{
2003	return pDrvIns->pHlpR3->pfnThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
2004	}
2005
2006	/**
2007	* @copydoc PDMR3ThreadDestroy
2008	* @param pDrvIns The driver instance.
2009	*/
2010	DECLINLINE(int) PDMDrvHlpThreadDestroy(PPDMDRVINS pDrvIns, PPDMTHREAD pThread, int *pRcThread)
2011	{
2012	return pDrvIns->pHlpR3->pfnThreadDestroy(pThread, pRcThread);
2013	}
2014
2015	/**
2016	* @copydoc PDMR3ThreadIAmSuspending
2017	* @param pDrvIns The driver instance.
2018	*/
2019	DECLINLINE(int) PDMDrvHlpThreadIAmSuspending(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2020	{
2021	return pDrvIns->pHlpR3->pfnThreadIAmSuspending(pThread);
2022	}
2023
2024	/**
2025	* @copydoc PDMR3ThreadIAmRunning
2026	* @param pDrvIns The driver instance.
2027	*/
2028	DECLINLINE(int) PDMDrvHlpThreadIAmRunning(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2029	{
2030	return pDrvIns->pHlpR3->pfnThreadIAmRunning(pThread);
2031	}
2032
2033	/**
2034	* @copydoc PDMR3ThreadSleep
2035	* @param pDrvIns The driver instance.
2036	*/
2037	DECLINLINE(int) PDMDrvHlpThreadSleep(PPDMDRVINS pDrvIns, PPDMTHREAD pThread, RTMSINTERVAL cMillies)
2038	{
2039	return pDrvIns->pHlpR3->pfnThreadSleep(pThread, cMillies);
2040	}
2041
2042	/**
2043	* @copydoc PDMR3ThreadSuspend
2044	* @param pDrvIns The driver instance.
2045	*/
2046	DECLINLINE(int) PDMDrvHlpThreadSuspend(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2047	{
2048	return pDrvIns->pHlpR3->pfnThreadSuspend(pThread);
2049	}
2050
2051	/**
2052	* @copydoc PDMR3ThreadResume
2053	* @param pDrvIns The driver instance.
2054	*/
2055	DECLINLINE(int) PDMDrvHlpThreadResume(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
2056	{
2057	return pDrvIns->pHlpR3->pfnThreadResume(pThread);
2058	}
2059
2060	# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
2061	/**
2062	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateCreate
2063	*/
2064	DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
2065	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void pvTemplateUser, const char pszDesc)
2066	{
2067	return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
2068	}
2069
2070	/**
2071	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateDestroy
2072	*/
2073	DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateDestroy(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONTEMPLATE pTemplate)
2074	{
2075	return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateDestroy(pTemplate);
2076	}
2077
2078	/**
2079	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpCreateForFile
2080	*/
2081	DECLINLINE(int) PDMDrvHlpAsyncCompletionEpCreateForFile(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONENDPOINT ppEndpoint,
2082	const char *pszFilename, uint32_t fFlags,
2083	PPDMASYNCCOMPLETIONTEMPLATE pTemplate)
2084	{
2085	return pDrvIns->pHlpR3->pfnAsyncCompletionEpCreateForFile(ppEndpoint, pszFilename, fFlags, pTemplate);
2086	}
2087
2088	/**
2089	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpClose
2090	*/
2091	DECLINLINE(void) PDMDrvHlpAsyncCompletionEpClose(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint)
2092	{
2093	pDrvIns->pHlpR3->pfnAsyncCompletionEpClose(pEndpoint);
2094	}
2095
2096	/**
2097	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpGetSize
2098	*/
2099	DECLINLINE(int) PDMDrvHlpAsyncCompletionEpGetSize(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t *pcbSize)
2100	{
2101	return pDrvIns->pHlpR3->pfnAsyncCompletionEpGetSize(pEndpoint, pcbSize);
2102	}
2103
2104	/**
2105	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpSetSize
2106	*/
2107	DECLINLINE(int) PDMDrvHlpAsyncCompletionEpSetSize(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, uint64_t cbSize)
2108	{
2109	return pDrvIns->pHlpR3->pfnAsyncCompletionEpSetSize(pEndpoint, cbSize);
2110	}
2111
2112	/**
2113	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpSetBwMgr
2114	*/
2115	DECLINLINE(int) PDMDrvHlpAsyncCompletionEpSetBwMgr(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, const char *pszBwMgr)
2116	{
2117	return pDrvIns->pHlpR3->pfnAsyncCompletionEpSetBwMgr(pEndpoint, pszBwMgr);
2118	}
2119
2120	/**
2121	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpFlush
2122	*/
2123	DECLINLINE(int) PDMDrvHlpAsyncCompletionEpFlush(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, void *pvUser,
2124	PPPDMASYNCCOMPLETIONTASK ppTask)
2125	{
2126	return pDrvIns->pHlpR3->pfnAsyncCompletionEpFlush(pEndpoint, pvUser, ppTask);
2127	}
2128
2129	/**
2130	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpRead
2131	*/
2132	DECLINLINE(int) PDMDrvHlpAsyncCompletionEpRead(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
2133	PCRTSGSEG paSegments, unsigned cSegments,
2134	size_t cbRead, void *pvUser,
2135	PPPDMASYNCCOMPLETIONTASK ppTask)
2136	{
2137	return pDrvIns->pHlpR3->pfnAsyncCompletionEpRead(pEndpoint, off, paSegments, cSegments, cbRead, pvUser, ppTask);
2138	}
2139
2140	/**
2141	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionEpWrite
2142	*/
2143	DECLINLINE(int) PDMDrvHlpAsyncCompletionEpWrite(PPDMDRVINS pDrvIns, PPDMASYNCCOMPLETIONENDPOINT pEndpoint, RTFOFF off,
2144	PCRTSGSEG paSegments, unsigned cSegments,
2145	size_t cbWrite, void *pvUser,
2146	PPPDMASYNCCOMPLETIONTASK ppTask)
2147	{
2148	return pDrvIns->pHlpR3->pfnAsyncCompletionEpWrite(pEndpoint, off, paSegments, cSegments, cbWrite, pvUser, ppTask);
2149	}
2150	# endif
2151
2152	#endif /* IN_RING3 */
2153
2154	#ifdef VBOX_WITH_NETSHAPER
2155	# ifdef IN_RING3
2156
2157	/**
2158	* @copydoc PDMDRVHLPR3::pfnNetShaperAttach
2159	*/
2160	DECLINLINE(int) PDMDrvHlpNetShaperAttach(PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter)
2161	{
2162	return pDrvIns->pHlpR3->pfnNetShaperAttach(pDrvIns, pcszBwGroup, pFilter);
2163	}
2164
2165	/**
2166	* @copydoc PDMDRVHLPR3::pfnNetShaperDetach
2167	*/
2168	DECLINLINE(int) PDMDrvHlpNetShaperDetach(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
2169	{
2170	return pDrvIns->pHlpR3->pfnNetShaperDetach(pDrvIns, pFilter);
2171	}
2172
2173	# endif /* IN_RING3 */
2174
2175	/**
2176	* @copydoc PDMDRVHLPR3::pfnNetShaperAllocateBandwidth
2177	*/
2178	DECLINLINE(bool) PDMDrvHlpNetShaperAllocateBandwidth(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer)
2179	{
2180	return pDrvIns->CTX_SUFF(pHlp)->pfnNetShaperAllocateBandwidth(pDrvIns, pFilter, cbTransfer);
2181	}
2182
2183	#endif /* VBOX_WITH_NETSHAPER*/
2184
2185	#ifdef IN_RING3
2186	/**
2187	* @copydoc PDMDRVHLPR3::pfnCritSectInit
2188	*/
2189	DECLINLINE(int) PDMDrvHlpCritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName)
2190	{
2191	return pDrvIns->pHlpR3->pfnCritSectInit(pDrvIns, pCritSect, RT_SRC_POS_ARGS, pszName);
2192	}
2193	#endif /* IN_RING3 */
2194
2195	/**
2196	* @see PDMCritSectEnter
2197	*/
2198	DECLINLINE(int) PDMDrvHlpCritSectEnter(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy)
2199	{
2200	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectEnter(pDrvIns, pCritSect, rcBusy);
2201	}
2202
2203	/**
2204	* @see PDMCritSectEnterDebug
2205	*/
2206	DECLINLINE(int) PDMDrvHlpCritSectEnterDebug(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL)
2207	{
2208	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectEnterDebug(pDrvIns, pCritSect, rcBusy, uId, RT_SRC_POS_ARGS);
2209	}
2210
2211	/**
2212	* @see PDMCritSectTryEnter
2213	*/
2214	DECLINLINE(int) PDMDrvHlpCritSectTryEnter(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
2215	{
2216	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectTryEnter(pDrvIns, pCritSect);
2217	}
2218
2219	/**
2220	* @see PDMCritSectTryEnterDebug
2221	*/
2222	DECLINLINE(int) PDMDrvHlpCritSectTryEnterDebug(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL)
2223	{
2224	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectTryEnterDebug(pDrvIns, pCritSect, uId, RT_SRC_POS_ARGS);
2225	}
2226
2227	/**
2228	* @see PDMCritSectLeave
2229	*/
2230	DECLINLINE(int) PDMDrvHlpCritSectLeave(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
2231	{
2232	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectLeave(pDrvIns, pCritSect);
2233	}
2234
2235	/**
2236	* @see PDMCritSectIsOwner
2237	*/
2238	DECLINLINE(bool) PDMDrvHlpCritSectIsOwner(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2239	{
2240	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectIsOwner(pDrvIns, pCritSect);
2241	}
2242
2243	/**
2244	* @see PDMCritSectIsInitialized
2245	*/
2246	DECLINLINE(bool) PDMDrvHlpCritSectIsInitialized(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2247	{
2248	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectIsInitialized(pDrvIns, pCritSect);
2249	}
2250
2251	/**
2252	* @see PDMCritSectHasWaiters
2253	*/
2254	DECLINLINE(bool) PDMDrvHlpCritSectHasWaiters(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2255	{
2256	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectHasWaiters(pDrvIns, pCritSect);
2257	}
2258
2259	/**
2260	* @see PDMCritSectGetRecursion
2261	*/
2262	DECLINLINE(uint32_t) PDMDrvHlpCritSectGetRecursion(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
2263	{
2264	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectGetRecursion(pDrvIns, pCritSect);
2265	}
2266
2267	#if defined(IN_RING3) \|\| defined(IN_RING0)
2268	/**
2269	* @see PDMHCCritSectScheduleExitEvent
2270	*/
2271	DECLINLINE(int) PDMDrvHlpCritSectScheduleExitEvent(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal)
2272	{
2273	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectScheduleExitEvent(pDrvIns, pCritSect, hEventToSignal);
2274	}
2275	#endif
2276
2277	/* Strict build: Remap the two enter calls to the debug versions. */
2278	#ifdef VBOX_STRICT
2279	# ifdef IPRT_INCLUDED_asm_h
2280	# define PDMDrvHlpCritSectEnter(pDrvIns, pCritSect, rcBusy) PDMDrvHlpCritSectEnterDebug((pDrvIns), (pCritSect), (rcBusy), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
2281	# define PDMDrvHlpCritSectTryEnter(pDrvIns, pCritSect) PDMDrvHlpCritSectTryEnterDebug((pDrvIns), (pCritSect), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
2282	# else
2283	# define PDMDrvHlpCritSectEnter(pDrvIns, pCritSect, rcBusy) PDMDrvHlpCritSectEnterDebug((pDrvIns), (pCritSect), (rcBusy), 0, RT_SRC_POS)
2284	# define PDMDrvHlpCritSectTryEnter(pDrvIns, pCritSect) PDMDrvHlpCritSectTryEnterDebug((pDrvIns), (pCritSect), 0, RT_SRC_POS)
2285	# endif
2286	#endif
2287
2288	#if defined(IN_RING3) \|\| defined(DOXYGEN_RUNNING)
2289
2290	/**
2291	* @see PDMR3CritSectDelete
2292	*/
2293	DECLINLINE(int) PDMDrvHlpCritSectDelete(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
2294	{
2295	return pDrvIns->pHlpR3->pfnCritSectDelete(pDrvIns, pCritSect);
2296	}
2297
2298	/**
2299	* @copydoc PDMDRVHLPR3::pfnCallR0
2300	*/
2301	DECLINLINE(int) PDMDrvHlpCallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
2302	{
2303	return pDrvIns->pHlpR3->pfnCallR0(pDrvIns, uOperation, u64Arg);
2304	}
2305
2306	/**
2307	* @copydoc PDMDRVHLPR3::pfnBlkCacheRetain
2308	*/
2309	DECLINLINE(int) PDMDrvHlpBlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
2310	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
2311	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
2312	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
2313	const char *pcszId)
2314	{
2315	return pDrvIns->pHlpR3->pfnBlkCacheRetain(pDrvIns, ppBlkCache, pfnXferComplete, pfnXferEnqueue, pfnXferEnqueueDiscard, pcszId);
2316	}
2317
2318	/**
2319	* @copydoc PDMDRVHLPR3::pfnBlkCacheRelease
2320	*/
2321	DECLINLINE(void) PDMDrvHlpBlkCacheRelease(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2322	{
2323	pDrvIns->pHlpR3->pfnBlkCacheRelease(pBlkCache);
2324	}
2325
2326	/**
2327	* @copydoc PDMDRVHLPR3::pfnBlkCacheClear
2328	*/
2329	DECLINLINE(int) PDMDrvHlpBlkCacheClear(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2330	{
2331	return pDrvIns->pHlpR3->pfnBlkCacheClear(pBlkCache);
2332	}
2333
2334	/**
2335	* @copydoc PDMDRVHLPR3::pfnBlkCacheSuspend
2336	*/
2337	DECLINLINE(int) PDMDrvHlpBlkCacheSuspend(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2338	{
2339	return pDrvIns->pHlpR3->pfnBlkCacheSuspend(pBlkCache);
2340	}
2341
2342	/**
2343	* @copydoc PDMDRVHLPR3::pfnBlkCacheResume
2344	*/
2345	DECLINLINE(int) PDMDrvHlpBlkCacheResume(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache)
2346	{
2347	return pDrvIns->pHlpR3->pfnBlkCacheResume(pBlkCache);
2348	}
2349
2350	/**
2351	* @copydoc PDMDRVHLPR3::pfnBlkCacheIoXferComplete
2352	*/
2353	DECLINLINE(void) PDMDrvHlpBlkCacheIoXferComplete(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache,
2354	PPDMBLKCACHEIOXFER hIoXfer, int rcIoXfer)
2355	{
2356	pDrvIns->pHlpR3->pfnBlkCacheIoXferComplete(pBlkCache, hIoXfer, rcIoXfer);
2357	}
2358
2359	/**
2360	* @copydoc PDMDRVHLPR3::pfnBlkCacheRead
2361	*/
2362	DECLINLINE(int) PDMDrvHlpBlkCacheRead(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, uint64_t off,
2363	PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser)
2364	{
2365	return pDrvIns->pHlpR3->pfnBlkCacheRead(pBlkCache, off, pSgBuf, cbRead, pvUser);
2366	}
2367
2368	/**
2369	* @copydoc PDMDRVHLPR3::pfnBlkCacheWrite
2370	*/
2371	DECLINLINE(int) PDMDrvHlpBlkCacheWrite(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, uint64_t off,
2372	PCRTSGBUF pSgBuf, size_t cbRead, void *pvUser)
2373	{
2374	return pDrvIns->pHlpR3->pfnBlkCacheWrite(pBlkCache, off, pSgBuf, cbRead, pvUser);
2375	}
2376
2377	/**
2378	* @copydoc PDMDRVHLPR3::pfnBlkCacheFlush
2379	*/
2380	DECLINLINE(int) PDMDrvHlpBlkCacheFlush(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, void *pvUser)
2381	{
2382	return pDrvIns->pHlpR3->pfnBlkCacheFlush(pBlkCache, pvUser);
2383	}
2384
2385	/**
2386	* @copydoc PDMDRVHLPR3::pfnBlkCacheDiscard
2387	*/
2388	DECLINLINE(int) PDMDrvHlpBlkCacheDiscard(PPDMDRVINS pDrvIns, PPDMBLKCACHE pBlkCache, PCRTRANGE paRanges,
2389	unsigned cRanges, void *pvUser)
2390	{
2391	return pDrvIns->pHlpR3->pfnBlkCacheDiscard(pBlkCache, paRanges, cRanges, pvUser);
2392	}
2393
2394	/**
2395	* @copydoc PDMDRVHLPR3::pfnVMGetSuspendReason
2396	*/
2397	DECLINLINE(VMSUSPENDREASON) PDMDrvHlpVMGetSuspendReason(PPDMDRVINS pDrvIns)
2398	{
2399	return pDrvIns->pHlpR3->pfnVMGetSuspendReason(pDrvIns);
2400	}
2401
2402	/**
2403	* @copydoc PDMDRVHLPR3::pfnVMGetResumeReason
2404	*/
2405	DECLINLINE(VMRESUMEREASON) PDMDrvHlpVMGetResumeReason(PPDMDRVINS pDrvIns)
2406	{
2407	return pDrvIns->pHlpR3->pfnVMGetResumeReason(pDrvIns);
2408	}
2409
2410	/**
2411	* @copydoc PDMDRVHLPR3::pfnQueryGenericUserObject
2412	*/
2413	DECLINLINE(void *) PDMDrvHlpQueryGenericUserObject(PPDMDRVINS pDrvIns, PCRTUUID pUuid)
2414	{
2415	return pDrvIns->pHlpR3->pfnQueryGenericUserObject(pDrvIns, pUuid);
2416	}
2417
2418
2419	/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
2420	typedef struct PDMDRVREGCB *PPDMDRVREGCB;
2421	/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
2422	typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
2423
2424	/**
2425	* Callbacks for VBoxDriverRegister().
2426	*/
2427	typedef struct PDMDRVREGCB
2428	{
2429	/** Interface version.
2430	* This is set to PDM_DRVREG_CB_VERSION. */
2431	uint32_t u32Version;
2432
2433	/**
2434	* Registers a driver with the current VM instance.
2435	*
2436	* @returns VBox status code.
2437	* @param pCallbacks Pointer to the callback table.
2438	* @param pReg Pointer to the driver registration record.
2439	* This data must be permanent and readonly.
2440	*/
2441	DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg));
2442	} PDMDRVREGCB;
2443
2444	/** Current version of the PDMDRVREGCB structure. */
2445	#define PDM_DRVREG_CB_VERSION PDM_VERSION_MAKE(0xf0fa, 1, 0)
2446
2447
2448	/**
2449	* The VBoxDriverRegister callback function.
2450	*
2451	* PDM will invoke this function after loading a driver module and letting
2452	* the module decide which drivers to register and how to handle conflicts.
2453	*
2454	* @returns VBox status code.
2455	* @param pCallbacks Pointer to the callback table.
2456	* @param u32Version VBox version number.
2457	*/
2458	typedef DECLCALLBACKTYPE(int, FNPDMVBOXDRIVERSREGISTER,(PCPDMDRVREGCB pCallbacks, uint32_t u32Version));
2459
2460	VMMR3DECL(int) PDMR3DrvStaticRegistration(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
2461
2462	#endif /* IN_RING3 */
2463
2464	/** @} */
2465
2466	RT_C_DECLS_END
2467
2468	#endif /* !VBOX_INCLUDED_vmm_pdmdrv_h */

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: