git: bbfd734823f4 - main - acpidump: Document the alphabit soup of ACPI Table names

The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=bbfd734823f43e7964f66390df3e1c350bffd991

commit bbfd734823f43e7964f66390df3e1c350bffd991
Author:     Warner Losh <imp@FreeBSD.org>
AuthorDate: 2024-10-15 11:08:24 +0000
Commit:     Warner Losh <imp@FreeBSD.org>
CommitDate: 2024-10-15 11:08:24 +0000

    acpidump: Document the alphabit soup of ACPI Table names
    
    Clarify what's reported with -t (it's all the fixed acpi tables,
    not just the listed ones). The listed tables are more fully decoded,
    while all other tables just have their headers decoded.
    
    Sponsored by:           Netflix
    Reviewed by:            adrian
    Differential Revision:  https://reviews.freebsd.org/D47080
---
 usr.sbin/acpi/acpidump/acpidump.8 | 91 +++++++++++++++++++++++++++------------
 1 file changed, 64 insertions(+), 27 deletions(-)

diff --git a/usr.sbin/acpi/acpidump/acpidump.8 b/usr.sbin/acpi/acpidump/acpidump.8
index f193b9a3511a..98e0a4d9f524 100644
--- a/usr.sbin/acpi/acpidump/acpidump.8
+++ b/usr.sbin/acpi/acpidump/acpidump.8
@@ -27,7 +27,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd June 29, 2020
+.Dd October 5, 2024
 .Dt ACPIDUMP 8
 .Os
 .Sh NAME
@@ -36,11 +36,11 @@
 .Sh SYNOPSIS
 .Nm
 .Op Fl d
-.Op Fl t
-.Op Fl h
-.Op Fl v
 .Op Fl f Ar dsdt_input
+.Op Fl h
 .Op Fl o Ar dsdt_output
+.Op Fl t
+.Op Fl v
 .Sh DESCRIPTION
 The
 .Nm
@@ -88,38 +88,75 @@ called SDTs
 and their header has a common format which consists of items
 such as Signature, Length, Revision, Checksum, OEMID, OEM Table ID,
 OEM Revision, Creator ID and Creator Revision.
+.Pp
 When invoked with the
 .Fl t
 flag, the
 .Nm
-utility dumps contents of the following tables:
+utility dumps contents of all the ACPI tables, except the DSDT and SSDT.
+The following SDTs are reported in detail, while the remainder will only report
+the common header information:
 .Pp
 .Bl -tag -offset indent -width 12345 -compact
-.It BERT
-.It DMAR
-.It DSDT
-.It ECDT
-.It EINJ
-.It ERST
-.It FACS
-.It FADT
-.It HEST
-.It HPET
-.It LPIT
-.It MADT
-.It MCFG
-.It NFIT
+.It BERT Boot Error Record Table
+Reports any previous boot errors.
+.It DMAR DMA Remapping Table
+Contains information about the DMA remapping necessary for the system
+for I/O virtualization on Intel CPUS.
+.It DSDT Differentiated System Description Table
+Contains the main AML for the system.
+.It ECDT Embedded Controller Boot Resources Table
+Contains information about accessing the embedded controller
+prior to the OS decoding the DSDT for all its details.
+.It EINJ Error Injection Table
+Use to inject hardware errors to the error reporting mechanisms.
+.It ERST Error Record Serialization Table
+Information to retrieve and manage errors reported from the hardware.
+.It FACS Firmware ACPI Control Structure
+Information for the OS to interact with the firmware for things
+like suspend / resume and prevent mutual access to resources
+shared between the OS and the firmware.
+.It FACP Fixed ACPI Description Table (FADT)
+Information related to power management, and other CPU related data.
+.It HEST Hardware Error Source Table
+Describes the possible sources of hardware errors to the OS.
+.It HPET High Precision Event Timer Table
+Describes the high precision timers in the system.
+.It IVRS I/O Virtualization Reporting Structure
+Information for hypvervisors to use to share I/O resources on AMD
+processors.
+.It LPIT Low Power Idle Table
+Power management information for reducing power usage of the system.
+.It MADT Multiple APIC Description Table
+Describes all the Advanced Programmable Interrupt Controllers and
+Intel Streamlined Advanced Programmable Interrupt Controller present
+in the system.
+.It MCFG PCI Express Memory-mapped Configuration
+PCI config space base address register.
+.It NFIT NVDIMM Firmware Interface Table
+NVDIMM information in the system.
 .It RSD PTR
-.It RSDT
-.It SLIT
-.It SRAT
-.It TCPA
-.It TPM2
-.It WDDT
+Pointer to the RSDT.
+.It RSDT Root System Description Table
+An array of physical pointers to other system description tables,
+the FACP (Fixed ACPI Description Table).
+.It SLIT System Locality Distance Information Table
+Provides information about the cost of communicating between different
+parts of the system (NUMA).
+.It SPCR Serial Port Console Redirection
+Contains informatiom about any serial port that the firmware used as
+a reporting console.
+.It SRAT System Resource Affinity Table
+Defines the domains of locality in the system for processors, memory
+and generic initiators (eg PCIe root complexes).
+.It TCPA Trusted Computing Platform Alliance
+Information about the TPM elements of the system.
+.It TPM2 Trusted Platform Module 2
+Additional information about newer TPM hardware.
+.It WDDT Watchdog Timer Description Table
+Information about how to manage watchdog timers in the system.
 .El
 .Pp
-The RSDT contains a pointer to the physical memory address of the FACP
-(Fixed ACPI Description Table).
 The FACP defines static system information about power management support
 (ACPI Hardware Register Implementation)
 such as interrupt mode (INT_MODEL),