UefiCpuPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / UefiCpuPkg / Library / CpuExceptionHandlerLib / CpuExceptionCommon.c

/** @file\r
  CPU Exception Handler Library common functions.\r
\r
  Copyright (c) 2012 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "CpuExceptionCommon.h"\r
\r
//\r
// Error code flag indicating whether or not an error code will be\r
// pushed on the stack if an exception occurs.\r
//\r
// 1 means an error code will be pushed, otherwise 0\r
//\r
CONST UINT32 mErrorCodeFlag = 0x00227d00;\r
\r
//\r
// Define the maximum message length\r
//\r
#define MAX_DEBUG_MESSAGE_LENGTH  0x100\r
\r
CONST CHAR8 mExceptionReservedStr[] = "Reserved";\r
CONST CHAR8 *mExceptionNameStr[] = {\r
  "#DE - Divide Error",\r
  "#DB - Debug",\r
  "NMI Interrupt",\r
  "#BP - Breakpoint",\r
  "#OF - Overflow",\r
  "#BR - BOUND Range Exceeded",\r
  "#UD - Invalid Opcode",\r
  "#NM - Device Not Available",\r
  "#DF - Double Fault",\r
  "Coprocessor Segment Overrun",\r
  "#TS - Invalid TSS",\r
  "#NP - Segment Not Present",\r
  "#SS - Stack Fault Fault",\r
  "#GP - General Protection",\r
  "#PF - Page-Fault",\r
  "Reserved",\r
  "#MF - x87 FPU Floating-Point Error",\r
  "#AC - Alignment Check",\r
  "#MC - Machine-Check",\r
  "#XM - SIMD floating-point",\r
  "#VE - Virtualization",\r
  "#CP - Control Protection"\r
};\r
\r
#define EXCEPTION_KNOWN_NAME_NUM  (sizeof (mExceptionNameStr) / sizeof (CHAR8 *))\r
\r
/**\r
  Get ASCII format string exception name by exception type.\r
\r
  @param ExceptionType  Exception type.\r
\r
  @return  ASCII format string exception name.\r
**/\r
CONST CHAR8 *\r
GetExceptionNameStr (\r
  IN EFI_EXCEPTION_TYPE          ExceptionType\r
  )\r
{\r
  if ((UINTN) ExceptionType < EXCEPTION_KNOWN_NAME_NUM) {\r
    return mExceptionNameStr[ExceptionType];\r
  } else {\r
    return mExceptionReservedStr;\r
  }\r
}\r
\r
/**\r
  Prints a message to the serial port.\r
\r
  @param  Format      Format string for the message to print.\r
  @param  ...         Variable argument list whose contents are accessed\r
                      based on the format string specified by Format.\r
\r
**/\r
VOID\r
EFIAPI\r
InternalPrintMessage (\r
  IN  CONST CHAR8  *Format,\r
  ...\r
  )\r
{\r
  CHAR8    Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
  VA_LIST  Marker;\r
\r
  //\r
  // Convert the message to an ASCII String\r
  //\r
  VA_START (Marker, Format);\r
  AsciiVSPrint (Buffer, sizeof (Buffer), Format, Marker);\r
  VA_END (Marker);\r
\r
  //\r
  // Send the print string to a Serial Port\r
  //\r
  SerialPortWrite ((UINT8 *)Buffer, AsciiStrLen (Buffer));\r
}\r
\r
/**\r
  Find and display image base address and return image base and its entry point.\r
\r
  @param CurrentEip      Current instruction pointer.\r
\r
**/\r
VOID\r
DumpModuleImageInfo (\r
  IN  UINTN              CurrentEip\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  UINTN                                Pe32Data;\r
  VOID                                 *PdbPointer;\r
  VOID                                 *EntryPoint;\r
\r
  Pe32Data = PeCoffSearchImageBase (CurrentEip);\r
  if (Pe32Data == 0) {\r
    InternalPrintMessage ("!!!! Can't find image information. !!!!\n");\r
  } else {\r
    //\r
    // Find Image Base entry point\r
    //\r
    Status = PeCoffLoaderGetEntryPoint ((VOID *) Pe32Data, &EntryPoint);\r
    if (EFI_ERROR (Status)) {\r
      EntryPoint = NULL;\r
    }\r
    InternalPrintMessage ("!!!! Find image based on IP(0x%x) ", CurrentEip);\r
    PdbPointer = PeCoffLoaderGetPdbPointer ((VOID *) Pe32Data);\r
    if (PdbPointer != NULL) {\r
      InternalPrintMessage ("%a", PdbPointer);\r
    } else {\r
      InternalPrintMessage ("(No PDB) " );\r
    }\r
    InternalPrintMessage (\r
      " (ImageBase=%016lp, EntryPoint=%016p) !!!!\n",\r
      (VOID *) Pe32Data,\r
      EntryPoint\r
      );\r
  }\r
}\r
\r
/**\r
  Read and save reserved vector information\r
\r
  @param[in]  VectorInfo        Pointer to reserved vector list.\r
  @param[out] ReservedVector    Pointer to reserved vector data buffer.\r
  @param[in]  VectorCount       Vector number to be updated.\r
\r
  @return EFI_SUCCESS           Read and save vector info successfully.\r
  @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.\r
\r
**/\r
EFI_STATUS\r
ReadAndVerifyVectorInfo (\r
  IN  EFI_VECTOR_HANDOFF_INFO       *VectorInfo,\r
  OUT RESERVED_VECTORS_DATA         *ReservedVector,\r
  IN  UINTN                         VectorCount\r
  )\r
{\r
  while (VectorInfo->Attribute != EFI_VECTOR_HANDOFF_LAST_ENTRY) {\r
    if (VectorInfo->Attribute > EFI_VECTOR_HANDOFF_HOOK_AFTER) {\r
      //\r
      // If vector attrubute is invalid\r
      //\r
      return EFI_INVALID_PARAMETER;\r
    }\r
    if (VectorInfo->VectorNumber < VectorCount) {\r
      ReservedVector[VectorInfo->VectorNumber].Attribute = VectorInfo->Attribute;\r
    }\r
    VectorInfo ++;\r
  }\r
  return EFI_SUCCESS;\r
}\r