MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Library / CpuExceptionHandlerLib.h

/** @file\r
  CPU Exception library provides the default CPU interrupt/exception handler.\r
  It also provides capability to register user interrupt/exception handler.\r
\r
  Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __CPU_EXCEPTION_HANDLER_LIB_H__\r
#define __CPU_EXCEPTION_HANDLER_LIB_H__\r
\r
#include <Ppi/VectorHandoffInfo.h>\r
#include <Protocol/Cpu.h>\r
\r
#define CPU_EXCEPTION_INIT_DATA_REV     1\r
\r
typedef union {\r
  struct {\r
    //\r
    // Revision number of this structure.\r
    //\r
    UINT32                    Revision;\r
    //\r
    // The address of top of known good stack reserved for *ALL* exceptions\r
    // listed in field StackSwitchExceptions.\r
    //\r
    UINTN                     KnownGoodStackTop;\r
    //\r
    // The size of known good stack for *ONE* exception only.\r
    //\r
    UINTN                     KnownGoodStackSize;\r
    //\r
    // Buffer of exception vector list for stack switch.\r
    //\r
    UINT8                     *StackSwitchExceptions;\r
    //\r
    // Number of exception vectors in StackSwitchExceptions.\r
    //\r
    UINTN                     StackSwitchExceptionNumber;\r
    //\r
    // Buffer of IDT table. It must be type of IA32_IDT_GATE_DESCRIPTOR.\r
    // Normally there's no need to change IDT table size.\r
    //\r
    VOID                      *IdtTable;\r
    //\r
    // Size of buffer for IdtTable.\r
    //\r
    UINTN                     IdtTableSize;\r
    //\r
    // Buffer of GDT table. It must be type of IA32_SEGMENT_DESCRIPTOR.\r
    //\r
    VOID                      *GdtTable;\r
    //\r
    // Size of buffer for GdtTable.\r
    //\r
    UINTN                     GdtTableSize;\r
    //\r
    // Pointer to start address of descriptor of exception task gate in the\r
    // GDT table. It must be type of IA32_TSS_DESCRIPTOR.\r
    //\r
    VOID                      *ExceptionTssDesc;\r
    //\r
    // Size of buffer for ExceptionTssDesc.\r
    //\r
    UINTN                     ExceptionTssDescSize;\r
    //\r
    // Buffer of task-state segment for exceptions. It must be type of\r
    // IA32_TASK_STATE_SEGMENT.\r
    //\r
    VOID                      *ExceptionTss;\r
    //\r
    // Size of buffer for ExceptionTss.\r
    //\r
    UINTN                     ExceptionTssSize;\r
    //\r
    // Flag to indicate if default handlers should be initialized or not.\r
    //\r
    BOOLEAN                   InitDefaultHandlers;\r
  } Ia32, X64;\r
} CPU_EXCEPTION_INIT_DATA;\r
\r
/**\r
  Initializes all CPU exceptions entries and provides the default exception handlers.\r
\r
  Caller should try to get an array of interrupt and/or exception vectors that are in use and need to\r
  persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.\r
  If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.\r
  If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.\r
\r
  @param[in]  VectorInfo    Pointer to reserved vector list.\r
\r
  @retval EFI_SUCCESS           CPU Exception Entries have been successfully initialized\r
                                with default exception handlers.\r
  @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.\r
  @retval EFI_UNSUPPORTED       This function is not supported.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeCpuExceptionHandlers (\r
  IN EFI_VECTOR_HANDOFF_INFO       *VectorInfo OPTIONAL\r
  );\r
\r
/**\r
  Initializes all CPU exceptions entries with optional extra initializations.\r
\r
  By default, this method should include all functionalities implemented by\r
  InitializeCpuExceptionHandlers(), plus extra initialization works, if any.\r
  This could be done by calling InitializeCpuExceptionHandlers() directly\r
  in this method besides the extra works.\r
\r
  InitData is optional and its use and content are processor arch dependent.\r
  The typical usage of it is to convey resources which have to be reserved\r
  elsewhere and are necessary for the extra initializations of exception.\r
\r
  @param[in]  VectorInfo    Pointer to reserved vector list.\r
  @param[in]  InitData      Pointer to data optional for extra initializations\r
                            of exception.\r
\r
  @retval EFI_SUCCESS             The exceptions have been successfully\r
                                  initialized.\r
  @retval EFI_INVALID_PARAMETER   VectorInfo or InitData contains invalid\r
                                  content.\r
  @retval EFI_UNSUPPORTED         This function is not supported.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeCpuExceptionHandlersEx (\r
  IN EFI_VECTOR_HANDOFF_INFO            *VectorInfo OPTIONAL,\r
  IN CPU_EXCEPTION_INIT_DATA            *InitData OPTIONAL\r
  );\r
\r
/**\r
  Initializes all CPU interrupt/exceptions entries and provides the default interrupt/exception handlers.\r
\r
  Caller should try to get an array of interrupt and/or exception vectors that are in use and need to\r
  persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.\r
  If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.\r
  If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.\r
\r
  @param[in]  VectorInfo    Pointer to reserved vector list.\r
\r
  @retval EFI_SUCCESS           All CPU interrupt/exception entries have been successfully initialized\r
                                with default interrupt/exception handlers.\r
  @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.\r
  @retval EFI_UNSUPPORTED       This function is not supported.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
InitializeCpuInterruptHandlers (\r
  IN EFI_VECTOR_HANDOFF_INFO       *VectorInfo OPTIONAL\r
  );\r
\r
/**\r
  Registers a function to be called from the processor interrupt handler.\r
\r
  This function registers and enables the handler specified by InterruptHandler for a processor\r
  interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the\r
  handler for the processor interrupt or exception type specified by InterruptType is uninstalled.\r
  The installed handler is called once for each processor interrupt or exception.\r
  NOTE: This function should be invoked after InitializeCpuExceptionHandlers() or\r
  InitializeCpuInterruptHandlers() invoked, otherwise EFI_UNSUPPORTED returned.\r
\r
  @param[in]  InterruptType     Defines which interrupt or exception to hook.\r
  @param[in]  InterruptHandler  A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r
                                when a processor interrupt occurs. If this parameter is NULL, then the handler\r
                                will be uninstalled.\r
\r
  @retval EFI_SUCCESS           The handler for the processor interrupt was successfully installed or uninstalled.\r
  @retval EFI_ALREADY_STARTED   InterruptHandler is not NULL, and a handler for InterruptType was\r
                                previously installed.\r
  @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
                                previously installed.\r
  @retval EFI_UNSUPPORTED       The interrupt specified by InterruptType is not supported,\r
                                or this function is not supported.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterCpuInterruptHandler (\r
  IN EFI_EXCEPTION_TYPE            InterruptType,\r
  IN EFI_CPU_INTERRUPT_HANDLER     InterruptHandler\r
  );\r
\r
/**\r
  Display processor context.\r
\r
  @param[in] ExceptionType  Exception type.\r
  @param[in] SystemContext  Processor context to be display.\r
**/\r
VOID\r
EFIAPI\r
DumpCpuContext (\r
  IN EFI_EXCEPTION_TYPE   ExceptionType,\r
  IN EFI_SYSTEM_CONTEXT   SystemContext\r
  );\r
\r
#endif\r