CpuExceptionHandlerLib.h File Reference

Data Structures
union	CPU_EXCEPTION_INIT_DATA

Macros
#define	CPU_EXCEPTION_INIT_DATA_REV   1

Functions
EFI_STATUS EFIAPI	InitializeCpuExceptionHandlers (IN EFI_VECTOR_HANDOFF_INFO *VectorInfo)
EFI_STATUS EFIAPI	InitializeCpuExceptionHandlersEx (IN EFI_VECTOR_HANDOFF_INFO *VectorInfo, IN CPU_EXCEPTION_INIT_DATA *InitData)
EFI_STATUS EFIAPI	InitializeCpuInterruptHandlers (IN EFI_VECTOR_HANDOFF_INFO *VectorInfo)
EFI_STATUS EFIAPI	RegisterCpuInterruptHandler (IN EFI_EXCEPTION_TYPE InterruptType, IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler)
VOID EFIAPI	DumpCpuContext (IN EFI_EXCEPTION_TYPE ExceptionType, IN EFI_SYSTEM_CONTEXT SystemContext)

Detailed Description

CPU Exception library provides the default CPU interrupt/exception handler. It also provides capability to register user interrupt/exception handler.

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

Macro Definition Documentation

#define CPU_EXCEPTION_INIT_DATA_REV   1

Function Documentation

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

Display processor context.

Parameters

[in]	ExceptionType	Exception type.
[in]	SystemContext	Processor context to be display.

EFI_STATUS EFIAPI InitializeCpuExceptionHandlers

(

IN EFI_VECTOR_HANDOFF_INFO *

VectorInfo

)

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.

EFI_STATUS EFIAPI InitializeCpuExceptionHandlersEx	(	IN EFI_VECTOR_HANDOFF_INFO *	VectorInfo,
		IN CPU_EXCEPTION_INIT_DATA *	InitData
	)

Initializes all CPU exceptions entries with optional extra initializations.

By default, this method should include all functionalities implemented by InitializeCpuExceptionHandlers(), plus extra initialization works, if any. This could be done by calling InitializeCpuExceptionHandlers() directly in this method besides the extra works.

InitData is optional and its use and content are processor arch dependent. The typical usage of it is to convey resources which have to be reserved elsewhere and are necessary for the extra initializations of exception.

Parameters

[in]	VectorInfo	Pointer to reserved vector list.
[in]	InitData	Pointer to data optional for extra initializations of exception.

Return values

EFI_SUCCESS	The exceptions have been successfully initialized.
EFI_INVALID_PARAMETER	VectorInfo or InitData contains invalid content.
EFI_UNSUPPORTED	This function is not supported.

EFI_STATUS EFIAPI InitializeCpuInterruptHandlers

(

IN EFI_VECTOR_HANDOFF_INFO *

VectorInfo

)

Initializes all CPU interrupt/exceptions entries and provides the default interrupt/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	All CPU interrupt/exception entries have been successfully initialized with default interrupt/exception handlers.
EFI_INVALID_PARAMETER	VectorInfo includes the invalid content if VectorInfo is not NULL.
EFI_UNSUPPORTED	This function is not supported.

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() or InitializeCpuInterruptHandlers() 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.