TianoCore EDK2 master
Loading...
Searching...
No Matches
Data Structures | Functions | Variables
PeiCpuException.c File Reference
#include <PiPei.h>
#include "CpuExceptionCommon.h"
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PcdLib.h>

Go to the source code of this file.

Data Structures

struct  EXCEPTION0_STUB_HEADER
 

Functions

EXCEPTION_HANDLER_DATA * GetExceptionHandlerData (VOID)
 
VOID SetExceptionHandlerData (IN EXCEPTION_HANDLER_DATA *ExceptionHandlerData)
 
VOID EFIAPI CommonExceptionHandler (IN EFI_EXCEPTION_TYPE ExceptionType, IN EFI_SYSTEM_CONTEXT SystemContext)
 
EFI_STATUS EFIAPI RegisterCpuInterruptHandler (IN EFI_EXCEPTION_TYPE InterruptType, IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler)
 
EFI_STATUS EFIAPI InitializeCpuExceptionHandlers (IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL)
 
EFI_STATUS EFIAPI InitializeSeparateExceptionStacks (IN VOID *Buffer, IN OUT UINTN *BufferSize)
 

Variables

CONST UINTN mDoFarReturnFlag = 0
 

Detailed Description

CPU exception handler library implementation for PEIM module.

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

Definition in file PeiCpuException.c.

Function Documentation

◆ CommonExceptionHandler()

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

Common exception handler.

Parameters
ExceptionTypeException type.
SystemContextPointer to EFI_SYSTEM_CONTEXT.

Definition at line 96 of file PeiCpuException.c.

◆ GetExceptionHandlerData()

EXCEPTION_HANDLER_DATA * GetExceptionHandlerData ( VOID  )

Get exception handler data pointer from IDT[0].

The exception #0 stub header is duplicated in an allocated pool with extra 4-byte/8-byte to store the exception handler data. The new allocated memory layout follows structure EXCEPTION0_STUB_HEADER. The code assumes that all processors uses the same exception handler for #0 exception.

Returns
pointer to exception handler data.

Definition at line 33 of file PeiCpuException.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. 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 163 of file PeiCpuException.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 216 of file PeiCpuException.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.

Definition at line 132 of file PeiCpuException.c.

◆ SetExceptionHandlerData()

VOID SetExceptionHandlerData ( IN EXCEPTION_HANDLER_DATA *  ExceptionHandlerData)

Set exception handler data pointer to IDT[0].

The exception #0 stub header is duplicated in an allocated pool with extra 4-byte/8-byte to store the exception handler data. The new allocated memory layout follows structure EXCEPTION0_STUB_HEADER. The code assumes that all processors uses the same exception handler for #0 exception.

Parameters
ExceptionHandlerDatapointer to exception handler data.

Definition at line 58 of file PeiCpuException.c.

Variable Documentation

◆ mDoFarReturnFlag

CONST UINTN mDoFarReturnFlag = 0

Definition at line 16 of file PeiCpuException.c.