1 /******************************************************************************
2  *
3  * Name: actbl1.h - Additional ACPI table definitions
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2016, 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  *
50  * Additional ACPI Tables (1)
51  *
52  * These tables are not consumed directly by the ACPICA subsystem, but are
53  * included here to support device drivers and the AML disassembler.
54  *
55  * The tables in this file are fully defined within the ACPI specification.
56  *
57  ******************************************************************************/
58 
59 
60 /*
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.
64  */
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 */
77 
78 
79 /*
80  * All tables must be byte-packed to match the ACPI specification, since
81  * the tables are provided by the system BIOS.
82  */
83 #pragma pack(1)
84 
85 /*
86  * Note: C bitfields are not used for this reason:
87  *
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
95  */
96 
97 
98 /*******************************************************************************
99  *
100  * Common subtable headers
101  *
102  ******************************************************************************/
103 
104 /* Generic subtable header (used in MADT, SRAT, etc.) */
105 
106 typedef struct acpi_subtable_header
107 {
108     UINT8                   Type;
109     UINT8                   Length;
110 
111 } ACPI_SUBTABLE_HEADER;
112 
113 
114 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
115 
116 typedef struct acpi_whea_header
117 {
118     UINT8                   Action;
119     UINT8                   Instruction;
120     UINT8                   Flags;
121     UINT8                   Reserved;
122     ACPI_GENERIC_ADDRESS    RegisterRegion;
123     UINT64                  Value;              /* Value used with Read/Write register */
124     UINT64                  Mask;               /* Bitmask required for this register instruction */
125 
126 } ACPI_WHEA_HEADER;
127 
128 
129 /*******************************************************************************
130  *
131  * BERT - Boot Error Record Table (ACPI 4.0)
132  *        Version 1
133  *
134  ******************************************************************************/
135 
136 typedef struct acpi_table_bert
137 {
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 */
141 
142 } ACPI_TABLE_BERT;
143 
144 
145 /* Boot Error Region (not a subtable, pointed to by Address field above) */
146 
147 typedef struct acpi_bert_region
148 {
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 */
154 
155 } ACPI_BERT_REGION;
156 
157 /* Values for BlockStatus flags above */
158 
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 */
164 
165 /* Values for ErrorSeverity above */
166 
167 enum AcpiBertErrorSeverity
168 {
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 */
174 };
175 
176 /*
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
179  */
180 
181 
182 /*******************************************************************************
183  *
184  * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
185  *        Version 1
186  *
187  ******************************************************************************/
188 
189 typedef struct acpi_table_cpep
190 {
191     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
192     UINT64                  Reserved;
193 
194 } ACPI_TABLE_CPEP;
195 
196 
197 /* Subtable */
198 
199 typedef struct acpi_cpep_polling
200 {
201     ACPI_SUBTABLE_HEADER    Header;
202     UINT8                   Id;                 /* Processor ID */
203     UINT8                   Eid;                /* Processor EID */
204     UINT32                  Interval;           /* Polling interval (msec) */
205 
206 } ACPI_CPEP_POLLING;
207 
208 
209 /*******************************************************************************
210  *
211  * ECDT - Embedded Controller Boot Resources Table
212  *        Version 1
213  *
214  ******************************************************************************/
215 
216 typedef struct acpi_table_ecdt
217 {
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 */
224 
225 } ACPI_TABLE_ECDT;
226 
227 
228 /*******************************************************************************
229  *
230  * EINJ - Error Injection Table (ACPI 4.0)
231  *        Version 1
232  *
233  ******************************************************************************/
234 
235 typedef struct acpi_table_einj
236 {
237     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
238     UINT32                  HeaderLength;
239     UINT8                   Flags;
240     UINT8                   Reserved[3];
241     UINT32                  Entries;
242 
243 } ACPI_TABLE_EINJ;
244 
245 
246 /* EINJ Injection Instruction Entries (actions) */
247 
248 typedef struct acpi_einj_entry
249 {
250     ACPI_WHEA_HEADER        WheaHeader;         /* Common header for WHEA tables */
251 
252 } ACPI_EINJ_ENTRY;
253 
254 /* Masks for Flags field above */
255 
256 #define ACPI_EINJ_PRESERVE          (1)
257 
258 /* Values for Action field above */
259 
260 enum AcpiEinjActions
261 {
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_GET_EXECUTE_TIMINGS           = 9,
272     ACPI_EINJ_ACTION_RESERVED               = 10,    /* 10 and greater are reserved */
273     ACPI_EINJ_TRIGGER_ERROR                 = 0xFF   /* Except for this value */
274 };
275 
276 /* Values for Instruction field above */
277 
278 enum AcpiEinjInstructions
279 {
280     ACPI_EINJ_READ_REGISTER         = 0,
281     ACPI_EINJ_READ_REGISTER_VALUE   = 1,
282     ACPI_EINJ_WRITE_REGISTER        = 2,
283     ACPI_EINJ_WRITE_REGISTER_VALUE  = 3,
284     ACPI_EINJ_NOOP                  = 4,
285     ACPI_EINJ_FLUSH_CACHELINE       = 5,
286     ACPI_EINJ_INSTRUCTION_RESERVED  = 6     /* 6 and greater are reserved */
287 };
288 
289 typedef struct acpi_einj_error_type_with_addr
290 {
291     UINT32                  ErrorType;
292     UINT32                  VendorStructOffset;
293     UINT32                  Flags;
294     UINT32                  ApicId;
295     UINT64                  Address;
296     UINT64                  Range;
297     UINT32                  PcieId;
298 
299 } ACPI_EINJ_ERROR_TYPE_WITH_ADDR;
300 
301 typedef struct acpi_einj_vendor
302 {
303     UINT32                  Length;
304     UINT32                  PcieId;
305     UINT16                  VendorId;
306     UINT16                  DeviceId;
307     UINT8                   RevisionId;
308     UINT8                   Reserved[3];
309 
310 } ACPI_EINJ_VENDOR;
311 
312 
313 /* EINJ Trigger Error Action Table */
314 
315 typedef struct acpi_einj_trigger
316 {
317     UINT32                  HeaderSize;
318     UINT32                  Revision;
319     UINT32                  TableSize;
320     UINT32                  EntryCount;
321 
322 } ACPI_EINJ_TRIGGER;
323 
324 /* Command status return values */
325 
326 enum AcpiEinjCommandStatus
327 {
328     ACPI_EINJ_SUCCESS               = 0,
329     ACPI_EINJ_FAILURE               = 1,
330     ACPI_EINJ_INVALID_ACCESS        = 2,
331     ACPI_EINJ_STATUS_RESERVED       = 3     /* 3 and greater are reserved */
332 };
333 
334 
335 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
336 
337 #define ACPI_EINJ_PROCESSOR_CORRECTABLE     (1)
338 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE   (1<<1)
339 #define ACPI_EINJ_PROCESSOR_FATAL           (1<<2)
340 #define ACPI_EINJ_MEMORY_CORRECTABLE        (1<<3)
341 #define ACPI_EINJ_MEMORY_UNCORRECTABLE      (1<<4)
342 #define ACPI_EINJ_MEMORY_FATAL              (1<<5)
343 #define ACPI_EINJ_PCIX_CORRECTABLE          (1<<6)
344 #define ACPI_EINJ_PCIX_UNCORRECTABLE        (1<<7)
345 #define ACPI_EINJ_PCIX_FATAL                (1<<8)
346 #define ACPI_EINJ_PLATFORM_CORRECTABLE      (1<<9)
347 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE    (1<<10)
348 #define ACPI_EINJ_PLATFORM_FATAL            (1<<11)
349 #define ACPI_EINJ_VENDOR_DEFINED            (1<<31)
350 
351 
352 /*******************************************************************************
353  *
354  * ERST - Error Record Serialization Table (ACPI 4.0)
355  *        Version 1
356  *
357  ******************************************************************************/
358 
359 typedef struct acpi_table_erst
360 {
361     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
362     UINT32                  HeaderLength;
363     UINT32                  Reserved;
364     UINT32                  Entries;
365 
366 } ACPI_TABLE_ERST;
367 
368 
369 /* ERST Serialization Entries (actions) */
370 
371 typedef struct acpi_erst_entry
372 {
373     ACPI_WHEA_HEADER        WheaHeader;         /* Common header for WHEA tables */
374 
375 } ACPI_ERST_ENTRY;
376 
377 /* Masks for Flags field above */
378 
379 #define ACPI_ERST_PRESERVE          (1)
380 
381 /* Values for Action field above */
382 
383 enum AcpiErstActions
384 {
385     ACPI_ERST_BEGIN_WRITE           = 0,
386     ACPI_ERST_BEGIN_READ            = 1,
387     ACPI_ERST_BEGIN_CLEAR           = 2,
388     ACPI_ERST_END                   = 3,
389     ACPI_ERST_SET_RECORD_OFFSET     = 4,
390     ACPI_ERST_EXECUTE_OPERATION     = 5,
391     ACPI_ERST_CHECK_BUSY_STATUS     = 6,
392     ACPI_ERST_GET_COMMAND_STATUS    = 7,
393     ACPI_ERST_GET_RECORD_ID         = 8,
394     ACPI_ERST_SET_RECORD_ID         = 9,
395     ACPI_ERST_GET_RECORD_COUNT      = 10,
396     ACPI_ERST_BEGIN_DUMMY_WRIITE    = 11,
397     ACPI_ERST_NOT_USED              = 12,
398     ACPI_ERST_GET_ERROR_RANGE       = 13,
399     ACPI_ERST_GET_ERROR_LENGTH      = 14,
400     ACPI_ERST_GET_ERROR_ATTRIBUTES  = 15,
401     ACPI_ERST_EXECUTE_TIMINGS       = 16,
402     ACPI_ERST_ACTION_RESERVED       = 17    /* 17 and greater are reserved */
403 };
404 
405 /* Values for Instruction field above */
406 
407 enum AcpiErstInstructions
408 {
409     ACPI_ERST_READ_REGISTER         = 0,
410     ACPI_ERST_READ_REGISTER_VALUE   = 1,
411     ACPI_ERST_WRITE_REGISTER        = 2,
412     ACPI_ERST_WRITE_REGISTER_VALUE  = 3,
413     ACPI_ERST_NOOP                  = 4,
414     ACPI_ERST_LOAD_VAR1             = 5,
415     ACPI_ERST_LOAD_VAR2             = 6,
416     ACPI_ERST_STORE_VAR1            = 7,
417     ACPI_ERST_ADD                   = 8,
418     ACPI_ERST_SUBTRACT              = 9,
419     ACPI_ERST_ADD_VALUE             = 10,
420     ACPI_ERST_SUBTRACT_VALUE        = 11,
421     ACPI_ERST_STALL                 = 12,
422     ACPI_ERST_STALL_WHILE_TRUE      = 13,
423     ACPI_ERST_SKIP_NEXT_IF_TRUE     = 14,
424     ACPI_ERST_GOTO                  = 15,
425     ACPI_ERST_SET_SRC_ADDRESS_BASE  = 16,
426     ACPI_ERST_SET_DST_ADDRESS_BASE  = 17,
427     ACPI_ERST_MOVE_DATA             = 18,
428     ACPI_ERST_INSTRUCTION_RESERVED  = 19    /* 19 and greater are reserved */
429 };
430 
431 /* Command status return values */
432 
433 enum AcpiErstCommandStatus
434 {
435     ACPI_ERST_SUCESS                = 0,
436     ACPI_ERST_NO_SPACE              = 1,
437     ACPI_ERST_NOT_AVAILABLE         = 2,
438     ACPI_ERST_FAILURE               = 3,
439     ACPI_ERST_RECORD_EMPTY          = 4,
440     ACPI_ERST_NOT_FOUND             = 5,
441     ACPI_ERST_STATUS_RESERVED       = 6     /* 6 and greater are reserved */
442 };
443 
444 
445 /* Error Record Serialization Information */
446 
447 typedef struct acpi_erst_info
448 {
449     UINT16                  Signature;          /* Should be "ER" */
450     UINT8                   Data[48];
451 
452 } ACPI_ERST_INFO;
453 
454 
455 /*******************************************************************************
456  *
457  * HEST - Hardware Error Source Table (ACPI 4.0)
458  *        Version 1
459  *
460  ******************************************************************************/
461 
462 typedef struct acpi_table_hest
463 {
464     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
465     UINT32                  ErrorSourceCount;
466 
467 } ACPI_TABLE_HEST;
468 
469 
470 /* HEST subtable header */
471 
472 typedef struct acpi_hest_header
473 {
474     UINT16                  Type;
475     UINT16                  SourceId;
476 
477 } ACPI_HEST_HEADER;
478 
479 
480 /* Values for Type field above for subtables */
481 
482 enum AcpiHestTypes
483 {
484     ACPI_HEST_TYPE_IA32_CHECK           = 0,
485     ACPI_HEST_TYPE_IA32_CORRECTED_CHECK = 1,
486     ACPI_HEST_TYPE_IA32_NMI             = 2,
487     ACPI_HEST_TYPE_NOT_USED3            = 3,
488     ACPI_HEST_TYPE_NOT_USED4            = 4,
489     ACPI_HEST_TYPE_NOT_USED5            = 5,
490     ACPI_HEST_TYPE_AER_ROOT_PORT        = 6,
491     ACPI_HEST_TYPE_AER_ENDPOINT         = 7,
492     ACPI_HEST_TYPE_AER_BRIDGE           = 8,
493     ACPI_HEST_TYPE_GENERIC_ERROR        = 9,
494     ACPI_HEST_TYPE_GENERIC_ERROR_V2     = 10,
495     ACPI_HEST_TYPE_RESERVED             = 11    /* 11 and greater are reserved */
496 };
497 
498 
499 /*
500  * HEST substructures contained in subtables
501  */
502 
503 /*
504  * IA32 Error Bank(s) - Follows the ACPI_HEST_IA_MACHINE_CHECK and
505  * ACPI_HEST_IA_CORRECTED structures.
506  */
507 typedef struct acpi_hest_ia_error_bank
508 {
509     UINT8                   BankNumber;
510     UINT8                   ClearStatusOnInit;
511     UINT8                   StatusFormat;
512     UINT8                   Reserved;
513     UINT32                  ControlRegister;
514     UINT64                  ControlData;
515     UINT32                  StatusRegister;
516     UINT32                  AddressRegister;
517     UINT32                  MiscRegister;
518 
519 } ACPI_HEST_IA_ERROR_BANK;
520 
521 
522 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
523 
524 typedef struct acpi_hest_aer_common
525 {
526     UINT16                  Reserved1;
527     UINT8                   Flags;
528     UINT8                   Enabled;
529     UINT32                  RecordsToPreallocate;
530     UINT32                  MaxSectionsPerRecord;
531     UINT32                  Bus;                    /* Bus and Segment numbers */
532     UINT16                  Device;
533     UINT16                  Function;
534     UINT16                  DeviceControl;
535     UINT16                  Reserved2;
536     UINT32                  UncorrectableMask;
537     UINT32                  UncorrectableSeverity;
538     UINT32                  CorrectableMask;
539     UINT32                  AdvancedCapabilities;
540 
541 } ACPI_HEST_AER_COMMON;
542 
543 /* Masks for HEST Flags fields */
544 
545 #define ACPI_HEST_FIRMWARE_FIRST        (1)
546 #define ACPI_HEST_GLOBAL                (1<<1)
547 
548 /*
549  * Macros to access the bus/segment numbers in Bus field above:
550  *  Bus number is encoded in bits 7:0
551  *  Segment number is encoded in bits 23:8
552  */
553 #define ACPI_HEST_BUS(Bus)              ((Bus) & 0xFF)
554 #define ACPI_HEST_SEGMENT(Bus)          (((Bus) >> 8) & 0xFFFF)
555 
556 
557 /* Hardware Error Notification */
558 
559 typedef struct acpi_hest_notify
560 {
561     UINT8                   Type;
562     UINT8                   Length;
563     UINT16                  ConfigWriteEnable;
564     UINT32                  PollInterval;
565     UINT32                  Vector;
566     UINT32                  PollingThresholdValue;
567     UINT32                  PollingThresholdWindow;
568     UINT32                  ErrorThresholdValue;
569     UINT32                  ErrorThresholdWindow;
570 
571 } ACPI_HEST_NOTIFY;
572 
573 /* Values for Notify Type field above */
574 
575 enum AcpiHestNotifyTypes
576 {
577     ACPI_HEST_NOTIFY_POLLED     = 0,
578     ACPI_HEST_NOTIFY_EXTERNAL   = 1,
579     ACPI_HEST_NOTIFY_LOCAL      = 2,
580     ACPI_HEST_NOTIFY_SCI        = 3,
581     ACPI_HEST_NOTIFY_NMI        = 4,
582     ACPI_HEST_NOTIFY_CMCI       = 5,    /* ACPI 5.0 */
583     ACPI_HEST_NOTIFY_MCE        = 6,    /* ACPI 5.0 */
584     ACPI_HEST_NOTIFY_RESERVED   = 7     /* 7 and greater are reserved */
585 };
586 
587 /* Values for ConfigWriteEnable bitfield above */
588 
589 #define ACPI_HEST_TYPE                  (1)
590 #define ACPI_HEST_POLL_INTERVAL         (1<<1)
591 #define ACPI_HEST_POLL_THRESHOLD_VALUE  (1<<2)
592 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
593 #define ACPI_HEST_ERR_THRESHOLD_VALUE   (1<<4)
594 #define ACPI_HEST_ERR_THRESHOLD_WINDOW  (1<<5)
595 
596 
597 /*
598  * HEST subtables
599  */
600 
601 /* 0: IA32 Machine Check Exception */
602 
603 typedef struct acpi_hest_ia_machine_check
604 {
605     ACPI_HEST_HEADER        Header;
606     UINT16                  Reserved1;
607     UINT8                   Flags;
608     UINT8                   Enabled;
609     UINT32                  RecordsToPreallocate;
610     UINT32                  MaxSectionsPerRecord;
611     UINT64                  GlobalCapabilityData;
612     UINT64                  GlobalControlData;
613     UINT8                   NumHardwareBanks;
614     UINT8                   Reserved3[7];
615 
616 } ACPI_HEST_IA_MACHINE_CHECK;
617 
618 
619 /* 1: IA32 Corrected Machine Check */
620 
621 typedef struct acpi_hest_ia_corrected
622 {
623     ACPI_HEST_HEADER        Header;
624     UINT16                  Reserved1;
625     UINT8                   Flags;
626     UINT8                   Enabled;
627     UINT32                  RecordsToPreallocate;
628     UINT32                  MaxSectionsPerRecord;
629     ACPI_HEST_NOTIFY        Notify;
630     UINT8                   NumHardwareBanks;
631     UINT8                   Reserved2[3];
632 
633 } ACPI_HEST_IA_CORRECTED;
634 
635 
636 /* 2: IA32 Non-Maskable Interrupt */
637 
638 typedef struct acpi_hest_ia_nmi
639 {
640     ACPI_HEST_HEADER        Header;
641     UINT32                  Reserved;
642     UINT32                  RecordsToPreallocate;
643     UINT32                  MaxSectionsPerRecord;
644     UINT32                  MaxRawDataLength;
645 
646 } ACPI_HEST_IA_NMI;
647 
648 
649 /* 3,4,5: Not used */
650 
651 /* 6: PCI Express Root Port AER */
652 
653 typedef struct acpi_hest_aer_root
654 {
655     ACPI_HEST_HEADER        Header;
656     ACPI_HEST_AER_COMMON    Aer;
657     UINT32                  RootErrorCommand;
658 
659 } ACPI_HEST_AER_ROOT;
660 
661 
662 /* 7: PCI Express AER (AER Endpoint) */
663 
664 typedef struct acpi_hest_aer
665 {
666     ACPI_HEST_HEADER        Header;
667     ACPI_HEST_AER_COMMON    Aer;
668 
669 } ACPI_HEST_AER;
670 
671 
672 /* 8: PCI Express/PCI-X Bridge AER */
673 
674 typedef struct acpi_hest_aer_bridge
675 {
676     ACPI_HEST_HEADER        Header;
677     ACPI_HEST_AER_COMMON    Aer;
678     UINT32                  UncorrectableMask2;
679     UINT32                  UncorrectableSeverity2;
680     UINT32                  AdvancedCapabilities2;
681 
682 } ACPI_HEST_AER_BRIDGE;
683 
684 
685 /* 9: Generic Hardware Error Source */
686 
687 typedef struct acpi_hest_generic
688 {
689     ACPI_HEST_HEADER        Header;
690     UINT16                  RelatedSourceId;
691     UINT8                   Reserved;
692     UINT8                   Enabled;
693     UINT32                  RecordsToPreallocate;
694     UINT32                  MaxSectionsPerRecord;
695     UINT32                  MaxRawDataLength;
696     ACPI_GENERIC_ADDRESS    ErrorStatusAddress;
697     ACPI_HEST_NOTIFY        Notify;
698     UINT32                  ErrorBlockLength;
699 
700 } ACPI_HEST_GENERIC;
701 
702 
703 /* 10: Generic Hardware Error Source, version 2 */
704 
705 typedef struct acpi_hest_generic_v2
706 {
707     ACPI_HEST_HEADER        Header;
708     UINT16                  RelatedSourceId;
709     UINT8                   Reserved;
710     UINT8                   Enabled;
711     UINT32                  RecordsToPreallocate;
712     UINT32                  MaxSectionsPerRecord;
713     UINT32                  MaxRawDataLength;
714     ACPI_GENERIC_ADDRESS    ErrorStatusAddress;
715     ACPI_HEST_NOTIFY        Notify;
716     UINT32                  ErrorBlockLength;
717     ACPI_GENERIC_ADDRESS    ReadAckRegister;
718     UINT64                  ReadAckPreserve;
719     UINT64                  ReadAckWrite;
720 
721 } ACPI_HEST_GENERIC_V2;
722 
723 
724 /* Generic Error Status block */
725 
726 typedef struct acpi_hest_generic_status
727 {
728     UINT32                  BlockStatus;
729     UINT32                  RawDataOffset;
730     UINT32                  RawDataLength;
731     UINT32                  DataLength;
732     UINT32                  ErrorSeverity;
733 
734 } ACPI_HEST_GENERIC_STATUS;
735 
736 /* Values for BlockStatus flags above */
737 
738 #define ACPI_HEST_UNCORRECTABLE             (1)
739 #define ACPI_HEST_CORRECTABLE               (1<<1)
740 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE    (1<<2)
741 #define ACPI_HEST_MULTIPLE_CORRECTABLE      (1<<3)
742 #define ACPI_HEST_ERROR_ENTRY_COUNT         (0xFF<<4) /* 8 bits, error count */
743 
744 
745 /* Generic Error Data entry */
746 
747 typedef struct acpi_hest_generic_data
748 {
749     UINT8                   SectionType[16];
750     UINT32                  ErrorSeverity;
751     UINT16                  Revision;
752     UINT8                   ValidationBits;
753     UINT8                   Flags;
754     UINT32                  ErrorDataLength;
755     UINT8                   FruId[16];
756     UINT8                   FruText[20];
757     UINT64                  TimeStamp;
758 
759 } ACPI_HEST_GENERIC_DATA;
760 
761 
762 /*******************************************************************************
763  *
764  * MADT - Multiple APIC Description Table
765  *        Version 3
766  *
767  ******************************************************************************/
768 
769 typedef struct acpi_table_madt
770 {
771     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
772     UINT32                  Address;            /* Physical address of local APIC */
773     UINT32                  Flags;
774 
775 } ACPI_TABLE_MADT;
776 
777 /* Masks for Flags field above */
778 
779 #define ACPI_MADT_PCAT_COMPAT       (1)         /* 00: System also has dual 8259s */
780 
781 /* Values for PCATCompat flag */
782 
783 #define ACPI_MADT_DUAL_PIC          0
784 #define ACPI_MADT_MULTIPLE_APIC     1
785 
786 
787 /* Values for MADT subtable type in ACPI_SUBTABLE_HEADER */
788 
789 enum AcpiMadtType
790 {
791     ACPI_MADT_TYPE_LOCAL_APIC               = 0,
792     ACPI_MADT_TYPE_IO_APIC                  = 1,
793     ACPI_MADT_TYPE_INTERRUPT_OVERRIDE       = 2,
794     ACPI_MADT_TYPE_NMI_SOURCE               = 3,
795     ACPI_MADT_TYPE_LOCAL_APIC_NMI           = 4,
796     ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE      = 5,
797     ACPI_MADT_TYPE_IO_SAPIC                 = 6,
798     ACPI_MADT_TYPE_LOCAL_SAPIC              = 7,
799     ACPI_MADT_TYPE_INTERRUPT_SOURCE         = 8,
800     ACPI_MADT_TYPE_LOCAL_X2APIC             = 9,
801     ACPI_MADT_TYPE_LOCAL_X2APIC_NMI         = 10,
802     ACPI_MADT_TYPE_GENERIC_INTERRUPT        = 11,
803     ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR      = 12,
804     ACPI_MADT_TYPE_GENERIC_MSI_FRAME        = 13,
805     ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR    = 14,
806     ACPI_MADT_TYPE_GENERIC_TRANSLATOR       = 15,
807     ACPI_MADT_TYPE_RESERVED                 = 16    /* 16 and greater are reserved */
808 };
809 
810 
811 /*
812  * MADT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
813  */
814 
815 /* 0: Processor Local APIC */
816 
817 typedef struct acpi_madt_local_apic
818 {
819     ACPI_SUBTABLE_HEADER    Header;
820     UINT8                   ProcessorId;        /* ACPI processor id */
821     UINT8                   Id;                 /* Processor's local APIC id */
822     UINT32                  LapicFlags;
823 
824 } ACPI_MADT_LOCAL_APIC;
825 
826 
827 /* 1: IO APIC */
828 
829 typedef struct acpi_madt_io_apic
830 {
831     ACPI_SUBTABLE_HEADER    Header;
832     UINT8                   Id;                 /* I/O APIC ID */
833     UINT8                   Reserved;           /* Reserved - must be zero */
834     UINT32                  Address;            /* APIC physical address */
835     UINT32                  GlobalIrqBase;      /* Global system interrupt where INTI lines start */
836 
837 } ACPI_MADT_IO_APIC;
838 
839 
840 /* 2: Interrupt Override */
841 
842 typedef struct acpi_madt_interrupt_override
843 {
844     ACPI_SUBTABLE_HEADER    Header;
845     UINT8                   Bus;                /* 0 - ISA */
846     UINT8                   SourceIrq;          /* Interrupt source (IRQ) */
847     UINT32                  GlobalIrq;          /* Global system interrupt */
848     UINT16                  IntiFlags;
849 
850 } ACPI_MADT_INTERRUPT_OVERRIDE;
851 
852 
853 /* 3: NMI Source */
854 
855 typedef struct acpi_madt_nmi_source
856 {
857     ACPI_SUBTABLE_HEADER    Header;
858     UINT16                  IntiFlags;
859     UINT32                  GlobalIrq;          /* Global system interrupt */
860 
861 } ACPI_MADT_NMI_SOURCE;
862 
863 
864 /* 4: Local APIC NMI */
865 
866 typedef struct acpi_madt_local_apic_nmi
867 {
868     ACPI_SUBTABLE_HEADER    Header;
869     UINT8                   ProcessorId;        /* ACPI processor id */
870     UINT16                  IntiFlags;
871     UINT8                   Lint;               /* LINTn to which NMI is connected */
872 
873 } ACPI_MADT_LOCAL_APIC_NMI;
874 
875 
876 /* 5: Address Override */
877 
878 typedef struct acpi_madt_local_apic_override
879 {
880     ACPI_SUBTABLE_HEADER    Header;
881     UINT16                  Reserved;           /* Reserved, must be zero */
882     UINT64                  Address;            /* APIC physical address */
883 
884 } ACPI_MADT_LOCAL_APIC_OVERRIDE;
885 
886 
887 /* 6: I/O Sapic */
888 
889 typedef struct acpi_madt_io_sapic
890 {
891     ACPI_SUBTABLE_HEADER    Header;
892     UINT8                   Id;                 /* I/O SAPIC ID */
893     UINT8                   Reserved;           /* Reserved, must be zero */
894     UINT32                  GlobalIrqBase;      /* Global interrupt for SAPIC start */
895     UINT64                  Address;            /* SAPIC physical address */
896 
897 } ACPI_MADT_IO_SAPIC;
898 
899 
900 /* 7: Local Sapic */
901 
902 typedef struct acpi_madt_local_sapic
903 {
904     ACPI_SUBTABLE_HEADER    Header;
905     UINT8                   ProcessorId;        /* ACPI processor id */
906     UINT8                   Id;                 /* SAPIC ID */
907     UINT8                   Eid;                /* SAPIC EID */
908     UINT8                   Reserved[3];        /* Reserved, must be zero */
909     UINT32                  LapicFlags;
910     UINT32                  Uid;                /* Numeric UID - ACPI 3.0 */
911     char                    UidString[1];       /* String UID  - ACPI 3.0 */
912 
913 } ACPI_MADT_LOCAL_SAPIC;
914 
915 
916 /* 8: Platform Interrupt Source */
917 
918 typedef struct acpi_madt_interrupt_source
919 {
920     ACPI_SUBTABLE_HEADER    Header;
921     UINT16                  IntiFlags;
922     UINT8                   Type;               /* 1=PMI, 2=INIT, 3=corrected */
923     UINT8                   Id;                 /* Processor ID */
924     UINT8                   Eid;                /* Processor EID */
925     UINT8                   IoSapicVector;      /* Vector value for PMI interrupts */
926     UINT32                  GlobalIrq;          /* Global system interrupt */
927     UINT32                  Flags;              /* Interrupt Source Flags */
928 
929 } ACPI_MADT_INTERRUPT_SOURCE;
930 
931 /* Masks for Flags field above */
932 
933 #define ACPI_MADT_CPEI_OVERRIDE     (1)
934 
935 
936 /* 9: Processor Local X2APIC (ACPI 4.0) */
937 
938 typedef struct acpi_madt_local_x2apic
939 {
940     ACPI_SUBTABLE_HEADER    Header;
941     UINT16                  Reserved;           /* Reserved - must be zero */
942     UINT32                  LocalApicId;        /* Processor x2APIC ID  */
943     UINT32                  LapicFlags;
944     UINT32                  Uid;                /* ACPI processor UID */
945 
946 } ACPI_MADT_LOCAL_X2APIC;
947 
948 
949 /* 10: Local X2APIC NMI (ACPI 4.0) */
950 
951 typedef struct acpi_madt_local_x2apic_nmi
952 {
953     ACPI_SUBTABLE_HEADER    Header;
954     UINT16                  IntiFlags;
955     UINT32                  Uid;                /* ACPI processor UID */
956     UINT8                   Lint;               /* LINTn to which NMI is connected */
957     UINT8                   Reserved[3];        /* Reserved - must be zero */
958 
959 } ACPI_MADT_LOCAL_X2APIC_NMI;
960 
961 
962 /* 11: Generic Interrupt (ACPI 5.0 + ACPI 6.0 changes) */
963 
964 typedef struct acpi_madt_generic_interrupt
965 {
966     ACPI_SUBTABLE_HEADER    Header;
967     UINT16                  Reserved;           /* Reserved - must be zero */
968     UINT32                  CpuInterfaceNumber;
969     UINT32                  Uid;
970     UINT32                  Flags;
971     UINT32                  ParkingVersion;
972     UINT32                  PerformanceInterrupt;
973     UINT64                  ParkedAddress;
974     UINT64                  BaseAddress;
975     UINT64                  GicvBaseAddress;
976     UINT64                  GichBaseAddress;
977     UINT32                  VgicInterrupt;
978     UINT64                  GicrBaseAddress;
979     UINT64                  ArmMpidr;
980     UINT8                   EfficiencyClass;
981     UINT8                   Reserved2[3];
982 
983 } ACPI_MADT_GENERIC_INTERRUPT;
984 
985 /* Masks for Flags field above */
986 
987 /* ACPI_MADT_ENABLED                    (1)      Processor is usable if set */
988 #define ACPI_MADT_PERFORMANCE_IRQ_MODE  (1<<1)  /* 01: Performance Interrupt Mode */
989 #define ACPI_MADT_VGIC_IRQ_MODE         (1<<2)  /* 02: VGIC Maintenance Interrupt mode */
990 
991 
992 /* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
993 
994 typedef struct acpi_madt_generic_distributor
995 {
996     ACPI_SUBTABLE_HEADER    Header;
997     UINT16                  Reserved;           /* Reserved - must be zero */
998     UINT32                  GicId;
999     UINT64                  BaseAddress;
1000     UINT32                  GlobalIrqBase;
1001     UINT8                   Version;
1002     UINT8                   Reserved2[3];       /* Reserved - must be zero */
1003 
1004 } ACPI_MADT_GENERIC_DISTRIBUTOR;
1005 
1006 /* Values for Version field above */
1007 
1008 enum AcpiMadtGicVersion
1009 {
1010     ACPI_MADT_GIC_VERSION_NONE          = 0,
1011     ACPI_MADT_GIC_VERSION_V1            = 1,
1012     ACPI_MADT_GIC_VERSION_V2            = 2,
1013     ACPI_MADT_GIC_VERSION_V3            = 3,
1014     ACPI_MADT_GIC_VERSION_V4            = 4,
1015     ACPI_MADT_GIC_VERSION_RESERVED      = 5     /* 5 and greater are reserved */
1016 };
1017 
1018 
1019 /* 13: Generic MSI Frame (ACPI 5.1) */
1020 
1021 typedef struct acpi_madt_generic_msi_frame
1022 {
1023     ACPI_SUBTABLE_HEADER    Header;
1024     UINT16                  Reserved;           /* Reserved - must be zero */
1025     UINT32                  MsiFrameId;
1026     UINT64                  BaseAddress;
1027     UINT32                  Flags;
1028     UINT16                  SpiCount;
1029     UINT16                  SpiBase;
1030 
1031 } ACPI_MADT_GENERIC_MSI_FRAME;
1032 
1033 /* Masks for Flags field above */
1034 
1035 #define ACPI_MADT_OVERRIDE_SPI_VALUES   (1)
1036 
1037 
1038 /* 14: Generic Redistributor (ACPI 5.1) */
1039 
1040 typedef struct acpi_madt_generic_redistributor
1041 {
1042     ACPI_SUBTABLE_HEADER    Header;
1043     UINT16                  Reserved;           /* reserved - must be zero */
1044     UINT64                  BaseAddress;
1045     UINT32                  Length;
1046 
1047 } ACPI_MADT_GENERIC_REDISTRIBUTOR;
1048 
1049 
1050 /* 15: Generic Translator (ACPI 6.0) */
1051 
1052 typedef struct acpi_madt_generic_translator
1053 {
1054     ACPI_SUBTABLE_HEADER    Header;
1055     UINT16                  Reserved;           /* reserved - must be zero */
1056     UINT32                  TranslationId;
1057     UINT64                  BaseAddress;
1058     UINT32                  Reserved2;
1059 
1060 } ACPI_MADT_GENERIC_TRANSLATOR;
1061 
1062 
1063 /*
1064  * Common flags fields for MADT subtables
1065  */
1066 
1067 /* MADT Local APIC flags */
1068 
1069 #define ACPI_MADT_ENABLED           (1)         /* 00: Processor is usable if set */
1070 
1071 /* MADT MPS INTI flags (IntiFlags) */
1072 
1073 #define ACPI_MADT_POLARITY_MASK     (3)         /* 00-01: Polarity of APIC I/O input signals */
1074 #define ACPI_MADT_TRIGGER_MASK      (3<<2)      /* 02-03: Trigger mode of APIC input signals */
1075 
1076 /* Values for MPS INTI flags */
1077 
1078 #define ACPI_MADT_POLARITY_CONFORMS       0
1079 #define ACPI_MADT_POLARITY_ACTIVE_HIGH    1
1080 #define ACPI_MADT_POLARITY_RESERVED       2
1081 #define ACPI_MADT_POLARITY_ACTIVE_LOW     3
1082 
1083 #define ACPI_MADT_TRIGGER_CONFORMS        (0)
1084 #define ACPI_MADT_TRIGGER_EDGE            (1<<2)
1085 #define ACPI_MADT_TRIGGER_RESERVED        (2<<2)
1086 #define ACPI_MADT_TRIGGER_LEVEL           (3<<2)
1087 
1088 
1089 /*******************************************************************************
1090  *
1091  * MSCT - Maximum System Characteristics Table (ACPI 4.0)
1092  *        Version 1
1093  *
1094  ******************************************************************************/
1095 
1096 typedef struct acpi_table_msct
1097 {
1098     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1099     UINT32                  ProximityOffset;    /* Location of proximity info struct(s) */
1100     UINT32                  MaxProximityDomains;/* Max number of proximity domains */
1101     UINT32                  MaxClockDomains;    /* Max number of clock domains */
1102     UINT64                  MaxAddress;         /* Max physical address in system */
1103 
1104 } ACPI_TABLE_MSCT;
1105 
1106 
1107 /* Subtable - Maximum Proximity Domain Information. Version 1 */
1108 
1109 typedef struct acpi_msct_proximity
1110 {
1111     UINT8                   Revision;
1112     UINT8                   Length;
1113     UINT32                  RangeStart;         /* Start of domain range */
1114     UINT32                  RangeEnd;           /* End of domain range */
1115     UINT32                  ProcessorCapacity;
1116     UINT64                  MemoryCapacity;     /* In bytes */
1117 
1118 } ACPI_MSCT_PROXIMITY;
1119 
1120 
1121 /*******************************************************************************
1122  *
1123  * NFIT - NVDIMM Interface Table (ACPI 6.0)
1124  *        Version 1
1125  *
1126  ******************************************************************************/
1127 
1128 typedef struct acpi_table_nfit
1129 {
1130     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1131     UINT32                  Reserved;           /* Reserved, must be zero */
1132 
1133 } ACPI_TABLE_NFIT;
1134 
1135 /* Subtable header for NFIT */
1136 
1137 typedef struct acpi_nfit_header
1138 {
1139     UINT16                   Type;
1140     UINT16                   Length;
1141 
1142 } ACPI_NFIT_HEADER;
1143 
1144 
1145 /* Values for subtable type in ACPI_NFIT_HEADER */
1146 
1147 enum AcpiNfitType
1148 {
1149     ACPI_NFIT_TYPE_SYSTEM_ADDRESS       = 0,
1150     ACPI_NFIT_TYPE_MEMORY_MAP           = 1,
1151     ACPI_NFIT_TYPE_INTERLEAVE           = 2,
1152     ACPI_NFIT_TYPE_SMBIOS               = 3,
1153     ACPI_NFIT_TYPE_CONTROL_REGION       = 4,
1154     ACPI_NFIT_TYPE_DATA_REGION          = 5,
1155     ACPI_NFIT_TYPE_FLUSH_ADDRESS        = 6,
1156     ACPI_NFIT_TYPE_RESERVED             = 7     /* 7 and greater are reserved */
1157 };
1158 
1159 /*
1160  * NFIT Subtables
1161  */
1162 
1163 /* 0: System Physical Address Range Structure */
1164 
1165 typedef struct acpi_nfit_system_address
1166 {
1167     ACPI_NFIT_HEADER        Header;
1168     UINT16                  RangeIndex;
1169     UINT16                  Flags;
1170     UINT32                  Reserved;           /* Reseved, must be zero */
1171     UINT32                  ProximityDomain;
1172     UINT8                   RangeGuid[16];
1173     UINT64                  Address;
1174     UINT64                  Length;
1175     UINT64                  MemoryMapping;
1176 
1177 } ACPI_NFIT_SYSTEM_ADDRESS;
1178 
1179 /* Flags */
1180 
1181 #define ACPI_NFIT_ADD_ONLINE_ONLY       (1)     /* 00: Add/Online Operation Only */
1182 #define ACPI_NFIT_PROXIMITY_VALID       (1<<1)  /* 01: Proximity Domain Valid */
1183 
1184 /* Range Type GUIDs appear in the include/acuuid.h file */
1185 
1186 
1187 /* 1: Memory Device to System Address Range Map Structure */
1188 
1189 typedef struct acpi_nfit_memory_map
1190 {
1191     ACPI_NFIT_HEADER        Header;
1192     UINT32                  DeviceHandle;
1193     UINT16                  PhysicalId;
1194     UINT16                  RegionId;
1195     UINT16                  RangeIndex;
1196     UINT16                  RegionIndex;
1197     UINT64                  RegionSize;
1198     UINT64                  RegionOffset;
1199     UINT64                  Address;
1200     UINT16                  InterleaveIndex;
1201     UINT16                  InterleaveWays;
1202     UINT16                  Flags;
1203     UINT16                  Reserved;           /* Reserved, must be zero */
1204 
1205 } ACPI_NFIT_MEMORY_MAP;
1206 
1207 /* Flags */
1208 
1209 #define ACPI_NFIT_MEM_SAVE_FAILED       (1)     /* 00: Last SAVE to Memory Device failed */
1210 #define ACPI_NFIT_MEM_RESTORE_FAILED    (1<<1)  /* 01: Last RESTORE from Memory Device failed */
1211 #define ACPI_NFIT_MEM_FLUSH_FAILED      (1<<2)  /* 02: Platform flush failed */
1212 #define ACPI_NFIT_MEM_NOT_ARMED         (1<<3)  /* 03: Memory Device is not armed */
1213 #define ACPI_NFIT_MEM_HEALTH_OBSERVED   (1<<4)  /* 04: Memory Device observed SMART/health events */
1214 #define ACPI_NFIT_MEM_HEALTH_ENABLED    (1<<5)  /* 05: SMART/health events enabled */
1215 #define ACPI_NFIT_MEM_MAP_FAILED        (1<<6)  /* 06: Mapping to SPA failed */
1216 
1217 
1218 /* 2: Interleave Structure */
1219 
1220 typedef struct acpi_nfit_interleave
1221 {
1222     ACPI_NFIT_HEADER        Header;
1223     UINT16                  InterleaveIndex;
1224     UINT16                  Reserved;           /* Reserved, must be zero */
1225     UINT32                  LineCount;
1226     UINT32                  LineSize;
1227     UINT32                  LineOffset[1];      /* Variable length */
1228 
1229 } ACPI_NFIT_INTERLEAVE;
1230 
1231 
1232 /* 3: SMBIOS Management Information Structure */
1233 
1234 typedef struct acpi_nfit_smbios
1235 {
1236     ACPI_NFIT_HEADER        Header;
1237     UINT32                  Reserved;           /* Reserved, must be zero */
1238     UINT8                   Data[1];            /* Variable length */
1239 
1240 } ACPI_NFIT_SMBIOS;
1241 
1242 
1243 /* 4: NVDIMM Control Region Structure */
1244 
1245 typedef struct acpi_nfit_control_region
1246 {
1247     ACPI_NFIT_HEADER        Header;
1248     UINT16                  RegionIndex;
1249     UINT16                  VendorId;
1250     UINT16                  DeviceId;
1251     UINT16                  RevisionId;
1252     UINT16                  SubsystemVendorId;
1253     UINT16                  SubsystemDeviceId;
1254     UINT16                  SubsystemRevisionId;
1255     UINT8                   Reserved[6];        /* Reserved, must be zero */
1256     UINT32                  SerialNumber;
1257     UINT16                  Code;
1258     UINT16                  Windows;
1259     UINT64                  WindowSize;
1260     UINT64                  CommandOffset;
1261     UINT64                  CommandSize;
1262     UINT64                  StatusOffset;
1263     UINT64                  StatusSize;
1264     UINT16                  Flags;
1265     UINT8                   Reserved1[6];       /* Reserved, must be zero */
1266 
1267 } ACPI_NFIT_CONTROL_REGION;
1268 
1269 /* Flags */
1270 
1271 #define ACPI_NFIT_CONTROL_BUFFERED      (1)     /* Block Data Windows implementation is buffered */
1272 
1273 
1274 /* 5: NVDIMM Block Data Window Region Structure */
1275 
1276 typedef struct acpi_nfit_data_region
1277 {
1278     ACPI_NFIT_HEADER        Header;
1279     UINT16                  RegionIndex;
1280     UINT16                  Windows;
1281     UINT64                  Offset;
1282     UINT64                  Size;
1283     UINT64                  Capacity;
1284     UINT64                  StartAddress;
1285 
1286 } ACPI_NFIT_DATA_REGION;
1287 
1288 
1289 /* 6: Flush Hint Address Structure */
1290 
1291 typedef struct acpi_nfit_flush_address
1292 {
1293     ACPI_NFIT_HEADER        Header;
1294     UINT32                  DeviceHandle;
1295     UINT16                  HintCount;
1296     UINT8                   Reserved[6];        /* Reserved, must be zero */
1297     UINT64                  HintAddress[1];     /* Variable length */
1298 
1299 } ACPI_NFIT_FLUSH_ADDRESS;
1300 
1301 
1302 /*******************************************************************************
1303  *
1304  * SBST - Smart Battery Specification Table
1305  *        Version 1
1306  *
1307  ******************************************************************************/
1308 
1309 typedef struct acpi_table_sbst
1310 {
1311     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1312     UINT32                  WarningLevel;
1313     UINT32                  LowLevel;
1314     UINT32                  CriticalLevel;
1315 
1316 } ACPI_TABLE_SBST;
1317 
1318 
1319 /*******************************************************************************
1320  *
1321  * SLIT - System Locality Distance Information Table
1322  *        Version 1
1323  *
1324  ******************************************************************************/
1325 
1326 typedef struct acpi_table_slit
1327 {
1328     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1329     UINT64                  LocalityCount;
1330     UINT8                   Entry[1];           /* Real size = localities^2 */
1331 
1332 } ACPI_TABLE_SLIT;
1333 
1334 
1335 /*******************************************************************************
1336  *
1337  * SRAT - System Resource Affinity Table
1338  *        Version 3
1339  *
1340  ******************************************************************************/
1341 
1342 typedef struct acpi_table_srat
1343 {
1344     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1345     UINT32                  TableRevision;      /* Must be value '1' */
1346     UINT64                  Reserved;           /* Reserved, must be zero */
1347 
1348 } ACPI_TABLE_SRAT;
1349 
1350 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
1351 
1352 enum AcpiSratType
1353 {
1354     ACPI_SRAT_TYPE_CPU_AFFINITY         = 0,
1355     ACPI_SRAT_TYPE_MEMORY_AFFINITY      = 1,
1356     ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY  = 2,
1357     ACPI_SRAT_TYPE_GICC_AFFINITY        = 3,
1358     ACPI_SRAT_TYPE_RESERVED             = 4     /* 4 and greater are reserved */
1359 };
1360 
1361 /*
1362  * SRAT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
1363  */
1364 
1365 /* 0: Processor Local APIC/SAPIC Affinity */
1366 
1367 typedef struct acpi_srat_cpu_affinity
1368 {
1369     ACPI_SUBTABLE_HEADER    Header;
1370     UINT8                   ProximityDomainLo;
1371     UINT8                   ApicId;
1372     UINT32                  Flags;
1373     UINT8                   LocalSapicEid;
1374     UINT8                   ProximityDomainHi[3];
1375     UINT32                  ClockDomain;
1376 
1377 } ACPI_SRAT_CPU_AFFINITY;
1378 
1379 /* Flags */
1380 
1381 #define ACPI_SRAT_CPU_USE_AFFINITY  (1)         /* 00: Use affinity structure */
1382 
1383 
1384 /* 1: Memory Affinity */
1385 
1386 typedef struct acpi_srat_mem_affinity
1387 {
1388     ACPI_SUBTABLE_HEADER    Header;
1389     UINT32                  ProximityDomain;
1390     UINT16                  Reserved;           /* Reserved, must be zero */
1391     UINT64                  BaseAddress;
1392     UINT64                  Length;
1393     UINT32                  Reserved1;
1394     UINT32                  Flags;
1395     UINT64                  Reserved2;          /* Reserved, must be zero */
1396 
1397 } ACPI_SRAT_MEM_AFFINITY;
1398 
1399 /* Flags */
1400 
1401 #define ACPI_SRAT_MEM_ENABLED       (1)         /* 00: Use affinity structure */
1402 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1)      /* 01: Memory region is hot pluggable */
1403 #define ACPI_SRAT_MEM_NON_VOLATILE  (1<<2)      /* 02: Memory region is non-volatile */
1404 
1405 
1406 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
1407 
1408 typedef struct acpi_srat_x2apic_cpu_affinity
1409 {
1410     ACPI_SUBTABLE_HEADER    Header;
1411     UINT16                  Reserved;           /* Reserved, must be zero */
1412     UINT32                  ProximityDomain;
1413     UINT32                  ApicId;
1414     UINT32                  Flags;
1415     UINT32                  ClockDomain;
1416     UINT32                  Reserved2;
1417 
1418 } ACPI_SRAT_X2APIC_CPU_AFFINITY;
1419 
1420 /* Flags for ACPI_SRAT_CPU_AFFINITY and ACPI_SRAT_X2APIC_CPU_AFFINITY */
1421 
1422 #define ACPI_SRAT_CPU_ENABLED       (1)         /* 00: Use affinity structure */
1423 
1424 
1425 /* 3: GICC Affinity (ACPI 5.1) */
1426 
1427 typedef struct acpi_srat_gicc_affinity
1428 {
1429     ACPI_SUBTABLE_HEADER    Header;
1430     UINT32                  ProximityDomain;
1431     UINT32                  AcpiProcessorUid;
1432     UINT32                  Flags;
1433     UINT32                  ClockDomain;
1434 
1435 } ACPI_SRAT_GICC_AFFINITY;
1436 
1437 /* Flags for ACPI_SRAT_GICC_AFFINITY */
1438 
1439 #define ACPI_SRAT_GICC_ENABLED     (1)         /* 00: Use affinity structure */
1440 
1441 
1442 /* Reset to default packing */
1443 
1444 #pragma pack()
1445 
1446 #endif /* __ACTBL1_H__ */
1447