--- /dev/null
+// @file\r
+//\r
+// Standalone EFI application that displays and verifies ACPI tables\r
+//\r
+// Copyright (c) 2020, ARM Limited. All rights reserved.<BR>\r
+// SPDX-License-Identifier: BSD-2-Clause-Patent\r
+//\r
+\r
+/=#\r
+\r
+#langdef en-US "english"\r
+\r
+#string STR_GET_HELP_ACPIVIEW #language en-US ""\r
+".TH acpiview 0 "Display ACPI information."\r\n"\r
+".SH NAME\r\n"\r
+"Display ACPI Table information.\r\n"\r
+".SH SYNOPSIS\r\n"\r
+" \r\n"\r
+"ACPIVIEWAPP.EFI [[-?] | [[[[-l] | [-s AcpiTable [-d]]] [-q] [-h]] [-r Spec]]]\r\n"\r
+" \r\n"\r
+".SH OPTIONS\r\n"\r
+" \r\n"\r
+" -l - Display list of installed ACPI Tables.\r\n"\r
+" -s - Display only the specified AcpiTable type and only support single\r\n"\r
+" invocation option.\r\n"\r
+" AcpiTable : The required ACPI Table type.\r\n"\r
+" -d - Generate a binary file dump of the specified AcpiTable.\r\n"\r
+" -q - Quiet. Suppress errors and warnings. Disables consistency checks.\r\n"\r
+" -h - Enable colour highlighting.\r\n"\r
+" -r - Validate that all required ACPI tables are installed\r\n"\r
+" Spec : Specification to validate against.\r\n"\r
+" For Arm, the possible values are:\r\n"\r
+" 0 - Server Base Boot Requirements v1.0\r\n"\r
+" 1 - Server Base Boot Requirements v1.1\r\n"\r
+" 2 - Server Base Boot Requirements v1.2\r\n"\r
+" -? - Show help.\r\n"\r
+" \r\n"\r
+".SH DESCRIPTION\r\n"\r
+" \r\n"\r
+" This program is provided to allow examination of ACPI table values from the\r\n"\r
+" UEFI Shell. This can help with investigations, especially at that stage\r\n"\r
+" where the tables are not enabling an OS to boot.\r\n"\r
+" The program is not exhaustive, and only encapsulates detailed knowledge of a\r\n"\r
+" limited number of table types.\r\n"\r
+" \r\n"\r
+" Default behaviour is to display the content of all tables installed.\r\n"\r
+" 'Known' table types (listed in NOTES below) will be parsed and displayed\r\n"\r
+" with descriptions and field values. Where appropriate a degree of\r\n"\r
+" consistency checking is done and errors may be reported in the output.\r\n"\r
+" Other table types will be displayed as an array of Hexadecimal bytes.\r\n"\r
+" \r\n"\r
+" To facilitate debugging, the -s and -d options can be used to generate a\r\n"\r
+" binary file image of a table that can be copied elsewhere for investigation\r\n"\r
+" using tools such as those provided by acpica.org. This is especially\r\n"\r
+" relevant for AML type tables like DSDT and SSDT.\r\n"\r
+" \r\n"\r
+"NOTES:\r\n"\r
+" 1. The AcpiTable parameter can match any installed table type.\r\n"\r
+" Tables without specific handling will be displayed as a raw hex dump (or\r\n"\r
+" dumped to a file if -d is used).\r\n"\r
+" 2. -s option supports to display the specified AcpiTable type that is present\r\n"\r
+" in the system. For normal type AcpiTable, it would display the data of the\r\n"\r
+" AcpiTable and AcpiTable header. The following type may contain header type\r\n"\r
+" other than AcpiTable header. The actual header can refer to the ACPI spec\r\n"\r
+" 6.3\r\n"\r
+" Extra A. Particular types:\r\n"\r
+" APIC - Multiple APIC Description Table (MADT)\r\n"\r
+" BGRT - Boot Graphics Resource Table\r\n"\r
+" DBG2 - Debug Port Table 2\r\n"\r
+" DSDT - Differentiated System Description Table\r\n"\r
+" FACP - Fixed ACPI Description Table (FADT)\r\n"\r
+" GTDT - Generic Timer Description Table\r\n"\r
+" IORT - IO Remapping Table\r\n"\r
+" MCFG - Memory Mapped Config Space Base Address Description Table\r\n"\r
+" PPTT - Processor Properties Topology Table\r\n"\r
+" RSDP - Root System Description Pointer\r\n"\r
+" SLIT - System Locality Information Table\r\n"\r
+" SPCR - Serial Port Console Redirection Table\r\n"\r
+" SRAT - System Resource Affinity Table\r\n"\r
+" SSDT - Secondary SystemDescription Table\r\n"\r
+" XSDT - Extended System Description Table\r\n"\r
+" \r\n"\r
+".SH STANDARDS\r\n"\r
+" \r\n"\r
+" Table details correspond to those in 'Advanced Configuration and Power\r\n"\r
+" Interface Specification' Version 6.3 [January 2019]\r\n"\r
+" (https://uefi.org/specifications)\r\n"\r
+" \r\n"\r
+" NOTE: The nature of the ACPI standard means that almost all tables in 6.3\r\n"\r
+" will be 'backwards compatible' with prior version of the specification\r\n"\r
+" in terms of structure, so formatted output should be correct. The main\r\n"\r
+" exception will be that previously 'reserved' fields will be reported\r\n"\r
+" with new names, where they have been added in later versions of the\r\n"\r
+" specification.\r\n"\r
+" \r\n"\r
+".SH EXAMPLES\r\n"\r
+" \r\n"\r
+" \r\n"\r
+"EXAMPLES:\r\n"\r
+" * To display a list of the installed table types:\r\n"\r
+" fs0:\> acpiviewapp.efi -l\r\n"\r
+" \r\n"\r
+" * To parse and display a specific table type:\r\n"\r
+" fs0:\> acpiviewapp.efi -s GTDT\r\n"\r
+" \r\n"\r
+" * To save a binary dump of the contents of a table to a file\r\n"\r
+" in the current working directory:\r\n"\r
+" fs0:\> acpiviewapp.efi -s DSDT -d\r\n"\r
+" \r\n"\r
+" * To display contents of all ACPI tables:\r\n"\r
+" fs0:\> acpiviewapp.efi\r\n"\r
+" \r\n"\r
+" * To check if all Server Base Boot Requirements (SBBR) v1.2 mandatory\r\n"\r
+" ACPI tables are installed (Arm only):\r\n"\r
+" fs0:\> acpiviewapp.efi -r 2\r\n"\r
+" \r\n"\r
+".SH RETURNVALUES\r\n"\r
+" \r\n"\r
+"RETURN VALUES:\r\n"\r
+" SHELL_SUCCESS Data was displayed as requested.\r\n"\r
+" SHELL_INVALID_PARAMETER ACPI Table parsing failed.\r\n"\r
+" \r\n"\r
projects / mirror_edk2.git / blobdiff