/** @file Main file for Dmem shell Debug1 function. Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.
(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
(C) Copyright 2015 Hewlett Packard Enterprise Development LP
SPDX-License-Identifier: BSD-2-Clause-Patent **/ #include "UefiShellDebug1CommandsLib.h" #include #include #include #include #include #include #include #include #include #include #include /** Make a printable character. If Char is printable then return it, otherwise return a question mark. @param[in] Char The character to make printable. @return A printable character representing Char. **/ CHAR16 MakePrintable ( IN CONST CHAR16 Char ) { if (((Char < 0x20) && (Char > 0)) || (Char > 126)) { return (L'?'); } return (Char); } /** Display some Memory-Mapped-IO memory. @param[in] Address The starting address to display. @param[in] Size The length of memory to display. **/ SHELL_STATUS DisplayMmioMemory ( IN CONST VOID *Address, IN CONST UINTN Size ) { EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL *PciRbIo; EFI_STATUS Status; VOID *Buffer; SHELL_STATUS ShellStatus; ShellStatus = SHELL_SUCCESS; Status = gBS->LocateProtocol (&gEfiPciRootBridgeIoProtocolGuid, NULL, (VOID **)&PciRbIo); if (EFI_ERROR (Status)) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PCIRBIO_NF), gShellDebug1HiiHandle, L"dmem"); return (SHELL_NOT_FOUND); } Buffer = AllocateZeroPool (Size); if (Buffer == NULL) { return SHELL_OUT_OF_RESOURCES; } Status = PciRbIo->Mem.Read (PciRbIo, EfiPciWidthUint8, (UINT64)(UINTN)Address, Size, Buffer); if (EFI_ERROR (Status)) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PCIRBIO_ER), gShellDebug1HiiHandle, L"dmem"); ShellStatus = SHELL_NOT_FOUND; } else { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_MMIO_HEADER_ROW), gShellDebug1HiiHandle, (UINT64)(UINTN)Address, Size); DumpHex (2, (UINTN)Address, Size, Buffer); } FreePool (Buffer); return (ShellStatus); } /** Display the RtPropertiesTable entries @param[in] Address The pointer to the RtPropertiesTable. **/ SHELL_STATUS DisplayRtProperties ( IN UINT64 Address ) { EFI_RT_PROPERTIES_TABLE *RtPropertiesTable; UINT32 RtServices; SHELL_STATUS ShellStatus; EFI_STATUS Status; ShellStatus = SHELL_SUCCESS; if (Address != 0) { EfiGetSystemConfigurationTable (&gEfiRtPropertiesTableGuid, (VOID **)&RtPropertiesTable); RtServices = (UINT32)RtPropertiesTable->RuntimeServicesSupported; Status = ShellPrintHiiEx ( -1, -1, NULL, STRING_TOKEN (STR_DMEM_RT_PROPERTIES), gShellDebug1HiiHandle, EFI_RT_PROPERTIES_TABLE_VERSION, (RtServices & EFI_RT_SUPPORTED_GET_TIME) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_SET_TIME) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_GET_WAKEUP_TIME) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_SET_WAKEUP_TIME) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_GET_VARIABLE) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_SET_VARIABLE) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_CONVERT_POINTER) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_RESET_SYSTEM) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_UPDATE_CAPSULE) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES) ? 1 : 0, (RtServices & EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO) ? 1 : 0 ); if (EFI_ERROR (Status)) { ShellStatus = SHELL_ABORTED; ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_ERR_GET_FAIL), gShellDebug1HiiHandle, L"RtPropertiesTable"); } } else { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_ERR_NOT_FOUND), gShellDebug1HiiHandle, L"RtPropertiesTable"); } return (ShellStatus); } /** Retrieve the ImageExecutionTable Entry ImageName from ImagePath @param[in] FileName The full path of the image. @param[out] BaseName The name of the image. **/ EFI_STATUS GetBaseName ( IN CHAR16 *FileName, OUT CHAR16 **BaseName ) { UINTN StrLen; CHAR16 *StrTail; StrLen = StrSize (FileName); for (StrTail = FileName + StrLen - 1; StrTail != FileName && *StrTail != L'\\'; StrTail--) { } if (StrTail == FileName) { return EFI_NOT_FOUND; } *BaseName = StrTail+1; return EFI_SUCCESS; } /** Retrieve the ImageExecutionTable entries. **/ EFI_STATUS GetImageExecutionInfo ( ) { EFI_STATUS Status; EFI_IMAGE_EXECUTION_INFO_TABLE *ExecInfoTablePtr; EFI_IMAGE_EXECUTION_INFO *InfoPtr; CHAR8 *ptr; CHAR16 *ImagePath; CHAR16 *ImageName; UINTN Image; UINTN *NumberOfImages; CHAR16 *ActionType; EfiGetSystemConfigurationTable (&gEfiImageSecurityDatabaseGuid, (VOID **)&ExecInfoTablePtr); NumberOfImages = &ExecInfoTablePtr->NumberOfImages; ptr = (CHAR8 *)ExecInfoTablePtr + 1; for (Image = 0; Image < *NumberOfImages; Image++, ptr += InfoPtr->InfoSize) { InfoPtr = (EFI_IMAGE_EXECUTION_INFO *)ptr; ImagePath = (CHAR16 *)(InfoPtr + 1); GetBaseName (ImagePath, &ImageName); switch (InfoPtr->Action) { case EFI_IMAGE_EXECUTION_AUTHENTICATION: ActionType = L"AUTHENTICATION"; break; case EFI_IMAGE_EXECUTION_AUTH_UNTESTED: ActionType = L"AUTH_UNTESTED"; break; case EFI_IMAGE_EXECUTION_AUTH_SIG_FAILED: ActionType = L"AUTH_SIG_FAILED"; break; case EFI_IMAGE_EXECUTION_AUTH_SIG_PASSED: ActionType = L"AUTH_SIG_PASSED"; break; case EFI_IMAGE_EXECUTION_AUTH_SIG_NOT_FOUND: ActionType = L"AUTH_SIG_NOT_FOUND"; break; case EFI_IMAGE_EXECUTION_AUTH_SIG_FOUND: ActionType = L"AUTH_SIG_FOUND"; break; case EFI_IMAGE_EXECUTION_POLICY_FAILED: ActionType = L"POLICY_FAILED"; break; case EFI_IMAGE_EXECUTION_INITIALIZED: ActionType = L"INITIALIZED"; break; default: ActionType = L"invalid action"; } Status = ShellPrintHiiEx ( -1, -1, NULL, STRING_TOKEN (STR_DMEM_IMG_EXE_ENTRY), gShellDebug1HiiHandle, ImageName, ActionType ); } return Status; } /** Display the ImageExecutionTable entries @param[in] Address The pointer to the ImageExecutionTable. **/ SHELL_STATUS DisplayImageExecutionEntries ( IN UINT64 Address ) { SHELL_STATUS ShellStatus; EFI_STATUS Status; ShellStatus = SHELL_SUCCESS; if (Address != 0) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_IMG_EXE_TABLE), gShellDebug1HiiHandle); Status = GetImageExecutionInfo (); if (EFI_ERROR (Status)) { ShellStatus = SHELL_ABORTED; ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_ERR_GET_FAIL), gShellDebug1HiiHandle, L"ImageExecutionTable"); } } else { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_ERR_NOT_FOUND), gShellDebug1HiiHandle, L"ImageExecutionTable"); } return (ShellStatus); } /** Display the ConformanceProfileTable entries @param[in] Address The pointer to the ConformanceProfileTable. **/ SHELL_STATUS DisplayConformanceProfiles ( IN UINT64 Address ) { SHELL_STATUS ShellStatus; EFI_STATUS Status; EFI_GUID *EntryGuid; CHAR16 *GuidName; UINTN Profile; EFI_CONFORMANCE_PROFILES_TABLE *ConfProfTable; ShellStatus = SHELL_SUCCESS; if (Address != 0) { EfiGetSystemConfigurationTable (&gEfiConfProfilesTableGuid, (VOID **)&ConfProfTable); ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_CONF_PRO_TABLE), gShellDebug1HiiHandle); EntryGuid = (EFI_GUID *)(ConfProfTable + 1); for (Profile = 0; Profile < ConfProfTable->NumberOfProfiles; Profile++, EntryGuid++) { GuidName = L"Unknown_Profile"; if (CompareGuid (EntryGuid, &gEfiConfProfilesUefiSpecGuid)) { GuidName = L"EFI_CONFORMANCE_PROFILE_UEFI_SPEC_GUID"; } if (CompareGuid (EntryGuid, &gEfiConfProfilesEbbrSpec21Guid)) { GuidName = L"EBBR_2.1"; } if (CompareGuid (EntryGuid, &gEfiConfProfilesEbbrSpec22Guid)) { GuidName = L"EBBR_2.2"; } Status = ShellPrintHiiEx ( -1, -1, NULL, STRING_TOKEN (STR_DMEM_CONF_PRO_ROW), gShellDebug1HiiHandle, GuidName, EntryGuid ); } if (EFI_ERROR (Status)) { ShellStatus = SHELL_ABORTED; ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_ERR_GET_FAIL), gShellDebug1HiiHandle, L"ComformanceProfilesTable"); } } else { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_CONF_PRO_TABLE), gShellDebug1HiiHandle); ShellPrintHiiEx ( -1, -1, NULL, STRING_TOKEN (STR_DMEM_CONF_PRO_ROW), gShellDebug1HiiHandle, L"EFI_CONFORMANCE_PROFILES_UEFI_SPEC_GUID", &gEfiConfProfilesUefiSpecGuid ); } return (ShellStatus); } STATIC CONST SHELL_PARAM_ITEM ParamList[] = { { L"-mmio", TypeFlag }, { L"-verbose", TypeFlag }, { NULL, TypeMax } }; /** Function for 'dmem' command. @param[in] ImageHandle Handle to the Image (NULL if Internal). @param[in] SystemTable Pointer to the System Table (NULL if Internal). **/ SHELL_STATUS EFIAPI ShellCommandRunDmem ( IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable ) { EFI_STATUS Status; LIST_ENTRY *Package; CHAR16 *ProblemParam; SHELL_STATUS ShellStatus; VOID *Address; UINT64 Size; CONST CHAR16 *Temp1; UINT64 AcpiTableAddress; UINT64 Acpi20TableAddress; UINT64 SalTableAddress; UINT64 SmbiosTableAddress; UINT64 MpsTableAddress; UINT64 DtbTableAddress; UINT64 MemoryAttributesTableAddress; UINT64 RtPropertiesTableAddress; UINT64 SystemResourceTableAddress; UINT64 DebugImageInfoTableAddress; UINT64 ImageExecutionTableAddress; UINT64 JsonConfigDataTableAddress; UINT64 JsonCapsuleDataTableAddress; UINT64 JsonCapsuleResultTableAddress; UINT64 MemoryRangeCapsuleAddress; UINT64 HiiDatabaseExportBufferAddress; UINT64 ConformanceProfileTableAddress; UINTN TableWalker; ShellStatus = SHELL_SUCCESS; Status = EFI_SUCCESS; Address = NULL; Size = 0; // // initialize the shell lib (we must be in non-auto-init...) // Status = ShellInitialize (); ASSERT_EFI_ERROR (Status); Status = CommandInit (); ASSERT_EFI_ERROR (Status); // // parse the command line // Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE); if (EFI_ERROR (Status)) { if ((Status == EFI_VOLUME_CORRUPTED) && (ProblemParam != NULL)) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"dmem", ProblemParam); FreePool (ProblemParam); ShellStatus = SHELL_INVALID_PARAMETER; } else { ASSERT (FALSE); } } else { if (ShellCommandLineGetCount (Package) > 3) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle, L"dmem"); ShellStatus = SHELL_INVALID_PARAMETER; } else { Temp1 = ShellCommandLineGetRawValue (Package, 1); if (Temp1 == NULL) { Address = gST; Size = sizeof (*gST); } else { if (!ShellIsHexOrDecimalNumber (Temp1, TRUE, FALSE) || EFI_ERROR (ShellConvertStringToUint64 (Temp1, (UINT64 *)&Address, TRUE, FALSE))) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dmem", Temp1); ShellStatus = SHELL_INVALID_PARAMETER; } Temp1 = ShellCommandLineGetRawValue (Package, 2); if (Temp1 == NULL) { Size = 512; } else { if (!ShellIsHexOrDecimalNumber (Temp1, FALSE, FALSE) || EFI_ERROR (ShellConvertStringToUint64 (Temp1, &Size, TRUE, FALSE))) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dmem", Temp1); ShellStatus = SHELL_INVALID_PARAMETER; } } } } if (ShellStatus == SHELL_SUCCESS) { if (!ShellCommandLineGetFlag (Package, L"-mmio")) { ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_DMEM_HEADER_ROW), gShellDebug1HiiHandle, (UINT64)(UINTN)Address, Size); DumpHex (2, (UINTN)Address, (UINTN)Size, Address); if (Address == (VOID *)gST) { Acpi20TableAddress = 0; AcpiTableAddress = 0; SalTableAddress = 0; SmbiosTableAddress = 0; MpsTableAddress = 0; DtbTableAddress = 0; MemoryAttributesTableAddress = 0; RtPropertiesTableAddress = 0; SystemResourceTableAddress = 0; DebugImageInfoTableAddress = 0; ImageExecutionTableAddress = 0; JsonConfigDataTableAddress = 0; JsonCapsuleDataTableAddress = 0; JsonCapsuleResultTableAddress = 0; MemoryRangeCapsuleAddress = 0; HiiDatabaseExportBufferAddress = 0; ConformanceProfileTableAddress = 0; for (TableWalker = 0; TableWalker < gST->NumberOfTableEntries; TableWalker++) { if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiAcpi20TableGuid)) { Acpi20TableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiAcpi10TableGuid)) { AcpiTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiSmbiosTableGuid)) { SmbiosTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiSmbios3TableGuid)) { SmbiosTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiMpsTableGuid)) { MpsTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiMemoryAttributesTableGuid)) { MemoryAttributesTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiRtPropertiesTableGuid)) { RtPropertiesTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiSystemResourceTableGuid)) { SystemResourceTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiDebugImageInfoTableGuid)) { DebugImageInfoTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiImageSecurityDatabaseGuid)) { ImageExecutionTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiJsonConfigDataTableGuid)) { JsonConfigDataTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiJsonCapsuleDataTableGuid)) { JsonCapsuleDataTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiJsonCapsuleResultTableGuid)) { JsonCapsuleResultTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiHiiDatabaseProtocolGuid)) { HiiDatabaseExportBufferAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } if (CompareGuid (&gST->ConfigurationTable[TableWalker].VendorGuid, &gEfiConfProfilesTableGuid)) { ConformanceProfileTableAddress = (UINT64)(UINTN)gST->ConfigurationTable[TableWalker].VendorTable; continue; } } ShellPrintHiiEx ( -1, -1, NULL, STRING_TOKEN (STR_DMEM_SYSTEM_TABLE), gShellDebug1HiiHandle, (UINT64)(UINTN)Address, gST->Hdr.HeaderSize, gST->Hdr.Revision, (UINT64)(UINTN)gST->ConIn, (UINT64)(UINTN)gST->ConOut, (UINT64)(UINTN)gST->StdErr, (UINT64)(UINTN)gST->RuntimeServices, (UINT64)(UINTN)gST->BootServices, SalTableAddress, AcpiTableAddress, Acpi20TableAddress, MpsTableAddress, SmbiosTableAddress, DtbTableAddress, MemoryAttributesTableAddress, RtPropertiesTableAddress, SystemResourceTableAddress, DebugImageInfoTableAddress, ImageExecutionTableAddress, JsonConfigDataTableAddress, JsonCapsuleDataTableAddress, JsonCapsuleResultTableAddress, MemoryRangeCapsuleAddress, HiiDatabaseExportBufferAddress, ConformanceProfileTableAddress ); } if (ShellCommandLineGetFlag (Package, L"-verbose")) { if (ShellStatus == SHELL_SUCCESS) { ShellStatus = DisplayRtProperties (RtPropertiesTableAddress); } if (ShellStatus == SHELL_SUCCESS) { ShellStatus = DisplayImageExecutionEntries (ImageExecutionTableAddress); } if (ShellStatus == SHELL_SUCCESS) { ShellStatus = DisplayConformanceProfiles (ConformanceProfileTableAddress); } } } else { ShellStatus = DisplayMmioMemory (Address, (UINTN)Size); } } ShellCommandLineFreeVarList (Package); } return (ShellStatus); }