remove some comments introduced by tools.

[mirror_edk2.git] / MdeModulePkg / Universal / DebugSupportDxe / ipf / plDebugSupport.h

/**@file\r
  IPF specific debugsupport types, macros, and definitions.\r
  \r
Copyright (c) 2004 - 2006 Intel Corporation                                                         \r
All rights reserved. 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 _PLDEBUG_SUPPORT_H\r
#define _PLDEBUG_SUPPORT_H\r
\r
//\r
// The package level header files this module uses\r
//\r
#include <PiDxe.h>\r
//\r
// The protocols, PPI and GUID defintions for this module\r
//\r
#include <Protocol/DebugSupport.h>\r
#include <Protocol/LoadedImage.h>\r
//\r
// The Library classes this module consumes\r
//\r
#include <Library/DebugLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/PcdLib.h>\r
\r
#define DISABLE_INTERRUPTS  0UL\r
\r
//\r
// The remaining definitions comprise the protocol members.\r
//\r
#define EFI_ISA IsaIpf\r
\r
//\r
// processor specific functions that must be public\r
//\r
EFI_STATUS\r
plInitializeDebugSupportDriver (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
  IPF specific DebugSupport driver initialization.  Must be public because it's\r
  referenced from DebugSupport.c\r
\r
Arguments:\r
\r
Returns:\r
\r
  EFI_SUCCESS\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
plUnloadDebugSupportDriver (\r
  IN EFI_HANDLE                   ImageHandle\r
  )\r
/*++\r
\r
Routine Description:\r
  Unload handler that is called during UnloadImage() - deallocates pool memory\r
  used by the driver.  Must be public because it's referenced from DebugSuport.c\r
\r
Arguments:\r
  ImageHandle - Image handle\r
\r
Returns:\r
\r
  EFI_STATUS - anything other than EFI_SUCCESS indicates the callback was not registered.\r
\r
--*/\r
;\r
\r
//\r
// Assembly worker functions and data referenced from plDebugSupport.c\r
//\r
VOID  *\r
GetIva (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  C callable function to obtain the current value of IVA\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  Current value if IVA\r
\r
--*/\r
;\r
\r
VOID\r
HookStub (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  HookStub will be copied from it's loaded location into the IVT when\r
  an IVT entry is hooked.\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
;\r
\r
VOID\r
ChainHandler (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Chains an interrupt handler\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
;\r
\r
VOID\r
UnchainHandler (\r
  VOID\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Unchains an interrupt handler\r
\r
Arguments:\r
\r
  None\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
;\r
\r
UINT64\r
ProgramInterruptFlags (\r
  IN UINT64                       NewInterruptState\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  C callable function to enable/disable interrupts\r
\r
Arguments:\r
\r
  NewInterruptState - New Interrupt State\r
\r
Returns:\r
\r
  Previous state of psr.ic\r
\r
--*/\r
;\r
\r
VOID\r
InstructionCacheFlush (\r
  IN VOID    *StartAddress,\r
  IN UINTN   SizeInBytes\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Flushes instruction cache for specified number of bytes\r
\r
Arguments:\r
\r
  StartAddress  - Cache Start Address\r
  SizeInBytes   - Cache Size\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
GetMaximumProcessorIndex (\r
  IN EFI_DEBUG_SUPPORT_PROTOCOL   *This,\r
  OUT UINTN                       *MaxProcessorIndex\r
  )\r
/*++\r
\r
Routine Description: This is a DebugSupport protocol member function.  Hard\r
  coded to support only 1 processor for now.\r
\r
Arguments:\r
  This              - The DebugSupport instance\r
  MaxProcessorIndex - The maximuim supported processor index\r
\r
Returns:\r
  Always returns EFI_SUCCESS with *MaxProcessorIndex set to 0\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
RegisterPeriodicCallback (\r
  IN EFI_DEBUG_SUPPORT_PROTOCOL   *This,\r
  IN UINTN                        ProcessorIndex,\r
  IN EFI_PERIODIC_CALLBACK        PeriodicCallback\r
  )\r
/*++\r
\r
Routine Description:\r
  DebugSupport protocol member function\r
\r
Arguments:\r
  This             - The DebugSupport instance\r
  ProcessorIndex   - Which processor the callback applies to.\r
  PeriodicCallback - Callback function\r
\r
Returns:\r
\r
  EFI_STATUS - anything other than EFI_SUCCESS indicates the callback was not registered.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
RegisterExceptionCallback (\r
  IN EFI_DEBUG_SUPPORT_PROTOCOL   *This,\r
  IN UINTN                        ProcessorIndex,\r
  IN EFI_EXCEPTION_CALLBACK       NewHandler,\r
  IN EFI_EXCEPTION_TYPE           ExceptionType\r
  )\r
/*++\r
\r
Routine Description:\r
  DebugSupport protocol member function\r
\r
Arguments:\r
  This             - The DebugSupport instance\r
  ProcessorIndex   - Which processor the callback applies to.\r
  NewCallback      - Callback function\r
  ExceptionType    - Which exception to hook\r
\r
Returns:\r
\r
  EFI_STATUS - anything other than EFI_SUCCESS indicates the callback was not registered.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
InvalidateInstructionCache (\r
  IN EFI_DEBUG_SUPPORT_PROTOCOL   *This,\r
  IN UINTN                        ProcessorIndex,\r
  IN VOID                         *Start,\r
  IN UINTN                        Length\r
  )\r
/*++\r
\r
Routine Description:\r
  DebugSupport protocol member function.  Calls assembly routine to flush cache.\r
\r
Arguments:\r
  This             - The DebugSupport instance\r
  ProcessorIndex   - Which processor the callback applies to.\r
  Start            - Physical base of the memory range to be invalidated\r
  Length           - mininum number of bytes in instruction cache to invalidate\r
\r
Returns:\r
  EFI_SUCCESS\r
\r
--*/\r
;\r
\r
VOID\r
CommonHandler (\r
  IN EFI_EXCEPTION_TYPE ExceptionType,\r
  IN EFI_SYSTEM_CONTEXT Context\r
  )\r
/*++\r
\r
Routine Description:\r
  C routine that is called for all registered exceptions.  This is the main\r
  exception dispatcher.  Must be public because it's referenced from AsmFuncs.s.\r
\r
Arguments:\r
  ExceptionType - Exception Type\r
  Context       - System Context\r
\r
Returns:\r
\r
  Nothing\r
  \r
--*/\r
;\r
\r
#endif\r