actbl3.h revision 199767f8919635c4928607450d9e0abb932109ce
/******************************************************************************
*
* Name: actbl3.h - ACPI Table Definitions
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2015, 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 __ACTBL3_H__
#define __ACTBL3_H__
/*******************************************************************************
*
* Additional ACPI Tables (3)
*
* These tables are not consumed directly by the ACPICA subsystem, but are
* included here to support device drivers and the AML disassembler.
*
* In general, the tables in this file are fully defined within the ACPI
* specification.
*
******************************************************************************/
/*
* 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.
*/
/* Reserved table signatures */
/*
* 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.
*/
/*******************************************************************************
*
* BGRT - Boot Graphics Resource Table (ACPI 5.0)
* Version 1
*
******************************************************************************/
typedef struct acpi_table_bgrt
{
/*******************************************************************************
*
* DRTM - Dynamic Root of Trust for Measurement table
* Conforms to "TCG D-RTM Architecture" June 17 2013, Version 1.0.0
* Table version 1
*
******************************************************************************/
typedef struct acpi_table_drtm
{
/* Flag Definitions for above */
#define ACPI_DRTM_ACCESS_ALLOWED (1)
/* 1) Validated Tables List (64-bit addresses) */
typedef struct acpi_drtm_vtable_list
{
/* 2) Resources List (of Resource Descriptors) */
/* Resource Descriptor */
typedef struct acpi_drtm_resource
{
typedef struct acpi_drtm_resource_list
{
/* 3) Platform-specific Identifiers List */
typedef struct acpi_drtm_dps_id
{
/*******************************************************************************
*
* FPDT - Firmware Performance Data Table (ACPI 5.0)
* Version 1
*
******************************************************************************/
typedef struct acpi_table_fpdt
{
/* FPDT subtable header */
typedef struct acpi_fpdt_header
{
/* Values for Type field above */
enum AcpiFpdtType
{
ACPI_FPDT_TYPE_BOOT = 0,
};
/*
* FPDT subtables
*/
/* 0: Firmware Basic Boot Performance Record */
typedef struct acpi_fpdt_boot
{
/* 1: S3 Performance Table Pointer Record */
typedef struct acpi_fpdt_s3pt_ptr
{
/*
* S3PT - S3 Performance Table. This table is pointed to by the
* FPDT S3 Pointer Record above.
*/
typedef struct acpi_table_s3pt
{
/*
* S3PT Subtables
*/
typedef struct acpi_s3pt_header
{
/* Values for Type field above */
enum AcpiS3ptType
{
};
typedef struct acpi_s3pt_resume
{
typedef struct acpi_s3pt_suspend
{
/*******************************************************************************
*
* GTDT - Generic Timer Description Table (ACPI 5.1)
* Version 2
*
******************************************************************************/
typedef struct acpi_table_gtdt
{
/* Flag Definitions: Timer Block Physical Timers and Virtual timers */
#define ACPI_GTDT_INTERRUPT_MODE (1)
/* Common GTDT subtable header */
typedef struct acpi_gtdt_header
{
/* Values for GTDT subtable type above */
enum AcpiGtdtType
{
};
/* GTDT Subtables, correspond to Type in acpi_gtdt_header */
/* 0: Generic Timer Block */
typedef struct acpi_gtdt_timer_block
{
/* Timer Sub-Structure, one per timer */
typedef struct acpi_gtdt_timer_entry
{
/* Flag Definitions: TimerFlags and VirtualTimerFlags above */
#define ACPI_GTDT_GT_IRQ_MODE (1)
/* Flag Definitions: CommonFlags above */
#define ACPI_GTDT_GT_IS_SECURE_TIMER (1)
/* 1: SBSA Generic Watchdog Structure */
typedef struct acpi_gtdt_watchdog
{
/* Flag Definitions: TimerFlags above */
#define ACPI_GTDT_WATCHDOG_IRQ_MODE (1)
/*******************************************************************************
*
* MPST - Memory Power State Table (ACPI 5.0)
* Version 1
*
******************************************************************************/
#define ACPI_MPST_CHANNEL_INFO \
/* Main table */
typedef struct acpi_table_mpst
{
ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
/* Memory Platform Communication Channel Info */
typedef struct acpi_mpst_channel
{
ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
/* Memory Power Node Structure */
typedef struct acpi_mpst_power_node
{
/* Values for Flags field above */
#define ACPI_MPST_ENABLED 1
#define ACPI_MPST_POWER_MANAGED 2
#define ACPI_MPST_HOT_PLUG_CAPABLE 4
/* Memory Power State Structure (follows POWER_NODE above) */
typedef struct acpi_mpst_power_state
{
/* Physical Component ID Structure (follows POWER_STATE above) */
typedef struct acpi_mpst_component
{
/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
typedef struct acpi_mpst_data_hdr
{
typedef struct acpi_mpst_power_data
{
/* Values for Flags field above */
#define ACPI_MPST_PRESERVE 1
#define ACPI_MPST_AUTOENTRY 2
#define ACPI_MPST_AUTOEXIT 4
/* Shared Memory Region (not part of an ACPI table) */
typedef struct acpi_mpst_shared
{
/*******************************************************************************
*
* PCCT - Platform Communications Channel Table (ACPI 5.0)
* Version 1
*
******************************************************************************/
typedef struct acpi_table_pcct
{
/* Values for Flags field above */
#define ACPI_PCCT_DOORBELL 1
/* Values for subtable type in ACPI_SUBTABLE_HEADER */
enum AcpiPcctType
{
};
/*
* PCCT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
*/
/* 0: Generic Communications Subspace */
typedef struct acpi_pcct_subspace
{
/* 1: HW-reduced Communications Subspace (ACPI 5.1) */
typedef struct acpi_pcct_hw_reduced
{
/* Values for doorbell flags above */
#define ACPI_PCCT_INTERRUPT_POLARITY (1)
/*
* PCC memory structures (not part of the ACPI table)
*/
/* Shared Memory Region */
typedef struct acpi_pcct_shared_memory
{
/*******************************************************************************
*
* PMTT - Platform Memory Topology Table (ACPI 5.0)
* Version 1
*
******************************************************************************/
typedef struct acpi_table_pmtt
{
/* Common header for PMTT subtables that follow main table */
typedef struct acpi_pmtt_header
{
/* Values for Type field above */
#define ACPI_PMTT_TYPE_SOCKET 0
#define ACPI_PMTT_TYPE_CONTROLLER 1
#define ACPI_PMTT_TYPE_DIMM 2
/* Values for Flags field above */
#define ACPI_PMTT_TOP_LEVEL 0x0001
#define ACPI_PMTT_PHYSICAL 0x0002
#define ACPI_PMTT_MEMORY_TYPE 0x000C
/*
* PMTT subtables, correspond to Type in acpi_pmtt_header
*/
/* 0: Socket Structure */
typedef struct acpi_pmtt_socket
{
/* 1: Memory Controller subtable */
typedef struct acpi_pmtt_controller
{
/* 1a: Proximity Domain substructure */
typedef struct acpi_pmtt_domain
{
/* 2: Physical Component Identifier (DIMM) */
typedef struct acpi_pmtt_physical_component
{
/*******************************************************************************
*
* RASF - RAS Feature Table (ACPI 5.0)
* Version 1
*
******************************************************************************/
typedef struct acpi_table_rasf
{
/* RASF Platform Communication Channel Shared Memory Region */
typedef struct acpi_rasf_shared_memory
{
/* RASF Parameter Block Structure Header */
typedef struct acpi_rasf_parameter_block
{
/* RASF Parameter Block Structure for PATROL_SCRUB */
typedef struct acpi_rasf_patrol_scrub_parameter
{
/* Masks for Flags and Speed fields above */
#define ACPI_RASF_SCRUBBER_RUNNING 1
#define ACPI_RASF_SPEED_SLOW (0<<1)
/* Channel Commands */
enum AcpiRasfCommands
{
};
/* Platform RAS Capabilities */
{
};
/* Patrol Scrub Commands */
{
};
/* Channel Command flags */
/* Status values */
enum AcpiRasfStatus
{
ACPI_RASF_SUCCESS = 0,
ACPI_RASF_NOT_VALID = 1,
ACPI_RASF_BUSY = 3,
ACPI_RASF_FAILED = 4,
ACPI_RASF_ABORTED = 5,
};
/* Status flags */
#define ACPI_RASF_COMMAND_COMPLETE (1)
/*******************************************************************************
*
* STAO - Status Override Table (_STA override) - ACPI 6.0
* Version 1
*
* Conforms to "ACPI Specification for Status Override Table"
* 6 January 2015
*
******************************************************************************/
typedef struct acpi_table_stao
{
/*******************************************************************************
*
* WPBT - Windows Platform Environment Table (ACPI 6.0)
* Version 1
*
* Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
*
******************************************************************************/
typedef struct acpi_table_wpbt
{
/*******************************************************************************
*
* XENV - Xen Environment Table (ACPI 6.0)
* Version 1
*
* Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
*
******************************************************************************/
typedef struct acpi_table_xenv
{
/* Reset to default packing */
#pragma pack()
#endif /* __ACTBL3_H__ */