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
;
266 EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE
*mLMFAConfigurationTable
= NULL
;
269 // Table of Protocol notification and GUIDed Event notifications that the SMM IPL requires
271 SMM_IPL_EVENT_NOTIFICATION mSmmIplEvents
[] = {
273 // Declare protocol notification on the SMM Configuration protocol. When this notification is established,
274 // the associated event is immediately signalled, so the notification function will be executed and the
275 // SMM Configuration Protocol will be found if it is already in the handle database.
277 { TRUE
, FALSE
, &gEfiSmmConfigurationProtocolGuid
, SmmIplSmmConfigurationEventNotify
, &gEfiSmmConfigurationProtocolGuid
, TPL_NOTIFY
, NULL
},
279 // Declare protocol notification on DxeSmmReadyToLock protocols. When this notification is established,
280 // the associated event is immediately signalled, so the notification function will be executed and the
281 // DXE SMM Ready To Lock Protocol will be found if it is already in the handle database.
283 { TRUE
, TRUE
, &gEfiDxeSmmReadyToLockProtocolGuid
, SmmIplReadyToLockEventNotify
, &gEfiDxeSmmReadyToLockProtocolGuid
, TPL_CALLBACK
, NULL
},
285 // Declare event notification on EndOfDxe event. When this notification is established,
286 // the associated event is immediately signalled, so the notification function will be executed and the
287 // SMM End Of Dxe Protocol will be found if it is already in the handle database.
289 { FALSE
, TRUE
, &gEfiEndOfDxeEventGroupGuid
, SmmIplGuidedEventNotify
, &gEfiEndOfDxeEventGroupGuid
, TPL_CALLBACK
, NULL
},
291 // Declare event notification on EndOfDxe event. This is used to set EndOfDxe event signaled flag.
293 { FALSE
, TRUE
, &gEfiEndOfDxeEventGroupGuid
, SmmIplEndOfDxeEventNotify
, &gEfiEndOfDxeEventGroupGuid
, TPL_CALLBACK
, NULL
},
295 // Declare event notification on the DXE Dispatch Event Group. This event is signaled by the DXE Core
296 // each time the DXE Core dispatcher has completed its work. When this event is signalled, the SMM Core
297 // if notified, so the SMM Core can dispatch SMM drivers.
299 { FALSE
, TRUE
, &gEfiEventDxeDispatchGuid
, SmmIplDxeDispatchEventNotify
, &gEfiEventDxeDispatchGuid
, TPL_CALLBACK
, NULL
},
301 // Declare event notification on Ready To Boot Event Group. This is an extra event notification that is
302 // used to make sure SMRAM is locked before any boot options are processed.
304 { FALSE
, TRUE
, &gEfiEventReadyToBootGuid
, SmmIplReadyToLockEventNotify
, &gEfiEventReadyToBootGuid
, TPL_CALLBACK
, NULL
},
306 // Declare event notification on Legacy Boot Event Group. This is used to inform the SMM Core that the platform
307 // is performing a legacy boot operation, and that the UEFI environment is no longer available and the SMM Core
308 // must guarantee that it does not access any UEFI related structures outside of SMRAM.
309 // It is also to inform the SMM Core to notify SMM driver that system enter legacy boot.
311 { FALSE
, FALSE
, &gEfiEventLegacyBootGuid
, SmmIplGuidedEventNotify
, &gEfiEventLegacyBootGuid
, TPL_CALLBACK
, NULL
},
313 // Declare event notification on Exit Boot Services Event Group. This is used to inform the SMM Core
314 // to notify SMM driver that system enter exit boot services.
316 { FALSE
, FALSE
, &gEfiEventExitBootServicesGuid
, SmmIplGuidedEventNotify
, &gEfiEventExitBootServicesGuid
, TPL_CALLBACK
, NULL
},
318 // Declare event notification on Ready To Boot Event Group. This is used to inform the SMM Core
319 // to notify SMM driver that system enter ready to boot.
321 { FALSE
, FALSE
, &gEfiEventReadyToBootGuid
, SmmIplGuidedEventNotify
, &gEfiEventReadyToBootGuid
, TPL_CALLBACK
, NULL
},
323 // Declare event notification on SetVirtualAddressMap() Event Group. This is used to convert gSmmCorePrivate
324 // and mSmmControl2 from physical addresses to virtual addresses.
326 { FALSE
, FALSE
, &gEfiEventVirtualAddressChangeGuid
, SmmIplSetVirtualAddressNotify
, NULL
, TPL_CALLBACK
, NULL
},
328 // Terminate the table of event notifications
330 { FALSE
, FALSE
, NULL
, NULL
, NULL
, TPL_CALLBACK
, NULL
}
334 Find the maximum SMRAM cache range that covers the range specified by SmramRange.
336 This function searches and joins all adjacent ranges of SmramRange into a range to be cached.
338 @param SmramRange The SMRAM range to search from.
339 @param SmramCacheBase The returned cache range base.
340 @param SmramCacheSize The returned cache range size.
345 IN EFI_SMRAM_DESCRIPTOR
*SmramRange
,
346 OUT EFI_PHYSICAL_ADDRESS
*SmramCacheBase
,
347 OUT UINT64
*SmramCacheSize
351 EFI_PHYSICAL_ADDRESS RangeCpuStart
;
352 UINT64 RangePhysicalSize
;
353 BOOLEAN FoundAjacentRange
;
355 *SmramCacheBase
= SmramRange
->CpuStart
;
356 *SmramCacheSize
= SmramRange
->PhysicalSize
;
359 FoundAjacentRange
= FALSE
;
360 for (Index
= 0; Index
< gSmmCorePrivate
->SmramRangeCount
; Index
++) {
361 RangeCpuStart
= gSmmCorePrivate
->SmramRanges
[Index
].CpuStart
;
362 RangePhysicalSize
= gSmmCorePrivate
->SmramRanges
[Index
].PhysicalSize
;
363 if (RangeCpuStart
< *SmramCacheBase
&& *SmramCacheBase
== (RangeCpuStart
+ RangePhysicalSize
)) {
364 *SmramCacheBase
= RangeCpuStart
;
365 *SmramCacheSize
+= RangePhysicalSize
;
366 FoundAjacentRange
= TRUE
;
367 } else if ((*SmramCacheBase
+ *SmramCacheSize
) == RangeCpuStart
&& RangePhysicalSize
> 0) {
368 *SmramCacheSize
+= RangePhysicalSize
;
369 FoundAjacentRange
= TRUE
;
372 } while (FoundAjacentRange
);
377 Indicate whether the driver is currently executing in the SMM Initialization phase.
379 @param This The EFI_SMM_BASE2_PROTOCOL instance.
380 @param InSmram Pointer to a Boolean which, on return, indicates that the driver is currently executing
381 inside of SMRAM (TRUE) or outside of SMRAM (FALSE).
383 @retval EFI_INVALID_PARAMETER InSmram was NULL.
384 @retval EFI_SUCCESS The call returned successfully.
390 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
394 if (InSmram
== NULL
) {
395 return EFI_INVALID_PARAMETER
;
398 *InSmram
= gSmmCorePrivate
->InSmm
;
404 Retrieves the location of the System Management System Table (SMST).
406 @param This The EFI_SMM_BASE2_PROTOCOL instance.
407 @param Smst On return, points to a pointer to the System Management Service Table (SMST).
409 @retval EFI_INVALID_PARAMETER Smst or This was invalid.
410 @retval EFI_SUCCESS The memory was returned to the system.
411 @retval EFI_UNSUPPORTED Not in SMM.
416 SmmBase2GetSmstLocation (
417 IN CONST EFI_SMM_BASE2_PROTOCOL
*This
,
418 OUT EFI_SMM_SYSTEM_TABLE2
**Smst
421 if ((This
== NULL
) ||(Smst
== NULL
)) {
422 return EFI_INVALID_PARAMETER
;
425 if (!gSmmCorePrivate
->InSmm
) {
426 return EFI_UNSUPPORTED
;
429 *Smst
= gSmmCorePrivate
->Smst
;
435 Communicates with a registered handler.
437 This function provides a service to send and receive messages from a registered
438 UEFI service. This function is part of the SMM Communication Protocol that may
439 be called in physical mode prior to SetVirtualAddressMap() and in virtual mode
440 after SetVirtualAddressMap().
442 @param[in] This The EFI_SMM_COMMUNICATION_PROTOCOL instance.
443 @param[in, out] CommBuffer A pointer to the buffer to convey into SMRAM.
444 @param[in, out] CommSize The size of the data buffer being passed in.On exit, the size of data
445 being returned. Zero if the handler does not wish to reply with any data.
447 @retval EFI_SUCCESS The message was successfully posted.
448 @retval EFI_INVALID_PARAMETER The CommBuffer was NULL.
452 SmmCommunicationCommunicate (
453 IN CONST EFI_SMM_COMMUNICATION_PROTOCOL
*This
,
454 IN OUT VOID
*CommBuffer
,
455 IN OUT UINTN
*CommSize
459 EFI_SMM_COMMUNICATE_HEADER
*CommunicateHeader
;
465 if ((CommBuffer
== NULL
) || (CommSize
== NULL
)) {
466 return EFI_INVALID_PARAMETER
;
470 // CommSize must hold HeaderGuid and MessageLength
472 if (*CommSize
< OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
)) {
473 return EFI_INVALID_PARAMETER
;
477 // If not already in SMM, then generate a Software SMI
479 if (!gSmmCorePrivate
->InSmm
&& gSmmCorePrivate
->SmmEntryPointRegistered
) {
481 // Put arguments for Software SMI in gSmmCorePrivate
483 gSmmCorePrivate
->CommunicationBuffer
= CommBuffer
;
484 gSmmCorePrivate
->BufferSize
= *CommSize
;
487 // Generate Software SMI
489 Status
= mSmmControl2
->Trigger (mSmmControl2
, NULL
, NULL
, FALSE
, 0);
490 if (EFI_ERROR (Status
)) {
491 return EFI_UNSUPPORTED
;
495 // Return status from software SMI
497 *CommSize
= gSmmCorePrivate
->BufferSize
;
498 return gSmmCorePrivate
->ReturnStatus
;
502 // If we are in SMM, then the execution mode must be physical, which means that
503 // OS established virtual addresses can not be used. If SetVirtualAddressMap()
504 // has been called, then a direct invocation of the Software SMI is not
505 // not allowed so return EFI_INVALID_PARAMETER.
507 if (EfiGoneVirtual()) {
508 return EFI_INVALID_PARAMETER
;
512 // If we are not in SMM, don't allow call SmiManage() directly when SMRAM is closed or locked.
514 if ((!gSmmCorePrivate
->InSmm
) && (!mSmmAccess
->OpenState
|| mSmmAccess
->LockState
)) {
515 return EFI_INVALID_PARAMETER
;
519 // Save current InSmm state and set InSmm state to TRUE
521 OldInSmm
= gSmmCorePrivate
->InSmm
;
522 gSmmCorePrivate
->InSmm
= TRUE
;
525 // Before SetVirtualAddressMap(), we are in SMM or SMRAM is open and unlocked, call SmiManage() directly.
527 CommunicateHeader
= (EFI_SMM_COMMUNICATE_HEADER
*)CommBuffer
;
528 *CommSize
-= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
529 Status
= gSmmCorePrivate
->Smst
->SmiManage (
530 &CommunicateHeader
->HeaderGuid
,
532 CommunicateHeader
->Data
,
537 // Update CommunicationBuffer, BufferSize and ReturnStatus
538 // Communicate service finished, reset the pointer to CommBuffer to NULL
540 *CommSize
+= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
543 // Restore original InSmm state
545 gSmmCorePrivate
->InSmm
= OldInSmm
;
547 return (Status
== EFI_SUCCESS
) ? EFI_SUCCESS
: EFI_NOT_FOUND
;
551 Event notification that is fired when GUIDed Event Group is signaled.
553 @param Event The Event that is being processed, not used.
554 @param Context Event Context, not used.
559 SmmIplGuidedEventNotify (
567 // Use Guid to initialize EFI_SMM_COMMUNICATE_HEADER structure
569 CopyGuid (&mCommunicateHeader
.HeaderGuid
, (EFI_GUID
*)Context
);
570 mCommunicateHeader
.MessageLength
= 1;
571 mCommunicateHeader
.Data
[0] = 0;
574 // Generate the Software SMI and return the result
576 Size
= sizeof (mCommunicateHeader
);
577 SmmCommunicationCommunicate (&mSmmCommunication
, &mCommunicateHeader
, &Size
);
581 Event notification that is fired when EndOfDxe Event Group is signaled.
583 @param Event The Event that is being processed, not used.
584 @param Context Event Context, not used.
589 SmmIplEndOfDxeEventNotify (
598 Event notification that is fired when DxeDispatch Event Group is signaled.
600 @param Event The Event that is being processed, not used.
601 @param Context Event Context, not used.
606 SmmIplDxeDispatchEventNotify (
615 // Keep calling the SMM Core Dispatcher until there is no request to restart it.
619 // Use Guid to initialize EFI_SMM_COMMUNICATE_HEADER structure
620 // Clear the buffer passed into the Software SMI. This buffer will return
621 // the status of the SMM Core Dispatcher.
623 CopyGuid (&mCommunicateHeader
.HeaderGuid
, (EFI_GUID
*)Context
);
624 mCommunicateHeader
.MessageLength
= 1;
625 mCommunicateHeader
.Data
[0] = 0;
628 // Generate the Software SMI and return the result
630 Size
= sizeof (mCommunicateHeader
);
631 SmmCommunicationCommunicate (&mSmmCommunication
, &mCommunicateHeader
, &Size
);
634 // Return if there is no request to restart the SMM Core Dispatcher
636 if (mCommunicateHeader
.Data
[0] != COMM_BUFFER_SMM_DISPATCH_RESTART
) {
641 // Attempt to reset SMRAM cacheability to UC
642 // Assume CPU AP is available at this time
644 Status
= gDS
->SetMemorySpaceAttributes(
649 if (EFI_ERROR (Status
)) {
650 DEBUG ((DEBUG_WARN
, "SMM IPL failed to reset SMRAM window to EFI_MEMORY_UC\n"));
654 // Close all SMRAM ranges to protect SMRAM
656 Status
= mSmmAccess
->Close (mSmmAccess
);
657 ASSERT_EFI_ERROR (Status
);
660 // Print debug message that the SMRAM window is now closed.
662 DEBUG ((DEBUG_INFO
, "SMM IPL closed SMRAM window\n"));
667 Event notification that is fired every time a gEfiSmmConfigurationProtocol installs.
669 @param Event The Event that is being processed, not used.
670 @param Context Event Context, not used.
675 SmmIplSmmConfigurationEventNotify (
681 EFI_SMM_CONFIGURATION_PROTOCOL
*SmmConfiguration
;
684 // Make sure this notification is for this handler
686 Status
= gBS
->LocateProtocol (Context
, NULL
, (VOID
**)&SmmConfiguration
);
687 if (EFI_ERROR (Status
)) {
692 // Register the SMM Entry Point provided by the SMM Core with the SMM COnfiguration protocol
694 Status
= SmmConfiguration
->RegisterSmmEntry (SmmConfiguration
, gSmmCorePrivate
->SmmEntryPoint
);
695 ASSERT_EFI_ERROR (Status
);
698 // Set flag to indicate that the SMM Entry Point has been registered which
699 // means that SMIs are now fully operational.
701 gSmmCorePrivate
->SmmEntryPointRegistered
= TRUE
;
704 // Print debug message showing SMM Core entry point address.
706 DEBUG ((DEBUG_INFO
, "SMM IPL registered SMM Entry Point address %p\n", (VOID
*)(UINTN
)gSmmCorePrivate
->SmmEntryPoint
));
710 Event notification that is fired every time a DxeSmmReadyToLock protocol is added
711 or if gEfiEventReadyToBootGuid is signaled.
713 @param Event The Event that is being processed, not used.
714 @param Context Event Context, not used.
719 SmmIplReadyToLockEventNotify (
729 // See if we are already locked
736 // Make sure this notification is for this handler
738 if (CompareGuid ((EFI_GUID
*)Context
, &gEfiDxeSmmReadyToLockProtocolGuid
)) {
739 Status
= gBS
->LocateProtocol (&gEfiDxeSmmReadyToLockProtocolGuid
, NULL
, &Interface
);
740 if (EFI_ERROR (Status
)) {
745 // If SMM is not locked yet and we got here from gEfiEventReadyToBootGuid being
746 // signaled, then gEfiDxeSmmReadyToLockProtocolGuid was not installed as expected.
747 // Print a warning on debug builds.
749 DEBUG ((DEBUG_WARN
, "SMM IPL! DXE SMM Ready To Lock Protocol not installed before Ready To Boot signal\n"));
753 DEBUG ((DEBUG_ERROR
, "EndOfDxe Event must be signaled before DxeSmmReadyToLock Protocol installation!\n"));
755 EFI_ERROR_CODE
| EFI_ERROR_UNRECOVERED
,
756 (EFI_SOFTWARE_SMM_DRIVER
| EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
)
762 // Lock the SMRAM (Note: Locking SMRAM may not be supported on all platforms)
764 mSmmAccess
->Lock (mSmmAccess
);
767 // Close protocol and event notification events that do not apply after the
768 // DXE SMM Ready To Lock Protocol has been installed or the Ready To Boot
769 // event has been signalled.
771 for (Index
= 0; mSmmIplEvents
[Index
].NotifyFunction
!= NULL
; Index
++) {
772 if (mSmmIplEvents
[Index
].CloseOnLock
) {
773 gBS
->CloseEvent (mSmmIplEvents
[Index
].Event
);
778 // Inform SMM Core that the DxeSmmReadyToLock protocol was installed
780 SmmIplGuidedEventNotify (Event
, (VOID
*)&gEfiDxeSmmReadyToLockProtocolGuid
);
783 // Print debug message that the SMRAM window is now locked.
785 DEBUG ((DEBUG_INFO
, "SMM IPL locked SMRAM window\n"));
788 // Set flag so this operation will not be performed again
794 Notification function of EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE.
796 This is a notification function registered on EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.
797 It convers pointer to new virtual address.
799 @param Event Event whose notification function is being invoked.
800 @param Context Pointer to the notification function's context.
805 SmmIplSetVirtualAddressNotify (
810 EfiConvertPointer (0x0, (VOID
**)&mSmmControl2
);
814 Get the fixed loading address from image header assigned by build tool. This function only be called
815 when Loading module at Fixed address feature enabled.
817 @param ImageContext Pointer to the image context structure that describes the PE/COFF
818 image that needs to be examined by this function.
819 @retval EFI_SUCCESS An fixed loading address is assigned to this image by build tools .
820 @retval EFI_NOT_FOUND The image has no assigned fixed loading address.
823 GetPeCoffImageFixLoadingAssignedAddress(
824 IN OUT PE_COFF_LOADER_IMAGE_CONTEXT
*ImageContext
827 UINTN SectionHeaderOffset
;
829 EFI_IMAGE_SECTION_HEADER SectionHeader
;
830 EFI_IMAGE_OPTIONAL_HEADER_UNION
*ImgHdr
;
831 EFI_PHYSICAL_ADDRESS FixLoadingAddress
;
834 UINT16 NumberOfSections
;
835 EFI_PHYSICAL_ADDRESS SmramBase
;
837 UINT64 ValueInSectionHeader
;
839 // Build tool will calculate the smm code size and then patch the PcdLoadFixAddressSmmCodePageNumber
841 SmmCodeSize
= EFI_PAGES_TO_SIZE (PcdGet32(PcdLoadFixAddressSmmCodePageNumber
));
843 FixLoadingAddress
= 0;
844 Status
= EFI_NOT_FOUND
;
845 SmramBase
= mLMFAConfigurationTable
->SmramBase
;
847 // Get PeHeader pointer
849 ImgHdr
= (EFI_IMAGE_OPTIONAL_HEADER_UNION
*)((CHAR8
* )ImageContext
->Handle
+ ImageContext
->PeCoffHeaderOffset
);
850 SectionHeaderOffset
= ImageContext
->PeCoffHeaderOffset
+
852 sizeof (EFI_IMAGE_FILE_HEADER
) +
853 ImgHdr
->Pe32
.FileHeader
.SizeOfOptionalHeader
;
854 NumberOfSections
= ImgHdr
->Pe32
.FileHeader
.NumberOfSections
;
857 // Get base address from the first section header that doesn't point to code section.
859 for (Index
= 0; Index
< NumberOfSections
; Index
++) {
861 // Read section header from file
863 Size
= sizeof (EFI_IMAGE_SECTION_HEADER
);
864 Status
= ImageContext
->ImageRead (
865 ImageContext
->Handle
,
870 if (EFI_ERROR (Status
)) {
874 Status
= EFI_NOT_FOUND
;
876 if ((SectionHeader
.Characteristics
& EFI_IMAGE_SCN_CNT_CODE
) == 0) {
878 // Build tool saves the offset to SMRAM base as image base in PointerToRelocations & PointerToLineNumbers fields in the
879 // first section header that doesn't point to code section in image header. And there is an assumption that when the
880 // feature is enabled, if a module is assigned a loading address by tools, PointerToRelocations & PointerToLineNumbers
881 // fields should NOT be Zero, or else, these 2 fields should be set to Zero
883 ValueInSectionHeader
= ReadUnaligned64((UINT64
*)&SectionHeader
.PointerToRelocations
);
884 if (ValueInSectionHeader
!= 0) {
886 // Found first section header that doesn't point to code section in which build tool saves the
887 // offset to SMRAM base as image base in PointerToRelocations & PointerToLineNumbers fields
889 FixLoadingAddress
= (EFI_PHYSICAL_ADDRESS
)(SmramBase
+ (INT64
)ValueInSectionHeader
);
891 if (SmramBase
+ SmmCodeSize
> FixLoadingAddress
&& SmramBase
<= FixLoadingAddress
) {
893 // The assigned address is valid. Return the specified loading address
895 ImageContext
->ImageAddress
= FixLoadingAddress
;
896 Status
= EFI_SUCCESS
;
901 SectionHeaderOffset
+= sizeof (EFI_IMAGE_SECTION_HEADER
);
903 DEBUG ((EFI_D_INFO
|EFI_D_LOAD
, "LOADING MODULE FIXED INFO: Loading module at fixed address %x, Status = %r \n", FixLoadingAddress
, Status
));
907 Load the SMM Core image into SMRAM and executes the SMM Core from SMRAM.
909 @param[in, out] SmramRange Descriptor for the range of SMRAM to reload the
910 currently executing image, the rang of SMRAM to
911 hold SMM Core will be excluded.
912 @param[in, out] SmramRangeSmmCore Descriptor for the range of SMRAM to hold SMM Core.
914 @param[in] Context Context to pass into SMM Core
920 ExecuteSmmCoreFromSmram (
921 IN OUT EFI_SMRAM_DESCRIPTOR
*SmramRange
,
922 IN OUT EFI_SMRAM_DESCRIPTOR
*SmramRangeSmmCore
,
929 PE_COFF_LOADER_IMAGE_CONTEXT ImageContext
;
931 EFI_IMAGE_ENTRY_POINT EntryPoint
;
934 // Search all Firmware Volumes for a PE/COFF image in a file of type SMM_CORE
936 Status
= GetSectionFromAnyFvByFileType (
937 EFI_FV_FILETYPE_SMM_CORE
,
944 if (EFI_ERROR (Status
)) {
949 // Initilize ImageContext
951 ImageContext
.Handle
= SourceBuffer
;
952 ImageContext
.ImageRead
= PeCoffLoaderImageReadFromMemory
;
955 // Get information about the image being loaded
957 Status
= PeCoffLoaderGetImageInfo (&ImageContext
);
958 if (EFI_ERROR (Status
)) {
962 // if Loading module at Fixed Address feature is enabled, the SMM core driver will be loaded to
963 // the address assigned by build tool.
965 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
967 // Get the fixed loading address assigned by Build tool
969 Status
= GetPeCoffImageFixLoadingAssignedAddress (&ImageContext
);
970 if (!EFI_ERROR (Status
)) {
972 // Since the memory range to load SMM CORE will be cut out in SMM core, so no need to allocate and free this range
976 // Reserved Smram Region for SmmCore is not used, and remove it from SmramRangeCount.
978 gSmmCorePrivate
->SmramRangeCount
--;
980 DEBUG ((EFI_D_INFO
, "LOADING MODULE FIXED ERROR: Loading module at fixed address at address failed\n"));
982 // Allocate memory for the image being loaded from the EFI_SRAM_DESCRIPTOR
983 // specified by SmramRange
985 PageCount
= (UINTN
)EFI_SIZE_TO_PAGES((UINTN
)ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
987 ASSERT ((SmramRange
->PhysicalSize
& EFI_PAGE_MASK
) == 0);
988 ASSERT (SmramRange
->PhysicalSize
> EFI_PAGES_TO_SIZE (PageCount
));
990 SmramRange
->PhysicalSize
-= EFI_PAGES_TO_SIZE (PageCount
);
991 SmramRangeSmmCore
->CpuStart
= SmramRange
->CpuStart
+ SmramRange
->PhysicalSize
;
992 SmramRangeSmmCore
->PhysicalStart
= SmramRange
->PhysicalStart
+ SmramRange
->PhysicalSize
;
993 SmramRangeSmmCore
->RegionState
= SmramRange
->RegionState
| EFI_ALLOCATED
;
994 SmramRangeSmmCore
->PhysicalSize
= EFI_PAGES_TO_SIZE (PageCount
);
997 // Align buffer on section boundary
999 ImageContext
.ImageAddress
= SmramRangeSmmCore
->CpuStart
;
1003 // Allocate memory for the image being loaded from the EFI_SRAM_DESCRIPTOR
1004 // specified by SmramRange
1006 PageCount
= (UINTN
)EFI_SIZE_TO_PAGES((UINTN
)ImageContext
.ImageSize
+ ImageContext
.SectionAlignment
);
1008 ASSERT ((SmramRange
->PhysicalSize
& EFI_PAGE_MASK
) == 0);
1009 ASSERT (SmramRange
->PhysicalSize
> EFI_PAGES_TO_SIZE (PageCount
));
1011 SmramRange
->PhysicalSize
-= EFI_PAGES_TO_SIZE (PageCount
);
1012 SmramRangeSmmCore
->CpuStart
= SmramRange
->CpuStart
+ SmramRange
->PhysicalSize
;
1013 SmramRangeSmmCore
->PhysicalStart
= SmramRange
->PhysicalStart
+ SmramRange
->PhysicalSize
;
1014 SmramRangeSmmCore
->RegionState
= SmramRange
->RegionState
| EFI_ALLOCATED
;
1015 SmramRangeSmmCore
->PhysicalSize
= EFI_PAGES_TO_SIZE (PageCount
);
1018 // Align buffer on section boundary
1020 ImageContext
.ImageAddress
= SmramRangeSmmCore
->CpuStart
;
1023 ImageContext
.ImageAddress
+= ImageContext
.SectionAlignment
- 1;
1024 ImageContext
.ImageAddress
&= ~((EFI_PHYSICAL_ADDRESS
)ImageContext
.SectionAlignment
- 1);
1027 // Print debug message showing SMM Core load address.
1029 DEBUG ((DEBUG_INFO
, "SMM IPL loading SMM Core at SMRAM address %p\n", (VOID
*)(UINTN
)ImageContext
.ImageAddress
));
1032 // Load the image to our new buffer
1034 Status
= PeCoffLoaderLoadImage (&ImageContext
);
1035 if (!EFI_ERROR (Status
)) {
1037 // Relocate the image in our new buffer
1039 Status
= PeCoffLoaderRelocateImage (&ImageContext
);
1040 if (!EFI_ERROR (Status
)) {
1042 // Flush the instruction cache so the image data are written before we execute it
1044 InvalidateInstructionCacheRange ((VOID
*)(UINTN
)ImageContext
.ImageAddress
, (UINTN
)ImageContext
.ImageSize
);
1047 // Print debug message showing SMM Core entry point address.
1049 DEBUG ((DEBUG_INFO
, "SMM IPL calling SMM Core at SMRAM address %p\n", (VOID
*)(UINTN
)ImageContext
.EntryPoint
));
1051 gSmmCorePrivate
->PiSmmCoreImageBase
= ImageContext
.ImageAddress
;
1052 gSmmCorePrivate
->PiSmmCoreImageSize
= ImageContext
.ImageSize
;
1053 DEBUG ((DEBUG_INFO
, "PiSmmCoreImageBase - 0x%016lx\n", gSmmCorePrivate
->PiSmmCoreImageBase
));
1054 DEBUG ((DEBUG_INFO
, "PiSmmCoreImageSize - 0x%016lx\n", gSmmCorePrivate
->PiSmmCoreImageSize
));
1056 gSmmCorePrivate
->PiSmmCoreEntryPoint
= ImageContext
.EntryPoint
;
1061 EntryPoint
= (EFI_IMAGE_ENTRY_POINT
)(UINTN
)ImageContext
.EntryPoint
;
1062 Status
= EntryPoint ((EFI_HANDLE
)Context
, gST
);
1067 // Always free memory allocted by GetFileBufferByFilePath ()
1069 FreePool (SourceBuffer
);
1075 SMM split SMRAM entry.
1077 @param[in, out] RangeToCompare Pointer to EFI_SMRAM_DESCRIPTOR to compare.
1078 @param[in, out] ReservedRangeToCompare Pointer to EFI_SMM_RESERVED_SMRAM_REGION to compare.
1079 @param[out] Ranges Output pointer to hold split EFI_SMRAM_DESCRIPTOR entry.
1080 @param[in, out] RangeCount Pointer to range count.
1081 @param[out] ReservedRanges Output pointer to hold split EFI_SMM_RESERVED_SMRAM_REGION entry.
1082 @param[in, out] ReservedRangeCount Pointer to reserved range count.
1083 @param[out] FinalRanges Output pointer to hold split final EFI_SMRAM_DESCRIPTOR entry
1084 that no need to be split anymore.
1085 @param[in, out] FinalRangeCount Pointer to final range count.
1089 SmmSplitSmramEntry (
1090 IN OUT EFI_SMRAM_DESCRIPTOR
*RangeToCompare
,
1091 IN OUT EFI_SMM_RESERVED_SMRAM_REGION
*ReservedRangeToCompare
,
1092 OUT EFI_SMRAM_DESCRIPTOR
*Ranges
,
1093 IN OUT UINTN
*RangeCount
,
1094 OUT EFI_SMM_RESERVED_SMRAM_REGION
*ReservedRanges
,
1095 IN OUT UINTN
*ReservedRangeCount
,
1096 OUT EFI_SMRAM_DESCRIPTOR
*FinalRanges
,
1097 IN OUT UINTN
*FinalRangeCount
1100 UINT64 RangeToCompareEnd
;
1101 UINT64 ReservedRangeToCompareEnd
;
1103 RangeToCompareEnd
= RangeToCompare
->CpuStart
+ RangeToCompare
->PhysicalSize
;
1104 ReservedRangeToCompareEnd
= ReservedRangeToCompare
->SmramReservedStart
+ ReservedRangeToCompare
->SmramReservedSize
;
1106 if ((RangeToCompare
->CpuStart
>= ReservedRangeToCompare
->SmramReservedStart
) &&
1107 (RangeToCompare
->CpuStart
< ReservedRangeToCompareEnd
)) {
1108 if (RangeToCompareEnd
< ReservedRangeToCompareEnd
) {
1110 // RangeToCompare ReservedRangeToCompare
1111 // ---- ---- --------------------------------------
1112 // | | | | -> 1. ReservedRangeToCompare
1113 // ---- | | |--| --------------------------------------
1115 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1116 // | | | | | | RangeToCompare->PhysicalSize = 0
1117 // ---- | | |--| --------------------------------------
1118 // | | | | -> 3. ReservedRanges[*ReservedRangeCount] and increment *ReservedRangeCount
1119 // ---- ---- --------------------------------------
1123 // 1. Update ReservedRangeToCompare.
1125 ReservedRangeToCompare
->SmramReservedSize
= RangeToCompare
->CpuStart
- ReservedRangeToCompare
->SmramReservedStart
;
1127 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1128 // Zero RangeToCompare->PhysicalSize.
1130 FinalRanges
[*FinalRangeCount
].CpuStart
= RangeToCompare
->CpuStart
;
1131 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
;
1132 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1133 FinalRanges
[*FinalRangeCount
].PhysicalSize
= RangeToCompare
->PhysicalSize
;
1134 *FinalRangeCount
+= 1;
1135 RangeToCompare
->PhysicalSize
= 0;
1137 // 3. Update ReservedRanges[*ReservedRangeCount] and increment *ReservedRangeCount.
1139 ReservedRanges
[*ReservedRangeCount
].SmramReservedStart
= FinalRanges
[*FinalRangeCount
- 1].CpuStart
+ FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1140 ReservedRanges
[*ReservedRangeCount
].SmramReservedSize
= ReservedRangeToCompareEnd
- RangeToCompareEnd
;
1141 *ReservedRangeCount
+= 1;
1144 // RangeToCompare ReservedRangeToCompare
1145 // ---- ---- --------------------------------------
1146 // | | | | -> 1. ReservedRangeToCompare
1147 // ---- | | |--| --------------------------------------
1149 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1151 // | | ---- |--| --------------------------------------
1152 // | | | | -> 3. RangeToCompare
1153 // ---- ---- --------------------------------------
1157 // 1. Update ReservedRangeToCompare.
1159 ReservedRangeToCompare
->SmramReservedSize
= RangeToCompare
->CpuStart
- ReservedRangeToCompare
->SmramReservedStart
;
1161 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1163 FinalRanges
[*FinalRangeCount
].CpuStart
= RangeToCompare
->CpuStart
;
1164 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
;
1165 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1166 FinalRanges
[*FinalRangeCount
].PhysicalSize
= ReservedRangeToCompareEnd
- RangeToCompare
->CpuStart
;
1167 *FinalRangeCount
+= 1;
1169 // 3. Update RangeToCompare.
1171 RangeToCompare
->CpuStart
+= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1172 RangeToCompare
->PhysicalStart
+= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1173 RangeToCompare
->PhysicalSize
-= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1175 } else if ((ReservedRangeToCompare
->SmramReservedStart
>= RangeToCompare
->CpuStart
) &&
1176 (ReservedRangeToCompare
->SmramReservedStart
< RangeToCompareEnd
)) {
1177 if (ReservedRangeToCompareEnd
< RangeToCompareEnd
) {
1179 // RangeToCompare ReservedRangeToCompare
1180 // ---- ---- --------------------------------------
1181 // | | | | -> 1. RangeToCompare
1182 // | | ---- |--| --------------------------------------
1184 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1185 // | | | | | | ReservedRangeToCompare->SmramReservedSize = 0
1186 // | | ---- |--| --------------------------------------
1187 // | | | | -> 3. Ranges[*RangeCount] and increment *RangeCount
1188 // ---- ---- --------------------------------------
1192 // 1. Update RangeToCompare.
1194 RangeToCompare
->PhysicalSize
= ReservedRangeToCompare
->SmramReservedStart
- RangeToCompare
->CpuStart
;
1196 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1197 // ReservedRangeToCompare->SmramReservedSize = 0
1199 FinalRanges
[*FinalRangeCount
].CpuStart
= ReservedRangeToCompare
->SmramReservedStart
;
1200 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
+ RangeToCompare
->PhysicalSize
;
1201 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1202 FinalRanges
[*FinalRangeCount
].PhysicalSize
= ReservedRangeToCompare
->SmramReservedSize
;
1203 *FinalRangeCount
+= 1;
1204 ReservedRangeToCompare
->SmramReservedSize
= 0;
1206 // 3. Update Ranges[*RangeCount] and increment *RangeCount.
1208 Ranges
[*RangeCount
].CpuStart
= FinalRanges
[*FinalRangeCount
- 1].CpuStart
+ FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1209 Ranges
[*RangeCount
].PhysicalStart
= FinalRanges
[*FinalRangeCount
- 1].PhysicalStart
+ FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1210 Ranges
[*RangeCount
].RegionState
= RangeToCompare
->RegionState
;
1211 Ranges
[*RangeCount
].PhysicalSize
= RangeToCompareEnd
- ReservedRangeToCompareEnd
;
1215 // RangeToCompare ReservedRangeToCompare
1216 // ---- ---- --------------------------------------
1217 // | | | | -> 1. RangeToCompare
1218 // | | ---- |--| --------------------------------------
1220 // | | | | | | -> 2. FinalRanges[*FinalRangeCount] and increment *FinalRangeCount
1222 // ---- | | |--| --------------------------------------
1223 // | | | | -> 3. ReservedRangeToCompare
1224 // ---- ---- --------------------------------------
1228 // 1. Update RangeToCompare.
1230 RangeToCompare
->PhysicalSize
= ReservedRangeToCompare
->SmramReservedStart
- RangeToCompare
->CpuStart
;
1232 // 2. Update FinalRanges[FinalRangeCount] and increment *FinalRangeCount.
1233 // ReservedRangeToCompare->SmramReservedSize = 0
1235 FinalRanges
[*FinalRangeCount
].CpuStart
= ReservedRangeToCompare
->SmramReservedStart
;
1236 FinalRanges
[*FinalRangeCount
].PhysicalStart
= RangeToCompare
->PhysicalStart
+ RangeToCompare
->PhysicalSize
;
1237 FinalRanges
[*FinalRangeCount
].RegionState
= RangeToCompare
->RegionState
| EFI_ALLOCATED
;
1238 FinalRanges
[*FinalRangeCount
].PhysicalSize
= RangeToCompareEnd
- ReservedRangeToCompare
->SmramReservedStart
;
1239 *FinalRangeCount
+= 1;
1241 // 3. Update ReservedRangeToCompare.
1243 ReservedRangeToCompare
->SmramReservedStart
+= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1244 ReservedRangeToCompare
->SmramReservedSize
-= FinalRanges
[*FinalRangeCount
- 1].PhysicalSize
;
1250 Returns if SMRAM range and SMRAM reserved range are overlapped.
1252 @param[in] RangeToCompare Pointer to EFI_SMRAM_DESCRIPTOR to compare.
1253 @param[in] ReservedRangeToCompare Pointer to EFI_SMM_RESERVED_SMRAM_REGION to compare.
1255 @retval TRUE There is overlap.
1256 @retval FALSE There is no overlap.
1261 IN EFI_SMRAM_DESCRIPTOR
*RangeToCompare
,
1262 IN EFI_SMM_RESERVED_SMRAM_REGION
*ReservedRangeToCompare
1265 UINT64 RangeToCompareEnd
;
1266 UINT64 ReservedRangeToCompareEnd
;
1268 RangeToCompareEnd
= RangeToCompare
->CpuStart
+ RangeToCompare
->PhysicalSize
;
1269 ReservedRangeToCompareEnd
= ReservedRangeToCompare
->SmramReservedStart
+ ReservedRangeToCompare
->SmramReservedSize
;
1271 if ((RangeToCompare
->CpuStart
>= ReservedRangeToCompare
->SmramReservedStart
) &&
1272 (RangeToCompare
->CpuStart
< ReservedRangeToCompareEnd
)) {
1274 } else if ((ReservedRangeToCompare
->SmramReservedStart
>= RangeToCompare
->CpuStart
) &&
1275 (ReservedRangeToCompare
->SmramReservedStart
< RangeToCompareEnd
)) {
1282 Get full SMRAM ranges.
1284 It will get SMRAM ranges from SmmAccess protocol and SMRAM reserved ranges from
1285 SmmConfiguration protocol, split the entries if there is overlap between them.
1286 It will also reserve one entry for SMM core.
1288 @param[out] FullSmramRangeCount Output pointer to full SMRAM range count.
1290 @return Pointer to full SMRAM ranges.
1293 EFI_SMRAM_DESCRIPTOR
*
1294 GetFullSmramRanges (
1295 OUT UINTN
*FullSmramRangeCount
1299 EFI_SMM_CONFIGURATION_PROTOCOL
*SmmConfiguration
;
1303 EFI_SMRAM_DESCRIPTOR
*FullSmramRanges
;
1304 UINTN TempSmramRangeCount
;
1305 UINTN AdditionSmramRangeCount
;
1306 EFI_SMRAM_DESCRIPTOR
*TempSmramRanges
;
1307 UINTN SmramRangeCount
;
1308 EFI_SMRAM_DESCRIPTOR
*SmramRanges
;
1309 UINTN SmramReservedCount
;
1310 EFI_SMM_RESERVED_SMRAM_REGION
*SmramReservedRanges
;
1315 // Get SMM Configuration Protocol if it is present.
1317 SmmConfiguration
= NULL
;
1318 Status
= gBS
->LocateProtocol (&gEfiSmmConfigurationProtocolGuid
, NULL
, (VOID
**) &SmmConfiguration
);
1321 // Get SMRAM information.
1324 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, NULL
);
1325 ASSERT (Status
== EFI_BUFFER_TOO_SMALL
);
1327 SmramRangeCount
= Size
/ sizeof (EFI_SMRAM_DESCRIPTOR
);
1330 // Get SMRAM reserved region count.
1332 SmramReservedCount
= 0;
1333 if (SmmConfiguration
!= NULL
) {
1334 while (SmmConfiguration
->SmramReservedRegions
[SmramReservedCount
].SmramReservedSize
!= 0) {
1335 SmramReservedCount
++;
1340 // Reserve one entry for SMM Core in the full SMRAM ranges.
1342 AdditionSmramRangeCount
= 1;
1343 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0) {
1345 // Reserve two entries for all SMM drivers and SMM Core in the full SMRAM ranges.
1347 AdditionSmramRangeCount
= 2;
1350 if (SmramReservedCount
== 0) {
1352 // No reserved SMRAM entry from SMM Configuration Protocol.
1354 *FullSmramRangeCount
= SmramRangeCount
+ AdditionSmramRangeCount
;
1355 Size
= (*FullSmramRangeCount
) * sizeof (EFI_SMRAM_DESCRIPTOR
);
1356 FullSmramRanges
= (EFI_SMRAM_DESCRIPTOR
*) AllocateZeroPool (Size
);
1357 ASSERT (FullSmramRanges
!= NULL
);
1359 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, FullSmramRanges
);
1360 ASSERT_EFI_ERROR (Status
);
1362 return FullSmramRanges
;
1366 // Why MaxCount = X + 2 * Y?
1367 // Take Y = 1 as example below, Y > 1 case is just the iteration of Y = 1.
1369 // X = 1 Y = 1 MaxCount = 3 = 1 + 2 * 1
1376 // X = 2 Y = 1 MaxCount = 4 = 2 + 2 * 1
1387 // X = 3 Y = 1 MaxCount = 5 = 3 + 2 * 1
1400 MaxCount
= SmramRangeCount
+ 2 * SmramReservedCount
;
1402 Size
= MaxCount
* sizeof (EFI_SMM_RESERVED_SMRAM_REGION
);
1403 SmramReservedRanges
= (EFI_SMM_RESERVED_SMRAM_REGION
*) AllocatePool (Size
);
1404 ASSERT (SmramReservedRanges
!= NULL
);
1405 for (Index
= 0; Index
< SmramReservedCount
; Index
++) {
1406 CopyMem (&SmramReservedRanges
[Index
], &SmmConfiguration
->SmramReservedRegions
[Index
], sizeof (EFI_SMM_RESERVED_SMRAM_REGION
));
1409 Size
= MaxCount
* sizeof (EFI_SMRAM_DESCRIPTOR
);
1410 TempSmramRanges
= (EFI_SMRAM_DESCRIPTOR
*) AllocatePool (Size
);
1411 ASSERT (TempSmramRanges
!= NULL
);
1412 TempSmramRangeCount
= 0;
1414 SmramRanges
= (EFI_SMRAM_DESCRIPTOR
*) AllocatePool (Size
);
1415 ASSERT (SmramRanges
!= NULL
);
1416 Status
= mSmmAccess
->GetCapabilities (mSmmAccess
, &Size
, SmramRanges
);
1417 ASSERT_EFI_ERROR (Status
);
1421 for (Index
= 0; (Index
< SmramRangeCount
) && !Rescan
; Index
++) {
1423 // Skip zero size entry.
1425 if (SmramRanges
[Index
].PhysicalSize
!= 0) {
1426 for (Index2
= 0; (Index2
< SmramReservedCount
) && !Rescan
; Index2
++) {
1428 // Skip zero size entry.
1430 if (SmramReservedRanges
[Index2
].SmramReservedSize
!= 0) {
1431 if (SmmIsSmramOverlap (
1432 &SmramRanges
[Index
],
1433 &SmramReservedRanges
[Index2
]
1436 // There is overlap, need to split entry and then rescan.
1438 SmmSplitSmramEntry (
1439 &SmramRanges
[Index
],
1440 &SmramReservedRanges
[Index2
],
1443 SmramReservedRanges
,
1444 &SmramReservedCount
,
1446 &TempSmramRangeCount
1454 // No any overlap, copy the entry to the temp SMRAM ranges.
1455 // Zero SmramRanges[Index].PhysicalSize = 0;
1457 CopyMem (&TempSmramRanges
[TempSmramRangeCount
++], &SmramRanges
[Index
], sizeof (EFI_SMRAM_DESCRIPTOR
));
1458 SmramRanges
[Index
].PhysicalSize
= 0;
1463 ASSERT (TempSmramRangeCount
<= MaxCount
);
1468 FullSmramRanges
= AllocateZeroPool ((TempSmramRangeCount
+ AdditionSmramRangeCount
) * sizeof (EFI_SMRAM_DESCRIPTOR
));
1469 ASSERT (FullSmramRanges
!= NULL
);
1470 *FullSmramRangeCount
= 0;
1472 for (Index
= 0; Index
< TempSmramRangeCount
; Index
++) {
1473 if (TempSmramRanges
[Index
].PhysicalSize
!= 0) {
1477 ASSERT (Index
< TempSmramRangeCount
);
1478 for (Index2
= 0; Index2
< TempSmramRangeCount
; Index2
++) {
1479 if ((Index2
!= Index
) && (TempSmramRanges
[Index2
].PhysicalSize
!= 0) && (TempSmramRanges
[Index2
].CpuStart
< TempSmramRanges
[Index
].CpuStart
)) {
1483 CopyMem (&FullSmramRanges
[*FullSmramRangeCount
], &TempSmramRanges
[Index
], sizeof (EFI_SMRAM_DESCRIPTOR
));
1484 *FullSmramRangeCount
+= 1;
1485 TempSmramRanges
[Index
].PhysicalSize
= 0;
1486 } while (*FullSmramRangeCount
< TempSmramRangeCount
);
1487 ASSERT (*FullSmramRangeCount
== TempSmramRangeCount
);
1488 *FullSmramRangeCount
+= AdditionSmramRangeCount
;
1490 FreePool (SmramRanges
);
1491 FreePool (SmramReservedRanges
);
1492 FreePool (TempSmramRanges
);
1494 return FullSmramRanges
;
1498 The Entry Point for SMM IPL
1500 Load SMM Core into SMRAM, register SMM Core entry point for SMIs, install
1501 SMM Base 2 Protocol and SMM Communication Protocol, and register for the
1502 critical events required to coordinate between DXE and SMM environments.
1504 @param ImageHandle The firmware allocated handle for the EFI image.
1505 @param SystemTable A pointer to the EFI System Table.
1507 @retval EFI_SUCCESS The entry point is executed successfully.
1508 @retval Other Some error occurred when executing this entry point.
1514 IN EFI_HANDLE ImageHandle
,
1515 IN EFI_SYSTEM_TABLE
*SystemTable
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
**) &mLMFAConfigurationTable
1628 if (!EFI_ERROR (Status
) && mLMFAConfigurationTable
!= NULL
) {
1629 mLMFAConfigurationTable
->SmramBase
= mCurrentSmramRange
->CpuStart
;
1631 // Print the SMRAM base
1633 DEBUG ((EFI_D_INFO
, "LOADING MODULE FIXED INFO: TSEG BASE is %x. \n", mLMFAConfigurationTable
->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
);