pdmdrv.h@ 27095

Last change on this file since 27095 was 26175, checked in by vboxsync, 15 years ago
PDM: Ring-0 and raw-mode context driver helpers. Driver RC relcoations.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 55.5 KB

Line
1	/** @file
2	* PDM - Pluggable Device Manager, Drivers. (VMM)
3	*/
4
5	/*
6	* Copyright (C) 2006-2010 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___VBox_pdmdrv_h
31	#define ___VBox_pdmdrv_h
32
33	#include <VBox/pdmqueue.h>
34	#include <VBox/pdmcritsect.h>
35	#include <VBox/pdmthread.h>
36	#include <VBox/pdmifs.h>
37	#include <VBox/pdmins.h>
38	#include <VBox/pdmcommon.h>
39	#include <VBox/pdmasynccompletion.h>
40	#include <VBox/tm.h>
41	#include <VBox/ssm.h>
42	#include <VBox/cfgm.h>
43	#include <VBox/dbgf.h>
44	#include <VBox/mm.h>
45	#include <VBox/err.h>
46	#include <iprt/stdarg.h>
47
48	RT_C_DECLS_BEGIN
49
50	/** @defgroup grp_pdm_driver The PDM Drivers API
51	* @ingroup grp_pdm
52	* @{
53	*/
54
55	/** Pointer const PDM Driver API, ring-3. */
56	typedef R3PTRTYPE(struct PDMDRVHLPR3 const *) PCPDMDRVHLPR3;
57	/** Pointer const PDM Driver API, ring-0. */
58	typedef R0PTRTYPE(struct PDMDRVHLPR0 const *) PCPDMDRVHLPR0;
59	/** Pointer const PDM Driver API, raw-mode context. */
60	typedef RCPTRTYPE(struct PDMDRVHLPRC const *) PCPDMDRVHLPRC;
61
62
63	/**
64	* Construct a driver instance for a VM.
65	*
66	* @returns VBox status.
67	* @param pDrvIns The driver instance data. If the registration structure
68	* is needed, it can be accessed thru pDrvIns->pReg.
69	* @param pCfg Configuration node handle for the driver. This is
70	* expected to be in high demand in the constructor and is
71	* therefore passed as an argument. When using it at other
72	* times, it can be accessed via pDrvIns->pCfg.
73	* @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
74	*/
75	typedef DECLCALLBACK(int) FNPDMDRVCONSTRUCT(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags);
76	/** Pointer to a FNPDMDRVCONSTRUCT() function. */
77	typedef FNPDMDRVCONSTRUCT *PFNPDMDRVCONSTRUCT;
78
79	/**
80	* Destruct a driver instance.
81	*
82	* Most VM resources are freed by the VM. This callback is provided so that
83	* any non-VM resources can be freed correctly.
84	*
85	* @param pDrvIns The driver instance data.
86	*/
87	typedef DECLCALLBACK(void) FNPDMDRVDESTRUCT(PPDMDRVINS pDrvIns);
88	/** Pointer to a FNPDMDRVDESTRUCT() function. */
89	typedef FNPDMDRVDESTRUCT *PFNPDMDRVDESTRUCT;
90
91	/**
92	* Driver relocation callback.
93	*
94	* This is called when the instance data has been relocated in raw-mode context
95	* (RC). It is also called when the RC hypervisor selects changes. The driver
96	* must fixup all necessary pointers and re-query all interfaces to other RC
97	* devices and drivers.
98	*
99	* Before the RC code is executed the first time, this function will be called
100	* with a 0 delta so RC pointer calculations can be one in one place.
101	*
102	* @param pDrvIns Pointer to the driver instance.
103	* @param offDelta The relocation delta relative to the old location.
104	*
105	* @remark A relocation CANNOT fail.
106	*/
107	typedef DECLCALLBACK(void) FNPDMDRVRELOCATE(PPDMDRVINS pDrvIns, RTGCINTPTR offDelta);
108	/** Pointer to a FNPDMDRVRELOCATE() function. */
109	typedef FNPDMDRVRELOCATE *PFNPDMDRVRELOCATE;
110
111	/**
112	* Driver I/O Control interface.
113	*
114	* This is used by external components, such as the COM interface, to
115	* communicate with a driver using a driver specific interface. Generally,
116	* the driver interfaces are used for this task.
117	*
118	* @returns VBox status code.
119	* @param pDrvIns Pointer to the driver instance.
120	* @param uFunction Function to perform.
121	* @param pvIn Pointer to input data.
122	* @param cbIn Size of input data.
123	* @param pvOut Pointer to output data.
124	* @param cbOut Size of output data.
125	* @param pcbOut Where to store the actual size of the output data.
126	*/
127	typedef DECLCALLBACK(int) FNPDMDRVIOCTL(PPDMDRVINS pDrvIns, uint32_t uFunction,
128	void *pvIn, uint32_t cbIn,
129	void pvOut, uint32_t cbOut, uint32_t pcbOut);
130	/** Pointer to a FNPDMDRVIOCTL() function. */
131	typedef FNPDMDRVIOCTL *PFNPDMDRVIOCTL;
132
133	/**
134	* Power On notification.
135	*
136	* @param pDrvIns The driver instance data.
137	*/
138	typedef DECLCALLBACK(void) FNPDMDRVPOWERON(PPDMDRVINS pDrvIns);
139	/** Pointer to a FNPDMDRVPOWERON() function. */
140	typedef FNPDMDRVPOWERON *PFNPDMDRVPOWERON;
141
142	/**
143	* Reset notification.
144	*
145	* @returns VBox status.
146	* @param pDrvIns The driver instance data.
147	*/
148	typedef DECLCALLBACK(void) FNPDMDRVRESET(PPDMDRVINS pDrvIns);
149	/** Pointer to a FNPDMDRVRESET() function. */
150	typedef FNPDMDRVRESET *PFNPDMDRVRESET;
151
152	/**
153	* Suspend notification.
154	*
155	* @returns VBox status.
156	* @param pDrvIns The driver instance data.
157	*/
158	typedef DECLCALLBACK(void) FNPDMDRVSUSPEND(PPDMDRVINS pDrvIns);
159	/** Pointer to a FNPDMDRVSUSPEND() function. */
160	typedef FNPDMDRVSUSPEND *PFNPDMDRVSUSPEND;
161
162	/**
163	* Resume notification.
164	*
165	* @returns VBox status.
166	* @param pDrvIns The driver instance data.
167	*/
168	typedef DECLCALLBACK(void) FNPDMDRVRESUME(PPDMDRVINS pDrvIns);
169	/** Pointer to a FNPDMDRVRESUME() function. */
170	typedef FNPDMDRVRESUME *PFNPDMDRVRESUME;
171
172	/**
173	* Power Off notification.
174	*
175	* @param pDrvIns The driver instance data.
176	*/
177	typedef DECLCALLBACK(void) FNPDMDRVPOWEROFF(PPDMDRVINS pDrvIns);
178	/** Pointer to a FNPDMDRVPOWEROFF() function. */
179	typedef FNPDMDRVPOWEROFF *PFNPDMDRVPOWEROFF;
180
181	/**
182	* Attach command.
183	*
184	* This is called to let the drive attach to a driver at runtime. This is not
185	* called during VM construction, the driver constructor have to do this by
186	* calling PDMDrvHlpAttach.
187	*
188	* This is like plugging in the keyboard or mouse after turning on the PC.
189	*
190	* @returns VBox status code.
191	* @param pDrvIns The driver instance.
192	* @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
193	*/
194	typedef DECLCALLBACK(int) FNPDMDRVATTACH(PPDMDRVINS pDrvIns, uint32_t fFlags);
195	/** Pointer to a FNPDMDRVATTACH() function. */
196	typedef FNPDMDRVATTACH *PFNPDMDRVATTACH;
197
198	/**
199	* Detach notification.
200	*
201	* This is called when a driver below it in the chain is detaching itself
202	* from it. The driver should adjust it's state to reflect this.
203	*
204	* This is like ejecting a cdrom or floppy.
205	*
206	* @param pDrvIns The driver instance.
207	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
208	*/
209	typedef DECLCALLBACK(void) FNPDMDRVDETACH(PPDMDRVINS pDrvIns, uint32_t fFlags);
210	/** Pointer to a FNPDMDRVDETACH() function. */
211	typedef FNPDMDRVDETACH *PFNPDMDRVDETACH;
212
213
214
215	/**
216	* PDM Driver Registration Structure.
217	*
218	* This structure is used when registering a driver from VBoxInitDrivers() (in
219	* host ring-3 context). PDM will continue use till the VM is terminated.
220	*/
221	typedef struct PDMDRVREG
222	{
223	/** Structure version. PDM_DRVREG_VERSION defines the current version. */
224	uint32_t u32Version;
225	/** Driver name. */
226	char szName[32];
227	/** Name of the raw-mode context module (no path).
228	* Only evalutated if PDM_DRVREG_FLAGS_RC is set. */
229	char szRCMod[32];
230	/** Name of the ring-0 module (no path).
231	* Only evalutated if PDM_DRVREG_FLAGS_R0 is set. */
232	char szR0Mod[32];
233	/** The description of the driver. The UTF-8 string pointed to shall, like this structure,
234	* remain unchanged from registration till VM destruction. */
235	const char *pszDescription;
236
237	/** Flags, combination of the PDM_DRVREG_FLAGS_* \#defines. */
238	uint32_t fFlags;
239	/** Driver class(es), combination of the PDM_DRVREG_CLASS_* \#defines. */
240	uint32_t fClass;
241	/** Maximum number of instances (per VM). */
242	uint32_t cMaxInstances;
243	/** Size of the instance data. */
244	uint32_t cbInstance;
245
246	/** Construct instance - required. */
247	PFNPDMDRVCONSTRUCT pfnConstruct;
248	/** Destruct instance - optional. */
249	PFNPDMDRVDESTRUCT pfnDestruct;
250	/** Relocation command - optional. */
251	PFNPDMDRVRELOCATE pfnRelocate;
252	/** I/O control - optional. */
253	PFNPDMDRVIOCTL pfnIOCtl;
254	/** Power on notification - optional. */
255	PFNPDMDRVPOWERON pfnPowerOn;
256	/** Reset notification - optional. */
257	PFNPDMDRVRESET pfnReset;
258	/** Suspend notification - optional. */
259	PFNPDMDRVSUSPEND pfnSuspend;
260	/** Resume notification - optional. */
261	PFNPDMDRVRESUME pfnResume;
262	/** Attach command - optional. */
263	PFNPDMDRVATTACH pfnAttach;
264	/** Detach notification - optional. */
265	PFNPDMDRVDETACH pfnDetach;
266	/** Power off notification - optional. */
267	PFNPDMDRVPOWEROFF pfnPowerOff;
268	/** @todo */
269	PFNRT pfnSoftReset;
270	/** Initialization safty marker. */
271	uint32_t u32VersionEnd;
272	} PDMDRVREG;
273	/** Pointer to a PDM Driver Structure. */
274	typedef PDMDRVREG *PPDMDRVREG;
275	/** Const pointer to a PDM Driver Structure. */
276	typedef PDMDRVREG const *PCPDMDRVREG;
277
278	/** Current DRVREG version number. */
279	#define PDM_DRVREG_VERSION PDM_VERSION_MAKE(0xf0ff, 1, 0)
280
281	/** PDM Driver Flags.
282	* @{ */
283	/** @def PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT
284	* The bit count for the current host. */
285	#if HC_ARCH_BITS == 32
286	# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT UINT32_C(0x00000001)
287	#elif HC_ARCH_BITS == 64
288	# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT UINT32_C(0x00000002)
289	#else
290	# error Unsupported HC_ARCH_BITS value.
291	#endif
292	/** The host bit count mask. */
293	#define PDM_DRVREG_FLAGS_HOST_BITS_MASK UINT32_C(0x00000003)
294	/** This flag is used to indicate that the driver has a RC component. */
295	#define PDM_DRVREG_FLAGS_RC UINT32_C(0x00000010)
296	/** This flag is used to indicate that the driver has a R0 component. */
297	#define PDM_DRVREG_FLAGS_R0 UINT32_C(0x00000020)
298
299	/** @} */
300
301
302	/** PDM Driver Classes.
303	* @{ */
304	/** Mouse input driver. */
305	#define PDM_DRVREG_CLASS_MOUSE RT_BIT(0)
306	/** Keyboard input driver. */
307	#define PDM_DRVREG_CLASS_KEYBOARD RT_BIT(1)
308	/** Display driver. */
309	#define PDM_DRVREG_CLASS_DISPLAY RT_BIT(2)
310	/** Network transport driver. */
311	#define PDM_DRVREG_CLASS_NETWORK RT_BIT(3)
312	/** Block driver. */
313	#define PDM_DRVREG_CLASS_BLOCK RT_BIT(4)
314	/** Media driver. */
315	#define PDM_DRVREG_CLASS_MEDIA RT_BIT(5)
316	/** Mountable driver. */
317	#define PDM_DRVREG_CLASS_MOUNTABLE RT_BIT(6)
318	/** Audio driver. */
319	#define PDM_DRVREG_CLASS_AUDIO RT_BIT(7)
320	/** VMMDev driver. */
321	#define PDM_DRVREG_CLASS_VMMDEV RT_BIT(8)
322	/** Status driver. */
323	#define PDM_DRVREG_CLASS_STATUS RT_BIT(9)
324	/** ACPI driver. */
325	#define PDM_DRVREG_CLASS_ACPI RT_BIT(10)
326	/** USB related driver. */
327	#define PDM_DRVREG_CLASS_USB RT_BIT(11)
328	/** ISCSI Transport related driver. */
329	#define PDM_DRVREG_CLASS_ISCSITRANSPORT RT_BIT(12)
330	/** Char driver. */
331	#define PDM_DRVREG_CLASS_CHAR RT_BIT(13)
332	/** Stream driver. */
333	#define PDM_DRVREG_CLASS_STREAM RT_BIT(14)
334	/** SCSI driver. */
335	#define PDM_DRVREG_CLASS_SCSI RT_BIT(15)
336	/** @} */
337
338
339	/**
340	* PDM Driver Instance.
341	*
342	* @implements PDMIBASE
343	*/
344	typedef struct PDMDRVINS
345	{
346	/** Structure version. PDM_DRVINS_VERSION defines the current version. */
347	uint32_t u32Version;
348	/** Driver instance number. */
349	uint32_t iInstance;
350
351	/** Pointer the PDM Driver API. */
352	RCPTRTYPE(PCPDMDRVHLPRC) pHlpRC;
353	/** Pointer to driver instance data. */
354	RCPTRTYPE(void *) pvInstanceDataRC;
355
356	/** Pointer the PDM Driver API. */
357	R0PTRTYPE(PCPDMDRVHLPR0) pHlpR0;
358	/** Pointer to driver instance data. */
359	R0PTRTYPE(void *) pvInstanceDataR0;
360
361	/** Pointer the PDM Driver API. */
362	R3PTRTYPE(PCPDMDRVHLPR3) pHlpR3;
363	/** Pointer to driver instance data. */
364	R3PTRTYPE(void *) pvInstanceDataR3;
365
366	/** Pointer to driver registration structure. */
367	R3PTRTYPE(PCPDMDRVREG) pReg;
368	/** Configuration handle. */
369	R3PTRTYPE(PCFGMNODE) pCfg;
370
371	/** Pointer to the base interface of the device/driver instance above. */
372	R3PTRTYPE(PPDMIBASE) pUpBase;
373	/** Pointer to the base interface of the driver instance below. */
374	R3PTRTYPE(PPDMIBASE) pDownBase;
375
376	/** The base interface of the driver.
377	* The driver constructor initializes this. */
378	PDMIBASE IBase;
379	/** Align the internal data more naturally. */
380	RTR3PTR R3PtrPadding;
381
382	/** Internal data. */
383	union
384	{
385	#ifdef PDMDRVINSINT_DECLARED
386	PDMDRVINSINT s;
387	#endif
388	uint8_t padding[HC_ARCH_BITS == 32 ? 40 + 32 : 72 + 24];
389	} Internal;
390
391	/** Driver instance data. The size of this area is defined
392	* in the PDMDRVREG::cbInstanceData field. */
393	char achInstanceData[4];
394	} PDMDRVINS;
395
396	/** Current DRVREG version number. */
397	#define PDM_DRVINS_VERSION PDM_VERSION_MAKE(0xf0fe, 1, 0)
398
399	/** Converts a pointer to the PDMDRVINS::IBase to a pointer to PDMDRVINS. */
400	#define PDMIBASE_2_PDMDRV(pInterface) ( (PPDMDRVINS)((char *)(pInterface) - RT_OFFSETOF(PDMDRVINS, IBase)) )
401
402	/**
403	* Checks the structure versions of the drive instance and driver helpers,
404	* returning if they are incompatible.
405	*
406	* Intended for the constructor.
407	*
408	* @param pDrvIns The drvice instance pointer.
409	*/
410	#define PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns) \
411	do \
412	{ \
413	PPDMDRVINS pDrvInsTypeCheck = (pDrvIns); NOREF(pDrvInsTypeCheck); \
414	AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->u32Version, PDM_DRVINS_VERSION), \
415	("DrvIns=%#x mine=%#x\n", (pDrvIns)->u32Version, PDM_DRVINS_VERSION), \
416	VERR_VERSION_MISMATCH); \
417	AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION), \
418	("DrvHlp=%#x mine=%#x\n", (pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION), \
419	VERR_VERSION_MISMATCH); \
420	} while (0)
421
422	/**
423	* Quietly checks the structure versions of the drive instance and driver
424	* helpers, returning if they are incompatible.
425	*
426	* Intended for the destructor.
427	*
428	* @param pDrvIns The drvice instance pointer.
429	*/
430	#define PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns) \
431	do \
432	{ \
433	PPDMDRVINS pDrvInsTypeCheck = (pDrvIns); NOREF(pDrvInsTypeCheck); \
434	if (RT_UNLIKELY( !PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->u32Version, PDM_DRVINS_VERSION) \
435	\|\| !PDM_VERSION_ARE_COMPATIBLE((pDrvIns)->pHlpR3->u32Version, PDM_DRVHLPR3_VERSION)) ) \
436	return; \
437	} while (0)
438
439
440
441
442	/**
443	* USB hub registration structure.
444	*/
445	typedef struct PDMUSBHUBREG
446	{
447	/** Structure version number. PDM_USBHUBREG_VERSION defines the current version. */
448	uint32_t u32Version;
449
450	/**
451	* Request the hub to attach of the specified device.
452	*
453	* @returns VBox status code.
454	* @param pDrvIns The hub instance.
455	* @param pUsbIns The device to attach.
456	* @param piPort Where to store the port number the device was attached to.
457	* @thread EMT.
458	*/
459	DECLR3CALLBACKMEMBER(int, pfnAttachDevice,(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, uint32_t *piPort));
460
461	/**
462	* Request the hub to detach of the specified device.
463	*
464	* The device has previously been attached to the hub with the
465	* pfnAttachDevice call. This call is not currently expected to
466	* fail.
467	*
468	* @returns VBox status code.
469	* @param pDrvIns The hub instance.
470	* @param pUsbIns The device to detach.
471	* @param iPort The port number returned by the attach call.
472	* @thread EMT.
473	*/
474	DECLR3CALLBACKMEMBER(int, pfnDetachDevice,(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, uint32_t iPort));
475
476	/** Counterpart to u32Version, same value. */
477	uint32_t u32TheEnd;
478	} PDMUSBHUBREG;
479	/** Pointer to a const USB hub registration structure. */
480	typedef const PDMUSBHUBREG *PCPDMUSBHUBREG;
481
482	/** Current PDMUSBHUBREG version number. */
483	#define PDM_USBHUBREG_VERSION PDM_VERSION_MAKE(0xf0fd, 1, 0)
484
485
486	/**
487	* USB hub helpers.
488	* This is currently just a place holder.
489	*/
490	typedef struct PDMUSBHUBHLP
491	{
492	/** Structure version. PDM_USBHUBHLP_VERSION defines the current version. */
493	uint32_t u32Version;
494
495	/** Just a safety precaution. */
496	uint32_t u32TheEnd;
497	} PDMUSBHUBHLP;
498	/** Pointer to PCI helpers. */
499	typedef PDMUSBHUBHLP *PPDMUSBHUBHLP;
500	/** Pointer to const PCI helpers. */
501	typedef const PDMUSBHUBHLP *PCPDMUSBHUBHLP;
502	/** Pointer to const PCI helpers pointer. */
503	typedef PCPDMUSBHUBHLP *PPCPDMUSBHUBHLP;
504
505	/** Current PDMUSBHUBHLP version number. */
506	#define PDM_USBHUBHLP_VERSION PDM_VERSION_MAKE(0xf0fc, 1, 0)
507
508
509	/**
510	* PDM Driver API - raw-mode context variant.
511	*/
512	typedef struct PDMDRVHLPRC
513	{
514	/** Structure version. PDM_DRVHLPRC_VERSION defines the current version. */
515	uint32_t u32Version;
516
517	/**
518	* Set the VM error message
519	*
520	* @returns rc.
521	* @param pDrvIns Driver instance.
522	* @param rc VBox status code.
523	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
524	* @param pszFormat Error message format string.
525	* @param ... Error message arguments.
526	*/
527	DECLRCCALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...));
528
529	/**
530	* Set the VM error message
531	*
532	* @returns rc.
533	* @param pDrvIns Driver instance.
534	* @param rc VBox status code.
535	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
536	* @param pszFormat Error message format string.
537	* @param va Error message arguments.
538	*/
539	DECLRCCALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
540
541	/**
542	* Set the VM runtime error message
543	*
544	* @returns VBox status code.
545	* @param pDrvIns Driver instance.
546	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
547	* @param pszErrorId Error ID string.
548	* @param pszFormat Error message format string.
549	* @param ... Error message arguments.
550	*/
551	DECLRCCALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...));
552
553	/**
554	* Set the VM runtime error message
555	*
556	* @returns VBox status code.
557	* @param pDrvIns Driver instance.
558	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
559	* @param pszErrorId Error ID string.
560	* @param pszFormat Error message format string.
561	* @param va Error message arguments.
562	*/
563	DECLRCCALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va));
564
565	/**
566	* Assert that the current thread is the emulation thread.
567	*
568	* @returns True if correct.
569	* @returns False if wrong.
570	* @param pDrvIns Driver instance.
571	* @param pszFile Filename of the assertion location.
572	* @param iLine Linenumber of the assertion location.
573	* @param pszFunction Function of the assertion location.
574	*/
575	DECLRCCALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
576
577	/**
578	* Assert that the current thread is NOT the emulation thread.
579	*
580	* @returns True if correct.
581	* @returns False if wrong.
582	* @param pDrvIns Driver instance.
583	* @param pszFile Filename of the assertion location.
584	* @param iLine Linenumber of the assertion location.
585	* @param pszFunction Function of the assertion location.
586	*/
587	DECLRCCALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
588
589	/** Just a safety precaution. */
590	uint32_t u32TheEnd;
591	} PDMDRVHLPRC;
592	/** Current PDMDRVHLPRC version number. */
593	#define PDM_DRVHLPRC_VERSION PDM_VERSION_MAKE(0xf0f9, 1, 0)
594
595
596	/**
597	* PDM Driver API, ring-0 context.
598	*/
599	typedef struct PDMDRVHLPR0
600	{
601	/** Structure version. PDM_DRVHLPR0_VERSION defines the current version. */
602	uint32_t u32Version;
603
604	/**
605	* Set the VM error message
606	*
607	* @returns rc.
608	* @param pDrvIns Driver instance.
609	* @param rc VBox status code.
610	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
611	* @param pszFormat Error message format string.
612	* @param ... Error message arguments.
613	*/
614	DECLR0CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...));
615
616	/**
617	* Set the VM error message
618	*
619	* @returns rc.
620	* @param pDrvIns Driver instance.
621	* @param rc VBox status code.
622	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
623	* @param pszFormat Error message format string.
624	* @param va Error message arguments.
625	*/
626	DECLR0CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
627
628	/**
629	* Set the VM runtime error message
630	*
631	* @returns VBox status code.
632	* @param pDrvIns Driver instance.
633	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
634	* @param pszErrorId Error ID string.
635	* @param pszFormat Error message format string.
636	* @param ... Error message arguments.
637	*/
638	DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...));
639
640	/**
641	* Set the VM runtime error message
642	*
643	* @returns VBox status code.
644	* @param pDrvIns Driver instance.
645	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
646	* @param pszErrorId Error ID string.
647	* @param pszFormat Error message format string.
648	* @param va Error message arguments.
649	*/
650	DECLR0CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va));
651
652	/**
653	* Assert that the current thread is the emulation thread.
654	*
655	* @returns True if correct.
656	* @returns False if wrong.
657	* @param pDrvIns Driver instance.
658	* @param pszFile Filename of the assertion location.
659	* @param iLine Linenumber of the assertion location.
660	* @param pszFunction Function of the assertion location.
661	*/
662	DECLR0CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
663
664	/**
665	* Assert that the current thread is NOT the emulation thread.
666	*
667	* @returns True if correct.
668	* @returns False if wrong.
669	* @param pDrvIns Driver instance.
670	* @param pszFile Filename of the assertion location.
671	* @param iLine Linenumber of the assertion location.
672	* @param pszFunction Function of the assertion location.
673	*/
674	DECLR0CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
675
676	/** Just a safety precaution. */
677	uint32_t u32TheEnd;
678	} PDMDRVHLPR0;
679	/** Current DRVHLP version number. */
680	#define PDM_DRVHLPR0_VERSION PDM_VERSION_MAKE(0xf0f8, 1, 0)
681
682
683	#ifdef IN_RING3
684
685	/**
686	* PDM Driver API.
687	*/
688	typedef struct PDMDRVHLPR3
689	{
690	/** Structure version. PDM_DRVHLPR3_VERSION defines the current version. */
691	uint32_t u32Version;
692
693	/**
694	* Attaches a driver (chain) to the driver.
695	*
696	* @returns VBox status code.
697	* @param pDrvIns Driver instance.
698	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
699	* @param ppBaseInterface Where to store the pointer to the base interface.
700	*/
701	DECLR3CALLBACKMEMBER(int, pfnAttach,(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface));
702
703	/**
704	* Detach the driver the drivers below us.
705	*
706	* @returns VBox status code.
707	* @param pDrvIns Driver instance.
708	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
709	*/
710	DECLR3CALLBACKMEMBER(int, pfnDetach,(PPDMDRVINS pDrvIns, uint32_t fFlags));
711
712	/**
713	* Detach the driver from the driver above it and destroy this
714	* driver and all drivers below it.
715	*
716	* @returns VBox status code.
717	* @param pDrvIns Driver instance.
718	* @param fFlags PDM_TACH_FLAGS_NOT_HOT_PLUG or 0.
719	*/
720	DECLR3CALLBACKMEMBER(int, pfnDetachSelf,(PPDMDRVINS pDrvIns, uint32_t fFlags));
721
722	/**
723	* Prepare a media mount.
724	*
725	* The driver must not have anything attached to itself
726	* when calling this function as the purpose is to set up the configuration
727	* of an future attachment.
728	*
729	* @returns VBox status code
730	* @param pDrvIns Driver instance.
731	* @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
732	* constructed a configuration which can be attached to the bottom driver.
733	* @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
734	*/
735	DECLR3CALLBACKMEMBER(int, pfnMountPrepare,(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver));
736
737	/**
738	* Assert that the current thread is 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	DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
748
749	/**
750	* Assert that the current thread is NOT the emulation thread.
751	*
752	* @returns True if correct.
753	* @returns False if wrong.
754	* @param pDrvIns Driver instance.
755	* @param pszFile Filename of the assertion location.
756	* @param iLine Linenumber of the assertion location.
757	* @param pszFunction Function of the assertion location.
758	*/
759	DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char pszFile, unsigned iLine, const char pszFunction));
760
761	/**
762	* Set the VM error message
763	*
764	* @returns rc.
765	* @param pDrvIns Driver instance.
766	* @param rc VBox status code.
767	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
768	* @param pszFormat Error message format string.
769	* @param ... Error message arguments.
770	*/
771	DECLR3CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...));
772
773	/**
774	* Set the VM error message
775	*
776	* @returns rc.
777	* @param pDrvIns Driver instance.
778	* @param rc VBox status code.
779	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
780	* @param pszFormat Error message format string.
781	* @param va Error message arguments.
782	*/
783	DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
784
785	/**
786	* Set the VM runtime error message
787	*
788	* @returns VBox status code.
789	* @param pDrvIns Driver instance.
790	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
791	* @param pszErrorId Error ID string.
792	* @param pszFormat Error message format string.
793	* @param ... Error message arguments.
794	*/
795	DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...));
796
797	/**
798	* Set the VM runtime error message
799	*
800	* @returns VBox status code.
801	* @param pDrvIns Driver instance.
802	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
803	* @param pszErrorId Error ID string.
804	* @param pszFormat Error message format string.
805	* @param va Error message arguments.
806	*/
807	DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va));
808
809	/**
810	* Gets the VM state.
811	*
812	* @returns VM state.
813	* @param pDrvIns The driver instance.
814	* @thread Any thread (just keep in mind that it's volatile info).
815	*/
816	DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMDRVINS pDrvIns));
817
818	/**
819	* Checks if the VM was teleported and hasn't been fully resumed yet.
820	*
821	* @returns true / false.
822	* @param pDrvIns The driver instance.
823	* @thread Any thread.
824	*/
825	DECLR3CALLBACKMEMBER(bool, pfnVMTeleportedAndNotFullyResumedYet,(PPDMDRVINS pDrvIns));
826
827	/**
828	* Create a queue.
829	*
830	* @returns VBox status code.
831	* @param pDrvIns Driver instance.
832	* @param cbItem Size a queue item.
833	* @param cItems Number of items in the queue.
834	* @param cMilliesInterval Number of milliseconds between polling the queue.
835	* If 0 then the emulation thread will be notified whenever an item arrives.
836	* @param pfnCallback The consumer function.
837	* @param pszName The queue base name. The instance number will be
838	* appended automatically.
839	* @param ppQueue Where to store the queue handle on success.
840	* @thread The emulation thread.
841	*/
842	DECLR3CALLBACKMEMBER(int, pfnPDMQueueCreate,(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
843	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue));
844
845	/**
846	* Query the virtual timer frequency.
847	*
848	* @returns Frequency in Hz.
849	* @param pDrvIns Driver instance.
850	* @thread Any thread.
851	*/
852	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualFreq,(PPDMDRVINS pDrvIns));
853
854	/**
855	* Query the virtual time.
856	*
857	* @returns The current virtual time.
858	* @param pDrvIns Driver instance.
859	* @thread Any thread.
860	*/
861	DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualTime,(PPDMDRVINS pDrvIns));
862
863	/**
864	* Creates a timer.
865	*
866	* @returns VBox status.
867	* @param pDrvIns Driver instance.
868	* @param enmClock The clock to use on this timer.
869	* @param pfnCallback Callback function.
870	* @param pvUser The user argument to the callback.
871	* @param fFlags Timer creation flags, see grp_tm_timer_flags.
872	* @param pszDesc Pointer to description string which must stay around
873	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
874	* @param ppTimer Where to store the timer on success.
875	* @thread EMT
876	*/
877	DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void pvUser, uint32_t fFlags, const char pszDesc, PPTMTIMERR3 ppTimer));
878
879	/**
880	* Register a save state data unit.
881	*
882	* @returns VBox status.
883	* @param pDrvIns Driver instance.
884	* @param uVersion Data layout version number.
885	* @param cbGuess The approximate amount of data in the unit.
886	* Only for progress indicators.
887	*
888	* @param pfnLivePrep Prepare live save callback, optional.
889	* @param pfnLiveExec Execute live save callback, optional.
890	* @param pfnLiveVote Vote live save callback, optional.
891	*
892	* @param pfnSavePrep Prepare save callback, optional.
893	* @param pfnSaveExec Execute save callback, optional.
894	* @param pfnSaveDone Done save callback, optional.
895	*
896	* @param pfnLoadPrep Prepare load callback, optional.
897	* @param pfnLoadExec Execute load callback, optional.
898	* @param pfnLoadDone Done load callback, optional.
899	*/
900	DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
901	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
902	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
903	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
904
905	/**
906	* Deregister a save state data unit.
907	*
908	* @returns VBox status.
909	* @param pDrvIns Driver instance.
910	* @param pszName Data unit name.
911	* @param uInstance The instance identifier of the data unit.
912	* This must together with the name be unique.
913	*/
914	DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t uInstance));
915
916	/**
917	* Registers a statistics sample if statistics are enabled.
918	*
919	* @param pDrvIns Driver instance.
920	* @param pvSample Pointer to the sample.
921	* @param enmType Sample type. This indicates what pvSample is pointing at.
922	* @param pszName Sample name. The name is on this form "/<component>/<sample>".
923	* Further nesting is possible.
924	* @param enmUnit Sample unit.
925	* @param pszDesc Sample description.
926	*/
927	DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName,
928	STAMUNIT enmUnit, const char *pszDesc));
929
930	/**
931	* Same as pfnSTAMRegister except that the name is specified in a
932	* RTStrPrintf like fashion.
933	*
934	* @param pDrvIns Driver instance.
935	* @param pvSample Pointer to the sample.
936	* @param enmType Sample type. This indicates what pvSample is pointing at.
937	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
938	* @param enmUnit Sample unit.
939	* @param pszDesc Sample description.
940	* @param pszName The sample name format string.
941	* @param ... Arguments to the format string.
942	*/
943	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
944	STAMUNIT enmUnit, const char pszDesc, const char pszName, ...));
945
946	/**
947	* Same as pfnSTAMRegister except that the name is specified in a
948	* RTStrPrintfV like fashion.
949	*
950	* @param pDrvIns Driver instance.
951	* @param pvSample Pointer to the sample.
952	* @param enmType Sample type. This indicates what pvSample is pointing at.
953	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
954	* @param enmUnit Sample unit.
955	* @param pszDesc Sample description.
956	* @param pszName The sample name format string.
957	* @param args Arguments to the format string.
958	*/
959	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
960	STAMUNIT enmUnit, const char pszDesc, const char pszName, va_list args));
961
962	/**
963	* Deregister a statistic item previously registered with pfnSTAMRegister,
964	* pfnSTAMRegisterF or pfnSTAMRegisterV
965	*
966	* @returns VBox status.
967	* @param pDrvIns Driver instance.
968	* @param pvSample Pointer to the sample.
969	*/
970	DECLR3CALLBACKMEMBER(int, pfnSTAMDeregister,(PPDMDRVINS pDrvIns, void *pvSample));
971
972	/**
973	* Calls the HC R0 VMM entry point, in a safer but slower manner than
974	* SUPR3CallVMMR0.
975	*
976	* When entering using this call the R0 components can call into the host kernel
977	* (i.e. use the SUPR0 and RT APIs).
978	*
979	* See VMMR0Entry() for more details.
980	*
981	* @returns error code specific to uFunction.
982	* @param pDrvIns The driver instance.
983	* @param uOperation Operation to execute.
984	* This is limited to services.
985	* @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
986	* @param cbArg The size of the argument. This is used to copy whatever the argument
987	* points at into a kernel buffer to avoid problems like the user page
988	* being invalidated while we're executing the call.
989	*/
990	DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
991
992	/**
993	* Registers a USB HUB.
994	*
995	* @returns VBox status code.
996	* @param pDrvIns The driver instance.
997	* @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
998	* @param cPorts The number of ports.
999	* @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
1000	* @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
1001	*
1002	* @thread EMT.
1003	*/
1004	DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
1005
1006	/**
1007	* Set up asynchronous handling of a suspend, reset or power off notification.
1008	*
1009	* This shall only be called when getting the notification. It must be called
1010	* for each one.
1011	*
1012	* @returns VBox status code.
1013	* @param pDrvIns The driver instance.
1014	* @param pfnAsyncNotify The callback.
1015	* @thread EMT(0)
1016	*/
1017	DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify));
1018
1019	/**
1020	* Notify EMT(0) that the driver has completed the asynchronous notification
1021	* handling.
1022	*
1023	* This can be called at any time, spurious calls will simply be ignored.
1024	*
1025	* @param pDrvIns The driver instance.
1026	* @thread Any
1027	*/
1028	DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMDRVINS pDrvIns));
1029
1030	/**
1031	* Creates a PDM thread.
1032	*
1033	* This differs from the RTThreadCreate() API in that PDM takes care of suspending,
1034	* resuming, and destroying the thread as the VM state changes.
1035	*
1036	* @returns VBox status code.
1037	* @param pDrvIns The driver instance.
1038	* @param ppThread Where to store the thread 'handle'.
1039	* @param pvUser The user argument to the thread function.
1040	* @param pfnThread The thread function.
1041	* @param pfnWakeup The wakup callback. This is called on the EMT thread when
1042	* a state change is pending.
1043	* @param cbStack See RTThreadCreate.
1044	* @param enmType See RTThreadCreate.
1045	* @param pszName See RTThreadCreate.
1046	*/
1047	DECLR3CALLBACKMEMBER(int, pfnPDMThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1048	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
1049
1050	/**
1051	* Creates a async completion template for a driver instance.
1052	*
1053	* The template is used when creating new completion tasks.
1054	*
1055	* @returns VBox status code.
1056	* @param pDrvIns The driver instance.
1057	* @param ppTemplate Where to store the template pointer on success.
1058	* @param pfnCompleted The completion callback routine.
1059	* @param pvTemplateUser Template user argument.
1060	* @param pszDesc Description.
1061	*/
1062	DECLR3CALLBACKMEMBER(int, pfnPDMAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1063	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void *pvTemplateUser,
1064	const char *pszDesc));
1065
1066
1067	/**
1068	* Resolves the symbol for a raw-mode context interface.
1069	*
1070	* @returns VBox status code.
1071	* @param pDrvIns The driver instance.
1072	* @param pvInterface The interface structure.
1073	* @param cbInterface The size of the interface structure.
1074	* @param pszSymPrefix What to prefix the symbols in the list with before
1075	* resolving them. This must start with 'drv' and
1076	* contain the driver name.
1077	* @param pszSymList List of symbols corresponding to the interface.
1078	* There is generally a there is generally a define
1079	* holding this list associated with the interface
1080	* definition (INTERFACE_SYM_LIST). For more details
1081	* see PDMR3LdrGetInterfaceSymbols.
1082	* @thread EMT
1083	*/
1084	DECLR3CALLBACKMEMBER(int, pfnPDMLdrGetRCInterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1085	const char pszSymPrefix, const char pszSymList));
1086
1087	/**
1088	* Resolves the symbol for a ring-0 context interface.
1089	*
1090	* @returns VBox status code.
1091	* @param pDrvIns The driver instance.
1092	* @param pvInterface The interface structure.
1093	* @param cbInterface The size of the interface structure.
1094	* @param pszSymPrefix What to prefix the symbols in the list with before
1095	* resolving them. This must start with 'drv' and
1096	* contain the driver name.
1097	* @param pszSymList List of symbols corresponding to the interface.
1098	* There is generally a there is generally a define
1099	* holding this list associated with the interface
1100	* definition (INTERFACE_SYM_LIST). For more details
1101	* see PDMR3LdrGetInterfaceSymbols.
1102	* @thread EMT
1103	*/
1104	DECLR3CALLBACKMEMBER(int, pfnPDMLdrGetR0InterfaceSymbols,(PPDMDRVINS pDrvIns, void *pvInterface, size_t cbInterface,
1105	const char pszSymPrefix, const char pszSymList));
1106	/** Just a safety precaution. */
1107	uint32_t u32TheEnd;
1108	} PDMDRVHLPR3;
1109	/** Current DRVHLP version number. */
1110	#define PDM_DRVHLPR3_VERSION PDM_VERSION_MAKE(0xf0fb, 1, 0)
1111
1112	#endif /* IN_RING3 */
1113
1114
1115	/**
1116	* @copydoc PDMDRVHLP::pfnVMSetError
1117	*/
1118	DECLINLINE(int) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
1119	{
1120	va_list va;
1121	va_start(va, pszFormat);
1122	pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1123	va_end(va);
1124	return rc;
1125	}
1126
1127	/** @def PDMDRV_SET_ERROR
1128	* Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
1129	*/
1130	#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
1131	PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
1132
1133	/**
1134	* @copydoc PDMDRVHLP::pfnVMSetErrorV
1135	*/
1136	DECLINLINE(int) PDMDrvHlpVMSetErrorV(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va)
1137	{
1138	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
1139	}
1140
1141
1142	/**
1143	* @copydoc PDMDRVHLP::pfnVMSetRuntimeError
1144	*/
1145	DECLINLINE(int) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, ...)
1146	{
1147	va_list va;
1148	int rc;
1149	va_start(va, pszFormat);
1150	rc = pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1151	va_end(va);
1152	return rc;
1153	}
1154
1155	/** @def PDMDRV_SET_RUNTIME_ERROR
1156	* Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
1157	*/
1158	#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFlags, pszErrorId, pszError) \
1159	PDMDrvHlpVMSetRuntimeError(pDrvIns, fFlags, pszErrorId, "%s", pszError)
1160
1161	/**
1162	* @copydoc PDMDRVHLP::pfnVMSetRuntimeErrorV
1163	*/
1164	DECLINLINE(int) PDMDrvHlpVMSetRuntimeErrorV(PPDMDRVINS pDrvIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va)
1165	{
1166	return pDrvIns->CTX_SUFF(pHlp)->pfnVMSetRuntimeErrorV(pDrvIns, fFlags, pszErrorId, pszFormat, va);
1167	}
1168
1169
1170
1171	/** @def PDMDRV_ASSERT_EMT
1172	* Assert that the current thread is the emulation thread.
1173	*/
1174	#ifdef VBOX_STRICT
1175	# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1176	#else
1177	# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
1178	#endif
1179
1180	/** @def PDMDRV_ASSERT_OTHER
1181	* Assert that the current thread is NOT the emulation thread.
1182	*/
1183	#ifdef VBOX_STRICT
1184	# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->CTX_SUFF(pHlp)->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
1185	#else
1186	# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
1187	#endif
1188
1189
1190	#ifdef IN_RING3
1191
1192	/**
1193	* @copydoc PDMDRVHLP::pfnAttach
1194	*/
1195	DECLINLINE(int) PDMDrvHlpAttach(PPDMDRVINS pDrvIns, uint32_t fFlags, PPDMIBASE *ppBaseInterface)
1196	{
1197	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, fFlags, ppBaseInterface);
1198	}
1199
1200	/**
1201	* Check that there is no driver below the us that we should attach to.
1202	*
1203	* @returns VERR_PDM_NO_ATTACHED_DRIVER if there is no driver.
1204	* @param pDrvIns The driver instance.
1205	*/
1206	DECLINLINE(int) PDMDrvHlpNoAttach(PPDMDRVINS pDrvIns)
1207	{
1208	return pDrvIns->pHlpR3->pfnAttach(pDrvIns, 0, NULL);
1209	}
1210
1211	/**
1212	* @copydoc PDMDRVHLP::pfnDetach
1213	*/
1214	DECLINLINE(int) PDMDrvHlpDetach(PPDMDRVINS pDrvIns, uint32_t fFlags)
1215	{
1216	return pDrvIns->pHlpR3->pfnDetach(pDrvIns, fFlags);
1217	}
1218
1219	/**
1220	* @copydoc PDMDRVHLP::pfnDetachSelf
1221	*/
1222	DECLINLINE(int) PDMDrvHlpDetachSelf(PPDMDRVINS pDrvIns, uint32_t fFlags)
1223	{
1224	return pDrvIns->pHlpR3->pfnDetachSelf(pDrvIns, fFlags);
1225	}
1226
1227	/**
1228	* @copydoc PDMDRVHLP::pfnMountPrepare
1229	*/
1230	DECLINLINE(int) PDMDrvHlpMountPrepare(PPDMDRVINS pDrvIns, const char pszFilename, const char pszCoreDriver)
1231	{
1232	return pDrvIns->pHlpR3->pfnMountPrepare(pDrvIns, pszFilename, pszCoreDriver);
1233	}
1234
1235	/**
1236	* @copydoc PDMDRVHLP::pfnVMState
1237	*/
1238	DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
1239	{
1240	return pDrvIns->CTX_SUFF(pHlp)->pfnVMState(pDrvIns);
1241	}
1242
1243	/**
1244	* @copydoc PDMDRVHLP::pfnVMTeleportedAndNotFullyResumedYet
1245	*/
1246	DECLINLINE(bool) PDMDrvHlpVMTeleportedAndNotFullyResumedYet(PPDMDRVINS pDrvIns)
1247	{
1248	return pDrvIns->pHlpR3->pfnVMTeleportedAndNotFullyResumedYet(pDrvIns);
1249	}
1250
1251	/**
1252	* @copydoc PDMDRVHLP::pfnPDMQueueCreate
1253	*/
1254	DECLINLINE(int) PDMDrvHlpPDMQueueCreate(PPDMDRVINS pDrvIns, uint32_t cbItem, uint32_t cItems, uint32_t cMilliesInterval,
1255	PFNPDMQUEUEDRV pfnCallback, const char pszName, PPDMQUEUE ppQueue)
1256	{
1257	return pDrvIns->pHlpR3->pfnPDMQueueCreate(pDrvIns, cbItem, cItems, cMilliesInterval, pfnCallback, pszName, ppQueue);
1258	}
1259
1260	/**
1261	* @copydoc PDMDRVHLP::pfnTMGetVirtualFreq
1262	*/
1263	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualFreq(PPDMDRVINS pDrvIns)
1264	{
1265	return pDrvIns->pHlpR3->pfnTMGetVirtualFreq(pDrvIns);
1266	}
1267
1268	/**
1269	* @copydoc PDMDRVHLP::pfnTMGetVirtualTime
1270	*/
1271	DECLINLINE(uint64_t) PDMDrvHlpTMGetVirtualTime(PPDMDRVINS pDrvIns)
1272	{
1273	return pDrvIns->pHlpR3->pfnTMGetVirtualTime(pDrvIns);
1274	}
1275
1276	/**
1277	* @copydoc PDMDRVHLP::pfnTMTimerCreate
1278	*/
1279	DECLINLINE(int) PDMDrvHlpTMTimerCreate(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, void pvUser, uint32_t fFlags, const char pszDesc, PPTMTIMERR3 ppTimer)
1280	{
1281	return pDrvIns->pHlpR3->pfnTMTimerCreate(pDrvIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
1282	}
1283
1284	/**
1285	* Register a save state data unit.
1286	*
1287	* @returns VBox status.
1288	* @param pDrvIns Driver instance.
1289	* @param uVersion Data layout version number.
1290	* @param cbGuess The approximate amount of data in the unit.
1291	* Only for progress indicators.
1292	* @param pfnSaveExec Execute save callback, optional.
1293	* @param pfnLoadExec Execute load callback, optional.
1294	*/
1295	DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1296	PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVLOADEXEC pfnLoadExec)
1297	{
1298	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1299	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1300	NULL /pfnSavePrep/, pfnSaveExec, NULL /pfnSaveDone/,
1301	NULL /pfnLoadPrep/, pfnLoadExec, NULL /pfnLoadDone/);
1302	}
1303
1304	/**
1305	* @copydoc PDMDRVHLP::pfnSSMRegister
1306	*/
1307	DECLINLINE(int) PDMDrvHlpSSMRegisterEx(PPDMDRVINS pDrvIns, uint32_t uVersion, size_t cbGuess,
1308	PFNSSMDRVLIVEPREP pfnLivePrep, PFNSSMDRVLIVEEXEC pfnLiveExec, PFNSSMDRVLIVEVOTE pfnLiveVote,
1309	PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
1310	PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
1311	{
1312	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, uVersion, cbGuess,
1313	pfnLivePrep, pfnLiveExec, pfnLiveVote,
1314	pfnSavePrep, pfnSaveExec, pfnSaveDone,
1315	pfnLoadPrep, pfnLoadExec, pfnLoadDone);
1316	}
1317
1318	/**
1319	* Register a load done callback.
1320	*
1321	* @returns VBox status.
1322	* @param pDrvIns Driver instance.
1323	* @param pfnLoadDone Done load callback, optional.
1324	*/
1325	DECLINLINE(int) PDMDrvHlpSSMRegisterLoadDone(PPDMDRVINS pDrvIns, PFNSSMDRVLOADDONE pfnLoadDone)
1326	{
1327	return pDrvIns->pHlpR3->pfnSSMRegister(pDrvIns, 0 /uVersion/, 0 /cbGuess/,
1328	NULL /pfnLivePrep/, NULL /pfnLiveExec/, NULL /pfnLiveVote/,
1329	NULL /pfnSavePrep/, NULL /pfnSaveExec/, NULL /pfnSaveDone/,
1330	NULL /pfnLoadPrep/, NULL /pfnLoadExec/, pfnLoadDone);
1331	}
1332
1333	/**
1334	* @copydoc PDMDRVHLP::pfnSTAMRegister
1335	*/
1336	DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void pvSample, STAMTYPE enmType, const char pszName, STAMUNIT enmUnit, const char *pszDesc)
1337	{
1338	pDrvIns->pHlpR3->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
1339	}
1340
1341	/**
1342	* @copydoc PDMDRVHLP::pfnSTAMRegisterF
1343	*/
1344	DECLINLINE(void) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1345	const char pszDesc, const char pszName, ...)
1346	{
1347	va_list va;
1348	va_start(va, pszName);
1349	pDrvIns->pHlpR3->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
1350	va_end(va);
1351	}
1352
1353	/**
1354	* @copydoc PDMDRVHLP::pfnSTAMDeregister
1355	*/
1356	DECLINLINE(int) PDMDrvHlpSTAMDeregister(PPDMDRVINS pDrvIns, void *pvSample)
1357	{
1358	return pDrvIns->pHlpR3->pfnSTAMDeregister(pDrvIns, pvSample);
1359	}
1360
1361	/**
1362	* @copydoc PDMDRVHLP::pfnSUPCallVMMR0Ex
1363	*/
1364	DECLINLINE(int) PDMDrvHlpSUPCallVMMR0Ex(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg)
1365	{
1366	return pDrvIns->pHlpR3->pfnSUPCallVMMR0Ex(pDrvIns, uOperation, pvArg, cbArg);
1367	}
1368
1369	/**
1370	* @copydoc PDMDRVHLP::pfnUSBRegisterHub
1371	*/
1372	DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
1373	{
1374	return pDrvIns->pHlpR3->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
1375	}
1376
1377	/**
1378	* @copydoc PDMDRVHLP::pfnSetAsyncNotification
1379	*/
1380	DECLINLINE(int) PDMDrvHlpSetAsyncNotification(PPDMDRVINS pDrvIns, PFNPDMDRVASYNCNOTIFY pfnAsyncNotify)
1381	{
1382	return pDrvIns->pHlpR3->pfnSetAsyncNotification(pDrvIns, pfnAsyncNotify);
1383	}
1384
1385	/**
1386	* @copydoc PDMDRVHLP::pfnAsyncNotificationCompleted
1387	*/
1388	DECLINLINE(void) PDMDrvHlpAsyncNotificationCompleted(PPDMDRVINS pDrvIns)
1389	{
1390	pDrvIns->pHlpR3->pfnAsyncNotificationCompleted(pDrvIns);
1391	}
1392
1393	/**
1394	* @copydoc PDMDRVHLP::pfnPDMThreadCreate
1395	*/
1396	DECLINLINE(int) PDMDrvHlpPDMThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
1397	PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
1398	{
1399	return pDrvIns->pHlpR3->pfnPDMThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
1400	}
1401
1402	# ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
1403	/**
1404	* @copydoc PDMDRVHLP::pfnPDMAsyncCompletionTemplateCreate
1405	*/
1406	DECLINLINE(int) PDMDrvHlpPDMAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
1407	PFNPDMASYNCCOMPLETEDRV pfnCompleted, void pvTemplateUser, const char pszDesc)
1408	{
1409	return pDrvIns->pHlpR3->pfnPDMAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pvTemplateUser, pszDesc);
1410	}
1411	# endif
1412
1413
1414	/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
1415	typedef struct PDMDRVREGCB *PPDMDRVREGCB;
1416	/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
1417	typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
1418
1419	/**
1420	* Callbacks for VBoxDriverRegister().
1421	*/
1422	typedef struct PDMDRVREGCB
1423	{
1424	/** Interface version.
1425	* This is set to PDM_DRVREG_CB_VERSION. */
1426	uint32_t u32Version;
1427
1428	/**
1429	* Registers a driver with the current VM instance.
1430	*
1431	* @returns VBox status code.
1432	* @param pCallbacks Pointer to the callback table.
1433	* @param pReg Pointer to the driver registration record.
1434	* This data must be permanent and readonly.
1435	*/
1436	DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pReg));
1437	} PDMDRVREGCB;
1438
1439	/** Current version of the PDMDRVREGCB structure. */
1440	#define PDM_DRVREG_CB_VERSION PDM_VERSION_MAKE(0xf0fa, 1, 0)
1441
1442
1443	/**
1444	* The VBoxDriverRegister callback function.
1445	*
1446	* PDM will invoke this function after loading a driver module and letting
1447	* the module decide which drivers to register and how to handle conflicts.
1448	*
1449	* @returns VBox status code.
1450	* @param pCallbacks Pointer to the callback table.
1451	* @param u32Version VBox version number.
1452	*/
1453	typedef DECLCALLBACK(int) FNPDMVBOXDRIVERSREGISTER(PCPDMDRVREGCB pCallbacks, uint32_t u32Version);
1454
1455	VMMR3DECL(int) PDMR3RegisterDrivers(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
1456
1457	#endif /* IN_RING3 */
1458
1459	/** @} */
1460
1461	RT_C_DECLS_END
1462
1463	#endif

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

source: vbox/trunk/include/VBox/pdmdrv.h@ 27095

Download in other formats: