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