]>
Commit | Line | Data |
---|---|---|
31f228cf | 1 | /** @file\r |
2 | DXE Core Main Entry Point\r | |
3 | \r | |
bce776a5 | 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
31f228cf | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | #include "DxeMain.h"\r | |
10 | \r | |
11 | //\r | |
12 | // DXE Core Global Variables for Protocols from PEI\r | |
13 | //\r | |
14 | EFI_HANDLE mDecompressHandle = NULL;\r | |
15 | \r | |
16 | //\r | |
17 | // DXE Core globals for Architecture Protocols\r | |
18 | //\r | |
19 | EFI_SECURITY_ARCH_PROTOCOL *gSecurity = NULL;\r | |
bc2dfdbc | 20 | EFI_SECURITY2_ARCH_PROTOCOL *gSecurity2 = NULL;\r |
31f228cf | 21 | EFI_CPU_ARCH_PROTOCOL *gCpu = NULL;\r |
22 | EFI_METRONOME_ARCH_PROTOCOL *gMetronome = NULL;\r | |
23 | EFI_TIMER_ARCH_PROTOCOL *gTimer = NULL;\r | |
24 | EFI_BDS_ARCH_PROTOCOL *gBds = NULL;\r | |
25 | EFI_WATCHDOG_TIMER_ARCH_PROTOCOL *gWatchdogTimer = NULL;\r | |
26 | \r | |
0803854b | 27 | //\r |
28 | // DXE Core globals for optional protocol dependencies\r | |
29 | //\r | |
30 | EFI_SMM_BASE2_PROTOCOL *gSmmBase2 = NULL;\r | |
31 | \r | |
31f228cf | 32 | //\r |
33 | // DXE Core Global used to update core loaded image protocol handle\r | |
34 | //\r | |
35 | EFI_GUID *gDxeCoreFileName;\r | |
36 | EFI_LOADED_IMAGE_PROTOCOL *gDxeCoreLoadedImage;\r | |
37 | \r | |
38 | //\r | |
39 | // DXE Core Module Variables\r | |
40 | //\r | |
41 | EFI_BOOT_SERVICES mBootServices = {\r | |
42 | {\r | |
43 | EFI_BOOT_SERVICES_SIGNATURE, // Signature\r | |
44 | EFI_BOOT_SERVICES_REVISION, // Revision\r | |
45 | sizeof (EFI_BOOT_SERVICES), // HeaderSize\r | |
46 | 0, // CRC32\r | |
47 | 0 // Reserved\r | |
48 | },\r | |
49 | (EFI_RAISE_TPL) CoreRaiseTpl, // RaiseTPL\r | |
50 | (EFI_RESTORE_TPL) CoreRestoreTpl, // RestoreTPL\r | |
51 | (EFI_ALLOCATE_PAGES) CoreAllocatePages, // AllocatePages\r | |
52 | (EFI_FREE_PAGES) CoreFreePages, // FreePages\r | |
53 | (EFI_GET_MEMORY_MAP) CoreGetMemoryMap, // GetMemoryMap\r | |
54 | (EFI_ALLOCATE_POOL) CoreAllocatePool, // AllocatePool\r | |
55 | (EFI_FREE_POOL) CoreFreePool, // FreePool\r | |
56 | (EFI_CREATE_EVENT) CoreCreateEvent, // CreateEvent\r | |
57 | (EFI_SET_TIMER) CoreSetTimer, // SetTimer\r | |
58 | (EFI_WAIT_FOR_EVENT) CoreWaitForEvent, // WaitForEvent\r | |
59 | (EFI_SIGNAL_EVENT) CoreSignalEvent, // SignalEvent\r | |
60 | (EFI_CLOSE_EVENT) CoreCloseEvent, // CloseEvent\r | |
61 | (EFI_CHECK_EVENT) CoreCheckEvent, // CheckEvent\r | |
62 | (EFI_INSTALL_PROTOCOL_INTERFACE) CoreInstallProtocolInterface, // InstallProtocolInterface\r | |
63 | (EFI_REINSTALL_PROTOCOL_INTERFACE) CoreReinstallProtocolInterface, // ReinstallProtocolInterface\r | |
64 | (EFI_UNINSTALL_PROTOCOL_INTERFACE) CoreUninstallProtocolInterface, // UninstallProtocolInterface\r | |
65 | (EFI_HANDLE_PROTOCOL) CoreHandleProtocol, // HandleProtocol\r | |
66 | (VOID *) NULL, // Reserved\r | |
67 | (EFI_REGISTER_PROTOCOL_NOTIFY) CoreRegisterProtocolNotify, // RegisterProtocolNotify\r | |
68 | (EFI_LOCATE_HANDLE) CoreLocateHandle, // LocateHandle\r | |
69 | (EFI_LOCATE_DEVICE_PATH) CoreLocateDevicePath, // LocateDevicePath\r | |
70 | (EFI_INSTALL_CONFIGURATION_TABLE) CoreInstallConfigurationTable, // InstallConfigurationTable\r | |
71 | (EFI_IMAGE_LOAD) CoreLoadImage, // LoadImage\r | |
72 | (EFI_IMAGE_START) CoreStartImage, // StartImage\r | |
73 | (EFI_EXIT) CoreExit, // Exit\r | |
74 | (EFI_IMAGE_UNLOAD) CoreUnloadImage, // UnloadImage\r | |
75 | (EFI_EXIT_BOOT_SERVICES) CoreExitBootServices, // ExitBootServices\r | |
76 | (EFI_GET_NEXT_MONOTONIC_COUNT) CoreEfiNotAvailableYetArg1, // GetNextMonotonicCount\r | |
77 | (EFI_STALL) CoreStall, // Stall\r | |
78 | (EFI_SET_WATCHDOG_TIMER) CoreSetWatchdogTimer, // SetWatchdogTimer\r | |
79 | (EFI_CONNECT_CONTROLLER) CoreConnectController, // ConnectController\r | |
80 | (EFI_DISCONNECT_CONTROLLER) CoreDisconnectController, // DisconnectController\r | |
81 | (EFI_OPEN_PROTOCOL) CoreOpenProtocol, // OpenProtocol\r | |
82 | (EFI_CLOSE_PROTOCOL) CoreCloseProtocol, // CloseProtocol\r | |
83 | (EFI_OPEN_PROTOCOL_INFORMATION) CoreOpenProtocolInformation, // OpenProtocolInformation\r | |
84 | (EFI_PROTOCOLS_PER_HANDLE) CoreProtocolsPerHandle, // ProtocolsPerHandle\r | |
85 | (EFI_LOCATE_HANDLE_BUFFER) CoreLocateHandleBuffer, // LocateHandleBuffer\r | |
86 | (EFI_LOCATE_PROTOCOL) CoreLocateProtocol, // LocateProtocol\r | |
87 | (EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) CoreInstallMultipleProtocolInterfaces, // InstallMultipleProtocolInterfaces\r | |
88 | (EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) CoreUninstallMultipleProtocolInterfaces, // UninstallMultipleProtocolInterfaces\r | |
89 | (EFI_CALCULATE_CRC32) CoreEfiNotAvailableYetArg3, // CalculateCrc32\r | |
90 | (EFI_COPY_MEM) CopyMem, // CopyMem\r | |
91 | (EFI_SET_MEM) SetMem, // SetMem\r | |
92 | (EFI_CREATE_EVENT_EX) CoreCreateEventEx // CreateEventEx\r | |
93 | };\r | |
94 | \r | |
95 | EFI_DXE_SERVICES mDxeServices = {\r | |
96 | {\r | |
97 | DXE_SERVICES_SIGNATURE, // Signature\r | |
98 | DXE_SERVICES_REVISION, // Revision\r | |
99 | sizeof (DXE_SERVICES), // HeaderSize\r | |
100 | 0, // CRC32\r | |
101 | 0 // Reserved\r | |
102 | },\r | |
103 | (EFI_ADD_MEMORY_SPACE) CoreAddMemorySpace, // AddMemorySpace\r | |
104 | (EFI_ALLOCATE_MEMORY_SPACE) CoreAllocateMemorySpace, // AllocateMemorySpace\r | |
105 | (EFI_FREE_MEMORY_SPACE) CoreFreeMemorySpace, // FreeMemorySpace\r | |
106 | (EFI_REMOVE_MEMORY_SPACE) CoreRemoveMemorySpace, // RemoveMemorySpace\r | |
107 | (EFI_GET_MEMORY_SPACE_DESCRIPTOR) CoreGetMemorySpaceDescriptor, // GetMemorySpaceDescriptor\r | |
108 | (EFI_SET_MEMORY_SPACE_ATTRIBUTES) CoreSetMemorySpaceAttributes, // SetMemorySpaceAttributes\r | |
109 | (EFI_GET_MEMORY_SPACE_MAP) CoreGetMemorySpaceMap, // GetMemorySpaceMap\r | |
110 | (EFI_ADD_IO_SPACE) CoreAddIoSpace, // AddIoSpace\r | |
111 | (EFI_ALLOCATE_IO_SPACE) CoreAllocateIoSpace, // AllocateIoSpace\r | |
112 | (EFI_FREE_IO_SPACE) CoreFreeIoSpace, // FreeIoSpace\r | |
113 | (EFI_REMOVE_IO_SPACE) CoreRemoveIoSpace, // RemoveIoSpace\r | |
114 | (EFI_GET_IO_SPACE_DESCRIPTOR) CoreGetIoSpaceDescriptor, // GetIoSpaceDescriptor\r | |
115 | (EFI_GET_IO_SPACE_MAP) CoreGetIoSpaceMap, // GetIoSpaceMap\r | |
116 | (EFI_DISPATCH) CoreDispatcher, // Dispatch\r | |
117 | (EFI_SCHEDULE) CoreSchedule, // Schedule\r | |
118 | (EFI_TRUST) CoreTrust, // Trust\r | |
119 | (EFI_PROCESS_FIRMWARE_VOLUME) CoreProcessFirmwareVolume, // ProcessFirmwareVolume\r | |
771ee501 | 120 | (EFI_SET_MEMORY_SPACE_CAPABILITIES)CoreSetMemorySpaceCapabilities, // SetMemorySpaceCapabilities\r |
31f228cf | 121 | };\r |
122 | \r | |
123 | EFI_SYSTEM_TABLE mEfiSystemTableTemplate = {\r | |
124 | {\r | |
125 | EFI_SYSTEM_TABLE_SIGNATURE, // Signature\r | |
126 | EFI_SYSTEM_TABLE_REVISION, // Revision\r | |
127 | sizeof (EFI_SYSTEM_TABLE), // HeaderSize\r | |
128 | 0, // CRC32\r | |
129 | 0 // Reserved\r | |
130 | },\r | |
131 | NULL, // FirmwareVendor\r | |
132 | 0, // FirmwareRevision\r | |
133 | NULL, // ConsoleInHandle\r | |
134 | NULL, // ConIn\r | |
135 | NULL, // ConsoleOutHandle\r | |
136 | NULL, // ConOut\r | |
137 | NULL, // StandardErrorHandle\r | |
138 | NULL, // StdErr\r | |
139 | NULL, // RuntimeServices\r | |
140 | &mBootServices, // BootServices\r | |
141 | 0, // NumberOfConfigurationTableEntries\r | |
142 | NULL // ConfigurationTable\r | |
143 | };\r | |
144 | \r | |
145 | EFI_RUNTIME_SERVICES mEfiRuntimeServicesTableTemplate = {\r | |
146 | {\r | |
147 | EFI_RUNTIME_SERVICES_SIGNATURE, // Signature\r | |
148 | EFI_RUNTIME_SERVICES_REVISION, // Revision\r | |
149 | sizeof (EFI_RUNTIME_SERVICES), // HeaderSize\r | |
150 | 0, // CRC32\r | |
151 | 0 // Reserved\r | |
152 | },\r | |
153 | (EFI_GET_TIME) CoreEfiNotAvailableYetArg2, // GetTime\r | |
154 | (EFI_SET_TIME) CoreEfiNotAvailableYetArg1, // SetTime\r | |
155 | (EFI_GET_WAKEUP_TIME) CoreEfiNotAvailableYetArg3, // GetWakeupTime\r | |
156 | (EFI_SET_WAKEUP_TIME) CoreEfiNotAvailableYetArg2, // SetWakeupTime\r | |
157 | (EFI_SET_VIRTUAL_ADDRESS_MAP) CoreEfiNotAvailableYetArg4, // SetVirtualAddressMap\r | |
158 | (EFI_CONVERT_POINTER) CoreEfiNotAvailableYetArg2, // ConvertPointer\r | |
159 | (EFI_GET_VARIABLE) CoreEfiNotAvailableYetArg5, // GetVariable\r | |
160 | (EFI_GET_NEXT_VARIABLE_NAME) CoreEfiNotAvailableYetArg3, // GetNextVariableName\r | |
161 | (EFI_SET_VARIABLE) CoreEfiNotAvailableYetArg5, // SetVariable\r | |
162 | (EFI_GET_NEXT_HIGH_MONO_COUNT) CoreEfiNotAvailableYetArg1, // GetNextHighMonotonicCount\r | |
163 | (EFI_RESET_SYSTEM) CoreEfiNotAvailableYetArg4, // ResetSystem\r | |
164 | (EFI_UPDATE_CAPSULE) CoreEfiNotAvailableYetArg3, // UpdateCapsule\r | |
165 | (EFI_QUERY_CAPSULE_CAPABILITIES) CoreEfiNotAvailableYetArg4, // QueryCapsuleCapabilities\r | |
166 | (EFI_QUERY_VARIABLE_INFO) CoreEfiNotAvailableYetArg4 // QueryVariableInfo\r | |
167 | };\r | |
168 | \r | |
169 | EFI_RUNTIME_ARCH_PROTOCOL gRuntimeTemplate = {\r | |
170 | INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate.ImageHead),\r | |
171 | INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate.EventHead),\r | |
172 | \r | |
173 | //\r | |
174 | // Make sure Size != sizeof (EFI_MEMORY_DESCRIPTOR). This will\r | |
175 | // prevent people from having pointer math bugs in their code.\r | |
176 | // now you have to use *DescriptorSize to make things work.\r | |
177 | //\r | |
178 | sizeof (EFI_MEMORY_DESCRIPTOR) + sizeof (UINT64) - (sizeof (EFI_MEMORY_DESCRIPTOR) % sizeof (UINT64)),\r | |
179 | EFI_MEMORY_DESCRIPTOR_VERSION,\r | |
180 | 0,\r | |
181 | NULL,\r | |
182 | NULL,\r | |
183 | FALSE,\r | |
184 | FALSE\r | |
185 | };\r | |
186 | \r | |
187 | EFI_RUNTIME_ARCH_PROTOCOL *gRuntime = &gRuntimeTemplate;\r | |
188 | \r | |
189 | //\r | |
190 | // DXE Core Global Variables for the EFI System Table, Boot Services Table,\r | |
191 | // DXE Services Table, and Runtime Services Table\r | |
192 | //\r | |
193 | EFI_DXE_SERVICES *gDxeCoreDS = &mDxeServices;\r | |
194 | EFI_SYSTEM_TABLE *gDxeCoreST = NULL;\r | |
195 | \r | |
196 | //\r | |
197 | // For debug initialize gDxeCoreRT to template. gDxeCoreRT must be allocated from RT memory\r | |
198 | // but gDxeCoreRT is used for ASSERT () and DEBUG () type macros so lets give it\r | |
199 | // a value that will not cause debug infrastructure to crash early on.\r | |
200 | //\r | |
201 | EFI_RUNTIME_SERVICES *gDxeCoreRT = &mEfiRuntimeServicesTableTemplate;\r | |
202 | EFI_HANDLE gDxeCoreImageHandle = NULL;\r | |
203 | \r | |
74a88770 | 204 | BOOLEAN gMemoryMapTerminated = FALSE;\r |
31f228cf | 205 | \r |
206 | //\r | |
207 | // EFI Decompress Protocol\r | |
208 | //\r | |
209 | EFI_DECOMPRESS_PROTOCOL gEfiDecompress = {\r | |
210 | DxeMainUefiDecompressGetInfo,\r | |
211 | DxeMainUefiDecompress\r | |
212 | };\r | |
213 | \r | |
214 | //\r | |
e7af83ae | 215 | // For Loading modules at fixed address feature, the configuration table is to cache the top address below which to load\r |
216 | // Runtime code&boot time code\r | |
54ea99a7 | 217 | //\r |
ebfb7bb5 | 218 | GLOBAL_REMOVE_IF_UNREFERENCED EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE gLoadModuleAtFixAddressConfigurationTable = {0, 0};\r |
54ea99a7 | 219 | \r |
31f228cf | 220 | // Main entry point to the DXE Core\r |
221 | //\r | |
222 | \r | |
223 | /**\r | |
224 | Main entry point to DXE Core.\r | |
225 | \r | |
226 | @param HobStart Pointer to the beginning of the HOB List from PEI.\r | |
227 | \r | |
228 | @return This function should never return.\r | |
229 | \r | |
230 | **/\r | |
231 | VOID\r | |
232 | EFIAPI\r | |
233 | DxeMain (\r | |
234 | IN VOID *HobStart\r | |
235 | )\r | |
236 | {\r | |
d0d41b52 | 237 | EFI_STATUS Status;\r |
238 | EFI_PHYSICAL_ADDRESS MemoryBaseAddress;\r | |
239 | UINT64 MemoryLength;\r | |
240 | PE_COFF_LOADER_IMAGE_CONTEXT ImageContext;\r | |
57f360f2 JF |
241 | UINTN Index;\r |
242 | EFI_HOB_GUID_TYPE *GuidHob;\r | |
243 | EFI_VECTOR_HANDOFF_INFO *VectorInfoList;\r | |
244 | EFI_VECTOR_HANDOFF_INFO *VectorInfo;\r | |
1cf4e933 | 245 | VOID *EntryPoint;\r |
31f228cf | 246 | \r |
1e172d6b | 247 | //\r |
248 | // Setup the default exception handlers\r | |
249 | //\r | |
57f360f2 JF |
250 | VectorInfoList = NULL;\r |
251 | GuidHob = GetNextGuidHob (&gEfiVectorHandoffInfoPpiGuid, HobStart);\r | |
252 | if (GuidHob != NULL) {\r | |
253 | VectorInfoList = (EFI_VECTOR_HANDOFF_INFO *) (GET_GUID_HOB_DATA(GuidHob));\r | |
254 | }\r | |
a8ab14d3 | 255 | Status = InitializeCpuExceptionHandlersEx (VectorInfoList, NULL);\r |
57f360f2 | 256 | ASSERT_EFI_ERROR (Status);\r |
d1102dba | 257 | \r |
e7af83ae | 258 | //\r |
259 | // Initialize Debug Agent to support source level debug in DXE phase\r | |
260 | //\r | |
4cf7e038 | 261 | InitializeDebugAgent (DEBUG_AGENT_INIT_DXE_CORE, HobStart, NULL);\r |
e7af83ae | 262 | \r |
31f228cf | 263 | //\r |
264 | // Initialize Memory Services\r | |
265 | //\r | |
266 | CoreInitializeMemoryServices (&HobStart, &MemoryBaseAddress, &MemoryLength);\r | |
267 | \r | |
84edd20b SZ |
268 | MemoryProfileInit (HobStart);\r |
269 | \r | |
31f228cf | 270 | //\r |
271 | // Allocate the EFI System Table and EFI Runtime Service Table from EfiRuntimeServicesData\r | |
272 | // Use the templates to initialize the contents of the EFI System Table and EFI Runtime Services Table\r | |
273 | //\r | |
274 | gDxeCoreST = AllocateRuntimeCopyPool (sizeof (EFI_SYSTEM_TABLE), &mEfiSystemTableTemplate);\r | |
275 | ASSERT (gDxeCoreST != NULL);\r | |
276 | \r | |
277 | gDxeCoreRT = AllocateRuntimeCopyPool (sizeof (EFI_RUNTIME_SERVICES), &mEfiRuntimeServicesTableTemplate);\r | |
278 | ASSERT (gDxeCoreRT != NULL);\r | |
279 | \r | |
280 | gDxeCoreST->RuntimeServices = gDxeCoreRT;\r | |
281 | \r | |
282 | //\r | |
283 | // Start the Image Services.\r | |
284 | //\r | |
285 | Status = CoreInitializeImageServices (HobStart);\r | |
286 | ASSERT_EFI_ERROR (Status);\r | |
287 | \r | |
31f228cf | 288 | //\r |
289 | // Initialize the Global Coherency Domain Services\r | |
290 | //\r | |
291 | Status = CoreInitializeGcdServices (&HobStart, MemoryBaseAddress, MemoryLength);\r | |
292 | ASSERT_EFI_ERROR (Status);\r | |
293 | \r | |
c5d53799 SZ |
294 | //\r |
295 | // Call constructor for all libraries\r | |
296 | //\r | |
297 | ProcessLibraryConstructorList (gDxeCoreImageHandle, gDxeCoreST);\r | |
67e9ab84 BD |
298 | PERF_CROSSMODULE_END ("PEI");\r |
299 | PERF_CROSSMODULE_BEGIN ("DXE");\r | |
c5d53799 | 300 | \r |
31ffa077 SZ |
301 | //\r |
302 | // Report DXE Core image information to the PE/COFF Extra Action Library\r | |
303 | //\r | |
304 | ZeroMem (&ImageContext, sizeof (ImageContext));\r | |
305 | ImageContext.ImageAddress = (EFI_PHYSICAL_ADDRESS)(UINTN)gDxeCoreLoadedImage->ImageBase;\r | |
306 | ImageContext.PdbPointer = PeCoffLoaderGetPdbPointer ((VOID*)(UINTN)ImageContext.ImageAddress);\r | |
307 | ImageContext.SizeOfHeaders = PeCoffGetSizeOfHeaders ((VOID*)(UINTN)ImageContext.ImageAddress);\r | |
308 | Status = PeCoffLoaderGetEntryPoint ((VOID*)(UINTN)ImageContext.ImageAddress, &EntryPoint);\r | |
309 | if (Status == EFI_SUCCESS) {\r | |
310 | ImageContext.EntryPoint = (EFI_PHYSICAL_ADDRESS)(UINTN)EntryPoint;\r | |
311 | }\r | |
dfbc039f AB |
312 | ImageContext.Handle = (VOID *)(UINTN)gDxeCoreLoadedImage->ImageBase;\r |
313 | ImageContext.ImageRead = PeCoffLoaderImageReadFromMemory;\r | |
31ffa077 SZ |
314 | PeCoffLoaderRelocateImageExtraAction (&ImageContext);\r |
315 | \r | |
31f228cf | 316 | //\r |
317 | // Install the DXE Services Table into the EFI System Tables's Configuration Table\r | |
318 | //\r | |
319 | Status = CoreInstallConfigurationTable (&gEfiDxeServicesTableGuid, gDxeCoreDS);\r | |
320 | ASSERT_EFI_ERROR (Status);\r | |
321 | \r | |
322 | //\r | |
323 | // Install the HOB List into the EFI System Tables's Configuration Table\r | |
324 | //\r | |
325 | Status = CoreInstallConfigurationTable (&gEfiHobListGuid, HobStart);\r | |
326 | ASSERT_EFI_ERROR (Status);\r | |
327 | \r | |
328 | //\r | |
329 | // Install Memory Type Information Table into the EFI System Tables's Configuration Table\r | |
330 | //\r | |
331 | Status = CoreInstallConfigurationTable (&gEfiMemoryTypeInformationGuid, &gMemoryTypeInformation);\r | |
332 | ASSERT_EFI_ERROR (Status);\r | |
e7af83ae | 333 | \r |
54ea99a7 | 334 | //\r |
e7af83ae | 335 | // If Loading modules At fixed address feature is enabled, install Load moduels at fixed address\r |
54ea99a7 | 336 | // Configuration Table so that user could easily to retrieve the top address to load Dxe and PEI\r |
e7af83ae | 337 | // Code and Tseg base to load SMM driver.\r |
54ea99a7 | 338 | //\r |
852081fc | 339 | if (PcdGet64(PcdLoadModuleAtFixAddressEnable) != 0) {\r |
54ea99a7 | 340 | Status = CoreInstallConfigurationTable (&gLoadFixedAddressConfigurationTableGuid, &gLoadModuleAtFixAddressConfigurationTable);\r |
341 | ASSERT_EFI_ERROR (Status);\r | |
342 | }\r | |
31f228cf | 343 | //\r |
344 | // Report Status Code here for DXE_ENTRY_POINT once it is available\r | |
345 | //\r | |
346 | REPORT_STATUS_CODE (\r | |
347 | EFI_PROGRESS_CODE,\r | |
f9876ecf | 348 | (EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_ENTRY_POINT)\r |
31f228cf | 349 | );\r |
350 | \r | |
351 | //\r | |
352 | // Create the aligned system table pointer structure that is used by external\r | |
353 | // debuggers to locate the system table... Also, install debug image info\r | |
354 | // configuration table.\r | |
355 | //\r | |
356 | CoreInitializeDebugImageInfoTable ();\r | |
357 | CoreNewDebugImageInfoEntry (\r | |
358 | EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL,\r | |
359 | gDxeCoreLoadedImage,\r | |
360 | gDxeCoreImageHandle\r | |
361 | );\r | |
362 | \r | |
363 | DEBUG ((DEBUG_INFO | DEBUG_LOAD, "HOBLIST address in DXE = 0x%p\n", HobStart));\r | |
364 | \r | |
365 | DEBUG_CODE_BEGIN ();\r | |
366 | EFI_PEI_HOB_POINTERS Hob;\r | |
367 | \r | |
368 | for (Hob.Raw = HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {\r | |
369 | if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_MEMORY_ALLOCATION) {\r | |
8e90dd6b | 370 | DEBUG ((DEBUG_INFO | DEBUG_LOAD, "Memory Allocation 0x%08x 0x%0lx - 0x%0lx\n", \\r |
bfef82a1 | 371 | Hob.MemoryAllocation->AllocDescriptor.MemoryType, \\r |
31f228cf | 372 | Hob.MemoryAllocation->AllocDescriptor.MemoryBaseAddress, \\r |
bfef82a1 | 373 | Hob.MemoryAllocation->AllocDescriptor.MemoryBaseAddress + Hob.MemoryAllocation->AllocDescriptor.MemoryLength - 1));\r |
31f228cf | 374 | }\r |
375 | }\r | |
376 | for (Hob.Raw = HobStart; !END_OF_HOB_LIST(Hob); Hob.Raw = GET_NEXT_HOB(Hob)) {\r | |
c6037045 SZ |
377 | if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_FV) {\r |
378 | DEBUG ((\r | |
379 | DEBUG_INFO | DEBUG_LOAD,\r | |
380 | "FV Hob 0x%0lx - 0x%0lx\n",\r | |
381 | Hob.FirmwareVolume->BaseAddress,\r | |
382 | Hob.FirmwareVolume->BaseAddress + Hob.FirmwareVolume->Length - 1\r | |
383 | ));\r | |
384 | } else if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_FV2) {\r | |
385 | DEBUG ((\r | |
386 | DEBUG_INFO | DEBUG_LOAD,\r | |
387 | "FV2 Hob 0x%0lx - 0x%0lx\n",\r | |
388 | Hob.FirmwareVolume2->BaseAddress,\r | |
389 | Hob.FirmwareVolume2->BaseAddress + Hob.FirmwareVolume2->Length - 1\r | |
390 | ));\r | |
391 | DEBUG ((\r | |
392 | DEBUG_INFO | DEBUG_LOAD,\r | |
393 | " %g - %g\n",\r | |
394 | &Hob.FirmwareVolume2->FvName,\r | |
395 | &Hob.FirmwareVolume2->FileName\r | |
396 | ));\r | |
397 | } else if (GET_HOB_TYPE (Hob) == EFI_HOB_TYPE_FV3) {\r | |
398 | DEBUG ((\r | |
399 | DEBUG_INFO | DEBUG_LOAD,\r | |
400 | "FV3 Hob 0x%0lx - 0x%0lx - 0x%x - 0x%x\n",\r | |
401 | Hob.FirmwareVolume3->BaseAddress,\r | |
402 | Hob.FirmwareVolume3->BaseAddress + Hob.FirmwareVolume3->Length - 1,\r | |
403 | Hob.FirmwareVolume3->AuthenticationStatus,\r | |
404 | Hob.FirmwareVolume3->ExtractedFv\r | |
405 | ));\r | |
406 | if (Hob.FirmwareVolume3->ExtractedFv) {\r | |
407 | DEBUG ((\r | |
408 | DEBUG_INFO | DEBUG_LOAD,\r | |
409 | " %g - %g\n",\r | |
410 | &Hob.FirmwareVolume3->FvName,\r | |
411 | &Hob.FirmwareVolume3->FileName\r | |
412 | ));\r | |
413 | }\r | |
31f228cf | 414 | }\r |
415 | }\r | |
416 | DEBUG_CODE_END ();\r | |
417 | \r | |
418 | //\r | |
419 | // Initialize the Event Services\r | |
420 | //\r | |
421 | Status = CoreInitializeEventServices ();\r | |
422 | ASSERT_EFI_ERROR (Status);\r | |
423 | \r | |
84edd20b SZ |
424 | MemoryProfileInstallProtocol ();\r |
425 | \r | |
03d486b2 | 426 | CoreInitializePropertiesTable ();\r |
a94d51bd | 427 | CoreInitializeMemoryAttributesTable ();\r |
d0e92aad | 428 | CoreInitializeMemoryProtection ();\r |
03d486b2 | 429 | \r |
57f360f2 JF |
430 | //\r |
431 | // Get persisted vector hand-off info from GUIDeed HOB again due to HobStart may be updated,\r | |
432 | // and install configuration table\r | |
433 | //\r | |
434 | GuidHob = GetNextGuidHob (&gEfiVectorHandoffInfoPpiGuid, HobStart);\r | |
435 | if (GuidHob != NULL) {\r | |
436 | VectorInfoList = (EFI_VECTOR_HANDOFF_INFO *) (GET_GUID_HOB_DATA(GuidHob));\r | |
437 | VectorInfo = VectorInfoList;\r | |
438 | Index = 1;\r | |
439 | while (VectorInfo->Attribute != EFI_VECTOR_HANDOFF_LAST_ENTRY) {\r | |
440 | VectorInfo ++;\r | |
441 | Index ++;\r | |
442 | }\r | |
443 | VectorInfo = AllocateCopyPool (sizeof (EFI_VECTOR_HANDOFF_INFO) * Index, (VOID *) VectorInfoList);\r | |
444 | ASSERT (VectorInfo != NULL);\r | |
445 | Status = CoreInstallConfigurationTable (&gEfiVectorHandoffTableGuid, (VOID *) VectorInfo);\r | |
446 | ASSERT_EFI_ERROR (Status);\r | |
447 | }\r | |
31f228cf | 448 | \r |
449 | //\r | |
450 | // Get the Protocols that were passed in from PEI to DXE through GUIDed HOBs\r | |
451 | //\r | |
452 | // These Protocols are not architectural. This implementation is sharing code between\r | |
453 | // PEI and DXE in order to save FLASH space. These Protocols could also be implemented\r | |
454 | // as part of the DXE Core. However, that would also require the DXE Core to be ported\r | |
455 | // each time a different CPU is used, a different Decompression algorithm is used, or a\r | |
456 | // different Image type is used. By placing these Protocols in PEI, the DXE Core remains\r | |
457 | // generic, and only PEI and the Arch Protocols need to be ported from Platform to Platform,\r | |
458 | // and from CPU to CPU.\r | |
459 | //\r | |
460 | \r | |
461 | //\r | |
462 | // Publish the EFI, Tiano, and Custom Decompress protocols for use by other DXE components\r | |
463 | //\r | |
464 | Status = CoreInstallMultipleProtocolInterfaces (\r | |
465 | &mDecompressHandle,\r | |
466 | &gEfiDecompressProtocolGuid, &gEfiDecompress,\r | |
467 | NULL\r | |
468 | );\r | |
469 | ASSERT_EFI_ERROR (Status);\r | |
470 | \r | |
471 | //\r | |
472 | // Register for the GUIDs of the Architectural Protocols, so the rest of the\r | |
473 | // EFI Boot Services and EFI Runtime Services tables can be filled in.\r | |
74e44290 | 474 | // Also register for the GUIDs of optional protocols.\r |
31f228cf | 475 | //\r |
74e44290 | 476 | CoreNotifyOnProtocolInstallation ();\r |
31f228cf | 477 | \r |
478 | //\r | |
479 | // Produce Firmware Volume Protocols, one for each FV in the HOB list.\r | |
480 | //\r | |
481 | Status = FwVolBlockDriverInit (gDxeCoreImageHandle, gDxeCoreST);\r | |
482 | ASSERT_EFI_ERROR (Status);\r | |
483 | \r | |
484 | Status = FwVolDriverInit (gDxeCoreImageHandle, gDxeCoreST);\r | |
485 | ASSERT_EFI_ERROR (Status);\r | |
486 | \r | |
487 | //\r | |
488 | // Produce the Section Extraction Protocol\r | |
489 | //\r | |
490 | Status = InitializeSectionExtraction (gDxeCoreImageHandle, gDxeCoreST);\r | |
491 | ASSERT_EFI_ERROR (Status);\r | |
492 | \r | |
493 | //\r | |
494 | // Initialize the DXE Dispatcher\r | |
495 | //\r | |
31f228cf | 496 | CoreInitializeDispatcher ();\r |
31f228cf | 497 | \r |
498 | //\r | |
499 | // Invoke the DXE Dispatcher\r | |
500 | //\r | |
31f228cf | 501 | CoreDispatcher ();\r |
31f228cf | 502 | \r |
503 | //\r | |
504 | // Display Architectural protocols that were not loaded if this is DEBUG build\r | |
505 | //\r | |
506 | DEBUG_CODE_BEGIN ();\r | |
507 | CoreDisplayMissingArchProtocols ();\r | |
508 | DEBUG_CODE_END ();\r | |
509 | \r | |
510 | //\r | |
511 | // Display any drivers that were not dispatched because dependency expression\r | |
512 | // evaluated to false if this is a debug build\r | |
513 | //\r | |
514 | DEBUG_CODE_BEGIN ();\r | |
515 | CoreDisplayDiscoveredNotDispatched ();\r | |
516 | DEBUG_CODE_END ();\r | |
517 | \r | |
518 | //\r | |
519 | // Assert if the Architectural Protocols are not present.\r | |
520 | //\r | |
37623a5c | 521 | Status = CoreAllEfiServicesAvailable ();\r |
522 | if (EFI_ERROR(Status)) {\r | |
523 | //\r | |
524 | // Report Status code that some Architectural Protocols are not present.\r | |
525 | //\r | |
526 | REPORT_STATUS_CODE (\r | |
527 | EFI_ERROR_CODE | EFI_ERROR_MAJOR,\r | |
528 | (EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_EC_NO_ARCH)\r | |
d1102dba | 529 | );\r |
37623a5c | 530 | }\r |
531 | ASSERT_EFI_ERROR (Status);\r | |
31f228cf | 532 | \r |
533 | //\r | |
534 | // Report Status code before transfer control to BDS\r | |
535 | //\r | |
536 | REPORT_STATUS_CODE (\r | |
537 | EFI_PROGRESS_CODE,\r | |
f9876ecf | 538 | (EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT)\r |
31f228cf | 539 | );\r |
540 | \r | |
541 | //\r | |
542 | // Transfer control to the BDS Architectural Protocol\r | |
543 | //\r | |
544 | gBds->Entry (gBds);\r | |
545 | \r | |
546 | //\r | |
547 | // BDS should never return\r | |
548 | //\r | |
549 | ASSERT (FALSE);\r | |
550 | CpuDeadLoop ();\r | |
3a7daf9e MH |
551 | \r |
552 | UNREACHABLE ();\r | |
31f228cf | 553 | }\r |
554 | \r | |
555 | \r | |
556 | \r | |
31f228cf | 557 | \r |
558 | /**\r | |
559 | Place holder function until all the Boot Services and Runtime Services are\r | |
560 | available.\r | |
561 | \r | |
562 | @param Arg1 Undefined\r | |
563 | \r | |
564 | @return EFI_NOT_AVAILABLE_YET\r | |
565 | \r | |
566 | **/\r | |
567 | EFI_STATUS\r | |
568 | EFIAPI\r | |
569 | CoreEfiNotAvailableYetArg1 (\r | |
570 | UINTN Arg1\r | |
571 | )\r | |
572 | {\r | |
573 | //\r | |
574 | // This function should never be executed. If it does, then the architectural protocols\r | |
575 | // have not been designed correctly. The CpuBreakpoint () is commented out for now until the\r | |
576 | // DXE Core and all the Architectural Protocols are complete.\r | |
577 | //\r | |
578 | \r | |
579 | return EFI_NOT_AVAILABLE_YET;\r | |
580 | }\r | |
581 | \r | |
582 | \r | |
583 | /**\r | |
584 | Place holder function until all the Boot Services and Runtime Services are available.\r | |
585 | \r | |
586 | @param Arg1 Undefined\r | |
587 | @param Arg2 Undefined\r | |
588 | \r | |
589 | @return EFI_NOT_AVAILABLE_YET\r | |
590 | \r | |
591 | **/\r | |
592 | EFI_STATUS\r | |
593 | EFIAPI\r | |
594 | CoreEfiNotAvailableYetArg2 (\r | |
595 | UINTN Arg1,\r | |
596 | UINTN Arg2\r | |
597 | )\r | |
598 | {\r | |
599 | //\r | |
600 | // This function should never be executed. If it does, then the architectural protocols\r | |
601 | // have not been designed correctly. The CpuBreakpoint () is commented out for now until the\r | |
602 | // DXE Core and all the Architectural Protocols are complete.\r | |
603 | //\r | |
604 | \r | |
605 | return EFI_NOT_AVAILABLE_YET;\r | |
606 | }\r | |
607 | \r | |
608 | \r | |
609 | /**\r | |
610 | Place holder function until all the Boot Services and Runtime Services are available.\r | |
611 | \r | |
612 | @param Arg1 Undefined\r | |
613 | @param Arg2 Undefined\r | |
614 | @param Arg3 Undefined\r | |
615 | \r | |
616 | @return EFI_NOT_AVAILABLE_YET\r | |
617 | \r | |
618 | **/\r | |
619 | EFI_STATUS\r | |
620 | EFIAPI\r | |
621 | CoreEfiNotAvailableYetArg3 (\r | |
622 | UINTN Arg1,\r | |
623 | UINTN Arg2,\r | |
624 | UINTN Arg3\r | |
625 | )\r | |
626 | {\r | |
627 | //\r | |
628 | // This function should never be executed. If it does, then the architectural protocols\r | |
629 | // have not been designed correctly. The CpuBreakpoint () is commented out for now until the\r | |
630 | // DXE Core and all the Architectural Protocols are complete.\r | |
631 | //\r | |
632 | \r | |
633 | return EFI_NOT_AVAILABLE_YET;\r | |
634 | }\r | |
635 | \r | |
636 | \r | |
637 | /**\r | |
638 | Place holder function until all the Boot Services and Runtime Services are available.\r | |
639 | \r | |
640 | @param Arg1 Undefined\r | |
641 | @param Arg2 Undefined\r | |
642 | @param Arg3 Undefined\r | |
643 | @param Arg4 Undefined\r | |
644 | \r | |
645 | @return EFI_NOT_AVAILABLE_YET\r | |
646 | \r | |
647 | **/\r | |
648 | EFI_STATUS\r | |
649 | EFIAPI\r | |
650 | CoreEfiNotAvailableYetArg4 (\r | |
651 | UINTN Arg1,\r | |
652 | UINTN Arg2,\r | |
653 | UINTN Arg3,\r | |
654 | UINTN Arg4\r | |
655 | )\r | |
656 | {\r | |
657 | //\r | |
658 | // This function should never be executed. If it does, then the architectural protocols\r | |
659 | // have not been designed correctly. The CpuBreakpoint () is commented out for now until the\r | |
660 | // DXE Core and all the Architectural Protocols are complete.\r | |
661 | //\r | |
662 | \r | |
663 | return EFI_NOT_AVAILABLE_YET;\r | |
664 | }\r | |
665 | \r | |
666 | \r | |
667 | /**\r | |
668 | Place holder function until all the Boot Services and Runtime Services are available.\r | |
669 | \r | |
670 | @param Arg1 Undefined\r | |
671 | @param Arg2 Undefined\r | |
672 | @param Arg3 Undefined\r | |
673 | @param Arg4 Undefined\r | |
674 | @param Arg5 Undefined\r | |
675 | \r | |
676 | @return EFI_NOT_AVAILABLE_YET\r | |
677 | \r | |
678 | **/\r | |
679 | EFI_STATUS\r | |
680 | EFIAPI\r | |
681 | CoreEfiNotAvailableYetArg5 (\r | |
682 | UINTN Arg1,\r | |
683 | UINTN Arg2,\r | |
684 | UINTN Arg3,\r | |
685 | UINTN Arg4,\r | |
686 | UINTN Arg5\r | |
687 | )\r | |
688 | {\r | |
689 | //\r | |
690 | // This function should never be executed. If it does, then the architectural protocols\r | |
691 | // have not been designed correctly. The CpuBreakpoint () is commented out for now until the\r | |
692 | // DXE Core and all the Architectural Protocols are complete.\r | |
693 | //\r | |
694 | \r | |
695 | return EFI_NOT_AVAILABLE_YET;\r | |
696 | }\r | |
697 | \r | |
698 | \r | |
699 | /**\r | |
700 | Calcualte the 32-bit CRC in a EFI table using the service provided by the\r | |
701 | gRuntime service.\r | |
702 | \r | |
703 | @param Hdr Pointer to an EFI standard header\r | |
704 | \r | |
705 | **/\r | |
706 | VOID\r | |
707 | CalculateEfiHdrCrc (\r | |
708 | IN OUT EFI_TABLE_HEADER *Hdr\r | |
709 | )\r | |
710 | {\r | |
711 | UINT32 Crc;\r | |
712 | \r | |
713 | Hdr->CRC32 = 0;\r | |
714 | \r | |
715 | //\r | |
716 | // If gBS->CalculateCrce32 () == CoreEfiNotAvailableYet () then\r | |
717 | // Crc will come back as zero if we set it to zero here\r | |
718 | //\r | |
719 | Crc = 0;\r | |
720 | gBS->CalculateCrc32 ((UINT8 *)Hdr, Hdr->HeaderSize, &Crc);\r | |
721 | Hdr->CRC32 = Crc;\r | |
722 | }\r | |
723 | \r | |
724 | \r | |
725 | /**\r | |
726 | Terminates all boot services.\r | |
727 | \r | |
728 | @param ImageHandle Handle that identifies the exiting image.\r | |
729 | @param MapKey Key to the latest memory map.\r | |
730 | \r | |
731 | @retval EFI_SUCCESS Boot Services terminated\r | |
732 | @retval EFI_INVALID_PARAMETER MapKey is incorrect.\r | |
733 | \r | |
734 | **/\r | |
735 | EFI_STATUS\r | |
736 | EFIAPI\r | |
737 | CoreExitBootServices (\r | |
738 | IN EFI_HANDLE ImageHandle,\r | |
739 | IN UINTN MapKey\r | |
740 | )\r | |
741 | {\r | |
742 | EFI_STATUS Status;\r | |
743 | \r | |
785b5f5a | 744 | //\r |
745 | // Disable Timer\r | |
746 | //\r | |
747 | gTimer->SetTimerPeriod (gTimer, 0);\r | |
748 | \r | |
31f228cf | 749 | //\r |
750 | // Terminate memory services if the MapKey matches\r | |
751 | //\r | |
752 | Status = CoreTerminateMemoryMap (MapKey);\r | |
753 | if (EFI_ERROR (Status)) {\r | |
044824d9 | 754 | //\r |
d1102dba | 755 | // Notify other drivers that ExitBootServices fail\r |
044824d9 | 756 | //\r |
757 | CoreNotifySignalList (&gEventExitBootServicesFailedGuid);\r | |
31f228cf | 758 | return Status;\r |
759 | }\r | |
760 | \r | |
74a88770 SZ |
761 | gMemoryMapTerminated = TRUE;\r |
762 | \r | |
31f228cf | 763 | //\r |
764 | // Notify other drivers that we are exiting boot services.\r | |
765 | //\r | |
766 | CoreNotifySignalList (&gEfiEventExitBootServicesGuid);\r | |
767 | \r | |
e4c83a4f LG |
768 | //\r |
769 | // Report that ExitBootServices() has been called\r | |
770 | //\r | |
771 | REPORT_STATUS_CODE (\r | |
772 | EFI_PROGRESS_CODE,\r | |
773 | (EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_BS_PC_EXIT_BOOT_SERVICES)\r | |
774 | );\r | |
775 | \r | |
bce776a5 HW |
776 | MemoryProtectionExitBootServicesCallback();\r |
777 | \r | |
213fecef | 778 | //\r |
779 | // Disable interrupt of Debug timer.\r | |
780 | //\r | |
781 | SaveAndSetDebugTimerInterrupt (FALSE);\r | |
782 | \r | |
31f228cf | 783 | //\r |
784 | // Disable CPU Interrupts\r | |
785 | //\r | |
786 | gCpu->DisableInterrupt (gCpu);\r | |
787 | \r | |
31f228cf | 788 | //\r |
789 | // Clear the non-runtime values of the EFI System Table\r | |
790 | //\r | |
791 | gDxeCoreST->BootServices = NULL;\r | |
792 | gDxeCoreST->ConIn = NULL;\r | |
793 | gDxeCoreST->ConsoleInHandle = NULL;\r | |
794 | gDxeCoreST->ConOut = NULL;\r | |
795 | gDxeCoreST->ConsoleOutHandle = NULL;\r | |
796 | gDxeCoreST->StdErr = NULL;\r | |
797 | gDxeCoreST->StandardErrorHandle = NULL;\r | |
798 | \r | |
799 | //\r | |
800 | // Recompute the 32-bit CRC of the EFI System Table\r | |
801 | //\r | |
802 | CalculateEfiHdrCrc (&gDxeCoreST->Hdr);\r | |
803 | \r | |
804 | //\r | |
805 | // Zero out the Boot Service Table\r | |
806 | //\r | |
807 | ZeroMem (gBS, sizeof (EFI_BOOT_SERVICES));\r | |
808 | gBS = NULL;\r | |
809 | \r | |
810 | //\r | |
811 | // Update the AtRuntime field in Runtiem AP.\r | |
812 | //\r | |
813 | gRuntime->AtRuntime = TRUE;\r | |
814 | \r | |
815 | return Status;\r | |
816 | }\r | |
817 | \r | |
818 | \r | |
819 | /**\r | |
820 | Given a compressed source buffer, this function retrieves the size of the\r | |
821 | uncompressed buffer and the size of the scratch buffer required to decompress\r | |
822 | the compressed source buffer.\r | |
823 | \r | |
824 | The GetInfo() function retrieves the size of the uncompressed buffer and the\r | |
825 | temporary scratch buffer required to decompress the buffer specified by Source\r | |
826 | and SourceSize. If the size of the uncompressed buffer or the size of the\r | |
827 | scratch buffer cannot be determined from the compressed data specified by\r | |
828 | Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the\r | |
829 | size of the uncompressed buffer is returned in DestinationSize, the size of\r | |
830 | the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.\r | |
831 | The GetInfo() function does not have scratch buffer available to perform a\r | |
832 | thorough checking of the validity of the source data. It just retrieves the\r | |
833 | "Original Size" field from the beginning bytes of the source data and output\r | |
834 | it as DestinationSize. And ScratchSize is specific to the decompression\r | |
835 | implementation.\r | |
836 | \r | |
837 | @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r | |
838 | @param Source The source buffer containing the compressed data.\r | |
839 | @param SourceSize The size, in bytes, of the source buffer.\r | |
840 | @param DestinationSize A pointer to the size, in bytes, of the\r | |
841 | uncompressed buffer that will be generated when the\r | |
842 | compressed buffer specified by Source and\r | |
843 | SourceSize is decompressed.\r | |
844 | @param ScratchSize A pointer to the size, in bytes, of the scratch\r | |
845 | buffer that is required to decompress the\r | |
846 | compressed buffer specified by Source and\r | |
847 | SourceSize.\r | |
848 | \r | |
849 | @retval EFI_SUCCESS The size of the uncompressed data was returned in\r | |
850 | DestinationSize and the size of the scratch buffer\r | |
851 | was returned in ScratchSize.\r | |
852 | @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of\r | |
853 | the scratch buffer cannot be determined from the\r | |
854 | compressed data specified by Source and\r | |
855 | SourceSize.\r | |
856 | \r | |
857 | **/\r | |
858 | EFI_STATUS\r | |
859 | EFIAPI\r | |
860 | DxeMainUefiDecompressGetInfo (\r | |
861 | IN EFI_DECOMPRESS_PROTOCOL *This,\r | |
862 | IN VOID *Source,\r | |
863 | IN UINT32 SourceSize,\r | |
864 | OUT UINT32 *DestinationSize,\r | |
865 | OUT UINT32 *ScratchSize\r | |
866 | )\r | |
867 | {\r | |
868 | if (Source == NULL || DestinationSize == NULL || ScratchSize == NULL) {\r | |
869 | return EFI_INVALID_PARAMETER;\r | |
870 | }\r | |
871 | return UefiDecompressGetInfo (Source, SourceSize, DestinationSize, ScratchSize);\r | |
872 | }\r | |
873 | \r | |
874 | \r | |
875 | /**\r | |
876 | Decompresses a compressed source buffer.\r | |
877 | \r | |
878 | The Decompress() function extracts decompressed data to its original form.\r | |
879 | This protocol is designed so that the decompression algorithm can be\r | |
880 | implemented without using any memory services. As a result, the Decompress()\r | |
881 | Function is not allowed to call AllocatePool() or AllocatePages() in its\r | |
882 | implementation. It is the caller's responsibility to allocate and free the\r | |
883 | Destination and Scratch buffers.\r | |
884 | If the compressed source data specified by Source and SourceSize is\r | |
93e8d03c | 885 | successfully decompressed into Destination, then EFI_SUCCESS is returned. If\r |
31f228cf | 886 | the compressed source data specified by Source and SourceSize is not in a\r |
887 | valid compressed data format, then EFI_INVALID_PARAMETER is returned.\r | |
888 | \r | |
889 | @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.\r | |
890 | @param Source The source buffer containing the compressed data.\r | |
891 | @param SourceSize SourceSizeThe size of source data.\r | |
892 | @param Destination On output, the destination buffer that contains\r | |
893 | the uncompressed data.\r | |
894 | @param DestinationSize The size of the destination buffer. The size of\r | |
895 | the destination buffer needed is obtained from\r | |
896 | EFI_DECOMPRESS_PROTOCOL.GetInfo().\r | |
897 | @param Scratch A temporary scratch buffer that is used to perform\r | |
898 | the decompression.\r | |
899 | @param ScratchSize The size of scratch buffer. The size of the\r | |
900 | scratch buffer needed is obtained from GetInfo().\r | |
901 | \r | |
902 | @retval EFI_SUCCESS Decompression completed successfully, and the\r | |
903 | uncompressed buffer is returned in Destination.\r | |
904 | @retval EFI_INVALID_PARAMETER The source buffer specified by Source and\r | |
905 | SourceSize is corrupted (not in a valid\r | |
906 | compressed format).\r | |
907 | \r | |
908 | **/\r | |
909 | EFI_STATUS\r | |
910 | EFIAPI\r | |
911 | DxeMainUefiDecompress (\r | |
912 | IN EFI_DECOMPRESS_PROTOCOL *This,\r | |
913 | IN VOID *Source,\r | |
914 | IN UINT32 SourceSize,\r | |
915 | IN OUT VOID *Destination,\r | |
916 | IN UINT32 DestinationSize,\r | |
917 | IN OUT VOID *Scratch,\r | |
918 | IN UINT32 ScratchSize\r | |
919 | )\r | |
920 | {\r | |
921 | EFI_STATUS Status;\r | |
922 | UINT32 TestDestinationSize;\r | |
923 | UINT32 TestScratchSize;\r | |
924 | \r | |
925 | if (Source == NULL || Destination== NULL || Scratch == NULL) {\r | |
926 | return EFI_INVALID_PARAMETER;\r | |
927 | }\r | |
928 | \r | |
929 | Status = UefiDecompressGetInfo (Source, SourceSize, &TestDestinationSize, &TestScratchSize);\r | |
930 | if (EFI_ERROR (Status)) {\r | |
931 | return Status;\r | |
932 | }\r | |
933 | \r | |
934 | if (ScratchSize < TestScratchSize || DestinationSize < TestDestinationSize) {\r | |
935 | return RETURN_INVALID_PARAMETER;\r | |
936 | }\r | |
937 | \r | |
938 | return UefiDecompress (Source, Destination, Scratch);\r | |
939 | }\r |