2 Agent Module to load other modules to deploy SMM Entry Vector for X86 CPU.
4 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
5 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 #ifndef _CPU_PISMMCPUDXESMM_H_
18 #define _CPU_PISMMCPUDXESMM_H_
22 #include <Protocol/MpService.h>
23 #include <Protocol/SmmConfiguration.h>
24 #include <Protocol/SmmCpu.h>
25 #include <Protocol/SmmAccess2.h>
26 #include <Protocol/SmmReadyToLock.h>
27 #include <Protocol/SmmCpuService.h>
28 #include <Protocol/SmmMemoryAttribute.h>
30 #include <Guid/AcpiS3Context.h>
31 #include <Guid/PiSmmMemoryAttributesTable.h>
33 #include <Library/BaseLib.h>
34 #include <Library/IoLib.h>
35 #include <Library/TimerLib.h>
36 #include <Library/SynchronizationLib.h>
37 #include <Library/DebugLib.h>
38 #include <Library/BaseMemoryLib.h>
39 #include <Library/PcdLib.h>
40 #include <Library/CacheMaintenanceLib.h>
41 #include <Library/MtrrLib.h>
42 #include <Library/SmmCpuPlatformHookLib.h>
43 #include <Library/SmmServicesTableLib.h>
44 #include <Library/MemoryAllocationLib.h>
45 #include <Library/UefiBootServicesTableLib.h>
46 #include <Library/UefiRuntimeServicesTableLib.h>
47 #include <Library/DebugAgentLib.h>
48 #include <Library/HobLib.h>
49 #include <Library/LocalApicLib.h>
50 #include <Library/UefiCpuLib.h>
51 #include <Library/CpuExceptionHandlerLib.h>
52 #include <Library/ReportStatusCodeLib.h>
53 #include <Library/SmmCpuFeaturesLib.h>
54 #include <Library/PeCoffGetEntryPointLib.h>
56 #include <AcpiCpuData.h>
57 #include <CpuHotPlugData.h>
59 #include <Register/Cpuid.h>
60 #include <Register/Msr.h>
62 #include "CpuService.h"
63 #include "SmmProfile.h"
66 // MSRs required for configuration of SMM Code Access Check
68 #define EFI_MSR_SMM_MCA_CAP 0x17D
69 #define SMM_CODE_ACCESS_CHK_BIT BIT58
71 #define SMM_FEATURE_CONTROL_LOCK_BIT BIT0
72 #define SMM_CODE_CHK_EN_BIT BIT2
77 #define IA32_PG_P BIT0
78 #define IA32_PG_RW BIT1
79 #define IA32_PG_U BIT2
80 #define IA32_PG_WT BIT3
81 #define IA32_PG_CD BIT4
82 #define IA32_PG_A BIT5
83 #define IA32_PG_D BIT6
84 #define IA32_PG_PS BIT7
85 #define IA32_PG_PAT_2M BIT12
86 #define IA32_PG_PAT_4K IA32_PG_PS
87 #define IA32_PG_PMNT BIT62
88 #define IA32_PG_NX BIT63
90 #define PAGE_ATTRIBUTE_BITS (IA32_PG_D | IA32_PG_A | IA32_PG_U | IA32_PG_RW | IA32_PG_P)
92 // Bits 1, 2, 5, 6 are reserved in the IA32 PAE PDPTE
93 // X64 PAE PDPTE does not have such restriction
95 #define IA32_PAE_PDPTE_ATTRIBUTE_BITS (IA32_PG_P)
97 #define PAGE_PROGATE_BITS (IA32_PG_NX | PAGE_ATTRIBUTE_BITS)
99 #define PAGING_4K_MASK 0xFFF
100 #define PAGING_2M_MASK 0x1FFFFF
101 #define PAGING_1G_MASK 0x3FFFFFFF
103 #define PAGING_PAE_INDEX_MASK 0x1FF
105 #define PAGING_4K_ADDRESS_MASK_64 0x000FFFFFFFFFF000ull
106 #define PAGING_2M_ADDRESS_MASK_64 0x000FFFFFFFE00000ull
107 #define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull
109 #define SMRR_MAX_ADDRESS BASE_4GB
119 PAGE_ATTRIBUTE Attribute
;
122 } PAGE_ATTRIBUTE_TABLE
;
125 // Size of Task-State Segment defined in IA32 Manual
128 #define TSS_X64_IST1_OFFSET 36
129 #define TSS_IA32_CR3_OFFSET 28
130 #define TSS_IA32_ESP_OFFSET 56
137 #define PROTECT_MODE_CODE_SEGMENT 0x08
138 #define LONG_MODE_CODE_SEGMENT 0x38
141 // The size 0x20 must be bigger than
142 // the size of template code of SmmInit. Currently,
143 // the size of SmmInit requires the 0x16 Bytes buffer
146 #define BACK_BUF_SIZE 0x20
148 #define EXCEPTION_VECTOR_NUMBER 0x20
150 #define INVALID_APIC_ID 0xFFFFFFFFFFFFFFFFULL
152 typedef UINT32 SMM_CPU_ARRIVAL_EXCEPTIONS
;
153 #define ARRIVAL_EXCEPTION_BLOCKED 0x1
154 #define ARRIVAL_EXCEPTION_DELAYED 0x2
155 #define ARRIVAL_EXCEPTION_SMI_DISABLED 0x4
158 // Private structure for the SMM CPU module that is stored in DXE Runtime memory
159 // Contains the SMM Configuration Protocols that is produced.
160 // Contains a mix of DXE and SMM contents. All the fields must be used properly.
162 #define SMM_CPU_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('s', 'c', 'p', 'u')
167 EFI_HANDLE SmmCpuHandle
;
169 EFI_PROCESSOR_INFORMATION
*ProcessorInfo
;
170 SMM_CPU_OPERATION
*Operation
;
171 UINTN
*CpuSaveStateSize
;
174 EFI_SMM_RESERVED_SMRAM_REGION SmmReservedSmramRegion
[1];
175 EFI_SMM_ENTRY_CONTEXT SmmCoreEntryContext
;
176 EFI_SMM_ENTRY_POINT SmmCoreEntry
;
178 EFI_SMM_CONFIGURATION_PROTOCOL SmmConfiguration
;
179 } SMM_CPU_PRIVATE_DATA
;
181 extern SMM_CPU_PRIVATE_DATA
*gSmmCpuPrivate
;
182 extern CPU_HOT_PLUG_DATA mCpuHotPlugData
;
183 extern UINTN mMaxNumberOfCpus
;
184 extern UINTN mNumberOfCpus
;
185 extern EFI_SMM_CPU_PROTOCOL mSmmCpu
;
188 /// The mode of the CPU at the time an SMI occurs
190 extern UINT8 mSmmSaveStateRegisterLma
;
193 // SMM CPU Protocol function prototypes.
197 Read information from the CPU save state.
199 @param This EFI_SMM_CPU_PROTOCOL instance
200 @param Width The number of bytes to read from the CPU save state.
201 @param Register Specifies the CPU register to read form the save state.
202 @param CpuIndex Specifies the zero-based index of the CPU save state
203 @param Buffer Upon return, this holds the CPU register value read from the save state.
205 @retval EFI_SUCCESS The register was read from Save State
206 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
207 @retval EFI_INVALID_PARAMTER This or Buffer is NULL.
213 IN CONST EFI_SMM_CPU_PROTOCOL
*This
,
215 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
221 Write data to the CPU save state.
223 @param This EFI_SMM_CPU_PROTOCOL instance
224 @param Width The number of bytes to read from the CPU save state.
225 @param Register Specifies the CPU register to write to the save state.
226 @param CpuIndex Specifies the zero-based index of the CPU save state
227 @param Buffer Upon entry, this holds the new CPU register value.
229 @retval EFI_SUCCESS The register was written from Save State
230 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
231 @retval EFI_INVALID_PARAMTER ProcessorIndex or Width is not correct
237 IN CONST EFI_SMM_CPU_PROTOCOL
*This
,
239 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
241 IN CONST VOID
*Buffer
245 Read a CPU Save State register on the target processor.
247 This function abstracts the differences that whether the CPU Save State register is in the
248 IA32 CPU Save State Map or X64 CPU Save State Map.
250 This function supports reading a CPU Save State register in SMBase relocation handler.
252 @param[in] CpuIndex Specifies the zero-based index of the CPU save state.
253 @param[in] RegisterIndex Index into mSmmCpuWidthOffset[] look up table.
254 @param[in] Width The number of bytes to read from the CPU save state.
255 @param[out] Buffer Upon return, this holds the CPU register value read from the save state.
257 @retval EFI_SUCCESS The register was read from Save State.
258 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor.
259 @retval EFI_INVALID_PARAMTER This or Buffer is NULL.
264 ReadSaveStateRegister (
266 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
272 Write value to a CPU Save State register on the target processor.
274 This function abstracts the differences that whether the CPU Save State register is in the
275 IA32 CPU Save State Map or X64 CPU Save State Map.
277 This function supports writing a CPU Save State register in SMBase relocation handler.
279 @param[in] CpuIndex Specifies the zero-based index of the CPU save state.
280 @param[in] RegisterIndex Index into mSmmCpuWidthOffset[] look up table.
281 @param[in] Width The number of bytes to read from the CPU save state.
282 @param[in] Buffer Upon entry, this holds the new CPU register value.
284 @retval EFI_SUCCESS The register was written to Save State.
285 @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor.
286 @retval EFI_INVALID_PARAMTER ProcessorIndex or Width is not correct.
291 WriteSaveStateRegister (
293 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
295 IN CONST VOID
*Buffer
307 extern IA32_FAR_ADDRESS gSmmJmpAddr
;
309 extern CONST UINT8 gcSmmInitTemplate
[];
310 extern CONST UINT16 gcSmmInitSize
;
311 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr0
;
312 extern UINT32 mSmmCr0
;
313 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr3
;
314 extern UINT32 mSmmCr4
;
315 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr4
;
316 extern UINTN gSmmInitStack
;
319 Semaphore operation for all processor relocate SMMBase.
323 SmmRelocationSemaphoreComplete (
328 /// The type of SMM CPU Information
332 volatile EFI_AP_PROCEDURE Procedure
;
333 volatile VOID
*Parameter
;
334 volatile UINT32
*Run
;
335 volatile BOOLEAN
*Present
;
336 } SMM_CPU_DATA_BLOCK
;
339 SmmCpuSyncModeTradition
,
340 SmmCpuSyncModeRelaxedAp
,
346 // Pointer to an array. The array should be located immediately after this structure
347 // so that UC cache-ability can be set together.
349 SMM_CPU_DATA_BLOCK
*CpuData
;
350 volatile UINT32
*Counter
;
351 volatile UINT32 BspIndex
;
352 volatile BOOLEAN
*InsideSmm
;
353 volatile BOOLEAN
*AllCpusInSync
;
354 volatile SMM_CPU_SYNC_MODE EffectiveSyncMode
;
355 volatile BOOLEAN SwitchBsp
;
356 volatile BOOLEAN
*CandidateBsp
;
357 } SMM_DISPATCHER_MP_SYNC_DATA
;
359 #define MSR_SPIN_LOCK_INIT_NUM 15
366 #define SMM_PSD_OFFSET 0xfb00
369 /// All global semaphores' pointer
372 volatile UINT32
*Counter
;
373 volatile BOOLEAN
*InsideSmm
;
374 volatile BOOLEAN
*AllCpusInSync
;
376 SPIN_LOCK
*CodeAccessCheckLock
;
377 SPIN_LOCK
*MemoryMappedLock
;
378 } SMM_CPU_SEMAPHORE_GLOBAL
;
381 /// All semaphores for each processor
385 volatile UINT32
*Run
;
386 volatile BOOLEAN
*Present
;
387 } SMM_CPU_SEMAPHORE_CPU
;
390 /// All MSRs semaphores' pointer and counter
394 UINTN AvailableCounter
;
395 } SMM_CPU_SEMAPHORE_MSR
;
398 /// All semaphores' information
401 SMM_CPU_SEMAPHORE_GLOBAL SemaphoreGlobal
;
402 SMM_CPU_SEMAPHORE_CPU SemaphoreCpu
;
403 SMM_CPU_SEMAPHORE_MSR SemaphoreMsr
;
404 } SMM_CPU_SEMAPHORES
;
406 extern IA32_DESCRIPTOR gcSmiGdtr
;
407 extern EFI_PHYSICAL_ADDRESS mGdtBuffer
;
408 extern UINTN mGdtBufferSize
;
409 extern IA32_DESCRIPTOR gcSmiIdtr
;
410 extern VOID
*gcSmiIdtrPtr
;
411 extern UINT64 gPhyMask
;
412 extern SMM_DISPATCHER_MP_SYNC_DATA
*mSmmMpSyncData
;
413 extern UINTN mSmmStackArrayBase
;
414 extern UINTN mSmmStackArrayEnd
;
415 extern UINTN mSmmStackSize
;
416 extern EFI_SMM_CPU_SERVICE_PROTOCOL mSmmCpuService
;
417 extern IA32_DESCRIPTOR gcSmiInitGdtr
;
418 extern SMM_CPU_SEMAPHORES mSmmCpuSemaphores
;
419 extern UINTN mSemaphoreSize
;
420 extern SPIN_LOCK
*mPFLock
;
421 extern SPIN_LOCK
*mConfigSmmCodeAccessCheckLock
;
422 extern SPIN_LOCK
*mMemoryMappedLock
;
423 extern EFI_SMRAM_DESCRIPTOR
*mSmmCpuSmramRanges
;
424 extern UINTN mSmmCpuSmramRangeCount
;
425 extern UINT8 mPhysicalAddressBits
;
428 // Copy of the PcdPteMemoryEncryptionAddressOrMask
430 extern UINT64 mAddressEncMask
;
433 Create 4G PageTable in SMRAM.
435 @param[in] Is32BitPageTable Whether the page table is 32-bit PAE
436 @return PageTable Address
441 IN BOOLEAN Is32BitPageTable
446 Initialize global data for MP synchronization.
448 @param Stacks Base address of SMI stack buffer for all processors.
449 @param StackSize Stack size for each processor in SMM.
453 InitializeMpServiceData (
459 Initialize Timer for SMM AP Sync.
468 Start Timer for SMM AP Sync.
478 Check if the SMM AP Sync timer is timeout.
480 @param Timer The start timer from the begin.
490 Initialize IDT for SMM Stack Guard.
495 InitializeIDTSmmStackGuard (
500 Initialize Gdt for all processors.
502 @param[in] Cr3 CR3 value.
503 @param[out] GdtStepSize The step size for GDT table.
505 @return GdtBase for processor 0.
506 GdtBase for processor X is: GdtBase + (GdtStepSize * X)
511 OUT UINTN
*GdtStepSize
516 Register the SMM Foundation entry point.
518 @param This Pointer to EFI_SMM_CONFIGURATION_PROTOCOL instance
519 @param SmmEntryPoint SMM Foundation EntryPoint
521 @retval EFI_SUCCESS Successfully to register SMM foundation entry point
527 IN CONST EFI_SMM_CONFIGURATION_PROTOCOL
*This
,
528 IN EFI_SMM_ENTRY_POINT SmmEntryPoint
532 Create PageTable for SMM use.
534 @return PageTable Address
543 Schedule a procedure to run on the specified CPU.
545 @param Procedure The address of the procedure to run
546 @param CpuIndex Target CPU number
547 @param ProcArguments The parameter to pass to the procedure
549 @retval EFI_INVALID_PARAMETER CpuNumber not valid
550 @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP
551 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not enter SMM
552 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy
553 @retval EFI_SUCCESS - The procedure has been successfully scheduled
559 IN EFI_AP_PROCEDURE Procedure
,
561 IN OUT VOID
*ProcArguments OPTIONAL
565 Schedule a procedure to run on the specified CPU in a blocking fashion.
567 @param Procedure The address of the procedure to run
568 @param CpuIndex Target CPU Index
569 @param ProcArguments The parameter to pass to the procedure
571 @retval EFI_INVALID_PARAMETER CpuNumber not valid
572 @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP
573 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not enter SMM
574 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy
575 @retval EFI_SUCCESS The procedure has been successfully scheduled
580 SmmBlockingStartupThisAp (
581 IN EFI_AP_PROCEDURE Procedure
,
583 IN OUT VOID
*ProcArguments OPTIONAL
587 This function sets the attributes for the memory region specified by BaseAddress and
588 Length from their current attributes to the attributes specified by Attributes.
590 @param[in] BaseAddress The physical address that is the start address of a memory region.
591 @param[in] Length The size in bytes of the memory region.
592 @param[in] Attributes The bit mask of attributes to set for the memory region.
594 @retval EFI_SUCCESS The attributes were set for the memory region.
595 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
596 BaseAddress and Length cannot be modified.
597 @retval EFI_INVALID_PARAMETER Length is zero.
598 Attributes specified an illegal combination of attributes that
599 cannot be set together.
600 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
601 the memory resource range.
602 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
603 resource range specified by BaseAddress and Length.
604 The bit mask of attributes is not support for the memory resource
605 range specified by BaseAddress and Length.
610 SmmSetMemoryAttributes (
611 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
617 This function clears the attributes for the memory region specified by BaseAddress and
618 Length from their current attributes to the attributes specified by Attributes.
620 @param[in] BaseAddress The physical address that is the start address of a memory region.
621 @param[in] Length The size in bytes of the memory region.
622 @param[in] Attributes The bit mask of attributes to clear for the memory region.
624 @retval EFI_SUCCESS The attributes were cleared for the memory region.
625 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
626 BaseAddress and Length cannot be modified.
627 @retval EFI_INVALID_PARAMETER Length is zero.
628 Attributes specified an illegal combination of attributes that
629 cannot be set together.
630 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
631 the memory resource range.
632 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
633 resource range specified by BaseAddress and Length.
634 The bit mask of attributes is not support for the memory resource
635 range specified by BaseAddress and Length.
640 SmmClearMemoryAttributes (
641 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
647 Initialize MP synchronization data.
652 InitializeMpSyncData (
658 Find out SMRAM information including SMRR base and SMRR size.
660 @param SmrrBase SMRR base
661 @param SmrrSize SMRR size
666 OUT UINT32
*SmrrBase
,
671 Relocate SmmBases for each processor.
673 Execute on first boot and all S3 resumes
683 Page Fault handler for SMM use.
685 @param InterruptType Defines the type of interrupt or exception that
686 occurred on the processor.This parameter is processor architecture specific.
687 @param SystemContext A pointer to the processor context when
688 the interrupt occurred on the processor.
693 IN EFI_EXCEPTION_TYPE InterruptType
,
694 IN EFI_SYSTEM_CONTEXT SystemContext
698 Perform the remaining tasks.
702 PerformRemainingTasks (
707 Perform the pre tasks.
716 Initialize MSR spin lock by MSR index.
718 @param MsrIndex MSR index value.
722 InitMsrSpinLockByIndex (
727 Hook return address of SMM Save State so that semaphore code
728 can be executed immediately after AP exits SMM to indicate to
729 the BSP that an AP has exited SMM after SMBASE relocation.
731 @param[in] CpuIndex The processor index.
732 @param[in] RebasedFlag A pointer to a flag that is set to TRUE
733 immediately after AP exits SMM.
739 IN
volatile BOOLEAN
*RebasedFlag
743 Configure SMM Code Access Check feature for all processors.
744 SMM Feature Control MSR will be locked after configuration.
747 ConfigSmmCodeAccessCheck (
752 Hook the code executed immediately after an RSM instruction on the currently
753 executing CPU. The mode of code executed immediately after RSM must be
754 detected, and the appropriate hook must be selected. Always clear the auto
755 HALT restart flag if it is set.
757 @param[in] CpuIndex The processor index for the currently
759 @param[in] CpuState Pointer to SMRAM Save State Map for the
760 currently executing CPU.
761 @param[in] NewInstructionPointer32 Instruction pointer to use if resuming to
762 32-bit mode from 64-bit SMM.
763 @param[in] NewInstructionPointer Instruction pointer to use if resuming to
766 @retval The value of the original instruction pointer before it was hooked.
773 SMRAM_SAVE_STATE_MAP
*CpuState
,
774 UINT64 NewInstructionPointer32
,
775 UINT64 NewInstructionPointer
779 Get the size of the SMI Handler in bytes.
781 @retval The size, in bytes, of the SMI Handler.
791 Install the SMI handler for the CPU specified by CpuIndex. This function
792 is called by the CPU that was elected as monarch during System Management
795 @param[in] CpuIndex The index of the CPU to install the custom SMI handler.
796 The value must be between 0 and the NumberOfCpus field
797 in the System Management System Table (SMST).
798 @param[in] SmBase The SMBASE address for the CPU specified by CpuIndex.
799 @param[in] SmiStack The stack to use when an SMI is processed by the
800 the CPU specified by CpuIndex.
801 @param[in] StackSize The size, in bytes, if the stack used when an SMI is
802 processed by the CPU specified by CpuIndex.
803 @param[in] GdtBase The base address of the GDT to use when an SMI is
804 processed by the CPU specified by CpuIndex.
805 @param[in] GdtSize The size, in bytes, of the GDT used when an SMI is
806 processed by the CPU specified by CpuIndex.
807 @param[in] IdtBase The base address of the IDT to use when an SMI is
808 processed by the CPU specified by CpuIndex.
809 @param[in] IdtSize The size, in bytes, of the IDT used when an SMI is
810 processed by the CPU specified by CpuIndex.
811 @param[in] Cr3 The base address of the page tables to use when an SMI
812 is processed by the CPU specified by CpuIndex.
829 Search module name by input IP address and output it.
831 @param CallerIpAddress Caller instruction pointer.
836 IN UINTN CallerIpAddress
840 This function sets memory attribute according to MemoryAttributesTable.
843 SetMemMapAttributes (
848 This function sets UEFI memory attribute according to UEFI memory map.
851 SetUefiMemMapAttributes (
856 Return if the Address is forbidden as SMM communication buffer.
858 @param[in] Address the address to be checked
860 @return TRUE The address is forbidden as SMM communication buffer.
861 @return FALSE The address is allowed as SMM communication buffer.
864 IsSmmCommBufferForbiddenAddress (
869 This function caches the UEFI memory map information.
877 This function sets memory attribute for page table.
880 SetPageTableAttributes (
885 Return page table base.
887 @return page table base.
895 This function sets the attributes for the memory region specified by BaseAddress and
896 Length from their current attributes to the attributes specified by Attributes.
898 @param[in] BaseAddress The physical address that is the start address of a memory region.
899 @param[in] Length The size in bytes of the memory region.
900 @param[in] Attributes The bit mask of attributes to set for the memory region.
901 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
903 @retval EFI_SUCCESS The attributes were set for the memory region.
904 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
905 BaseAddress and Length cannot be modified.
906 @retval EFI_INVALID_PARAMETER Length is zero.
907 Attributes specified an illegal combination of attributes that
908 cannot be set together.
909 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
910 the memory resource range.
911 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
912 resource range specified by BaseAddress and Length.
913 The bit mask of attributes is not support for the memory resource
914 range specified by BaseAddress and Length.
919 SmmSetMemoryAttributesEx (
920 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
922 IN UINT64 Attributes
,
923 OUT BOOLEAN
*IsSplitted OPTIONAL
927 This function clears the attributes for the memory region specified by BaseAddress and
928 Length from their current attributes to the attributes specified by Attributes.
930 @param[in] BaseAddress The physical address that is the start address of a memory region.
931 @param[in] Length The size in bytes of the memory region.
932 @param[in] Attributes The bit mask of attributes to clear for the memory region.
933 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
935 @retval EFI_SUCCESS The attributes were cleared for the memory region.
936 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
937 BaseAddress and Length cannot be modified.
938 @retval EFI_INVALID_PARAMETER Length is zero.
939 Attributes specified an illegal combination of attributes that
940 cannot be set together.
941 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
942 the memory resource range.
943 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
944 resource range specified by BaseAddress and Length.
945 The bit mask of attributes is not support for the memory resource
946 range specified by BaseAddress and Length.
951 SmmClearMemoryAttributesEx (
952 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
954 IN UINT64 Attributes
,
955 OUT BOOLEAN
*IsSplitted OPTIONAL
959 This API provides a way to allocate memory for page table.
961 This API can be called more once to allocate memory for page tables.
963 Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
964 allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
965 is returned. If there is not enough memory remaining to satisfy the request, then NULL is
968 @param Pages The number of 4 KB pages to allocate.
970 @return A pointer to the allocated buffer or NULL if allocation fails.
974 AllocatePageTableMemory (
979 Allocate pages for code.
981 @param[in] Pages Number of pages to be allocated.
983 @return Allocated memory.
991 Allocate aligned pages for code.
993 @param[in] Pages Number of pages to be allocated.
994 @param[in] Alignment The requested alignment of the allocation.
995 Must be a power of two.
996 If Alignment is zero, then byte alignment is used.
998 @return Allocated memory.
1001 AllocateAlignedCodePages (
1008 // S3 related global variable and function prototype.
1011 extern BOOLEAN mSmmS3Flag
;
1014 Initialize SMM S3 resume state structure used during S3 Resume.
1016 @param[in] Cr3 The base address of the page tables to use in SMM.
1020 InitSmmS3ResumeState (
1034 Restore SMM Configuration in S3 boot path.
1038 RestoreSmmConfigurationInS3 (
1043 Get ACPI S3 enable flag.
1047 GetAcpiS3EnableFlag (
1052 Transfer AP to safe hlt-loop after it finished restore CPU features on S3 patch.
1054 @param[in] ApHltLoopCode The address of the safe hlt-loop function.
1055 @param[in] TopOfStack A pointer to the new stack to use for the ApHltLoopCode.
1056 @param[in] NumberToFinishAddress Address of Semaphore of APs finish count.
1060 TransferApToSafeState (
1061 IN UINTN ApHltLoopCode
,
1062 IN UINTN TopOfStack
,
1063 IN UINTN NumberToFinishAddress
1067 This function set given attributes of the memory region specified by
1068 BaseAddress and Length.
1070 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1071 @param BaseAddress The physical address that is the start address of
1073 @param Length The size in bytes of the memory region.
1074 @param Attributes The bit mask of attributes to set for the memory
1077 @retval EFI_SUCCESS The attributes were set for the memory region.
1078 @retval EFI_INVALID_PARAMETER Length is zero.
1079 Attributes specified an illegal combination of
1080 attributes that cannot be set together.
1081 @retval EFI_UNSUPPORTED The processor does not support one or more
1082 bytes of the memory resource range specified
1083 by BaseAddress and Length.
1084 The bit mask of attributes is not supported for
1085 the memory resource range specified by
1086 BaseAddress and Length.
1091 EdkiiSmmSetMemoryAttributes (
1092 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1093 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1095 IN UINT64 Attributes
1099 This function clears given attributes of the memory region specified by
1100 BaseAddress and Length.
1102 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1103 @param BaseAddress The physical address that is the start address of
1105 @param Length The size in bytes of the memory region.
1106 @param Attributes The bit mask of attributes to clear for the memory
1109 @retval EFI_SUCCESS The attributes were cleared for the memory region.
1110 @retval EFI_INVALID_PARAMETER Length is zero.
1111 Attributes specified an illegal combination of
1112 attributes that cannot be cleared together.
1113 @retval EFI_UNSUPPORTED The processor does not support one or more
1114 bytes of the memory resource range specified
1115 by BaseAddress and Length.
1116 The bit mask of attributes is not supported for
1117 the memory resource range specified by
1118 BaseAddress and Length.
1123 EdkiiSmmClearMemoryAttributes (
1124 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1125 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1127 IN UINT64 Attributes
1131 This function retrieves the attributes of the memory region specified by
1132 BaseAddress and Length. If different attributes are got from different part
1133 of the memory region, EFI_NO_MAPPING will be returned.
1135 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1136 @param BaseAddress The physical address that is the start address of
1138 @param Length The size in bytes of the memory region.
1139 @param Attributes Pointer to attributes returned.
1141 @retval EFI_SUCCESS The attributes got for the memory region.
1142 @retval EFI_INVALID_PARAMETER Length is zero.
1144 @retval EFI_NO_MAPPING Attributes are not consistent cross the memory
1146 @retval EFI_UNSUPPORTED The processor does not support one or more
1147 bytes of the memory resource range specified
1148 by BaseAddress and Length.
1153 EdkiiSmmGetMemoryAttributes (
1154 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1155 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1157 IN UINT64
*Attributes
1161 This function fixes up the address of the global variable or function
1162 referred in SmmInit assembly files to be the absoute address.
1166 PiSmmCpuSmmInitFixupAddress (
1170 This function fixes up the address of the global variable or function
1171 referred in SmiEntry assembly files to be the absoute address.
1175 PiSmmCpuSmiEntryFixupAddress (