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 * Fundamental ACPI tables 50 * 51 * This file contains definitions for the ACPI tables that are directly consumed 52 * by ACPICA. All other tables are consumed by the OS-dependent ACPI-related 53 * device drivers and other OS support code. 54 * 55 * The RSDP and FACS do not use the common ACPI table header. All other ACPI 56 * tables use the header. 57 * 58 ******************************************************************************/ 59 60 /* 61 * Values for description table header signatures for tables defined in this 62 * file. Useful because they make it more difficult to inadvertently type in 63 * the wrong signature. 64 */ 65 #define ACPI_SIG_DSDT "DSDT" /* Differentiated System Description Table */ 66 #define ACPI_SIG_FADT "FACP" /* Fixed ACPI Description Table */ 67 #define ACPI_SIG_FACS "FACS" /* Firmware ACPI Control Structure */ 68 #define ACPI_SIG_PSDT "PSDT" /* Persistent System Description Table */ 69 #define ACPI_SIG_RSDP "RSD PTR " /* Root System Description Pointer */ 70 #define ACPI_SIG_RSDT "RSDT" /* Root System Description Table */ 71 #define ACPI_SIG_XSDT "XSDT" /* Extended System Description Table */ 72 #define ACPI_SIG_SSDT "SSDT" /* Secondary System Description Table */ 73 #define ACPI_RSDP_NAME "RSDP" /* Short name for RSDP, not signature */ 74 75 /* 76 * All tables and structures must be byte-packed to match the ACPI 77 * specification, since the tables are provided by the system BIOS 78 */ 79 #pragma pack(1) 80 81 /* 82 * Note about bitfields: The u8 type is used for bitfields in ACPI tables. 83 * This is the only type that is even remotely portable. Anything else is not 84 * portable, so do not use any other bitfield types. 85 */ 86 87 /******************************************************************************* 88 * 89 * Master ACPI Table Header. This common header is used by all ACPI tables 90 * except the RSDP and FACS. 91 * 92 ******************************************************************************/ 93 94 struct acpi_table_header { 95 char signature[ACPI_NAME_SIZE]; /* ASCII table signature */ 96 u32 length; /* Length of table in bytes, including this header */ 97 u8 revision; /* ACPI Specification minor version # */ 98 u8 checksum; /* To make sum of entire table == 0 */ 99 char oem_id[ACPI_OEM_ID_SIZE]; /* ASCII OEM identification */ 100 char oem_table_id[ACPI_OEM_TABLE_ID_SIZE]; /* ASCII OEM table identification */ 101 u32 oem_revision; /* OEM revision number */ 102 char asl_compiler_id[ACPI_NAME_SIZE]; /* ASCII ASL compiler vendor ID */ 103 u32 asl_compiler_revision; /* ASL compiler version */ 104 }; 105 106 /******************************************************************************* 107 * 108 * GAS - Generic Address Structure (ACPI 2.0+) 109 * 110 * Note: Since this structure is used in the ACPI tables, it is byte aligned. 111 * If misaliged access is not supported by the hardware, accesses to the 112 * 64-bit Address field must be performed with care. 113 * 114 ******************************************************************************/ 115 116 struct acpi_generic_address { 117 u8 space_id; /* Address space where struct or register exists */ 118 u8 bit_width; /* Size in bits of given register */ 119 u8 bit_offset; /* Bit offset within the register */ 120 u8 access_width; /* Minimum Access size (ACPI 3.0) */ 121 u64 address; /* 64-bit address of struct or register */ 122 }; 123 124 /******************************************************************************* 125 * 126 * RSDP - Root System Description Pointer (Signature is "RSD PTR ") 127 * Version 2 128 * 129 ******************************************************************************/ 130 131 struct acpi_table_rsdp { 132 char signature[8]; /* ACPI signature, contains "RSD PTR " */ 133 u8 checksum; /* ACPI 1.0 checksum */ 134 char oem_id[ACPI_OEM_ID_SIZE]; /* OEM identification */ 135 u8 revision; /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */ 136 u32 rsdt_physical_address; /* 32-bit physical address of the RSDT */ 137 u32 length; /* Table length in bytes, including header (ACPI 2.0+) */ 138 u64 xsdt_physical_address; /* 64-bit physical address of the XSDT (ACPI 2.0+) */ 139 u8 extended_checksum; /* Checksum of entire table (ACPI 2.0+) */ 140 u8 reserved[3]; /* Reserved, must be zero */ 141 }; 142 143 #define ACPI_RSDP_REV0_SIZE 20 /* Size of original ACPI 1.0 RSDP */ 144 145 /******************************************************************************* 146 * 147 * RSDT/XSDT - Root System Description Tables 148 * Version 1 (both) 149 * 150 ******************************************************************************/ 151 152 struct acpi_table_rsdt { 153 struct acpi_table_header header; /* Common ACPI table header */ 154 u32 table_offset_entry[1]; /* Array of pointers to ACPI tables */ 155 }; 156 157 struct acpi_table_xsdt { 158 struct acpi_table_header header; /* Common ACPI table header */ 159 u64 table_offset_entry[1]; /* Array of pointers to ACPI tables */ 160 }; 161 162 /******************************************************************************* 163 * 164 * FACS - Firmware ACPI Control Structure (FACS) 165 * 166 ******************************************************************************/ 167 168 struct acpi_table_facs { 169 char signature[4]; /* ASCII table signature */ 170 u32 length; /* Length of structure, in bytes */ 171 u32 hardware_signature; /* Hardware configuration signature */ 172 u32 firmware_waking_vector; /* 32-bit physical address of the Firmware Waking Vector */ 173 u32 global_lock; /* Global Lock for shared hardware resources */ 174 u32 flags; 175 u64 xfirmware_waking_vector; /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */ 176 u8 version; /* Version of this table (ACPI 2.0+) */ 177 u8 reserved[3]; /* Reserved, must be zero */ 178 u32 ospm_flags; /* Flags to be set by OSPM (ACPI 4.0) */ 179 u8 reserved1[24]; /* Reserved, must be zero */ 180 }; 181 182 /* Masks for global_lock flag field above */ 183 184 #define ACPI_GLOCK_PENDING (1) /* 00: Pending global lock ownership */ 185 #define ACPI_GLOCK_OWNED (1<<1) /* 01: Global lock is owned */ 186 187 /* Masks for Flags field above */ 188 189 #define ACPI_FACS_S4_BIOS_PRESENT (1) /* 00: S4BIOS support is present */ 190 #define ACPI_FACS_64BIT_WAKE (1<<1) /* 01: 64-bit wake vector supported (ACPI 4.0) */ 191 192 /* Masks for ospm_flags field above */ 193 194 #define ACPI_FACS_64BIT_ENVIRONMENT (1) /* 00: 64-bit wake environment is required (ACPI 4.0) */ 195 196 /******************************************************************************* 197 * 198 * FADT - Fixed ACPI Description Table (Signature "FACP") 199 * Version 4 200 * 201 ******************************************************************************/ 202 203 /* Fields common to all versions of the FADT */ 204 205 struct acpi_table_fadt { 206 struct acpi_table_header header; /* Common ACPI table header */ 207 u32 facs; /* 32-bit physical address of FACS */ 208 u32 dsdt; /* 32-bit physical address of DSDT */ 209 u8 model; /* System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */ 210 u8 preferred_profile; /* Conveys preferred power management profile to OSPM. */ 211 u16 sci_interrupt; /* System vector of SCI interrupt */ 212 u32 smi_command; /* 32-bit Port address of SMI command port */ 213 u8 acpi_enable; /* Value to write to smi_cmd to enable ACPI */ 214 u8 acpi_disable; /* Value to write to smi_cmd to disable ACPI */ 215 u8 S4bios_request; /* Value to write to SMI CMD to enter S4BIOS state */ 216 u8 pstate_control; /* Processor performance state control */ 217 u32 pm1a_event_block; /* 32-bit Port address of Power Mgt 1a Event Reg Blk */ 218 u32 pm1b_event_block; /* 32-bit Port address of Power Mgt 1b Event Reg Blk */ 219 u32 pm1a_control_block; /* 32-bit Port address of Power Mgt 1a Control Reg Blk */ 220 u32 pm1b_control_block; /* 32-bit Port address of Power Mgt 1b Control Reg Blk */ 221 u32 pm2_control_block; /* 32-bit Port address of Power Mgt 2 Control Reg Blk */ 222 u32 pm_timer_block; /* 32-bit Port address of Power Mgt Timer Ctrl Reg Blk */ 223 u32 gpe0_block; /* 32-bit Port address of General Purpose Event 0 Reg Blk */ 224 u32 gpe1_block; /* 32-bit Port address of General Purpose Event 1 Reg Blk */ 225 u8 pm1_event_length; /* Byte Length of ports at pm1x_event_block */ 226 u8 pm1_control_length; /* Byte Length of ports at pm1x_control_block */ 227 u8 pm2_control_length; /* Byte Length of ports at pm2_control_block */ 228 u8 pm_timer_length; /* Byte Length of ports at pm_timer_block */ 229 u8 gpe0_block_length; /* Byte Length of ports at gpe0_block */ 230 u8 gpe1_block_length; /* Byte Length of ports at gpe1_block */ 231 u8 gpe1_base; /* Offset in GPE number space where GPE1 events start */ 232 u8 cst_control; /* Support for the _CST object and C States change notification */ 233 u16 C2latency; /* Worst case HW latency to enter/exit C2 state */ 234 u16 C3latency; /* Worst case HW latency to enter/exit C3 state */ 235 u16 flush_size; /* Processor's memory cache line width, in bytes */ 236 u16 flush_stride; /* Number of flush strides that need to be read */ 237 u8 duty_offset; /* Processor duty cycle index in processor's P_CNT reg */ 238 u8 duty_width; /* Processor duty cycle value bit width in P_CNT register */ 239 u8 day_alarm; /* Index to day-of-month alarm in RTC CMOS RAM */ 240 u8 month_alarm; /* Index to month-of-year alarm in RTC CMOS RAM */ 241 u8 century; /* Index to century in RTC CMOS RAM */ 242 u16 boot_flags; /* IA-PC Boot Architecture Flags (see below for individual flags) */ 243 u8 reserved; /* Reserved, must be zero */ 244 u32 flags; /* Miscellaneous flag bits (see below for individual flags) */ 245 struct acpi_generic_address reset_register; /* 64-bit address of the Reset register */ 246 u8 reset_value; /* Value to write to the reset_register port to reset the system */ 247 u8 reserved4[3]; /* Reserved, must be zero */ 248 u64 Xfacs; /* 64-bit physical address of FACS */ 249 u64 Xdsdt; /* 64-bit physical address of DSDT */ 250 struct acpi_generic_address xpm1a_event_block; /* 64-bit Extended Power Mgt 1a Event Reg Blk address */ 251 struct acpi_generic_address xpm1b_event_block; /* 64-bit Extended Power Mgt 1b Event Reg Blk address */ 252 struct acpi_generic_address xpm1a_control_block; /* 64-bit Extended Power Mgt 1a Control Reg Blk address */ 253 struct acpi_generic_address xpm1b_control_block; /* 64-bit Extended Power Mgt 1b Control Reg Blk address */ 254 struct acpi_generic_address xpm2_control_block; /* 64-bit Extended Power Mgt 2 Control Reg Blk address */ 255 struct acpi_generic_address xpm_timer_block; /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */ 256 struct acpi_generic_address xgpe0_block; /* 64-bit Extended General Purpose Event 0 Reg Blk address */ 257 struct acpi_generic_address xgpe1_block; /* 64-bit Extended General Purpose Event 1 Reg Blk address */ 258 struct acpi_generic_address sleep_control; /* 64-bit Sleep Control register */ 259 struct acpi_generic_address sleep_status; /* 64-bit Sleep Status register */ 260 }; 261 262 /* Masks for FADT Boot Architecture Flags (boot_flags) */ 263 264 #define ACPI_FADT_LEGACY_DEVICES (1) /* 00: [V2] System has LPC or ISA bus devices */ 265 #define ACPI_FADT_8042 (1<<1) /* 01: [V3] System has an 8042 controller on port 60/64 */ 266 #define ACPI_FADT_NO_VGA (1<<2) /* 02: [V4] It is not safe to probe for VGA hardware */ 267 #define ACPI_FADT_NO_MSI (1<<3) /* 03: [V4] Message Signaled Interrupts (MSI) must not be enabled */ 268 #define ACPI_FADT_NO_ASPM (1<<4) /* 04: [V4] PCIe ASPM control must not be enabled */ 269 #define ACPI_FADT_NO_CMOS_RTC (1<<5) /* 05: [V5] No CMOS real-time clock present */ 270 271 #define FADT2_REVISION_ID 3 272 273 /* Masks for FADT flags */ 274 275 #define ACPI_FADT_WBINVD (1) /* 00: [V1] The wbinvd instruction works properly */ 276 #define ACPI_FADT_WBINVD_FLUSH (1<<1) /* 01: [V1] wbinvd flushes but does not invalidate caches */ 277 #define ACPI_FADT_C1_SUPPORTED (1<<2) /* 02: [V1] All processors support C1 state */ 278 #define ACPI_FADT_C2_MP_SUPPORTED (1<<3) /* 03: [V1] C2 state works on MP system */ 279 #define ACPI_FADT_POWER_BUTTON (1<<4) /* 04: [V1] Power button is handled as a control method device */ 280 #define ACPI_FADT_SLEEP_BUTTON (1<<5) /* 05: [V1] Sleep button is handled as a control method device */ 281 #define ACPI_FADT_FIXED_RTC (1<<6) /* 06: [V1] RTC wakeup status not in fixed register space */ 282 #define ACPI_FADT_S4_RTC_WAKE (1<<7) /* 07: [V1] RTC alarm can wake system from S4 */ 283 #define ACPI_FADT_32BIT_TIMER (1<<8) /* 08: [V1] ACPI timer width is 32-bit (0=24-bit) */ 284 #define ACPI_FADT_DOCKING_SUPPORTED (1<<9) /* 09: [V1] Docking supported */ 285 #define ACPI_FADT_RESET_REGISTER (1<<10) /* 10: [V2] System reset via the FADT RESET_REG supported */ 286 #define ACPI_FADT_SEALED_CASE (1<<11) /* 11: [V3] No internal expansion capabilities and case is sealed */ 287 #define ACPI_FADT_HEADLESS (1<<12) /* 12: [V3] No local video capabilities or local input devices */ 288 #define ACPI_FADT_SLEEP_TYPE (1<<13) /* 13: [V3] Must execute native instruction after writing SLP_TYPx register */ 289 #define ACPI_FADT_PCI_EXPRESS_WAKE (1<<14) /* 14: [V4] System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */ 290 #define ACPI_FADT_PLATFORM_CLOCK (1<<15) /* 15: [V4] OSPM should use platform-provided timer (ACPI 3.0) */ 291 #define ACPI_FADT_S4_RTC_VALID (1<<16) /* 16: [V4] Contents of RTC_STS valid after S4 wake (ACPI 3.0) */ 292 #define ACPI_FADT_REMOTE_POWER_ON (1<<17) /* 17: [V4] System is compatible with remote power on (ACPI 3.0) */ 293 #define ACPI_FADT_APIC_CLUSTER (1<<18) /* 18: [V4] All local APICs must use cluster model (ACPI 3.0) */ 294 #define ACPI_FADT_APIC_PHYSICAL (1<<19) /* 19: [V4] All local x_aPICs must use physical dest mode (ACPI 3.0) */ 295 #define ACPI_FADT_HW_REDUCED (1<<20) /* 20: [V5] ACPI hardware is not implemented (ACPI 5.0) */ 296 #define ACPI_FADT_LOW_POWER_S0 (1<<21) /* 21: [V5] S0 power savings are equal or better than S3 (ACPI 5.0) */ 297 298 /* Values for preferred_profile (Preferred Power Management Profiles) */ 299 300 enum acpi_prefered_pm_profiles { 301 PM_UNSPECIFIED = 0, 302 PM_DESKTOP = 1, 303 PM_MOBILE = 2, 304 PM_WORKSTATION = 3, 305 PM_ENTERPRISE_SERVER = 4, 306 PM_SOHO_SERVER = 5, 307 PM_APPLIANCE_PC = 6, 308 PM_PERFORMANCE_SERVER = 7, 309 PM_TABLET = 8 310 }; 311 312 /* Values for sleep_status and sleep_control registers (V5 FADT) */ 313 314 #define ACPI_X_WAKE_STATUS 0x80 315 #define ACPI_X_SLEEP_TYPE_MASK 0x1C 316 #define ACPI_X_SLEEP_TYPE_POSITION 0x02 317 #define ACPI_X_SLEEP_ENABLE 0x20 318 319 /* Reset to default packing */ 320 321 #pragma pack() 322 323 #define ACPI_FADT_OFFSET(f) (u16) ACPI_OFFSET (struct acpi_table_fadt, f) 324 325 /* 326 * Internal table-related structures 327 */ 328 union acpi_name_union { 329 u32 integer; 330 char ascii[4]; 331 }; 332 333 /* Internal ACPI Table Descriptor. One per ACPI table. */ 334 335 struct acpi_table_desc { 336 acpi_physical_address address; 337 struct acpi_table_header *pointer; 338 u32 length; /* Length fixed at 32 bits */ 339 union acpi_name_union signature; 340 acpi_owner_id owner_id; 341 u8 flags; 342 }; 343 344 /* Masks for Flags field above */ 345 346 #define ACPI_TABLE_ORIGIN_UNKNOWN (0) 347 #define ACPI_TABLE_ORIGIN_MAPPED (1) 348 #define ACPI_TABLE_ORIGIN_ALLOCATED (2) 349 #define ACPI_TABLE_ORIGIN_OVERRIDE (4) 350 #define ACPI_TABLE_ORIGIN_MASK (7) 351 #define ACPI_TABLE_IS_LOADED (8) 352 353 /* 354 * Get the remaining ACPI tables 355 */ 356 357 #include <acpi/actbl1.h> 358 #include <acpi/actbl2.h> 359 #include <acpi/actbl3.h> 360 361 /* 362 * Sizes of the various flavors of FADT. We need to look closely 363 * at the FADT length because the version number essentially tells 364 * us nothing because of many BIOS bugs where the version does not 365 * match the expected length. In other words, the length of the 366 * FADT is the bottom line as to what the version really is. 367 * 368 * For reference, the values below are as follows: 369 * FADT V1 size: 0x074 370 * FADT V2 size: 0x084 371 * FADT V3 size: 0x0F4 372 * FADT V4 size: 0x0F4 373 * FADT V5 size: 0x10C 374 */ 375 #define ACPI_FADT_V1_SIZE (u32) (ACPI_FADT_OFFSET (flags) + 4) 376 #define ACPI_FADT_V2_SIZE (u32) (ACPI_FADT_OFFSET (reserved4[0]) + 3) 377 #define ACPI_FADT_V3_SIZE (u32) (ACPI_FADT_OFFSET (sleep_control)) 378 #define ACPI_FADT_V5_SIZE (u32) (sizeof (struct acpi_table_fadt)) 379 380 #endif /* __ACTBL_H__ */ 381