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