2 SMM IPL that produces SMM related runtime protocols and load the SMM Core into SMRAM
4 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available
6 under the terms and conditions of the BSD License which accompanies this
7 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.
17 #include <Protocol/SmmBase2.h>
18 #include <Protocol/SmmCommunication.h>
19 #include <Protocol/SmmAccess2.h>
20 #include <Protocol/SmmConfiguration.h>
21 #include <Protocol/SmmControl2.h>
22 #include <Protocol/DxeSmmReadyToLock.h>
23 #include <Protocol/FirmwareVolume2.h>
25 #include <Guid/EventGroup.h>
26 #include <Guid/EventLegacyBios.h>
27 #include <Guid/LoadModuleAtFixedAddress.h>
29 #include <Library/BaseLib.h>
30 #include <Library/BaseMemoryLib.h>
31 #include <Library/PeCoffLib.h>
32 #include <Library/CacheMaintenanceLib.h>
33 #include <Library/MemoryAllocationLib.h>
34 #include <Library/DebugLib.h>
35 #include <Library/UefiBootServicesTableLib.h>
36 #include <Library/DxeServicesTableLib.h>
37 #include <Library/UefiLib.h>
38 #include <Library/UefiRuntimeLib.h>
39 #include <Library/PcdLib.h>
41 #include "PiSmmCorePrivateData.h"
44 // Function prototypes from produced protocols
48 Indicate whether the driver is currently executing in the SMM Initialization phase.
50 @param This The EFI_SMM_BASE2_PROTOCOL instance.
51 @param InSmram Pointer to a Boolean which, on return, indicates that the driver is currently executing
52 inside of SMRAM (TRUE) or outside of SMRAM (FALSE).
54 @retval EFI_INVALID_PARAMETER InSmram was NULL.
55 @retval EFI_SUCCESS The call returned successfully.
61 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
66 Retrieves the location of the System Management System Table (SMST).
68 @param This The EFI_SMM_BASE2_PROTOCOL instance.
69 @param Smst On return, points to a pointer to the System Management Service Table (SMST).
71 @retval EFI_INVALID_PARAMETER Smst or This was invalid.
72 @retval EFI_SUCCESS The memory was returned to the system.
73 @retval EFI_UNSUPPORTED Not in SMM.
78 SmmBase2GetSmstLocation (
79 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
80 OUT EFI_SMM_SYSTEM_TABLE2
**Smst
84 Communicates with a registered handler.
86 This function provides a service to send and receive messages from a registered
87 UEFI service. This function is part of the SMM Communication Protocol that may
88 be called in physical mode prior to SetVirtualAddressMap() and in virtual mode
89 after SetVirtualAddressMap().
91 @param[in] This The EFI_SMM_COMMUNICATION_PROTOCOL instance.
92 @param[in, out] CommBuffer A pointer to the buffer to convey into SMRAM.
93 @param[in, out] CommSize The size of the data buffer being passed in.On exit, the size of data
94 being returned. Zero if the handler does not wish to reply with any data.
96 @retval EFI_SUCCESS The message was successfully posted.
97 @retval EFI_INVALID_PARAMETER The CommBuffer was NULL.
101 SmmCommunicationCommunicate (
102 IN CONST EFI_SMM_COMMUNICATION_PROTOCOL
*This
,
103 IN OUT VOID
*CommBuffer
,
104 IN OUT UINTN
*CommSize
108 Event notification that is fired every time a gEfiSmmConfigurationProtocol installs.
110 @param Event The Event that is being processed, not used.
111 @param Context Event Context, not used.
116 SmmIplSmmConfigurationEventNotify (
122 Event notification that is fired every time a DxeSmmReadyToLock protocol is added
123 or if gEfiEventReadyToBootGuid is signalled.
125 @param Event The Event that is being processed, not used.
126 @param Context Event Context, not used.
131 SmmIplReadyToLockEventNotify (
137 Event notification that is fired when DxeDispatch Event Group is signaled.
139 @param Event The Event that is being processed, not used.
140 @param Context Event Context, not used.
145 SmmIplGuidedEventNotify (
151 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
153 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
154 It convers pointer to new virtual address.
156 @param Event Event whose notification function is being invoked.
157 @param Context Pointer to the notification function's context.
162 SmmIplSetVirtualAddressNotify (
168 // Data structure used to declare a table of protocol notifications and event
169 // notifications required by the SMM IPL
175 EFI_EVENT_NOTIFY NotifyFunction
;
178 } SMM_IPL_EVENT_NOTIFICATION
;
181 // Handle to install the SMM Base2 Protocol and the SMM Communication Protocol
183 EFI_HANDLE mSmmIplHandle
= NULL
;
186 // SMM Base 2 Protocol instance
188 EFI_SMM_BASE2_PROTOCOL mSmmBase2
= {
190 SmmBase2GetSmstLocation
194 // SMM Communication Protocol instance
196 EFI_SMM_COMMUNICATION_PROTOCOL mSmmCommunication
= {
197 SmmCommunicationCommunicate
201 // SMM Core Private Data structure that contains the data shared between
202 // the SMM IPL and the SMM Core.
204 SMM_CORE_PRIVATE_DATA mSmmCorePrivateData
= {
205 SMM_CORE_PRIVATE_DATA_SIGNATURE
, // Signature
206 NULL
, // SmmIplImageHandle
207 0, // SmramRangeCount
209 NULL
, // SmmEntryPoint
210 FALSE
, // SmmEntryPointRegistered
213 NULL
, // CommunicationBuffer
215 EFI_SUCCESS
// ReturnStatus
219 // Global pointer used to access mSmmCorePrivateData from outside and inside SMM
221 SMM_CORE_PRIVATE_DATA
*gSmmCorePrivate
= &mSmmCorePrivateData
;
224 // SMM IPL global variables
226 EFI_SMM_CONTROL2_PROTOCOL
*mSmmControl2
;
227 EFI_SMM_ACCESS2_PROTOCOL
*mSmmAccess
;
228 EFI_SMRAM_DESCRIPTOR
*mCurrentSmramRange
;
229 BOOLEAN mSmmLocked
= FALSE
;
230 EFI_PHYSICAL_ADDRESS mSmramCacheBase
;
231 UINT64 mSmramCacheSize
;
234 // Table of Protocol notification and GUIDed Event notifications that the SMM IPL requires
236 SMM_IPL_EVENT_NOTIFICATION mSmmIplEvents
[] = {
238 // Declare protocol notification on the SMM Configuration protocol. When this notification is etablished,
239 // the associated event is immediately signalled, so the notification function will be executed and the
240 // SMM Configuration Protocol will be found if it is already in the handle database.
242 { TRUE
, FALSE
, &gEfiSmmConfigurationProtocolGuid
, SmmIplSmmConfigurationEventNotify
, &gEfiSmmConfigurationProtocolGuid
, NULL
},
244 // Declare protocl notification on DxeSmmReadyToLock protocols. When this notification is etablished,
245 // the associated event is immediately signalled, so the notification function will be executed and the
246 // DXE SMM Ready To Lock Protocol will be found if it is already in the handle database.
248 { TRUE
, TRUE
, &gEfiDxeSmmReadyToLockProtocolGuid
, SmmIplReadyToLockEventNotify
, &gEfiDxeSmmReadyToLockProtocolGuid
, NULL
},
250 // Declare event notification on the DXE Dispatch Event Group. This event is signaled by the DXE Core
251 // each time the DXE Core dispatcher has completed its work. When this event is signalled, the SMM Core
252 // if notified, so the SMM Core can dispatch SMM drivers.
254 { FALSE
, TRUE
, &gEfiEventDxeDispatchGuid
, SmmIplGuidedEventNotify
, &gEfiEventDxeDispatchGuid
, NULL
},
256 // Declare event notification on Ready To Boot Event Group. This is an extra event notification that is
257 // used to make sure SMRAM is locked before any boot options are processed.
259 { FALSE
, TRUE
, &gEfiEventReadyToBootGuid
, SmmIplReadyToLockEventNotify
, &gEfiEventReadyToBootGuid
, NULL
},
261 // Declare event notification on Legacy Boot Event Group. This is used to inform the SMM Core that the platform
262 // is performing a legacy boot operation, and that the UEFI environment is no longer available and the SMM Core
263 // must guarantee that it does not access any UEFI related structures outside of SMRAM.
265 { FALSE
, FALSE
, &gEfiEventLegacyBootGuid
, SmmIplGuidedEventNotify
, &gEfiEventLegacyBootGuid
, NULL
},
267 // Declare event notification on SetVirtualAddressMap() Event Group. This is used to convert gSmmCorePrivate
268 // and mSmmControl2 from physical addresses to virtual addresses.
270 { FALSE
, FALSE
, &gEfiEventVirtualAddressChangeGuid
, SmmIplSetVirtualAddressNotify
, NULL
, NULL
},
272 // Terminate the table of event notifications
274 { FALSE
, FALSE
, NULL
, NULL
, NULL
, NULL
}
278 Find the maximum SMRAM cache range that covers the range specified by SmramRange.
280 This function searches and joins all adjacent ranges of SmramRange into a range to be cached.
282 @param SmramRange The SMRAM range to search from.
283 @param SmramCacheBase The returned cache range base.
284 @param SmramCacheSize The returned cache range size.
289 IN EFI_SMRAM_DESCRIPTOR
*SmramRange
,
290 OUT EFI_PHYSICAL_ADDRESS
*SmramCacheBase
,
291 OUT UINT64
*SmramCacheSize
295 EFI_PHYSICAL_ADDRESS RangeCpuStart
;
296 UINT64 RangePhysicalSize
;
297 BOOLEAN FoundAjacentRange
;
299 *SmramCacheBase
= SmramRange
->CpuStart
;
300 *SmramCacheSize
= SmramRange
->PhysicalSize
;
303 FoundAjacentRange
= FALSE
;
304 for (Index
= 0; Index
< gSmmCorePrivate
->SmramRangeCount
; Index
++) {
305 RangeCpuStart
= gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
;
306 RangePhysicalSize
= gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
;
307 if (RangeCpuStart
< *SmramCacheBase
&& *SmramCacheBase
== (RangeCpuStart
+ RangePhysicalSize
)) {
308 *SmramCacheBase
= RangeCpuStart
;
309 *SmramCacheSize
+= RangePhysicalSize
;
310 FoundAjacentRange
= TRUE
;
311 } else if ((*SmramCacheBase
+ *SmramCacheSize
) == RangeCpuStart
&& RangePhysicalSize
> 0) {
312 *SmramCacheSize
+= RangePhysicalSize
;
313 FoundAjacentRange
= TRUE
;
316 } while (FoundAjacentRange
);
321 Indicate whether the driver is currently executing in the SMM Initialization phase.
323 @param This The EFI_SMM_BASE2_PROTOCOL instance.
324 @param InSmram Pointer to a Boolean which, on return, indicates that the driver is currently executing
325 inside of SMRAM (TRUE) or outside of SMRAM (FALSE).
327 @retval EFI_INVALID_PARAMETER InSmram was NULL.
328 @retval EFI_SUCCESS The call returned successfully.
334 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
338 if (InSmram
== NULL
) {
339 return EFI_INVALID_PARAMETER
;
342 *InSmram
= gSmmCorePrivate
->InSmm
;
348 Retrieves the location of the System Management System Table (SMST).
350 @param This The EFI_SMM_BASE2_PROTOCOL instance.
351 @param Smst On return, points to a pointer to the System Management Service Table (SMST).
353 @retval EFI_INVALID_PARAMETER Smst or This was invalid.
354 @retval EFI_SUCCESS The memory was returned to the system.
355 @retval EFI_UNSUPPORTED Not in SMM.
360 SmmBase2GetSmstLocation (
361 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
362 OUT EFI_SMM_SYSTEM_TABLE2
**Smst
365 if ((This
== NULL
) ||(Smst
== NULL
)) {
366 return EFI_INVALID_PARAMETER
;
369 if (!gSmmCorePrivate
->InSmm
) {
370 return EFI_UNSUPPORTED
;
373 *Smst
= gSmmCorePrivate
->Smst
;
379 Communicates with a registered handler.
381 This function provides a service to send and receive messages from a registered
382 UEFI service. This function is part of the SMM Communication Protocol that may
383 be called in physical mode prior to SetVirtualAddressMap() and in virtual mode
384 after SetVirtualAddressMap().
386 @param[in] This The EFI_SMM_COMMUNICATION_PROTOCOL instance.
387 @param[in, out] CommBuffer A pointer to the buffer to convey into SMRAM.
388 @param[in, out] CommSize The size of the data buffer being passed in.On exit, the size of data
389 being returned. Zero if the handler does not wish to reply with any data.
391 @retval EFI_SUCCESS The message was successfully posted.
392 @retval EFI_INVALID_PARAMETER The CommBuffer was NULL.
396 SmmCommunicationCommunicate (
397 IN CONST EFI_SMM_COMMUNICATION_PROTOCOL
*This
,
398 IN OUT VOID
*CommBuffer
,
399 IN OUT UINTN
*CommSize
403 EFI_SMM_COMMUNICATE_HEADER
*CommunicateHeader
;
409 if ((CommBuffer
== NULL
) || (CommSize
== NULL
)) {
410 return EFI_INVALID_PARAMETER
;
414 // CommSize must hold HeaderGuid and MessageLength
416 if (*CommSize
< OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
)) {
417 return EFI_INVALID_PARAMETER
;
421 // If not already in SMM, then generate a Software SMI
423 if (!gSmmCorePrivate
->InSmm
&& gSmmCorePrivate
->SmmEntryPointRegistered
) {
425 // Put arguments for Software SMI in gSmmCorePrivate
427 gSmmCorePrivate
->CommunicationBuffer
= CommBuffer
;
428 gSmmCorePrivate
->BufferSize
= *CommSize
;
431 // Generate Software SMI
433 Status
= mSmmControl2
->Trigger (mSmmControl2
, NULL
, NULL
, FALSE
, 0);
434 if (EFI_ERROR (Status
)) {
435 return EFI_UNSUPPORTED
;
439 // Return status from software SMI
441 *CommSize
= gSmmCorePrivate
->BufferSize
;
442 return gSmmCorePrivate
->ReturnStatus
;
446 // If we are in SMM, then the execution mode must be physical, which means that
447 // OS established virtual addresses can not be used. If SetVirtualAddressMap()
448 // has been called, then a direct invocation of the Software SMI is not
449 // not allowed so return EFI_INVALID_PARAMETER.
451 if (EfiGoneVirtual()) {
452 return EFI_INVALID_PARAMETER
;
456 // Don't allow call SmiManage() directly when SMRAM is closed or locked.
458 if (!mSmmAccess
->OpenState
|| mSmmAccess
->LockState
) {
459 return EFI_INVALID_PARAMETER
;
463 // Save current InSmm state and set InSmm state to TRUE
465 OldInSmm
= gSmmCorePrivate
->InSmm
;
466 gSmmCorePrivate
->InSmm
= TRUE
;
469 // Already in SMM and before SetVirtualAddressMap(), so call SmiManage() directly.
471 CommunicateHeader
= (EFI_SMM_COMMUNICATE_HEADER
*)CommBuffer
;
472 *CommSize
-= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
473 Status
= gSmmCorePrivate
->Smst
->SmiManage (
474 &CommunicateHeader
->HeaderGuid
,
476 CommunicateHeader
->Data
,
481 // Update CommunicationBuffer, BufferSize and ReturnStatus
482 // Communicate service finished, reset the pointer to CommBuffer to NULL
484 *CommSize
+= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
487 // Restore original InSmm state
489 gSmmCorePrivate
->InSmm
= OldInSmm
;
491 return (Status
== EFI_WARN_INTERRUPT_SOURCE_QUIESCED
) ? EFI_SUCCESS
: EFI_NOT_FOUND
;
495 Event notification that is fired when DxeDispatch Event Group is signaled.
497 @param Event The Event that is being processed, not used.
498 @param Context Event Context, not used.
503 SmmIplGuidedEventNotify (
508 EFI_SMM_COMMUNICATE_HEADER CommunicateHeader
;
512 // Use Guid to initialize EFI_SMM_COMMUNICATE_HEADER structure
514 CopyGuid (&CommunicateHeader
.HeaderGuid
, (EFI_GUID
*)Context
);
515 CommunicateHeader
.MessageLength
= 1;
516 CommunicateHeader
.Data
[0] = 0;
519 // Generate the Software SMI and return the result
521 Size
= sizeof (CommunicateHeader
);
522 SmmCommunicationCommunicate (&mSmmCommunication
, &CommunicateHeader
, &Size
);
526 Event notification that is fired every time a gEfiSmmConfigurationProtocol installs.
528 @param Event The Event that is being processed, not used.
529 @param Context Event Context, not used.
534 SmmIplSmmConfigurationEventNotify (
540 EFI_SMM_CONFIGURATION_PROTOCOL
*SmmConfiguration
;
543 // Make sure this notification is for this handler
545 Status
= gBS
->LocateProtocol (Context
, NULL
, (VOID
**)&SmmConfiguration
);
546 if (EFI_ERROR (Status
)) {
551 // Register the SMM Entry Point provided by the SMM Core with the SMM COnfiguration protocol
553 Status
= SmmConfiguration
->RegisterSmmEntry (SmmConfiguration
, gSmmCorePrivate
->SmmEntryPoint
);
554 ASSERT_EFI_ERROR (Status
);
557 // Set flag to indicate that the SM< Entry Point has been registered which
558 // means that SMIs are now fully operational.
560 gSmmCorePrivate
->SmmEntryPointRegistered
= TRUE
;
563 // Print debug message showing SMM Core entry point address.
565 DEBUG ((DEBUG_INFO
, "SMM IPL registered SMM Entry Point address %p\n", (VOID
*)(UINTN
)gSmmCorePrivate
->SmmEntryPoint
));
568 // Attempt to reset SMRAM cacheability to UC
570 Status
= gDS
->SetMemorySpaceAttributes(
575 if (EFI_ERROR (Status
)) {
576 DEBUG ((DEBUG_WARN
, "SMM IPL failed to reset SMRAM window to EFI_MEMORY_UC\n"));
580 // Close all SMRAM ranges to protect SMRAM
582 Status
= mSmmAccess
->Close (mSmmAccess
);
583 ASSERT_EFI_ERROR (Status
);
586 // Print debug message that the SMRAM window is now closed.
588 DEBUG ((DEBUG_INFO
, "SMM IPL closed SMRAM window\n"));
592 Event notification that is fired every time a DxeSmmReadyToLock protocol is added
593 or if gEfiEventReadyToBootGuid is signalled.
595 @param Event The Event that is being processed, not used.
596 @param Context Event Context, not used.
601 SmmIplReadyToLockEventNotify (
611 // See if we are already locked
618 // Make sure this notification is for this handler
620 if (CompareGuid ((EFI_GUID
*)Context
, &gEfiDxeSmmReadyToLockProtocolGuid
)) {
621 Status
= gBS
->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid
, NULL
, &Interface
);
622 if (EFI_ERROR (Status
)) {
627 // If SMM is not locked yet and we got here from gEfiEventReadyToBootGuid being
628 // signalled, then gEfiDxeSmmReadyToLockProtocolGuid was not installed as expected.
629 // Print a warning on debug builds.
631 DEBUG ((DEBUG_WARN
, "SMM IPL! DXE SMM Ready To Lock Protocol not installed before Ready To Boot signal\n"));
635 // Lock the SMRAM (Note: Locking SMRAM may not be supported on all platforms)
637 mSmmAccess
->Lock (mSmmAccess
);
640 // Close protocol and event notification events that do not apply after the
641 // DXE SMM Ready To Lock Protocol has been installed or the Ready To Boot
642 // event has been signalled.
644 for (Index
= 0; mSmmIplEvents
[Index
].NotifyFunction
!= NULL
; Index
++) {
645 if (mSmmIplEvents
[Index
].CloseOnLock
) {
646 gBS
->CloseEvent (mSmmIplEvents
[Index
].Event
);
651 // Inform SMM Core that the DxeSmmReadyToLock protocol was installed
653 SmmIplGuidedEventNotify (Event
, (VOID
*)&gEfiDxeSmmReadyToLockProtocolGuid
);
656 // Print debug message that the SMRAM window is now locked.
658 DEBUG ((DEBUG_INFO
, "SMM IPL locked SMRAM window\n"));
661 // Set flag so this operation will not be performed again
667 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
669 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
670 It convers pointer to new virtual address.
672 @param Event Event whose notification function is being invoked.
673 @param Context Pointer to the notification function's context.
678 SmmIplSetVirtualAddressNotify (
683 EfiConvertPointer (0x0, (VOID
**)&mSmmControl2
);
687 Searches all Firmware Volumes for the first file matching FileType and SectionType and returns the section data.
689 @param FileType FileType to search for within any of the firmware volumes in the platform.
690 @param SectionType SectionType to search for within any of the matching FileTypes in the firmware volumes in the platform.
691 @param SourceSize Return the size of the returned section data..
693 @retval != NULL Pointer to the allocated buffer containing the section data.
694 @retval NULL Section data was not found.
699 IN EFI_FV_FILETYPE FileType
,
700 IN EFI_SECTION_TYPE SectionType
,
701 OUT UINTN
*SourceSize
706 EFI_HANDLE
*HandleBuffer
;
708 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
711 EFI_FV_FILE_ATTRIBUTES Attributes
;
713 UINT32 AuthenticationStatus
;
716 Status
= gBS
->LocateHandleBuffer (
718 &gEfiFirmwareVolume2ProtocolGuid
,
723 if (EFI_ERROR (Status
)) {
727 for (Index
= 0; Index
< HandleCount
; Index
++) {
728 Status
= gBS
->HandleProtocol (
730 &gEfiFirmwareVolume2ProtocolGuid
,
733 if (EFI_ERROR (Status
)) {
738 // Use Firmware Volume 2 Protocol to search for a file of type FileType
741 Status
= Fv
->GetNextFile (Fv
, &Key
, &FileType
, &NameGuid
, &Attributes
, SourceSize
);
742 if (EFI_ERROR (Status
)) {
747 // Use Firmware Volume 2 Protocol to read a section of type SectionType
750 Status
= Fv
->ReadSection (Fv
, &NameGuid
, SectionType
, 0, &SourceBuffer
, SourceSize
, &AuthenticationStatus
);
751 if (!EFI_ERROR (Status
)) {
752 FreePool (HandleBuffer
);
757 FreePool(HandleBuffer
);
762 Get the fixed loadding address from image header assigned by build tool. This function only be called
763 when Loading module at Fixed address feature enabled.
765 @param ImageContext Pointer to the image context structure that describes the PE/COFF
766 image that needs to be examined by this function.
767 @retval EFI_SUCCESS An fixed loading address is assigned to this image by build tools .
768 @retval EFI_NOT_FOUND The image has no assigned fixed loadding address.
771 GetPeCoffImageFixLoadingAssignedAddress(
772 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
775 UINTN SectionHeaderOffset
;
777 EFI_IMAGE_SECTION_HEADER SectionHeader
;
778 EFI_IMAGE_OPTIONAL_HEADER_UNION
*ImgHdr
;
779 EFI_PHYSICAL_ADDRESS FixLoaddingAddress
;
782 UINT16 NumberOfSections
;
783 EFI_PHYSICAL_ADDRESS SmramBase
;
785 UINT64 ValueInSectionHeader
;
787 // Build tool will calculate the smm code size and then patch the PcdLoadFixAddressSmmCodePageNumber
789 SmmCodeSize
= EFI_PAGES_TO_SIZE (PcdGet32(PcdLoadFixAddressSmmCodePageNumber
));
791 FixLoaddingAddress
= 0;
792 Status
= EFI_NOT_FOUND
;
793 SmramBase
= mCurrentSmramRange
->CpuStart
;
795 // Get PeHeader pointer
797 ImgHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)((CHAR8
* )ImageContext
->Handle
+ ImageContext
->PeCoffHeaderOffset
);
798 SectionHeaderOffset
= (UINTN
)(
799 ImageContext
->PeCoffHeaderOffset
+
801 sizeof (EFI_IMAGE_FILE_HEADER
) +
802 ImgHdr
->Pe32
.FileHeader
.SizeOfOptionalHeader
804 NumberOfSections
= ImgHdr
->Pe32
.FileHeader
.NumberOfSections
;
807 // Get base address from the first section header that doesn't point to code section.
809 for (Index
= 0; Index
< NumberOfSections
; Index
++) {
811 // Read section header from file
813 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
814 Status
= ImageContext
->ImageRead (
815 ImageContext
->Handle
,
820 if (EFI_ERROR (Status
)) {
824 Status
= EFI_NOT_FOUND
;
826 if ((SectionHeader
.Characteristics
& EFI_IMAGE_SCN_CNT_CODE
) == 0) {
828 // Build tool saves the offset to SMRAM base as image base in PointerToRelocations & PointerToLineNumbers fields in the
829 // first section header that doesn't point to code section in image header. And there is an assumption that when the
830 // feature is enabled, if a module is assigned a loading address by tools, PointerToRelocations & PointerToLineNumbers
831 // fields should NOT be Zero, or else, these 2 fileds should be set to Zero
833 ValueInSectionHeader
= ReadUnaligned64((UINT64
*)&SectionHeader
.PointerToRelocations
);
834 if (ValueInSectionHeader
!= 0) {
836 // Found first section header that doesn't point to code section in which uild tool saves the
837 // offset to SMRAM base as image base in PointerToRelocations & PointerToLineNumbers fields
839 FixLoaddingAddress
= (EFI_PHYSICAL_ADDRESS
)(SmramBase
+ (INT64
)ValueInSectionHeader
);
841 if (SmramBase
+ SmmCodeSize
> FixLoaddingAddress
&& SmramBase
<= FixLoaddingAddress
) {
843 // The assigned address is valid. Return the specified loadding address
845 ImageContext
->ImageAddress
= FixLoaddingAddress
;
846 Status
= EFI_SUCCESS
;
851 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
853 DEBUG ((EFI_D_INFO
|EFI_D_LOAD
, "LOADING MODULE FIXED INFO: Loading module at fixed address %x, Status = %r \n", FixLoaddingAddress
, Status
));
857 Load the SMM Core image into SMRAM and executes the SMM Core from SMRAM.
859 @param[in] SmramRange Descriptor for the range of SMRAM to reload the
860 currently executing image.
861 @param[in] Context Context to pass into SMM Core
867 ExecuteSmmCoreFromSmram (
868 IN EFI_SMRAM_DESCRIPTOR
*SmramRange
,
875 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
877 EFI_PHYSICAL_ADDRESS DestinationBuffer
;
878 EFI_IMAGE_ENTRY_POINT EntryPoint
;
881 // Search all Firmware Volumes for a PE/COFF image in a file of type SMM_CORE
883 SourceBuffer
= GetSectionInAnyFv (EFI_FV_FILETYPE_SMM_CORE
, EFI_SECTION_PE32
, &SourceSize
);
884 if (SourceBuffer
== NULL
) {
885 return EFI_NOT_FOUND
;
889 // Initilize ImageContext
891 ImageContext
.Handle
= SourceBuffer
;
892 ImageContext
.ImageRead
= PeCoffLoaderImageReadFromMemory
;
895 // Get information about the image being loaded
897 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
898 if (EFI_ERROR (Status
)) {
902 // if Loading module at Fixed Address feature is enabled, the SMM core driver will be loaded to
903 // the address assigned by build tool.
905 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
907 // Get the fixed loading address assigned by Build tool
909 Status
= GetPeCoffImageFixLoadingAssignedAddress (&ImageContext
);
910 if (!EFI_ERROR (Status
)) {
912 // Since the memory range to load SMM CORE will be cut out in SMM core, so no need to allocate and free this range
916 DEBUG ((EFI_D_INFO
, "LOADING MODULE FIXED ERROR: Loading module at fixed address at address failed\n"));
918 // Allocate memory for the image being loaded from the EFI_SRAM_DESCRIPTOR
919 // specified by SmramRange
921 PageCount
= (UINTN
)EFI_SIZE_TO_PAGES(ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
923 ASSERT ((SmramRange
->PhysicalSize
& EFI_PAGE_MASK
) == 0);
924 ASSERT (SmramRange
->PhysicalSize
> EFI_PAGES_TO_SIZE (PageCount
));
926 SmramRange
->PhysicalSize
-= EFI_PAGES_TO_SIZE (PageCount
);
927 DestinationBuffer
= SmramRange
->CpuStart
+ SmramRange
->PhysicalSize
;
930 // Align buffer on section boundry
932 ImageContext
.ImageAddress
= DestinationBuffer
;
936 // Allocate memory for the image being loaded from the EFI_SRAM_DESCRIPTOR
937 // specified by SmramRange
939 PageCount
= (UINTN
)EFI_SIZE_TO_PAGES(ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
941 ASSERT ((SmramRange
->PhysicalSize
& EFI_PAGE_MASK
) == 0);
942 ASSERT (SmramRange
->PhysicalSize
> EFI_PAGES_TO_SIZE (PageCount
));
944 SmramRange
->PhysicalSize
-= EFI_PAGES_TO_SIZE (PageCount
);
945 DestinationBuffer
= SmramRange
->CpuStart
+ SmramRange
->PhysicalSize
;
948 // Align buffer on section boundry
950 ImageContext
.ImageAddress
= DestinationBuffer
;
953 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
- 1;
954 ImageContext
.ImageAddress
&= ~(ImageContext
.SectionAlignment
- 1);
957 // Print debug message showing SMM Core load address.
959 DEBUG ((DEBUG_INFO
, "SMM IPL loading SMM Core at SMRAM address %p\n", (VOID
*)(UINTN
)ImageContext
.ImageAddress
));
962 // Load the image to our new buffer
964 Status
= PeCoffLoaderLoadImage (&ImageContext
);
965 if (!EFI_ERROR (Status
)) {
967 // Relocate the image in our new buffer
969 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
970 if (!EFI_ERROR (Status
)) {
972 // Flush the instruction cache so the image data are written before we execute it
974 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)ImageContext
.ImageAddress
, (UINTN
)ImageContext
.ImageSize
);
977 // Print debug message showing SMM Core entry point address.
979 DEBUG ((DEBUG_INFO
, "SMM IPL calling SMM Core at SMRAM address %p\n", (VOID
*)(UINTN
)ImageContext
.EntryPoint
));
984 EntryPoint
= (EFI_IMAGE_ENTRY_POINT
)(UINTN
)ImageContext
.EntryPoint
;
985 Status
= EntryPoint ((EFI_HANDLE
)Context
, gST
);
990 // If the load operation, relocate operation, or the image execution return an
991 // error, then free memory allocated from the EFI_SRAM_DESCRIPTOR specified by
994 if (EFI_ERROR (Status
)) {
995 SmramRange
->PhysicalSize
+= EFI_PAGES_TO_SIZE (PageCount
);
999 // Always free memory allocted by GetFileBufferByFilePath ()
1001 FreePool (SourceBuffer
);
1007 The Entry Point for SMM IPL
1009 Load SMM Core into SMRAM, register SMM Core entry point for SMIs, install
1010 SMM Base 2 Protocol and SMM Communication Protocol, and register for the
1011 critical events required to coordinate between DXE and SMM environments.
1013 @param ImageHandle The firmware allocated handle for the EFI image.
1014 @param SystemTable A pointer to the EFI System Table.
1016 @retval EFI_SUCCESS The entry point is executed successfully.
1017 @retval Other Some error occurred when executing this entry point.
1023 IN EFI_HANDLE ImageHandle
,
1024 IN EFI_SYSTEM_TABLE
*SystemTable
1028 EFI_SMM_CONFIGURATION_PROTOCOL
*SmmConfiguration
;
1031 EFI_SMM_RESERVED_SMRAM_REGION
*SmramResRegion
;
1035 EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE
*LMFAConfigurationTable
;
1038 // Fill in the image handle of the SMM IPL so the SMM Core can use this as the
1039 // ParentImageHandle field of the Load Image Protocol for all SMM Drivers loaded
1042 mSmmCorePrivateData
.SmmIplImageHandle
= ImageHandle
;
1045 // Get SMM Access Protocol
1047 Status
= gBS
->LocateProtocol (&gEfiSmmAccess2ProtocolGuid
, NULL
, (VOID
**)&mSmmAccess
);
1048 ASSERT_EFI_ERROR (Status
);
1051 // Get SMM Control2 Protocol
1053 Status
= gBS
->LocateProtocol (&gEfiSmmControl2ProtocolGuid
, NULL
, (VOID
**)&mSmmControl2
);
1054 ASSERT_EFI_ERROR (Status
);
1057 // Get SMM Configuration Protocol if it is present
1059 SmmConfiguration
= NULL
;
1060 Status
= gBS
->LocateProtocol (&gEfiSmmConfigurationProtocolGuid
, NULL
, (VOID
**) &SmmConfiguration
);
1063 // Get SMRAM information
1066 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, NULL
);
1067 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
1069 gSmmCorePrivate
->SmramRanges
= (EFI_SMRAM_DESCRIPTOR
*)AllocatePool (Size
);
1070 ASSERT (gSmmCorePrivate
->SmramRanges
!= NULL
);
1072 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, gSmmCorePrivate
->SmramRanges
);
1073 ASSERT_EFI_ERROR (Status
);
1075 gSmmCorePrivate
->SmramRangeCount
= Size
/ sizeof (EFI_SMRAM_DESCRIPTOR
);
1078 // Open all SMRAM ranges
1080 Status
= mSmmAccess
->Open (mSmmAccess
);
1081 ASSERT_EFI_ERROR (Status
);
1084 // Print debug message that the SMRAM window is now open.
1086 DEBUG ((DEBUG_INFO
, "SMM IPL opened SMRAM window\n"));
1089 // Subtract SMRAM any reserved SMRAM regions.
1091 if (SmmConfiguration
!= NULL
) {
1092 SmramResRegion
= SmmConfiguration
->SmramReservedRegions
;
1093 while (SmramResRegion
->SmramReservedSize
!= 0) {
1094 for (Index
= 0; Index
< gSmmCorePrivate
->SmramRangeCount
; Index
++) {
1095 if ((SmramResRegion
->SmramReservedStart
>= gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
) && \
1096 ((SmramResRegion
->SmramReservedStart
+ SmramResRegion
->SmramReservedSize
) <= \
1097 (gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
+ gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
))) {
1099 // This range has reserved area, calculate the left free size
1101 gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
= SmramResRegion
->SmramReservedStart
- gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
;
1109 // Find the largest SMRAM range between 1MB and 4GB that is at least 256KB - 4K in size
1111 mCurrentSmramRange
= NULL
;
1112 for (Index
= 0, MaxSize
= SIZE_256KB
- EFI_PAGE_SIZE
; Index
< gSmmCorePrivate
->SmramRangeCount
; Index
++) {
1113 if (gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
>= BASE_1MB
) {
1114 if ((gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
+ gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
) <= BASE_4GB
) {
1115 if (gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
>= MaxSize
) {
1116 MaxSize
= gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
;
1117 mCurrentSmramRange
= &gSmmCorePrivate
->SmramRanges
[Index
];
1123 if (mCurrentSmramRange
!= NULL
) {
1125 // Print debug message showing SMRAM window that will be used by SMM IPL and SMM Core
1127 DEBUG ((DEBUG_INFO
, "SMM IPL found SMRAM window %p - %p\n",
1128 (VOID
*)(UINTN
)mCurrentSmramRange
->CpuStart
,
1129 (VOID
*)(UINTN
)(mCurrentSmramRange
->CpuStart
+ mCurrentSmramRange
->PhysicalSize
- 1)
1132 GetSmramCacheRange (mCurrentSmramRange
, &mSmramCacheBase
, &mSmramCacheSize
);
1134 // Attempt to set SMRAM cacheability to WB
1136 Status
= gDS
->SetMemorySpaceAttributes(
1141 if (EFI_ERROR (Status
)) {
1142 DEBUG ((DEBUG_WARN
, "SMM IPL failed to set SMRAM window to EFI_MEMORY_WB\n"));
1145 // if Loading module at Fixed Address feature is enabled, save the SMRAM base to Load
1146 // Modules At Fixed Address Configuration Table.
1148 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
1150 // Build tool will calculate the smm code size and then patch the PcdLoadFixAddressSmmCodePageNumber
1152 SmmCodeSize
= LShiftU64 (PcdGet32(PcdLoadFixAddressSmmCodePageNumber
), EFI_PAGE_SHIFT
);
1154 // The SMRAM available memory is assumed to be larger than SmmCodeSize
1156 ASSERT (mCurrentSmramRange
->PhysicalSize
> SmmCodeSize
);
1158 // Retrieve Load modules At fixed address configuration table and save the SMRAM base.
1160 Status
= EfiGetSystemConfigurationTable (
1161 &gLoadFixedAddressConfigurationTableGuid
,
1162 (VOID
**) &LMFAConfigurationTable
1164 if (!EFI_ERROR (Status
) && LMFAConfigurationTable
!= NULL
) {
1165 LMFAConfigurationTable
->SmramBase
= mCurrentSmramRange
->CpuStart
;
1167 // Print the SMRAM base
1169 DEBUG ((EFI_D_INFO
, "LOADING MODULE FIXED INFO: TSEG BASE is %x. \n", LMFAConfigurationTable
->SmramBase
));
1173 // Load SMM Core into SMRAM and execute it from SMRAM
1175 Status
= ExecuteSmmCoreFromSmram (mCurrentSmramRange
, gSmmCorePrivate
);
1176 if (EFI_ERROR (Status
)) {
1178 // Print error message that the SMM Core failed to be loaded and executed.
1180 DEBUG ((DEBUG_ERROR
, "SMM IPL could not load and execute SMM Core from SMRAM\n"));
1183 // Attempt to reset SMRAM cacheability to UC
1185 Status
= gDS
->SetMemorySpaceAttributes(
1190 if (EFI_ERROR (Status
)) {
1191 DEBUG ((DEBUG_WARN
, "SMM IPL failed to reset SMRAM window to EFI_MEMORY_UC\n"));
1196 // Print error message that there are not enough SMRAM resources to load the SMM Core.
1198 DEBUG ((DEBUG_ERROR
, "SMM IPL could not find a large enough SMRAM region to load SMM Core\n"));
1202 // If the SMM Core could not be loaded then close SMRAM window, free allocated
1203 // resources, and return an error so SMM IPL will be unloaded.
1205 if (mCurrentSmramRange
== NULL
|| EFI_ERROR (Status
)) {
1207 // Close all SMRAM ranges
1209 Status
= mSmmAccess
->Close (mSmmAccess
);
1210 ASSERT_EFI_ERROR (Status
);
1213 // Print debug message that the SMRAM window is now closed.
1215 DEBUG ((DEBUG_INFO
, "SMM IPL closed SMRAM window\n"));
1218 // Free all allocated resources
1220 FreePool (gSmmCorePrivate
->SmramRanges
);
1222 return EFI_UNSUPPORTED
;
1226 // Install SMM Base2 Protocol and SMM Communication Protocol
1228 Status
= gBS
->InstallMultipleProtocolInterfaces (
1230 &gEfiSmmBase2ProtocolGuid
, &mSmmBase2
,
1231 &gEfiSmmCommunicationProtocolGuid
, &mSmmCommunication
,
1234 ASSERT_EFI_ERROR (Status
);
1237 // Create the set of protocol and event notififcations that the SMM IPL requires
1239 for (Index
= 0; mSmmIplEvents
[Index
].NotifyFunction
!= NULL
; Index
++) {
1240 if (mSmmIplEvents
[Index
].Protocol
) {
1241 mSmmIplEvents
[Index
].Event
= EfiCreateProtocolNotifyEvent (
1242 mSmmIplEvents
[Index
].Guid
,
1244 mSmmIplEvents
[Index
].NotifyFunction
,
1245 mSmmIplEvents
[Index
].NotifyContext
,
1249 Status
= gBS
->CreateEventEx (
1252 mSmmIplEvents
[Index
].NotifyFunction
,
1253 mSmmIplEvents
[Index
].NotifyContext
,
1254 mSmmIplEvents
[Index
].Guid
,
1255 &mSmmIplEvents
[Index
].Event
1257 ASSERT_EFI_ERROR (Status
);