1 /****************************************************************************** 2 * 3 * Name: actbl.h - Basic ACPI Table Definitions 4 * $Revision: 1.85 $ 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2008, 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 * Values for description table header signatures. Useful because they make 122 * it more difficult to inadvertently type in the wrong signature. 123 */ 124 #define ACPI_SIG_DSDT "DSDT" /* Differentiated System Description Table */ 125 #define ACPI_SIG_FADT "FACP" /* Fixed ACPI Description Table */ 126 #define ACPI_SIG_FACS "FACS" /* Firmware ACPI Control Structure */ 127 #define ACPI_SIG_PSDT "PSDT" /* Persistent System Description Table */ 128 #define ACPI_SIG_RSDP "RSD PTR " /* Root System Description Pointer */ 129 #define ACPI_SIG_RSDT "RSDT" /* Root System Description Table */ 130 #define ACPI_SIG_XSDT "XSDT" /* Extended System Description Table */ 131 #define ACPI_SIG_SSDT "SSDT" /* Secondary System Description Table */ 132 #define ACPI_RSDP_NAME "RSDP" /* Short name for RSDP, not signature */ 133 134 135 /* 136 * All tables and structures must be byte-packed to match the ACPI 137 * specification, since the tables are provided by the system BIOS 138 */ 139 #pragma pack(1) 140 141 142 /* 143 * These are the ACPI tables that are directly consumed by the subsystem. 144 * 145 * The RSDP and FACS do not use the common ACPI table header. All other ACPI 146 * tables use the header. 147 * 148 * Note about bitfields: The UINT8 type is used for bitfields in ACPI tables. 149 * This is the only type that is even remotely portable. Anything else is not 150 * portable, so do not use any other bitfield types. 151 */ 152 153 /******************************************************************************* 154 * 155 * ACPI Table Header. This common header is used by all tables except the 156 * RSDP and FACS. The define is used for direct inclusion of header into 157 * other ACPI tables 158 * 159 ******************************************************************************/ 160 161 typedef struct acpi_table_header 162 { 163 char Signature[ACPI_NAME_SIZE]; /* ASCII table signature */ 164 UINT32 Length; /* Length of table in bytes, including this header */ 165 UINT8 Revision; /* ACPI Specification minor version # */ 166 UINT8 Checksum; /* To make sum of entire table == 0 */ 167 char OemId[ACPI_OEM_ID_SIZE]; /* ASCII OEM identification */ 168 char OemTableId[ACPI_OEM_TABLE_ID_SIZE]; /* ASCII OEM table identification */ 169 UINT32 OemRevision; /* OEM revision number */ 170 char AslCompilerId[ACPI_NAME_SIZE]; /* ASCII ASL compiler vendor ID */ 171 UINT32 AslCompilerRevision; /* ASL compiler version */ 172 173 } ACPI_TABLE_HEADER; 174 175 176 /* 177 * GAS - Generic Address Structure (ACPI 2.0+) 178 * 179 * Note: Since this structure is used in the ACPI tables, it is byte aligned. 180 * If misalignment is not supported, access to the Address field must be 181 * performed with care. 182 */ 183 typedef struct acpi_generic_address 184 { 185 UINT8 SpaceId; /* Address space where struct or register exists */ 186 UINT8 BitWidth; /* Size in bits of given register */ 187 UINT8 BitOffset; /* Bit offset within the register */ 188 UINT8 AccessWidth; /* Minimum Access size (ACPI 3.0) */ 189 UINT64 Address; /* 64-bit address of struct or register */ 190 191 } ACPI_GENERIC_ADDRESS; 192 193 194 /******************************************************************************* 195 * 196 * RSDP - Root System Description Pointer (Signature is "RSD PTR ") 197 * 198 ******************************************************************************/ 199 200 typedef struct acpi_table_rsdp 201 { 202 char Signature[8]; /* ACPI signature, contains "RSD PTR " */ 203 UINT8 Checksum; /* ACPI 1.0 checksum */ 204 char OemId[ACPI_OEM_ID_SIZE]; /* OEM identification */ 205 UINT8 Revision; /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */ 206 UINT32 RsdtPhysicalAddress; /* 32-bit physical address of the RSDT */ 207 UINT32 Length; /* Table length in bytes, including header (ACPI 2.0+) */ 208 UINT64 XsdtPhysicalAddress; /* 64-bit physical address of the XSDT (ACPI 2.0+) */ 209 UINT8 ExtendedChecksum; /* Checksum of entire table (ACPI 2.0+) */ 210 UINT8 Reserved[3]; /* Reserved, must be zero */ 211 212 } ACPI_TABLE_RSDP; 213 214 #define ACPI_RSDP_REV0_SIZE 20 /* Size of original ACPI 1.0 RSDP */ 215 216 217 /******************************************************************************* 218 * 219 * RSDT/XSDT - Root System Description Tables 220 * 221 ******************************************************************************/ 222 223 typedef struct acpi_table_rsdt 224 { 225 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 226 UINT32 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */ 227 228 } ACPI_TABLE_RSDT; 229 230 typedef struct acpi_table_xsdt 231 { 232 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 233 UINT64 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */ 234 235 } ACPI_TABLE_XSDT; 236 237 238 /******************************************************************************* 239 * 240 * FACS - Firmware ACPI Control Structure (FACS) 241 * 242 ******************************************************************************/ 243 244 typedef struct acpi_table_facs 245 { 246 char Signature[4]; /* ASCII table signature */ 247 UINT32 Length; /* Length of structure, in bytes */ 248 UINT32 HardwareSignature; /* Hardware configuration signature */ 249 UINT32 FirmwareWakingVector; /* 32-bit physical address of the Firmware Waking Vector */ 250 UINT32 GlobalLock; /* Global Lock for shared hardware resources */ 251 UINT32 Flags; 252 UINT64 XFirmwareWakingVector; /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */ 253 UINT8 Version; /* Version of this table (ACPI 2.0+) */ 254 UINT8 Reserved[31]; /* Reserved, must be zero */ 255 256 } ACPI_TABLE_FACS; 257 258 /* Flag macros */ 259 260 #define ACPI_FACS_S4_BIOS_PRESENT (1) /* 00: S4BIOS support is present */ 261 262 /* Global lock flags */ 263 264 #define ACPI_GLOCK_PENDING 0x01 /* 00: Pending global lock ownership */ 265 #define ACPI_GLOCK_OWNED 0x02 /* 01: Global lock is owned */ 266 267 268 /******************************************************************************* 269 * 270 * FADT - Fixed ACPI Description Table (Signature "FACP") 271 * 272 ******************************************************************************/ 273 274 /* Fields common to all versions of the FADT */ 275 276 typedef struct acpi_table_fadt 277 { 278 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 279 UINT32 Facs; /* 32-bit physical address of FACS */ 280 UINT32 Dsdt; /* 32-bit physical address of DSDT */ 281 UINT8 Model; /* System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */ 282 UINT8 PreferredProfile; /* Conveys preferred power management profile to OSPM. */ 283 UINT16 SciInterrupt; /* System vector of SCI interrupt */ 284 UINT32 SmiCommand; /* 32-bit Port address of SMI command port */ 285 UINT8 AcpiEnable; /* Value to write to smi_cmd to enable ACPI */ 286 UINT8 AcpiDisable; /* Value to write to smi_cmd to disable ACPI */ 287 UINT8 S4BiosRequest; /* Value to write to SMI CMD to enter S4BIOS state */ 288 UINT8 PstateControl; /* Processor performance state control*/ 289 UINT32 Pm1aEventBlock; /* 32-bit Port address of Power Mgt 1a Event Reg Blk */ 290 UINT32 Pm1bEventBlock; /* 32-bit Port address of Power Mgt 1b Event Reg Blk */ 291 UINT32 Pm1aControlBlock; /* 32-bit Port address of Power Mgt 1a Control Reg Blk */ 292 UINT32 Pm1bControlBlock; /* 32-bit Port address of Power Mgt 1b Control Reg Blk */ 293 UINT32 Pm2ControlBlock; /* 32-bit Port address of Power Mgt 2 Control Reg Blk */ 294 UINT32 PmTimerBlock; /* 32-bit Port address of Power Mgt Timer Ctrl Reg Blk */ 295 UINT32 Gpe0Block; /* 32-bit Port address of General Purpose Event 0 Reg Blk */ 296 UINT32 Gpe1Block; /* 32-bit Port address of General Purpose Event 1 Reg Blk */ 297 UINT8 Pm1EventLength; /* Byte Length of ports at Pm1xEventBlock */ 298 UINT8 Pm1ControlLength; /* Byte Length of ports at Pm1xControlBlock */ 299 UINT8 Pm2ControlLength; /* Byte Length of ports at Pm2ControlBlock */ 300 UINT8 PmTimerLength; /* Byte Length of ports at PmTimerBlock */ 301 UINT8 Gpe0BlockLength; /* Byte Length of ports at Gpe0Block */ 302 UINT8 Gpe1BlockLength; /* Byte Length of ports at Gpe1Block */ 303 UINT8 Gpe1Base; /* Offset in GPE number space where GPE1 events start */ 304 UINT8 CstControl; /* Support for the _CST object and C States change notification */ 305 UINT16 C2Latency; /* Worst case HW latency to enter/exit C2 state */ 306 UINT16 C3Latency; /* Worst case HW latency to enter/exit C3 state */ 307 UINT16 FlushSize; /* Processor's memory cache line width, in bytes */ 308 UINT16 FlushStride; /* Number of flush strides that need to be read */ 309 UINT8 DutyOffset; /* Processor duty cycle index in processor's P_CNT reg*/ 310 UINT8 DutyWidth; /* Processor duty cycle value bit width in P_CNT register.*/ 311 UINT8 DayAlarm; /* Index to day-of-month alarm in RTC CMOS RAM */ 312 UINT8 MonthAlarm; /* Index to month-of-year alarm in RTC CMOS RAM */ 313 UINT8 Century; /* Index to century in RTC CMOS RAM */ 314 UINT16 BootFlags; /* IA-PC Boot Architecture Flags. See Table 5-10 for description */ 315 UINT8 Reserved; /* Reserved, must be zero */ 316 UINT32 Flags; /* Miscellaneous flag bits (see below for individual flags) */ 317 ACPI_GENERIC_ADDRESS ResetRegister; /* 64-bit address of the Reset register */ 318 UINT8 ResetValue; /* Value to write to the ResetRegister port to reset the system */ 319 UINT8 Reserved4[3]; /* Reserved, must be zero */ 320 UINT64 XFacs; /* 64-bit physical address of FACS */ 321 UINT64 XDsdt; /* 64-bit physical address of DSDT */ 322 ACPI_GENERIC_ADDRESS XPm1aEventBlock; /* 64-bit Extended Power Mgt 1a Event Reg Blk address */ 323 ACPI_GENERIC_ADDRESS XPm1bEventBlock; /* 64-bit Extended Power Mgt 1b Event Reg Blk address */ 324 ACPI_GENERIC_ADDRESS XPm1aControlBlock; /* 64-bit Extended Power Mgt 1a Control Reg Blk address */ 325 ACPI_GENERIC_ADDRESS XPm1bControlBlock; /* 64-bit Extended Power Mgt 1b Control Reg Blk address */ 326 ACPI_GENERIC_ADDRESS XPm2ControlBlock; /* 64-bit Extended Power Mgt 2 Control Reg Blk address */ 327 ACPI_GENERIC_ADDRESS XPmTimerBlock; /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */ 328 ACPI_GENERIC_ADDRESS XGpe0Block; /* 64-bit Extended General Purpose Event 0 Reg Blk address */ 329 ACPI_GENERIC_ADDRESS XGpe1Block; /* 64-bit Extended General Purpose Event 1 Reg Blk address */ 330 331 } ACPI_TABLE_FADT; 332 333 334 /* FADT flags */ 335 336 #define ACPI_FADT_WBINVD (1) /* 00: The wbinvd instruction works properly */ 337 #define ACPI_FADT_WBINVD_FLUSH (1<<1) /* 01: The wbinvd flushes but does not invalidate */ 338 #define ACPI_FADT_C1_SUPPORTED (1<<2) /* 02: All processors support C1 state */ 339 #define ACPI_FADT_C2_MP_SUPPORTED (1<<3) /* 03: C2 state works on MP system */ 340 #define ACPI_FADT_POWER_BUTTON (1<<4) /* 04: Power button is handled as a generic feature */ 341 #define ACPI_FADT_SLEEP_BUTTON (1<<5) /* 05: Sleep button is handled as a generic feature, or not present */ 342 #define ACPI_FADT_FIXED_RTC (1<<6) /* 06: RTC wakeup stat not in fixed register space */ 343 #define ACPI_FADT_S4_RTC_WAKE (1<<7) /* 07: RTC wakeup stat not possible from S4 */ 344 #define ACPI_FADT_32BIT_TIMER (1<<8) /* 08: tmr_val is 32 bits 0=24-bits */ 345 #define ACPI_FADT_DOCKING_SUPPORTED (1<<9) /* 09: Docking supported */ 346 #define ACPI_FADT_RESET_REGISTER (1<<10) /* 10: System reset via the FADT RESET_REG supported */ 347 #define ACPI_FADT_SEALED_CASE (1<<11) /* 11: No internal expansion capabilities and case is sealed */ 348 #define ACPI_FADT_HEADLESS (1<<12) /* 12: No local video capabilities or local input devices */ 349 #define ACPI_FADT_SLEEP_TYPE (1<<13) /* 13: Must execute native instruction after writing SLP_TYPx register */ 350 #define ACPI_FADT_PCI_EXPRESS_WAKE (1<<14) /* 14: System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */ 351 #define ACPI_FADT_PLATFORM_CLOCK (1<<15) /* 15: OSPM should use platform-provided timer (ACPI 3.0) */ 352 #define ACPI_FADT_S4_RTC_VALID (1<<16) /* 16: Contents of RTC_STS valid after S4 wake (ACPI 3.0) */ 353 #define ACPI_FADT_REMOTE_POWER_ON (1<<17) /* 17: System is compatible with remote power on (ACPI 3.0) */ 354 #define ACPI_FADT_APIC_CLUSTER (1<<18) /* 18: All local APICs must use cluster model (ACPI 3.0) */ 355 #define ACPI_FADT_APIC_PHYSICAL (1<<19) /* 19: All local xAPICs must use physical dest mode (ACPI 3.0) */ 356 357 358 /* 359 * FADT Prefered Power Management Profiles 360 */ 361 enum AcpiPreferedPmProfiles 362 { 363 PM_UNSPECIFIED = 0, 364 PM_DESKTOP = 1, 365 PM_MOBILE = 2, 366 PM_WORKSTATION = 3, 367 PM_ENTERPRISE_SERVER = 4, 368 PM_SOHO_SERVER = 5, 369 PM_APPLIANCE_PC = 6 370 }; 371 372 373 /* FADT Boot Arch Flags */ 374 375 #define BAF_LEGACY_DEVICES 0x0001 376 #define BAF_8042_KEYBOARD_CONTROLLER 0x0002 377 378 #define FADT2_REVISION_ID 3 379 #define FADT2_MINUS_REVISION_ID 2 380 381 382 /* Reset to default packing */ 383 384 #pragma pack() 385 386 /* 387 * Get the remaining ACPI tables 388 */ 389 #include "actbl1.h" 390 391 /* Macros used to generate offsets to specific table fields */ 392 393 #define ACPI_FADT_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_TABLE_FADT, f) 394 395 #endif /* __ACTBL_H__ */ 396