1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/* $Id: VBoxSampleDevice.cpp $ */
/** @file
* VBox Sample Device.
*/
/*
* Copyright (C) 2009-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#define LOG_GROUP LOG_GROUP_MISC
#include <VBox/vmm/pdmdev.h>
#include <VBox/version.h>
#include <iprt/errcore.h>
#include <VBox/log.h>
#include <iprt/assert.h>
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* Device Instance Data.
*/
typedef struct VBOXSAMPLEDEVICE
{
uint32_t Whatever;
} VBOXSAMPLEDEVICE;
typedef VBOXSAMPLEDEVICE *PVBOXSAMPLEDEVICE;
static DECLCALLBACK(int) devSampleDestruct(PPDMDEVINS pDevIns)
{
/*
* Check the versions here as well since the destructor is *always* called.
*/
PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
return VINF_SUCCESS;
}
static DECLCALLBACK(int) devSampleConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
{
/*
* Check that the device instance and device helper structures are compatible.
*/
PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
NOREF(pCfg);
/*
* Initialize the instance data so that the destructor won't mess up.
*/
PVBOXSAMPLEDEVICE pThis = PDMINS_2_DATA(pDevIns, PVBOXSAMPLEDEVICE);
pThis->Whatever = 0;
/*
* Validate and read the configuration.
*/
PDMDEV_VALIDATE_CONFIG_RETURN(pDevIns, "Whatever1|Whatever2", "");
/*
* Use the instance number if necessary (not for this device, which in
* g_DeviceSample below declares a maximum instance count of 1).
*/
NOREF(iInstance);
return VINF_SUCCESS;
}
/**
* The device registration structure.
*/
static const PDMDEVREG g_DeviceSample =
{
/* u32Version */
PDM_DEVREG_VERSION,
/* szName */
"sample",
/* szRCMod */
"",
/* szR0Mod */
"",
/* pszDescription */
"VBox Sample Device.",
/* fFlags */
PDM_DEVREG_FLAGS_DEFAULT_BITS,
/* fClass */
PDM_DEVREG_CLASS_MISC,
/* cMaxInstances */
1,
/* cbInstance */
sizeof(VBOXSAMPLEDEVICE),
/* pfnConstruct */
devSampleConstruct,
/* pfnDestruct */
devSampleDestruct,
/* pfnRelocate */
NULL,
/* pfnMemSetup */
NULL,
/* pfnPowerOn */
NULL,
/* pfnReset */
NULL,
/* pfnSuspend */
NULL,
/* pfnResume */
NULL,
/* pfnAttach */
NULL,
/* pfnDetach */
NULL,
/* pfnQueryInterface */
NULL,
/* pfnInitComplete */
NULL,
/* pfnPowerOff */
NULL,
/* pfnSoftReset */
NULL,
/* u32VersionEnd */
PDM_DEVREG_VERSION
};
/**
* Register devices provided by the plugin.
*
* @returns VBox status code.
* @param pCallbacks Pointer to the callback table.
* @param u32Version VBox version number.
*/
extern "C" DECLEXPORT(int) VBoxDevicesRegister(PPDMDEVREGCB pCallbacks, uint32_t u32Version)
{
LogFlow(("VBoxSampleDevice::VBoxDevicesRegister: u32Version=%#x pCallbacks->u32Version=%#x\n", u32Version, pCallbacks->u32Version));
AssertLogRelMsgReturn(u32Version >= VBOX_VERSION,
("VirtualBox version %#x, expected %#x or higher\n", u32Version, VBOX_VERSION),
VERR_VERSION_MISMATCH);
AssertLogRelMsgReturn(pCallbacks->u32Version == PDM_DEVREG_CB_VERSION,
("callback version %#x, expected %#x\n", pCallbacks->u32Version, PDM_DEVREG_CB_VERSION),
VERR_VERSION_MISMATCH);
return pCallbacks->pfnRegister(pCallbacks, &g_DeviceSample);
}
|