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