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 ZeroMem (&ImageContext
, sizeof (ImageContext
));
300 ImageContext
.ImageAddress
= (EFI_PHYSICAL_ADDRESS
)(UINTN
)gDxeCoreLoadedImage
->ImageBase
;
301 ImageContext
.PdbPointer
= PeCoffLoaderGetPdbPointer ((VOID
*) (UINTN
) ImageContext
.ImageAddress
);
302 PeCoffLoaderRelocateImageExtraAction (&ImageContext
);
305 // Initialize the Global Coherency Domain Services
307 Status
= CoreInitializeGcdServices (&HobStart
, MemoryBaseAddress
, MemoryLength
);
308 ASSERT_EFI_ERROR (Status
);
311 // Install the DXE Services Table into the EFI System Tables's Configuration Table
313 Status
= CoreInstallConfigurationTable (&gEfiDxeServicesTableGuid
, gDxeCoreDS
);
314 ASSERT_EFI_ERROR (Status
);
317 // Install the HOB List into the EFI System Tables's Configuration Table
319 Status
= CoreInstallConfigurationTable (&gEfiHobListGuid
, HobStart
);
320 ASSERT_EFI_ERROR (Status
);
323 // Install Memory Type Information Table into the EFI System Tables's Configuration Table
325 Status
= CoreInstallConfigurationTable (&gEfiMemoryTypeInformationGuid
, &gMemoryTypeInformation
);
326 ASSERT_EFI_ERROR (Status
);
329 // If Loading modules At fixed address feature is enabled, install Load moduels at fixed address
330 // Configuration Table so that user could easily to retrieve the top address to load Dxe and PEI
331 // Code and Tseg base to load SMM driver.
333 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
334 Status
= CoreInstallConfigurationTable (&gLoadFixedAddressConfigurationTableGuid
, &gLoadModuleAtFixAddressConfigurationTable
);
335 ASSERT_EFI_ERROR (Status
);
338 // Report Status Code here for DXE_ENTRY_POINT once it is available
342 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_PC_ENTRY_POINT
)
346 // Create the aligned system table pointer structure that is used by external
347 // debuggers to locate the system table... Also, install debug image info
348 // configuration table.
350 CoreInitializeDebugImageInfoTable ();
351 CoreNewDebugImageInfoEntry (
352 EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL
,
357 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "HOBLIST address in DXE = 0x%p\n", HobStart
));
360 EFI_PEI_HOB_POINTERS Hob
;
362 for (Hob
.Raw
= HobStart
; !END_OF_HOB_LIST(Hob
); Hob
.Raw
= GET_NEXT_HOB(Hob
)) {
363 if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_MEMORY_ALLOCATION
) {
364 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "Memory Allocation 0x%08x 0x%0lx - 0x%0lx\n", \
365 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryType
, \
366 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryBaseAddress
, \
367 Hob
.MemoryAllocation
->AllocDescriptor
.MemoryBaseAddress
+ Hob
.MemoryAllocation
->AllocDescriptor
.MemoryLength
- 1));
370 for (Hob
.Raw
= HobStart
; !END_OF_HOB_LIST(Hob
); Hob
.Raw
= GET_NEXT_HOB(Hob
)) {
371 if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_FV2
) {
372 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "FV2 Hob 0x%0lx - 0x%0lx\n", Hob
.FirmwareVolume2
->BaseAddress
, Hob
.FirmwareVolume2
->BaseAddress
+ Hob
.FirmwareVolume2
->Length
- 1));
373 } else if (GET_HOB_TYPE (Hob
) == EFI_HOB_TYPE_FV
) {
374 DEBUG ((DEBUG_INFO
| DEBUG_LOAD
, "FV Hob 0x%0lx - 0x%0lx\n", Hob
.FirmwareVolume
->BaseAddress
, Hob
.FirmwareVolume
->BaseAddress
+ Hob
.FirmwareVolume2
->Length
- 1));
380 // Initialize the Event Services
382 Status
= CoreInitializeEventServices ();
383 ASSERT_EFI_ERROR (Status
);
386 // Get persisted vector hand-off info from GUIDeed HOB again due to HobStart may be updated,
387 // and install configuration table
389 GuidHob
= GetNextGuidHob (&gEfiVectorHandoffInfoPpiGuid
, HobStart
);
390 if (GuidHob
!= NULL
) {
391 VectorInfoList
= (EFI_VECTOR_HANDOFF_INFO
*) (GET_GUID_HOB_DATA(GuidHob
));
392 VectorInfo
= VectorInfoList
;
394 while (VectorInfo
->Attribute
!= EFI_VECTOR_HANDOFF_LAST_ENTRY
) {
398 VectorInfo
= AllocateCopyPool (sizeof (EFI_VECTOR_HANDOFF_INFO
) * Index
, (VOID
*) VectorInfoList
);
399 ASSERT (VectorInfo
!= NULL
);
400 Status
= CoreInstallConfigurationTable (&gEfiVectorHandoffTableGuid
, (VOID
*) VectorInfo
);
401 ASSERT_EFI_ERROR (Status
);
405 // Get the Protocols that were passed in from PEI to DXE through GUIDed HOBs
407 // These Protocols are not architectural. This implementation is sharing code between
408 // PEI and DXE in order to save FLASH space. These Protocols could also be implemented
409 // as part of the DXE Core. However, that would also require the DXE Core to be ported
410 // each time a different CPU is used, a different Decompression algorithm is used, or a
411 // different Image type is used. By placing these Protocols in PEI, the DXE Core remains
412 // generic, and only PEI and the Arch Protocols need to be ported from Platform to Platform,
413 // and from CPU to CPU.
417 // Publish the EFI, Tiano, and Custom Decompress protocols for use by other DXE components
419 Status
= CoreInstallMultipleProtocolInterfaces (
421 &gEfiDecompressProtocolGuid
, &gEfiDecompress
,
424 ASSERT_EFI_ERROR (Status
);
427 // Register for the GUIDs of the Architectural Protocols, so the rest of the
428 // EFI Boot Services and EFI Runtime Services tables can be filled in.
429 // Also register for the GUIDs of optional protocols.
431 CoreNotifyOnProtocolInstallation ();
434 // Produce Firmware Volume Protocols, one for each FV in the HOB list.
436 Status
= FwVolBlockDriverInit (gDxeCoreImageHandle
, gDxeCoreST
);
437 ASSERT_EFI_ERROR (Status
);
439 Status
= FwVolDriverInit (gDxeCoreImageHandle
, gDxeCoreST
);
440 ASSERT_EFI_ERROR (Status
);
443 // Produce the Section Extraction Protocol
445 Status
= InitializeSectionExtraction (gDxeCoreImageHandle
, gDxeCoreST
);
446 ASSERT_EFI_ERROR (Status
);
449 // Initialize the DXE Dispatcher
451 PERF_START (NULL
,"CoreInitializeDispatcher", "DxeMain", 0) ;
452 CoreInitializeDispatcher ();
453 PERF_END (NULL
,"CoreInitializeDispatcher", "DxeMain", 0) ;
456 // Invoke the DXE Dispatcher
458 PERF_START (NULL
, "CoreDispatcher", "DxeMain", 0);
460 PERF_END (NULL
, "CoreDispatcher", "DxeMain", 0);
463 // Display Architectural protocols that were not loaded if this is DEBUG build
466 CoreDisplayMissingArchProtocols ();
470 // Display any drivers that were not dispatched because dependency expression
471 // evaluated to false if this is a debug build
474 CoreDisplayDiscoveredNotDispatched ();
478 // Assert if the Architectural Protocols are not present.
480 Status
= CoreAllEfiServicesAvailable ();
481 if (EFI_ERROR(Status
)) {
483 // Report Status code that some Architectural Protocols are not present.
486 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
487 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_EC_NO_ARCH
)
490 ASSERT_EFI_ERROR (Status
);
493 // Report Status code before transfer control to BDS
497 (EFI_SOFTWARE_DXE_CORE
| EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT
)
501 // Transfer control to the BDS Architectural Protocol
506 // BDS should never return
515 Place holder function until all the Boot Services and Runtime Services are
518 @return EFI_NOT_AVAILABLE_YET
523 CoreEfiNotAvailableYetArg0 (
528 // This function should never be executed. If it does, then the architectural protocols
529 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
530 // DXE Core and all the Architectural Protocols are complete.
533 return EFI_NOT_AVAILABLE_YET
;
538 Place holder function until all the Boot Services and Runtime Services are
541 @param Arg1 Undefined
543 @return EFI_NOT_AVAILABLE_YET
548 CoreEfiNotAvailableYetArg1 (
553 // This function should never be executed. If it does, then the architectural protocols
554 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
555 // DXE Core and all the Architectural Protocols are complete.
558 return EFI_NOT_AVAILABLE_YET
;
563 Place holder function until all the Boot Services and Runtime Services are available.
565 @param Arg1 Undefined
566 @param Arg2 Undefined
568 @return EFI_NOT_AVAILABLE_YET
573 CoreEfiNotAvailableYetArg2 (
579 // This function should never be executed. If it does, then the architectural protocols
580 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
581 // DXE Core and all the Architectural Protocols are complete.
584 return EFI_NOT_AVAILABLE_YET
;
589 Place holder function until all the Boot Services and Runtime Services are available.
591 @param Arg1 Undefined
592 @param Arg2 Undefined
593 @param Arg3 Undefined
595 @return EFI_NOT_AVAILABLE_YET
600 CoreEfiNotAvailableYetArg3 (
607 // This function should never be executed. If it does, then the architectural protocols
608 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
609 // DXE Core and all the Architectural Protocols are complete.
612 return EFI_NOT_AVAILABLE_YET
;
617 Place holder function until all the Boot Services and Runtime Services are available.
619 @param Arg1 Undefined
620 @param Arg2 Undefined
621 @param Arg3 Undefined
622 @param Arg4 Undefined
624 @return EFI_NOT_AVAILABLE_YET
629 CoreEfiNotAvailableYetArg4 (
637 // This function should never be executed. If it does, then the architectural protocols
638 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
639 // DXE Core and all the Architectural Protocols are complete.
642 return EFI_NOT_AVAILABLE_YET
;
647 Place holder function until all the Boot Services and Runtime Services are available.
649 @param Arg1 Undefined
650 @param Arg2 Undefined
651 @param Arg3 Undefined
652 @param Arg4 Undefined
653 @param Arg5 Undefined
655 @return EFI_NOT_AVAILABLE_YET
660 CoreEfiNotAvailableYetArg5 (
669 // This function should never be executed. If it does, then the architectural protocols
670 // have not been designed correctly. The CpuBreakpoint () is commented out for now until the
671 // DXE Core and all the Architectural Protocols are complete.
674 return EFI_NOT_AVAILABLE_YET
;
679 Calcualte the 32-bit CRC in a EFI table using the service provided by the
682 @param Hdr Pointer to an EFI standard header
687 IN OUT EFI_TABLE_HEADER
*Hdr
695 // If gBS->CalculateCrce32 () == CoreEfiNotAvailableYet () then
696 // Crc will come back as zero if we set it to zero here
699 gBS
->CalculateCrc32 ((UINT8
*)Hdr
, Hdr
->HeaderSize
, &Crc
);
705 Terminates all boot services.
707 @param ImageHandle Handle that identifies the exiting image.
708 @param MapKey Key to the latest memory map.
710 @retval EFI_SUCCESS Boot Services terminated
711 @retval EFI_INVALID_PARAMETER MapKey is incorrect.
716 CoreExitBootServices (
717 IN EFI_HANDLE ImageHandle
,
726 gTimer
->SetTimerPeriod (gTimer
, 0);
729 // Terminate memory services if the MapKey matches
731 Status
= CoreTerminateMemoryMap (MapKey
);
732 if (EFI_ERROR (Status
)) {
734 // Notify other drivers that ExitBootServices fail
736 CoreNotifySignalList (&gEventExitBootServicesFailedGuid
);
741 // Notify other drivers that we are exiting boot services.
743 CoreNotifySignalList (&gEfiEventExitBootServicesGuid
);
746 // Report that ExitBootServices() has been called
750 (EFI_SOFTWARE_EFI_BOOT_SERVICE
| EFI_SW_BS_PC_EXIT_BOOT_SERVICES
)
754 // Disable interrupt of Debug timer.
756 SaveAndSetDebugTimerInterrupt (FALSE
);
759 // Disable CPU Interrupts
761 gCpu
->DisableInterrupt (gCpu
);
764 // Clear the non-runtime values of the EFI System Table
766 gDxeCoreST
->BootServices
= NULL
;
767 gDxeCoreST
->ConIn
= NULL
;
768 gDxeCoreST
->ConsoleInHandle
= NULL
;
769 gDxeCoreST
->ConOut
= NULL
;
770 gDxeCoreST
->ConsoleOutHandle
= NULL
;
771 gDxeCoreST
->StdErr
= NULL
;
772 gDxeCoreST
->StandardErrorHandle
= NULL
;
775 // Recompute the 32-bit CRC of the EFI System Table
777 CalculateEfiHdrCrc (&gDxeCoreST
->Hdr
);
780 // Zero out the Boot Service Table
782 ZeroMem (gBS
, sizeof (EFI_BOOT_SERVICES
));
786 // Update the AtRuntime field in Runtiem AP.
788 gRuntime
->AtRuntime
= TRUE
;
795 Given a compressed source buffer, this function retrieves the size of the
796 uncompressed buffer and the size of the scratch buffer required to decompress
797 the compressed source buffer.
799 The GetInfo() function retrieves the size of the uncompressed buffer and the
800 temporary scratch buffer required to decompress the buffer specified by Source
801 and SourceSize. If the size of the uncompressed buffer or the size of the
802 scratch buffer cannot be determined from the compressed data specified by
803 Source and SourceData, then EFI_INVALID_PARAMETER is returned. Otherwise, the
804 size of the uncompressed buffer is returned in DestinationSize, the size of
805 the scratch buffer is returned in ScratchSize, and EFI_SUCCESS is returned.
806 The GetInfo() function does not have scratch buffer available to perform a
807 thorough checking of the validity of the source data. It just retrieves the
808 "Original Size" field from the beginning bytes of the source data and output
809 it as DestinationSize. And ScratchSize is specific to the decompression
812 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
813 @param Source The source buffer containing the compressed data.
814 @param SourceSize The size, in bytes, of the source buffer.
815 @param DestinationSize A pointer to the size, in bytes, of the
816 uncompressed buffer that will be generated when the
817 compressed buffer specified by Source and
818 SourceSize is decompressed.
819 @param ScratchSize A pointer to the size, in bytes, of the scratch
820 buffer that is required to decompress the
821 compressed buffer specified by Source and
824 @retval EFI_SUCCESS The size of the uncompressed data was returned in
825 DestinationSize and the size of the scratch buffer
826 was returned in ScratchSize.
827 @retval EFI_INVALID_PARAMETER The size of the uncompressed data or the size of
828 the scratch buffer cannot be determined from the
829 compressed data specified by Source and
835 DxeMainUefiDecompressGetInfo (
836 IN EFI_DECOMPRESS_PROTOCOL
*This
,
838 IN UINT32 SourceSize
,
839 OUT UINT32
*DestinationSize
,
840 OUT UINT32
*ScratchSize
843 if (Source
== NULL
|| DestinationSize
== NULL
|| ScratchSize
== NULL
) {
844 return EFI_INVALID_PARAMETER
;
846 return UefiDecompressGetInfo (Source
, SourceSize
, DestinationSize
, ScratchSize
);
851 Decompresses a compressed source buffer.
853 The Decompress() function extracts decompressed data to its original form.
854 This protocol is designed so that the decompression algorithm can be
855 implemented without using any memory services. As a result, the Decompress()
856 Function is not allowed to call AllocatePool() or AllocatePages() in its
857 implementation. It is the caller's responsibility to allocate and free the
858 Destination and Scratch buffers.
859 If the compressed source data specified by Source and SourceSize is
860 successfully decompressed into Destination, then EFI_SUCCESS is returned. If
861 the compressed source data specified by Source and SourceSize is not in a
862 valid compressed data format, then EFI_INVALID_PARAMETER is returned.
864 @param This A pointer to the EFI_DECOMPRESS_PROTOCOL instance.
865 @param Source The source buffer containing the compressed data.
866 @param SourceSize SourceSizeThe size of source data.
867 @param Destination On output, the destination buffer that contains
868 the uncompressed data.
869 @param DestinationSize The size of the destination buffer. The size of
870 the destination buffer needed is obtained from
871 EFI_DECOMPRESS_PROTOCOL.GetInfo().
872 @param Scratch A temporary scratch buffer that is used to perform
874 @param ScratchSize The size of scratch buffer. The size of the
875 scratch buffer needed is obtained from GetInfo().
877 @retval EFI_SUCCESS Decompression completed successfully, and the
878 uncompressed buffer is returned in Destination.
879 @retval EFI_INVALID_PARAMETER The source buffer specified by Source and
880 SourceSize is corrupted (not in a valid
886 DxeMainUefiDecompress (
887 IN EFI_DECOMPRESS_PROTOCOL
*This
,
889 IN UINT32 SourceSize
,
890 IN OUT VOID
*Destination
,
891 IN UINT32 DestinationSize
,
892 IN OUT VOID
*Scratch
,
893 IN UINT32 ScratchSize
897 UINT32 TestDestinationSize
;
898 UINT32 TestScratchSize
;
900 if (Source
== NULL
|| Destination
== NULL
|| Scratch
== NULL
) {
901 return EFI_INVALID_PARAMETER
;
904 Status
= UefiDecompressGetInfo (Source
, SourceSize
, &TestDestinationSize
, &TestScratchSize
);
905 if (EFI_ERROR (Status
)) {
909 if (ScratchSize
< TestScratchSize
|| DestinationSize
< TestDestinationSize
) {
910 return RETURN_INVALID_PARAMETER
;
913 return UefiDecompress (Source
, Destination
, Scratch
);