pdmdrv.h@ 91711

Last change on this file since 91711 was 91000, checked in by vboxsync, 4 years ago
VMM,PDM,PGM: Restrict the VMSetError and VMSetRuntimeError APIs to ring-3, these never worked properly in ring-0 or raw-mode. A PAEmode runtime error was the only place any of these were used, but given that the VMSetRuntimeError codepath starts with an assertion, it can't have been used/tested. The PAEmode runtime error shouldn't necessarily be triggered by PGM anyway, but IEM. Removed VMMCALLRING3_VM_SET_ERROR and VMMCALLRING3_VM_SET_RUNTIME_ERROR. [doxygen fix] bugref:10093
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 79.7 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 = CFGMR3ValidateConfig((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	/**
823	* Create a queue.
824	*
825	* @returns VBox status code.
826	* @param pDrvIns Driver instance.
827	* @param cbItem Size a queue item.
828	* @param cItems Number of items in the queue.
829	* @param cMilliesInterval Number of milliseconds between polling the queue.
830	* If 0 then the emulation thread will be notified whenever an item arrives.
831	* @param pfnCallback The consumer function.
832	* @param pszName The queue base name. The instance number will be
833	* appended automatically.
834	* @param ppQueue Where to store the queue handle on success.
835	* @thread The emulation thread.
836	*/
837	DECLR3CALLBACKMEMBER(int, pfnQueueCreate,(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
838	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue));
839
840	/**
841	* Query the virtual timer frequency.
842	*
843	* @returns Frequency in Hz.
844	* @param pDrvIns Driver instance.
845	* @thread Any thread.
846	*/
847	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualFreq,(PPDMDRVINS pDrvIns));
848
849	/**
850	* Query the virtual time.
851	*
852	* @returns The current virtual time.
853	* @param pDrvIns Driver instance.
854	* @thread Any thread.
855	*/
856	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualTime,(PPDMDRVINS pDrvIns));
857
858	/**
859	* Creates a timer.
860	*
861	* @returns VBox status.
862	* @param pDrvIns Driver instance.
863	* @param enmClock The clock to use on this timer.
864	* @param pfnCallback Callback function.
865	* @param pvUser The user argument to the callback.
866	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
867	* @param pszDesc Pointer to description string which must stay around
868	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
869	* @param phTimer Where to store the timer handle on success.
870	* @thread EMT
871	*
872	* @todo Need to add a bunch of timer helpers for this to be useful again.
873	* Will do when required.
874	*/
875	DECLR3CALLBACKMEMBER(int, pfnTimerCreate,(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
876	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer));
877
878	/**
879	* Register a save state data unit.
880	*
881	* @returns VBox status.
882	* @param pDrvIns Driver instance.
883	* @param uVersion Data layout version number.
884	* @param cbGuess The approximate amount of data in the unit.
885	* Only for progress indicators.
886	*
887	* @param pfnLivePrep Prepare live save callback, optional.
888	* @param pfnLiveExec Execute live save callback, optional.
889	* @param pfnLiveVote Vote live save callback, optional.
890	*
891	* @param pfnSavePrep Prepare save callback, optional.
892	* @param pfnSaveExec Execute save callback, optional.
893	* @param pfnSaveDone Done save callback, optional.
894	*
895	* @param pfnLoadPrep Prepare load callback, optional.
896	* @param pfnLoadExec Execute load callback, optional.
897	* @param pfnLoadDone Done load callback, optional.
898	*/
899	DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
900	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
901	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
902	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
903
904	/**
905	* Deregister a save state data unit.
906	*
907	* @returns VBox status.
908	* @param pDrvIns Driver instance.
909	* @param pszName Data unit name.
910	* @param uInstance The instance identifier of the data unit.
911	* This must together with the name be unique.
912	*/
913	DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance));
914
915	/**
916	* Register an info handler with DBGF.
917	*
918	* @returns VBox status code.
919	* @param pDrvIns Driver instance.
920	* @param pszName Data unit name.
921	* @param pszDesc The description of the info and any arguments
922	* the handler may take.
923	* @param pfnHandler The handler function to be called to display the
924	* info.
925	*/
926	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler));
927
928	/**
929	* Register an info handler with DBGF, argv style.
930	*
931	* @returns VBox status code.
932	* @param pDrvIns Driver instance.
933	* @param pszName Data unit name.
934	* @param pszDesc The description of the info and any arguments
935	* the handler may take.
936	* @param pfnHandler The handler function to be called to display the
937	* info.
938	*/
939	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegisterArgv,(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFINFOARGVDRV pfnHandler));
940
941	/**
942	* Deregister an info handler from DBGF.
943	*
944	* @returns VBox status code.
945	* @param pDrvIns Driver instance.
946	* @param pszName Data unit name.
947	*/
948	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoDeregister,(PPDMDRVINS pDrvIns, const char *pszName));
949
950	/**
951	* Registers a statistics sample if statistics are enabled.
952	*
953	* @param pDrvIns Driver instance.
954	* @param pvSample Pointer to the sample.
955	* @param enmType Sample type. This indicates what pvSample is pointing at.
956	* @param pszName Sample name. The name is on this form "/<component>/<sample>".
957	* Further nesting is possible. If this does not start
958	* with a '/', the default prefix will be prepended,
959	* otherwise it will be used as-is.
960	* @param enmUnit Sample unit.
961	* @param pszDesc Sample description.
962	*/
963	DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName,
964	STAMUNIT enmUnit, const char *pszDesc));
965
966	/**
967	* Same as pfnSTAMRegister except that the name is specified in a
968	* RTStrPrintf like fashion.
969	*
970	* @param pDrvIns Driver instance.
971	* @param pvSample Pointer to the sample.
972	* @param enmType Sample type. This indicates what pvSample is pointing at.
973	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
974	* @param enmUnit Sample unit.
975	* @param pszDesc Sample description.
976	* @param pszName The sample name format string. If this does not start
977	* with a '/', the default prefix will be prepended,
978	* otherwise it will be used as-is.
979	* @param ... Arguments to the format string.
980	*/
981	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
982	STAMUNIT enmUnit, const char *pszDesc,
983	const char *pszName, ...) RT_IPRT_FORMAT_ATTR(7, 8));
984
985	/**
986	* Same as pfnSTAMRegister except that the name is specified in a
987	* RTStrPrintfV like fashion.
988	*
989	* @param pDrvIns Driver instance.
990	* @param pvSample Pointer to the sample.
991	* @param enmType Sample type. This indicates what pvSample is pointing at.
992	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
993	* @param enmUnit Sample unit.
994	* @param pszDesc Sample description.
995	* @param pszName The sample name format string. If this does not
996	* start with a '/', the default prefix will be prepended,
997	* otherwise it will be used as-is.
998	* @param args Arguments to the format string.
999	*/
1000	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1001	STAMUNIT enmUnit, const char *pszDesc,
1002	const char *pszName, va_list args) RT_IPRT_FORMAT_ATTR(7, 0));
1003
1004	/**
1005	* Deregister a statistic item previously registered with pfnSTAMRegister,
1006	* pfnSTAMRegisterF or pfnSTAMRegisterV
1007	*
1008	* @returns VBox status.
1009	* @param pDrvIns Driver instance.
1010	* @param pvSample Pointer to the sample.
1011	*/
1012	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregister,(PPDMDRVINS pDrvIns, void *pvSample));
1013
1014	/**
1015	* Calls the HC R0 VMM entry point, in a safer but slower manner than
1016	* SUPR3CallVMMR0.
1017	*
1018	* When entering using this call the R0 components can call into the host kernel
1019	* (i.e. use the SUPR0 and RT APIs).
1020	*
1021	* See VMMR0Entry() for more details.
1022	*
1023	* @returns error code specific to uFunction.
1024	* @param pDrvIns The driver instance.
1025	* @param uOperation Operation to execute.
1026	* This is limited to services.
1027	* @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
1028	* @param cbArg The size of the argument. This is used to copy whatever the argument
1029	* points at into a kernel buffer to avoid problems like the user page
1030	* being invalidated while we're executing the call.
1031	*/
1032	DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
1033
1034	/**
1035	* Registers a USB HUB.
1036	*
1037	* @returns VBox status code.
1038	* @param pDrvIns The driver instance.
1039	* @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
1040	* @param cPorts The number of ports.
1041	* @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
1042	* @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
1043	*
1044	* @thread EMT.
1045	*/
1046	DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
1047
1048	/**
1049	* Set up asynchronous handling of a suspend, reset or power off notification.
1050	*
1051	* This shall only be called when getting the notification. It must be called
1052	* for each one.
1053	*
1054	* @returns VBox status code.
1055	* @param pDrvIns The driver instance.
1056	* @param pfnAsyncNotify The callback.
1057	* @thread EMT(0)
1058	*/
1059	DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
1060
1061	/**
1062	* Notify EMT(0) that the driver has completed the asynchronous notification
1063	* handling.
1064	*
1065	* This can be called at any time, spurious calls will simply be ignored.
1066	*
1067	* @param pDrvIns The driver instance.
1068	* @thread Any
1069	*/
1070	DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMDRVINS pDrvIns));
1071
1072	/**
1073	* Creates a PDM thread.
1074	*
1075	* This differs from the RTThreadCreate() API in that PDM takes care of suspending,
1076	* resuming, and destroying the thread as the VM state changes.
1077	*
1078	* @returns VBox status code.
1079	* @param pDrvIns The driver instance.
1080	* @param ppThread Where to store the thread 'handle'.
1081	* @param pvUser The user argument to the thread function.
1082	* @param pfnThread The thread function.
1083	* @param pfnWakeup The wakup callback. This is called on the EMT thread when
1084	* a state change is pending.
1085	* @param cbStack See RTThreadCreate.
1086	* @param enmType See RTThreadCreate.
1087	* @param pszName See RTThreadCreate.
1088	*/
1089	DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1090	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
1091
1092	/**
1093	* Creates an async completion template for a driver instance.
1094	*
1095	* The template is used when creating new completion tasks.
1096	*
1097	* @returns VBox status code.
1098	* @param pDrvIns The driver instance.
1099	* @param ppTemplate Where to store the template pointer on success.
1100	* @param pfnCompleted The completion callback routine.
1101	* @param pvTemplateUser Template user argument.
1102	* @param pszDesc Description.
1103	*/
1104	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1105	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1106	const char *pszDesc));
1107
1108	/**
1109	* Attaches network filter driver to a bandwidth group.
1110	*
1111	* @returns VBox status code.
1112	* @param pDrvIns The driver instance.
1113	* @param pszBwGroup Name of the bandwidth group to attach to.
1114	* @param pFilter Pointer to the filter we attach.
1115	*/
1116	DECLR3CALLBACKMEMBER(int, pfnNetShaperAttach,(PPDMDRVINS pDrvIns, const char *pszBwGroup, PPDMNSFILTER pFilter));
1117
1118	/**
1119	* Detaches network filter driver to a bandwidth group.
1120	*
1121	* @returns VBox status code.
1122	* @param pDrvIns The driver instance.
1123	* @param pFilter Pointer to the filter we attach.
1124	*/
1125	DECLR3CALLBACKMEMBER(int, pfnNetShaperDetach,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter));
1126
1127	/**
1128	* Obtains bandwidth in a bandwidth group.
1129	*
1130	* @returns True if bandwidth was allocated, false if not.
1131	* @param pDrvIns The driver instance.
1132	* @param pFilter Pointer to the filter that allocates bandwidth.
1133	* @param cbTransfer Number of bytes to allocate.
1134	*/
1135	DECLR3CALLBACKMEMBER(bool, pfnNetShaperAllocateBandwidth,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer));
1136
1137	/**
1138	* Resolves the symbol for a raw-mode context interface.
1139	*
1140	* @returns VBox status code.
1141	* @param pDrvIns The driver instance.
1142	* @param pvInterface The interface structure.
1143	* @param cbInterface The size of the interface structure.
1144	* @param pszSymPrefix What to prefix the symbols in the list with before
1145	* resolving them. This must start with 'drv' and
1146	* contain the driver name.
1147	* @param pszSymList List of symbols corresponding to the interface.
1148	* There is generally a there is generally a define
1149	* holding this list associated with the interface
1150	* definition (INTERFACE_SYM_LIST). For more details
1151	* see PDMR3LdrGetInterfaceSymbols.
1152	* @thread EMT
1153	*/
1154	DECLR3CALLBACKMEMBER(int, pfnLdrGetRCInterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1155	const char pszSymPrefix, const char pszSymList));
1156
1157	/**
1158	* Resolves the symbol for a ring-0 context interface.
1159	*
1160	* @returns VBox status code.
1161	* @param pDrvIns The driver instance.
1162	* @param pvInterface The interface structure.
1163	* @param cbInterface The size of the interface structure.
1164	* @param pszSymPrefix What to prefix the symbols in the list with before
1165	* resolving them. This must start with 'drv' and
1166	* contain the driver name.
1167	* @param pszSymList List of symbols corresponding to the interface.
1168	* There is generally a there is generally a define
1169	* holding this list associated with the interface
1170	* definition (INTERFACE_SYM_LIST). For more details
1171	* see PDMR3LdrGetInterfaceSymbols.
1172	* @thread EMT
1173	*/
1174	DECLR3CALLBACKMEMBER(int, pfnLdrGetR0InterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1175	const char pszSymPrefix, const char pszSymList));
1176	/**
1177	* Initializes a PDM critical section.
1178	*
1179	* The PDM critical sections are derived from the IPRT critical sections, but
1180	* works in both RC and R0 as well as R3.
1181	*
1182	* @returns VBox status code.
1183	* @param pDrvIns The driver instance.
1184	* @param pCritSect Pointer to the critical section.
1185	* @param SRC_POS Use RT_SRC_POS.
1186	* @param pszName The base name of the critical section. Will be
1187	* mangeled with the instance number. For
1188	* statistics and lock validation.
1189	* @thread EMT
1190	*/
1191	DECLR3CALLBACKMEMBER(int, pfnCritSectInit,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName));
1192
1193	/** @name Exported PDM Critical Section Functions
1194	* @{ */
1195	DECLR3CALLBACKMEMBER(bool, pfnCritSectYield,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1196	DECLR3CALLBACKMEMBER(int, pfnCritSectEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy));
1197	DECLR3CALLBACKMEMBER(int, pfnCritSectEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL));
1198	DECLR3CALLBACKMEMBER(int, pfnCritSectTryEnter,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1199	DECLR3CALLBACKMEMBER(int, pfnCritSectTryEnterDebug,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL));
1200	DECLR3CALLBACKMEMBER(int, pfnCritSectLeave,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1201	DECLR3CALLBACKMEMBER(bool, pfnCritSectIsOwner,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1202	DECLR3CALLBACKMEMBER(bool, pfnCritSectIsInitialized,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1203	DECLR3CALLBACKMEMBER(bool, pfnCritSectHasWaiters,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1204	DECLR3CALLBACKMEMBER(uint32_t, pfnCritSectGetRecursion,(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect));
1205	DECLR3CALLBACKMEMBER(int, pfnCritSectScheduleExitEvent,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal));
1206	DECLR3CALLBACKMEMBER(int, pfnCritSectDelete,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect));
1207	/** @} */
1208
1209	/**
1210	* Call the ring-0 request handler routine of the driver.
1211	*
1212	* For this to work, the driver must be ring-0 enabled and export a request
1213	* handler function. The name of the function must be the driver name in the
1214	* PDMDRVREG struct prefixed with 'drvR0' and suffixed with 'ReqHandler'.
1215	* The driver name will be capitalized. It shall take the exact same
1216	* arguments as this function and be declared using PDMBOTHCBDECL. See
1217	* FNPDMDRVREQHANDLERR0.
1218	*
1219	* @returns VBox status code.
1220	* @retval VERR_SYMBOL_NOT_FOUND if the driver doesn't export the required
1221	* handler function.
1222	* @retval VERR_ACCESS_DENIED if the driver isn't ring-0 capable.
1223	*
1224	* @param pDrvIns The driver instance.
1225	* @param uOperation The operation to perform.
1226	* @param u64Arg 64-bit integer argument.
1227	* @thread Any
1228	*/
1229	DECLR3CALLBACKMEMBER(int, pfnCallR0,(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg));
1230
1231	/**
1232	* Creates a block cache for a driver driver instance.
1233	*
1234	* @returns VBox status code.
1235	* @param pDrvIns The driver instance.
1236	* @param ppBlkCache Where to store the handle to the block cache.
1237	* @param pfnXferComplete The I/O transfer complete callback.
1238	* @param pfnXferEnqueue The I/O request enqueue callback.
1239	* @param pfnXferEnqueueDiscard The discard request enqueue callback.
1240	* @param pcszId Unique ID used to identify the user.
1241	*/
1242	DECLR3CALLBACKMEMBER(int, pfnBlkCacheRetain, (PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1243	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1244	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1245	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1246	const char *pcszId));
1247	/**
1248	* Gets the reason for the most recent VM suspend.
1249	*
1250	* @returns The suspend reason. VMSUSPENDREASON_INVALID is returned if no
1251	* suspend has been made or if the pDrvIns is invalid.
1252	* @param pDrvIns The driver instance.
1253	*/
1254	DECLR3CALLBACKMEMBER(VMSUSPENDREASON, pfnVMGetSuspendReason,(PPDMDRVINS pDrvIns));
1255
1256	/**
1257	* Gets the reason for the most recent VM resume.
1258	*
1259	* @returns The resume reason. VMRESUMEREASON_INVALID is returned if no
1260	* resume has been made or if the pDrvIns is invalid.
1261	* @param pDrvIns The driver instance.
1262	*/
1263	DECLR3CALLBACKMEMBER(VMRESUMEREASON, pfnVMGetResumeReason,(PPDMDRVINS pDrvIns));
1264
1265	/** @name Space reserved for minor interface changes.
1266	* @{ */
1267	DECLR3CALLBACKMEMBER(int, pfnTimerSetMillies,(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext));
1268
1269	/**
1270	* Deregister zero or more samples given their name prefix.
1271	*
1272	* @returns VBox status code.
1273	* @param pDrvIns The driver instance.
1274	* @param pszPrefix The name prefix of the samples to remove. If this does
1275	* not start with a '/', the default prefix will be
1276	* prepended, otherwise it will be used as-is.
1277	*/
1278	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregisterByPrefix,(PPDMDRVINS pDrvIns, const char *pszPrefix));
1279
1280	/**
1281	* Queries a generic object from the VMM user.
1282	*
1283	* @returns Pointer to the object if found, NULL if not.
1284	* @param pDrvIns The driver instance.
1285	* @param pUuid The UUID of what's being queried. The UUIDs and
1286	* the usage conventions are defined by the user.
1287	*/
1288	DECLR3CALLBACKMEMBER(void *, pfnQueryGenericUserObject,(PPDMDRVINS pDrvIns, PCRTUUID pUuid));
1289
1290	DECLR3CALLBACKMEMBER(void, pfnReserved2,(PPDMDRVINS pDrvIns));
1291	DECLR3CALLBACKMEMBER(void, pfnReserved3,(PPDMDRVINS pDrvIns));
1292	DECLR3CALLBACKMEMBER(void, pfnReserved4,(PPDMDRVINS pDrvIns));
1293	DECLR3CALLBACKMEMBER(void, pfnReserved5,(PPDMDRVINS pDrvIns));
1294	DECLR3CALLBACKMEMBER(void, pfnReserved6,(PPDMDRVINS pDrvIns));
1295	DECLR3CALLBACKMEMBER(void, pfnReserved7,(PPDMDRVINS pDrvIns));
1296	DECLR3CALLBACKMEMBER(void, pfnReserved8,(PPDMDRVINS pDrvIns));
1297	/** @} */
1298
1299	/** Just a safety precaution. */
1300	uint32_t u32TheEnd;
1301	} PDMDRVHLPR3;
1302	/** Current DRVHLP version number. */
1303	#define PDM_DRVHLPR3_VERSION PDM_VERSION_MAKE(0xf0fb, 8, 0)
1304
1305
1306	/**
1307	* Set the VM error message
1308	*
1309	* @returns rc.
1310	* @param pDrvIns Driver instance.
1311	* @param rc VBox status code.
1312	* @param SRC_POS Use RT_SRC_POS.
1313	* @param pszFormat Error message format string.
1314	* @param ... Error message arguments.
1315	* @sa PDMDRV_SET_ERROR, PDMDrvHlpVMSetErrorV, VMSetError
1316	*/
1317	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 7) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1318	const char *pszFormat, ...)
1319	{
1320	va_list va;
1321	va_start(va, pszFormat);
1322	pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1323	va_end(va);
1324	return rc;
1325	}
1326
1327	/** @def PDMDRV_SET_ERROR
1328	* Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
1329	*/
1330	#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
1331	PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
1332
1333	/**
1334	* @copydoc PDMDRVHLPR3::pfnVMSetErrorV
1335	*/
1336	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 0) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1337	const char *pszFormat, va_list va)
1338	{
1339	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1340	}
1341
1342
1343	/**
1344	* Set the VM runtime error message
1345	*
1346	* @returns VBox status code.
1347	* @param pDrvIns Driver instance.
1348	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
1349	* @param pszErrorId Error ID string.
1350	* @param pszFormat Error message format string.
1351	* @param ... Error message arguments.
1352	* @sa PDMDRV_SET_RUNTIME_ERROR, PDMDrvHlpVMSetRuntimeErrorV,
1353	* VMSetRuntimeError
1354	*/
1355	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 5) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
1356	const char *pszFormat, ...)
1357	{
1358	va_list va;
1359	int rc;
1360	va_start(va, pszFormat);
1361	rc = pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1362	va_end(va);
1363	return rc;
1364	}
1365
1366	/** @def PDMDRV_SET_RUNTIME_ERROR
1367	* Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
1368	*/
1369	#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFlags, pszErrorId, pszError) \
1370	PDMDrvHlpVMSetRuntimeError(pDrvIns, fFlags, pszErrorId, "%s", pszError)
1371
1372	/**
1373	* @copydoc PDMDRVHLPR3::pfnVMSetRuntimeErrorV
1374	*/
1375	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 0) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags,
1376	const char pszErrorId, const char pszFormat, va_list va)
1377	{
1378	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1379	}
1380
1381	#endif /* IN_RING3 */
1382
1383	/** @def PDMDRV_ASSERT_EMT
1384	* Assert that the current thread is the emulation thread.
1385	*/
1386	#ifdef VBOX_STRICT
1387	# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1388	#else
1389	# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
1390	#endif
1391
1392	/** @def PDMDRV_ASSERT_OTHER
1393	* Assert that the current thread is NOT the emulation thread.
1394	*/
1395	#ifdef VBOX_STRICT
1396	# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1397	#else
1398	# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
1399	#endif
1400
1401
1402	#ifdef IN_RING3
1403
1404	/**
1405	* @copydoc PDMDRVHLPR3::pfnAttach
1406	*/
1407	DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
1408	{
1409	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, fFlags, ppBaseInterface);
1410	}
1411
1412	/**
1413	* Check that there is no driver below the us that we should attach to.
1414	*
1415	* @returns VERR_PDM_NO_ATTACHED_DRIVER if there is no driver.
1416	* @param pDrvIns The driver instance.
1417	*/
1418	DECLINLINE(int) PDMDrvHlpNoAttach(PPDMDRVINS pDrvIns)
1419	{
1420	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, 0, NULL);
1421	}
1422
1423	/**
1424	* @copydoc PDMDRVHLPR3::pfnDetach
1425	*/
1426	DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1427	{
1428	return pDrvIns->pHlpR3->pfnDetach(pDrvIns, fFlags);
1429	}
1430
1431	/**
1432	* @copydoc PDMDRVHLPR3::pfnDetachSelf
1433	*/
1434	DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1435	{
1436	return pDrvIns->pHlpR3->pfnDetachSelf(pDrvIns, fFlags);
1437	}
1438
1439	/**
1440	* @copydoc PDMDRVHLPR3::pfnMountPrepare
1441	*/
1442	DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
1443	{
1444	return pDrvIns->pHlpR3->pfnMountPrepare(pDrvIns, pszFilename, pszCoreDriver);
1445	}
1446
1447	/**
1448	* @copydoc PDMDRVHLPR3::pfnVMState
1449	*/
1450	DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
1451	{
1452	return pDrvIns->CTX_SUFF(pHlp)->pfnVMState(pDrvIns);
1453	}
1454
1455	/**
1456	* @copydoc PDMDRVHLPR3::pfnVMTeleportedAndNotFullyResumedYet
1457	*/
1458	DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1459	{
1460	return pDrvIns->pHlpR3->pfnVMTeleportedAndNotFullyResumedYet(pDrvIns);
1461	}
1462
1463	/**
1464	* @copydoc PDMDRVHLPR3::pfnGetSupDrvSession
1465	*/
1466	DECLINLINE(PSUPDRVSESSION) PDMDrvHlpGetSupDrvSession(PPDMDRVINS pDrvIns)
1467	{
1468	return pDrvIns->pHlpR3->pfnGetSupDrvSession(pDrvIns);
1469	}
1470
1471	/**
1472	* @copydoc PDMDRVHLPR3::pfnQueueCreate
1473	*/
1474	DECLINLINE(int) PDMDrvHlpQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1475	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue)
1476	{
1477	return pDrvIns->pHlpR3->pfnQueueCreate(pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
1478	}
1479
1480	/**
1481	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualFreq
1482	*/
1483	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
1484	{
1485	return pDrvIns->pHlpR3->pfnTMGetVirtualFreq(pDrvIns);
1486	}
1487
1488	/**
1489	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualTime
1490	*/
1491	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
1492	{
1493	return pDrvIns->pHlpR3->pfnTMGetVirtualTime(pDrvIns);
1494	}
1495
1496	/**
1497	* @copydoc PDMDRVHLPR3::pfnTimerCreate
1498	*/
1499	DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
1500	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1501
1502	{
1503	return pDrvIns->pHlpR3->pfnTimerCreate(pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, phTimer);
1504	}
1505
1506	/**
1507	* @copydoc PDMDRVHLPR3::pfnTimerSetMillies
1508	*/
1509	DECLINLINE(int) PDMDrvHlpTimerSetMillies(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext)
1510
1511	{
1512	return pDrvIns->pHlpR3->pfnTimerSetMillies(pDrvIns, hTimer, cMilliesToNext);
1513	}
1514
1515	/**
1516	* Register a save state data unit.
1517	*
1518	* @returns VBox status.
1519	* @param pDrvIns Driver instance.
1520	* @param uVersion Data layout version number.
1521	* @param cbGuess The approximate amount of data in the unit.
1522	* Only for progress indicators.
1523	* @param pfnSaveExec Execute save callback, optional.
1524	* @param pfnLoadExec Execute load callback, optional.
1525	*/
1526	DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1527	PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVLOADEXEC pfnLoadExec)
1528	{
1529	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1530	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1531	NULL /pfnSavePrep/, pfnSaveExec, NULL /pfnSaveDone/,
1532	NULL /pfnLoadPrep/, pfnLoadExec, NULL /pfnLoadDone/);
1533	}
1534
1535	/**
1536	* @copydoc PDMDRVHLPR3::pfnSSMRegister
1537	*/
1538	DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1539	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1540	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1541	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1542	{
1543	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1544	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1545	pfnSavePrep, pfnSaveExec, pfnSaveDone,
1546	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1547	}
1548
1549	/**
1550	* Register a load done callback.
1551	*
1552	* @returns VBox status.
1553	* @param pDrvIns Driver instance.
1554	* @param pfnLoadDone Done load callback, optional.
1555	*/
1556	DECLINLINE(int) PDMDrvHlpSSMRegisterLoadDone(PPDMDRVINS pDrvIns, PFNSSMDRVLOADDONE pfnLoadDone)
1557	{
1558	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, 0 /uVersion/, 0 /cbGuess/,
1559	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1560	NULL /pfnSavePrep/, NULL /pfnSaveExec/, NULL /pfnSaveDone/,
1561	NULL /pfnLoadPrep/, NULL /pfnLoadExec/, pfnLoadDone);
1562	}
1563
1564	/**
1565	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1566	*/
1567	DECLINLINE(int) PDMDrvHlpDBGFInfoRegister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1568	{
1569	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1570	}
1571
1572	/**
1573	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegisterArgv
1574	*/
1575	DECLINLINE(int) PDMDrvHlpDBGFInfoRegisterArgv(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFINFOARGVDRV pfnHandler)
1576	{
1577	return pDrvIns->pHlpR3->pfnDBGFInfoRegisterArgv(pDrvIns, pszName, pszDesc, pfnHandler);
1578	}
1579
1580	/**
1581	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1582	*/
1583	DECLINLINE(int) PDMDrvHlpDBGFInfoDeregister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1584	{
1585	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1586	}
1587
1588	/**
1589	* @copydoc PDMDRVHLPR3::pfnSTAMRegister
1590	*/
1591	DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
1592	{
1593	pDrvIns->pHlpR3->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
1594	}
1595
1596	/**
1597	* @copydoc PDMDRVHLPR3::pfnSTAMRegisterF
1598	*/
1599	DECLINLINE(void) RT_IPRT_FORMAT_ATTR(7, 8) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType,
1600	STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1601	const char pszDesc, const char pszName, ...)
1602	{
1603	va_list va;
1604	va_start(va, pszName);
1605	pDrvIns->pHlpR3->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1606	va_end(va);
1607	}
1608
1609	/**
1610	* Convenience wrapper that registers counter which is always visible.
1611	*
1612	* @param pDrvIns The driver instance.
1613	* @param pCounter Pointer to the counter variable.
1614	* @param pszName The name of the sample. This is prefixed with
1615	* "/Drivers/<drivername>-<instance no>/".
1616	* @param enmUnit The unit.
1617	* @param pszDesc The description.
1618	*/
1619	DECLINLINE(void) PDMDrvHlpSTAMRegCounterEx(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1620	{
1621	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pCounter, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1622	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1623	}
1624
1625	/**
1626	* Convenience wrapper that registers counter which is always visible and has
1627	* the STAMUNIT_COUNT unit.
1628	*
1629	* @param pDrvIns The driver instance.
1630	* @param pCounter Pointer to the counter variable.
1631	* @param pszName The name of the sample. This is prefixed with
1632	* "/Drivers/<drivername>-<instance no>/".
1633	* @param pszDesc The description.
1634	*/
1635	DECLINLINE(void) PDMDrvHlpSTAMRegCounter(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, const char pszDesc)
1636	{
1637	PDMDrvHlpSTAMRegCounterEx(pDrvIns, pCounter, pszName, STAMUNIT_COUNT, pszDesc);
1638	}
1639
1640	/**
1641	* Convenience wrapper that registers profiling sample which is always visible.
1642	*
1643	* @param pDrvIns The driver instance.
1644	* @param pProfile Pointer to the profiling variable.
1645	* @param pszName The name of the sample. This is prefixed with
1646	* "/Drivers/<drivername>-<instance no>/".
1647	* @param enmUnit The unit.
1648	* @param pszDesc The description.
1649	*/
1650	DECLINLINE(void) PDMDrvHlpSTAMRegProfileEx(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1651	{
1652	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1653	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1654	}
1655
1656	/**
1657	* Convenience wrapper that registers profiling sample which is always visible
1658	* hand counts ticks per call (STAMUNIT_TICKS_PER_CALL).
1659	*
1660	* @param pDrvIns The driver instance.
1661	* @param pProfile Pointer to the profiling variable.
1662	* @param pszName The name of the sample. This is prefixed with
1663	* "/Drivers/<drivername>-<instance no>/".
1664	* @param pszDesc The description.
1665	*/
1666	DECLINLINE(void) PDMDrvHlpSTAMRegProfile(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, const char pszDesc)
1667	{
1668	PDMDrvHlpSTAMRegProfileEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1669	}
1670
1671	/**
1672	* Convenience wrapper that registers an advanced profiling sample which is
1673	* always visible.
1674	*
1675	* @param pDrvIns The driver instance.
1676	* @param pProfile Pointer to the profiling variable.
1677	* @param enmUnit The unit.
1678	* @param pszName The name of the sample. This is prefixed with
1679	* "/Drivers/<drivername>-<instance no>/".
1680	* @param pszDesc The description.
1681	*/
1682	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdvEx(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1683	{
1684	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1685	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1686	}
1687
1688	/**
1689	* Convenience wrapper that registers an advanced profiling sample which is
1690	* always visible.
1691	*
1692	* @param pDrvIns The driver instance.
1693	* @param pProfile Pointer to the profiling variable.
1694	* @param pszName The name of the sample. This is prefixed with
1695	* "/Drivers/<drivername>-<instance no>/".
1696	* @param pszDesc The description.
1697	*/
1698	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdv(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, const char pszDesc)
1699	{
1700	PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1701	}
1702
1703	/**
1704	* @copydoc PDMDRVHLPR3::pfnSTAMDeregister
1705	*/
1706	DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1707	{
1708	return pDrvIns->pHlpR3->pfnSTAMDeregister(pDrvIns, pvSample);
1709	}
1710
1711	/**
1712	* @copydoc PDMDRVHLPR3::pfnSTAMDeregisterByPrefix
1713	*/
1714	DECLINLINE(int) PDMDrvHlpSTAMDeregisterByPrefix(PPDMDRVINS pDrvIns, const char *pszPrefix)
1715	{
1716	return pDrvIns->pHlpR3->pfnSTAMDeregisterByPrefix(pDrvIns, pszPrefix);
1717	}
1718
1719	/**
1720	* @copydoc PDMDRVHLPR3::pfnSUPCallVMMR0Ex
1721	*/
1722	DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1723	{
1724	return pDrvIns->pHlpR3->pfnSUPCallVMMR0Ex(pDrvIns, uOperation, pvArg, cbArg);
1725	}
1726
1727	/**
1728	* @copydoc PDMDRVHLPR3::pfnUSBRegisterHub
1729	*/
1730	DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1731	{
1732	return pDrvIns->pHlpR3->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1733	}
1734
1735	/**
1736	* @copydoc PDMDRVHLPR3::pfnSetAsyncNotification
1737	*/
1738	DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1739	{
1740	return pDrvIns->pHlpR3->pfnSetAsyncNotification(pDrvIns, pfnAsyncNotify);
1741	}
1742
1743	/**
1744	* @copydoc PDMDRVHLPR3::pfnAsyncNotificationCompleted
1745	*/
1746	DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1747	{
1748	pDrvIns->pHlpR3->pfnAsyncNotificationCompleted(pDrvIns);
1749	}
1750
1751	/**
1752	* @copydoc PDMDRVHLPR3::pfnThreadCreate
1753	*/
1754	DECLINLINE(int) PDMDrvHlpThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1755	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1756	{
1757	return pDrvIns->pHlpR3->pfnThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1758	}
1759
1760	# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1761	/**
1762	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateCreate
1763	*/
1764	DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1765	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void pvTemplateUser, const char pszDesc)
1766	{
1767	return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1768	}
1769	# endif
1770
1771	#endif /* IN_RING3 */
1772
1773	#ifdef VBOX_WITH_NETSHAPER
1774	# ifdef IN_RING3
1775
1776	/**
1777	* @copydoc PDMDRVHLPR3::pfnNetShaperAttach
1778	*/
1779	DECLINLINE(int) PDMDrvHlpNetShaperAttach(PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter)
1780	{
1781	return pDrvIns->pHlpR3->pfnNetShaperAttach(pDrvIns, pcszBwGroup, pFilter);
1782	}
1783
1784	/**
1785	* @copydoc PDMDRVHLPR3::pfnNetShaperDetach
1786	*/
1787	DECLINLINE(int) PDMDrvHlpNetShaperDetach(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
1788	{
1789	return pDrvIns->pHlpR3->pfnNetShaperDetach(pDrvIns, pFilter);
1790	}
1791
1792	# endif /* IN_RING3 */
1793
1794	/**
1795	* @copydoc PDMDRVHLPR3::pfnNetShaperAllocateBandwidth
1796	*/
1797	DECLINLINE(bool) PDMDrvHlpNetShaperAllocateBandwidth(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter, size_t cbTransfer)
1798	{
1799	return pDrvIns->CTX_SUFF(pHlp)->pfnNetShaperAllocateBandwidth(pDrvIns, pFilter, cbTransfer);
1800	}
1801
1802	#endif /* VBOX_WITH_NETSHAPER*/
1803
1804	#ifdef IN_RING3
1805	/**
1806	* @copydoc PDMDRVHLPR3::pfnCritSectInit
1807	*/
1808	DECLINLINE(int) PDMDrvHlpCritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName)
1809	{
1810	return pDrvIns->pHlpR3->pfnCritSectInit(pDrvIns, pCritSect, RT_SRC_POS_ARGS, pszName);
1811	}
1812	#endif /* IN_RING3 */
1813
1814	/**
1815	* @see PDMCritSectEnter
1816	*/
1817	DECLINLINE(int) PDMDrvHlpCritSectEnter(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy)
1818	{
1819	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectEnter(pDrvIns, pCritSect, rcBusy);
1820	}
1821
1822	/**
1823	* @see PDMCritSectEnterDebug
1824	*/
1825	DECLINLINE(int) PDMDrvHlpCritSectEnterDebug(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, int rcBusy, RTHCUINTPTR uId, RT_SRC_POS_DECL)
1826	{
1827	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectEnterDebug(pDrvIns, pCritSect, rcBusy, uId, RT_SRC_POS_ARGS);
1828	}
1829
1830	/**
1831	* @see PDMCritSectTryEnter
1832	*/
1833	DECLINLINE(int) PDMDrvHlpCritSectTryEnter(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
1834	{
1835	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectTryEnter(pDrvIns, pCritSect);
1836	}
1837
1838	/**
1839	* @see PDMCritSectTryEnterDebug
1840	*/
1841	DECLINLINE(int) PDMDrvHlpCritSectTryEnterDebug(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RTHCUINTPTR uId, RT_SRC_POS_DECL)
1842	{
1843	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectTryEnterDebug(pDrvIns, pCritSect, uId, RT_SRC_POS_ARGS);
1844	}
1845
1846	/**
1847	* @see PDMCritSectLeave
1848	*/
1849	DECLINLINE(int) PDMDrvHlpCritSectLeave(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
1850	{
1851	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectLeave(pDrvIns, pCritSect);
1852	}
1853
1854	/**
1855	* @see PDMCritSectIsOwner
1856	*/
1857	DECLINLINE(bool) PDMDrvHlpCritSectIsOwner(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
1858	{
1859	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectIsOwner(pDrvIns, pCritSect);
1860	}
1861
1862	/**
1863	* @see PDMCritSectIsInitialized
1864	*/
1865	DECLINLINE(bool) PDMDrvHlpCritSectIsInitialized(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
1866	{
1867	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectIsInitialized(pDrvIns, pCritSect);
1868	}
1869
1870	/**
1871	* @see PDMCritSectHasWaiters
1872	*/
1873	DECLINLINE(bool) PDMDrvHlpCritSectHasWaiters(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
1874	{
1875	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectHasWaiters(pDrvIns, pCritSect);
1876	}
1877
1878	/**
1879	* @see PDMCritSectGetRecursion
1880	*/
1881	DECLINLINE(uint32_t) PDMDrvHlpCritSectGetRecursion(PPDMDRVINS pDrvIns, PCPDMCRITSECT pCritSect)
1882	{
1883	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectGetRecursion(pDrvIns, pCritSect);
1884	}
1885
1886	#if defined(IN_RING3) \|\| defined(IN_RING0)
1887	/**
1888	* @see PDMHCCritSectScheduleExitEvent
1889	*/
1890	DECLINLINE(int) PDMDrvHlpCritSectScheduleExitEvent(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, SUPSEMEVENT hEventToSignal)
1891	{
1892	return pDrvIns->CTX_SUFF(pHlp)->pfnCritSectScheduleExitEvent(pDrvIns, pCritSect, hEventToSignal);
1893	}
1894	#endif
1895
1896	/* Strict build: Remap the two enter calls to the debug versions. */
1897	#ifdef VBOX_STRICT
1898	# ifdef IPRT_INCLUDED_asm_h
1899	# define PDMDrvHlpCritSectEnter(pDrvIns, pCritSect, rcBusy) PDMDrvHlpCritSectEnterDebug((pDrvIns), (pCritSect), (rcBusy), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
1900	# define PDMDrvHlpCritSectTryEnter(pDrvIns, pCritSect) PDMDrvHlpCritSectTryEnterDebug((pDrvIns), (pCritSect), (uintptr_t)ASMReturnAddress(), RT_SRC_POS)
1901	# else
1902	# define PDMDrvHlpCritSectEnter(pDrvIns, pCritSect, rcBusy) PDMDrvHlpCritSectEnterDebug((pDrvIns), (pCritSect), (rcBusy), 0, RT_SRC_POS)
1903	# define PDMDrvHlpCritSectTryEnter(pDrvIns, pCritSect) PDMDrvHlpCritSectTryEnterDebug((pDrvIns), (pCritSect), 0, RT_SRC_POS)
1904	# endif
1905	#endif
1906
1907	#if defined(IN_RING3) \|\| defined(DOXYGEN_RUNNING)
1908
1909	/**
1910	* @see PDMR3CritSectDelete
1911	*/
1912	DECLINLINE(int) PDMDrvHlpCritSectDelete(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect)
1913	{
1914	return pDrvIns->pHlpR3->pfnCritSectDelete(pDrvIns, pCritSect);
1915	}
1916
1917	/**
1918	* @copydoc PDMDRVHLPR3::pfnCallR0
1919	*/
1920	DECLINLINE(int) PDMDrvHlpCallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
1921	{
1922	return pDrvIns->pHlpR3->pfnCallR0(pDrvIns, uOperation, u64Arg);
1923	}
1924
1925	/**
1926	* @copydoc PDMDRVHLPR3::pfnBlkCacheRetain
1927	*/
1928	DECLINLINE(int) PDMDrvHlpBlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1929	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1930	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1931	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1932	const char *pcszId)
1933	{
1934	return pDrvIns->pHlpR3->pfnBlkCacheRetain(pDrvIns, ppBlkCache, pfnXferComplete, pfnXferEnqueue, pfnXferEnqueueDiscard, pcszId);
1935	}
1936
1937	/**
1938	* @copydoc PDMDRVHLPR3::pfnVMGetSuspendReason
1939	*/
1940	DECLINLINE(VMSUSPENDREASON) PDMDrvHlpVMGetSuspendReason(PPDMDRVINS pDrvIns)
1941	{
1942	return pDrvIns->pHlpR3->pfnVMGetSuspendReason(pDrvIns);
1943	}
1944
1945	/**
1946	* @copydoc PDMDRVHLPR3::pfnVMGetResumeReason
1947	*/
1948	DECLINLINE(VMRESUMEREASON) PDMDrvHlpVMGetResumeReason(PPDMDRVINS pDrvIns)
1949	{
1950	return pDrvIns->pHlpR3->pfnVMGetResumeReason(pDrvIns);
1951	}
1952
1953	/**
1954	* @copydoc PDMDRVHLPR3::pfnQueryGenericUserObject
1955	*/
1956	DECLINLINE(void *) PDMDrvHlpQueryGenericUserObject(PPDMDRVINS pDrvIns, PCRTUUID pUuid)
1957	{
1958	return pDrvIns->pHlpR3->pfnQueryGenericUserObject(pDrvIns, pUuid);
1959	}
1960
1961
1962	/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
1963	typedef struct PDMDRVREGCB *PPDMDRVREGCB;
1964	/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
1965	typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
1966
1967	/**
1968	* Callbacks for VBoxDriverRegister().
1969	*/
1970	typedef struct PDMDRVREGCB
1971	{
1972	/** Interface version.
1973	* This is set to PDM_DRVREG_CB_VERSION. */
1974	uint32_t u32Version;
1975
1976	/**
1977	* Registers a driver with the current VM instance.
1978	*
1979	* @returns VBox status code.
1980	* @param pCallbacks Pointer to the callback table.
1981	* @param pReg Pointer to the driver registration record.
1982	* This data must be permanent and readonly.
1983	*/
1984	DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg));
1985	} PDMDRVREGCB;
1986
1987	/** Current version of the PDMDRVREGCB structure. */
1988	#define PDM_DRVREG_CB_VERSION PDM_VERSION_MAKE(0xf0fa, 1, 0)
1989
1990
1991	/**
1992	* The VBoxDriverRegister callback function.
1993	*
1994	* PDM will invoke this function after loading a driver module and letting
1995	* the module decide which drivers to register and how to handle conflicts.
1996	*
1997	* @returns VBox status code.
1998	* @param pCallbacks Pointer to the callback table.
1999	* @param u32Version VBox version number.
2000	*/
2001	typedef DECLCALLBACKTYPE(int, FNPDMVBOXDRIVERSREGISTER,(PCPDMDRVREGCB pCallbacks, uint32_t u32Version));
2002
2003	VMMR3DECL(int) PDMR3DrvStaticRegistration(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
2004
2005	#endif /* IN_RING3 */
2006
2007	/** @} */
2008
2009	RT_C_DECLS_END
2010
2011	#endif /* !VBOX_INCLUDED_vmm_pdmdrv_h */

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

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

Download in other formats: