VirtualBox

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

Last change on this file since 12954 was 12476, checked in by vboxsync, 16 years ago

BusLogic: Complete the device part.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 34.3 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Drivers.
3 */
4
5/*
6 * Copyright (C) 2006-2007 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/tm.h>
39#include <VBox/ssm.h>
40#include <VBox/cfgm.h>
41#include <VBox/dbgf.h>
42#include <VBox/mm.h>
43#include <VBox/err.h>
44#include <iprt/stdarg.h>
45
46#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
47# include <VBox/pdmasynccompletion.h>
48#endif
49
50__BEGIN_DECLS
51
52/** @defgroup grp_pdm_driver Drivers
53 * @ingroup grp_pdm
54 * @{
55 */
56
57/**
58 * Construct a driver instance for a VM.
59 *
60 * @returns VBox status.
61 * @param pDrvIns The driver instance data.
62 * If the registration structure is needed, pDrvIns->pDrvReg points to it.
63 * @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration
64 * of the driver instance. It's also found in pDrvIns->pCfgHandle as it's expected
65 * to be used frequently in this function.
66 */
67typedef DECLCALLBACK(int) FNPDMDRVCONSTRUCT(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle);
68/** Pointer to a FNPDMDRVCONSTRUCT() function. */
69typedef FNPDMDRVCONSTRUCT *PFNPDMDRVCONSTRUCT;
70
71/**
72 * Destruct a driver instance.
73 *
74 * Most VM resources are freed by the VM. This callback is provided so that
75 * any non-VM resources can be freed correctly.
76 *
77 * @param pDrvIns The driver instance data.
78 */
79typedef DECLCALLBACK(void) FNPDMDRVDESTRUCT(PPDMDRVINS pDrvIns);
80/** Pointer to a FNPDMDRVDESTRUCT() function. */
81typedef FNPDMDRVDESTRUCT *PFNPDMDRVDESTRUCT;
82
83/**
84 * Driver I/O Control interface.
85 *
86 * This is used by external components, such as the COM interface, to
87 * communicate with a driver using a driver specific interface. Generally,
88 * the driver interfaces are used for this task.
89 *
90 * @returns VBox status code.
91 * @param pDrvIns Pointer to the driver instance.
92 * @param uFunction Function to perform.
93 * @param pvIn Pointer to input data.
94 * @param cbIn Size of input data.
95 * @param pvOut Pointer to output data.
96 * @param cbOut Size of output data.
97 * @param pcbOut Where to store the actual size of the output data.
98 */
99typedef DECLCALLBACK(int) FNPDMDRVIOCTL(PPDMDRVINS pDrvIns, RTUINT uFunction,
100 void *pvIn, RTUINT cbIn,
101 void *pvOut, RTUINT cbOut, PRTUINT pcbOut);
102/** Pointer to a FNPDMDRVIOCTL() function. */
103typedef FNPDMDRVIOCTL *PFNPDMDRVIOCTL;
104
105/**
106 * Power On notification.
107 *
108 * @param pDrvIns The driver instance data.
109 */
110typedef DECLCALLBACK(void) FNPDMDRVPOWERON(PPDMDRVINS pDrvIns);
111/** Pointer to a FNPDMDRVPOWERON() function. */
112typedef FNPDMDRVPOWERON *PFNPDMDRVPOWERON;
113
114/**
115 * Reset notification.
116 *
117 * @returns VBox status.
118 * @param pDrvIns The driver instance data.
119 */
120typedef DECLCALLBACK(void) FNPDMDRVRESET(PPDMDRVINS pDrvIns);
121/** Pointer to a FNPDMDRVRESET() function. */
122typedef FNPDMDRVRESET *PFNPDMDRVRESET;
123
124/**
125 * Suspend notification.
126 *
127 * @returns VBox status.
128 * @param pDrvIns The driver instance data.
129 */
130typedef DECLCALLBACK(void) FNPDMDRVSUSPEND(PPDMDRVINS pDrvIns);
131/** Pointer to a FNPDMDRVSUSPEND() function. */
132typedef FNPDMDRVSUSPEND *PFNPDMDRVSUSPEND;
133
134/**
135 * Resume notification.
136 *
137 * @returns VBox status.
138 * @param pDrvIns The driver instance data.
139 */
140typedef DECLCALLBACK(void) FNPDMDRVRESUME(PPDMDRVINS pDrvIns);
141/** Pointer to a FNPDMDRVRESUME() function. */
142typedef FNPDMDRVRESUME *PFNPDMDRVRESUME;
143
144/**
145 * Power Off notification.
146 *
147 * @param pDrvIns The driver instance data.
148 */
149typedef DECLCALLBACK(void) FNPDMDRVPOWEROFF(PPDMDRVINS pDrvIns);
150/** Pointer to a FNPDMDRVPOWEROFF() function. */
151typedef FNPDMDRVPOWEROFF *PFNPDMDRVPOWEROFF;
152
153/**
154 * Detach notification.
155 *
156 * This is called when a driver below it in the chain is detaching itself
157 * from it. The driver should adjust it's state to reflect this.
158 *
159 * This is like ejecting a cdrom or floppy.
160 *
161 * @param pDrvIns The driver instance.
162 */
163typedef DECLCALLBACK(void) FNPDMDRVDETACH(PPDMDRVINS pDrvIns);
164/** Pointer to a FNPDMDRVDETACH() function. */
165typedef FNPDMDRVDETACH *PFNPDMDRVDETACH;
166
167
168
169/** PDM Driver Registration Structure,
170 * This structure is used when registering a driver from
171 * VBoxInitDrivers() (HC Ring-3). PDM will continue use till
172 * the VM is terminated.
173 */
174typedef struct PDMDRVREG
175{
176 /** Structure version. PDM_DRVREG_VERSION defines the current version. */
177 uint32_t u32Version;
178 /** Driver name. */
179 char szDriverName[32];
180 /** The description of the driver. The UTF-8 string pointed to shall, like this structure,
181 * remain unchanged from registration till VM destruction. */
182 const char *pszDescription;
183
184 /** Flags, combination of the PDM_DRVREG_FLAGS_* \#defines. */
185 RTUINT fFlags;
186 /** Driver class(es), combination of the PDM_DRVREG_CLASS_* \#defines. */
187 RTUINT fClass;
188 /** Maximum number of instances (per VM). */
189 RTUINT cMaxInstances;
190 /** Size of the instance data. */
191 RTUINT cbInstance;
192
193 /** Construct instance - required. */
194 PFNPDMDRVCONSTRUCT pfnConstruct;
195 /** Destruct instance - optional. */
196 PFNPDMDRVDESTRUCT pfnDestruct;
197 /** I/O control - optional. */
198 PFNPDMDRVIOCTL pfnIOCtl;
199 /** Power on notification - optional. */
200 PFNPDMDRVPOWERON pfnPowerOn;
201 /** Reset notification - optional. */
202 PFNPDMDRVRESET pfnReset;
203 /** Suspend notification - optional. */
204 PFNPDMDRVSUSPEND pfnSuspend;
205 /** Resume notification - optional. */
206 PFNPDMDRVRESUME pfnResume;
207 /** Detach notification - optional. */
208 PFNPDMDRVDETACH pfnDetach;
209 /** Power off notification - optional. */
210 PFNPDMDRVPOWEROFF pfnPowerOff;
211
212} PDMDRVREG;
213/** Pointer to a PDM Driver Structure. */
214typedef PDMDRVREG *PPDMDRVREG;
215/** Const pointer to a PDM Driver Structure. */
216typedef PDMDRVREG const *PCPDMDRVREG;
217
218/** Current DRVREG version number. */
219#define PDM_DRVREG_VERSION 0x80010000
220
221/** PDM Device Flags.
222 * @{ */
223/** @def PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT
224 * The bit count for the current host. */
225#if HC_ARCH_BITS == 32
226# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT 0x000000001
227#elif HC_ARCH_BITS == 64
228# define PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT 0x000000002
229#else
230# error Unsupported HC_ARCH_BITS value.
231#endif
232/** The host bit count mask. */
233#define PDM_DRVREG_FLAGS_HOST_BITS_MASK 0x000000003
234
235/** @} */
236
237
238/** PDM Driver Classes.
239 * @{ */
240/** Mouse input driver. */
241#define PDM_DRVREG_CLASS_MOUSE RT_BIT(0)
242/** Keyboard input driver. */
243#define PDM_DRVREG_CLASS_KEYBOARD RT_BIT(1)
244/** Display driver. */
245#define PDM_DRVREG_CLASS_DISPLAY RT_BIT(2)
246/** Network transport driver. */
247#define PDM_DRVREG_CLASS_NETWORK RT_BIT(3)
248/** Block driver. */
249#define PDM_DRVREG_CLASS_BLOCK RT_BIT(4)
250/** Media driver. */
251#define PDM_DRVREG_CLASS_MEDIA RT_BIT(5)
252/** Mountable driver. */
253#define PDM_DRVREG_CLASS_MOUNTABLE RT_BIT(6)
254/** Audio driver. */
255#define PDM_DRVREG_CLASS_AUDIO RT_BIT(7)
256/** VMMDev driver. */
257#define PDM_DRVREG_CLASS_VMMDEV RT_BIT(8)
258/** Status driver. */
259#define PDM_DRVREG_CLASS_STATUS RT_BIT(9)
260/** ACPI driver. */
261#define PDM_DRVREG_CLASS_ACPI RT_BIT(10)
262/** USB related driver. */
263#define PDM_DRVREG_CLASS_USB RT_BIT(11)
264/** ISCSI Transport related driver. */
265#define PDM_DRVREG_CLASS_ISCSITRANSPORT RT_BIT(12)
266/** Char driver. */
267#define PDM_DRVREG_CLASS_CHAR RT_BIT(13)
268/** Stream driver. */
269#define PDM_DRVREG_CLASS_STREAM RT_BIT(14)
270/** SCSI driver. */
271#define PDM_DRVREG_CLASS_SCSI RT_BIT(15)
272/** @} */
273
274
275/**
276 * USB hub registration structure.
277 */
278typedef struct PDMUSBHUBREG
279{
280 /** Structure version number. PDM_USBHUBREG_VERSION defines the current version. */
281 uint32_t u32Version;
282
283 /**
284 * Request the hub to attach of the specified device.
285 *
286 * @returns VBox status code.
287 * @param pDrvIns The hub instance.
288 * @param pUsbIns The device to attach.
289 * @param piPort Where to store the port number the device was attached to.
290 * @thread EMT.
291 */
292 DECLR3CALLBACKMEMBER(int, pfnAttachDevice,(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, uint32_t *piPort));
293
294 /**
295 * Request the hub to detach of the specified device.
296 *
297 * The device has previously been attached to the hub with the
298 * pfnAttachDevice call. This call is not currently expected to
299 * fail.
300 *
301 * @returns VBox status code.
302 * @param pDrvIns The hub instance.
303 * @param pUsbIns The device to detach.
304 * @param iPort The port number returned by the attach call.
305 * @thread EMT.
306 */
307 DECLR3CALLBACKMEMBER(int, pfnDetachDevice,(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, uint32_t iPort));
308
309 /** Counterpart to u32Version, same value. */
310 uint32_t u32TheEnd;
311} PDMUSBHUBREG;
312/** Pointer to a const USB hub registration structure. */
313typedef const PDMUSBHUBREG *PCPDMUSBHUBREG;
314
315/** Current PDMUSBHUBREG version number. */
316#define PDM_USBHUBREG_VERSION 0xeb010000
317
318
319/**
320 * USB hub helpers.
321 * This is currently just a place holder.
322 */
323typedef struct PDMUSBHUBHLP
324{
325 /** Structure version. PDM_USBHUBHLP_VERSION defines the current version. */
326 uint32_t u32Version;
327
328 /** Just a safety precaution. */
329 uint32_t u32TheEnd;
330} PDMUSBHUBHLP;
331/** Pointer to PCI helpers. */
332typedef PDMUSBHUBHLP *PPDMUSBHUBHLP;
333/** Pointer to const PCI helpers. */
334typedef const PDMUSBHUBHLP *PCPDMUSBHUBHLP;
335/** Pointer to const PCI helpers pointer. */
336typedef PCPDMUSBHUBHLP *PPCPDMUSBHUBHLP;
337
338/** Current PDMUSBHUBHLP version number. */
339#define PDM_USBHUBHLP_VERSION 0xea010000
340
341
342
343/**
344 * Poller callback.
345 *
346 * @param pDrvIns The driver instance.
347 */
348typedef DECLCALLBACK(void) FNPDMDRVPOLLER(PPDMDRVINS pDrvIns);
349/** Pointer to a FNPDMDRVPOLLER function. */
350typedef FNPDMDRVPOLLER *PFNPDMDRVPOLLER;
351
352#ifdef IN_RING3
353/**
354 * PDM Driver API.
355 */
356typedef struct PDMDRVHLP
357{
358 /** Structure version. PDM_DRVHLP_VERSION defines the current version. */
359 uint32_t u32Version;
360
361 /**
362 * Attaches a driver (chain) to the driver.
363 *
364 * @returns VBox status code.
365 * @param pDrvIns Driver instance.
366 * @param ppBaseInterface Where to store the pointer to the base interface.
367 */
368 DECLR3CALLBACKMEMBER(int, pfnAttach,(PPDMDRVINS pDrvIns, PPDMIBASE *ppBaseInterface));
369
370 /**
371 * Detach the driver the drivers below us.
372 *
373 * @returns VBox status code.
374 * @param pDrvIns Driver instance.
375 */
376 DECLR3CALLBACKMEMBER(int, pfnDetach,(PPDMDRVINS pDrvIns));
377
378 /**
379 * Detach the driver from the driver above it and destroy this
380 * driver and all drivers below it.
381 *
382 * @returns VBox status code.
383 * @param pDrvIns Driver instance.
384 */
385 DECLR3CALLBACKMEMBER(int, pfnDetachSelf,(PPDMDRVINS pDrvIns));
386
387 /**
388 * Prepare a media mount.
389 *
390 * The driver must not have anything attached to itself
391 * when calling this function as the purpose is to set up the configuration
392 * of an future attachment.
393 *
394 * @returns VBox status code
395 * @param pDrvIns Driver instance.
396 * @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
397 * constructed a configuration which can be attached to the bottom driver.
398 * @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
399 */
400 DECLR3CALLBACKMEMBER(int, pfnMountPrepare,(PPDMDRVINS pDrvIns, const char *pszFilename, const char *pszCoreDriver));
401
402 /**
403 * Assert that the current thread is the emulation thread.
404 *
405 * @returns True if correct.
406 * @returns False if wrong.
407 * @param pDrvIns Driver instance.
408 * @param pszFile Filename of the assertion location.
409 * @param iLine Linenumber of the assertion location.
410 * @param pszFunction Function of the assertion location.
411 */
412 DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
413
414 /**
415 * Assert that the current thread is NOT the emulation thread.
416 *
417 * @returns True if correct.
418 * @returns False if wrong.
419 * @param pDrvIns Driver instance.
420 * @param pszFile Filename of the assertion location.
421 * @param iLine Linenumber of the assertion location.
422 * @param pszFunction Function of the assertion location.
423 */
424 DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMDRVINS pDrvIns, const char *pszFile, unsigned iLine, const char *pszFunction));
425
426 /**
427 * Set the VM error message
428 *
429 * @returns rc.
430 * @param pDrvIns Driver instance.
431 * @param rc VBox status code.
432 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
433 * @param pszFormat Error message format string.
434 * @param ... Error message arguments.
435 */
436 DECLR3CALLBACKMEMBER(int, pfnVMSetError,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...));
437
438 /**
439 * Set the VM error message
440 *
441 * @returns rc.
442 * @param pDrvIns Driver instance.
443 * @param rc VBox status code.
444 * @param RT_SRC_POS_DECL Use RT_SRC_POS.
445 * @param pszFormat Error message format string.
446 * @param va Error message arguments.
447 */
448 DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMDRVINS pDrvIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
449
450 /**
451 * Set the VM runtime error message
452 *
453 * @returns VBox status code.
454 * @param pDrvIns Driver instance.
455 * @param fFatal Whether it is a fatal error or not.
456 * @param pszErrorID Error ID string.
457 * @param pszFormat Error message format string.
458 * @param ... Error message arguments.
459 */
460 DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeError,(PPDMDRVINS pDrvIns, bool fFatal, const char *pszErrorID, const char *pszFormat, ...));
461
462 /**
463 * Set the VM runtime error message
464 *
465 * @returns VBox status code.
466 * @param pDrvIns Driver instance.
467 * @param fFatal Whether it is a fatal error or not.
468 * @param pszErrorID Error ID string.
469 * @param pszFormat Error message format string.
470 * @param va Error message arguments.
471 */
472 DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMDRVINS pDrvIns, bool fFatal, const char *pszErrorID, const char *pszFormat, va_list va));
473
474 /**
475 * Create a queue.
476 *
477 * @returns VBox status code.
478 * @param pDrvIns Driver instance.
479 * @param cbItem Size a queue item.
480 * @param cItems Number of items in the queue.
481 * @param cMilliesInterval Number of milliseconds between polling the queue.
482 * If 0 then the emulation thread will be notified whenever an item arrives.
483 * @param pfnCallback The consumer function.
484 * @param ppQueue Where to store the queue handle on success.
485 * @thread The emulation thread.
486 */
487 DECLR3CALLBACKMEMBER(int, pfnPDMQueueCreate,(PPDMDRVINS pDrvIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval, PFNPDMQUEUEDRV pfnCallback, PPDMQUEUE *ppQueue));
488
489 /**
490 * Register a poller function.
491 * TEMPORARY HACK FOR NETWORKING! DON'T USE!
492 *
493 * @returns VBox status code.
494 * @param pDrvIns Driver instance.
495 * @param pfnPoller The callback function.
496 */
497 DECLR3CALLBACKMEMBER(int, pfnPDMPollerRegister,(PPDMDRVINS pDrvIns, PFNPDMDRVPOLLER pfnPoller));
498
499 /**
500 * Query the virtual timer frequency.
501 *
502 * @returns Frequency in Hz.
503 * @param pDrvIns Driver instance.
504 * @thread Any thread.
505 */
506 DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualFreq,(PPDMDRVINS pDrvIns));
507
508 /**
509 * Query the virtual time.
510 *
511 * @returns The current virtual time.
512 * @param pDrvIns Driver instance.
513 * @thread Any thread.
514 */
515 DECLR3CALLBACKMEMBER(uint64_t, pfnTMGetVirtualTime,(PPDMDRVINS pDrvIns));
516
517 /**
518 * Creates a timer.
519 *
520 * @returns VBox status.
521 * @param pDrvIns Driver instance.
522 * @param enmClock The clock to use on this timer.
523 * @param pfnCallback Callback function.
524 * @param pszDesc Pointer to description string which must stay around
525 * until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
526 * @param ppTimer Where to store the timer on success.
527 */
528 DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMDRVINS pDrvIns, TMCLOCK enmClock, PFNTMTIMERDRV pfnCallback, const char *pszDesc, PPTMTIMERR3 ppTimer));
529
530 /**
531 * Register a save state data unit.
532 *
533 * @returns VBox status.
534 * @param pDrvIns Driver instance.
535 * @param pszName Data unit name.
536 * @param u32Instance The instance identifier of the data unit.
537 * This must together with the name be unique.
538 * @param u32Version Data layout version number.
539 * @param cbGuess The approximate amount of data in the unit.
540 * Only for progress indicators.
541 * @param pfnSavePrep Prepare save callback, optional.
542 * @param pfnSaveExec Execute save callback, optional.
543 * @param pfnSaveDone Done save callback, optional.
544 * @param pfnLoadPrep Prepare load callback, optional.
545 * @param pfnLoadExec Execute load callback, optional.
546 * @param pfnLoadDone Done load callback, optional.
547 */
548 DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
549 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
550 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone));
551
552 /**
553 * Deregister a save state data unit.
554 *
555 * @returns VBox status.
556 * @param pDrvIns Driver instance.
557 * @param pszName Data unit name.
558 * @param u32Instance The instance identifier of the data unit.
559 * This must together with the name be unique.
560 */
561 DECLR3CALLBACKMEMBER(int, pfnSSMDeregister,(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance));
562
563 /**
564 * Registers a statistics sample if statistics are enabled.
565 *
566 * @param pDrvIns Driver instance.
567 * @param pvSample Pointer to the sample.
568 * @param enmType Sample type. This indicates what pvSample is pointing at.
569 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
570 * Further nesting is possible.
571 * @param enmUnit Sample unit.
572 * @param pszDesc Sample description.
573 */
574 DECLR3CALLBACKMEMBER(void, pfnSTAMRegister,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName,
575 STAMUNIT enmUnit, const char *pszDesc));
576
577 /**
578 * Same as pfnSTAMRegister except that the name is specified in a
579 * RTStrPrintf like fashion.
580 *
581 * @returns VBox status.
582 * @param pDrvIns Driver instance.
583 * @param pvSample Pointer to the sample.
584 * @param enmType Sample type. This indicates what pvSample is pointing at.
585 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
586 * @param enmUnit Sample unit.
587 * @param pszDesc Sample description.
588 * @param pszName The sample name format string.
589 * @param ... Arguments to the format string.
590 */
591 DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterF,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
592 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, ...));
593
594 /**
595 * Same as pfnSTAMRegister except that the name is specified in a
596 * RTStrPrintfV like fashion.
597 *
598 * @returns VBox status.
599 * @param pDrvIns Driver instance.
600 * @param pvSample Pointer to the sample.
601 * @param enmType Sample type. This indicates what pvSample is pointing at.
602 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
603 * @param enmUnit Sample unit.
604 * @param pszDesc Sample description.
605 * @param pszName The sample name format string.
606 * @param args Arguments to the format string.
607 */
608 DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
609 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list args));
610
611 /**
612 * Calls the HC R0 VMM entry point, in a safer but slower manner than SUPCallVMMR0.
613 *
614 * When entering using this call the R0 components can call into the host kernel
615 * (i.e. use the SUPR0 and RT APIs).
616 *
617 * See VMMR0Entry() for more details.
618 *
619 * @returns error code specific to uFunction.
620 * @param pDrvIns The driver instance.
621 * @param uOperation Operation to execute.
622 * This is limited to services.
623 * @param pvArg Pointer to argument structure or if cbArg is 0 just an value.
624 * @param cbArg The size of the argument. This is used to copy whatever the argument
625 * points at into a kernel buffer to avoid problems like the user page
626 * being invalidated while we're executing the call.
627 */
628 DECLR3CALLBACKMEMBER(int, pfnSUPCallVMMR0Ex,(PPDMDRVINS pDrvIns, unsigned uOperation, void *pvArg, unsigned cbArg));
629
630 /**
631 * Registers a USB HUB.
632 *
633 * @returns VBox status code.
634 * @param pDrvIns The driver instance.
635 * @param fVersions Indicates the kinds of USB devices that can be attached to this HUB.
636 * @param cPorts The number of ports.
637 * @param pUsbHubReg The hub callback structure that PDMUsb uses to interact with it.
638 * @param ppUsbHubHlp The helper callback structure that the hub uses to talk to PDMUsb.
639 *
640 * @thread EMT.
641 */
642 DECLR3CALLBACKMEMBER(int, pfnUSBRegisterHub,(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp));
643
644 /**
645 * Creates a PDM thread.
646 *
647 * This differs from the RTThreadCreate() API in that PDM takes care of suspending,
648 * resuming, and destroying the thread as the VM state changes.
649 *
650 * @returns VBox status code.
651 * @param pDrvIns The driver instance.
652 * @param ppThread Where to store the thread 'handle'.
653 * @param pvUser The user argument to the thread function.
654 * @param pfnThread The thread function.
655 * @param pfnWakeup The wakup callback. This is called on the EMT thread when
656 * a state change is pending.
657 * @param cbStack See RTThreadCreate.
658 * @param enmType See RTThreadCreate.
659 * @param pszName See RTThreadCreate.
660 */
661 DECLR3CALLBACKMEMBER(int, pfnPDMThreadCreate,(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
662 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
663
664 /**
665 * Gets the VM state.
666 *
667 * @returns VM state.
668 * @param pDrvIns The driver instance.
669 * @thread Any thread (just keep in mind that it's volatile info).
670 */
671 DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMDRVINS pDrvIns));
672
673#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
674 /**
675 * Creates a async completion template for a driver instance.
676 *
677 * The template is used when creating new completion tasks.
678 *
679 * @returns VBox status code.
680 * @param pDrvIns The driver instance.
681 * @param ppTemplate Where to store the template pointer on success.
682 * @param pfnCompleted The completion callback routine.
683 * @param pszDesc Description.
684 */
685 DECLR3CALLBACKMEMBER(int, pfnPDMAsyncCompletionTemplateCreate,(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
686 PFNPDMASYNCCOMPLETEDRV pfnCompleted, const char *pszDesc));
687#endif
688
689 /** Just a safety precaution. */
690 uint32_t u32TheEnd;
691} PDMDRVHLP;
692/** Pointer PDM Driver API. */
693typedef PDMDRVHLP *PPDMDRVHLP;
694/** Pointer const PDM Driver API. */
695typedef const PDMDRVHLP *PCPDMDRVHLP;
696
697/** Current DRVHLP version number. */
698#define PDM_DRVHLP_VERSION 0x90020001
699
700
701
702/**
703 * PDM Driver Instance.
704 */
705typedef struct PDMDRVINS
706{
707 /** Structure version. PDM_DRVINS_VERSION defines the current version. */
708 uint32_t u32Version;
709
710 /** Internal data. */
711 union
712 {
713#ifdef PDMDRVINSINT_DECLARED
714 PDMDRVINSINT s;
715#endif
716 uint8_t padding[HC_ARCH_BITS == 32 ? 32 : 64];
717 } Internal;
718
719 /** Pointer the PDM Driver API. */
720 R3PTRTYPE(PCPDMDRVHLP) pDrvHlp;
721 /** Pointer to driver registration structure. */
722 R3PTRTYPE(PCPDMDRVREG) pDrvReg;
723 /** Configuration handle. */
724 R3PTRTYPE(PCFGMNODE) pCfgHandle;
725 /** Driver instance number. */
726 RTUINT iInstance;
727 /** Pointer to the base interface of the device/driver instance above. */
728 R3PTRTYPE(PPDMIBASE) pUpBase;
729 /** Pointer to the base interface of the driver instance below. */
730 R3PTRTYPE(PPDMIBASE) pDownBase;
731 /** The base interface of the driver.
732 * The driver constructor initializes this. */
733 PDMIBASE IBase;
734 /* padding to make achInstanceData aligned at 16 byte boundrary. */
735 uint32_t au32Padding[HC_ARCH_BITS == 32 ? 3 : 1];
736 /** Pointer to driver instance data. */
737 R3PTRTYPE(void *) pvInstanceData;
738 /** Driver instance data. The size of this area is defined
739 * in the PDMDRVREG::cbInstanceData field. */
740 char achInstanceData[4];
741} PDMDRVINS;
742
743/** Current DRVREG version number. */
744#define PDM_DRVINS_VERSION 0xa0010000
745
746/** Converts a pointer to the PDMDRVINS::IBase to a pointer to PDMDRVINS. */
747#define PDMIBASE_2_PDMDRV(pInterface) ( (PPDMDRVINS)((char *)(pInterface) - RT_OFFSETOF(PDMDRVINS, IBase)) )
748
749/**
750 * @copydoc PDMDRVHLP::pfnVMSetError
751 */
752DECLINLINE(int) PDMDrvHlpVMSetError(PPDMDRVINS pDrvIns, const int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
753{
754 va_list va;
755 va_start(va, pszFormat);
756 pDrvIns->pDrvHlp->pfnVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
757 va_end(va);
758 return rc;
759}
760
761/** @def PDMDRV_SET_ERROR
762 * Set the VM error. See PDMDrvHlpVMSetError() for printf like message formatting.
763 */
764#define PDMDRV_SET_ERROR(pDrvIns, rc, pszError) \
765 PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, "%s", pszError)
766
767/**
768 * @copydoc PDMDRVHLP::pfnVMSetRuntimeError
769 */
770DECLINLINE(int) PDMDrvHlpVMSetRuntimeError(PPDMDRVINS pDrvIns, bool fFatal, const char *pszErrorID, const char *pszFormat, ...)
771{
772 va_list va;
773 int rc;
774 va_start(va, pszFormat);
775 rc = pDrvIns->pDrvHlp->pfnVMSetRuntimeErrorV(pDrvIns, fFatal, pszErrorID, pszFormat, va);
776 va_end(va);
777 return rc;
778}
779
780/** @def PDMDRV_SET_RUNTIME_ERROR
781 * Set the VM runtime error. See PDMDrvHlpVMSetRuntimeError() for printf like message formatting.
782 */
783#define PDMDRV_SET_RUNTIME_ERROR(pDrvIns, fFatal, pszErrorID, pszError) \
784 PDMDrvHlpVMSetRuntimeError(pDrvIns, fFatal, pszErrorID, "%s", pszError)
785
786#endif /* IN_RING3 */
787
788
789/** @def PDMDRV_ASSERT_EMT
790 * Assert that the current thread is the emulation thread.
791 */
792#ifdef VBOX_STRICT
793# define PDMDRV_ASSERT_EMT(pDrvIns) pDrvIns->pDrvHlp->pfnAssertEMT(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
794#else
795# define PDMDRV_ASSERT_EMT(pDrvIns) do { } while (0)
796#endif
797
798/** @def PDMDRV_ASSERT_OTHER
799 * Assert that the current thread is NOT the emulation thread.
800 */
801#ifdef VBOX_STRICT
802# define PDMDRV_ASSERT_OTHER(pDrvIns) pDrvIns->pDrvHlp->pfnAssertOther(pDrvIns, __FILE__, __LINE__, __FUNCTION__)
803#else
804# define PDMDRV_ASSERT_OTHER(pDrvIns) do { } while (0)
805#endif
806
807
808#ifdef IN_RING3
809/**
810 * @copydoc PDMDRVHLP::pfnSSMRegister
811 */
812DECLINLINE(int) PDMDrvHlpSSMRegister(PPDMDRVINS pDrvIns, const char *pszName, uint32_t u32Instance, uint32_t u32Version, size_t cbGuess,
813 PFNSSMDRVSAVEPREP pfnSavePrep, PFNSSMDRVSAVEEXEC pfnSaveExec, PFNSSMDRVSAVEDONE pfnSaveDone,
814 PFNSSMDRVLOADPREP pfnLoadPrep, PFNSSMDRVLOADEXEC pfnLoadExec, PFNSSMDRVLOADDONE pfnLoadDone)
815{
816 return pDrvIns->pDrvHlp->pfnSSMRegister(pDrvIns, pszName, u32Instance, u32Version, cbGuess,
817 pfnSavePrep, pfnSaveExec, pfnSaveDone,
818 pfnLoadPrep, pfnLoadExec, pfnLoadDone);
819}
820
821
822/**
823 * @copydoc PDMDRVHLP::pfnSTAMRegister
824 */
825DECLINLINE(void) PDMDrvHlpSTAMRegister(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
826{
827 pDrvIns->pDrvHlp->pfnSTAMRegister(pDrvIns, pvSample, enmType, pszName, enmUnit, pszDesc);
828}
829
830/**
831 * @copydoc PDMDRVHLP::pfnSTAMRegisterF
832 */
833DECLINLINE(void) PDMDrvHlpSTAMRegisterF(PPDMDRVINS pDrvIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
834 const char *pszDesc, const char *pszName, ...)
835{
836 va_list va;
837 va_start(va, pszName);
838 pDrvIns->pDrvHlp->pfnSTAMRegisterV(pDrvIns, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
839 va_end(va);
840}
841
842/**
843 * @copydoc PDMDRVHLP::pfnUSBRegisterHub
844 */
845DECLINLINE(int) PDMDrvHlpUSBRegisterHub(PPDMDRVINS pDrvIns, uint32_t fVersions, uint32_t cPorts, PCPDMUSBHUBREG pUsbHubReg, PPCPDMUSBHUBHLP ppUsbHubHlp)
846{
847 return pDrvIns->pDrvHlp->pfnUSBRegisterHub(pDrvIns, fVersions, cPorts, pUsbHubReg, ppUsbHubHlp);
848}
849
850/**
851 * @copydoc PDMDRVHLP::pfnPDMThreadCreate
852 */
853DECLINLINE(int) PDMDrvHlpPDMThreadCreate(PPDMDRVINS pDrvIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADDRV pfnThread,
854 PFNPDMTHREADWAKEUPDRV pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
855{
856 return pDrvIns->pDrvHlp->pfnPDMThreadCreate(pDrvIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
857}
858
859/**
860 * @copydoc PDMDRVHLP::pfnVMState
861 */
862DECLINLINE(VMSTATE) PDMDrvHlpVMState(PPDMDRVINS pDrvIns)
863{
864 return pDrvIns->pDrvHlp->pfnVMState(pDrvIns);
865}
866
867#ifdef VBOX_WITH_PDM_ASYNC_COMPLETION
868/**
869 * @copydoc PDMDRVHLP::pfnPDMAsyncCompletionTemplateCreate
870 */
871DECLINLINE(int) PDMDrvHlpPDMAsyncCompletionTemplateCreate(PPDMDRVINS pDrvIns, PPPDMASYNCCOMPLETIONTEMPLATE ppTemplate,
872 PFNPDMASYNCCOMPLETEDRV pfnCompleted, const char *pszDesc)
873{
874 return pDrvIns->pDrvHlp->pfnPDMAsyncCompletionTemplateCreate(pDrvIns, ppTemplate, pfnCompleted, pszDesc);
875}
876#endif
877
878#endif /* IN_RING3 */
879
880
881
882/** Pointer to callbacks provided to the VBoxDriverRegister() call. */
883typedef struct PDMDRVREGCB *PPDMDRVREGCB;
884/** Pointer to const callbacks provided to the VBoxDriverRegister() call. */
885typedef const struct PDMDRVREGCB *PCPDMDRVREGCB;
886
887/**
888 * Callbacks for VBoxDriverRegister().
889 */
890typedef struct PDMDRVREGCB
891{
892 /** Interface version.
893 * This is set to PDM_DRVREG_CB_VERSION. */
894 uint32_t u32Version;
895
896 /**
897 * Registers a driver with the current VM instance.
898 *
899 * @returns VBox status code.
900 * @param pCallbacks Pointer to the callback table.
901 * @param pDrvReg Pointer to the driver registration record.
902 * This data must be permanent and readonly.
903 */
904 DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMDRVREGCB pCallbacks, PCPDMDRVREG pDrvReg));
905} PDMDRVREGCB;
906
907/** Current version of the PDMDRVREGCB structure. */
908#define PDM_DRVREG_CB_VERSION 0xb0010000
909
910
911/**
912 * The VBoxDriverRegister callback function.
913 *
914 * PDM will invoke this function after loading a driver module and letting
915 * the module decide which drivers to register and how to handle conflicts.
916 *
917 * @returns VBox status code.
918 * @param pCallbacks Pointer to the callback table.
919 * @param u32Version VBox version number.
920 */
921typedef DECLCALLBACK(int) FNPDMVBOXDRIVERSREGISTER(PCPDMDRVREGCB pCallbacks, uint32_t u32Version);
922
923/**
924 * Register external drivers
925 *
926 * @returns VBox status code.
927 * @param pVM The VM to operate on.
928 * @param pfnCallback Driver registration callback
929 */
930PDMR3DECL(int) PDMR3RegisterDrivers(PVM pVM, FNPDMVBOXDRIVERSREGISTER pfnCallback);
931
932/** @} */
933
934__END_DECLS
935
936#endif
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette