xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/include/actbl1.h (revision 204dee708a999d5a71d0cb9497650ee7cef85d0a)
1 /******************************************************************************
2  *
3  * Name: actbl1.h - Additional ACPI table definitions
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #ifndef __ACTBL1_H__
117 #define __ACTBL1_H__
118 
119 
120 /*******************************************************************************
121  *
122  * Additional ACPI Tables (1)
123  *
124  * These tables are not consumed directly by the ACPICA subsystem, but are
125  * included here to support device drivers and the AML disassembler.
126  *
127  * The tables in this file are fully defined within the ACPI specification.
128  *
129  ******************************************************************************/
130 
131 
132 /*
133  * Values for description table header signatures for tables defined in this
134  * file. Useful because they make it more difficult to inadvertently type in
135  * the wrong signature.
136  */
137 #define ACPI_SIG_BERT           "BERT"      /* Boot Error Record Table */
138 #define ACPI_SIG_CPEP           "CPEP"      /* Corrected Platform Error Polling table */
139 #define ACPI_SIG_ECDT           "ECDT"      /* Embedded Controller Boot Resources Table */
140 #define ACPI_SIG_EINJ           "EINJ"      /* Error Injection table */
141 #define ACPI_SIG_ERST           "ERST"      /* Error Record Serialization Table */
142 #define ACPI_SIG_HEST           "HEST"      /* Hardware Error Source Table */
143 #define ACPI_SIG_MADT           "APIC"      /* Multiple APIC Description Table */
144 #define ACPI_SIG_MSCT           "MSCT"      /* Maximum System Characteristics Table */
145 #define ACPI_SIG_SBST           "SBST"      /* Smart Battery Specification Table */
146 #define ACPI_SIG_SLIT           "SLIT"      /* System Locality Distance Information Table */
147 #define ACPI_SIG_SRAT           "SRAT"      /* System Resource Affinity Table */
148 
149 
150 /*
151  * All tables must be byte-packed to match the ACPI specification, since
152  * the tables are provided by the system BIOS.
153  */
154 #pragma pack(1)
155 
156 /*
157  * Note: C bitfields are not used for this reason:
158  *
159  * "Bitfields are great and easy to read, but unfortunately the C language
160  * does not specify the layout of bitfields in memory, which means they are
161  * essentially useless for dealing with packed data in on-disk formats or
162  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
163  * this decision was a design error in C. Ritchie could have picked an order
164  * and stuck with it." Norman Ramsey.
165  * See http://stackoverflow.com/a/1053662/41661
166  */
167 
168 
169 /*******************************************************************************
170  *
171  * Common subtable headers
172  *
173  ******************************************************************************/
174 
175 /* Generic subtable header (used in MADT, SRAT, etc.) */
176 
177 typedef struct acpi_subtable_header
178 {
179     UINT8                   Type;
180     UINT8                   Length;
181 
182 } ACPI_SUBTABLE_HEADER;
183 
184 
185 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
186 
187 typedef struct acpi_whea_header
188 {
189     UINT8                   Action;
190     UINT8                   Instruction;
191     UINT8                   Flags;
192     UINT8                   Reserved;
193     ACPI_GENERIC_ADDRESS    RegisterRegion;
194     UINT64                  Value;              /* Value used with Read/Write register */
195     UINT64                  Mask;               /* Bitmask required for this register instruction */
196 
197 } ACPI_WHEA_HEADER;
198 
199 
200 /*******************************************************************************
201  *
202  * BERT - Boot Error Record Table (ACPI 4.0)
203  *        Version 1
204  *
205  ******************************************************************************/
206 
207 typedef struct acpi_table_bert
208 {
209     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
210     UINT32                  RegionLength;       /* Length of the boot error region */
211     UINT64                  Address;            /* Physical address of the error region */
212 
213 } ACPI_TABLE_BERT;
214 
215 
216 /* Boot Error Region (not a subtable, pointed to by Address field above) */
217 
218 typedef struct acpi_bert_region
219 {
220     UINT32                  BlockStatus;        /* Type of error information */
221     UINT32                  RawDataOffset;      /* Offset to raw error data */
222     UINT32                  RawDataLength;      /* Length of raw error data */
223     UINT32                  DataLength;         /* Length of generic error data */
224     UINT32                  ErrorSeverity;      /* Severity code */
225 
226 } ACPI_BERT_REGION;
227 
228 /* Values for BlockStatus flags above */
229 
230 #define ACPI_BERT_UNCORRECTABLE             (1)
231 #define ACPI_BERT_CORRECTABLE               (1<<1)
232 #define ACPI_BERT_MULTIPLE_UNCORRECTABLE    (1<<2)
233 #define ACPI_BERT_MULTIPLE_CORRECTABLE      (1<<3)
234 #define ACPI_BERT_ERROR_ENTRY_COUNT         (0xFF<<4) /* 8 bits, error count */
235 
236 /* Values for ErrorSeverity above */
237 
238 enum AcpiBertErrorSeverity
239 {
240     ACPI_BERT_ERROR_CORRECTABLE     = 0,
241     ACPI_BERT_ERROR_FATAL           = 1,
242     ACPI_BERT_ERROR_CORRECTED       = 2,
243     ACPI_BERT_ERROR_NONE            = 3,
244     ACPI_BERT_ERROR_RESERVED        = 4     /* 4 and greater are reserved */
245 };
246 
247 /*
248  * Note: The generic error data that follows the ErrorSeverity field above
249  * uses the ACPI_HEST_GENERIC_DATA defined under the HEST table below
250  */
251 
252 
253 /*******************************************************************************
254  *
255  * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
256  *        Version 1
257  *
258  ******************************************************************************/
259 
260 typedef struct acpi_table_cpep
261 {
262     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
263     UINT64                  Reserved;
264 
265 } ACPI_TABLE_CPEP;
266 
267 
268 /* Subtable */
269 
270 typedef struct acpi_cpep_polling
271 {
272     ACPI_SUBTABLE_HEADER    Header;
273     UINT8                   Id;                 /* Processor ID */
274     UINT8                   Eid;                /* Processor EID */
275     UINT32                  Interval;           /* Polling interval (msec) */
276 
277 } ACPI_CPEP_POLLING;
278 
279 
280 /*******************************************************************************
281  *
282  * ECDT - Embedded Controller Boot Resources Table
283  *        Version 1
284  *
285  ******************************************************************************/
286 
287 typedef struct acpi_table_ecdt
288 {
289     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
290     ACPI_GENERIC_ADDRESS    Control;            /* Address of EC command/status register */
291     ACPI_GENERIC_ADDRESS    Data;               /* Address of EC data register */
292     UINT32                  Uid;                /* Unique ID - must be same as the EC _UID method */
293     UINT8                   Gpe;                /* The GPE for the EC */
294     UINT8                   Id[1];              /* Full namepath of the EC in the ACPI namespace */
295 
296 } ACPI_TABLE_ECDT;
297 
298 
299 /*******************************************************************************
300  *
301  * EINJ - Error Injection Table (ACPI 4.0)
302  *        Version 1
303  *
304  ******************************************************************************/
305 
306 typedef struct acpi_table_einj
307 {
308     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
309     UINT32                  HeaderLength;
310     UINT8                   Flags;
311     UINT8                   Reserved[3];
312     UINT32                  Entries;
313 
314 } ACPI_TABLE_EINJ;
315 
316 
317 /* EINJ Injection Instruction Entries (actions) */
318 
319 typedef struct acpi_einj_entry
320 {
321     ACPI_WHEA_HEADER        WheaHeader;         /* Common header for WHEA tables */
322 
323 } ACPI_EINJ_ENTRY;
324 
325 /* Masks for Flags field above */
326 
327 #define ACPI_EINJ_PRESERVE          (1)
328 
329 /* Values for Action field above */
330 
331 enum AcpiEinjActions
332 {
333     ACPI_EINJ_BEGIN_OPERATION               = 0,
334     ACPI_EINJ_GET_TRIGGER_TABLE             = 1,
335     ACPI_EINJ_SET_ERROR_TYPE                = 2,
336     ACPI_EINJ_GET_ERROR_TYPE                = 3,
337     ACPI_EINJ_END_OPERATION                 = 4,
338     ACPI_EINJ_EXECUTE_OPERATION             = 5,
339     ACPI_EINJ_CHECK_BUSY_STATUS             = 6,
340     ACPI_EINJ_GET_COMMAND_STATUS            = 7,
341     ACPI_EINJ_SET_ERROR_TYPE_WITH_ADDRESS   = 8,
342     ACPI_EINJ_ACTION_RESERVED               = 9,     /* 9 and greater are reserved */
343     ACPI_EINJ_TRIGGER_ERROR                 = 0xFF   /* Except for this value */
344 };
345 
346 /* Values for Instruction field above */
347 
348 enum AcpiEinjInstructions
349 {
350     ACPI_EINJ_READ_REGISTER         = 0,
351     ACPI_EINJ_READ_REGISTER_VALUE   = 1,
352     ACPI_EINJ_WRITE_REGISTER        = 2,
353     ACPI_EINJ_WRITE_REGISTER_VALUE  = 3,
354     ACPI_EINJ_NOOP                  = 4,
355     ACPI_EINJ_FLUSH_CACHELINE       = 5,
356     ACPI_EINJ_INSTRUCTION_RESERVED  = 6     /* 6 and greater are reserved */
357 };
358 
359 typedef struct acpi_einj_error_type_with_addr
360 {
361     UINT32                  ErrorType;
362     UINT32                  VendorStructOffset;
363     UINT32                  Flags;
364     UINT32                  ApicId;
365     UINT64                  Address;
366     UINT64                  Range;
367     UINT32                  PcieId;
368 
369 } ACPI_EINJ_ERROR_TYPE_WITH_ADDR;
370 
371 typedef struct acpi_einj_vendor
372 {
373     UINT32                  Length;
374     UINT32                  PcieId;
375     UINT16                  VendorId;
376     UINT16                  DeviceId;
377     UINT8                   RevisionId;
378     UINT8                   Reserved[3];
379 
380 } ACPI_EINJ_VENDOR;
381 
382 
383 /* EINJ Trigger Error Action Table */
384 
385 typedef struct acpi_einj_trigger
386 {
387     UINT32                  HeaderSize;
388     UINT32                  Revision;
389     UINT32                  TableSize;
390     UINT32                  EntryCount;
391 
392 } ACPI_EINJ_TRIGGER;
393 
394 /* Command status return values */
395 
396 enum AcpiEinjCommandStatus
397 {
398     ACPI_EINJ_SUCCESS               = 0,
399     ACPI_EINJ_FAILURE               = 1,
400     ACPI_EINJ_INVALID_ACCESS        = 2,
401     ACPI_EINJ_STATUS_RESERVED       = 3     /* 3 and greater are reserved */
402 };
403 
404 
405 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
406 
407 #define ACPI_EINJ_PROCESSOR_CORRECTABLE     (1)
408 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE   (1<<1)
409 #define ACPI_EINJ_PROCESSOR_FATAL           (1<<2)
410 #define ACPI_EINJ_MEMORY_CORRECTABLE        (1<<3)
411 #define ACPI_EINJ_MEMORY_UNCORRECTABLE      (1<<4)
412 #define ACPI_EINJ_MEMORY_FATAL              (1<<5)
413 #define ACPI_EINJ_PCIX_CORRECTABLE          (1<<6)
414 #define ACPI_EINJ_PCIX_UNCORRECTABLE        (1<<7)
415 #define ACPI_EINJ_PCIX_FATAL                (1<<8)
416 #define ACPI_EINJ_PLATFORM_CORRECTABLE      (1<<9)
417 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE    (1<<10)
418 #define ACPI_EINJ_PLATFORM_FATAL            (1<<11)
419 #define ACPI_EINJ_VENDOR_DEFINED            (1<<31)
420 
421 
422 /*******************************************************************************
423  *
424  * ERST - Error Record Serialization Table (ACPI 4.0)
425  *        Version 1
426  *
427  ******************************************************************************/
428 
429 typedef struct acpi_table_erst
430 {
431     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
432     UINT32                  HeaderLength;
433     UINT32                  Reserved;
434     UINT32                  Entries;
435 
436 } ACPI_TABLE_ERST;
437 
438 
439 /* ERST Serialization Entries (actions) */
440 
441 typedef struct acpi_erst_entry
442 {
443     ACPI_WHEA_HEADER        WheaHeader;         /* Common header for WHEA tables */
444 
445 } ACPI_ERST_ENTRY;
446 
447 /* Masks for Flags field above */
448 
449 #define ACPI_ERST_PRESERVE          (1)
450 
451 /* Values for Action field above */
452 
453 enum AcpiErstActions
454 {
455     ACPI_ERST_BEGIN_WRITE           = 0,
456     ACPI_ERST_BEGIN_READ            = 1,
457     ACPI_ERST_BEGIN_CLEAR           = 2,
458     ACPI_ERST_END                   = 3,
459     ACPI_ERST_SET_RECORD_OFFSET     = 4,
460     ACPI_ERST_EXECUTE_OPERATION     = 5,
461     ACPI_ERST_CHECK_BUSY_STATUS     = 6,
462     ACPI_ERST_GET_COMMAND_STATUS    = 7,
463     ACPI_ERST_GET_RECORD_ID         = 8,
464     ACPI_ERST_SET_RECORD_ID         = 9,
465     ACPI_ERST_GET_RECORD_COUNT      = 10,
466     ACPI_ERST_BEGIN_DUMMY_WRIITE    = 11,
467     ACPI_ERST_NOT_USED              = 12,
468     ACPI_ERST_GET_ERROR_RANGE       = 13,
469     ACPI_ERST_GET_ERROR_LENGTH      = 14,
470     ACPI_ERST_GET_ERROR_ATTRIBUTES  = 15,
471     ACPI_ERST_ACTION_RESERVED       = 16    /* 16 and greater are reserved */
472 };
473 
474 /* Values for Instruction field above */
475 
476 enum AcpiErstInstructions
477 {
478     ACPI_ERST_READ_REGISTER         = 0,
479     ACPI_ERST_READ_REGISTER_VALUE   = 1,
480     ACPI_ERST_WRITE_REGISTER        = 2,
481     ACPI_ERST_WRITE_REGISTER_VALUE  = 3,
482     ACPI_ERST_NOOP                  = 4,
483     ACPI_ERST_LOAD_VAR1             = 5,
484     ACPI_ERST_LOAD_VAR2             = 6,
485     ACPI_ERST_STORE_VAR1            = 7,
486     ACPI_ERST_ADD                   = 8,
487     ACPI_ERST_SUBTRACT              = 9,
488     ACPI_ERST_ADD_VALUE             = 10,
489     ACPI_ERST_SUBTRACT_VALUE        = 11,
490     ACPI_ERST_STALL                 = 12,
491     ACPI_ERST_STALL_WHILE_TRUE      = 13,
492     ACPI_ERST_SKIP_NEXT_IF_TRUE     = 14,
493     ACPI_ERST_GOTO                  = 15,
494     ACPI_ERST_SET_SRC_ADDRESS_BASE  = 16,
495     ACPI_ERST_SET_DST_ADDRESS_BASE  = 17,
496     ACPI_ERST_MOVE_DATA             = 18,
497     ACPI_ERST_INSTRUCTION_RESERVED  = 19    /* 19 and greater are reserved */
498 };
499 
500 /* Command status return values */
501 
502 enum AcpiErstCommandStatus
503 {
504     ACPI_ERST_SUCESS                = 0,
505     ACPI_ERST_NO_SPACE              = 1,
506     ACPI_ERST_NOT_AVAILABLE         = 2,
507     ACPI_ERST_FAILURE               = 3,
508     ACPI_ERST_RECORD_EMPTY          = 4,
509     ACPI_ERST_NOT_FOUND             = 5,
510     ACPI_ERST_STATUS_RESERVED       = 6     /* 6 and greater are reserved */
511 };
512 
513 
514 /* Error Record Serialization Information */
515 
516 typedef struct acpi_erst_info
517 {
518     UINT16                  Signature;          /* Should be "ER" */
519     UINT8                   Data[48];
520 
521 } ACPI_ERST_INFO;
522 
523 
524 /*******************************************************************************
525  *
526  * HEST - Hardware Error Source Table (ACPI 4.0)
527  *        Version 1
528  *
529  ******************************************************************************/
530 
531 typedef struct acpi_table_hest
532 {
533     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
534     UINT32                  ErrorSourceCount;
535 
536 } ACPI_TABLE_HEST;
537 
538 
539 /* HEST subtable header */
540 
541 typedef struct acpi_hest_header
542 {
543     UINT16                  Type;
544     UINT16                  SourceId;
545 
546 } ACPI_HEST_HEADER;
547 
548 
549 /* Values for Type field above for subtables */
550 
551 enum AcpiHestTypes
552 {
553     ACPI_HEST_TYPE_IA32_CHECK           = 0,
554     ACPI_HEST_TYPE_IA32_CORRECTED_CHECK = 1,
555     ACPI_HEST_TYPE_IA32_NMI             = 2,
556     ACPI_HEST_TYPE_NOT_USED3            = 3,
557     ACPI_HEST_TYPE_NOT_USED4            = 4,
558     ACPI_HEST_TYPE_NOT_USED5            = 5,
559     ACPI_HEST_TYPE_AER_ROOT_PORT        = 6,
560     ACPI_HEST_TYPE_AER_ENDPOINT         = 7,
561     ACPI_HEST_TYPE_AER_BRIDGE           = 8,
562     ACPI_HEST_TYPE_GENERIC_ERROR        = 9,
563     ACPI_HEST_TYPE_RESERVED             = 10    /* 10 and greater are reserved */
564 };
565 
566 
567 /*
568  * HEST substructures contained in subtables
569  */
570 
571 /*
572  * IA32 Error Bank(s) - Follows the ACPI_HEST_IA_MACHINE_CHECK and
573  * ACPI_HEST_IA_CORRECTED structures.
574  */
575 typedef struct acpi_hest_ia_error_bank
576 {
577     UINT8                   BankNumber;
578     UINT8                   ClearStatusOnInit;
579     UINT8                   StatusFormat;
580     UINT8                   Reserved;
581     UINT32                  ControlRegister;
582     UINT64                  ControlData;
583     UINT32                  StatusRegister;
584     UINT32                  AddressRegister;
585     UINT32                  MiscRegister;
586 
587 } ACPI_HEST_IA_ERROR_BANK;
588 
589 
590 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
591 
592 typedef struct acpi_hest_aer_common
593 {
594     UINT16                  Reserved1;
595     UINT8                   Flags;
596     UINT8                   Enabled;
597     UINT32                  RecordsToPreallocate;
598     UINT32                  MaxSectionsPerRecord;
599     UINT32                  Bus;
600     UINT16                  Device;
601     UINT16                  Function;
602     UINT16                  DeviceControl;
603     UINT16                  Reserved2;
604     UINT32                  UncorrectableMask;
605     UINT32                  UncorrectableSeverity;
606     UINT32                  CorrectableMask;
607     UINT32                  AdvancedCapabilities;
608 
609 } ACPI_HEST_AER_COMMON;
610 
611 /* Masks for HEST Flags fields */
612 
613 #define ACPI_HEST_FIRMWARE_FIRST        (1)
614 #define ACPI_HEST_GLOBAL                (1<<1)
615 
616 
617 /* Hardware Error Notification */
618 
619 typedef struct acpi_hest_notify
620 {
621     UINT8                   Type;
622     UINT8                   Length;
623     UINT16                  ConfigWriteEnable;
624     UINT32                  PollInterval;
625     UINT32                  Vector;
626     UINT32                  PollingThresholdValue;
627     UINT32                  PollingThresholdWindow;
628     UINT32                  ErrorThresholdValue;
629     UINT32                  ErrorThresholdWindow;
630 
631 } ACPI_HEST_NOTIFY;
632 
633 /* Values for Notify Type field above */
634 
635 enum AcpiHestNotifyTypes
636 {
637     ACPI_HEST_NOTIFY_POLLED     = 0,
638     ACPI_HEST_NOTIFY_EXTERNAL   = 1,
639     ACPI_HEST_NOTIFY_LOCAL      = 2,
640     ACPI_HEST_NOTIFY_SCI        = 3,
641     ACPI_HEST_NOTIFY_NMI        = 4,
642     ACPI_HEST_NOTIFY_CMCI       = 5,    /* ACPI 5.0 */
643     ACPI_HEST_NOTIFY_MCE        = 6,    /* ACPI 5.0 */
644     ACPI_HEST_NOTIFY_RESERVED   = 7     /* 7 and greater are reserved */
645 };
646 
647 /* Values for ConfigWriteEnable bitfield above */
648 
649 #define ACPI_HEST_TYPE                  (1)
650 #define ACPI_HEST_POLL_INTERVAL         (1<<1)
651 #define ACPI_HEST_POLL_THRESHOLD_VALUE  (1<<2)
652 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
653 #define ACPI_HEST_ERR_THRESHOLD_VALUE   (1<<4)
654 #define ACPI_HEST_ERR_THRESHOLD_WINDOW  (1<<5)
655 
656 
657 /*
658  * HEST subtables
659  */
660 
661 /* 0: IA32 Machine Check Exception */
662 
663 typedef struct acpi_hest_ia_machine_check
664 {
665     ACPI_HEST_HEADER        Header;
666     UINT16                  Reserved1;
667     UINT8                   Flags;
668     UINT8                   Enabled;
669     UINT32                  RecordsToPreallocate;
670     UINT32                  MaxSectionsPerRecord;
671     UINT64                  GlobalCapabilityData;
672     UINT64                  GlobalControlData;
673     UINT8                   NumHardwareBanks;
674     UINT8                   Reserved3[7];
675 
676 } ACPI_HEST_IA_MACHINE_CHECK;
677 
678 
679 /* 1: IA32 Corrected Machine Check */
680 
681 typedef struct acpi_hest_ia_corrected
682 {
683     ACPI_HEST_HEADER        Header;
684     UINT16                  Reserved1;
685     UINT8                   Flags;
686     UINT8                   Enabled;
687     UINT32                  RecordsToPreallocate;
688     UINT32                  MaxSectionsPerRecord;
689     ACPI_HEST_NOTIFY        Notify;
690     UINT8                   NumHardwareBanks;
691     UINT8                   Reserved2[3];
692 
693 } ACPI_HEST_IA_CORRECTED;
694 
695 
696 /* 2: IA32 Non-Maskable Interrupt */
697 
698 typedef struct acpi_hest_ia_nmi
699 {
700     ACPI_HEST_HEADER        Header;
701     UINT32                  Reserved;
702     UINT32                  RecordsToPreallocate;
703     UINT32                  MaxSectionsPerRecord;
704     UINT32                  MaxRawDataLength;
705 
706 } ACPI_HEST_IA_NMI;
707 
708 
709 /* 3,4,5: Not used */
710 
711 /* 6: PCI Express Root Port AER */
712 
713 typedef struct acpi_hest_aer_root
714 {
715     ACPI_HEST_HEADER        Header;
716     ACPI_HEST_AER_COMMON    Aer;
717     UINT32                  RootErrorCommand;
718 
719 } ACPI_HEST_AER_ROOT;
720 
721 
722 /* 7: PCI Express AER (AER Endpoint) */
723 
724 typedef struct acpi_hest_aer
725 {
726     ACPI_HEST_HEADER        Header;
727     ACPI_HEST_AER_COMMON    Aer;
728 
729 } ACPI_HEST_AER;
730 
731 
732 /* 8: PCI Express/PCI-X Bridge AER */
733 
734 typedef struct acpi_hest_aer_bridge
735 {
736     ACPI_HEST_HEADER        Header;
737     ACPI_HEST_AER_COMMON    Aer;
738     UINT32                  UncorrectableMask2;
739     UINT32                  UncorrectableSeverity2;
740     UINT32                  AdvancedCapabilities2;
741 
742 } ACPI_HEST_AER_BRIDGE;
743 
744 
745 /* 9: Generic Hardware Error Source */
746 
747 typedef struct acpi_hest_generic
748 {
749     ACPI_HEST_HEADER        Header;
750     UINT16                  RelatedSourceId;
751     UINT8                   Reserved;
752     UINT8                   Enabled;
753     UINT32                  RecordsToPreallocate;
754     UINT32                  MaxSectionsPerRecord;
755     UINT32                  MaxRawDataLength;
756     ACPI_GENERIC_ADDRESS    ErrorStatusAddress;
757     ACPI_HEST_NOTIFY        Notify;
758     UINT32                  ErrorBlockLength;
759 
760 } ACPI_HEST_GENERIC;
761 
762 
763 /* Generic Error Status block */
764 
765 typedef struct acpi_hest_generic_status
766 {
767     UINT32                  BlockStatus;
768     UINT32                  RawDataOffset;
769     UINT32                  RawDataLength;
770     UINT32                  DataLength;
771     UINT32                  ErrorSeverity;
772 
773 } ACPI_HEST_GENERIC_STATUS;
774 
775 /* Values for BlockStatus flags above */
776 
777 #define ACPI_HEST_UNCORRECTABLE             (1)
778 #define ACPI_HEST_CORRECTABLE               (1<<1)
779 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE    (1<<2)
780 #define ACPI_HEST_MULTIPLE_CORRECTABLE      (1<<3)
781 #define ACPI_HEST_ERROR_ENTRY_COUNT         (0xFF<<4) /* 8 bits, error count */
782 
783 
784 /* Generic Error Data entry */
785 
786 typedef struct acpi_hest_generic_data
787 {
788     UINT8                   SectionType[16];
789     UINT32                  ErrorSeverity;
790     UINT16                  Revision;
791     UINT8                   ValidationBits;
792     UINT8                   Flags;
793     UINT32                  ErrorDataLength;
794     UINT8                   FruId[16];
795     UINT8                   FruText[20];
796 
797 } ACPI_HEST_GENERIC_DATA;
798 
799 
800 /*******************************************************************************
801  *
802  * MADT - Multiple APIC Description Table
803  *        Version 3
804  *
805  ******************************************************************************/
806 
807 typedef struct acpi_table_madt
808 {
809     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
810     UINT32                  Address;            /* Physical address of local APIC */
811     UINT32                  Flags;
812 
813 } ACPI_TABLE_MADT;
814 
815 /* Masks for Flags field above */
816 
817 #define ACPI_MADT_PCAT_COMPAT       (1)         /* 00: System also has dual 8259s */
818 
819 /* Values for PCATCompat flag */
820 
821 #define ACPI_MADT_DUAL_PIC          0
822 #define ACPI_MADT_MULTIPLE_APIC     1
823 
824 
825 /* Values for MADT subtable type in ACPI_SUBTABLE_HEADER */
826 
827 enum AcpiMadtType
828 {
829     ACPI_MADT_TYPE_LOCAL_APIC           = 0,
830     ACPI_MADT_TYPE_IO_APIC              = 1,
831     ACPI_MADT_TYPE_INTERRUPT_OVERRIDE   = 2,
832     ACPI_MADT_TYPE_NMI_SOURCE           = 3,
833     ACPI_MADT_TYPE_LOCAL_APIC_NMI       = 4,
834     ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE  = 5,
835     ACPI_MADT_TYPE_IO_SAPIC             = 6,
836     ACPI_MADT_TYPE_LOCAL_SAPIC          = 7,
837     ACPI_MADT_TYPE_INTERRUPT_SOURCE     = 8,
838     ACPI_MADT_TYPE_LOCAL_X2APIC         = 9,
839     ACPI_MADT_TYPE_LOCAL_X2APIC_NMI     = 10,
840     ACPI_MADT_TYPE_GENERIC_INTERRUPT    = 11,
841     ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR  = 12,
842     ACPI_MADT_TYPE_RESERVED             = 13    /* 13 and greater are reserved */
843 };
844 
845 
846 /*
847  * MADT Sub-tables, correspond to Type in ACPI_SUBTABLE_HEADER
848  */
849 
850 /* 0: Processor Local APIC */
851 
852 typedef struct acpi_madt_local_apic
853 {
854     ACPI_SUBTABLE_HEADER    Header;
855     UINT8                   ProcessorId;        /* ACPI processor id */
856     UINT8                   Id;                 /* Processor's local APIC id */
857     UINT32                  LapicFlags;
858 
859 } ACPI_MADT_LOCAL_APIC;
860 
861 
862 /* 1: IO APIC */
863 
864 typedef struct acpi_madt_io_apic
865 {
866     ACPI_SUBTABLE_HEADER    Header;
867     UINT8                   Id;                 /* I/O APIC ID */
868     UINT8                   Reserved;           /* Reserved - must be zero */
869     UINT32                  Address;            /* APIC physical address */
870     UINT32                  GlobalIrqBase;      /* Global system interrupt where INTI lines start */
871 
872 } ACPI_MADT_IO_APIC;
873 
874 
875 /* 2: Interrupt Override */
876 
877 typedef struct acpi_madt_interrupt_override
878 {
879     ACPI_SUBTABLE_HEADER    Header;
880     UINT8                   Bus;                /* 0 - ISA */
881     UINT8                   SourceIrq;          /* Interrupt source (IRQ) */
882     UINT32                  GlobalIrq;          /* Global system interrupt */
883     UINT16                  IntiFlags;
884 
885 } ACPI_MADT_INTERRUPT_OVERRIDE;
886 
887 
888 /* 3: NMI Source */
889 
890 typedef struct acpi_madt_nmi_source
891 {
892     ACPI_SUBTABLE_HEADER    Header;
893     UINT16                  IntiFlags;
894     UINT32                  GlobalIrq;          /* Global system interrupt */
895 
896 } ACPI_MADT_NMI_SOURCE;
897 
898 
899 /* 4: Local APIC NMI */
900 
901 typedef struct acpi_madt_local_apic_nmi
902 {
903     ACPI_SUBTABLE_HEADER    Header;
904     UINT8                   ProcessorId;        /* ACPI processor id */
905     UINT16                  IntiFlags;
906     UINT8                   Lint;               /* LINTn to which NMI is connected */
907 
908 } ACPI_MADT_LOCAL_APIC_NMI;
909 
910 
911 /* 5: Address Override */
912 
913 typedef struct acpi_madt_local_apic_override
914 {
915     ACPI_SUBTABLE_HEADER    Header;
916     UINT16                  Reserved;           /* Reserved, must be zero */
917     UINT64                  Address;            /* APIC physical address */
918 
919 } ACPI_MADT_LOCAL_APIC_OVERRIDE;
920 
921 
922 /* 6: I/O Sapic */
923 
924 typedef struct acpi_madt_io_sapic
925 {
926     ACPI_SUBTABLE_HEADER    Header;
927     UINT8                   Id;                 /* I/O SAPIC ID */
928     UINT8                   Reserved;           /* Reserved, must be zero */
929     UINT32                  GlobalIrqBase;      /* Global interrupt for SAPIC start */
930     UINT64                  Address;            /* SAPIC physical address */
931 
932 } ACPI_MADT_IO_SAPIC;
933 
934 
935 /* 7: Local Sapic */
936 
937 typedef struct acpi_madt_local_sapic
938 {
939     ACPI_SUBTABLE_HEADER    Header;
940     UINT8                   ProcessorId;        /* ACPI processor id */
941     UINT8                   Id;                 /* SAPIC ID */
942     UINT8                   Eid;                /* SAPIC EID */
943     UINT8                   Reserved[3];        /* Reserved, must be zero */
944     UINT32                  LapicFlags;
945     UINT32                  Uid;                /* Numeric UID - ACPI 3.0 */
946     char                    UidString[1];       /* String UID  - ACPI 3.0 */
947 
948 } ACPI_MADT_LOCAL_SAPIC;
949 
950 
951 /* 8: Platform Interrupt Source */
952 
953 typedef struct acpi_madt_interrupt_source
954 {
955     ACPI_SUBTABLE_HEADER    Header;
956     UINT16                  IntiFlags;
957     UINT8                   Type;               /* 1=PMI, 2=INIT, 3=corrected */
958     UINT8                   Id;                 /* Processor ID */
959     UINT8                   Eid;                /* Processor EID */
960     UINT8                   IoSapicVector;      /* Vector value for PMI interrupts */
961     UINT32                  GlobalIrq;          /* Global system interrupt */
962     UINT32                  Flags;              /* Interrupt Source Flags */
963 
964 } ACPI_MADT_INTERRUPT_SOURCE;
965 
966 /* Masks for Flags field above */
967 
968 #define ACPI_MADT_CPEI_OVERRIDE     (1)
969 
970 
971 /* 9: Processor Local X2APIC (ACPI 4.0) */
972 
973 typedef struct acpi_madt_local_x2apic
974 {
975     ACPI_SUBTABLE_HEADER    Header;
976     UINT16                  Reserved;           /* Reserved - must be zero */
977     UINT32                  LocalApicId;        /* Processor x2APIC ID  */
978     UINT32                  LapicFlags;
979     UINT32                  Uid;                /* ACPI processor UID */
980 
981 } ACPI_MADT_LOCAL_X2APIC;
982 
983 
984 /* 10: Local X2APIC NMI (ACPI 4.0) */
985 
986 typedef struct acpi_madt_local_x2apic_nmi
987 {
988     ACPI_SUBTABLE_HEADER    Header;
989     UINT16                  IntiFlags;
990     UINT32                  Uid;                /* ACPI processor UID */
991     UINT8                   Lint;               /* LINTn to which NMI is connected */
992     UINT8                   Reserved[3];        /* Reserved - must be zero */
993 
994 } ACPI_MADT_LOCAL_X2APIC_NMI;
995 
996 
997 /* 11: Generic Interrupt (ACPI 5.0) */
998 
999 typedef struct acpi_madt_generic_interrupt
1000 {
1001     ACPI_SUBTABLE_HEADER    Header;
1002     UINT16                  Reserved;           /* Reserved - must be zero */
1003     UINT32                  GicId;
1004     UINT32                  Uid;
1005     UINT32                  Flags;
1006     UINT32                  ParkingVersion;
1007     UINT32                  PerformanceInterrupt;
1008     UINT64                  ParkedAddress;
1009     UINT64                  BaseAddress;
1010 
1011 } ACPI_MADT_GENERIC_INTERRUPT;
1012 
1013 
1014 /* 12: Generic Distributor (ACPI 5.0) */
1015 
1016 typedef struct acpi_madt_generic_distributor
1017 {
1018     ACPI_SUBTABLE_HEADER    Header;
1019     UINT16                  Reserved;           /* Reserved - must be zero */
1020     UINT32                  GicId;
1021     UINT64                  BaseAddress;
1022     UINT32                  GlobalIrqBase;
1023     UINT32                  Reserved2;          /* Reserved - must be zero */
1024 
1025 } ACPI_MADT_GENERIC_DISTRIBUTOR;
1026 
1027 
1028 /*
1029  * Common flags fields for MADT subtables
1030  */
1031 
1032 /* MADT Local APIC flags (LapicFlags) and GIC flags */
1033 
1034 #define ACPI_MADT_ENABLED           (1)         /* 00: Processor is usable if set */
1035 
1036 /* MADT MPS INTI flags (IntiFlags) */
1037 
1038 #define ACPI_MADT_POLARITY_MASK     (3)         /* 00-01: Polarity of APIC I/O input signals */
1039 #define ACPI_MADT_TRIGGER_MASK      (3<<2)      /* 02-03: Trigger mode of APIC input signals */
1040 
1041 /* Values for MPS INTI flags */
1042 
1043 #define ACPI_MADT_POLARITY_CONFORMS       0
1044 #define ACPI_MADT_POLARITY_ACTIVE_HIGH    1
1045 #define ACPI_MADT_POLARITY_RESERVED       2
1046 #define ACPI_MADT_POLARITY_ACTIVE_LOW     3
1047 
1048 #define ACPI_MADT_TRIGGER_CONFORMS        (0)
1049 #define ACPI_MADT_TRIGGER_EDGE            (1<<2)
1050 #define ACPI_MADT_TRIGGER_RESERVED        (2<<2)
1051 #define ACPI_MADT_TRIGGER_LEVEL           (3<<2)
1052 
1053 
1054 /*******************************************************************************
1055  *
1056  * MSCT - Maximum System Characteristics Table (ACPI 4.0)
1057  *        Version 1
1058  *
1059  ******************************************************************************/
1060 
1061 typedef struct acpi_table_msct
1062 {
1063     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1064     UINT32                  ProximityOffset;    /* Location of proximity info struct(s) */
1065     UINT32                  MaxProximityDomains;/* Max number of proximity domains */
1066     UINT32                  MaxClockDomains;    /* Max number of clock domains */
1067     UINT64                  MaxAddress;         /* Max physical address in system */
1068 
1069 } ACPI_TABLE_MSCT;
1070 
1071 
1072 /* Subtable - Maximum Proximity Domain Information. Version 1 */
1073 
1074 typedef struct acpi_msct_proximity
1075 {
1076     UINT8                   Revision;
1077     UINT8                   Length;
1078     UINT32                  RangeStart;         /* Start of domain range */
1079     UINT32                  RangeEnd;           /* End of domain range */
1080     UINT32                  ProcessorCapacity;
1081     UINT64                  MemoryCapacity;     /* In bytes */
1082 
1083 } ACPI_MSCT_PROXIMITY;
1084 
1085 
1086 /*******************************************************************************
1087  *
1088  * SBST - Smart Battery Specification Table
1089  *        Version 1
1090  *
1091  ******************************************************************************/
1092 
1093 typedef struct acpi_table_sbst
1094 {
1095     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1096     UINT32                  WarningLevel;
1097     UINT32                  LowLevel;
1098     UINT32                  CriticalLevel;
1099 
1100 } ACPI_TABLE_SBST;
1101 
1102 
1103 /*******************************************************************************
1104  *
1105  * SLIT - System Locality Distance Information Table
1106  *        Version 1
1107  *
1108  ******************************************************************************/
1109 
1110 typedef struct acpi_table_slit
1111 {
1112     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1113     UINT64                  LocalityCount;
1114     UINT8                   Entry[1];           /* Real size = localities^2 */
1115 
1116 } ACPI_TABLE_SLIT;
1117 
1118 
1119 /*******************************************************************************
1120  *
1121  * SRAT - System Resource Affinity Table
1122  *        Version 3
1123  *
1124  ******************************************************************************/
1125 
1126 typedef struct acpi_table_srat
1127 {
1128     ACPI_TABLE_HEADER       Header;             /* Common ACPI table header */
1129     UINT32                  TableRevision;      /* Must be value '1' */
1130     UINT64                  Reserved;           /* Reserved, must be zero */
1131 
1132 } ACPI_TABLE_SRAT;
1133 
1134 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
1135 
1136 enum AcpiSratType
1137 {
1138     ACPI_SRAT_TYPE_CPU_AFFINITY         = 0,
1139     ACPI_SRAT_TYPE_MEMORY_AFFINITY      = 1,
1140     ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY  = 2,
1141     ACPI_SRAT_TYPE_RESERVED             = 3     /* 3 and greater are reserved */
1142 };
1143 
1144 /*
1145  * SRAT Sub-tables, correspond to Type in ACPI_SUBTABLE_HEADER
1146  */
1147 
1148 /* 0: Processor Local APIC/SAPIC Affinity */
1149 
1150 typedef struct acpi_srat_cpu_affinity
1151 {
1152     ACPI_SUBTABLE_HEADER    Header;
1153     UINT8                   ProximityDomainLo;
1154     UINT8                   ApicId;
1155     UINT32                  Flags;
1156     UINT8                   LocalSapicEid;
1157     UINT8                   ProximityDomainHi[3];
1158     UINT32                  Reserved;           /* Reserved, must be zero */
1159 
1160 } ACPI_SRAT_CPU_AFFINITY;
1161 
1162 /* Flags */
1163 
1164 #define ACPI_SRAT_CPU_USE_AFFINITY  (1)         /* 00: Use affinity structure */
1165 
1166 
1167 /* 1: Memory Affinity */
1168 
1169 typedef struct acpi_srat_mem_affinity
1170 {
1171     ACPI_SUBTABLE_HEADER    Header;
1172     UINT32                  ProximityDomain;
1173     UINT16                  Reserved;           /* Reserved, must be zero */
1174     UINT64                  BaseAddress;
1175     UINT64                  Length;
1176     UINT32                  Reserved1;
1177     UINT32                  Flags;
1178     UINT64                  Reserved2;          /* Reserved, must be zero */
1179 
1180 } ACPI_SRAT_MEM_AFFINITY;
1181 
1182 /* Flags */
1183 
1184 #define ACPI_SRAT_MEM_ENABLED       (1)         /* 00: Use affinity structure */
1185 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1)      /* 01: Memory region is hot pluggable */
1186 #define ACPI_SRAT_MEM_NON_VOLATILE  (1<<2)      /* 02: Memory region is non-volatile */
1187 
1188 
1189 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
1190 
1191 typedef struct acpi_srat_x2apic_cpu_affinity
1192 {
1193     ACPI_SUBTABLE_HEADER    Header;
1194     UINT16                  Reserved;           /* Reserved, must be zero */
1195     UINT32                  ProximityDomain;
1196     UINT32                  ApicId;
1197     UINT32                  Flags;
1198     UINT32                  ClockDomain;
1199     UINT32                  Reserved2;
1200 
1201 } ACPI_SRAT_X2APIC_CPU_AFFINITY;
1202 
1203 /* Flags for ACPI_SRAT_CPU_AFFINITY and ACPI_SRAT_X2APIC_CPU_AFFINITY */
1204 
1205 #define ACPI_SRAT_CPU_ENABLED       (1)         /* 00: Use affinity structure */
1206 
1207 
1208 /* Reset to default packing */
1209 
1210 #pragma pack()
1211 
1212 #endif /* __ACTBL1_H__ */
1213