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