[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / Dmem.c

/** @file\r
  Main file for Dmem shell Debug1 function.\r
\r
  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2010 - 2011, 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
#include "UefiShellDebug1CommandsLib.h"\r
#include <Protocol/PciRootBridgeIo.h>\r
#include <Guid/Acpi.h>\r
#include <Guid/Mps.h>\r
#include <Guid/SmBios.h>\r
#include <Guid/SalSystemTable.h>\r
\r
/**\r
  Make a printable character.\r
\r
  If Char is printable then return it, otherwise return a question mark.\r
\r
  @param[in] Char     The character to make printable.\r
\r
  @return A printable character representing Char.\r
**/\r
CHAR16\r
EFIAPI\r
MakePrintable(\r
  IN CONST CHAR16 Char\r
  )\r
{\r
  if ((Char < 0x20 && Char > 0)||(Char > 126)) {\r
    return (L'?');\r
  }\r
  return (Char);\r
}\r
\r
/**\r
  Display some Memory-Mapped-IO memory.\r
\r
  @param[in] Address    The starting address to display.\r
  @param[in] Size       The length of memory to display.\r
**/\r
SHELL_STATUS\r
EFIAPI\r
DisplayMmioMemory(\r
  IN CONST VOID   *Address,\r
  IN CONST UINTN  Size\r
  )\r
{\r
  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRbIo;\r
  EFI_STATUS                      Status;\r
  VOID                            *Buffer;\r
  SHELL_STATUS                    ShellStatus;\r
\r
  ShellStatus = SHELL_SUCCESS;\r
\r
  Status = gBS->LocateProtocol(&gEfiPciRootBridgeIoProtocolGuid, NULL, (VOID**)&PciRbIo);\r
  if (EFI_ERROR(Status)) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PCIRBIO_NF), gShellDebug1HiiHandle, L"dmem");  \r
    return (SHELL_NOT_FOUND);\r
  }\r
  Buffer = AllocateZeroPool(Size);\r
  ASSERT(Buffer != NULL);\r
\r
  Status = PciRbIo->Mem.Read(PciRbIo, EfiPciWidthUint8, (UINT64)(UINTN)Address, Size, Buffer);\r
  if (EFI_ERROR(Status)) {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PCIRBIO_ER), gShellDebug1HiiHandle, L"dmem");  \r
    ShellStatus = SHELL_NOT_FOUND;\r
  } else {\r
    ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DMEM_MMIO_HEADER_ROW), gShellDebug1HiiHandle, (UINT64)(UINTN)Address, Size);\r
    DumpHex(2, (UINTN)Address, Size, Buffer);\r
  }\r
\r
  FreePool(Buffer);\r
  return (ShellStatus);\r
}\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-mmio", TypeFlag},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Function for 'dmem' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunDmem (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS          Status;\r
  LIST_ENTRY          *Package;\r
  CHAR16              *ProblemParam;\r
  SHELL_STATUS        ShellStatus;\r
  VOID                *Address;\r
  UINT64              Size;\r
  CONST CHAR16        *Temp1;\r
  UINT64              AcpiTableAddress;\r
  UINT64              Acpi20TableAddress;\r
  UINT64              SalTableAddress;\r
  UINT64              SmbiosTableAddress;\r
  UINT64              MpsTableAddress;\r
  UINTN               TableWalker;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  Status              = EFI_SUCCESS;\r
  Address             = NULL;\r
  Size                = 0;\r
\r
  //\r
  // initialize the shell lib (we must be in non-auto-init...)\r
  //\r
  Status = ShellInitialize();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  Status = CommandInit();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  //\r
  // parse the command line\r
  //\r
  Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
  if (EFI_ERROR(Status)) {\r
    if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"dmem", ProblemParam);  \r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    if (ShellCommandLineGetCount(Package) > 3) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle, L"dmem");  \r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      Temp1 = ShellCommandLineGetRawValue(Package, 1);\r
      if (Temp1 == NULL) {\r
        Address = gST;\r
        Size = 512;\r
      } else {\r
        if (!ShellIsHexOrDecimalNumber(Temp1, TRUE, FALSE) || EFI_ERROR(ShellConvertStringToUint64(Temp1, (UINT64*)&Address, TRUE, FALSE))) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dmem", Temp1);  \r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        } \r
        Temp1 = ShellCommandLineGetRawValue(Package, 2);\r
        if (Temp1 == NULL) {\r
          Size = 512;\r
        } else {\r
          if (!ShellIsHexOrDecimalNumber(Temp1, FALSE, FALSE) || EFI_ERROR(ShellConvertStringToUint64(Temp1, &Size, TRUE, FALSE))) {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dmem", Temp1);  \r
            ShellStatus = SHELL_INVALID_PARAMETER;\r
          }\r
        }\r
      }\r
    }\r
\r
    if (ShellStatus == SHELL_SUCCESS) {\r
      if (!ShellCommandLineGetFlag(Package, L"-mmio")) {\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DMEM_HEADER_ROW), gShellDebug1HiiHandle, (UINT64)(UINTN)Address, Size);\r
        DumpHex(2, (UINTN)Address, (UINTN)Size, Address);\r
        if (Address == (VOID*)gST) {\r
          Acpi20TableAddress  = 0;\r
          AcpiTableAddress    = 0;\r
          SalTableAddress     = 0;\r
          SmbiosTableAddress  = 0;\r
          MpsTableAddress     = 0;\r
          for (TableWalker = 0 ; TableWalker < gST->NumberOfTableEntries ; TableWalker++) {\r
            if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiAcpi20TableGuid)) {\r
              Acpi20TableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
              continue;\r
            }\r
            if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiAcpi10TableGuid)) {\r
              AcpiTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
              continue;\r
            }\r
            if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiSalSystemTableGuid)) {\r
              SalTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
              continue;\r
            }\r
            if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiSmbiosTableGuid)) {\r
              SmbiosTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
              continue;\r
            }\r
            if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiMpsTableGuid)) {\r
              MpsTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
              continue;\r
            }\r
          }\r
\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DMEM_SYSTEM_TABLE), gShellDebug1HiiHandle, \r
            (UINT64)(UINTN)Address,\r
            gST->Hdr.HeaderSize,\r
            gST->Hdr.Revision,\r
            (UINT64)(UINTN)gST->ConIn,\r
            (UINT64)(UINTN)gST->ConOut,\r
            (UINT64)(UINTN)gST->StdErr,\r
            (UINT64)(UINTN)gST->RuntimeServices,\r
            (UINT64)(UINTN)gST->BootServices,\r
            SalTableAddress,\r
            AcpiTableAddress,\r
            Acpi20TableAddress,\r
            MpsTableAddress,\r
            SmbiosTableAddress\r
            );\r
        }\r
      } else {\r
        ShellStatus = DisplayMmioMemory(Address, (UINTN)Size);\r
      }\r
    }\r
\r
\r
    ShellCommandLineFreeVarList (Package);\r
  }\r
\r
  return (ShellStatus);\r
}\r
Commit	Line	Data
5d73d92f	1	/** @file\r
	2	Main file for Dmem shell Debug1 function.\r
	3	\r
c011b6c9	4	(C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
3737ac2b	5	Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
5d73d92f	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#include "UefiShellDebug1CommandsLib.h"\r
	17	#include <Protocol/PciRootBridgeIo.h>\r
3737ac2b	18	#include <Guid/Acpi.h>\r
	19	#include <Guid/Mps.h>\r
	20	#include <Guid/SmBios.h>\r
	21	#include <Guid/SalSystemTable.h>\r
5d73d92f	22	\r
3737ac2b	23	/**\r
	24	Make a printable character.\r
	25	\r
	26	If Char is printable then return it, otherwise return a question mark.\r
	27	\r
	28	@param[in] Char The character to make printable.\r
	29	\r
	30	@return A printable character representing Char.\r
	31	**/\r
5d73d92f	32	CHAR16\r
3737ac2b	33	EFIAPI\r
5d73d92f	34	MakePrintable(\r
	35	IN CONST CHAR16 Char\r
	36	)\r
	37	{\r
	38	if ((Char < 0x20 && Char > 0)\|\|(Char > 126)) {\r
	39	return (L'?');\r
	40	}\r
	41	return (Char);\r
	42	}\r
	43	\r
3737ac2b	44	/**\r
	45	Display some Memory-Mapped-IO memory.\r
	46	\r
	47	@param[in] Address The starting address to display.\r
	48	@param[in] Size The length of memory to display.\r
	49	**/\r
5d73d92f	50	SHELL_STATUS\r
	51	EFIAPI\r
	52	DisplayMmioMemory(\r
	53	IN CONST VOID *Address,\r
	54	IN CONST UINTN Size\r
	55	)\r
	56	{\r
	57	EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRbIo;\r
	58	EFI_STATUS Status;\r
	59	VOID *Buffer;\r
	60	SHELL_STATUS ShellStatus;\r
	61	\r
	62	ShellStatus = SHELL_SUCCESS;\r
	63	\r
	64	Status = gBS->LocateProtocol(&gEfiPciRootBridgeIoProtocolGuid, NULL, (VOID**)&PciRbIo);\r
	65	if (EFI_ERROR(Status)) {\r
4092a8f6	66	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PCIRBIO_NF), gShellDebug1HiiHandle, L"dmem"); \r
5d73d92f	67	return (SHELL_NOT_FOUND);\r
	68	}\r
	69	Buffer = AllocateZeroPool(Size);\r
	70	ASSERT(Buffer != NULL);\r
	71	\r
e0c2cc6f	72	Status = PciRbIo->Mem.Read(PciRbIo, EfiPciWidthUint8, (UINT64)(UINTN)Address, Size, Buffer);\r
5d73d92f	73	if (EFI_ERROR(Status)) {\r
4092a8f6	74	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PCIRBIO_ER), gShellDebug1HiiHandle, L"dmem"); \r
5d73d92f	75	ShellStatus = SHELL_NOT_FOUND;\r
5d73d92f	76	} else {\r
e0c2cc6f	77	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DMEM_MMIO_HEADER_ROW), gShellDebug1HiiHandle, (UINT64)(UINTN)Address, Size);\r
5904052a	78	DumpHex(2, (UINTN)Address, Size, Buffer);\r
5d73d92f	79	}\r
	80	\r
	81	FreePool(Buffer);\r
	82	return (ShellStatus);\r
	83	}\r
	84	\r
	85	STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
	86	{L"-mmio", TypeFlag},\r
	87	{NULL, TypeMax}\r
	88	};\r
	89	\r
3737ac2b	90	/**\r
	91	Function for 'dmem' command.\r
	92	\r
	93	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	94	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	95	**/\r
5d73d92f	96	SHELL_STATUS\r
	97	EFIAPI\r
	98	ShellCommandRunDmem (\r
	99	IN EFI_HANDLE ImageHandle,\r
	100	IN EFI_SYSTEM_TABLE *SystemTable\r
	101	)\r
	102	{\r
	103	EFI_STATUS Status;\r
	104	LIST_ENTRY *Package;\r
	105	CHAR16 *ProblemParam;\r
	106	SHELL_STATUS ShellStatus;\r
	107	VOID *Address;\r
3737ac2b	108	UINT64 Size;\r
5d73d92f	109	CONST CHAR16 *Temp1;\r
3737ac2b	110	UINT64 AcpiTableAddress;\r
	111	UINT64 Acpi20TableAddress;\r
	112	UINT64 SalTableAddress;\r
	113	UINT64 SmbiosTableAddress;\r
	114	UINT64 MpsTableAddress;\r
	115	UINTN TableWalker;\r
5d73d92f	116	\r
	117	ShellStatus = SHELL_SUCCESS;\r
	118	Status = EFI_SUCCESS;\r
	119	Address = NULL;\r
	120	Size = 0;\r
	121	\r
	122	//\r
	123	// initialize the shell lib (we must be in non-auto-init...)\r
	124	//\r
	125	Status = ShellInitialize();\r
	126	ASSERT_EFI_ERROR(Status);\r
	127	\r
	128	Status = CommandInit();\r
	129	ASSERT_EFI_ERROR(Status);\r
	130	\r
	131	//\r
	132	// parse the command line\r
	133	//\r
	134	Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
	135	if (EFI_ERROR(Status)) {\r
	136	if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
4092a8f6	137	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"dmem", ProblemParam); \r
5d73d92f	138	FreePool(ProblemParam);\r
	139	ShellStatus = SHELL_INVALID_PARAMETER;\r
	140	} else {\r
	141	ASSERT(FALSE);\r
	142	}\r
	143	} else {\r
3737ac2b	144	if (ShellCommandLineGetCount(Package) > 3) {\r
4092a8f6	145	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle, L"dmem"); \r
3737ac2b	146	ShellStatus = SHELL_INVALID_PARAMETER;\r
5d73d92f	147	} else {\r
3737ac2b	148	Temp1 = ShellCommandLineGetRawValue(Package, 1);\r
5d73d92f	149	if (Temp1 == NULL) {\r
3737ac2b	150	Address = gST;\r
5d73d92f	151	Size = 512;\r
5d73d92f	152	} else {\r
3737ac2b	153	if (!ShellIsHexOrDecimalNumber(Temp1, TRUE, FALSE) \|\| EFI_ERROR(ShellConvertStringToUint64(Temp1, (UINT64*)&Address, TRUE, FALSE))) {\r
4092a8f6	154	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dmem", Temp1); \r
5d73d92f	155	ShellStatus = SHELL_INVALID_PARAMETER;\r
3737ac2b	156	} \r
	157	Temp1 = ShellCommandLineGetRawValue(Package, 2);\r
	158	if (Temp1 == NULL) {\r
	159	Size = 512;\r
5d73d92f	160	} else {\r
3737ac2b	161	if (!ShellIsHexOrDecimalNumber(Temp1, FALSE, FALSE) \|\| EFI_ERROR(ShellConvertStringToUint64(Temp1, &Size, TRUE, FALSE))) {\r
4092a8f6	162	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dmem", Temp1); \r
3737ac2b	163	ShellStatus = SHELL_INVALID_PARAMETER;\r
3737ac2b	164	}\r
5d73d92f	165	}\r
	166	}\r
	167	}\r
	168	\r
	169	if (ShellStatus == SHELL_SUCCESS) {\r
	170	if (!ShellCommandLineGetFlag(Package, L"-mmio")) {\r
e0c2cc6f	171	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DMEM_HEADER_ROW), gShellDebug1HiiHandle, (UINT64)(UINTN)Address, Size);\r
5904052a	172	DumpHex(2, (UINTN)Address, (UINTN)Size, Address);\r
3737ac2b	173	if (Address == (VOID*)gST) {\r
	174	Acpi20TableAddress = 0;\r
	175	AcpiTableAddress = 0;\r
	176	SalTableAddress = 0;\r
	177	SmbiosTableAddress = 0;\r
	178	MpsTableAddress = 0;\r
	179	for (TableWalker = 0 ; TableWalker < gST->NumberOfTableEntries ; TableWalker++) {\r
	180	if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiAcpi20TableGuid)) {\r
e0c2cc6f	181	Acpi20TableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
3737ac2b	182	continue;\r
	183	}\r
	184	if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiAcpi10TableGuid)) {\r
e0c2cc6f	185	AcpiTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
3737ac2b	186	continue;\r
	187	}\r
	188	if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiSalSystemTableGuid)) {\r
e0c2cc6f	189	SalTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
3737ac2b	190	continue;\r
	191	}\r
	192	if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiSmbiosTableGuid)) {\r
e0c2cc6f	193	SmbiosTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
3737ac2b	194	continue;\r
	195	}\r
	196	if (CompareGuid(&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiMpsTableGuid)) {\r
e0c2cc6f	197	MpsTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable;\r
3737ac2b	198	continue;\r
	199	}\r
	200	}\r
	201	\r
	202	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DMEM_SYSTEM_TABLE), gShellDebug1HiiHandle, \r
e0c2cc6f	203	(UINT64)(UINTN)Address,\r
3737ac2b	204	gST->Hdr.HeaderSize,\r
3737ac2b	205	gST->Hdr.Revision,\r
e0c2cc6f	206	(UINT64)(UINTN)gST->ConIn,\r
	207	(UINT64)(UINTN)gST->ConOut,\r
	208	(UINT64)(UINTN)gST->StdErr,\r
	209	(UINT64)(UINTN)gST->RuntimeServices,\r
	210	(UINT64)(UINTN)gST->BootServices,\r
3737ac2b	211	SalTableAddress,\r
	212	AcpiTableAddress,\r
	213	Acpi20TableAddress,\r
	214	MpsTableAddress,\r
	215	SmbiosTableAddress\r
	216	);\r
	217	}\r
5d73d92f	218	} else {\r
3737ac2b	219	ShellStatus = DisplayMmioMemory(Address, (UINTN)Size);\r
5d73d92f	220	}\r
	221	}\r
	222	\r
	223	\r
	224	ShellCommandLineFreeVarList (Package);\r
	225	}\r
	226	\r
	227	return (ShellStatus);\r
	228	}\r