actbl.h revision 1.1.1.12.2.1 1 1.1 jruoho /******************************************************************************
2 1.1 jruoho *
3 1.1 jruoho * Name: actbl.h - Basic ACPI Table Definitions
4 1.1 jruoho *
5 1.1 jruoho *****************************************************************************/
6 1.1 jruoho
7 1.1.1.2 jruoho /*
8 1.1.1.12.2.1 christos * Copyright (C) 2000 - 2019, Intel Corp.
9 1.1 jruoho * All rights reserved.
10 1.1 jruoho *
11 1.1.1.2 jruoho * Redistribution and use in source and binary forms, with or without
12 1.1.1.2 jruoho * modification, are permitted provided that the following conditions
13 1.1.1.2 jruoho * are met:
14 1.1.1.2 jruoho * 1. Redistributions of source code must retain the above copyright
15 1.1.1.2 jruoho * notice, this list of conditions, and the following disclaimer,
16 1.1.1.2 jruoho * without modification.
17 1.1.1.2 jruoho * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 1.1.1.2 jruoho * substantially similar to the "NO WARRANTY" disclaimer below
19 1.1.1.2 jruoho * ("Disclaimer") and any redistribution must be conditioned upon
20 1.1.1.2 jruoho * including a substantially similar Disclaimer requirement for further
21 1.1.1.2 jruoho * binary redistribution.
22 1.1.1.2 jruoho * 3. Neither the names of the above-listed copyright holders nor the names
23 1.1.1.2 jruoho * of any contributors may be used to endorse or promote products derived
24 1.1.1.2 jruoho * from this software without specific prior written permission.
25 1.1.1.2 jruoho *
26 1.1.1.2 jruoho * Alternatively, this software may be distributed under the terms of the
27 1.1.1.2 jruoho * GNU General Public License ("GPL") version 2 as published by the Free
28 1.1.1.2 jruoho * Software Foundation.
29 1.1.1.2 jruoho *
30 1.1.1.2 jruoho * NO WARRANTY
31 1.1.1.2 jruoho * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 1.1.1.2 jruoho * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 1.1.1.2 jruoho * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 1.1.1.2 jruoho * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 1.1.1.2 jruoho * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 1.1.1.2 jruoho * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 1.1.1.2 jruoho * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 1.1.1.2 jruoho * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 1.1.1.2 jruoho * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 1.1.1.2 jruoho * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 1.1.1.2 jruoho * POSSIBILITY OF SUCH DAMAGES.
42 1.1.1.2 jruoho */
43 1.1 jruoho
44 1.1 jruoho #ifndef __ACTBL_H__
45 1.1 jruoho #define __ACTBL_H__
46 1.1 jruoho
47 1.1 jruoho
48 1.1 jruoho /*******************************************************************************
49 1.1 jruoho *
50 1.1 jruoho * Fundamental ACPI tables
51 1.1 jruoho *
52 1.1 jruoho * This file contains definitions for the ACPI tables that are directly consumed
53 1.1 jruoho * by ACPICA. All other tables are consumed by the OS-dependent ACPI-related
54 1.1 jruoho * device drivers and other OS support code.
55 1.1 jruoho *
56 1.1 jruoho * The RSDP and FACS do not use the common ACPI table header. All other ACPI
57 1.1 jruoho * tables use the header.
58 1.1 jruoho *
59 1.1 jruoho ******************************************************************************/
60 1.1 jruoho
61 1.1 jruoho
62 1.1 jruoho /*
63 1.1 jruoho * Values for description table header signatures for tables defined in this
64 1.1 jruoho * file. Useful because they make it more difficult to inadvertently type in
65 1.1 jruoho * the wrong signature.
66 1.1 jruoho */
67 1.1 jruoho #define ACPI_SIG_DSDT "DSDT" /* Differentiated System Description Table */
68 1.1 jruoho #define ACPI_SIG_FADT "FACP" /* Fixed ACPI Description Table */
69 1.1 jruoho #define ACPI_SIG_FACS "FACS" /* Firmware ACPI Control Structure */
70 1.1.1.6 christos #define ACPI_SIG_OSDT "OSDT" /* Override System Description Table */
71 1.1 jruoho #define ACPI_SIG_PSDT "PSDT" /* Persistent System Description Table */
72 1.1 jruoho #define ACPI_SIG_RSDP "RSD PTR " /* Root System Description Pointer */
73 1.1 jruoho #define ACPI_SIG_RSDT "RSDT" /* Root System Description Table */
74 1.1 jruoho #define ACPI_SIG_XSDT "XSDT" /* Extended System Description Table */
75 1.1 jruoho #define ACPI_SIG_SSDT "SSDT" /* Secondary System Description Table */
76 1.1 jruoho #define ACPI_RSDP_NAME "RSDP" /* Short name for RSDP, not signature */
77 1.1.1.12.2.1 christos #define ACPI_OEM_NAME "OEM" /* Short name for OEM, not signature */
78 1.1 jruoho
79 1.1 jruoho
80 1.1 jruoho /*
81 1.1 jruoho * All tables and structures must be byte-packed to match the ACPI
82 1.1 jruoho * specification, since the tables are provided by the system BIOS
83 1.1 jruoho */
84 1.1 jruoho #pragma pack(1)
85 1.1 jruoho
86 1.1 jruoho /*
87 1.1.1.3 christos * Note: C bitfields are not used for this reason:
88 1.1.1.3 christos *
89 1.1.1.3 christos * "Bitfields are great and easy to read, but unfortunately the C language
90 1.1.1.3 christos * does not specify the layout of bitfields in memory, which means they are
91 1.1.1.3 christos * essentially useless for dealing with packed data in on-disk formats or
92 1.1.1.3 christos * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
93 1.1.1.3 christos * this decision was a design error in C. Ritchie could have picked an order
94 1.1.1.3 christos * and stuck with it." Norman Ramsey.
95 1.1.1.3 christos * See http://stackoverflow.com/a/1053662/41661
96 1.1 jruoho */
97 1.1 jruoho
98 1.1 jruoho
99 1.1 jruoho /*******************************************************************************
100 1.1 jruoho *
101 1.1 jruoho * Master ACPI Table Header. This common header is used by all ACPI tables
102 1.1 jruoho * except the RSDP and FACS.
103 1.1 jruoho *
104 1.1 jruoho ******************************************************************************/
105 1.1 jruoho
106 1.1 jruoho typedef struct acpi_table_header
107 1.1 jruoho {
108 1.1.1.12.2.1 christos char Signature[ACPI_NAMESEG_SIZE]; /* ASCII table signature */
109 1.1 jruoho UINT32 Length; /* Length of table in bytes, including this header */
110 1.1.1.3 christos UINT8 Revision; /* ACPI Specification minor version number */
111 1.1 jruoho UINT8 Checksum; /* To make sum of entire table == 0 */
112 1.1 jruoho char OemId[ACPI_OEM_ID_SIZE]; /* ASCII OEM identification */
113 1.1 jruoho char OemTableId[ACPI_OEM_TABLE_ID_SIZE]; /* ASCII OEM table identification */
114 1.1 jruoho UINT32 OemRevision; /* OEM revision number */
115 1.1.1.12.2.1 christos char AslCompilerId[ACPI_NAMESEG_SIZE]; /* ASCII ASL compiler vendor ID */
116 1.1 jruoho UINT32 AslCompilerRevision; /* ASL compiler version */
117 1.1 jruoho
118 1.1 jruoho } ACPI_TABLE_HEADER;
119 1.1 jruoho
120 1.1 jruoho
121 1.1 jruoho /*******************************************************************************
122 1.1 jruoho *
123 1.1 jruoho * GAS - Generic Address Structure (ACPI 2.0+)
124 1.1 jruoho *
125 1.1 jruoho * Note: Since this structure is used in the ACPI tables, it is byte aligned.
126 1.1.1.3 christos * If misaligned access is not supported by the hardware, accesses to the
127 1.1 jruoho * 64-bit Address field must be performed with care.
128 1.1 jruoho *
129 1.1 jruoho ******************************************************************************/
130 1.1 jruoho
131 1.1 jruoho typedef struct acpi_generic_address
132 1.1 jruoho {
133 1.1 jruoho UINT8 SpaceId; /* Address space where struct or register exists */
134 1.1 jruoho UINT8 BitWidth; /* Size in bits of given register */
135 1.1 jruoho UINT8 BitOffset; /* Bit offset within the register */
136 1.1 jruoho UINT8 AccessWidth; /* Minimum Access size (ACPI 3.0) */
137 1.1 jruoho UINT64 Address; /* 64-bit address of struct or register */
138 1.1 jruoho
139 1.1 jruoho } ACPI_GENERIC_ADDRESS;
140 1.1 jruoho
141 1.1 jruoho
142 1.1 jruoho /*******************************************************************************
143 1.1 jruoho *
144 1.1 jruoho * RSDP - Root System Description Pointer (Signature is "RSD PTR ")
145 1.1 jruoho * Version 2
146 1.1 jruoho *
147 1.1 jruoho ******************************************************************************/
148 1.1 jruoho
149 1.1 jruoho typedef struct acpi_table_rsdp
150 1.1 jruoho {
151 1.1 jruoho char Signature[8]; /* ACPI signature, contains "RSD PTR " */
152 1.1 jruoho UINT8 Checksum; /* ACPI 1.0 checksum */
153 1.1 jruoho char OemId[ACPI_OEM_ID_SIZE]; /* OEM identification */
154 1.1 jruoho UINT8 Revision; /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */
155 1.1 jruoho UINT32 RsdtPhysicalAddress; /* 32-bit physical address of the RSDT */
156 1.1 jruoho UINT32 Length; /* Table length in bytes, including header (ACPI 2.0+) */
157 1.1 jruoho UINT64 XsdtPhysicalAddress; /* 64-bit physical address of the XSDT (ACPI 2.0+) */
158 1.1 jruoho UINT8 ExtendedChecksum; /* Checksum of entire table (ACPI 2.0+) */
159 1.1 jruoho UINT8 Reserved[3]; /* Reserved, must be zero */
160 1.1 jruoho
161 1.1 jruoho } ACPI_TABLE_RSDP;
162 1.1 jruoho
163 1.1.1.2 jruoho /* Standalone struct for the ACPI 1.0 RSDP */
164 1.1.1.2 jruoho
165 1.1.1.2 jruoho typedef struct acpi_rsdp_common
166 1.1.1.2 jruoho {
167 1.1.1.2 jruoho char Signature[8];
168 1.1.1.2 jruoho UINT8 Checksum;
169 1.1.1.2 jruoho char OemId[ACPI_OEM_ID_SIZE];
170 1.1.1.2 jruoho UINT8 Revision;
171 1.1.1.2 jruoho UINT32 RsdtPhysicalAddress;
172 1.1.1.2 jruoho
173 1.1.1.2 jruoho } ACPI_RSDP_COMMON;
174 1.1.1.2 jruoho
175 1.1.1.2 jruoho /* Standalone struct for the extended part of the RSDP (ACPI 2.0+) */
176 1.1.1.2 jruoho
177 1.1.1.2 jruoho typedef struct acpi_rsdp_extension
178 1.1.1.2 jruoho {
179 1.1.1.2 jruoho UINT32 Length;
180 1.1.1.2 jruoho UINT64 XsdtPhysicalAddress;
181 1.1.1.2 jruoho UINT8 ExtendedChecksum;
182 1.1.1.2 jruoho UINT8 Reserved[3];
183 1.1.1.2 jruoho
184 1.1.1.2 jruoho } ACPI_RSDP_EXTENSION;
185 1.1 jruoho
186 1.1 jruoho
187 1.1 jruoho /*******************************************************************************
188 1.1 jruoho *
189 1.1 jruoho * RSDT/XSDT - Root System Description Tables
190 1.1 jruoho * Version 1 (both)
191 1.1 jruoho *
192 1.1 jruoho ******************************************************************************/
193 1.1 jruoho
194 1.1 jruoho typedef struct acpi_table_rsdt
195 1.1 jruoho {
196 1.1 jruoho ACPI_TABLE_HEADER Header; /* Common ACPI table header */
197 1.1 jruoho UINT32 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */
198 1.1 jruoho
199 1.1 jruoho } ACPI_TABLE_RSDT;
200 1.1 jruoho
201 1.1 jruoho typedef struct acpi_table_xsdt
202 1.1 jruoho {
203 1.1 jruoho ACPI_TABLE_HEADER Header; /* Common ACPI table header */
204 1.1 jruoho UINT64 TableOffsetEntry[1]; /* Array of pointers to ACPI tables */
205 1.1 jruoho
206 1.1 jruoho } ACPI_TABLE_XSDT;
207 1.1 jruoho
208 1.1.1.3 christos #define ACPI_RSDT_ENTRY_SIZE (sizeof (UINT32))
209 1.1.1.3 christos #define ACPI_XSDT_ENTRY_SIZE (sizeof (UINT64))
210 1.1.1.3 christos
211 1.1 jruoho
212 1.1 jruoho /*******************************************************************************
213 1.1 jruoho *
214 1.1 jruoho * FACS - Firmware ACPI Control Structure (FACS)
215 1.1 jruoho *
216 1.1 jruoho ******************************************************************************/
217 1.1 jruoho
218 1.1 jruoho typedef struct acpi_table_facs
219 1.1 jruoho {
220 1.1 jruoho char Signature[4]; /* ASCII table signature */
221 1.1 jruoho UINT32 Length; /* Length of structure, in bytes */
222 1.1 jruoho UINT32 HardwareSignature; /* Hardware configuration signature */
223 1.1 jruoho UINT32 FirmwareWakingVector; /* 32-bit physical address of the Firmware Waking Vector */
224 1.1 jruoho UINT32 GlobalLock; /* Global Lock for shared hardware resources */
225 1.1 jruoho UINT32 Flags;
226 1.1 jruoho UINT64 XFirmwareWakingVector; /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */
227 1.1 jruoho UINT8 Version; /* Version of this table (ACPI 2.0+) */
228 1.1 jruoho UINT8 Reserved[3]; /* Reserved, must be zero */
229 1.1 jruoho UINT32 OspmFlags; /* Flags to be set by OSPM (ACPI 4.0) */
230 1.1 jruoho UINT8 Reserved1[24]; /* Reserved, must be zero */
231 1.1 jruoho
232 1.1 jruoho } ACPI_TABLE_FACS;
233 1.1 jruoho
234 1.1 jruoho /* Masks for GlobalLock flag field above */
235 1.1 jruoho
236 1.1 jruoho #define ACPI_GLOCK_PENDING (1) /* 00: Pending global lock ownership */
237 1.1 jruoho #define ACPI_GLOCK_OWNED (1<<1) /* 01: Global lock is owned */
238 1.1 jruoho
239 1.1 jruoho /* Masks for Flags field above */
240 1.1 jruoho
241 1.1 jruoho #define ACPI_FACS_S4_BIOS_PRESENT (1) /* 00: S4BIOS support is present */
242 1.1 jruoho #define ACPI_FACS_64BIT_WAKE (1<<1) /* 01: 64-bit wake vector supported (ACPI 4.0) */
243 1.1 jruoho
244 1.1 jruoho /* Masks for OspmFlags field above */
245 1.1 jruoho
246 1.1 jruoho #define ACPI_FACS_64BIT_ENVIRONMENT (1) /* 00: 64-bit wake environment is required (ACPI 4.0) */
247 1.1 jruoho
248 1.1 jruoho
249 1.1 jruoho /*******************************************************************************
250 1.1 jruoho *
251 1.1 jruoho * FADT - Fixed ACPI Description Table (Signature "FACP")
252 1.1.1.8 christos * Version 6
253 1.1 jruoho *
254 1.1 jruoho ******************************************************************************/
255 1.1 jruoho
256 1.1 jruoho /* Fields common to all versions of the FADT */
257 1.1 jruoho
258 1.1 jruoho typedef struct acpi_table_fadt
259 1.1 jruoho {
260 1.1.1.10 christos ACPI_TABLE_HEADER Header; /* Common ACPI table header */
261 1.1.1.10 christos UINT32 Facs; /* 32-bit physical address of FACS */
262 1.1.1.10 christos UINT32 Dsdt; /* 32-bit physical address of DSDT */
263 1.1.1.10 christos UINT8 Model; /* System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */
264 1.1.1.10 christos UINT8 PreferredProfile; /* Conveys preferred power management profile to OSPM. */
265 1.1.1.10 christos UINT16 SciInterrupt; /* System vector of SCI interrupt */
266 1.1.1.10 christos UINT32 SmiCommand; /* 32-bit Port address of SMI command port */
267 1.1.1.10 christos UINT8 AcpiEnable; /* Value to write to SMI_CMD to enable ACPI */
268 1.1.1.10 christos UINT8 AcpiDisable; /* Value to write to SMI_CMD to disable ACPI */
269 1.1.1.10 christos UINT8 S4BiosRequest; /* Value to write to SMI_CMD to enter S4BIOS state */
270 1.1.1.10 christos UINT8 PstateControl; /* Processor performance state control*/
271 1.1.1.10 christos UINT32 Pm1aEventBlock; /* 32-bit port address of Power Mgt 1a Event Reg Blk */
272 1.1.1.10 christos UINT32 Pm1bEventBlock; /* 32-bit port address of Power Mgt 1b Event Reg Blk */
273 1.1.1.10 christos UINT32 Pm1aControlBlock; /* 32-bit port address of Power Mgt 1a Control Reg Blk */
274 1.1.1.10 christos UINT32 Pm1bControlBlock; /* 32-bit port address of Power Mgt 1b Control Reg Blk */
275 1.1.1.10 christos UINT32 Pm2ControlBlock; /* 32-bit port address of Power Mgt 2 Control Reg Blk */
276 1.1.1.10 christos UINT32 PmTimerBlock; /* 32-bit port address of Power Mgt Timer Ctrl Reg Blk */
277 1.1.1.10 christos UINT32 Gpe0Block; /* 32-bit port address of General Purpose Event 0 Reg Blk */
278 1.1.1.10 christos UINT32 Gpe1Block; /* 32-bit port address of General Purpose Event 1 Reg Blk */
279 1.1.1.10 christos UINT8 Pm1EventLength; /* Byte Length of ports at Pm1xEventBlock */
280 1.1.1.10 christos UINT8 Pm1ControlLength; /* Byte Length of ports at Pm1xControlBlock */
281 1.1.1.10 christos UINT8 Pm2ControlLength; /* Byte Length of ports at Pm2ControlBlock */
282 1.1.1.10 christos UINT8 PmTimerLength; /* Byte Length of ports at PmTimerBlock */
283 1.1.1.10 christos UINT8 Gpe0BlockLength; /* Byte Length of ports at Gpe0Block */
284 1.1.1.10 christos UINT8 Gpe1BlockLength; /* Byte Length of ports at Gpe1Block */
285 1.1.1.10 christos UINT8 Gpe1Base; /* Offset in GPE number space where GPE1 events start */
286 1.1.1.10 christos UINT8 CstControl; /* Support for the _CST object and C-States change notification */
287 1.1.1.10 christos UINT16 C2Latency; /* Worst case HW latency to enter/exit C2 state */
288 1.1.1.10 christos UINT16 C3Latency; /* Worst case HW latency to enter/exit C3 state */
289 1.1.1.10 christos UINT16 FlushSize; /* Processor memory cache line width, in bytes */
290 1.1.1.10 christos UINT16 FlushStride; /* Number of flush strides that need to be read */
291 1.1.1.10 christos UINT8 DutyOffset; /* Processor duty cycle index in processor P_CNT reg */
292 1.1.1.10 christos UINT8 DutyWidth; /* Processor duty cycle value bit width in P_CNT register */
293 1.1.1.10 christos UINT8 DayAlarm; /* Index to day-of-month alarm in RTC CMOS RAM */
294 1.1.1.10 christos UINT8 MonthAlarm; /* Index to month-of-year alarm in RTC CMOS RAM */
295 1.1.1.10 christos UINT8 Century; /* Index to century in RTC CMOS RAM */
296 1.1.1.10 christos UINT16 BootFlags; /* IA-PC Boot Architecture Flags (see below for individual flags) */
297 1.1.1.10 christos UINT8 Reserved; /* Reserved, must be zero */
298 1.1.1.10 christos UINT32 Flags; /* Miscellaneous flag bits (see below for individual flags) */
299 1.1.1.10 christos ACPI_GENERIC_ADDRESS ResetRegister; /* 64-bit address of the Reset register */
300 1.1.1.10 christos UINT8 ResetValue; /* Value to write to the ResetRegister port to reset the system */
301 1.1.1.10 christos UINT16 ArmBootFlags; /* ARM-Specific Boot Flags (see below for individual flags) (ACPI 5.1) */
302 1.1.1.10 christos UINT8 MinorRevision; /* FADT Minor Revision (ACPI 5.1) */
303 1.1.1.10 christos UINT64 XFacs; /* 64-bit physical address of FACS */
304 1.1.1.10 christos UINT64 XDsdt; /* 64-bit physical address of DSDT */
305 1.1.1.10 christos ACPI_GENERIC_ADDRESS XPm1aEventBlock; /* 64-bit Extended Power Mgt 1a Event Reg Blk address */
306 1.1.1.10 christos ACPI_GENERIC_ADDRESS XPm1bEventBlock; /* 64-bit Extended Power Mgt 1b Event Reg Blk address */
307 1.1.1.10 christos ACPI_GENERIC_ADDRESS XPm1aControlBlock; /* 64-bit Extended Power Mgt 1a Control Reg Blk address */
308 1.1.1.10 christos ACPI_GENERIC_ADDRESS XPm1bControlBlock; /* 64-bit Extended Power Mgt 1b Control Reg Blk address */
309 1.1.1.10 christos ACPI_GENERIC_ADDRESS XPm2ControlBlock; /* 64-bit Extended Power Mgt 2 Control Reg Blk address */
310 1.1.1.10 christos ACPI_GENERIC_ADDRESS XPmTimerBlock; /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */
311 1.1.1.10 christos ACPI_GENERIC_ADDRESS XGpe0Block; /* 64-bit Extended General Purpose Event 0 Reg Blk address */
312 1.1.1.10 christos ACPI_GENERIC_ADDRESS XGpe1Block; /* 64-bit Extended General Purpose Event 1 Reg Blk address */
313 1.1.1.10 christos ACPI_GENERIC_ADDRESS SleepControl; /* 64-bit Sleep Control register (ACPI 5.0) */
314 1.1.1.10 christos ACPI_GENERIC_ADDRESS SleepStatus; /* 64-bit Sleep Status register (ACPI 5.0) */
315 1.1.1.10 christos UINT64 HypervisorId; /* Hypervisor Vendor ID (ACPI 6.0) */
316 1.1 jruoho
317 1.1 jruoho } ACPI_TABLE_FADT;
318 1.1 jruoho
319 1.1 jruoho
320 1.1.1.4 christos /* Masks for FADT IA-PC Boot Architecture Flags (boot_flags) [Vx]=Introduced in this FADT revision */
321 1.1 jruoho
322 1.1 jruoho #define ACPI_FADT_LEGACY_DEVICES (1) /* 00: [V2] System has LPC or ISA bus devices */
323 1.1 jruoho #define ACPI_FADT_8042 (1<<1) /* 01: [V3] System has an 8042 controller on port 60/64 */
324 1.1 jruoho #define ACPI_FADT_NO_VGA (1<<2) /* 02: [V4] It is not safe to probe for VGA hardware */
325 1.1 jruoho #define ACPI_FADT_NO_MSI (1<<3) /* 03: [V4] Message Signaled Interrupts (MSI) must not be enabled */
326 1.1 jruoho #define ACPI_FADT_NO_ASPM (1<<4) /* 04: [V4] PCIe ASPM control must not be enabled */
327 1.1.1.3 christos #define ACPI_FADT_NO_CMOS_RTC (1<<5) /* 05: [V5] No CMOS real-time clock present */
328 1.1 jruoho
329 1.1.1.4 christos /* Masks for FADT ARM Boot Architecture Flags (arm_boot_flags) ACPI 5.1 */
330 1.1.1.4 christos
331 1.1.1.10 christos #define ACPI_FADT_PSCI_COMPLIANT (1) /* 00: [V5+] PSCI 0.2+ is implemented */
332 1.1.1.10 christos #define ACPI_FADT_PSCI_USE_HVC (1<<1) /* 01: [V5+] HVC must be used instead of SMC as the PSCI conduit */
333 1.1.1.4 christos
334 1.1 jruoho /* Masks for FADT flags */
335 1.1 jruoho
336 1.1.1.3 christos #define ACPI_FADT_WBINVD (1) /* 00: [V1] The WBINVD instruction works properly */
337 1.1.1.3 christos #define ACPI_FADT_WBINVD_FLUSH (1<<1) /* 01: [V1] WBINVD flushes but does not invalidate caches */
338 1.1 jruoho #define ACPI_FADT_C1_SUPPORTED (1<<2) /* 02: [V1] All processors support C1 state */
339 1.1 jruoho #define ACPI_FADT_C2_MP_SUPPORTED (1<<3) /* 03: [V1] C2 state works on MP system */
340 1.1 jruoho #define ACPI_FADT_POWER_BUTTON (1<<4) /* 04: [V1] Power button is handled as a control method device */
341 1.1 jruoho #define ACPI_FADT_SLEEP_BUTTON (1<<5) /* 05: [V1] Sleep button is handled as a control method device */
342 1.1.1.3 christos #define ACPI_FADT_FIXED_RTC (1<<6) /* 06: [V1] RTC wakeup status is not in fixed register space */
343 1.1 jruoho #define ACPI_FADT_S4_RTC_WAKE (1<<7) /* 07: [V1] RTC alarm can wake system from S4 */
344 1.1 jruoho #define ACPI_FADT_32BIT_TIMER (1<<8) /* 08: [V1] ACPI timer width is 32-bit (0=24-bit) */
345 1.1 jruoho #define ACPI_FADT_DOCKING_SUPPORTED (1<<9) /* 09: [V1] Docking supported */
346 1.1 jruoho #define ACPI_FADT_RESET_REGISTER (1<<10) /* 10: [V2] System reset via the FADT RESET_REG supported */
347 1.1 jruoho #define ACPI_FADT_SEALED_CASE (1<<11) /* 11: [V3] No internal expansion capabilities and case is sealed */
348 1.1 jruoho #define ACPI_FADT_HEADLESS (1<<12) /* 12: [V3] No local video capabilities or local input devices */
349 1.1 jruoho #define ACPI_FADT_SLEEP_TYPE (1<<13) /* 13: [V3] Must execute native instruction after writing SLP_TYPx register */
350 1.1 jruoho #define ACPI_FADT_PCI_EXPRESS_WAKE (1<<14) /* 14: [V4] System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */
351 1.1 jruoho #define ACPI_FADT_PLATFORM_CLOCK (1<<15) /* 15: [V4] OSPM should use platform-provided timer (ACPI 3.0) */
352 1.1 jruoho #define ACPI_FADT_S4_RTC_VALID (1<<16) /* 16: [V4] Contents of RTC_STS valid after S4 wake (ACPI 3.0) */
353 1.1 jruoho #define ACPI_FADT_REMOTE_POWER_ON (1<<17) /* 17: [V4] System is compatible with remote power on (ACPI 3.0) */
354 1.1 jruoho #define ACPI_FADT_APIC_CLUSTER (1<<18) /* 18: [V4] All local APICs must use cluster model (ACPI 3.0) */
355 1.1 jruoho #define ACPI_FADT_APIC_PHYSICAL (1<<19) /* 19: [V4] All local xAPICs must use physical dest mode (ACPI 3.0) */
356 1.1.1.3 christos #define ACPI_FADT_HW_REDUCED (1<<20) /* 20: [V5] ACPI hardware is not implemented (ACPI 5.0) */
357 1.1.1.3 christos #define ACPI_FADT_LOW_POWER_S0 (1<<21) /* 21: [V5] S0 power savings are equal or better than S3 (ACPI 5.0) */
358 1.1 jruoho
359 1.1 jruoho
360 1.1.1.3 christos /* Values for PreferredProfile (Preferred Power Management Profiles) */
361 1.1 jruoho
362 1.1.1.3 christos enum AcpiPreferredPmProfiles
363 1.1 jruoho {
364 1.1 jruoho PM_UNSPECIFIED = 0,
365 1.1 jruoho PM_DESKTOP = 1,
366 1.1 jruoho PM_MOBILE = 2,
367 1.1 jruoho PM_WORKSTATION = 3,
368 1.1 jruoho PM_ENTERPRISE_SERVER = 4,
369 1.1 jruoho PM_SOHO_SERVER = 5,
370 1.1.1.3 christos PM_APPLIANCE_PC = 6,
371 1.1.1.3 christos PM_PERFORMANCE_SERVER = 7,
372 1.1.1.3 christos PM_TABLET = 8
373 1.1 jruoho };
374 1.1 jruoho
375 1.1.1.6 christos /* Values for SleepStatus and SleepControl registers (V5+ FADT) */
376 1.1.1.3 christos
377 1.1.1.3 christos #define ACPI_X_WAKE_STATUS 0x80
378 1.1.1.3 christos #define ACPI_X_SLEEP_TYPE_MASK 0x1C
379 1.1.1.3 christos #define ACPI_X_SLEEP_TYPE_POSITION 0x02
380 1.1.1.3 christos #define ACPI_X_SLEEP_ENABLE 0x20
381 1.1.1.3 christos
382 1.1 jruoho
383 1.1 jruoho /* Reset to default packing */
384 1.1 jruoho
385 1.1 jruoho #pragma pack()
386 1.1 jruoho
387 1.1 jruoho
388 1.1 jruoho /*
389 1.1 jruoho * Internal table-related structures
390 1.1 jruoho */
391 1.1 jruoho typedef union acpi_name_union
392 1.1 jruoho {
393 1.1 jruoho UINT32 Integer;
394 1.1 jruoho char Ascii[4];
395 1.1 jruoho
396 1.1 jruoho } ACPI_NAME_UNION;
397 1.1 jruoho
398 1.1 jruoho
399 1.1 jruoho /* Internal ACPI Table Descriptor. One per ACPI table. */
400 1.1 jruoho
401 1.1 jruoho typedef struct acpi_table_desc
402 1.1 jruoho {
403 1.1 jruoho ACPI_PHYSICAL_ADDRESS Address;
404 1.1 jruoho ACPI_TABLE_HEADER *Pointer;
405 1.1.1.3 christos UINT32 Length; /* Length fixed at 32 bits (fixed in table header) */
406 1.1 jruoho ACPI_NAME_UNION Signature;
407 1.1 jruoho ACPI_OWNER_ID OwnerId;
408 1.1 jruoho UINT8 Flags;
409 1.1.1.10 christos UINT16 ValidationCount;
410 1.1 jruoho
411 1.1 jruoho } ACPI_TABLE_DESC;
412 1.1 jruoho
413 1.1.1.11 christos /*
414 1.1.1.11 christos * Maximum value of the ValidationCount field in ACPI_TABLE_DESC.
415 1.1.1.11 christos * When reached, ValidationCount cannot be changed any more and the table will
416 1.1.1.11 christos * be permanently regarded as validated.
417 1.1.1.11 christos *
418 1.1.1.11 christos * This is to prevent situations in which unbalanced table get/put operations
419 1.1.1.11 christos * may cause premature table unmapping in the OS to happen.
420 1.1.1.11 christos *
421 1.1.1.11 christos * The maximum validation count can be defined to any value, but should be
422 1.1.1.11 christos * greater than the maximum number of OS early stage mapping slots to avoid
423 1.1.1.11 christos * leaking early stage table mappings to the late stage.
424 1.1.1.11 christos */
425 1.1.1.11 christos #define ACPI_MAX_TABLE_VALIDATIONS ACPI_UINT16_MAX
426 1.1.1.11 christos
427 1.1 jruoho /* Masks for Flags field above */
428 1.1 jruoho
429 1.1.1.4 christos #define ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL (0) /* Virtual address, external maintained */
430 1.1.1.4 christos #define ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL (1) /* Physical address, internally mapped */
431 1.1.1.4 christos #define ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL (2) /* Virtual address, internallly allocated */
432 1.1.1.4 christos #define ACPI_TABLE_ORIGIN_MASK (3)
433 1.1.1.11 christos #define ACPI_TABLE_IS_VERIFIED (4)
434 1.1.1.4 christos #define ACPI_TABLE_IS_LOADED (8)
435 1.1 jruoho
436 1.1 jruoho
437 1.1 jruoho /*
438 1.1 jruoho * Get the remaining ACPI tables
439 1.1 jruoho */
440 1.1 jruoho #include "actbl1.h"
441 1.1 jruoho #include "actbl2.h"
442 1.1.1.3 christos #include "actbl3.h"
443 1.1 jruoho
444 1.1 jruoho /* Macros used to generate offsets to specific table fields */
445 1.1 jruoho
446 1.1.1.3 christos #define ACPI_FADT_OFFSET(f) (UINT16) ACPI_OFFSET (ACPI_TABLE_FADT, f)
447 1.1 jruoho
448 1.1.1.2 jruoho /*
449 1.1.1.2 jruoho * Sizes of the various flavors of FADT. We need to look closely
450 1.1.1.2 jruoho * at the FADT length because the version number essentially tells
451 1.1.1.2 jruoho * us nothing because of many BIOS bugs where the version does not
452 1.1.1.2 jruoho * match the expected length. In other words, the length of the
453 1.1.1.2 jruoho * FADT is the bottom line as to what the version really is.
454 1.1.1.2 jruoho *
455 1.1.1.10 christos * For reference, the values below are as follows:
456 1.1.1.10 christos * FADT V1 size: 0x074
457 1.1.1.10 christos * FADT V2 size: 0x084
458 1.1.1.10 christos * FADT V3 size: 0x0F4
459 1.1.1.10 christos * FADT V4 size: 0x0F4
460 1.1.1.10 christos * FADT V5 size: 0x10C
461 1.1.1.10 christos * FADT V6 size: 0x114
462 1.1.1.2 jruoho */
463 1.1.1.10 christos #define ACPI_FADT_V1_SIZE (UINT32) (ACPI_FADT_OFFSET (Flags) + 4)
464 1.1.1.10 christos #define ACPI_FADT_V2_SIZE (UINT32) (ACPI_FADT_OFFSET (MinorRevision) + 1)
465 1.1.1.10 christos #define ACPI_FADT_V3_SIZE (UINT32) (ACPI_FADT_OFFSET (SleepControl))
466 1.1.1.10 christos #define ACPI_FADT_V5_SIZE (UINT32) (ACPI_FADT_OFFSET (HypervisorId))
467 1.1.1.10 christos #define ACPI_FADT_V6_SIZE (UINT32) (sizeof (ACPI_TABLE_FADT))
468 1.1.1.2 jruoho
469 1.1.1.8 christos #define ACPI_FADT_CONFORMANCE "ACPI 6.1 (FADT version 6)"
470 1.1.1.8 christos
471 1.1 jruoho #endif /* __ACTBL_H__ */
472