actbl2.h revision 7b1019a6d29ccb7999dc76cba3dde1c627e8e609
/******************************************************************************
*
* Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2016, Intel Corp.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* substantially similar to the "NO WARRANTY" disclaimer below
* ("Disclaimer") and any redistribution must be conditioned upon
* including a substantially similar Disclaimer requirement for further
* binary redistribution.
* 3. Neither the names of the above-listed copyright holders nor the names
* of any contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* Alternatively, this software may be distributed under the terms of the
* GNU General Public License ("GPL") version 2 as published by the Free
* Software Foundation.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*/
#ifndef __ACTBL2_H__
#define __ACTBL2_H__
/*******************************************************************************
*
* Additional ACPI Tables (2)
*
* These tables are not consumed directly by the ACPICA subsystem, but are
* included here to support device drivers and the AML disassembler.
*
* Generally, the tables in this file are defined by third-party specifications,
* and are not defined directly by the ACPI specification itself.
*
******************************************************************************/
/*
* Values for description table header signatures for tables defined in this
* file. Useful because they make it more difficult to inadvertently type in
* the wrong signature.
*/
#ifdef ACPI_UNDEFINED_TABLES
/*
* These tables have been seen in the field, but no definition has been found
*/
#define ACPI_SIG_ATKG "ATKG"
#define ACPI_SIG_IEIT "IEIT"
#endif
/*
* All tables must be byte-packed to match the ACPI specification, since
* the tables are provided by the system BIOS.
*/
#pragma pack(1)
/*
* Note: C bitfields are not used for this reason:
*
* "Bitfields are great and easy to read, but unfortunately the C language
* does not specify the layout of bitfields in memory, which means they are
* essentially useless for dealing with packed data in on-disk formats or
* binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
* this decision was a design error in C. Ritchie could have picked an order
* and stuck with it." Norman Ramsey.
*/
/*******************************************************************************
*
* ASF - Alert Standard Format table (Signature "ASF!")
* Revision 0x10
*
* Conforms to the Alert Standard Format Specification V2.0, 23 April 2003
*
******************************************************************************/
typedef struct acpi_table_asf
{
/* ASF subtable header */
typedef struct acpi_asf_header
{
/* Values for Type field above */
enum AcpiAsfType
{
ACPI_ASF_TYPE_INFO = 0,
ACPI_ASF_TYPE_ALERT = 1,
ACPI_ASF_TYPE_BOOT = 3,
};
/*
* ASF subtables
*/
/* 0: ASF Information */
typedef struct acpi_asf_info
{
/* Masks for Flags field above */
#define ACPI_ASF_SMBUS_PROTOCOLS (1)
/* 1: ASF Alerts */
typedef struct acpi_asf_alert
{
typedef struct acpi_asf_alert_data
{
/* 2: ASF Remote Control */
typedef struct acpi_asf_remote
{
typedef struct acpi_asf_control_data
{
/* 3: ASF RMCP Boot Options */
typedef struct acpi_asf_rmcp
{
/* 4: ASF Address */
typedef struct acpi_asf_address
{
/*******************************************************************************
*
* BOOT - Simple Boot Flag Table
* Version 1
*
* Conforms to the "Simple Boot Flag Specification", Version 2.1
*
******************************************************************************/
typedef struct acpi_table_boot
{
/*******************************************************************************
*
* CSRT - Core System Resource Table
* Version 0
*
* Conforms to the "Core System Resource Table (CSRT)", November 14, 2011
*
******************************************************************************/
typedef struct acpi_table_csrt
{
/* Resource Group subtable */
typedef struct acpi_csrt_group
{
/* Shared data immediately follows (Length = SharedInfoLength) */
/* Shared Info subtable */
typedef struct acpi_csrt_shared_info
{
/* Resource descriptors immediately follow (Length = Group Length - SharedInfoLength) */
/* Resource Descriptor subtable */
typedef struct acpi_csrt_descriptor
{
/* Resource-specific information immediately follows */
/* Resource Types */
#define ACPI_CSRT_TYPE_INTERRUPT 0x0001
#define ACPI_CSRT_TYPE_TIMER 0x0002
#define ACPI_CSRT_TYPE_DMA 0x0003
/* Resource Subtypes */
#define ACPI_CSRT_XRUPT_LINE 0x0000
#define ACPI_CSRT_XRUPT_CONTROLLER 0x0001
#define ACPI_CSRT_TIMER 0x0000
#define ACPI_CSRT_DMA_CHANNEL 0x0000
#define ACPI_CSRT_DMA_CONTROLLER 0x0001
/*******************************************************************************
*
* DBG2 - Debug Port Table 2
* Version 0 (Both main table and subtables)
*
* Conforms to "Microsoft Debug Port Table 2 (DBG2)", December 10, 2015
*
******************************************************************************/
typedef struct acpi_table_dbg2
{
typedef struct acpi_dbg2_header
{
/* Debug Device Information Subtable */
typedef struct acpi_dbg2_device
{
/*
* Data that follows:
* BaseAddress (required) - Each in 12-byte Generic Address Structure format.
* AddressSize (required) - Array of UINT32 sizes corresponding to each BaseAddress register.
* Namepath (required) - Null terminated string. Single dot if not supported.
* OemData (optional) - Length is OemDataLength.
*/
/* Types for PortType field above */
#define ACPI_DBG2_SERIAL_PORT 0x8000
#define ACPI_DBG2_1394_PORT 0x8001
#define ACPI_DBG2_USB_PORT 0x8002
#define ACPI_DBG2_NET_PORT 0x8003
/* Subtypes for PortSubtype field above */
#define ACPI_DBG2_16550_COMPATIBLE 0x0000
#define ACPI_DBG2_16550_SUBSET 0x0001
#define ACPI_DBG2_ARM_PL011 0x0003
#define ACPI_DBG2_ARM_SBSA_32BIT 0x000D
#define ACPI_DBG2_ARM_SBSA_GENERIC 0x000E
#define ACPI_DBG2_ARM_DCC 0x000F
#define ACPI_DBG2_BCM2835 0x0010
#define ACPI_DBG2_1394_STANDARD 0x0000
#define ACPI_DBG2_USB_XHCI 0x0000
#define ACPI_DBG2_USB_EHCI 0x0001
/*******************************************************************************
*
* DBGP - Debug Port table
* Version 1
*
* Conforms to the "Debug Port Specification", Version 1.00, 2/9/2000
*
******************************************************************************/
typedef struct acpi_table_dbgp
{
/*******************************************************************************
*
* DMAR - DMA Remapping table
* Version 1
*
* Conforms to "Intel Virtualization Technology for Directed I/O",
* Version 2.3, October 2014
*
******************************************************************************/
typedef struct acpi_table_dmar
{
/* Masks for Flags field above */
#define ACPI_DMAR_INTR_REMAP (1)
/* DMAR subtable header */
typedef struct acpi_dmar_header
{
/* Values for subtable type in ACPI_DMAR_HEADER */
enum AcpiDmarType
{
};
/* DMAR Device Scope structure */
typedef struct acpi_dmar_device_scope
{
/* Values for EntryType in ACPI_DMAR_DEVICE_SCOPE - device types */
enum AcpiDmarScopeType
{
};
typedef struct acpi_dmar_pci_path
{
/*
* DMAR Subtables, correspond to Type in ACPI_DMAR_HEADER
*/
/* 0: Hardware Unit Definition */
typedef struct acpi_dmar_hardware_unit
{
/* Masks for Flags field above */
#define ACPI_DMAR_INCLUDE_ALL (1)
/* 1: Reserved Memory Defininition */
typedef struct acpi_dmar_reserved_memory
{
/* Masks for Flags field above */
#define ACPI_DMAR_ALLOW_ALL (1)
/* 2: Root Port ATS Capability Reporting Structure */
typedef struct acpi_dmar_atsr
{
/* Masks for Flags field above */
#define ACPI_DMAR_ALL_PORTS (1)
/* 3: Remapping Hardware Static Affinity Structure */
typedef struct acpi_dmar_rhsa
{
/* 4: ACPI Namespace Device Declaration Structure */
typedef struct acpi_dmar_andd
{
char DeviceName[1];
/*******************************************************************************
*
* HPET - High Precision Event Timer table
* Version 1
*
* Conforms to "IA-PC HPET (High Precision Event Timers) Specification",
* Version 1.0a, October 2004
*
******************************************************************************/
typedef struct acpi_table_hpet
{
/* Masks for Flags field above */
#define ACPI_HPET_PAGE_PROTECT_MASK (3)
/* Values for Page Protect flags */
enum AcpiHpetPageProtect
{
};
/*******************************************************************************
*
* IBFT - Boot Firmware Table
* Version 1
*
* Conforms to "iSCSI Boot Firmware Table (iBFT) as Defined in ACPI 3.0b
* Specification", Version 1.01, March 1, 2007
*
* Therefore, it is not currently supported by the disassembler.
*
******************************************************************************/
typedef struct acpi_table_ibft
{
/* IBFT common subtable header */
typedef struct acpi_ibft_header
{
/* Values for Type field above */
enum AcpiIbftType
{
ACPI_IBFT_TYPE_NIC = 3,
};
/* IBFT subtables */
typedef struct acpi_ibft_control
{
typedef struct acpi_ibft_initiator
{
typedef struct acpi_ibft_nic
{
typedef struct acpi_ibft_target
{
/*******************************************************************************
*
* IORT - IO Remapping Table
*
* Conforms to "IO Remapping Table System Software on ARM Platforms",
* Document number: ARM DEN 0049B, October 2015
*
******************************************************************************/
typedef struct acpi_table_iort
{
/*
* IORT subtables
*/
typedef struct acpi_iort_node
{
char NodeData[1];
/* Values for subtable Type above */
enum AcpiIortNodeType
{
ACPI_IORT_NODE_ITS_GROUP = 0x00,
ACPI_IORT_NODE_NAMED_COMPONENT = 0x01,
ACPI_IORT_NODE_PCI_ROOT_COMPLEX = 0x02,
ACPI_IORT_NODE_SMMU = 0x03,
ACPI_IORT_NODE_SMMU_V3 = 0x04
};
typedef struct acpi_iort_id_mapping
{
/* Masks for Flags field above for IORT subtable */
#define ACPI_IORT_ID_SINGLE_MAPPING (1)
typedef struct acpi_iort_memory_access
{
/* Values for CacheCoherency field above */
/* Masks for Hints field above */
#define ACPI_IORT_HT_TRANSIENT (1)
/* Masks for MemoryFlags field above */
#define ACPI_IORT_MF_COHERENCY (1)
/*
* IORT node specific subtables
*/
typedef struct acpi_iort_its_group
{
typedef struct acpi_iort_named_component
{
typedef struct acpi_iort_root_complex
{
/* Values for AtsAttribute field above */
typedef struct acpi_iort_smmu
{
/* Values for Model field above */
/* Masks for Flags field above */
#define ACPI_IORT_SMMU_DVM_SUPPORTED (1)
typedef struct acpi_iort_smmu_v3
{
/* Masks for Flags field above */
#define ACPI_IORT_SMMU_V3_COHACC_OVERRIDE (1)
/*******************************************************************************
*
* IVRS - I/O Virtualization Reporting Structure
* Version 1
*
* Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
* Revision 1.26, February 2009.
*
******************************************************************************/
typedef struct acpi_table_ivrs
{
/* Values for Info field above */
/* IVRS subtable header */
typedef struct acpi_ivrs_header
{
/* Values for subtable Type above */
enum AcpiIvrsType
{
ACPI_IVRS_TYPE_HARDWARE = 0x10,
ACPI_IVRS_TYPE_MEMORY1 = 0x20,
ACPI_IVRS_TYPE_MEMORY2 = 0x21,
ACPI_IVRS_TYPE_MEMORY3 = 0x22
};
/* Masks for Flags field above for IVHD subtable */
#define ACPI_IVHD_TT_ENABLE (1)
/* Masks for Flags field above for IVMD subtable */
#define ACPI_IVMD_UNITY (1)
/*
* IVRS subtables, correspond to Type in ACPI_IVRS_HEADER
*/
/* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
typedef struct acpi_ivrs_hardware
{
/* Masks for Info field above */
/*
* Device Entries for IVHD subtable, appear after ACPI_IVRS_HARDWARE structure.
* Upper two bits of the Type field are the (encoded) length of the structure.
* Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
* are reserved for future use but not defined.
*/
typedef struct acpi_ivrs_de_header
{
/* Length of device entry is in the top two bits of Type field above */
#define ACPI_IVHD_ENTRY_LENGTH 0xC0
/* Values for device entry Type field above */
{
/* 4-byte device entries, all use ACPI_IVRS_DEVICE4 */
ACPI_IVRS_TYPE_PAD4 = 0,
ACPI_IVRS_TYPE_ALL = 1,
ACPI_IVRS_TYPE_START = 3,
ACPI_IVRS_TYPE_END = 4,
/* 8-byte device entries */
ACPI_IVRS_TYPE_PAD8 = 64,
ACPI_IVRS_TYPE_NOT_USED = 65,
};
/* Values for Data field above */
#define ACPI_IVHD_INIT_PASS (1)
/* Types 0-4: 4-byte device entry */
typedef struct acpi_ivrs_device4
{
/* Types 66-67: 8-byte device entry */
typedef struct acpi_ivrs_device8a
{
/* Types 70-71: 8-byte device entry */
typedef struct acpi_ivrs_device8b
{
/* Values for ExtendedData above */
/* Type 72: 8-byte device entry */
typedef struct acpi_ivrs_device8c
{
/* Values for Variety field above */
#define ACPI_IVHD_IOAPIC 1
#define ACPI_IVHD_HPET 2
/* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
typedef struct acpi_ivrs_memory
{
/*******************************************************************************
*
* LPIT - Low Power Idle Table
*
* Conforms to "ACPI Low Power Idle Table (LPIT)" July 2014.
*
******************************************************************************/
typedef struct acpi_table_lpit
{
/* LPIT subtable header */
typedef struct acpi_lpit_header
{
/* Values for subtable Type above */
enum AcpiLpitType
{
ACPI_LPIT_TYPE_NATIVE_CSTATE = 0x00,
};
/* Masks for Flags field above */
#define ACPI_LPIT_STATE_DISABLED (1)
/*
* LPIT subtables, correspond to Type in ACPI_LPIT_HEADER
*/
/* 0x00: Native C-state instruction based LPI structure */
typedef struct acpi_lpit_native
{
/*******************************************************************************
*
* MCFG - PCI Memory Mapped Configuration table and subtable
* Version 1
*
* Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
*
******************************************************************************/
typedef struct acpi_table_mcfg
{
/* Subtable */
typedef struct acpi_mcfg_allocation
{
/*******************************************************************************
*
* MCHI - Management Controller Host Interface Table
* Version 1
*
* Conforms to "Management Component Transport Protocol (MCTP) Host
* Interface Specification", Revision 1.0.0a, October 13, 2009
*
******************************************************************************/
typedef struct acpi_table_mchi
{
/*******************************************************************************
*
* MSDM - Microsoft Data Management table
*
* Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
* November 29, 2011. Copyright 2011 Microsoft
*
******************************************************************************/
/* Basic MSDM table is only the common ACPI header */
typedef struct acpi_table_msdm
{
/*******************************************************************************
*
* MTMR - MID Timer Table
* Version 1
*
* Conforms to "Simple Firmware Interface Specification",
* Draft 0.8.2, Oct 19, 2010
* NOTE: The ACPI MTMR is equivalent to the SFI MTMR table.
*
******************************************************************************/
typedef struct acpi_table_mtmr
{
/* MTMR entry */
typedef struct acpi_mtmr_entry
{
/*******************************************************************************
*
* SLIC - Software Licensing Description Table
*
* Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
* November 29, 2011. Copyright 2011 Microsoft
*
******************************************************************************/
/* Basic SLIC table is only the common ACPI header */
typedef struct acpi_table_slic
{
/*******************************************************************************
*
* SPCR - Serial Port Console Redirection table
* Version 2
*
* Conforms to "Serial Port Console Redirection Table",
* Version 1.03, August 10, 2015
*
******************************************************************************/
typedef struct acpi_table_spcr
{
/* Masks for PciFlags field above */
#define ACPI_SPCR_DO_NOT_DISABLE (1)
/* Values for Interface Type: See the definition of the DBG2 table */
/*******************************************************************************
*
* SPMI - Server Platform Management Interface table
* Version 5
*
* Conforms to "Intelligent Platform Management Interface Specification
* Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
* June 12, 2009 markup.
*
******************************************************************************/
typedef struct acpi_table_spmi
{
/* Values for InterfaceType above */
{
ACPI_SPMI_NOT_USED = 0,
ACPI_SPMI_KEYBOARD = 1,
ACPI_SPMI_SMI = 2,
ACPI_SPMI_SMBUS = 4,
};
/*******************************************************************************
*
* TCPA - Trusted Computing Platform Alliance table
* Version 2
*
* Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
* December 19, 2014
*
* NOTE: There are two versions of the table with the same signature --
* the client version and the server version. The common PlatformClass
* field is used to differentiate the two types of tables.
*
******************************************************************************/
typedef struct acpi_table_tcpa_hdr
{
/*
* Values for PlatformClass above.
* This is how the client and server subtables are differentiated
*/
#define ACPI_TCPA_CLIENT_TABLE 0
#define ACPI_TCPA_SERVER_TABLE 1
typedef struct acpi_table_tcpa_client
{
typedef struct acpi_table_tcpa_server
{
/* Values for DeviceFlags above */
#define ACPI_TCPA_PCI_DEVICE (1)
/* Values for InterruptFlags above */
#define ACPI_TCPA_INTERRUPT_MODE (1)
/*******************************************************************************
*
* TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
* Version 4
*
* Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
* December 19, 2014
*
******************************************************************************/
typedef struct acpi_table_tpm2
{
/* Platform-specific data follows */
/* Values for StartMethod above */
#define ACPI_TPM2_NOT_ALLOWED 0
#define ACPI_TPM2_START_METHOD 2
#define ACPI_TPM2_MEMORY_MAPPED 6
#define ACPI_TPM2_COMMAND_BUFFER 7
/*******************************************************************************
*
* UEFI - UEFI Boot optimization Table
* Version 1
*
* Conforms to "Unified Extensible Firmware Interface Specification",
* Version 2.3, May 8, 2009
*
******************************************************************************/
typedef struct acpi_table_uefi
{
/*******************************************************************************
*
* VRTC - Virtual Real Time Clock Table
* Version 1
*
* Conforms to "Simple Firmware Interface Specification",
* Draft 0.8.2, Oct 19, 2010
* NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
*
******************************************************************************/
typedef struct acpi_table_vrtc
{
/* VRTC entry */
typedef struct acpi_vrtc_entry
{
/*******************************************************************************
*
* WAET - Windows ACPI Emulated devices Table
* Version 1
*
* Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
*
******************************************************************************/
typedef struct acpi_table_waet
{
/* Masks for Flags field above */
/*******************************************************************************
*
* WDAT - Watchdog Action Table
* Version 1
*
* Conforms to "Hardware Watchdog Timers Design Specification",
* Copyright 2006 Microsoft Corporation.
*
******************************************************************************/
typedef struct acpi_table_wdat
{
/* Masks for Flags field above */
#define ACPI_WDAT_ENABLED (1)
#define ACPI_WDAT_STOPPED 0x80
/* WDAT Instruction Entries (actions) */
typedef struct acpi_wdat_entry
{
/* Values for Action field above */
enum AcpiWdatActions
{
ACPI_WDAT_RESET = 1,
ACPI_WDAT_GET_REBOOT = 16,
ACPI_WDAT_SET_REBOOT = 17,
ACPI_WDAT_GET_SHUTDOWN = 18,
ACPI_WDAT_SET_SHUTDOWN = 19,
ACPI_WDAT_GET_STATUS = 32,
ACPI_WDAT_SET_STATUS = 33,
};
/* Values for Instruction field above */
enum AcpiWdatInstructions
{
ACPI_WDAT_READ_VALUE = 0,
};
/*******************************************************************************
*
* WDDT - Watchdog Descriptor Table
* Version 1
*
* Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
* Version 001, September 2002
*
******************************************************************************/
typedef struct acpi_table_wddt
{
/* Flags for Status field above */
#define ACPI_WDDT_AVAILABLE (1)
/* Flags for Capability field above */
#define ACPI_WDDT_AUTO_RESET (1)
/*******************************************************************************
*
* WDRT - Watchdog Resource Table
* Version 1
*
* Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
* Version 1.01, August 28, 2006
*
******************************************************************************/
typedef struct acpi_table_wdrt
{
/* Reset to default packing */
#pragma pack()
#endif /* __ACTBL2_H__ */