TianoCore EDK2 master
Loading...
Searching...
No Matches
SmmCpuFeaturesLib.c File Reference

Go to the source code of this file.

Macros

#define LMA   BIT10
 

Functions

EFI_STATUS EFIAPI SmmCpuFeaturesLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
 
VOID EFIAPI SmmCpuFeaturesInitializeProcessor (IN UINTN CpuIndex, IN BOOLEAN IsMonarch, IN EFI_PROCESSOR_INFORMATION *ProcessorInfo, IN CPU_HOT_PLUG_DATA *CpuHotPlugData)
 
UINT64 EFIAPI SmmCpuFeaturesHookReturnFromSmm (IN UINTN CpuIndex, IN SMRAM_SAVE_STATE_MAP *CpuState, IN UINT64 NewInstructionPointer32, IN UINT64 NewInstructionPointer)
 
STATIC VOID InitCpuHotEjectData (VOID)
 
VOID EFIAPI SmmCpuFeaturesSmmRelocationComplete (VOID)
 
UINTN EFIAPI SmmCpuFeaturesGetSmiHandlerSize (VOID)
 
VOID EFIAPI SmmCpuFeaturesInstallSmiHandler (IN UINTN CpuIndex, IN UINT32 SmBase, IN VOID *SmiStack, IN UINTN StackSize, IN UINTN GdtBase, IN UINTN GdtSize, IN UINTN IdtBase, IN UINTN IdtSize, IN UINT32 Cr3)
 
BOOLEAN EFIAPI SmmCpuFeaturesNeedConfigureMtrrs (VOID)
 
VOID EFIAPI SmmCpuFeaturesDisableSmrr (VOID)
 
VOID EFIAPI SmmCpuFeaturesReenableSmrr (VOID)
 
VOID EFIAPI SmmCpuFeaturesRendezvousEntry (IN UINTN CpuIndex)
 
VOID EFIAPI SmmCpuFeaturesRendezvousExit (IN UINTN CpuIndex)
 
BOOLEAN EFIAPI SmmCpuFeaturesIsSmmRegisterSupported (IN UINTN CpuIndex, IN SMM_REG_NAME RegName)
 
UINT64 EFIAPI SmmCpuFeaturesGetSmmRegister (IN UINTN CpuIndex, IN SMM_REG_NAME RegName)
 
VOID EFIAPI SmmCpuFeaturesSetSmmRegister (IN UINTN CpuIndex, IN SMM_REG_NAME RegName, IN UINT64 Value)
 
VOID EFIAPI SmmCpuFeaturesCompleteSmmReadyToLock (VOID)
 

Variables

STATIC CPU_HOT_EJECT_DATAmCpuHotEjectData = NULL
 

Detailed Description

The CPU specific programming for PiSmmCpuDxeSmm module.

Copyright (c) 2010 - 2023, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SmmCpuFeaturesLib.c.

Macro Definition Documentation

◆ LMA

#define LMA   BIT10

Definition at line 30 of file SmmCpuFeaturesLib.c.

Function Documentation

◆ InitCpuHotEjectData()

STATIC VOID InitCpuHotEjectData ( VOID  )

Initialize mCpuHotEjectData if PcdCpuMaxLogicalProcessorNumber > 1.

Also setup the corresponding PcdCpuHotEjectDataAddress.

Definition at line 196 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesCompleteSmmReadyToLock()

VOID EFIAPI SmmCpuFeaturesCompleteSmmReadyToLock ( VOID  )

This function is hook point called after the gEfiSmmReadyToLockProtocolGuid notification is completely processed.

Definition at line 587 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesDisableSmrr()

VOID EFIAPI SmmCpuFeaturesDisableSmrr ( VOID  )

Disable SMRR register if SMRR is supported and SmmCpuFeaturesNeedConfigureMtrrs() returns TRUE.

Definition at line 417 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesGetSmiHandlerSize()

UINTN EFIAPI SmmCpuFeaturesGetSmiHandlerSize ( VOID  )

Return the size, in bytes, of a custom SMI Handler in bytes. If 0 is returned, then a custom SMI handler is not provided by this library, and the default SMI handler must be used.

Return values
0Use the default SMI handler.
>0 Use the SMI handler installed by SmmCpuFeaturesInstallSmiHandler(). The caller is required to allocate enough SMRAM for each CPU to support the size of the custom SMI handler.

Definition at line 346 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesGetSmmRegister()

UINT64 EFIAPI SmmCpuFeaturesGetSmmRegister ( IN UINTN  CpuIndex,
IN SMM_REG_NAME  RegName 
)

Returns the current value of the SMM register for the specified CPU. If the SMM register is not supported, then 0 is returned.

Parameters
[in]CpuIndexThe index of the CPU to read the SMM register. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).
[in]RegNameIdentifies the SMM register to read.
Returns
The value of the SMM register specified by RegName from the CPU specified by CpuIndex.

Definition at line 546 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesHookReturnFromSmm()

UINT64 EFIAPI SmmCpuFeaturesHookReturnFromSmm ( IN UINTN  CpuIndex,
IN SMRAM_SAVE_STATE_MAP CpuState,
IN UINT64  NewInstructionPointer32,
IN UINT64  NewInstructionPointer 
)

This function updates the SMRAM save state on the currently executing CPU to resume execution at a specific address after an RSM instruction. This function must evaluate the SMRAM save state to determine the execution mode the RSM instruction resumes and update the resume execution address with either NewInstructionPointer32 or NewInstructionPoint. The auto HALT restart flag in the SMRAM save state must always be cleared. This function returns the value of the instruction pointer from the SMRAM save state that was replaced. If this function returns 0, then the SMRAM save state was not modified.

This function is called during the very first SMI on each CPU after SmmCpuFeaturesInitializeProcessor() to set a flag in normal execution mode to signal that the SMBASE of each CPU has been updated before the default SMBASE address is used for the first SMI to the next CPU.

Parameters
[in]CpuIndexThe index of the CPU to hook. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).
[in]CpuStatePointer to SMRAM Save State Map for the currently executing CPU.
[in]NewInstructionPointer32Instruction pointer to use if resuming to 32-bit execution mode from 64-bit SMM.
[in]NewInstructionPointerInstruction pointer to use if resuming to same execution mode as SMM.
Return values
0This function did modify the SMRAM save state.
>0 The original instruction pointer value from the SMRAM save state before it was replaced.

Definition at line 146 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesInitializeProcessor()

VOID EFIAPI SmmCpuFeaturesInitializeProcessor ( IN UINTN  CpuIndex,
IN BOOLEAN  IsMonarch,
IN EFI_PROCESSOR_INFORMATION ProcessorInfo,
IN CPU_HOT_PLUG_DATA CpuHotPlugData 
)

Called during the very first SMI into System Management Mode to initialize CPU features, including SMBASE, for the currently executing CPU. Since this is the first SMI, the SMRAM Save State Map is at the default address of SMM_DEFAULT_SMBASE + SMRAM_SAVE_STATE_MAP_OFFSET. The currently executing CPU is specified by CpuIndex and CpuIndex can be used to access information about the currently executing CPU in the ProcessorInfo array and the HotPlugCpuData data structure.

Parameters
[in]CpuIndexThe index of the CPU to initialize. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).
[in]IsMonarchTRUE if the CpuIndex is the index of the CPU that was elected as monarch during System Management Mode initialization. FALSE if the CpuIndex is not the index of the CPU that was elected as monarch during System Management Mode initialization.
[in]ProcessorInfoPointer to an array of EFI_PROCESSOR_INFORMATION structures. ProcessorInfo[CpuIndex] contains the information for the currently executing CPU.
[in]CpuHotPlugDataPointer to the CPU_HOT_PLUG_DATA structure that contains the ApidId and SmBase arrays.

Definition at line 86 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesInstallSmiHandler()

VOID EFIAPI SmmCpuFeaturesInstallSmiHandler ( IN UINTN  CpuIndex,
IN UINT32  SmBase,
IN VOID *  SmiStack,
IN UINTN  StackSize,
IN UINTN  GdtBase,
IN UINTN  GdtSize,
IN UINTN  IdtBase,
IN UINTN  IdtSize,
IN UINT32  Cr3 
)

Install a custom SMI handler for the CPU specified by CpuIndex. This function is only called if SmmCpuFeaturesGetSmiHandlerSize() returns a size is greater than zero and is called by the CPU that was elected as monarch during System Management Mode initialization.

Parameters
[in]CpuIndexThe index of the CPU to install the custom SMI handler. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).
[in]SmBaseThe SMBASE address for the CPU specified by CpuIndex.
[in]SmiStackThe stack to use when an SMI is processed by the the CPU specified by CpuIndex.
[in]StackSizeThe size, in bytes, if the stack used when an SMI is processed by the CPU specified by CpuIndex.
[in]GdtBaseThe base address of the GDT to use when an SMI is processed by the CPU specified by CpuIndex.
[in]GdtSizeThe size, in bytes, of the GDT used when an SMI is processed by the CPU specified by CpuIndex.
[in]IdtBaseThe base address of the IDT to use when an SMI is processed by the CPU specified by CpuIndex.
[in]IdtSizeThe size, in bytes, of the IDT used when an SMI is processed by the CPU specified by CpuIndex.
[in]Cr3The base address of the page tables to use when an SMI is processed by the CPU specified by CpuIndex.

Definition at line 380 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesIsSmmRegisterSupported()

BOOLEAN EFIAPI SmmCpuFeaturesIsSmmRegisterSupported ( IN UINTN  CpuIndex,
IN SMM_REG_NAME  RegName 
)

Check to see if an SMM register is supported by a specified CPU.

Parameters
[in]CpuIndexThe index of the CPU to check for SMM register support. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).
[in]RegNameIdentifies the SMM register to check for support.
Return values
TRUEThe SMM register specified by RegName is supported by the CPU specified by CpuIndex.
FALSEThe SMM register specified by RegName is not supported by the CPU specified by CpuIndex.

Definition at line 523 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesLibConstructor()

EFI_STATUS EFIAPI SmmCpuFeaturesLibConstructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

The constructor function

Parameters
[in]ImageHandleThe firmware allocated handle for the EFI image.
[in]SystemTableA pointer to the EFI System Table.
Return values
EFI_SUCCESSThe constructor always returns EFI_SUCCESS.

Definition at line 43 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesNeedConfigureMtrrs()

BOOLEAN EFIAPI SmmCpuFeaturesNeedConfigureMtrrs ( VOID  )

Determines if MTRR registers must be configured to set SMRAM cache-ability when executing in System Management Mode.

Return values
TRUEMTRR registers must be configured to set SMRAM cache-ability.
FALSEMTRR registers do not need to be configured to set SMRAM cache-ability.

Definition at line 404 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesReenableSmrr()

VOID EFIAPI SmmCpuFeaturesReenableSmrr ( VOID  )

Enable SMRR register if SMRR is supported and SmmCpuFeaturesNeedConfigureMtrrs() returns TRUE.

Definition at line 432 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesRendezvousEntry()

VOID EFIAPI SmmCpuFeaturesRendezvousEntry ( IN UINTN  CpuIndex)

Processor specific hook point each time a CPU enters System Management Mode.

Parameters
[in]CpuIndexThe index of the CPU that has entered SMM. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).

Definition at line 450 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesRendezvousExit()

VOID EFIAPI SmmCpuFeaturesRendezvousExit ( IN UINTN  CpuIndex)

Processor specific hook point each time a CPU exits System Management Mode.

Parameters
[in]CpuIndexThe index of the CPU that is exiting SMM. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).

Definition at line 468 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesSetSmmRegister()

VOID EFIAPI SmmCpuFeaturesSetSmmRegister ( IN UINTN  CpuIndex,
IN SMM_REG_NAME  RegName,
IN UINT64  Value 
)

Sets the value of an SMM register on a specified CPU. If the SMM register is not supported, then no action is performed.

Parameters
[in]CpuIndexThe index of the CPU to write the SMM register. The value must be between 0 and the NumberOfCpus field in the System Management System Table (SMST).
[in]RegNameIdentifies the SMM register to write. registers are read-only.
[in]ValueThe value to write to the SMM register.

Definition at line 572 of file SmmCpuFeaturesLib.c.

◆ SmmCpuFeaturesSmmRelocationComplete()

VOID EFIAPI SmmCpuFeaturesSmmRelocationComplete ( VOID  )

Hook point in normal execution mode that allows the one CPU that was elected as monarch during System Management Mode initialization to perform additional initialization actions immediately after all of the CPUs have processed their first SMI and called SmmCpuFeaturesInitializeProcessor() relocating SMBASE into a buffer in SMRAM and called SmmCpuFeaturesHookReturnFromSmm().

Definition at line 272 of file SmmCpuFeaturesLib.c.

Variable Documentation

◆ mCpuHotEjectData

STATIC CPU_HOT_EJECT_DATA* mCpuHotEjectData = NULL

Definition at line 187 of file SmmCpuFeaturesLib.c.