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