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