#include <PiMm.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/SmmServicesTableLib.h>
#include <Library/TpmMeasurementLib.h>
#include <Register/Intel/Cpuid.h>
#include <Register/Intel/ArchitecturalMsr.h>
#include <Register/Intel/SmramSaveStateMap.h>
#include <Protocol/MpService.h>
#include "CpuFeaturesLib.h"
#include "SmmStm.h"

Macros
#define	TXT_EVTYPE_BASE 0x400

#define	TXT_EVTYPE_STM_HASH (TXT_EVTYPE_BASE + 14)

#define	RDWR_ACCS 3

#define	FULL_ACCS 7

#define	CPUID1_EDX_XD_SUPPORT 0x100000

Functions
EFI_STATUS EFIAPI	SmmCpuFeaturesLibStmConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

VOID	FinishSmmCpuFeaturesInitializeProcessor (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)

EFI_STATUS EFIAPI	SmmEndOfDxeEventNotify (IN CONST EFI_GUID Protocol, IN VOID Interface, IN EFI_HANDLE Handle)

VOID	StmSmmConfigurationTableInit (VOID)

EFI_SM_MONITOR_STATE EFIAPI	GetMonitorState (VOID)

BOOLEAN	HandleSingleResource (IN STM_RSC Resource, IN STM_RSC Record)

VOID	AddSingleResource (IN STM_RSC *Resource)

VOID	AddResource (IN STM_RSC *ResourceList, IN UINT32 NumEntries OPTIONAL)

BOOLEAN	ValidateResource (IN STM_RSC *ResourceList, IN UINT32 NumEntries OPTIONAL)

UINTN	GetResourceSize (IN STM_RSC *ResourceList, IN UINT32 NumEntries OPTIONAL)

EFI_STATUS EFIAPI	AddPiResource (IN STM_RSC *ResourceList, IN UINT32 NumEntries OPTIONAL)

EFI_STATUS EFIAPI	DeletePiResource (IN STM_RSC *ResourceList, IN UINT32 NumEntries OPTIONAL)

EFI_STATUS EFIAPI	GetPiResource (OUT STM_RSC ResourceList, IN OUT UINT32 ResourceSize)

VOID EFIAPI	EnableMsegMsr (IN VOID *Buffer)

UINT32	GetVmcsSize (VOID)

BOOLEAN	StmCheckStmImage (IN EFI_PHYSICAL_ADDRESS StmImage, IN UINTN StmImageSize)

VOID	StmLoadStmImage (IN EFI_PHYSICAL_ADDRESS StmImage, IN UINTN StmImageSize)

EFI_STATUS EFIAPI	LoadMonitor (IN EFI_PHYSICAL_ADDRESS StmImage, IN UINTN StmImageSize)

VOID *	GetStmResource (VOID)

VOID	NotifyStmResourceChange (VOID *StmResource)

VOID EFIAPI	SmmStmSetup (VOID)

VOID EFIAPI	SmmStmTeardown (VOID)

Variables
EFI_HANDLE	mStmSmmCpuHandle = NULL

BOOLEAN	mLockLoadMonitor = FALSE

GLOBAL_REMOVE_IF_UNREFERENCED STM_RSC_END	mRscEndNode

GLOBAL_REMOVE_IF_UNREFERENCED UINT8 *	mStmResourcesPtr = NULL

GLOBAL_REMOVE_IF_UNREFERENCED UINTN	mStmResourceTotalSize = 0x0

GLOBAL_REMOVE_IF_UNREFERENCED UINTN	mStmResourceSizeUsed = 0x0

GLOBAL_REMOVE_IF_UNREFERENCED UINTN	mStmResourceSizeAvailable = 0x0

GLOBAL_REMOVE_IF_UNREFERENCED UINT32	mStmState = 0

GLOBAL_REMOVE_IF_UNREFERENCED EFI_SM_MONITOR_INIT_PROTOCOL	mSmMonitorInitProtocol

CONST TXT_PROCESSOR_SMM_DESCRIPTOR	gcStmPsd

UINT32	gStmSmbase

volatile UINT32	gStmSmiStack

UINT32	gStmSmiCr3

volatile UINT8	gcStmSmiHandlerTemplate []

CONST UINT16	gcStmSmiHandlerSize

UINT16	gcStmSmiHandlerOffset

BOOLEAN	gStmXdSupported

IA32_DESCRIPTOR	gStmSmiHandlerIdtr

EFI_MP_SERVICES_PROTOCOL *	mSmmCpuFeaturesLibMpService = NULL

UINTN	mMsegBase = 0

UINTN	mMsegSize = 0

BOOLEAN	mStmConfigurationTableInitialized = FALSE

Detailed Description

SMM STM support functions

Copyright (c) 2015 - 2023, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SmmStm.c.

Macro Definition Documentation

◆ CPUID1_EDX_XD_SUPPORT

#define CPUID1_EDX_XD_SUPPORT 0x100000

Definition at line 59 of file SmmStm.c.

◆ FULL_ACCS

#define FULL_ACCS 7

Definition at line 27 of file SmmStm.c.

◆ RDWR_ACCS

#define RDWR_ACCS 3

Definition at line 26 of file SmmStm.c.

◆ TXT_EVTYPE_BASE

#define TXT_EVTYPE_BASE 0x400

Definition at line 23 of file SmmStm.c.

◆ TXT_EVTYPE_STM_HASH

#define TXT_EVTYPE_STM_HASH (TXT_EVTYPE_BASE + 14)

Definition at line 24 of file SmmStm.c.

Function Documentation

◆ AddPiResource()

EFI_STATUS EFIAPI AddPiResource	(	IN STM_RSC *	ResourceList,
		IN UINT32 NumEntries	OPTIONAL
	)

Add resources in list to database. Allocate new memory areas as needed.

Parameters

ResourceList	A pointer to resource list to be added
NumEntries	Optional number of entries. If 0, list must be terminated by END_OF_RESOURCES.

Return values

EFI_SUCCESS	If resources are added
EFI_INVALID_PARAMETER	If nested procedure detected resource failer
EFI_OUT_OF_RESOURCES	If nested procedure returned it and we cannot allocate more areas.

Definition at line 880 of file SmmStm.c.

◆ AddResource()

VOID AddResource	(	IN STM_RSC *	ResourceList,
		IN UINT32 NumEntries	OPTIONAL
	)

Add resource list.

Parameters

ResourceList	A pointer to resource list to be added
NumEntries	Optional number of entries. If 0, list must be terminated by END_OF_RESOURCES.

Definition at line 660 of file SmmStm.c.

◆ AddSingleResource()

VOID AddSingleResource ( IN STM_RSC * Resource )

Add resource node.

Parameters

Resource A pointer to resource node to be added

Definition at line 600 of file SmmStm.c.

◆ DeletePiResource()

EFI_STATUS EFIAPI DeletePiResource	(	IN STM_RSC *	ResourceList,
		IN UINT32 NumEntries	OPTIONAL
	)

Delete resources in list to database.

Parameters

ResourceList	A pointer to resource list to be deleted NULL means delete all resources.
NumEntries	Optional number of entries. If 0, list must be terminated by END_OF_RESOURCES.

Return values

EFI_SUCCESS	If resources are deleted
EFI_INVALID_PARAMETER	If nested procedure detected resource failer

Definition at line 988 of file SmmStm.c.

◆ EnableMsegMsr()

VOID EFIAPI EnableMsegMsr ( IN VOID * Buffer )

Set valid bit for MSEG MSR.

Parameters

Buffer Ap function buffer. (not used)

Definition at line 1047 of file SmmStm.c.

◆ FinishSmmCpuFeaturesInitializeProcessor()

VOID FinishSmmCpuFeaturesInitializeProcessor ( VOID )

Internal worker function that is called to complete CPU initialization at the end of SmmCpuFeaturesInitializeProcessor().

Definition at line 173 of file SmmStm.c.

◆ GetMonitorState()

EFI_SM_MONITOR_STATE EFIAPI GetMonitorState ( VOID )

Get STM state.

Returns: STM state

Definition at line 446 of file SmmStm.c.

◆ GetPiResource()

EFI_STATUS EFIAPI GetPiResource	(	OUT STM_RSC *	ResourceList,
		IN OUT UINT32 *	ResourceSize
	)

Get BIOS resources.

Parameters

ResourceList	A pointer to resource list to be filled
ResourceSize	On input it means size of resource list input. On output it means size of resource list filled, or the size of resource list to be filled if size of too small.

Return values

EFI_SUCCESS	If resources are returned.
EFI_BUFFER_TOO_SMALL	If resource list buffer is too small to hold the whole resources.

Definition at line 1023 of file SmmStm.c.

◆ GetResourceSize()

UINTN GetResourceSize	(	IN STM_RSC *	ResourceList,
		IN UINT32 NumEntries	OPTIONAL
	)

Get resource list. EndResource is excluded.

Parameters

ResourceList	A pointer to resource list to be added
NumEntries	Optional number of entries. If 0, list must be terminated by END_OF_RESOURCES.

Return values

TRUE	resource valid
FALSE	resource invalid

Definition at line 828 of file SmmStm.c.

◆ GetStmResource()

VOID * GetStmResource ( VOID )

This function return BIOS STM resource. Produced by SmmStm. Consumed by SmmMpService when Init.

Returns: BIOS STM resource

Definition at line 1250 of file SmmStm.c.

◆ GetVmcsSize()

UINT32 GetVmcsSize ( VOID )

Get 4K page aligned VMCS size.

Returns: 4K page aligned VMCS size

Definition at line 1066 of file SmmStm.c.

◆ HandleSingleResource()

BOOLEAN HandleSingleResource	(	IN STM_RSC *	Resource,
		IN STM_RSC *	Record
	)

Handle single Resource to see if it can be merged into Record.

Parameters

Resource	A pointer to resource node to be added
Record	A pointer to record node to be merged

Return values

TRUE	resource handled
FALSE	resource is not handled

Definition at line 465 of file SmmStm.c.

◆ LoadMonitor()

EFI_STATUS EFIAPI LoadMonitor	(	IN EFI_PHYSICAL_ADDRESS	StmImage,
		IN UINTN	StmImageSize
	)

Load STM image to MSEG.

Parameters

StmImage	STM image
StmImageSize	STM image size

Return values

EFI_SUCCESS	Load STM to MSEG successfully
EFI_ALREADY_STARTED	STM image is already loaded to MSEG
EFI_BUFFER_TOO_SMALL	MSEG is smaller than minimal requirement of STM image
EFI_UNSUPPORTED	MSEG is not enabled

Definition at line 1204 of file SmmStm.c.

◆ NotifyStmResourceChange()

VOID NotifyStmResourceChange ( VOID * StmResource )

This function notify STM resource change.

Parameters

StmResource BIOS STM resource

Definition at line 1264 of file SmmStm.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

0	Use 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 202 of file SmmStm.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]	CpuIndex	The 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]	SmBase	The SMBASE address for the CPU specified by CpuIndex.
[in]	SmiStack	The stack to use when an SMI is processed by the the CPU specified by CpuIndex.
[in]	StackSize	The size, in bytes, if the stack used when an SMI is processed by the CPU specified by CpuIndex.
[in]	GdtBase	The base address of the GDT to use when an SMI is processed by the CPU specified by CpuIndex.
[in]	GdtSize	The size, in bytes, of the GDT used when an SMI is processed by the CPU specified by CpuIndex.
[in]	IdtBase	The base address of the IDT to use when an SMI is processed by the CPU specified by CpuIndex.
[in]	IdtSize	The size, in bytes, of the IDT used when an SMI is processed by the CPU specified by CpuIndex.
[in]	Cr3	The base address of the page tables to use when an SMI is processed by the CPU specified by CpuIndex.

Definition at line 236 of file SmmStm.c.

◆ SmmCpuFeaturesLibStmConstructor()

EFI_STATUS EFIAPI SmmCpuFeaturesLibStmConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The constructor function for the Traditional MM library instance with STM.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS The constructor always returns EFI_SUCCESS.

Definition at line 102 of file SmmStm.c.

◆ SmmEndOfDxeEventNotify()

EFI_STATUS EFIAPI SmmEndOfDxeEventNotify	(	IN CONST EFI_GUID *	Protocol,
		IN VOID *	Interface,
		IN EFI_HANDLE	Handle
	)

SMM End Of Dxe event notification handler.

STM support need patch AcpiRsdp in TXT_PROCESSOR_SMM_DESCRIPTOR.

Parameters

[in]	Protocol	Points to the protocol's unique identifier.
[in]	Interface	Points to the interface instance.
[in]	Handle	The handle on which the interface was installed.

Return values

EFI_SUCCESS Notification handler runs successfully.

Definition at line 357 of file SmmStm.c.

◆ SmmStmSetup()

VOID EFIAPI SmmStmSetup ( VOID )

This is STM setup BIOS callback.

Definition at line 1284 of file SmmStm.c.

◆ SmmStmTeardown()

VOID EFIAPI SmmStmTeardown ( VOID )

This is STM teardown BIOS callback.

Definition at line 1296 of file SmmStm.c.

◆ StmCheckStmImage()

BOOLEAN StmCheckStmImage	(	IN EFI_PHYSICAL_ADDRESS	StmImage,
		IN UINTN	StmImageSize
	)

Check STM image size.

Parameters

StmImage	STM image
StmImageSize	STM image size

Return values

TRUE	check pass
FALSE	check fail

Definition at line 1090 of file SmmStm.c.

◆ StmLoadStmImage()

VOID StmLoadStmImage	(	IN EFI_PHYSICAL_ADDRESS	StmImage,
		IN UINTN	StmImageSize
	)

Load STM image to MSEG.

Parameters

StmImage	STM image
StmImageSize	STM image size

Definition at line 1156 of file SmmStm.c.

◆ StmSmmConfigurationTableInit()

VOID StmSmmConfigurationTableInit ( VOID )

This function initializes the STM configuration table.

Definition at line 410 of file SmmStm.c.

◆ ValidateResource()

BOOLEAN ValidateResource	(	IN STM_RSC *	ResourceList,
		IN UINT32 NumEntries	OPTIONAL
	)

Validate resource list.

Parameters

ResourceList	A pointer to resource list to be added
NumEntries	Optional number of entries. If 0, list must be terminated by END_OF_RESOURCES.

Return values

TRUE	resource valid
FALSE	resource invalid

Definition at line 702 of file SmmStm.c.

Variable Documentation

◆ gStmSmiHandlerIdtr

IA32_DESCRIPTOR gStmSmiHandlerIdtr

Definition at line 76 of file SmmStm.c.

◆ mLockLoadMonitor

BOOLEAN mLockLoadMonitor = FALSE

Definition at line 31 of file SmmStm.c.

◆ mMsegBase

UINTN mMsegBase = 0

Definition at line 86 of file SmmStm.c.

◆ mMsegSize

UINTN mMsegSize = 0

Definition at line 87 of file SmmStm.c.

◆ mRscEndNode

GLOBAL_REMOVE_IF_UNREFERENCED STM_RSC_END mRscEndNode

Initial value:

= {
  { END_OF_RESOURCES, sizeof (STM_RSC_END) },
}

Definition at line 36 of file SmmStm.c.

◆ mSmmCpuFeaturesLibMpService

EFI_MP_SERVICES_PROTOCOL* mSmmCpuFeaturesLibMpService = NULL

Definition at line 81 of file SmmStm.c.

◆ mSmMonitorInitProtocol

GLOBAL_REMOVE_IF_UNREFERENCED EFI_SM_MONITOR_INIT_PROTOCOL mSmMonitorInitProtocol

Initial value:

= {
  LoadMonitor,
  AddPiResource,
  DeletePiResource,
  GetPiResource,
  GetMonitorState,
}

Definition at line 51 of file SmmStm.c.

◆ mStmConfigurationTableInitialized

BOOLEAN mStmConfigurationTableInitialized = FALSE

Definition at line 89 of file SmmStm.c.

◆ mStmResourceSizeAvailable

GLOBAL_REMOVE_IF_UNREFERENCED UINTN mStmResourceSizeAvailable = 0x0

Definition at line 43 of file SmmStm.c.

◆ mStmResourceSizeUsed

GLOBAL_REMOVE_IF_UNREFERENCED UINTN mStmResourceSizeUsed = 0x0

Definition at line 42 of file SmmStm.c.

◆ mStmResourcesPtr

GLOBAL_REMOVE_IF_UNREFERENCED UINT8* mStmResourcesPtr = NULL

Definition at line 40 of file SmmStm.c.

◆ mStmResourceTotalSize

GLOBAL_REMOVE_IF_UNREFERENCED UINTN mStmResourceTotalSize = 0x0

Definition at line 41 of file SmmStm.c.

◆ mStmSmmCpuHandle

EFI_HANDLE mStmSmmCpuHandle = NULL

Definition at line 29 of file SmmStm.c.

◆ mStmState

GLOBAL_REMOVE_IF_UNREFERENCED UINT32 mStmState = 0

Definition at line 45 of file SmmStm.c.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CPUID1_EDX_XD_SUPPORT

◆ FULL_ACCS

◆ RDWR_ACCS

◆ TXT_EVTYPE_BASE

◆ TXT_EVTYPE_STM_HASH

Function Documentation

◆ AddPiResource()

◆ AddResource()

◆ AddSingleResource()

◆ DeletePiResource()

◆ EnableMsegMsr()

◆ FinishSmmCpuFeaturesInitializeProcessor()

◆ GetMonitorState()

◆ GetPiResource()

◆ GetResourceSize()

◆ GetStmResource()

◆ GetVmcsSize()

◆ HandleSingleResource()

◆ LoadMonitor()

◆ NotifyStmResourceChange()

◆ SmmCpuFeaturesGetSmiHandlerSize()

◆ SmmCpuFeaturesInstallSmiHandler()

◆ SmmCpuFeaturesLibStmConstructor()

◆ SmmEndOfDxeEventNotify()

◆ SmmStmSetup()

◆ SmmStmTeardown()

◆ StmCheckStmImage()

◆ StmLoadStmImage()

◆ StmSmmConfigurationTableInit()

◆ ValidateResource()

Variable Documentation

◆ gStmSmiHandlerIdtr

◆ mLockLoadMonitor

◆ mMsegBase

◆ mMsegSize

◆ mRscEndNode

◆ mSmmCpuFeaturesLibMpService

◆ mSmMonitorInitProtocol

◆ mStmConfigurationTableInitialized

◆ mStmResourceSizeAvailable

◆ mStmResourceSizeUsed

◆ mStmResourcesPtr

◆ mStmResourceTotalSize

◆ mStmSmmCpuHandle

◆ mStmState