include/acpi/actbl2.h

   1 /******************************************************************************
   2  *
   3  * Name: actbl2.h - ACPI Specification Revision 2.0 Tables
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   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 __ACTBL2_H__
  45 #define __ACTBL2_H__
  46
  47 /*
  48  * Prefered Power Management Profiles
  49  */
  50 #define PM_UNSPECIFIED                  0
  51 #define PM_DESKTOP                      1
  52 #define PM_MOBILE                       2
  53 #define PM_WORKSTATION                  3
  54 #define PM_ENTERPRISE_SERVER            4
  55 #define PM_SOHO_SERVER                  5
  56 #define PM_APPLIANCE_PC                 6
  57
  58 /*
  59  * ACPI Boot Arch Flags
  60  */
  61 #define BAF_LEGACY_DEVICES              0x0001
  62 #define BAF_8042_KEYBOARD_CONTROLLER    0x0002
  63
  64 #define FADT2_REVISION_ID               3
  65 #define FADT2_MINUS_REVISION_ID         2
  66
  67
  68 #pragma pack(1)
  69
  70 /*
  71  * ACPI 2.0 Root System Description Table (RSDT)
  72  */
  73 struct rsdt_descriptor_rev2
  74 {
  75         ACPI_TABLE_HEADER_DEF                           /* ACPI common table header */
  76         u32                             table_offset_entry[1];  /* Array of pointers to ACPI tables */
  77 };
  78
  79
  80 /*
  81  * ACPI 2.0 Extended System Description Table (XSDT)
  82  */
  83 struct xsdt_descriptor_rev2
  84 {
  85         ACPI_TABLE_HEADER_DEF                           /* ACPI common table header */
  86         u64                             table_offset_entry[1];  /* Array of pointers to ACPI tables */
  87 };
  88
  89
  90 /*
  91  * ACPI 2.0 Firmware ACPI Control Structure (FACS)
  92  */
  93 struct facs_descriptor_rev2
  94 {
  95         char                            signature[4];           /* ASCII table signature */
  96         u32                             length;                 /* Length of structure, in bytes */
  97         u32                             hardware_signature;     /* Hardware configuration signature */
  98         u32                             firmware_waking_vector; /* 32-bit physical address of the Firmware Waking Vector. */
  99         u32                             global_lock;            /* Global Lock used to synchronize access to shared hardware resources */
 100
 101         /* Flags (32 bits) */
 102
 103         u8                              S4bios_f        : 1;    /* 00:    S4BIOS support is present */
 104         u8                                              : 7;    /* 01-07: Reserved, must be zero */
 105         u8                              reserved1[3];           /* 08-31: Reserved, must be zero */
 106
 107         u64                             xfirmware_waking_vector; /* 64-bit physical address of the Firmware Waking Vector. */
 108         u8                              version;                /* Version of this table */
 109         u8                              reserved3[31];          /* Reserved, must be zero */
 110 };
 111
 112
 113 /*
 114  * ACPI 2.0+ Generic Address Structure (GAS)
 115  */
 116 struct acpi_generic_address
 117 {
 118         u8                              address_space_id;       /* Address space where struct or register exists. */
 119         u8                              register_bit_width;     /* Size in bits of given register */
 120         u8                              register_bit_offset;    /* Bit offset within the register */
 121         u8                              access_width;           /* Minimum Access size (ACPI 3.0) */
 122         u64                             address;                /* 64-bit address of struct or register */
 123 };
 124
 125
 126 #define FADT_REV2_COMMON \
 127         u32                             V1_firmware_ctrl;   /* 32-bit physical address of FACS */ \
 128         u32                             V1_dsdt;            /* 32-bit physical address of DSDT */ \
 129         u8                              reserved1;          /* System Interrupt Model isn't used in ACPI 2.0*/ \
 130         u8                              prefer_PM_profile;  /* Conveys preferred power management profile to OSPM. */ \
 131         u16                             sci_int;            /* System vector of SCI interrupt */ \
 132         u32                             smi_cmd;            /* Port address of SMI command port */ \
 133         u8                              acpi_enable;        /* Value to write to smi_cmd to enable ACPI */ \
 134         u8                              acpi_disable;       /* Value to write to smi_cmd to disable ACPI */ \
 135         u8                              S4bios_req;         /* Value to write to SMI CMD to enter S4BIOS state */ \
 136         u8                              pstate_cnt;         /* Processor performance state control*/ \
 137         u32                             V1_pm1a_evt_blk;    /* Port address of Power Mgt 1a acpi_event Reg Blk */ \
 138         u32                             V1_pm1b_evt_blk;    /* Port address of Power Mgt 1b acpi_event Reg Blk */ \
 139         u32                             V1_pm1a_cnt_blk;    /* Port address of Power Mgt 1a Control Reg Blk */ \
 140         u32                             V1_pm1b_cnt_blk;    /* Port address of Power Mgt 1b Control Reg Blk */ \
 141         u32                             V1_pm2_cnt_blk;     /* Port address of Power Mgt 2 Control Reg Blk */ \
 142         u32                             V1_pm_tmr_blk;      /* Port address of Power Mgt Timer Ctrl Reg Blk */ \
 143         u32                             V1_gpe0_blk;        /* Port addr of General Purpose acpi_event 0 Reg Blk */ \
 144         u32                             V1_gpe1_blk;        /* Port addr of General Purpose acpi_event 1 Reg Blk */ \
 145         u8                              pm1_evt_len;        /* Byte length of ports at pm1_x_evt_blk */ \
 146         u8                              pm1_cnt_len;        /* Byte length of ports at pm1_x_cnt_blk */ \
 147         u8                              pm2_cnt_len;        /* Byte Length of ports at pm2_cnt_blk */ \
 148         u8                              pm_tm_len;          /* Byte Length of ports at pm_tm_blk */ \
 149         u8                              gpe0_blk_len;       /* Byte Length of ports at gpe0_blk */ \
 150         u8                              gpe1_blk_len;       /* Byte Length of ports at gpe1_blk */ \
 151         u8                              gpe1_base;          /* Offset in gpe model where gpe1 events start */ \
 152         u8                              cst_cnt;            /* Support for the _CST object and C States change notification.*/ \
 153         u16                             plvl2_lat;          /* Worst case HW latency to enter/exit C2 state */ \
 154         u16                             plvl3_lat;          /* Worst case HW latency to enter/exit C3 state */ \
 155         u16                             flush_size;         /* Number of flush strides that need to be read */ \
 156         u16                             flush_stride;       /* Processor's memory cache line width, in bytes */ \
 157         u8                              duty_offset;        /* Processor's duty cycle index in processor's P_CNT reg*/ \
 158         u8                              duty_width;         /* Processor's duty cycle value bit width in P_CNT register.*/ \
 159         u8                              day_alrm;           /* Index to day-of-month alarm in RTC CMOS RAM */ \
 160         u8                              mon_alrm;           /* Index to month-of-year alarm in RTC CMOS RAM */ \
 161         u8                              century;            /* Index to century in RTC CMOS RAM */ \
 162         u16                             iapc_boot_arch;     /* IA-PC Boot Architecture Flags. See Table 5-10 for description*/
 163
 164 /*
 165  * ACPI 2.0+ Fixed ACPI Description Table (FADT)
 166  */
 167 struct fadt_descriptor_rev2
 168 {
 169         ACPI_TABLE_HEADER_DEF                       /* ACPI common table header */
 170         FADT_REV2_COMMON
 171         u8                              reserved2;          /* Reserved, must be zero */
 172
 173         /* Flags (32 bits) */
 174
 175         u8                              wb_invd     : 1;    /* 00:    The wbinvd instruction works properly */
 176         u8                              wb_invd_flush : 1;  /* 01:    The wbinvd flushes but does not invalidate */
 177         u8                              proc_c1     : 1;    /* 02:    All processors support C1 state */
 178         u8                              plvl2_up    : 1;    /* 03:    C2 state works on MP system */
 179         u8                              pwr_button  : 1;    /* 04:    Power button is handled as a generic feature */
 180         u8                              sleep_button : 1;   /* 05:    Sleep button is handled as a generic feature, or not present */
 181         u8                              fixed_rTC   : 1;    /* 06:    RTC wakeup stat not in fixed register space */
 182         u8                              rtcs4       : 1;    /* 07:    RTC wakeup stat not possible from S4 */
 183         u8                              tmr_val_ext : 1;    /* 08:    tmr_val is 32 bits 0=24-bits */
 184         u8                              dock_cap    : 1;    /* 09:    Docking supported */
 185         u8                              reset_reg_sup : 1;  /* 10:    System reset via the FADT RESET_REG supported */
 186         u8                              sealed_case : 1;    /* 11:    No internal expansion capabilities and case is sealed */
 187         u8                              headless    : 1;    /* 12:    No local video capabilities or local input devices */
 188         u8                              cpu_sw_sleep : 1;   /* 13:    Must execute native instruction after writing SLP_TYPx register */
 189
 190         u8                              pci_exp_wak                         : 1; /* 14:    System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */
 191         u8                              use_platform_clock                  : 1; /* 15:    OSPM should use platform-provided timer (ACPI 3.0) */
 192         u8                              S4rtc_sts_valid                     : 1; /* 16:    Contents of RTC_STS valid after S4 wake (ACPI 3.0) */
 193         u8                              remote_power_on_capable             : 1; /* 17:    System is compatible with remote power on (ACPI 3.0) */
 194         u8                              force_apic_cluster_model            : 1; /* 18:    All local APICs must use cluster model (ACPI 3.0) */
 195         u8                              force_apic_physical_destination_mode : 1; /* 19:   all local x_aPICs must use physical dest mode (ACPI 3.0) */
 196         u8                                                                  : 4; /* 20-23: Reserved, must be zero */
 197         u8                              reserved3;                               /* 24-31: Reserved, must be zero */
 198
 199         struct acpi_generic_address     reset_register;     /* Reset register address in GAS format */
 200         u8                              reset_value;        /* Value to write to the reset_register port to reset the system */
 201         u8                              reserved4[3];       /* These three bytes must be zero */
 202         u64                             xfirmware_ctrl;     /* 64-bit physical address of FACS */
 203         u64                             Xdsdt;              /* 64-bit physical address of DSDT */
 204         struct acpi_generic_address     xpm1a_evt_blk;      /* Extended Power Mgt 1a acpi_event Reg Blk address */
 205         struct acpi_generic_address     xpm1b_evt_blk;      /* Extended Power Mgt 1b acpi_event Reg Blk address */
 206         struct acpi_generic_address     xpm1a_cnt_blk;      /* Extended Power Mgt 1a Control Reg Blk address */
 207         struct acpi_generic_address     xpm1b_cnt_blk;      /* Extended Power Mgt 1b Control Reg Blk address */
 208         struct acpi_generic_address     xpm2_cnt_blk;       /* Extended Power Mgt 2 Control Reg Blk address */
 209         struct acpi_generic_address     xpm_tmr_blk;        /* Extended Power Mgt Timer Ctrl Reg Blk address */
 210         struct acpi_generic_address     xgpe0_blk;          /* Extended General Purpose acpi_event 0 Reg Blk address */
 211         struct acpi_generic_address     xgpe1_blk;          /* Extended General Purpose acpi_event 1 Reg Blk address */
 212 };
 213
 214
 215 /* "Down-revved" ACPI 2.0 FADT descriptor */
 216
 217 struct fadt_descriptor_rev2_minus
 218 {
 219         ACPI_TABLE_HEADER_DEF                       /* ACPI common table header */
 220         FADT_REV2_COMMON
 221         u8                              reserved2;          /* Reserved, must be zero */
 222         u32                             flags;
 223         struct acpi_generic_address     reset_register;     /* Reset register address in GAS format */
 224         u8                              reset_value;        /* Value to write to the reset_register port to reset the system. */
 225         u8                              reserved7[3];       /* Reserved, must be zero */
 226 };
 227
 228
 229 /* ECDT - Embedded Controller Boot Resources Table */
 230
 231 struct ec_boot_resources
 232 {
 233         ACPI_TABLE_HEADER_DEF
 234         struct acpi_generic_address     ec_control;         /* Address of EC command/status register */
 235         struct acpi_generic_address     ec_data;            /* Address of EC data register */
 236         u32                             uid;                /* Unique ID - must be same as the EC _UID method */
 237         u8                              gpe_bit;            /* The GPE for the EC */
 238         u8                              ec_id[1];           /* Full namepath of the EC in the ACPI namespace */
 239 };
 240
 241
 242 /* SRAT - System Resource Affinity Table */
 243
 244 struct static_resource_alloc
 245 {
 246         u8                              type;
 247         u8                              length;
 248         u8                              proximity_domain_lo;
 249         u8                              apic_id;
 250
 251         /* Flags (32 bits) */
 252
 253         u8                              enabled         :1; /* 00:    Use affinity structure */
 254         u8                                              :7; /* 01-07: Reserved, must be zero */
 255         u8                              reserved3[3];       /* 08-31: Reserved, must be zero */
 256
 257         u8                              local_sapic_eid;
 258         u8                              proximity_domain_hi[3];
 259         u32                             reserved4;          /* Reserved, must be zero */
 260 };
 261
 262 struct memory_affinity
 263 {
 264         u8                              type;
 265         u8                              length;
 266         u32                             proximity_domain;
 267         u16                             reserved3;
 268         u64                             base_address;
 269         u64                             address_length;
 270         u32                             reserved4;
 271
 272         /* Flags (32 bits) */
 273
 274         u8                              enabled         :1; /* 00:    Use affinity structure */
 275         u8                              hot_pluggable   :1; /* 01:    Memory region is hot pluggable */
 276         u8                              non_volatile    :1; /* 02:    Memory is non-volatile */
 277         u8                                              :5; /* 03-07: Reserved, must be zero */
 278         u8                              reserved5[3];       /* 08-31: Reserved, must be zero */
 279
 280         u64                             reserved6;          /* Reserved, must be zero */
 281 };
 282
 283 struct system_resource_affinity
 284 {
 285         ACPI_TABLE_HEADER_DEF
 286         u32                             reserved1;          /* Must be value '1' */
 287         u64                             reserved2;          /* Reserved, must be zero */
 288 };
 289
 290
 291 /* SLIT - System Locality Distance Information Table */
 292
 293 struct system_locality_info
 294 {
 295         ACPI_TABLE_HEADER_DEF
 296         u64                             locality_count;
 297         u8                              entry[1][1];
 298 };
 299
 300
 301 #pragma pack()
 302
 303 #endif /* __ACTBL2_H__ */
 304