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

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