#include "PiSmmCore.h"

Functions
EFI_STATUS EFIAPI	SmmEfiNotAvailableYetArg5 (UINTN Arg1, UINTN Arg2, UINTN Arg3, UINTN Arg4, UINTN Arg5)

EFI_STATUS EFIAPI	SmmLegacyBootHandler (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

EFI_STATUS EFIAPI	SmmExitBootServicesHandler (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

EFI_STATUS EFIAPI	SmmS3EntryCallBack (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

EFI_STATUS EFIAPI	SmmReadyToBootHandler (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

EFI_STATUS EFIAPI	SmmReadyToLockHandler (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

EFI_STATUS EFIAPI	SmmEndOfDxeHandler (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

EFI_STATUS EFIAPI	SmmS3SmmInitDoneHandler (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

EFI_STATUS EFIAPI	SmmEndOfS3ResumeHandler (IN EFI_HANDLE DispatchHandle, IN CONST VOID Context OPTIONAL, IN OUT VOID CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)

BOOLEAN	InternalIsBufferOverlapped (IN UINT8 Buff1, IN UINTN Size1, IN UINT8 Buff2, IN UINTN Size2)

VOID EFIAPI	SmmEntryPoint (IN CONST EFI_SMM_ENTRY_CONTEXT *SmmEntryContext)

VOID	SmmCoreInstallLoadedImage (VOID)

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

Detailed Description

SMM Core Main Entry Point

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

Definition in file PiSmmCore.c.

Function Documentation

◆ InternalIsBufferOverlapped()

BOOLEAN InternalIsBufferOverlapped	(	IN UINT8 *	Buff1,
		IN UINTN	Size1,
		IN UINT8 *	Buff2,
		IN UINTN	Size2
	)

Determine if two buffers overlap in memory.

Parameters

[in]	Buff1	Pointer to first buffer
[in]	Size1	Size of Buff1
[in]	Buff2	Pointer to second buffer
[in]	Size2	Size of Buff2

Return values

TRUE	Buffers overlap in memory.
TRUE	Math error. Prevents potential math over and underflows.
FALSE	Buffer doesn't overlap.

Definition at line 627 of file PiSmmCore.c.

◆ SmmCoreInstallLoadedImage()

VOID SmmCoreInstallLoadedImage ( VOID )

Install LoadedImage protocol for SMM Core.

Definition at line 795 of file PiSmmCore.c.

◆ SmmEfiNotAvailableYetArg5()

EFI_STATUS EFIAPI SmmEfiNotAvailableYetArg5	(	UINTN	Arg1,
		UINTN	Arg2,
		UINTN	Arg3,
		UINTN	Arg4,
		UINTN	Arg5
	)

Place holder function until all the SMM System Table Service are available.

Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.

Parameters

Arg1	Undefined
Arg2	Undefined
Arg3	Undefined
Arg4	Undefined
Arg5	Undefined

Returns: EFI_NOT_AVAILABLE_YET

Definition at line 125 of file PiSmmCore.c.

◆ SmmEndOfDxeHandler()

EFI_STATUS EFIAPI SmmEndOfDxeHandler	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Software SMI handler that is called when the EndOfDxe event is signalled. This function installs the SMM EndOfDxe Protocol so SMM Drivers are informed that platform code will invoke 3rd part code.

Parameters

DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
Context	Points to an optional handler context which was specified when the handler was registered.
CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
CommBufferSize	The size of the CommBuffer.

Returns: Status Code

Definition at line 436 of file PiSmmCore.c.

◆ SmmEndOfS3ResumeHandler()

EFI_STATUS EFIAPI SmmEndOfS3ResumeHandler	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Software SMI handler that is called when the EndOfS3Resume signal is triggered. This function installs the SMM EndOfS3Resume Protocol so SMM Drivers are informed that S3 resume has finished.

Parameters

DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
Context	Points to an optional handler context which was specified when the handler was registered.
CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
CommBufferSize	The size of the CommBuffer.

Returns: Status Code

Definition at line 569 of file PiSmmCore.c.

◆ SmmEntryPoint()

VOID EFIAPI SmmEntryPoint ( IN CONST EFI_SMM_ENTRY_CONTEXT * SmmEntryContext )

The main entry point to SMM Foundation.

Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.

Parameters

SmmEntryContext Processor information and functionality needed by SMM Foundation.

Definition at line 669 of file PiSmmCore.c.

◆ SmmExitBootServicesHandler()

EFI_STATUS EFIAPI SmmExitBootServicesHandler	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Software SMI handler that is called when an Exit Boot Services event is signalled. Then the SMM Core also install SMM Exit Boot Services protocol to notify SMM driver that system enter exit boot services.

Parameters

DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
Context	Points to an optional handler context which was specified when the handler was registered.
CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
CommBufferSize	The size of the CommBuffer.

Returns: Status Code

Definition at line 214 of file PiSmmCore.c.

◆ SmmLegacyBootHandler()

EFI_STATUS EFIAPI SmmLegacyBootHandler	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Software SMI handler that is called when a Legacy Boot event is signalled. The SMM Core uses this signal to know that a Legacy Boot has been performed and that gSmmCorePrivate that is shared between the UEFI and SMM execution environments can not be accessed from SMM anymore since that structure is considered free memory by a legacy OS. Then the SMM Core also install SMM Legacy Boot protocol to notify SMM driver that system enter legacy boot.

Parameters

DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
Context	Points to an optional handler context which was specified when the handler was registered.
CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
CommBufferSize	The size of the CommBuffer.

Returns: Status Code

Definition at line 159 of file PiSmmCore.c.

◆ SmmMain()

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

The Entry Point for SMM Core

Install DXE Protocols and reload SMM Core into SMRAM and register SMM Core EntryPoint on the SMI vector.

Note: This function is called for both DXE invocation and SMRAM invocation.

Parameters

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

Return values

EFI_SUCCESS	The entry point is executed successfully.
Other	Some error occurred when executing this entry point.

Definition at line 890 of file PiSmmCore.c.

◆ SmmReadyToBootHandler()

EFI_STATUS EFIAPI SmmReadyToBootHandler	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Software SMI handler that is called when an Ready To Boot event is signalled. Then the SMM Core also install SMM Ready To Boot protocol to notify SMM driver that system enter ready to boot.

Parameters

DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
Context	Points to an optional handler context which was specified when the handler was registered.
CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
CommBufferSize	The size of the CommBuffer.

Returns: Status Code

Definition at line 298 of file PiSmmCore.c.

◆ SmmReadyToLockHandler()

EFI_STATUS EFIAPI SmmReadyToLockHandler	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Software SMI handler that is called when the DxeSmmReadyToLock protocol is added or if gEfiEventReadyToBootGuid is signalled. This function unregisters the Software SMIs that are nor required after SMRAM is locked and installs the SMM Ready To Lock Protocol so SMM Drivers are informed that SMRAM is about to be locked. It also verifies the SMM CPU I/O 2 Protocol has been installed and NULLs gBS and gST because they can not longer be used after SMRAM is locked.

Parameters

DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
Context	Points to an optional handler context which was specified when the handler was registered.
CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
CommBufferSize	The size of the CommBuffer.

Returns: Status Code

Definition at line 346 of file PiSmmCore.c.

◆ SmmS3EntryCallBack()

EFI_STATUS EFIAPI SmmS3EntryCallBack	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Main entry point for an SMM handler dispatch or communicate-based callback.

Parameters

[in]	DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
[in]	Context	Points to an optional handler context which was specified when the handler was registered.
[in,out]	CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
[in,out]	CommBufferSize	The size of the CommBuffer.

Return values

EFI_SUCCESS	The interrupt was handled and quiesced. No other handlers should still be called.
EFI_WARN_INTERRUPT_SOURCE_QUIESCED	The interrupt has been quiesced but other handlers should still be called.
EFI_WARN_INTERRUPT_SOURCE_PENDING	The interrupt is still pending and other handlers should still be called.
EFI_INTERRUPT_PENDING	The interrupt could not be quiesced.

Definition at line 271 of file PiSmmCore.c.

◆ SmmS3SmmInitDoneHandler()

EFI_STATUS EFIAPI SmmS3SmmInitDoneHandler	(	IN EFI_HANDLE	DispatchHandle,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Software SMI handler that is called when the S3SmmInitDone signal is triggered. This function installs the SMM S3SmmInitDone Protocol so SMM Drivers are informed that S3 SMM initialization has been done.

Parameters

DispatchHandle	The unique handle assigned to this handler by SmiHandlerRegister().
Context	Points to an optional handler context which was specified when the handler was registered.
CommBuffer	A pointer to a collection of data in memory that will be conveyed from a non-SMM environment into an SMM environment.
CommBufferSize	The size of the CommBuffer.

Returns: Status Code

Definition at line 510 of file PiSmmCore.c.

Variable Documentation

◆ gSmmCorePrivate

SMM_CORE_PRIVATE_DATA* gSmmCorePrivate

Definition at line 14 of file PiSmmCore.c.

◆ gSmmCoreSmst

EFI_SMM_SYSTEM_TABLE2 gSmmCoreSmst

Definition at line 19 of file PiSmmCore.c.

◆ mAcpiS3Enable

BOOLEAN mAcpiS3Enable = FALSE

Definition at line 78 of file PiSmmCore.c.

◆ mDuringS3Resume

BOOLEAN mDuringS3Resume = FALSE

Definition at line 72 of file PiSmmCore.c.

◆ mFullSmramRangeCount

UINTN mFullSmramRangeCount

Definition at line 102 of file PiSmmCore.c.

◆ mFullSmramRanges

EFI_SMRAM_DESCRIPTOR* mFullSmramRanges

Definition at line 103 of file PiSmmCore.c.

◆ mInLegacyBoot

BOOLEAN mInLegacyBoot = FALSE

Definition at line 66 of file PiSmmCore.c.

◆ mSmmCoreDriverEntry

EFI_SMM_DRIVER_ENTRY* mSmmCoreDriverEntry

Definition at line 105 of file PiSmmCore.c.

◆ mSmmCoreLoadedImage

EFI_LOADED_IMAGE_PROTOCOL* mSmmCoreLoadedImage

Definition at line 107 of file PiSmmCore.c.

◆ mSmmCoreS3SmiHandlers

SMM_CORE_SMI_HANDLERS mSmmCoreS3SmiHandlers[]

Initial value:

= {
  { SmmS3SmmInitDoneHandler, &gEdkiiS3SmmInitDoneGuid, NULL, FALSE },
  { SmmEndOfS3ResumeHandler, &gEdkiiEndOfS3ResumeGuid, NULL, FALSE },
  { NULL,                    NULL,                     NULL, FALSE }
}

Definition at line 96 of file PiSmmCore.c.

◆ mSmmCoreSmiHandlers

SMM_CORE_SMI_HANDLERS mSmmCoreSmiHandlers[]

Initial value:

= {
  { SmmDriverDispatchHandler,   &gEfiEventDxeDispatchGuid,          NULL, TRUE  },
  { SmmReadyToLockHandler,      &gEfiDxeSmmReadyToLockProtocolGuid, NULL, TRUE  },
  { SmmLegacyBootHandler,       &gEfiEventLegacyBootGuid,           NULL, FALSE },
  { SmmExitBootServicesHandler, &gEfiEventExitBootServicesGuid,     NULL, FALSE },
  { SmmReadyToBootHandler,      &gEfiEventReadyToBootGuid,          NULL, FALSE },
  { SmmEndOfDxeHandler,         &gEfiEndOfDxeEventGroupGuid,        NULL, TRUE  },
  { NULL,                       NULL,                               NULL, FALSE }
}

Definition at line 83 of file PiSmmCore.c.

Variables
SMM_CORE_PRIVATE_DATA *	gSmmCorePrivate

EFI_SMM_SYSTEM_TABLE2	gSmmCoreSmst

BOOLEAN	mInLegacyBoot = FALSE

BOOLEAN	mDuringS3Resume = FALSE

BOOLEAN	mAcpiS3Enable = FALSE

SMM_CORE_SMI_HANDLERS	mSmmCoreSmiHandlers []

SMM_CORE_SMI_HANDLERS	mSmmCoreS3SmiHandlers []

UINTN	mFullSmramRangeCount

EFI_SMRAM_DESCRIPTOR *	mFullSmramRanges

EFI_SMM_DRIVER_ENTRY *	mSmmCoreDriverEntry

EFI_LOADED_IMAGE_PROTOCOL *	mSmmCoreLoadedImage

Functions

Variables

Detailed Description

Function Documentation

◆ InternalIsBufferOverlapped()

◆ SmmCoreInstallLoadedImage()

◆ SmmEfiNotAvailableYetArg5()

◆ SmmEndOfDxeHandler()

◆ SmmEndOfS3ResumeHandler()

◆ SmmEntryPoint()

◆ SmmExitBootServicesHandler()

◆ SmmLegacyBootHandler()

◆ SmmMain()

◆ SmmReadyToBootHandler()

◆ SmmReadyToLockHandler()

◆ SmmS3EntryCallBack()

◆ SmmS3SmmInitDoneHandler()

Variable Documentation

◆ gSmmCorePrivate

◆ gSmmCoreSmst

◆ mAcpiS3Enable

◆ mDuringS3Resume

◆ mFullSmramRangeCount

◆ mFullSmramRanges

◆ mInLegacyBoot

◆ mSmmCoreDriverEntry

◆ mSmmCoreLoadedImage

◆ mSmmCoreS3SmiHandlers

◆ mSmmCoreSmiHandlers