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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
/** @file
The driver entry point for RamDiskDxe driver.
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "RamDiskImpl.h"
//
// Handle for the EFI_RAM_DISK_PROTOCOL instance
//
EFI_HANDLE mRamDiskHandle = NULL;
//
// The EFI_RAM_DISK_PROTOCOL instances that is installed onto the driver
// handle
//
EFI_RAM_DISK_PROTOCOL mRamDiskProtocol = {
RamDiskRegister,
RamDiskUnregister
};
//
// RamDiskDxe driver maintains a list of registered RAM disks.
//
LIST_ENTRY RegisteredRamDisks;
//
// Pointers to the EFI_ACPI_TABLE_PROTOCOL and EFI_ACPI_SDT_PROTOCOL.
//
EFI_ACPI_TABLE_PROTOCOL *mAcpiTableProtocol = NULL;
EFI_ACPI_SDT_PROTOCOL *mAcpiSdtProtocol = NULL;
/**
Check whether EFI_ACPI_TABLE_PROTOCOL and EFI_ACPI_SDT_PROTOCOL are produced.
If both protocols are produced, publish all the reserved memory type RAM
disks to the NVDIMM Firmware Interface Table (NFIT).
@param[in] Event Event whose notification function is being invoked.
@param[in] Context The pointer to the notification function's context,
which is implementation-dependent.
**/
VOID
EFIAPI
RamDiskAcpiCheck (
IN EFI_EVENT Event,
IN VOID *Context
)
{
EFI_STATUS Status;
LIST_ENTRY *Entry;
RAM_DISK_PRIVATE_DATA *PrivateData;
gBS->CloseEvent (Event);
//
// Locate the EFI_ACPI_TABLE_PROTOCOL.
//
Status = gBS->LocateProtocol (
&gEfiAcpiTableProtocolGuid,
NULL,
(VOID **)&mAcpiTableProtocol
);
if (EFI_ERROR (Status)) {
DEBUG ((
EFI_D_INFO,
"RamDiskAcpiCheck: Cannot locate the EFI ACPI Table Protocol, "
"unable to publish RAM disks to NFIT.\n"
));
return;
}
//
// Locate the EFI_ACPI_SDT_PROTOCOL.
//
Status = gBS->LocateProtocol (
&gEfiAcpiSdtProtocolGuid,
NULL,
(VOID **)&mAcpiSdtProtocol
);
if (EFI_ERROR (Status)) {
DEBUG ((
EFI_D_INFO,
"RamDiskAcpiCheck: Cannot locate the EFI ACPI Sdt Protocol, "
"unable to publish RAM disks to NFIT.\n"
));
mAcpiTableProtocol = NULL;
return;
}
EFI_LIST_FOR_EACH (Entry, &RegisteredRamDisks) {
PrivateData = RAM_DISK_PRIVATE_FROM_THIS (Entry);
RamDiskPublishNfit (PrivateData);
}
}
/**
The entry point for RamDiskDxe driver.
@param[in] ImageHandle The image handle of the driver.
@param[in] SystemTable The system table.
@retval EFI_ALREADY_STARTED The driver already exists in system.
@retval EFI_OUT_OF_RESOURCES Fail to execute entry point due to lack of
resources.
@retval EFI_SUCCES All the related protocols are installed on
the driver.
**/
EFI_STATUS
EFIAPI
RamDiskDxeEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
RAM_DISK_CONFIG_PRIVATE_DATA *ConfigPrivate;
VOID *DummyInterface;
EFI_EVENT Event;
//
// If already started, return.
//
Status = gBS->LocateProtocol (
&gEfiRamDiskProtocolGuid,
NULL,
&DummyInterface
);
if (!EFI_ERROR (Status)) {
DEBUG ((EFI_D_INFO, "Driver already started!\n"));
return EFI_ALREADY_STARTED;
}
//
// Create a private data structure.
//
ConfigPrivate = AllocateCopyPool (sizeof (RAM_DISK_CONFIG_PRIVATE_DATA), &mRamDiskConfigPrivateDataTemplate);
if (ConfigPrivate == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// Install RAM disk configuration form
//
Status = InstallRamDiskConfigForm (ConfigPrivate);
if (EFI_ERROR (Status)) {
goto ErrorExit;
}
//
// Install the EFI_RAM_DISK_PROTOCOL and RAM disk private data onto a
// new handle
//
Status = gBS->InstallMultipleProtocolInterfaces (
&mRamDiskHandle,
&gEfiRamDiskProtocolGuid,
&mRamDiskProtocol,
&gEfiCallerIdGuid,
ConfigPrivate,
NULL
);
if (EFI_ERROR (Status)) {
goto ErrorExit;
}
//
// Initialize the list of registered RAM disks maintained by the driver
//
InitializeListHead (&RegisteredRamDisks);
Status = EfiCreateEventReadyToBootEx (
TPL_CALLBACK,
RamDiskAcpiCheck,
NULL,
&Event
);
ASSERT_EFI_ERROR (Status);
return EFI_SUCCESS;
ErrorExit:
if (ConfigPrivate != NULL) {
UninstallRamDiskConfigForm (ConfigPrivate);
}
return Status;
}
/**
Unload the RamDiskDxe driver and its configuration form.
@param[in] ImageHandle The driver's image handle.
@retval EFI_SUCCESS The RamDiskDxe driver and its configuration
form is unloaded.
@retval Others Failed to unload the form.
**/
EFI_STATUS
EFIAPI
RamDiskDxeUnload (
IN EFI_HANDLE ImageHandle
)
{
EFI_STATUS Status;
RAM_DISK_CONFIG_PRIVATE_DATA *ConfigPrivate;
Status = gBS->HandleProtocol (
mRamDiskHandle,
&gEfiCallerIdGuid,
(VOID **) &ConfigPrivate
);
if (EFI_ERROR (Status)) {
return Status;
}
ASSERT (ConfigPrivate->Signature == RAM_DISK_CONFIG_PRIVATE_DATA_SIGNATURE);
//
// Unregister all registered RAM disks
//
UnregisterAllRamDisks ();
gBS->UninstallMultipleProtocolInterfaces (
mRamDiskHandle,
&gEfiRamDiskProtocolGuid,
&mRamDiskProtocol,
&gEfiCallerIdGuid,
ConfigPrivate,
NULL
);
UninstallRamDiskConfigForm (ConfigPrivate);
return EFI_SUCCESS;
}
|
