2 Agent Module to load other modules to deploy SMM Entry Vector for X86 CPU.
4 Copyright (c) 2009 - 2020, Intel Corporation. All rights reserved.<BR>
5 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
11 #ifndef _CPU_PISMMCPUDXESMM_H_
12 #define _CPU_PISMMCPUDXESMM_H_
16 #include <Protocol/MpService.h>
17 #include <Protocol/SmmConfiguration.h>
18 #include <Protocol/SmmCpu.h>
19 #include <Protocol/SmmAccess2.h>
20 #include <Protocol/SmmReadyToLock.h>
21 #include <Protocol/SmmCpuService.h>
22 #include <Protocol/SmmMemoryAttribute.h>
23 #include <Protocol/MmMp.h>
25 #include <Guid/AcpiS3Context.h>
26 #include <Guid/MemoryAttributesTable.h>
27 #include <Guid/PiSmmMemoryAttributesTable.h>
29 #include <Library/BaseLib.h>
30 #include <Library/IoLib.h>
31 #include <Library/TimerLib.h>
32 #include <Library/SynchronizationLib.h>
33 #include <Library/DebugLib.h>
34 #include <Library/BaseMemoryLib.h>
35 #include <Library/PcdLib.h>
36 #include <Library/MtrrLib.h>
37 #include <Library/SmmCpuPlatformHookLib.h>
38 #include <Library/SmmServicesTableLib.h>
39 #include <Library/MemoryAllocationLib.h>
40 #include <Library/UefiBootServicesTableLib.h>
41 #include <Library/UefiRuntimeServicesTableLib.h>
42 #include <Library/DebugAgentLib.h>
43 #include <Library/UefiLib.h>
44 #include <Library/HobLib.h>
45 #include <Library/LocalApicLib.h>
46 #include <Library/UefiCpuLib.h>
47 #include <Library/CpuExceptionHandlerLib.h>
48 #include <Library/ReportStatusCodeLib.h>
49 #include <Library/SmmCpuFeaturesLib.h>
50 #include <Library/PeCoffGetEntryPointLib.h>
51 #include <Library/RegisterCpuFeaturesLib.h>
53 #include <AcpiCpuData.h>
54 #include <CpuHotPlugData.h>
56 #include <Register/Intel/Cpuid.h>
57 #include <Register/Intel/Msr.h>
59 #include "CpuService.h"
60 #include "SmmProfile.h"
65 #define CPUID_CET_SS BIT7
66 #define CPUID_CET_IBT BIT20
68 #define CR4_CET_ENABLE BIT23
70 #define MSR_IA32_S_CET 0x6A2
71 #define MSR_IA32_PL0_SSP 0x6A4
72 #define MSR_IA32_INTERRUPT_SSP_TABLE_ADDR 0x6A8
76 // enable shadow stacks
78 // enable the WRSS{D,Q}W instructions.
80 // enable tracking of indirect call/jmp targets to be ENDBRANCH instruction.
82 // enable legacy compatibility treatment for indirect call/jmp tracking.
84 // enable use of no-track prefix on indirect call/jmp.
86 // disable suppression of CET indirect branch tracking on legacy compatibility.
87 UINT32 SUPPRESS_DIS
:1;
89 // indirect branch tracking is suppressed.
90 // This bit can be written to 1 only if TRACKER is written as IDLE.
92 // Value of the endbranch state machine
93 // Values: IDLE (0), WAIT_FOR_ENDBRANCH(1).
95 // linear address of a bitmap in memory indicating valid
96 // pages as target of CALL/JMP_indirect that do not land on ENDBRANCH when CET is enabled
97 // and not suppressed. Valid when ENDBR_EN is 1. Must be machine canonical when written on
98 // parts that support 64 bit mode. On parts that do not support 64 bit mode, the bits 63:32 are
99 // reserved and must be 0. This value is extended by 12 bits at the low end to form the base address
100 // (this automatically aligns the address on a 4-Kbyte boundary).
101 UINT32 EB_LEG_BITMAP_BASE_low
:12;
102 UINT32 EB_LEG_BITMAP_BASE_high
:32;
108 // MSRs required for configuration of SMM Code Access Check
110 #define EFI_MSR_SMM_MCA_CAP 0x17D
111 #define SMM_CODE_ACCESS_CHK_BIT BIT58
113 #define SMM_FEATURE_CONTROL_LOCK_BIT BIT0
114 #define SMM_CODE_CHK_EN_BIT BIT2
119 #define IA32_PG_P BIT0
120 #define IA32_PG_RW BIT1
121 #define IA32_PG_U BIT2
122 #define IA32_PG_WT BIT3
123 #define IA32_PG_CD BIT4
124 #define IA32_PG_A BIT5
125 #define IA32_PG_D BIT6
126 #define IA32_PG_PS BIT7
127 #define IA32_PG_PAT_2M BIT12
128 #define IA32_PG_PAT_4K IA32_PG_PS
129 #define IA32_PG_PMNT BIT62
130 #define IA32_PG_NX BIT63
132 #define PAGE_ATTRIBUTE_BITS (IA32_PG_D | IA32_PG_A | IA32_PG_U | IA32_PG_RW | IA32_PG_P)
134 // Bits 1, 2, 5, 6 are reserved in the IA32 PAE PDPTE
135 // X64 PAE PDPTE does not have such restriction
137 #define IA32_PAE_PDPTE_ATTRIBUTE_BITS (IA32_PG_P)
139 #define PAGE_PROGATE_BITS (IA32_PG_NX | PAGE_ATTRIBUTE_BITS)
141 #define PAGING_4K_MASK 0xFFF
142 #define PAGING_2M_MASK 0x1FFFFF
143 #define PAGING_1G_MASK 0x3FFFFFFF
145 #define PAGING_PAE_INDEX_MASK 0x1FF
147 #define PAGING_4K_ADDRESS_MASK_64 0x000FFFFFFFFFF000ull
148 #define PAGING_2M_ADDRESS_MASK_64 0x000FFFFFFFE00000ull
149 #define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull
151 #define SMRR_MAX_ADDRESS BASE_4GB
161 PAGE_ATTRIBUTE Attribute
;
164 } PAGE_ATTRIBUTE_TABLE
;
167 // Size of Task-State Segment defined in IA32 Manual
170 #define EXCEPTION_TSS_SIZE (TSS_SIZE + 4) // Add 4 bytes SSP
171 #define TSS_X64_IST1_OFFSET 36
172 #define TSS_IA32_CR3_OFFSET 28
173 #define TSS_IA32_ESP_OFFSET 56
174 #define TSS_IA32_SSP_OFFSET 104
181 #define PROTECT_MODE_CODE_SEGMENT 0x08
182 #define LONG_MODE_CODE_SEGMENT 0x38
185 // The size 0x20 must be bigger than
186 // the size of template code of SmmInit. Currently,
187 // the size of SmmInit requires the 0x16 Bytes buffer
190 #define BACK_BUF_SIZE 0x20
192 #define EXCEPTION_VECTOR_NUMBER 0x20
194 #define INVALID_APIC_ID 0xFFFFFFFFFFFFFFFFULL
196 typedef UINT32 SMM_CPU_ARRIVAL_EXCEPTIONS
;
197 #define ARRIVAL_EXCEPTION_BLOCKED 0x1
198 #define ARRIVAL_EXCEPTION_DELAYED 0x2
199 #define ARRIVAL_EXCEPTION_SMI_DISABLED 0x4
202 // Wrapper used to convert EFI_AP_PROCEDURE2 and EFI_AP_PROCEDURE.
205 EFI_AP_PROCEDURE Procedure
;
206 VOID
*ProcedureArgument
;
209 #define PROCEDURE_TOKEN_SIGNATURE SIGNATURE_32 ('P', 'R', 'T', 'S')
216 volatile UINT32 RunningApCount
;
219 #define PROCEDURE_TOKEN_FROM_LINK(a) CR (a, PROCEDURE_TOKEN, Link, PROCEDURE_TOKEN_SIGNATURE)
221 #define TOKEN_BUFFER_SIGNATURE SIGNATURE_32 ('T', 'K', 'B', 'S')
230 #define TOKEN_BUFFER_FROM_LINK(a) CR (a, TOKEN_BUFFER, Link, TOKEN_BUFFER_SIGNATURE)
233 // Private structure for the SMM CPU module that is stored in DXE Runtime memory
234 // Contains the SMM Configuration Protocols that is produced.
235 // Contains a mix of DXE and SMM contents. All the fields must be used properly.
237 #define SMM_CPU_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('s', 'c', 'p', 'u')
242 EFI_HANDLE SmmCpuHandle
;
244 EFI_PROCESSOR_INFORMATION
*ProcessorInfo
;
245 SMM_CPU_OPERATION
*Operation
;
246 UINTN
*CpuSaveStateSize
;
249 EFI_SMM_RESERVED_SMRAM_REGION SmmReservedSmramRegion
[1];
250 EFI_SMM_ENTRY_CONTEXT SmmCoreEntryContext
;
251 EFI_SMM_ENTRY_POINT SmmCoreEntry
;
253 EFI_SMM_CONFIGURATION_PROTOCOL SmmConfiguration
;
255 PROCEDURE_WRAPPER
*ApWrapperFunc
;
256 LIST_ENTRY TokenList
;
257 LIST_ENTRY
*FirstFreeToken
;
258 } SMM_CPU_PRIVATE_DATA
;
260 extern SMM_CPU_PRIVATE_DATA
*gSmmCpuPrivate
;
261 extern CPU_HOT_PLUG_DATA mCpuHotPlugData
;
262 extern UINTN mMaxNumberOfCpus
;
263 extern UINTN mNumberOfCpus
;
264 extern EFI_SMM_CPU_PROTOCOL mSmmCpu
;
265 extern EFI_MM_MP_PROTOCOL mSmmMp
;
268 /// The mode of the CPU at the time an SMI occurs
270 extern UINT8 mSmmSaveStateRegisterLma
;
273 // SMM CPU Protocol function prototypes.
277 Read information from the CPU save state.
279 @param This EFI_SMM_CPU_PROTOCOL instance
280 @param Width The number of bytes to read from the CPU save state.
281 @param Register Specifies the CPU register to read form the save state.
282 @param CpuIndex Specifies the zero-based index of the CPU save state
283 @param Buffer Upon return, this holds the CPU register value read from the save state.
285 @retval EFI_SUCCESS The register was read from Save State
286 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
287 @retval EFI_INVALID_PARAMETER This or Buffer is NULL.
293 IN CONST EFI_SMM_CPU_PROTOCOL
*This
,
295 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
301 Write data to the CPU save state.
303 @param This EFI_SMM_CPU_PROTOCOL instance
304 @param Width The number of bytes to read from the CPU save state.
305 @param Register Specifies the CPU register to write to the save state.
306 @param CpuIndex Specifies the zero-based index of the CPU save state
307 @param Buffer Upon entry, this holds the new CPU register value.
309 @retval EFI_SUCCESS The register was written from Save State
310 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
311 @retval EFI_INVALID_PARAMETER ProcessorIndex or Width is not correct
317 IN CONST EFI_SMM_CPU_PROTOCOL
*This
,
319 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
321 IN CONST VOID
*Buffer
325 Read a CPU Save State register on the target processor.
327 This function abstracts the differences that whether the CPU Save State register is in the
328 IA32 CPU Save State Map or X64 CPU Save State Map.
330 This function supports reading a CPU Save State register in SMBase relocation handler.
332 @param[in] CpuIndex Specifies the zero-based index of the CPU save state.
333 @param[in] RegisterIndex Index into mSmmCpuWidthOffset[] look up table.
334 @param[in] Width The number of bytes to read from the CPU save state.
335 @param[out] Buffer Upon return, this holds the CPU register value read from the save state.
337 @retval EFI_SUCCESS The register was read from Save State.
338 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor.
339 @retval EFI_INVALID_PARAMETER This or Buffer is NULL.
344 ReadSaveStateRegister (
346 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
352 Write value to a CPU Save State register on the target processor.
354 This function abstracts the differences that whether the CPU Save State register is in the
355 IA32 CPU Save State Map or X64 CPU Save State Map.
357 This function supports writing a CPU Save State register in SMBase relocation handler.
359 @param[in] CpuIndex Specifies the zero-based index of the CPU save state.
360 @param[in] RegisterIndex Index into mSmmCpuWidthOffset[] look up table.
361 @param[in] Width The number of bytes to read from the CPU save state.
362 @param[in] Buffer Upon entry, this holds the new CPU register value.
364 @retval EFI_SUCCESS The register was written to Save State.
365 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor.
366 @retval EFI_INVALID_PARAMETER ProcessorIndex or Width is not correct.
371 WriteSaveStateRegister (
373 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
375 IN CONST VOID
*Buffer
378 extern CONST UINT8 gcSmmInitTemplate
[];
379 extern CONST UINT16 gcSmmInitSize
;
380 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr0
;
381 extern UINT32 mSmmCr0
;
382 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr3
;
383 extern UINT32 mSmmCr4
;
384 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr4
;
385 X86_ASSEMBLY_PATCH_LABEL gPatchSmmInitStack
;
386 X86_ASSEMBLY_PATCH_LABEL mPatchCetSupported
;
387 extern BOOLEAN mCetSupported
;
390 Semaphore operation for all processor relocate SMMBase.
394 SmmRelocationSemaphoreComplete (
399 /// The type of SMM CPU Information
403 volatile EFI_AP_PROCEDURE2 Procedure
;
404 volatile VOID
*Parameter
;
405 volatile UINT32
*Run
;
406 volatile BOOLEAN
*Present
;
407 PROCEDURE_TOKEN
*Token
;
409 } SMM_CPU_DATA_BLOCK
;
412 SmmCpuSyncModeTradition
,
413 SmmCpuSyncModeRelaxedAp
,
419 // Pointer to an array. The array should be located immediately after this structure
420 // so that UC cache-ability can be set together.
422 SMM_CPU_DATA_BLOCK
*CpuData
;
423 volatile UINT32
*Counter
;
424 volatile UINT32 BspIndex
;
425 volatile BOOLEAN
*InsideSmm
;
426 volatile BOOLEAN
*AllCpusInSync
;
427 volatile SMM_CPU_SYNC_MODE EffectiveSyncMode
;
428 volatile BOOLEAN SwitchBsp
;
429 volatile BOOLEAN
*CandidateBsp
;
430 EFI_AP_PROCEDURE StartupProcedure
;
431 VOID
*StartupProcArgs
;
432 } SMM_DISPATCHER_MP_SYNC_DATA
;
434 #define SMM_PSD_OFFSET 0xfb00
437 /// All global semaphores' pointer
440 volatile UINT32
*Counter
;
441 volatile BOOLEAN
*InsideSmm
;
442 volatile BOOLEAN
*AllCpusInSync
;
444 SPIN_LOCK
*CodeAccessCheckLock
;
445 } SMM_CPU_SEMAPHORE_GLOBAL
;
448 /// All semaphores for each processor
452 volatile UINT32
*Run
;
453 volatile BOOLEAN
*Present
;
455 } SMM_CPU_SEMAPHORE_CPU
;
458 /// All semaphores' information
461 SMM_CPU_SEMAPHORE_GLOBAL SemaphoreGlobal
;
462 SMM_CPU_SEMAPHORE_CPU SemaphoreCpu
;
463 } SMM_CPU_SEMAPHORES
;
465 extern IA32_DESCRIPTOR gcSmiGdtr
;
466 extern EFI_PHYSICAL_ADDRESS mGdtBuffer
;
467 extern UINTN mGdtBufferSize
;
468 extern IA32_DESCRIPTOR gcSmiIdtr
;
469 extern VOID
*gcSmiIdtrPtr
;
470 extern UINT64 gPhyMask
;
471 extern SMM_DISPATCHER_MP_SYNC_DATA
*mSmmMpSyncData
;
472 extern UINTN mSmmStackArrayBase
;
473 extern UINTN mSmmStackArrayEnd
;
474 extern UINTN mSmmStackSize
;
475 extern EFI_SMM_CPU_SERVICE_PROTOCOL mSmmCpuService
;
476 extern IA32_DESCRIPTOR gcSmiInitGdtr
;
477 extern SMM_CPU_SEMAPHORES mSmmCpuSemaphores
;
478 extern UINTN mSemaphoreSize
;
479 extern SPIN_LOCK
*mPFLock
;
480 extern SPIN_LOCK
*mConfigSmmCodeAccessCheckLock
;
481 extern EFI_SMRAM_DESCRIPTOR
*mSmmCpuSmramRanges
;
482 extern UINTN mSmmCpuSmramRangeCount
;
483 extern UINT8 mPhysicalAddressBits
;
486 // Copy of the PcdPteMemoryEncryptionAddressOrMask
488 extern UINT64 mAddressEncMask
;
491 Create 4G PageTable in SMRAM.
493 @param[in] Is32BitPageTable Whether the page table is 32-bit PAE
494 @return PageTable Address
499 IN BOOLEAN Is32BitPageTable
504 Initialize global data for MP synchronization.
506 @param Stacks Base address of SMI stack buffer for all processors.
507 @param StackSize Stack size for each processor in SMM.
508 @param ShadowStackSize Shadow Stack size for each processor in SMM.
512 InitializeMpServiceData (
515 IN UINTN ShadowStackSize
519 Initialize Timer for SMM AP Sync.
528 Start Timer for SMM AP Sync.
538 Check if the SMM AP Sync timer is timeout.
540 @param Timer The start timer from the begin.
550 Initialize IDT for SMM Stack Guard.
555 InitializeIDTSmmStackGuard (
560 Initialize Gdt for all processors.
562 @param[in] Cr3 CR3 value.
563 @param[out] GdtStepSize The step size for GDT table.
565 @return GdtBase for processor 0.
566 GdtBase for processor X is: GdtBase + (GdtStepSize * X)
571 OUT UINTN
*GdtStepSize
576 Register the SMM Foundation entry point.
578 @param This Pointer to EFI_SMM_CONFIGURATION_PROTOCOL instance
579 @param SmmEntryPoint SMM Foundation EntryPoint
581 @retval EFI_SUCCESS Successfully to register SMM foundation entry point
587 IN CONST EFI_SMM_CONFIGURATION_PROTOCOL
*This
,
588 IN EFI_SMM_ENTRY_POINT SmmEntryPoint
592 Create PageTable for SMM use.
594 @return PageTable Address
603 Schedule a procedure to run on the specified CPU.
605 @param Procedure The address of the procedure to run
606 @param CpuIndex Target CPU number
607 @param ProcArguments The parameter to pass to the procedure
609 @retval EFI_INVALID_PARAMETER CpuNumber not valid
610 @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP
611 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not enter SMM
612 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy
613 @retval EFI_SUCCESS - The procedure has been successfully scheduled
619 IN EFI_AP_PROCEDURE Procedure
,
621 IN OUT VOID
*ProcArguments OPTIONAL
625 Schedule a procedure to run on the specified CPU in a blocking fashion.
627 @param Procedure The address of the procedure to run
628 @param CpuIndex Target CPU Index
629 @param ProcArguments The parameter to pass to the procedure
631 @retval EFI_INVALID_PARAMETER CpuNumber not valid
632 @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP
633 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not enter SMM
634 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy
635 @retval EFI_SUCCESS The procedure has been successfully scheduled
640 SmmBlockingStartupThisAp (
641 IN EFI_AP_PROCEDURE Procedure
,
643 IN OUT VOID
*ProcArguments OPTIONAL
647 This function sets the attributes for the memory region specified by BaseAddress and
648 Length from their current attributes to the attributes specified by Attributes.
650 @param[in] BaseAddress The physical address that is the start address of a memory region.
651 @param[in] Length The size in bytes of the memory region.
652 @param[in] Attributes The bit mask of attributes to set for the memory region.
654 @retval EFI_SUCCESS The attributes were set for the memory region.
655 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
656 BaseAddress and Length cannot be modified.
657 @retval EFI_INVALID_PARAMETER Length is zero.
658 Attributes specified an illegal combination of attributes that
659 cannot be set together.
660 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
661 the memory resource range.
662 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
663 resource range specified by BaseAddress and Length.
664 The bit mask of attributes is not support for the memory resource
665 range specified by BaseAddress and Length.
670 SmmSetMemoryAttributes (
671 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
677 This function clears the attributes for the memory region specified by BaseAddress and
678 Length from their current attributes to the attributes specified by Attributes.
680 @param[in] BaseAddress The physical address that is the start address of a memory region.
681 @param[in] Length The size in bytes of the memory region.
682 @param[in] Attributes The bit mask of attributes to clear for the memory region.
684 @retval EFI_SUCCESS The attributes were cleared for the memory region.
685 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
686 BaseAddress and Length cannot be modified.
687 @retval EFI_INVALID_PARAMETER Length is zero.
688 Attributes specified an illegal combination of attributes that
689 cannot be set together.
690 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
691 the memory resource range.
692 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
693 resource range specified by BaseAddress and Length.
694 The bit mask of attributes is not support for the memory resource
695 range specified by BaseAddress and Length.
700 SmmClearMemoryAttributes (
701 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
707 Initialize MP synchronization data.
712 InitializeMpSyncData (
718 Find out SMRAM information including SMRR base and SMRR size.
720 @param SmrrBase SMRR base
721 @param SmrrSize SMRR size
726 OUT UINT32
*SmrrBase
,
731 Relocate SmmBases for each processor.
733 Execute on first boot and all S3 resumes
743 Page Fault handler for SMM use.
745 @param InterruptType Defines the type of interrupt or exception that
746 occurred on the processor.This parameter is processor architecture specific.
747 @param SystemContext A pointer to the processor context when
748 the interrupt occurred on the processor.
753 IN EFI_EXCEPTION_TYPE InterruptType
,
754 IN EFI_SYSTEM_CONTEXT SystemContext
758 Perform the remaining tasks.
762 PerformRemainingTasks (
767 Perform the pre tasks.
776 Initialize MSR spin lock by MSR index.
778 @param MsrIndex MSR index value.
782 InitMsrSpinLockByIndex (
787 Hook return address of SMM Save State so that semaphore code
788 can be executed immediately after AP exits SMM to indicate to
789 the BSP that an AP has exited SMM after SMBASE relocation.
791 @param[in] CpuIndex The processor index.
792 @param[in] RebasedFlag A pointer to a flag that is set to TRUE
793 immediately after AP exits SMM.
799 IN
volatile BOOLEAN
*RebasedFlag
803 Configure SMM Code Access Check feature for all processors.
804 SMM Feature Control MSR will be locked after configuration.
807 ConfigSmmCodeAccessCheck (
812 Hook the code executed immediately after an RSM instruction on the currently
813 executing CPU. The mode of code executed immediately after RSM must be
814 detected, and the appropriate hook must be selected. Always clear the auto
815 HALT restart flag if it is set.
817 @param[in] CpuIndex The processor index for the currently
819 @param[in] CpuState Pointer to SMRAM Save State Map for the
820 currently executing CPU.
821 @param[in] NewInstructionPointer32 Instruction pointer to use if resuming to
822 32-bit mode from 64-bit SMM.
823 @param[in] NewInstructionPointer Instruction pointer to use if resuming to
826 @retval The value of the original instruction pointer before it was hooked.
833 SMRAM_SAVE_STATE_MAP
*CpuState
,
834 UINT64 NewInstructionPointer32
,
835 UINT64 NewInstructionPointer
839 Get the size of the SMI Handler in bytes.
841 @retval The size, in bytes, of the SMI Handler.
851 Install the SMI handler for the CPU specified by CpuIndex. This function
852 is called by the CPU that was elected as monarch during System Management
855 @param[in] CpuIndex The index of the CPU to install the custom SMI handler.
856 The value must be between 0 and the NumberOfCpus field
857 in the System Management System Table (SMST).
858 @param[in] SmBase The SMBASE address for the CPU specified by CpuIndex.
859 @param[in] SmiStack The stack to use when an SMI is processed by the
860 the CPU specified by CpuIndex.
861 @param[in] StackSize The size, in bytes, if the stack used when an SMI is
862 processed by the CPU specified by CpuIndex.
863 @param[in] GdtBase The base address of the GDT to use when an SMI is
864 processed by the CPU specified by CpuIndex.
865 @param[in] GdtSize The size, in bytes, of the GDT used when an SMI is
866 processed by the CPU specified by CpuIndex.
867 @param[in] IdtBase The base address of the IDT to use when an SMI is
868 processed by the CPU specified by CpuIndex.
869 @param[in] IdtSize The size, in bytes, of the IDT used when an SMI is
870 processed by the CPU specified by CpuIndex.
871 @param[in] Cr3 The base address of the page tables to use when an SMI
872 is processed by the CPU specified by CpuIndex.
889 Search module name by input IP address and output it.
891 @param CallerIpAddress Caller instruction pointer.
896 IN UINTN CallerIpAddress
900 This function sets memory attribute according to MemoryAttributesTable.
903 SetMemMapAttributes (
908 This function sets UEFI memory attribute according to UEFI memory map.
911 SetUefiMemMapAttributes (
916 Return if the Address is forbidden as SMM communication buffer.
918 @param[in] Address the address to be checked
920 @return TRUE The address is forbidden as SMM communication buffer.
921 @return FALSE The address is allowed as SMM communication buffer.
924 IsSmmCommBufferForbiddenAddress (
929 This function caches the UEFI memory map information.
937 This function sets memory attribute for page table.
940 SetPageTableAttributes (
945 Return page table base.
947 @return page table base.
955 This function sets the attributes for the memory region specified by BaseAddress and
956 Length from their current attributes to the attributes specified by Attributes.
958 @param[in] BaseAddress The physical address that is the start address of a memory region.
959 @param[in] Length The size in bytes of the memory region.
960 @param[in] Attributes The bit mask of attributes to set for the memory region.
961 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
963 @retval EFI_SUCCESS The attributes were set for the memory region.
964 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
965 BaseAddress and Length cannot be modified.
966 @retval EFI_INVALID_PARAMETER Length is zero.
967 Attributes specified an illegal combination of attributes that
968 cannot be set together.
969 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
970 the memory resource range.
971 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
972 resource range specified by BaseAddress and Length.
973 The bit mask of attributes is not support for the memory resource
974 range specified by BaseAddress and Length.
979 SmmSetMemoryAttributesEx (
980 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
982 IN UINT64 Attributes
,
983 OUT BOOLEAN
*IsSplitted OPTIONAL
987 This function clears the attributes for the memory region specified by BaseAddress and
988 Length from their current attributes to the attributes specified by Attributes.
990 @param[in] BaseAddress The physical address that is the start address of a memory region.
991 @param[in] Length The size in bytes of the memory region.
992 @param[in] Attributes The bit mask of attributes to clear for the memory region.
993 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
995 @retval EFI_SUCCESS The attributes were cleared for the memory region.
996 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
997 BaseAddress and Length cannot be modified.
998 @retval EFI_INVALID_PARAMETER Length is zero.
999 Attributes specified an illegal combination of attributes that
1000 cannot be set together.
1001 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
1002 the memory resource range.
1003 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
1004 resource range specified by BaseAddress and Length.
1005 The bit mask of attributes is not support for the memory resource
1006 range specified by BaseAddress and Length.
1011 SmmClearMemoryAttributesEx (
1012 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1014 IN UINT64 Attributes
,
1015 OUT BOOLEAN
*IsSplitted OPTIONAL
1019 This API provides a way to allocate memory for page table.
1021 This API can be called more once to allocate memory for page tables.
1023 Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
1024 allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
1025 is returned. If there is not enough memory remaining to satisfy the request, then NULL is
1028 @param Pages The number of 4 KB pages to allocate.
1030 @return A pointer to the allocated buffer or NULL if allocation fails.
1034 AllocatePageTableMemory (
1039 Allocate pages for code.
1041 @param[in] Pages Number of pages to be allocated.
1043 @return Allocated memory.
1051 Allocate aligned pages for code.
1053 @param[in] Pages Number of pages to be allocated.
1054 @param[in] Alignment The requested alignment of the allocation.
1055 Must be a power of two.
1056 If Alignment is zero, then byte alignment is used.
1058 @return Allocated memory.
1061 AllocateAlignedCodePages (
1068 // S3 related global variable and function prototype.
1071 extern BOOLEAN mSmmS3Flag
;
1074 Initialize SMM S3 resume state structure used during S3 Resume.
1076 @param[in] Cr3 The base address of the page tables to use in SMM.
1080 InitSmmS3ResumeState (
1094 Restore SMM Configuration in S3 boot path.
1098 RestoreSmmConfigurationInS3 (
1103 Get ACPI S3 enable flag.
1107 GetAcpiS3EnableFlag (
1112 Transfer AP to safe hlt-loop after it finished restore CPU features on S3 patch.
1114 @param[in] ApHltLoopCode The address of the safe hlt-loop function.
1115 @param[in] TopOfStack A pointer to the new stack to use for the ApHltLoopCode.
1116 @param[in] NumberToFinishAddress Address of Semaphore of APs finish count.
1120 TransferApToSafeState (
1121 IN UINTN ApHltLoopCode
,
1122 IN UINTN TopOfStack
,
1123 IN UINTN NumberToFinishAddress
1127 Set ShadowStack memory.
1129 @param[in] Cr3 The page table base address.
1130 @param[in] BaseAddress The physical address that is the start address of a memory region.
1131 @param[in] Length The size in bytes of the memory region.
1133 @retval EFI_SUCCESS The shadow stack memory is set.
1138 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1143 Set not present memory.
1145 @param[in] Cr3 The page table base address.
1146 @param[in] BaseAddress The physical address that is the start address of a memory region.
1147 @param[in] Length The size in bytes of the memory region.
1149 @retval EFI_SUCCESS The not present memory is set.
1154 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1159 Initialize the shadow stack related data structure.
1161 @param CpuIndex The index of CPU.
1162 @param ShadowStack The bottom of the shadow stack for this CPU.
1167 IN VOID
*ShadowStack
1171 This function set given attributes of the memory region specified by
1172 BaseAddress and Length.
1174 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1175 @param BaseAddress The physical address that is the start address of
1177 @param Length The size in bytes of the memory region.
1178 @param Attributes The bit mask of attributes to set for the memory
1181 @retval EFI_SUCCESS The attributes were set for the memory region.
1182 @retval EFI_INVALID_PARAMETER Length is zero.
1183 Attributes specified an illegal combination of
1184 attributes that cannot be set together.
1185 @retval EFI_UNSUPPORTED The processor does not support one or more
1186 bytes of the memory resource range specified
1187 by BaseAddress and Length.
1188 The bit mask of attributes is not supported for
1189 the memory resource range specified by
1190 BaseAddress and Length.
1195 EdkiiSmmSetMemoryAttributes (
1196 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1197 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1199 IN UINT64 Attributes
1203 This function clears given attributes of the memory region specified by
1204 BaseAddress and Length.
1206 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1207 @param BaseAddress The physical address that is the start address of
1209 @param Length The size in bytes of the memory region.
1210 @param Attributes The bit mask of attributes to clear for the memory
1213 @retval EFI_SUCCESS The attributes were cleared for the memory region.
1214 @retval EFI_INVALID_PARAMETER Length is zero.
1215 Attributes specified an illegal combination of
1216 attributes that cannot be cleared together.
1217 @retval EFI_UNSUPPORTED The processor does not support one or more
1218 bytes of the memory resource range specified
1219 by BaseAddress and Length.
1220 The bit mask of attributes is not supported for
1221 the memory resource range specified by
1222 BaseAddress and Length.
1227 EdkiiSmmClearMemoryAttributes (
1228 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1229 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1231 IN UINT64 Attributes
1235 This function retrieves the attributes of the memory region specified by
1236 BaseAddress and Length. If different attributes are got from different part
1237 of the memory region, EFI_NO_MAPPING will be returned.
1239 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1240 @param BaseAddress The physical address that is the start address of
1242 @param Length The size in bytes of the memory region.
1243 @param Attributes Pointer to attributes returned.
1245 @retval EFI_SUCCESS The attributes got for the memory region.
1246 @retval EFI_INVALID_PARAMETER Length is zero.
1248 @retval EFI_NO_MAPPING Attributes are not consistent cross the memory
1250 @retval EFI_UNSUPPORTED The processor does not support one or more
1251 bytes of the memory resource range specified
1252 by BaseAddress and Length.
1257 EdkiiSmmGetMemoryAttributes (
1258 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1259 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1261 IN UINT64
*Attributes
1265 This function fixes up the address of the global variable or function
1266 referred in SmmInit assembly files to be the absolute address.
1270 PiSmmCpuSmmInitFixupAddress (
1274 This function fixes up the address of the global variable or function
1275 referred in SmiEntry assembly files to be the absolute address.
1279 PiSmmCpuSmiEntryFixupAddress (
1283 This function reads CR2 register when on-demand paging is enabled
1284 for 64 bit and no action for 32 bit.
1286 @param[out] *Cr2 Pointer to variable to hold CR2 register value.
1294 This function writes into CR2 register when on-demand paging is enabled
1295 for 64 bit and no action for 32 bit.
1297 @param[in] Cr2 Value to write into CR2 register.
1305 Schedule a procedure to run on the specified CPU.
1307 @param[in] Procedure The address of the procedure to run
1308 @param[in] CpuIndex Target CPU Index
1309 @param[in,out] ProcArguments The parameter to pass to the procedure
1310 @param[in,out] Token This is an optional parameter that allows the caller to execute the
1311 procedure in a blocking or non-blocking fashion. If it is NULL the
1312 call is blocking, and the call will not return until the AP has
1313 completed the procedure. If the token is not NULL, the call will
1314 return immediately. The caller can check whether the procedure has
1315 completed with CheckOnProcedure or WaitForProcedure.
1316 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for the APs to finish
1317 execution of Procedure, either for blocking or non-blocking mode.
1318 Zero means infinity. If the timeout expires before all APs return
1319 from Procedure, then Procedure on the failed APs is terminated. If
1320 the timeout expires in blocking mode, the call returns EFI_TIMEOUT.
1321 If the timeout expires in non-blocking mode, the timeout determined
1322 can be through CheckOnProcedure or WaitForProcedure.
1323 Note that timeout support is optional. Whether an implementation
1324 supports this feature can be determined via the Attributes data
1326 @param[in,out] CpuStatus This optional pointer may be used to get the status code returned
1327 by Procedure when it completes execution on the target AP, or with
1328 EFI_TIMEOUT if the Procedure fails to complete within the optional
1329 timeout. The implementation will update this variable with
1330 EFI_NOT_READY prior to starting Procedure on the target AP.
1332 @retval EFI_INVALID_PARAMETER CpuNumber not valid
1333 @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP
1334 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not enter SMM
1335 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy
1336 @retval EFI_SUCCESS The procedure has been successfully scheduled
1340 InternalSmmStartupThisAp (
1341 IN EFI_AP_PROCEDURE2 Procedure
,
1343 IN OUT VOID
*ProcArguments OPTIONAL
,
1344 IN OUT MM_COMPLETION
*Token
,
1345 IN UINTN TimeoutInMicroseconds
,
1346 IN OUT EFI_STATUS
*CpuStatus
1350 Checks whether the input token is the current used token.
1352 @param[in] Token This parameter describes the token that was passed into DispatchProcedure or
1355 @retval TRUE The input token is the current used token.
1356 @retval FALSE The input token is not the current used token.
1364 Checks status of specified AP.
1366 This function checks whether the specified AP has finished the task assigned
1367 by StartupThisAP(), and whether timeout expires.
1369 @param[in] Token This parameter describes the token that was passed into DispatchProcedure or
1372 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
1373 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
1381 Check whether it is an present AP.
1383 @param CpuIndex The AP index which calls this function.
1385 @retval TRUE It's a present AP.
1386 @retval TRUE This is not an AP or it is not present.
1395 Worker function to execute a caller provided function on all enabled APs.
1397 @param[in] Procedure A pointer to the function to be run on
1398 enabled APs of the system.
1399 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
1400 APs to return from Procedure, either for
1401 blocking or non-blocking mode.
1402 @param[in,out] ProcedureArguments The parameter passed into Procedure for
1404 @param[in,out] Token This is an optional parameter that allows the caller to execute the
1405 procedure in a blocking or non-blocking fashion. If it is NULL the
1406 call is blocking, and the call will not return until the AP has
1407 completed the procedure. If the token is not NULL, the call will
1408 return immediately. The caller can check whether the procedure has
1409 completed with CheckOnProcedure or WaitForProcedure.
1410 @param[in,out] CPUStatus This optional pointer may be used to get the status code returned
1411 by Procedure when it completes execution on the target AP, or with
1412 EFI_TIMEOUT if the Procedure fails to complete within the optional
1413 timeout. The implementation will update this variable with
1414 EFI_NOT_READY prior to starting Procedure on the target AP.
1416 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1417 the timeout expired.
1418 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1420 @retval others Failed to Startup all APs.
1424 InternalSmmStartupAllAPs (
1425 IN EFI_AP_PROCEDURE2 Procedure
,
1426 IN UINTN TimeoutInMicroseconds
,
1427 IN OUT VOID
*ProcedureArguments OPTIONAL
,
1428 IN OUT MM_COMPLETION
*Token
,
1429 IN OUT EFI_STATUS
*CPUStatus
1434 Register the SMM Foundation entry point.
1436 @param[in] Procedure A pointer to the code stream to be run on the designated target AP
1437 of the system. Type EFI_AP_PROCEDURE is defined below in Volume 2
1438 with the related definitions of
1439 EFI_MP_SERVICES_PROTOCOL.StartupAllAPs.
1440 If caller may pass a value of NULL to deregister any existing
1442 @param[in,out] ProcedureArguments Allows the caller to pass a list of parameters to the code that is
1443 run by the AP. It is an optional common mailbox between APs and
1444 the caller to share information
1446 @retval EFI_SUCCESS The Procedure has been set successfully.
1447 @retval EFI_INVALID_PARAMETER The Procedure is NULL but ProcedureArguments not NULL.
1451 RegisterStartupProcedure (
1452 IN EFI_AP_PROCEDURE Procedure
,
1453 IN OUT VOID
*ProcedureArguments OPTIONAL
1457 Allocate buffer for SpinLock and Wrapper function buffer.
1461 InitializeDataForMmMp (
1466 Return whether access to non-SMRAM is restricted.
1468 @retval TRUE Access to non-SMRAM is restricted.
1469 @retval FALSE Access to non-SMRAM is not restricted.
1472 IsRestrictedMemoryAccess (