1 /******************************************************************************
3 * Name: actbl1.h - Additional ACPI table definitions
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, 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 (1)
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_BERT "BERT" /* Boot Error Record Table */
64 #define ACPI_SIG_CPEP "CPEP" /* Corrected Platform Error Polling table */
65 #define ACPI_SIG_ECDT "ECDT" /* Embedded Controller Boot Resources Table */
66 #define ACPI_SIG_EINJ "EINJ" /* Error Injection table */
67 #define ACPI_SIG_ERST "ERST" /* Error Record Serialization Table */
68 #define ACPI_SIG_HMAT "HMAT" /* Heterogeneous Memory Attributes Table */
69 #define ACPI_SIG_HEST "HEST" /* Hardware Error Source Table */
70 #define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
71 #define ACPI_SIG_MSCT "MSCT" /* Maximum System Characteristics Table */
72 #define ACPI_SIG_PPTT "PPTT" /* Processor Properties Topology Table */
73 #define ACPI_SIG_SBST "SBST" /* Smart Battery Specification Table */
74 #define ACPI_SIG_SLIT "SLIT" /* System Locality Distance Information Table */
75 #define ACPI_SIG_SRAT "SRAT" /* System Resource Affinity Table */
76 #define ACPI_SIG_NFIT "NFIT" /* NVDIMM Firmware Interface Table */
79 * All tables must be byte-packed to match the ACPI specification, since
80 * the tables are provided by the system BIOS.
85 * Note: C bitfields are not used for this reason:
87 * "Bitfields are great and easy to read, but unfortunately the C language
88 * does not specify the layout of bitfields in memory, which means they are
89 * essentially useless for dealing with packed data in on-disk formats or
90 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
91 * this decision was a design error in C. Ritchie could have picked an order
92 * and stuck with it." Norman Ramsey.
93 * See http://stackoverflow.com/a/1053662/41661
96 /*******************************************************************************
98 * Common subtable headers
100 ******************************************************************************/
102 /* Generic subtable header (used in MADT, SRAT, etc.) */
104 struct acpi_subtable_header
{
109 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
111 struct acpi_whea_header
{
116 struct acpi_generic_address register_region
;
117 u64 value
; /* Value used with Read/Write register */
118 u64 mask
; /* Bitmask required for this register instruction */
121 /*******************************************************************************
123 * BERT - Boot Error Record Table (ACPI 4.0)
126 ******************************************************************************/
128 struct acpi_table_bert
{
129 struct acpi_table_header header
; /* Common ACPI table header */
130 u32 region_length
; /* Length of the boot error region */
131 u64 address
; /* Physical address of the error region */
134 /* Boot Error Region (not a subtable, pointed to by Address field above) */
136 struct acpi_bert_region
{
137 u32 block_status
; /* Type of error information */
138 u32 raw_data_offset
; /* Offset to raw error data */
139 u32 raw_data_length
; /* Length of raw error data */
140 u32 data_length
; /* Length of generic error data */
141 u32 error_severity
; /* Severity code */
144 /* Values for block_status flags above */
146 #define ACPI_BERT_UNCORRECTABLE (1)
147 #define ACPI_BERT_CORRECTABLE (1<<1)
148 #define ACPI_BERT_MULTIPLE_UNCORRECTABLE (1<<2)
149 #define ACPI_BERT_MULTIPLE_CORRECTABLE (1<<3)
150 #define ACPI_BERT_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
152 /* Values for error_severity above */
154 enum acpi_bert_error_severity
{
155 ACPI_BERT_ERROR_CORRECTABLE
= 0,
156 ACPI_BERT_ERROR_FATAL
= 1,
157 ACPI_BERT_ERROR_CORRECTED
= 2,
158 ACPI_BERT_ERROR_NONE
= 3,
159 ACPI_BERT_ERROR_RESERVED
= 4 /* 4 and greater are reserved */
163 * Note: The generic error data that follows the error_severity field above
164 * uses the struct acpi_hest_generic_data defined under the HEST table below
167 /*******************************************************************************
169 * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
172 ******************************************************************************/
174 struct acpi_table_cpep
{
175 struct acpi_table_header header
; /* Common ACPI table header */
181 struct acpi_cpep_polling
{
182 struct acpi_subtable_header header
;
183 u8 id
; /* Processor ID */
184 u8 eid
; /* Processor EID */
185 u32 interval
; /* Polling interval (msec) */
188 /*******************************************************************************
190 * ECDT - Embedded Controller Boot Resources Table
193 ******************************************************************************/
195 struct acpi_table_ecdt
{
196 struct acpi_table_header header
; /* Common ACPI table header */
197 struct acpi_generic_address control
; /* Address of EC command/status register */
198 struct acpi_generic_address data
; /* Address of EC data register */
199 u32 uid
; /* Unique ID - must be same as the EC _UID method */
200 u8 gpe
; /* The GPE for the EC */
201 u8 id
[1]; /* Full namepath of the EC in the ACPI namespace */
204 /*******************************************************************************
206 * EINJ - Error Injection Table (ACPI 4.0)
209 ******************************************************************************/
211 struct acpi_table_einj
{
212 struct acpi_table_header header
; /* Common ACPI table header */
219 /* EINJ Injection Instruction Entries (actions) */
221 struct acpi_einj_entry
{
222 struct acpi_whea_header whea_header
; /* Common header for WHEA tables */
225 /* Masks for Flags field above */
227 #define ACPI_EINJ_PRESERVE (1)
229 /* Values for Action field above */
231 enum acpi_einj_actions
{
232 ACPI_EINJ_BEGIN_OPERATION
= 0,
233 ACPI_EINJ_GET_TRIGGER_TABLE
= 1,
234 ACPI_EINJ_SET_ERROR_TYPE
= 2,
235 ACPI_EINJ_GET_ERROR_TYPE
= 3,
236 ACPI_EINJ_END_OPERATION
= 4,
237 ACPI_EINJ_EXECUTE_OPERATION
= 5,
238 ACPI_EINJ_CHECK_BUSY_STATUS
= 6,
239 ACPI_EINJ_GET_COMMAND_STATUS
= 7,
240 ACPI_EINJ_SET_ERROR_TYPE_WITH_ADDRESS
= 8,
241 ACPI_EINJ_GET_EXECUTE_TIMINGS
= 9,
242 ACPI_EINJ_ACTION_RESERVED
= 10, /* 10 and greater are reserved */
243 ACPI_EINJ_TRIGGER_ERROR
= 0xFF /* Except for this value */
246 /* Values for Instruction field above */
248 enum acpi_einj_instructions
{
249 ACPI_EINJ_READ_REGISTER
= 0,
250 ACPI_EINJ_READ_REGISTER_VALUE
= 1,
251 ACPI_EINJ_WRITE_REGISTER
= 2,
252 ACPI_EINJ_WRITE_REGISTER_VALUE
= 3,
254 ACPI_EINJ_FLUSH_CACHELINE
= 5,
255 ACPI_EINJ_INSTRUCTION_RESERVED
= 6 /* 6 and greater are reserved */
258 struct acpi_einj_error_type_with_addr
{
260 u32 vendor_struct_offset
;
268 struct acpi_einj_vendor
{
277 /* EINJ Trigger Error Action Table */
279 struct acpi_einj_trigger
{
286 /* Command status return values */
288 enum acpi_einj_command_status
{
289 ACPI_EINJ_SUCCESS
= 0,
290 ACPI_EINJ_FAILURE
= 1,
291 ACPI_EINJ_INVALID_ACCESS
= 2,
292 ACPI_EINJ_STATUS_RESERVED
= 3 /* 3 and greater are reserved */
295 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
297 #define ACPI_EINJ_PROCESSOR_CORRECTABLE (1)
298 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE (1<<1)
299 #define ACPI_EINJ_PROCESSOR_FATAL (1<<2)
300 #define ACPI_EINJ_MEMORY_CORRECTABLE (1<<3)
301 #define ACPI_EINJ_MEMORY_UNCORRECTABLE (1<<4)
302 #define ACPI_EINJ_MEMORY_FATAL (1<<5)
303 #define ACPI_EINJ_PCIX_CORRECTABLE (1<<6)
304 #define ACPI_EINJ_PCIX_UNCORRECTABLE (1<<7)
305 #define ACPI_EINJ_PCIX_FATAL (1<<8)
306 #define ACPI_EINJ_PLATFORM_CORRECTABLE (1<<9)
307 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE (1<<10)
308 #define ACPI_EINJ_PLATFORM_FATAL (1<<11)
309 #define ACPI_EINJ_VENDOR_DEFINED (1<<31)
311 /*******************************************************************************
313 * ERST - Error Record Serialization Table (ACPI 4.0)
316 ******************************************************************************/
318 struct acpi_table_erst
{
319 struct acpi_table_header header
; /* Common ACPI table header */
325 /* ERST Serialization Entries (actions) */
327 struct acpi_erst_entry
{
328 struct acpi_whea_header whea_header
; /* Common header for WHEA tables */
331 /* Masks for Flags field above */
333 #define ACPI_ERST_PRESERVE (1)
335 /* Values for Action field above */
337 enum acpi_erst_actions
{
338 ACPI_ERST_BEGIN_WRITE
= 0,
339 ACPI_ERST_BEGIN_READ
= 1,
340 ACPI_ERST_BEGIN_CLEAR
= 2,
342 ACPI_ERST_SET_RECORD_OFFSET
= 4,
343 ACPI_ERST_EXECUTE_OPERATION
= 5,
344 ACPI_ERST_CHECK_BUSY_STATUS
= 6,
345 ACPI_ERST_GET_COMMAND_STATUS
= 7,
346 ACPI_ERST_GET_RECORD_ID
= 8,
347 ACPI_ERST_SET_RECORD_ID
= 9,
348 ACPI_ERST_GET_RECORD_COUNT
= 10,
349 ACPI_ERST_BEGIN_DUMMY_WRIITE
= 11,
350 ACPI_ERST_NOT_USED
= 12,
351 ACPI_ERST_GET_ERROR_RANGE
= 13,
352 ACPI_ERST_GET_ERROR_LENGTH
= 14,
353 ACPI_ERST_GET_ERROR_ATTRIBUTES
= 15,
354 ACPI_ERST_EXECUTE_TIMINGS
= 16,
355 ACPI_ERST_ACTION_RESERVED
= 17 /* 17 and greater are reserved */
358 /* Values for Instruction field above */
360 enum acpi_erst_instructions
{
361 ACPI_ERST_READ_REGISTER
= 0,
362 ACPI_ERST_READ_REGISTER_VALUE
= 1,
363 ACPI_ERST_WRITE_REGISTER
= 2,
364 ACPI_ERST_WRITE_REGISTER_VALUE
= 3,
366 ACPI_ERST_LOAD_VAR1
= 5,
367 ACPI_ERST_LOAD_VAR2
= 6,
368 ACPI_ERST_STORE_VAR1
= 7,
370 ACPI_ERST_SUBTRACT
= 9,
371 ACPI_ERST_ADD_VALUE
= 10,
372 ACPI_ERST_SUBTRACT_VALUE
= 11,
373 ACPI_ERST_STALL
= 12,
374 ACPI_ERST_STALL_WHILE_TRUE
= 13,
375 ACPI_ERST_SKIP_NEXT_IF_TRUE
= 14,
377 ACPI_ERST_SET_SRC_ADDRESS_BASE
= 16,
378 ACPI_ERST_SET_DST_ADDRESS_BASE
= 17,
379 ACPI_ERST_MOVE_DATA
= 18,
380 ACPI_ERST_INSTRUCTION_RESERVED
= 19 /* 19 and greater are reserved */
383 /* Command status return values */
385 enum acpi_erst_command_status
{
386 ACPI_ERST_SUCESS
= 0,
387 ACPI_ERST_NO_SPACE
= 1,
388 ACPI_ERST_NOT_AVAILABLE
= 2,
389 ACPI_ERST_FAILURE
= 3,
390 ACPI_ERST_RECORD_EMPTY
= 4,
391 ACPI_ERST_NOT_FOUND
= 5,
392 ACPI_ERST_STATUS_RESERVED
= 6 /* 6 and greater are reserved */
395 /* Error Record Serialization Information */
397 struct acpi_erst_info
{
398 u16 signature
; /* Should be "ER" */
402 /*******************************************************************************
404 * HEST - Hardware Error Source Table (ACPI 4.0)
407 ******************************************************************************/
409 struct acpi_table_hest
{
410 struct acpi_table_header header
; /* Common ACPI table header */
411 u32 error_source_count
;
414 /* HEST subtable header */
416 struct acpi_hest_header
{
421 /* Values for Type field above for subtables */
423 enum acpi_hest_types
{
424 ACPI_HEST_TYPE_IA32_CHECK
= 0,
425 ACPI_HEST_TYPE_IA32_CORRECTED_CHECK
= 1,
426 ACPI_HEST_TYPE_IA32_NMI
= 2,
427 ACPI_HEST_TYPE_NOT_USED3
= 3,
428 ACPI_HEST_TYPE_NOT_USED4
= 4,
429 ACPI_HEST_TYPE_NOT_USED5
= 5,
430 ACPI_HEST_TYPE_AER_ROOT_PORT
= 6,
431 ACPI_HEST_TYPE_AER_ENDPOINT
= 7,
432 ACPI_HEST_TYPE_AER_BRIDGE
= 8,
433 ACPI_HEST_TYPE_GENERIC_ERROR
= 9,
434 ACPI_HEST_TYPE_GENERIC_ERROR_V2
= 10,
435 ACPI_HEST_TYPE_IA32_DEFERRED_CHECK
= 11,
436 ACPI_HEST_TYPE_RESERVED
= 12 /* 12 and greater are reserved */
440 * HEST substructures contained in subtables
444 * IA32 Error Bank(s) - Follows the struct acpi_hest_ia_machine_check and
445 * struct acpi_hest_ia_corrected structures.
447 struct acpi_hest_ia_error_bank
{
449 u8 clear_status_on_init
;
452 u32 control_register
;
455 u32 address_register
;
459 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
461 struct acpi_hest_aer_common
{
465 u32 records_to_preallocate
;
466 u32 max_sections_per_record
;
467 u32 bus
; /* Bus and Segment numbers */
472 u32 uncorrectable_mask
;
473 u32 uncorrectable_severity
;
474 u32 correctable_mask
;
475 u32 advanced_capabilities
;
478 /* Masks for HEST Flags fields */
480 #define ACPI_HEST_FIRMWARE_FIRST (1)
481 #define ACPI_HEST_GLOBAL (1<<1)
482 #define ACPI_HEST_GHES_ASSIST (1<<2)
485 * Macros to access the bus/segment numbers in Bus field above:
486 * Bus number is encoded in bits 7:0
487 * Segment number is encoded in bits 23:8
489 #define ACPI_HEST_BUS(bus) ((bus) & 0xFF)
490 #define ACPI_HEST_SEGMENT(bus) (((bus) >> 8) & 0xFFFF)
492 /* Hardware Error Notification */
494 struct acpi_hest_notify
{
497 u16 config_write_enable
;
500 u32 polling_threshold_value
;
501 u32 polling_threshold_window
;
502 u32 error_threshold_value
;
503 u32 error_threshold_window
;
506 /* Values for Notify Type field above */
508 enum acpi_hest_notify_types
{
509 ACPI_HEST_NOTIFY_POLLED
= 0,
510 ACPI_HEST_NOTIFY_EXTERNAL
= 1,
511 ACPI_HEST_NOTIFY_LOCAL
= 2,
512 ACPI_HEST_NOTIFY_SCI
= 3,
513 ACPI_HEST_NOTIFY_NMI
= 4,
514 ACPI_HEST_NOTIFY_CMCI
= 5, /* ACPI 5.0 */
515 ACPI_HEST_NOTIFY_MCE
= 6, /* ACPI 5.0 */
516 ACPI_HEST_NOTIFY_GPIO
= 7, /* ACPI 6.0 */
517 ACPI_HEST_NOTIFY_SEA
= 8, /* ACPI 6.1 */
518 ACPI_HEST_NOTIFY_SEI
= 9, /* ACPI 6.1 */
519 ACPI_HEST_NOTIFY_GSIV
= 10, /* ACPI 6.1 */
520 ACPI_HEST_NOTIFY_SOFTWARE_DELEGATED
= 11, /* ACPI 6.2 */
521 ACPI_HEST_NOTIFY_RESERVED
= 12 /* 12 and greater are reserved */
524 /* Values for config_write_enable bitfield above */
526 #define ACPI_HEST_TYPE (1)
527 #define ACPI_HEST_POLL_INTERVAL (1<<1)
528 #define ACPI_HEST_POLL_THRESHOLD_VALUE (1<<2)
529 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
530 #define ACPI_HEST_ERR_THRESHOLD_VALUE (1<<4)
531 #define ACPI_HEST_ERR_THRESHOLD_WINDOW (1<<5)
537 /* 0: IA32 Machine Check Exception */
539 struct acpi_hest_ia_machine_check
{
540 struct acpi_hest_header header
;
542 u8 flags
; /* See flags ACPI_HEST_GLOBAL, etc. above */
544 u32 records_to_preallocate
;
545 u32 max_sections_per_record
;
546 u64 global_capability_data
;
547 u64 global_control_data
;
548 u8 num_hardware_banks
;
552 /* 1: IA32 Corrected Machine Check */
554 struct acpi_hest_ia_corrected
{
555 struct acpi_hest_header header
;
557 u8 flags
; /* See flags ACPI_HEST_GLOBAL, etc. above */
559 u32 records_to_preallocate
;
560 u32 max_sections_per_record
;
561 struct acpi_hest_notify notify
;
562 u8 num_hardware_banks
;
566 /* 2: IA32 Non-Maskable Interrupt */
568 struct acpi_hest_ia_nmi
{
569 struct acpi_hest_header header
;
571 u32 records_to_preallocate
;
572 u32 max_sections_per_record
;
573 u32 max_raw_data_length
;
576 /* 3,4,5: Not used */
578 /* 6: PCI Express Root Port AER */
580 struct acpi_hest_aer_root
{
581 struct acpi_hest_header header
;
582 struct acpi_hest_aer_common aer
;
583 u32 root_error_command
;
586 /* 7: PCI Express AER (AER Endpoint) */
588 struct acpi_hest_aer
{
589 struct acpi_hest_header header
;
590 struct acpi_hest_aer_common aer
;
593 /* 8: PCI Express/PCI-X Bridge AER */
595 struct acpi_hest_aer_bridge
{
596 struct acpi_hest_header header
;
597 struct acpi_hest_aer_common aer
;
598 u32 uncorrectable_mask2
;
599 u32 uncorrectable_severity2
;
600 u32 advanced_capabilities2
;
603 /* 9: Generic Hardware Error Source */
605 struct acpi_hest_generic
{
606 struct acpi_hest_header header
;
607 u16 related_source_id
;
610 u32 records_to_preallocate
;
611 u32 max_sections_per_record
;
612 u32 max_raw_data_length
;
613 struct acpi_generic_address error_status_address
;
614 struct acpi_hest_notify notify
;
615 u32 error_block_length
;
618 /* 10: Generic Hardware Error Source, version 2 */
620 struct acpi_hest_generic_v2
{
621 struct acpi_hest_header header
;
622 u16 related_source_id
;
625 u32 records_to_preallocate
;
626 u32 max_sections_per_record
;
627 u32 max_raw_data_length
;
628 struct acpi_generic_address error_status_address
;
629 struct acpi_hest_notify notify
;
630 u32 error_block_length
;
631 struct acpi_generic_address read_ack_register
;
632 u64 read_ack_preserve
;
636 /* Generic Error Status block */
638 struct acpi_hest_generic_status
{
646 /* Values for block_status flags above */
648 #define ACPI_HEST_UNCORRECTABLE (1)
649 #define ACPI_HEST_CORRECTABLE (1<<1)
650 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE (1<<2)
651 #define ACPI_HEST_MULTIPLE_CORRECTABLE (1<<3)
652 #define ACPI_HEST_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
654 /* Generic Error Data entry */
656 struct acpi_hest_generic_data
{
662 u32 error_data_length
;
667 /* Extension for revision 0x0300 */
669 struct acpi_hest_generic_data_v300
{
675 u32 error_data_length
;
681 /* Values for error_severity above */
683 #define ACPI_HEST_GEN_ERROR_RECOVERABLE 0
684 #define ACPI_HEST_GEN_ERROR_FATAL 1
685 #define ACPI_HEST_GEN_ERROR_CORRECTED 2
686 #define ACPI_HEST_GEN_ERROR_NONE 3
688 /* Flags for validation_bits above */
690 #define ACPI_HEST_GEN_VALID_FRU_ID (1)
691 #define ACPI_HEST_GEN_VALID_FRU_STRING (1<<1)
692 #define ACPI_HEST_GEN_VALID_TIMESTAMP (1<<2)
694 /* 11: IA32 Deferred Machine Check Exception (ACPI 6.2) */
696 struct acpi_hest_ia_deferred_check
{
697 struct acpi_hest_header header
;
699 u8 flags
; /* See flags ACPI_HEST_GLOBAL, etc. above */
701 u32 records_to_preallocate
;
702 u32 max_sections_per_record
;
703 struct acpi_hest_notify notify
;
704 u8 num_hardware_banks
;
708 /*******************************************************************************
710 * HMAT - Heterogeneous Memory Attributes Table (ACPI 6.2)
713 ******************************************************************************/
715 struct acpi_table_hmat
{
716 struct acpi_table_header header
; /* Common ACPI table header */
720 /* Values for HMAT structure types */
722 enum acpi_hmat_type
{
723 ACPI_HMAT_TYPE_ADDRESS_RANGE
= 0, /* Memory subystem address range */
724 ACPI_HMAT_TYPE_LOCALITY
= 1, /* System locality latency and bandwidth information */
725 ACPI_HMAT_TYPE_CACHE
= 2, /* Memory side cache information */
726 ACPI_HMAT_TYPE_RESERVED
= 3 /* 3 and greater are reserved */
729 struct acpi_hmat_structure
{
736 * HMAT Structures, correspond to Type in struct acpi_hmat_structure
739 /* 0: Memory subystem address range */
741 struct acpi_hmat_address_range
{
742 struct acpi_hmat_structure header
;
745 u32 processor_PD
; /* Processor proximity domain */
746 u32 memory_PD
; /* Memory proximity domain */
748 u64 physical_address_base
; /* Physical address range base */
749 u64 physical_address_length
; /* Physical address range length */
752 /* Masks for Flags field above */
754 #define ACPI_HMAT_PROCESSOR_PD_VALID (1) /* 1: processor_PD field is valid */
755 #define ACPI_HMAT_MEMORY_PD_VALID (1<<1) /* 1: memory_PD field is valid */
756 #define ACPI_HMAT_RESERVATION_HINT (1<<2) /* 1: Reservation hint */
758 /* 1: System locality latency and bandwidth information */
760 struct acpi_hmat_locality
{
761 struct acpi_hmat_structure header
;
765 u32 number_of_initiator_Pds
;
766 u32 number_of_target_Pds
;
771 /* Masks for Flags field above */
773 #define ACPI_HMAT_MEMORY_HIERARCHY (0x0F)
775 /* Values for Memory Hierarchy flag */
777 #define ACPI_HMAT_MEMORY 0
778 #define ACPI_HMAT_LAST_LEVEL_CACHE 1
779 #define ACPI_HMAT_1ST_LEVEL_CACHE 2
780 #define ACPI_HMAT_2ND_LEVEL_CACHE 3
781 #define ACPI_HMAT_3RD_LEVEL_CACHE 4
783 /* Values for data_type field above */
785 #define ACPI_HMAT_ACCESS_LATENCY 0
786 #define ACPI_HMAT_READ_LATENCY 1
787 #define ACPI_HMAT_WRITE_LATENCY 2
788 #define ACPI_HMAT_ACCESS_BANDWIDTH 3
789 #define ACPI_HMAT_READ_BANDWIDTH 4
790 #define ACPI_HMAT_WRITE_BANDWIDTH 5
792 /* 2: Memory side cache information */
794 struct acpi_hmat_cache
{
795 struct acpi_hmat_structure header
;
799 u32 cache_attributes
;
801 u16 number_of_SMBIOShandles
;
804 /* Masks for cache_attributes field above */
806 #define ACPI_HMAT_TOTAL_CACHE_LEVEL (0x0000000F)
807 #define ACPI_HMAT_CACHE_LEVEL (0x000000F0)
808 #define ACPI_HMAT_CACHE_ASSOCIATIVITY (0x00000F00)
809 #define ACPI_HMAT_WRITE_POLICY (0x0000F000)
810 #define ACPI_HMAT_CACHE_LINE_SIZE (0xFFFF0000)
812 /* Values for cache associativity flag */
814 #define ACPI_HMAT_CA_NONE (0)
815 #define ACPI_HMAT_CA_DIRECT_MAPPED (1)
816 #define ACPI_HMAT_CA_COMPLEX_CACHE_INDEXING (2)
818 /* Values for write policy flag */
820 #define ACPI_HMAT_CP_NONE (0)
821 #define ACPI_HMAT_CP_WB (1)
822 #define ACPI_HMAT_CP_WT (2)
824 /*******************************************************************************
826 * MADT - Multiple APIC Description Table
829 ******************************************************************************/
831 struct acpi_table_madt
{
832 struct acpi_table_header header
; /* Common ACPI table header */
833 u32 address
; /* Physical address of local APIC */
837 /* Masks for Flags field above */
839 #define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
841 /* Values for PCATCompat flag */
843 #define ACPI_MADT_DUAL_PIC 1
844 #define ACPI_MADT_MULTIPLE_APIC 0
846 /* Values for MADT subtable type in struct acpi_subtable_header */
848 enum acpi_madt_type
{
849 ACPI_MADT_TYPE_LOCAL_APIC
= 0,
850 ACPI_MADT_TYPE_IO_APIC
= 1,
851 ACPI_MADT_TYPE_INTERRUPT_OVERRIDE
= 2,
852 ACPI_MADT_TYPE_NMI_SOURCE
= 3,
853 ACPI_MADT_TYPE_LOCAL_APIC_NMI
= 4,
854 ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE
= 5,
855 ACPI_MADT_TYPE_IO_SAPIC
= 6,
856 ACPI_MADT_TYPE_LOCAL_SAPIC
= 7,
857 ACPI_MADT_TYPE_INTERRUPT_SOURCE
= 8,
858 ACPI_MADT_TYPE_LOCAL_X2APIC
= 9,
859 ACPI_MADT_TYPE_LOCAL_X2APIC_NMI
= 10,
860 ACPI_MADT_TYPE_GENERIC_INTERRUPT
= 11,
861 ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR
= 12,
862 ACPI_MADT_TYPE_GENERIC_MSI_FRAME
= 13,
863 ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR
= 14,
864 ACPI_MADT_TYPE_GENERIC_TRANSLATOR
= 15,
865 ACPI_MADT_TYPE_RESERVED
= 16 /* 16 and greater are reserved */
869 * MADT Subtables, correspond to Type in struct acpi_subtable_header
872 /* 0: Processor Local APIC */
874 struct acpi_madt_local_apic
{
875 struct acpi_subtable_header header
;
876 u8 processor_id
; /* ACPI processor id */
877 u8 id
; /* Processor's local APIC id */
883 struct acpi_madt_io_apic
{
884 struct acpi_subtable_header header
;
885 u8 id
; /* I/O APIC ID */
886 u8 reserved
; /* reserved - must be zero */
887 u32 address
; /* APIC physical address */
888 u32 global_irq_base
; /* Global system interrupt where INTI lines start */
891 /* 2: Interrupt Override */
893 struct acpi_madt_interrupt_override
{
894 struct acpi_subtable_header header
;
895 u8 bus
; /* 0 - ISA */
896 u8 source_irq
; /* Interrupt source (IRQ) */
897 u32 global_irq
; /* Global system interrupt */
903 struct acpi_madt_nmi_source
{
904 struct acpi_subtable_header header
;
906 u32 global_irq
; /* Global system interrupt */
909 /* 4: Local APIC NMI */
911 struct acpi_madt_local_apic_nmi
{
912 struct acpi_subtable_header header
;
913 u8 processor_id
; /* ACPI processor id */
915 u8 lint
; /* LINTn to which NMI is connected */
918 /* 5: Address Override */
920 struct acpi_madt_local_apic_override
{
921 struct acpi_subtable_header header
;
922 u16 reserved
; /* Reserved, must be zero */
923 u64 address
; /* APIC physical address */
928 struct acpi_madt_io_sapic
{
929 struct acpi_subtable_header header
;
930 u8 id
; /* I/O SAPIC ID */
931 u8 reserved
; /* Reserved, must be zero */
932 u32 global_irq_base
; /* Global interrupt for SAPIC start */
933 u64 address
; /* SAPIC physical address */
938 struct acpi_madt_local_sapic
{
939 struct acpi_subtable_header header
;
940 u8 processor_id
; /* ACPI processor id */
941 u8 id
; /* SAPIC ID */
942 u8 eid
; /* SAPIC EID */
943 u8 reserved
[3]; /* Reserved, must be zero */
945 u32 uid
; /* Numeric UID - ACPI 3.0 */
946 char uid_string
[1]; /* String UID - ACPI 3.0 */
949 /* 8: Platform Interrupt Source */
951 struct acpi_madt_interrupt_source
{
952 struct acpi_subtable_header header
;
954 u8 type
; /* 1=PMI, 2=INIT, 3=corrected */
955 u8 id
; /* Processor ID */
956 u8 eid
; /* Processor EID */
957 u8 io_sapic_vector
; /* Vector value for PMI interrupts */
958 u32 global_irq
; /* Global system interrupt */
959 u32 flags
; /* Interrupt Source Flags */
962 /* Masks for Flags field above */
964 #define ACPI_MADT_CPEI_OVERRIDE (1)
966 /* 9: Processor Local X2APIC (ACPI 4.0) */
968 struct acpi_madt_local_x2apic
{
969 struct acpi_subtable_header header
;
970 u16 reserved
; /* reserved - must be zero */
971 u32 local_apic_id
; /* Processor x2APIC ID */
973 u32 uid
; /* ACPI processor UID */
976 /* 10: Local X2APIC NMI (ACPI 4.0) */
978 struct acpi_madt_local_x2apic_nmi
{
979 struct acpi_subtable_header header
;
981 u32 uid
; /* ACPI processor UID */
982 u8 lint
; /* LINTn to which NMI is connected */
983 u8 reserved
[3]; /* reserved - must be zero */
986 /* 11: Generic Interrupt (ACPI 5.0 + ACPI 6.0 changes) */
988 struct acpi_madt_generic_interrupt
{
989 struct acpi_subtable_header header
;
990 u16 reserved
; /* reserved - must be zero */
991 u32 cpu_interface_number
;
995 u32 performance_interrupt
;
998 u64 gicv_base_address
;
999 u64 gich_base_address
;
1001 u64 gicr_base_address
;
1003 u8 efficiency_class
;
1007 /* Masks for Flags field above */
1009 /* ACPI_MADT_ENABLED (1) Processor is usable if set */
1010 #define ACPI_MADT_PERFORMANCE_IRQ_MODE (1<<1) /* 01: Performance Interrupt Mode */
1011 #define ACPI_MADT_VGIC_IRQ_MODE (1<<2) /* 02: VGIC Maintenance Interrupt mode */
1013 /* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
1015 struct acpi_madt_generic_distributor
{
1016 struct acpi_subtable_header header
;
1017 u16 reserved
; /* reserved - must be zero */
1020 u32 global_irq_base
;
1022 u8 reserved2
[3]; /* reserved - must be zero */
1025 /* Values for Version field above */
1027 enum acpi_madt_gic_version
{
1028 ACPI_MADT_GIC_VERSION_NONE
= 0,
1029 ACPI_MADT_GIC_VERSION_V1
= 1,
1030 ACPI_MADT_GIC_VERSION_V2
= 2,
1031 ACPI_MADT_GIC_VERSION_V3
= 3,
1032 ACPI_MADT_GIC_VERSION_V4
= 4,
1033 ACPI_MADT_GIC_VERSION_RESERVED
= 5 /* 5 and greater are reserved */
1036 /* 13: Generic MSI Frame (ACPI 5.1) */
1038 struct acpi_madt_generic_msi_frame
{
1039 struct acpi_subtable_header header
;
1040 u16 reserved
; /* reserved - must be zero */
1048 /* Masks for Flags field above */
1050 #define ACPI_MADT_OVERRIDE_SPI_VALUES (1)
1052 /* 14: Generic Redistributor (ACPI 5.1) */
1054 struct acpi_madt_generic_redistributor
{
1055 struct acpi_subtable_header header
;
1056 u16 reserved
; /* reserved - must be zero */
1061 /* 15: Generic Translator (ACPI 6.0) */
1063 struct acpi_madt_generic_translator
{
1064 struct acpi_subtable_header header
;
1065 u16 reserved
; /* reserved - must be zero */
1072 * Common flags fields for MADT subtables
1075 /* MADT Local APIC flags */
1077 #define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
1079 /* MADT MPS INTI flags (inti_flags) */
1081 #define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
1082 #define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
1084 /* Values for MPS INTI flags */
1086 #define ACPI_MADT_POLARITY_CONFORMS 0
1087 #define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
1088 #define ACPI_MADT_POLARITY_RESERVED 2
1089 #define ACPI_MADT_POLARITY_ACTIVE_LOW 3
1091 #define ACPI_MADT_TRIGGER_CONFORMS (0)
1092 #define ACPI_MADT_TRIGGER_EDGE (1<<2)
1093 #define ACPI_MADT_TRIGGER_RESERVED (2<<2)
1094 #define ACPI_MADT_TRIGGER_LEVEL (3<<2)
1096 /*******************************************************************************
1098 * MSCT - Maximum System Characteristics Table (ACPI 4.0)
1101 ******************************************************************************/
1103 struct acpi_table_msct
{
1104 struct acpi_table_header header
; /* Common ACPI table header */
1105 u32 proximity_offset
; /* Location of proximity info struct(s) */
1106 u32 max_proximity_domains
; /* Max number of proximity domains */
1107 u32 max_clock_domains
; /* Max number of clock domains */
1108 u64 max_address
; /* Max physical address in system */
1111 /* subtable - Maximum Proximity Domain Information. Version 1 */
1113 struct acpi_msct_proximity
{
1116 u32 range_start
; /* Start of domain range */
1117 u32 range_end
; /* End of domain range */
1118 u32 processor_capacity
;
1119 u64 memory_capacity
; /* In bytes */
1122 /*******************************************************************************
1124 * NFIT - NVDIMM Interface Table (ACPI 6.0+)
1127 ******************************************************************************/
1129 struct acpi_table_nfit
{
1130 struct acpi_table_header header
; /* Common ACPI table header */
1131 u32 reserved
; /* Reserved, must be zero */
1134 /* Subtable header for NFIT */
1136 struct acpi_nfit_header
{
1141 /* Values for subtable type in struct acpi_nfit_header */
1143 enum acpi_nfit_type
{
1144 ACPI_NFIT_TYPE_SYSTEM_ADDRESS
= 0,
1145 ACPI_NFIT_TYPE_MEMORY_MAP
= 1,
1146 ACPI_NFIT_TYPE_INTERLEAVE
= 2,
1147 ACPI_NFIT_TYPE_SMBIOS
= 3,
1148 ACPI_NFIT_TYPE_CONTROL_REGION
= 4,
1149 ACPI_NFIT_TYPE_DATA_REGION
= 5,
1150 ACPI_NFIT_TYPE_FLUSH_ADDRESS
= 6,
1151 ACPI_NFIT_TYPE_RESERVED
= 7 /* 7 and greater are reserved */
1158 /* 0: System Physical Address Range Structure */
1160 struct acpi_nfit_system_address
{
1161 struct acpi_nfit_header header
;
1164 u32 reserved
; /* Reseved, must be zero */
1165 u32 proximity_domain
;
1174 #define ACPI_NFIT_ADD_ONLINE_ONLY (1) /* 00: Add/Online Operation Only */
1175 #define ACPI_NFIT_PROXIMITY_VALID (1<<1) /* 01: Proximity Domain Valid */
1177 /* Range Type GUIDs appear in the include/acuuid.h file */
1179 /* 1: Memory Device to System Address Range Map Structure */
1181 struct acpi_nfit_memory_map
{
1182 struct acpi_nfit_header header
;
1191 u16 interleave_index
;
1192 u16 interleave_ways
;
1194 u16 reserved
; /* Reserved, must be zero */
1199 #define ACPI_NFIT_MEM_SAVE_FAILED (1) /* 00: Last SAVE to Memory Device failed */
1200 #define ACPI_NFIT_MEM_RESTORE_FAILED (1<<1) /* 01: Last RESTORE from Memory Device failed */
1201 #define ACPI_NFIT_MEM_FLUSH_FAILED (1<<2) /* 02: Platform flush failed */
1202 #define ACPI_NFIT_MEM_NOT_ARMED (1<<3) /* 03: Memory Device is not armed */
1203 #define ACPI_NFIT_MEM_HEALTH_OBSERVED (1<<4) /* 04: Memory Device observed SMART/health events */
1204 #define ACPI_NFIT_MEM_HEALTH_ENABLED (1<<5) /* 05: SMART/health events enabled */
1205 #define ACPI_NFIT_MEM_MAP_FAILED (1<<6) /* 06: Mapping to SPA failed */
1207 /* 2: Interleave Structure */
1209 struct acpi_nfit_interleave
{
1210 struct acpi_nfit_header header
;
1211 u16 interleave_index
;
1212 u16 reserved
; /* Reserved, must be zero */
1215 u32 line_offset
[1]; /* Variable length */
1218 /* 3: SMBIOS Management Information Structure */
1220 struct acpi_nfit_smbios
{
1221 struct acpi_nfit_header header
;
1222 u32 reserved
; /* Reserved, must be zero */
1223 u8 data
[1]; /* Variable length */
1226 /* 4: NVDIMM Control Region Structure */
1228 struct acpi_nfit_control_region
{
1229 struct acpi_nfit_header header
;
1234 u16 subsystem_vendor_id
;
1235 u16 subsystem_device_id
;
1236 u16 subsystem_revision_id
;
1238 u8 manufacturing_location
;
1239 u16 manufacturing_date
;
1240 u8 reserved
[2]; /* Reserved, must be zero */
1250 u8 reserved1
[6]; /* Reserved, must be zero */
1255 #define ACPI_NFIT_CONTROL_BUFFERED (1) /* Block Data Windows implementation is buffered */
1257 /* valid_fields bits */
1259 #define ACPI_NFIT_CONTROL_MFG_INFO_VALID (1) /* Manufacturing fields are valid */
1261 /* 5: NVDIMM Block Data Window Region Structure */
1263 struct acpi_nfit_data_region
{
1264 struct acpi_nfit_header header
;
1273 /* 6: Flush Hint Address Structure */
1275 struct acpi_nfit_flush_address
{
1276 struct acpi_nfit_header header
;
1279 u8 reserved
[6]; /* Reserved, must be zero */
1280 u64 hint_address
[1]; /* Variable length */
1283 /*******************************************************************************
1285 * PPTT - Processor Properties Topology Table (ACPI 6.2)
1288 ******************************************************************************/
1290 struct acpi_table_pptt
{
1291 struct acpi_table_header header
; /* Common ACPI table header */
1294 /* Values for Type field above */
1296 enum acpi_pptt_type
{
1297 ACPI_PPTT_TYPE_PROCESSOR
= 0,
1298 ACPI_PPTT_TYPE_CACHE
= 1,
1299 ACPI_PPTT_TYPE_ID
= 2,
1300 ACPI_PPTT_TYPE_RESERVED
= 3
1303 /* 0: Processor Hierarchy Node Structure */
1305 struct acpi_pptt_processor
{
1306 struct acpi_subtable_header header
;
1310 u32 acpi_processor_id
;
1311 u32 number_of_priv_resources
;
1316 #define ACPI_PPTT_PHYSICAL_PACKAGE (1) /* Physical package */
1317 #define ACPI_PPTT_ACPI_PROCESSOR_ID_VALID (2) /* ACPI Processor ID valid */
1319 /* 1: Cache Type Structure */
1321 struct acpi_pptt_cache
{
1322 struct acpi_subtable_header header
;
1325 u32 next_level_of_cache
;
1335 #define ACPI_PPTT_SIZE_PROPERTY_VALID (1) /* Physical property valid */
1336 #define ACPI_PPTT_NUMBER_OF_SETS_VALID (1<<1) /* Number of sets valid */
1337 #define ACPI_PPTT_ASSOCIATIVITY_VALID (1<<2) /* Associativity valid */
1338 #define ACPI_PPTT_ALLOCATION_TYPE_VALID (1<<3) /* Allocation type valid */
1339 #define ACPI_PPTT_CACHE_TYPE_VALID (1<<4) /* Cache type valid */
1340 #define ACPI_PPTT_WRITE_POLICY_VALID (1<<5) /* Write policy valid */
1341 #define ACPI_PPTT_LINE_SIZE_VALID (1<<6) /* Line size valid */
1343 /* Masks for Attributes */
1345 #define ACPI_PPTT_MASK_ALLOCATION_TYPE (0x03) /* Allocation type */
1346 #define ACPI_PPTT_MASK_CACHE_TYPE (0x0C) /* Cache type */
1347 #define ACPI_PPTT_MASK_WRITE_POLICY (0x10) /* Write policy */
1349 /* 2: ID Structure */
1351 struct acpi_pptt_id
{
1352 struct acpi_subtable_header header
;
1362 /*******************************************************************************
1364 * SBST - Smart Battery Specification Table
1367 ******************************************************************************/
1369 struct acpi_table_sbst
{
1370 struct acpi_table_header header
; /* Common ACPI table header */
1376 /*******************************************************************************
1378 * SLIT - System Locality Distance Information Table
1381 ******************************************************************************/
1383 struct acpi_table_slit
{
1384 struct acpi_table_header header
; /* Common ACPI table header */
1386 u8 entry
[1]; /* Real size = localities^2 */
1389 /*******************************************************************************
1391 * SRAT - System Resource Affinity Table
1394 ******************************************************************************/
1396 struct acpi_table_srat
{
1397 struct acpi_table_header header
; /* Common ACPI table header */
1398 u32 table_revision
; /* Must be value '1' */
1399 u64 reserved
; /* Reserved, must be zero */
1402 /* Values for subtable type in struct acpi_subtable_header */
1404 enum acpi_srat_type
{
1405 ACPI_SRAT_TYPE_CPU_AFFINITY
= 0,
1406 ACPI_SRAT_TYPE_MEMORY_AFFINITY
= 1,
1407 ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY
= 2,
1408 ACPI_SRAT_TYPE_GICC_AFFINITY
= 3,
1409 ACPI_SRAT_TYPE_GIC_ITS_AFFINITY
= 4, /* ACPI 6.2 */
1410 ACPI_SRAT_TYPE_RESERVED
= 5 /* 5 and greater are reserved */
1414 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
1417 /* 0: Processor Local APIC/SAPIC Affinity */
1419 struct acpi_srat_cpu_affinity
{
1420 struct acpi_subtable_header header
;
1421 u8 proximity_domain_lo
;
1425 u8 proximity_domain_hi
[3];
1431 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
1433 /* 1: Memory Affinity */
1435 struct acpi_srat_mem_affinity
{
1436 struct acpi_subtable_header header
;
1437 u32 proximity_domain
;
1438 u16 reserved
; /* Reserved, must be zero */
1443 u64 reserved2
; /* Reserved, must be zero */
1448 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
1449 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
1450 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
1452 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
1454 struct acpi_srat_x2apic_cpu_affinity
{
1455 struct acpi_subtable_header header
;
1456 u16 reserved
; /* Reserved, must be zero */
1457 u32 proximity_domain
;
1464 /* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
1466 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
1468 /* 3: GICC Affinity (ACPI 5.1) */
1470 struct acpi_srat_gicc_affinity
{
1471 struct acpi_subtable_header header
;
1472 u32 proximity_domain
;
1473 u32 acpi_processor_uid
;
1478 /* Flags for struct acpi_srat_gicc_affinity */
1480 #define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
1482 /* 4: GCC ITS Affinity (ACPI 6.2) */
1484 struct acpi_srat_gic_its_affinity
{
1485 struct acpi_subtable_header header
;
1486 u32 proximity_domain
;
1491 /* Reset to default packing */
1495 #endif /* __ACTBL1_H__ */