1 /******************************************************************************
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
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
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.
114 *****************************************************************************
116 * Alternatively, you may choose to be licensed under the terms of the
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
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.
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.
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.
150 *****************************************************************************/
152 #ifndef __ACTYPES_H__
153 #define __ACTYPES_H__
155 /* acpisrc:StructDefs -- for acpisrc conversion */
158 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
159 * header and must be either 32 or 64. 16-bit ACPICA is no longer
160 * supported, as of 12/2006.
162 #ifndef ACPI_MACHINE_WIDTH
163 #error ACPI_MACHINE_WIDTH not defined
168 * Note: These macros are designed to be compiler independent as well as
169 * working around problems that some 32-bit compilers have with 64-bit
172 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
173 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
174 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
175 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
176 #define ACPI_ASCII_MAX 0x7F
180 * Architecture-specific ACPICA Subsystem Data Types
182 * The goal of these types is to provide source code portability across
183 * 16-bit, 32-bit, and 64-bit targets.
185 * 1) The following types are of fixed size for all targets (16/32/64):
187 * BOOLEAN Logical boolean
189 * UINT8 8-bit (1 byte) unsigned value
190 * UINT16 16-bit (2 byte) unsigned value
191 * UINT32 32-bit (4 byte) unsigned value
192 * UINT64 64-bit (8 byte) unsigned value
194 * INT16 16-bit (2 byte) signed value
195 * INT32 32-bit (4 byte) signed value
196 * INT64 64-bit (8 byte) signed value
198 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
199 * compiler-dependent header(s) and were introduced because there is no
200 * common 64-bit integer type across the various compilation models, as
201 * shown in the table below.
203 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
205 * short 16 16 16 16 16 16
207 * int 32 64 32 32 16 16
208 * long 64 64 32 32 32 32
210 * pointer 64 64 64 32 32 32
212 * Note: ILP64 and LP32 are currently not supported.
215 * 2) These types represent the native word size of the target mode of the
216 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
217 * usually used for memory allocation, efficient loop counters, and array
218 * indexes. The types are similar to the size_t type in the C library and
219 * are required because there is no C type that consistently represents the
220 * native data width. ACPI_SIZE is needed because there is no guarantee
221 * that a kernel-level C library is present.
223 * ACPI_SIZE 16/32/64-bit unsigned value
224 * ACPI_NATIVE_INT 16/32/64-bit signed value
227 /*******************************************************************************
229 * Common types for all compilers, all targets
231 ******************************************************************************/
233 #ifndef ACPI_USE_SYSTEM_INTTYPES
235 typedef unsigned char BOOLEAN
;
236 typedef unsigned char UINT8
;
237 typedef unsigned short UINT16
;
239 typedef COMPILER_DEPENDENT_UINT64 UINT64
;
240 typedef COMPILER_DEPENDENT_INT64 INT64
;
242 #endif /* ACPI_USE_SYSTEM_INTTYPES */
245 * Value returned by AcpiOsGetThreadId. There is no standard "thread_id"
246 * across operating systems or even the various UNIX systems. Since ACPICA
247 * only needs the thread ID as a unique thread identifier, we use a UINT64
248 * as the only common data type - it will accommodate any type of pointer or
249 * any type of integer. It is up to the host-dependent OSL to cast the
250 * native thread ID type to a UINT64 (in AcpiOsGetThreadId).
252 #define ACPI_THREAD_ID UINT64
255 /*******************************************************************************
257 * Types specific to 64-bit targets
259 ******************************************************************************/
261 #if ACPI_MACHINE_WIDTH == 64
263 #ifndef ACPI_USE_SYSTEM_INTTYPES
265 typedef unsigned int UINT32
;
268 #endif /* ACPI_USE_SYSTEM_INTTYPES */
271 typedef INT64 ACPI_NATIVE_INT
;
272 typedef UINT64 ACPI_SIZE
;
273 typedef UINT64 ACPI_IO_ADDRESS
;
274 typedef UINT64 ACPI_PHYSICAL_ADDRESS
;
276 #define ACPI_MAX_PTR ACPI_UINT64_MAX
277 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
278 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
279 #define ACPI_USE_NATIVE_MATH64 /* Has native 64-bit integer support */
282 * In the case of the Itanium Processor Family (IPF), the hardware does not
283 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
284 * flag to indicate that special precautions must be taken to avoid alignment
285 * faults. (IA64 or ia64 is currently used by existing compilers to indicate
288 * Note: EM64T and other X86-64 processors support misaligned transfers,
289 * so there is no need to define this flag.
291 #if defined (__IA64__) || defined (__ia64__)
292 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
296 /*******************************************************************************
298 * Types specific to 32-bit targets
300 ******************************************************************************/
302 #elif ACPI_MACHINE_WIDTH == 32
304 #ifndef ACPI_USE_SYSTEM_INTTYPES
306 typedef unsigned int UINT32
;
309 #endif /* ACPI_USE_SYSTEM_INTTYPES */
312 typedef INT32 ACPI_NATIVE_INT
;
313 typedef UINT32 ACPI_SIZE
;
315 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
318 * OSPMs can define this to shrink the size of the structures for 32-bit
319 * none PAE environment. ASL compiler may always define this to generate
320 * 32-bit OSPM compliant tables.
322 typedef UINT32 ACPI_IO_ADDRESS
;
323 typedef UINT32 ACPI_PHYSICAL_ADDRESS
;
325 #else /* ACPI_32BIT_PHYSICAL_ADDRESS */
328 * It is reported that, after some calculations, the physical addresses can
329 * wrap over the 32-bit boundary on 32-bit PAE environment.
330 * https://bugzilla.kernel.org/show_bug.cgi?id=87971
332 typedef UINT64 ACPI_IO_ADDRESS
;
333 typedef UINT64 ACPI_PHYSICAL_ADDRESS
;
335 #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */
337 #define ACPI_MAX_PTR ACPI_UINT32_MAX
338 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
342 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
344 #error unknown ACPI_MACHINE_WIDTH
348 /*******************************************************************************
352 * If the defaults below are not appropriate for the host system, they can
353 * be defined in the OS-specific header, and this will take precedence.
355 ******************************************************************************/
357 /* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */
359 #ifndef ACPI_CPU_FLAGS
360 #define ACPI_CPU_FLAGS ACPI_SIZE
363 /* Object returned from AcpiOsCreateCache */
366 #ifdef ACPI_USE_LOCAL_CACHE
367 #define ACPI_CACHE_T ACPI_MEMORY_LIST
369 #define ACPI_CACHE_T void *
374 * Synchronization objects - Mutexes, Semaphores, and SpinLocks
376 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
378 * These macros are used if the host OS does not support a mutex object.
379 * Map the OSL Mutex interfaces to binary semaphores.
381 #define ACPI_MUTEX ACPI_SEMAPHORE
382 #define AcpiOsCreateMutex(OutHandle) AcpiOsCreateSemaphore (1, 1, OutHandle)
383 #define AcpiOsDeleteMutex(Handle) (void) AcpiOsDeleteSemaphore (Handle)
384 #define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time)
385 #define AcpiOsReleaseMutex(Handle) (void) AcpiOsSignalSemaphore (Handle, 1)
388 /* Configurable types for synchronization objects */
390 #ifndef ACPI_SPINLOCK
391 #define ACPI_SPINLOCK void *
394 #ifndef ACPI_SEMAPHORE
395 #define ACPI_SEMAPHORE void *
399 #define ACPI_MUTEX void *
403 /*******************************************************************************
405 * Compiler-dependent types
407 * If the defaults below are not appropriate for the host compiler, they can
408 * be defined in the compiler-specific header, and this will take precedence.
410 ******************************************************************************/
412 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
414 #ifndef ACPI_UINTPTR_T
415 #define ACPI_UINTPTR_T void *
419 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
420 * some compilers can catch printf format string problems
422 #ifndef ACPI_PRINTF_LIKE
423 #define ACPI_PRINTF_LIKE(c)
427 * Some compilers complain about unused variables. Sometimes we don't want
428 * to use all the variables (for example, _AcpiModuleName). This allows us
429 * to tell the compiler in a per-variable manner that a variable
432 #ifndef ACPI_UNUSED_VAR
433 #define ACPI_UNUSED_VAR
437 * All ACPICA external functions that are available to the rest of the
438 * kernel are tagged with these macros which can be defined as appropriate
442 * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
443 * interfaces that may need special processing.
444 * ACPI_EXPORT_SYMBOL is used for all other public external functions.
446 #ifndef ACPI_EXPORT_SYMBOL_INIT
447 #define ACPI_EXPORT_SYMBOL_INIT(Symbol)
450 #ifndef ACPI_EXPORT_SYMBOL
451 #define ACPI_EXPORT_SYMBOL(Symbol)
455 * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
458 #ifndef ACPI_DEBUG_INITIALIZE
459 #define ACPI_DEBUG_INITIALIZE()
463 /*******************************************************************************
467 ******************************************************************************/
469 #ifdef ACPI_NO_MEM_ALLOCATIONS
471 #define ACPI_ALLOCATE(a) NULL
472 #define ACPI_ALLOCATE_ZEROED(a) NULL
474 #define ACPI_MEM_TRACKING(a)
476 #else /* ACPI_NO_MEM_ALLOCATIONS */
478 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
480 * Memory allocation tracking (used by AcpiExec to detect memory leaks)
482 #define ACPI_MEM_PARAMETERS _COMPONENT, _AcpiModuleName, __LINE__
483 #define ACPI_ALLOCATE(a) AcpiUtAllocateAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
484 #define ACPI_ALLOCATE_ZEROED(a) AcpiUtAllocateZeroedAndTrack ((ACPI_SIZE) (a), ACPI_MEM_PARAMETERS)
485 #define ACPI_FREE(a) AcpiUtFreeAndTrack (a, ACPI_MEM_PARAMETERS)
486 #define ACPI_MEM_TRACKING(a) a
490 * Normal memory allocation directly via the OS services layer
492 #define ACPI_ALLOCATE(a) AcpiOsAllocate ((ACPI_SIZE) (a))
493 #define ACPI_ALLOCATE_ZEROED(a) AcpiOsAllocateZeroed ((ACPI_SIZE) (a))
494 #define ACPI_FREE(a) AcpiOsFree (a)
495 #define ACPI_MEM_TRACKING(a)
497 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
499 #endif /* ACPI_NO_MEM_ALLOCATIONS */
502 /******************************************************************************
504 * ACPI Specification constants (Do not change unless the specification
507 *****************************************************************************/
509 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
511 #define ACPI_MAX_GPE_BLOCKS 2
513 /* Default ACPI register widths */
515 #define ACPI_GPE_REGISTER_WIDTH 8
516 #define ACPI_PM1_REGISTER_WIDTH 16
517 #define ACPI_PM2_REGISTER_WIDTH 8
518 #define ACPI_PM_TIMER_WIDTH 32
519 #define ACPI_RESET_REGISTER_WIDTH 8
521 /* Names within the namespace are 4 bytes long */
523 #define ACPI_NAME_SIZE 4
524 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
525 #define ACPI_PATH_SEPARATOR '.'
527 /* Sizes for ACPI table headers */
529 #define ACPI_OEM_ID_SIZE 6
530 #define ACPI_OEM_TABLE_ID_SIZE 8
532 /* ACPI/PNP hardware IDs */
534 #define PCI_ROOT_HID_STRING "PNP0A03"
535 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
537 /* PM Timer ticks per second (HZ) */
539 #define ACPI_PM_TIMER_FREQUENCY 3579545
542 /*******************************************************************************
546 ******************************************************************************/
548 /* Logical defines and NULL */
553 #define FALSE (1 == 0)
558 #define TRUE (1 == 1)
561 #define NULL (void *) 0
566 * Miscellaneous types
568 typedef UINT32 ACPI_STATUS
; /* All ACPI Exceptions */
569 typedef UINT32 ACPI_NAME
; /* 4-byte ACPI name */
570 typedef char * ACPI_STRING
; /* Null terminated ASCII string */
571 typedef void * ACPI_HANDLE
; /* Actually a ptr to a NS Node */
574 /* Time constants for timer calculations */
576 #define ACPI_MSEC_PER_SEC 1000L
578 #define ACPI_USEC_PER_MSEC 1000L
579 #define ACPI_USEC_PER_SEC 1000000L
581 #define ACPI_100NSEC_PER_USEC 10L
582 #define ACPI_100NSEC_PER_MSEC 10000L
583 #define ACPI_100NSEC_PER_SEC 10000000L
585 #define ACPI_NSEC_PER_USEC 1000L
586 #define ACPI_NSEC_PER_MSEC 1000000L
587 #define ACPI_NSEC_PER_SEC 1000000000L
589 #define ACPI_TIME_AFTER(a, b) ((INT64)((b) - (a)) < 0)
592 /* Owner IDs are used to track namespace nodes for selective deletion */
594 typedef UINT8 ACPI_OWNER_ID
;
595 #define ACPI_OWNER_ID_MAX 0xFF
598 #define ACPI_INTEGER_BIT_SIZE 64
599 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
600 #define ACPI_MAX64_DECIMAL_DIGITS 20
601 #define ACPI_MAX32_DECIMAL_DIGITS 10
602 #define ACPI_MAX16_DECIMAL_DIGITS 5
603 #define ACPI_MAX8_DECIMAL_DIGITS 3
606 * Constants with special meanings
608 #define ACPI_ROOT_OBJECT ((ACPI_HANDLE) ACPI_TO_POINTER (ACPI_MAX_PTR))
609 #define ACPI_WAIT_FOREVER 0xFFFF /* UINT16, as per ACPI spec */
610 #define ACPI_DO_NOT_WAIT 0
613 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
614 * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
615 * Note that this pertains to the ACPI integer type only, not to other
616 * integers used in the implementation of the ACPICA subsystem.
618 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
619 * code base. It remains here for compatibility with device drivers that use
620 * the type. However, it will be removed in the future.
622 typedef UINT64 ACPI_INTEGER
;
623 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
626 /*******************************************************************************
628 * Commonly used macros
630 ******************************************************************************/
632 /* Data manipulation */
634 #define ACPI_LOBYTE(Integer) ((UINT8) (UINT16)(Integer))
635 #define ACPI_HIBYTE(Integer) ((UINT8) (((UINT16)(Integer)) >> 8))
636 #define ACPI_LOWORD(Integer) ((UINT16) (UINT32)(Integer))
637 #define ACPI_HIWORD(Integer) ((UINT16)(((UINT32)(Integer)) >> 16))
638 #define ACPI_LODWORD(Integer64) ((UINT32) (UINT64)(Integer64))
639 #define ACPI_HIDWORD(Integer64) ((UINT32)(((UINT64)(Integer64)) >> 32))
641 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
642 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
643 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
644 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
646 /* Size calculation */
648 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
650 /* Pointer manipulation */
652 #define ACPI_CAST_PTR(t, p) ((t *) (ACPI_UINTPTR_T) (p))
653 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (ACPI_UINTPTR_T) (p))
654 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
655 #define ACPI_SUB_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) - (ACPI_SIZE)(b)))
656 #define ACPI_PTR_DIFF(a, b) ((ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b))))
658 /* Pointer/Integer type conversions */
660 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) 0, (ACPI_SIZE) (i))
661 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) 0)
662 #define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) 0)
663 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
664 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
666 /* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */
668 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
669 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
670 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
672 #define ACPI_COMPARE_NAME(a,b) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
673 #define ACPI_MOVE_NAME(dest,src) (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
676 /* Support for the special RSDP signature (8 characters) */
678 #define ACPI_VALIDATE_RSDP_SIG(a) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
679 #define ACPI_MAKE_RSDP_SIG(dest) (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
682 * Algorithm to obtain access bit width.
683 * Can be used with AccessWidth of ACPI_GENERIC_ADDRESS and AccessSize of
684 * ACPI_RESOURCE_GENERIC_REGISTER.
686 #define ACPI_ACCESS_BIT_WIDTH(size) (1 << ((size) + 2))
689 /*******************************************************************************
691 * Miscellaneous constants
693 ******************************************************************************/
696 * Initialization sequence options
698 #define ACPI_FULL_INITIALIZATION 0x0000
699 #define ACPI_NO_FACS_INIT 0x0001
700 #define ACPI_NO_ACPI_ENABLE 0x0002
701 #define ACPI_NO_HARDWARE_INIT 0x0004
702 #define ACPI_NO_EVENT_INIT 0x0008
703 #define ACPI_NO_HANDLER_INIT 0x0010
704 #define ACPI_NO_OBJECT_INIT 0x0020
705 #define ACPI_NO_DEVICE_INIT 0x0040
706 #define ACPI_NO_ADDRESS_SPACE_INIT 0x0080
709 * Initialization state
711 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
712 #define ACPI_INITIALIZED_OK 0x02
717 #define ACPI_STATE_UNKNOWN (UINT8) 0xFF
719 #define ACPI_STATE_S0 (UINT8) 0
720 #define ACPI_STATE_S1 (UINT8) 1
721 #define ACPI_STATE_S2 (UINT8) 2
722 #define ACPI_STATE_S3 (UINT8) 3
723 #define ACPI_STATE_S4 (UINT8) 4
724 #define ACPI_STATE_S5 (UINT8) 5
725 #define ACPI_S_STATES_MAX ACPI_STATE_S5
726 #define ACPI_S_STATE_COUNT 6
728 #define ACPI_STATE_D0 (UINT8) 0
729 #define ACPI_STATE_D1 (UINT8) 1
730 #define ACPI_STATE_D2 (UINT8) 2
731 #define ACPI_STATE_D3 (UINT8) 3
732 #define ACPI_D_STATES_MAX ACPI_STATE_D3
733 #define ACPI_D_STATE_COUNT 4
735 #define ACPI_STATE_C0 (UINT8) 0
736 #define ACPI_STATE_C1 (UINT8) 1
737 #define ACPI_STATE_C2 (UINT8) 2
738 #define ACPI_STATE_C3 (UINT8) 3
739 #define ACPI_C_STATES_MAX ACPI_STATE_C3
740 #define ACPI_C_STATE_COUNT 4
743 * Sleep type invalid value
745 #define ACPI_SLEEP_TYPE_MAX 0x7
746 #define ACPI_SLEEP_TYPE_INVALID 0xFF
749 * Standard notify values
751 #define ACPI_NOTIFY_BUS_CHECK (UINT8) 0x00
752 #define ACPI_NOTIFY_DEVICE_CHECK (UINT8) 0x01
753 #define ACPI_NOTIFY_DEVICE_WAKE (UINT8) 0x02
754 #define ACPI_NOTIFY_EJECT_REQUEST (UINT8) 0x03
755 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (UINT8) 0x04
756 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (UINT8) 0x05
757 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (UINT8) 0x06
758 #define ACPI_NOTIFY_POWER_FAULT (UINT8) 0x07
759 #define ACPI_NOTIFY_CAPABILITIES_CHECK (UINT8) 0x08
760 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (UINT8) 0x09
761 #define ACPI_NOTIFY_RESERVED (UINT8) 0x0A
762 #define ACPI_NOTIFY_LOCALITY_UPDATE (UINT8) 0x0B
763 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (UINT8) 0x0C
764 #define ACPI_NOTIFY_AFFINITY_UPDATE (UINT8) 0x0D
765 #define ACPI_NOTIFY_MEMORY_UPDATE (UINT8) 0x0E
767 #define ACPI_GENERIC_NOTIFY_MAX 0x0E
768 #define ACPI_SPECIFIC_NOTIFY_MAX 0x84
771 * Types associated with ACPI names and objects. The first group of
772 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
773 * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
774 * only add to the first group if the spec changes.
776 * NOTE: Types must be kept in sync with the global AcpiNsProperties
777 * and AcpiNsTypeNames arrays.
779 typedef UINT32 ACPI_OBJECT_TYPE
;
781 #define ACPI_TYPE_ANY 0x00
782 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
783 #define ACPI_TYPE_STRING 0x02
784 #define ACPI_TYPE_BUFFER 0x03
785 #define ACPI_TYPE_PACKAGE 0x04 /* ByteConst, multiple DataTerm/Constant/SuperName */
786 #define ACPI_TYPE_FIELD_UNIT 0x05
787 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
788 #define ACPI_TYPE_EVENT 0x07
789 #define ACPI_TYPE_METHOD 0x08 /* Name, ByteConst, multiple Code */
790 #define ACPI_TYPE_MUTEX 0x09
791 #define ACPI_TYPE_REGION 0x0A
792 #define ACPI_TYPE_POWER 0x0B /* Name,ByteConst,WordConst,multi Node */
793 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
794 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
795 #define ACPI_TYPE_BUFFER_FIELD 0x0E
796 #define ACPI_TYPE_DDB_HANDLE 0x0F
797 #define ACPI_TYPE_DEBUG_OBJECT 0x10
799 #define ACPI_TYPE_EXTERNAL_MAX 0x10
800 #define ACPI_NUM_TYPES (ACPI_TYPE_EXTERNAL_MAX + 1)
803 * These are object types that do not map directly to the ACPI
804 * ObjectType() operator. They are used for various internal purposes
805 * only. If new predefined ACPI_TYPEs are added (via the ACPI
806 * specification), these internal types must move upwards. (There
807 * is code that depends on these values being contiguous with the
808 * external types above.)
810 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
811 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
812 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
813 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, RefOf, Index */
814 #define ACPI_TYPE_LOCAL_ALIAS 0x15
815 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
816 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
817 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
818 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
819 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
820 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple ObjectList Nodes */
822 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
823 #define ACPI_TOTAL_TYPES (ACPI_TYPE_NS_NODE_MAX + 1)
826 * These are special object types that never appear in
827 * a Namespace node, only in an object of ACPI_OPERAND_OBJECT
829 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
830 #define ACPI_TYPE_LOCAL_DATA 0x1D
832 #define ACPI_TYPE_LOCAL_MAX 0x1D
834 /* All types above here are invalid */
836 #define ACPI_TYPE_INVALID 0x1E
837 #define ACPI_TYPE_NOT_FOUND 0xFF
839 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
847 #define ACPI_IO_MASK 1
850 * Event Types: Fixed & General Purpose
852 typedef UINT32 ACPI_EVENT_TYPE
;
857 #define ACPI_EVENT_PMTIMER 0
858 #define ACPI_EVENT_GLOBAL 1
859 #define ACPI_EVENT_POWER_BUTTON 2
860 #define ACPI_EVENT_SLEEP_BUTTON 3
861 #define ACPI_EVENT_RTC 4
862 #define ACPI_EVENT_MAX 4
863 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
866 * Event Status - Per event
868 * The encoding of ACPI_EVENT_STATUS is illustrated below.
869 * Note that a set bit (1) indicates the property is TRUE
870 * (e.g. if bit 0 is set then the event is enabled).
871 * +-------------+-+-+-+-+-+-+
872 * | Bits 31:6 |5|4|3|2|1|0|
873 * +-------------+-+-+-+-+-+-+
875 * | | | | | | +- Enabled?
876 * | | | | | +--- Enabled for wake?
877 * | | | | +----- Status bit set?
878 * | | | +------- Enable bit set?
879 * | | +--------- Has a handler?
880 * | +----------- Masked?
881 * +----------------- <Reserved>
883 typedef UINT32 ACPI_EVENT_STATUS
;
885 #define ACPI_EVENT_FLAG_DISABLED (ACPI_EVENT_STATUS) 0x00
886 #define ACPI_EVENT_FLAG_ENABLED (ACPI_EVENT_STATUS) 0x01
887 #define ACPI_EVENT_FLAG_WAKE_ENABLED (ACPI_EVENT_STATUS) 0x02
888 #define ACPI_EVENT_FLAG_STATUS_SET (ACPI_EVENT_STATUS) 0x04
889 #define ACPI_EVENT_FLAG_ENABLE_SET (ACPI_EVENT_STATUS) 0x08
890 #define ACPI_EVENT_FLAG_HAS_HANDLER (ACPI_EVENT_STATUS) 0x10
891 #define ACPI_EVENT_FLAG_MASKED (ACPI_EVENT_STATUS) 0x20
892 #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET
894 /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
896 #define ACPI_GPE_ENABLE 0
897 #define ACPI_GPE_DISABLE 1
898 #define ACPI_GPE_CONDITIONAL_ENABLE 2
901 * GPE info flags - Per GPE
906 * | | | | +-- Type of dispatch:to method, handler, notify, or none
907 * | | | +----- Interrupt type: edge or level triggered
908 * | | +------- Is a Wake GPE
909 * | +--------- Has been enabled automatically at init time
910 * +------------ <Reserved>
912 #define ACPI_GPE_DISPATCH_NONE (UINT8) 0x00
913 #define ACPI_GPE_DISPATCH_METHOD (UINT8) 0x01
914 #define ACPI_GPE_DISPATCH_HANDLER (UINT8) 0x02
915 #define ACPI_GPE_DISPATCH_NOTIFY (UINT8) 0x03
916 #define ACPI_GPE_DISPATCH_RAW_HANDLER (UINT8) 0x04
917 #define ACPI_GPE_DISPATCH_MASK (UINT8) 0x07
918 #define ACPI_GPE_DISPATCH_TYPE(flags) ((UINT8) ((flags) & ACPI_GPE_DISPATCH_MASK))
920 #define ACPI_GPE_LEVEL_TRIGGERED (UINT8) 0x08
921 #define ACPI_GPE_EDGE_TRIGGERED (UINT8) 0x00
922 #define ACPI_GPE_XRUPT_TYPE_MASK (UINT8) 0x08
924 #define ACPI_GPE_CAN_WAKE (UINT8) 0x10
925 #define ACPI_GPE_AUTO_ENABLED (UINT8) 0x20
926 #define ACPI_GPE_INITIALIZED (UINT8) 0x40
929 * Flags for GPE and Lock interfaces
931 #define ACPI_NOT_ISR 0x1
937 #define ACPI_SYSTEM_NOTIFY 0x1
938 #define ACPI_DEVICE_NOTIFY 0x2
939 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
940 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
941 #define ACPI_NUM_NOTIFY_TYPES 2
943 #define ACPI_MAX_SYS_NOTIFY 0x7F
944 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
946 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
947 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
950 /* Address Space (Operation Region) Types */
952 typedef UINT8 ACPI_ADR_SPACE_TYPE
;
954 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (ACPI_ADR_SPACE_TYPE) 0
955 #define ACPI_ADR_SPACE_SYSTEM_IO (ACPI_ADR_SPACE_TYPE) 1
956 #define ACPI_ADR_SPACE_PCI_CONFIG (ACPI_ADR_SPACE_TYPE) 2
957 #define ACPI_ADR_SPACE_EC (ACPI_ADR_SPACE_TYPE) 3
958 #define ACPI_ADR_SPACE_SMBUS (ACPI_ADR_SPACE_TYPE) 4
959 #define ACPI_ADR_SPACE_CMOS (ACPI_ADR_SPACE_TYPE) 5
960 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (ACPI_ADR_SPACE_TYPE) 6
961 #define ACPI_ADR_SPACE_IPMI (ACPI_ADR_SPACE_TYPE) 7
962 #define ACPI_ADR_SPACE_GPIO (ACPI_ADR_SPACE_TYPE) 8
963 #define ACPI_ADR_SPACE_GSBUS (ACPI_ADR_SPACE_TYPE) 9
964 #define ACPI_ADR_SPACE_PLATFORM_COMM (ACPI_ADR_SPACE_TYPE) 10
966 #define ACPI_NUM_PREDEFINED_REGIONS 11
969 * Special Address Spaces
971 * Note: A Data Table region is a special type of operation region
972 * that has its own AML opcode. However, internally, the AML
973 * interpreter simply creates an operation region with an an address
974 * space type of ACPI_ADR_SPACE_DATA_TABLE.
976 #define ACPI_ADR_SPACE_DATA_TABLE (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
977 #define ACPI_ADR_SPACE_FIXED_HARDWARE (ACPI_ADR_SPACE_TYPE) 0x7F
979 /* Values for _REG connection code */
981 #define ACPI_REG_DISCONNECT 0
982 #define ACPI_REG_CONNECT 1
987 * These values are intended to be used by the hardware interfaces
988 * and are mapped to individual bitfields defined within the ACPI
989 * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
993 /* PM1 Status register */
995 #define ACPI_BITREG_TIMER_STATUS 0x00
996 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
997 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
998 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
999 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
1000 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
1001 #define ACPI_BITREG_WAKE_STATUS 0x06
1002 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
1004 /* PM1 Enable register */
1006 #define ACPI_BITREG_TIMER_ENABLE 0x08
1007 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
1008 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
1009 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
1010 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
1011 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
1013 /* PM1 Control register */
1015 #define ACPI_BITREG_SCI_ENABLE 0x0E
1016 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
1017 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
1018 #define ACPI_BITREG_SLEEP_TYPE 0x11
1019 #define ACPI_BITREG_SLEEP_ENABLE 0x12
1021 /* PM2 Control register */
1023 #define ACPI_BITREG_ARB_DISABLE 0x13
1025 #define ACPI_BITREG_MAX 0x13
1026 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
1029 /* Status register values. A 1 clears a status bit. 0 = no effect */
1031 #define ACPI_CLEAR_STATUS 1
1033 /* Enable and Control register values */
1035 #define ACPI_ENABLE_EVENT 1
1036 #define ACPI_DISABLE_EVENT 0
1039 /* Sleep function dispatch */
1041 typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION
) (
1044 typedef struct acpi_sleep_functions
1046 ACPI_SLEEP_FUNCTION LegacyFunction
;
1047 ACPI_SLEEP_FUNCTION ExtendedFunction
;
1049 } ACPI_SLEEP_FUNCTIONS
;
1053 * External ACPI object definition
1057 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
1058 * element or an unresolved named reference.
1060 typedef union acpi_object
1062 ACPI_OBJECT_TYPE Type
; /* See definition of AcpiNsType for values */
1065 ACPI_OBJECT_TYPE Type
; /* ACPI_TYPE_INTEGER */
1066 UINT64 Value
; /* The actual number */
1071 ACPI_OBJECT_TYPE Type
; /* ACPI_TYPE_STRING */
1072 UINT32 Length
; /* # of bytes in string, excluding trailing null */
1073 char *Pointer
; /* points to the string value */
1078 ACPI_OBJECT_TYPE Type
; /* ACPI_TYPE_BUFFER */
1079 UINT32 Length
; /* # of bytes in buffer */
1080 UINT8
*Pointer
; /* points to the buffer */
1085 ACPI_OBJECT_TYPE Type
; /* ACPI_TYPE_PACKAGE */
1086 UINT32 Count
; /* # of elements in package */
1087 union acpi_object
*Elements
; /* Pointer to an array of ACPI_OBJECTs */
1092 ACPI_OBJECT_TYPE Type
; /* ACPI_TYPE_LOCAL_REFERENCE */
1093 ACPI_OBJECT_TYPE ActualType
; /* Type associated with the Handle */
1094 ACPI_HANDLE Handle
; /* object reference */
1099 ACPI_OBJECT_TYPE Type
; /* ACPI_TYPE_PROCESSOR */
1101 ACPI_IO_ADDRESS PblkAddress
;
1107 ACPI_OBJECT_TYPE Type
; /* ACPI_TYPE_POWER */
1109 UINT32 ResourceOrder
;
1116 * List of objects, used as a parameter list for control method evaluation
1118 typedef struct acpi_object_list
1121 ACPI_OBJECT
*Pointer
;
1127 * Miscellaneous common Data Structures used by the interfaces
1129 #define ACPI_NO_BUFFER 0
1131 #ifdef ACPI_NO_MEM_ALLOCATIONS
1133 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (0)
1134 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (0)
1136 #else /* ACPI_NO_MEM_ALLOCATIONS */
1138 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (-1) /* Let ACPICA allocate buffer */
1139 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (-2) /* For internal use only (enables tracking) */
1141 #endif /* ACPI_NO_MEM_ALLOCATIONS */
1143 typedef struct acpi_buffer
1145 ACPI_SIZE Length
; /* Length in bytes of the buffer */
1146 void *Pointer
; /* pointer to buffer */
1152 * NameType for AcpiGetName
1154 #define ACPI_FULL_PATHNAME 0
1155 #define ACPI_SINGLE_NAME 1
1156 #define ACPI_FULL_PATHNAME_NO_TRAILING 2
1157 #define ACPI_NAME_TYPE_MAX 2
1161 * Predefined Namespace items
1163 typedef struct acpi_predefined_names
1169 } ACPI_PREDEFINED_NAMES
;
1173 * Structure and flags for AcpiGetSystemInfo
1175 #define ACPI_SYS_MODE_UNKNOWN 0x0000
1176 #define ACPI_SYS_MODE_ACPI 0x0001
1177 #define ACPI_SYS_MODE_LEGACY 0x0002
1178 #define ACPI_SYS_MODES_MASK 0x0003
1182 * System info returned by AcpiGetSystemInfo()
1184 typedef struct acpi_system_info
1186 UINT32 AcpiCaVersion
;
1188 UINT32 TimerResolution
;
1198 * System statistics returned by AcpiGetStatistics()
1200 typedef struct acpi_statistics
1204 UINT32 FixedEventCount
[ACPI_NUM_FIXED_EVENTS
];
1211 * Types specific to the OS service interfaces
1214 (ACPI_SYSTEM_XFACE
*ACPI_OSD_HANDLER
) (
1218 (ACPI_SYSTEM_XFACE
*ACPI_OSD_EXEC_CALLBACK
) (
1222 * Various handlers and callback procedures
1225 UINT32 (*ACPI_SCI_HANDLER
) (
1229 void (*ACPI_GBL_EVENT_HANDLER
) (
1235 #define ACPI_EVENT_TYPE_GPE 0
1236 #define ACPI_EVENT_TYPE_FIXED 1
1239 UINT32 (*ACPI_EVENT_HANDLER
) (
1243 UINT32 (*ACPI_GPE_HANDLER
) (
1244 ACPI_HANDLE GpeDevice
,
1249 void (*ACPI_NOTIFY_HANDLER
) (
1255 void (*ACPI_OBJECT_HANDLER
) (
1260 ACPI_STATUS (*ACPI_INIT_HANDLER
) (
1264 #define ACPI_INIT_DEVICE_INI 1
1267 ACPI_STATUS (*ACPI_EXCEPTION_HANDLER
) (
1268 ACPI_STATUS AmlStatus
,
1274 /* Table Event handler (Load, LoadTable, etc.) and types */
1277 ACPI_STATUS (*ACPI_TABLE_HANDLER
) (
1283 /* Table Event Types */
1285 #define ACPI_TABLE_EVENT_LOAD 0x0
1286 #define ACPI_TABLE_EVENT_UNLOAD 0x1
1287 #define ACPI_TABLE_EVENT_INSTALL 0x2
1288 #define ACPI_TABLE_EVENT_UNINSTALL 0x3
1289 #define ACPI_NUM_TABLE_EVENTS 4
1292 /* Address Spaces (For Operation Regions) */
1295 ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER
) (
1297 ACPI_PHYSICAL_ADDRESS Address
,
1300 void *HandlerContext
,
1301 void *RegionContext
);
1303 #define ACPI_DEFAULT_HANDLER NULL
1305 /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
1307 typedef struct acpi_connection_info
1313 } ACPI_CONNECTION_INFO
;
1317 ACPI_STATUS (*ACPI_ADR_SPACE_SETUP
) (
1318 ACPI_HANDLE RegionHandle
,
1320 void *HandlerContext
,
1321 void **RegionContext
);
1323 #define ACPI_REGION_ACTIVATE 0
1324 #define ACPI_REGION_DEACTIVATE 1
1327 ACPI_STATUS (*ACPI_WALK_CALLBACK
) (
1329 UINT32 NestingLevel
,
1331 void **ReturnValue
);
1334 UINT32 (*ACPI_INTERFACE_HANDLER
) (
1335 ACPI_STRING InterfaceName
,
1339 /* Interrupt handler return values */
1341 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
1342 #define ACPI_INTERRUPT_HANDLED 0x01
1344 /* GPE handler return values */
1346 #define ACPI_REENABLE_GPE 0x80
1349 /* Length of 32-bit EISAID values when converted back to a string */
1351 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1353 /* Length of UUID (string) values */
1355 #define ACPI_UUID_LENGTH 16
1357 /* Length of 3-byte PCI class code values when converted back to a string */
1359 #define ACPI_PCICLS_STRING_SIZE 7 /* Includes null terminator */
1362 /* Structures used for device/processor HID, UID, CID */
1364 typedef struct acpi_pnp_device_id
1366 UINT32 Length
; /* Length of string + null */
1369 } ACPI_PNP_DEVICE_ID
;
1371 typedef struct acpi_pnp_device_id_list
1373 UINT32 Count
; /* Number of IDs in Ids array */
1374 UINT32 ListSize
; /* Size of list, including ID strings */
1375 ACPI_PNP_DEVICE_ID Ids
[1]; /* ID array */
1377 } ACPI_PNP_DEVICE_ID_LIST
;
1380 * Structure returned from AcpiGetObjectInfo.
1381 * Optimized for both 32-bit and 64-bit builds.
1383 typedef struct acpi_device_info
1385 UINT32 InfoSize
; /* Size of info, including ID strings */
1386 UINT32 Name
; /* ACPI object Name */
1387 ACPI_OBJECT_TYPE Type
; /* ACPI object Type */
1388 UINT8 ParamCount
; /* If a method, required parameter count */
1389 UINT16 Valid
; /* Indicates which optional fields are valid */
1390 UINT8 Flags
; /* Miscellaneous info */
1391 UINT8 HighestDstates
[4]; /* _SxD values: 0xFF indicates not valid */
1392 UINT8 LowestDstates
[5]; /* _SxW values: 0xFF indicates not valid */
1393 UINT64 Address
; /* _ADR value */
1394 ACPI_PNP_DEVICE_ID HardwareId
; /* _HID value */
1395 ACPI_PNP_DEVICE_ID UniqueId
; /* _UID value */
1396 ACPI_PNP_DEVICE_ID ClassCode
; /* _CLS value */
1397 ACPI_PNP_DEVICE_ID_LIST CompatibleIdList
; /* _CID list <must be last> */
1401 /* Values for Flags field above (AcpiGetObjectInfo) */
1403 #define ACPI_PCI_ROOT_BRIDGE 0x01
1405 /* Flags for Valid field above (AcpiGetObjectInfo) */
1407 #define ACPI_VALID_ADR 0x0002
1408 #define ACPI_VALID_HID 0x0004
1409 #define ACPI_VALID_UID 0x0008
1410 #define ACPI_VALID_CID 0x0020
1411 #define ACPI_VALID_CLS 0x0040
1412 #define ACPI_VALID_SXDS 0x0100
1413 #define ACPI_VALID_SXWS 0x0200
1415 /* Flags for _STA method */
1417 #define ACPI_STA_DEVICE_PRESENT 0x01
1418 #define ACPI_STA_DEVICE_ENABLED 0x02
1419 #define ACPI_STA_DEVICE_UI 0x04
1420 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1421 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1422 #define ACPI_STA_BATTERY_PRESENT 0x10
1425 /* Context structs for address space handlers */
1427 typedef struct acpi_pci_id
1436 typedef struct acpi_mem_space_context
1439 ACPI_PHYSICAL_ADDRESS Address
;
1440 ACPI_PHYSICAL_ADDRESS MappedPhysicalAddress
;
1441 UINT8
*MappedLogicalAddress
;
1442 ACPI_SIZE MappedLength
;
1444 } ACPI_MEM_SPACE_CONTEXT
;
1448 * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
1450 typedef struct acpi_memory_list
1452 const char *ListName
;
1456 UINT16 CurrentDepth
;
1458 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1460 /* Statistics for debug memory tracking only */
1462 UINT32 TotalAllocated
;
1466 UINT32 CurrentTotalSize
;
1474 /* Definitions of trace event types */
1478 ACPI_TRACE_AML_METHOD
,
1479 ACPI_TRACE_AML_OPCODE
,
1480 ACPI_TRACE_AML_REGION
1482 } ACPI_TRACE_EVENT_TYPE
;
1485 /* Definitions of _OSI support */
1487 #define ACPI_VENDOR_STRINGS 0x01
1488 #define ACPI_FEATURE_STRINGS 0x02
1489 #define ACPI_ENABLE_INTERFACES 0x00
1490 #define ACPI_DISABLE_INTERFACES 0x04
1492 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1493 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1494 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1495 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1496 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1497 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1499 #define ACPI_OSI_WIN_2000 0x01
1500 #define ACPI_OSI_WIN_XP 0x02
1501 #define ACPI_OSI_WIN_XP_SP1 0x03
1502 #define ACPI_OSI_WINSRV_2003 0x04
1503 #define ACPI_OSI_WIN_XP_SP2 0x05
1504 #define ACPI_OSI_WINSRV_2003_SP1 0x06
1505 #define ACPI_OSI_WIN_VISTA 0x07
1506 #define ACPI_OSI_WINSRV_2008 0x08
1507 #define ACPI_OSI_WIN_VISTA_SP1 0x09
1508 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
1509 #define ACPI_OSI_WIN_7 0x0B
1510 #define ACPI_OSI_WIN_8 0x0C
1511 #define ACPI_OSI_WIN_10 0x0D
1512 #define ACPI_OSI_WIN_10_RS1 0x0E
1513 #define ACPI_OSI_WIN_10_RS2 0x0F
1514 #define ACPI_OSI_WIN_10_RS3 0x10
1517 /* Definitions of getopt */
1519 #define ACPI_OPT_END -1
1522 #endif /* __ACTYPES_H__ */