1 /****************************************************************************** 2 * 3 * Name: actbl.h - Table data structures defined in ACPI specification 4 * $Revision: 1.72 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 #ifndef __ACTBL_H__ 118 #define __ACTBL_H__ 119 120 121 /* 122 * Values for description table header signatures 123 */ 124 #define RSDP_NAME "RSDP" 125 #define RSDP_SIG "RSD PTR " /* RSDT Pointer signature */ 126 #define APIC_SIG "APIC" /* Multiple APIC Description Table */ 127 #define DSDT_SIG "DSDT" /* Differentiated System Description Table */ 128 #define FADT_SIG "FACP" /* Fixed ACPI Description Table */ 129 #define FACS_SIG "FACS" /* Firmware ACPI Control Structure */ 130 #define PSDT_SIG "PSDT" /* Persistent System Description Table */ 131 #define RSDT_SIG "RSDT" /* Root System Description Table */ 132 #define XSDT_SIG "XSDT" /* Extended System Description Table */ 133 #define SSDT_SIG "SSDT" /* Secondary System Description Table */ 134 #define SBST_SIG "SBST" /* Smart Battery Specification Table */ 135 #define SPIC_SIG "SPIC" /* IOSAPIC table */ 136 #define BOOT_SIG "BOOT" /* Boot table */ 137 138 139 #define GL_OWNED 0x02 /* Ownership of global lock is bit 1 */ 140 141 142 /* 143 * Common table types. The base code can remain 144 * constant if the underlying tables are changed 145 */ 146 #define RSDT_DESCRIPTOR RSDT_DESCRIPTOR_REV2 147 #define XSDT_DESCRIPTOR XSDT_DESCRIPTOR_REV2 148 #define FACS_DESCRIPTOR FACS_DESCRIPTOR_REV2 149 #define FADT_DESCRIPTOR FADT_DESCRIPTOR_REV2 150 151 152 #pragma pack(1) 153 154 /* 155 * ACPI Version-independent tables 156 * 157 * NOTE: The tables that are specific to ACPI versions (1.0, 2.0, etc.) 158 * are in separate files. 159 */ 160 typedef struct rsdp_descriptor /* Root System Descriptor Pointer */ 161 { 162 char Signature[8]; /* ACPI signature, contains "RSD PTR " */ 163 UINT8 Checksum; /* ACPI 1.0 checksum */ 164 char OemId[6]; /* OEM identification */ 165 UINT8 Revision; /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */ 166 UINT32 RsdtPhysicalAddress; /* 32-bit physical address of the RSDT */ 167 UINT32 Length; /* XSDT Length in bytes, including header */ 168 UINT64 XsdtPhysicalAddress; /* 64-bit physical address of the XSDT */ 169 UINT8 ExtendedChecksum; /* Checksum of entire table (ACPI 2.0) */ 170 char Reserved[3]; /* Reserved, must be zero */ 171 172 } RSDP_DESCRIPTOR; 173 174 175 typedef struct acpi_common_facs /* Common FACS for internal use */ 176 { 177 UINT32 *GlobalLock; 178 UINT64 *FirmwareWakingVector; 179 UINT8 VectorWidth; 180 181 } ACPI_COMMON_FACS; 182 183 184 #define ACPI_TABLE_HEADER_DEF /* ACPI common table header */ \ 185 char Signature[4]; /* ASCII table signature */\ 186 UINT32 Length; /* Length of table in bytes, including this header */\ 187 UINT8 Revision; /* ACPI Specification minor version # */\ 188 UINT8 Checksum; /* To make sum of entire table == 0 */\ 189 char OemId[6]; /* ASCII OEM identification */\ 190 char OemTableId[8]; /* ASCII OEM table identification */\ 191 UINT32 OemRevision; /* OEM revision number */\ 192 char AslCompilerId [4]; /* ASCII ASL compiler vendor ID */\ 193 UINT32 AslCompilerRevision; /* ASL compiler version */ 194 195 196 typedef struct acpi_table_header /* ACPI common table header */ 197 { 198 ACPI_TABLE_HEADER_DEF 199 200 } ACPI_TABLE_HEADER; 201 202 203 /* 204 * MADT values and structures 205 */ 206 207 /* Values for MADT PCATCompat */ 208 209 #define DUAL_PIC 0 210 #define MULTIPLE_APIC 1 211 212 /* Master MADT */ 213 214 typedef struct multiple_apic_table 215 { 216 ACPI_TABLE_HEADER_DEF /* ACPI common table header */ 217 UINT32 LocalApicAddress; /* Physical address of local APIC */ 218 219 /* Flags (32 bits) */ 220 221 UINT8_BIT PCATCompat : 1; /* 00: System also has dual 8259s */ 222 UINT8_BIT : 7; /* 01-07: Reserved, must be zero */ 223 UINT8 Reserved1[3]; /* 08-31: Reserved, must be zero */ 224 225 } MULTIPLE_APIC_TABLE; 226 227 /* Values for Type in APIC_HEADER_DEF */ 228 229 #define APIC_PROCESSOR 0 230 #define APIC_IO 1 231 #define APIC_XRUPT_OVERRIDE 2 232 #define APIC_NMI 3 233 #define APIC_LOCAL_NMI 4 234 #define APIC_ADDRESS_OVERRIDE 5 235 #define APIC_IO_SAPIC 6 236 #define APIC_LOCAL_SAPIC 7 237 #define APIC_XRUPT_SOURCE 8 238 #define APIC_RESERVED 9 /* 9 and greater are reserved */ 239 240 /* 241 * MADT sub-structures (Follow MULTIPLE_APIC_DESCRIPTION_TABLE) 242 */ 243 #define APIC_HEADER_DEF /* Common APIC sub-structure header */\ 244 UINT8 Type; \ 245 UINT8 Length; 246 247 typedef struct apic_header 248 { 249 APIC_HEADER_DEF 250 251 } APIC_HEADER; 252 253 /* Values for MPS INTI flags */ 254 255 #define POLARITY_CONFORMS 0 256 #define POLARITY_ACTIVE_HIGH 1 257 #define POLARITY_RESERVED 2 258 #define POLARITY_ACTIVE_LOW 3 259 260 #define TRIGGER_CONFORMS 0 261 #define TRIGGER_EDGE 1 262 #define TRIGGER_RESERVED 2 263 #define TRIGGER_LEVEL 3 264 265 /* Common flag definitions (16 bits each) */ 266 267 #define MPS_INTI_FLAGS \ 268 UINT8_BIT Polarity : 2; /* 00-01: Polarity of APIC I/O input signals */\ 269 UINT8_BIT TriggerMode : 2; /* 02-03: Trigger mode of APIC input signals */\ 270 UINT8_BIT : 4; /* 04-07: Reserved, must be zero */\ 271 UINT8 Reserved1; /* 08-15: Reserved, must be zero */ 272 273 #define LOCAL_APIC_FLAGS \ 274 UINT8_BIT ProcessorEnabled: 1; /* 00: Processor is usable if set */\ 275 UINT8_BIT : 7; /* 01-07: Reserved, must be zero */\ 276 UINT8 Reserved2; /* 08-15: Reserved, must be zero */ 277 278 /* Sub-structures for MADT */ 279 280 typedef struct madt_processor_apic 281 { 282 APIC_HEADER_DEF 283 UINT8 ProcessorId; /* ACPI processor id */ 284 UINT8 LocalApicId; /* Processor's local APIC id */ 285 LOCAL_APIC_FLAGS 286 287 } MADT_PROCESSOR_APIC; 288 289 typedef struct madt_io_apic 290 { 291 APIC_HEADER_DEF 292 UINT8 IoApicId; /* I/O APIC ID */ 293 UINT8 Reserved; /* Reserved - must be zero */ 294 UINT32 Address; /* APIC physical address */ 295 UINT32 Interrupt; /* Global system interrupt where INTI 296 * lines start */ 297 } MADT_IO_APIC; 298 299 typedef struct madt_interrupt_override 300 { 301 APIC_HEADER_DEF 302 UINT8 Bus; /* 0 - ISA */ 303 UINT8 Source; /* Interrupt source (IRQ) */ 304 UINT32 Interrupt; /* Global system interrupt */ 305 MPS_INTI_FLAGS 306 307 } MADT_INTERRUPT_OVERRIDE; 308 309 typedef struct madt_nmi_source 310 { 311 APIC_HEADER_DEF 312 MPS_INTI_FLAGS 313 UINT32 Interrupt; /* Global system interrupt */ 314 315 } MADT_NMI_SOURCE; 316 317 typedef struct madt_local_apic_nmi 318 { 319 APIC_HEADER_DEF 320 UINT8 ProcessorId; /* ACPI processor id */ 321 MPS_INTI_FLAGS 322 UINT8 Lint; /* LINTn to which NMI is connected */ 323 324 } MADT_LOCAL_APIC_NMI; 325 326 typedef struct madt_address_override 327 { 328 APIC_HEADER_DEF 329 UINT16 Reserved; /* Reserved, must be zero */ 330 UINT64 Address; /* APIC physical address */ 331 332 } MADT_ADDRESS_OVERRIDE; 333 334 typedef struct madt_io_sapic 335 { 336 APIC_HEADER_DEF 337 UINT8 IoSapicId; /* I/O SAPIC ID */ 338 UINT8 Reserved; /* Reserved, must be zero */ 339 UINT32 InterruptBase; /* Glocal interrupt for SAPIC start */ 340 UINT64 Address; /* SAPIC physical address */ 341 342 } MADT_IO_SAPIC; 343 344 typedef struct madt_local_sapic 345 { 346 APIC_HEADER_DEF 347 UINT8 ProcessorId; /* ACPI processor id */ 348 UINT8 LocalSapicId; /* SAPIC ID */ 349 UINT8 LocalSapicEid; /* SAPIC EID */ 350 UINT8 Reserved[3]; /* Reserved, must be zero */ 351 LOCAL_APIC_FLAGS 352 UINT32 ProcessorUID; /* Numeric UID - ACPI 3.0 */ 353 char ProcessorUIDString[1]; /* String UID - ACPI 3.0 */ 354 355 } MADT_LOCAL_SAPIC; 356 357 typedef struct madt_interrupt_source 358 { 359 APIC_HEADER_DEF 360 MPS_INTI_FLAGS 361 UINT8 InterruptType; /* 1=PMI, 2=INIT, 3=corrected */ 362 UINT8 ProcessorId; /* Processor ID */ 363 UINT8 ProcessorEid; /* Processor EID */ 364 UINT8 IoSapicVector; /* Vector value for PMI interrupts */ 365 UINT32 Interrupt; /* Global system interrupt */ 366 UINT32 Flags; /* Interrupt Source Flags */ 367 368 } MADT_INTERRUPT_SOURCE; 369 370 371 /* 372 * Smart Battery 373 */ 374 typedef struct smart_battery_table 375 { 376 ACPI_TABLE_HEADER_DEF 377 UINT32 WarningLevel; 378 UINT32 LowLevel; 379 UINT32 CriticalLevel; 380 381 } SMART_BATTERY_TABLE; 382 383 384 #pragma pack() 385 386 387 /* 388 * ACPI Table information. We save the table address, length, 389 * and type of memory allocation (mapped or allocated) for each 390 * table for 1) when we exit, and 2) if a new table is installed 391 */ 392 #define ACPI_MEM_NOT_ALLOCATED 0 393 #define ACPI_MEM_ALLOCATED 1 394 #define ACPI_MEM_MAPPED 2 395 396 /* Definitions for the Flags bitfield member of ACPI_TABLE_SUPPORT */ 397 398 #define ACPI_TABLE_SINGLE 0x00 399 #define ACPI_TABLE_MULTIPLE 0x01 400 #define ACPI_TABLE_EXECUTABLE 0x02 401 402 #define ACPI_TABLE_ROOT 0x00 403 #define ACPI_TABLE_PRIMARY 0x10 404 #define ACPI_TABLE_SECONDARY 0x20 405 #define ACPI_TABLE_ALL 0x30 406 #define ACPI_TABLE_TYPE_MASK 0x30 407 408 /* Data about each known table type */ 409 410 typedef struct acpi_table_support 411 { 412 char *Name; 413 char *Signature; 414 void **GlobalPtr; 415 UINT8 SigLength; 416 UINT8 Flags; 417 418 } ACPI_TABLE_SUPPORT; 419 420 421 /* 422 * Get the ACPI version-specific tables 423 */ 424 #include "actbl1.h" /* Acpi 1.0 table definitions */ 425 #include "actbl2.h" /* Acpi 2.0 table definitions */ 426 427 428 #pragma pack(1) 429 /* 430 * High performance timer 431 */ 432 typedef struct hpet_table 433 { 434 ACPI_TABLE_HEADER_DEF 435 UINT32 HardwareId; 436 ACPI_GENERIC_ADDRESS BaseAddress; 437 UINT8 HpetNumber; 438 UINT16 ClockTick; 439 UINT8 Attributes; 440 441 } HPET_TABLE; 442 443 #pragma pack() 444 445 #endif /* __ACTBL_H__ */ 446