2 SMM IPL that produces SMM related runtime protocols and load the SMM Core into SMRAM
4 Copyright (c) 2009 - 2017, 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/Cpu.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/DxeServicesLib.h>
38 #include <Library/UefiLib.h>
39 #include <Library/UefiRuntimeLib.h>
40 #include <Library/PcdLib.h>
41 #include <Library/ReportStatusCodeLib.h>
43 #include "PiSmmCorePrivateData.h"
46 // Function prototypes from produced protocols
50 Indicate whether the driver is currently executing in the SMM Initialization phase.
52 @param This The EFI_SMM_BASE2_PROTOCOL instance.
53 @param InSmram Pointer to a Boolean which, on return, indicates that the driver is currently executing
54 inside of SMRAM (TRUE) or outside of SMRAM (FALSE).
56 @retval EFI_INVALID_PARAMETER InSmram was NULL.
57 @retval EFI_SUCCESS The call returned successfully.
63 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
68 Retrieves the location of the System Management System Table (SMST).
70 @param This The EFI_SMM_BASE2_PROTOCOL instance.
71 @param Smst On return, points to a pointer to the System Management Service Table (SMST).
73 @retval EFI_INVALID_PARAMETER Smst or This was invalid.
74 @retval EFI_SUCCESS The memory was returned to the system.
75 @retval EFI_UNSUPPORTED Not in SMM.
80 SmmBase2GetSmstLocation (
81 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
82 OUT EFI_SMM_SYSTEM_TABLE2
**Smst
86 Communicates with a registered handler.
88 This function provides a service to send and receive messages from a registered
89 UEFI service. This function is part of the SMM Communication Protocol that may
90 be called in physical mode prior to SetVirtualAddressMap() and in virtual mode
91 after SetVirtualAddressMap().
93 @param[in] This The EFI_SMM_COMMUNICATION_PROTOCOL instance.
94 @param[in, out] CommBuffer A pointer to the buffer to convey into SMRAM.
95 @param[in, out] CommSize The size of the data buffer being passed in.On exit, the size of data
96 being returned. Zero if the handler does not wish to reply with any data.
98 @retval EFI_SUCCESS The message was successfully posted.
99 @retval EFI_INVALID_PARAMETER The CommBuffer was NULL.
103 SmmCommunicationCommunicate (
104 IN CONST EFI_SMM_COMMUNICATION_PROTOCOL
*This
,
105 IN OUT VOID
*CommBuffer
,
106 IN OUT UINTN
*CommSize
110 Event notification that is fired every time a gEfiSmmConfigurationProtocol installs.
112 @param Event The Event that is being processed, not used.
113 @param Context Event Context, not used.
118 SmmIplSmmConfigurationEventNotify (
124 Event notification that is fired every time a DxeSmmReadyToLock protocol is added
125 or if gEfiEventReadyToBootGuid is signalled.
127 @param Event The Event that is being processed, not used.
128 @param Context Event Context, not used.
133 SmmIplReadyToLockEventNotify (
139 Event notification that is fired when DxeDispatch Event Group is signaled.
141 @param Event The Event that is being processed, not used.
142 @param Context Event Context, not used.
147 SmmIplDxeDispatchEventNotify (
153 Event notification that is fired when a GUIDed Event Group is signaled.
155 @param Event The Event that is being processed, not used.
156 @param Context Event Context, not used.
161 SmmIplGuidedEventNotify (
167 Event notification that is fired when EndOfDxe Event Group is signaled.
169 @param Event The Event that is being processed, not used.
170 @param Context Event Context, not used.
175 SmmIplEndOfDxeEventNotify (
181 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
183 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
184 It convers pointer to new virtual address.
186 @param Event Event whose notification function is being invoked.
187 @param Context Pointer to the notification function's context.
192 SmmIplSetVirtualAddressNotify (
198 // Data structure used to declare a table of protocol notifications and event
199 // notifications required by the SMM IPL
205 EFI_EVENT_NOTIFY NotifyFunction
;
209 } SMM_IPL_EVENT_NOTIFICATION
;
212 // Handle to install the SMM Base2 Protocol and the SMM Communication Protocol
214 EFI_HANDLE mSmmIplHandle
= NULL
;
217 // SMM Base 2 Protocol instance
219 EFI_SMM_BASE2_PROTOCOL mSmmBase2
= {
221 SmmBase2GetSmstLocation
225 // SMM Communication Protocol instance
227 EFI_SMM_COMMUNICATION_PROTOCOL mSmmCommunication
= {
228 SmmCommunicationCommunicate
232 // SMM Core Private Data structure that contains the data shared between
233 // the SMM IPL and the SMM Core.
235 SMM_CORE_PRIVATE_DATA mSmmCorePrivateData
= {
236 SMM_CORE_PRIVATE_DATA_SIGNATURE
, // Signature
237 NULL
, // SmmIplImageHandle
238 0, // SmramRangeCount
240 NULL
, // SmmEntryPoint
241 FALSE
, // SmmEntryPointRegistered
244 NULL
, // CommunicationBuffer
246 EFI_SUCCESS
// ReturnStatus
250 // Global pointer used to access mSmmCorePrivateData from outside and inside SMM
252 SMM_CORE_PRIVATE_DATA
*gSmmCorePrivate
= &mSmmCorePrivateData
;
255 // SMM IPL global variables
257 EFI_SMM_CONTROL2_PROTOCOL
*mSmmControl2
;
258 EFI_SMM_ACCESS2_PROTOCOL
*mSmmAccess
;
259 EFI_SMRAM_DESCRIPTOR
*mCurrentSmramRange
;
260 BOOLEAN mSmmLocked
= FALSE
;
261 BOOLEAN mEndOfDxe
= FALSE
;
262 EFI_PHYSICAL_ADDRESS mSmramCacheBase
;
263 UINT64 mSmramCacheSize
;
265 EFI_SMM_COMMUNICATE_HEADER mCommunicateHeader
;
268 // Table of Protocol notification and GUIDed Event notifications that the SMM IPL requires
270 SMM_IPL_EVENT_NOTIFICATION mSmmIplEvents
[] = {
272 // Declare protocol notification on the SMM Configuration protocol. When this notification is established,
273 // the associated event is immediately signalled, so the notification function will be executed and the
274 // SMM Configuration Protocol will be found if it is already in the handle database.
276 { TRUE
, FALSE
, &gEfiSmmConfigurationProtocolGuid
, SmmIplSmmConfigurationEventNotify
, &gEfiSmmConfigurationProtocolGuid
, TPL_NOTIFY
, NULL
},
278 // Declare protocol notification on DxeSmmReadyToLock protocols. When this notification is established,
279 // the associated event is immediately signalled, so the notification function will be executed and the
280 // DXE SMM Ready To Lock Protocol will be found if it is already in the handle database.
282 { TRUE
, TRUE
, &gEfiDxeSmmReadyToLockProtocolGuid
, SmmIplReadyToLockEventNotify
, &gEfiDxeSmmReadyToLockProtocolGuid
, TPL_CALLBACK
, NULL
},
284 // Declare event notification on EndOfDxe event. When this notification is established,
285 // the associated event is immediately signalled, so the notification function will be executed and the
286 // SMM End Of Dxe Protocol will be found if it is already in the handle database.
288 { FALSE
, TRUE
, &gEfiEndOfDxeEventGroupGuid
, SmmIplGuidedEventNotify
, &gEfiEndOfDxeEventGroupGuid
, TPL_CALLBACK
, NULL
},
290 // Declare event notification on EndOfDxe event. This is used to set EndOfDxe event signaled flag.
292 { FALSE
, TRUE
, &gEfiEndOfDxeEventGroupGuid
, SmmIplEndOfDxeEventNotify
, &gEfiEndOfDxeEventGroupGuid
, TPL_CALLBACK
, NULL
},
294 // Declare event notification on the DXE Dispatch Event Group. This event is signaled by the DXE Core
295 // each time the DXE Core dispatcher has completed its work. When this event is signalled, the SMM Core
296 // if notified, so the SMM Core can dispatch SMM drivers.
298 { FALSE
, TRUE
, &gEfiEventDxeDispatchGuid
, SmmIplDxeDispatchEventNotify
, &gEfiEventDxeDispatchGuid
, TPL_CALLBACK
, NULL
},
300 // Declare event notification on Ready To Boot Event Group. This is an extra event notification that is
301 // used to make sure SMRAM is locked before any boot options are processed.
303 { FALSE
, TRUE
, &gEfiEventReadyToBootGuid
, SmmIplReadyToLockEventNotify
, &gEfiEventReadyToBootGuid
, TPL_CALLBACK
, NULL
},
305 // Declare event notification on Legacy Boot Event Group. This is used to inform the SMM Core that the platform
306 // is performing a legacy boot operation, and that the UEFI environment is no longer available and the SMM Core
307 // must guarantee that it does not access any UEFI related structures outside of SMRAM.
308 // It is also to inform the SMM Core to notify SMM driver that system enter legacy boot.
310 { FALSE
, FALSE
, &gEfiEventLegacyBootGuid
, SmmIplGuidedEventNotify
, &gEfiEventLegacyBootGuid
, TPL_CALLBACK
, NULL
},
312 // Declare event notification on Exit Boot Services Event Group. This is used to inform the SMM Core
313 // to notify SMM driver that system enter exit boot services.
315 { FALSE
, FALSE
, &gEfiEventExitBootServicesGuid
, SmmIplGuidedEventNotify
, &gEfiEventExitBootServicesGuid
, TPL_CALLBACK
, NULL
},
317 // Declare event notification on Ready To Boot Event Group. This is used to inform the SMM Core
318 // to notify SMM driver that system enter ready to boot.
320 { FALSE
, FALSE
, &gEfiEventReadyToBootGuid
, SmmIplGuidedEventNotify
, &gEfiEventReadyToBootGuid
, TPL_CALLBACK
, NULL
},
322 // Declare event notification on SetVirtualAddressMap() Event Group. This is used to convert gSmmCorePrivate
323 // and mSmmControl2 from physical addresses to virtual addresses.
325 { FALSE
, FALSE
, &gEfiEventVirtualAddressChangeGuid
, SmmIplSetVirtualAddressNotify
, NULL
, TPL_CALLBACK
, NULL
},
327 // Terminate the table of event notifications
329 { FALSE
, FALSE
, NULL
, NULL
, NULL
, TPL_CALLBACK
, NULL
}
333 Find the maximum SMRAM cache range that covers the range specified by SmramRange.
335 This function searches and joins all adjacent ranges of SmramRange into a range to be cached.
337 @param SmramRange The SMRAM range to search from.
338 @param SmramCacheBase The returned cache range base.
339 @param SmramCacheSize The returned cache range size.
344 IN EFI_SMRAM_DESCRIPTOR
*SmramRange
,
345 OUT EFI_PHYSICAL_ADDRESS
*SmramCacheBase
,
346 OUT UINT64
*SmramCacheSize
350 EFI_PHYSICAL_ADDRESS RangeCpuStart
;
351 UINT64 RangePhysicalSize
;
352 BOOLEAN FoundAjacentRange
;
354 *SmramCacheBase
= SmramRange
->CpuStart
;
355 *SmramCacheSize
= SmramRange
->PhysicalSize
;
358 FoundAjacentRange
= FALSE
;
359 for (Index
= 0; Index
< gSmmCorePrivate
->SmramRangeCount
; Index
++) {
360 RangeCpuStart
= gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
;
361 RangePhysicalSize
= gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
;
362 if (RangeCpuStart
< *SmramCacheBase
&& *SmramCacheBase
== (RangeCpuStart
+ RangePhysicalSize
)) {
363 *SmramCacheBase
= RangeCpuStart
;
364 *SmramCacheSize
+= RangePhysicalSize
;
365 FoundAjacentRange
= TRUE
;
366 } else if ((*SmramCacheBase
+ *SmramCacheSize
) == RangeCpuStart
&& RangePhysicalSize
> 0) {
367 *SmramCacheSize
+= RangePhysicalSize
;
368 FoundAjacentRange
= TRUE
;
371 } while (FoundAjacentRange
);
376 Indicate whether the driver is currently executing in the SMM Initialization phase.
378 @param This The EFI_SMM_BASE2_PROTOCOL instance.
379 @param InSmram Pointer to a Boolean which, on return, indicates that the driver is currently executing
380 inside of SMRAM (TRUE) or outside of SMRAM (FALSE).
382 @retval EFI_INVALID_PARAMETER InSmram was NULL.
383 @retval EFI_SUCCESS The call returned successfully.
389 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
393 if (InSmram
== NULL
) {
394 return EFI_INVALID_PARAMETER
;
397 *InSmram
= gSmmCorePrivate
->InSmm
;
403 Retrieves the location of the System Management System Table (SMST).
405 @param This The EFI_SMM_BASE2_PROTOCOL instance.
406 @param Smst On return, points to a pointer to the System Management Service Table (SMST).
408 @retval EFI_INVALID_PARAMETER Smst or This was invalid.
409 @retval EFI_SUCCESS The memory was returned to the system.
410 @retval EFI_UNSUPPORTED Not in SMM.
415 SmmBase2GetSmstLocation (
416 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
417 OUT EFI_SMM_SYSTEM_TABLE2
**Smst
420 if ((This
== NULL
) ||(Smst
== NULL
)) {
421 return EFI_INVALID_PARAMETER
;
424 if (!gSmmCorePrivate
->InSmm
) {
425 return EFI_UNSUPPORTED
;
428 *Smst
= gSmmCorePrivate
->Smst
;
434 Communicates with a registered handler.
436 This function provides a service to send and receive messages from a registered
437 UEFI service. This function is part of the SMM Communication Protocol that may
438 be called in physical mode prior to SetVirtualAddressMap() and in virtual mode
439 after SetVirtualAddressMap().
441 @param[in] This The EFI_SMM_COMMUNICATION_PROTOCOL instance.
442 @param[in, out] CommBuffer A pointer to the buffer to convey into SMRAM.
443 @param[in, out] CommSize The size of the data buffer being passed in.On exit, the size of data
444 being returned. Zero if the handler does not wish to reply with any data.
446 @retval EFI_SUCCESS The message was successfully posted.
447 @retval EFI_INVALID_PARAMETER The CommBuffer was NULL.
451 SmmCommunicationCommunicate (
452 IN CONST EFI_SMM_COMMUNICATION_PROTOCOL
*This
,
453 IN OUT VOID
*CommBuffer
,
454 IN OUT UINTN
*CommSize
458 EFI_SMM_COMMUNICATE_HEADER
*CommunicateHeader
;
464 if ((CommBuffer
== NULL
) || (CommSize
== NULL
)) {
465 return EFI_INVALID_PARAMETER
;
469 // CommSize must hold HeaderGuid and MessageLength
471 if (*CommSize
< OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
)) {
472 return EFI_INVALID_PARAMETER
;
476 // If not already in SMM, then generate a Software SMI
478 if (!gSmmCorePrivate
->InSmm
&& gSmmCorePrivate
->SmmEntryPointRegistered
) {
480 // Put arguments for Software SMI in gSmmCorePrivate
482 gSmmCorePrivate
->CommunicationBuffer
= CommBuffer
;
483 gSmmCorePrivate
->BufferSize
= *CommSize
;
486 // Generate Software SMI
488 Status
= mSmmControl2
->Trigger (mSmmControl2
, NULL
, NULL
, FALSE
, 0);
489 if (EFI_ERROR (Status
)) {
490 return EFI_UNSUPPORTED
;
494 // Return status from software SMI
496 *CommSize
= gSmmCorePrivate
->BufferSize
;
497 return gSmmCorePrivate
->ReturnStatus
;
501 // If we are in SMM, then the execution mode must be physical, which means that
502 // OS established virtual addresses can not be used. If SetVirtualAddressMap()
503 // has been called, then a direct invocation of the Software SMI is not
504 // not allowed so return EFI_INVALID_PARAMETER.
506 if (EfiGoneVirtual()) {
507 return EFI_INVALID_PARAMETER
;
511 // If we are not in SMM, don't allow call SmiManage() directly when SMRAM is closed or locked.
513 if ((!gSmmCorePrivate
->InSmm
) && (!mSmmAccess
->OpenState
|| mSmmAccess
->LockState
)) {
514 return EFI_INVALID_PARAMETER
;
518 // Save current InSmm state and set InSmm state to TRUE
520 OldInSmm
= gSmmCorePrivate
->InSmm
;
521 gSmmCorePrivate
->InSmm
= TRUE
;
524 // Before SetVirtualAddressMap(), we are in SMM or SMRAM is open and unlocked, call SmiManage() directly.
526 CommunicateHeader
= (EFI_SMM_COMMUNICATE_HEADER
*)CommBuffer
;
527 *CommSize
-= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
528 Status
= gSmmCorePrivate
->Smst
->SmiManage (
529 &CommunicateHeader
->HeaderGuid
,
531 CommunicateHeader
->Data
,
536 // Update CommunicationBuffer, BufferSize and ReturnStatus
537 // Communicate service finished, reset the pointer to CommBuffer to NULL
539 *CommSize
+= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
542 // Restore original InSmm state
544 gSmmCorePrivate
->InSmm
= OldInSmm
;
546 return (Status
== EFI_SUCCESS
) ? EFI_SUCCESS
: EFI_NOT_FOUND
;
550 Event notification that is fired when GUIDed Event Group is signaled.
552 @param Event The Event that is being processed, not used.
553 @param Context Event Context, not used.
558 SmmIplGuidedEventNotify (
566 // Use Guid to initialize EFI_SMM_COMMUNICATE_HEADER structure
568 CopyGuid (&mCommunicateHeader
.HeaderGuid
, (EFI_GUID
*)Context
);
569 mCommunicateHeader
.MessageLength
= 1;
570 mCommunicateHeader
.Data
[0] = 0;
573 // Generate the Software SMI and return the result
575 Size
= sizeof (mCommunicateHeader
);
576 SmmCommunicationCommunicate (&mSmmCommunication
, &mCommunicateHeader
, &Size
);
580 Event notification that is fired when EndOfDxe Event Group is signaled.
582 @param Event The Event that is being processed, not used.
583 @param Context Event Context, not used.
588 SmmIplEndOfDxeEventNotify (
597 Event notification that is fired when DxeDispatch Event Group is signaled.
599 @param Event The Event that is being processed, not used.
600 @param Context Event Context, not used.
605 SmmIplDxeDispatchEventNotify (
614 // Keep calling the SMM Core Dispatcher until there is no request to restart it.
618 // Use Guid to initialize EFI_SMM_COMMUNICATE_HEADER structure
619 // Clear the buffer passed into the Software SMI. This buffer will return
620 // the status of the SMM Core Dispatcher.
622 CopyGuid (&mCommunicateHeader
.HeaderGuid
, (EFI_GUID
*)Context
);
623 mCommunicateHeader
.MessageLength
= 1;
624 mCommunicateHeader
.Data
[0] = 0;
627 // Generate the Software SMI and return the result
629 Size
= sizeof (mCommunicateHeader
);
630 SmmCommunicationCommunicate (&mSmmCommunication
, &mCommunicateHeader
, &Size
);
633 // Return if there is no request to restart the SMM Core Dispatcher
635 if (mCommunicateHeader
.Data
[0] != COMM_BUFFER_SMM_DISPATCH_RESTART
) {
640 // Attempt to reset SMRAM cacheability to UC
641 // Assume CPU AP is available at this time
643 Status
= gDS
->SetMemorySpaceAttributes(
648 if (EFI_ERROR (Status
)) {
649 DEBUG ((DEBUG_WARN
, "SMM IPL failed to reset SMRAM window to EFI_MEMORY_UC\n"));
653 // Close all SMRAM ranges to protect SMRAM
655 Status
= mSmmAccess
->Close (mSmmAccess
);
656 ASSERT_EFI_ERROR (Status
);
659 // Print debug message that the SMRAM window is now closed.
661 DEBUG ((DEBUG_INFO
, "SMM IPL closed SMRAM window\n"));
666 Event notification that is fired every time a gEfiSmmConfigurationProtocol installs.
668 @param Event The Event that is being processed, not used.
669 @param Context Event Context, not used.
674 SmmIplSmmConfigurationEventNotify (
680 EFI_SMM_CONFIGURATION_PROTOCOL
*SmmConfiguration
;
683 // Make sure this notification is for this handler
685 Status
= gBS
->LocateProtocol (Context
, NULL
, (VOID
**)&SmmConfiguration
);
686 if (EFI_ERROR (Status
)) {
691 // Register the SMM Entry Point provided by the SMM Core with the SMM COnfiguration protocol
693 Status
= SmmConfiguration
->RegisterSmmEntry (SmmConfiguration
, gSmmCorePrivate
->SmmEntryPoint
);
694 ASSERT_EFI_ERROR (Status
);
697 // Set flag to indicate that the SMM Entry Point has been registered which
698 // means that SMIs are now fully operational.
700 gSmmCorePrivate
->SmmEntryPointRegistered
= TRUE
;
703 // Print debug message showing SMM Core entry point address.
705 DEBUG ((DEBUG_INFO
, "SMM IPL registered SMM Entry Point address %p\n", (VOID
*)(UINTN
)gSmmCorePrivate
->SmmEntryPoint
));
709 Event notification that is fired every time a DxeSmmReadyToLock protocol is added
710 or if gEfiEventReadyToBootGuid is signaled.
712 @param Event The Event that is being processed, not used.
713 @param Context Event Context, not used.
718 SmmIplReadyToLockEventNotify (
728 // See if we are already locked
735 // Make sure this notification is for this handler
737 if (CompareGuid ((EFI_GUID
*)Context
, &gEfiDxeSmmReadyToLockProtocolGuid
)) {
738 Status
= gBS
->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid
, NULL
, &Interface
);
739 if (EFI_ERROR (Status
)) {
744 // If SMM is not locked yet and we got here from gEfiEventReadyToBootGuid being
745 // signaled, then gEfiDxeSmmReadyToLockProtocolGuid was not installed as expected.
746 // Print a warning on debug builds.
748 DEBUG ((DEBUG_WARN
, "SMM IPL! DXE SMM Ready To Lock Protocol not installed before Ready To Boot signal\n"));
752 DEBUG ((DEBUG_ERROR
, "EndOfDxe Event must be signaled before DxeSmmReadyToLock Protocol installation!\n"));
754 EFI_ERROR_CODE
| EFI_ERROR_UNRECOVERED
,
755 (EFI_SOFTWARE_SMM_DRIVER
| EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
)
761 // Lock the SMRAM (Note: Locking SMRAM may not be supported on all platforms)
763 mSmmAccess
->Lock (mSmmAccess
);
766 // Close protocol and event notification events that do not apply after the
767 // DXE SMM Ready To Lock Protocol has been installed or the Ready To Boot
768 // event has been signalled.
770 for (Index
= 0; mSmmIplEvents
[Index
].NotifyFunction
!= NULL
; Index
++) {
771 if (mSmmIplEvents
[Index
].CloseOnLock
) {
772 gBS
->CloseEvent (mSmmIplEvents
[Index
].Event
);
777 // Inform SMM Core that the DxeSmmReadyToLock protocol was installed
779 SmmIplGuidedEventNotify (Event
, (VOID
*)&gEfiDxeSmmReadyToLockProtocolGuid
);
782 // Print debug message that the SMRAM window is now locked.
784 DEBUG ((DEBUG_INFO
, "SMM IPL locked SMRAM window\n"));
787 // Set flag so this operation will not be performed again
793 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
795 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
796 It convers pointer to new virtual address.
798 @param Event Event whose notification function is being invoked.
799 @param Context Pointer to the notification function's context.
804 SmmIplSetVirtualAddressNotify (
809 EfiConvertPointer (0x0, (VOID
**)&mSmmControl2
);
813 Get the fixed loading address from image header assigned by build tool. This function only be called
814 when Loading module at Fixed address feature enabled.
816 @param ImageContext Pointer to the image context structure that describes the PE/COFF
817 image that needs to be examined by this function.
818 @retval EFI_SUCCESS An fixed loading address is assigned to this image by build tools .
819 @retval EFI_NOT_FOUND The image has no assigned fixed loading address.
822 GetPeCoffImageFixLoadingAssignedAddress(
823 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
826 UINTN SectionHeaderOffset
;
828 EFI_IMAGE_SECTION_HEADER SectionHeader
;
829 EFI_IMAGE_OPTIONAL_HEADER_UNION
*ImgHdr
;
830 EFI_PHYSICAL_ADDRESS FixLoadingAddress
;
833 UINT16 NumberOfSections
;
834 EFI_PHYSICAL_ADDRESS SmramBase
;
836 UINT64 ValueInSectionHeader
;
838 // Build tool will calculate the smm code size and then patch the PcdLoadFixAddressSmmCodePageNumber
840 SmmCodeSize
= EFI_PAGES_TO_SIZE (PcdGet32(PcdLoadFixAddressSmmCodePageNumber
));
842 FixLoadingAddress
= 0;
843 Status
= EFI_NOT_FOUND
;
844 SmramBase
= mCurrentSmramRange
->CpuStart
;
846 // Get PeHeader pointer
848 ImgHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)((CHAR8
* )ImageContext
->Handle
+ ImageContext
->PeCoffHeaderOffset
);
849 SectionHeaderOffset
= ImageContext
->PeCoffHeaderOffset
+
851 sizeof (EFI_IMAGE_FILE_HEADER
) +
852 ImgHdr
->Pe32
.FileHeader
.SizeOfOptionalHeader
;
853 NumberOfSections
= ImgHdr
->Pe32
.FileHeader
.NumberOfSections
;
856 // Get base address from the first section header that doesn't point to code section.
858 for (Index
= 0; Index
< NumberOfSections
; Index
++) {
860 // Read section header from file
862 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
863 Status
= ImageContext
->ImageRead (
864 ImageContext
->Handle
,
869 if (EFI_ERROR (Status
)) {
873 Status
= EFI_NOT_FOUND
;
875 if ((SectionHeader
.Characteristics
& EFI_IMAGE_SCN_CNT_CODE
) == 0) {
877 // Build tool saves the offset to SMRAM base as image base in PointerToRelocations & PointerToLineNumbers fields in the
878 // first section header that doesn't point to code section in image header. And there is an assumption that when the
879 // feature is enabled, if a module is assigned a loading address by tools, PointerToRelocations & PointerToLineNumbers
880 // fields should NOT be Zero, or else, these 2 fields should be set to Zero
882 ValueInSectionHeader
= ReadUnaligned64((UINT64
*)&SectionHeader
.PointerToRelocations
);
883 if (ValueInSectionHeader
!= 0) {
885 // Found first section header that doesn't point to code section in which build tool saves the
886 // offset to SMRAM base as image base in PointerToRelocations & PointerToLineNumbers fields
888 FixLoadingAddress
= (EFI_PHYSICAL_ADDRESS
)(SmramBase
+ (INT64
)ValueInSectionHeader
);
890 if (SmramBase
+ SmmCodeSize
> FixLoadingAddress
&& SmramBase
<= FixLoadingAddress
) {
892 // The assigned address is valid. Return the specified loading address
894 ImageContext
->ImageAddress
= FixLoadingAddress
;
895 Status
= EFI_SUCCESS
;
900 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
902 DEBUG ((EFI_D_INFO
|EFI_D_LOAD
, "LOADING MODULE FIXED INFO: Loading module at fixed address %x, Status = %r \n", FixLoadingAddress
, Status
));
906 Load the SMM Core image into SMRAM and executes the SMM Core from SMRAM.
908 @param[in, out] SmramRange Descriptor for the range of SMRAM to reload the
909 currently executing image, the rang of SMRAM to
910 hold SMM Core will be excluded.
911 @param[in, out] SmramRangeSmmCore Descriptor for the range of SMRAM to hold SMM Core.
913 @param[in] Context Context to pass into SMM Core
919 ExecuteSmmCoreFromSmram (
920 IN OUT EFI_SMRAM_DESCRIPTOR
*SmramRange
,
921 IN OUT EFI_SMRAM_DESCRIPTOR
*SmramRangeSmmCore
,
928 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
930 EFI_IMAGE_ENTRY_POINT EntryPoint
;
933 // Search all Firmware Volumes for a PE/COFF image in a file of type SMM_CORE
935 Status
= GetSectionFromAnyFvByFileType (
936 EFI_FV_FILETYPE_SMM_CORE
,
943 if (EFI_ERROR (Status
)) {
948 // Initilize ImageContext
950 ImageContext
.Handle
= SourceBuffer
;
951 ImageContext
.ImageRead
= PeCoffLoaderImageReadFromMemory
;
954 // Get information about the image being loaded
956 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
957 if (EFI_ERROR (Status
)) {
961 // if Loading module at Fixed Address feature is enabled, the SMM core driver will be loaded to
962 // the address assigned by build tool.
964 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
966 // Get the fixed loading address assigned by Build tool
968 Status
= GetPeCoffImageFixLoadingAssignedAddress (&ImageContext
);
969 if (!EFI_ERROR (Status
)) {
971 // Since the memory range to load SMM CORE will be cut out in SMM core, so no need to allocate and free this range
975 // Reserved Smram Region for SmmCore is not used, and remove it from SmramRangeCount.
977 gSmmCorePrivate
->SmramRangeCount
--;
979 DEBUG ((EFI_D_INFO
, "LOADING MODULE FIXED ERROR: Loading module at fixed address at address failed\n"));
981 // Allocate memory for the image being loaded from the EFI_SRAM_DESCRIPTOR
982 // specified by SmramRange
984 PageCount
= (UINTN
)EFI_SIZE_TO_PAGES((UINTN
)ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
986 ASSERT ((SmramRange
->PhysicalSize
& EFI_PAGE_MASK
) == 0);
987 ASSERT (SmramRange
->PhysicalSize
> EFI_PAGES_TO_SIZE (PageCount
));
989 SmramRange
->PhysicalSize
-= EFI_PAGES_TO_SIZE (PageCount
);
990 SmramRangeSmmCore
->CpuStart
= SmramRange
->CpuStart
+ SmramRange
->PhysicalSize
;
991 SmramRangeSmmCore
->PhysicalStart
= SmramRange
->PhysicalStart
+ SmramRange
->PhysicalSize
;
992 SmramRangeSmmCore
->RegionState
= SmramRange
->RegionState
| EFI_ALLOCATED
;
993 SmramRangeSmmCore
->PhysicalSize
= EFI_PAGES_TO_SIZE (PageCount
);
996 // Align buffer on section boundary
998 ImageContext
.ImageAddress
= SmramRangeSmmCore
->CpuStart
;
1002 // Allocate memory for the image being loaded from the EFI_SRAM_DESCRIPTOR
1003 // specified by SmramRange
1005 PageCount
= (UINTN
)EFI_SIZE_TO_PAGES((UINTN
)ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
1007 ASSERT ((SmramRange
->PhysicalSize
& EFI_PAGE_MASK
) == 0);
1008 ASSERT (SmramRange
->PhysicalSize
> EFI_PAGES_TO_SIZE (PageCount
));
1010 SmramRange
->PhysicalSize
-= EFI_PAGES_TO_SIZE (PageCount
);
1011 SmramRangeSmmCore
->CpuStart
= SmramRange
->CpuStart
+ SmramRange
->PhysicalSize
;
1012 SmramRangeSmmCore
->PhysicalStart
= SmramRange
->PhysicalStart
+ SmramRange
->PhysicalSize
;
1013 SmramRangeSmmCore
->RegionState
= SmramRange
->RegionState
| EFI_ALLOCATED
;
1014 SmramRangeSmmCore
->PhysicalSize
= EFI_PAGES_TO_SIZE (PageCount
);
1017 // Align buffer on section boundary
1019 ImageContext
.ImageAddress
= SmramRangeSmmCore
->CpuStart
;
1022 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
- 1;
1023 ImageContext
.ImageAddress
&= ~((EFI_PHYSICAL_ADDRESS
)ImageContext
.SectionAlignment
- 1);
1026 // Print debug message showing SMM Core load address.
1028 DEBUG ((DEBUG_INFO
, "SMM IPL loading SMM Core at SMRAM address %p\n", (VOID
*)(UINTN
)ImageContext
.ImageAddress
));
1031 // Load the image to our new buffer
1033 Status
= PeCoffLoaderLoadImage (&ImageContext
);
1034 if (!EFI_ERROR (Status
)) {
1036 // Relocate the image in our new buffer
1038 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
1039 if (!EFI_ERROR (Status
)) {
1041 // Flush the instruction cache so the image data are written before we execute it
1043 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)ImageContext
.ImageAddress
, (UINTN
)ImageContext
.ImageSize
);
1046 // Print debug message showing SMM Core entry point address.
1048 DEBUG ((DEBUG_INFO
, "SMM IPL calling SMM Core at SMRAM address %p\n", (VOID
*)(UINTN
)ImageContext
.EntryPoint
));
1050 gSmmCorePrivate
->PiSmmCoreImageBase
= ImageContext
.ImageAddress
;
1051 gSmmCorePrivate
->PiSmmCoreImageSize
= ImageContext
.ImageSize
;
1052 DEBUG ((DEBUG_INFO
, "PiSmmCoreImageBase - 0x%016lx\n", gSmmCorePrivate
->PiSmmCoreImageBase
));
1053 DEBUG ((DEBUG_INFO
, "PiSmmCoreImageSize - 0x%016lx\n", gSmmCorePrivate
->PiSmmCoreImageSize
));
1055 gSmmCorePrivate
->PiSmmCoreEntryPoint
= ImageContext
.EntryPoint
;
1060 EntryPoint
= (EFI_IMAGE_ENTRY_POINT
)(UINTN
)ImageContext
.EntryPoint
;
1061 Status
= EntryPoint ((EFI_HANDLE
)Context
, gST
);
1066 // Always free memory allocted by GetFileBufferByFilePath ()
1068 FreePool (SourceBuffer
);
1074 SMM split SMRAM entry.
1076 @param[in, out] RangeToCompare Pointer to EFI_SMRAM_DESCRIPTOR to compare.
1077 @param[in, out] ReservedRangeToCompare Pointer to EFI_SMM_RESERVED_SMRAM_REGION to compare.
1078 @param[out] Ranges Output pointer to hold split EFI_SMRAM_DESCRIPTOR entry.
1079 @param[in, out] RangeCount Pointer to range count.
1080 @param[out] ReservedRanges Output pointer to hold split EFI_SMM_RESERVED_SMRAM_REGION entry.
1081 @param[in, out] ReservedRangeCount Pointer to reserved range count.
1082 @param[out] FinalRanges Output pointer to hold split final EFI_SMRAM_DESCRIPTOR entry
1083 that no need to be split anymore.
1084 @param[in, out] FinalRangeCount Pointer to final range count.
1088 SmmSplitSmramEntry (
1089 IN OUT EFI_SMRAM_DESCRIPTOR
*RangeToCompare
,
1090 IN OUT EFI_SMM_RESERVED_SMRAM_REGION
*ReservedRangeToCompare
,
1091 OUT EFI_SMRAM_DESCRIPTOR
*Ranges
,
1092 IN OUT UINTN
*RangeCount
,
1093 OUT EFI_SMM_RESERVED_SMRAM_REGION
*ReservedRanges
,
1094 IN OUT UINTN
*ReservedRangeCount
,
1095 OUT EFI_SMRAM_DESCRIPTOR
*FinalRanges
,
1096 IN OUT UINTN
*FinalRangeCount
1099 UINT64 RangeToCompareEnd
;
1100 UINT64 ReservedRangeToCompareEnd
;
1102 RangeToCompareEnd
= RangeToCompare
->CpuStart
+ RangeToCompare
->PhysicalSize
;
1103 ReservedRangeToCompareEnd
= ReservedRangeToCompare
->SmramReservedStart
+ ReservedRangeToCompare
->SmramReservedSize
;
1105 if ((RangeToCompare
->CpuStart
>= ReservedRangeToCompare
->SmramReservedStart
) &&
1106 (RangeToCompare
->CpuStart
< ReservedRangeToCompareEnd
)) {
1107 if (RangeToCompareEnd
< ReservedRangeToCompareEnd
) {
1109 // RangeToCompare ReservedRangeToCompare
1110 // ---- ---- --------------------------------------
1111 // | | | | -> 1. ReservedRangeToCompare
1112 // ---- | | |--| --------------------------------------
1114 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1115 // | | | | | | RangeToCompare->PhysicalSize = 0
1116 // ---- | | |--| --------------------------------------
1117 // | | | | -> 3. ReservedRanges[*ReservedRangeCount] and increment *ReservedRangeCount
1118 // ---- ---- --------------------------------------
1122 // 1. Update ReservedRangeToCompare.
1124 ReservedRangeToCompare
->SmramReservedSize
= RangeToCompare
->CpuStart
- ReservedRangeToCompare
->SmramReservedStart
;
1126 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1127 // Zero RangeToCompare->PhysicalSize.
1129 FinalRanges
[*FinalRangeCount
].CpuStart
= RangeToCompare
->CpuStart
;
1130 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
;
1131 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1132 FinalRanges
[*FinalRangeCount
].PhysicalSize
= RangeToCompare
->PhysicalSize
;
1133 *FinalRangeCount
+= 1;
1134 RangeToCompare
->PhysicalSize
= 0;
1136 // 3. Update ReservedRanges[*ReservedRangeCount] and increment *ReservedRangeCount.
1138 ReservedRanges
[*ReservedRangeCount
].SmramReservedStart
= FinalRanges
[*FinalRangeCount
- 1].CpuStart
+ FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1139 ReservedRanges
[*ReservedRangeCount
].SmramReservedSize
= ReservedRangeToCompareEnd
- RangeToCompareEnd
;
1140 *ReservedRangeCount
+= 1;
1143 // RangeToCompare ReservedRangeToCompare
1144 // ---- ---- --------------------------------------
1145 // | | | | -> 1. ReservedRangeToCompare
1146 // ---- | | |--| --------------------------------------
1148 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1150 // | | ---- |--| --------------------------------------
1151 // | | | | -> 3. RangeToCompare
1152 // ---- ---- --------------------------------------
1156 // 1. Update ReservedRangeToCompare.
1158 ReservedRangeToCompare
->SmramReservedSize
= RangeToCompare
->CpuStart
- ReservedRangeToCompare
->SmramReservedStart
;
1160 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1162 FinalRanges
[*FinalRangeCount
].CpuStart
= RangeToCompare
->CpuStart
;
1163 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
;
1164 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1165 FinalRanges
[*FinalRangeCount
].PhysicalSize
= ReservedRangeToCompareEnd
- RangeToCompare
->CpuStart
;
1166 *FinalRangeCount
+= 1;
1168 // 3. Update RangeToCompare.
1170 RangeToCompare
->CpuStart
+= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1171 RangeToCompare
->PhysicalStart
+= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1172 RangeToCompare
->PhysicalSize
-= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1174 } else if ((ReservedRangeToCompare
->SmramReservedStart
>= RangeToCompare
->CpuStart
) &&
1175 (ReservedRangeToCompare
->SmramReservedStart
< RangeToCompareEnd
)) {
1176 if (ReservedRangeToCompareEnd
< RangeToCompareEnd
) {
1178 // RangeToCompare ReservedRangeToCompare
1179 // ---- ---- --------------------------------------
1180 // | | | | -> 1. RangeToCompare
1181 // | | ---- |--| --------------------------------------
1183 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1184 // | | | | | | ReservedRangeToCompare->SmramReservedSize = 0
1185 // | | ---- |--| --------------------------------------
1186 // | | | | -> 3. Ranges[*RangeCount] and increment *RangeCount
1187 // ---- ---- --------------------------------------
1191 // 1. Update RangeToCompare.
1193 RangeToCompare
->PhysicalSize
= ReservedRangeToCompare
->SmramReservedStart
- RangeToCompare
->CpuStart
;
1195 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1196 // ReservedRangeToCompare->SmramReservedSize = 0
1198 FinalRanges
[*FinalRangeCount
].CpuStart
= ReservedRangeToCompare
->SmramReservedStart
;
1199 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
+ RangeToCompare
->PhysicalSize
;
1200 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1201 FinalRanges
[*FinalRangeCount
].PhysicalSize
= ReservedRangeToCompare
->SmramReservedSize
;
1202 *FinalRangeCount
+= 1;
1203 ReservedRangeToCompare
->SmramReservedSize
= 0;
1205 // 3. Update Ranges[*RangeCount] and increment *RangeCount.
1207 Ranges
[*RangeCount
].CpuStart
= FinalRanges
[*FinalRangeCount
- 1].CpuStart
+ FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1208 Ranges
[*RangeCount
].PhysicalStart
= FinalRanges
[*FinalRangeCount
- 1].PhysicalStart
+ FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1209 Ranges
[*RangeCount
].RegionState
= RangeToCompare
->RegionState
;
1210 Ranges
[*RangeCount
].PhysicalSize
= RangeToCompareEnd
- ReservedRangeToCompareEnd
;
1214 // RangeToCompare ReservedRangeToCompare
1215 // ---- ---- --------------------------------------
1216 // | | | | -> 1. RangeToCompare
1217 // | | ---- |--| --------------------------------------
1219 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1221 // ---- | | |--| --------------------------------------
1222 // | | | | -> 3. ReservedRangeToCompare
1223 // ---- ---- --------------------------------------
1227 // 1. Update RangeToCompare.
1229 RangeToCompare
->PhysicalSize
= ReservedRangeToCompare
->SmramReservedStart
- RangeToCompare
->CpuStart
;
1231 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1232 // ReservedRangeToCompare->SmramReservedSize = 0
1234 FinalRanges
[*FinalRangeCount
].CpuStart
= ReservedRangeToCompare
->SmramReservedStart
;
1235 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
+ RangeToCompare
->PhysicalSize
;
1236 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1237 FinalRanges
[*FinalRangeCount
].PhysicalSize
= RangeToCompareEnd
- ReservedRangeToCompare
->SmramReservedStart
;
1238 *FinalRangeCount
+= 1;
1240 // 3. Update ReservedRangeToCompare.
1242 ReservedRangeToCompare
->SmramReservedStart
+= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1243 ReservedRangeToCompare
->SmramReservedSize
-= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1249 Returns if SMRAM range and SMRAM reserved range are overlapped.
1251 @param[in] RangeToCompare Pointer to EFI_SMRAM_DESCRIPTOR to compare.
1252 @param[in] ReservedRangeToCompare Pointer to EFI_SMM_RESERVED_SMRAM_REGION to compare.
1254 @retval TRUE There is overlap.
1255 @retval FALSE There is no overlap.
1260 IN EFI_SMRAM_DESCRIPTOR
*RangeToCompare
,
1261 IN EFI_SMM_RESERVED_SMRAM_REGION
*ReservedRangeToCompare
1264 UINT64 RangeToCompareEnd
;
1265 UINT64 ReservedRangeToCompareEnd
;
1267 RangeToCompareEnd
= RangeToCompare
->CpuStart
+ RangeToCompare
->PhysicalSize
;
1268 ReservedRangeToCompareEnd
= ReservedRangeToCompare
->SmramReservedStart
+ ReservedRangeToCompare
->SmramReservedSize
;
1270 if ((RangeToCompare
->CpuStart
>= ReservedRangeToCompare
->SmramReservedStart
) &&
1271 (RangeToCompare
->CpuStart
< ReservedRangeToCompareEnd
)) {
1273 } else if ((ReservedRangeToCompare
->SmramReservedStart
>= RangeToCompare
->CpuStart
) &&
1274 (ReservedRangeToCompare
->SmramReservedStart
< RangeToCompareEnd
)) {
1281 Get full SMRAM ranges.
1283 It will get SMRAM ranges from SmmAccess protocol and SMRAM reserved ranges from
1284 SmmConfiguration protocol, split the entries if there is overlap between them.
1285 It will also reserve one entry for SMM core.
1287 @param[out] FullSmramRangeCount Output pointer to full SMRAM range count.
1289 @return Pointer to full SMRAM ranges.
1292 EFI_SMRAM_DESCRIPTOR
*
1293 GetFullSmramRanges (
1294 OUT UINTN
*FullSmramRangeCount
1298 EFI_SMM_CONFIGURATION_PROTOCOL
*SmmConfiguration
;
1302 EFI_SMRAM_DESCRIPTOR
*FullSmramRanges
;
1303 UINTN TempSmramRangeCount
;
1304 UINTN AdditionSmramRangeCount
;
1305 EFI_SMRAM_DESCRIPTOR
*TempSmramRanges
;
1306 UINTN SmramRangeCount
;
1307 EFI_SMRAM_DESCRIPTOR
*SmramRanges
;
1308 UINTN SmramReservedCount
;
1309 EFI_SMM_RESERVED_SMRAM_REGION
*SmramReservedRanges
;
1314 // Get SMM Configuration Protocol if it is present.
1316 SmmConfiguration
= NULL
;
1317 Status
= gBS
->LocateProtocol (&gEfiSmmConfigurationProtocolGuid
, NULL
, (VOID
**) &SmmConfiguration
);
1320 // Get SMRAM information.
1323 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, NULL
);
1324 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
1326 SmramRangeCount
= Size
/ sizeof (EFI_SMRAM_DESCRIPTOR
);
1329 // Get SMRAM reserved region count.
1331 SmramReservedCount
= 0;
1332 if (SmmConfiguration
!= NULL
) {
1333 while (SmmConfiguration
->SmramReservedRegions
[SmramReservedCount
].SmramReservedSize
!= 0) {
1334 SmramReservedCount
++;
1339 // Reserve one entry for SMM Core in the full SMRAM ranges.
1341 AdditionSmramRangeCount
= 1;
1342 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
1344 // Reserve two entries for all SMM drivers and SMM Core in the full SMRAM ranges.
1346 AdditionSmramRangeCount
= 2;
1349 if (SmramReservedCount
== 0) {
1351 // No reserved SMRAM entry from SMM Configuration Protocol.
1353 *FullSmramRangeCount
= SmramRangeCount
+ AdditionSmramRangeCount
;
1354 Size
= (*FullSmramRangeCount
) * sizeof (EFI_SMRAM_DESCRIPTOR
);
1355 FullSmramRanges
= (EFI_SMRAM_DESCRIPTOR
*) AllocateZeroPool (Size
);
1356 ASSERT (FullSmramRanges
!= NULL
);
1358 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, FullSmramRanges
);
1359 ASSERT_EFI_ERROR (Status
);
1361 return FullSmramRanges
;
1365 // Why MaxCount = X + 2 * Y?
1366 // Take Y = 1 as example below, Y > 1 case is just the iteration of Y = 1.
1368 // X = 1 Y = 1 MaxCount = 3 = 1 + 2 * 1
1375 // X = 2 Y = 1 MaxCount = 4 = 2 + 2 * 1
1386 // X = 3 Y = 1 MaxCount = 5 = 3 + 2 * 1
1399 MaxCount
= SmramRangeCount
+ 2 * SmramReservedCount
;
1401 Size
= MaxCount
* sizeof (EFI_SMM_RESERVED_SMRAM_REGION
);
1402 SmramReservedRanges
= (EFI_SMM_RESERVED_SMRAM_REGION
*) AllocatePool (Size
);
1403 ASSERT (SmramReservedRanges
!= NULL
);
1404 for (Index
= 0; Index
< SmramReservedCount
; Index
++) {
1405 CopyMem (&SmramReservedRanges
[Index
], &SmmConfiguration
->SmramReservedRegions
[Index
], sizeof (EFI_SMM_RESERVED_SMRAM_REGION
));
1408 Size
= MaxCount
* sizeof (EFI_SMRAM_DESCRIPTOR
);
1409 TempSmramRanges
= (EFI_SMRAM_DESCRIPTOR
*) AllocatePool (Size
);
1410 ASSERT (TempSmramRanges
!= NULL
);
1411 TempSmramRangeCount
= 0;
1413 SmramRanges
= (EFI_SMRAM_DESCRIPTOR
*) AllocatePool (Size
);
1414 ASSERT (SmramRanges
!= NULL
);
1415 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, SmramRanges
);
1416 ASSERT_EFI_ERROR (Status
);
1420 for (Index
= 0; (Index
< SmramRangeCount
) && !Rescan
; Index
++) {
1422 // Skip zero size entry.
1424 if (SmramRanges
[Index
].PhysicalSize
!= 0) {
1425 for (Index2
= 0; (Index2
< SmramReservedCount
) && !Rescan
; Index2
++) {
1427 // Skip zero size entry.
1429 if (SmramReservedRanges
[Index2
].SmramReservedSize
!= 0) {
1430 if (SmmIsSmramOverlap (
1431 &SmramRanges
[Index
],
1432 &SmramReservedRanges
[Index2
]
1435 // There is overlap, need to split entry and then rescan.
1437 SmmSplitSmramEntry (
1438 &SmramRanges
[Index
],
1439 &SmramReservedRanges
[Index2
],
1442 SmramReservedRanges
,
1443 &SmramReservedCount
,
1445 &TempSmramRangeCount
1453 // No any overlap, copy the entry to the temp SMRAM ranges.
1454 // Zero SmramRanges[Index].PhysicalSize = 0;
1456 CopyMem (&TempSmramRanges
[TempSmramRangeCount
++], &SmramRanges
[Index
], sizeof (EFI_SMRAM_DESCRIPTOR
));
1457 SmramRanges
[Index
].PhysicalSize
= 0;
1462 ASSERT (TempSmramRangeCount
<= MaxCount
);
1467 FullSmramRanges
= AllocateZeroPool ((TempSmramRangeCount
+ AdditionSmramRangeCount
) * sizeof (EFI_SMRAM_DESCRIPTOR
));
1468 ASSERT (FullSmramRanges
!= NULL
);
1469 *FullSmramRangeCount
= 0;
1471 for (Index
= 0; Index
< TempSmramRangeCount
; Index
++) {
1472 if (TempSmramRanges
[Index
].PhysicalSize
!= 0) {
1476 ASSERT (Index
< TempSmramRangeCount
);
1477 for (Index2
= 0; Index2
< TempSmramRangeCount
; Index2
++) {
1478 if ((Index2
!= Index
) && (TempSmramRanges
[Index2
].PhysicalSize
!= 0) && (TempSmramRanges
[Index2
].CpuStart
< TempSmramRanges
[Index
].CpuStart
)) {
1482 CopyMem (&FullSmramRanges
[*FullSmramRangeCount
], &TempSmramRanges
[Index
], sizeof (EFI_SMRAM_DESCRIPTOR
));
1483 *FullSmramRangeCount
+= 1;
1484 TempSmramRanges
[Index
].PhysicalSize
= 0;
1485 } while (*FullSmramRangeCount
< TempSmramRangeCount
);
1486 ASSERT (*FullSmramRangeCount
== TempSmramRangeCount
);
1487 *FullSmramRangeCount
+= AdditionSmramRangeCount
;
1489 FreePool (SmramRanges
);
1490 FreePool (SmramReservedRanges
);
1491 FreePool (TempSmramRanges
);
1493 return FullSmramRanges
;
1497 The Entry Point for SMM IPL
1499 Load SMM Core into SMRAM, register SMM Core entry point for SMIs, install
1500 SMM Base 2 Protocol and SMM Communication Protocol, and register for the
1501 critical events required to coordinate between DXE and SMM environments.
1503 @param ImageHandle The firmware allocated handle for the EFI image.
1504 @param SystemTable A pointer to the EFI System Table.
1506 @retval EFI_SUCCESS The entry point is executed successfully.
1507 @retval Other Some error occurred when executing this entry point.
1513 IN EFI_HANDLE ImageHandle
,
1514 IN EFI_SYSTEM_TABLE
*SystemTable
1522 EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE
*LMFAConfigurationTable
;
1523 EFI_CPU_ARCH_PROTOCOL
*CpuArch
;
1524 EFI_STATUS SetAttrStatus
;
1525 EFI_SMRAM_DESCRIPTOR
*SmramRangeSmmDriver
;
1528 // Fill in the image handle of the SMM IPL so the SMM Core can use this as the
1529 // ParentImageHandle field of the Load Image Protocol for all SMM Drivers loaded
1532 mSmmCorePrivateData
.SmmIplImageHandle
= ImageHandle
;
1535 // Get SMM Access Protocol
1537 Status
= gBS
->LocateProtocol (&gEfiSmmAccess2ProtocolGuid
, NULL
, (VOID
**)&mSmmAccess
);
1538 ASSERT_EFI_ERROR (Status
);
1541 // Get SMM Control2 Protocol
1543 Status
= gBS
->LocateProtocol (&gEfiSmmControl2ProtocolGuid
, NULL
, (VOID
**)&mSmmControl2
);
1544 ASSERT_EFI_ERROR (Status
);
1546 gSmmCorePrivate
->SmramRanges
= GetFullSmramRanges (&gSmmCorePrivate
->SmramRangeCount
);
1549 // Open all SMRAM ranges
1551 Status
= mSmmAccess
->Open (mSmmAccess
);
1552 ASSERT_EFI_ERROR (Status
);
1555 // Print debug message that the SMRAM window is now open.
1557 DEBUG ((DEBUG_INFO
, "SMM IPL opened SMRAM window\n"));
1560 // Find the largest SMRAM range between 1MB and 4GB that is at least 256KB - 4K in size
1562 mCurrentSmramRange
= NULL
;
1563 for (Index
= 0, MaxSize
= SIZE_256KB
- EFI_PAGE_SIZE
; Index
< gSmmCorePrivate
->SmramRangeCount
; Index
++) {
1565 // Skip any SMRAM region that is already allocated, needs testing, or needs ECC initialization
1567 if ((gSmmCorePrivate
->SmramRanges
[Index
].RegionState
& (EFI_ALLOCATED
| EFI_NEEDS_TESTING
| EFI_NEEDS_ECC_INITIALIZATION
)) != 0) {
1571 if (gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
>= BASE_1MB
) {
1572 if ((gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
+ gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
- 1) <= MAX_ADDRESS
) {
1573 if (gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
>= MaxSize
) {
1574 MaxSize
= gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
;
1575 mCurrentSmramRange
= &gSmmCorePrivate
->SmramRanges
[Index
];
1581 if (mCurrentSmramRange
!= NULL
) {
1583 // Print debug message showing SMRAM window that will be used by SMM IPL and SMM Core
1585 DEBUG ((DEBUG_INFO
, "SMM IPL found SMRAM window %p - %p\n",
1586 (VOID
*)(UINTN
)mCurrentSmramRange
->CpuStart
,
1587 (VOID
*)(UINTN
)(mCurrentSmramRange
->CpuStart
+ mCurrentSmramRange
->PhysicalSize
- 1)
1590 GetSmramCacheRange (mCurrentSmramRange
, &mSmramCacheBase
, &mSmramCacheSize
);
1592 // If CPU AP is present, attempt to set SMRAM cacheability to WB
1593 // Note that it is expected that cacheability of SMRAM has been set to WB if CPU AP
1594 // is not available here.
1597 Status
= gBS
->LocateProtocol (&gEfiCpuArchProtocolGuid
, NULL
, (VOID
**)&CpuArch
);
1598 if (!EFI_ERROR (Status
)) {
1599 Status
= gDS
->SetMemorySpaceAttributes(
1604 if (EFI_ERROR (Status
)) {
1605 DEBUG ((DEBUG_WARN
, "SMM IPL failed to set SMRAM window to EFI_MEMORY_WB\n"));
1609 // if Loading module at Fixed Address feature is enabled, save the SMRAM base to Load
1610 // Modules At Fixed Address Configuration Table.
1612 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
1614 // Build tool will calculate the smm code size and then patch the PcdLoadFixAddressSmmCodePageNumber
1616 SmmCodeSize
= LShiftU64 (PcdGet32(PcdLoadFixAddressSmmCodePageNumber
), EFI_PAGE_SHIFT
);
1618 // The SMRAM available memory is assumed to be larger than SmmCodeSize
1620 ASSERT (mCurrentSmramRange
->PhysicalSize
> SmmCodeSize
);
1622 // Retrieve Load modules At fixed address configuration table and save the SMRAM base.
1624 Status
= EfiGetSystemConfigurationTable (
1625 &gLoadFixedAddressConfigurationTableGuid
,
1626 (VOID
**) &LMFAConfigurationTable
1628 if (!EFI_ERROR (Status
) && LMFAConfigurationTable
!= NULL
) {
1629 LMFAConfigurationTable
->SmramBase
= mCurrentSmramRange
->CpuStart
;
1631 // Print the SMRAM base
1633 DEBUG ((EFI_D_INFO
, "LOADING MODULE FIXED INFO: TSEG BASE is %x. \n", LMFAConfigurationTable
->SmramBase
));
1637 // Fill the Smram range for all SMM code
1639 SmramRangeSmmDriver
= &gSmmCorePrivate
->SmramRanges
[gSmmCorePrivate
->SmramRangeCount
- 2];
1640 SmramRangeSmmDriver
->CpuStart
= mCurrentSmramRange
->CpuStart
;
1641 SmramRangeSmmDriver
->PhysicalStart
= mCurrentSmramRange
->PhysicalStart
;
1642 SmramRangeSmmDriver
->RegionState
= mCurrentSmramRange
->RegionState
| EFI_ALLOCATED
;
1643 SmramRangeSmmDriver
->PhysicalSize
= SmmCodeSize
;
1645 mCurrentSmramRange
->PhysicalSize
-= SmmCodeSize
;
1646 mCurrentSmramRange
->CpuStart
= mCurrentSmramRange
->CpuStart
+ SmmCodeSize
;
1647 mCurrentSmramRange
->PhysicalStart
= mCurrentSmramRange
->PhysicalStart
+ SmmCodeSize
;
1650 // Load SMM Core into SMRAM and execute it from SMRAM
1652 Status
= ExecuteSmmCoreFromSmram (
1654 &gSmmCorePrivate
->SmramRanges
[gSmmCorePrivate
->SmramRangeCount
- 1],
1657 if (EFI_ERROR (Status
)) {
1659 // Print error message that the SMM Core failed to be loaded and executed.
1661 DEBUG ((DEBUG_ERROR
, "SMM IPL could not load and execute SMM Core from SMRAM\n"));
1664 // Attempt to reset SMRAM cacheability to UC
1666 if (CpuArch
!= NULL
) {
1667 SetAttrStatus
= gDS
->SetMemorySpaceAttributes(
1672 if (EFI_ERROR (SetAttrStatus
)) {
1673 DEBUG ((DEBUG_WARN
, "SMM IPL failed to reset SMRAM window to EFI_MEMORY_UC\n"));
1679 // Print error message that there are not enough SMRAM resources to load the SMM Core.
1681 DEBUG ((DEBUG_ERROR
, "SMM IPL could not find a large enough SMRAM region to load SMM Core\n"));
1685 // If the SMM Core could not be loaded then close SMRAM window, free allocated
1686 // resources, and return an error so SMM IPL will be unloaded.
1688 if (mCurrentSmramRange
== NULL
|| EFI_ERROR (Status
)) {
1690 // Close all SMRAM ranges
1692 Status
= mSmmAccess
->Close (mSmmAccess
);
1693 ASSERT_EFI_ERROR (Status
);
1696 // Print debug message that the SMRAM window is now closed.
1698 DEBUG ((DEBUG_INFO
, "SMM IPL closed SMRAM window\n"));
1701 // Free all allocated resources
1703 FreePool (gSmmCorePrivate
->SmramRanges
);
1705 return EFI_UNSUPPORTED
;
1709 // Install SMM Base2 Protocol and SMM Communication Protocol
1711 Status
= gBS
->InstallMultipleProtocolInterfaces (
1713 &gEfiSmmBase2ProtocolGuid
, &mSmmBase2
,
1714 &gEfiSmmCommunicationProtocolGuid
, &mSmmCommunication
,
1717 ASSERT_EFI_ERROR (Status
);
1720 // Create the set of protocol and event notififcations that the SMM IPL requires
1722 for (Index
= 0; mSmmIplEvents
[Index
].NotifyFunction
!= NULL
; Index
++) {
1723 if (mSmmIplEvents
[Index
].Protocol
) {
1724 mSmmIplEvents
[Index
].Event
= EfiCreateProtocolNotifyEvent (
1725 mSmmIplEvents
[Index
].Guid
,
1726 mSmmIplEvents
[Index
].NotifyTpl
,
1727 mSmmIplEvents
[Index
].NotifyFunction
,
1728 mSmmIplEvents
[Index
].NotifyContext
,
1732 Status
= gBS
->CreateEventEx (
1734 mSmmIplEvents
[Index
].NotifyTpl
,
1735 mSmmIplEvents
[Index
].NotifyFunction
,
1736 mSmmIplEvents
[Index
].NotifyContext
,
1737 mSmmIplEvents
[Index
].Guid
,
1738 &mSmmIplEvents
[Index
].Event
1740 ASSERT_EFI_ERROR (Status
);