actbl1.h revision 1.11 1 /******************************************************************************
2 *
3 * Name: actbl1.h - Additional ACPI table definitions
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2017, 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_HMAT "HMAT" /* Heterogeneous Memory Attributes Table */
71 #define ACPI_SIG_HEST "HEST" /* Hardware Error Source Table */
72 #define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
73 #define ACPI_SIG_MSCT "MSCT" /* Maximum System Characteristics Table */
74 #define ACPI_SIG_PDTT "PDTT" /* Processor Debug Trigger Table */
75 #define ACPI_SIG_PPTT "PPTT" /* Processor Properties Topology Table */
76 #define ACPI_SIG_SBST "SBST" /* Smart Battery Specification Table */
77 #define ACPI_SIG_SLIT "SLIT" /* System Locality Distance Information Table */
78 #define ACPI_SIG_SRAT "SRAT" /* System Resource Affinity Table */
79 #define ACPI_SIG_NFIT "NFIT" /* NVDIMM Firmware Interface Table */
80
81
82 /*
83 * All tables must be byte-packed to match the ACPI specification, since
84 * the tables are provided by the system BIOS.
85 */
86 #pragma pack(1)
87
88 /*
89 * Note: C bitfields are not used for this reason:
90 *
91 * "Bitfields are great and easy to read, but unfortunately the C language
92 * does not specify the layout of bitfields in memory, which means they are
93 * essentially useless for dealing with packed data in on-disk formats or
94 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
95 * this decision was a design error in C. Ritchie could have picked an order
96 * and stuck with it." Norman Ramsey.
97 * See http://stackoverflow.com/a/1053662/41661
98 */
99
100
101 /*******************************************************************************
102 *
103 * Common subtable headers
104 *
105 ******************************************************************************/
106
107 /* Generic subtable header (used in MADT, SRAT, etc.) */
108
109 typedef struct acpi_subtable_header
110 {
111 UINT8 Type;
112 UINT8 Length;
113
114 } ACPI_SUBTABLE_HEADER;
115
116
117 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
118
119 typedef struct acpi_whea_header
120 {
121 UINT8 Action;
122 UINT8 Instruction;
123 UINT8 Flags;
124 UINT8 Reserved;
125 ACPI_GENERIC_ADDRESS RegisterRegion;
126 UINT64 Value; /* Value used with Read/Write register */
127 UINT64 Mask; /* Bitmask required for this register instruction */
128
129 } ACPI_WHEA_HEADER;
130
131
132 /*******************************************************************************
133 *
134 * BERT - Boot Error Record Table (ACPI 4.0)
135 * Version 1
136 *
137 ******************************************************************************/
138
139 typedef struct acpi_table_bert
140 {
141 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
142 UINT32 RegionLength; /* Length of the boot error region */
143 UINT64 Address; /* Physical address of the error region */
144
145 } ACPI_TABLE_BERT;
146
147
148 /* Boot Error Region (not a subtable, pointed to by Address field above) */
149
150 typedef struct acpi_bert_region
151 {
152 UINT32 BlockStatus; /* Type of error information */
153 UINT32 RawDataOffset; /* Offset to raw error data */
154 UINT32 RawDataLength; /* Length of raw error data */
155 UINT32 DataLength; /* Length of generic error data */
156 UINT32 ErrorSeverity; /* Severity code */
157
158 } ACPI_BERT_REGION;
159
160 /* Values for BlockStatus flags above */
161
162 #define ACPI_BERT_UNCORRECTABLE (1)
163 #define ACPI_BERT_CORRECTABLE (1<<1)
164 #define ACPI_BERT_MULTIPLE_UNCORRECTABLE (1<<2)
165 #define ACPI_BERT_MULTIPLE_CORRECTABLE (1<<3)
166 #define ACPI_BERT_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
167
168 /* Values for ErrorSeverity above */
169
170 enum AcpiBertErrorSeverity
171 {
172 ACPI_BERT_ERROR_CORRECTABLE = 0,
173 ACPI_BERT_ERROR_FATAL = 1,
174 ACPI_BERT_ERROR_CORRECTED = 2,
175 ACPI_BERT_ERROR_NONE = 3,
176 ACPI_BERT_ERROR_RESERVED = 4 /* 4 and greater are reserved */
177 };
178
179 /*
180 * Note: The generic error data that follows the ErrorSeverity field above
181 * uses the ACPI_HEST_GENERIC_DATA defined under the HEST table below
182 */
183
184
185 /*******************************************************************************
186 *
187 * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
188 * Version 1
189 *
190 ******************************************************************************/
191
192 typedef struct acpi_table_cpep
193 {
194 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
195 UINT64 Reserved;
196
197 } ACPI_TABLE_CPEP;
198
199
200 /* Subtable */
201
202 typedef struct acpi_cpep_polling
203 {
204 ACPI_SUBTABLE_HEADER Header;
205 UINT8 Id; /* Processor ID */
206 UINT8 Eid; /* Processor EID */
207 UINT32 Interval; /* Polling interval (msec) */
208
209 } ACPI_CPEP_POLLING;
210
211
212 /*******************************************************************************
213 *
214 * ECDT - Embedded Controller Boot Resources Table
215 * Version 1
216 *
217 ******************************************************************************/
218
219 typedef struct acpi_table_ecdt
220 {
221 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
222 ACPI_GENERIC_ADDRESS Control; /* Address of EC command/status register */
223 ACPI_GENERIC_ADDRESS Data; /* Address of EC data register */
224 UINT32 Uid; /* Unique ID - must be same as the EC _UID method */
225 UINT8 Gpe; /* The GPE for the EC */
226 UINT8 Id[1]; /* Full namepath of the EC in the ACPI namespace */
227
228 } ACPI_TABLE_ECDT;
229
230
231 /*******************************************************************************
232 *
233 * EINJ - Error Injection Table (ACPI 4.0)
234 * Version 1
235 *
236 ******************************************************************************/
237
238 typedef struct acpi_table_einj
239 {
240 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
241 UINT32 HeaderLength;
242 UINT8 Flags;
243 UINT8 Reserved[3];
244 UINT32 Entries;
245
246 } ACPI_TABLE_EINJ;
247
248
249 /* EINJ Injection Instruction Entries (actions) */
250
251 typedef struct acpi_einj_entry
252 {
253 ACPI_WHEA_HEADER WheaHeader; /* Common header for WHEA tables */
254
255 } ACPI_EINJ_ENTRY;
256
257 /* Masks for Flags field above */
258
259 #define ACPI_EINJ_PRESERVE (1)
260
261 /* Values for Action field above */
262
263 enum AcpiEinjActions
264 {
265 ACPI_EINJ_BEGIN_OPERATION = 0,
266 ACPI_EINJ_GET_TRIGGER_TABLE = 1,
267 ACPI_EINJ_SET_ERROR_TYPE = 2,
268 ACPI_EINJ_GET_ERROR_TYPE = 3,
269 ACPI_EINJ_END_OPERATION = 4,
270 ACPI_EINJ_EXECUTE_OPERATION = 5,
271 ACPI_EINJ_CHECK_BUSY_STATUS = 6,
272 ACPI_EINJ_GET_COMMAND_STATUS = 7,
273 ACPI_EINJ_SET_ERROR_TYPE_WITH_ADDRESS = 8,
274 ACPI_EINJ_GET_EXECUTE_TIMINGS = 9,
275 ACPI_EINJ_ACTION_RESERVED = 10, /* 10 and greater are reserved */
276 ACPI_EINJ_TRIGGER_ERROR = 0xFF /* Except for this value */
277 };
278
279 /* Values for Instruction field above */
280
281 enum AcpiEinjInstructions
282 {
283 ACPI_EINJ_READ_REGISTER = 0,
284 ACPI_EINJ_READ_REGISTER_VALUE = 1,
285 ACPI_EINJ_WRITE_REGISTER = 2,
286 ACPI_EINJ_WRITE_REGISTER_VALUE = 3,
287 ACPI_EINJ_NOOP = 4,
288 ACPI_EINJ_FLUSH_CACHELINE = 5,
289 ACPI_EINJ_INSTRUCTION_RESERVED = 6 /* 6 and greater are reserved */
290 };
291
292 typedef struct acpi_einj_error_type_with_addr
293 {
294 UINT32 ErrorType;
295 UINT32 VendorStructOffset;
296 UINT32 Flags;
297 UINT32 ApicId;
298 UINT64 Address;
299 UINT64 Range;
300 UINT32 PcieId;
301
302 } ACPI_EINJ_ERROR_TYPE_WITH_ADDR;
303
304 typedef struct acpi_einj_vendor
305 {
306 UINT32 Length;
307 UINT32 PcieId;
308 UINT16 VendorId;
309 UINT16 DeviceId;
310 UINT8 RevisionId;
311 UINT8 Reserved[3];
312
313 } ACPI_EINJ_VENDOR;
314
315
316 /* EINJ Trigger Error Action Table */
317
318 typedef struct acpi_einj_trigger
319 {
320 UINT32 HeaderSize;
321 UINT32 Revision;
322 UINT32 TableSize;
323 UINT32 EntryCount;
324
325 } ACPI_EINJ_TRIGGER;
326
327 /* Command status return values */
328
329 enum AcpiEinjCommandStatus
330 {
331 ACPI_EINJ_SUCCESS = 0,
332 ACPI_EINJ_FAILURE = 1,
333 ACPI_EINJ_INVALID_ACCESS = 2,
334 ACPI_EINJ_STATUS_RESERVED = 3 /* 3 and greater are reserved */
335 };
336
337
338 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
339
340 #define ACPI_EINJ_PROCESSOR_CORRECTABLE (1)
341 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE (1<<1)
342 #define ACPI_EINJ_PROCESSOR_FATAL (1<<2)
343 #define ACPI_EINJ_MEMORY_CORRECTABLE (1<<3)
344 #define ACPI_EINJ_MEMORY_UNCORRECTABLE (1<<4)
345 #define ACPI_EINJ_MEMORY_FATAL (1<<5)
346 #define ACPI_EINJ_PCIX_CORRECTABLE (1<<6)
347 #define ACPI_EINJ_PCIX_UNCORRECTABLE (1<<7)
348 #define ACPI_EINJ_PCIX_FATAL (1<<8)
349 #define ACPI_EINJ_PLATFORM_CORRECTABLE (1<<9)
350 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE (1<<10)
351 #define ACPI_EINJ_PLATFORM_FATAL (1<<11)
352 #define ACPI_EINJ_VENDOR_DEFINED (1<<31)
353
354
355 /*******************************************************************************
356 *
357 * ERST - Error Record Serialization Table (ACPI 4.0)
358 * Version 1
359 *
360 ******************************************************************************/
361
362 typedef struct acpi_table_erst
363 {
364 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
365 UINT32 HeaderLength;
366 UINT32 Reserved;
367 UINT32 Entries;
368
369 } ACPI_TABLE_ERST;
370
371
372 /* ERST Serialization Entries (actions) */
373
374 typedef struct acpi_erst_entry
375 {
376 ACPI_WHEA_HEADER WheaHeader; /* Common header for WHEA tables */
377
378 } ACPI_ERST_ENTRY;
379
380 /* Masks for Flags field above */
381
382 #define ACPI_ERST_PRESERVE (1)
383
384 /* Values for Action field above */
385
386 enum AcpiErstActions
387 {
388 ACPI_ERST_BEGIN_WRITE = 0,
389 ACPI_ERST_BEGIN_READ = 1,
390 ACPI_ERST_BEGIN_CLEAR = 2,
391 ACPI_ERST_END = 3,
392 ACPI_ERST_SET_RECORD_OFFSET = 4,
393 ACPI_ERST_EXECUTE_OPERATION = 5,
394 ACPI_ERST_CHECK_BUSY_STATUS = 6,
395 ACPI_ERST_GET_COMMAND_STATUS = 7,
396 ACPI_ERST_GET_RECORD_ID = 8,
397 ACPI_ERST_SET_RECORD_ID = 9,
398 ACPI_ERST_GET_RECORD_COUNT = 10,
399 ACPI_ERST_BEGIN_DUMMY_WRIITE = 11,
400 ACPI_ERST_NOT_USED = 12,
401 ACPI_ERST_GET_ERROR_RANGE = 13,
402 ACPI_ERST_GET_ERROR_LENGTH = 14,
403 ACPI_ERST_GET_ERROR_ATTRIBUTES = 15,
404 ACPI_ERST_EXECUTE_TIMINGS = 16,
405 ACPI_ERST_ACTION_RESERVED = 17 /* 17 and greater are reserved */
406 };
407
408 /* Values for Instruction field above */
409
410 enum AcpiErstInstructions
411 {
412 ACPI_ERST_READ_REGISTER = 0,
413 ACPI_ERST_READ_REGISTER_VALUE = 1,
414 ACPI_ERST_WRITE_REGISTER = 2,
415 ACPI_ERST_WRITE_REGISTER_VALUE = 3,
416 ACPI_ERST_NOOP = 4,
417 ACPI_ERST_LOAD_VAR1 = 5,
418 ACPI_ERST_LOAD_VAR2 = 6,
419 ACPI_ERST_STORE_VAR1 = 7,
420 ACPI_ERST_ADD = 8,
421 ACPI_ERST_SUBTRACT = 9,
422 ACPI_ERST_ADD_VALUE = 10,
423 ACPI_ERST_SUBTRACT_VALUE = 11,
424 ACPI_ERST_STALL = 12,
425 ACPI_ERST_STALL_WHILE_TRUE = 13,
426 ACPI_ERST_SKIP_NEXT_IF_TRUE = 14,
427 ACPI_ERST_GOTO = 15,
428 ACPI_ERST_SET_SRC_ADDRESS_BASE = 16,
429 ACPI_ERST_SET_DST_ADDRESS_BASE = 17,
430 ACPI_ERST_MOVE_DATA = 18,
431 ACPI_ERST_INSTRUCTION_RESERVED = 19 /* 19 and greater are reserved */
432 };
433
434 /* Command status return values */
435
436 enum AcpiErstCommandStatus
437 {
438 ACPI_ERST_SUCESS = 0,
439 ACPI_ERST_NO_SPACE = 1,
440 ACPI_ERST_NOT_AVAILABLE = 2,
441 ACPI_ERST_FAILURE = 3,
442 ACPI_ERST_RECORD_EMPTY = 4,
443 ACPI_ERST_NOT_FOUND = 5,
444 ACPI_ERST_STATUS_RESERVED = 6 /* 6 and greater are reserved */
445 };
446
447
448 /* Error Record Serialization Information */
449
450 typedef struct acpi_erst_info
451 {
452 UINT16 Signature; /* Should be "ER" */
453 UINT8 Data[48];
454
455 } ACPI_ERST_INFO;
456
457
458 /*******************************************************************************
459 *
460 * HEST - Hardware Error Source Table (ACPI 4.0)
461 * Version 1
462 *
463 ******************************************************************************/
464
465 typedef struct acpi_table_hest
466 {
467 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
468 UINT32 ErrorSourceCount;
469
470 } ACPI_TABLE_HEST;
471
472
473 /* HEST subtable header */
474
475 typedef struct acpi_hest_header
476 {
477 UINT16 Type;
478 UINT16 SourceId;
479
480 } ACPI_HEST_HEADER;
481
482
483 /* Values for Type field above for subtables */
484
485 enum AcpiHestTypes
486 {
487 ACPI_HEST_TYPE_IA32_CHECK = 0,
488 ACPI_HEST_TYPE_IA32_CORRECTED_CHECK = 1,
489 ACPI_HEST_TYPE_IA32_NMI = 2,
490 ACPI_HEST_TYPE_NOT_USED3 = 3,
491 ACPI_HEST_TYPE_NOT_USED4 = 4,
492 ACPI_HEST_TYPE_NOT_USED5 = 5,
493 ACPI_HEST_TYPE_AER_ROOT_PORT = 6,
494 ACPI_HEST_TYPE_AER_ENDPOINT = 7,
495 ACPI_HEST_TYPE_AER_BRIDGE = 8,
496 ACPI_HEST_TYPE_GENERIC_ERROR = 9,
497 ACPI_HEST_TYPE_GENERIC_ERROR_V2 = 10,
498 ACPI_HEST_TYPE_IA32_DEFERRED_CHECK = 11,
499 ACPI_HEST_TYPE_RESERVED = 12 /* 12 and greater are reserved */
500 };
501
502
503 /*
504 * HEST substructures contained in subtables
505 */
506
507 /*
508 * IA32 Error Bank(s) - Follows the ACPI_HEST_IA_MACHINE_CHECK and
509 * ACPI_HEST_IA_CORRECTED structures.
510 */
511 typedef struct acpi_hest_ia_error_bank
512 {
513 UINT8 BankNumber;
514 UINT8 ClearStatusOnInit;
515 UINT8 StatusFormat;
516 UINT8 Reserved;
517 UINT32 ControlRegister;
518 UINT64 ControlData;
519 UINT32 StatusRegister;
520 UINT32 AddressRegister;
521 UINT32 MiscRegister;
522
523 } ACPI_HEST_IA_ERROR_BANK;
524
525
526 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
527
528 typedef struct acpi_hest_aer_common
529 {
530 UINT16 Reserved1;
531 UINT8 Flags;
532 UINT8 Enabled;
533 UINT32 RecordsToPreallocate;
534 UINT32 MaxSectionsPerRecord;
535 UINT32 Bus; /* Bus and Segment numbers */
536 UINT16 Device;
537 UINT16 Function;
538 UINT16 DeviceControl;
539 UINT16 Reserved2;
540 UINT32 UncorrectableMask;
541 UINT32 UncorrectableSeverity;
542 UINT32 CorrectableMask;
543 UINT32 AdvancedCapabilities;
544
545 } ACPI_HEST_AER_COMMON;
546
547 /* Masks for HEST Flags fields */
548
549 #define ACPI_HEST_FIRMWARE_FIRST (1)
550 #define ACPI_HEST_GLOBAL (1<<1)
551 #define ACPI_HEST_GHES_ASSIST (1<<2)
552
553 /*
554 * Macros to access the bus/segment numbers in Bus field above:
555 * Bus number is encoded in bits 7:0
556 * Segment number is encoded in bits 23:8
557 */
558 #define ACPI_HEST_BUS(Bus) ((Bus) & 0xFF)
559 #define ACPI_HEST_SEGMENT(Bus) (((Bus) >> 8) & 0xFFFF)
560
561
562 /* Hardware Error Notification */
563
564 typedef struct acpi_hest_notify
565 {
566 UINT8 Type;
567 UINT8 Length;
568 UINT16 ConfigWriteEnable;
569 UINT32 PollInterval;
570 UINT32 Vector;
571 UINT32 PollingThresholdValue;
572 UINT32 PollingThresholdWindow;
573 UINT32 ErrorThresholdValue;
574 UINT32 ErrorThresholdWindow;
575
576 } ACPI_HEST_NOTIFY;
577
578 /* Values for Notify Type field above */
579
580 enum AcpiHestNotifyTypes
581 {
582 ACPI_HEST_NOTIFY_POLLED = 0,
583 ACPI_HEST_NOTIFY_EXTERNAL = 1,
584 ACPI_HEST_NOTIFY_LOCAL = 2,
585 ACPI_HEST_NOTIFY_SCI = 3,
586 ACPI_HEST_NOTIFY_NMI = 4,
587 ACPI_HEST_NOTIFY_CMCI = 5, /* ACPI 5.0 */
588 ACPI_HEST_NOTIFY_MCE = 6, /* ACPI 5.0 */
589 ACPI_HEST_NOTIFY_GPIO = 7, /* ACPI 6.0 */
590 ACPI_HEST_NOTIFY_SEA = 8, /* ACPI 6.1 */
591 ACPI_HEST_NOTIFY_SEI = 9, /* ACPI 6.1 */
592 ACPI_HEST_NOTIFY_GSIV = 10, /* ACPI 6.1 */
593 ACPI_HEST_NOTIFY_SOFTWARE_DELEGATED = 11, /* ACPI 6.2 */
594 ACPI_HEST_NOTIFY_RESERVED = 12 /* 12 and greater are reserved */
595 };
596
597 /* Values for ConfigWriteEnable bitfield above */
598
599 #define ACPI_HEST_TYPE (1)
600 #define ACPI_HEST_POLL_INTERVAL (1<<1)
601 #define ACPI_HEST_POLL_THRESHOLD_VALUE (1<<2)
602 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
603 #define ACPI_HEST_ERR_THRESHOLD_VALUE (1<<4)
604 #define ACPI_HEST_ERR_THRESHOLD_WINDOW (1<<5)
605
606
607 /*
608 * HEST subtables
609 */
610
611 /* 0: IA32 Machine Check Exception */
612
613 typedef struct acpi_hest_ia_machine_check
614 {
615 ACPI_HEST_HEADER Header;
616 UINT16 Reserved1;
617 UINT8 Flags; /* See flags ACPI_HEST_GLOBAL, etc. above */
618 UINT8 Enabled;
619 UINT32 RecordsToPreallocate;
620 UINT32 MaxSectionsPerRecord;
621 UINT64 GlobalCapabilityData;
622 UINT64 GlobalControlData;
623 UINT8 NumHardwareBanks;
624 UINT8 Reserved3[7];
625
626 } ACPI_HEST_IA_MACHINE_CHECK;
627
628
629 /* 1: IA32 Corrected Machine Check */
630
631 typedef struct acpi_hest_ia_corrected
632 {
633 ACPI_HEST_HEADER Header;
634 UINT16 Reserved1;
635 UINT8 Flags; /* See flags ACPI_HEST_GLOBAL, etc. above */
636 UINT8 Enabled;
637 UINT32 RecordsToPreallocate;
638 UINT32 MaxSectionsPerRecord;
639 ACPI_HEST_NOTIFY Notify;
640 UINT8 NumHardwareBanks;
641 UINT8 Reserved2[3];
642
643 } ACPI_HEST_IA_CORRECTED;
644
645
646 /* 2: IA32 Non-Maskable Interrupt */
647
648 typedef struct acpi_hest_ia_nmi
649 {
650 ACPI_HEST_HEADER Header;
651 UINT32 Reserved;
652 UINT32 RecordsToPreallocate;
653 UINT32 MaxSectionsPerRecord;
654 UINT32 MaxRawDataLength;
655
656 } ACPI_HEST_IA_NMI;
657
658
659 /* 3,4,5: Not used */
660
661 /* 6: PCI Express Root Port AER */
662
663 typedef struct acpi_hest_aer_root
664 {
665 ACPI_HEST_HEADER Header;
666 ACPI_HEST_AER_COMMON Aer;
667 UINT32 RootErrorCommand;
668
669 } ACPI_HEST_AER_ROOT;
670
671
672 /* 7: PCI Express AER (AER Endpoint) */
673
674 typedef struct acpi_hest_aer
675 {
676 ACPI_HEST_HEADER Header;
677 ACPI_HEST_AER_COMMON Aer;
678
679 } ACPI_HEST_AER;
680
681
682 /* 8: PCI Express/PCI-X Bridge AER */
683
684 typedef struct acpi_hest_aer_bridge
685 {
686 ACPI_HEST_HEADER Header;
687 ACPI_HEST_AER_COMMON Aer;
688 UINT32 UncorrectableMask2;
689 UINT32 UncorrectableSeverity2;
690 UINT32 AdvancedCapabilities2;
691
692 } ACPI_HEST_AER_BRIDGE;
693
694
695 /* 9: Generic Hardware Error Source */
696
697 typedef struct acpi_hest_generic
698 {
699 ACPI_HEST_HEADER Header;
700 UINT16 RelatedSourceId;
701 UINT8 Reserved;
702 UINT8 Enabled;
703 UINT32 RecordsToPreallocate;
704 UINT32 MaxSectionsPerRecord;
705 UINT32 MaxRawDataLength;
706 ACPI_GENERIC_ADDRESS ErrorStatusAddress;
707 ACPI_HEST_NOTIFY Notify;
708 UINT32 ErrorBlockLength;
709
710 } ACPI_HEST_GENERIC;
711
712
713 /* 10: Generic Hardware Error Source, version 2 */
714
715 typedef struct acpi_hest_generic_v2
716 {
717 ACPI_HEST_HEADER Header;
718 UINT16 RelatedSourceId;
719 UINT8 Reserved;
720 UINT8 Enabled;
721 UINT32 RecordsToPreallocate;
722 UINT32 MaxSectionsPerRecord;
723 UINT32 MaxRawDataLength;
724 ACPI_GENERIC_ADDRESS ErrorStatusAddress;
725 ACPI_HEST_NOTIFY Notify;
726 UINT32 ErrorBlockLength;
727 ACPI_GENERIC_ADDRESS ReadAckRegister;
728 UINT64 ReadAckPreserve;
729 UINT64 ReadAckWrite;
730
731 } ACPI_HEST_GENERIC_V2;
732
733
734 /* Generic Error Status block */
735
736 typedef struct acpi_hest_generic_status
737 {
738 UINT32 BlockStatus;
739 UINT32 RawDataOffset;
740 UINT32 RawDataLength;
741 UINT32 DataLength;
742 UINT32 ErrorSeverity;
743
744 } ACPI_HEST_GENERIC_STATUS;
745
746 /* Values for BlockStatus flags above */
747
748 #define ACPI_HEST_UNCORRECTABLE (1)
749 #define ACPI_HEST_CORRECTABLE (1<<1)
750 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE (1<<2)
751 #define ACPI_HEST_MULTIPLE_CORRECTABLE (1<<3)
752 #define ACPI_HEST_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
753
754
755 /* Generic Error Data entry */
756
757 typedef struct acpi_hest_generic_data
758 {
759 UINT8 SectionType[16];
760 UINT32 ErrorSeverity;
761 UINT16 Revision;
762 UINT8 ValidationBits;
763 UINT8 Flags;
764 UINT32 ErrorDataLength;
765 UINT8 FruId[16];
766 UINT8 FruText[20];
767
768 } ACPI_HEST_GENERIC_DATA;
769
770 /* Extension for revision 0x0300 */
771
772 typedef struct acpi_hest_generic_data_v300
773 {
774 UINT8 SectionType[16];
775 UINT32 ErrorSeverity;
776 UINT16 Revision;
777 UINT8 ValidationBits;
778 UINT8 Flags;
779 UINT32 ErrorDataLength;
780 UINT8 FruId[16];
781 UINT8 FruText[20];
782 UINT64 TimeStamp;
783
784 } ACPI_HEST_GENERIC_DATA_V300;
785
786 /* Values for ErrorSeverity above */
787
788 #define ACPI_HEST_GEN_ERROR_RECOVERABLE 0
789 #define ACPI_HEST_GEN_ERROR_FATAL 1
790 #define ACPI_HEST_GEN_ERROR_CORRECTED 2
791 #define ACPI_HEST_GEN_ERROR_NONE 3
792
793 /* Flags for ValidationBits above */
794
795 #define ACPI_HEST_GEN_VALID_FRU_ID (1)
796 #define ACPI_HEST_GEN_VALID_FRU_STRING (1<<1)
797 #define ACPI_HEST_GEN_VALID_TIMESTAMP (1<<2)
798
799
800 /* 11: IA32 Deferred Machine Check Exception (ACPI 6.2) */
801
802 typedef struct acpi_hest_ia_deferred_check
803 {
804 ACPI_HEST_HEADER Header;
805 UINT16 Reserved1;
806 UINT8 Flags; /* See flags ACPI_HEST_GLOBAL, etc. above */
807 UINT8 Enabled;
808 UINT32 RecordsToPreallocate;
809 UINT32 MaxSectionsPerRecord;
810 ACPI_HEST_NOTIFY Notify;
811 UINT8 NumHardwareBanks;
812 UINT8 Reserved2[3];
813
814 } ACPI_HEST_IA_DEFERRED_CHECK;
815
816
817 /*******************************************************************************
818 *
819 * HMAT - Heterogeneous Memory Attributes Table (ACPI 6.2)
820 * Version 1
821 *
822 ******************************************************************************/
823
824 typedef struct acpi_table_hmat
825 {
826 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
827 UINT32 Reserved;
828
829 } ACPI_TABLE_HMAT;
830
831
832 /* Values for HMAT structure types */
833
834 enum AcpiHmatType
835 {
836 ACPI_HMAT_TYPE_ADDRESS_RANGE = 0, /* Memory subystem address range */
837 ACPI_HMAT_TYPE_LOCALITY = 1, /* System locality latency and bandwidth information */
838 ACPI_HMAT_TYPE_CACHE = 2, /* Memory side cache information */
839 ACPI_HMAT_TYPE_RESERVED = 3 /* 3 and greater are reserved */
840 };
841
842 typedef struct acpi_hmat_structure
843 {
844 UINT16 Type;
845 UINT16 Reserved;
846 UINT32 Length;
847
848 } ACPI_HMAT_STRUCTURE;
849
850
851 /*
852 * HMAT Structures, correspond to Type in ACPI_HMAT_STRUCTURE
853 */
854
855 /* 0: Memory subystem address range */
856
857 typedef struct acpi_hmat_address_range
858 {
859 ACPI_HMAT_STRUCTURE Header;
860 UINT16 Flags;
861 UINT16 Reserved1;
862 UINT32 ProcessorPD; /* Processor proximity domain */
863 UINT32 MemoryPD; /* Memory proximity domain */
864 UINT32 Reserved2;
865 UINT64 PhysicalAddressBase; /* Physical address range base */
866 UINT64 PhysicalAddressLength; /* Physical address range length */
867
868 } ACPI_HMAT_ADDRESS_RANGE;
869
870 /* Masks for Flags field above */
871
872 #define ACPI_HMAT_PROCESSOR_PD_VALID (1) /* 1: ProcessorPD field is valid */
873 #define ACPI_HMAT_MEMORY_PD_VALID (1<<1) /* 1: MemoryPD field is valid */
874 #define ACPI_HMAT_RESERVATION_HINT (1<<2) /* 1: Reservation hint */
875
876
877 /* 1: System locality latency and bandwidth information */
878
879 typedef struct acpi_hmat_locality
880 {
881 ACPI_HMAT_STRUCTURE Header;
882 UINT8 Flags;
883 UINT8 DataType;
884 UINT16 Reserved1;
885 UINT32 NumberOfInitiatorPDs;
886 UINT32 NumberOfTargetPDs;
887 UINT32 Reserved2;
888 UINT64 EntryBaseUnit;
889
890 } ACPI_HMAT_LOCALITY;
891
892 /* Masks for Flags field above */
893
894 #define ACPI_HMAT_MEMORY_HIERARCHY (0x0F)
895
896 /* Values for Memory Hierarchy flag */
897
898 #define ACPI_HMAT_MEMORY 0
899 #define ACPI_HMAT_LAST_LEVEL_CACHE 1
900 #define ACPI_HMAT_1ST_LEVEL_CACHE 2
901 #define ACPI_HMAT_2ND_LEVEL_CACHE 3
902 #define ACPI_HMAT_3RD_LEVEL_CACHE 4
903
904 /* Values for DataType field above */
905
906 #define ACPI_HMAT_ACCESS_LATENCY 0
907 #define ACPI_HMAT_READ_LATENCY 1
908 #define ACPI_HMAT_WRITE_LATENCY 2
909 #define ACPI_HMAT_ACCESS_BANDWIDTH 3
910 #define ACPI_HMAT_READ_BANDWIDTH 4
911 #define ACPI_HMAT_WRITE_BANDWIDTH 5
912
913
914 /* 2: Memory side cache information */
915
916 typedef struct acpi_hmat_cache
917 {
918 ACPI_HMAT_STRUCTURE Header;
919 UINT32 MemoryPD;
920 UINT32 Reserved1;
921 UINT64 CacheSize;
922 UINT32 CacheAttributes;
923 UINT16 Reserved2;
924 UINT16 NumberOfSMBIOSHandles;
925
926 } ACPI_HMAT_CACHE;
927
928 /* Masks for CacheAttributes field above */
929
930 #define ACPI_HMAT_TOTAL_CACHE_LEVEL (0x0000000F)
931 #define ACPI_HMAT_CACHE_LEVEL (0x000000F0)
932 #define ACPI_HMAT_CACHE_ASSOCIATIVITY (0x00000F00)
933 #define ACPI_HMAT_WRITE_POLICY (0x0000F000)
934 #define ACPI_HMAT_CACHE_LINE_SIZE (0xFFFF0000)
935
936 /* Values for cache associativity flag */
937
938 #define ACPI_HMAT_CA_NONE (0)
939 #define ACPI_HMAT_CA_DIRECT_MAPPED (1)
940 #define ACPI_HMAT_CA_COMPLEX_CACHE_INDEXING (2)
941
942 /* Values for write policy flag */
943
944 #define ACPI_HMAT_CP_NONE (0)
945 #define ACPI_HMAT_CP_WB (1)
946 #define ACPI_HMAT_CP_WT (2)
947
948
949 /*******************************************************************************
950 *
951 * MADT - Multiple APIC Description Table
952 * Version 3
953 *
954 ******************************************************************************/
955
956 typedef struct acpi_table_madt
957 {
958 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
959 UINT32 Address; /* Physical address of local APIC */
960 UINT32 Flags;
961
962 } ACPI_TABLE_MADT;
963
964 /* Masks for Flags field above */
965
966 #define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
967
968 /* Values for PCATCompat flag */
969
970 #define ACPI_MADT_DUAL_PIC 1
971 #define ACPI_MADT_MULTIPLE_APIC 0
972
973
974 /* Values for MADT subtable type in ACPI_SUBTABLE_HEADER */
975
976 enum AcpiMadtType
977 {
978 ACPI_MADT_TYPE_LOCAL_APIC = 0,
979 ACPI_MADT_TYPE_IO_APIC = 1,
980 ACPI_MADT_TYPE_INTERRUPT_OVERRIDE = 2,
981 ACPI_MADT_TYPE_NMI_SOURCE = 3,
982 ACPI_MADT_TYPE_LOCAL_APIC_NMI = 4,
983 ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE = 5,
984 ACPI_MADT_TYPE_IO_SAPIC = 6,
985 ACPI_MADT_TYPE_LOCAL_SAPIC = 7,
986 ACPI_MADT_TYPE_INTERRUPT_SOURCE = 8,
987 ACPI_MADT_TYPE_LOCAL_X2APIC = 9,
988 ACPI_MADT_TYPE_LOCAL_X2APIC_NMI = 10,
989 ACPI_MADT_TYPE_GENERIC_INTERRUPT = 11,
990 ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR = 12,
991 ACPI_MADT_TYPE_GENERIC_MSI_FRAME = 13,
992 ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR = 14,
993 ACPI_MADT_TYPE_GENERIC_TRANSLATOR = 15,
994 ACPI_MADT_TYPE_RESERVED = 16 /* 16 and greater are reserved */
995 };
996
997
998 /*
999 * MADT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
1000 */
1001
1002 /* 0: Processor Local APIC */
1003
1004 typedef struct acpi_madt_local_apic
1005 {
1006 ACPI_SUBTABLE_HEADER Header;
1007 UINT8 ProcessorId; /* ACPI processor id */
1008 UINT8 Id; /* Processor's local APIC id */
1009 UINT32 LapicFlags;
1010
1011 } ACPI_MADT_LOCAL_APIC;
1012
1013
1014 /* 1: IO APIC */
1015
1016 typedef struct acpi_madt_io_apic
1017 {
1018 ACPI_SUBTABLE_HEADER Header;
1019 UINT8 Id; /* I/O APIC ID */
1020 UINT8 Reserved; /* Reserved - must be zero */
1021 UINT32 Address; /* APIC physical address */
1022 UINT32 GlobalIrqBase; /* Global system interrupt where INTI lines start */
1023
1024 } ACPI_MADT_IO_APIC;
1025
1026
1027 /* 2: Interrupt Override */
1028
1029 typedef struct acpi_madt_interrupt_override
1030 {
1031 ACPI_SUBTABLE_HEADER Header;
1032 UINT8 Bus; /* 0 - ISA */
1033 UINT8 SourceIrq; /* Interrupt source (IRQ) */
1034 UINT32 GlobalIrq; /* Global system interrupt */
1035 UINT16 IntiFlags;
1036
1037 } ACPI_MADT_INTERRUPT_OVERRIDE;
1038
1039
1040 /* 3: NMI Source */
1041
1042 typedef struct acpi_madt_nmi_source
1043 {
1044 ACPI_SUBTABLE_HEADER Header;
1045 UINT16 IntiFlags;
1046 UINT32 GlobalIrq; /* Global system interrupt */
1047
1048 } ACPI_MADT_NMI_SOURCE;
1049
1050
1051 /* 4: Local APIC NMI */
1052
1053 typedef struct acpi_madt_local_apic_nmi
1054 {
1055 ACPI_SUBTABLE_HEADER Header;
1056 UINT8 ProcessorId; /* ACPI processor id */
1057 UINT16 IntiFlags;
1058 UINT8 Lint; /* LINTn to which NMI is connected */
1059
1060 } ACPI_MADT_LOCAL_APIC_NMI;
1061
1062
1063 /* 5: Address Override */
1064
1065 typedef struct acpi_madt_local_apic_override
1066 {
1067 ACPI_SUBTABLE_HEADER Header;
1068 UINT16 Reserved; /* Reserved, must be zero */
1069 UINT64 Address; /* APIC physical address */
1070
1071 } ACPI_MADT_LOCAL_APIC_OVERRIDE;
1072
1073
1074 /* 6: I/O Sapic */
1075
1076 typedef struct acpi_madt_io_sapic
1077 {
1078 ACPI_SUBTABLE_HEADER Header;
1079 UINT8 Id; /* I/O SAPIC ID */
1080 UINT8 Reserved; /* Reserved, must be zero */
1081 UINT32 GlobalIrqBase; /* Global interrupt for SAPIC start */
1082 UINT64 Address; /* SAPIC physical address */
1083
1084 } ACPI_MADT_IO_SAPIC;
1085
1086
1087 /* 7: Local Sapic */
1088
1089 typedef struct acpi_madt_local_sapic
1090 {
1091 ACPI_SUBTABLE_HEADER Header;
1092 UINT8 ProcessorId; /* ACPI processor id */
1093 UINT8 Id; /* SAPIC ID */
1094 UINT8 Eid; /* SAPIC EID */
1095 UINT8 Reserved[3]; /* Reserved, must be zero */
1096 UINT32 LapicFlags;
1097 UINT32 Uid; /* Numeric UID - ACPI 3.0 */
1098 char UidString[1]; /* String UID - ACPI 3.0 */
1099
1100 } ACPI_MADT_LOCAL_SAPIC;
1101
1102
1103 /* 8: Platform Interrupt Source */
1104
1105 typedef struct acpi_madt_interrupt_source
1106 {
1107 ACPI_SUBTABLE_HEADER Header;
1108 UINT16 IntiFlags;
1109 UINT8 Type; /* 1=PMI, 2=INIT, 3=corrected */
1110 UINT8 Id; /* Processor ID */
1111 UINT8 Eid; /* Processor EID */
1112 UINT8 IoSapicVector; /* Vector value for PMI interrupts */
1113 UINT32 GlobalIrq; /* Global system interrupt */
1114 UINT32 Flags; /* Interrupt Source Flags */
1115
1116 } ACPI_MADT_INTERRUPT_SOURCE;
1117
1118 /* Masks for Flags field above */
1119
1120 #define ACPI_MADT_CPEI_OVERRIDE (1)
1121
1122
1123 /* 9: Processor Local X2APIC (ACPI 4.0) */
1124
1125 typedef struct acpi_madt_local_x2apic
1126 {
1127 ACPI_SUBTABLE_HEADER Header;
1128 UINT16 Reserved; /* Reserved - must be zero */
1129 UINT32 LocalApicId; /* Processor x2APIC ID */
1130 UINT32 LapicFlags;
1131 UINT32 Uid; /* ACPI processor UID */
1132
1133 } ACPI_MADT_LOCAL_X2APIC;
1134
1135
1136 /* 10: Local X2APIC NMI (ACPI 4.0) */
1137
1138 typedef struct acpi_madt_local_x2apic_nmi
1139 {
1140 ACPI_SUBTABLE_HEADER Header;
1141 UINT16 IntiFlags;
1142 UINT32 Uid; /* ACPI processor UID */
1143 UINT8 Lint; /* LINTn to which NMI is connected */
1144 UINT8 Reserved[3]; /* Reserved - must be zero */
1145
1146 } ACPI_MADT_LOCAL_X2APIC_NMI;
1147
1148
1149 /* 11: Generic Interrupt (ACPI 5.0 + ACPI 6.0 changes) */
1150
1151 typedef struct acpi_madt_generic_interrupt
1152 {
1153 ACPI_SUBTABLE_HEADER Header;
1154 UINT16 Reserved; /* Reserved - must be zero */
1155 UINT32 CpuInterfaceNumber;
1156 UINT32 Uid;
1157 UINT32 Flags;
1158 UINT32 ParkingVersion;
1159 UINT32 PerformanceInterrupt;
1160 UINT64 ParkedAddress;
1161 UINT64 BaseAddress;
1162 UINT64 GicvBaseAddress;
1163 UINT64 GichBaseAddress;
1164 UINT32 VgicInterrupt;
1165 UINT64 GicrBaseAddress;
1166 UINT64 ArmMpidr;
1167 UINT8 EfficiencyClass;
1168 UINT8 Reserved2[3];
1169
1170 } ACPI_MADT_GENERIC_INTERRUPT;
1171
1172 /* Masks for Flags field above */
1173
1174 /* ACPI_MADT_ENABLED (1) Processor is usable if set */
1175 #define ACPI_MADT_PERFORMANCE_IRQ_MODE (1<<1) /* 01: Performance Interrupt Mode */
1176 #define ACPI_MADT_VGIC_IRQ_MODE (1<<2) /* 02: VGIC Maintenance Interrupt mode */
1177
1178
1179 /* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
1180
1181 typedef struct acpi_madt_generic_distributor
1182 {
1183 ACPI_SUBTABLE_HEADER Header;
1184 UINT16 Reserved; /* Reserved - must be zero */
1185 UINT32 GicId;
1186 UINT64 BaseAddress;
1187 UINT32 GlobalIrqBase;
1188 UINT8 Version;
1189 UINT8 Reserved2[3]; /* Reserved - must be zero */
1190
1191 } ACPI_MADT_GENERIC_DISTRIBUTOR;
1192
1193 /* Values for Version field above */
1194
1195 enum AcpiMadtGicVersion
1196 {
1197 ACPI_MADT_GIC_VERSION_NONE = 0,
1198 ACPI_MADT_GIC_VERSION_V1 = 1,
1199 ACPI_MADT_GIC_VERSION_V2 = 2,
1200 ACPI_MADT_GIC_VERSION_V3 = 3,
1201 ACPI_MADT_GIC_VERSION_V4 = 4,
1202 ACPI_MADT_GIC_VERSION_RESERVED = 5 /* 5 and greater are reserved */
1203 };
1204
1205
1206 /* 13: Generic MSI Frame (ACPI 5.1) */
1207
1208 typedef struct acpi_madt_generic_msi_frame
1209 {
1210 ACPI_SUBTABLE_HEADER Header;
1211 UINT16 Reserved; /* Reserved - must be zero */
1212 UINT32 MsiFrameId;
1213 UINT64 BaseAddress;
1214 UINT32 Flags;
1215 UINT16 SpiCount;
1216 UINT16 SpiBase;
1217
1218 } ACPI_MADT_GENERIC_MSI_FRAME;
1219
1220 /* Masks for Flags field above */
1221
1222 #define ACPI_MADT_OVERRIDE_SPI_VALUES (1)
1223
1224
1225 /* 14: Generic Redistributor (ACPI 5.1) */
1226
1227 typedef struct acpi_madt_generic_redistributor
1228 {
1229 ACPI_SUBTABLE_HEADER Header;
1230 UINT16 Reserved; /* reserved - must be zero */
1231 UINT64 BaseAddress;
1232 UINT32 Length;
1233
1234 } ACPI_MADT_GENERIC_REDISTRIBUTOR;
1235
1236
1237 /* 15: Generic Translator (ACPI 6.0) */
1238
1239 typedef struct acpi_madt_generic_translator
1240 {
1241 ACPI_SUBTABLE_HEADER Header;
1242 UINT16 Reserved; /* reserved - must be zero */
1243 UINT32 TranslationId;
1244 UINT64 BaseAddress;
1245 UINT32 Reserved2;
1246
1247 } ACPI_MADT_GENERIC_TRANSLATOR;
1248
1249
1250 /*
1251 * Common flags fields for MADT subtables
1252 */
1253
1254 /* MADT Local APIC flags */
1255
1256 #define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
1257
1258 /* MADT MPS INTI flags (IntiFlags) */
1259
1260 #define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
1261 #define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
1262
1263 /* Values for MPS INTI flags */
1264
1265 #define ACPI_MADT_POLARITY_CONFORMS 0
1266 #define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
1267 #define ACPI_MADT_POLARITY_RESERVED 2
1268 #define ACPI_MADT_POLARITY_ACTIVE_LOW 3
1269
1270 #define ACPI_MADT_TRIGGER_CONFORMS (0)
1271 #define ACPI_MADT_TRIGGER_EDGE (1<<2)
1272 #define ACPI_MADT_TRIGGER_RESERVED (2<<2)
1273 #define ACPI_MADT_TRIGGER_LEVEL (3<<2)
1274
1275
1276 /*******************************************************************************
1277 *
1278 * MSCT - Maximum System Characteristics Table (ACPI 4.0)
1279 * Version 1
1280 *
1281 ******************************************************************************/
1282
1283 typedef struct acpi_table_msct
1284 {
1285 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1286 UINT32 ProximityOffset; /* Location of proximity info struct(s) */
1287 UINT32 MaxProximityDomains;/* Max number of proximity domains */
1288 UINT32 MaxClockDomains; /* Max number of clock domains */
1289 UINT64 MaxAddress; /* Max physical address in system */
1290
1291 } ACPI_TABLE_MSCT;
1292
1293
1294 /* Subtable - Maximum Proximity Domain Information. Version 1 */
1295
1296 typedef struct acpi_msct_proximity
1297 {
1298 UINT8 Revision;
1299 UINT8 Length;
1300 UINT32 RangeStart; /* Start of domain range */
1301 UINT32 RangeEnd; /* End of domain range */
1302 UINT32 ProcessorCapacity;
1303 UINT64 MemoryCapacity; /* In bytes */
1304
1305 } ACPI_MSCT_PROXIMITY;
1306
1307
1308 /*******************************************************************************
1309 *
1310 * NFIT - NVDIMM Interface Table (ACPI 6.0+)
1311 * Version 1
1312 *
1313 ******************************************************************************/
1314
1315 typedef struct acpi_table_nfit
1316 {
1317 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1318 UINT32 Reserved; /* Reserved, must be zero */
1319
1320 } ACPI_TABLE_NFIT;
1321
1322 /* Subtable header for NFIT */
1323
1324 typedef struct acpi_nfit_header
1325 {
1326 UINT16 Type;
1327 UINT16 Length;
1328
1329 } ACPI_NFIT_HEADER;
1330
1331
1332 /* Values for subtable type in ACPI_NFIT_HEADER */
1333
1334 enum AcpiNfitType
1335 {
1336 ACPI_NFIT_TYPE_SYSTEM_ADDRESS = 0,
1337 ACPI_NFIT_TYPE_MEMORY_MAP = 1,
1338 ACPI_NFIT_TYPE_INTERLEAVE = 2,
1339 ACPI_NFIT_TYPE_SMBIOS = 3,
1340 ACPI_NFIT_TYPE_CONTROL_REGION = 4,
1341 ACPI_NFIT_TYPE_DATA_REGION = 5,
1342 ACPI_NFIT_TYPE_FLUSH_ADDRESS = 6,
1343 ACPI_NFIT_TYPE_RESERVED = 7 /* 7 and greater are reserved */
1344 };
1345
1346 /*
1347 * NFIT Subtables
1348 */
1349
1350 /* 0: System Physical Address Range Structure */
1351
1352 typedef struct acpi_nfit_system_address
1353 {
1354 ACPI_NFIT_HEADER Header;
1355 UINT16 RangeIndex;
1356 UINT16 Flags;
1357 UINT32 Reserved; /* Reseved, must be zero */
1358 UINT32 ProximityDomain;
1359 UINT8 RangeGuid[16];
1360 UINT64 Address;
1361 UINT64 Length;
1362 UINT64 MemoryMapping;
1363
1364 } ACPI_NFIT_SYSTEM_ADDRESS;
1365
1366 /* Flags */
1367
1368 #define ACPI_NFIT_ADD_ONLINE_ONLY (1) /* 00: Add/Online Operation Only */
1369 #define ACPI_NFIT_PROXIMITY_VALID (1<<1) /* 01: Proximity Domain Valid */
1370
1371 /* Range Type GUIDs appear in the include/acuuid.h file */
1372
1373
1374 /* 1: Memory Device to System Address Range Map Structure */
1375
1376 typedef struct acpi_nfit_memory_map
1377 {
1378 ACPI_NFIT_HEADER Header;
1379 UINT32 DeviceHandle;
1380 UINT16 PhysicalId;
1381 UINT16 RegionId;
1382 UINT16 RangeIndex;
1383 UINT16 RegionIndex;
1384 UINT64 RegionSize;
1385 UINT64 RegionOffset;
1386 UINT64 Address;
1387 UINT16 InterleaveIndex;
1388 UINT16 InterleaveWays;
1389 UINT16 Flags;
1390 UINT16 Reserved; /* Reserved, must be zero */
1391
1392 } ACPI_NFIT_MEMORY_MAP;
1393
1394 /* Flags */
1395
1396 #define ACPI_NFIT_MEM_SAVE_FAILED (1) /* 00: Last SAVE to Memory Device failed */
1397 #define ACPI_NFIT_MEM_RESTORE_FAILED (1<<1) /* 01: Last RESTORE from Memory Device failed */
1398 #define ACPI_NFIT_MEM_FLUSH_FAILED (1<<2) /* 02: Platform flush failed */
1399 #define ACPI_NFIT_MEM_NOT_ARMED (1<<3) /* 03: Memory Device is not armed */
1400 #define ACPI_NFIT_MEM_HEALTH_OBSERVED (1<<4) /* 04: Memory Device observed SMART/health events */
1401 #define ACPI_NFIT_MEM_HEALTH_ENABLED (1<<5) /* 05: SMART/health events enabled */
1402 #define ACPI_NFIT_MEM_MAP_FAILED (1<<6) /* 06: Mapping to SPA failed */
1403
1404
1405 /* 2: Interleave Structure */
1406
1407 typedef struct acpi_nfit_interleave
1408 {
1409 ACPI_NFIT_HEADER Header;
1410 UINT16 InterleaveIndex;
1411 UINT16 Reserved; /* Reserved, must be zero */
1412 UINT32 LineCount;
1413 UINT32 LineSize;
1414 UINT32 LineOffset[1]; /* Variable length */
1415
1416 } ACPI_NFIT_INTERLEAVE;
1417
1418
1419 /* 3: SMBIOS Management Information Structure */
1420
1421 typedef struct acpi_nfit_smbios
1422 {
1423 ACPI_NFIT_HEADER Header;
1424 UINT32 Reserved; /* Reserved, must be zero */
1425 UINT8 Data[1]; /* Variable length */
1426
1427 } ACPI_NFIT_SMBIOS;
1428
1429
1430 /* 4: NVDIMM Control Region Structure */
1431
1432 typedef struct acpi_nfit_control_region
1433 {
1434 ACPI_NFIT_HEADER Header;
1435 UINT16 RegionIndex;
1436 UINT16 VendorId;
1437 UINT16 DeviceId;
1438 UINT16 RevisionId;
1439 UINT16 SubsystemVendorId;
1440 UINT16 SubsystemDeviceId;
1441 UINT16 SubsystemRevisionId;
1442 UINT8 ValidFields;
1443 UINT8 ManufacturingLocation;
1444 UINT16 ManufacturingDate;
1445 UINT8 Reserved[2]; /* Reserved, must be zero */
1446 UINT32 SerialNumber;
1447 UINT16 Code;
1448 UINT16 Windows;
1449 UINT64 WindowSize;
1450 UINT64 CommandOffset;
1451 UINT64 CommandSize;
1452 UINT64 StatusOffset;
1453 UINT64 StatusSize;
1454 UINT16 Flags;
1455 UINT8 Reserved1[6]; /* Reserved, must be zero */
1456
1457 } ACPI_NFIT_CONTROL_REGION;
1458
1459 /* Flags */
1460
1461 #define ACPI_NFIT_CONTROL_BUFFERED (1) /* Block Data Windows implementation is buffered */
1462
1463 /* ValidFields bits */
1464
1465 #define ACPI_NFIT_CONTROL_MFG_INFO_VALID (1) /* Manufacturing fields are valid */
1466
1467
1468 /* 5: NVDIMM Block Data Window Region Structure */
1469
1470 typedef struct acpi_nfit_data_region
1471 {
1472 ACPI_NFIT_HEADER Header;
1473 UINT16 RegionIndex;
1474 UINT16 Windows;
1475 UINT64 Offset;
1476 UINT64 Size;
1477 UINT64 Capacity;
1478 UINT64 StartAddress;
1479
1480 } ACPI_NFIT_DATA_REGION;
1481
1482
1483 /* 6: Flush Hint Address Structure */
1484
1485 typedef struct acpi_nfit_flush_address
1486 {
1487 ACPI_NFIT_HEADER Header;
1488 UINT32 DeviceHandle;
1489 UINT16 HintCount;
1490 UINT8 Reserved[6]; /* Reserved, must be zero */
1491 UINT64 HintAddress[1]; /* Variable length */
1492
1493 } ACPI_NFIT_FLUSH_ADDRESS;
1494
1495
1496 /*******************************************************************************
1497 *
1498 * PDTT - Processor Debug Trigger Table (ACPI 6.2)
1499 * Version 0
1500 *
1501 ******************************************************************************/
1502
1503 typedef struct acpi_table_pdtt
1504 {
1505 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1506 UINT8 TriggerCount;
1507 UINT8 Reserved[3];
1508 UINT32 ArrayOffset;
1509
1510 } ACPI_TABLE_PDTT;
1511
1512
1513 /*
1514 * PDTT Communication Channel Identifier Structure.
1515 * The number of these structures is defined by TriggerCount above,
1516 * starting at ArrayOffset.
1517 */
1518 typedef struct acpi_pdtt_channel
1519 {
1520 UINT16 SubChannelId;
1521
1522 } ACPI_PDTT_CHANNEL;
1523
1524
1525 /* Mask and Flags for above */
1526
1527 #define ACPI_PDTT_SUBCHANNEL_ID_MASK 0x00FF
1528 #define ACPI_PDTT_RUNTIME_TRIGGER (1<<8)
1529 #define ACPI_PPTT_WAIT_COMPLETION (1<<9)
1530
1531
1532 /*******************************************************************************
1533 *
1534 * PPTT - Processor Properties Topology Table (ACPI 6.2)
1535 * Version 1
1536 *
1537 ******************************************************************************/
1538
1539 typedef struct acpi_table_pptt
1540 {
1541 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1542
1543 } ACPI_TABLE_PPTT;
1544
1545 /* Values for Type field above */
1546
1547 enum AcpiPpttType
1548 {
1549 ACPI_PPTT_TYPE_PROCESSOR = 0,
1550 ACPI_PPTT_TYPE_CACHE = 1,
1551 ACPI_PPTT_TYPE_ID = 2,
1552 ACPI_PPTT_TYPE_RESERVED = 3
1553 };
1554
1555
1556 /* 0: Processor Hierarchy Node Structure */
1557
1558 typedef struct acpi_pptt_processor
1559 {
1560 ACPI_SUBTABLE_HEADER Header;
1561 UINT16 Reserved;
1562 UINT32 Flags;
1563 UINT32 Parent;
1564 UINT32 AcpiProcessorId;
1565 UINT32 NumberOfPrivResources;
1566
1567 } ACPI_PPTT_PROCESSOR;
1568
1569 /* Flags */
1570
1571 #define ACPI_PPTT_PHYSICAL_PACKAGE (1) /* Physical package */
1572 #define ACPI_PPTT_ACPI_PROCESSOR_ID_VALID (2) /* ACPI Processor ID valid */
1573
1574
1575 /* 1: Cache Type Structure */
1576
1577 typedef struct acpi_pptt_cache
1578 {
1579 ACPI_SUBTABLE_HEADER Header;
1580 UINT16 Reserved;
1581 UINT32 Flags;
1582 UINT32 NextLevelOfCache;
1583 UINT32 Size;
1584 UINT32 NumberOfSets;
1585 UINT8 Associativity;
1586 UINT8 Attributes;
1587 UINT16 LineSize;
1588
1589 } ACPI_PPTT_CACHE;
1590
1591 /* Flags */
1592
1593 #define ACPI_PPTT_SIZE_PROPERTY_VALID (1) /* Physical property valid */
1594 #define ACPI_PPTT_NUMBER_OF_SETS_VALID (1<<1) /* Number of sets valid */
1595 #define ACPI_PPTT_ASSOCIATIVITY_VALID (1<<2) /* Associativity valid */
1596 #define ACPI_PPTT_ALLOCATION_TYPE_VALID (1<<3) /* Allocation type valid */
1597 #define ACPI_PPTT_CACHE_TYPE_VALID (1<<4) /* Cache type valid */
1598 #define ACPI_PPTT_WRITE_POLICY_VALID (1<<5) /* Write policy valid */
1599 #define ACPI_PPTT_LINE_SIZE_VALID (1<<6) /* Line size valid */
1600
1601 /* Masks for Attributes */
1602
1603 #define ACPI_PPTT_MASK_ALLOCATION_TYPE (0x03) /* Allocation type */
1604 #define ACPI_PPTT_MASK_CACHE_TYPE (0x0C) /* Cache type */
1605 #define ACPI_PPTT_MASK_WRITE_POLICY (0x10) /* Write policy */
1606
1607
1608 /* 2: ID Structure */
1609
1610 typedef struct acpi_pptt_id
1611 {
1612 ACPI_SUBTABLE_HEADER Header;
1613 UINT16 Reserved;
1614 UINT32 VendorId;
1615 UINT64 Level1Id;
1616 UINT64 Level2Id;
1617 UINT16 MajorRev;
1618 UINT16 MinorRev;
1619 UINT16 SpinRev;
1620
1621 } ACPI_PPTT_ID;
1622
1623
1624 /*******************************************************************************
1625 *
1626 * SBST - Smart Battery Specification Table
1627 * Version 1
1628 *
1629 ******************************************************************************/
1630
1631 typedef struct acpi_table_sbst
1632 {
1633 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1634 UINT32 WarningLevel;
1635 UINT32 LowLevel;
1636 UINT32 CriticalLevel;
1637
1638 } ACPI_TABLE_SBST;
1639
1640
1641 /*******************************************************************************
1642 *
1643 * SLIT - System Locality Distance Information Table
1644 * Version 1
1645 *
1646 ******************************************************************************/
1647
1648 typedef struct acpi_table_slit
1649 {
1650 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1651 UINT64 LocalityCount;
1652 UINT8 Entry[1]; /* Real size = localities^2 */
1653
1654 } ACPI_TABLE_SLIT;
1655
1656
1657 /*******************************************************************************
1658 *
1659 * SRAT - System Resource Affinity Table
1660 * Version 3
1661 *
1662 ******************************************************************************/
1663
1664 typedef struct acpi_table_srat
1665 {
1666 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
1667 UINT32 TableRevision; /* Must be value '1' */
1668 UINT64 Reserved; /* Reserved, must be zero */
1669
1670 } ACPI_TABLE_SRAT;
1671
1672 /* Values for subtable type in ACPI_SUBTABLE_HEADER */
1673
1674 enum AcpiSratType
1675 {
1676 ACPI_SRAT_TYPE_CPU_AFFINITY = 0,
1677 ACPI_SRAT_TYPE_MEMORY_AFFINITY = 1,
1678 ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY = 2,
1679 ACPI_SRAT_TYPE_GICC_AFFINITY = 3,
1680 ACPI_SRAT_TYPE_GIC_ITS_AFFINITY = 4, /* ACPI 6.2 */
1681 ACPI_SRAT_TYPE_RESERVED = 5 /* 5 and greater are reserved */
1682 };
1683
1684 /*
1685 * SRAT Subtables, correspond to Type in ACPI_SUBTABLE_HEADER
1686 */
1687
1688 /* 0: Processor Local APIC/SAPIC Affinity */
1689
1690 typedef struct acpi_srat_cpu_affinity
1691 {
1692 ACPI_SUBTABLE_HEADER Header;
1693 UINT8 ProximityDomainLo;
1694 UINT8 ApicId;
1695 UINT32 Flags;
1696 UINT8 LocalSapicEid;
1697 UINT8 ProximityDomainHi[3];
1698 UINT32 ClockDomain;
1699
1700 } ACPI_SRAT_CPU_AFFINITY;
1701
1702 /* Flags */
1703
1704 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
1705
1706
1707 /* 1: Memory Affinity */
1708
1709 typedef struct acpi_srat_mem_affinity
1710 {
1711 ACPI_SUBTABLE_HEADER Header;
1712 UINT32 ProximityDomain;
1713 UINT16 Reserved; /* Reserved, must be zero */
1714 UINT64 BaseAddress;
1715 UINT64 Length;
1716 UINT32 Reserved1;
1717 UINT32 Flags;
1718 UINT64 Reserved2; /* Reserved, must be zero */
1719
1720 } ACPI_SRAT_MEM_AFFINITY;
1721
1722 /* Flags */
1723
1724 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
1725 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
1726 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
1727
1728
1729 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
1730
1731 typedef struct acpi_srat_x2apic_cpu_affinity
1732 {
1733 ACPI_SUBTABLE_HEADER Header;
1734 UINT16 Reserved; /* Reserved, must be zero */
1735 UINT32 ProximityDomain;
1736 UINT32 ApicId;
1737 UINT32 Flags;
1738 UINT32 ClockDomain;
1739 UINT32 Reserved2;
1740
1741 } ACPI_SRAT_X2APIC_CPU_AFFINITY;
1742
1743 /* Flags for ACPI_SRAT_CPU_AFFINITY and ACPI_SRAT_X2APIC_CPU_AFFINITY */
1744
1745 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
1746
1747
1748 /* 3: GICC Affinity (ACPI 5.1) */
1749
1750 typedef struct acpi_srat_gicc_affinity
1751 {
1752 ACPI_SUBTABLE_HEADER Header;
1753 UINT32 ProximityDomain;
1754 UINT32 AcpiProcessorUid;
1755 UINT32 Flags;
1756 UINT32 ClockDomain;
1757
1758 } ACPI_SRAT_GICC_AFFINITY;
1759
1760 /* Flags for ACPI_SRAT_GICC_AFFINITY */
1761
1762 #define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
1763
1764
1765 /* 4: GCC ITS Affinity (ACPI 6.2) */
1766
1767 typedef struct acpi_srat_gic_its_affinity
1768 {
1769 ACPI_SUBTABLE_HEADER Header;
1770 UINT32 ProximityDomain;
1771 UINT16 Reserved;
1772 UINT32 ItsId;
1773
1774 } ACPI_SRAT_GIC_ITS_AFFINITY;
1775
1776
1777 /* Reset to default packing */
1778
1779 #pragma pack()
1780
1781 #endif /* __ACTBL1_H__ */
1782