2 DXE Core Main Entry Point
4 Copyright (c) 2006 - 2018, 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
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.
18 // DXE Core Global Variables for Protocols from PEI
20 EFI_HANDLE mDecompressHandle
= NULL
;
23 // DXE Core globals for Architecture Protocols
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
;
34 // DXE Core globals for optional protocol dependencies
36 EFI_SMM_BASE2_PROTOCOL
*gSmmBase2
= NULL
;
39 // DXE Core Global used to update core loaded image protocol handle
41 EFI_GUID
*gDxeCoreFileName
;
42 EFI_LOADED_IMAGE_PROTOCOL
*gDxeCoreLoadedImage
;
45 // DXE Core Module Variables
47 EFI_BOOT_SERVICES mBootServices
= {
49 EFI_BOOT_SERVICES_SIGNATURE
, // Signature
50 EFI_BOOT_SERVICES_REVISION
, // Revision
51 sizeof (EFI_BOOT_SERVICES
), // HeaderSize
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
101 EFI_DXE_SERVICES mDxeServices
= {
103 DXE_SERVICES_SIGNATURE
, // Signature
104 DXE_SERVICES_REVISION
, // Revision
105 sizeof (DXE_SERVICES
), // HeaderSize
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
129 EFI_SYSTEM_TABLE mEfiSystemTableTemplate
= {
131 EFI_SYSTEM_TABLE_SIGNATURE
, // Signature
132 EFI_SYSTEM_TABLE_REVISION
, // Revision
133 sizeof (EFI_SYSTEM_TABLE
), // HeaderSize
137 NULL
, // FirmwareVendor
138 0, // FirmwareRevision
139 NULL
, // ConsoleInHandle
141 NULL
, // ConsoleOutHandle
143 NULL
, // StandardErrorHandle
145 NULL
, // RuntimeServices
146 &mBootServices
, // BootServices
147 0, // NumberOfConfigurationTableEntries
148 NULL
// ConfigurationTable
151 EFI_RUNTIME_SERVICES mEfiRuntimeServicesTableTemplate
= {
153 EFI_RUNTIME_SERVICES_SIGNATURE
, // Signature
154 EFI_RUNTIME_SERVICES_REVISION
, // Revision
155 sizeof (EFI_RUNTIME_SERVICES
), // HeaderSize
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
175 EFI_RUNTIME_ARCH_PROTOCOL gRuntimeTemplate
= {
176 INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate
.ImageHead
),
177 INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate
.EventHead
),
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.
184 sizeof (EFI_MEMORY_DESCRIPTOR
) + sizeof (UINT64
) - (sizeof (EFI_MEMORY_DESCRIPTOR
) % sizeof (UINT64
)),
185 EFI_MEMORY_DESCRIPTOR_VERSION
,
193 EFI_RUNTIME_ARCH_PROTOCOL
*gRuntime
= &gRuntimeTemplate
;
196 // DXE Core Global Variables for the EFI System Table, Boot Services Table,
197 // DXE Services Table, and Runtime Services Table
199 EFI_DXE_SERVICES
*gDxeCoreDS
= &mDxeServices
;
200 EFI_SYSTEM_TABLE
*gDxeCoreST
= NULL
;
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.
207 EFI_RUNTIME_SERVICES
*gDxeCoreRT
= &mEfiRuntimeServicesTableTemplate
;
208 EFI_HANDLE gDxeCoreImageHandle
= NULL
;
210 BOOLEAN gMemoryMapTerminated
= FALSE
;
213 // EFI Decompress Protocol
215 EFI_DECOMPRESS_PROTOCOL gEfiDecompress
= {
216 DxeMainUefiDecompressGetInfo
,
217 DxeMainUefiDecompress
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
224 GLOBAL_REMOVE_IF_UNREFERENCED EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE gLoadModuleAtFixAddressConfigurationTable
= {0, 0};
226 // Main entry point to the DXE Core
230 Main entry point to DXE Core.
232 @param HobStart Pointer to the beginning of the HOB List from PEI.
234 @return This function should never return.
244 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
246 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
248 EFI_HOB_GUID_TYPE
*GuidHob
;
249 EFI_VECTOR_HANDOFF_INFO
*VectorInfoList
;
250 EFI_VECTOR_HANDOFF_INFO
*VectorInfo
;
254 // Setup the default exception handlers
256 VectorInfoList
= NULL
;
257 GuidHob
= GetNextGuidHob (&gEfiVectorHandoffInfoPpiGuid
, HobStart
);
258 if (GuidHob
!= NULL
) {
259 VectorInfoList
= (EFI_VECTOR_HANDOFF_INFO
*) (GET_GUID_HOB_DATA(GuidHob
));
261 Status
= InitializeCpuExceptionHandlersEx (VectorInfoList
, NULL
);
262 ASSERT_EFI_ERROR (Status
);
265 // Initialize Debug Agent to support source level debug in DXE phase
267 InitializeDebugAgent (DEBUG_AGENT_INIT_DXE_CORE
, HobStart
, NULL
);
270 // Initialize Memory Services
272 CoreInitializeMemoryServices (&HobStart
, &MemoryBaseAddress
, &MemoryLength
);
274 MemoryProfileInit (HobStart
);
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
280 gDxeCoreST
= AllocateRuntimeCopyPool (sizeof (EFI_SYSTEM_TABLE
), &mEfiSystemTableTemplate
);
281 ASSERT (gDxeCoreST
!= NULL
);
283 gDxeCoreRT
= AllocateRuntimeCopyPool (sizeof (EFI_RUNTIME_SERVICES
), &mEfiRuntimeServicesTableTemplate
);
284 ASSERT (gDxeCoreRT
!= NULL
);
286 gDxeCoreST
->RuntimeServices
= gDxeCoreRT
;
289 // Start the Image Services.
291 Status
= CoreInitializeImageServices (HobStart
);
292 ASSERT_EFI_ERROR (Status
);
295 // Initialize the Global Coherency Domain Services
297 Status
= CoreInitializeGcdServices (&HobStart
, MemoryBaseAddress
, MemoryLength
);
298 ASSERT_EFI_ERROR (Status
);
301 // Call constructor for all libraries
303 ProcessLibraryConstructorList (gDxeCoreImageHandle
, gDxeCoreST
);
304 PERF_CROSSMODULE_END ("PEI");
305 PERF_CROSSMODULE_BEGIN ("DXE");
308 // Report DXE Core image information to the PE/COFF Extra Action Library
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
;
318 ImageContext
.Handle
= (VOID
*)(UINTN
)gDxeCoreLoadedImage
->ImageBase
;
319 ImageContext
.ImageRead
= PeCoffLoaderImageReadFromMemory
;
320 PeCoffLoaderRelocateImageExtraAction (&ImageContext
);
323 // Install the DXE Services Table into the EFI System Tables's Configuration Table
325 Status
= CoreInstallConfigurationTable (&gEfiDxeServicesTableGuid
, gDxeCoreDS
);
326 ASSERT_EFI_ERROR (Status
);
329 // Install the HOB List into the EFI System Tables's Configuration Table
331 Status
= CoreInstallConfigurationTable (&gEfiHobListGuid
, HobStart
);
332 ASSERT_EFI_ERROR (Status
);
335 // Install Memory Type Information Table into the EFI System Tables's Configuration Table
337 Status
= CoreInstallConfigurationTable (&gEfiMemoryTypeInformationGuid
, &gMemoryTypeInformation
);
338 ASSERT_EFI_ERROR (Status
);
341 // If Loading modules At fixed address feature is enabled, install Load moduels at fixed address
342 // Configuration Table so that user could easily to retrieve the top address to load Dxe and PEI
343 // Code and Tseg base to load SMM driver.
345 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
346 Status
= CoreInstallConfigurationTable (&gLoadFixedAddressConfigurationTableGuid
, &gLoadModuleAtFixAddressConfigurationTable
);
347 ASSERT_EFI_ERROR (Status
);
350 // Report Status Code here for DXE_ENTRY_POINT once it is available
354 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_PC_ENTRY_POINT
)
358 // Create the aligned system table pointer structure that is used by external
359 // debuggers to locate the system table... Also, install debug image info
360 // configuration table.
362 CoreInitializeDebugImageInfoTable ();
363 CoreNewDebugImageInfoEntry (
364 EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL
,
369 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "HOBLIST address in DXE = 0x%p\n", HobStart
));
372 EFI_PEI_HOB_POINTERS Hob
;
374 for (Hob
.Raw
= HobStart
; !END_OF_HOB_LIST(Hob
); Hob
.Raw
= GET_NEXT_HOB(Hob
)) {
375 if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_MEMORY_ALLOCATION
) {
376 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Memory Allocation 0x%08x 0x%0lx - 0x%0lx\n", \
377 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryType
, \
378 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryBaseAddress
, \
379 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryBaseAddress
+ Hob
.MemoryAllocation
->AllocDescriptor
.MemoryLength
- 1));
382 for (Hob
.Raw
= HobStart
; !END_OF_HOB_LIST(Hob
); Hob
.Raw
= GET_NEXT_HOB(Hob
)) {
383 if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_FV
) {
385 DEBUG_INFO
| DEBUG_LOAD
,
386 "FV Hob 0x%0lx - 0x%0lx\n",
387 Hob
.FirmwareVolume
->BaseAddress
,
388 Hob
.FirmwareVolume
->BaseAddress
+ Hob
.FirmwareVolume
->Length
- 1
390 } else if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_FV2
) {
392 DEBUG_INFO
| DEBUG_LOAD
,
393 "FV2 Hob 0x%0lx - 0x%0lx\n",
394 Hob
.FirmwareVolume2
->BaseAddress
,
395 Hob
.FirmwareVolume2
->BaseAddress
+ Hob
.FirmwareVolume2
->Length
- 1
398 DEBUG_INFO
| DEBUG_LOAD
,
400 &Hob
.FirmwareVolume2
->FvName
,
401 &Hob
.FirmwareVolume2
->FileName
403 } else if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_FV3
) {
405 DEBUG_INFO
| DEBUG_LOAD
,
406 "FV3 Hob 0x%0lx - 0x%0lx - 0x%x - 0x%x\n",
407 Hob
.FirmwareVolume3
->BaseAddress
,
408 Hob
.FirmwareVolume3
->BaseAddress
+ Hob
.FirmwareVolume3
->Length
- 1,
409 Hob
.FirmwareVolume3
->AuthenticationStatus
,
410 Hob
.FirmwareVolume3
->ExtractedFv
412 if (Hob
.FirmwareVolume3
->ExtractedFv
) {
414 DEBUG_INFO
| DEBUG_LOAD
,
416 &Hob
.FirmwareVolume3
->FvName
,
417 &Hob
.FirmwareVolume3
->FileName
425 // Initialize the Event Services
427 Status
= CoreInitializeEventServices ();
428 ASSERT_EFI_ERROR (Status
);
430 MemoryProfileInstallProtocol ();
432 CoreInitializePropertiesTable ();
433 CoreInitializeMemoryAttributesTable ();
434 CoreInitializeMemoryProtection ();
437 // Get persisted vector hand-off info from GUIDeed HOB again due to HobStart may be updated,
438 // and install configuration table
440 GuidHob
= GetNextGuidHob (&gEfiVectorHandoffInfoPpiGuid
, HobStart
);
441 if (GuidHob
!= NULL
) {
442 VectorInfoList
= (EFI_VECTOR_HANDOFF_INFO
*) (GET_GUID_HOB_DATA(GuidHob
));
443 VectorInfo
= VectorInfoList
;
445 while (VectorInfo
->Attribute
!= EFI_VECTOR_HANDOFF_LAST_ENTRY
) {
449 VectorInfo
= AllocateCopyPool (sizeof (EFI_VECTOR_HANDOFF_INFO
) * Index
, (VOID
*) VectorInfoList
);
450 ASSERT (VectorInfo
!= NULL
);
451 Status
= CoreInstallConfigurationTable (&gEfiVectorHandoffTableGuid
, (VOID
*) VectorInfo
);
452 ASSERT_EFI_ERROR (Status
);
456 // Get the Protocols that were passed in from PEI to DXE through GUIDed HOBs
458 // These Protocols are not architectural. This implementation is sharing code between
459 // PEI and DXE in order to save FLASH space. These Protocols could also be implemented
460 // as part of the DXE Core. However, that would also require the DXE Core to be ported
461 // each time a different CPU is used, a different Decompression algorithm is used, or a
462 // different Image type is used. By placing these Protocols in PEI, the DXE Core remains
463 // generic, and only PEI and the Arch Protocols need to be ported from Platform to Platform,
464 // and from CPU to CPU.
468 // Publish the EFI, Tiano, and Custom Decompress protocols for use by other DXE components
470 Status
= CoreInstallMultipleProtocolInterfaces (
472 &gEfiDecompressProtocolGuid
, &gEfiDecompress
,
475 ASSERT_EFI_ERROR (Status
);
478 // Register for the GUIDs of the Architectural Protocols, so the rest of the
479 // EFI Boot Services and EFI Runtime Services tables can be filled in.
480 // Also register for the GUIDs of optional protocols.
482 CoreNotifyOnProtocolInstallation ();
485 // Produce Firmware Volume Protocols, one for each FV in the HOB list.
487 Status
= FwVolBlockDriverInit (gDxeCoreImageHandle
, gDxeCoreST
);
488 ASSERT_EFI_ERROR (Status
);
490 Status
= FwVolDriverInit (gDxeCoreImageHandle
, gDxeCoreST
);
491 ASSERT_EFI_ERROR (Status
);
494 // Produce the Section Extraction Protocol
496 Status
= InitializeSectionExtraction (gDxeCoreImageHandle
, gDxeCoreST
);
497 ASSERT_EFI_ERROR (Status
);
500 // Initialize the DXE Dispatcher
502 CoreInitializeDispatcher ();
505 // Invoke the DXE Dispatcher
510 // Display Architectural protocols that were not loaded if this is DEBUG build
513 CoreDisplayMissingArchProtocols ();
517 // Display any drivers that were not dispatched because dependency expression
518 // evaluated to false if this is a debug build
521 CoreDisplayDiscoveredNotDispatched ();
525 // Assert if the Architectural Protocols are not present.
527 Status
= CoreAllEfiServicesAvailable ();
528 if (EFI_ERROR(Status
)) {
530 // Report Status code that some Architectural Protocols are not present.
533 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
534 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_EC_NO_ARCH
)
537 ASSERT_EFI_ERROR (Status
);
540 // Report Status code before transfer control to BDS
544 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT
)
548 // Transfer control to the BDS Architectural Protocol
553 // BDS should never return
564 Place holder function until all the Boot Services and Runtime Services are
567 @return EFI_NOT_AVAILABLE_YET
572 CoreEfiNotAvailableYetArg0 (
577 // This function should never be executed. If it does, then the architectural protocols
578 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
579 // DXE Core and all the Architectural Protocols are complete.
582 return EFI_NOT_AVAILABLE_YET
;
587 Place holder function until all the Boot Services and Runtime Services are
590 @param Arg1 Undefined
592 @return EFI_NOT_AVAILABLE_YET
597 CoreEfiNotAvailableYetArg1 (
602 // This function should never be executed. If it does, then the architectural protocols
603 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
604 // DXE Core and all the Architectural Protocols are complete.
607 return EFI_NOT_AVAILABLE_YET
;
612 Place holder function until all the Boot Services and Runtime Services are available.
614 @param Arg1 Undefined
615 @param Arg2 Undefined
617 @return EFI_NOT_AVAILABLE_YET
622 CoreEfiNotAvailableYetArg2 (
628 // This function should never be executed. If it does, then the architectural protocols
629 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
630 // DXE Core and all the Architectural Protocols are complete.
633 return EFI_NOT_AVAILABLE_YET
;
638 Place holder function until all the Boot Services and Runtime Services are available.
640 @param Arg1 Undefined
641 @param Arg2 Undefined
642 @param Arg3 Undefined
644 @return EFI_NOT_AVAILABLE_YET
649 CoreEfiNotAvailableYetArg3 (
656 // This function should never be executed. If it does, then the architectural protocols
657 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
658 // DXE Core and all the Architectural Protocols are complete.
661 return EFI_NOT_AVAILABLE_YET
;
666 Place holder function until all the Boot Services and Runtime Services are available.
668 @param Arg1 Undefined
669 @param Arg2 Undefined
670 @param Arg3 Undefined
671 @param Arg4 Undefined
673 @return EFI_NOT_AVAILABLE_YET
678 CoreEfiNotAvailableYetArg4 (
686 // This function should never be executed. If it does, then the architectural protocols
687 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
688 // DXE Core and all the Architectural Protocols are complete.
691 return EFI_NOT_AVAILABLE_YET
;
696 Place holder function until all the Boot Services and Runtime Services are available.
698 @param Arg1 Undefined
699 @param Arg2 Undefined
700 @param Arg3 Undefined
701 @param Arg4 Undefined
702 @param Arg5 Undefined
704 @return EFI_NOT_AVAILABLE_YET
709 CoreEfiNotAvailableYetArg5 (
718 // This function should never be executed. If it does, then the architectural protocols
719 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
720 // DXE Core and all the Architectural Protocols are complete.
723 return EFI_NOT_AVAILABLE_YET
;
728 Calcualte the 32-bit CRC in a EFI table using the service provided by the
731 @param Hdr Pointer to an EFI standard header
736 IN OUT EFI_TABLE_HEADER
*Hdr
744 // If gBS->CalculateCrce32 () == CoreEfiNotAvailableYet () then
745 // Crc will come back as zero if we set it to zero here
748 gBS
->CalculateCrc32 ((UINT8
*)Hdr
, Hdr
->HeaderSize
, &Crc
);
754 Terminates all boot services.
756 @param ImageHandle Handle that identifies the exiting image.
757 @param MapKey Key to the latest memory map.
759 @retval EFI_SUCCESS Boot Services terminated
760 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
765 CoreExitBootServices (
766 IN EFI_HANDLE ImageHandle
,
775 gTimer
->SetTimerPeriod (gTimer
, 0);
778 // Terminate memory services if the MapKey matches
780 Status
= CoreTerminateMemoryMap (MapKey
);
781 if (EFI_ERROR (Status
)) {
783 // Notify other drivers that ExitBootServices fail
785 CoreNotifySignalList (&gEventExitBootServicesFailedGuid
);
789 gMemoryMapTerminated
= TRUE
;
792 // Notify other drivers that we are exiting boot services.
794 CoreNotifySignalList (&gEfiEventExitBootServicesGuid
);
797 // Report that ExitBootServices() has been called
801 (EFI_SOFTWARE_EFI_BOOT_SERVICE
| EFI_SW_BS_PC_EXIT_BOOT_SERVICES
)
804 MemoryProtectionExitBootServicesCallback();
807 // Disable interrupt of Debug timer.
809 SaveAndSetDebugTimerInterrupt (FALSE
);
812 // Disable CPU Interrupts
814 gCpu
->DisableInterrupt (gCpu
);
817 // Clear the non-runtime values of the EFI System Table
819 gDxeCoreST
->BootServices
= NULL
;
820 gDxeCoreST
->ConIn
= NULL
;
821 gDxeCoreST
->ConsoleInHandle
= NULL
;
822 gDxeCoreST
->ConOut
= NULL
;
823 gDxeCoreST
->ConsoleOutHandle
= NULL
;
824 gDxeCoreST
->StdErr
= NULL
;
825 gDxeCoreST
->StandardErrorHandle
= NULL
;
828 // Recompute the 32-bit CRC of the EFI System Table
830 CalculateEfiHdrCrc (&gDxeCoreST
->Hdr
);
833 // Zero out the Boot Service Table
835 ZeroMem (gBS
, sizeof (EFI_BOOT_SERVICES
));
839 // Update the AtRuntime field in Runtiem AP.
841 gRuntime
->AtRuntime
= TRUE
;
848 Given a compressed source buffer, this function retrieves the size of the
849 uncompressed buffer and the size of the scratch buffer required to decompress
850 the compressed source buffer.
852 The GetInfo() function retrieves the size of the uncompressed buffer and the
853 temporary scratch buffer required to decompress the buffer specified by Source
854 and SourceSize. If the size of the uncompressed buffer or the size of the
855 scratch buffer cannot be determined from the compressed data specified by
856 Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the
857 size of the uncompressed buffer is returned in DestinationSize, the size of
858 the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.
859 The GetInfo() function does not have scratch buffer available to perform a
860 thorough checking of the validity of the source data. It just retrieves the
861 "Original Size" field from the beginning bytes of the source data and output
862 it as DestinationSize. And ScratchSize is specific to the decompression
865 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
866 @param Source The source buffer containing the compressed data.
867 @param SourceSize The size, in bytes, of the source buffer.
868 @param DestinationSize A pointer to the size, in bytes, of the
869 uncompressed buffer that will be generated when the
870 compressed buffer specified by Source and
871 SourceSize is decompressed.
872 @param ScratchSize A pointer to the size, in bytes, of the scratch
873 buffer that is required to decompress the
874 compressed buffer specified by Source and
877 @retval EFI_SUCCESS The size of the uncompressed data was returned in
878 DestinationSize and the size of the scratch buffer
879 was returned in ScratchSize.
880 @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of
881 the scratch buffer cannot be determined from the
882 compressed data specified by Source and
888 DxeMainUefiDecompressGetInfo (
889 IN EFI_DECOMPRESS_PROTOCOL
*This
,
891 IN UINT32 SourceSize
,
892 OUT UINT32
*DestinationSize
,
893 OUT UINT32
*ScratchSize
896 if (Source
== NULL
|| DestinationSize
== NULL
|| ScratchSize
== NULL
) {
897 return EFI_INVALID_PARAMETER
;
899 return UefiDecompressGetInfo (Source
, SourceSize
, DestinationSize
, ScratchSize
);
904 Decompresses a compressed source buffer.
906 The Decompress() function extracts decompressed data to its original form.
907 This protocol is designed so that the decompression algorithm can be
908 implemented without using any memory services. As a result, the Decompress()
909 Function is not allowed to call AllocatePool() or AllocatePages() in its
910 implementation. It is the caller's responsibility to allocate and free the
911 Destination and Scratch buffers.
912 If the compressed source data specified by Source and SourceSize is
913 successfully decompressed into Destination, then EFI_SUCCESS is returned. If
914 the compressed source data specified by Source and SourceSize is not in a
915 valid compressed data format, then EFI_INVALID_PARAMETER is returned.
917 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
918 @param Source The source buffer containing the compressed data.
919 @param SourceSize SourceSizeThe size of source data.
920 @param Destination On output, the destination buffer that contains
921 the uncompressed data.
922 @param DestinationSize The size of the destination buffer. The size of
923 the destination buffer needed is obtained from
924 EFI_DECOMPRESS_PROTOCOL.GetInfo().
925 @param Scratch A temporary scratch buffer that is used to perform
927 @param ScratchSize The size of scratch buffer. The size of the
928 scratch buffer needed is obtained from GetInfo().
930 @retval EFI_SUCCESS Decompression completed successfully, and the
931 uncompressed buffer is returned in Destination.
932 @retval EFI_INVALID_PARAMETER The source buffer specified by Source and
933 SourceSize is corrupted (not in a valid
939 DxeMainUefiDecompress (
940 IN EFI_DECOMPRESS_PROTOCOL
*This
,
942 IN UINT32 SourceSize
,
943 IN OUT VOID
*Destination
,
944 IN UINT32 DestinationSize
,
945 IN OUT VOID
*Scratch
,
946 IN UINT32 ScratchSize
950 UINT32 TestDestinationSize
;
951 UINT32 TestScratchSize
;
953 if (Source
== NULL
|| Destination
== NULL
|| Scratch
== NULL
) {
954 return EFI_INVALID_PARAMETER
;
957 Status
= UefiDecompressGetInfo (Source
, SourceSize
, &TestDestinationSize
, &TestScratchSize
);
958 if (EFI_ERROR (Status
)) {
962 if (ScratchSize
< TestScratchSize
|| DestinationSize
< TestDestinationSize
) {
963 return RETURN_INVALID_PARAMETER
;
966 return UefiDecompress (Source
, Destination
, Scratch
);