ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.uni

   1 // /**
   2 //
   3 // Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.<BR>
   4 // SPDX-License-Identifier: BSD-2-Clause-Patent
   5 //
   6 // Module Name:
   7 //
   8 // UefiShellAcpiViewCommandLib.uni
   9 //
  10 // Abstract:
  11 //
  12 // String definitions for UEFI Shell acpiview command
  13 //
  14 //
  15 // */
  16
  17 /=#
  18
  19 #langdef   en-US "english"
  20
  21 #string STR_GEN_PROBLEM           #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"
  22 #string STR_GEN_NO_VALUE          #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"
  23 #string STR_GEN_TOO_MANY          #language en-US "%H%s%N: Too many arguments.\r\n"
  24 #string STR_GEN_MISSING_OPTION    #language en-US "%H%s%N: Missing option '%H%s%N' required by flag - '%H%s%N'\r\n"
  25 #string STR_GEN_READONLY_MEDIA    #language en-US "%H%s%N: Unable to write to the current directory, check if media is writable.\r\n"
  26
  27 #string STR_GET_HELP_ACPIVIEW   #language en-US ""
  28 ".TH acpiview 0 "Display ACPI information."\r\n"
  29 ".SH NAME\r\n"
  30 "Display ACPI Table information.\r\n"
  31 ".SH SYNOPSIS\r\n"
  32 " \r\n"
  33 "ACPIVIEW [[-?] | [[-l] | [-s AcpiTable [-d]]] [-c] [-v] [-h Highlight]]\r\n"
  34 " \r\n"
  35 ".SH OPTIONS\r\n"
  36 " \r\n"
  37 "  -l - Display list of installed ACPI Tables.\r\n"
  38 "  -s - Display only the specified AcpiTable type.\r\n"
  39 "         AcpiTable    : The required ACPI Table type.\r\n"
  40 "  -d - Generate a binary file dump of the specified AcpiTable.\r\n"
  41 "  -c - Consistency checking (enabled by default).\r\n"
  42 "  -v - Display verbose data (enabled by default).\r\n"
  43 "  -h - Enable/Disable Colour Highlighting.\r\n"
  44 "         Highlight    : TRUE/ON enables highlighting;\r\n"
  45 "                        FALSE/OFF (default) disables highlighting.\r\n"
  46 "  -? - Show help.\r\n"
  47 " \r\n"
  48 ".SH DESCRIPTION\r\n"
  49 " \r\n"
  50 "  This program is provided to allow examination of ACPI table values from the\r\n"
  51 "  UEFI Shell.  This can help with investigations, especially at that stage where\r\n"
  52 "  the tables are not enabling an OS to boot.\r\n"
  53 "  The program is not exhaustive, and only encapsulates detailed knowledge of a\r\n"
  54 "  limited number of table types.\r\n"
  55 " \r\n"
  56 "  Default behaviour is to display the content of all tables installed.\r\n"
  57 "  'Known' table types (listed in NOTES below) will be parsed and displayed\r\n"
  58 "  with descriptions and field values.  Where appropriate a degree of consistency\r\n"
  59 "  checking is done and errors may be reported in the output.\r\n"
  60 "  Other table types will be displayed as an array of Hexadecimal bytes.\r\n"
  61 " \r\n"
  62 "  To facilitate debugging, the -s and -d options can be used to generate a\r\n"
  63 "  binary file image of a table that can be copied elsewhere for investigation\r\n"
  64 "  using tools such as those provided by acpica.org.  This is especially relevant\r\n"
  65 "  for AML type tables like DSDT and SSDT.\r\n"
  66 " \r\n"
  67 "NOTES:\r\n"
  68 "  1. The AcpiTable parameter can match any installed table type.\r\n"
  69 "     Tables without specific handling will be displayed as a raw hex dump (or\r\n"
  70 "     dumped to a file if -d is used).\r\n"
  71 "  2. -s option supports to display the specified AcpiTable type that is present\r\n"
  72 "     in the system. For normal type AcpiTable, it would display the data of the\r\n"
  73 "     AcpiTable and AcpiTable header. The following type may contain header type\r\n"
  74 "     other than AcpiTable header. The actual header can refer to the ACPI spec 6.2\r\n"
  75 "     Extra A. Particular types:\r\n"
  76 "       APIC  - Multiple APIC Description Table (MADT)\r\n"
  77 "       BGRT  - Boot Graphics Resource Table\r\n"
  78 "       DBG2  - Debug Port Table 2\r\n"
  79 "       DSDT  - Differentiated System Description Table\r\n"
  80 "       FACP  - Fixed ACPI Description Table (FADT)\r\n"
  81 "       GTDT  - Generic Timer Description Table\r\n"
  82 "       IORT  - IO Remapping Table\r\n"
  83 "       MCFG  - Memory Mapped Config Space Base Address Description Table\r\n"
  84 "       PPTT  - Processor Properties Topology Table\r\n"
  85 "       RSDP  - Root System Description Pointer\r\n"
  86 "       SLIT  - System Locality Information Table\r\n"
  87 "       SPCR  - Serial Port Console Redirection Table\r\n"
  88 "       SRAT  - System Resource Affinity Table\r\n"
  89 "       SSDT  - Secondary SystemDescription Table\r\n"
  90 "       XSDT  - Extended System Description Table\r\n"
  91 " \r\n"
  92 ".SH STANDARDS\r\n"
  93 " \r\n"
  94 "  Table details correspond to those in 'Advanced Configuration and Power\r\n"
  95 "  Interface Specification' Version 6.2 Errata A, [September 2017]\r\n"
  96 "  (http://www.uefi.org/sites/default/files/resources/ACPI%206_2_A_Sept29.pdf)\r\n"
  97 " \r\n"
  98 "  NOTE: The nature of the ACPI standard means that almost all tables in 6.1 will\r\n"
  99 "        be 'backwards compatible' with prior version of the specification in\r\n"
 100 "        terms of structure, so formatted output should be correct.  The main\r\n"
 101 "        exception will be that previously 'reserved' fields will be reported\r\n"
 102 "        with new names, where they have been added in later versions of the\r\n"
 103 "        specification.\r\n"
 104 " \r\n"
 105 ".SH EXAMPLES\r\n"
 106 " \r\n"
 107 " \r\n"
 108 "EXAMPLES:\r\n"
 109 "  * To display a list of the installed table types:\r\n"
 110 "    fs0:\> acpiview -l\r\n"
 111 " \r\n"
 112 "  * To parse and display a specific table type:\r\n"
 113 "    fs0:\> acpiview -s GTDT\r\n"
 114 " \r\n"
 115 "  * To save a binary dump of the contents of a table to a file\r\n"
 116 "    in the current working directory:\r\n"
 117 "    fs0:\> acpiview -s DSDT -d\r\n"
 118 " \r\n"
 119 "  * To display contents of all ACPI tables:\r\n"
 120 "    fs0:\> acpiview\r\n"
 121 " \r\n"
 122 ".SH RETURNVALUES\r\n"
 123 " \r\n"
 124 "RETURN VALUES:\r\n"
 125 "  SHELL_SUCCESS             Data was displayed as requested.\r\n"
 126 "  SHELL_INVALID_PARAMETER   ACPI Table parsing failed.\r\n"
 127 " \r\n"
 128