1 /******************************************************************************
3 * Name: actbl3.h - ACPI Table Definitions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
47 /*******************************************************************************
49 * Additional ACPI Tables (3)
51 * These tables are not consumed directly by the ACPICA subsystem, but are
52 * included here to support device drivers and the AML disassembler.
54 * The tables in this file are fully defined within the ACPI specification.
56 ******************************************************************************/
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.
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 */
71 #define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */
73 #define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
74 #define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
76 /* Reserved table signatures */
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 */
83 * All tables must be byte-packed to match the ACPI specification, since
84 * the tables are provided by the system BIOS.
89 * Note: C bitfields are not used for this reason:
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
100 /*******************************************************************************
102 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
105 ******************************************************************************/
107 struct acpi_table_bgrt {
108 struct acpi_table_header header; /* Common ACPI table header */
117 /*******************************************************************************
119 * DRTM - Dynamic Root of Trust for Measurement table
121 ******************************************************************************/
123 struct acpi_table_drtm {
124 struct acpi_table_header header; /* Common ACPI table header */
125 u64 entry_base_address;
130 u64 log_area_address;
132 u64 arch_dependent_address;
136 /* 1) Validated Tables List */
138 struct acpi_drtm_vtl_list {
139 u32 validated_table_list_count;
142 /* 2) Resources List */
144 struct acpi_drtm_resource_list {
145 u32 resource_list_count;
148 /* 3) Platform-specific Identifiers List */
150 struct acpi_drtm_id_list {
154 /*******************************************************************************
156 * FPDT - Firmware Performance Data Table (ACPI 5.0)
159 ******************************************************************************/
161 struct acpi_table_fpdt {
162 struct acpi_table_header header; /* Common ACPI table header */
165 /* FPDT subtable header */
167 struct acpi_fpdt_header {
173 /* Values for Type field above */
175 enum acpi_fpdt_type {
176 ACPI_FPDT_TYPE_BOOT = 0,
177 ACPI_FPDT_TYPE_S3PERF = 1
184 /* 0: Firmware Basic Boot Performance Record */
186 struct acpi_fpdt_boot {
187 struct acpi_fpdt_header header;
192 u64 exit_services_entry;
193 u64 exit_services_exit;
196 /* 1: S3 Performance Table Pointer Record */
198 struct acpi_fpdt_s3pt_ptr {
199 struct acpi_fpdt_header header;
205 * S3PT - S3 Performance Table. This table is pointed to by the
206 * FPDT S3 Pointer Record above.
208 struct acpi_table_s3pt {
209 u8 signature[4]; /* "S3PT" */
216 struct acpi_s3pt_header {
222 /* Values for Type field above */
224 enum acpi_s3pt_type {
225 ACPI_S3PT_TYPE_RESUME = 0,
226 ACPI_S3PT_TYPE_SUSPEND = 1
229 struct acpi_s3pt_resume {
230 struct acpi_s3pt_header header;
236 struct acpi_s3pt_suspend {
237 struct acpi_s3pt_header header;
242 /*******************************************************************************
244 * GTDT - Generic Timer Description Table (ACPI 5.0)
247 ******************************************************************************/
249 struct acpi_table_gtdt {
250 struct acpi_table_header header; /* Common ACPI table header */
253 u32 secure_pl1_interrupt;
254 u32 secure_pl1_flags;
255 u32 non_secure_pl1_interrupt;
256 u32 non_secure_pl1_flags;
257 u32 virtual_timer_interrupt;
258 u32 virtual_timer_flags;
259 u32 non_secure_pl2_interrupt;
260 u32 non_secure_pl2_flags;
263 /* Values for Flags field above */
265 #define ACPI_GTDT_MAPPED_BLOCK_PRESENT 1
267 /* Values for all "TimerFlags" fields above */
269 #define ACPI_GTDT_INTERRUPT_MODE 1
270 #define ACPI_GTDT_INTERRUPT_POLARITY 2
272 /*******************************************************************************
274 * MPST - Memory Power State Table (ACPI 5.0)
277 ******************************************************************************/
279 #define ACPI_MPST_CHANNEL_INFO \
282 u16 power_node_count; \
287 struct acpi_table_mpst {
288 struct acpi_table_header header; /* Common ACPI table header */
289 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
292 /* Memory Platform Communication Channel Info */
294 struct acpi_mpst_channel {
295 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
298 /* Memory Power Node Structure */
300 struct acpi_mpst_power_node {
307 u32 num_power_states;
308 u32 num_physical_components;
311 /* Values for Flags field above */
313 #define ACPI_MPST_ENABLED 1
314 #define ACPI_MPST_POWER_MANAGED 2
315 #define ACPI_MPST_HOT_PLUG_CAPABLE 4
317 /* Memory Power State Structure (follows POWER_NODE above) */
319 struct acpi_mpst_power_state {
324 /* Physical Component ID Structure (follows POWER_STATE above) */
326 struct acpi_mpst_component {
330 /* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
332 struct acpi_mpst_data_hdr {
333 u16 characteristics_count;
337 struct acpi_mpst_power_data {
347 /* Values for Flags field above */
349 #define ACPI_MPST_PRESERVE 1
350 #define ACPI_MPST_AUTOENTRY 2
351 #define ACPI_MPST_AUTOEXIT 4
353 /* Shared Memory Region (not part of an ACPI table) */
355 struct acpi_mpst_shared {
359 u32 command_register;
367 /*******************************************************************************
369 * PCCT - Platform Communications Channel Table (ACPI 5.0)
372 ******************************************************************************/
374 struct acpi_table_pcct {
375 struct acpi_table_header header; /* Common ACPI table header */
380 /* Values for Flags field above */
382 #define ACPI_PCCT_DOORBELL 1
384 /* Values for subtable type in struct acpi_subtable_header */
386 enum acpi_pcct_type {
387 ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0,
388 ACPI_PCCT_TYPE_RESERVED = 1 /* 1 and greater are reserved */
392 * PCCT Subtables, correspond to Type in struct acpi_subtable_header
395 /* 0: Generic Communications Subspace */
397 struct acpi_pcct_subspace {
398 struct acpi_subtable_header header;
402 struct acpi_generic_address doorbell_register;
407 u16 min_turnaround_time;
411 * PCC memory structures (not part of the ACPI table)
414 /* Shared Memory Region */
416 struct acpi_pcct_shared_memory {
422 /*******************************************************************************
424 * PMTT - Platform Memory Topology Table (ACPI 5.0)
427 ******************************************************************************/
429 struct acpi_table_pmtt {
430 struct acpi_table_header header; /* Common ACPI table header */
434 /* Common header for PMTT subtables that follow main table */
436 struct acpi_pmtt_header {
444 /* Values for Type field above */
446 #define ACPI_PMTT_TYPE_SOCKET 0
447 #define ACPI_PMTT_TYPE_CONTROLLER 1
448 #define ACPI_PMTT_TYPE_DIMM 2
449 #define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
451 /* Values for Flags field above */
453 #define ACPI_PMTT_TOP_LEVEL 0x0001
454 #define ACPI_PMTT_PHYSICAL 0x0002
455 #define ACPI_PMTT_MEMORY_TYPE 0x000C
458 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
461 /* 0: Socket Structure */
463 struct acpi_pmtt_socket {
464 struct acpi_pmtt_header header;
469 /* 1: Memory Controller subtable */
471 struct acpi_pmtt_controller {
472 struct acpi_pmtt_header header;
483 /* 1a: Proximity Domain substructure */
485 struct acpi_pmtt_domain {
486 u32 proximity_domain;
489 /* 2: Physical Component Identifier (DIMM) */
491 struct acpi_pmtt_physical_component {
492 struct acpi_pmtt_header header;
499 /*******************************************************************************
501 * RASF - RAS Feature Table (ACPI 5.0)
504 ******************************************************************************/
506 struct acpi_table_rasf {
507 struct acpi_table_header header; /* Common ACPI table header */
511 /* RASF Platform Communication Channel Shared Memory Region */
513 struct acpi_rasf_shared_memory {
519 u8 set_capabilities[16];
520 u16 num_parameter_blocks;
521 u32 set_capabilities_status;
524 /* RASF Parameter Block Structure Header */
526 struct acpi_rasf_parameter_block {
532 /* RASF Parameter Block Structure for PATROL_SCRUB */
534 struct acpi_rasf_patrol_scrub_parameter {
535 struct acpi_rasf_parameter_block header;
536 u16 patrol_scrub_command;
537 u64 requested_address_range[2];
538 u64 actual_address_range[2];
543 /* Masks for Flags and Speed fields above */
545 #define ACPI_RASF_SCRUBBER_RUNNING 1
546 #define ACPI_RASF_SPEED (7<<1)
547 #define ACPI_RASF_SPEED_SLOW (0<<1)
548 #define ACPI_RASF_SPEED_MEDIUM (4<<1)
549 #define ACPI_RASF_SPEED_FAST (7<<1)
551 /* Channel Commands */
553 enum acpi_rasf_commands {
554 ACPI_RASF_EXECUTE_RASF_COMMAND = 1
557 /* Platform RAS Capabilities */
559 enum acpi_rasf_capabiliities {
560 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
561 ACPI_SW_PATROL_SCRUB_EXPOSED = 1
564 /* Patrol Scrub Commands */
566 enum acpi_rasf_patrol_scrub_commands {
567 ACPI_RASF_GET_PATROL_PARAMETERS = 1,
568 ACPI_RASF_START_PATROL_SCRUBBER = 2,
569 ACPI_RASF_STOP_PATROL_SCRUBBER = 3
572 /* Channel Command flags */
574 #define ACPI_RASF_GENERATE_SCI (1<<15)
578 enum acpi_rasf_status {
579 ACPI_RASF_SUCCESS = 0,
580 ACPI_RASF_NOT_VALID = 1,
581 ACPI_RASF_NOT_SUPPORTED = 2,
583 ACPI_RASF_FAILED = 4,
584 ACPI_RASF_ABORTED = 5,
585 ACPI_RASF_INVALID_DATA = 6
590 #define ACPI_RASF_COMMAND_COMPLETE (1)
591 #define ACPI_RASF_SCI_DOORBELL (1<<1)
592 #define ACPI_RASF_ERROR (1<<2)
593 #define ACPI_RASF_STATUS (0x1F<<3)
595 /*******************************************************************************
597 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
600 * Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011
602 ******************************************************************************/
604 struct acpi_table_tpm2 {
605 struct acpi_table_header header; /* Common ACPI table header */
611 /* Control area structure (not part of table, pointed to by control_address) */
613 struct acpi_tpm2_control {
618 u64 interrupt_control;
622 u64 response_address;
625 /* Reset to default packing */
629 #endif /* __ACTBL3_H__ */