Smi.c File Reference

#include "PiSmmCore.h"

Go to the source code of this file.

Functions
SMI_ENTRY *EFIAPI	SmmCoreFindSmiEntry (IN EFI_GUID *HandlerType, IN BOOLEAN Create)
BOOLEAN	RemoveSmiHandler (IN SMI_HANDLER *SmiHandler, IN SMI_ENTRY *SmiEntry)
EFI_STATUS EFIAPI	SmiManage (IN CONST EFI_GUID *HandlerType, IN CONST VOID *Context OPTIONAL, IN OUT VOID *CommBuffer OPTIONAL, IN OUT UINTN *CommBufferSize OPTIONAL)
EFI_STATUS EFIAPI	SmiHandlerRegister (IN EFI_SMM_HANDLER_ENTRY_POINT2 Handler, IN CONST EFI_GUID *HandlerType OPTIONAL, OUT EFI_HANDLE *DispatchHandle)
EFI_STATUS EFIAPI	SmiHandlerUnRegister (IN EFI_HANDLE DispatchHandle)

Variables
UINTN	mSmiManageCallingDepth = 0
LIST_ENTRY	mSmiEntryList = INITIALIZE_LIST_HEAD_VARIABLE (mSmiEntryList)
SMI_ENTRY	mRootSmiEntry

Detailed Description

SMI management.

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

Definition in file Smi.c.

Function Documentation

RemoveSmiHandler()

BOOLEAN RemoveSmiHandler	(	IN SMI_HANDLER *	SmiHandler,
		IN SMI_ENTRY *	SmiEntry
	)

Remove SmiHandler and free the memory it used. If SmiEntry is empty, remove SmiEntry and free the memory it used.

Parameters

SmiHandler	Points to SMI handler.
SmiEntry	Points to SMI Entry or NULL for root SMI handlers.

Return values

TRUE	SmiEntry is removed.
FALSE	SmiEntry is not removed.

Definition at line 98 of file Smi.c.

SmiHandlerRegister()

EFI_STATUS EFIAPI SmiHandlerRegister	(	IN EFI_SMM_HANDLER_ENTRY_POINT2	Handler,
		IN CONST EFI_GUID *HandlerType	OPTIONAL,
		OUT EFI_HANDLE *	DispatchHandle
	)

Registers a handler to execute within SMM.

Parameters

Handler	Handler service function pointer.
HandlerType	Points to the handler type or NULL for root SMI handlers.
DispatchHandle	On return, contains a unique handle which can be used to later unregister the handler function.

Return values

EFI_SUCCESS	Handler register success.
EFI_INVALID_PARAMETER	Handler or DispatchHandle is NULL.

Definition at line 334 of file Smi.c.

SmiHandlerUnRegister()

EFI_STATUS EFIAPI SmiHandlerUnRegister

(

IN EFI_HANDLE

DispatchHandle

)

Unregister a handler in SMM.

Parameters

DispatchHandle

The handle that was specified when the handler was registered.

Return values

EFI_SUCCESS	Handler function was successfully unregistered.
EFI_INVALID_PARAMETER	DispatchHandle does not refer to a valid handle.

Definition at line 394 of file Smi.c.

SmiManage()

EFI_STATUS EFIAPI SmiManage	(	IN CONST EFI_GUID *	HandlerType,
		IN CONST VOID *Context	OPTIONAL,
		IN OUT VOID *CommBuffer	OPTIONAL,
		IN OUT UINTN *CommBufferSize	OPTIONAL
	)

Manage SMI of a particular type.

Parameters

HandlerType	Points to the handler type or NULL for root SMI handlers.
Context	Points to an optional context buffer.
CommBuffer	Points to the optional communication buffer.
CommBufferSize	Points to the size of the optional communication buffer.

Return values

EFI_WARN_INTERRUPT_SOURCE_PENDING	Interrupt source was processed successfully but not quiesced.
EFI_INTERRUPT_PENDING	One or more SMI sources could not be quiesced.
EFI_NOT_FOUND	Interrupt source was not handled or quiesced.
EFI_SUCCESS	Interrupt source was handled and quiesced.

Definition at line 137 of file Smi.c.

SmmCoreFindSmiEntry()

SMI_ENTRY *EFIAPI SmmCoreFindSmiEntry	(	IN EFI_GUID *	HandlerType,
		IN BOOLEAN	Create
	)

Finds the SMI entry for the requested handler type.

Parameters

HandlerType	The type of the interrupt
Create	Create a new entry if not found

Returns

SMI entry

Definition at line 36 of file Smi.c.

Variable Documentation

mRootSmiEntry

SMI_ENTRY mRootSmiEntry

Initial value:

= {
  SMI_ENTRY_SIGNATURE,
  INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiEntry.AllEntries),
  { 0 },
  INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiEntry.SmiHandlers),
}

Definition at line 18 of file Smi.c.

mSmiEntryList

LIST_ENTRY mSmiEntryList = INITIALIZE_LIST_HEAD_VARIABLE (mSmiEntryList)

Definition at line 16 of file Smi.c.

mSmiManageCallingDepth

UINTN mSmiManageCallingDepth = 0

Definition at line 14 of file Smi.c.