xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/include/actbl.h (revision d63ed5844d997a61afd7a6c4b7c9fad0dc01e9f3)
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 - 2016, 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 #ifndef __ACTBL_H__
117 #define __ACTBL_H__
118 
119 
120 /*******************************************************************************
121  *
122  * Fundamental ACPI tables
123  *
124  * This file contains definitions for the ACPI tables that are directly consumed
125  * by ACPICA. All other tables are consumed by the OS-dependent ACPI-related
126  * device drivers and other OS support code.
127  *
128  * The RSDP and FACS do not use the common ACPI table header. All other ACPI
129  * tables use the header.
130  *
131  ******************************************************************************/
132 
133 
134 /*
135  * Values for description table header signatures for tables defined in this
136  * file. Useful because they make it more difficult to inadvertently type in
137  * the wrong signature.
138  */
139 #define ACPI_SIG_DSDT           "DSDT"      /* Differentiated System Description Table */
140 #define ACPI_SIG_FADT           "FACP"      /* Fixed ACPI Description Table */
141 #define ACPI_SIG_FACS           "FACS"      /* Firmware ACPI Control Structure */
142 #define ACPI_SIG_OSDT           "OSDT"      /* Override System Description Table */
143 #define ACPI_SIG_PSDT           "PSDT"      /* Persistent System Description Table */
144 #define ACPI_SIG_RSDP           "RSD PTR "  /* Root System Description Pointer */
145 #define ACPI_SIG_RSDT           "RSDT"      /* Root System Description Table */
146 #define ACPI_SIG_XSDT           "XSDT"      /* Extended  System Description Table */
147 #define ACPI_SIG_SSDT           "SSDT"      /* Secondary System Description Table */
148 #define ACPI_RSDP_NAME          "RSDP"      /* Short name for RSDP, not signature */
149 
150 
151 /*
152  * All tables and structures must be byte-packed to match the ACPI
153  * specification, since the tables are provided by the system BIOS
154  */
155 #pragma pack(1)
156 
157 /*
158  * Note: C bitfields are not used for this reason:
159  *
160  * "Bitfields are great and easy to read, but unfortunately the C language
161  * does not specify the layout of bitfields in memory, which means they are
162  * essentially useless for dealing with packed data in on-disk formats or
163  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
164  * this decision was a design error in C. Ritchie could have picked an order
165  * and stuck with it." Norman Ramsey.
166  * See http://stackoverflow.com/a/1053662/41661
167  */
168 
169 
170 /*******************************************************************************
171  *
172  * Master ACPI Table Header. This common header is used by all ACPI tables
173  * except the RSDP and FACS.
174  *
175  ******************************************************************************/
176 
177 typedef struct acpi_table_header
178 {
179     char                    Signature[ACPI_NAME_SIZE];          /* ASCII table signature */
180     UINT32                  Length;                             /* Length of table in bytes, including this header */
181     UINT8                   Revision;                           /* ACPI Specification minor version number */
182     UINT8                   Checksum;                           /* To make sum of entire table == 0 */
183     char                    OemId[ACPI_OEM_ID_SIZE];            /* ASCII OEM identification */
184     char                    OemTableId[ACPI_OEM_TABLE_ID_SIZE]; /* ASCII OEM table identification */
185     UINT32                  OemRevision;                        /* OEM revision number */
186     char                    AslCompilerId[ACPI_NAME_SIZE];      /* ASCII ASL compiler vendor ID */
187     UINT32                  AslCompilerRevision;                /* ASL compiler version */
188 
189 } ACPI_TABLE_HEADER;
190 
191 
192 /*******************************************************************************
193  *
194  * GAS - Generic Address Structure (ACPI 2.0+)
195  *
196  * Note: Since this structure is used in the ACPI tables, it is byte aligned.
197  * If misaligned access is not supported by the hardware, accesses to the
198  * 64-bit Address field must be performed with care.
199  *
200  ******************************************************************************/
201 
202 typedef struct acpi_generic_address
203 {
204     UINT8                   SpaceId;                /* Address space where struct or register exists */
205     UINT8                   BitWidth;               /* Size in bits of given register */
206     UINT8                   BitOffset;              /* Bit offset within the register */
207     UINT8                   AccessWidth;            /* Minimum Access size (ACPI 3.0) */
208     UINT64                  Address;                /* 64-bit address of struct or register */
209 
210 } ACPI_GENERIC_ADDRESS;
211 
212 
213 /*******************************************************************************
214  *
215  * RSDP - Root System Description Pointer (Signature is "RSD PTR ")
216  *        Version 2
217  *
218  ******************************************************************************/
219 
220 typedef struct acpi_table_rsdp
221 {
222     char                    Signature[8];               /* ACPI signature, contains "RSD PTR " */
223     UINT8                   Checksum;                   /* ACPI 1.0 checksum */
224     char                    OemId[ACPI_OEM_ID_SIZE];    /* OEM identification */
225     UINT8                   Revision;                   /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */
226     UINT32                  RsdtPhysicalAddress;        /* 32-bit physical address of the RSDT */
227     UINT32                  Length;                     /* Table length in bytes, including header (ACPI 2.0+) */
228     UINT64                  XsdtPhysicalAddress;        /* 64-bit physical address of the XSDT (ACPI 2.0+) */
229     UINT8                   ExtendedChecksum;           /* Checksum of entire table (ACPI 2.0+) */
230     UINT8                   Reserved[3];                /* Reserved, must be zero */
231 
232 } ACPI_TABLE_RSDP;
233 
234 /* Standalone struct for the ACPI 1.0 RSDP */
235 
236 typedef struct acpi_rsdp_common
237 {
238     char                    Signature[8];
239     UINT8                   Checksum;
240     char                    OemId[ACPI_OEM_ID_SIZE];
241     UINT8                   Revision;
242     UINT32                  RsdtPhysicalAddress;
243 
244 } ACPI_RSDP_COMMON;
245 
246 /* Standalone struct for the extended part of the RSDP (ACPI 2.0+) */
247 
248 typedef struct acpi_rsdp_extension
249 {
250     UINT32                  Length;
251     UINT64                  XsdtPhysicalAddress;
252     UINT8                   ExtendedChecksum;
253     UINT8                   Reserved[3];
254 
255 } ACPI_RSDP_EXTENSION;
256 
257 
258 /*******************************************************************************
259  *
260  * RSDT/XSDT - Root System Description Tables
261  *             Version 1 (both)
262  *
263  ******************************************************************************/
264 
265 typedef struct acpi_table_rsdt
266 {
267     ACPI_TABLE_HEADER       Header;                 /* Common ACPI table header */
268     UINT32                  TableOffsetEntry[1];    /* Array of pointers to ACPI tables */
269 
270 } ACPI_TABLE_RSDT;
271 
272 typedef struct acpi_table_xsdt
273 {
274     ACPI_TABLE_HEADER       Header;                 /* Common ACPI table header */
275     UINT64                  TableOffsetEntry[1];    /* Array of pointers to ACPI tables */
276 
277 } ACPI_TABLE_XSDT;
278 
279 #define ACPI_RSDT_ENTRY_SIZE        (sizeof (UINT32))
280 #define ACPI_XSDT_ENTRY_SIZE        (sizeof (UINT64))
281 
282 
283 /*******************************************************************************
284  *
285  * FACS - Firmware ACPI Control Structure (FACS)
286  *
287  ******************************************************************************/
288 
289 typedef struct acpi_table_facs
290 {
291     char                    Signature[4];           /* ASCII table signature */
292     UINT32                  Length;                 /* Length of structure, in bytes */
293     UINT32                  HardwareSignature;      /* Hardware configuration signature */
294     UINT32                  FirmwareWakingVector;   /* 32-bit physical address of the Firmware Waking Vector */
295     UINT32                  GlobalLock;             /* Global Lock for shared hardware resources */
296     UINT32                  Flags;
297     UINT64                  XFirmwareWakingVector;  /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */
298     UINT8                   Version;                /* Version of this table (ACPI 2.0+) */
299     UINT8                   Reserved[3];            /* Reserved, must be zero */
300     UINT32                  OspmFlags;              /* Flags to be set by OSPM (ACPI 4.0) */
301     UINT8                   Reserved1[24];          /* Reserved, must be zero */
302 
303 } ACPI_TABLE_FACS;
304 
305 /* Masks for GlobalLock flag field above */
306 
307 #define ACPI_GLOCK_PENDING          (1)             /* 00: Pending global lock ownership */
308 #define ACPI_GLOCK_OWNED            (1<<1)          /* 01: Global lock is owned */
309 
310 /* Masks for Flags field above  */
311 
312 #define ACPI_FACS_S4_BIOS_PRESENT   (1)             /* 00: S4BIOS support is present */
313 #define ACPI_FACS_64BIT_WAKE        (1<<1)          /* 01: 64-bit wake vector supported (ACPI 4.0) */
314 
315 /* Masks for OspmFlags field above */
316 
317 #define ACPI_FACS_64BIT_ENVIRONMENT (1)             /* 00: 64-bit wake environment is required (ACPI 4.0) */
318 
319 
320 /*******************************************************************************
321  *
322  * FADT - Fixed ACPI Description Table (Signature "FACP")
323  *        Version 6
324  *
325  ******************************************************************************/
326 
327 /* Fields common to all versions of the FADT */
328 
329 typedef struct acpi_table_fadt
330 {
331     ACPI_TABLE_HEADER       Header;             /* [V1] Common ACPI table header */
332     UINT32                  Facs;               /* [V1] 32-bit physical address of FACS */
333     UINT32                  Dsdt;               /* [V1] 32-bit physical address of DSDT */
334     UINT8                   Model;              /* [V1] System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */
335     UINT8                   PreferredProfile;   /* [V1] Conveys preferred power management profile to OSPM. */
336     UINT16                  SciInterrupt;       /* [V1] System vector of SCI interrupt */
337     UINT32                  SmiCommand;         /* [V1] 32-bit Port address of SMI command port */
338     UINT8                   AcpiEnable;         /* [V1] Value to write to SMI_CMD to enable ACPI */
339     UINT8                   AcpiDisable;        /* [V1] Value to write to SMI_CMD to disable ACPI */
340     UINT8                   S4BiosRequest;      /* [V1] Value to write to SMI_CMD to enter S4BIOS state */
341     UINT8                   PstateControl;      /* [V1] Processor performance state control*/
342     UINT32                  Pm1aEventBlock;     /* [V1] 32-bit port address of Power Mgt 1a Event Reg Blk */
343     UINT32                  Pm1bEventBlock;     /* [V1] 32-bit port address of Power Mgt 1b Event Reg Blk */
344     UINT32                  Pm1aControlBlock;   /* [V1] 32-bit port address of Power Mgt 1a Control Reg Blk */
345     UINT32                  Pm1bControlBlock;   /* [V1] 32-bit port address of Power Mgt 1b Control Reg Blk */
346     UINT32                  Pm2ControlBlock;    /* [V1] 32-bit port address of Power Mgt 2 Control Reg Blk */
347     UINT32                  PmTimerBlock;       /* [V1] 32-bit port address of Power Mgt Timer Ctrl Reg Blk */
348     UINT32                  Gpe0Block;          /* [V1] 32-bit port address of General Purpose Event 0 Reg Blk */
349     UINT32                  Gpe1Block;          /* [V1] 32-bit port address of General Purpose Event 1 Reg Blk */
350     UINT8                   Pm1EventLength;     /* [V1] Byte Length of ports at Pm1xEventBlock */
351     UINT8                   Pm1ControlLength;   /* [V1] Byte Length of ports at Pm1xControlBlock */
352     UINT8                   Pm2ControlLength;   /* [V1] Byte Length of ports at Pm2ControlBlock */
353     UINT8                   PmTimerLength;      /* [V1] Byte Length of ports at PmTimerBlock */
354     UINT8                   Gpe0BlockLength;    /* [V1] Byte Length of ports at Gpe0Block */
355     UINT8                   Gpe1BlockLength;    /* [V1] Byte Length of ports at Gpe1Block */
356     UINT8                   Gpe1Base;           /* [V1] Offset in GPE number space where GPE1 events start */
357     UINT8                   CstControl;         /* [V1] Support for the _CST object and C-States change notification */
358     UINT16                  C2Latency;          /* [V1] Worst case HW latency to enter/exit C2 state */
359     UINT16                  C3Latency;          /* [V1] Worst case HW latency to enter/exit C3 state */
360     UINT16                  FlushSize;          /* [V1] Processor memory cache line width, in bytes */
361     UINT16                  FlushStride;        /* [V1] Number of flush strides that need to be read */
362     UINT8                   DutyOffset;         /* [V1] Processor duty cycle index in processor P_CNT reg */
363     UINT8                   DutyWidth;          /* [V1] Processor duty cycle value bit width in P_CNT register */
364     UINT8                   DayAlarm;           /* [V1] Index to day-of-month alarm in RTC CMOS RAM */
365     UINT8                   MonthAlarm;         /* [V1] Index to month-of-year alarm in RTC CMOS RAM */
366     UINT8                   Century;            /* [V1] Index to century in RTC CMOS RAM */
367     UINT16                  BootFlags;          /* [V3] IA-PC Boot Architecture Flags (see below for individual flags) */
368     UINT8                   Reserved;           /* [V1] Reserved, must be zero */
369     UINT32                  Flags;              /* [V1] Miscellaneous flag bits (see below for individual flags) */
370     /* End of Version 1 FADT fields (ACPI 1.0) */
371 
372     ACPI_GENERIC_ADDRESS    ResetRegister;      /* [V3] 64-bit address of the Reset register */
373     UINT8                   ResetValue;         /* [V3] Value to write to the ResetRegister port to reset the system */
374     UINT16                  ArmBootFlags;       /* [V5] ARM-Specific Boot Flags (see below for individual flags) (ACPI 5.1) */
375     UINT8                   MinorRevision;      /* [V5] FADT Minor Revision (ACPI 5.1) */
376     UINT64                  XFacs;              /* [V3] 64-bit physical address of FACS */
377     UINT64                  XDsdt;              /* [V3] 64-bit physical address of DSDT */
378     ACPI_GENERIC_ADDRESS    XPm1aEventBlock;    /* [V3] 64-bit Extended Power Mgt 1a Event Reg Blk address */
379     ACPI_GENERIC_ADDRESS    XPm1bEventBlock;    /* [V3] 64-bit Extended Power Mgt 1b Event Reg Blk address */
380     ACPI_GENERIC_ADDRESS    XPm1aControlBlock;  /* [V3] 64-bit Extended Power Mgt 1a Control Reg Blk address */
381     ACPI_GENERIC_ADDRESS    XPm1bControlBlock;  /* [V3] 64-bit Extended Power Mgt 1b Control Reg Blk address */
382     ACPI_GENERIC_ADDRESS    XPm2ControlBlock;   /* [V3] 64-bit Extended Power Mgt 2 Control Reg Blk address */
383     ACPI_GENERIC_ADDRESS    XPmTimerBlock;      /* [V3] 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */
384     ACPI_GENERIC_ADDRESS    XGpe0Block;         /* [V3] 64-bit Extended General Purpose Event 0 Reg Blk address */
385     ACPI_GENERIC_ADDRESS    XGpe1Block;         /* [V3] 64-bit Extended General Purpose Event 1 Reg Blk address */
386     /* End of Version 3 FADT fields (ACPI 2.0) */
387 
388     ACPI_GENERIC_ADDRESS    SleepControl;       /* [V4] 64-bit Sleep Control register (ACPI 5.0) */
389     /* End of Version 4 FADT fields (ACPI 3.0 and ACPI 4.0) (Field was originally reserved in ACPI 3.0) */
390 
391     ACPI_GENERIC_ADDRESS    SleepStatus;        /* [V5] 64-bit Sleep Status register (ACPI 5.0) */
392     /* End of Version 5 FADT fields (ACPI 5.0) */
393 
394     UINT64                  HypervisorId;       /* [V6] Hypervisor Vendor ID (ACPI 6.0) */
395     /* End of Version 6 FADT fields (ACPI 6.0) */
396 
397 
398 } ACPI_TABLE_FADT;
399 
400 
401 /* Masks for FADT IA-PC Boot Architecture Flags (boot_flags) [Vx]=Introduced in this FADT revision */
402 
403 #define ACPI_FADT_LEGACY_DEVICES    (1)         /* 00: [V2] System has LPC or ISA bus devices */
404 #define ACPI_FADT_8042              (1<<1)      /* 01: [V3] System has an 8042 controller on port 60/64 */
405 #define ACPI_FADT_NO_VGA            (1<<2)      /* 02: [V4] It is not safe to probe for VGA hardware */
406 #define ACPI_FADT_NO_MSI            (1<<3)      /* 03: [V4] Message Signaled Interrupts (MSI) must not be enabled */
407 #define ACPI_FADT_NO_ASPM           (1<<4)      /* 04: [V4] PCIe ASPM control must not be enabled */
408 #define ACPI_FADT_NO_CMOS_RTC       (1<<5)      /* 05: [V5] No CMOS real-time clock present */
409 
410 /* Masks for FADT ARM Boot Architecture Flags (arm_boot_flags) ACPI 5.1 */
411 
412 #define ACPI_FADT_PSCI_COMPLIANT    (1)         /* 00: [V5] PSCI 0.2+ is implemented */
413 #define ACPI_FADT_PSCI_USE_HVC      (1<<1)      /* 01: [V5] HVC must be used instead of SMC as the PSCI conduit */
414 
415 /* Masks for FADT flags */
416 
417 #define ACPI_FADT_WBINVD            (1)         /* 00: [V1] The WBINVD instruction works properly */
418 #define ACPI_FADT_WBINVD_FLUSH      (1<<1)      /* 01: [V1] WBINVD flushes but does not invalidate caches */
419 #define ACPI_FADT_C1_SUPPORTED      (1<<2)      /* 02: [V1] All processors support C1 state */
420 #define ACPI_FADT_C2_MP_SUPPORTED   (1<<3)      /* 03: [V1] C2 state works on MP system */
421 #define ACPI_FADT_POWER_BUTTON      (1<<4)      /* 04: [V1] Power button is handled as a control method device */
422 #define ACPI_FADT_SLEEP_BUTTON      (1<<5)      /* 05: [V1] Sleep button is handled as a control method device */
423 #define ACPI_FADT_FIXED_RTC         (1<<6)      /* 06: [V1] RTC wakeup status is not in fixed register space */
424 #define ACPI_FADT_S4_RTC_WAKE       (1<<7)      /* 07: [V1] RTC alarm can wake system from S4 */
425 #define ACPI_FADT_32BIT_TIMER       (1<<8)      /* 08: [V1] ACPI timer width is 32-bit (0=24-bit) */
426 #define ACPI_FADT_DOCKING_SUPPORTED (1<<9)      /* 09: [V1] Docking supported */
427 #define ACPI_FADT_RESET_REGISTER    (1<<10)     /* 10: [V2] System reset via the FADT RESET_REG supported */
428 #define ACPI_FADT_SEALED_CASE       (1<<11)     /* 11: [V3] No internal expansion capabilities and case is sealed */
429 #define ACPI_FADT_HEADLESS          (1<<12)     /* 12: [V3] No local video capabilities or local input devices */
430 #define ACPI_FADT_SLEEP_TYPE        (1<<13)     /* 13: [V3] Must execute native instruction after writing  SLP_TYPx register */
431 #define ACPI_FADT_PCI_EXPRESS_WAKE  (1<<14)     /* 14: [V4] System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */
432 #define ACPI_FADT_PLATFORM_CLOCK    (1<<15)     /* 15: [V4] OSPM should use platform-provided timer (ACPI 3.0) */
433 #define ACPI_FADT_S4_RTC_VALID      (1<<16)     /* 16: [V4] Contents of RTC_STS valid after S4 wake (ACPI 3.0) */
434 #define ACPI_FADT_REMOTE_POWER_ON   (1<<17)     /* 17: [V4] System is compatible with remote power on (ACPI 3.0) */
435 #define ACPI_FADT_APIC_CLUSTER      (1<<18)     /* 18: [V4] All local APICs must use cluster model (ACPI 3.0) */
436 #define ACPI_FADT_APIC_PHYSICAL     (1<<19)     /* 19: [V4] All local xAPICs must use physical dest mode (ACPI 3.0) */
437 #define ACPI_FADT_HW_REDUCED        (1<<20)     /* 20: [V5] ACPI hardware is not implemented (ACPI 5.0) */
438 #define ACPI_FADT_LOW_POWER_S0      (1<<21)     /* 21: [V5] S0 power savings are equal or better than S3 (ACPI 5.0) */
439 
440 
441 /* Values for PreferredProfile (Preferred Power Management Profiles) */
442 
443 enum AcpiPreferredPmProfiles
444 {
445     PM_UNSPECIFIED          = 0,
446     PM_DESKTOP              = 1,
447     PM_MOBILE               = 2,
448     PM_WORKSTATION          = 3,
449     PM_ENTERPRISE_SERVER    = 4,
450     PM_SOHO_SERVER          = 5,
451     PM_APPLIANCE_PC         = 6,
452     PM_PERFORMANCE_SERVER   = 7,
453     PM_TABLET               = 8
454 };
455 
456 /* Values for SleepStatus and SleepControl registers (V5+ FADT) */
457 
458 #define ACPI_X_WAKE_STATUS          0x80
459 #define ACPI_X_SLEEP_TYPE_MASK      0x1C
460 #define ACPI_X_SLEEP_TYPE_POSITION  0x02
461 #define ACPI_X_SLEEP_ENABLE         0x20
462 
463 
464 /* Reset to default packing */
465 
466 #pragma pack()
467 
468 
469 /*
470  * Internal table-related structures
471  */
472 typedef union acpi_name_union
473 {
474     UINT32                          Integer;
475     char                            Ascii[4];
476 
477 } ACPI_NAME_UNION;
478 
479 
480 /* Internal ACPI Table Descriptor. One per ACPI table. */
481 
482 typedef struct acpi_table_desc
483 {
484     ACPI_PHYSICAL_ADDRESS           Address;
485     ACPI_TABLE_HEADER               *Pointer;
486     UINT32                          Length;     /* Length fixed at 32 bits (fixed in table header) */
487     ACPI_NAME_UNION                 Signature;
488     ACPI_OWNER_ID                   OwnerId;
489     UINT8                           Flags;
490 
491 } ACPI_TABLE_DESC;
492 
493 /* Masks for Flags field above */
494 
495 #define ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL  (0) /* Virtual address, external maintained */
496 #define ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL (1) /* Physical address, internally mapped */
497 #define ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL  (2) /* Virtual address, internallly allocated */
498 #define ACPI_TABLE_ORIGIN_MASK              (3)
499 #define ACPI_TABLE_IS_LOADED                (8)
500 
501 
502 /*
503  * Get the remaining ACPI tables
504  */
505 #include "actbl1.h"
506 #include "actbl2.h"
507 #include "actbl3.h"
508 
509 /* Macros used to generate offsets to specific table fields */
510 
511 #define ACPI_FADT_OFFSET(f)             (UINT16) ACPI_OFFSET (ACPI_TABLE_FADT, f)
512 
513 /*
514  * Sizes of the various flavors of FADT. We need to look closely
515  * at the FADT length because the version number essentially tells
516  * us nothing because of many BIOS bugs where the version does not
517  * match the expected length. In other words, the length of the
518  * FADT is the bottom line as to what the version really is.
519  *
520  * NOTE: There is no officialy released V2 of the FADT. This
521  * version was used only for prototyping and testing during the
522  * 32-bit to 64-bit transition. V3 was the first official 64-bit
523  * version of the FADT.
524  *
525  * Update this list of defines when a new version of the FADT is
526  * added to the ACPI specification. Note that the FADT version is
527  * only incremented when new fields are appended to the existing
528  * version. Therefore, the FADT version is competely independent
529  * from the version of the ACPI specification where it is
530  * defined.
531  *
532  * For reference, the various FADT lengths are as follows:
533  *     FADT V1 size: 0x074      ACPI 1.0
534  *     FADT V3 size: 0x0F4      ACPI 2.0
535  *     FADT V4 size: 0x100      ACPI 3.0 and ACPI 4.0
536  *     FADT V5 size: 0x10C      ACPI 5.0
537  *     FADT V6 size: 0x114      ACPI 6.0
538  */
539 #define ACPI_FADT_V1_SIZE       (UINT32) (ACPI_FADT_OFFSET (Flags) + 4)         /* ACPI 1.0 */
540 #define ACPI_FADT_V3_SIZE       (UINT32) (ACPI_FADT_OFFSET (SleepControl))      /* ACPI 2.0 */
541 #define ACPI_FADT_V4_SIZE       (UINT32) (ACPI_FADT_OFFSET (SleepStatus))       /* ACPI 3.0 and ACPI 4.0 */
542 #define ACPI_FADT_V5_SIZE       (UINT32) (ACPI_FADT_OFFSET (HypervisorId))      /* ACPI 5.0 */
543 #define ACPI_FADT_V6_SIZE       (UINT32) (sizeof (ACPI_TABLE_FADT))             /* ACPI 6.0 */
544 
545 /* Update these when new FADT versions are added */
546 
547 #define ACPI_FADT_MAX_VERSION   6
548 #define ACPI_FADT_CONFORMANCE   "ACPI 6.1 (FADT version 6)"
549 
550 #endif /* __ACTBL_H__ */
551