Commit | Line | Data |
---|---|---|
20752cb8 HW |
1 | /** @file\r |
2 | The driver entry point for RamDiskDxe driver.\r | |
3 | \r | |
4 | Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r | |
9c463f6f | 5 | Copyright (c) Microsoft Corporation.<BR>\r |
9d510e61 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
20752cb8 HW |
7 | \r |
8 | **/\r | |
9 | \r | |
10 | #include "RamDiskImpl.h"\r | |
11 | \r | |
12 | //\r | |
13 | // Handle for the EFI_RAM_DISK_PROTOCOL instance\r | |
14 | //\r | |
15 | EFI_HANDLE mRamDiskHandle = NULL;\r | |
16 | \r | |
17 | //\r | |
18 | // The EFI_RAM_DISK_PROTOCOL instances that is installed onto the driver\r | |
19 | // handle\r | |
20 | //\r | |
21 | EFI_RAM_DISK_PROTOCOL mRamDiskProtocol = {\r | |
22 | RamDiskRegister,\r | |
23 | RamDiskUnregister\r | |
24 | };\r | |
25 | \r | |
26 | //\r | |
27 | // RamDiskDxe driver maintains a list of registered RAM disks.\r | |
28 | //\r | |
29 | LIST_ENTRY RegisteredRamDisks;\r | |
20752cb8 | 30 | \r |
07a3fecd HW |
31 | //\r |
32 | // Pointers to the EFI_ACPI_TABLE_PROTOCOL and EFI_ACPI_SDT_PROTOCOL.\r | |
33 | //\r | |
34 | EFI_ACPI_TABLE_PROTOCOL *mAcpiTableProtocol = NULL;\r | |
35 | EFI_ACPI_SDT_PROTOCOL *mAcpiSdtProtocol = NULL;\r | |
36 | \r | |
37 | \r | |
38 | /**\r | |
39 | Check whether EFI_ACPI_TABLE_PROTOCOL and EFI_ACPI_SDT_PROTOCOL are produced.\r | |
40 | If both protocols are produced, publish all the reserved memory type RAM\r | |
41 | disks to the NVDIMM Firmware Interface Table (NFIT).\r | |
42 | \r | |
43 | @param[in] Event Event whose notification function is being invoked.\r | |
44 | @param[in] Context The pointer to the notification function's context,\r | |
45 | which is implementation-dependent.\r | |
46 | \r | |
47 | **/\r | |
48 | VOID\r | |
49 | EFIAPI\r | |
50 | RamDiskAcpiCheck (\r | |
51 | IN EFI_EVENT Event,\r | |
52 | IN VOID *Context\r | |
53 | )\r | |
54 | {\r | |
55 | EFI_STATUS Status;\r | |
56 | LIST_ENTRY *Entry;\r | |
57 | RAM_DISK_PRIVATE_DATA *PrivateData;\r | |
58 | \r | |
59 | gBS->CloseEvent (Event);\r | |
60 | \r | |
61 | //\r | |
62 | // Locate the EFI_ACPI_TABLE_PROTOCOL.\r | |
63 | //\r | |
64 | Status = gBS->LocateProtocol (\r | |
65 | &gEfiAcpiTableProtocolGuid,\r | |
66 | NULL,\r | |
67 | (VOID **)&mAcpiTableProtocol\r | |
68 | );\r | |
69 | if (EFI_ERROR (Status)) {\r | |
70 | DEBUG ((\r | |
87000d77 | 71 | DEBUG_INFO,\r |
76874be3 | 72 | "RamDiskAcpiCheck: Cannot locate the EFI ACPI Table Protocol, "\r |
07a3fecd HW |
73 | "unable to publish RAM disks to NFIT.\n"\r |
74 | ));\r | |
75 | return;\r | |
76 | }\r | |
77 | \r | |
78 | //\r | |
79 | // Locate the EFI_ACPI_SDT_PROTOCOL.\r | |
80 | //\r | |
81 | Status = gBS->LocateProtocol (\r | |
82 | &gEfiAcpiSdtProtocolGuid,\r | |
83 | NULL,\r | |
84 | (VOID **)&mAcpiSdtProtocol\r | |
85 | );\r | |
86 | if (EFI_ERROR (Status)) {\r | |
87 | DEBUG ((\r | |
87000d77 | 88 | DEBUG_INFO,\r |
76874be3 | 89 | "RamDiskAcpiCheck: Cannot locate the EFI ACPI Sdt Protocol, "\r |
07a3fecd HW |
90 | "unable to publish RAM disks to NFIT.\n"\r |
91 | ));\r | |
92 | mAcpiTableProtocol = NULL;\r | |
93 | return;\r | |
94 | }\r | |
95 | \r | |
9c463f6f | 96 | BASE_LIST_FOR_EACH (Entry, &RegisteredRamDisks) {\r |
07a3fecd HW |
97 | PrivateData = RAM_DISK_PRIVATE_FROM_THIS (Entry);\r |
98 | RamDiskPublishNfit (PrivateData);\r | |
99 | }\r | |
100 | }\r | |
101 | \r | |
20752cb8 HW |
102 | \r |
103 | /**\r | |
104 | The entry point for RamDiskDxe driver.\r | |
105 | \r | |
106 | @param[in] ImageHandle The image handle of the driver.\r | |
107 | @param[in] SystemTable The system table.\r | |
108 | \r | |
109 | @retval EFI_ALREADY_STARTED The driver already exists in system.\r | |
110 | @retval EFI_OUT_OF_RESOURCES Fail to execute entry point due to lack of\r | |
111 | resources.\r | |
112 | @retval EFI_SUCCES All the related protocols are installed on\r | |
113 | the driver.\r | |
114 | \r | |
115 | **/\r | |
116 | EFI_STATUS\r | |
117 | EFIAPI\r | |
118 | RamDiskDxeEntryPoint (\r | |
119 | IN EFI_HANDLE ImageHandle,\r | |
120 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
121 | )\r | |
122 | {\r | |
123 | EFI_STATUS Status;\r | |
124 | RAM_DISK_CONFIG_PRIVATE_DATA *ConfigPrivate;\r | |
125 | VOID *DummyInterface;\r | |
07a3fecd | 126 | EFI_EVENT Event;\r |
20752cb8 HW |
127 | \r |
128 | //\r | |
129 | // If already started, return.\r | |
130 | //\r | |
131 | Status = gBS->LocateProtocol (\r | |
132 | &gEfiRamDiskProtocolGuid,\r | |
133 | NULL,\r | |
134 | &DummyInterface\r | |
135 | );\r | |
136 | if (!EFI_ERROR (Status)) {\r | |
87000d77 | 137 | DEBUG ((DEBUG_INFO, "Driver already started!\n"));\r |
20752cb8 HW |
138 | return EFI_ALREADY_STARTED;\r |
139 | }\r | |
140 | \r | |
141 | //\r | |
142 | // Create a private data structure.\r | |
143 | //\r | |
144 | ConfigPrivate = AllocateCopyPool (sizeof (RAM_DISK_CONFIG_PRIVATE_DATA), &mRamDiskConfigPrivateDataTemplate);\r | |
145 | if (ConfigPrivate == NULL) {\r | |
146 | return EFI_OUT_OF_RESOURCES;\r | |
147 | }\r | |
148 | \r | |
149 | //\r | |
150 | // Install RAM disk configuration form\r | |
151 | //\r | |
152 | Status = InstallRamDiskConfigForm (ConfigPrivate);\r | |
153 | if (EFI_ERROR (Status)) {\r | |
154 | goto ErrorExit;\r | |
155 | }\r | |
156 | \r | |
d0b6596b TH |
157 | //\r |
158 | // Initialize the list of registered RAM disks maintained by the driver\r | |
159 | // before installing the protocol\r | |
160 | //\r | |
161 | InitializeListHead (&RegisteredRamDisks);\r | |
162 | \r | |
20752cb8 HW |
163 | //\r |
164 | // Install the EFI_RAM_DISK_PROTOCOL and RAM disk private data onto a\r | |
165 | // new handle\r | |
166 | //\r | |
167 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
168 | &mRamDiskHandle,\r | |
169 | &gEfiRamDiskProtocolGuid,\r | |
170 | &mRamDiskProtocol,\r | |
171 | &gEfiCallerIdGuid,\r | |
172 | ConfigPrivate,\r | |
173 | NULL\r | |
174 | );\r | |
175 | if (EFI_ERROR (Status)) {\r | |
176 | goto ErrorExit;\r | |
177 | }\r | |
178 | \r | |
07a3fecd HW |
179 | Status = EfiCreateEventReadyToBootEx (\r |
180 | TPL_CALLBACK,\r | |
181 | RamDiskAcpiCheck,\r | |
182 | NULL,\r | |
183 | &Event\r | |
184 | );\r | |
185 | ASSERT_EFI_ERROR (Status);\r | |
186 | \r | |
20752cb8 HW |
187 | return EFI_SUCCESS;\r |
188 | \r | |
189 | ErrorExit:\r | |
190 | if (ConfigPrivate != NULL) {\r | |
191 | UninstallRamDiskConfigForm (ConfigPrivate);\r | |
192 | }\r | |
193 | \r | |
194 | return Status;\r | |
195 | }\r | |
196 | \r | |
197 | \r | |
198 | /**\r | |
199 | Unload the RamDiskDxe driver and its configuration form.\r | |
200 | \r | |
201 | @param[in] ImageHandle The driver's image handle.\r | |
202 | \r | |
203 | @retval EFI_SUCCESS The RamDiskDxe driver and its configuration\r | |
204 | form is unloaded.\r | |
205 | @retval Others Failed to unload the form.\r | |
206 | \r | |
207 | **/\r | |
208 | EFI_STATUS\r | |
209 | EFIAPI\r | |
210 | RamDiskDxeUnload (\r | |
211 | IN EFI_HANDLE ImageHandle\r | |
212 | )\r | |
213 | {\r | |
214 | EFI_STATUS Status;\r | |
215 | RAM_DISK_CONFIG_PRIVATE_DATA *ConfigPrivate;\r | |
216 | \r | |
217 | Status = gBS->HandleProtocol (\r | |
218 | mRamDiskHandle,\r | |
219 | &gEfiCallerIdGuid,\r | |
220 | (VOID **) &ConfigPrivate\r | |
221 | );\r | |
222 | if (EFI_ERROR (Status)) {\r | |
223 | return Status;\r | |
224 | }\r | |
225 | \r | |
226 | ASSERT (ConfigPrivate->Signature == RAM_DISK_CONFIG_PRIVATE_DATA_SIGNATURE);\r | |
227 | \r | |
228 | //\r | |
229 | // Unregister all registered RAM disks\r | |
230 | //\r | |
231 | UnregisterAllRamDisks ();\r | |
232 | \r | |
233 | gBS->UninstallMultipleProtocolInterfaces (\r | |
234 | mRamDiskHandle,\r | |
235 | &gEfiRamDiskProtocolGuid,\r | |
236 | &mRamDiskProtocol,\r | |
237 | &gEfiCallerIdGuid,\r | |
238 | ConfigPrivate,\r | |
239 | NULL\r | |
240 | );\r | |
241 | \r | |
242 | UninstallRamDiskConfigForm (ConfigPrivate);\r | |
243 | \r | |
244 | return EFI_SUCCESS;\r | |
245 | }\r |