pdmdrv.h@ 89949

Last change on this file since 89949 was 89949, checked in by vboxsync, 3 years ago
VMM/PDMDriver: Add PDMDRVHLPR3::pfnQueryGenericUserObject/PDMDevHlpQueryGenericUserObject mapping to VMM2USERMETHODS::pfnQueryGenericObject, bugref:10053
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 75.9 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	* 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	/** Just a safety precaution. */
650	uint32_t u32TheEnd;
651	} PDMDRVHLPRC;
652	/** Current PDMDRVHLPRC version number. */
653	#define PDM_DRVHLPRC_VERSION PDM_VERSION_MAKE(0xf0f9, 3, 0)
654
655
656	/**
657	* PDM Driver API, ring-0 context.
658	*/
659	typedef struct PDMDRVHLPR0
660	{
661	/** Structure version. PDM_DRVHLPR0_VERSION defines the current version. */
662	uint32_t u32Version;
663
664	/**
665	* Set the VM error message
666	*
667	* @returns rc.
668	* @param pDrvIns Driver instance.
669	* @param rc VBox status code.
670	* @param SRC_POS Use RT_SRC_POS.
671	* @param pszFormat Error message format string.
672	* @param ... Error message arguments.
673	*/
674	DECLR0CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
675	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(6, 7));
676
677	/**
678	* Set the VM error message
679	*
680	* @returns rc.
681	* @param pDrvIns Driver instance.
682	* @param rc VBox status code.
683	* @param SRC_POS Use RT_SRC_POS.
684	* @param pszFormat Error message format string.
685	* @param va Error message arguments.
686	*/
687	DECLR0CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
688	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
689
690	/**
691	* Set the VM runtime error message
692	*
693	* @returns VBox status code.
694	* @param pDrvIns Driver instance.
695	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
696	* @param pszErrorId Error ID string.
697	* @param pszFormat Error message format string.
698	* @param ... Error message arguments.
699	*/
700	DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
701	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5));
702
703	/**
704	* Set the VM runtime error message
705	*
706	* @returns VBox status code.
707	* @param pDrvIns Driver instance.
708	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
709	* @param pszErrorId Error ID string.
710	* @param pszFormat Error message format string.
711	* @param va Error message arguments.
712	*/
713	DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
714	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0));
715
716	/**
717	* Assert that the current thread is the emulation thread.
718	*
719	* @returns True if correct.
720	* @returns False if wrong.
721	* @param pDrvIns Driver instance.
722	* @param pszFile Filename of the assertion location.
723	* @param iLine Linenumber of the assertion location.
724	* @param pszFunction Function of the assertion location.
725	*/
726	DECLR0CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
727
728	/**
729	* Assert that the current thread is NOT the emulation thread.
730	*
731	* @returns True if correct.
732	* @returns False if wrong.
733	* @param pDrvIns Driver instance.
734	* @param pszFile Filename of the assertion location.
735	* @param iLine Linenumber of the assertion location.
736	* @param pszFunction Function of the assertion location.
737	*/
738	DECLR0CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
739
740	/** Just a safety precaution. */
741	uint32_t u32TheEnd;
742	} PDMDRVHLPR0;
743	/** Current DRVHLP version number. */
744	#define PDM_DRVHLPR0_VERSION PDM_VERSION_MAKE(0xf0f8, 3, 0)
745
746
747	#ifdef IN_RING3
748
749	/**
750	* PDM Driver API.
751	*/
752	typedef struct PDMDRVHLPR3
753	{
754	/** Structure version. PDM_DRVHLPR3_VERSION defines the current version. */
755	uint32_t u32Version;
756
757	/**
758	* Attaches a driver (chain) to the driver.
759	*
760	* @returns VBox status code.
761	* @param pDrvIns Driver instance.
762	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
763	* @param ppBaseInterface Where to store the pointer to the base interface.
764	*/
765	DECLR3CALLBACKMEMBER(int, pfnAttach,(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface));
766
767	/**
768	* Detach the driver the drivers below us.
769	*
770	* @returns VBox status code.
771	* @param pDrvIns Driver instance.
772	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
773	*/
774	DECLR3CALLBACKMEMBER(int, pfnDetach,(PPDMDRVINS pDrvIns, uint32_t fFlags));
775
776	/**
777	* Detach the driver from the driver above it and destroy this
778	* driver and all drivers below it.
779	*
780	* @returns VBox status code.
781	* @param pDrvIns Driver instance.
782	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
783	*/
784	DECLR3CALLBACKMEMBER(int, pfnDetachSelf,(PPDMDRVINS pDrvIns, uint32_t fFlags));
785
786	/**
787	* Prepare a media mount.
788	*
789	* The driver must not have anything attached to itself
790	* when calling this function as the purpose is to set up the configuration
791	* of an future attachment.
792	*
793	* @returns VBox status code
794	* @param pDrvIns Driver instance.
795	* @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
796	* constructed a configuration which can be attached to the bottom driver.
797	* @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
798	*/
799	DECLR3CALLBACKMEMBER(int, pfnMountPrepare,(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver));
800
801	/**
802	* Assert that the current thread is the emulation thread.
803	*
804	* @returns True if correct.
805	* @returns False if wrong.
806	* @param pDrvIns Driver instance.
807	* @param pszFile Filename of the assertion location.
808	* @param iLine Linenumber of the assertion location.
809	* @param pszFunction Function of the assertion location.
810	*/
811	DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
812
813	/**
814	* Assert that the current thread is NOT the emulation thread.
815	*
816	* @returns True if correct.
817	* @returns False if wrong.
818	* @param pDrvIns Driver instance.
819	* @param pszFile Filename of the assertion location.
820	* @param iLine Linenumber of the assertion location.
821	* @param pszFunction Function of the assertion location.
822	*/
823	DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
824
825	/**
826	* Set the VM error message
827	*
828	* @returns rc.
829	* @param pDrvIns Driver instance.
830	* @param rc VBox status code.
831	* @param SRC_POS Use RT_SRC_POS.
832	* @param pszFormat Error message format string.
833	* @param ... Error message arguments.
834	*/
835	DECLR3CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
836	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(6, 7));
837
838	/**
839	* Set the VM error message
840	*
841	* @returns rc.
842	* @param pDrvIns Driver instance.
843	* @param rc VBox status code.
844	* @param SRC_POS Use RT_SRC_POS.
845	* @param pszFormat Error message format string.
846	* @param va Error message arguments.
847	*/
848	DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL,
849	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(6, 0));
850
851	/**
852	* Set the VM runtime error message
853	*
854	* @returns VBox status code.
855	* @param pDrvIns Driver instance.
856	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
857	* @param pszErrorId Error ID string.
858	* @param pszFormat Error message format string.
859	* @param ... Error message arguments.
860	*/
861	DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
862	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5));
863
864	/**
865	* Set the VM runtime error message
866	*
867	* @returns VBox status code.
868	* @param pDrvIns Driver instance.
869	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
870	* @param pszErrorId Error ID string.
871	* @param pszFormat Error message format string.
872	* @param va Error message arguments.
873	*/
874	DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
875	const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(4, 0));
876
877	/**
878	* Gets the VM state.
879	*
880	* @returns VM state.
881	* @param pDrvIns The driver instance.
882	* @thread Any thread (just keep in mind that it's volatile info).
883	*/
884	DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMDRVINS pDrvIns));
885
886	/**
887	* Checks if the VM was teleported and hasn't been fully resumed yet.
888	*
889	* @returns true / false.
890	* @param pDrvIns The driver instance.
891	* @thread Any thread.
892	*/
893	DECLR3CALLBACKMEMBER(bool, pfnVMTeleportedAndNotFullyResumedYet,(PPDMDRVINS pDrvIns));
894
895	/**
896	* Gets the support driver session.
897	*
898	* This is intended for working using the semaphore API.
899	*
900	* @returns Support driver session handle.
901	* @param pDrvIns The driver instance.
902	*/
903	DECLR3CALLBACKMEMBER(PSUPDRVSESSION, pfnGetSupDrvSession,(PPDMDRVINS pDrvIns));
904
905	/**
906	* Create a queue.
907	*
908	* @returns VBox status code.
909	* @param pDrvIns Driver instance.
910	* @param cbItem Size a queue item.
911	* @param cItems Number of items in the queue.
912	* @param cMilliesInterval Number of milliseconds between polling the queue.
913	* If 0 then the emulation thread will be notified whenever an item arrives.
914	* @param pfnCallback The consumer function.
915	* @param pszName The queue base name. The instance number will be
916	* appended automatically.
917	* @param ppQueue Where to store the queue handle on success.
918	* @thread The emulation thread.
919	*/
920	DECLR3CALLBACKMEMBER(int, pfnQueueCreate,(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
921	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue));
922
923	/**
924	* Query the virtual timer frequency.
925	*
926	* @returns Frequency in Hz.
927	* @param pDrvIns Driver instance.
928	* @thread Any thread.
929	*/
930	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualFreq,(PPDMDRVINS pDrvIns));
931
932	/**
933	* Query the virtual time.
934	*
935	* @returns The current virtual time.
936	* @param pDrvIns Driver instance.
937	* @thread Any thread.
938	*/
939	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualTime,(PPDMDRVINS pDrvIns));
940
941	/**
942	* Creates a timer.
943	*
944	* @returns VBox status.
945	* @param pDrvIns Driver instance.
946	* @param enmClock The clock to use on this timer.
947	* @param pfnCallback Callback function.
948	* @param pvUser The user argument to the callback.
949	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
950	* @param pszDesc Pointer to description string which must stay around
951	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
952	* @param phTimer Where to store the timer handle on success.
953	* @thread EMT
954	*
955	* @todo Need to add a bunch of timer helpers for this to be useful again.
956	* Will do when required.
957	*/
958	DECLR3CALLBACKMEMBER(int, pfnTimerCreate,(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
959	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer));
960
961	/**
962	* Register a save state data unit.
963	*
964	* @returns VBox status.
965	* @param pDrvIns Driver instance.
966	* @param uVersion Data layout version number.
967	* @param cbGuess The approximate amount of data in the unit.
968	* Only for progress indicators.
969	*
970	* @param pfnLivePrep Prepare live save callback, optional.
971	* @param pfnLiveExec Execute live save callback, optional.
972	* @param pfnLiveVote Vote live save callback, optional.
973	*
974	* @param pfnSavePrep Prepare save callback, optional.
975	* @param pfnSaveExec Execute save callback, optional.
976	* @param pfnSaveDone Done save callback, optional.
977	*
978	* @param pfnLoadPrep Prepare load callback, optional.
979	* @param pfnLoadExec Execute load callback, optional.
980	* @param pfnLoadDone Done load callback, optional.
981	*/
982	DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
983	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
984	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
985	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
986
987	/**
988	* Deregister a save state data unit.
989	*
990	* @returns VBox status.
991	* @param pDrvIns Driver instance.
992	* @param pszName Data unit name.
993	* @param uInstance The instance identifier of the data unit.
994	* This must together with the name be unique.
995	*/
996	DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance));
997
998	/**
999	* Register an info handler with DBGF.
1000	*
1001	* @returns VBox status code.
1002	* @param pDrvIns Driver instance.
1003	* @param pszName Data unit name.
1004	* @param pszDesc The description of the info and any arguments
1005	* the handler may take.
1006	* @param pfnHandler The handler function to be called to display the
1007	* info.
1008	*/
1009	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler));
1010
1011	/**
1012	* Register an info handler with DBGF, argv style.
1013	*
1014	* @returns VBox status code.
1015	* @param pDrvIns Driver instance.
1016	* @param pszName Data unit name.
1017	* @param pszDesc The description of the info and any arguments
1018	* the handler may take.
1019	* @param pfnHandler The handler function to be called to display the
1020	* info.
1021	*/
1022	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegisterArgv,(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFINFOARGVDRV pfnHandler));
1023
1024	/**
1025	* Deregister an info handler from DBGF.
1026	*
1027	* @returns VBox status code.
1028	* @param pDrvIns Driver instance.
1029	* @param pszName Data unit name.
1030	*/
1031	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoDeregister,(PPDMDRVINS pDrvIns, const char *pszName));
1032
1033	/**
1034	* Registers a statistics sample if statistics are enabled.
1035	*
1036	* @param pDrvIns Driver instance.
1037	* @param pvSample Pointer to the sample.
1038	* @param enmType Sample type. This indicates what pvSample is pointing at.
1039	* @param pszName Sample name. The name is on this form "/<component>/<sample>".
1040	* Further nesting is possible. If this does not start
1041	* with a '/', the default prefix will be prepended,
1042	* otherwise it will be used as-is.
1043	* @param enmUnit Sample unit.
1044	* @param pszDesc Sample description.
1045	*/
1046	DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName,
1047	STAMUNIT enmUnit, const char *pszDesc));
1048
1049	/**
1050	* Same as pfnSTAMRegister except that the name is specified in a
1051	* RTStrPrintf like fashion.
1052	*
1053	* @param pDrvIns Driver instance.
1054	* @param pvSample Pointer to the sample.
1055	* @param enmType Sample type. This indicates what pvSample is pointing at.
1056	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1057	* @param enmUnit Sample unit.
1058	* @param pszDesc Sample description.
1059	* @param pszName The sample name format string. If this does not start
1060	* with a '/', the default prefix will be prepended,
1061	* otherwise it will be used as-is.
1062	* @param ... Arguments to the format string.
1063	*/
1064	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1065	STAMUNIT enmUnit, const char *pszDesc,
1066	const char *pszName, ...) RT_IPRT_FORMAT_ATTR(7, 8));
1067
1068	/**
1069	* Same as pfnSTAMRegister except that the name is specified in a
1070	* RTStrPrintfV like fashion.
1071	*
1072	* @param pDrvIns Driver instance.
1073	* @param pvSample Pointer to the sample.
1074	* @param enmType Sample type. This indicates what pvSample is pointing at.
1075	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
1076	* @param enmUnit Sample unit.
1077	* @param pszDesc Sample description.
1078	* @param pszName The sample name format string. If this does not
1079	* start with a '/', the default prefix will be prepended,
1080	* otherwise it will be used as-is.
1081	* @param args Arguments to the format string.
1082	*/
1083	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
1084	STAMUNIT enmUnit, const char *pszDesc,
1085	const char *pszName, va_list args) RT_IPRT_FORMAT_ATTR(7, 0));
1086
1087	/**
1088	* Deregister a statistic item previously registered with pfnSTAMRegister,
1089	* pfnSTAMRegisterF or pfnSTAMRegisterV
1090	*
1091	* @returns VBox status.
1092	* @param pDrvIns Driver instance.
1093	* @param pvSample Pointer to the sample.
1094	*/
1095	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregister,(PPDMDRVINS pDrvIns, void *pvSample));
1096
1097	/**
1098	* Calls the HC R0 VMM entry point, in a safer but slower manner than
1099	* SUPR3CallVMMR0.
1100	*
1101	* When entering using this call the R0 components can call into the host kernel
1102	* (i.e. use the SUPR0 and RT APIs).
1103	*
1104	* See VMMR0Entry() for more details.
1105	*
1106	* @returns error code specific to uFunction.
1107	* @param pDrvIns The driver instance.
1108	* @param uOperation Operation to execute.
1109	* This is limited to services.
1110	* @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
1111	* @param cbArg The size of the argument. This is used to copy whatever the argument
1112	* points at into a kernel buffer to avoid problems like the user page
1113	* being invalidated while we're executing the call.
1114	*/
1115	DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
1116
1117	/**
1118	* Registers a USB HUB.
1119	*
1120	* @returns VBox status code.
1121	* @param pDrvIns The driver instance.
1122	* @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
1123	* @param cPorts The number of ports.
1124	* @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
1125	* @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
1126	*
1127	* @thread EMT.
1128	*/
1129	DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
1130
1131	/**
1132	* Set up asynchronous handling of a suspend, reset or power off notification.
1133	*
1134	* This shall only be called when getting the notification. It must be called
1135	* for each one.
1136	*
1137	* @returns VBox status code.
1138	* @param pDrvIns The driver instance.
1139	* @param pfnAsyncNotify The callback.
1140	* @thread EMT(0)
1141	*/
1142	DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
1143
1144	/**
1145	* Notify EMT(0) that the driver has completed the asynchronous notification
1146	* handling.
1147	*
1148	* This can be called at any time, spurious calls will simply be ignored.
1149	*
1150	* @param pDrvIns The driver instance.
1151	* @thread Any
1152	*/
1153	DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMDRVINS pDrvIns));
1154
1155	/**
1156	* Creates a PDM thread.
1157	*
1158	* This differs from the RTThreadCreate() API in that PDM takes care of suspending,
1159	* resuming, and destroying the thread as the VM state changes.
1160	*
1161	* @returns VBox status code.
1162	* @param pDrvIns The driver instance.
1163	* @param ppThread Where to store the thread 'handle'.
1164	* @param pvUser The user argument to the thread function.
1165	* @param pfnThread The thread function.
1166	* @param pfnWakeup The wakup callback. This is called on the EMT thread when
1167	* a state change is pending.
1168	* @param cbStack See RTThreadCreate.
1169	* @param enmType See RTThreadCreate.
1170	* @param pszName See RTThreadCreate.
1171	*/
1172	DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1173	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
1174
1175	/**
1176	* Creates an async completion template for a driver instance.
1177	*
1178	* The template is used when creating new completion tasks.
1179	*
1180	* @returns VBox status code.
1181	* @param pDrvIns The driver instance.
1182	* @param ppTemplate Where to store the template pointer on success.
1183	* @param pfnCompleted The completion callback routine.
1184	* @param pvTemplateUser Template user argument.
1185	* @param pszDesc Description.
1186	*/
1187	DECLR3CALLBACKMEMBER(int, pfnAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1188	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1189	const char *pszDesc));
1190
1191	/**
1192	* Attaches network filter driver to a bandwidth group.
1193	*
1194	* @returns VBox status code.
1195	* @param pDrvIns The driver instance.
1196	* @param pcszBwGroup Name of the bandwidth group to attach to.
1197	* @param pFilter Pointer to the filter we attach.
1198	*/
1199	DECLR3CALLBACKMEMBER(int, pfnNetShaperAttach,(PPDMDRVINS pDrvIns, const char *pszBwGroup, PPDMNSFILTER pFilter));
1200
1201	/**
1202	* Detaches network filter driver to a bandwidth group.
1203	*
1204	* @returns VBox status code.
1205	* @param pDrvIns The driver instance.
1206	* @param pFilter Pointer to the filter we attach.
1207	*/
1208	DECLR3CALLBACKMEMBER(int, pfnNetShaperDetach,(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter));
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	* Creates a block cache for a driver driver instance.
1290	*
1291	* @returns VBox status code.
1292	* @param pDrvIns The driver instance.
1293	* @param ppBlkCache Where to store the handle to the block cache.
1294	* @param pfnXferComplete The I/O transfer complete callback.
1295	* @param pfnXferEnqueue The I/O request enqueue callback.
1296	* @param pfnXferEnqueueDiscard The discard request enqueue callback.
1297	* @param pcszId Unique ID used to identify the user.
1298	*/
1299	DECLR3CALLBACKMEMBER(int, pfnBlkCacheRetain, (PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1300	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1301	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1302	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1303	const char *pcszId));
1304	/**
1305	* Gets the reason for the most recent VM suspend.
1306	*
1307	* @returns The suspend reason. VMSUSPENDREASON_INVALID is returned if no
1308	* suspend has been made or if the pDrvIns is invalid.
1309	* @param pDrvIns The driver instance.
1310	*/
1311	DECLR3CALLBACKMEMBER(VMSUSPENDREASON, pfnVMGetSuspendReason,(PPDMDRVINS pDrvIns));
1312
1313	/**
1314	* Gets the reason for the most recent VM resume.
1315	*
1316	* @returns The resume reason. VMRESUMEREASON_INVALID is returned if no
1317	* resume has been made or if the pDrvIns is invalid.
1318	* @param pDrvIns The driver instance.
1319	*/
1320	DECLR3CALLBACKMEMBER(VMRESUMEREASON, pfnVMGetResumeReason,(PPDMDRVINS pDrvIns));
1321
1322	/** @name Space reserved for minor interface changes.
1323	* @{ */
1324	DECLR3CALLBACKMEMBER(int, pfnTimerSetMillies,(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext));
1325
1326	/**
1327	* Deregister zero or more samples given their name prefix.
1328	*
1329	* @returns VBox status code.
1330	* @param pDrvIns The driver instance.
1331	* @param pszPrefix The name prefix of the samples to remove. If this does
1332	* not start with a '/', the default prefix will be
1333	* prepended, otherwise it will be used as-is.
1334	*/
1335	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregisterByPrefix,(PPDMDRVINS pDrvIns, const char *pszPrefix));
1336
1337	/**
1338	* Queries a generic object from the VMM user.
1339	*
1340	* @returns Pointer to the object if found, NULL if not.
1341	* @param pDrvIns The driver instance.
1342	* @param pUuid The UUID of what's being queried. The UUIDs and
1343	* the usage conventions are defined by the user.
1344	*/
1345	DECLR3CALLBACKMEMBER(void *, pfnQueryGenericUserObject,(PPDMDRVINS pDrvIns, PCRTUUID pUuid));
1346
1347	DECLR3CALLBACKMEMBER(void, pfnReserved2,(PPDMDRVINS pDrvIns));
1348	DECLR3CALLBACKMEMBER(void, pfnReserved3,(PPDMDRVINS pDrvIns));
1349	DECLR3CALLBACKMEMBER(void, pfnReserved4,(PPDMDRVINS pDrvIns));
1350	DECLR3CALLBACKMEMBER(void, pfnReserved5,(PPDMDRVINS pDrvIns));
1351	DECLR3CALLBACKMEMBER(void, pfnReserved6,(PPDMDRVINS pDrvIns));
1352	DECLR3CALLBACKMEMBER(void, pfnReserved7,(PPDMDRVINS pDrvIns));
1353	DECLR3CALLBACKMEMBER(void, pfnReserved8,(PPDMDRVINS pDrvIns));
1354	/** @} */
1355
1356	/** Just a safety precaution. */
1357	uint32_t u32TheEnd;
1358	} PDMDRVHLPR3;
1359	/** Current DRVHLP version number. */
1360	#define PDM_DRVHLPR3_VERSION PDM_VERSION_MAKE(0xf0fb, 5, 2)
1361
1362	#endif /* IN_RING3 */
1363
1364
1365	/**
1366	* @copydoc PDMDRVHLPR3::pfnVMSetError
1367	*/
1368	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 7) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1369	const char *pszFormat, ...)
1370	{
1371	va_list va;
1372	va_start(va, pszFormat);
1373	pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1374	va_end(va);
1375	return rc;
1376	}
1377
1378	/** @def PDMDRV_SET_ERROR
1379	* Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
1380	*/
1381	#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
1382	PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
1383
1384	/**
1385	* @copydoc PDMDRVHLPR3::pfnVMSetErrorV
1386	*/
1387	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(6, 0) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL,
1388	const char *pszFormat, va_list va)
1389	{
1390	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1391	}
1392
1393
1394	/**
1395	* @copydoc PDMDRVHLPR3::pfnVMSetRuntimeError
1396	*/
1397	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 5) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char *pszErrorId,
1398	const char *pszFormat, ...)
1399	{
1400	va_list va;
1401	int rc;
1402	va_start(va, pszFormat);
1403	rc = pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1404	va_end(va);
1405	return rc;
1406	}
1407
1408	/** @def PDMDRV_SET_RUNTIME_ERROR
1409	* Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
1410	*/
1411	#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFlags, pszErrorId, pszError) \
1412	PDMDrvHlpVMSetRuntimeError(pDrvIns, fFlags, pszErrorId, "%s", pszError)
1413
1414	/**
1415	* @copydoc PDMDRVHLPR3::pfnVMSetRuntimeErrorV
1416	*/
1417	DECLINLINE(int) RT_IPRT_FORMAT_ATTR(4, 0) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags,
1418	const char pszErrorId, const char pszFormat, va_list va)
1419	{
1420	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1421	}
1422
1423
1424
1425	/** @def PDMDRV_ASSERT_EMT
1426	* Assert that the current thread is the emulation thread.
1427	*/
1428	#ifdef VBOX_STRICT
1429	# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1430	#else
1431	# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
1432	#endif
1433
1434	/** @def PDMDRV_ASSERT_OTHER
1435	* Assert that the current thread is NOT the emulation thread.
1436	*/
1437	#ifdef VBOX_STRICT
1438	# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1439	#else
1440	# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
1441	#endif
1442
1443
1444	#ifdef IN_RING3
1445
1446	/**
1447	* @copydoc PDMDRVHLPR3::pfnAttach
1448	*/
1449	DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
1450	{
1451	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, fFlags, ppBaseInterface);
1452	}
1453
1454	/**
1455	* Check that there is no driver below the us that we should attach to.
1456	*
1457	* @returns VERR_PDM_NO_ATTACHED_DRIVER if there is no driver.
1458	* @param pDrvIns The driver instance.
1459	*/
1460	DECLINLINE(int) PDMDrvHlpNoAttach(PPDMDRVINS pDrvIns)
1461	{
1462	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, 0, NULL);
1463	}
1464
1465	/**
1466	* @copydoc PDMDRVHLPR3::pfnDetach
1467	*/
1468	DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1469	{
1470	return pDrvIns->pHlpR3->pfnDetach(pDrvIns, fFlags);
1471	}
1472
1473	/**
1474	* @copydoc PDMDRVHLPR3::pfnDetachSelf
1475	*/
1476	DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1477	{
1478	return pDrvIns->pHlpR3->pfnDetachSelf(pDrvIns, fFlags);
1479	}
1480
1481	/**
1482	* @copydoc PDMDRVHLPR3::pfnMountPrepare
1483	*/
1484	DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
1485	{
1486	return pDrvIns->pHlpR3->pfnMountPrepare(pDrvIns, pszFilename, pszCoreDriver);
1487	}
1488
1489	/**
1490	* @copydoc PDMDRVHLPR3::pfnVMState
1491	*/
1492	DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
1493	{
1494	return pDrvIns->CTX_SUFF(pHlp)->pfnVMState(pDrvIns);
1495	}
1496
1497	/**
1498	* @copydoc PDMDRVHLPR3::pfnVMTeleportedAndNotFullyResumedYet
1499	*/
1500	DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1501	{
1502	return pDrvIns->pHlpR3->pfnVMTeleportedAndNotFullyResumedYet(pDrvIns);
1503	}
1504
1505	/**
1506	* @copydoc PDMDRVHLPR3::pfnGetSupDrvSession
1507	*/
1508	DECLINLINE(PSUPDRVSESSION) PDMDrvHlpGetSupDrvSession(PPDMDRVINS pDrvIns)
1509	{
1510	return pDrvIns->pHlpR3->pfnGetSupDrvSession(pDrvIns);
1511	}
1512
1513	/**
1514	* @copydoc PDMDRVHLPR3::pfnQueueCreate
1515	*/
1516	DECLINLINE(int) PDMDrvHlpQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1517	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue)
1518	{
1519	return pDrvIns->pHlpR3->pfnQueueCreate(pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
1520	}
1521
1522	/**
1523	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualFreq
1524	*/
1525	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
1526	{
1527	return pDrvIns->pHlpR3->pfnTMGetVirtualFreq(pDrvIns);
1528	}
1529
1530	/**
1531	* @copydoc PDMDRVHLPR3::pfnTMGetVirtualTime
1532	*/
1533	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
1534	{
1535	return pDrvIns->pHlpR3->pfnTMGetVirtualTime(pDrvIns);
1536	}
1537
1538	/**
1539	* @copydoc PDMDRVHLPR3::pfnTimerCreate
1540	*/
1541	DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void *pvUser,
1542	uint32_t fFlags, const char *pszDesc, PTMTIMERHANDLE phTimer)
1543
1544	{
1545	return pDrvIns->pHlpR3->pfnTimerCreate(pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, phTimer);
1546	}
1547
1548	/**
1549	* @copydoc PDMDRVHLPR3::pfnTimerSetMillies
1550	*/
1551	DECLINLINE(int) PDMDrvHlpTimerSetMillies(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, uint64_t cMilliesToNext)
1552
1553	{
1554	return pDrvIns->pHlpR3->pfnTimerSetMillies(pDrvIns, hTimer, cMilliesToNext);
1555	}
1556
1557	/**
1558	* Register a save state data unit.
1559	*
1560	* @returns VBox status.
1561	* @param pDrvIns Driver instance.
1562	* @param uVersion Data layout version number.
1563	* @param cbGuess The approximate amount of data in the unit.
1564	* Only for progress indicators.
1565	* @param pfnSaveExec Execute save callback, optional.
1566	* @param pfnLoadExec Execute load callback, optional.
1567	*/
1568	DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1569	PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVLOADEXEC pfnLoadExec)
1570	{
1571	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1572	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1573	NULL /pfnSavePrep/, pfnSaveExec, NULL /pfnSaveDone/,
1574	NULL /pfnLoadPrep/, pfnLoadExec, NULL /pfnLoadDone/);
1575	}
1576
1577	/**
1578	* @copydoc PDMDRVHLPR3::pfnSSMRegister
1579	*/
1580	DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1581	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1582	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1583	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1584	{
1585	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1586	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1587	pfnSavePrep, pfnSaveExec, pfnSaveDone,
1588	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1589	}
1590
1591	/**
1592	* Register a load done callback.
1593	*
1594	* @returns VBox status.
1595	* @param pDrvIns Driver instance.
1596	* @param pfnLoadDone Done load callback, optional.
1597	*/
1598	DECLINLINE(int) PDMDrvHlpSSMRegisterLoadDone(PPDMDRVINS pDrvIns, PFNSSMDRVLOADDONE pfnLoadDone)
1599	{
1600	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, 0 /uVersion/, 0 /cbGuess/,
1601	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1602	NULL /pfnSavePrep/, NULL /pfnSaveExec/, NULL /pfnSaveDone/,
1603	NULL /pfnLoadPrep/, NULL /pfnLoadExec/, pfnLoadDone);
1604	}
1605
1606	/**
1607	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1608	*/
1609	DECLINLINE(int) PDMDrvHlpDBGFInfoRegister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1610	{
1611	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1612	}
1613
1614	/**
1615	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegisterArgv
1616	*/
1617	DECLINLINE(int) PDMDrvHlpDBGFInfoRegisterArgv(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFINFOARGVDRV pfnHandler)
1618	{
1619	return pDrvIns->pHlpR3->pfnDBGFInfoRegisterArgv(pDrvIns, pszName, pszDesc, pfnHandler);
1620	}
1621
1622	/**
1623	* @copydoc PDMDRVHLPR3::pfnDBGFInfoRegister
1624	*/
1625	DECLINLINE(int) PDMDrvHlpDBGFInfoDeregister(PPDMDRVINS pDrvIns, const char pszName, const char pszDesc, PFNDBGFHANDLERDRV pfnHandler)
1626	{
1627	return pDrvIns->pHlpR3->pfnDBGFInfoRegister(pDrvIns, pszName, pszDesc, pfnHandler);
1628	}
1629
1630	/**
1631	* @copydoc PDMDRVHLPR3::pfnSTAMRegister
1632	*/
1633	DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
1634	{
1635	pDrvIns->pHlpR3->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
1636	}
1637
1638	/**
1639	* @copydoc PDMDRVHLPR3::pfnSTAMRegisterF
1640	*/
1641	DECLINLINE(void) RT_IPRT_FORMAT_ATTR(7, 8) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType,
1642	STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1643	const char pszDesc, const char pszName, ...)
1644	{
1645	va_list va;
1646	va_start(va, pszName);
1647	pDrvIns->pHlpR3->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1648	va_end(va);
1649	}
1650
1651	/**
1652	* Convenience wrapper that registers counter which is always visible.
1653	*
1654	* @param pDrvIns The driver instance.
1655	* @param pCounter Pointer to the counter variable.
1656	* @param pszName The name of the sample. This is prefixed with
1657	* "/Drivers/<drivername>-<instance no>/".
1658	* @param enmUnit The unit.
1659	* @param pszDesc The description.
1660	*/
1661	DECLINLINE(void) PDMDrvHlpSTAMRegCounterEx(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1662	{
1663	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pCounter, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1664	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1665	}
1666
1667	/**
1668	* Convenience wrapper that registers counter which is always visible and has
1669	* the STAMUNIT_COUNT unit.
1670	*
1671	* @param pDrvIns The driver instance.
1672	* @param pCounter Pointer to the counter variable.
1673	* @param pszName The name of the sample. This is prefixed with
1674	* "/Drivers/<drivername>-<instance no>/".
1675	* @param pszDesc The description.
1676	*/
1677	DECLINLINE(void) PDMDrvHlpSTAMRegCounter(PPDMDRVINS pDrvIns, PSTAMCOUNTER pCounter, const char pszName, const char pszDesc)
1678	{
1679	PDMDrvHlpSTAMRegCounterEx(pDrvIns, pCounter, pszName, STAMUNIT_COUNT, pszDesc);
1680	}
1681
1682	/**
1683	* Convenience wrapper that registers profiling sample which is always visible.
1684	*
1685	* @param pDrvIns The driver instance.
1686	* @param pProfile Pointer to the profiling variable.
1687	* @param pszName The name of the sample. This is prefixed with
1688	* "/Drivers/<drivername>-<instance no>/".
1689	* @param enmUnit The unit.
1690	* @param pszDesc The description.
1691	*/
1692	DECLINLINE(void) PDMDrvHlpSTAMRegProfileEx(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1693	{
1694	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1695	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1696	}
1697
1698	/**
1699	* Convenience wrapper that registers profiling sample which is always visible
1700	* hand counts ticks per call (STAMUNIT_TICKS_PER_CALL).
1701	*
1702	* @param pDrvIns The driver instance.
1703	* @param pProfile Pointer to the profiling variable.
1704	* @param pszName The name of the sample. This is prefixed with
1705	* "/Drivers/<drivername>-<instance no>/".
1706	* @param pszDesc The description.
1707	*/
1708	DECLINLINE(void) PDMDrvHlpSTAMRegProfile(PPDMDRVINS pDrvIns, PSTAMPROFILE pProfile, const char pszName, const char pszDesc)
1709	{
1710	PDMDrvHlpSTAMRegProfileEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1711	}
1712
1713	/**
1714	* Convenience wrapper that registers an advanced profiling sample which is
1715	* always visible.
1716	*
1717	* @param pDrvIns The driver instance.
1718	* @param pProfile Pointer to the profiling variable.
1719	* @param enmUnit The unit.
1720	* @param pszName The name of the sample. This is prefixed with
1721	* "/Drivers/<drivername>-<instance no>/".
1722	* @param pszDesc The description.
1723	*/
1724	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdvEx(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, STAMUNIT enmUnit, const char pszDesc)
1725	{
1726	pDrvIns->pHlpR3->pfnSTAMRegisterF(pDrvIns, pProfile, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, enmUnit, pszDesc,
1727	"/Drivers/%s-%u/%s", pDrvIns->pReg->szName, pDrvIns->iInstance, pszName);
1728	}
1729
1730	/**
1731	* Convenience wrapper that registers an advanced profiling sample which is
1732	* always visible.
1733	*
1734	* @param pDrvIns The driver instance.
1735	* @param pProfile Pointer to the profiling variable.
1736	* @param pszName The name of the sample. This is prefixed with
1737	* "/Drivers/<drivername>-<instance no>/".
1738	* @param pszDesc The description.
1739	*/
1740	DECLINLINE(void) PDMDrvHlpSTAMRegProfileAdv(PPDMDRVINS pDrvIns, PSTAMPROFILEADV pProfile, const char pszName, const char pszDesc)
1741	{
1742	PDMDrvHlpSTAMRegProfileAdvEx(pDrvIns, pProfile, pszName, STAMUNIT_TICKS_PER_CALL, pszDesc);
1743	}
1744
1745	/**
1746	* @copydoc PDMDRVHLPR3::pfnSTAMDeregister
1747	*/
1748	DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1749	{
1750	return pDrvIns->pHlpR3->pfnSTAMDeregister(pDrvIns, pvSample);
1751	}
1752
1753	/**
1754	* @copydoc PDMDRVHLPR3::pfnSTAMDeregisterByPrefix
1755	*/
1756	DECLINLINE(int) PDMDrvHlpSTAMDeregisterByPrefix(PPDMDRVINS pDrvIns, const char *pszPrefix)
1757	{
1758	return pDrvIns->pHlpR3->pfnSTAMDeregisterByPrefix(pDrvIns, pszPrefix);
1759	}
1760
1761	/**
1762	* @copydoc PDMDRVHLPR3::pfnSUPCallVMMR0Ex
1763	*/
1764	DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1765	{
1766	return pDrvIns->pHlpR3->pfnSUPCallVMMR0Ex(pDrvIns, uOperation, pvArg, cbArg);
1767	}
1768
1769	/**
1770	* @copydoc PDMDRVHLPR3::pfnUSBRegisterHub
1771	*/
1772	DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1773	{
1774	return pDrvIns->pHlpR3->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1775	}
1776
1777	/**
1778	* @copydoc PDMDRVHLPR3::pfnSetAsyncNotification
1779	*/
1780	DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1781	{
1782	return pDrvIns->pHlpR3->pfnSetAsyncNotification(pDrvIns, pfnAsyncNotify);
1783	}
1784
1785	/**
1786	* @copydoc PDMDRVHLPR3::pfnAsyncNotificationCompleted
1787	*/
1788	DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1789	{
1790	pDrvIns->pHlpR3->pfnAsyncNotificationCompleted(pDrvIns);
1791	}
1792
1793	/**
1794	* @copydoc PDMDRVHLPR3::pfnThreadCreate
1795	*/
1796	DECLINLINE(int) PDMDrvHlpThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1797	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1798	{
1799	return pDrvIns->pHlpR3->pfnThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1800	}
1801
1802	# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1803	/**
1804	* @copydoc PDMDRVHLPR3::pfnAsyncCompletionTemplateCreate
1805	*/
1806	DECLINLINE(int) PDMDrvHlpAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1807	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void pvTemplateUser, const char pszDesc)
1808	{
1809	return pDrvIns->pHlpR3->pfnAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1810	}
1811	# endif
1812
1813	# ifdef VBOX_WITH_NETSHAPER
1814	/**
1815	* @copydoc PDMDRVHLPR3::pfnNetShaperAttach
1816	*/
1817	DECLINLINE(int) PDMDrvHlpNetShaperAttach(PPDMDRVINS pDrvIns, const char *pcszBwGroup, PPDMNSFILTER pFilter)
1818	{
1819	return pDrvIns->pHlpR3->pfnNetShaperAttach(pDrvIns, pcszBwGroup, pFilter);
1820	}
1821
1822	/**
1823	* @copydoc PDMDRVHLPR3::pfnNetShaperDetach
1824	*/
1825	DECLINLINE(int) PDMDrvHlpNetShaperDetach(PPDMDRVINS pDrvIns, PPDMNSFILTER pFilter)
1826	{
1827	return pDrvIns->pHlpR3->pfnNetShaperDetach(pDrvIns, pFilter);
1828	}
1829	# endif
1830
1831	/**
1832	* @copydoc PDMDRVHLPR3::pfnCritSectInit
1833	*/
1834	DECLINLINE(int) PDMDrvHlpCritSectInit(PPDMDRVINS pDrvIns, PPDMCRITSECT pCritSect, RT_SRC_POS_DECL, const char *pszName)
1835	{
1836	return pDrvIns->pHlpR3->pfnCritSectInit(pDrvIns, pCritSect, RT_SRC_POS_ARGS, pszName);
1837	}
1838
1839	/**
1840	* @copydoc PDMDRVHLPR3::pfnCallR0
1841	*/
1842	DECLINLINE(int) PDMDrvHlpCallR0(PPDMDRVINS pDrvIns, uint32_t uOperation, uint64_t u64Arg)
1843	{
1844	return pDrvIns->pHlpR3->pfnCallR0(pDrvIns, uOperation, u64Arg);
1845	}
1846
1847	/**
1848	* @copydoc PDMDRVHLPR3::pfnBlkCacheRetain
1849	*/
1850	DECLINLINE(int) PDMDrvHlpBlkCacheRetain(PPDMDRVINS pDrvIns, PPPDMBLKCACHE ppBlkCache,
1851	PFNPDMBLKCACHEXFERCOMPLETEDRV pfnXferComplete,
1852	PFNPDMBLKCACHEXFERENQUEUEDRV pfnXferEnqueue,
1853	PFNPDMBLKCACHEXFERENQUEUEDISCARDDRV pfnXferEnqueueDiscard,
1854	const char *pcszId)
1855	{
1856	return pDrvIns->pHlpR3->pfnBlkCacheRetain(pDrvIns, ppBlkCache, pfnXferComplete, pfnXferEnqueue, pfnXferEnqueueDiscard, pcszId);
1857	}
1858
1859	/**
1860	* @copydoc PDMDRVHLPR3::pfnVMGetSuspendReason
1861	*/
1862	DECLINLINE(VMSUSPENDREASON) PDMDrvHlpVMGetSuspendReason(PPDMDRVINS pDrvIns)
1863	{
1864	return pDrvIns->pHlpR3->pfnVMGetSuspendReason(pDrvIns);
1865	}
1866
1867	/**
1868	* @copydoc PDMDRVHLPR3::pfnVMGetResumeReason
1869	*/
1870	DECLINLINE(VMRESUMEREASON) PDMDrvHlpVMGetResumeReason(PPDMDRVINS pDrvIns)
1871	{
1872	return pDrvIns->pHlpR3->pfnVMGetResumeReason(pDrvIns);
1873	}
1874
1875	/**
1876	* @copydoc PDMDRVHLPR3::pfnQueryGenericUserObject
1877	*/
1878	DECLINLINE(void *) PDMDrvHlpQueryGenericUserObject(PPDMDRVINS pDrvIns, PCRTUUID pUuid)
1879	{
1880	return pDrvIns->pHlpR3->pfnQueryGenericUserObject(pDrvIns, pUuid);
1881	}
1882
1883
1884	/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
1885	typedef struct PDMDRVREGCB *PPDMDRVREGCB;
1886	/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
1887	typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
1888
1889	/**
1890	* Callbacks for VBoxDriverRegister().
1891	*/
1892	typedef struct PDMDRVREGCB
1893	{
1894	/** Interface version.
1895	* This is set to PDM_DRVREG_CB_VERSION. */
1896	uint32_t u32Version;
1897
1898	/**
1899	* Registers a driver with the current VM instance.
1900	*
1901	* @returns VBox status code.
1902	* @param pCallbacks Pointer to the callback table.
1903	* @param pReg Pointer to the driver registration record.
1904	* This data must be permanent and readonly.
1905	*/
1906	DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg));
1907	} PDMDRVREGCB;
1908
1909	/** Current version of the PDMDRVREGCB structure. */
1910	#define PDM_DRVREG_CB_VERSION PDM_VERSION_MAKE(0xf0fa, 1, 0)
1911
1912
1913	/**
1914	* The VBoxDriverRegister callback function.
1915	*
1916	* PDM will invoke this function after loading a driver module and letting
1917	* the module decide which drivers to register and how to handle conflicts.
1918	*
1919	* @returns VBox status code.
1920	* @param pCallbacks Pointer to the callback table.
1921	* @param u32Version VBox version number.
1922	*/
1923	typedef DECLCALLBACKTYPE(int, FNPDMVBOXDRIVERSREGISTER,(PCPDMDRVREGCB pCallbacks, uint32_t u32Version));
1924
1925	VMMR3DECL(int) PDMR3DrvStaticRegistration(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
1926
1927	#endif /* IN_RING3 */
1928
1929	/** @} */
1930
1931	RT_C_DECLS_END
1932
1933	#endif /* !VBOX_INCLUDED_vmm_pdmdrv_h */

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

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

Download in other formats: