2 DXE Core Main Entry Point
4 Copyright (c) 2006 - 2014, 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
128 EFI_SYSTEM_TABLE mEfiSystemTableTemplate
= {
130 EFI_SYSTEM_TABLE_SIGNATURE
, // Signature
131 EFI_SYSTEM_TABLE_REVISION
, // Revision
132 sizeof (EFI_SYSTEM_TABLE
), // HeaderSize
136 NULL
, // FirmwareVendor
137 0, // FirmwareRevision
138 NULL
, // ConsoleInHandle
140 NULL
, // ConsoleOutHandle
142 NULL
, // StandardErrorHandle
144 NULL
, // RuntimeServices
145 &mBootServices
, // BootServices
146 0, // NumberOfConfigurationTableEntries
147 NULL
// ConfigurationTable
150 EFI_RUNTIME_SERVICES mEfiRuntimeServicesTableTemplate
= {
152 EFI_RUNTIME_SERVICES_SIGNATURE
, // Signature
153 EFI_RUNTIME_SERVICES_REVISION
, // Revision
154 sizeof (EFI_RUNTIME_SERVICES
), // HeaderSize
158 (EFI_GET_TIME
) CoreEfiNotAvailableYetArg2
, // GetTime
159 (EFI_SET_TIME
) CoreEfiNotAvailableYetArg1
, // SetTime
160 (EFI_GET_WAKEUP_TIME
) CoreEfiNotAvailableYetArg3
, // GetWakeupTime
161 (EFI_SET_WAKEUP_TIME
) CoreEfiNotAvailableYetArg2
, // SetWakeupTime
162 (EFI_SET_VIRTUAL_ADDRESS_MAP
) CoreEfiNotAvailableYetArg4
, // SetVirtualAddressMap
163 (EFI_CONVERT_POINTER
) CoreEfiNotAvailableYetArg2
, // ConvertPointer
164 (EFI_GET_VARIABLE
) CoreEfiNotAvailableYetArg5
, // GetVariable
165 (EFI_GET_NEXT_VARIABLE_NAME
) CoreEfiNotAvailableYetArg3
, // GetNextVariableName
166 (EFI_SET_VARIABLE
) CoreEfiNotAvailableYetArg5
, // SetVariable
167 (EFI_GET_NEXT_HIGH_MONO_COUNT
) CoreEfiNotAvailableYetArg1
, // GetNextHighMonotonicCount
168 (EFI_RESET_SYSTEM
) CoreEfiNotAvailableYetArg4
, // ResetSystem
169 (EFI_UPDATE_CAPSULE
) CoreEfiNotAvailableYetArg3
, // UpdateCapsule
170 (EFI_QUERY_CAPSULE_CAPABILITIES
) CoreEfiNotAvailableYetArg4
, // QueryCapsuleCapabilities
171 (EFI_QUERY_VARIABLE_INFO
) CoreEfiNotAvailableYetArg4
// QueryVariableInfo
174 EFI_RUNTIME_ARCH_PROTOCOL gRuntimeTemplate
= {
175 INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate
.ImageHead
),
176 INITIALIZE_LIST_HEAD_VARIABLE (gRuntimeTemplate
.EventHead
),
179 // Make sure Size != sizeof (EFI_MEMORY_DESCRIPTOR). This will
180 // prevent people from having pointer math bugs in their code.
181 // now you have to use *DescriptorSize to make things work.
183 sizeof (EFI_MEMORY_DESCRIPTOR
) + sizeof (UINT64
) - (sizeof (EFI_MEMORY_DESCRIPTOR
) % sizeof (UINT64
)),
184 EFI_MEMORY_DESCRIPTOR_VERSION
,
192 EFI_RUNTIME_ARCH_PROTOCOL
*gRuntime
= &gRuntimeTemplate
;
195 // DXE Core Global Variables for the EFI System Table, Boot Services Table,
196 // DXE Services Table, and Runtime Services Table
198 EFI_DXE_SERVICES
*gDxeCoreDS
= &mDxeServices
;
199 EFI_SYSTEM_TABLE
*gDxeCoreST
= NULL
;
202 // For debug initialize gDxeCoreRT to template. gDxeCoreRT must be allocated from RT memory
203 // but gDxeCoreRT is used for ASSERT () and DEBUG () type macros so lets give it
204 // a value that will not cause debug infrastructure to crash early on.
206 EFI_RUNTIME_SERVICES
*gDxeCoreRT
= &mEfiRuntimeServicesTableTemplate
;
207 EFI_HANDLE gDxeCoreImageHandle
= NULL
;
211 // EFI Decompress Protocol
213 EFI_DECOMPRESS_PROTOCOL gEfiDecompress
= {
214 DxeMainUefiDecompressGetInfo
,
215 DxeMainUefiDecompress
219 // For Loading modules at fixed address feature, the configuration table is to cache the top address below which to load
220 // Runtime code&boot time code
222 GLOBAL_REMOVE_IF_UNREFERENCED EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE gLoadModuleAtFixAddressConfigurationTable
= {0, 0};
224 // Main entry point to the DXE Core
228 Main entry point to DXE Core.
230 @param HobStart Pointer to the beginning of the HOB List from PEI.
232 @return This function should never return.
242 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
244 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
246 EFI_HOB_GUID_TYPE
*GuidHob
;
247 EFI_VECTOR_HANDOFF_INFO
*VectorInfoList
;
248 EFI_VECTOR_HANDOFF_INFO
*VectorInfo
;
251 // Setup the default exception handlers
253 VectorInfoList
= NULL
;
254 GuidHob
= GetNextGuidHob (&gEfiVectorHandoffInfoPpiGuid
, HobStart
);
255 if (GuidHob
!= NULL
) {
256 VectorInfoList
= (EFI_VECTOR_HANDOFF_INFO
*) (GET_GUID_HOB_DATA(GuidHob
));
258 Status
= InitializeCpuExceptionHandlers (VectorInfoList
);
259 ASSERT_EFI_ERROR (Status
);
262 // Initialize Debug Agent to support source level debug in DXE phase
264 InitializeDebugAgent (DEBUG_AGENT_INIT_DXE_CORE
, HobStart
, NULL
);
267 // Initialize Memory Services
269 CoreInitializeMemoryServices (&HobStart
, &MemoryBaseAddress
, &MemoryLength
);
272 // Allocate the EFI System Table and EFI Runtime Service Table from EfiRuntimeServicesData
273 // Use the templates to initialize the contents of the EFI System Table and EFI Runtime Services Table
275 gDxeCoreST
= AllocateRuntimeCopyPool (sizeof (EFI_SYSTEM_TABLE
), &mEfiSystemTableTemplate
);
276 ASSERT (gDxeCoreST
!= NULL
);
278 gDxeCoreRT
= AllocateRuntimeCopyPool (sizeof (EFI_RUNTIME_SERVICES
), &mEfiRuntimeServicesTableTemplate
);
279 ASSERT (gDxeCoreRT
!= NULL
);
281 gDxeCoreST
->RuntimeServices
= gDxeCoreRT
;
284 // Start the Image Services.
286 Status
= CoreInitializeImageServices (HobStart
);
287 ASSERT_EFI_ERROR (Status
);
290 // Call constructor for all libraries
292 ProcessLibraryConstructorList (gDxeCoreImageHandle
, gDxeCoreST
);
293 PERF_END (NULL
,"PEI", NULL
, 0) ;
294 PERF_START (NULL
,"DXE", NULL
, 0) ;
297 // Report DXE Core image information to the PE/COFF Extra Action Library
299 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)gDxeCoreLoadedImage
->ImageBase
;
300 ImageContext
.PdbPointer
= PeCoffLoaderGetPdbPointer ((VOID
*) (UINTN
) ImageContext
.ImageAddress
);
301 PeCoffLoaderRelocateImageExtraAction (&ImageContext
);
304 // Initialize the Global Coherency Domain Services
306 Status
= CoreInitializeGcdServices (&HobStart
, MemoryBaseAddress
, MemoryLength
);
307 ASSERT_EFI_ERROR (Status
);
310 // Install the DXE Services Table into the EFI System Tables's Configuration Table
312 Status
= CoreInstallConfigurationTable (&gEfiDxeServicesTableGuid
, gDxeCoreDS
);
313 ASSERT_EFI_ERROR (Status
);
316 // Install the HOB List into the EFI System Tables's Configuration Table
318 Status
= CoreInstallConfigurationTable (&gEfiHobListGuid
, HobStart
);
319 ASSERT_EFI_ERROR (Status
);
322 // Install Memory Type Information Table into the EFI System Tables's Configuration Table
324 Status
= CoreInstallConfigurationTable (&gEfiMemoryTypeInformationGuid
, &gMemoryTypeInformation
);
325 ASSERT_EFI_ERROR (Status
);
328 // If Loading modules At fixed address feature is enabled, install Load moduels at fixed address
329 // Configuration Table so that user could easily to retrieve the top address to load Dxe and PEI
330 // Code and Tseg base to load SMM driver.
332 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
333 Status
= CoreInstallConfigurationTable (&gLoadFixedAddressConfigurationTableGuid
, &gLoadModuleAtFixAddressConfigurationTable
);
334 ASSERT_EFI_ERROR (Status
);
337 // Report Status Code here for DXE_ENTRY_POINT once it is available
341 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_PC_ENTRY_POINT
)
345 // Create the aligned system table pointer structure that is used by external
346 // debuggers to locate the system table... Also, install debug image info
347 // configuration table.
349 CoreInitializeDebugImageInfoTable ();
350 CoreNewDebugImageInfoEntry (
351 EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL
,
356 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "HOBLIST address in DXE = 0x%p\n", HobStart
));
359 EFI_PEI_HOB_POINTERS Hob
;
361 for (Hob
.Raw
= HobStart
; !END_OF_HOB_LIST(Hob
); Hob
.Raw
= GET_NEXT_HOB(Hob
)) {
362 if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_MEMORY_ALLOCATION
) {
363 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Memory Allocation 0x%08x 0x%0lx - 0x%0lx\n", \
364 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryType
, \
365 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryBaseAddress
, \
366 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryBaseAddress
+ Hob
.MemoryAllocation
->AllocDescriptor
.MemoryLength
- 1));
369 for (Hob
.Raw
= HobStart
; !END_OF_HOB_LIST(Hob
); Hob
.Raw
= GET_NEXT_HOB(Hob
)) {
370 if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_FV2
) {
371 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "FV2 Hob 0x%0lx - 0x%0lx\n", Hob
.FirmwareVolume2
->BaseAddress
, Hob
.FirmwareVolume2
->BaseAddress
+ Hob
.FirmwareVolume2
->Length
- 1));
372 } else if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_FV
) {
373 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "FV Hob 0x%0lx - 0x%0lx\n", Hob
.FirmwareVolume
->BaseAddress
, Hob
.FirmwareVolume
->BaseAddress
+ Hob
.FirmwareVolume2
->Length
- 1));
379 // Initialize the Event Services
381 Status
= CoreInitializeEventServices ();
382 ASSERT_EFI_ERROR (Status
);
385 // Get persisted vector hand-off info from GUIDeed HOB again due to HobStart may be updated,
386 // and install configuration table
388 GuidHob
= GetNextGuidHob (&gEfiVectorHandoffInfoPpiGuid
, HobStart
);
389 if (GuidHob
!= NULL
) {
390 VectorInfoList
= (EFI_VECTOR_HANDOFF_INFO
*) (GET_GUID_HOB_DATA(GuidHob
));
391 VectorInfo
= VectorInfoList
;
393 while (VectorInfo
->Attribute
!= EFI_VECTOR_HANDOFF_LAST_ENTRY
) {
397 VectorInfo
= AllocateCopyPool (sizeof (EFI_VECTOR_HANDOFF_INFO
) * Index
, (VOID
*) VectorInfoList
);
398 ASSERT (VectorInfo
!= NULL
);
399 Status
= CoreInstallConfigurationTable (&gEfiVectorHandoffTableGuid
, (VOID
*) VectorInfo
);
400 ASSERT_EFI_ERROR (Status
);
404 // Get the Protocols that were passed in from PEI to DXE through GUIDed HOBs
406 // These Protocols are not architectural. This implementation is sharing code between
407 // PEI and DXE in order to save FLASH space. These Protocols could also be implemented
408 // as part of the DXE Core. However, that would also require the DXE Core to be ported
409 // each time a different CPU is used, a different Decompression algorithm is used, or a
410 // different Image type is used. By placing these Protocols in PEI, the DXE Core remains
411 // generic, and only PEI and the Arch Protocols need to be ported from Platform to Platform,
412 // and from CPU to CPU.
416 // Publish the EFI, Tiano, and Custom Decompress protocols for use by other DXE components
418 Status
= CoreInstallMultipleProtocolInterfaces (
420 &gEfiDecompressProtocolGuid
, &gEfiDecompress
,
423 ASSERT_EFI_ERROR (Status
);
426 // Register for the GUIDs of the Architectural Protocols, so the rest of the
427 // EFI Boot Services and EFI Runtime Services tables can be filled in.
428 // Also register for the GUIDs of optional protocols.
430 CoreNotifyOnProtocolInstallation ();
433 // Produce Firmware Volume Protocols, one for each FV in the HOB list.
435 Status
= FwVolBlockDriverInit (gDxeCoreImageHandle
, gDxeCoreST
);
436 ASSERT_EFI_ERROR (Status
);
438 Status
= FwVolDriverInit (gDxeCoreImageHandle
, gDxeCoreST
);
439 ASSERT_EFI_ERROR (Status
);
442 // Produce the Section Extraction Protocol
444 Status
= InitializeSectionExtraction (gDxeCoreImageHandle
, gDxeCoreST
);
445 ASSERT_EFI_ERROR (Status
);
448 // Initialize the DXE Dispatcher
450 PERF_START (NULL
,"CoreInitializeDispatcher", "DxeMain", 0) ;
451 CoreInitializeDispatcher ();
452 PERF_END (NULL
,"CoreInitializeDispatcher", "DxeMain", 0) ;
455 // Invoke the DXE Dispatcher
457 PERF_START (NULL
, "CoreDispatcher", "DxeMain", 0);
459 PERF_END (NULL
, "CoreDispatcher", "DxeMain", 0);
462 // Display Architectural protocols that were not loaded if this is DEBUG build
465 CoreDisplayMissingArchProtocols ();
469 // Display any drivers that were not dispatched because dependency expression
470 // evaluated to false if this is a debug build
473 CoreDisplayDiscoveredNotDispatched ();
477 // Assert if the Architectural Protocols are not present.
479 Status
= CoreAllEfiServicesAvailable ();
480 if (EFI_ERROR(Status
)) {
482 // Report Status code that some Architectural Protocols are not present.
485 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
486 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_EC_NO_ARCH
)
489 ASSERT_EFI_ERROR (Status
);
492 // Report Status code before transfer control to BDS
496 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT
)
500 // Transfer control to the BDS Architectural Protocol
505 // BDS should never return
514 Place holder function until all the Boot Services and Runtime Services are
517 @return EFI_NOT_AVAILABLE_YET
522 CoreEfiNotAvailableYetArg0 (
527 // This function should never be executed. If it does, then the architectural protocols
528 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
529 // DXE Core and all the Architectural Protocols are complete.
532 return EFI_NOT_AVAILABLE_YET
;
537 Place holder function until all the Boot Services and Runtime Services are
540 @param Arg1 Undefined
542 @return EFI_NOT_AVAILABLE_YET
547 CoreEfiNotAvailableYetArg1 (
552 // This function should never be executed. If it does, then the architectural protocols
553 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
554 // DXE Core and all the Architectural Protocols are complete.
557 return EFI_NOT_AVAILABLE_YET
;
562 Place holder function until all the Boot Services and Runtime Services are available.
564 @param Arg1 Undefined
565 @param Arg2 Undefined
567 @return EFI_NOT_AVAILABLE_YET
572 CoreEfiNotAvailableYetArg2 (
578 // This function should never be executed. If it does, then the architectural protocols
579 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
580 // DXE Core and all the Architectural Protocols are complete.
583 return EFI_NOT_AVAILABLE_YET
;
588 Place holder function until all the Boot Services and Runtime Services are available.
590 @param Arg1 Undefined
591 @param Arg2 Undefined
592 @param Arg3 Undefined
594 @return EFI_NOT_AVAILABLE_YET
599 CoreEfiNotAvailableYetArg3 (
606 // This function should never be executed. If it does, then the architectural protocols
607 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
608 // DXE Core and all the Architectural Protocols are complete.
611 return EFI_NOT_AVAILABLE_YET
;
616 Place holder function until all the Boot Services and Runtime Services are available.
618 @param Arg1 Undefined
619 @param Arg2 Undefined
620 @param Arg3 Undefined
621 @param Arg4 Undefined
623 @return EFI_NOT_AVAILABLE_YET
628 CoreEfiNotAvailableYetArg4 (
636 // This function should never be executed. If it does, then the architectural protocols
637 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
638 // DXE Core and all the Architectural Protocols are complete.
641 return EFI_NOT_AVAILABLE_YET
;
646 Place holder function until all the Boot Services and Runtime Services are available.
648 @param Arg1 Undefined
649 @param Arg2 Undefined
650 @param Arg3 Undefined
651 @param Arg4 Undefined
652 @param Arg5 Undefined
654 @return EFI_NOT_AVAILABLE_YET
659 CoreEfiNotAvailableYetArg5 (
668 // This function should never be executed. If it does, then the architectural protocols
669 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
670 // DXE Core and all the Architectural Protocols are complete.
673 return EFI_NOT_AVAILABLE_YET
;
678 Calcualte the 32-bit CRC in a EFI table using the service provided by the
681 @param Hdr Pointer to an EFI standard header
686 IN OUT EFI_TABLE_HEADER
*Hdr
694 // If gBS->CalculateCrce32 () == CoreEfiNotAvailableYet () then
695 // Crc will come back as zero if we set it to zero here
698 gBS
->CalculateCrc32 ((UINT8
*)Hdr
, Hdr
->HeaderSize
, &Crc
);
704 Terminates all boot services.
706 @param ImageHandle Handle that identifies the exiting image.
707 @param MapKey Key to the latest memory map.
709 @retval EFI_SUCCESS Boot Services terminated
710 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
715 CoreExitBootServices (
716 IN EFI_HANDLE ImageHandle
,
725 gTimer
->SetTimerPeriod (gTimer
, 0);
728 // Terminate memory services if the MapKey matches
730 Status
= CoreTerminateMemoryMap (MapKey
);
731 if (EFI_ERROR (Status
)) {
733 // Notify other drivers that ExitBootServices fail
735 CoreNotifySignalList (&gEventExitBootServicesFailedGuid
);
740 // Notify other drivers that we are exiting boot services.
742 CoreNotifySignalList (&gEfiEventExitBootServicesGuid
);
745 // Report that ExitBootServices() has been called
749 (EFI_SOFTWARE_EFI_BOOT_SERVICE
| EFI_SW_BS_PC_EXIT_BOOT_SERVICES
)
753 // Disable interrupt of Debug timer.
755 SaveAndSetDebugTimerInterrupt (FALSE
);
758 // Disable CPU Interrupts
760 gCpu
->DisableInterrupt (gCpu
);
763 // Clear the non-runtime values of the EFI System Table
765 gDxeCoreST
->BootServices
= NULL
;
766 gDxeCoreST
->ConIn
= NULL
;
767 gDxeCoreST
->ConsoleInHandle
= NULL
;
768 gDxeCoreST
->ConOut
= NULL
;
769 gDxeCoreST
->ConsoleOutHandle
= NULL
;
770 gDxeCoreST
->StdErr
= NULL
;
771 gDxeCoreST
->StandardErrorHandle
= NULL
;
774 // Recompute the 32-bit CRC of the EFI System Table
776 CalculateEfiHdrCrc (&gDxeCoreST
->Hdr
);
779 // Zero out the Boot Service Table
781 ZeroMem (gBS
, sizeof (EFI_BOOT_SERVICES
));
785 // Update the AtRuntime field in Runtiem AP.
787 gRuntime
->AtRuntime
= TRUE
;
794 Given a compressed source buffer, this function retrieves the size of the
795 uncompressed buffer and the size of the scratch buffer required to decompress
796 the compressed source buffer.
798 The GetInfo() function retrieves the size of the uncompressed buffer and the
799 temporary scratch buffer required to decompress the buffer specified by Source
800 and SourceSize. If the size of the uncompressed buffer or the size of the
801 scratch buffer cannot be determined from the compressed data specified by
802 Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the
803 size of the uncompressed buffer is returned in DestinationSize, the size of
804 the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.
805 The GetInfo() function does not have scratch buffer available to perform a
806 thorough checking of the validity of the source data. It just retrieves the
807 "Original Size" field from the beginning bytes of the source data and output
808 it as DestinationSize. And ScratchSize is specific to the decompression
811 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
812 @param Source The source buffer containing the compressed data.
813 @param SourceSize The size, in bytes, of the source buffer.
814 @param DestinationSize A pointer to the size, in bytes, of the
815 uncompressed buffer that will be generated when the
816 compressed buffer specified by Source and
817 SourceSize is decompressed.
818 @param ScratchSize A pointer to the size, in bytes, of the scratch
819 buffer that is required to decompress the
820 compressed buffer specified by Source and
823 @retval EFI_SUCCESS The size of the uncompressed data was returned in
824 DestinationSize and the size of the scratch buffer
825 was returned in ScratchSize.
826 @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of
827 the scratch buffer cannot be determined from the
828 compressed data specified by Source and
834 DxeMainUefiDecompressGetInfo (
835 IN EFI_DECOMPRESS_PROTOCOL
*This
,
837 IN UINT32 SourceSize
,
838 OUT UINT32
*DestinationSize
,
839 OUT UINT32
*ScratchSize
842 if (Source
== NULL
|| DestinationSize
== NULL
|| ScratchSize
== NULL
) {
843 return EFI_INVALID_PARAMETER
;
845 return UefiDecompressGetInfo (Source
, SourceSize
, DestinationSize
, ScratchSize
);
850 Decompresses a compressed source buffer.
852 The Decompress() function extracts decompressed data to its original form.
853 This protocol is designed so that the decompression algorithm can be
854 implemented without using any memory services. As a result, the Decompress()
855 Function is not allowed to call AllocatePool() or AllocatePages() in its
856 implementation. It is the caller's responsibility to allocate and free the
857 Destination and Scratch buffers.
858 If the compressed source data specified by Source and SourceSize is
859 successfully decompressed into Destination, then EFI_SUCCESS is returned. If
860 the compressed source data specified by Source and SourceSize is not in a
861 valid compressed data format, then EFI_INVALID_PARAMETER is returned.
863 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
864 @param Source The source buffer containing the compressed data.
865 @param SourceSize SourceSizeThe size of source data.
866 @param Destination On output, the destination buffer that contains
867 the uncompressed data.
868 @param DestinationSize The size of the destination buffer. The size of
869 the destination buffer needed is obtained from
870 EFI_DECOMPRESS_PROTOCOL.GetInfo().
871 @param Scratch A temporary scratch buffer that is used to perform
873 @param ScratchSize The size of scratch buffer. The size of the
874 scratch buffer needed is obtained from GetInfo().
876 @retval EFI_SUCCESS Decompression completed successfully, and the
877 uncompressed buffer is returned in Destination.
878 @retval EFI_INVALID_PARAMETER The source buffer specified by Source and
879 SourceSize is corrupted (not in a valid
885 DxeMainUefiDecompress (
886 IN EFI_DECOMPRESS_PROTOCOL
*This
,
888 IN UINT32 SourceSize
,
889 IN OUT VOID
*Destination
,
890 IN UINT32 DestinationSize
,
891 IN OUT VOID
*Scratch
,
892 IN UINT32 ScratchSize
896 UINT32 TestDestinationSize
;
897 UINT32 TestScratchSize
;
899 if (Source
== NULL
|| Destination
== NULL
|| Scratch
== NULL
) {
900 return EFI_INVALID_PARAMETER
;
903 Status
= UefiDecompressGetInfo (Source
, SourceSize
, &TestDestinationSize
, &TestScratchSize
);
904 if (EFI_ERROR (Status
)) {
908 if (ScratchSize
< TestScratchSize
|| DestinationSize
< TestDestinationSize
) {
909 return RETURN_INVALID_PARAMETER
;
912 return UefiDecompress (Source
, Destination
, Scratch
);