ACPICA: use new ACPI headers.
[linux-2.6.git] / include / acpi / actbl.h
1 /******************************************************************************
2  *
3  * Name: actbl.h - Basic ACPI Table Definitions
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2006, 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 __ACTBL_H__
45 #define __ACTBL_H__
46
47 /*
48  * Values for description table header signatures. Useful because they make
49  * it more difficult to inadvertently type in the wrong signature.
50  */
51 #define ACPI_SIG_DSDT           "DSDT"  /* Differentiated System Description Table */
52 #define ACPI_SIG_FADT           "FACP"  /* Fixed ACPI Description Table */
53 #define ACPI_SIG_FACS           "FACS"  /* Firmware ACPI Control Structure */
54 #define ACPI_SIG_PSDT           "PSDT"  /* Persistent System Description Table */
55 #define ACPI_SIG_RSDP           "RSD PTR "      /* Root System Description Pointer */
56 #define ACPI_SIG_RSDT           "RSDT"  /* Root System Description Table */
57 #define ACPI_SIG_XSDT           "XSDT"  /* Extended  System Description Table */
58 #define ACPI_SIG_SSDT           "SSDT"  /* Secondary System Description Table */
59 #define ACPI_RSDP_NAME          "RSDP"  /* Short name for RSDP, not signature */
60
61 /*
62  * All tables and structures must be byte-packed to match the ACPI
63  * specification, since the tables are provided by the system BIOS
64  */
65 #pragma pack(1)
66
67 /*
68  * These are the ACPI tables that are directly consumed by the subsystem.
69  *
70  * The RSDP and FACS do not use the common ACPI table header. All other ACPI
71  * tables use the header.
72  *
73  * Note about bitfields: The u8 type is used for bitfields in ACPI tables.
74  * This is the only type that is even remotely portable. Anything else is not
75  * portable, so do not use any other bitfield types.
76  */
77
78 /*******************************************************************************
79  *
80  * ACPI Table Header. This common header is used by all tables except the
81  * RSDP and FACS. The define is used for direct inclusion of header into
82  * other ACPI tables
83  *
84  ******************************************************************************/
85
86 struct acpi_table_header {
87         char signature[ACPI_NAME_SIZE]; /* ASCII table signature */
88         u32 length;             /* Length of table in bytes, including this header */
89         u8 revision;            /* ACPI Specification minor version # */
90         u8 checksum;            /* To make sum of entire table == 0 */
91         char oem_id[ACPI_OEM_ID_SIZE];  /* ASCII OEM identification */
92         char oem_table_id[ACPI_OEM_TABLE_ID_SIZE];      /* ASCII OEM table identification */
93         u32 oem_revision;       /* OEM revision number */
94         char asl_compiler_id[ACPI_NAME_SIZE];   /* ASCII ASL compiler vendor ID */
95         u32 asl_compiler_revision;      /* ASL compiler version */
96 };
97
98 /*
99  * GAS - Generic Address Structure (ACPI 2.0+)
100  *
101  * Note: Since this structure is used in the ACPI tables, it is byte aligned.
102  * If misalignment is not supported, access to the Address field must be
103  * performed with care.
104  */
105 struct acpi_generic_address {
106         u8 space_id;            /* Address space where struct or register exists */
107         u8 bit_width;           /* Size in bits of given register */
108         u8 bit_offset;          /* Bit offset within the register */
109         u8 access_width;        /* Minimum Access size (ACPI 3.0) */
110         u64 address;            /* 64-bit address of struct or register */
111 };
112
113 /*******************************************************************************
114  *
115  * RSDP - Root System Description Pointer (Signature is "RSD PTR ")
116  *
117  ******************************************************************************/
118
119 struct acpi_table_rsdp {
120         char signature[8];      /* ACPI signature, contains "RSD PTR " */
121         u8 checksum;            /* ACPI 1.0 checksum */
122         char oem_id[ACPI_OEM_ID_SIZE];  /* OEM identification */
123         u8 revision;            /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */
124         u32 rsdt_physical_address;      /* 32-bit physical address of the RSDT */
125         u32 length;             /* Table length in bytes, including header (ACPI 2.0+) */
126         u64 xsdt_physical_address;      /* 64-bit physical address of the XSDT (ACPI 2.0+) */
127         u8 extended_checksum;   /* Checksum of entire table (ACPI 2.0+) */
128         u8 reserved[3];         /* Reserved, must be zero */
129 };
130
131 #define ACPI_RSDP_REV0_SIZE     20      /* Size of original ACPI 1.0 RSDP */
132
133 /*******************************************************************************
134  *
135  * RSDT/XSDT - Root System Description Tables
136  *
137  ******************************************************************************/
138
139 struct acpi_table_rsdt {
140         struct acpi_table_header header;        /* Common ACPI table header */
141         u32 table_offset_entry[1];      /* Array of pointers to ACPI tables */
142 };
143
144 struct acpi_table_xsdt {
145         struct acpi_table_header header;        /* Common ACPI table header */
146         u64 table_offset_entry[1];      /* Array of pointers to ACPI tables */
147 };
148
149 /*******************************************************************************
150  *
151  * FACS - Firmware ACPI Control Structure (FACS)
152  *
153  ******************************************************************************/
154
155 struct acpi_table_facs {
156         char signature[4];      /* ASCII table signature */
157         u32 length;             /* Length of structure, in bytes */
158         u32 hardware_signature; /* Hardware configuration signature */
159         u32 firmware_waking_vector;     /* 32-bit physical address of the Firmware Waking Vector */
160         u32 global_lock;        /* Global Lock for shared hardware resources */
161         u32 flags;
162         u64 xfirmware_waking_vector;    /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */
163         u8 version;             /* Version of this table (ACPI 2.0+) */
164         u8 reserved[31];        /* Reserved, must be zero */
165 };
166
167 /* Flag macros */
168
169 #define ACPI_FACS_S4_BIOS_PRESENT (1)   /* 00: S4BIOS support is present */
170
171 /* Global lock flags */
172
173 #define ACPI_GLOCK_PENDING      0x01    /* 00: Pending global lock ownership */
174 #define ACPI_GLOCK_OWNED        0x02    /* 01: Global lock is owned */
175
176 /*******************************************************************************
177  *
178  * FADT - Fixed ACPI Description Table (Signature "FACP")
179  *
180  ******************************************************************************/
181
182 /* Fields common to all versions of the FADT */
183
184 struct acpi_table_fadt {
185         struct acpi_table_header header;        /* Common ACPI table header */
186         u32 facs;               /* 32-bit physical address of FACS */
187         u32 dsdt;               /* 32-bit physical address of DSDT */
188         u8 model;               /* System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */
189         u8 preferred_profile;   /* Conveys preferred power management profile to OSPM. */
190         u16 sci_interrupt;      /* System vector of SCI interrupt */
191         u32 smi_command;        /* 32-bit Port address of SMI command port */
192         u8 acpi_enable;         /* Value to write to smi_cmd to enable ACPI */
193         u8 acpi_disable;        /* Value to write to smi_cmd to disable ACPI */
194         u8 S4bios_request;      /* Value to write to SMI CMD to enter S4BIOS state */
195         u8 pstate_control;      /* Processor performance state control */
196         u32 pm1a_event_block;   /* 32-bit Port address of Power Mgt 1a Event Reg Blk */
197         u32 pm1b_event_block;   /* 32-bit Port address of Power Mgt 1b Event Reg Blk */
198         u32 pm1a_control_block; /* 32-bit Port address of Power Mgt 1a Control Reg Blk */
199         u32 pm1b_control_block; /* 32-bit Port address of Power Mgt 1b Control Reg Blk */
200         u32 pm2_control_block;  /* 32-bit Port address of Power Mgt 2 Control Reg Blk */
201         u32 pm_timer_block;     /* 32-bit Port address of Power Mgt Timer Ctrl Reg Blk */
202         u32 gpe0_block;         /* 32-bit Port address of General Purpose Event 0 Reg Blk */
203         u32 gpe1_block;         /* 32-bit Port address of General Purpose Event 1 Reg Blk */
204         u8 pm1_event_length;    /* Byte Length of ports at pm1x_event_block */
205         u8 pm1_control_length;  /* Byte Length of ports at pm1x_control_block */
206         u8 pm2_control_length;  /* Byte Length of ports at pm2_control_block */
207         u8 pm_timer_length;     /* Byte Length of ports at pm_timer_block */
208         u8 gpe0_block_length;   /* Byte Length of ports at gpe0_block */
209         u8 gpe1_block_length;   /* Byte Length of ports at gpe1_block */
210         u8 gpe1_base;           /* Offset in GPE number space where GPE1 events start */
211         u8 cst_control;         /* Support for the _CST object and C States change notification */
212         u16 C2latency;          /* Worst case HW latency to enter/exit C2 state */
213         u16 C3latency;          /* Worst case HW latency to enter/exit C3 state */
214         u16 flush_size;         /* Processor's memory cache line width, in bytes */
215         u16 flush_stride;       /* Number of flush strides that need to be read */
216         u8 duty_offset;         /* Processor duty cycle index in processor's P_CNT reg */
217         u8 duty_width;          /* Processor duty cycle value bit width in P_CNT register. */
218         u8 day_alarm;           /* Index to day-of-month alarm in RTC CMOS RAM */
219         u8 month_alarm;         /* Index to month-of-year alarm in RTC CMOS RAM */
220         u8 century;             /* Index to century in RTC CMOS RAM */
221         u16 boot_flags;         /* IA-PC Boot Architecture Flags. See Table 5-10 for description */
222         u8 reserved;            /* Reserved, must be zero */
223         u32 flags;              /* Miscellaneous flag bits (see below for individual flags) */
224         struct acpi_generic_address reset_register;     /* 64-bit address of the Reset register */
225         u8 reset_value;         /* Value to write to the reset_register port to reset the system */
226         u8 reserved4[3];        /* Reserved, must be zero */
227         u64 Xfacs;              /* 64-bit physical address of FACS */
228         u64 Xdsdt;              /* 64-bit physical address of DSDT */
229         struct acpi_generic_address xpm1a_event_block;  /* 64-bit Extended Power Mgt 1a Event Reg Blk address */
230         struct acpi_generic_address xpm1b_event_block;  /* 64-bit Extended Power Mgt 1b Event Reg Blk address */
231         struct acpi_generic_address xpm1a_control_block;        /* 64-bit Extended Power Mgt 1a Control Reg Blk address */
232         struct acpi_generic_address xpm1b_control_block;        /* 64-bit Extended Power Mgt 1b Control Reg Blk address */
233         struct acpi_generic_address xpm2_control_block; /* 64-bit Extended Power Mgt 2 Control Reg Blk address */
234         struct acpi_generic_address xpm_timer_block;    /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */
235         struct acpi_generic_address xgpe0_block;        /* 64-bit Extended General Purpose Event 0 Reg Blk address */
236         struct acpi_generic_address xgpe1_block;        /* 64-bit Extended General Purpose Event 1 Reg Blk address */
237 };
238
239 /* FADT flags */
240
241 #define ACPI_FADT_WBINVD            (1) /* 00: The wbinvd instruction works properly */
242 #define ACPI_FADT_WBINVD_FLUSH      (1<<1)      /* 01: The wbinvd flushes but does not invalidate */
243 #define ACPI_FADT_C1_SUPPORTED      (1<<2)      /* 02: All processors support C1 state */
244 #define ACPI_FADT_C2_MP_SUPPORTED   (1<<3)      /* 03: C2 state works on MP system */
245 #define ACPI_FADT_POWER_BUTTON      (1<<4)      /* 04: Power button is handled as a generic feature */
246 #define ACPI_FADT_SLEEP_BUTTON      (1<<5)      /* 05: Sleep button is handled as a generic feature, or  not present */
247 #define ACPI_FADT_FIXED_RTC         (1<<6)      /* 06: RTC wakeup stat not in fixed register space */
248 #define ACPI_FADT_S4_RTC_WAKE       (1<<7)      /* 07: RTC wakeup stat not possible from S4 */
249 #define ACPI_FADT_32BIT_TIMER       (1<<8)      /* 08: tmr_val is 32 bits 0=24-bits */
250 #define ACPI_FADT_DOCKING_SUPPORTED (1<<9)      /* 09: Docking supported */
251 #define ACPI_FADT_RESET_REGISTER    (1<<10)     /* 10: System reset via the FADT RESET_REG supported */
252 #define ACPI_FADT_SEALED_CASE       (1<<11)     /* 11: No internal expansion capabilities and case is sealed */
253 #define ACPI_FADT_HEADLESS          (1<<12)     /* 12: No local video capabilities or local input devices */
254 #define ACPI_FADT_SLEEP_TYPE        (1<<13)     /* 13: Must execute native instruction after writing  SLP_TYPx register */
255 #define ACPI_FADT_PCI_EXPRESS_WAKE  (1<<14)     /* 14: System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */
256 #define ACPI_FADT_PLATFORM_CLOCK    (1<<15)     /* 15: OSPM should use platform-provided timer (ACPI 3.0) */
257 #define ACPI_FADT_S4_RTC_VALID      (1<<16)     /* 16: Contents of RTC_STS valid after S4 wake (ACPI 3.0) */
258 #define ACPI_FADT_REMOTE_POWER_ON   (1<<17)     /* 17: System is compatible with remote power on (ACPI 3.0) */
259 #define ACPI_FADT_APIC_CLUSTER      (1<<18)     /* 18: All local APICs must use cluster model (ACPI 3.0) */
260 #define ACPI_FADT_APIC_PHYSICAL     (1<<19)     /* 19: All local x_aPICs must use physical dest mode (ACPI 3.0) */
261
262 /*
263  * FADT Prefered Power Management Profiles
264  */
265 enum acpi_prefered_pm_profiles {
266         PM_UNSPECIFIED = 0,
267         PM_DESKTOP = 1,
268         PM_MOBILE = 2,
269         PM_WORKSTATION = 3,
270         PM_ENTERPRISE_SERVER = 4,
271         PM_SOHO_SERVER = 5,
272         PM_APPLIANCE_PC = 6
273 };
274
275 /* FADT Boot Arch Flags */
276
277 #define BAF_LEGACY_DEVICES              0x0001
278 #define BAF_8042_KEYBOARD_CONTROLLER    0x0002
279
280 #define FADT2_REVISION_ID               3
281 #define FADT2_MINUS_REVISION_ID         2
282
283 /* Reset to default packing */
284
285 #pragma pack()
286
287 #define ACPI_FADT_OFFSET(f)             (u8) ACPI_OFFSET (struct acpi_table_fadt, f)
288
289 /*
290  * Get the remaining ACPI tables
291  */
292 /*
293  Don't include any new tables definitions for now.
294 #include <acpi/actbl1.h>
295 */
296 #endif                          /* __ACTBL_H__ */