ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.uni

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