1 /******************************************************************************
3 * Name: actbl1.h - Additional 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.
48 /*******************************************************************************
50 * Additional ACPI Tables (1)
52 * These tables are not consumed directly by the ACPICA subsystem, but are
53 * included here to support device drivers and the AML disassembler.
55 * The tables in this file are fully defined within the ACPI specification.
57 ******************************************************************************/
61 * Values for description table header signatures for tables defined in this
62 * file. Useful because they make it more difficult to inadvertently type in
63 * the wrong signature.
65 #define ACPI_SIG_BERT "BERT" /* Boot Error Record Table */
66 #define ACPI_SIG_CPEP "CPEP" /* Corrected Platform Error Polling table */
67 #define ACPI_SIG_ECDT "ECDT" /* Embedded Controller Boot Resources Table */
68 #define ACPI_SIG_EINJ "EINJ" /* Error Injection table */
69 #define ACPI_SIG_ERST "ERST" /* Error Record Serialization Table */
70 #define ACPI_SIG_HEST "HEST" /* Hardware Error Source Table */
71 #define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
72 #define ACPI_SIG_MSCT "MSCT" /* Maximum System Characteristics 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 */
80 * All tables must be byte-packed to match the ACPI specification, since
81 * the tables are provided by the system BIOS.
86 * Note: C bitfields are not used for this reason:
88 * "Bitfields are great and easy to read, but unfortunately the C language
89 * does not specify the layout of bitfields in memory, which means they are
90 * essentially useless for dealing with packed data in on-disk formats or
91 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
92 * this decision was a design error in C. Ritchie could have picked an order
93 * and stuck with it." Norman Ramsey.
94 * See http://stackoverflow.com/a/1053662/41661
98 /*******************************************************************************
100 * Common subtable headers
102 ******************************************************************************/
104 /* Generic subtable header (used in MADT, SRAT, etc.) */
106 typedef struct acpi_subtable_header
111 } ACPI_SUBTABLE_HEADER;
114 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
116 typedef struct acpi_whea_header
122 ACPI_GENERIC_ADDRESS RegisterRegion;
123 UINT64 Value; /* Value used with Read/Write register */
124 UINT64 Mask; /* Bitmask required for this register instruction */
129 /*******************************************************************************
131 * BERT - Boot Error Record Table (ACPI 4.0)
134 ******************************************************************************/
136 typedef struct acpi_table_bert
138 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
139 UINT32 RegionLength; /* Length of the boot error region */
140 UINT64 Address; /* Physical address of the error region */
145 /* Boot Error Region (not a subtable, pointed to by Address field above) */
147 typedef struct acpi_bert_region
149 UINT32 BlockStatus; /* Type of error information */
150 UINT32 RawDataOffset; /* Offset to raw error data */
151 UINT32 RawDataLength; /* Length of raw error data */
152 UINT32 DataLength; /* Length of generic error data */
153 UINT32 ErrorSeverity; /* Severity code */
157 /* Values for BlockStatus flags above */
159 #define ACPI_BERT_UNCORRECTABLE (1)
160 #define ACPI_BERT_CORRECTABLE (1<<1)
161 #define ACPI_BERT_MULTIPLE_UNCORRECTABLE (1<<2)
162 #define ACPI_BERT_MULTIPLE_CORRECTABLE (1<<3)
163 #define ACPI_BERT_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
165 /* Values for ErrorSeverity above */
167 enum AcpiBertErrorSeverity
169 ACPI_BERT_ERROR_CORRECTABLE = 0,
170 ACPI_BERT_ERROR_FATAL = 1,
171 ACPI_BERT_ERROR_CORRECTED = 2,
172 ACPI_BERT_ERROR_NONE = 3,
173 ACPI_BERT_ERROR_RESERVED = 4 /* 4 and greater are reserved */
177 * Note: The generic error data that follows the ErrorSeverity field above
178 * uses the ACPI_HEST_GENERIC_DATA defined under the HEST table below
182 /*******************************************************************************
184 * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
187 ******************************************************************************/
189 typedef struct acpi_table_cpep
191 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
199 typedef struct acpi_cpep_polling
201 ACPI_SUBTABLE_HEADER Header;
202 UINT8 Id; /* Processor ID */
203 UINT8 Eid; /* Processor EID */
204 UINT32 Interval; /* Polling interval (msec) */
209 /*******************************************************************************
211 * ECDT - Embedded Controller Boot Resources Table
214 ******************************************************************************/
216 typedef struct acpi_table_ecdt
218 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
219 ACPI_GENERIC_ADDRESS Control; /* Address of EC command/status register */
220 ACPI_GENERIC_ADDRESS Data; /* Address of EC data register */
221 UINT32 Uid; /* Unique ID - must be same as the EC _UID method */
222 UINT8 Gpe; /* The GPE for the EC */
223 UINT8 Id[1]; /* Full namepath of the EC in the ACPI namespace */
228 /*******************************************************************************
230 * EINJ - Error Injection Table (ACPI 4.0)
233 ******************************************************************************/
235 typedef struct acpi_table_einj
237 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
246 /* EINJ Injection Instruction Entries (actions) */
248 typedef struct acpi_einj_entry
250 ACPI_WHEA_HEADER WheaHeader; /* Common header for WHEA tables */
254 /* Masks for Flags field above */
256 #define ACPI_EINJ_PRESERVE (1)
258 /* Values for Action field above */
262 ACPI_EINJ_BEGIN_OPERATION = 0,
263 ACPI_EINJ_GET_TRIGGER_TABLE = 1,
264 ACPI_EINJ_SET_ERROR_TYPE = 2,
265 ACPI_EINJ_GET_ERROR_TYPE = 3,
266 ACPI_EINJ_END_OPERATION = 4,
267 ACPI_EINJ_EXECUTE_OPERATION = 5,
268 ACPI_EINJ_CHECK_BUSY_STATUS = 6,
269 ACPI_EINJ_GET_COMMAND_STATUS = 7,
270 ACPI_EINJ_SET_ERROR_TYPE_WITH_ADDRESS = 8,
271 ACPI_EINJ_ACTION_RESERVED = 9, /* 9 and greater are reserved */
272 ACPI_EINJ_TRIGGER_ERROR = 0xFF /* Except for this value */
275 /* Values for Instruction field above */
277 enum AcpiEinjInstructions
279 ACPI_EINJ_READ_REGISTER = 0,
280 ACPI_EINJ_READ_REGISTER_VALUE = 1,
281 ACPI_EINJ_WRITE_REGISTER = 2,
282 ACPI_EINJ_WRITE_REGISTER_VALUE = 3,
284 ACPI_EINJ_FLUSH_CACHELINE = 5,
285 ACPI_EINJ_INSTRUCTION_RESERVED = 6 /* 6 and greater are reserved */
288 typedef struct acpi_einj_error_type_with_addr
291 UINT32 VendorStructOffset;
298 } ACPI_EINJ_ERROR_TYPE_WITH_ADDR;
300 typedef struct acpi_einj_vendor
312 /* EINJ Trigger Error Action Table */
314 typedef struct acpi_einj_trigger
323 /* Command status return values */
325 enum AcpiEinjCommandStatus
327 ACPI_EINJ_SUCCESS = 0,
328 ACPI_EINJ_FAILURE = 1,
329 ACPI_EINJ_INVALID_ACCESS = 2,
330 ACPI_EINJ_STATUS_RESERVED = 3 /* 3 and greater are reserved */
334 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
336 #define ACPI_EINJ_PROCESSOR_CORRECTABLE (1)
337 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE (1<<1)
338 #define ACPI_EINJ_PROCESSOR_FATAL (1<<2)
339 #define ACPI_EINJ_MEMORY_CORRECTABLE (1<<3)
340 #define ACPI_EINJ_MEMORY_UNCORRECTABLE (1<<4)
341 #define ACPI_EINJ_MEMORY_FATAL (1<<5)
342 #define ACPI_EINJ_PCIX_CORRECTABLE (1<<6)
343 #define ACPI_EINJ_PCIX_UNCORRECTABLE (1<<7)
344 #define ACPI_EINJ_PCIX_FATAL (1<<8)
345 #define ACPI_EINJ_PLATFORM_CORRECTABLE (1<<9)
346 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE (1<<10)
347 #define ACPI_EINJ_PLATFORM_FATAL (1<<11)
348 #define ACPI_EINJ_VENDOR_DEFINED (1<<31)
351 /*******************************************************************************
353 * ERST - Error Record Serialization Table (ACPI 4.0)
356 ******************************************************************************/
358 typedef struct acpi_table_erst
360 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
368 /* ERST Serialization Entries (actions) */
370 typedef struct acpi_erst_entry
372 ACPI_WHEA_HEADER WheaHeader; /* Common header for WHEA tables */
376 /* Masks for Flags field above */
378 #define ACPI_ERST_PRESERVE (1)
380 /* Values for Action field above */
384 ACPI_ERST_BEGIN_WRITE = 0,
385 ACPI_ERST_BEGIN_READ = 1,
386 ACPI_ERST_BEGIN_CLEAR = 2,
388 ACPI_ERST_SET_RECORD_OFFSET = 4,
389 ACPI_ERST_EXECUTE_OPERATION = 5,
390 ACPI_ERST_CHECK_BUSY_STATUS = 6,
391 ACPI_ERST_GET_COMMAND_STATUS = 7,
392 ACPI_ERST_GET_RECORD_ID = 8,
393 ACPI_ERST_SET_RECORD_ID = 9,
394 ACPI_ERST_GET_RECORD_COUNT = 10,
395 ACPI_ERST_BEGIN_DUMMY_WRIITE = 11,
396 ACPI_ERST_NOT_USED = 12,
397 ACPI_ERST_GET_ERROR_RANGE = 13,
398 ACPI_ERST_GET_ERROR_LENGTH = 14,
399 ACPI_ERST_GET_ERROR_ATTRIBUTES = 15,
400 ACPI_ERST_ACTION_RESERVED = 16 /* 16 and greater are reserved */
403 /* Values for Instruction field above */
405 enum AcpiErstInstructions
407 ACPI_ERST_READ_REGISTER = 0,
408 ACPI_ERST_READ_REGISTER_VALUE = 1,
409 ACPI_ERST_WRITE_REGISTER = 2,
410 ACPI_ERST_WRITE_REGISTER_VALUE = 3,
412 ACPI_ERST_LOAD_VAR1 = 5,
413 ACPI_ERST_LOAD_VAR2 = 6,
414 ACPI_ERST_STORE_VAR1 = 7,
416 ACPI_ERST_SUBTRACT = 9,
417 ACPI_ERST_ADD_VALUE = 10,
418 ACPI_ERST_SUBTRACT_VALUE = 11,
419 ACPI_ERST_STALL = 12,
420 ACPI_ERST_STALL_WHILE_TRUE = 13,
421 ACPI_ERST_SKIP_NEXT_IF_TRUE = 14,
423 ACPI_ERST_SET_SRC_ADDRESS_BASE = 16,
424 ACPI_ERST_SET_DST_ADDRESS_BASE = 17,
425 ACPI_ERST_MOVE_DATA = 18,
426 ACPI_ERST_INSTRUCTION_RESERVED = 19 /* 19 and greater are reserved */
429 /* Command status return values */
431 enum AcpiErstCommandStatus
433 ACPI_ERST_SUCESS = 0,
434 ACPI_ERST_NO_SPACE = 1,
435 ACPI_ERST_NOT_AVAILABLE = 2,
436 ACPI_ERST_FAILURE = 3,
437 ACPI_ERST_RECORD_EMPTY = 4,
438 ACPI_ERST_NOT_FOUND = 5,
439 ACPI_ERST_STATUS_RESERVED = 6 /* 6 and greater are reserved */
443 /* Error Record Serialization Information */
445 typedef struct acpi_erst_info
447 UINT16 Signature; /* Should be "ER" */
453 /*******************************************************************************
455 * HEST - Hardware Error Source Table (ACPI 4.0)
458 ******************************************************************************/
460 typedef struct acpi_table_hest
462 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
463 UINT32 ErrorSourceCount;
468 /* HEST subtable header */
470 typedef struct acpi_hest_header
478 /* Values for Type field above for subtables */
482 ACPI_HEST_TYPE_IA32_CHECK = 0,
483 ACPI_HEST_TYPE_IA32_CORRECTED_CHECK = 1,
484 ACPI_HEST_TYPE_IA32_NMI = 2,
485 ACPI_HEST_TYPE_NOT_USED3 = 3,
486 ACPI_HEST_TYPE_NOT_USED4 = 4,
487 ACPI_HEST_TYPE_NOT_USED5 = 5,
488 ACPI_HEST_TYPE_AER_ROOT_PORT = 6,
489 ACPI_HEST_TYPE_AER_ENDPOINT = 7,
490 ACPI_HEST_TYPE_AER_BRIDGE = 8,
491 ACPI_HEST_TYPE_GENERIC_ERROR = 9,
492 ACPI_HEST_TYPE_RESERVED = 10 /* 10 and greater are reserved */
497 * HEST substructures contained in subtables
501 * IA32 Error Bank(s) - Follows the ACPI_HEST_IA_MACHINE_CHECK and
502 * ACPI_HEST_IA_CORRECTED structures.
504 typedef struct acpi_hest_ia_error_bank
507 UINT8 ClearStatusOnInit;
510 UINT32 ControlRegister;
512 UINT32 StatusRegister;
513 UINT32 AddressRegister;
516 } ACPI_HEST_IA_ERROR_BANK;
519 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
521 typedef struct acpi_hest_aer_common
526 UINT32 RecordsToPreallocate;
527 UINT32 MaxSectionsPerRecord;
528 UINT32 Bus; /* Bus and Segment numbers */
531 UINT16 DeviceControl;
533 UINT32 UncorrectableMask;
534 UINT32 UncorrectableSeverity;
535 UINT32 CorrectableMask;
536 UINT32 AdvancedCapabilities;
538 } ACPI_HEST_AER_COMMON;
540 /* Masks for HEST Flags fields */
542 #define ACPI_HEST_FIRMWARE_FIRST (1)
543 #define ACPI_HEST_GLOBAL (1<<1)
546 * Macros to access the bus/segment numbers in Bus field above:
547 * Bus number is encoded in bits 7:0
548 * Segment number is encoded in bits 23:8
550 #define ACPI_HEST_BUS(Bus) ((Bus) & 0xFF)
551 #define ACPI_HEST_SEGMENT(Bus) (((Bus) >> 8) & 0xFFFF)
554 /* Hardware Error Notification */
556 typedef struct acpi_hest_notify
560 UINT16 ConfigWriteEnable;
563 UINT32 PollingThresholdValue;
564 UINT32 PollingThresholdWindow;
565 UINT32 ErrorThresholdValue;
566 UINT32 ErrorThresholdWindow;
570 /* Values for Notify Type field above */
572 enum AcpiHestNotifyTypes
574 ACPI_HEST_NOTIFY_POLLED = 0,
575 ACPI_HEST_NOTIFY_EXTERNAL = 1,
576 ACPI_HEST_NOTIFY_LOCAL = 2,
577 ACPI_HEST_NOTIFY_SCI = 3,
578 ACPI_HEST_NOTIFY_NMI = 4,
579 ACPI_HEST_NOTIFY_CMCI = 5, /* ACPI 5.0 */
580 ACPI_HEST_NOTIFY_MCE = 6, /* ACPI 5.0 */
581 ACPI_HEST_NOTIFY_RESERVED = 7 /* 7 and greater are reserved */
584 /* Values for ConfigWriteEnable bitfield above */
586 #define ACPI_HEST_TYPE (1)
587 #define ACPI_HEST_POLL_INTERVAL (1<<1)
588 #define ACPI_HEST_POLL_THRESHOLD_VALUE (1<<2)
589 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
590 #define ACPI_HEST_ERR_THRESHOLD_VALUE (1<<4)
591 #define ACPI_HEST_ERR_THRESHOLD_WINDOW (1<<5)
598 /* 0: IA32 Machine Check Exception */
600 typedef struct acpi_hest_ia_machine_check
602 ACPI_HEST_HEADER Header;
606 UINT32 RecordsToPreallocate;
607 UINT32 MaxSectionsPerRecord;
608 UINT64 GlobalCapabilityData;
609 UINT64 GlobalControlData;
610 UINT8 NumHardwareBanks;
613 } ACPI_HEST_IA_MACHINE_CHECK;
616 /* 1: IA32 Corrected Machine Check */
618 typedef struct acpi_hest_ia_corrected
620 ACPI_HEST_HEADER Header;
624 UINT32 RecordsToPreallocate;
625 UINT32 MaxSectionsPerRecord;
626 ACPI_HEST_NOTIFY Notify;
627 UINT8 NumHardwareBanks;
630 } ACPI_HEST_IA_CORRECTED;
633 /* 2: IA32 Non-Maskable Interrupt */
635 typedef struct acpi_hest_ia_nmi
637 ACPI_HEST_HEADER Header;
639 UINT32 RecordsToPreallocate;
640 UINT32 MaxSectionsPerRecord;
641 UINT32 MaxRawDataLength;
646 /* 3,4,5: Not used */
648 /* 6: PCI Express Root Port AER */
650 typedef struct acpi_hest_aer_root
652 ACPI_HEST_HEADER Header;
653 ACPI_HEST_AER_COMMON Aer;
654 UINT32 RootErrorCommand;
656 } ACPI_HEST_AER_ROOT;
659 /* 7: PCI Express AER (AER Endpoint) */
661 typedef struct acpi_hest_aer
663 ACPI_HEST_HEADER Header;
664 ACPI_HEST_AER_COMMON Aer;
669 /* 8: PCI Express/PCI-X Bridge AER */
671 typedef struct acpi_hest_aer_bridge
673 ACPI_HEST_HEADER Header;
674 ACPI_HEST_AER_COMMON Aer;
675 UINT32 UncorrectableMask2;
676 UINT32 UncorrectableSeverity2;
677 UINT32 AdvancedCapabilities2;
679 } ACPI_HEST_AER_BRIDGE;
682 /* 9: Generic Hardware Error Source */
684 typedef struct acpi_hest_generic
686 ACPI_HEST_HEADER Header;
687 UINT16 RelatedSourceId;
690 UINT32 RecordsToPreallocate;
691 UINT32 MaxSectionsPerRecord;
692 UINT32 MaxRawDataLength;
693 ACPI_GENERIC_ADDRESS ErrorStatusAddress;
694 ACPI_HEST_NOTIFY Notify;
695 UINT32 ErrorBlockLength;
700 /* Generic Error Status block */
702 typedef struct acpi_hest_generic_status
705 UINT32 RawDataOffset;
706 UINT32 RawDataLength;
708 UINT32 ErrorSeverity;
710 } ACPI_HEST_GENERIC_STATUS;
712 /* Values for BlockStatus flags above */
714 #define ACPI_HEST_UNCORRECTABLE (1)
715 #define ACPI_HEST_CORRECTABLE (1<<1)
716 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE (1<<2)
717 #define ACPI_HEST_MULTIPLE_CORRECTABLE (1<<3)
718 #define ACPI_HEST_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
721 /* Generic Error Data entry */
723 typedef struct acpi_hest_generic_data
725 UINT8 SectionType[16];
726 UINT32 ErrorSeverity;
728 UINT8 ValidationBits;
730 UINT32 ErrorDataLength;
734 } ACPI_HEST_GENERIC_DATA;
737 /*******************************************************************************
739 * MADT - Multiple APIC Description Table
742 ******************************************************************************/
744 typedef struct acpi_table_madt
746 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
747 UINT32 Address; /* Physical address of local APIC */
752 /* Masks for Flags field above */
754 #define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
756 /* Values for PCATCompat flag */
758 #define ACPI_MADT_DUAL_PIC 0
759 #define ACPI_MADT_MULTIPLE_APIC 1
762 /* Values for MADT subtable type in ACPI_SUBTABLE_HEADER */
766 ACPI_MADT_TYPE_LOCAL_APIC = 0,
767 ACPI_MADT_TYPE_IO_APIC = 1,
768 ACPI_MADT_TYPE_INTERRUPT_OVERRIDE = 2,
769 ACPI_MADT_TYPE_NMI_SOURCE = 3,
770 ACPI_MADT_TYPE_LOCAL_APIC_NMI = 4,
771 ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE = 5,
772 ACPI_MADT_TYPE_IO_SAPIC = 6,
773 ACPI_MADT_TYPE_LOCAL_SAPIC = 7,
774 ACPI_MADT_TYPE_INTERRUPT_SOURCE = 8,
775 ACPI_MADT_TYPE_LOCAL_X2APIC = 9,
776 ACPI_MADT_TYPE_LOCAL_X2APIC_NMI = 10,
777 ACPI_MADT_TYPE_GENERIC_INTERRUPT = 11,
778 ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR = 12,
779 ACPI_MADT_TYPE_GENERIC_MSI_FRAME = 13,
780 ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR = 14,
781 ACPI_MADT_TYPE_GENERIC_TRANSLATOR = 15,
782 ACPI_MADT_TYPE_RESERVED = 16 /* 16 and greater are reserved */
787 * MADT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
790 /* 0: Processor Local APIC */
792 typedef struct acpi_madt_local_apic
794 ACPI_SUBTABLE_HEADER Header;
795 UINT8 ProcessorId; /* ACPI processor id */
796 UINT8 Id; /* Processor's local APIC id */
799 } ACPI_MADT_LOCAL_APIC;
804 typedef struct acpi_madt_io_apic
806 ACPI_SUBTABLE_HEADER Header;
807 UINT8 Id; /* I/O APIC ID */
808 UINT8 Reserved; /* Reserved - must be zero */
809 UINT32 Address; /* APIC physical address */
810 UINT32 GlobalIrqBase; /* Global system interrupt where INTI lines start */
815 /* 2: Interrupt Override */
817 typedef struct acpi_madt_interrupt_override
819 ACPI_SUBTABLE_HEADER Header;
820 UINT8 Bus; /* 0 - ISA */
821 UINT8 SourceIrq; /* Interrupt source (IRQ) */
822 UINT32 GlobalIrq; /* Global system interrupt */
825 } ACPI_MADT_INTERRUPT_OVERRIDE;
830 typedef struct acpi_madt_nmi_source
832 ACPI_SUBTABLE_HEADER Header;
834 UINT32 GlobalIrq; /* Global system interrupt */
836 } ACPI_MADT_NMI_SOURCE;
839 /* 4: Local APIC NMI */
841 typedef struct acpi_madt_local_apic_nmi
843 ACPI_SUBTABLE_HEADER Header;
844 UINT8 ProcessorId; /* ACPI processor id */
846 UINT8 Lint; /* LINTn to which NMI is connected */
848 } ACPI_MADT_LOCAL_APIC_NMI;
851 /* 5: Address Override */
853 typedef struct acpi_madt_local_apic_override
855 ACPI_SUBTABLE_HEADER Header;
856 UINT16 Reserved; /* Reserved, must be zero */
857 UINT64 Address; /* APIC physical address */
859 } ACPI_MADT_LOCAL_APIC_OVERRIDE;
864 typedef struct acpi_madt_io_sapic
866 ACPI_SUBTABLE_HEADER Header;
867 UINT8 Id; /* I/O SAPIC ID */
868 UINT8 Reserved; /* Reserved, must be zero */
869 UINT32 GlobalIrqBase; /* Global interrupt for SAPIC start */
870 UINT64 Address; /* SAPIC physical address */
872 } ACPI_MADT_IO_SAPIC;
877 typedef struct acpi_madt_local_sapic
879 ACPI_SUBTABLE_HEADER Header;
880 UINT8 ProcessorId; /* ACPI processor id */
881 UINT8 Id; /* SAPIC ID */
882 UINT8 Eid; /* SAPIC EID */
883 UINT8 Reserved[3]; /* Reserved, must be zero */
885 UINT32 Uid; /* Numeric UID - ACPI 3.0 */
886 char UidString[1]; /* String UID - ACPI 3.0 */
888 } ACPI_MADT_LOCAL_SAPIC;
891 /* 8: Platform Interrupt Source */
893 typedef struct acpi_madt_interrupt_source
895 ACPI_SUBTABLE_HEADER Header;
897 UINT8 Type; /* 1=PMI, 2=INIT, 3=corrected */
898 UINT8 Id; /* Processor ID */
899 UINT8 Eid; /* Processor EID */
900 UINT8 IoSapicVector; /* Vector value for PMI interrupts */
901 UINT32 GlobalIrq; /* Global system interrupt */
902 UINT32 Flags; /* Interrupt Source Flags */
904 } ACPI_MADT_INTERRUPT_SOURCE;
906 /* Masks for Flags field above */
908 #define ACPI_MADT_CPEI_OVERRIDE (1)
911 /* 9: Processor Local X2APIC (ACPI 4.0) */
913 typedef struct acpi_madt_local_x2apic
915 ACPI_SUBTABLE_HEADER Header;
916 UINT16 Reserved; /* Reserved - must be zero */
917 UINT32 LocalApicId; /* Processor x2APIC ID */
919 UINT32 Uid; /* ACPI processor UID */
921 } ACPI_MADT_LOCAL_X2APIC;
924 /* 10: Local X2APIC NMI (ACPI 4.0) */
926 typedef struct acpi_madt_local_x2apic_nmi
928 ACPI_SUBTABLE_HEADER Header;
930 UINT32 Uid; /* ACPI processor UID */
931 UINT8 Lint; /* LINTn to which NMI is connected */
932 UINT8 Reserved[3]; /* Reserved - must be zero */
934 } ACPI_MADT_LOCAL_X2APIC_NMI;
937 /* 11: Generic Interrupt (ACPI 5.0 + ACPI 6.0 changes) */
939 typedef struct acpi_madt_generic_interrupt
941 ACPI_SUBTABLE_HEADER Header;
942 UINT16 Reserved; /* Reserved - must be zero */
943 UINT32 CpuInterfaceNumber;
946 UINT32 ParkingVersion;
947 UINT32 PerformanceInterrupt;
948 UINT64 ParkedAddress;
950 UINT64 GicvBaseAddress;
951 UINT64 GichBaseAddress;
952 UINT32 VgicInterrupt;
953 UINT64 GicrBaseAddress;
955 UINT8 EfficiencyClass;
958 } ACPI_MADT_GENERIC_INTERRUPT;
960 /* Masks for Flags field above */
962 /* ACPI_MADT_ENABLED (1) Processor is usable if set */
963 #define ACPI_MADT_PERFORMANCE_IRQ_MODE (1<<1) /* 01: Performance Interrupt Mode */
964 #define ACPI_MADT_VGIC_IRQ_MODE (1<<2) /* 02: VGIC Maintenance Interrupt mode */
967 /* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
969 typedef struct acpi_madt_generic_distributor
971 ACPI_SUBTABLE_HEADER Header;
972 UINT16 Reserved; /* Reserved - must be zero */
975 UINT32 GlobalIrqBase;
977 UINT8 Reserved2[3]; /* Reserved - must be zero */
979 } ACPI_MADT_GENERIC_DISTRIBUTOR;
982 /* 13: Generic MSI Frame (ACPI 5.1) */
984 typedef struct acpi_madt_generic_msi_frame
986 ACPI_SUBTABLE_HEADER Header;
987 UINT16 Reserved; /* Reserved - must be zero */
994 } ACPI_MADT_GENERIC_MSI_FRAME;
996 /* Masks for Flags field above */
998 #define ACPI_MADT_OVERRIDE_SPI_VALUES (1)
1001 /* 14: Generic Redistributor (ACPI 5.1) */
1003 typedef struct acpi_madt_generic_redistributor
1005 ACPI_SUBTABLE_HEADER Header;
1006 UINT16 Reserved; /* reserved - must be zero */
1010 } ACPI_MADT_GENERIC_REDISTRIBUTOR;
1013 /* 15: Generic Translator (ACPI 6.0) */
1015 typedef struct acpi_madt_generic_translator
1017 ACPI_SUBTABLE_HEADER Header;
1018 UINT16 Reserved; /* reserved - must be zero */
1019 UINT32 TranslationId;
1023 } ACPI_MADT_GENERIC_TRANSLATOR;
1027 * Common flags fields for MADT subtables
1030 /* MADT Local APIC flags */
1032 #define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
1034 /* MADT MPS INTI flags (IntiFlags) */
1036 #define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
1037 #define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
1039 /* Values for MPS INTI flags */
1041 #define ACPI_MADT_POLARITY_CONFORMS 0
1042 #define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
1043 #define ACPI_MADT_POLARITY_RESERVED 2
1044 #define ACPI_MADT_POLARITY_ACTIVE_LOW 3
1046 #define ACPI_MADT_TRIGGER_CONFORMS (0)
1047 #define ACPI_MADT_TRIGGER_EDGE (1<<2)
1048 #define ACPI_MADT_TRIGGER_RESERVED (2<<2)
1049 #define ACPI_MADT_TRIGGER_LEVEL (3<<2)
1052 /*******************************************************************************
1054 * MSCT - Maximum System Characteristics Table (ACPI 4.0)
1057 ******************************************************************************/
1059 typedef struct acpi_table_msct
1061 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1062 UINT32 ProximityOffset; /* Location of proximity info struct(s) */
1063 UINT32 MaxProximityDomains;/* Max number of proximity domains */
1064 UINT32 MaxClockDomains; /* Max number of clock domains */
1065 UINT64 MaxAddress; /* Max physical address in system */
1070 /* Subtable - Maximum Proximity Domain Information. Version 1 */
1072 typedef struct acpi_msct_proximity
1076 UINT32 RangeStart; /* Start of domain range */
1077 UINT32 RangeEnd; /* End of domain range */
1078 UINT32 ProcessorCapacity;
1079 UINT64 MemoryCapacity; /* In bytes */
1081 } ACPI_MSCT_PROXIMITY;
1084 /*******************************************************************************
1086 * NFIT - NVDIMM Interface Table (ACPI 6.0)
1089 ******************************************************************************/
1091 typedef struct acpi_table_nfit
1093 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1094 UINT32 Reserved; /* Reserved, must be zero */
1098 /* Subtable header for NFIT */
1100 typedef struct acpi_nfit_header
1108 /* Values for subtable type in ACPI_NFIT_HEADER */
1112 ACPI_NFIT_TYPE_SYSTEM_ADDRESS = 0,
1113 ACPI_NFIT_TYPE_MEMORY_MAP = 1,
1114 ACPI_NFIT_TYPE_INTERLEAVE = 2,
1115 ACPI_NFIT_TYPE_SMBIOS = 3,
1116 ACPI_NFIT_TYPE_CONTROL_REGION = 4,
1117 ACPI_NFIT_TYPE_DATA_REGION = 5,
1118 ACPI_NFIT_TYPE_FLUSH_ADDRESS = 6,
1119 ACPI_NFIT_TYPE_RESERVED = 7 /* 7 and greater are reserved */
1126 /* 0: System Physical Address Range Structure */
1128 typedef struct acpi_nfit_system_address
1130 ACPI_NFIT_HEADER Header;
1133 UINT32 Reserved; /* Reseved, must be zero */
1134 UINT32 ProximityDomain;
1135 UINT8 RangeGuid[16];
1138 UINT64 MemoryMapping;
1140 } ACPI_NFIT_SYSTEM_ADDRESS;
1144 #define ACPI_NFIT_ADD_ONLINE_ONLY (1) /* 00: Add/Online Operation Only */
1145 #define ACPI_NFIT_PROXIMITY_VALID (1<<1) /* 01: Proximity Domain Valid */
1147 /* Range Type GUIDs appear in the include/acuuid.h file */
1150 /* 1: Memory Device to System Address Range Map Structure */
1152 typedef struct acpi_nfit_memory_map
1154 ACPI_NFIT_HEADER Header;
1155 UINT32 DeviceHandle;
1161 UINT64 RegionOffset;
1163 UINT16 InterleaveIndex;
1164 UINT16 InterleaveWays;
1166 UINT16 Reserved; /* Reserved, must be zero */
1168 } ACPI_NFIT_MEMORY_MAP;
1172 #define ACPI_NFIT_MEM_SAVE_FAILED (1) /* 00: Last SAVE to Memory Device failed */
1173 #define ACPI_NFIT_MEM_RESTORE_FAILED (1<<1) /* 01: Last RESTORE from Memory Device failed */
1174 #define ACPI_NFIT_MEM_FLUSH_FAILED (1<<2) /* 02: Platform flush failed */
1175 #define ACPI_NFIT_MEM_ARMED (1<<3) /* 03: Memory Device observed to be not armed */
1176 #define ACPI_NFIT_MEM_HEALTH_OBSERVED (1<<4) /* 04: Memory Device observed SMART/health events */
1177 #define ACPI_NFIT_MEM_HEALTH_ENABLED (1<<5) /* 05: SMART/health events enabled */
1180 /* 2: Interleave Structure */
1182 typedef struct acpi_nfit_interleave
1184 ACPI_NFIT_HEADER Header;
1185 UINT16 InterleaveIndex;
1186 UINT16 Reserved; /* Reserved, must be zero */
1189 UINT32 LineOffset[1]; /* Variable length */
1191 } ACPI_NFIT_INTERLEAVE;
1194 /* 3: SMBIOS Management Information Structure */
1196 typedef struct acpi_nfit_smbios
1198 ACPI_NFIT_HEADER Header;
1199 UINT32 Reserved; /* Reserved, must be zero */
1200 UINT8 Data[1]; /* Variable length */
1205 /* 4: NVDIMM Control Region Structure */
1207 typedef struct acpi_nfit_control_region
1209 ACPI_NFIT_HEADER Header;
1214 UINT16 SubsystemVendorId;
1215 UINT16 SubsystemDeviceId;
1216 UINT16 SubsystemRevisionId;
1217 UINT8 Reserved[6]; /* Reserved, must be zero */
1218 UINT32 SerialNumber;
1222 UINT64 CommandOffset;
1224 UINT64 StatusOffset;
1227 UINT8 Reserved1[6]; /* Reserved, must be zero */
1229 } ACPI_NFIT_CONTROL_REGION;
1233 #define ACPI_NFIT_CONTROL_BUFFERED (1) /* Block Data Windows implementation is buffered */
1236 /* 5: NVDIMM Block Data Window Region Structure */
1238 typedef struct acpi_nfit_data_region
1240 ACPI_NFIT_HEADER Header;
1246 UINT64 StartAddress;
1248 } ACPI_NFIT_DATA_REGION;
1251 /* 6: Flush Hint Address Structure */
1253 typedef struct acpi_nfit_flush_address
1255 ACPI_NFIT_HEADER Header;
1256 UINT32 DeviceHandle;
1258 UINT8 Reserved[6]; /* Reserved, must be zero */
1259 UINT64 HintAddress[1]; /* Variable length */
1261 } ACPI_NFIT_FLUSH_ADDRESS;
1264 /*******************************************************************************
1266 * SBST - Smart Battery Specification Table
1269 ******************************************************************************/
1271 typedef struct acpi_table_sbst
1273 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1274 UINT32 WarningLevel;
1276 UINT32 CriticalLevel;
1281 /*******************************************************************************
1283 * SLIT - System Locality Distance Information Table
1286 ******************************************************************************/
1288 typedef struct acpi_table_slit
1290 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1291 UINT64 LocalityCount;
1292 UINT8 Entry[1]; /* Real size = localities^2 */
1297 /*******************************************************************************
1299 * SRAT - System Resource Affinity Table
1302 ******************************************************************************/
1304 typedef struct acpi_table_srat
1306 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1307 UINT32 TableRevision; /* Must be value '1' */
1308 UINT64 Reserved; /* Reserved, must be zero */
1312 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
1316 ACPI_SRAT_TYPE_CPU_AFFINITY = 0,
1317 ACPI_SRAT_TYPE_MEMORY_AFFINITY = 1,
1318 ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY = 2,
1319 ACPI_SRAT_TYPE_GICC_AFFINITY = 3,
1320 ACPI_SRAT_TYPE_RESERVED = 4 /* 4 and greater are reserved */
1324 * SRAT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
1327 /* 0: Processor Local APIC/SAPIC Affinity */
1329 typedef struct acpi_srat_cpu_affinity
1331 ACPI_SUBTABLE_HEADER Header;
1332 UINT8 ProximityDomainLo;
1335 UINT8 LocalSapicEid;
1336 UINT8 ProximityDomainHi[3];
1339 } ACPI_SRAT_CPU_AFFINITY;
1343 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
1346 /* 1: Memory Affinity */
1348 typedef struct acpi_srat_mem_affinity
1350 ACPI_SUBTABLE_HEADER Header;
1351 UINT32 ProximityDomain;
1352 UINT16 Reserved; /* Reserved, must be zero */
1357 UINT64 Reserved2; /* Reserved, must be zero */
1359 } ACPI_SRAT_MEM_AFFINITY;
1363 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
1364 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
1365 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
1368 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
1370 typedef struct acpi_srat_x2apic_cpu_affinity
1372 ACPI_SUBTABLE_HEADER Header;
1373 UINT16 Reserved; /* Reserved, must be zero */
1374 UINT32 ProximityDomain;
1380 } ACPI_SRAT_X2APIC_CPU_AFFINITY;
1382 /* Flags for ACPI_SRAT_CPU_AFFINITY and ACPI_SRAT_X2APIC_CPU_AFFINITY */
1384 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
1387 /* 3: GICC Affinity (ACPI 5.1) */
1389 typedef struct acpi_srat_gicc_affinity
1391 ACPI_SUBTABLE_HEADER Header;
1392 UINT32 ProximityDomain;
1393 UINT32 AcpiProcessorUid;
1397 } ACPI_SRAT_GICC_AFFINITY;
1399 /* Flags for ACPI_SRAT_GICC_AFFINITY */
1401 #define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
1404 /* Reset to default packing */
1408 #endif /* __ACTBL1_H__ */