ShellPkg/Application/AcpiViewApp/AcpiViewApp.uni

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