MdeModulePkg/EbcDxe: add EBC Debugger

[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbDisasmSupport.h

/*++\r
\r
Copyright (c) 2007, 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
Module Name:\r
\r
  EdbDisasmSupport.h\r
\r
Abstract:\r
\r
\r
--*/\r
\r
#ifndef _EFI_EDB_DISASM_SUPPORT_H_\r
#define _EFI_EDB_DISASM_SUPPORT_H_\r
\r
#include <Uefi.h>\r
\r
#define EDB_BYTECODE_NUMBER_IN_LINE     5\r
\r
#ifdef EFI32\r
#define EDB_PRINT_ADDRESS_FORMAT    L"%08x: "\r
#else\r
// To use 012l instead of 016l because space is not enough\r
#define EDB_PRINT_ADDRESS_FORMAT    L"%012lx: "\r
#endif\r
\r
#define OPCODE_MAX 0x40\r
\r
#define EDB_INSTRUCTION_NAME_MAX_LENGTH     10\r
#define EDB_INSTRUCTION_NAME_MAX_SIZE       (EDB_INSTRUCTION_NAME_MAX_LENGTH * sizeof(CHAR16))\r
#define EDB_INSTRUCTION_CONTENT_MAX_LENGTH  30\r
#define EDB_INSTRUCTION_CONTENT_MAX_SIZE    (EDB_INSTRUCTION_CONTENT_MAX_LENGTH * sizeof(CHAR16))\r
\r
VOID\r
EdbSetOffset (\r
  IN UINTN InstructionNameOffset,\r
  IN UINTN InstructionContentOffset\r
  );\r
\r
CHAR16 *\r
EdbPreInstructionString (\r
  VOID\r
  );\r
\r
CHAR16 *\r
EdbPostInstructionString (\r
  VOID\r
  );\r
\r
UINTN\r
EdbPrintInstructionName (\r
  IN CHAR16                 *Name\r
  );\r
\r
BOOLEAN\r
EdbGetNaturalIndex16 (\r
  IN  UINT16  Data16,\r
  OUT UINTN   *NaturalUnits,\r
  OUT UINTN   *ConstantUnits\r
  );\r
\r
BOOLEAN\r
EdbGetNaturalIndex32 (\r
  IN  UINT32  Data32,\r
  OUT UINTN   *NaturalUnits,\r
  OUT UINTN   *ConstantUnits\r
  );\r
\r
BOOLEAN\r
EdbGetNaturalIndex64 (\r
  IN  UINT64  Data64,\r
  OUT UINT64  *NaturalUnits,\r
  OUT UINT64  *ConstantUnits\r
  );\r
\r
UINTN\r
EdbPrintRawIndexData16 (\r
  IN UINT16                 Data16\r
  );\r
\r
UINTN\r
EdbPrintRawIndexData32 (\r
  IN UINT32                 Data32\r
  );\r
\r
UINTN\r
EdbPrintRawIndexData64 (\r
  IN UINT64                 Data64\r
  );\r
\r
UINTN\r
EdbPrintRegister1 (\r
  IN UINT8                  Operands\r
  );\r
\r
UINTN\r
EdbPrintRegister2 (\r
  IN UINT8                  Operands\r
  );\r
\r
UINTN\r
EdbPrintDedicatedRegister1 (\r
  IN UINT8                  Operands\r
  );\r
\r
UINTN\r
EdbPrintDedicatedRegister2 (\r
  IN UINT8                  Operands\r
  );\r
\r
UINTN\r
EdbPrintIndexData (\r
  IN BOOLEAN                Sign,\r
  IN UINTN                  NaturalUnits,\r
  IN UINTN                  ConstantUnits\r
  );\r
\r
UINTN\r
EdbPrintIndexData64 (\r
  IN BOOLEAN                Sign,\r
  IN UINT64                 NaturalUnits,\r
  IN UINT64                 ConstantUnits\r
  );\r
\r
UINTN\r
EdbPrintImmData8 (\r
  IN UINT8                  Data\r
  );\r
\r
UINTN\r
EdbPrintImmData16 (\r
  IN UINT16                 Data\r
  );\r
\r
UINTN\r
EdbPrintImmData32 (\r
  IN UINT32                 Data\r
  );\r
\r
UINTN\r
EdbPrintImmData64 (\r
  IN UINT64                 Data\r
  );\r
\r
UINTN\r
EdbPrintImmDatan (\r
  IN UINTN                  Data\r
  );\r
\r
UINTN\r
EdbPrintImmData64n (\r
  IN UINT64                 Data64\r
  );\r
\r
UINTN\r
EdbPrintData8 (\r
  IN UINT8                  Data8\r
  );\r
\r
UINTN\r
EdbPrintData16 (\r
  IN UINT16                 Data16\r
  );\r
\r
UINTN\r
EdbPrintData32 (\r
  IN UINT32                 Data32\r
  );\r
\r
UINTN\r
EdbPrintData64 (\r
  IN UINT64                 Data64\r
  );\r
\r
UINTN\r
EdbPrintDatan (\r
  IN UINTN                  Data\r
  );\r
\r
UINTN\r
EdbPrintData64n (\r
  IN UINT64                 Data64\r
  );\r
\r
UINTN\r
EdbPrintData8s (\r
  IN UINT8                  Data8\r
  );\r
\r
UINTN\r
EdbPrintData16s (\r
  IN UINT16                 Data16\r
  );\r
\r
UINTN\r
EdbPrintData32s (\r
  IN UINT32                 Data32\r
  );\r
\r
UINTN\r
EdbPrintData64s (\r
  IN UINT64                 Data64\r
  );\r
\r
UINTN\r
EdbPrintComma (\r
  VOID\r
  );\r
\r
UINTN\r
EdbFindAndPrintSymbol (\r
  IN UINTN                  Address\r
  );\r
\r
VOID\r
EdbPrintRaw (\r
  IN EFI_PHYSICAL_ADDRESS   InstructionAddress,\r
  IN UINTN                  InstructionNumber\r
  );\r
\r
EFI_STATUS\r
EdbShowDisasm (\r
  IN     EFI_DEBUGGER_PRIVATE_DATA *DebuggerPrivate,\r
  IN     EFI_SYSTEM_CONTEXT        SystemContext\r
  );\r
\r
UINT64\r
GetRegisterValue (\r
  IN     EFI_SYSTEM_CONTEXT        SystemContext,\r
  IN     UINT8                     Index\r
  );\r
\r
#endif\r