Fix doxgen format issue.

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

/** @file\r
  Common header file for CPU Exception Handler Library.\r
\r
  Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _CPU_EXCEPTION_COMMON_H_\r
#define _CPU_EXCEPTION_COMMON_H_\r
\r
#include <Library/BaseLib.h>\r
#include <Library/SerialPortLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/LocalApicLib.h>\r
#include <Library/PeCoffGetEntryPointLib.h>\r
\r
#define  CPU_EXCEPTION_NUM     32\r
//\r
// Record exception handler information\r
//\r
typedef struct {\r
  UINTN ExceptionStart;\r
  UINTN ExceptionStubHeaderSize;\r
} EXCEPTION_HANDLER_TEMPLATE_MAP;\r
\r
extern UINT32           mErrorCodeFlag;\r
extern CONST UINTN      mImageAlignSize;\r
\r
/**\r
  Return address map of exception handler template so that C code can generate\r
  exception tables.\r
\r
  @param AddressMap  Pointer to a buffer where the address map is returned.\r
**/\r
VOID\r
EFIAPI\r
GetTemplateAddressMap (\r
  OUT EXCEPTION_HANDLER_TEMPLATE_MAP *AddressMap\r
  );\r
\r
/**\r
  Internal function to setup CPU exception handlers.\r
\r
**/\r
VOID\r
InternalSetupCpuExceptionHandlers (\r
  VOID\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
/**\r
  Find and display image base address and return image base and its entry point.\r
  \r
  @param CurrentEip      Current instruction pointer.\r
  @param EntryPoint      Return module entry point if module header is found.\r
  \r
  @return !0     Image base address.\r
  @return 0      Image header cannot be found.\r
**/\r
UINTN \r
FindModuleImageBase (\r
  IN  UINTN              CurrentEip,\r
  OUT UINTN              *EntryPoint\r
  );\r
\r
/**\r
  Display CPU information.\r
\r
  @param InterruptType  Exception type.\r
  @param SystemContext  Pointer to EFI_SYSTEM_CONTEXT.\r
**/\r
VOID\r
DumpCpuContent (\r
  IN UINTN                InterruptType,\r
  IN EFI_SYSTEM_CONTEXT   SystemContext\r
  );\r
\r
#endif\r