1 /******************************************************************************
3 * Name: actbl3.h - ACPI Table Definitions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, 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.1)
247 ******************************************************************************/
249 struct acpi_table_gtdt
{
250 struct acpi_table_header header
; /* Common ACPI table header */
251 u64 counter_block_addresss
;
253 u32 secure_el1_interrupt
;
254 u32 secure_el1_flags
;
255 u32 non_secure_el1_interrupt
;
256 u32 non_secure_el1_flags
;
257 u32 virtual_timer_interrupt
;
258 u32 virtual_timer_flags
;
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
;
266 /* Flag Definitions: Timer Block Physical Timers and Virtual timers */
268 #define ACPI_GTDT_INTERRUPT_MODE (1)
269 #define ACPI_GTDT_INTERRUPT_POLARITY (1<<1)
270 #define ACPI_GTDT_ALWAYS_ON (1<<2)
272 /* Common GTDT subtable header */
274 struct acpi_gtdt_header
{
279 /* Values for GTDT subtable type above */
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 */
287 /* GTDT Subtables, correspond to Type in struct acpi_gtdt_header */
289 /* 0: Generic Timer Block */
291 struct acpi_gtdt_timer_block
{
292 struct acpi_gtdt_header header
;
299 /* Timer Sub-Structure, one per timer */
301 struct acpi_gtdt_timer_entry
{
305 u64 el0_base_address
;
308 u32 virtual_timer_interrupt
;
309 u32 virtual_timer_flags
;
313 /* Flag Definitions: timer_flags and virtual_timer_flags above */
315 #define ACPI_GTDT_GT_IRQ_MODE (1)
316 #define ACPI_GTDT_GT_IRQ_POLARITY (1<<1)
318 /* Flag Definitions: common_flags above */
320 #define ACPI_GTDT_GT_IS_SECURE_TIMER (1)
321 #define ACPI_GTDT_GT_ALWAYS_ON (1<<1)
323 /* 1: SBSA Generic Watchdog Structure */
325 struct acpi_gtdt_watchdog
{
326 struct acpi_gtdt_header header
;
328 u64 refresh_frame_address
;
329 u64 control_frame_address
;
334 /* Flag Definitions: timer_flags above */
336 #define ACPI_GTDT_WATCHDOG_IRQ_MODE (1)
337 #define ACPI_GTDT_WATCHDOG_IRQ_POLARITY (1<<1)
338 #define ACPI_GTDT_WATCHDOG_SECURE (1<<2)
340 /*******************************************************************************
342 * MPST - Memory Power State Table (ACPI 5.0)
345 ******************************************************************************/
347 #define ACPI_MPST_CHANNEL_INFO \
350 u16 power_node_count; \
355 struct acpi_table_mpst
{
356 struct acpi_table_header header
; /* Common ACPI table header */
357 ACPI_MPST_CHANNEL_INFO
/* Platform Communication Channel */
360 /* Memory Platform Communication Channel Info */
362 struct acpi_mpst_channel
{
363 ACPI_MPST_CHANNEL_INFO
/* Platform Communication Channel */
366 /* Memory Power Node Structure */
368 struct acpi_mpst_power_node
{
375 u32 num_power_states
;
376 u32 num_physical_components
;
379 /* Values for Flags field above */
381 #define ACPI_MPST_ENABLED 1
382 #define ACPI_MPST_POWER_MANAGED 2
383 #define ACPI_MPST_HOT_PLUG_CAPABLE 4
385 /* Memory Power State Structure (follows POWER_NODE above) */
387 struct acpi_mpst_power_state
{
392 /* Physical Component ID Structure (follows POWER_STATE above) */
394 struct acpi_mpst_component
{
398 /* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
400 struct acpi_mpst_data_hdr
{
401 u16 characteristics_count
;
405 struct acpi_mpst_power_data
{
415 /* Values for Flags field above */
417 #define ACPI_MPST_PRESERVE 1
418 #define ACPI_MPST_AUTOENTRY 2
419 #define ACPI_MPST_AUTOEXIT 4
421 /* Shared Memory Region (not part of an ACPI table) */
423 struct acpi_mpst_shared
{
427 u32 command_register
;
435 /*******************************************************************************
437 * PCCT - Platform Communications Channel Table (ACPI 5.0)
440 ******************************************************************************/
442 struct acpi_table_pcct
{
443 struct acpi_table_header header
; /* Common ACPI table header */
448 /* Values for Flags field above */
450 #define ACPI_PCCT_DOORBELL 1
452 /* Values for subtable type in struct acpi_subtable_header */
454 enum acpi_pcct_type
{
455 ACPI_PCCT_TYPE_GENERIC_SUBSPACE
= 0,
456 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE
= 1,
457 ACPI_PCCT_TYPE_RESERVED
= 2 /* 2 and greater are reserved */
461 * PCCT Subtables, correspond to Type in struct acpi_subtable_header
464 /* 0: Generic Communications Subspace */
466 struct acpi_pcct_subspace
{
467 struct acpi_subtable_header header
;
471 struct acpi_generic_address doorbell_register
;
476 u16 min_turnaround_time
;
479 /* 1: HW-reduced Communications Subspace (ACPI 5.1) */
481 struct acpi_pcct_hw_reduced
{
482 struct acpi_subtable_header header
;
483 u32 doorbell_interrupt
;
488 struct acpi_generic_address doorbell_register
;
493 u16 min_turnaround_time
;
496 /* Values for doorbell flags above */
498 #define ACPI_PCCT_INTERRUPT_POLARITY (1)
499 #define ACPI_PCCT_INTERRUPT_MODE (1<<1)
502 * PCC memory structures (not part of the ACPI table)
505 /* Shared Memory Region */
507 struct acpi_pcct_shared_memory
{
513 /*******************************************************************************
515 * PMTT - Platform Memory Topology Table (ACPI 5.0)
518 ******************************************************************************/
520 struct acpi_table_pmtt
{
521 struct acpi_table_header header
; /* Common ACPI table header */
525 /* Common header for PMTT subtables that follow main table */
527 struct acpi_pmtt_header
{
535 /* Values for Type field above */
537 #define ACPI_PMTT_TYPE_SOCKET 0
538 #define ACPI_PMTT_TYPE_CONTROLLER 1
539 #define ACPI_PMTT_TYPE_DIMM 2
540 #define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
542 /* Values for Flags field above */
544 #define ACPI_PMTT_TOP_LEVEL 0x0001
545 #define ACPI_PMTT_PHYSICAL 0x0002
546 #define ACPI_PMTT_MEMORY_TYPE 0x000C
549 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
552 /* 0: Socket Structure */
554 struct acpi_pmtt_socket
{
555 struct acpi_pmtt_header header
;
560 /* 1: Memory Controller subtable */
562 struct acpi_pmtt_controller
{
563 struct acpi_pmtt_header header
;
574 /* 1a: Proximity Domain substructure */
576 struct acpi_pmtt_domain
{
577 u32 proximity_domain
;
580 /* 2: Physical Component Identifier (DIMM) */
582 struct acpi_pmtt_physical_component
{
583 struct acpi_pmtt_header header
;
590 /*******************************************************************************
592 * RASF - RAS Feature Table (ACPI 5.0)
595 ******************************************************************************/
597 struct acpi_table_rasf
{
598 struct acpi_table_header header
; /* Common ACPI table header */
602 /* RASF Platform Communication Channel Shared Memory Region */
604 struct acpi_rasf_shared_memory
{
610 u8 set_capabilities
[16];
611 u16 num_parameter_blocks
;
612 u32 set_capabilities_status
;
615 /* RASF Parameter Block Structure Header */
617 struct acpi_rasf_parameter_block
{
623 /* RASF Parameter Block Structure for PATROL_SCRUB */
625 struct acpi_rasf_patrol_scrub_parameter
{
626 struct acpi_rasf_parameter_block header
;
627 u16 patrol_scrub_command
;
628 u64 requested_address_range
[2];
629 u64 actual_address_range
[2];
634 /* Masks for Flags and Speed fields above */
636 #define ACPI_RASF_SCRUBBER_RUNNING 1
637 #define ACPI_RASF_SPEED (7<<1)
638 #define ACPI_RASF_SPEED_SLOW (0<<1)
639 #define ACPI_RASF_SPEED_MEDIUM (4<<1)
640 #define ACPI_RASF_SPEED_FAST (7<<1)
642 /* Channel Commands */
644 enum acpi_rasf_commands
{
645 ACPI_RASF_EXECUTE_RASF_COMMAND
= 1
648 /* Platform RAS Capabilities */
650 enum acpi_rasf_capabiliities
{
651 ACPI_HW_PATROL_SCRUB_SUPPORTED
= 0,
652 ACPI_SW_PATROL_SCRUB_EXPOSED
= 1
655 /* Patrol Scrub Commands */
657 enum acpi_rasf_patrol_scrub_commands
{
658 ACPI_RASF_GET_PATROL_PARAMETERS
= 1,
659 ACPI_RASF_START_PATROL_SCRUBBER
= 2,
660 ACPI_RASF_STOP_PATROL_SCRUBBER
= 3
663 /* Channel Command flags */
665 #define ACPI_RASF_GENERATE_SCI (1<<15)
669 enum acpi_rasf_status
{
670 ACPI_RASF_SUCCESS
= 0,
671 ACPI_RASF_NOT_VALID
= 1,
672 ACPI_RASF_NOT_SUPPORTED
= 2,
674 ACPI_RASF_FAILED
= 4,
675 ACPI_RASF_ABORTED
= 5,
676 ACPI_RASF_INVALID_DATA
= 6
681 #define ACPI_RASF_COMMAND_COMPLETE (1)
682 #define ACPI_RASF_SCI_DOORBELL (1<<1)
683 #define ACPI_RASF_ERROR (1<<2)
684 #define ACPI_RASF_STATUS (0x1F<<3)
686 /*******************************************************************************
688 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
691 * Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011
693 ******************************************************************************/
695 struct acpi_table_tpm2
{
696 struct acpi_table_header header
; /* Common ACPI table header */
702 /* Control area structure (not part of table, pointed to by control_address) */
704 struct acpi_tpm2_control
{
709 u64 interrupt_control
;
713 u64 response_address
;
716 /* Reset to default packing */
720 #endif /* __ACTBL3_H__ */