TianoCore EDK2 master
Loading...
Searching...
No Matches
CpuExceptionHandlerLib.h File Reference

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI InitializeCpuExceptionHandlers (IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL)
 
EFI_STATUS EFIAPI InitializeSeparateExceptionStacks (IN VOID *Buffer, IN OUT UINTN *BufferSize)
 
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 - 2022, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CpuExceptionHandlerLib.h.

Function Documentation

◆ DumpCpuContext()

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

Display processor context.

Parameters
[in]ExceptionTypeException type.
[in]SystemContextProcessor context to be display.

Display CPU information. This can be called by 3rd-party handlers set by RegisterCpuInterruptHandler.

Parameters
ExceptionTypeException type.
SystemContextPointer to EFI_SYSTEM_CONTEXT.

Display CPU information.

Parameters
ExceptionTypeException type.
SystemContextPointer to EFI_SYSTEM_CONTEXT.

Definition at line 77 of file CpuExceptionHandlerLibNull.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]VectorInfoPointer to reserved vector list.
Return values
EFI_SUCCESSCPU Exception Entries have been successfully initialized with default exception handlers.
EFI_INVALID_PARAMETERVectorInfo includes the invalid content if VectorInfo is not NULL.
EFI_UNSUPPORTEDThis function is not supported.

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

Always return EFI_SUCCESS in the SEC exception initialization module.

Parameters
[in]VectorInfoPointer to reserved vector list.
Return values
EFI_SUCCESSCPU Exception Entries have been successfully initialized with default exception handlers.

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. Note: Before invoking this API, caller must allocate memory for IDT table and load IDTR by AsmWriteIdtr().

Parameters
[in]VectorInfoPointer to reserved vector list.
Return values
EFI_SUCCESSCPU Exception Entries have been successfully initialized with default exception handlers.
EFI_INVALID_PARAMETERVectorInfo includes the invalid content if VectorInfo is not NULL.
EFI_UNSUPPORTEDThis function is not supported.

Definition at line 89 of file ArmExceptionLib.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]BufferPoint to buffer used to separate exception stack.
[in,out]BufferSizeOn 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_SUCCESSThe stacks are assigned successfully.
EFI_UNSUPPORTEDThis function is not supported.
EFI_BUFFER_TOO_SMALLThis BufferSize is too small.

Definition at line 305 of file ArmExceptionLib.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]InterruptTypeDefines which interrupt or exception to hook.
[in]InterruptHandlerA 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_SUCCESSThe handler for the processor interrupt was successfully installed or uninstalled.
EFI_ALREADY_STARTEDInterruptHandler is not NULL, and a handler for InterruptType was previously installed.
EFI_INVALID_PARAMETERInterruptHandler is NULL, and a handler for InterruptType was not previously installed.
EFI_UNSUPPORTEDThe interrupt specified by InterruptType is not supported, or this function is not supported.

Registers a function to be called from the processor exception handler. (On ARM/AArch64 this only provides exception handlers, not interrupt handling which is provided through the Hardware Interrupt Protocol.)

This function registers and enables the handler specified by ExceptionHandler for a processor interrupt or exception type specified by ExceptionType. If ExceptionHandler is NULL, then the handler for the processor interrupt or exception type specified by ExceptionType 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]ExceptionTypeDefines which interrupt or exception to hook.
[in]ExceptionHandlerA 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_SUCCESSThe handler for the processor interrupt was successfully installed or uninstalled.
EFI_ALREADY_STARTEDExceptionHandler is not NULL, and a handler for ExceptionType was previously installed.
EFI_INVALID_PARAMETERExceptionHandler is NULL, and a handler for ExceptionType was not previously installed.
EFI_UNSUPPORTEDThe interrupt specified by ExceptionType is not supported, or this function is not supported.

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 ExceptionType. If InterruptHandler is NULL, then the handler for the processor interrupt or exception type specified by ExceptionType 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]ExceptionTypeDefines which interrupt or exception to hook.
[in]InterruptHandlerA 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_SUCCESSThe handler for the processor interrupt was successfully installed or uninstalled.
EFI_ALREADY_STARTEDInterruptHandler is not NULL, and a handler for ExceptionType was previously installed.
EFI_INVALID_PARAMETERInterruptHandler is NULL, and a handler for ExceptionType was not previously installed.
EFI_UNSUPPORTEDThe interrupt specified by ExceptionType is not supported, or this function is not supported.

Registers a function to be called from the processor interrupt or exception 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.

Parameters
InterruptTypeA pointer to the processor's current interrupt state. Set to TRUE if interrupts are enabled and FALSE if interrupts are disabled.
InterruptHandlerA 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_SUCCESSThe handler for the processor interrupt was successfully installed or uninstalled.
EFI_ALREADY_STARTEDInterruptHandler is not NULL, and a handler for InterruptType was previously installed.
EFI_INVALID_PARAMETERInterruptHandler is NULL, and a handler for InterruptType was not previously installed.
EFI_UNSUPPORTEDThe interrupt specified by InterruptType is not supported.

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

Always return EFI_UNSUPPORTED in the SEC exception initialization module.

Parameters
InterruptTypeA pointer to the processor's current interrupt state. Set to TRUE if interrupts are enabled and FALSE if interrupts are disabled.
InterruptHandlerA 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_UNSUPPORTEDThe interrupt specified by InterruptType is not supported.

Definition at line 224 of file ArmExceptionLib.c.