sys/contrib/dev/acpica/source/include/actbl1.h

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