ArmPlatformPkg/ArmPlatformLibNull: Added template for ArmPlatformGetCorePosition()

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

/** @file\r
*\r
*  Copyright (c) 2011-2012, ARM Limited. All rights reserved.\r
*  \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
#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/DxeServicesTableLib.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
#include <Library/PerformanceLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/BdsLib.h>\r
\r
#include <Guid/DebugImageInfoTable.h>\r
\r
#include <Protocol/DebugSupport.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/DevicePathToText.h>\r
\r
EFI_STATUS\r
EblDumpMmu (\r
  IN UINTN  Argc,\r
  IN CHAR8  **Argv\r
  );\r
  \r
EFI_STATUS\r
EblDumpFdt (\r
  IN UINTN  Argc,\r
  IN CHAR8  **Argv\r
  );\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 command 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
  // Default string is for RealView debugger\r
#if (__ARMCC_VERSION < 500000)\r
  Format = (Argc > 1) ? Argv[1] : "load /a /ni /np %a &0x%x";\r
#else\r
  Format = (Argc > 1) ? Argv[1] : "add-symbol-file %a 0x%x";\r
#endif\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 (Pdb != NULL) {\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
        } else {\r
        }\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 command 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
CHAR8 *\r
ImageHandleToPdbFileName (\r
  IN  EFI_HANDLE    Handle\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_LOADED_IMAGE_PROTOCOL   *LoadedImage;\r
  CHAR8                       *Pdb;\r
  CHAR8                       *StripLeading;\r
\r
  Status = gBS->HandleProtocol (Handle, &gEfiLoadedImageProtocolGuid, (VOID **)&LoadedImage);\r
  if (EFI_ERROR (Status)) {\r
    return "";\r
  }\r
\r
  Pdb = PeCoffLoaderGetPdbPointer (LoadedImage->ImageBase);\r
  StripLeading = AsciiStrStr (Pdb, "\\ARM\\");\r
  if (StripLeading == NULL) {\r
    StripLeading = AsciiStrStr (Pdb, "/ARM/");\r
    if (StripLeading == NULL) {\r
      return Pdb;\r
    }\r
  }\r
  // Hopefully we hacked off the unneeded part\r
  return (StripLeading + 5);\r
}\r
\r
\r
STATIC CHAR8 *mTokenList[] = {\r
  /*"SEC",*/\r
  "PEI",\r
  "DXE",\r
  /*"BDS",*/\r
  NULL\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 command name\r
\r
  @return EFI_SUCCESS\r
\r
**/\r
EFI_STATUS\r
EblPerformance (\r
  IN UINTN  Argc,\r
  IN CHAR8  **Argv\r
  )\r
{\r
  UINTN       Key;\r
  CONST VOID  *Handle;\r
  CONST CHAR8 *Token, *Module;\r
  UINT64      Start, Stop, TimeStamp;\r
  UINT64      Delta, TicksPerSecond, Milliseconds, Microseconds;\r
  UINTN       Index;\r
  BOOLEAN     CountUp;\r
\r
  TicksPerSecond = GetPerformanceCounterProperties (&Start, &Stop);\r
  if (Start < Stop) {\r
    CountUp = TRUE;\r
  } else {\r
    CountUp = FALSE;\r
  }\r
\r
  Key       = 0;\r
  do {\r
    Key = GetPerformanceMeasurement (Key, (CONST VOID **)&Handle, &Token, &Module, &Start, &Stop);\r
    if (Key != 0) {\r
      if (AsciiStriCmp ("StartImage:", Token) == 0) {\r
        if (Stop == 0) {\r
          // The entry for EBL is still running so the stop time will be zero. Skip it\r
          AsciiPrint ("   running     %a\n", ImageHandleToPdbFileName ((EFI_HANDLE)Handle));\r
        } else {\r
          Delta =  CountUp?(Stop - Start):(Start - Stop);\r
          Microseconds = DivU64x64Remainder (MultU64x32 (Delta, 1000000), TicksPerSecond, NULL);\r
          AsciiPrint ("%10ld us  %a\n", Microseconds, ImageHandleToPdbFileName ((EFI_HANDLE)Handle));\r
        }\r
      }\r
    }\r
  } while (Key != 0);\r
\r
  AsciiPrint ("\n");\r
\r
  TimeStamp = 0;\r
  Key       = 0;\r
  do {\r
    Key = GetPerformanceMeasurement (Key, (CONST VOID **)&Handle, &Token, &Module, &Start, &Stop);\r
    if (Key != 0) {\r
      for (Index = 0; mTokenList[Index] != NULL; Index++) {\r
        if (AsciiStriCmp (mTokenList[Index], Token) == 0) {\r
          Delta =  CountUp?(Stop - Start):(Start - Stop);\r
          TimeStamp += Delta;\r
          Milliseconds = DivU64x64Remainder (MultU64x32 (Delta, 1000), TicksPerSecond, NULL);\r
          AsciiPrint ("%6a %6ld ms\n", Token, Milliseconds);\r
          break;\r
        }\r
      }   \r
    }\r
  } while (Key != 0);\r
\r
  AsciiPrint ("Total Time = %ld ms\n\n", DivU64x64Remainder (MultU64x32 (TimeStamp, 1000), TicksPerSecond, NULL));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
#define EFI_MEMORY_PORT_IO  0x4000000000000000ULL\r
\r
EFI_STATUS\r
EblDumpGcd (\r
  IN UINTN  Argc,\r
  IN CHAR8  **Argv\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  UINTN                           NumberOfDescriptors;\r
  UINTN i;\r
  EFI_GCD_MEMORY_SPACE_DESCRIPTOR *MemorySpaceMap;\r
  EFI_GCD_IO_SPACE_DESCRIPTOR *IoSpaceMap;\r
\r
  Status = gDS->GetMemorySpaceMap(&NumberOfDescriptors,&MemorySpaceMap);\r
  if (EFI_ERROR (Status)) {\r
      return Status;\r
  }\r
  AsciiPrint ("    Address Range       Image     Device   Attributes\n");\r
  AsciiPrint ("__________________________________________________________\n");\r
  for (i=0; i < NumberOfDescriptors; i++) {\r
    AsciiPrint ("MEM %016lx - %016lx",(UINT64)MemorySpaceMap[i].BaseAddress,MemorySpaceMap[i].BaseAddress+MemorySpaceMap[i].Length-1);\r
    AsciiPrint (" %08x %08x",MemorySpaceMap[i].ImageHandle,MemorySpaceMap[i].DeviceHandle);\r
\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_RUNTIME)\r
        AsciiPrint (" RUNTIME");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_PORT_IO)\r
        AsciiPrint (" PORT_IO");\r
\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_UC)\r
        AsciiPrint (" MEM_UC");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_WC)\r
        AsciiPrint (" MEM_WC");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_WT)\r
        AsciiPrint (" MEM_WT");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_WB)\r
        AsciiPrint (" MEM_WB");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_UCE)\r
        AsciiPrint (" MEM_UCE");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_WP)\r
        AsciiPrint (" MEM_WP");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_RP)\r
        AsciiPrint (" MEM_RP");\r
    if (MemorySpaceMap[i].Attributes & EFI_MEMORY_XP)\r
        AsciiPrint (" MEM_XP");\r
\r
    if (MemorySpaceMap[i].GcdMemoryType & EfiGcdMemoryTypeNonExistent)\r
        AsciiPrint (" TYPE_NONEXISTENT");\r
    if (MemorySpaceMap[i].GcdMemoryType & EfiGcdMemoryTypeReserved)\r
        AsciiPrint (" TYPE_RESERVED");\r
    if (MemorySpaceMap[i].GcdMemoryType & EfiGcdMemoryTypeSystemMemory)\r
        AsciiPrint (" TYPE_SYSMEM");\r
    if (MemorySpaceMap[i].GcdMemoryType & EfiGcdMemoryTypeMemoryMappedIo)\r
        AsciiPrint (" TYPE_MEMMAP");\r
\r
    AsciiPrint ("\n");\r
  }\r
\r
  Status = gDS->GetIoSpaceMap(&NumberOfDescriptors,&IoSpaceMap);\r
  if (EFI_ERROR (Status)) {\r
      return Status;\r
  }\r
  for (i=0; i < NumberOfDescriptors; i++) {\r
    AsciiPrint ("IO  %08lx - %08lx",IoSpaceMap[i].BaseAddress,IoSpaceMap[i].BaseAddress+IoSpaceMap[i].Length);\r
    AsciiPrint ("\t%08x %08x",IoSpaceMap[i].ImageHandle,IoSpaceMap[i].DeviceHandle);\r
\r
    if (IoSpaceMap[i].GcdIoType & EfiGcdMemoryTypeNonExistent)\r
        AsciiPrint (" TYPE_NONEXISTENT");\r
    if (IoSpaceMap[i].GcdIoType & EfiGcdMemoryTypeReserved)\r
        AsciiPrint (" TYPE_RESERVED");\r
    if (IoSpaceMap[i].GcdIoType & EfiGcdIoTypeIo)\r
        AsciiPrint (" TYPE_IO");\r
\r
    AsciiPrint ("\n");\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EblDevicePaths (\r
  IN UINTN  Argc,\r
  IN CHAR8  **Argv\r
  )\r
{\r
  EFI_STATUS Status;\r
  UINTN                              HandleCount;\r
  EFI_HANDLE                         *HandleBuffer;\r
  UINTN                              Index;\r
  CHAR16*                            String;\r
  EFI_DEVICE_PATH_PROTOCOL*          DevicePathProtocol;\r
  EFI_DEVICE_PATH_TO_TEXT_PROTOCOL*  DevicePathToTextProtocol;\r
\r
  BdsConnectAllDrivers();\r
\r
  Status = gBS->LocateProtocol(&gEfiDevicePathToTextProtocolGuid, NULL, (VOID **)&DevicePathToTextProtocol);\r
  if (EFI_ERROR (Status)) {\r
    AsciiPrint ("Did not find the DevicePathToTextProtocol.\n");\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiDevicePathProtocolGuid, NULL, &HandleCount, &HandleBuffer);\r
  if (EFI_ERROR (Status)) {\r
    AsciiPrint ("No device path found\n");\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (Index = 0; Index < HandleCount; Index++) {\r
    Status = gBS->HandleProtocol (HandleBuffer[Index], &gEfiDevicePathProtocolGuid, (VOID **)&DevicePathProtocol);\r
    String = DevicePathToTextProtocol->ConvertDevicePathToText(DevicePathProtocol,TRUE,TRUE);\r
    Print (L"[0x%X] %s\n",(UINT32)HandleBuffer[Index], String);\r
  }\r
\r
  return EFI_SUCCESS;\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
    "performance",\r
    " Display boot performance info",\r
    NULL,\r
    EblPerformance\r
  },\r
  {\r
    "symboltable [\"format string\"] [PECOFF]",\r
    " show symbol table commands for debugger",\r
    NULL,\r
    EblSymbolTable\r
  },\r
  {\r
    "dumpgcd",\r
    " dump Global Coherency Domain",\r
    NULL,\r
    EblDumpGcd\r
  },\r
  {\r
    "dumpmmu",\r
    " dump MMU Table",\r
    NULL,\r
    EblDumpMmu\r
  },\r
  {\r
    "devicepaths",\r
    " list all the Device Paths",\r
    NULL,\r
    EblDevicePaths\r
  },\r
  {\r
    "dumpfdt",\r
    " dump the current fdt or the one defined in the arguments",\r
    NULL,\r
    EblDumpFdt\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