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
298 extern CONST UINT8 gcSmmInitTemplate
[];
299 extern CONST UINT16 gcSmmInitSize
;
300 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr0
;
301 extern UINT32 mSmmCr0
;
302 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr3
;
303 extern UINT32 mSmmCr4
;
304 X86_ASSEMBLY_PATCH_LABEL gPatchSmmCr4
;
305 X86_ASSEMBLY_PATCH_LABEL gPatchSmmInitStack
;
308 Semaphore operation for all processor relocate SMMBase.
312 SmmRelocationSemaphoreComplete (
317 /// The type of SMM CPU Information
321 volatile EFI_AP_PROCEDURE Procedure
;
322 volatile VOID
*Parameter
;
323 volatile UINT32
*Run
;
324 volatile BOOLEAN
*Present
;
325 } SMM_CPU_DATA_BLOCK
;
328 SmmCpuSyncModeTradition
,
329 SmmCpuSyncModeRelaxedAp
,
335 // Pointer to an array. The array should be located immediately after this structure
336 // so that UC cache-ability can be set together.
338 SMM_CPU_DATA_BLOCK
*CpuData
;
339 volatile UINT32
*Counter
;
340 volatile UINT32 BspIndex
;
341 volatile BOOLEAN
*InsideSmm
;
342 volatile BOOLEAN
*AllCpusInSync
;
343 volatile SMM_CPU_SYNC_MODE EffectiveSyncMode
;
344 volatile BOOLEAN SwitchBsp
;
345 volatile BOOLEAN
*CandidateBsp
;
346 } SMM_DISPATCHER_MP_SYNC_DATA
;
348 #define MSR_SPIN_LOCK_INIT_NUM 15
355 #define SMM_PSD_OFFSET 0xfb00
358 /// All global semaphores' pointer
361 volatile UINT32
*Counter
;
362 volatile BOOLEAN
*InsideSmm
;
363 volatile BOOLEAN
*AllCpusInSync
;
365 SPIN_LOCK
*CodeAccessCheckLock
;
366 SPIN_LOCK
*MemoryMappedLock
;
367 } SMM_CPU_SEMAPHORE_GLOBAL
;
370 /// All semaphores for each processor
374 volatile UINT32
*Run
;
375 volatile BOOLEAN
*Present
;
376 } SMM_CPU_SEMAPHORE_CPU
;
379 /// All MSRs semaphores' pointer and counter
383 UINTN AvailableCounter
;
384 } SMM_CPU_SEMAPHORE_MSR
;
387 /// All semaphores' information
390 SMM_CPU_SEMAPHORE_GLOBAL SemaphoreGlobal
;
391 SMM_CPU_SEMAPHORE_CPU SemaphoreCpu
;
392 SMM_CPU_SEMAPHORE_MSR SemaphoreMsr
;
393 } SMM_CPU_SEMAPHORES
;
395 extern IA32_DESCRIPTOR gcSmiGdtr
;
396 extern EFI_PHYSICAL_ADDRESS mGdtBuffer
;
397 extern UINTN mGdtBufferSize
;
398 extern IA32_DESCRIPTOR gcSmiIdtr
;
399 extern VOID
*gcSmiIdtrPtr
;
400 extern UINT64 gPhyMask
;
401 extern SMM_DISPATCHER_MP_SYNC_DATA
*mSmmMpSyncData
;
402 extern UINTN mSmmStackArrayBase
;
403 extern UINTN mSmmStackArrayEnd
;
404 extern UINTN mSmmStackSize
;
405 extern EFI_SMM_CPU_SERVICE_PROTOCOL mSmmCpuService
;
406 extern IA32_DESCRIPTOR gcSmiInitGdtr
;
407 extern SMM_CPU_SEMAPHORES mSmmCpuSemaphores
;
408 extern UINTN mSemaphoreSize
;
409 extern SPIN_LOCK
*mPFLock
;
410 extern SPIN_LOCK
*mConfigSmmCodeAccessCheckLock
;
411 extern SPIN_LOCK
*mMemoryMappedLock
;
412 extern EFI_SMRAM_DESCRIPTOR
*mSmmCpuSmramRanges
;
413 extern UINTN mSmmCpuSmramRangeCount
;
414 extern UINT8 mPhysicalAddressBits
;
417 // Copy of the PcdPteMemoryEncryptionAddressOrMask
419 extern UINT64 mAddressEncMask
;
422 Create 4G PageTable in SMRAM.
424 @param[in] Is32BitPageTable Whether the page table is 32-bit PAE
425 @return PageTable Address
430 IN BOOLEAN Is32BitPageTable
435 Initialize global data for MP synchronization.
437 @param Stacks Base address of SMI stack buffer for all processors.
438 @param StackSize Stack size for each processor in SMM.
442 InitializeMpServiceData (
448 Initialize Timer for SMM AP Sync.
457 Start Timer for SMM AP Sync.
467 Check if the SMM AP Sync timer is timeout.
469 @param Timer The start timer from the begin.
479 Initialize IDT for SMM Stack Guard.
484 InitializeIDTSmmStackGuard (
489 Initialize Gdt for all processors.
491 @param[in] Cr3 CR3 value.
492 @param[out] GdtStepSize The step size for GDT table.
494 @return GdtBase for processor 0.
495 GdtBase for processor X is: GdtBase + (GdtStepSize * X)
500 OUT UINTN
*GdtStepSize
505 Register the SMM Foundation entry point.
507 @param This Pointer to EFI_SMM_CONFIGURATION_PROTOCOL instance
508 @param SmmEntryPoint SMM Foundation EntryPoint
510 @retval EFI_SUCCESS Successfully to register SMM foundation entry point
516 IN CONST EFI_SMM_CONFIGURATION_PROTOCOL
*This
,
517 IN EFI_SMM_ENTRY_POINT SmmEntryPoint
521 Create PageTable for SMM use.
523 @return PageTable Address
532 Schedule a procedure to run on the specified CPU.
534 @param Procedure The address of the procedure to run
535 @param CpuIndex Target CPU number
536 @param ProcArguments The parameter to pass to the procedure
538 @retval EFI_INVALID_PARAMETER CpuNumber not valid
539 @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP
540 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not enter SMM
541 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy
542 @retval EFI_SUCCESS - The procedure has been successfully scheduled
548 IN EFI_AP_PROCEDURE Procedure
,
550 IN OUT VOID
*ProcArguments OPTIONAL
554 Schedule a procedure to run on the specified CPU in a blocking fashion.
556 @param Procedure The address of the procedure to run
557 @param CpuIndex Target CPU Index
558 @param ProcArguments The parameter to pass to the procedure
560 @retval EFI_INVALID_PARAMETER CpuNumber not valid
561 @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP
562 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not enter SMM
563 @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy
564 @retval EFI_SUCCESS The procedure has been successfully scheduled
569 SmmBlockingStartupThisAp (
570 IN EFI_AP_PROCEDURE Procedure
,
572 IN OUT VOID
*ProcArguments OPTIONAL
576 This function sets the attributes for the memory region specified by BaseAddress and
577 Length from their current attributes to the attributes specified by Attributes.
579 @param[in] BaseAddress The physical address that is the start address of a memory region.
580 @param[in] Length The size in bytes of the memory region.
581 @param[in] Attributes The bit mask of attributes to set for the memory region.
583 @retval EFI_SUCCESS The attributes were set for the memory region.
584 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
585 BaseAddress and Length cannot be modified.
586 @retval EFI_INVALID_PARAMETER Length is zero.
587 Attributes specified an illegal combination of attributes that
588 cannot be set together.
589 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
590 the memory resource range.
591 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
592 resource range specified by BaseAddress and Length.
593 The bit mask of attributes is not support for the memory resource
594 range specified by BaseAddress and Length.
599 SmmSetMemoryAttributes (
600 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
606 This function clears the attributes for the memory region specified by BaseAddress and
607 Length from their current attributes to the attributes specified by Attributes.
609 @param[in] BaseAddress The physical address that is the start address of a memory region.
610 @param[in] Length The size in bytes of the memory region.
611 @param[in] Attributes The bit mask of attributes to clear for the memory region.
613 @retval EFI_SUCCESS The attributes were cleared for the memory region.
614 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
615 BaseAddress and Length cannot be modified.
616 @retval EFI_INVALID_PARAMETER Length is zero.
617 Attributes specified an illegal combination of attributes that
618 cannot be set together.
619 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
620 the memory resource range.
621 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
622 resource range specified by BaseAddress and Length.
623 The bit mask of attributes is not support for the memory resource
624 range specified by BaseAddress and Length.
629 SmmClearMemoryAttributes (
630 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
636 Initialize MP synchronization data.
641 InitializeMpSyncData (
647 Find out SMRAM information including SMRR base and SMRR size.
649 @param SmrrBase SMRR base
650 @param SmrrSize SMRR size
655 OUT UINT32
*SmrrBase
,
660 Relocate SmmBases for each processor.
662 Execute on first boot and all S3 resumes
672 Page Fault handler for SMM use.
674 @param InterruptType Defines the type of interrupt or exception that
675 occurred on the processor.This parameter is processor architecture specific.
676 @param SystemContext A pointer to the processor context when
677 the interrupt occurred on the processor.
682 IN EFI_EXCEPTION_TYPE InterruptType
,
683 IN EFI_SYSTEM_CONTEXT SystemContext
687 Perform the remaining tasks.
691 PerformRemainingTasks (
696 Perform the pre tasks.
705 Initialize MSR spin lock by MSR index.
707 @param MsrIndex MSR index value.
711 InitMsrSpinLockByIndex (
716 Hook return address of SMM Save State so that semaphore code
717 can be executed immediately after AP exits SMM to indicate to
718 the BSP that an AP has exited SMM after SMBASE relocation.
720 @param[in] CpuIndex The processor index.
721 @param[in] RebasedFlag A pointer to a flag that is set to TRUE
722 immediately after AP exits SMM.
728 IN
volatile BOOLEAN
*RebasedFlag
732 Configure SMM Code Access Check feature for all processors.
733 SMM Feature Control MSR will be locked after configuration.
736 ConfigSmmCodeAccessCheck (
741 Hook the code executed immediately after an RSM instruction on the currently
742 executing CPU. The mode of code executed immediately after RSM must be
743 detected, and the appropriate hook must be selected. Always clear the auto
744 HALT restart flag if it is set.
746 @param[in] CpuIndex The processor index for the currently
748 @param[in] CpuState Pointer to SMRAM Save State Map for the
749 currently executing CPU.
750 @param[in] NewInstructionPointer32 Instruction pointer to use if resuming to
751 32-bit mode from 64-bit SMM.
752 @param[in] NewInstructionPointer Instruction pointer to use if resuming to
755 @retval The value of the original instruction pointer before it was hooked.
762 SMRAM_SAVE_STATE_MAP
*CpuState
,
763 UINT64 NewInstructionPointer32
,
764 UINT64 NewInstructionPointer
768 Get the size of the SMI Handler in bytes.
770 @retval The size, in bytes, of the SMI Handler.
780 Install the SMI handler for the CPU specified by CpuIndex. This function
781 is called by the CPU that was elected as monarch during System Management
784 @param[in] CpuIndex The index of the CPU to install the custom SMI handler.
785 The value must be between 0 and the NumberOfCpus field
786 in the System Management System Table (SMST).
787 @param[in] SmBase The SMBASE address for the CPU specified by CpuIndex.
788 @param[in] SmiStack The stack to use when an SMI is processed by the
789 the CPU specified by CpuIndex.
790 @param[in] StackSize The size, in bytes, if the stack used when an SMI is
791 processed by the CPU specified by CpuIndex.
792 @param[in] GdtBase The base address of the GDT to use when an SMI is
793 processed by the CPU specified by CpuIndex.
794 @param[in] GdtSize The size, in bytes, of the GDT used when an SMI is
795 processed by the CPU specified by CpuIndex.
796 @param[in] IdtBase The base address of the IDT to use when an SMI is
797 processed by the CPU specified by CpuIndex.
798 @param[in] IdtSize The size, in bytes, of the IDT used when an SMI is
799 processed by the CPU specified by CpuIndex.
800 @param[in] Cr3 The base address of the page tables to use when an SMI
801 is processed by the CPU specified by CpuIndex.
818 Search module name by input IP address and output it.
820 @param CallerIpAddress Caller instruction pointer.
825 IN UINTN CallerIpAddress
829 This function sets memory attribute according to MemoryAttributesTable.
832 SetMemMapAttributes (
837 This function sets UEFI memory attribute according to UEFI memory map.
840 SetUefiMemMapAttributes (
845 Return if the Address is forbidden as SMM communication buffer.
847 @param[in] Address the address to be checked
849 @return TRUE The address is forbidden as SMM communication buffer.
850 @return FALSE The address is allowed as SMM communication buffer.
853 IsSmmCommBufferForbiddenAddress (
858 This function caches the UEFI memory map information.
866 This function sets memory attribute for page table.
869 SetPageTableAttributes (
874 Return page table base.
876 @return page table base.
884 This function sets the attributes for the memory region specified by BaseAddress and
885 Length from their current attributes to the attributes specified by Attributes.
887 @param[in] BaseAddress The physical address that is the start address of a memory region.
888 @param[in] Length The size in bytes of the memory region.
889 @param[in] Attributes The bit mask of attributes to set for the memory region.
890 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
892 @retval EFI_SUCCESS The attributes were set for the memory region.
893 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
894 BaseAddress and Length cannot be modified.
895 @retval EFI_INVALID_PARAMETER Length is zero.
896 Attributes specified an illegal combination of attributes that
897 cannot be set together.
898 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
899 the memory resource range.
900 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
901 resource range specified by BaseAddress and Length.
902 The bit mask of attributes is not support for the memory resource
903 range specified by BaseAddress and Length.
908 SmmSetMemoryAttributesEx (
909 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
911 IN UINT64 Attributes
,
912 OUT BOOLEAN
*IsSplitted OPTIONAL
916 This function clears the attributes for the memory region specified by BaseAddress and
917 Length from their current attributes to the attributes specified by Attributes.
919 @param[in] BaseAddress The physical address that is the start address of a memory region.
920 @param[in] Length The size in bytes of the memory region.
921 @param[in] Attributes The bit mask of attributes to clear for the memory region.
922 @param[out] IsSplitted TRUE means page table splitted. FALSE means page table not splitted.
924 @retval EFI_SUCCESS The attributes were cleared for the memory region.
925 @retval EFI_ACCESS_DENIED The attributes for the memory resource range specified by
926 BaseAddress and Length cannot be modified.
927 @retval EFI_INVALID_PARAMETER Length is zero.
928 Attributes specified an illegal combination of attributes that
929 cannot be set together.
930 @retval EFI_OUT_OF_RESOURCES There are not enough system resources to modify the attributes of
931 the memory resource range.
932 @retval EFI_UNSUPPORTED The processor does not support one or more bytes of the memory
933 resource range specified by BaseAddress and Length.
934 The bit mask of attributes is not support for the memory resource
935 range specified by BaseAddress and Length.
940 SmmClearMemoryAttributesEx (
941 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
943 IN UINT64 Attributes
,
944 OUT BOOLEAN
*IsSplitted OPTIONAL
948 This API provides a way to allocate memory for page table.
950 This API can be called more once to allocate memory for page tables.
952 Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
953 allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
954 is returned. If there is not enough memory remaining to satisfy the request, then NULL is
957 @param Pages The number of 4 KB pages to allocate.
959 @return A pointer to the allocated buffer or NULL if allocation fails.
963 AllocatePageTableMemory (
968 Allocate pages for code.
970 @param[in] Pages Number of pages to be allocated.
972 @return Allocated memory.
980 Allocate aligned pages for code.
982 @param[in] Pages Number of pages to be allocated.
983 @param[in] Alignment The requested alignment of the allocation.
984 Must be a power of two.
985 If Alignment is zero, then byte alignment is used.
987 @return Allocated memory.
990 AllocateAlignedCodePages (
997 // S3 related global variable and function prototype.
1000 extern BOOLEAN mSmmS3Flag
;
1003 Initialize SMM S3 resume state structure used during S3 Resume.
1005 @param[in] Cr3 The base address of the page tables to use in SMM.
1009 InitSmmS3ResumeState (
1023 Restore SMM Configuration in S3 boot path.
1027 RestoreSmmConfigurationInS3 (
1032 Get ACPI S3 enable flag.
1036 GetAcpiS3EnableFlag (
1041 Transfer AP to safe hlt-loop after it finished restore CPU features on S3 patch.
1043 @param[in] ApHltLoopCode The address of the safe hlt-loop function.
1044 @param[in] TopOfStack A pointer to the new stack to use for the ApHltLoopCode.
1045 @param[in] NumberToFinishAddress Address of Semaphore of APs finish count.
1049 TransferApToSafeState (
1050 IN UINTN ApHltLoopCode
,
1051 IN UINTN TopOfStack
,
1052 IN UINTN NumberToFinishAddress
1056 This function set given attributes of the memory region specified by
1057 BaseAddress and Length.
1059 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1060 @param BaseAddress The physical address that is the start address of
1062 @param Length The size in bytes of the memory region.
1063 @param Attributes The bit mask of attributes to set for the memory
1066 @retval EFI_SUCCESS The attributes were set for the memory region.
1067 @retval EFI_INVALID_PARAMETER Length is zero.
1068 Attributes specified an illegal combination of
1069 attributes that cannot be set together.
1070 @retval EFI_UNSUPPORTED The processor does not support one or more
1071 bytes of the memory resource range specified
1072 by BaseAddress and Length.
1073 The bit mask of attributes is not supported for
1074 the memory resource range specified by
1075 BaseAddress and Length.
1080 EdkiiSmmSetMemoryAttributes (
1081 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1082 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1084 IN UINT64 Attributes
1088 This function clears given attributes of the memory region specified by
1089 BaseAddress and Length.
1091 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1092 @param BaseAddress The physical address that is the start address of
1094 @param Length The size in bytes of the memory region.
1095 @param Attributes The bit mask of attributes to clear for the memory
1098 @retval EFI_SUCCESS The attributes were cleared for the memory region.
1099 @retval EFI_INVALID_PARAMETER Length is zero.
1100 Attributes specified an illegal combination of
1101 attributes that cannot be cleared together.
1102 @retval EFI_UNSUPPORTED The processor does not support one or more
1103 bytes of the memory resource range specified
1104 by BaseAddress and Length.
1105 The bit mask of attributes is not supported for
1106 the memory resource range specified by
1107 BaseAddress and Length.
1112 EdkiiSmmClearMemoryAttributes (
1113 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1114 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1116 IN UINT64 Attributes
1120 This function retrieves the attributes of the memory region specified by
1121 BaseAddress and Length. If different attributes are got from different part
1122 of the memory region, EFI_NO_MAPPING will be returned.
1124 @param This The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1125 @param BaseAddress The physical address that is the start address of
1127 @param Length The size in bytes of the memory region.
1128 @param Attributes Pointer to attributes returned.
1130 @retval EFI_SUCCESS The attributes got for the memory region.
1131 @retval EFI_INVALID_PARAMETER Length is zero.
1133 @retval EFI_NO_MAPPING Attributes are not consistent cross the memory
1135 @retval EFI_UNSUPPORTED The processor does not support one or more
1136 bytes of the memory resource range specified
1137 by BaseAddress and Length.
1142 EdkiiSmmGetMemoryAttributes (
1143 IN EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL
*This
,
1144 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
1146 IN UINT64
*Attributes
1150 This function fixes up the address of the global variable or function
1151 referred in SmmInit assembly files to be the absoute address.
1155 PiSmmCpuSmmInitFixupAddress (
1159 This function fixes up the address of the global variable or function
1160 referred in SmiEntry assembly files to be the absoute address.
1164 PiSmmCpuSmiEntryFixupAddress (