pdmdrv.h@ 76398

Last change on this file since 76398 was 73097, checked in by vboxsync, 6 years ago
*: Made RT_UOFFSETOF, RT_OFFSETOF, RT_UOFFSETOF_ADD and RT_OFFSETOF_ADD work like builtin_offsetof() and require compile time resolvable requests, adding RT_UOFFSETOF_DYN for the dynamic questions that can only be answered at runtime.
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 73.9 KB

Line
1	/** @file
2	* PDM - Pluggable Device Manager, Drivers.
3	*/
4
5	/*
6	* Copyright (C) 2006-2017 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___VBox_vmm_pdmdrv_h
27	#define ___VBox_vmm_pdmdrv_h
28
29	#include <VBox/vmm/pdmqueue.h>
30	#include <VBox/vmm/pdmcritsect.h>
31	#include <VBox/vmm/pdmthread.h>
32	#include <VBox/vmm/pdmifs.h>
33	#include <VBox/vmm/pdmins.h>
34	#include <VBox/vmm/pdmcommon.h>
35	#include <VBox/vmm/pdmasynccompletion.h>
36	#ifdef VBOX_WITH_NETSHAPER
37	#include <VBox/vmm/pdmnetshaper.h>
38	#endif /* VBOX_WITH_NETSHAPER */
39	#include <VBox/vmm/pdmblkcache.h>
40	#include <VBox/vmm/tm.h>
41	#include <VBox/vmm/ssm.h>
42	#include <VBox/vmm/cfgm.h>
43	#include <VBox/vmm/dbgf.h>
44	#include <VBox/vmm/mm.h>
45	#include <VBox/vmm/ftm.h>
46	#include <VBox/err.h>
47	#include <iprt/stdarg.h>
48
49
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 DECLCALLBACK(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 DECLCALLBACK(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 DECLCALLBACK(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 DECLCALLBACK(int) FNPDMDRVIOCTL(PPDMDRVINS pDrvIns, uint32_t uFunction,
130	void *pvIn, uint32_t cbIn,
131	void pvOut, uint32_t cbOut, uint32_t pcbOut);
132	/** Pointer to a FNPDMDRVIOCTL() function. */
133	typedef FNPDMDRVIOCTL *PFNPDMDRVIOCTL;
134
135	/**
136	* Power On notification.
137	*
138	* @param pDrvIns The driver instance data.
139	*/
140	typedef DECLCALLBACK(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 DECLCALLBACK(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 DECLCALLBACK(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 DECLCALLBACK(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 DECLCALLBACK(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 DECLCALLBACK(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 DECLCALLBACK(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	* Set the VM error message
575	*
576	* @returns rc.
577	* @param pDrvIns Driver instance.
578	* @param rc VBox status code.
579	* @param SRC_POS Use RT_SRC_POS.
580	* @param pszFormat Error message format string.
581	* @param ... Error message arguments.
582	*/
583	DECLRCCALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
584	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(6, 7));
585
586	/**
587	* Set the VM error message
588	*
589	* @returns rc.
590	* @param pDrvIns Driver instance.
591	* @param rc VBox status code.
592	* @param SRC_POS Use RT_SRC_POS.
593	* @param pszFormat Error message format string.
594	* @param va Error message arguments.
595	*/
596	DECLRCCALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
597	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
598
599	/**
600	* Set the VM runtime error message
601	*
602	* @returns VBox status code.
603	* @param pDrvIns Driver instance.
604	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
605	* @param pszErrorId Error ID string.
606	* @param pszFormat Error message format string.
607	* @param ... Error message arguments.
608	*/
609	DECLRCCALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
610	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5));
611
612	/**
613	* Set the VM runtime error message
614	*
615	* @returns VBox status code.
616	* @param pDrvIns Driver instance.
617	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
618	* @param pszErrorId Error ID string.
619	* @param pszFormat Error message format string.
620	* @param va Error message arguments.
621	*/
622	DECLRCCALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
623	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0));
624
625	/**
626	* Assert that the current thread is the emulation thread.
627	*
628	* @returns True if correct.
629	* @returns False if wrong.
630	* @param pDrvIns Driver instance.
631	* @param pszFile Filename of the assertion location.
632	* @param iLine Linenumber of the assertion location.
633	* @param pszFunction Function of the assertion location.
634	*/
635	DECLRCCALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
636
637	/**
638	* Assert that the current thread is NOT the emulation thread.
639	*
640	* @returns True if correct.
641	* @returns False if wrong.
642	* @param pDrvIns Driver instance.
643	* @param pszFile Filename of the assertion location.
644	* @param iLine Linenumber of the assertion location.
645	* @param pszFunction Function of the assertion location.
646	*/
647	DECLRCCALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
648
649	/**
650	* Notify FTM about a checkpoint occurrence
651	*
652	* @param pDrvIns The driver instance.
653	* @param enmType Checkpoint type
654	* @thread Any
655	*/
656	DECLRCCALLBACKMEMBER(int, pfnFTSetCheckpoint,(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType));
657
658	/** Just a safety precaution. */
659	uint32_t u32TheEnd;
660	} PDMDRVHLPRC;
661	/** Current PDMDRVHLPRC version number. */
662	#define PDM_DRVHLPRC_VERSION PDM_VERSION_MAKE(0xf0f9, 2, 0)
663
664
665	/**
666	* PDM Driver API, ring-0 context.
667	*/
668	typedef struct PDMDRVHLPR0
669	{
670	/** Structure version. PDM_DRVHLPR0_VERSION defines the current version. */
671	uint32_t u32Version;
672
673	/**
674	* Set the VM error message
675	*
676	* @returns rc.
677	* @param pDrvIns Driver instance.
678	* @param rc VBox status code.
679	* @param SRC_POS Use RT_SRC_POS.
680	* @param pszFormat Error message format string.
681	* @param ... Error message arguments.
682	*/
683	DECLR0CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
684	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(6, 7));
685
686	/**
687	* Set the VM error message
688	*
689	* @returns rc.
690	* @param pDrvIns Driver instance.
691	* @param rc VBox status code.
692	* @param SRC_POS Use RT_SRC_POS.
693	* @param pszFormat Error message format string.
694	* @param va Error message arguments.
695	*/
696	DECLR0CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
697	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
698
699	/**
700	* Set the VM runtime error message
701	*
702	* @returns VBox status code.
703	* @param pDrvIns Driver instance.
704	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
705	* @param pszErrorId Error ID string.
706	* @param pszFormat Error message format string.
707	* @param ... Error message arguments.
708	*/
709	DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
710	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5));
711
712	/**
713	* Set the VM runtime error message
714	*
715	* @returns VBox status code.
716	* @param pDrvIns Driver instance.
717	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
718	* @param pszErrorId Error ID string.
719	* @param pszFormat Error message format string.
720	* @param va Error message arguments.
721	*/
722	DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
723	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0));
724
725	/**
726	* Assert that the current thread is the emulation thread.
727	*
728	* @returns True if correct.
729	* @returns False if wrong.
730	* @param pDrvIns Driver instance.
731	* @param pszFile Filename of the assertion location.
732	* @param iLine Linenumber of the assertion location.
733	* @param pszFunction Function of the assertion location.
734	*/
735	DECLR0CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
736
737	/**
738	* Assert that the current thread is NOT the emulation thread.
739	*
740	* @returns True if correct.
741	* @returns False if wrong.
742	* @param pDrvIns Driver instance.
743	* @param pszFile Filename of the assertion location.
744	* @param iLine Linenumber of the assertion location.
745	* @param pszFunction Function of the assertion location.
746	*/
747	DECLR0CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
748
749	/**
750	* Notify FTM about a checkpoint occurrence
751	*
752	* @param pDrvIns The driver instance.
753	* @param enmType Checkpoint type
754	* @thread Any
755	*/
756	DECLR0CALLBACKMEMBER(int, pfnFTSetCheckpoint,(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType));
757
758	/** Just a safety precaution. */
759	uint32_t u32TheEnd;
760	} PDMDRVHLPR0;
761	/** Current DRVHLP version number. */
762	#define PDM_DRVHLPR0_VERSION PDM_VERSION_MAKE(0xf0f8, 2, 0)
763
764
765	#ifdef IN_RING3
766
767	/**
768	* PDM Driver API.
769	*/
770	typedef struct PDMDRVHLPR3
771	{
772	/** Structure version. PDM_DRVHLPR3_VERSION defines the current version. */
773	uint32_t u32Version;
774
775	/**
776	* Attaches a driver (chain) to the driver.
777	*
778	* @returns VBox status code.
779	* @param pDrvIns Driver instance.
780	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
781	* @param ppBaseInterface Where to store the pointer to the base interface.
782	*/
783	DECLR3CALLBACKMEMBER(int, pfnAttach,(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface));
784
785	/**
786	* Detach the driver the drivers below us.
787	*
788	* @returns VBox status code.
789	* @param pDrvIns Driver instance.
790	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
791	*/
792	DECLR3CALLBACKMEMBER(int, pfnDetach,(PPDMDRVINS pDrvIns, uint32_t fFlags));
793
794	/**
795	* Detach the driver from the driver above it and destroy this
796	* driver and all drivers below it.
797	*
798	* @returns VBox status code.
799	* @param pDrvIns Driver instance.
800	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
801	*/
802	DECLR3CALLBACKMEMBER(int, pfnDetachSelf,(PPDMDRVINS pDrvIns, uint32_t fFlags));
803
804	/**
805	* Prepare a media mount.
806	*
807	* The driver must not have anything attached to itself
808	* when calling this function as the purpose is to set up the configuration
809	* of an future attachment.
810	*
811	* @returns VBox status code
812	* @param pDrvIns Driver instance.
813	* @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
814	* constructed a configuration which can be attached to the bottom driver.
815	* @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
816	*/
817	DECLR3CALLBACKMEMBER(int, pfnMountPrepare,(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver));
818
819	/**
820	* Assert that the current thread is the emulation thread.
821	*
822	* @returns True if correct.
823	* @returns False if wrong.
824	* @param pDrvIns Driver instance.
825	* @param pszFile Filename of the assertion location.
826	* @param iLine Linenumber of the assertion location.
827	* @param pszFunction Function of the assertion location.
828	*/
829	DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
830
831	/**
832	* Assert that the current thread is NOT the emulation thread.
833	*
834	* @returns True if correct.
835	* @returns False if wrong.
836	* @param pDrvIns Driver instance.
837	* @param pszFile Filename of the assertion location.
838	* @param iLine Linenumber of the assertion location.
839	* @param pszFunction Function of the assertion location.
840	*/
841	DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
842
843	/**
844	* Set the VM error message
845	*
846	* @returns rc.
847	* @param pDrvIns Driver instance.
848	* @param rc VBox status code.
849	* @param SRC_POS Use RT_SRC_POS.
850	* @param pszFormat Error message format string.
851	* @param ... Error message arguments.
852	*/
853	DECLR3CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
854	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(6, 7));
855
856	/**
857	* Set the VM error message
858	*
859	* @returns rc.
860	* @param pDrvIns Driver instance.
861	* @param rc VBox status code.
862	* @param SRC_POS Use RT_SRC_POS.
863	* @param pszFormat Error message format string.
864	* @param va Error message arguments.
865	*/
866	DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
867	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
868
869	/**
870	* Set the VM runtime error message
871	*
872	* @returns VBox status code.
873	* @param pDrvIns Driver instance.
874	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
875	* @param pszErrorId Error ID string.
876	* @param pszFormat Error message format string.
877	* @param ... Error message arguments.
878	*/
879	DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
880	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5));
881
882	/**
883	* Set the VM runtime error message
884	*
885	* @returns VBox status code.
886	* @param pDrvIns Driver instance.
887	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
888	* @param pszErrorId Error ID string.
889	* @param pszFormat Error message format string.
890	* @param va Error message arguments.
891	*/
892	DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
893	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0));
894
895	/**
896	* Gets the VM state.
897	*
898	* @returns VM state.
899	* @param pDrvIns The driver instance.
900	* @thread Any thread (just keep in mind that it's volatile info).
901	*/
902	DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMDRVINS pDrvIns));
903
904	/**
905	* Checks if the VM was teleported and hasn't been fully resumed yet.
906	*
907	* @returns true / false.
908	* @param pDrvIns The driver instance.
909	* @thread Any thread.
910	*/
911	DECLR3CALLBACKMEMBER(bool, pfnVMTeleportedAndNotFullyResumedYet,(PPDMDRVINS pDrvIns));
912
913	/**
914	* Gets the support driver session.
915	*
916	* This is intended for working using the semaphore API.
917	*
918	* @returns Support driver session handle.
919	* @param pDrvIns The driver instance.
920	*/
921	DECLR3CALLBACKMEMBER(PSUPDRVSESSION, pfnGetSupDrvSession,(PPDMDRVINS pDrvIns));
922
923	/**
924	* Create a queue.
925	*
926	* @returns VBox status code.
927	* @param pDrvIns Driver instance.
928	* @param cbItem Size a queue item.
929	* @param cItems Number of items in the queue.
930	* @param cMilliesInterval Number of milliseconds between polling the queue.
931	* If 0 then the emulation thread will be notified whenever an item arrives.
932	* @param pfnCallback The consumer function.
933	* @param pszName The queue base name. The instance number will be
934	* appended automatically.
935	* @param ppQueue Where to store the queue handle on success.
936	* @thread The emulation thread.
937	*/
938	DECLR3CALLBACKMEMBER(int, pfnQueueCreate,(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
939	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue));
940
941	/**
942	* Query the virtual timer frequency.
943	*
944	* @returns Frequency in Hz.
945	* @param pDrvIns Driver instance.
946	* @thread Any thread.
947	*/
948	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualFreq,(PPDMDRVINS pDrvIns));
949
950	/**
951	* Query the virtual time.
952	*
953	* @returns The current virtual time.
954	* @param pDrvIns Driver instance.
955	* @thread Any thread.
956	*/
957	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualTime,(PPDMDRVINS pDrvIns));
958
959	/**
960	* Creates a timer.
961	*
962	* @returns VBox status.
963	* @param pDrvIns Driver instance.
964	* @param enmClock The clock to use on this timer.
965	* @param pfnCallback Callback function.
966	* @param pvUser The user argument to the callback.
967	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
968	* @param pszDesc Pointer to description string which must stay around
969	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
970	* @param ppTimer Where to store the timer on success.
971	* @thread EMT
972	*/
973	DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void pvUser, uint32_t fFlags, const char pszDesc, PPTMTIMERR3 ppTimer));
974
975	/**
976	* Register a save state data unit.
977	*
978	* @returns VBox status.
979	* @param pDrvIns Driver instance.
980	* @param uVersion Data layout version number.
981	* @param cbGuess The approximate amount of data in the unit.
982	* Only for progress indicators.
983	*
984	* @param pfnLivePrep Prepare live save callback, optional.
985	* @param pfnLiveExec Execute live save callback, optional.
986	* @param pfnLiveVote Vote live save callback, optional.
987	*
988	* @param pfnSavePrep Prepare save callback, optional.
989	* @param pfnSaveExec Execute save callback, optional.
990	* @param pfnSaveDone Done save callback, optional.
991	*
992	* @param pfnLoadPrep Prepare load callback, optional.
993	* @param pfnLoadExec Execute load callback, optional.
994	* @param pfnLoadDone Done load callback, optional.
995	*/
996	DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
997	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
998	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
999	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
1000
1001	/**
1002	* Deregister a save state data unit.
1003	*
1004	* @returns VBox status.
1005	* @param pDrvIns Driver instance.
1006	* @param pszName Data unit name.
1007	* @param uInstance The instance identifier of the data unit.
1008	* This must together with the name be unique.
1009	*/
1010	DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance));
1011
1012	/**
1013	* Register an info handler with DBGF.
1014	*
1015	* @returns VBox status code.
1016	* @param pDrvIns Driver instance.
1017	* @param pszName Data unit name.
1018	* @param pszDesc The description of the info and any arguments
1019	* the handler may take.
1020	* @param pfnHandler The handler function to be called to display the
1021	* info.
1022	*/
1023	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler));
1024
1025	/**
1026	* Deregister an info handler from DBGF.
1027	*
1028	* @returns VBox status code.
1029	* @param pDrvIns Driver instance.
1030	* @param pszName Data unit name.
1031	*/
1032	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoDeregister,(PPDMDRVINS pDrvIns, const char *pszName));
1033
1034	/**
1035	* Registers a statistics sample if statistics are enabled.
1036	*
1037	* @param pDrvIns Driver instance.
1038	* @param pvSample Pointer to the sample.
1039	* @param enmType Sample type. This indicates what pvSample is pointing at.
1040	* @param pszName Sample name. The name is on this form "/<component>/<sample>".
1041	* Further nesting is possible.
1042	* @param enmUnit Sample unit.
1043	* @param pszDesc Sample description.
1044	*/
1045	DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName,
1046	STAMUNIT enmUnit, const char *pszDesc));
1047
1048	/**
1049	* Same as pfnSTAMRegister except that the name is specified in a
1050	* RTStrPrintf like fashion.
1051	*
1052	* @param pDrvIns Driver instance.
1053	* @param pvSample Pointer to the sample.
1054	* @param enmType Sample type. This indicates what pvSample is pointing at.
1055	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1056	* @param enmUnit Sample unit.
1057	* @param pszDesc Sample description.
1058	* @param pszName The sample name format string.
1059	* @param ... Arguments to the format string.
1060	*/
1061	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1062	STAMUNIT enmUnit, const char *pszDesc,
1063	const char *pszName, ...) RT_IPRT_FORMAT_ATTR(7, 8));
1064
1065	/**
1066	* Same as pfnSTAMRegister except that the name is specified in a
1067	* RTStrPrintfV like fashion.
1068	*
1069	* @param pDrvIns Driver instance.
1070	* @param pvSample Pointer to the sample.
1071	* @param enmType Sample type. This indicates what pvSample is pointing at.
1072	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1073	* @param enmUnit Sample unit.
1074	* @param pszDesc Sample description.
1075	* @param pszName The sample name format string.
1076	* @param args Arguments to the format string.
1077	*/
1078	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1079	STAMUNIT enmUnit, const char *pszDesc,
1080	const char *pszName, va_list args) RT_IPRT_FORMAT_ATTR(7, 0));
1081
1082	/**
1083	* Deregister a statistic item previously registered with pfnSTAMRegister,
1084	* pfnSTAMRegisterF or pfnSTAMRegisterV
1085	*
1086	* @returns VBox status.
1087	* @param pDrvIns Driver instance.
1088	* @param pvSample Pointer to the sample.
1089	*/
1090	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregister,(PPDMDRVINS pDrvIns, void *pvSample));
1091
1092	/**
1093	* Calls the HC R0 VMM entry point, in a safer but slower manner than
1094	* SUPR3CallVMMR0.
1095	*
1096	* When entering using this call the R0 components can call into the host kernel
1097	* (i.e. use the SUPR0 and RT APIs).
1098	*
1099	* See VMMR0Entry() for more details.
1100	*
1101	* @returns error code specific to uFunction.
1102	* @param pDrvIns The driver instance.
1103	* @param uOperation Operation to execute.
1104	* This is limited to services.
1105	* @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
1106	* @param cbArg The size of the argument. This is used to copy whatever the argument
1107	* points at into a kernel buffer to avoid problems like the user page
1108	* being invalidated while we're executing the call.
1109	*/
1110	DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
1111
1112	/**
1113	* Registers a USB HUB.
1114	*
1115	* @returns VBox status code.
1116	* @param pDrvIns The driver instance.
1117	* @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
1118	* @param cPorts The number of ports.
1119	* @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
1120	* @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
1121	*
1122	* @thread EMT.
1123	*/
1124	DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
1125
1126	/**
1127	* Set up asynchronous handling of a suspend, reset or power off notification.
1128	*
1129	* This shall only be called when getting the notification. It must be called
1130	* for each one.
1131	*
1132	* @returns VBox status code.
1133	* @param pDrvIns The driver instance.
1134	* @param pfnAsyncNotify The callback.
1135	* @thread EMT(0)
1136	*/
1137	DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
1138
1139	/**
1140	* Notify EMT(0) that the driver has completed the asynchronous notification
1141	* handling.
1142	*
1143	* This can be called at any time, spurious calls will simply be ignored.
1144	*
1145	* @param pDrvIns The driver instance.
1146	* @thread Any
1147	*/
1148	DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMDRVINS pDrvIns));
1149
1150	/**
1151	* Creates a PDM thread.
1152	*
1153	* This differs from the RTThreadCreate() API in that PDM takes care of suspending,
1154	* resuming, and destroying the thread as the VM state changes.
1155	*
1156	* @returns VBox status code.
1157	* @param pDrvIns The driver instance.
1158	* @param ppThread Where to store the thread 'handle'.
1159	* @param pvUser The user argument to the thread function.
1160	* @param pfnThread The thread function.
1161	* @param pfnWakeup The wakup callback. This is called on the EMT thread when
1162	* a state change is pending.
1163	* @param cbStack See RTThreadCreate.
1164	* @param enmType See RTThreadCreate.
1165	* @param pszName See RTThreadCreate.
1166	*/
1167	DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1168	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
1169
1170	/**
1171	* Creates an async completion template for a driver instance.
1172	*
1173	* The template is used when creating new completion tasks.
1174	*
1175	* @returns VBox status code.
1176	* @param pDrvIns The driver instance.
1177	* @param ppTemplate Where to store the template pointer on success.
1178	* @param pfnCompleted The completion callback routine.
1179	* @param pvTemplateUser Template user argument.
1180	* @param pszDesc Description.
1181	*/
1182	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1183	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1184	const char *pszDesc));
1185
1186	#ifdef VBOX_WITH_NETSHAPER
1187	/**
1188	* Attaches network filter driver to a bandwidth group.
1189	*
1190	* @returns VBox status code.
1191	* @param pDrvIns The driver instance.
1192	* @param pcszBwGroup Name of the bandwidth group to attach to.
1193	* @param pFilter Pointer to the filter we attach.
1194	*/
1195	DECLR3CALLBACKMEMBER(int, pfnNetShaperAttach,(PPDMDRVINS pDrvIns, const char *pszBwGroup,
1196	PPDMNSFILTER pFilter));
1197
1198
1199	/**
1200	* Detaches network filter driver to a bandwidth group.
1201	*
1202	* @returns VBox status code.
1203	* @param pDrvIns The driver instance.
1204	* @param pFilter Pointer to the filter we attach.
1205	*/
1206	DECLR3CALLBACKMEMBER(int, pfnNetShaperDetach,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter));
1207	#endif /* VBOX_WITH_NETSHAPER */
1208
1209
1210	/**
1211	* Resolves the symbol for a raw-mode context interface.
1212	*
1213	* @returns VBox status code.
1214	* @param pDrvIns The driver instance.
1215	* @param pvInterface The interface structure.
1216	* @param cbInterface The size of the interface structure.
1217	* @param pszSymPrefix What to prefix the symbols in the list with before
1218	* resolving them. This must start with 'drv' and
1219	* contain the driver name.
1220	* @param pszSymList List of symbols corresponding to the interface.
1221	* There is generally a there is generally a define
1222	* holding this list associated with the interface
1223	* definition (INTERFACE_SYM_LIST). For more details
1224	* see PDMR3LdrGetInterfaceSymbols.
1225	* @thread EMT
1226	*/
1227	DECLR3CALLBACKMEMBER(int, pfnLdrGetRCInterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1228	const char pszSymPrefix, const char pszSymList));
1229
1230	/**
1231	* Resolves the symbol for a ring-0 context interface.
1232	*
1233	* @returns VBox status code.
1234	* @param pDrvIns The driver instance.
1235	* @param pvInterface The interface structure.
1236	* @param cbInterface The size of the interface structure.
1237	* @param pszSymPrefix What to prefix the symbols in the list with before
1238	* resolving them. This must start with 'drv' and
1239	* contain the driver name.
1240	* @param pszSymList List of symbols corresponding to the interface.
1241	* There is generally a there is generally a define
1242	* holding this list associated with the interface
1243	* definition (INTERFACE_SYM_LIST). For more details
1244	* see PDMR3LdrGetInterfaceSymbols.
1245	* @thread EMT
1246	*/
1247	DECLR3CALLBACKMEMBER(int, pfnLdrGetR0InterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1248	const char pszSymPrefix, const char pszSymList));
1249	/**
1250	* Initializes a PDM critical section.
1251	*
1252	* The PDM critical sections are derived from the IPRT critical sections, but
1253	* works in both RC and R0 as well as R3.
1254	*
1255	* @returns VBox status code.
1256	* @param pDrvIns The driver instance.
1257	* @param pCritSect Pointer to the critical section.
1258	* @param SRC_POS Use RT_SRC_POS.
1259	* @param pszName The base name of the critical section. Will be
1260	* mangeled with the instance number. For
1261	* statistics and lock validation.
1262	* @thread EMT
1263	*/
1264	DECLR3CALLBACKMEMBER(int, pfnCritSectInit,(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName));
1265
1266	/**
1267	* Call the ring-0 request handler routine of the driver.
1268	*
1269	* For this to work, the driver must be ring-0 enabled and export a request
1270	* handler function. The name of the function must be the driver name in the
1271	* PDMDRVREG struct prefixed with 'drvR0' and suffixed with 'ReqHandler'.
1272	* The driver name will be capitalized. It shall take the exact same
1273	* arguments as this function and be declared using PDMBOTHCBDECL. See
1274	* FNPDMDRVREQHANDLERR0.
1275	*
1276	* @returns VBox status code.
1277	* @retval VERR_SYMBOL_NOT_FOUND if the driver doesn't export the required
1278	* handler function.
1279	* @retval VERR_ACCESS_DENIED if the driver isn't ring-0 capable.
1280	*
1281	* @param pDrvIns The driver instance.
1282	* @param uOperation The operation to perform.
1283	* @param u64Arg 64-bit integer argument.
1284	* @thread Any
1285	*/
1286	DECLR3CALLBACKMEMBER(int, pfnCallR0,(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg));
1287
1288	/**
1289	* Notify FTM about a checkpoint occurrence
1290	*
1291	* @param pDrvIns The driver instance.
1292	* @param enmType Checkpoint type
1293	* @thread Any
1294	*/
1295	DECLR3CALLBACKMEMBER(int, pfnFTSetCheckpoint,(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType));
1296
1297	/**
1298	* Creates a block cache for a driver driver instance.
1299	*
1300	* @returns VBox status code.
1301	* @param pDrvIns The driver instance.
1302	* @param ppBlkCache Where to store the handle to the block cache.
1303	* @param pfnXferComplete The I/O transfer complete callback.
1304	* @param pfnXferEnqueue The I/O request enqueue callback.
1305	* @param pfnXferEnqueueDiscard The discard request enqueue callback.
1306	* @param pcszId Unique ID used to identify the user.
1307	*/
1308	DECLR3CALLBACKMEMBER(int, pfnBlkCacheRetain, (PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1309	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1310	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1311	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1312	const char *pcszId));
1313	/**
1314	* Gets the reason for the most recent VM suspend.
1315	*
1316	* @returns The suspend reason. VMSUSPENDREASON_INVALID is returned if no
1317	* suspend has been made or if the pDrvIns is invalid.
1318	* @param pDrvIns The driver instance.
1319	*/
1320	DECLR3CALLBACKMEMBER(VMSUSPENDREASON, pfnVMGetSuspendReason,(PPDMDRVINS pDrvIns));
1321
1322	/**
1323	* Gets the reason for the most recent VM resume.
1324	*
1325	* @returns The resume reason. VMRESUMEREASON_INVALID is returned if no
1326	* resume has been made or if the pDrvIns is invalid.
1327	* @param pDrvIns The driver instance.
1328	*/
1329	DECLR3CALLBACKMEMBER(VMRESUMEREASON, pfnVMGetResumeReason,(PPDMDRVINS pDrvIns));
1330
1331	/** @name Space reserved for minor interface changes.
1332	* @{ */
1333	DECLR3CALLBACKMEMBER(void, pfnReserved0,(PPDMDRVINS pDrvIns));
1334	DECLR3CALLBACKMEMBER(void, pfnReserved1,(PPDMDRVINS pDrvIns));
1335	DECLR3CALLBACKMEMBER(void, pfnReserved2,(PPDMDRVINS pDrvIns));
1336	DECLR3CALLBACKMEMBER(void, pfnReserved3,(PPDMDRVINS pDrvIns));
1337	DECLR3CALLBACKMEMBER(void, pfnReserved4,(PPDMDRVINS pDrvIns));
1338	DECLR3CALLBACKMEMBER(void, pfnReserved5,(PPDMDRVINS pDrvIns));
1339	DECLR3CALLBACKMEMBER(void, pfnReserved6,(PPDMDRVINS pDrvIns));
1340	DECLR3CALLBACKMEMBER(void, pfnReserved7,(PPDMDRVINS pDrvIns));
1341	DECLR3CALLBACKMEMBER(void, pfnReserved8,(PPDMDRVINS pDrvIns));
1342	DECLR3CALLBACKMEMBER(void, pfnReserved9,(PPDMDRVINS pDrvIns));
1343	/** @} */
1344
1345	/** Just a safety precaution. */
1346	uint32_t u32TheEnd;
1347	} PDMDRVHLPR3;
1348	/** Current DRVHLP version number. */
1349	#define PDM_DRVHLPR3_VERSION PDM_VERSION_MAKE(0xf0fb, 3, 0)
1350
1351	#endif /* IN_RING3 */
1352
1353
1354	/**
1355	* @copydoc PDMDRVHLPR3::pfnVMSetError
1356	*/
1357	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 7) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1358	const char *pszFormat, ...)
1359	{
1360	va_list va;
1361	va_start(va, pszFormat);
1362	pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1363	va_end(va);
1364	return rc;
1365	}
1366
1367	/** @def PDMDRV_SET_ERROR
1368	* Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
1369	*/
1370	#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
1371	PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
1372
1373	/**
1374	* @copydoc PDMDRVHLPR3::pfnVMSetErrorV
1375	*/
1376	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 0) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1377	const char *pszFormat, va_list va)
1378	{
1379	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1380	}
1381
1382
1383	/**
1384	* @copydoc PDMDRVHLPR3::pfnVMSetRuntimeError
1385	*/
1386	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 5) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
1387	const char *pszFormat, ...)
1388	{
1389	va_list va;
1390	int rc;
1391	va_start(va, pszFormat);
1392	rc = pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1393	va_end(va);
1394	return rc;
1395	}
1396
1397	/** @def PDMDRV_SET_RUNTIME_ERROR
1398	* Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
1399	*/
1400	#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFlags, pszErrorId, pszError) \
1401	PDMDrvHlpVMSetRuntimeError(pDrvIns, fFlags, pszErrorId, "%s", pszError)
1402
1403	/**
1404	* @copydoc PDMDRVHLPR3::pfnVMSetRuntimeErrorV
1405	*/
1406	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 0) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags,
1407	const char pszErrorId, const char pszFormat, va_list va)
1408	{
1409	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1410	}
1411
1412
1413
1414	/** @def PDMDRV_ASSERT_EMT
1415	* Assert that the current thread is the emulation thread.
1416	*/
1417	#ifdef VBOX_STRICT
1418	# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1419	#else
1420	# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
1421	#endif
1422
1423	/** @def PDMDRV_ASSERT_OTHER
1424	* Assert that the current thread is NOT the emulation thread.
1425	*/
1426	#ifdef VBOX_STRICT
1427	# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1428	#else
1429	# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
1430	#endif
1431
1432	/**
1433	* @copydoc PDMDRVHLPR3::pfnFTSetCheckpoint
1434	*/
1435	DECLINLINE(int) PDMDrvHlpFTSetCheckpoint(PPDMDRVINS pDrvIns, FTMCHECKPOINTTYPE enmType)
1436	{
1437	return pDrvIns->CTX_SUFF(pHlp)->pfnFTSetCheckpoint(pDrvIns, enmType);
1438	}
1439
1440
1441	#ifdef IN_RING3
1442
1443	/**
1444	* @copydoc PDMDRVHLPR3::pfnAttach
1445	*/
1446	DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
1447	{
1448	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, fFlags, ppBaseInterface);
1449	}
1450
1451	/**
1452	* Check that there is no driver below the us that we should attach to.
1453	*
1454	* @returns VERR_PDM_NO_ATTACHED_DRIVER if there is no driver.
1455	* @param pDrvIns The driver instance.
1456	*/
1457	DECLINLINE(int) PDMDrvHlpNoAttach(PPDMDRVINS pDrvIns)
1458	{
1459	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, 0, NULL);
1460	}
1461
1462	/**
1463	* @copydoc PDMDRVHLPR3::pfnDetach
1464	*/
1465	DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1466	{
1467	return pDrvIns->pHlpR3->pfnDetach(pDrvIns, fFlags);
1468	}
1469
1470	/**
1471	* @copydoc PDMDRVHLPR3::pfnDetachSelf
1472	*/
1473	DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1474	{
1475	return pDrvIns->pHlpR3->pfnDetachSelf(pDrvIns, fFlags);
1476	}
1477
1478	/**
1479	* @copydoc PDMDRVHLPR3::pfnMountPrepare
1480	*/
1481	DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
1482	{
1483	return pDrvIns->pHlpR3->pfnMountPrepare(pDrvIns, pszFilename, pszCoreDriver);
1484	}
1485
1486	/**
1487	* @copydoc PDMDRVHLPR3::pfnVMState
1488	*/
1489	DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
1490	{
1491	return pDrvIns->CTX_SUFF(pHlp)->pfnVMState(pDrvIns);
1492	}
1493
1494	/**
1495	* @copydoc PDMDRVHLPR3::pfnVMTeleportedAndNotFullyResumedYet
1496	*/
1497	DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1498	{
1499	return pDrvIns->pHlpR3->pfnVMTeleportedAndNotFullyResumedYet(pDrvIns);
1500	}
1501
1502	/**
1503	* @copydoc PDMDRVHLPR3::pfnGetSupDrvSession
1504	*/
1505	DECLINLINE(PSUPDRVSESSION) PDMDrvHlpGetSupDrvSession(PPDMDRVINS pDrvIns)
1506	{
1507	return pDrvIns->pHlpR3->pfnGetSupDrvSession(pDrvIns);
1508	}
1509
1510	/**
1511	* @copydoc PDMDRVHLPR3::pfnQueueCreate
1512	*/
1513	DECLINLINE(int) PDMDrvHlpQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1514	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue)
1515	{
1516	return pDrvIns->pHlpR3->pfnQueueCreate(pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
1517	}
1518
1519	/**
1520	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualFreq
1521	*/
1522	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
1523	{
1524	return pDrvIns->pHlpR3->pfnTMGetVirtualFreq(pDrvIns);
1525	}
1526
1527	/**
1528	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualTime
1529	*/
1530	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
1531	{
1532	return pDrvIns->pHlpR3->pfnTMGetVirtualTime(pDrvIns);
1533	}
1534
1535	/**
1536	* @copydoc PDMDRVHLPR3::pfnTMTimerCreate
1537	*/
1538	DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void pvUser, uint32_t fFlags, const char pszDesc, PPTMTIMERR3 ppTimer)
1539	{
1540	return pDrvIns->pHlpR3->pfnTMTimerCreate(pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
1541	}
1542
1543	/**
1544	* Register a save state data unit.
1545	*
1546	* @returns VBox status.
1547	* @param pDrvIns Driver instance.
1548	* @param uVersion Data layout version number.
1549	* @param cbGuess The approximate amount of data in the unit.
1550	* Only for progress indicators.
1551	* @param pfnSaveExec Execute save callback, optional.
1552	* @param pfnLoadExec Execute load callback, optional.
1553	*/
1554	DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1555	PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVLOADEXEC pfnLoadExec)
1556	{
1557	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1558	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1559	NULL /pfnSavePrep/, pfnSaveExec, NULL /pfnSaveDone/,
1560	NULL /pfnLoadPrep/, pfnLoadExec, NULL /pfnLoadDone/);
1561	}
1562
1563	/**
1564	* @copydoc PDMDRVHLPR3::pfnSSMRegister
1565	*/
1566	DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1567	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1568	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1569	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1570	{
1571	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1572	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1573	pfnSavePrep, pfnSaveExec, pfnSaveDone,
1574	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1575	}
1576
1577	/**
1578	* Register a load done callback.
1579	*
1580	* @returns VBox status.
1581	* @param pDrvIns Driver instance.
1582	* @param pfnLoadDone Done load callback, optional.
1583	*/
1584	DECLINLINE(int) PDMDrvHlpSSMRegisterLoadDone(PPDMDRVINS pDrvIns, PFNSSMDRVLOADDONE pfnLoadDone)
1585	{
1586	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, 0 /uVersion/, 0 /cbGuess/,
1587	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1588	NULL /pfnSavePrep/, NULL /pfnSaveExec/, NULL /pfnSaveDone/,
1589	NULL /pfnLoadPrep/, NULL /pfnLoadExec/, pfnLoadDone);
1590	}
1591
1592	/**
1593	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1594	*/
1595	DECLINLINE(int) PDMDrvHlpDBGFInfoRegister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1596	{
1597	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1598	}
1599
1600	/**
1601	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1602	*/
1603	DECLINLINE(int) PDMDrvHlpDBGFInfoDeregister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1604	{
1605	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1606	}
1607
1608	/**
1609	* @copydoc PDMDRVHLPR3::pfnSTAMRegister
1610	*/
1611	DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
1612	{
1613	pDrvIns->pHlpR3->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
1614	}
1615
1616	/**
1617	* @copydoc PDMDRVHLPR3::pfnSTAMRegisterF
1618	*/
1619	DECLINLINE(void) RT_IPRT_FORMAT_ATTR(7, 8) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType,
1620	STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1621	const char pszDesc, const char pszName, ...)
1622	{
1623	va_list va;
1624	va_start(va, pszName);
1625	pDrvIns->pHlpR3->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1626	va_end(va);
1627	}
1628
1629	/**
1630	* Convenience wrapper that registers counter which is always visible.
1631	*
1632	* @param pDrvIns The driver instance.
1633	* @param pCounter Pointer to the counter variable.
1634	* @param pszName The name of the sample. This is prefixed with
1635	* "/Drivers/<drivername>-<instance no>/".
1636	* @param enmUnit The unit.
1637	* @param pszDesc The description.
1638	*/
1639	DECLINLINE(void) PDMDrvHlpSTAMRegCounterEx(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1640	{
1641	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pCounter, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1642	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1643	}
1644
1645	/**
1646	* Convenience wrapper that registers counter which is always visible and has
1647	* the STAMUNIT_COUNT unit.
1648	*
1649	* @param pDrvIns The driver instance.
1650	* @param pCounter Pointer to the counter variable.
1651	* @param pszName The name of the sample. This is prefixed with
1652	* "/Drivers/<drivername>-<instance no>/".
1653	* @param pszDesc The description.
1654	*/
1655	DECLINLINE(void) PDMDrvHlpSTAMRegCounter(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, const char pszDesc)
1656	{
1657	PDMDrvHlpSTAMRegCounterEx(pDrvIns, pCounter, pszName, STAMUNIT_COUNT, pszDesc);
1658	}
1659
1660	/**
1661	* Convenience wrapper that registers profiling sample which is always visible.
1662	*
1663	* @param pDrvIns The driver instance.
1664	* @param pProfile Pointer to the profiling variable.
1665	* @param pszName The name of the sample. This is prefixed with
1666	* "/Drivers/<drivername>-<instance no>/".
1667	* @param enmUnit The unit.
1668	* @param pszDesc The description.
1669	*/
1670	DECLINLINE(void) PDMDrvHlpSTAMRegProfileEx(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1671	{
1672	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1673	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1674	}
1675
1676	/**
1677	* Convenience wrapper that registers profiling sample which is always visible
1678	* hand counts ticks per call (STAMUNIT_TICKS_PER_CALL).
1679	*
1680	* @param pDrvIns The driver instance.
1681	* @param pProfile Pointer to the profiling variable.
1682	* @param pszName The name of the sample. This is prefixed with
1683	* "/Drivers/<drivername>-<instance no>/".
1684	* @param pszDesc The description.
1685	*/
1686	DECLINLINE(void) PDMDrvHlpSTAMRegProfile(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, const char pszDesc)
1687	{
1688	PDMDrvHlpSTAMRegProfileEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1689	}
1690
1691	/**
1692	* Convenience wrapper that registers an advanced profiling sample which is
1693	* always visible.
1694	*
1695	* @param pDrvIns The driver instance.
1696	* @param pProfile Pointer to the profiling variable.
1697	* @param enmUnit The unit.
1698	* @param pszName The name of the sample. This is prefixed with
1699	* "/Drivers/<drivername>-<instance no>/".
1700	* @param pszDesc The description.
1701	*/
1702	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdvEx(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1703	{
1704	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1705	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1706	}
1707
1708	/**
1709	* Convenience wrapper that registers an advanced profiling sample which is
1710	* always visible.
1711	*
1712	* @param pDrvIns The driver instance.
1713	* @param pProfile Pointer to the profiling variable.
1714	* @param pszName The name of the sample. This is prefixed with
1715	* "/Drivers/<drivername>-<instance no>/".
1716	* @param pszDesc The description.
1717	*/
1718	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdv(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, const char pszDesc)
1719	{
1720	PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1721	}
1722
1723	/**
1724	* @copydoc PDMDRVHLPR3::pfnSTAMDeregister
1725	*/
1726	DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1727	{
1728	return pDrvIns->pHlpR3->pfnSTAMDeregister(pDrvIns, pvSample);
1729	}
1730
1731	/**
1732	* @copydoc PDMDRVHLPR3::pfnSUPCallVMMR0Ex
1733	*/
1734	DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1735	{
1736	return pDrvIns->pHlpR3->pfnSUPCallVMMR0Ex(pDrvIns, uOperation, pvArg, cbArg);
1737	}
1738
1739	/**
1740	* @copydoc PDMDRVHLPR3::pfnUSBRegisterHub
1741	*/
1742	DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1743	{
1744	return pDrvIns->pHlpR3->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1745	}
1746
1747	/**
1748	* @copydoc PDMDRVHLPR3::pfnSetAsyncNotification
1749	*/
1750	DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1751	{
1752	return pDrvIns->pHlpR3->pfnSetAsyncNotification(pDrvIns, pfnAsyncNotify);
1753	}
1754
1755	/**
1756	* @copydoc PDMDRVHLPR3::pfnAsyncNotificationCompleted
1757	*/
1758	DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1759	{
1760	pDrvIns->pHlpR3->pfnAsyncNotificationCompleted(pDrvIns);
1761	}
1762
1763	/**
1764	* @copydoc PDMDRVHLPR3::pfnThreadCreate
1765	*/
1766	DECLINLINE(int) PDMDrvHlpThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1767	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1768	{
1769	return pDrvIns->pHlpR3->pfnThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1770	}
1771
1772	# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1773	/**
1774	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateCreate
1775	*/
1776	DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1777	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void pvTemplateUser, const char pszDesc)
1778	{
1779	return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1780	}
1781	# endif
1782
1783	# ifdef VBOX_WITH_NETSHAPER
1784	/**
1785	* @copydoc PDMDRVHLPR3::pfnNetShaperAttach
1786	*/
1787	DECLINLINE(int) PDMDrvHlpNetShaperAttach(PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter)
1788	{
1789	return pDrvIns->pHlpR3->pfnNetShaperAttach(pDrvIns, pcszBwGroup, pFilter);
1790	}
1791
1792	/**
1793	* @copydoc PDMDRVHLPR3::pfnNetShaperDetach
1794	*/
1795	DECLINLINE(int) PDMDrvHlpNetShaperDetach(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
1796	{
1797	return pDrvIns->pHlpR3->pfnNetShaperDetach(pDrvIns, pFilter);
1798	}
1799	# endif
1800
1801	/**
1802	* @copydoc PDMDRVHLPR3::pfnCritSectInit
1803	*/
1804	DECLINLINE(int) PDMDrvHlpCritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName)
1805	{
1806	return pDrvIns->pHlpR3->pfnCritSectInit(pDrvIns, pCritSect, RT_SRC_POS_ARGS, pszName);
1807	}
1808
1809	/**
1810	* @copydoc PDMDRVHLPR3::pfnCallR0
1811	*/
1812	DECLINLINE(int) PDMDrvHlpCallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
1813	{
1814	return pDrvIns->pHlpR3->pfnCallR0(pDrvIns, uOperation, u64Arg);
1815	}
1816
1817	/**
1818	* @copydoc PDMDRVHLPR3::pfnBlkCacheRetain
1819	*/
1820	DECLINLINE(int) PDMDrvHlpBlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1821	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1822	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1823	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1824	const char *pcszId)
1825	{
1826	return pDrvIns->pHlpR3->pfnBlkCacheRetain(pDrvIns, ppBlkCache, pfnXferComplete, pfnXferEnqueue, pfnXferEnqueueDiscard, pcszId);
1827	}
1828
1829	/**
1830	* @copydoc PDMDRVHLPR3::pfnVMGetSuspendReason
1831	*/
1832	DECLINLINE(VMSUSPENDREASON) PDMDrvHlpVMGetSuspendReason(PPDMDRVINS pDrvIns)
1833	{
1834	return pDrvIns->pHlpR3->pfnVMGetSuspendReason(pDrvIns);
1835	}
1836
1837	/**
1838	* @copydoc PDMDRVHLPR3::pfnVMGetResumeReason
1839	*/
1840	DECLINLINE(VMRESUMEREASON) PDMDrvHlpVMGetResumeReason(PPDMDRVINS pDrvIns)
1841	{
1842	return pDrvIns->pHlpR3->pfnVMGetResumeReason(pDrvIns);
1843	}
1844
1845
1846	/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
1847	typedef struct PDMDRVREGCB *PPDMDRVREGCB;
1848	/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
1849	typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
1850
1851	/**
1852	* Callbacks for VBoxDriverRegister().
1853	*/
1854	typedef struct PDMDRVREGCB
1855	{
1856	/** Interface version.
1857	* This is set to PDM_DRVREG_CB_VERSION. */
1858	uint32_t u32Version;
1859
1860	/**
1861	* Registers a driver with the current VM instance.
1862	*
1863	* @returns VBox status code.
1864	* @param pCallbacks Pointer to the callback table.
1865	* @param pReg Pointer to the driver registration record.
1866	* This data must be permanent and readonly.
1867	*/
1868	DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg));
1869	} PDMDRVREGCB;
1870
1871	/** Current version of the PDMDRVREGCB structure. */
1872	#define PDM_DRVREG_CB_VERSION PDM_VERSION_MAKE(0xf0fa, 1, 0)
1873
1874
1875	/**
1876	* The VBoxDriverRegister callback function.
1877	*
1878	* PDM will invoke this function after loading a driver module and letting
1879	* the module decide which drivers to register and how to handle conflicts.
1880	*
1881	* @returns VBox status code.
1882	* @param pCallbacks Pointer to the callback table.
1883	* @param u32Version VBox version number.
1884	*/
1885	typedef DECLCALLBACK(int) FNPDMVBOXDRIVERSREGISTER(PCPDMDRVREGCB pCallbacks, uint32_t u32Version);
1886
1887	VMMR3DECL(int) PDMR3DrvStaticRegistration(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
1888
1889	#endif /* IN_RING3 */
1890
1891	/** @} */
1892
1893	RT_C_DECLS_END
1894
1895	#endif

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

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

Download in other formats: