Make script less verbose

[mirror_edk2.git] / BeagleBoardPkg / Library / EblCmdLib / EblCmdLib.c

/** @file\r
  Add custom commands for BeagleBoard development.\r
\r
  Copyright (c) 2008-2010, Apple Inc. All rights reserved.\r
  \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
#include <PiDxe.h>\r
#include <Library/ArmLib.h>\r
#include <Library/CacheMaintenanceLib.h>\r
#include <Library/EblCmdLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/EfiFileLib.h>\r
#include <Library/ArmDisassemblerLib.h>\r
#include <Library/PeCoffGetEntryPointLib.h>\r
\r
#include <Guid/DebugImageInfoTable.h>\r
#include <Protocol/DebugSupport.h>\r
#include <Protocol/LoadedImage.h>\r
\r
/**\r
  Simple arm disassembler via a library\r
\r
  Argv[0] - symboltable\r
  Argv[1] - Optional qoted format string \r
  Argv[2] - Optional flag\r
\r
  @param  Argc   Number of command arguments in Argv\r
  @param  Argv   Array of strings that represent the parsed command line. \r
                 Argv[0] is the comamnd name\r
\r
  @return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
EblSymbolTable (\r
  IN UINTN  Argc,\r
  IN CHAR8  **Argv\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EFI_DEBUG_IMAGE_INFO_TABLE_HEADER *DebugImageTableHeader = NULL;\r
  EFI_DEBUG_IMAGE_INFO              *DebugTable;\r
  UINTN                             Entry;\r
  CHAR8                             *Format;\r
  CHAR8                             *Pdb;\r
  UINT32                            PeCoffSizeOfHeaders;\r
  UINT32                            ImageBase;\r
  BOOLEAN                           Elf;\r
  \r
  // Need to add lots of error checking on the passed in string\r
  Format = (Argc > 1) ? Argv[1] : "load /a /ni /np %a & 0x%x";\r
  Elf = (Argc > 2) ? FALSE : TRUE;\r
  \r
  Status = EfiGetSystemConfigurationTable (&gEfiDebugImageInfoTableGuid, (VOID **)&DebugImageTableHeader);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  \r
  DebugTable = DebugImageTableHeader->EfiDebugImageInfoTable;\r
  if (DebugTable == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (Entry = 0; Entry < DebugImageTableHeader->TableSize; Entry++, DebugTable++) {\r
    if (DebugTable->NormalImage != NULL) {\r
      if ((DebugTable->NormalImage->ImageInfoType == EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL) && (DebugTable->NormalImage->LoadedImageProtocolInstance != NULL)) {\r
        ImageBase = (UINT32)DebugTable->NormalImage->LoadedImageProtocolInstance->ImageBase;\r
        PeCoffSizeOfHeaders = PeCoffGetSizeOfHeaders ((VOID *)(UINTN)ImageBase);\r
        Pdb = PeCoffLoaderGetPdbPointer (DebugTable->NormalImage->LoadedImageProtocolInstance->ImageBase);\r
        if (Elf) {\r
          // ELF and Mach-O images don't include the header so the linked address does not include header\r
          ImageBase += PeCoffSizeOfHeaders;\r
        } \r
        AsciiPrint (Format, Pdb, ImageBase);\r
        AsciiPrint ("\n");\r
      }\r
    }  \r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Simple arm disassembler via a library\r
\r
  Argv[0] - disasm\r
  Argv[1] - Address to start disassembling from\r
  ARgv[2] - Number of instructions to disassembly (optional)\r
\r
  @param  Argc   Number of command arguments in Argv\r
  @param  Argv   Array of strings that represent the parsed command line. \r
                 Argv[0] is the comamnd name\r
\r
  @return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
EblDisassembler (\r
  IN UINTN  Argc,\r
  IN CHAR8  **Argv\r
  )\r
{\r
  UINT8   *Ptr, *CurrentAddress;\r
  UINT32  Address;\r
  UINT32  Count;\r
  CHAR8   Buffer[80];\r
  UINT32  ItBlock;\r
  \r
  if (Argc < 2) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  \r
  Address = AsciiStrHexToUintn (Argv[1]);\r
  Count   = (Argc > 2) ? (UINT32)AsciiStrHexToUintn (Argv[2]) : 20;\r
\r
  Ptr = (UINT8 *)(UINTN)Address;  \r
  ItBlock = 0;\r
  do {\r
    CurrentAddress = Ptr;\r
    DisassembleInstruction (&Ptr, TRUE, TRUE, &ItBlock, Buffer, sizeof (Buffer));\r
    AsciiPrint ("0x%08x: %a\n", CurrentAddress, Buffer);\r
  } while (Count-- > 0);\r
 \r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED const EBL_COMMAND_TABLE mLibCmdTemplate[] =\r
{\r
  {\r
    "disasm address [count]",\r
    " disassemble count instructions",\r
    NULL,\r
    EblDisassembler\r
  },\r
  {\r
    "symboltable [\"format string\"] [TRUE]",\r
    " show symbol table commands for debugger",\r
    NULL,\r
    EblSymbolTable\r
  }\r
};\r
\r
\r
VOID\r
EblInitializeExternalCmd (\r
  VOID\r
  )\r
{\r
  EblAddCommands (mLibCmdTemplate, sizeof (mLibCmdTemplate)/sizeof (EBL_COMMAND_TABLE));\r
  return;\r
}\r