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