1 /******************************************************************************
3 * Name: actbl3.h - ACPI Table Definitions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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 * In general, the tables in this file are fully defined within the ACPI
57 ******************************************************************************/
60 * Values for description table header signatures for tables defined in this
61 * file. Useful because they make it more difficult to inadvertently type in
62 * the wrong signature.
64 #define ACPI_SIG_BGRT "BGRT" /* Boot Graphics Resource Table */
65 #define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */
66 #define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */
67 #define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */
68 #define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
69 #define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
70 #define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
71 #define ACPI_SIG_RASF "RASF" /* RAS Feature table */
72 #define ACPI_SIG_STAO "STAO" /* Status Override table */
73 #define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
74 #define ACPI_SIG_XENV "XENV" /* Xen Environment table */
76 #define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
77 #define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
79 /* Reserved table signatures */
81 #define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */
82 #define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
85 * All tables must be byte-packed to match the ACPI specification, since
86 * the tables are provided by the system BIOS.
91 * Note: C bitfields are not used for this reason:
93 * "Bitfields are great and easy to read, but unfortunately the C language
94 * does not specify the layout of bitfields in memory, which means they are
95 * essentially useless for dealing with packed data in on-disk formats or
96 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
97 * this decision was a design error in C. Ritchie could have picked an order
98 * and stuck with it." Norman Ramsey.
99 * See http://stackoverflow.com/a/1053662/41661
102 /*******************************************************************************
104 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
107 ******************************************************************************/
109 struct acpi_table_bgrt
{
110 struct acpi_table_header header
; /* Common ACPI table header */
119 /*******************************************************************************
121 * DRTM - Dynamic Root of Trust for Measurement table
122 * Conforms to "TCG D-RTM Architecture" June 17 2013, Version 1.0.0
125 ******************************************************************************/
127 struct acpi_table_drtm
{
128 struct acpi_table_header header
; /* Common ACPI table header */
129 u64 entry_base_address
;
134 u64 log_area_address
;
136 u64 arch_dependent_address
;
140 /* Flag Definitions for above */
142 #define ACPI_DRTM_ACCESS_ALLOWED (1)
143 #define ACPI_DRTM_ENABLE_GAP_CODE (1<<1)
144 #define ACPI_DRTM_INCOMPLETE_MEASUREMENTS (1<<2)
145 #define ACPI_DRTM_AUTHORITY_ORDER (1<<3)
147 /* 1) Validated Tables List (64-bit addresses) */
149 struct acpi_drtm_vtable_list
{
150 u32 validated_table_count
;
151 u64 validated_tables
[1];
154 /* 2) Resources List (of Resource Descriptors) */
156 /* Resource Descriptor */
158 struct acpi_drtm_resource
{
164 struct acpi_drtm_resource_list
{
166 struct acpi_drtm_resource resources
[1];
169 /* 3) Platform-specific Identifiers List */
171 struct acpi_drtm_dps_id
{
176 /*******************************************************************************
178 * FPDT - Firmware Performance Data Table (ACPI 5.0)
181 ******************************************************************************/
183 struct acpi_table_fpdt
{
184 struct acpi_table_header header
; /* Common ACPI table header */
187 /* FPDT subtable header (Performance Record Structure) */
189 struct acpi_fpdt_header
{
195 /* Values for Type field above */
197 enum acpi_fpdt_type
{
198 ACPI_FPDT_TYPE_BOOT
= 0,
199 ACPI_FPDT_TYPE_S3PERF
= 1
206 /* 0: Firmware Basic Boot Performance Record */
208 struct acpi_fpdt_boot_pointer
{
209 struct acpi_fpdt_header header
;
214 /* 1: S3 Performance Table Pointer Record */
216 struct acpi_fpdt_s3pt_pointer
{
217 struct acpi_fpdt_header header
;
223 * S3PT - S3 Performance Table. This table is pointed to by the
224 * S3 Pointer Record above.
226 struct acpi_table_s3pt
{
227 u8 signature
[4]; /* "S3PT" */
232 * S3PT Subtables (Not part of the actual FPDT)
235 /* Values for Type field in S3PT header */
237 enum acpi_s3pt_type
{
238 ACPI_S3PT_TYPE_RESUME
= 0,
239 ACPI_S3PT_TYPE_SUSPEND
= 1,
240 ACPI_FPDT_BOOT_PERFORMANCE
= 2
243 struct acpi_s3pt_resume
{
244 struct acpi_fpdt_header header
;
250 struct acpi_s3pt_suspend
{
251 struct acpi_fpdt_header header
;
257 * FPDT Boot Performance Record (Not part of the actual FPDT)
259 struct acpi_fpdt_boot
{
260 struct acpi_fpdt_header header
;
265 u64 exit_services_entry
;
266 u64 exit_services_exit
;
269 /*******************************************************************************
271 * GTDT - Generic Timer Description Table (ACPI 5.1)
274 ******************************************************************************/
276 struct acpi_table_gtdt
{
277 struct acpi_table_header header
; /* Common ACPI table header */
278 u64 counter_block_addresss
;
280 u32 secure_el1_interrupt
;
281 u32 secure_el1_flags
;
282 u32 non_secure_el1_interrupt
;
283 u32 non_secure_el1_flags
;
284 u32 virtual_timer_interrupt
;
285 u32 virtual_timer_flags
;
286 u32 non_secure_el2_interrupt
;
287 u32 non_secure_el2_flags
;
288 u64 counter_read_block_address
;
289 u32 platform_timer_count
;
290 u32 platform_timer_offset
;
293 /* Flag Definitions: Timer Block Physical Timers and Virtual timers */
295 #define ACPI_GTDT_INTERRUPT_MODE (1)
296 #define ACPI_GTDT_INTERRUPT_POLARITY (1<<1)
297 #define ACPI_GTDT_ALWAYS_ON (1<<2)
299 /* Common GTDT subtable header */
301 struct acpi_gtdt_header
{
306 /* Values for GTDT subtable type above */
308 enum acpi_gtdt_type
{
309 ACPI_GTDT_TYPE_TIMER_BLOCK
= 0,
310 ACPI_GTDT_TYPE_WATCHDOG
= 1,
311 ACPI_GTDT_TYPE_RESERVED
= 2 /* 2 and greater are reserved */
314 /* GTDT Subtables, correspond to Type in struct acpi_gtdt_header */
316 /* 0: Generic Timer Block */
318 struct acpi_gtdt_timer_block
{
319 struct acpi_gtdt_header header
;
326 /* Timer Sub-Structure, one per timer */
328 struct acpi_gtdt_timer_entry
{
332 u64 el0_base_address
;
335 u32 virtual_timer_interrupt
;
336 u32 virtual_timer_flags
;
340 /* Flag Definitions: timer_flags and virtual_timer_flags above */
342 #define ACPI_GTDT_GT_IRQ_MODE (1)
343 #define ACPI_GTDT_GT_IRQ_POLARITY (1<<1)
345 /* Flag Definitions: common_flags above */
347 #define ACPI_GTDT_GT_IS_SECURE_TIMER (1)
348 #define ACPI_GTDT_GT_ALWAYS_ON (1<<1)
350 /* 1: SBSA Generic Watchdog Structure */
352 struct acpi_gtdt_watchdog
{
353 struct acpi_gtdt_header header
;
355 u64 refresh_frame_address
;
356 u64 control_frame_address
;
361 /* Flag Definitions: timer_flags above */
363 #define ACPI_GTDT_WATCHDOG_IRQ_MODE (1)
364 #define ACPI_GTDT_WATCHDOG_IRQ_POLARITY (1<<1)
365 #define ACPI_GTDT_WATCHDOG_SECURE (1<<2)
367 /*******************************************************************************
369 * MPST - Memory Power State Table (ACPI 5.0)
372 ******************************************************************************/
374 #define ACPI_MPST_CHANNEL_INFO \
377 u16 power_node_count; \
382 struct acpi_table_mpst
{
383 struct acpi_table_header header
; /* Common ACPI table header */
384 ACPI_MPST_CHANNEL_INFO
/* Platform Communication Channel */
387 /* Memory Platform Communication Channel Info */
389 struct acpi_mpst_channel
{
390 ACPI_MPST_CHANNEL_INFO
/* Platform Communication Channel */
393 /* Memory Power Node Structure */
395 struct acpi_mpst_power_node
{
402 u32 num_power_states
;
403 u32 num_physical_components
;
406 /* Values for Flags field above */
408 #define ACPI_MPST_ENABLED 1
409 #define ACPI_MPST_POWER_MANAGED 2
410 #define ACPI_MPST_HOT_PLUG_CAPABLE 4
412 /* Memory Power State Structure (follows POWER_NODE above) */
414 struct acpi_mpst_power_state
{
419 /* Physical Component ID Structure (follows POWER_STATE above) */
421 struct acpi_mpst_component
{
425 /* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
427 struct acpi_mpst_data_hdr
{
428 u16 characteristics_count
;
432 struct acpi_mpst_power_data
{
442 /* Values for Flags field above */
444 #define ACPI_MPST_PRESERVE 1
445 #define ACPI_MPST_AUTOENTRY 2
446 #define ACPI_MPST_AUTOEXIT 4
448 /* Shared Memory Region (not part of an ACPI table) */
450 struct acpi_mpst_shared
{
454 u32 command_register
;
462 /*******************************************************************************
464 * PCCT - Platform Communications Channel Table (ACPI 5.0)
467 ******************************************************************************/
469 struct acpi_table_pcct
{
470 struct acpi_table_header header
; /* Common ACPI table header */
475 /* Values for Flags field above */
477 #define ACPI_PCCT_DOORBELL 1
479 /* Values for subtable type in struct acpi_subtable_header */
481 enum acpi_pcct_type
{
482 ACPI_PCCT_TYPE_GENERIC_SUBSPACE
= 0,
483 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE
= 1,
484 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE_TYPE2
= 2, /* ACPI 6.1 */
485 ACPI_PCCT_TYPE_RESERVED
= 3 /* 3 and greater are reserved */
489 * PCCT Subtables, correspond to Type in struct acpi_subtable_header
492 /* 0: Generic Communications Subspace */
494 struct acpi_pcct_subspace
{
495 struct acpi_subtable_header header
;
499 struct acpi_generic_address doorbell_register
;
504 u16 min_turnaround_time
;
507 /* 1: HW-reduced Communications Subspace (ACPI 5.1) */
509 struct acpi_pcct_hw_reduced
{
510 struct acpi_subtable_header header
;
511 u32 doorbell_interrupt
;
516 struct acpi_generic_address doorbell_register
;
521 u16 min_turnaround_time
;
524 /* 2: HW-reduced Communications Subspace Type 2 (ACPI 6.1) */
526 struct acpi_pcct_hw_reduced_type2
{
527 struct acpi_subtable_header header
;
528 u32 doorbell_interrupt
;
533 struct acpi_generic_address doorbell_register
;
538 u16 min_turnaround_time
;
539 struct acpi_generic_address doorbell_ack_register
;
540 u64 ack_preserve_mask
;
544 /* Values for doorbell flags above */
546 #define ACPI_PCCT_INTERRUPT_POLARITY (1)
547 #define ACPI_PCCT_INTERRUPT_MODE (1<<1)
550 * PCC memory structures (not part of the ACPI table)
553 /* Shared Memory Region */
555 struct acpi_pcct_shared_memory
{
561 /*******************************************************************************
563 * PMTT - Platform Memory Topology Table (ACPI 5.0)
566 ******************************************************************************/
568 struct acpi_table_pmtt
{
569 struct acpi_table_header header
; /* Common ACPI table header */
573 /* Common header for PMTT subtables that follow main table */
575 struct acpi_pmtt_header
{
583 /* Values for Type field above */
585 #define ACPI_PMTT_TYPE_SOCKET 0
586 #define ACPI_PMTT_TYPE_CONTROLLER 1
587 #define ACPI_PMTT_TYPE_DIMM 2
588 #define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
590 /* Values for Flags field above */
592 #define ACPI_PMTT_TOP_LEVEL 0x0001
593 #define ACPI_PMTT_PHYSICAL 0x0002
594 #define ACPI_PMTT_MEMORY_TYPE 0x000C
597 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
600 /* 0: Socket Structure */
602 struct acpi_pmtt_socket
{
603 struct acpi_pmtt_header header
;
608 /* 1: Memory Controller subtable */
610 struct acpi_pmtt_controller
{
611 struct acpi_pmtt_header header
;
622 /* 1a: Proximity Domain substructure */
624 struct acpi_pmtt_domain
{
625 u32 proximity_domain
;
628 /* 2: Physical Component Identifier (DIMM) */
630 struct acpi_pmtt_physical_component
{
631 struct acpi_pmtt_header header
;
638 /*******************************************************************************
640 * RASF - RAS Feature Table (ACPI 5.0)
643 ******************************************************************************/
645 struct acpi_table_rasf
{
646 struct acpi_table_header header
; /* Common ACPI table header */
650 /* RASF Platform Communication Channel Shared Memory Region */
652 struct acpi_rasf_shared_memory
{
658 u8 set_capabilities
[16];
659 u16 num_parameter_blocks
;
660 u32 set_capabilities_status
;
663 /* RASF Parameter Block Structure Header */
665 struct acpi_rasf_parameter_block
{
671 /* RASF Parameter Block Structure for PATROL_SCRUB */
673 struct acpi_rasf_patrol_scrub_parameter
{
674 struct acpi_rasf_parameter_block header
;
675 u16 patrol_scrub_command
;
676 u64 requested_address_range
[2];
677 u64 actual_address_range
[2];
682 /* Masks for Flags and Speed fields above */
684 #define ACPI_RASF_SCRUBBER_RUNNING 1
685 #define ACPI_RASF_SPEED (7<<1)
686 #define ACPI_RASF_SPEED_SLOW (0<<1)
687 #define ACPI_RASF_SPEED_MEDIUM (4<<1)
688 #define ACPI_RASF_SPEED_FAST (7<<1)
690 /* Channel Commands */
692 enum acpi_rasf_commands
{
693 ACPI_RASF_EXECUTE_RASF_COMMAND
= 1
696 /* Platform RAS Capabilities */
698 enum acpi_rasf_capabiliities
{
699 ACPI_HW_PATROL_SCRUB_SUPPORTED
= 0,
700 ACPI_SW_PATROL_SCRUB_EXPOSED
= 1
703 /* Patrol Scrub Commands */
705 enum acpi_rasf_patrol_scrub_commands
{
706 ACPI_RASF_GET_PATROL_PARAMETERS
= 1,
707 ACPI_RASF_START_PATROL_SCRUBBER
= 2,
708 ACPI_RASF_STOP_PATROL_SCRUBBER
= 3
711 /* Channel Command flags */
713 #define ACPI_RASF_GENERATE_SCI (1<<15)
717 enum acpi_rasf_status
{
718 ACPI_RASF_SUCCESS
= 0,
719 ACPI_RASF_NOT_VALID
= 1,
720 ACPI_RASF_NOT_SUPPORTED
= 2,
722 ACPI_RASF_FAILED
= 4,
723 ACPI_RASF_ABORTED
= 5,
724 ACPI_RASF_INVALID_DATA
= 6
729 #define ACPI_RASF_COMMAND_COMPLETE (1)
730 #define ACPI_RASF_SCI_DOORBELL (1<<1)
731 #define ACPI_RASF_ERROR (1<<2)
732 #define ACPI_RASF_STATUS (0x1F<<3)
734 /*******************************************************************************
736 * STAO - Status Override Table (_STA override) - ACPI 6.0
739 * Conforms to "ACPI Specification for Status Override Table"
742 ******************************************************************************/
744 struct acpi_table_stao
{
745 struct acpi_table_header header
; /* Common ACPI table header */
749 /*******************************************************************************
751 * WPBT - Windows Platform Environment Table (ACPI 6.0)
754 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
756 ******************************************************************************/
758 struct acpi_table_wpbt
{
759 struct acpi_table_header header
; /* Common ACPI table header */
764 u16 arguments_length
;
767 /*******************************************************************************
769 * XENV - Xen Environment Table (ACPI 6.0)
772 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
774 ******************************************************************************/
776 struct acpi_table_xenv
{
777 struct acpi_table_header header
; /* Common ACPI table header */
778 u64 grant_table_address
;
779 u64 grant_table_size
;
784 /* Reset to default packing */
788 #endif /* __ACTBL3_H__ */