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