1 /******************************************************************************
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
47 /* acpisrc:StructDefs -- for acpisrc conversion */
50 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
51 * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
54 #ifndef ACPI_MACHINE_WIDTH
55 #error ACPI_MACHINE_WIDTH not defined
58 /*! [Begin] no source code translation */
62 * Note: These macros are designed to be compiler independent as well as
63 * working around problems that some 32-bit compilers have with 64-bit
66 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
67 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
68 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
69 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
70 #define ACPI_ASCII_MAX 0x7F
74 * Architecture-specific ACPICA Subsystem Data Types
76 * The goal of these types is to provide source code portability across
77 * 16-bit, 32-bit, and 64-bit targets.
79 * 1) The following types are of fixed size for all targets (16/32/64):
81 * BOOLEAN Logical boolean
83 * UINT8 8-bit (1 byte) unsigned value
84 * UINT16 16-bit (2 byte) unsigned value
85 * UINT32 32-bit (4 byte) unsigned value
86 * UINT64 64-bit (8 byte) unsigned value
88 * INT16 16-bit (2 byte) signed value
89 * INT32 32-bit (4 byte) signed value
90 * INT64 64-bit (8 byte) signed value
92 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
93 * compiler-dependent header(s) and were introduced because there is no common
94 * 64-bit integer type across the various compilation models, as shown in
97 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
99 * short 16 16 16 16 16 16
101 * int 32 64 32 32 16 16
102 * long 64 64 32 32 32 32
104 * pointer 64 64 64 32 32 32
106 * Note: ILP64 and LP32 are currently not supported.
109 * 2) These types represent the native word size of the target mode of the
110 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
111 * usually used for memory allocation, efficient loop counters, and array
112 * indexes. The types are similar to the size_t type in the C library and are
113 * required because there is no C type that consistently represents the native
114 * data width. ACPI_SIZE is needed because there is no guarantee that a
115 * kernel-level C library is present.
117 * ACPI_SIZE 16/32/64-bit unsigned value
118 * ACPI_NATIVE_INT 16/32/64-bit signed value
121 /*******************************************************************************
123 * Common types for all compilers, all targets
125 ******************************************************************************/
127 typedef unsigned char BOOLEAN;
128 typedef unsigned char UINT8;
129 typedef unsigned short UINT16;
130 typedef COMPILER_DEPENDENT_UINT64 UINT64;
131 typedef COMPILER_DEPENDENT_INT64 INT64;
133 /*! [End] no source code translation !*/
136 * Value returned by AcpiOsGetThreadId. There is no standard "thread_id"
137 * across operating systems or even the various UNIX systems. Since ACPICA
138 * only needs the thread ID as a unique thread identifier, we use a UINT64
139 * as the only common data type - it will accommodate any type of pointer or
140 * any type of integer. It is up to the host-dependent OSL to cast the
141 * native thread ID type to a UINT64 (in AcpiOsGetThreadId).
143 #define ACPI_THREAD_ID UINT64
146 /*******************************************************************************
148 * Types specific to 64-bit targets
150 ******************************************************************************/
152 #if ACPI_MACHINE_WIDTH == 64
154 /*! [Begin] no source code translation (keep the typedefs as-is) */
156 typedef unsigned int UINT32;
159 /*! [End] no source code translation !*/
162 typedef INT64 ACPI_NATIVE_INT;
163 typedef UINT64 ACPI_SIZE;
164 typedef UINT64 ACPI_IO_ADDRESS;
165 typedef UINT64 ACPI_PHYSICAL_ADDRESS;
167 #define ACPI_MAX_PTR ACPI_UINT64_MAX
168 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
169 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
172 * In the case of the Itanium Processor Family (IPF), the hardware does not
173 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
174 * to indicate that special precautions must be taken to avoid alignment faults.
175 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
177 * Note: EM64T and other X86-64 processors support misaligned transfers,
178 * so there is no need to define this flag.
180 #if defined (__IA64__) || defined (__ia64__)
181 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
185 /*******************************************************************************
187 * Types specific to 32-bit targets
189 ******************************************************************************/
191 #elif ACPI_MACHINE_WIDTH == 32
193 /*! [Begin] no source code translation (keep the typedefs as-is) */
195 typedef unsigned int UINT32;
198 /*! [End] no source code translation !*/
201 typedef INT32 ACPI_NATIVE_INT;
202 typedef UINT32 ACPI_SIZE;
203 typedef UINT32 ACPI_IO_ADDRESS;
204 typedef UINT32 ACPI_PHYSICAL_ADDRESS;
206 #define ACPI_MAX_PTR ACPI_UINT32_MAX
207 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
211 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
213 #error unknown ACPI_MACHINE_WIDTH
217 /*******************************************************************************
221 * If the defaults below are not appropriate for the host system, they can
222 * be defined in the OS-specific header, and this will take precedence.
224 ******************************************************************************/
226 /* Flags for AcpiOsAcquireLock/AcpiOsReleaseLock */
228 #ifndef ACPI_CPU_FLAGS
229 #define ACPI_CPU_FLAGS ACPI_SIZE
232 /* Object returned from AcpiOsCreateCache */
235 #ifdef ACPI_USE_LOCAL_CACHE
236 #define ACPI_CACHE_T ACPI_MEMORY_LIST
238 #define ACPI_CACHE_T void *
243 * Synchronization objects - Mutexes, Semaphores, and SpinLocks
245 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
247 * These macros are used if the host OS does not support a mutex object.
248 * Map the OSL Mutex interfaces to binary semaphores.
250 #define ACPI_MUTEX ACPI_SEMAPHORE
251 #define AcpiOsCreateMutex(OutHandle) AcpiOsCreateSemaphore (1, 1, OutHandle)
252 #define AcpiOsDeleteMutex(Handle) (void) AcpiOsDeleteSemaphore (Handle)
253 #define AcpiOsAcquireMutex(Handle,Time) AcpiOsWaitSemaphore (Handle, 1, Time)
254 #define AcpiOsReleaseMutex(Handle) (void) AcpiOsSignalSemaphore (Handle, 1)
257 /* Configurable types for synchronization objects */
259 #ifndef ACPI_SPINLOCK
260 #define ACPI_SPINLOCK void *
263 #ifndef ACPI_SEMAPHORE
264 #define ACPI_SEMAPHORE void *
268 #define ACPI_MUTEX void *
272 /*******************************************************************************
274 * Compiler-dependent types
276 * If the defaults below are not appropriate for the host compiler, they can
277 * be defined in the compiler-specific header, and this will take precedence.
279 ******************************************************************************/
281 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
283 #ifndef ACPI_UINTPTR_T
284 #define ACPI_UINTPTR_T void *
288 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
289 * some compilers can catch printf format string problems
291 #ifndef ACPI_PRINTF_LIKE
292 #define ACPI_PRINTF_LIKE(c)
296 * Some compilers complain about unused variables. Sometimes we don't want to
297 * use all the variables (for example, _AcpiModuleName). This allows us
298 * to tell the compiler in a per-variable manner that a variable
301 #ifndef ACPI_UNUSED_VAR
302 #define ACPI_UNUSED_VAR
306 * All ACPICA functions that are available to the rest of the kernel are
307 * tagged with this macro which can be defined as appropriate for the host.
309 #ifndef ACPI_EXPORT_SYMBOL
310 #define ACPI_EXPORT_SYMBOL(Symbol)
314 * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
317 #ifndef ACPI_DEBUG_INITIALIZE
318 #define ACPI_DEBUG_INITIALIZE()
322 /******************************************************************************
324 * ACPI Specification constants (Do not change unless the specification changes)
326 *****************************************************************************/
328 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
330 #define ACPI_MAX_GPE_BLOCKS 2
332 /* Default ACPI register widths */
334 #define ACPI_GPE_REGISTER_WIDTH 8
335 #define ACPI_PM1_REGISTER_WIDTH 16
336 #define ACPI_PM2_REGISTER_WIDTH 8
337 #define ACPI_PM_TIMER_WIDTH 32
339 /* Names within the namespace are 4 bytes long */
341 #define ACPI_NAME_SIZE 4
342 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
343 #define ACPI_PATH_SEPARATOR '.'
345 /* Sizes for ACPI table headers */
347 #define ACPI_OEM_ID_SIZE 6
348 #define ACPI_OEM_TABLE_ID_SIZE 8
350 /* ACPI/PNP hardware IDs */
352 #define PCI_ROOT_HID_STRING "PNP0A03"
353 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
355 /* PM Timer ticks per second (HZ) */
357 #define ACPI_PM_TIMER_FREQUENCY 3579545
360 /*******************************************************************************
364 ******************************************************************************/
366 /* Logical defines and NULL */
371 #define FALSE (1 == 0)
376 #define TRUE (1 == 1)
379 #define NULL (void *) 0
384 * Miscellaneous types
386 typedef UINT32 ACPI_STATUS; /* All ACPI Exceptions */
387 typedef UINT32 ACPI_NAME; /* 4-byte ACPI name */
388 typedef char * ACPI_STRING; /* Null terminated ASCII string */
389 typedef void * ACPI_HANDLE; /* Actually a ptr to a NS Node */
392 /* Time constants for timer calculations */
394 #define ACPI_MSEC_PER_SEC 1000L
396 #define ACPI_USEC_PER_MSEC 1000L
397 #define ACPI_USEC_PER_SEC 1000000L
399 #define ACPI_100NSEC_PER_USEC 10L
400 #define ACPI_100NSEC_PER_MSEC 10000L
401 #define ACPI_100NSEC_PER_SEC 10000000L
403 #define ACPI_NSEC_PER_USEC 1000L
404 #define ACPI_NSEC_PER_MSEC 1000000L
405 #define ACPI_NSEC_PER_SEC 1000000000L
408 /* Owner IDs are used to track namespace nodes for selective deletion */
410 typedef UINT8 ACPI_OWNER_ID;
411 #define ACPI_OWNER_ID_MAX 0xFF
414 #define ACPI_INTEGER_BIT_SIZE 64
415 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
416 #define ACPI_MAX64_DECIMAL_DIGITS 20
417 #define ACPI_MAX32_DECIMAL_DIGITS 10
418 #define ACPI_MAX16_DECIMAL_DIGITS 5
419 #define ACPI_MAX8_DECIMAL_DIGITS 3
422 * Constants with special meanings
424 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (ACPI_HANDLE, NULL, ACPI_MAX_PTR)
425 #define ACPI_WAIT_FOREVER 0xFFFF /* UINT16, as per ACPI spec */
426 #define ACPI_DO_NOT_WAIT 0
429 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
430 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
431 * pertains to the ACPI integer type only, not to other integers used in the
432 * implementation of the ACPICA subsystem.
434 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
435 * code base. It remains here for compatibility with device drivers that use
436 * the type. However, it will be removed in the future.
438 typedef UINT64 ACPI_INTEGER;
439 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
442 /*******************************************************************************
444 * Commonly used macros
446 ******************************************************************************/
448 /* Data manipulation */
450 #define ACPI_LOBYTE(Integer) ((UINT8) (UINT16)(Integer))
451 #define ACPI_HIBYTE(Integer) ((UINT8) (((UINT16)(Integer)) >> 8))
452 #define ACPI_LOWORD(Integer) ((UINT16) (UINT32)(Integer))
453 #define ACPI_HIWORD(Integer) ((UINT16)(((UINT32)(Integer)) >> 16))
454 #define ACPI_LODWORD(Integer64) ((UINT32) (UINT64)(Integer64))
455 #define ACPI_HIDWORD(Integer64) ((UINT32)(((UINT64)(Integer64)) >> 32))
457 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
458 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
459 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
460 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
462 /* Size calculation */
464 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
466 /* Pointer manipulation */
468 #define ACPI_CAST_PTR(t, p) ((t *) (ACPI_UINTPTR_T) (p))
469 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (ACPI_UINTPTR_T) (p))
470 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (UINT8, (a)) + (ACPI_SIZE)(b)))
471 #define ACPI_PTR_DIFF(a, b) (ACPI_SIZE) (ACPI_CAST_PTR (UINT8, (a)) - ACPI_CAST_PTR (UINT8, (b)))
473 /* Pointer/Integer type conversions */
475 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(ACPI_SIZE) i)
476 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
477 #define ACPI_OFFSET(d, f) (ACPI_SIZE) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
478 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
479 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
481 /* Optimizations for 4-character (32-bit) ACPI_NAME manipulation */
483 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
484 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (UINT32, (a)) == *ACPI_CAST_PTR (UINT32, (b)))
485 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (UINT32, (dest)) = *ACPI_CAST_PTR (UINT32, (src)))
487 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
488 #define ACPI_MOVE_NAME(dest,src) (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
491 /* Support for the special RSDP signature (8 characters) */
493 #define ACPI_VALIDATE_RSDP_SIG(a) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
494 #define ACPI_MAKE_RSDP_SIG(dest) (ACPI_MEMCPY (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
497 /*******************************************************************************
499 * Miscellaneous constants
501 ******************************************************************************/
504 * Initialization sequence
506 #define ACPI_FULL_INITIALIZATION 0x00
507 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
508 #define ACPI_NO_HARDWARE_INIT 0x02
509 #define ACPI_NO_EVENT_INIT 0x04
510 #define ACPI_NO_HANDLER_INIT 0x08
511 #define ACPI_NO_ACPI_ENABLE 0x10
512 #define ACPI_NO_DEVICE_INIT 0x20
513 #define ACPI_NO_OBJECT_INIT 0x40
516 * Initialization state
518 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
519 #define ACPI_INITIALIZED_OK 0x02
524 #define ACPI_STATE_UNKNOWN (UINT8) 0xFF
526 #define ACPI_STATE_S0 (UINT8) 0
527 #define ACPI_STATE_S1 (UINT8) 1
528 #define ACPI_STATE_S2 (UINT8) 2
529 #define ACPI_STATE_S3 (UINT8) 3
530 #define ACPI_STATE_S4 (UINT8) 4
531 #define ACPI_STATE_S5 (UINT8) 5
532 #define ACPI_S_STATES_MAX ACPI_STATE_S5
533 #define ACPI_S_STATE_COUNT 6
535 #define ACPI_STATE_D0 (UINT8) 0
536 #define ACPI_STATE_D1 (UINT8) 1
537 #define ACPI_STATE_D2 (UINT8) 2
538 #define ACPI_STATE_D3 (UINT8) 3
539 #define ACPI_D_STATES_MAX ACPI_STATE_D3
540 #define ACPI_D_STATE_COUNT 4
542 #define ACPI_STATE_C0 (UINT8) 0
543 #define ACPI_STATE_C1 (UINT8) 1
544 #define ACPI_STATE_C2 (UINT8) 2
545 #define ACPI_STATE_C3 (UINT8) 3
546 #define ACPI_C_STATES_MAX ACPI_STATE_C3
547 #define ACPI_C_STATE_COUNT 4
550 * Sleep type invalid value
552 #define ACPI_SLEEP_TYPE_MAX 0x7
553 #define ACPI_SLEEP_TYPE_INVALID 0xFF
556 * Standard notify values
558 #define ACPI_NOTIFY_BUS_CHECK (UINT8) 0x00
559 #define ACPI_NOTIFY_DEVICE_CHECK (UINT8) 0x01
560 #define ACPI_NOTIFY_DEVICE_WAKE (UINT8) 0x02
561 #define ACPI_NOTIFY_EJECT_REQUEST (UINT8) 0x03
562 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (UINT8) 0x04
563 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (UINT8) 0x05
564 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (UINT8) 0x06
565 #define ACPI_NOTIFY_POWER_FAULT (UINT8) 0x07
566 #define ACPI_NOTIFY_CAPABILITIES_CHECK (UINT8) 0x08
567 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (UINT8) 0x09
568 #define ACPI_NOTIFY_RESERVED (UINT8) 0x0A
569 #define ACPI_NOTIFY_LOCALITY_UPDATE (UINT8) 0x0B
570 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (UINT8) 0x0C
572 #define ACPI_NOTIFY_MAX 0x0C
575 * Types associated with ACPI names and objects. The first group of
576 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
577 * of the ACPI ObjectType() operator (See the ACPI Spec). Therefore,
578 * only add to the first group if the spec changes.
580 * NOTE: Types must be kept in sync with the global AcpiNsProperties
581 * and AcpiNsTypeNames arrays.
583 typedef UINT32 ACPI_OBJECT_TYPE;
585 #define ACPI_TYPE_ANY 0x00
586 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
587 #define ACPI_TYPE_STRING 0x02
588 #define ACPI_TYPE_BUFFER 0x03
589 #define ACPI_TYPE_PACKAGE 0x04 /* ByteConst, multiple DataTerm/Constant/SuperName */
590 #define ACPI_TYPE_FIELD_UNIT 0x05
591 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
592 #define ACPI_TYPE_EVENT 0x07
593 #define ACPI_TYPE_METHOD 0x08 /* Name, ByteConst, multiple Code */
594 #define ACPI_TYPE_MUTEX 0x09
595 #define ACPI_TYPE_REGION 0x0A
596 #define ACPI_TYPE_POWER 0x0B /* Name,ByteConst,WordConst,multi Node */
597 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
598 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
599 #define ACPI_TYPE_BUFFER_FIELD 0x0E
600 #define ACPI_TYPE_DDB_HANDLE 0x0F
601 #define ACPI_TYPE_DEBUG_OBJECT 0x10
603 #define ACPI_TYPE_EXTERNAL_MAX 0x10
606 * These are object types that do not map directly to the ACPI
607 * ObjectType() operator. They are used for various internal purposes only.
608 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
609 * internal types must move upwards. (There is code that depends on these
610 * values being contiguous with the external types above.)
612 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
613 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
614 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
615 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, RefOf, Index */
616 #define ACPI_TYPE_LOCAL_ALIAS 0x15
617 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
618 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
619 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
620 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
621 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
622 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple ObjectList Nodes */
624 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
627 * These are special object types that never appear in
628 * a Namespace node, only in an object of ACPI_OPERAND_OBJECT
630 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
631 #define ACPI_TYPE_LOCAL_DATA 0x1D
633 #define ACPI_TYPE_LOCAL_MAX 0x1D
635 /* All types above here are invalid */
637 #define ACPI_TYPE_INVALID 0x1E
638 #define ACPI_TYPE_NOT_FOUND 0xFF
640 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
648 #define ACPI_IO_MASK 1
651 * Event Types: Fixed & General Purpose
653 typedef UINT32 ACPI_EVENT_TYPE;
658 #define ACPI_EVENT_PMTIMER 0
659 #define ACPI_EVENT_GLOBAL 1
660 #define ACPI_EVENT_POWER_BUTTON 2
661 #define ACPI_EVENT_SLEEP_BUTTON 3
662 #define ACPI_EVENT_RTC 4
663 #define ACPI_EVENT_MAX 4
664 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
667 * Event Status - Per event
669 * The encoding of ACPI_EVENT_STATUS is illustrated below.
670 * Note that a set bit (1) indicates the property is TRUE
671 * (e.g. if bit 0 is set then the event is enabled).
672 * +-------------+-+-+-+
673 * | Bits 31:3 |2|1|0|
674 * +-------------+-+-+-+
677 * | | +--- Enabled for wake?
679 * +----------- <Reserved>
681 typedef UINT32 ACPI_EVENT_STATUS;
683 #define ACPI_EVENT_FLAG_DISABLED (ACPI_EVENT_STATUS) 0x00
684 #define ACPI_EVENT_FLAG_ENABLED (ACPI_EVENT_STATUS) 0x01
685 #define ACPI_EVENT_FLAG_WAKE_ENABLED (ACPI_EVENT_STATUS) 0x02
686 #define ACPI_EVENT_FLAG_SET (ACPI_EVENT_STATUS) 0x04
688 /* Actions for AcpiSetGpe, AcpiGpeWakeup, AcpiHwLowSetGpe */
690 #define ACPI_GPE_ENABLE 0
691 #define ACPI_GPE_DISABLE 1
692 #define ACPI_GPE_CONDITIONAL_ENABLE 2
695 * GPE info flags - Per GPE
700 * | | | +-- Type of dispatch:to method, handler, notify, or none
701 * | | +----- Interrupt type: edge or level triggered
702 * | +------- Is a Wake GPE
703 * +------------ <Reserved>
705 #define ACPI_GPE_DISPATCH_NONE (UINT8) 0x00
706 #define ACPI_GPE_DISPATCH_METHOD (UINT8) 0x01
707 #define ACPI_GPE_DISPATCH_HANDLER (UINT8) 0x02
708 #define ACPI_GPE_DISPATCH_NOTIFY (UINT8) 0x03
709 #define ACPI_GPE_DISPATCH_MASK (UINT8) 0x03
711 #define ACPI_GPE_LEVEL_TRIGGERED (UINT8) 0x04
712 #define ACPI_GPE_EDGE_TRIGGERED (UINT8) 0x00
713 #define ACPI_GPE_XRUPT_TYPE_MASK (UINT8) 0x04
715 #define ACPI_GPE_CAN_WAKE (UINT8) 0x08
718 * Flags for GPE and Lock interfaces
720 #define ACPI_NOT_ISR 0x1
726 #define ACPI_SYSTEM_NOTIFY 0x1
727 #define ACPI_DEVICE_NOTIFY 0x2
728 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
729 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
730 #define ACPI_NUM_NOTIFY_TYPES 2
732 #define ACPI_MAX_SYS_NOTIFY 0x7F
733 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
735 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
736 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
739 /* Address Space (Operation Region) Types */
741 typedef UINT8 ACPI_ADR_SPACE_TYPE;
743 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (ACPI_ADR_SPACE_TYPE) 0
744 #define ACPI_ADR_SPACE_SYSTEM_IO (ACPI_ADR_SPACE_TYPE) 1
745 #define ACPI_ADR_SPACE_PCI_CONFIG (ACPI_ADR_SPACE_TYPE) 2
746 #define ACPI_ADR_SPACE_EC (ACPI_ADR_SPACE_TYPE) 3
747 #define ACPI_ADR_SPACE_SMBUS (ACPI_ADR_SPACE_TYPE) 4
748 #define ACPI_ADR_SPACE_CMOS (ACPI_ADR_SPACE_TYPE) 5
749 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (ACPI_ADR_SPACE_TYPE) 6
750 #define ACPI_ADR_SPACE_IPMI (ACPI_ADR_SPACE_TYPE) 7
751 #define ACPI_ADR_SPACE_GPIO (ACPI_ADR_SPACE_TYPE) 8
752 #define ACPI_ADR_SPACE_GSBUS (ACPI_ADR_SPACE_TYPE) 9
753 #define ACPI_ADR_SPACE_PLATFORM_COMM (ACPI_ADR_SPACE_TYPE) 10
755 #define ACPI_NUM_PREDEFINED_REGIONS 11
758 * Special Address Spaces
760 * Note: A Data Table region is a special type of operation region
761 * that has its own AML opcode. However, internally, the AML
762 * interpreter simply creates an operation region with an an address
763 * space type of ACPI_ADR_SPACE_DATA_TABLE.
765 #define ACPI_ADR_SPACE_DATA_TABLE (ACPI_ADR_SPACE_TYPE) 0x7E /* Internal to ACPICA only */
766 #define ACPI_ADR_SPACE_FIXED_HARDWARE (ACPI_ADR_SPACE_TYPE) 0x7F
768 /* Values for _REG connection code */
770 #define ACPI_REG_DISCONNECT 0
771 #define ACPI_REG_CONNECT 1
776 * These values are intended to be used by the hardware interfaces
777 * and are mapped to individual bitfields defined within the ACPI
778 * registers. See the AcpiGbl_BitRegisterInfo global table in utglobal.c
782 /* PM1 Status register */
784 #define ACPI_BITREG_TIMER_STATUS 0x00
785 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
786 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
787 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
788 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
789 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
790 #define ACPI_BITREG_WAKE_STATUS 0x06
791 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
793 /* PM1 Enable register */
795 #define ACPI_BITREG_TIMER_ENABLE 0x08
796 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
797 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
798 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
799 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
800 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
802 /* PM1 Control register */
804 #define ACPI_BITREG_SCI_ENABLE 0x0E
805 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
806 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
807 #define ACPI_BITREG_SLEEP_TYPE 0x11
808 #define ACPI_BITREG_SLEEP_ENABLE 0x12
810 /* PM2 Control register */
812 #define ACPI_BITREG_ARB_DISABLE 0x13
814 #define ACPI_BITREG_MAX 0x13
815 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
818 /* Status register values. A 1 clears a status bit. 0 = no effect */
820 #define ACPI_CLEAR_STATUS 1
822 /* Enable and Control register values */
824 #define ACPI_ENABLE_EVENT 1
825 #define ACPI_DISABLE_EVENT 0
828 /* Sleep function dispatch */
830 typedef ACPI_STATUS (*ACPI_SLEEP_FUNCTION) (
833 typedef struct acpi_sleep_functions
835 ACPI_SLEEP_FUNCTION LegacyFunction;
836 ACPI_SLEEP_FUNCTION ExtendedFunction;
838 } ACPI_SLEEP_FUNCTIONS;
842 * External ACPI object definition
846 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
847 * or an unresolved named reference.
849 typedef union acpi_object
851 ACPI_OBJECT_TYPE Type; /* See definition of AcpiNsType for values */
854 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_INTEGER */
855 UINT64 Value; /* The actual number */
860 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_STRING */
861 UINT32 Length; /* # of bytes in string, excluding trailing null */
862 char *Pointer; /* points to the string value */
867 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_BUFFER */
868 UINT32 Length; /* # of bytes in buffer */
869 UINT8 *Pointer; /* points to the buffer */
874 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PACKAGE */
875 UINT32 Count; /* # of elements in package */
876 union acpi_object *Elements; /* Pointer to an array of ACPI_OBJECTs */
881 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_LOCAL_REFERENCE */
882 ACPI_OBJECT_TYPE ActualType; /* Type associated with the Handle */
883 ACPI_HANDLE Handle; /* object reference */
888 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_PROCESSOR */
890 ACPI_IO_ADDRESS PblkAddress;
896 ACPI_OBJECT_TYPE Type; /* ACPI_TYPE_POWER */
898 UINT32 ResourceOrder;
905 * List of objects, used as a parameter list for control method evaluation
907 typedef struct acpi_object_list
910 ACPI_OBJECT *Pointer;
916 * Miscellaneous common Data Structures used by the interfaces
918 #define ACPI_NO_BUFFER 0
919 #define ACPI_ALLOCATE_BUFFER (ACPI_SIZE) (-1)
920 #define ACPI_ALLOCATE_LOCAL_BUFFER (ACPI_SIZE) (-2)
922 typedef struct acpi_buffer
924 ACPI_SIZE Length; /* Length in bytes of the buffer */
925 void *Pointer; /* pointer to buffer */
929 /* Free a buffer created in an ACPI_BUFFER via ACPI_ALLOCATE_LOCAL_BUFFER */
931 #define ACPI_FREE_BUFFER(b) ACPI_FREE(b.Pointer)
935 * NameType for AcpiGetName
937 #define ACPI_FULL_PATHNAME 0
938 #define ACPI_SINGLE_NAME 1
939 #define ACPI_NAME_TYPE_MAX 1
943 * Predefined Namespace items
945 typedef struct acpi_predefined_names
951 } ACPI_PREDEFINED_NAMES;
955 * Structure and flags for AcpiGetSystemInfo
957 #define ACPI_SYS_MODE_UNKNOWN 0x0000
958 #define ACPI_SYS_MODE_ACPI 0x0001
959 #define ACPI_SYS_MODE_LEGACY 0x0002
960 #define ACPI_SYS_MODES_MASK 0x0003
964 * System info returned by AcpiGetSystemInfo()
966 typedef struct acpi_system_info
968 UINT32 AcpiCaVersion;
970 UINT32 TimerResolution;
980 * System statistics returned by AcpiGetStatistics()
982 typedef struct acpi_statistics
986 UINT32 FixedEventCount[ACPI_NUM_FIXED_EVENTS];
992 /* Table Event Types */
994 #define ACPI_TABLE_EVENT_LOAD 0x0
995 #define ACPI_TABLE_EVENT_UNLOAD 0x1
996 #define ACPI_NUM_TABLE_EVENTS 2
1000 * Types specific to the OS service interfaces
1003 (ACPI_SYSTEM_XFACE *ACPI_OSD_HANDLER) (
1007 (ACPI_SYSTEM_XFACE *ACPI_OSD_EXEC_CALLBACK) (
1011 * Various handlers and callback procedures
1014 UINT32 (*ACPI_SCI_HANDLER) (
1018 void (*ACPI_GBL_EVENT_HANDLER) (
1024 #define ACPI_EVENT_TYPE_GPE 0
1025 #define ACPI_EVENT_TYPE_FIXED 1
1028 UINT32 (*ACPI_EVENT_HANDLER) (
1032 UINT32 (*ACPI_GPE_HANDLER) (
1033 ACPI_HANDLE GpeDevice,
1038 void (*ACPI_NOTIFY_HANDLER) (
1044 void (*ACPI_OBJECT_HANDLER) (
1049 ACPI_STATUS (*ACPI_INIT_HANDLER) (
1053 #define ACPI_INIT_DEVICE_INI 1
1056 ACPI_STATUS (*ACPI_EXCEPTION_HANDLER) (
1057 ACPI_STATUS AmlStatus,
1063 /* Table Event handler (Load, LoadTable, etc.) and types */
1066 ACPI_STATUS (*ACPI_TABLE_HANDLER) (
1071 #define ACPI_TABLE_LOAD 0x0
1072 #define ACPI_TABLE_UNLOAD 0x1
1073 #define ACPI_NUM_TABLE_EVENTS 2
1076 /* Address Spaces (For Operation Regions) */
1079 ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
1081 ACPI_PHYSICAL_ADDRESS Address,
1084 void *HandlerContext,
1085 void *RegionContext);
1087 #define ACPI_DEFAULT_HANDLER NULL
1089 /* Special Context data for GenericSerialBus/GeneralPurposeIo (ACPI 5.0) */
1091 typedef struct acpi_connection_info
1097 } ACPI_CONNECTION_INFO;
1101 ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
1102 ACPI_HANDLE RegionHandle,
1104 void *HandlerContext,
1105 void **RegionContext);
1107 #define ACPI_REGION_ACTIVATE 0
1108 #define ACPI_REGION_DEACTIVATE 1
1111 ACPI_STATUS (*ACPI_WALK_CALLBACK) (
1113 UINT32 NestingLevel,
1115 void **ReturnValue);
1118 UINT32 (*ACPI_INTERFACE_HANDLER) (
1119 ACPI_STRING InterfaceName,
1123 /* Interrupt handler return values */
1125 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
1126 #define ACPI_INTERRUPT_HANDLED 0x01
1128 /* GPE handler return values */
1130 #define ACPI_REENABLE_GPE 0x80
1133 /* Length of 32-bit EISAID values when converted back to a string */
1135 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1137 /* Length of UUID (string) values */
1139 #define ACPI_UUID_LENGTH 16
1142 /* Structures used for device/processor HID, UID, CID, and SUB */
1144 typedef struct acpi_pnp_device_id
1146 UINT32 Length; /* Length of string + null */
1149 } ACPI_PNP_DEVICE_ID;
1151 typedef struct acpi_pnp_device_id_list
1153 UINT32 Count; /* Number of IDs in Ids array */
1154 UINT32 ListSize; /* Size of list, including ID strings */
1155 ACPI_PNP_DEVICE_ID Ids[1]; /* ID array */
1157 } ACPI_PNP_DEVICE_ID_LIST;
1160 * Structure returned from AcpiGetObjectInfo.
1161 * Optimized for both 32- and 64-bit builds
1163 typedef struct acpi_device_info
1165 UINT32 InfoSize; /* Size of info, including ID strings */
1166 UINT32 Name; /* ACPI object Name */
1167 ACPI_OBJECT_TYPE Type; /* ACPI object Type */
1168 UINT8 ParamCount; /* If a method, required parameter count */
1169 UINT8 Valid; /* Indicates which optional fields are valid */
1170 UINT8 Flags; /* Miscellaneous info */
1171 UINT8 HighestDstates[4]; /* _SxD values: 0xFF indicates not valid */
1172 UINT8 LowestDstates[5]; /* _SxW values: 0xFF indicates not valid */
1173 UINT32 CurrentStatus; /* _STA value */
1174 UINT64 Address; /* _ADR value */
1175 ACPI_PNP_DEVICE_ID HardwareId; /* _HID value */
1176 ACPI_PNP_DEVICE_ID UniqueId; /* _UID value */
1177 ACPI_PNP_DEVICE_ID SubsystemId; /* _SUB value */
1178 ACPI_PNP_DEVICE_ID_LIST CompatibleIdList; /* _CID list <must be last> */
1182 /* Values for Flags field above (AcpiGetObjectInfo) */
1184 #define ACPI_PCI_ROOT_BRIDGE 0x01
1186 /* Flags for Valid field above (AcpiGetObjectInfo) */
1188 #define ACPI_VALID_STA 0x01
1189 #define ACPI_VALID_ADR 0x02
1190 #define ACPI_VALID_HID 0x04
1191 #define ACPI_VALID_UID 0x08
1192 #define ACPI_VALID_SUB 0x10
1193 #define ACPI_VALID_CID 0x20
1194 #define ACPI_VALID_SXDS 0x40
1195 #define ACPI_VALID_SXWS 0x80
1197 /* Flags for _STA return value (CurrentStatus above) */
1199 #define ACPI_STA_DEVICE_PRESENT 0x01
1200 #define ACPI_STA_DEVICE_ENABLED 0x02
1201 #define ACPI_STA_DEVICE_UI 0x04
1202 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1203 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1204 #define ACPI_STA_BATTERY_PRESENT 0x10
1207 /* Context structs for address space handlers */
1209 typedef struct acpi_pci_id
1218 typedef struct acpi_mem_space_context
1221 ACPI_PHYSICAL_ADDRESS Address;
1222 ACPI_PHYSICAL_ADDRESS MappedPhysicalAddress;
1223 UINT8 *MappedLogicalAddress;
1224 ACPI_SIZE MappedLength;
1226 } ACPI_MEM_SPACE_CONTEXT;
1230 * ACPI_MEMORY_LIST is used only if the ACPICA local cache is enabled
1232 typedef struct acpi_memory_list
1238 UINT16 CurrentDepth;
1240 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1242 /* Statistics for debug memory tracking only */
1244 UINT32 TotalAllocated;
1248 UINT32 CurrentTotalSize;
1256 /* Definitions of _OSI support */
1258 #define ACPI_VENDOR_STRINGS 0x01
1259 #define ACPI_FEATURE_STRINGS 0x02
1260 #define ACPI_ENABLE_INTERFACES 0x00
1261 #define ACPI_DISABLE_INTERFACES 0x04
1263 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1264 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1265 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1266 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1267 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1268 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1270 #define ACPI_OSI_WIN_2000 0x01
1271 #define ACPI_OSI_WIN_XP 0x02
1272 #define ACPI_OSI_WIN_XP_SP1 0x03
1273 #define ACPI_OSI_WINSRV_2003 0x04
1274 #define ACPI_OSI_WIN_XP_SP2 0x05
1275 #define ACPI_OSI_WINSRV_2003_SP1 0x06
1276 #define ACPI_OSI_WIN_VISTA 0x07
1277 #define ACPI_OSI_WINSRV_2008 0x08
1278 #define ACPI_OSI_WIN_VISTA_SP1 0x09
1279 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
1280 #define ACPI_OSI_WIN_7 0x0B
1281 #define ACPI_OSI_WIN_8 0x0C
1284 #endif /* __ACTYPES_H__ */