#include <PiSmm.h>
#include "CpuExceptionCommon.h"

Functions
VOID EFIAPI	CommonExceptionHandler (IN EFI_EXCEPTION_TYPE ExceptionType, IN EFI_SYSTEM_CONTEXT SystemContext)

EFI_STATUS EFIAPI	InitializeCpuExceptionHandlers (IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL)

EFI_STATUS EFIAPI	RegisterCpuInterruptHandler (IN EFI_EXCEPTION_TYPE InterruptType, IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler)

EFI_STATUS EFIAPI	InitializeSeparateExceptionStacks (IN VOID Buffer, IN OUT UINTN BufferSize)

Variables
CONST UINTN	mDoFarReturnFlag = 1

RESERVED_VECTORS_DATA	mReservedVectorsData [CPU_EXCEPTION_NUM]

EFI_CPU_INTERRUPT_HANDLER	mExternalInterruptHandlerTable [CPU_EXCEPTION_NUM]

EXCEPTION_HANDLER_DATA	mExceptionHandlerData

Detailed Description

CPU exception handler library implementation for SMM modules.

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

Definition in file SmmException.c.

Function Documentation

◆ CommonExceptionHandler()

VOID EFIAPI CommonExceptionHandler	(	IN EFI_EXCEPTION_TYPE	ExceptionType,
		IN EFI_SYSTEM_CONTEXT	SystemContext
	)

Common exception handler.

Parameters

ExceptionType	Exception type.
SystemContext	Pointer to EFI_SYSTEM_CONTEXT.

Definition at line 31 of file SmmException.c.

◆ InitializeCpuExceptionHandlers()

EFI_STATUS EFIAPI InitializeCpuExceptionHandlers ( IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL )

Initializes all CPU exceptions entries and provides the default exception handlers.

Caller should try to get an array of interrupt and/or exception vectors that are in use and need to persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification. If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL. If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.

Parameters

[in] VectorInfo Pointer to reserved vector list.

Return values

EFI_SUCCESS	CPU Exception Entries have been successfully initialized with default exception handlers.
EFI_INVALID_PARAMETER	VectorInfo includes the invalid content if VectorInfo is not NULL.
EFI_UNSUPPORTED	This function is not supported.

Definition at line 57 of file SmmException.c.

◆ InitializeSeparateExceptionStacks()

EFI_STATUS EFIAPI InitializeSeparateExceptionStacks	(	IN VOID *	Buffer,
		IN OUT UINTN *	BufferSize
	)

Setup separate stacks for certain exception handlers. If the input Buffer and BufferSize are both NULL, use global variable if possible.

Parameters

[in]	Buffer	Point to buffer used to separate exception stack.
[in,out]	BufferSize	On input, it indicates the byte size of Buffer. If the size is not enough, the return status will be EFI_BUFFER_TOO_SMALL, and output BufferSize will be the size it needs.

Return values

EFI_SUCCESS	The stacks are assigned successfully.
EFI_UNSUPPORTED	This function is not supported.
EFI_BUFFER_TOO_SMALL	This BufferSize is too small.

Definition at line 114 of file SmmException.c.

◆ RegisterCpuInterruptHandler()

EFI_STATUS EFIAPI RegisterCpuInterruptHandler	(	IN EFI_EXCEPTION_TYPE	InterruptType,
		IN EFI_CPU_INTERRUPT_HANDLER	InterruptHandler
	)

Registers a function to be called from the processor interrupt handler.

This function registers and enables the handler specified by InterruptHandler for a processor interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the handler for the processor interrupt or exception type specified by InterruptType is uninstalled. The installed handler is called once for each processor interrupt or exception. NOTE: This function should be invoked after InitializeCpuExceptionHandlers() is invoked, otherwise EFI_UNSUPPORTED returned.

Parameters

[in]	InterruptType	Defines which interrupt or exception to hook.
[in]	InterruptHandler	A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called when a processor interrupt occurs. If this parameter is NULL, then the handler will be uninstalled.

Return values

EFI_SUCCESS	The handler for the processor interrupt was successfully installed or uninstalled.
EFI_ALREADY_STARTED	InterruptHandler is not NULL, and a handler for InterruptType was previously installed.
EFI_INVALID_PARAMETER	InterruptHandler is NULL, and a handler for InterruptType was not previously installed.
EFI_UNSUPPORTED	The interrupt specified by InterruptType is not supported, or this function is not supported.

Definition at line 90 of file SmmException.c.

Variable Documentation

◆ mDoFarReturnFlag

CONST UINTN mDoFarReturnFlag = 1

Definition at line 12 of file SmmException.c.

◆ mExceptionHandlerData

EXCEPTION_HANDLER_DATA mExceptionHandlerData

Initial value:

= {
  CPU_EXCEPTION_NUM,
  0,                     
  mReservedVectorsData,
  mExternalInterruptHandlerTable
}

Definition at line 16 of file SmmException.c.

◆ mExternalInterruptHandlerTable

EFI_CPU_INTERRUPT_HANDLER mExternalInterruptHandlerTable[CPU_EXCEPTION_NUM]

Definition at line 15 of file SmmException.c.

◆ mReservedVectorsData

RESERVED_VECTORS_DATA mReservedVectorsData[CPU_EXCEPTION_NUM]

Definition at line 14 of file SmmException.c.

Functions

Variables

Detailed Description

Function Documentation

◆ CommonExceptionHandler()

◆ InitializeCpuExceptionHandlers()

◆ InitializeSeparateExceptionStacks()

◆ RegisterCpuInterruptHandler()

Variable Documentation

◆ mDoFarReturnFlag

◆ mExceptionHandlerData

◆ mExternalInterruptHandlerTable

◆ mReservedVectorsData