Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
actbl1.h
Go to the documentation of this file.
1 /******************************************************************************
2  *
3  * Name: actbl1.h - Additional ACPI table definitions
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2012, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
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.
25  *
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.
29  *
30  * NO WARRANTY
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.
42  */
43 
44 #ifndef __ACTBL1_H__
45 #define __ACTBL1_H__
46 
47 /*******************************************************************************
48  *
49  * Additional ACPI Tables (1)
50  *
51  * These tables are not consumed directly by the ACPICA subsystem, but are
52  * included here to support device drivers and the AML disassembler.
53  *
54  * The tables in this file are fully defined within the ACPI specification.
55  *
56  ******************************************************************************/
57 
58 /*
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.
62  */
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_HEST "HEST" /* Hardware Error Source Table */
69 #define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
70 #define ACPI_SIG_MSCT "MSCT" /* Maximum System Characteristics Table */
71 #define ACPI_SIG_SBST "SBST" /* Smart Battery Specification Table */
72 #define ACPI_SIG_SLIT "SLIT" /* System Locality Distance Information Table */
73 #define ACPI_SIG_SRAT "SRAT" /* System Resource Affinity Table */
74 
75 /*
76  * All tables must be byte-packed to match the ACPI specification, since
77  * the tables are provided by the system BIOS.
78  */
79 #pragma pack(1)
80 
81 /*
82  * Note: C bitfields are not used for this reason:
83  *
84  * "Bitfields are great and easy to read, but unfortunately the C language
85  * does not specify the layout of bitfields in memory, which means they are
86  * essentially useless for dealing with packed data in on-disk formats or
87  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
88  * this decision was a design error in C. Ritchie could have picked an order
89  * and stuck with it." Norman Ramsey.
90  * See http://stackoverflow.com/a/1053662/41661
91  */
92 
93 /*******************************************************************************
94  *
95  * Common subtable headers
96  *
97  ******************************************************************************/
98 
99 /* Generic subtable header (used in MADT, SRAT, etc.) */
100 
104 };
105 
106 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
107 
114  u64 value; /* Value used with Read/Write register */
115  u64 mask; /* Bitmask required for this register instruction */
116 };
117 
118 /*******************************************************************************
119  *
120  * BERT - Boot Error Record Table (ACPI 4.0)
121  * Version 1
122  *
123  ******************************************************************************/
124 
126  struct acpi_table_header header; /* Common ACPI table header */
127  u32 region_length; /* Length of the boot error region */
128  u64 address; /* Physical address of the error region */
129 };
130 
131 /* Boot Error Region (not a subtable, pointed to by Address field above) */
132 
134  u32 block_status; /* Type of error information */
135  u32 raw_data_offset; /* Offset to raw error data */
136  u32 raw_data_length; /* Length of raw error data */
137  u32 data_length; /* Length of generic error data */
138  u32 error_severity; /* Severity code */
139 };
140 
141 /* Values for block_status flags above */
142 
143 #define ACPI_BERT_UNCORRECTABLE (1)
144 #define ACPI_BERT_CORRECTABLE (1<<1)
145 #define ACPI_BERT_MULTIPLE_UNCORRECTABLE (1<<2)
146 #define ACPI_BERT_MULTIPLE_CORRECTABLE (1<<3)
147 #define ACPI_BERT_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
148 
149 /* Values for error_severity above */
150 
156  ACPI_BERT_ERROR_RESERVED = 4 /* 4 and greater are reserved */
157 };
158 
159 /*
160  * Note: The generic error data that follows the error_severity field above
161  * uses the struct acpi_hest_generic_data defined under the HEST table below
162  */
163 
164 /*******************************************************************************
165  *
166  * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
167  * Version 1
168  *
169  ******************************************************************************/
170 
172  struct acpi_table_header header; /* Common ACPI table header */
174 };
175 
176 /* Subtable */
177 
180  u8 id; /* Processor ID */
181  u8 eid; /* Processor EID */
182  u32 interval; /* Polling interval (msec) */
183 };
184 
185 /*******************************************************************************
186  *
187  * ECDT - Embedded Controller Boot Resources Table
188  * Version 1
189  *
190  ******************************************************************************/
191 
193  struct acpi_table_header header; /* Common ACPI table header */
194  struct acpi_generic_address control; /* Address of EC command/status register */
195  struct acpi_generic_address data; /* Address of EC data register */
196  u32 uid; /* Unique ID - must be same as the EC _UID method */
197  u8 gpe; /* The GPE for the EC */
198  u8 id[1]; /* Full namepath of the EC in the ACPI namespace */
199 };
200 
201 /*******************************************************************************
202  *
203  * EINJ - Error Injection Table (ACPI 4.0)
204  * Version 1
205  *
206  ******************************************************************************/
207 
209  struct acpi_table_header header; /* Common ACPI table header */
214 };
215 
216 /* EINJ Injection Instruction Entries (actions) */
217 
219  struct acpi_whea_header whea_header; /* Common header for WHEA tables */
220 };
221 
222 /* Masks for Flags field above */
223 
224 #define ACPI_EINJ_PRESERVE (1)
225 
226 /* Values for Action field above */
227 
238  ACPI_EINJ_ACTION_RESERVED = 9, /* 9 and greater are reserved */
239  ACPI_EINJ_TRIGGER_ERROR = 0xFF /* Except for this value */
240 };
241 
242 /* Values for Instruction field above */
243 
251  ACPI_EINJ_INSTRUCTION_RESERVED = 6 /* 6 and greater are reserved */
252 };
253 
262 };
263 
271 };
272 
273 /* EINJ Trigger Error Action Table */
274 
280 };
281 
282 /* Command status return values */
283 
288  ACPI_EINJ_STATUS_RESERVED = 3 /* 3 and greater are reserved */
289 };
290 
291 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
292 
293 #define ACPI_EINJ_PROCESSOR_CORRECTABLE (1)
294 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE (1<<1)
295 #define ACPI_EINJ_PROCESSOR_FATAL (1<<2)
296 #define ACPI_EINJ_MEMORY_CORRECTABLE (1<<3)
297 #define ACPI_EINJ_MEMORY_UNCORRECTABLE (1<<4)
298 #define ACPI_EINJ_MEMORY_FATAL (1<<5)
299 #define ACPI_EINJ_PCIX_CORRECTABLE (1<<6)
300 #define ACPI_EINJ_PCIX_UNCORRECTABLE (1<<7)
301 #define ACPI_EINJ_PCIX_FATAL (1<<8)
302 #define ACPI_EINJ_PLATFORM_CORRECTABLE (1<<9)
303 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE (1<<10)
304 #define ACPI_EINJ_PLATFORM_FATAL (1<<11)
305 #define ACPI_EINJ_VENDOR_DEFINED (1<<31)
306 
307 /*******************************************************************************
308  *
309  * ERST - Error Record Serialization Table (ACPI 4.0)
310  * Version 1
311  *
312  ******************************************************************************/
313 
315  struct acpi_table_header header; /* Common ACPI table header */
319 };
320 
321 /* ERST Serialization Entries (actions) */
322 
324  struct acpi_whea_header whea_header; /* Common header for WHEA tables */
325 };
326 
327 /* Masks for Flags field above */
328 
329 #define ACPI_ERST_PRESERVE (1)
330 
331 /* Values for Action field above */
332 
350  ACPI_ERST_ACTION_RESERVED = 16 /* 16 and greater are reserved */
351 };
352 
353 /* Values for Instruction field above */
354 
375  ACPI_ERST_INSTRUCTION_RESERVED = 19 /* 19 and greater are reserved */
376 };
377 
378 /* Command status return values */
379 
387  ACPI_ERST_STATUS_RESERVED = 6 /* 6 and greater are reserved */
388 };
389 
390 /* Error Record Serialization Information */
391 
393  u16 signature; /* Should be "ER" */
394  u8 data[48];
395 };
396 
397 /*******************************************************************************
398  *
399  * HEST - Hardware Error Source Table (ACPI 4.0)
400  * Version 1
401  *
402  ******************************************************************************/
403 
405  struct acpi_table_header header; /* Common ACPI table header */
407 };
408 
409 /* HEST subtable header */
410 
414 };
415 
416 /* Values for Type field above for subtables */
417 
429  ACPI_HEST_TYPE_RESERVED = 10 /* 10 and greater are reserved */
430 };
431 
432 /*
433  * HEST substructures contained in subtables
434  */
435 
436 /*
437  * IA32 Error Bank(s) - Follows the struct acpi_hest_ia_machine_check and
438  * struct acpi_hest_ia_corrected structures.
439  */
450 };
451 
452 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
453 
462  u16 function;
469 };
470 
471 /* Masks for HEST Flags fields */
472 
473 #define ACPI_HEST_FIRMWARE_FIRST (1)
474 #define ACPI_HEST_GLOBAL (1<<1)
475 
476 /* Hardware Error Notification */
477 
488 };
489 
490 /* Values for Notify Type field above */
491 
498  ACPI_HEST_NOTIFY_CMCI = 5, /* ACPI 5.0 */
499  ACPI_HEST_NOTIFY_MCE = 6, /* ACPI 5.0 */
500  ACPI_HEST_NOTIFY_RESERVED = 7 /* 7 and greater are reserved */
501 };
502 
503 /* Values for config_write_enable bitfield above */
504 
505 #define ACPI_HEST_TYPE (1)
506 #define ACPI_HEST_POLL_INTERVAL (1<<1)
507 #define ACPI_HEST_POLL_THRESHOLD_VALUE (1<<2)
508 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
509 #define ACPI_HEST_ERR_THRESHOLD_VALUE (1<<4)
510 #define ACPI_HEST_ERR_THRESHOLD_WINDOW (1<<5)
511 
512 /*
513  * HEST subtables
514  */
515 
516 /* 0: IA32 Machine Check Exception */
517 
529 };
530 
531 /* 1: IA32 Corrected Machine Check */
532 
543 };
544 
545 /* 2: IA32 Non-Maskable Interrupt */
546 
553 };
554 
555 /* 3,4,5: Not used */
556 
557 /* 6: PCI Express Root Port AER */
558 
563 };
564 
565 /* 7: PCI Express AER (AER Endpoint) */
566 
570 };
571 
572 /* 8: PCI Express/PCI-X Bridge AER */
573 
580 };
581 
582 /* 9: Generic Hardware Error Source */
583 
595 };
596 
597 /* Generic Error Status block */
598 
605 };
606 
607 /* Values for block_status flags above */
608 
609 #define ACPI_HEST_UNCORRECTABLE (1)
610 #define ACPI_HEST_CORRECTABLE (1<<1)
611 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE (1<<2)
612 #define ACPI_HEST_MULTIPLE_CORRECTABLE (1<<3)
613 #define ACPI_HEST_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
614 
615 /* Generic Error Data entry */
616 
624  u8 fru_id[16];
626 };
627 
628 /*******************************************************************************
629  *
630  * MADT - Multiple APIC Description Table
631  * Version 3
632  *
633  ******************************************************************************/
634 
636  struct acpi_table_header header; /* Common ACPI table header */
637  u32 address; /* Physical address of local APIC */
639 };
640 
641 /* Masks for Flags field above */
642 
643 #define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
644 
645 /* Values for PCATCompat flag */
646 
647 #define ACPI_MADT_DUAL_PIC 0
648 #define ACPI_MADT_MULTIPLE_APIC 1
649 
650 /* Values for MADT subtable type in struct acpi_subtable_header */
651 
666  ACPI_MADT_TYPE_RESERVED = 13 /* 13 and greater are reserved */
667 };
668 
669 /*
670  * MADT Sub-tables, correspond to Type in struct acpi_subtable_header
671  */
672 
673 /* 0: Processor Local APIC */
674 
677  u8 processor_id; /* ACPI processor id */
678  u8 id; /* Processor's local APIC id */
680 };
681 
682 /* 1: IO APIC */
683 
686  u8 id; /* I/O APIC ID */
687  u8 reserved; /* reserved - must be zero */
688  u32 address; /* APIC physical address */
689  u32 global_irq_base; /* Global system interrupt where INTI lines start */
690 };
691 
692 /* 2: Interrupt Override */
693 
696  u8 bus; /* 0 - ISA */
697  u8 source_irq; /* Interrupt source (IRQ) */
698  u32 global_irq; /* Global system interrupt */
700 };
701 
702 /* 3: NMI Source */
703 
707  u32 global_irq; /* Global system interrupt */
708 };
709 
710 /* 4: Local APIC NMI */
711 
714  u8 processor_id; /* ACPI processor id */
716  u8 lint; /* LINTn to which NMI is connected */
717 };
718 
719 /* 5: Address Override */
720 
723  u16 reserved; /* Reserved, must be zero */
724  u64 address; /* APIC physical address */
725 };
726 
727 /* 6: I/O Sapic */
728 
731  u8 id; /* I/O SAPIC ID */
732  u8 reserved; /* Reserved, must be zero */
733  u32 global_irq_base; /* Global interrupt for SAPIC start */
734  u64 address; /* SAPIC physical address */
735 };
736 
737 /* 7: Local Sapic */
738 
741  u8 processor_id; /* ACPI processor id */
742  u8 id; /* SAPIC ID */
743  u8 eid; /* SAPIC EID */
744  u8 reserved[3]; /* Reserved, must be zero */
746  u32 uid; /* Numeric UID - ACPI 3.0 */
747  char uid_string[1]; /* String UID - ACPI 3.0 */
748 };
749 
750 /* 8: Platform Interrupt Source */
751 
755  u8 type; /* 1=PMI, 2=INIT, 3=corrected */
756  u8 id; /* Processor ID */
757  u8 eid; /* Processor EID */
758  u8 io_sapic_vector; /* Vector value for PMI interrupts */
759  u32 global_irq; /* Global system interrupt */
760  u32 flags; /* Interrupt Source Flags */
761 };
762 
763 /* Masks for Flags field above */
764 
765 #define ACPI_MADT_CPEI_OVERRIDE (1)
766 
767 /* 9: Processor Local X2APIC (ACPI 4.0) */
768 
771  u16 reserved; /* Reserved - must be zero */
772  u32 local_apic_id; /* Processor x2APIC ID */
774  u32 uid; /* ACPI processor UID */
775 };
776 
777 /* 10: Local X2APIC NMI (ACPI 4.0) */
778 
782  u32 uid; /* ACPI processor UID */
783  u8 lint; /* LINTn to which NMI is connected */
785 };
786 
787 /* 11: Generic Interrupt (ACPI 5.0) */
788 
791  u16 reserved; /* Reserved - must be zero */
799 };
800 
801 /* 12: Generic Distributor (ACPI 5.0) */
802 
805  u16 reserved; /* reserved - must be zero */
809  u32 reserved2; /* reserved - must be zero */
810 };
811 
812 /*
813  * Common flags fields for MADT subtables
814  */
815 
816 /* MADT Local APIC flags (lapic_flags) and GIC flags */
817 
818 #define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
819 
820 /* MADT MPS INTI flags (inti_flags) */
821 
822 #define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
823 #define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
824 
825 /* Values for MPS INTI flags */
826 
827 #define ACPI_MADT_POLARITY_CONFORMS 0
828 #define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
829 #define ACPI_MADT_POLARITY_RESERVED 2
830 #define ACPI_MADT_POLARITY_ACTIVE_LOW 3
831 
832 #define ACPI_MADT_TRIGGER_CONFORMS (0)
833 #define ACPI_MADT_TRIGGER_EDGE (1<<2)
834 #define ACPI_MADT_TRIGGER_RESERVED (2<<2)
835 #define ACPI_MADT_TRIGGER_LEVEL (3<<2)
836 
837 /*******************************************************************************
838  *
839  * MSCT - Maximum System Characteristics Table (ACPI 4.0)
840  * Version 1
841  *
842  ******************************************************************************/
843 
845  struct acpi_table_header header; /* Common ACPI table header */
846  u32 proximity_offset; /* Location of proximity info struct(s) */
847  u32 max_proximity_domains; /* Max number of proximity domains */
848  u32 max_clock_domains; /* Max number of clock domains */
849  u64 max_address; /* Max physical address in system */
850 };
851 
852 /* subtable - Maximum Proximity Domain Information. Version 1 */
853 
857  u32 range_start; /* Start of domain range */
858  u32 range_end; /* End of domain range */
860  u64 memory_capacity; /* In bytes */
861 };
862 
863 /*******************************************************************************
864  *
865  * SBST - Smart Battery Specification Table
866  * Version 1
867  *
868  ******************************************************************************/
869 
871  struct acpi_table_header header; /* Common ACPI table header */
875 };
876 
877 /*******************************************************************************
878  *
879  * SLIT - System Locality Distance Information Table
880  * Version 1
881  *
882  ******************************************************************************/
883 
885  struct acpi_table_header header; /* Common ACPI table header */
887  u8 entry[1]; /* Real size = localities^2 */
888 };
889 
890 /*******************************************************************************
891  *
892  * SRAT - System Resource Affinity Table
893  * Version 3
894  *
895  ******************************************************************************/
896 
898  struct acpi_table_header header; /* Common ACPI table header */
899  u32 table_revision; /* Must be value '1' */
900  u64 reserved; /* Reserved, must be zero */
901 };
902 
903 /* Values for subtable type in struct acpi_subtable_header */
904 
909  ACPI_SRAT_TYPE_RESERVED = 3 /* 3 and greater are reserved */
910 };
911 
912 /*
913  * SRAT Sub-tables, correspond to Type in struct acpi_subtable_header
914  */
915 
916 /* 0: Processor Local APIC/SAPIC Affinity */
917 
925  u32 reserved; /* Reserved, must be zero */
926 };
927 
928 /* Flags */
929 
930 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
931 
932 /* 1: Memory Affinity */
933 
937  u16 reserved; /* Reserved, must be zero */
942  u64 reserved2; /* Reserved, must be zero */
943 };
944 
945 /* Flags */
946 
947 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
948 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
949 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
950 
951 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
952 
955  u16 reserved; /* Reserved, must be zero */
961 };
962 
963 /* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
964 
965 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
966 
967 /* Reset to default packing */
968 
969 #pragma pack()
970 
971 #endif /* __ACTBL1_H__ */