1/****************************************************************************** 2 * 3 * Name: actbl.h - Basic ACPI Table Definitions 4 * 5 *****************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116#ifndef __ACTBL_H__ 117#define __ACTBL_H__ 118 119 120/******************************************************************************* 121 * 122 * Fundamental ACPI tables 123 * 124 * This file contains definitions for the ACPI tables that are directly consumed 125 * by ACPICA. All other tables are consumed by the OS-dependent ACPI-related 126 * device drivers and other OS support code. 127 * 128 * The RSDP and FACS do not use the common ACPI table header. All other ACPI 129 * tables use the header. 130 * 131 ******************************************************************************/ 132 133 134/* 135 * Values for description table header signatures for tables defined in this 136 * file. Useful because they make it more difficult to inadvertently type in 137 * the wrong signature. 138 */ 139#define ACPI_SIG_DSDT "DSDT" /* Differentiated System Description Table */ 140#define ACPI_SIG_FADT "FACP" /* Fixed ACPI Description Table */ 141#define ACPI_SIG_FACS "FACS" /* Firmware ACPI Control Structure */ 142#define ACPI_SIG_PSDT "PSDT" /* Persistent System Description Table */ 143#define ACPI_SIG_RSDP "RSD PTR " /* Root System Description Pointer */ 144#define ACPI_SIG_RSDT "RSDT" /* Root System Description Table */ 145#define ACPI_SIG_XSDT "XSDT" /* Extended System Description Table */ 146#define ACPI_SIG_SSDT "SSDT" /* Secondary System Description Table */ 147#define ACPI_RSDP_NAME "RSDP" /* Short name for RSDP, not signature */ 148 149 150/* 151 * All tables and structures must be byte-packed to match the ACPI 152 * specification, since the tables are provided by the system BIOS 153 */ 154#pragma pack(1) 155 156/* 157 * Note about bitfields: The UINT8 type is used for bitfields in ACPI tables. 158 * This is the only type that is even remotely portable. Anything else is not 159 * portable, so do not use any other bitfield types. 160 */ 161 162 163/******************************************************************************* 164 * 165 * Master ACPI Table Header. This common header is used by all ACPI tables 166 * except the RSDP and FACS. 167 * 168 ******************************************************************************/ 169 170typedef struct acpi_table_header 171{ 172 char Signature[ACPI_NAME_SIZE]; /* ASCII table signature */ 173 UINT32 Length; /* Length of table in bytes, including this header */ 174 UINT8 Revision; /* ACPI Specification minor version # */ 175 UINT8 Checksum; /* To make sum of entire table == 0 */ 176 char OemId[ACPI_OEM_ID_SIZE]; /* ASCII OEM identification */ 177 char OemTableId[ACPI_OEM_TABLE_ID_SIZE]; /* ASCII OEM table identification */ 178 UINT32 OemRevision; /* OEM revision number */ 179 char AslCompilerId[ACPI_NAME_SIZE]; /* ASCII ASL compiler vendor ID */ 180 UINT32 AslCompilerRevision; /* ASL compiler version */ 181 182} ACPI_TABLE_HEADER; 183 184 185/******************************************************************************* 186 * 187 * GAS - Generic Address Structure (ACPI 2.0+) 188 * 189 * Note: Since this structure is used in the ACPI tables, it is byte aligned. 190 * If misaliged access is not supported by the hardware, accesses to the 191 * 64-bit Address field must be performed with care. 192 * 193 ******************************************************************************/ 194 195typedef struct acpi_generic_address 196{ 197 UINT8 SpaceId; /* Address space where struct or register exists */ 198 UINT8 BitWidth; /* Size in bits of given register */ 199 UINT8 BitOffset; /* Bit offset within the register */ 200 UINT8 AccessWidth; /* Minimum Access size (ACPI 3.0) */ 201 UINT64 Address; /* 64-bit address of struct or register */ 202 203} ACPI_GENERIC_ADDRESS; 204 205 206/******************************************************************************* 207 * 208 * RSDP - Root System Description Pointer (Signature is "RSD PTR ") 209 * Version 2 210 * 211 ******************************************************************************/ 212 213typedef struct acpi_table_rsdp 214{ 215 char Signature[8]; /* ACPI signature, contains "RSD PTR " */ 216 UINT8 Checksum; /* ACPI 1.0 checksum */ 217 char OemId[ACPI_OEM_ID_SIZE]; /* OEM identification */ 218 UINT8 Revision; /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */ 219 UINT32 RsdtPhysicalAddress; /* 32-bit physical address of the RSDT */ 220 UINT32 Length; /* Table length in bytes, including header (ACPI 2.0+) */ 221 UINT64 XsdtPhysicalAddress; /* 64-bit physical address of the XSDT (ACPI 2.0+) */ 222 UINT8 ExtendedChecksum; /* Checksum of entire table (ACPI 2.0+) */ 223 UINT8 Reserved[3]; /* Reserved, must be zero */ 224 225} ACPI_TABLE_RSDP; 226 227#define ACPI_RSDP_REV0_SIZE 20 /* Size of original ACPI 1.0 RSDP */ 228 229 230/******************************************************************************* 231 * 232 * RSDT/XSDT - Root System Description Tables 233 * Version 1 (both) 234 * 235 ******************************************************************************/ 236 237typedef struct acpi_table_rsdt 238{ 239 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 240 UINT32 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */ 241 242} ACPI_TABLE_RSDT; 243 244typedef struct acpi_table_xsdt 245{ 246 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 247 UINT64 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */ 248 249} ACPI_TABLE_XSDT; 250 251 252/******************************************************************************* 253 * 254 * FACS - Firmware ACPI Control Structure (FACS) 255 * 256 ******************************************************************************/ 257 258typedef struct acpi_table_facs 259{ 260 char Signature[4]; /* ASCII table signature */ 261 UINT32 Length; /* Length of structure, in bytes */ 262 UINT32 HardwareSignature; /* Hardware configuration signature */ 263 UINT32 FirmwareWakingVector; /* 32-bit physical address of the Firmware Waking Vector */ 264 UINT32 GlobalLock; /* Global Lock for shared hardware resources */ 265 UINT32 Flags; 266 UINT64 XFirmwareWakingVector; /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */ 267 UINT8 Version; /* Version of this table (ACPI 2.0+) */ 268 UINT8 Reserved[3]; /* Reserved, must be zero */ 269 UINT32 OspmFlags; /* Flags to be set by OSPM (ACPI 4.0) */ 270 UINT8 Reserved1[24]; /* Reserved, must be zero */ 271 272} ACPI_TABLE_FACS; 273 274/* Masks for GlobalLock flag field above */ 275 276#define ACPI_GLOCK_PENDING (1) /* 00: Pending global lock ownership */ 277#define ACPI_GLOCK_OWNED (1<<1) /* 01: Global lock is owned */ 278 279/* Masks for Flags field above */ 280 281#define ACPI_FACS_S4_BIOS_PRESENT (1) /* 00: S4BIOS support is present */ 282#define ACPI_FACS_64BIT_WAKE (1<<1) /* 01: 64-bit wake vector supported (ACPI 4.0) */ 283 284/* Masks for OspmFlags field above */ 285 286#define ACPI_FACS_64BIT_ENVIRONMENT (1) /* 00: 64-bit wake environment is required (ACPI 4.0) */ 287 288 289/******************************************************************************* 290 * 291 * FADT - Fixed ACPI Description Table (Signature "FACP") 292 * Version 4 293 * 294 ******************************************************************************/ 295 296/* Fields common to all versions of the FADT */ 297 298typedef struct acpi_table_fadt 299{ 300 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 301 UINT32 Facs; /* 32-bit physical address of FACS */ 302 UINT32 Dsdt; /* 32-bit physical address of DSDT */ 303 UINT8 Model; /* System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */ 304 UINT8 PreferredProfile; /* Conveys preferred power management profile to OSPM. */ 305 UINT16 SciInterrupt; /* System vector of SCI interrupt */ 306 UINT32 SmiCommand; /* 32-bit Port address of SMI command port */ 307 UINT8 AcpiEnable; /* Value to write to smi_cmd to enable ACPI */ 308 UINT8 AcpiDisable; /* Value to write to smi_cmd to disable ACPI */ 309 UINT8 S4BiosRequest; /* Value to write to SMI CMD to enter S4BIOS state */ 310 UINT8 PstateControl; /* Processor performance state control*/ 311 UINT32 Pm1aEventBlock; /* 32-bit Port address of Power Mgt 1a Event Reg Blk */ 312 UINT32 Pm1bEventBlock; /* 32-bit Port address of Power Mgt 1b Event Reg Blk */ 313 UINT32 Pm1aControlBlock; /* 32-bit Port address of Power Mgt 1a Control Reg Blk */ 314 UINT32 Pm1bControlBlock; /* 32-bit Port address of Power Mgt 1b Control Reg Blk */ 315 UINT32 Pm2ControlBlock; /* 32-bit Port address of Power Mgt 2 Control Reg Blk */ 316 UINT32 PmTimerBlock; /* 32-bit Port address of Power Mgt Timer Ctrl Reg Blk */ 317 UINT32 Gpe0Block; /* 32-bit Port address of General Purpose Event 0 Reg Blk */ 318 UINT32 Gpe1Block; /* 32-bit Port address of General Purpose Event 1 Reg Blk */ 319 UINT8 Pm1EventLength; /* Byte Length of ports at Pm1xEventBlock */ 320 UINT8 Pm1ControlLength; /* Byte Length of ports at Pm1xControlBlock */ 321 UINT8 Pm2ControlLength; /* Byte Length of ports at Pm2ControlBlock */ 322 UINT8 PmTimerLength; /* Byte Length of ports at PmTimerBlock */ 323 UINT8 Gpe0BlockLength; /* Byte Length of ports at Gpe0Block */ 324 UINT8 Gpe1BlockLength; /* Byte Length of ports at Gpe1Block */ 325 UINT8 Gpe1Base; /* Offset in GPE number space where GPE1 events start */ 326 UINT8 CstControl; /* Support for the _CST object and C States change notification */ 327 UINT16 C2Latency; /* Worst case HW latency to enter/exit C2 state */ 328 UINT16 C3Latency; /* Worst case HW latency to enter/exit C3 state */ 329 UINT16 FlushSize; /* Processor's memory cache line width, in bytes */ 330 UINT16 FlushStride; /* Number of flush strides that need to be read */ 331 UINT8 DutyOffset; /* Processor duty cycle index in processor's P_CNT reg */ 332 UINT8 DutyWidth; /* Processor duty cycle value bit width in P_CNT register */ 333 UINT8 DayAlarm; /* Index to day-of-month alarm in RTC CMOS RAM */ 334 UINT8 MonthAlarm; /* Index to month-of-year alarm in RTC CMOS RAM */ 335 UINT8 Century; /* Index to century in RTC CMOS RAM */ 336 UINT16 BootFlags; /* IA-PC Boot Architecture Flags (see below for individual flags) */ 337 UINT8 Reserved; /* Reserved, must be zero */ 338 UINT32 Flags; /* Miscellaneous flag bits (see below for individual flags) */ 339 ACPI_GENERIC_ADDRESS ResetRegister; /* 64-bit address of the Reset register */ 340 UINT8 ResetValue; /* Value to write to the ResetRegister port to reset the system */ 341 UINT8 Reserved4[3]; /* Reserved, must be zero */ 342 UINT64 XFacs; /* 64-bit physical address of FACS */ 343 UINT64 XDsdt; /* 64-bit physical address of DSDT */ 344 ACPI_GENERIC_ADDRESS XPm1aEventBlock; /* 64-bit Extended Power Mgt 1a Event Reg Blk address */ 345 ACPI_GENERIC_ADDRESS XPm1bEventBlock; /* 64-bit Extended Power Mgt 1b Event Reg Blk address */ 346 ACPI_GENERIC_ADDRESS XPm1aControlBlock; /* 64-bit Extended Power Mgt 1a Control Reg Blk address */ 347 ACPI_GENERIC_ADDRESS XPm1bControlBlock; /* 64-bit Extended Power Mgt 1b Control Reg Blk address */ 348 ACPI_GENERIC_ADDRESS XPm2ControlBlock; /* 64-bit Extended Power Mgt 2 Control Reg Blk address */ 349 ACPI_GENERIC_ADDRESS XPmTimerBlock; /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */ 350 ACPI_GENERIC_ADDRESS XGpe0Block; /* 64-bit Extended General Purpose Event 0 Reg Blk address */ 351 ACPI_GENERIC_ADDRESS XGpe1Block; /* 64-bit Extended General Purpose Event 1 Reg Blk address */ 352 353} ACPI_TABLE_FADT; 354 355 356/* Masks for FADT Boot Architecture Flags (BootFlags) */ 357 358#define ACPI_FADT_LEGACY_DEVICES (1) /* 00: [V2] System has LPC or ISA bus devices */ 359#define ACPI_FADT_8042 (1<<1) /* 01: [V3] System has an 8042 controller on port 60/64 */ 360#define ACPI_FADT_NO_VGA (1<<2) /* 02: [V4] It is not safe to probe for VGA hardware */ 361#define ACPI_FADT_NO_MSI (1<<3) /* 03: [V4] Message Signaled Interrupts (MSI) must not be enabled */ 362#define ACPI_FADT_NO_ASPM (1<<4) /* 04: [V4] PCIe ASPM control must not be enabled */ 363 364/* Masks for FADT flags */ 365 366#define ACPI_FADT_WBINVD (1) /* 00: [V1] The wbinvd instruction works properly */ 367#define ACPI_FADT_WBINVD_FLUSH (1<<1) /* 01: [V1] wbinvd flushes but does not invalidate caches */ 368#define ACPI_FADT_C1_SUPPORTED (1<<2) /* 02: [V1] All processors support C1 state */ 369#define ACPI_FADT_C2_MP_SUPPORTED (1<<3) /* 03: [V1] C2 state works on MP system */ 370#define ACPI_FADT_POWER_BUTTON (1<<4) /* 04: [V1] Power button is handled as a control method device */ 371#define ACPI_FADT_SLEEP_BUTTON (1<<5) /* 05: [V1] Sleep button is handled as a control method device */ 372#define ACPI_FADT_FIXED_RTC (1<<6) /* 06: [V1] RTC wakeup status not in fixed register space */ 373#define ACPI_FADT_S4_RTC_WAKE (1<<7) /* 07: [V1] RTC alarm can wake system from S4 */ 374#define ACPI_FADT_32BIT_TIMER (1<<8) /* 08: [V1] ACPI timer width is 32-bit (0=24-bit) */ 375#define ACPI_FADT_DOCKING_SUPPORTED (1<<9) /* 09: [V1] Docking supported */ 376#define ACPI_FADT_RESET_REGISTER (1<<10) /* 10: [V2] System reset via the FADT RESET_REG supported */ 377#define ACPI_FADT_SEALED_CASE (1<<11) /* 11: [V3] No internal expansion capabilities and case is sealed */ 378#define ACPI_FADT_HEADLESS (1<<12) /* 12: [V3] No local video capabilities or local input devices */ 379#define ACPI_FADT_SLEEP_TYPE (1<<13) /* 13: [V3] Must execute native instruction after writing SLP_TYPx register */ 380#define ACPI_FADT_PCI_EXPRESS_WAKE (1<<14) /* 14: [V4] System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */ 381#define ACPI_FADT_PLATFORM_CLOCK (1<<15) /* 15: [V4] OSPM should use platform-provided timer (ACPI 3.0) */ 382#define ACPI_FADT_S4_RTC_VALID (1<<16) /* 16: [V4] Contents of RTC_STS valid after S4 wake (ACPI 3.0) */ 383#define ACPI_FADT_REMOTE_POWER_ON (1<<17) /* 17: [V4] System is compatible with remote power on (ACPI 3.0) */ 384#define ACPI_FADT_APIC_CLUSTER (1<<18) /* 18: [V4] All local APICs must use cluster model (ACPI 3.0) */ 385#define ACPI_FADT_APIC_PHYSICAL (1<<19) /* 19: [V4] All local xAPICs must use physical dest mode (ACPI 3.0) */ 386 387 388/* Values for PreferredProfile (Prefered Power Management Profiles) */ 389 390enum AcpiPreferedPmProfiles 391{ 392 PM_UNSPECIFIED = 0, 393 PM_DESKTOP = 1, 394 PM_MOBILE = 2, 395 PM_WORKSTATION = 3, 396 PM_ENTERPRISE_SERVER = 4, 397 PM_SOHO_SERVER = 5, 398 PM_APPLIANCE_PC = 6 399}; 400 401 402/* Reset to default packing */ 403 404#pragma pack() 405 406 407/* 408 * Internal table-related structures 409 */ 410typedef union acpi_name_union 411{ 412 UINT32 Integer; 413 char Ascii[4]; 414 415} ACPI_NAME_UNION; 416 417 418/* Internal ACPI Table Descriptor. One per ACPI table. */ 419 420typedef struct acpi_table_desc 421{ 422 ACPI_PHYSICAL_ADDRESS Address; 423 ACPI_TABLE_HEADER *Pointer; 424 UINT32 Length; /* Length fixed at 32 bits */ 425 ACPI_NAME_UNION Signature; 426 ACPI_OWNER_ID OwnerId; 427 UINT8 Flags; 428 429} ACPI_TABLE_DESC; 430 431/* Masks for Flags field above */ 432 433#define ACPI_TABLE_ORIGIN_UNKNOWN (0) 434#define ACPI_TABLE_ORIGIN_MAPPED (1) 435#define ACPI_TABLE_ORIGIN_ALLOCATED (2) 436#define ACPI_TABLE_ORIGIN_OVERRIDE (4) 437#define ACPI_TABLE_ORIGIN_MASK (7) 438#define ACPI_TABLE_IS_LOADED (8) 439 440 441/* 442 * Get the remaining ACPI tables 443 */ 444#include "actbl1.h" 445#include "actbl2.h" 446 447/* Macros used to generate offsets to specific table fields */ 448 449#define ACPI_FADT_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_TABLE_FADT, f) 450 451#endif /* __ACTBL_H__ */ 452