[deliverable/linux.git] / include / acpi / actbl3.h

/******************************************************************************
 *
 * Name: actbl3.h - ACPI Table Definitions
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2014, 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.
 *
 * 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.
 */
#define ACPI_SIG_BGRT           "BGRT"	/* Boot Graphics Resource Table */
#define ACPI_SIG_DRTM           "DRTM"	/* Dynamic Root of Trust for Measurement table */
#define ACPI_SIG_FPDT           "FPDT"	/* Firmware Performance Data Table */
#define ACPI_SIG_GTDT           "GTDT"	/* Generic Timer Description Table */
#define ACPI_SIG_MPST           "MPST"	/* Memory Power State Table */
#define ACPI_SIG_PCCT           "PCCT"	/* Platform Communications Channel Table */
#define ACPI_SIG_PMTT           "PMTT"	/* Platform Memory Topology Table */
#define ACPI_SIG_RASF           "RASF"	/* RAS Feature table */
#define ACPI_SIG_TPM2           "TPM2"	/* Trusted Platform Module 2.0 H/W interface table */

#define ACPI_SIG_S3PT           "S3PT"	/* S3 Performance (sub)Table */
#define ACPI_SIG_PCCS           "PCC"	/* PCC Shared Memory Region */

/* Reserved table signatures */

#define ACPI_SIG_MATR           "MATR"	/* Memory Address Translation Table */
#define ACPI_SIG_MSDM           "MSDM"	/* Microsoft Data Management Table */
#define ACPI_SIG_WPBT           "WPBT"	/* Windows Platform Binary Table */

/*
 * 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.
 * See http://stackoverflow.com/a/1053662/41661
 */

/*******************************************************************************
 *
 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
 *        Version 1
 *
 ******************************************************************************/

struct acpi_table_bgrt {
	struct acpi_table_header header;	/* Common ACPI table header */
	u16 version;
	u8 status;
	u8 image_type;
	u64 image_address;
	u32 image_offset_x;
	u32 image_offset_y;
};

/*******************************************************************************
 *
 * DRTM - Dynamic Root of Trust for Measurement table
 *
 ******************************************************************************/

struct acpi_table_drtm {
	struct acpi_table_header header;	/* Common ACPI table header */
	u64 entry_base_address;
	u64 entry_length;
	u32 entry_address32;
	u64 entry_address64;
	u64 exit_address;
	u64 log_area_address;
	u32 log_area_length;
	u64 arch_dependent_address;
	u32 flags;
};

/* 1) Validated Tables List */

struct acpi_drtm_vtl_list {
	u32 validated_table_list_count;
};

/* 2) Resources List */

struct acpi_drtm_resource_list {
	u32 resource_list_count;
};

/* 3) Platform-specific Identifiers List */

struct acpi_drtm_id_list {
	u32 id_list_count;
};

/*******************************************************************************
 *
 * FPDT - Firmware Performance Data Table (ACPI 5.0)
 *        Version 1
 *
 ******************************************************************************/

struct acpi_table_fpdt {
	struct acpi_table_header header;	/* Common ACPI table header */
};

/* FPDT subtable header */

struct acpi_fpdt_header {
	u16 type;
	u8 length;
	u8 revision;
};

/* Values for Type field above */

enum acpi_fpdt_type {
	ACPI_FPDT_TYPE_BOOT = 0,
	ACPI_FPDT_TYPE_S3PERF = 1
};

/*
 * FPDT subtables
 */

/* 0: Firmware Basic Boot Performance Record */

struct acpi_fpdt_boot {
	struct acpi_fpdt_header header;
	u8 reserved[4];
	u64 reset_end;
	u64 load_start;
	u64 startup_start;
	u64 exit_services_entry;
	u64 exit_services_exit;
};

/* 1: S3 Performance Table Pointer Record */

struct acpi_fpdt_s3pt_ptr {
	struct acpi_fpdt_header header;
	u8 reserved[4];
	u64 address;
};

/*
 * S3PT - S3 Performance Table. This table is pointed to by the
 * FPDT S3 Pointer Record above.
 */
struct acpi_table_s3pt {
	u8 signature[4];	/* "S3PT" */
	u32 length;
};

/*
 * S3PT Subtables
 */
struct acpi_s3pt_header {
	u16 type;
	u8 length;
	u8 revision;
};

/* Values for Type field above */

enum acpi_s3pt_type {
	ACPI_S3PT_TYPE_RESUME = 0,
	ACPI_S3PT_TYPE_SUSPEND = 1
};

struct acpi_s3pt_resume {
	struct acpi_s3pt_header header;
	u32 resume_count;
	u64 full_resume;
	u64 average_resume;
};

struct acpi_s3pt_suspend {
	struct acpi_s3pt_header header;
	u64 suspend_start;
	u64 suspend_end;
};

/*******************************************************************************
 *
 * GTDT - Generic Timer Description Table (ACPI 5.1)
 *        Version 2
 *
 ******************************************************************************/

struct acpi_table_gtdt {
	struct acpi_table_header header;	/* Common ACPI table header */
	u64 counter_block_addresss;
	u32 reserved;
	u32 secure_el1_interrupt;
	u32 secure_el1_flags;
	u32 non_secure_el1_interrupt;
	u32 non_secure_el1_flags;
	u32 virtual_timer_interrupt;
	u32 virtual_timer_flags;
	u32 non_secure_el2_interrupt;
	u32 non_secure_el2_flags;
	u64 counter_read_block_address;
	u32 platform_timer_count;
	u32 platform_timer_offset;
};

/* Flag Definitions: Timer Block Physical Timers and Virtual timers */

#define ACPI_GTDT_INTERRUPT_MODE        (1)
#define ACPI_GTDT_INTERRUPT_POLARITY    (1<<1)
#define ACPI_GTDT_ALWAYS_ON             (1<<2)

/* Common GTDT subtable header */

struct acpi_gtdt_header {
	u8 type;
	u16 length;
};

/* Values for GTDT subtable type above */

enum acpi_gtdt_type {
	ACPI_GTDT_TYPE_TIMER_BLOCK = 0,
	ACPI_GTDT_TYPE_WATCHDOG = 1,
	ACPI_GTDT_TYPE_RESERVED = 2	/* 2 and greater are reserved */
};

/* GTDT Subtables, correspond to Type in struct acpi_gtdt_header */

/* 0: Generic Timer Block */

struct acpi_gtdt_timer_block {
	struct acpi_gtdt_header header;
	u8 reserved;
	u64 block_address;
	u32 timer_count;
	u32 timer_offset;
};

/* Timer Sub-Structure, one per timer */

struct acpi_gtdt_timer_entry {
	u8 frame_number;
	u8 reserved[3];
	u64 base_address;
	u64 el0_base_address;
	u32 timer_interrupt;
	u32 timer_flags;
	u32 virtual_timer_interrupt;
	u32 virtual_timer_flags;
	u32 common_flags;
};

/* Flag Definitions: common_flags above */

#define ACPI_GTDT_GT_IS_SECURE_TIMER    (1)
#define ACPI_GTDT_GT_ALWAYS_ON          (1<<1)

/* 1: SBSA Generic Watchdog Structure */

struct acpi_gtdt_watchdog {
	struct acpi_gtdt_header header;
	u8 reserved;
	u64 refresh_frame_address;
	u64 control_frame_address;
	u32 timer_interrupt;
	u32 timer_flags;
};

/* Flag Definitions: timer_flags above */

#define ACPI_GTDT_WATCHDOG_IRQ_MODE         (1)
#define ACPI_GTDT_WATCHDOG_IRQ_POLARITY     (1<<1)
#define ACPI_GTDT_WATCHDOG_SECURE           (1<<2)

/*******************************************************************************
 *
 * MPST - Memory Power State Table (ACPI 5.0)
 *        Version 1
 *
 ******************************************************************************/

#define ACPI_MPST_CHANNEL_INFO \
	u8                              channel_id; \
	u8                              reserved1[3]; \
	u16                             power_node_count; \
	u16                             reserved2;

/* Main table */

struct acpi_table_mpst {
	struct acpi_table_header header;	/* Common ACPI table header */
	 ACPI_MPST_CHANNEL_INFO	/* Platform Communication Channel */
};

/* Memory Platform Communication Channel Info */

struct acpi_mpst_channel {
	ACPI_MPST_CHANNEL_INFO	/* Platform Communication Channel */
};

/* Memory Power Node Structure */

struct acpi_mpst_power_node {
	u8 flags;
	u8 reserved1;
	u16 node_id;
	u32 length;
	u64 range_address;
	u64 range_length;
	u32 num_power_states;
	u32 num_physical_components;
};

/* 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) */

struct acpi_mpst_power_state {
	u8 power_state;
	u8 info_index;
};

/* Physical Component ID Structure (follows POWER_STATE above) */

struct acpi_mpst_component {
	u16 component_id;
};

/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */

struct acpi_mpst_data_hdr {
	u16 characteristics_count;
	u16 reserved;
};

struct acpi_mpst_power_data {
	u8 structure_id;
	u8 flags;
	u16 reserved1;
	u32 average_power;
	u32 power_saving;
	u64 exit_latency;
	u64 reserved2;
};

/* 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) */

struct acpi_mpst_shared {
	u32 signature;
	u16 pcc_command;
	u16 pcc_status;
	u32 command_register;
	u32 status_register;
	u32 power_state_id;
	u32 power_node_id;
	u64 energy_consumed;
	u64 average_power;
};

/*******************************************************************************
 *
 * PCCT - Platform Communications Channel Table (ACPI 5.0)
 *        Version 1
 *
 ******************************************************************************/

struct acpi_table_pcct {
	struct acpi_table_header header;	/* Common ACPI table header */
	u32 flags;
	u64 reserved;
};

/* Values for Flags field above */

#define ACPI_PCCT_DOORBELL              1

/* Values for subtable type in struct acpi_subtable_header */

enum acpi_pcct_type {
	ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0,
	ACPI_PCCT_TYPE_RESERVED = 1	/* 1 and greater are reserved */
};

/*
 * PCCT Subtables, correspond to Type in struct acpi_subtable_header
 */

/* 0: Generic Communications Subspace */

struct acpi_pcct_subspace {
	struct acpi_subtable_header header;
	u8 reserved[6];
	u64 base_address;
	u64 length;
	struct acpi_generic_address doorbell_register;
	u64 preserve_mask;
	u64 write_mask;
	u32 latency;
	u32 max_access_rate;
	u16 min_turnaround_time;
};

/*
 * PCC memory structures (not part of the ACPI table)
 */

/* Shared Memory Region */

struct acpi_pcct_shared_memory {
	u32 signature;
	u16 command;
	u16 status;
};

/*******************************************************************************
 *
 * PMTT - Platform Memory Topology Table (ACPI 5.0)
 *        Version 1
 *
 ******************************************************************************/

struct acpi_table_pmtt {
	struct acpi_table_header header;	/* Common ACPI table header */
	u32 reserved;
};

/* Common header for PMTT subtables that follow main table */

struct acpi_pmtt_header {
	u8 type;
	u8 reserved1;
	u16 length;
	u16 flags;
	u16 reserved2;
};

/* Values for Type field above */

#define ACPI_PMTT_TYPE_SOCKET           0
#define ACPI_PMTT_TYPE_CONTROLLER       1
#define ACPI_PMTT_TYPE_DIMM             2
#define ACPI_PMTT_TYPE_RESERVED         3	/* 0x03-0xFF are reserved */

/* 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 struct acpi_pmtt_header
 */

/* 0: Socket Structure */

struct acpi_pmtt_socket {
	struct acpi_pmtt_header header;
	u16 socket_id;
	u16 reserved;
};

/* 1: Memory Controller subtable */

struct acpi_pmtt_controller {
	struct acpi_pmtt_header header;
	u32 read_latency;
	u32 write_latency;
	u32 read_bandwidth;
	u32 write_bandwidth;
	u16 access_width;
	u16 alignment;
	u16 reserved;
	u16 domain_count;
};

/* 1a: Proximity Domain substructure */

struct acpi_pmtt_domain {
	u32 proximity_domain;
};

/* 2: Physical Component Identifier (DIMM) */

struct acpi_pmtt_physical_component {
	struct acpi_pmtt_header header;
	u16 component_id;
	u16 reserved;
	u32 memory_size;
	u32 bios_handle;
};

/*******************************************************************************
 *
 * RASF - RAS Feature Table (ACPI 5.0)
 *        Version 1
 *
 ******************************************************************************/

struct acpi_table_rasf {
	struct acpi_table_header header;	/* Common ACPI table header */
	u8 channel_id[12];
};

/* RASF Platform Communication Channel Shared Memory Region */

struct acpi_rasf_shared_memory {
	u32 signature;
	u16 command;
	u16 status;
	u16 version;
	u8 capabilities[16];
	u8 set_capabilities[16];
	u16 num_parameter_blocks;
	u32 set_capabilities_status;
};

/* RASF Parameter Block Structure Header */

struct acpi_rasf_parameter_block {
	u16 type;
	u16 version;
	u16 length;
};

/* RASF Parameter Block Structure for PATROL_SCRUB */

struct acpi_rasf_patrol_scrub_parameter {
	struct acpi_rasf_parameter_block header;
	u16 patrol_scrub_command;
	u64 requested_address_range[2];
	u64 actual_address_range[2];
	u16 flags;
	u8 requested_speed;
};

/* Masks for Flags and Speed fields above */

#define ACPI_RASF_SCRUBBER_RUNNING      1
#define ACPI_RASF_SPEED                 (7<<1)
#define ACPI_RASF_SPEED_SLOW            (0<<1)
#define ACPI_RASF_SPEED_MEDIUM          (4<<1)
#define ACPI_RASF_SPEED_FAST            (7<<1)

/* Channel Commands */

enum acpi_rasf_commands {
	ACPI_RASF_EXECUTE_RASF_COMMAND = 1
};

/* Platform RAS Capabilities */

enum acpi_rasf_capabiliities {
	ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
	ACPI_SW_PATROL_SCRUB_EXPOSED = 1
};

/* Patrol Scrub Commands */

enum acpi_rasf_patrol_scrub_commands {
	ACPI_RASF_GET_PATROL_PARAMETERS = 1,
	ACPI_RASF_START_PATROL_SCRUBBER = 2,
	ACPI_RASF_STOP_PATROL_SCRUBBER = 3
};

/* Channel Command flags */

#define ACPI_RASF_GENERATE_SCI          (1<<15)

/* Status values */

enum acpi_rasf_status {
	ACPI_RASF_SUCCESS = 0,
	ACPI_RASF_NOT_VALID = 1,
	ACPI_RASF_NOT_SUPPORTED = 2,
	ACPI_RASF_BUSY = 3,
	ACPI_RASF_FAILED = 4,
	ACPI_RASF_ABORTED = 5,
	ACPI_RASF_INVALID_DATA = 6
};

/* Status flags */

#define ACPI_RASF_COMMAND_COMPLETE      (1)
#define ACPI_RASF_SCI_DOORBELL          (1<<1)
#define ACPI_RASF_ERROR                 (1<<2)
#define ACPI_RASF_STATUS                (0x1F<<3)

/*******************************************************************************
 *
 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
 *        Version 3
 *
 * Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011
 *
 ******************************************************************************/

struct acpi_table_tpm2 {
	struct acpi_table_header header;	/* Common ACPI table header */
	u32 flags;
	u64 control_address;
	u32 start_method;
};

/* Control area structure (not part of table, pointed to by control_address) */

struct acpi_tpm2_control {
	u32 reserved;
	u32 error;
	u32 cancel;
	u32 start;
	u64 interrupt_control;
	u32 command_size;
	u64 command_address;
	u32 response_size;
	u64 response_address;
};

/* Reset to default packing */

#pragma pack()

#endif				/* __ACTBL3_H__ */
Commit	Line	Data
c5bd6537 BM	1	/******************************************************************************
	2	*
	3	* Name: actbl3.h - ACPI Table Definitions
	4	*
	5	*****************************************************************************/
	6
	7	/*
fbb7a2dc	8	* Copyright (C) 2000 - 2014, Intel Corp.
c5bd6537 BM	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	14	* 1. Redistributions of source code must retain the above copyright
	15	* notice, this list of conditions, and the following disclaimer,
	16	* without modification.
	17	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	18	* substantially similar to the "NO WARRANTY" disclaimer below
	19	* ("Disclaimer") and any redistribution must be conditioned upon
	20	* including a substantially similar Disclaimer requirement for further
	21	* binary redistribution.
	22	* 3. Neither the names of the above-listed copyright holders nor the names
	23	* of any contributors may be used to endorse or promote products derived
	24	* from this software without specific prior written permission.
	25	*
	26	* Alternatively, this software may be distributed under the terms of the
	27	* GNU General Public License ("GPL") version 2 as published by the Free
	28	* Software Foundation.
	29	*
	30	* NO WARRANTY
	31	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	32	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	33	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	34	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	35	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	36	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	37	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	38	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	39	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	40	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	41	* POSSIBILITY OF SUCH DAMAGES.
	42	*/
	43
	44	#ifndef __ACTBL3_H__
	45	#define __ACTBL3_H__
	46
	47	/*******************************************************************************
	48	*
	49	* Additional ACPI Tables (3)
	50	*
	51	* These tables are not consumed directly by the ACPICA subsystem, but are
	52	* included here to support device drivers and the AML disassembler.
	53	*
	54	* The tables in this file are fully defined within the ACPI specification.
	55	*
	56	******************************************************************************/
	57
	58	/*
	59	* Values for description table header signatures for tables defined in this
	60	* file. Useful because they make it more difficult to inadvertently type in
	61	* the wrong signature.
	62	*/
	63	#define ACPI_SIG_BGRT "BGRT" /* Boot Graphics Resource Table */
	64	#define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */
	65	#define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */
	66	#define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */
	67	#define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
	68	#define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
	69	#define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
	70	#define ACPI_SIG_RASF "RASF" /* RAS Feature table */
99c93f55	71	#define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */
c5bd6537 BM	72
	73	#define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
	74	#define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
	75
	76	/* Reserved table signatures */
	77
c5bd6537 BM	78	#define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */
	79	#define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
	80	#define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
	81
	82	/*
	83	* All tables must be byte-packed to match the ACPI specification, since
	84	* the tables are provided by the system BIOS.
	85	*/
	86	#pragma pack(1)
	87
	88	/*
be030a57 BM	89	* Note: C bitfields are not used for this reason:
	90	*
	91	* "Bitfields are great and easy to read, but unfortunately the C language
	92	* does not specify the layout of bitfields in memory, which means they are
	93	* essentially useless for dealing with packed data in on-disk formats or
	94	* binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
	95	* this decision was a design error in C. Ritchie could have picked an order
	96	* and stuck with it." Norman Ramsey.
	97	* See http://stackoverflow.com/a/1053662/41661
c5bd6537 BM	98	*/
	99
	100	/*******************************************************************************
	101	*
	102	* BGRT - Boot Graphics Resource Table (ACPI 5.0)
	103	* Version 1
	104	*
	105	******************************************************************************/
	106
	107	struct acpi_table_bgrt {
	108	struct acpi_table_header header; /* Common ACPI table header */
	109	u16 version;
	110	u8 status;
	111	u8 image_type;
	112	u64 image_address;
	113	u32 image_offset_x;
	114	u32 image_offset_y;
	115	};
	116
	117	/*******************************************************************************
	118	*
	119	* DRTM - Dynamic Root of Trust for Measurement table
	120	*
	121	******************************************************************************/
	122
	123	struct acpi_table_drtm {
	124	struct acpi_table_header header; /* Common ACPI table header */
	125	u64 entry_base_address;
	126	u64 entry_length;
	127	u32 entry_address32;
	128	u64 entry_address64;
	129	u64 exit_address;
	130	u64 log_area_address;
	131	u32 log_area_length;
	132	u64 arch_dependent_address;
	133	u32 flags;
	134	};
	135
	136	/* 1) Validated Tables List */
	137
	138	struct acpi_drtm_vtl_list {
	139	u32 validated_table_list_count;
	140	};
	141
	142	/* 2) Resources List */
	143
	144	struct acpi_drtm_resource_list {
	145	u32 resource_list_count;
	146	};
	147
	148	/* 3) Platform-specific Identifiers List */
	149
	150	struct acpi_drtm_id_list {
	151	u32 id_list_count;
	152	};
	153
	154	/*******************************************************************************
	155	*
	156	* FPDT - Firmware Performance Data Table (ACPI 5.0)
	157	* Version 1
	158	*
	159	******************************************************************************/
	160
	161	struct acpi_table_fpdt {
162	struct acpi_table_header header; /* Common ACPI table header */
163	};
164
165	/* FPDT subtable header */
166
167	struct acpi_fpdt_header {
168	u16 type;
169	u8 length;
170	u8 revision;
171	};
172
173	/* Values for Type field above */
174
175	enum acpi_fpdt_type {
176	ACPI_FPDT_TYPE_BOOT = 0,
6be58e2f	177	ACPI_FPDT_TYPE_S3PERF = 1
c5bd6537 BM	178	};
	179
	180	/*
	181	* FPDT subtables
	182	*/
	183
	184	/* 0: Firmware Basic Boot Performance Record */
	185
	186	struct acpi_fpdt_boot {
	187	struct acpi_fpdt_header header;
	188	u8 reserved[4];
	189	u64 reset_end;
	190	u64 load_start;
	191	u64 startup_start;
	192	u64 exit_services_entry;
	193	u64 exit_services_exit;
	194	};
	195
	196	/* 1: S3 Performance Table Pointer Record */
	197
	198	struct acpi_fpdt_s3pt_ptr {
	199	struct acpi_fpdt_header header;
	200	u8 reserved[4];
	201	u64 address;
	202	};
	203
	204	/*
	205	* S3PT - S3 Performance Table. This table is pointed to by the
	206	* FPDT S3 Pointer Record above.
	207	*/
	208	struct acpi_table_s3pt {
	209	u8 signature[4]; /* "S3PT" */
	210	u32 length;
	211	};
	212
	213	/*
	214	* S3PT Subtables
	215	*/
	216	struct acpi_s3pt_header {
	217	u16 type;
	218	u8 length;
	219	u8 revision;
	220	};
	221
	222	/* Values for Type field above */
	223
	224	enum acpi_s3pt_type {
	225	ACPI_S3PT_TYPE_RESUME = 0,
6be58e2f	226	ACPI_S3PT_TYPE_SUSPEND = 1
c5bd6537 BM	227	};
	228
	229	struct acpi_s3pt_resume {
	230	struct acpi_s3pt_header header;
	231	u32 resume_count;
	232	u64 full_resume;
	233	u64 average_resume;
	234	};
	235
	236	struct acpi_s3pt_suspend {
	237	struct acpi_s3pt_header header;
	238	u64 suspend_start;
	239	u64 suspend_end;
	240	};
	241
	242	/*******************************************************************************
	243	*
54ea4247 TN	244	* GTDT - Generic Timer Description Table (ACPI 5.1)
54ea4247 TN	245	* Version 2
c5bd6537 BM	246	*
	247	******************************************************************************/
	248
	249	struct acpi_table_gtdt {
	250	struct acpi_table_header header; /* Common ACPI table header */
54ea4247 TN	251	u64 counter_block_addresss;
	252	u32 reserved;
	253	u32 secure_el1_interrupt;
	254	u32 secure_el1_flags;
	255	u32 non_secure_el1_interrupt;
	256	u32 non_secure_el1_flags;
c5bd6537 BM	257	u32 virtual_timer_interrupt;
c5bd6537 BM	258	u32 virtual_timer_flags;
54ea4247 TN	259	u32 non_secure_el2_interrupt;
	260	u32 non_secure_el2_flags;
	261	u64 counter_read_block_address;
	262	u32 platform_timer_count;
	263	u32 platform_timer_offset;
	264	};
	265
	266	/* Flag Definitions: Timer Block Physical Timers and Virtual timers */
	267
	268	#define ACPI_GTDT_INTERRUPT_MODE (1)
	269	#define ACPI_GTDT_INTERRUPT_POLARITY (1<<1)
	270	#define ACPI_GTDT_ALWAYS_ON (1<<2)
	271
	272	/* Common GTDT subtable header */
	273
	274	struct acpi_gtdt_header {
	275	u8 type;
	276	u16 length;
	277	};
	278
	279	/* Values for GTDT subtable type above */
	280
	281	enum acpi_gtdt_type {
	282	ACPI_GTDT_TYPE_TIMER_BLOCK = 0,
	283	ACPI_GTDT_TYPE_WATCHDOG = 1,
	284	ACPI_GTDT_TYPE_RESERVED = 2 /* 2 and greater are reserved */
c5bd6537 BM	285	};
c5bd6537 BM	286
54ea4247 TN	287	/* GTDT Subtables, correspond to Type in struct acpi_gtdt_header */
	288
	289	/* 0: Generic Timer Block */
c5bd6537	290
54ea4247 TN	291	struct acpi_gtdt_timer_block {
	292	struct acpi_gtdt_header header;
	293	u8 reserved;
	294	u64 block_address;
	295	u32 timer_count;
	296	u32 timer_offset;
	297	};
	298
	299	/* Timer Sub-Structure, one per timer */
	300
	301	struct acpi_gtdt_timer_entry {
	302	u8 frame_number;
	303	u8 reserved[3];
	304	u64 base_address;
	305	u64 el0_base_address;
	306	u32 timer_interrupt;
	307	u32 timer_flags;
	308	u32 virtual_timer_interrupt;
	309	u32 virtual_timer_flags;
	310	u32 common_flags;
	311	};
	312
	313	/* Flag Definitions: common_flags above */
	314
	315	#define ACPI_GTDT_GT_IS_SECURE_TIMER (1)
	316	#define ACPI_GTDT_GT_ALWAYS_ON (1<<1)
	317
	318	/* 1: SBSA Generic Watchdog Structure */
	319
	320	struct acpi_gtdt_watchdog {
	321	struct acpi_gtdt_header header;
	322	u8 reserved;
	323	u64 refresh_frame_address;
	324	u64 control_frame_address;
	325	u32 timer_interrupt;
	326	u32 timer_flags;
	327	};
c5bd6537	328
54ea4247	329	/* Flag Definitions: timer_flags above */
c5bd6537	330
54ea4247 TN	331	#define ACPI_GTDT_WATCHDOG_IRQ_MODE (1)
	332	#define ACPI_GTDT_WATCHDOG_IRQ_POLARITY (1<<1)
	333	#define ACPI_GTDT_WATCHDOG_SECURE (1<<2)
c5bd6537 BM	334
	335	/*******************************************************************************
	336	*
	337	* MPST - Memory Power State Table (ACPI 5.0)
	338	* Version 1
	339	*
	340	******************************************************************************/
	341
	342	#define ACPI_MPST_CHANNEL_INFO \
c5bd6537	343	u8 channel_id; \
2d2dd508 BM	344	u8 reserved1[3]; \
	345	u16 power_node_count; \
	346	u16 reserved2;
c5bd6537 BM	347
	348	/* Main table */
	349
	350	struct acpi_table_mpst {
	351	struct acpi_table_header header; /* Common ACPI table header */
	352	ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
	353	};
	354
	355	/* Memory Platform Communication Channel Info */
	356
	357	struct acpi_mpst_channel {
	358	ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
	359	};
	360
	361	/* Memory Power Node Structure */
	362
	363	struct acpi_mpst_power_node {
	364	u8 flags;
	365	u8 reserved1;
	366	u16 node_id;
	367	u32 length;
	368	u64 range_address;
	369	u64 range_length;
2d2dd508 BM	370	u32 num_power_states;
2d2dd508 BM	371	u32 num_physical_components;
c5bd6537 BM	372	};
	373
	374	/* Values for Flags field above */
	375
	376	#define ACPI_MPST_ENABLED 1
	377	#define ACPI_MPST_POWER_MANAGED 2
	378	#define ACPI_MPST_HOT_PLUG_CAPABLE 4
	379
	380	/* Memory Power State Structure (follows POWER_NODE above) */
	381
	382	struct acpi_mpst_power_state {
	383	u8 power_state;
	384	u8 info_index;
	385	};
	386
	387	/* Physical Component ID Structure (follows POWER_STATE above) */
	388
	389	struct acpi_mpst_component {
	390	u16 component_id;
	391	};
	392
	393	/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
	394
	395	struct acpi_mpst_data_hdr {
	396	u16 characteristics_count;
2d2dd508	397	u16 reserved;
c5bd6537 BM	398	};
	399
	400	struct acpi_mpst_power_data {
2d2dd508	401	u8 structure_id;
c5bd6537 BM	402	u8 flags;
	403	u16 reserved1;
	404	u32 average_power;
	405	u32 power_saving;
	406	u64 exit_latency;
	407	u64 reserved2;
	408	};
	409
	410	/* Values for Flags field above */
	411
	412	#define ACPI_MPST_PRESERVE 1
	413	#define ACPI_MPST_AUTOENTRY 2
	414	#define ACPI_MPST_AUTOEXIT 4
	415
	416	/* Shared Memory Region (not part of an ACPI table) */
	417
	418	struct acpi_mpst_shared {
	419	u32 signature;
	420	u16 pcc_command;
	421	u16 pcc_status;
2d2dd508 BM	422	u32 command_register;
	423	u32 status_register;
	424	u32 power_state_id;
	425	u32 power_node_id;
c5bd6537 BM	426	u64 energy_consumed;
	427	u64 average_power;
	428	};
	429
	430	/*******************************************************************************
	431	*
	432	* PCCT - Platform Communications Channel Table (ACPI 5.0)
	433	* Version 1
	434	*
	435	******************************************************************************/
	436
	437	struct acpi_table_pcct {
	438	struct acpi_table_header header; /* Common ACPI table header */
	439	u32 flags;
f0d73664	440	u64 reserved;
c5bd6537 BM	441	};
	442
	443	/* Values for Flags field above */
	444
	445	#define ACPI_PCCT_DOORBELL 1
	446
f0d73664 BM	447	/* Values for subtable type in struct acpi_subtable_header */
	448
	449	enum acpi_pcct_type {
	450	ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0,
	451	ACPI_PCCT_TYPE_RESERVED = 1 /* 1 and greater are reserved */
	452	};
	453
c5bd6537	454	/*
f0d73664	455	* PCCT Subtables, correspond to Type in struct acpi_subtable_header
c5bd6537 BM	456	*/
	457
	458	/* 0: Generic Communications Subspace */
	459
	460	struct acpi_pcct_subspace {
	461	struct acpi_subtable_header header;
	462	u8 reserved[6];
	463	u64 base_address;
	464	u64 length;
	465	struct acpi_generic_address doorbell_register;
	466	u64 preserve_mask;
	467	u64 write_mask;
f0d73664 BM	468	u32 latency;
	469	u32 max_access_rate;
	470	u16 min_turnaround_time;
c5bd6537 BM	471	};
	472
	473	/*
	474	* PCC memory structures (not part of the ACPI table)
	475	*/
	476
	477	/* Shared Memory Region */
	478
	479	struct acpi_pcct_shared_memory {
	480	u32 signature;
	481	u16 command;
	482	u16 status;
	483	};
	484
	485	/*******************************************************************************
	486	*
	487	* PMTT - Platform Memory Topology Table (ACPI 5.0)
	488	* Version 1
	489	*
	490	******************************************************************************/
	491
	492	struct acpi_table_pmtt {
	493	struct acpi_table_header header; /* Common ACPI table header */
	494	u32 reserved;
	495	};
	496
	497	/* Common header for PMTT subtables that follow main table */
	498
	499	struct acpi_pmtt_header {
	500	u8 type;
	501	u8 reserved1;
	502	u16 length;
	503	u16 flags;
	504	u16 reserved2;
	505	};
	506
	507	/* Values for Type field above */
	508
	509	#define ACPI_PMTT_TYPE_SOCKET 0
	510	#define ACPI_PMTT_TYPE_CONTROLLER 1
	511	#define ACPI_PMTT_TYPE_DIMM 2
	512	#define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
	513
	514	/* Values for Flags field above */
	515
	516	#define ACPI_PMTT_TOP_LEVEL 0x0001
	517	#define ACPI_PMTT_PHYSICAL 0x0002
	518	#define ACPI_PMTT_MEMORY_TYPE 0x000C
	519
	520	/*
	521	* PMTT subtables, correspond to Type in struct acpi_pmtt_header
	522	*/
	523
	524	/* 0: Socket Structure */
	525
	526	struct acpi_pmtt_socket {
	527	struct acpi_pmtt_header header;
	528	u16 socket_id;
	529	u16 reserved;
	530	};
	531
	532	/* 1: Memory Controller subtable */
	533
	534	struct acpi_pmtt_controller {
535	struct acpi_pmtt_header header;
536	u32 read_latency;
537	u32 write_latency;
538	u32 read_bandwidth;
539	u32 write_bandwidth;
540	u16 access_width;
541	u16 alignment;
542	u16 reserved;
543	u16 domain_count;
544	};
545
546	/* 1a: Proximity Domain substructure */
547
548	struct acpi_pmtt_domain {
549	u32 proximity_domain;
550	};
551
552	/* 2: Physical Component Identifier (DIMM) */
553
554	struct acpi_pmtt_physical_component {
555	struct acpi_pmtt_header header;
556	u16 component_id;
557	u16 reserved;
558	u32 memory_size;
559	u32 bios_handle;
560	};
561
562	/*******************************************************************************
563	*
564	* RASF - RAS Feature Table (ACPI 5.0)
565	* Version 1
566	*
567	******************************************************************************/
568
569	struct acpi_table_rasf {
570	struct acpi_table_header header; /* Common ACPI table header */
571	u8 channel_id[12];
572	};
573
574	/* RASF Platform Communication Channel Shared Memory Region */
575
576	struct acpi_rasf_shared_memory {
577	u32 signature;
578	u16 command;
579	u16 status;
8c280914 LZ	580	u16 version;
	581	u8 capabilities[16];
	582	u8 set_capabilities[16];
	583	u16 num_parameter_blocks;
	584	u32 set_capabilities_status;
	585	};
	586
	587	/* RASF Parameter Block Structure Header */
	588
	589	struct acpi_rasf_parameter_block {
	590	u16 type;
	591	u16 version;
	592	u16 length;
	593	};
	594
	595	/* RASF Parameter Block Structure for PATROL_SCRUB */
	596
	597	struct acpi_rasf_patrol_scrub_parameter {
	598	struct acpi_rasf_parameter_block header;
	599	u16 patrol_scrub_command;
	600	u64 requested_address_range[2];
	601	u64 actual_address_range[2];
c5bd6537	602	u16 flags;
8c280914	603	u8 requested_speed;
c5bd6537 BM	604	};
	605
	606	/* Masks for Flags and Speed fields above */
	607
	608	#define ACPI_RASF_SCRUBBER_RUNNING 1
	609	#define ACPI_RASF_SPEED (7<<1)
8c280914 LZ	610	#define ACPI_RASF_SPEED_SLOW (0<<1)
	611	#define ACPI_RASF_SPEED_MEDIUM (4<<1)
	612	#define ACPI_RASF_SPEED_FAST (7<<1)
c5bd6537 BM	613
	614	/* Channel Commands */
	615
	616	enum acpi_rasf_commands {
8c280914 LZ	617	ACPI_RASF_EXECUTE_RASF_COMMAND = 1
	618	};
	619
	620	/* Platform RAS Capabilities */
	621
	622	enum acpi_rasf_capabiliities {
	623	ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
	624	ACPI_SW_PATROL_SCRUB_EXPOSED = 1
	625	};
	626
	627	/* Patrol Scrub Commands */
	628
	629	enum acpi_rasf_patrol_scrub_commands {
	630	ACPI_RASF_GET_PATROL_PARAMETERS = 1,
	631	ACPI_RASF_START_PATROL_SCRUBBER = 2,
	632	ACPI_RASF_STOP_PATROL_SCRUBBER = 3
c5bd6537 BM	633	};
	634
	635	/* Channel Command flags */
	636
	637	#define ACPI_RASF_GENERATE_SCI (1<<15)
	638
	639	/* Status values */
	640
	641	enum acpi_rasf_status {
	642	ACPI_RASF_SUCCESS = 0,
	643	ACPI_RASF_NOT_VALID = 1,
	644	ACPI_RASF_NOT_SUPPORTED = 2,
	645	ACPI_RASF_BUSY = 3,
	646	ACPI_RASF_FAILED = 4,
	647	ACPI_RASF_ABORTED = 5,
	648	ACPI_RASF_INVALID_DATA = 6
	649	};
	650
	651	/* Status flags */
	652
	653	#define ACPI_RASF_COMMAND_COMPLETE (1)
	654	#define ACPI_RASF_SCI_DOORBELL (1<<1)
	655	#define ACPI_RASF_ERROR (1<<2)
	656	#define ACPI_RASF_STATUS (0x1F<<3)
	657
99c93f55 BM	658	/*******************************************************************************
	659	*
	660	* TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
	661	* Version 3
	662	*
	663	* Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011
	664	*
	665	******************************************************************************/
	666
	667	struct acpi_table_tpm2 {
	668	struct acpi_table_header header; /* Common ACPI table header */
	669	u32 flags;
	670	u64 control_address;
	671	u32 start_method;
	672	};
	673
	674	/* Control area structure (not part of table, pointed to by control_address) */
	675
	676	struct acpi_tpm2_control {
	677	u32 reserved;
	678	u32 error;
	679	u32 cancel;
	680	u32 start;
	681	u64 interrupt_control;
	682	u32 command_size;
	683	u64 command_address;
	684	u32 response_size;
	685	u64 response_address;
	686	};
	687
6e596084 RM	688	/* Reset to default packing */
	689
	690	#pragma pack()
c5bd6537 BM	691
c5bd6537 BM	692	#endif /* __ACTBL3_H__ */