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