1/****************************************************************************** 2 * 3 * Name: actbl.h - Basic ACPI Table Definitions 4 * 5 *****************************************************************************/ 6 7/* 8 * Copyright (C) 2000 - 2011, 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 __ACTBL_H__ 45#define __ACTBL_H__ 46 47 48/******************************************************************************* 49 * 50 * Fundamental ACPI tables 51 * 52 * This file contains definitions for the ACPI tables that are directly consumed 53 * by ACPICA. All other tables are consumed by the OS-dependent ACPI-related 54 * device drivers and other OS support code. 55 * 56 * The RSDP and FACS do not use the common ACPI table header. All other ACPI 57 * tables use the header. 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_DSDT "DSDT" /* Differentiated System Description Table */ 68#define ACPI_SIG_FADT "FACP" /* Fixed ACPI Description Table */ 69#define ACPI_SIG_FACS "FACS" /* Firmware ACPI Control Structure */ 70#define ACPI_SIG_PSDT "PSDT" /* Persistent System Description Table */ 71#define ACPI_SIG_RSDP "RSD PTR " /* Root System Description Pointer */ 72#define ACPI_SIG_RSDT "RSDT" /* Root System Description Table */ 73#define ACPI_SIG_XSDT "XSDT" /* Extended System Description Table */ 74#define ACPI_SIG_SSDT "SSDT" /* Secondary System Description Table */ 75#define ACPI_RSDP_NAME "RSDP" /* Short name for RSDP, not signature */ 76 77 78/* 79 * All tables and structures must be byte-packed to match the ACPI 80 * specification, since the tables are provided by the system BIOS 81 */ 82#pragma pack(1) 83 84/* 85 * Note about bitfields: The UINT8 type is used for bitfields in ACPI tables. 86 * This is the only type that is even remotely portable. Anything else is not 87 * portable, so do not use any other bitfield types. 88 */ 89 90 91/******************************************************************************* 92 * 93 * Master ACPI Table Header. This common header is used by all ACPI tables 94 * except the RSDP and FACS. 95 * 96 ******************************************************************************/ 97 98typedef struct acpi_table_header 99{ 100 char Signature[ACPI_NAME_SIZE]; /* ASCII table signature */ 101 UINT32 Length; /* Length of table in bytes, including this header */ 102 UINT8 Revision; /* ACPI Specification minor version # */ 103 UINT8 Checksum; /* To make sum of entire table == 0 */ 104 char OemId[ACPI_OEM_ID_SIZE]; /* ASCII OEM identification */ 105 char OemTableId[ACPI_OEM_TABLE_ID_SIZE]; /* ASCII OEM table identification */ 106 UINT32 OemRevision; /* OEM revision number */ 107 char AslCompilerId[ACPI_NAME_SIZE]; /* ASCII ASL compiler vendor ID */ 108 UINT32 AslCompilerRevision; /* ASL compiler version */ 109 110} ACPI_TABLE_HEADER; 111 112 113/******************************************************************************* 114 * 115 * GAS - Generic Address Structure (ACPI 2.0+) 116 * 117 * Note: Since this structure is used in the ACPI tables, it is byte aligned. 118 * If misaliged access is not supported by the hardware, accesses to the 119 * 64-bit Address field must be performed with care. 120 * 121 ******************************************************************************/ 122 123typedef struct acpi_generic_address 124{ 125 UINT8 SpaceId; /* Address space where struct or register exists */ 126 UINT8 BitWidth; /* Size in bits of given register */ 127 UINT8 BitOffset; /* Bit offset within the register */ 128 UINT8 AccessWidth; /* Minimum Access size (ACPI 3.0) */ 129 UINT64 Address; /* 64-bit address of struct or register */ 130 131} ACPI_GENERIC_ADDRESS; 132 133 134/******************************************************************************* 135 * 136 * RSDP - Root System Description Pointer (Signature is "RSD PTR ") 137 * Version 2 138 * 139 ******************************************************************************/ 140 141typedef struct acpi_table_rsdp 142{ 143 char Signature[8]; /* ACPI signature, contains "RSD PTR " */ 144 UINT8 Checksum; /* ACPI 1.0 checksum */ 145 char OemId[ACPI_OEM_ID_SIZE]; /* OEM identification */ 146 UINT8 Revision; /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */ 147 UINT32 RsdtPhysicalAddress; /* 32-bit physical address of the RSDT */ 148 UINT32 Length; /* Table length in bytes, including header (ACPI 2.0+) */ 149 UINT64 XsdtPhysicalAddress; /* 64-bit physical address of the XSDT (ACPI 2.0+) */ 150 UINT8 ExtendedChecksum; /* Checksum of entire table (ACPI 2.0+) */ 151 UINT8 Reserved[3]; /* Reserved, must be zero */ 152 153} ACPI_TABLE_RSDP; 154 155/* Standalone struct for the ACPI 1.0 RSDP */ 156 157typedef struct acpi_rsdp_common 158{ 159 char Signature[8]; 160 UINT8 Checksum; 161 char OemId[ACPI_OEM_ID_SIZE]; 162 UINT8 Revision; 163 UINT32 RsdtPhysicalAddress; 164 165} ACPI_RSDP_COMMON; 166 167/* Standalone struct for the extended part of the RSDP (ACPI 2.0+) */ 168 169typedef struct acpi_rsdp_extension 170{ 171 UINT32 Length; 172 UINT64 XsdtPhysicalAddress; 173 UINT8 ExtendedChecksum; 174 UINT8 Reserved[3]; 175 176} ACPI_RSDP_EXTENSION; 177 178 179/******************************************************************************* 180 * 181 * RSDT/XSDT - Root System Description Tables 182 * Version 1 (both) 183 * 184 ******************************************************************************/ 185 186typedef struct acpi_table_rsdt 187{ 188 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 189 UINT32 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */ 190 191} ACPI_TABLE_RSDT; 192 193typedef struct acpi_table_xsdt 194{ 195 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 196 UINT64 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */ 197 198} ACPI_TABLE_XSDT; 199 200 201/******************************************************************************* 202 * 203 * FACS - Firmware ACPI Control Structure (FACS) 204 * 205 ******************************************************************************/ 206 207typedef struct acpi_table_facs 208{ 209 char Signature[4]; /* ASCII table signature */ 210 UINT32 Length; /* Length of structure, in bytes */ 211 UINT32 HardwareSignature; /* Hardware configuration signature */ 212 UINT32 FirmwareWakingVector; /* 32-bit physical address of the Firmware Waking Vector */ 213 UINT32 GlobalLock; /* Global Lock for shared hardware resources */ 214 UINT32 Flags; 215 UINT64 XFirmwareWakingVector; /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */ 216 UINT8 Version; /* Version of this table (ACPI 2.0+) */ 217 UINT8 Reserved[3]; /* Reserved, must be zero */ 218 UINT32 OspmFlags; /* Flags to be set by OSPM (ACPI 4.0) */ 219 UINT8 Reserved1[24]; /* Reserved, must be zero */ 220 221} ACPI_TABLE_FACS; 222 223/* Masks for GlobalLock flag field above */ 224 225#define ACPI_GLOCK_PENDING (1) /* 00: Pending global lock ownership */ 226#define ACPI_GLOCK_OWNED (1<<1) /* 01: Global lock is owned */ 227 228/* Masks for Flags field above */ 229 230#define ACPI_FACS_S4_BIOS_PRESENT (1) /* 00: S4BIOS support is present */ 231#define ACPI_FACS_64BIT_WAKE (1<<1) /* 01: 64-bit wake vector supported (ACPI 4.0) */ 232 233/* Masks for OspmFlags field above */ 234 235#define ACPI_FACS_64BIT_ENVIRONMENT (1) /* 00: 64-bit wake environment is required (ACPI 4.0) */ 236 237 238/******************************************************************************* 239 * 240 * FADT - Fixed ACPI Description Table (Signature "FACP") 241 * Version 4 242 * 243 ******************************************************************************/ 244 245/* Fields common to all versions of the FADT */ 246 247typedef struct acpi_table_fadt 248{ 249 ACPI_TABLE_HEADER Header; /* Common ACPI table header */ 250 UINT32 Facs; /* 32-bit physical address of FACS */ 251 UINT32 Dsdt; /* 32-bit physical address of DSDT */ 252 UINT8 Model; /* System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */ 253 UINT8 PreferredProfile; /* Conveys preferred power management profile to OSPM. */ 254 UINT16 SciInterrupt; /* System vector of SCI interrupt */ 255 UINT32 SmiCommand; /* 32-bit Port address of SMI command port */ 256 UINT8 AcpiEnable; /* Value to write to smi_cmd to enable ACPI */ 257 UINT8 AcpiDisable; /* Value to write to smi_cmd to disable ACPI */ 258 UINT8 S4BiosRequest; /* Value to write to SMI CMD to enter S4BIOS state */ 259 UINT8 PstateControl; /* Processor performance state control*/ 260 UINT32 Pm1aEventBlock; /* 32-bit Port address of Power Mgt 1a Event Reg Blk */ 261 UINT32 Pm1bEventBlock; /* 32-bit Port address of Power Mgt 1b Event Reg Blk */ 262 UINT32 Pm1aControlBlock; /* 32-bit Port address of Power Mgt 1a Control Reg Blk */ 263 UINT32 Pm1bControlBlock; /* 32-bit Port address of Power Mgt 1b Control Reg Blk */ 264 UINT32 Pm2ControlBlock; /* 32-bit Port address of Power Mgt 2 Control Reg Blk */ 265 UINT32 PmTimerBlock; /* 32-bit Port address of Power Mgt Timer Ctrl Reg Blk */ 266 UINT32 Gpe0Block; /* 32-bit Port address of General Purpose Event 0 Reg Blk */ 267 UINT32 Gpe1Block; /* 32-bit Port address of General Purpose Event 1 Reg Blk */ 268 UINT8 Pm1EventLength; /* Byte Length of ports at Pm1xEventBlock */ 269 UINT8 Pm1ControlLength; /* Byte Length of ports at Pm1xControlBlock */ 270 UINT8 Pm2ControlLength; /* Byte Length of ports at Pm2ControlBlock */ 271 UINT8 PmTimerLength; /* Byte Length of ports at PmTimerBlock */ 272 UINT8 Gpe0BlockLength; /* Byte Length of ports at Gpe0Block */ 273 UINT8 Gpe1BlockLength; /* Byte Length of ports at Gpe1Block */ 274 UINT8 Gpe1Base; /* Offset in GPE number space where GPE1 events start */ 275 UINT8 CstControl; /* Support for the _CST object and C States change notification */ 276 UINT16 C2Latency; /* Worst case HW latency to enter/exit C2 state */ 277 UINT16 C3Latency; /* Worst case HW latency to enter/exit C3 state */ 278 UINT16 FlushSize; /* Processor's memory cache line width, in bytes */ 279 UINT16 FlushStride; /* Number of flush strides that need to be read */ 280 UINT8 DutyOffset; /* Processor duty cycle index in processor's P_CNT reg */ 281 UINT8 DutyWidth; /* Processor duty cycle value bit width in P_CNT register */ 282 UINT8 DayAlarm; /* Index to day-of-month alarm in RTC CMOS RAM */ 283 UINT8 MonthAlarm; /* Index to month-of-year alarm in RTC CMOS RAM */ 284 UINT8 Century; /* Index to century in RTC CMOS RAM */ 285 UINT16 BootFlags; /* IA-PC Boot Architecture Flags (see below for individual flags) */ 286 UINT8 Reserved; /* Reserved, must be zero */ 287 UINT32 Flags; /* Miscellaneous flag bits (see below for individual flags) */ 288 ACPI_GENERIC_ADDRESS ResetRegister; /* 64-bit address of the Reset register */ 289 UINT8 ResetValue; /* Value to write to the ResetRegister port to reset the system */ 290 UINT8 Reserved4[3]; /* Reserved, must be zero */ 291 UINT64 XFacs; /* 64-bit physical address of FACS */ 292 UINT64 XDsdt; /* 64-bit physical address of DSDT */ 293 ACPI_GENERIC_ADDRESS XPm1aEventBlock; /* 64-bit Extended Power Mgt 1a Event Reg Blk address */ 294 ACPI_GENERIC_ADDRESS XPm1bEventBlock; /* 64-bit Extended Power Mgt 1b Event Reg Blk address */ 295 ACPI_GENERIC_ADDRESS XPm1aControlBlock; /* 64-bit Extended Power Mgt 1a Control Reg Blk address */ 296 ACPI_GENERIC_ADDRESS XPm1bControlBlock; /* 64-bit Extended Power Mgt 1b Control Reg Blk address */ 297 ACPI_GENERIC_ADDRESS XPm2ControlBlock; /* 64-bit Extended Power Mgt 2 Control Reg Blk address */ 298 ACPI_GENERIC_ADDRESS XPmTimerBlock; /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */ 299 ACPI_GENERIC_ADDRESS XGpe0Block; /* 64-bit Extended General Purpose Event 0 Reg Blk address */ 300 ACPI_GENERIC_ADDRESS XGpe1Block; /* 64-bit Extended General Purpose Event 1 Reg Blk address */ 301 302} ACPI_TABLE_FADT; 303 304 305/* Masks for FADT Boot Architecture Flags (BootFlags) */ 306 307#define ACPI_FADT_LEGACY_DEVICES (1) /* 00: [V2] System has LPC or ISA bus devices */ 308#define ACPI_FADT_8042 (1<<1) /* 01: [V3] System has an 8042 controller on port 60/64 */ 309#define ACPI_FADT_NO_VGA (1<<2) /* 02: [V4] It is not safe to probe for VGA hardware */ 310#define ACPI_FADT_NO_MSI (1<<3) /* 03: [V4] Message Signaled Interrupts (MSI) must not be enabled */ 311#define ACPI_FADT_NO_ASPM (1<<4) /* 04: [V4] PCIe ASPM control must not be enabled */ 312 313/* Masks for FADT flags */ 314 315#define ACPI_FADT_WBINVD (1) /* 00: [V1] The wbinvd instruction works properly */ 316#define ACPI_FADT_WBINVD_FLUSH (1<<1) /* 01: [V1] wbinvd flushes but does not invalidate caches */ 317#define ACPI_FADT_C1_SUPPORTED (1<<2) /* 02: [V1] All processors support C1 state */ 318#define ACPI_FADT_C2_MP_SUPPORTED (1<<3) /* 03: [V1] C2 state works on MP system */ 319#define ACPI_FADT_POWER_BUTTON (1<<4) /* 04: [V1] Power button is handled as a control method device */ 320#define ACPI_FADT_SLEEP_BUTTON (1<<5) /* 05: [V1] Sleep button is handled as a control method device */ 321#define ACPI_FADT_FIXED_RTC (1<<6) /* 06: [V1] RTC wakeup status not in fixed register space */ 322#define ACPI_FADT_S4_RTC_WAKE (1<<7) /* 07: [V1] RTC alarm can wake system from S4 */ 323#define ACPI_FADT_32BIT_TIMER (1<<8) /* 08: [V1] ACPI timer width is 32-bit (0=24-bit) */ 324#define ACPI_FADT_DOCKING_SUPPORTED (1<<9) /* 09: [V1] Docking supported */ 325#define ACPI_FADT_RESET_REGISTER (1<<10) /* 10: [V2] System reset via the FADT RESET_REG supported */ 326#define ACPI_FADT_SEALED_CASE (1<<11) /* 11: [V3] No internal expansion capabilities and case is sealed */ 327#define ACPI_FADT_HEADLESS (1<<12) /* 12: [V3] No local video capabilities or local input devices */ 328#define ACPI_FADT_SLEEP_TYPE (1<<13) /* 13: [V3] Must execute native instruction after writing SLP_TYPx register */ 329#define ACPI_FADT_PCI_EXPRESS_WAKE (1<<14) /* 14: [V4] System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */ 330#define ACPI_FADT_PLATFORM_CLOCK (1<<15) /* 15: [V4] OSPM should use platform-provided timer (ACPI 3.0) */ 331#define ACPI_FADT_S4_RTC_VALID (1<<16) /* 16: [V4] Contents of RTC_STS valid after S4 wake (ACPI 3.0) */ 332#define ACPI_FADT_REMOTE_POWER_ON (1<<17) /* 17: [V4] System is compatible with remote power on (ACPI 3.0) */ 333#define ACPI_FADT_APIC_CLUSTER (1<<18) /* 18: [V4] All local APICs must use cluster model (ACPI 3.0) */ 334#define ACPI_FADT_APIC_PHYSICAL (1<<19) /* 19: [V4] All local xAPICs must use physical dest mode (ACPI 3.0) */ 335 336 337/* Values for PreferredProfile (Prefered Power Management Profiles) */ 338 339enum AcpiPreferedPmProfiles 340{ 341 PM_UNSPECIFIED = 0, 342 PM_DESKTOP = 1, 343 PM_MOBILE = 2, 344 PM_WORKSTATION = 3, 345 PM_ENTERPRISE_SERVER = 4, 346 PM_SOHO_SERVER = 5, 347 PM_APPLIANCE_PC = 6 348}; 349 350 351/* Reset to default packing */ 352 353#pragma pack() 354 355 356/* 357 * Internal table-related structures 358 */ 359typedef union acpi_name_union 360{ 361 UINT32 Integer; 362 char Ascii[4]; 363 364} ACPI_NAME_UNION; 365 366 367/* Internal ACPI Table Descriptor. One per ACPI table. */ 368 369typedef struct acpi_table_desc 370{ 371 ACPI_PHYSICAL_ADDRESS Address; 372 ACPI_TABLE_HEADER *Pointer; 373 UINT32 Length; /* Length fixed at 32 bits */ 374 ACPI_NAME_UNION Signature; 375 ACPI_OWNER_ID OwnerId; 376 UINT8 Flags; 377 378} ACPI_TABLE_DESC; 379 380/* Masks for Flags field above */ 381 382#define ACPI_TABLE_ORIGIN_UNKNOWN (0) 383#define ACPI_TABLE_ORIGIN_MAPPED (1) 384#define ACPI_TABLE_ORIGIN_ALLOCATED (2) 385#define ACPI_TABLE_ORIGIN_OVERRIDE (4) 386#define ACPI_TABLE_ORIGIN_MASK (7) 387#define ACPI_TABLE_IS_LOADED (8) 388 389 390/* 391 * Get the remaining ACPI tables 392 */ 393#include <contrib/dev/acpica/include/actbl1.h> 394#include <contrib/dev/acpica/include/actbl2.h> 395 396/* Macros used to generate offsets to specific table fields */ 397 398#define ACPI_FADT_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_TABLE_FADT, f) 399 400/* 401 * Sizes of the various flavors of FADT. We need to look closely 402 * at the FADT length because the version number essentially tells 403 * us nothing because of many BIOS bugs where the version does not 404 * match the expected length. In other words, the length of the 405 * FADT is the bottom line as to what the version really is. 406 * 407 * For reference, the values below are as follows: 408 * FADT V1 size: 0x74 409 * FADT V2 size: 0x84 410 * FADT V3+ size: 0xF4 411 */ 412#define ACPI_FADT_V1_SIZE (UINT32) (ACPI_FADT_OFFSET (Flags) + 4) 413#define ACPI_FADT_V2_SIZE (UINT32) (ACPI_FADT_OFFSET (Reserved4[0]) + 3) 414#define ACPI_FADT_V3_SIZE (UINT32) (sizeof (ACPI_TABLE_FADT)) 415 416#endif /* __ACTBL_H__ */ 417