1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Name: actypes.h - Common data types for the entire ACPI subsystem
6 * Copyright (C) 2000 - 2018, Intel Corp.
8 *****************************************************************************/
13 /* acpisrc:struct_defs -- for acpisrc conversion */
16 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
17 * header and must be either 32 or 64. 16-bit ACPICA is no longer
18 * supported, as of 12/2006.
20 #ifndef ACPI_MACHINE_WIDTH
21 #error ACPI_MACHINE_WIDTH not defined
26 * Note: These macros are designed to be compiler independent as well as
27 * working around problems that some 32-bit compilers have with 64-bit
30 #define ACPI_UINT8_MAX (u8) (~((u8) 0)) /* 0xFF */
31 #define ACPI_UINT16_MAX (u16)(~((u16) 0)) /* 0xFFFF */
32 #define ACPI_UINT32_MAX (u32)(~((u32) 0)) /* 0xFFFFFFFF */
33 #define ACPI_UINT64_MAX (u64)(~((u64) 0)) /* 0xFFFFFFFFFFFFFFFF */
34 #define ACPI_ASCII_MAX 0x7F
37 * Architecture-specific ACPICA Subsystem Data Types
39 * The goal of these types is to provide source code portability across
40 * 16-bit, 32-bit, and 64-bit targets.
42 * 1) The following types are of fixed size for all targets (16/32/64):
46 * u8 8-bit (1 byte) unsigned value
47 * u16 16-bit (2 byte) unsigned value
48 * u32 32-bit (4 byte) unsigned value
49 * u64 64-bit (8 byte) unsigned value
51 * s16 16-bit (2 byte) signed value
52 * s32 32-bit (4 byte) signed value
53 * s64 64-bit (8 byte) signed value
55 * COMPILER_DEPENDENT_UINT64/s64 - These types are defined in the
56 * compiler-dependent header(s) and were introduced because there is no
57 * common 64-bit integer type across the various compilation models, as
58 * shown in the table below.
60 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
62 * short 16 16 16 16 16 16
64 * int 32 64 32 32 16 16
65 * long 64 64 32 32 32 32
67 * pointer 64 64 64 32 32 32
69 * Note: ILP64 and LP32 are currently not supported.
72 * 2) These types represent the native word size of the target mode of the
73 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
74 * usually used for memory allocation, efficient loop counters, and array
75 * indexes. The types are similar to the size_t type in the C library and
76 * are required because there is no C type that consistently represents the
77 * native data width. acpi_size is needed because there is no guarantee
78 * that a kernel-level C library is present.
80 * acpi_size 16/32/64-bit unsigned value
81 * acpi_native_int 16/32/64-bit signed value
84 /*******************************************************************************
86 * Common types for all compilers, all targets
88 ******************************************************************************/
90 #ifndef ACPI_USE_SYSTEM_INTTYPES
92 typedef unsigned char u8;
93 typedef unsigned short u16;
95 typedef COMPILER_DEPENDENT_UINT64 u64;
96 typedef COMPILER_DEPENDENT_INT64 s64;
98 #endif /* ACPI_USE_SYSTEM_INTTYPES */
101 * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
102 * across operating systems or even the various UNIX systems. Since ACPICA
103 * only needs the thread ID as a unique thread identifier, we use a u64
104 * as the only common data type - it will accommodate any type of pointer or
105 * any type of integer. It is up to the host-dependent OSL to cast the
106 * native thread ID type to a u64 (in acpi_os_get_thread_id).
108 #define acpi_thread_id u64
110 /*******************************************************************************
112 * Types specific to 64-bit targets
114 ******************************************************************************/
116 #if ACPI_MACHINE_WIDTH == 64
118 #ifndef ACPI_USE_SYSTEM_INTTYPES
120 typedef unsigned int u32;
123 #endif /* ACPI_USE_SYSTEM_INTTYPES */
125 typedef s64 acpi_native_int;
127 typedef u64 acpi_size;
128 typedef u64 acpi_io_address;
129 typedef u64 acpi_physical_address;
131 #define ACPI_MAX_PTR ACPI_UINT64_MAX
132 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
134 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
135 #define ACPI_USE_NATIVE_MATH64 /* Has native 64-bit integer support */
138 * In the case of the Itanium Processor Family (IPF), the hardware does not
139 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
140 * flag to indicate that special precautions must be taken to avoid alignment
141 * faults. (IA64 or ia64 is currently used by existing compilers to indicate
144 * Note: EM64T and other X86-64 processors support misaligned transfers,
145 * so there is no need to define this flag.
147 #if defined (__IA64__) || defined (__ia64__)
148 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
151 /*******************************************************************************
153 * Types specific to 32-bit targets
155 ******************************************************************************/
157 #elif ACPI_MACHINE_WIDTH == 32
159 #ifndef ACPI_USE_SYSTEM_INTTYPES
161 typedef unsigned int u32;
164 #endif /* ACPI_USE_SYSTEM_INTTYPES */
166 typedef s32 acpi_native_int;
168 typedef u32 acpi_size;
170 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
173 * OSPMs can define this to shrink the size of the structures for 32-bit
174 * none PAE environment. ASL compiler may always define this to generate
175 * 32-bit OSPM compliant tables.
177 typedef u32 acpi_io_address;
178 typedef u32 acpi_physical_address;
180 #else /* ACPI_32BIT_PHYSICAL_ADDRESS */
183 * It is reported that, after some calculations, the physical addresses can
184 * wrap over the 32-bit boundary on 32-bit PAE environment.
185 * https://bugzilla.kernel.org/show_bug.cgi?id=87971
187 typedef u64 acpi_io_address;
188 typedef u64 acpi_physical_address;
190 #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */
192 #define ACPI_MAX_PTR ACPI_UINT32_MAX
193 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
197 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
199 #error unknown ACPI_MACHINE_WIDTH
202 /*******************************************************************************
206 * If the defaults below are not appropriate for the host system, they can
207 * be defined in the OS-specific header, and this will take precedence.
209 ******************************************************************************/
211 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
213 #ifndef acpi_cpu_flags
214 #define acpi_cpu_flags acpi_size
217 /* Object returned from acpi_os_create_cache */
220 #ifdef ACPI_USE_LOCAL_CACHE
221 #define acpi_cache_t struct acpi_memory_list
223 #define acpi_cache_t void *
228 * Synchronization objects - Mutexes, Semaphores, and spin_locks
230 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
232 * These macros are used if the host OS does not support a mutex object.
233 * Map the OSL Mutex interfaces to binary semaphores.
235 #define acpi_mutex acpi_semaphore
236 #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
237 #define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
238 #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
239 #define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
242 /* Configurable types for synchronization objects */
244 #ifndef acpi_spinlock
245 #define acpi_spinlock void *
248 #ifndef acpi_raw_spinlock
249 #define acpi_raw_spinlock acpi_spinlock
252 #ifndef acpi_semaphore
253 #define acpi_semaphore void *
257 #define acpi_mutex void *
260 /*******************************************************************************
262 * Compiler-dependent types
264 * If the defaults below are not appropriate for the host compiler, they can
265 * be defined in the compiler-specific header, and this will take precedence.
267 ******************************************************************************/
269 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
271 #ifndef acpi_uintptr_t
272 #define acpi_uintptr_t void *
276 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
277 * some compilers can catch printf format string problems
279 #ifndef ACPI_PRINTF_LIKE
280 #define ACPI_PRINTF_LIKE(c)
284 * Some compilers complain about unused variables. Sometimes we don't want
285 * to use all the variables (for example, _acpi_module_name). This allows us
286 * to tell the compiler in a per-variable manner that a variable
289 #ifndef ACPI_UNUSED_VAR
290 #define ACPI_UNUSED_VAR
294 * All ACPICA external functions that are available to the rest of the
295 * kernel are tagged with these macros which can be defined as appropriate
299 * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
300 * interfaces that may need special processing.
301 * ACPI_EXPORT_SYMBOL is used for all other public external functions.
303 #ifndef ACPI_EXPORT_SYMBOL_INIT
304 #define ACPI_EXPORT_SYMBOL_INIT(symbol)
307 #ifndef ACPI_EXPORT_SYMBOL
308 #define ACPI_EXPORT_SYMBOL(symbol)
312 * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
315 #ifndef ACPI_DEBUG_INITIALIZE
316 #define ACPI_DEBUG_INITIALIZE()
319 /*******************************************************************************
323 ******************************************************************************/
325 #ifdef ACPI_NO_MEM_ALLOCATIONS
327 #define ACPI_ALLOCATE(a) NULL
328 #define ACPI_ALLOCATE_ZEROED(a) NULL
330 #define ACPI_MEM_TRACKING(a)
332 #else /* ACPI_NO_MEM_ALLOCATIONS */
334 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
336 * Memory allocation tracking (used by acpi_exec to detect memory leaks)
338 #define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__
339 #define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
340 #define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
341 #define ACPI_FREE(a) acpi_ut_free_and_track (a, ACPI_MEM_PARAMETERS)
342 #define ACPI_MEM_TRACKING(a) a
346 * Normal memory allocation directly via the OS services layer
348 #define ACPI_ALLOCATE(a) acpi_os_allocate ((acpi_size) (a))
349 #define ACPI_ALLOCATE_ZEROED(a) acpi_os_allocate_zeroed ((acpi_size) (a))
350 #define ACPI_FREE(a) acpi_os_free (a)
351 #define ACPI_MEM_TRACKING(a)
353 #endif /* ACPI_DBG_TRACK_ALLOCATIONS */
355 #endif /* ACPI_NO_MEM_ALLOCATIONS */
357 /******************************************************************************
359 * ACPI Specification constants (Do not change unless the specification
362 *****************************************************************************/
364 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
366 #define ACPI_MAX_GPE_BLOCKS 2
368 /* Default ACPI register widths */
370 #define ACPI_GPE_REGISTER_WIDTH 8
371 #define ACPI_PM1_REGISTER_WIDTH 16
372 #define ACPI_PM2_REGISTER_WIDTH 8
373 #define ACPI_PM_TIMER_WIDTH 32
374 #define ACPI_RESET_REGISTER_WIDTH 8
376 /* Names within the namespace are 4 bytes long */
378 #define ACPI_NAME_SIZE 4
379 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
380 #define ACPI_PATH_SEPARATOR '.'
382 /* Sizes for ACPI table headers */
384 #define ACPI_OEM_ID_SIZE 6
385 #define ACPI_OEM_TABLE_ID_SIZE 8
387 /* ACPI/PNP hardware IDs */
389 #define PCI_ROOT_HID_STRING "PNP0A03"
390 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
392 /* PM Timer ticks per second (HZ) */
394 #define ACPI_PM_TIMER_FREQUENCY 3579545
396 /*******************************************************************************
400 ******************************************************************************/
402 /* Logical defines and NULL */
407 #define FALSE (1 == 0)
412 #define TRUE (1 == 1)
415 #define NULL (void *) 0
419 * Miscellaneous types
421 typedef u32 acpi_status; /* All ACPI Exceptions */
422 typedef u32 acpi_name; /* 4-byte ACPI name */
423 typedef char *acpi_string; /* Null terminated ASCII string */
424 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
426 /* Time constants for timer calculations */
428 #define ACPI_MSEC_PER_SEC 1000L
430 #define ACPI_USEC_PER_MSEC 1000L
431 #define ACPI_USEC_PER_SEC 1000000L
433 #define ACPI_100NSEC_PER_USEC 10L
434 #define ACPI_100NSEC_PER_MSEC 10000L
435 #define ACPI_100NSEC_PER_SEC 10000000L
437 #define ACPI_NSEC_PER_USEC 1000L
438 #define ACPI_NSEC_PER_MSEC 1000000L
439 #define ACPI_NSEC_PER_SEC 1000000000L
441 #define ACPI_TIME_AFTER(a, b) ((s64)((b) - (a)) < 0)
443 /* Owner IDs are used to track namespace nodes for selective deletion */
445 typedef u8 acpi_owner_id;
446 #define ACPI_OWNER_ID_MAX 0xFF
448 #define ACPI_INTEGER_BIT_SIZE 64
449 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
450 #define ACPI_MAX64_DECIMAL_DIGITS 20
451 #define ACPI_MAX32_DECIMAL_DIGITS 10
452 #define ACPI_MAX16_DECIMAL_DIGITS 5
453 #define ACPI_MAX8_DECIMAL_DIGITS 3
456 * Constants with special meanings
458 #define ACPI_ROOT_OBJECT ((acpi_handle) ACPI_TO_POINTER (ACPI_MAX_PTR))
459 #define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
460 #define ACPI_DO_NOT_WAIT 0
463 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
464 * 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
465 * Note that this pertains to the ACPI integer type only, not to other
466 * integers used in the implementation of the ACPICA subsystem.
468 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
469 * code base. It remains here for compatibility with device drivers that use
470 * the type. However, it will be removed in the future.
472 typedef u64 acpi_integer;
473 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
475 /*******************************************************************************
477 * Commonly used macros
479 ******************************************************************************/
481 /* Data manipulation */
483 #define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
484 #define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
485 #define ACPI_LOWORD(integer) ((u16) (u32)(integer))
486 #define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
487 #define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
488 #define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
490 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
491 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
492 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
493 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
495 /* Size calculation */
497 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
499 /* Pointer manipulation */
501 #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
502 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
503 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
504 #define ACPI_SUB_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) - (acpi_size)(b)))
505 #define ACPI_PTR_DIFF(a, b) ((acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b))))
507 /* Pointer/Integer type conversions */
509 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) 0, (acpi_size) (i))
510 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) 0)
511 #define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) 0)
512 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
513 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
515 /* Optimizations for 4-character (32-bit) acpi_name manipulation */
517 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
518 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
519 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
521 #define ACPI_COMPARE_NAME(a,b) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
522 #define ACPI_MOVE_NAME(dest,src) (strncpy (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
525 /* Support for the special RSDP signature (8 characters) */
527 #define ACPI_VALIDATE_RSDP_SIG(a) (!strncmp (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
528 #define ACPI_MAKE_RSDP_SIG(dest) (memcpy (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
531 * Algorithm to obtain access bit or byte width.
532 * Can be used with access_width of struct acpi_generic_address and access_size of
533 * struct acpi_resource_generic_register.
535 #define ACPI_ACCESS_BIT_WIDTH(size) (1 << ((size) + 2))
536 #define ACPI_ACCESS_BYTE_WIDTH(size) (1 << ((size) - 1))
538 /*******************************************************************************
540 * Miscellaneous constants
542 ******************************************************************************/
545 * Initialization sequence options
547 #define ACPI_FULL_INITIALIZATION 0x0000
548 #define ACPI_NO_FACS_INIT 0x0001
549 #define ACPI_NO_ACPI_ENABLE 0x0002
550 #define ACPI_NO_HARDWARE_INIT 0x0004
551 #define ACPI_NO_EVENT_INIT 0x0008
552 #define ACPI_NO_HANDLER_INIT 0x0010
553 #define ACPI_NO_OBJECT_INIT 0x0020
554 #define ACPI_NO_DEVICE_INIT 0x0040
555 #define ACPI_NO_ADDRESS_SPACE_INIT 0x0080
558 * Initialization state
560 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
561 #define ACPI_INITIALIZED_OK 0x02
566 #define ACPI_STATE_UNKNOWN (u8) 0xFF
568 #define ACPI_STATE_S0 (u8) 0
569 #define ACPI_STATE_S1 (u8) 1
570 #define ACPI_STATE_S2 (u8) 2
571 #define ACPI_STATE_S3 (u8) 3
572 #define ACPI_STATE_S4 (u8) 4
573 #define ACPI_STATE_S5 (u8) 5
574 #define ACPI_S_STATES_MAX ACPI_STATE_S5
575 #define ACPI_S_STATE_COUNT 6
577 #define ACPI_STATE_D0 (u8) 0
578 #define ACPI_STATE_D1 (u8) 1
579 #define ACPI_STATE_D2 (u8) 2
580 #define ACPI_STATE_D3_HOT (u8) 3
581 #define ACPI_STATE_D3 (u8) 4
582 #define ACPI_STATE_D3_COLD ACPI_STATE_D3
583 #define ACPI_D_STATES_MAX ACPI_STATE_D3
584 #define ACPI_D_STATE_COUNT 5
586 #define ACPI_STATE_C0 (u8) 0
587 #define ACPI_STATE_C1 (u8) 1
588 #define ACPI_STATE_C2 (u8) 2
589 #define ACPI_STATE_C3 (u8) 3
590 #define ACPI_C_STATES_MAX ACPI_STATE_C3
591 #define ACPI_C_STATE_COUNT 4
594 * Sleep type invalid value
596 #define ACPI_SLEEP_TYPE_MAX 0x7
597 #define ACPI_SLEEP_TYPE_INVALID 0xFF
600 * Standard notify values
602 #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
603 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
604 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
605 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
606 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
607 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
608 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
609 #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
610 #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
611 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
612 #define ACPI_NOTIFY_RESERVED (u8) 0x0A
613 #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
614 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (u8) 0x0C
615 #define ACPI_NOTIFY_AFFINITY_UPDATE (u8) 0x0D
616 #define ACPI_NOTIFY_MEMORY_UPDATE (u8) 0x0E
618 #define ACPI_GENERIC_NOTIFY_MAX 0x0E
619 #define ACPI_SPECIFIC_NOTIFY_MAX 0x84
622 * Types associated with ACPI names and objects. The first group of
623 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
624 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
625 * only add to the first group if the spec changes.
627 * NOTE: Types must be kept in sync with the global acpi_ns_properties
628 * and acpi_ns_type_names arrays.
630 typedef u32 acpi_object_type;
632 #define ACPI_TYPE_ANY 0x00
633 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
634 #define ACPI_TYPE_STRING 0x02
635 #define ACPI_TYPE_BUFFER 0x03
636 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
637 #define ACPI_TYPE_FIELD_UNIT 0x05
638 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
639 #define ACPI_TYPE_EVENT 0x07
640 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
641 #define ACPI_TYPE_MUTEX 0x09
642 #define ACPI_TYPE_REGION 0x0A
643 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
644 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
645 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
646 #define ACPI_TYPE_BUFFER_FIELD 0x0E
647 #define ACPI_TYPE_DDB_HANDLE 0x0F
648 #define ACPI_TYPE_DEBUG_OBJECT 0x10
650 #define ACPI_TYPE_EXTERNAL_MAX 0x10
651 #define ACPI_NUM_TYPES (ACPI_TYPE_EXTERNAL_MAX + 1)
654 * These are object types that do not map directly to the ACPI
655 * object_type() operator. They are used for various internal purposes
656 * only. If new predefined ACPI_TYPEs are added (via the ACPI
657 * specification), these internal types must move upwards. (There
658 * is code that depends on these values being contiguous with the
659 * external types above.)
661 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
662 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
663 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
664 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
665 #define ACPI_TYPE_LOCAL_ALIAS 0x15
666 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
667 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
668 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
669 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
670 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
671 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
673 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
674 #define ACPI_TOTAL_TYPES (ACPI_TYPE_NS_NODE_MAX + 1)
677 * These are special object types that never appear in
678 * a Namespace node, only in an object of union acpi_operand_object
680 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
681 #define ACPI_TYPE_LOCAL_DATA 0x1D
683 #define ACPI_TYPE_LOCAL_MAX 0x1D
685 /* All types above here are invalid */
687 #define ACPI_TYPE_INVALID 0x1E
688 #define ACPI_TYPE_NOT_FOUND 0xFF
690 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
697 #define ACPI_IO_MASK 1
700 * Event Types: Fixed & General Purpose
702 typedef u32 acpi_event_type;
707 #define ACPI_EVENT_PMTIMER 0
708 #define ACPI_EVENT_GLOBAL 1
709 #define ACPI_EVENT_POWER_BUTTON 2
710 #define ACPI_EVENT_SLEEP_BUTTON 3
711 #define ACPI_EVENT_RTC 4
712 #define ACPI_EVENT_MAX 4
713 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
716 * Event status - Per event
718 * The encoding of acpi_event_status is illustrated below.
719 * Note that a set bit (1) indicates the property is TRUE
720 * (e.g. if bit 0 is set then the event is enabled).
721 * +-------------+-+-+-+-+-+-+
722 * | Bits 31:6 |5|4|3|2|1|0|
723 * +-------------+-+-+-+-+-+-+
725 * | | | | | | +- Enabled?
726 * | | | | | +--- Enabled for wake?
727 * | | | | +----- Status bit set?
728 * | | | +------- Enable bit set?
729 * | | +--------- Has a handler?
730 * | +----------- Masked?
731 * +----------------- <Reserved>
733 typedef u32 acpi_event_status;
735 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
736 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
737 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
738 #define ACPI_EVENT_FLAG_STATUS_SET (acpi_event_status) 0x04
739 #define ACPI_EVENT_FLAG_ENABLE_SET (acpi_event_status) 0x08
740 #define ACPI_EVENT_FLAG_HAS_HANDLER (acpi_event_status) 0x10
741 #define ACPI_EVENT_FLAG_MASKED (acpi_event_status) 0x20
742 #define ACPI_EVENT_FLAG_SET ACPI_EVENT_FLAG_STATUS_SET
744 /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
746 #define ACPI_GPE_ENABLE 0
747 #define ACPI_GPE_DISABLE 1
748 #define ACPI_GPE_CONDITIONAL_ENABLE 2
751 * GPE info flags - Per GPE
756 * | | | | +-- Type of dispatch:to method, handler, notify, or none
757 * | | | +----- Interrupt type: edge or level triggered
758 * | | +------- Is a Wake GPE
759 * | +--------- Has been enabled automatically at init time
760 * +------------ <Reserved>
762 #define ACPI_GPE_DISPATCH_NONE (u8) 0x00
763 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
764 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
765 #define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
766 #define ACPI_GPE_DISPATCH_RAW_HANDLER (u8) 0x04
767 #define ACPI_GPE_DISPATCH_MASK (u8) 0x07
768 #define ACPI_GPE_DISPATCH_TYPE(flags) ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK))
770 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x08
771 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
772 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x08
774 #define ACPI_GPE_CAN_WAKE (u8) 0x10
775 #define ACPI_GPE_AUTO_ENABLED (u8) 0x20
776 #define ACPI_GPE_INITIALIZED (u8) 0x40
779 * Flags for GPE and Lock interfaces
781 #define ACPI_NOT_ISR 0x1
786 #define ACPI_SYSTEM_NOTIFY 0x1
787 #define ACPI_DEVICE_NOTIFY 0x2
788 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
789 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
790 #define ACPI_NUM_NOTIFY_TYPES 2
792 #define ACPI_MAX_SYS_NOTIFY 0x7F
793 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
795 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
796 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
798 /* Address Space (Operation Region) Types */
800 typedef u8 acpi_adr_space_type;
802 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
803 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
804 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
805 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
806 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
807 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
808 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
809 #define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
810 #define ACPI_ADR_SPACE_GPIO (acpi_adr_space_type) 8
811 #define ACPI_ADR_SPACE_GSBUS (acpi_adr_space_type) 9
812 #define ACPI_ADR_SPACE_PLATFORM_COMM (acpi_adr_space_type) 10
814 #define ACPI_NUM_PREDEFINED_REGIONS 11
817 * Special Address Spaces
819 * Note: A Data Table region is a special type of operation region
820 * that has its own AML opcode. However, internally, the AML
821 * interpreter simply creates an operation region with an an address
822 * space type of ACPI_ADR_SPACE_DATA_TABLE.
824 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */
825 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F
827 /* Values for _REG connection code */
829 #define ACPI_REG_DISCONNECT 0
830 #define ACPI_REG_CONNECT 1
835 * These values are intended to be used by the hardware interfaces
836 * and are mapped to individual bitfields defined within the ACPI
837 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
841 /* PM1 Status register */
843 #define ACPI_BITREG_TIMER_STATUS 0x00
844 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
845 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
846 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
847 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
848 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
849 #define ACPI_BITREG_WAKE_STATUS 0x06
850 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
852 /* PM1 Enable register */
854 #define ACPI_BITREG_TIMER_ENABLE 0x08
855 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
856 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
857 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
858 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
859 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
861 /* PM1 Control register */
863 #define ACPI_BITREG_SCI_ENABLE 0x0E
864 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
865 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
866 #define ACPI_BITREG_SLEEP_TYPE 0x11
867 #define ACPI_BITREG_SLEEP_ENABLE 0x12
869 /* PM2 Control register */
871 #define ACPI_BITREG_ARB_DISABLE 0x13
873 #define ACPI_BITREG_MAX 0x13
874 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
876 /* Status register values. A 1 clears a status bit. 0 = no effect */
878 #define ACPI_CLEAR_STATUS 1
880 /* Enable and Control register values */
882 #define ACPI_ENABLE_EVENT 1
883 #define ACPI_DISABLE_EVENT 0
885 /* Sleep function dispatch */
887 typedef acpi_status (*acpi_sleep_function) (u8 sleep_state);
889 struct acpi_sleep_functions {
890 acpi_sleep_function legacy_function;
891 acpi_sleep_function extended_function;
895 * External ACPI object definition
899 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
900 * element or an unresolved named reference.
903 acpi_object_type type; /* See definition of acpi_ns_type for values */
905 acpi_object_type type; /* ACPI_TYPE_INTEGER */
906 u64 value; /* The actual number */
910 acpi_object_type type; /* ACPI_TYPE_STRING */
911 u32 length; /* # of bytes in string, excluding trailing null */
912 char *pointer; /* points to the string value */
916 acpi_object_type type; /* ACPI_TYPE_BUFFER */
917 u32 length; /* # of bytes in buffer */
918 u8 *pointer; /* points to the buffer */
922 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
923 u32 count; /* # of elements in package */
924 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
928 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
929 acpi_object_type actual_type; /* Type associated with the Handle */
930 acpi_handle handle; /* object reference */
934 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
936 acpi_io_address pblk_address;
941 acpi_object_type type; /* ACPI_TYPE_POWER */
948 * List of objects, used as a parameter list for control method evaluation
950 struct acpi_object_list {
952 union acpi_object *pointer;
956 * Miscellaneous common Data Structures used by the interfaces
958 #define ACPI_NO_BUFFER 0
960 #ifdef ACPI_NO_MEM_ALLOCATIONS
962 #define ACPI_ALLOCATE_BUFFER (acpi_size) (0)
963 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (0)
965 #else /* ACPI_NO_MEM_ALLOCATIONS */
967 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1) /* Let ACPICA allocate buffer */
968 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2) /* For internal use only (enables tracking) */
970 #endif /* ACPI_NO_MEM_ALLOCATIONS */
973 acpi_size length; /* Length in bytes of the buffer */
974 void *pointer; /* pointer to buffer */
978 * name_type for acpi_get_name
980 #define ACPI_FULL_PATHNAME 0
981 #define ACPI_SINGLE_NAME 1
982 #define ACPI_FULL_PATHNAME_NO_TRAILING 2
983 #define ACPI_NAME_TYPE_MAX 2
986 * Predefined Namespace items
988 struct acpi_predefined_names {
995 * Structure and flags for acpi_get_system_info
997 #define ACPI_SYS_MODE_UNKNOWN 0x0000
998 #define ACPI_SYS_MODE_ACPI 0x0001
999 #define ACPI_SYS_MODE_LEGACY 0x0002
1000 #define ACPI_SYS_MODES_MASK 0x0003
1003 * System info returned by acpi_get_system_info()
1005 struct acpi_system_info {
1006 u32 acpi_ca_version;
1008 u32 timer_resolution;
1016 * System statistics returned by acpi_get_statistics()
1018 struct acpi_statistics {
1021 u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS];
1026 * Types specific to the OS service interfaces
1029 (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
1032 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
1035 * Various handlers and callback procedures
1038 u32 (*acpi_sci_handler) (void *context);
1041 void (*acpi_gbl_event_handler) (u32 event_type,
1043 u32 event_number, void *context);
1045 #define ACPI_EVENT_TYPE_GPE 0
1046 #define ACPI_EVENT_TYPE_FIXED 1
1049 u32(*acpi_event_handler) (void *context);
1052 u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
1055 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
1058 void (*acpi_object_handler) (acpi_handle object, void *data);
1061 acpi_status (*acpi_init_handler) (acpi_handle object, u32 function);
1063 #define ACPI_INIT_DEVICE_INI 1
1066 acpi_status (*acpi_exception_handler) (acpi_status aml_status,
1069 u32 aml_offset, void *context);
1071 /* Table Event handler (Load, load_table, etc.) and types */
1074 acpi_status (*acpi_table_handler) (u32 event, void *table, void *context);
1076 /* Table Event Types */
1078 #define ACPI_TABLE_EVENT_LOAD 0x0
1079 #define ACPI_TABLE_EVENT_UNLOAD 0x1
1080 #define ACPI_TABLE_EVENT_INSTALL 0x2
1081 #define ACPI_TABLE_EVENT_UNINSTALL 0x3
1082 #define ACPI_NUM_TABLE_EVENTS 4
1084 /* Address Spaces (For Operation Regions) */
1087 acpi_status (*acpi_adr_space_handler) (u32 function,
1088 acpi_physical_address address,
1091 void *handler_context,
1092 void *region_context);
1094 #define ACPI_DEFAULT_HANDLER NULL
1096 /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
1098 struct acpi_connection_info {
1105 acpi_status (*acpi_adr_space_setup) (acpi_handle region_handle,
1107 void *handler_context,
1108 void **region_context);
1110 #define ACPI_REGION_ACTIVATE 0
1111 #define ACPI_REGION_DEACTIVATE 1
1114 acpi_status (*acpi_walk_callback) (acpi_handle object,
1116 void *context, void **return_value);
1119 u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
1121 /* Interrupt handler return values */
1123 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
1124 #define ACPI_INTERRUPT_HANDLED 0x01
1126 /* GPE handler return values */
1128 #define ACPI_REENABLE_GPE 0x80
1130 /* Length of 32-bit EISAID values when converted back to a string */
1132 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1134 /* Length of UUID (string) values */
1136 #define ACPI_UUID_LENGTH 16
1138 /* Length of 3-byte PCI class code values when converted back to a string */
1140 #define ACPI_PCICLS_STRING_SIZE 7 /* Includes null terminator */
1142 /* Structures used for device/processor HID, UID, CID */
1144 struct acpi_pnp_device_id {
1145 u32 length; /* Length of string + null */
1149 struct acpi_pnp_device_id_list {
1150 u32 count; /* Number of IDs in Ids array */
1151 u32 list_size; /* Size of list, including ID strings */
1152 struct acpi_pnp_device_id ids[1]; /* ID array */
1156 * Structure returned from acpi_get_object_info.
1157 * Optimized for both 32-bit and 64-bit builds.
1159 struct acpi_device_info {
1160 u32 info_size; /* Size of info, including ID strings */
1161 u32 name; /* ACPI object Name */
1162 acpi_object_type type; /* ACPI object Type */
1163 u8 param_count; /* If a method, required parameter count */
1164 u16 valid; /* Indicates which optional fields are valid */
1165 u8 flags; /* Miscellaneous info */
1166 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1167 u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
1168 u64 address; /* _ADR value */
1169 struct acpi_pnp_device_id hardware_id; /* _HID value */
1170 struct acpi_pnp_device_id unique_id; /* _UID value */
1171 struct acpi_pnp_device_id class_code; /* _CLS value */
1172 struct acpi_pnp_device_id_list compatible_id_list; /* _CID list <must be last> */
1175 /* Values for Flags field above (acpi_get_object_info) */
1177 #define ACPI_PCI_ROOT_BRIDGE 0x01
1179 /* Flags for Valid field above (acpi_get_object_info) */
1181 #define ACPI_VALID_ADR 0x0002
1182 #define ACPI_VALID_HID 0x0004
1183 #define ACPI_VALID_UID 0x0008
1184 #define ACPI_VALID_CID 0x0020
1185 #define ACPI_VALID_CLS 0x0040
1186 #define ACPI_VALID_SXDS 0x0100
1187 #define ACPI_VALID_SXWS 0x0200
1189 /* Flags for _STA method */
1191 #define ACPI_STA_DEVICE_PRESENT 0x01
1192 #define ACPI_STA_DEVICE_ENABLED 0x02
1193 #define ACPI_STA_DEVICE_UI 0x04
1194 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1195 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1196 #define ACPI_STA_BATTERY_PRESENT 0x10
1198 /* Context structs for address space handlers */
1200 struct acpi_pci_id {
1207 struct acpi_mem_space_context {
1209 acpi_physical_address address;
1210 acpi_physical_address mapped_physical_address;
1211 u8 *mapped_logical_address;
1212 acpi_size mapped_length;
1216 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1218 struct acpi_memory_list {
1219 const char *list_name;
1225 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1227 /* Statistics for debug memory tracking only */
1229 u32 total_allocated;
1233 u32 current_total_size;
1239 /* Definitions of trace event types */
1242 ACPI_TRACE_AML_METHOD,
1243 ACPI_TRACE_AML_OPCODE,
1244 ACPI_TRACE_AML_REGION
1245 } acpi_trace_event_type;
1247 /* Definitions of _OSI support */
1249 #define ACPI_VENDOR_STRINGS 0x01
1250 #define ACPI_FEATURE_STRINGS 0x02
1251 #define ACPI_ENABLE_INTERFACES 0x00
1252 #define ACPI_DISABLE_INTERFACES 0x04
1254 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1255 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1256 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1257 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1258 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1259 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1261 #define ACPI_OSI_WIN_2000 0x01
1262 #define ACPI_OSI_WIN_XP 0x02
1263 #define ACPI_OSI_WIN_XP_SP1 0x03
1264 #define ACPI_OSI_WINSRV_2003 0x04
1265 #define ACPI_OSI_WIN_XP_SP2 0x05
1266 #define ACPI_OSI_WINSRV_2003_SP1 0x06
1267 #define ACPI_OSI_WIN_VISTA 0x07
1268 #define ACPI_OSI_WINSRV_2008 0x08
1269 #define ACPI_OSI_WIN_VISTA_SP1 0x09
1270 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
1271 #define ACPI_OSI_WIN_7 0x0B
1272 #define ACPI_OSI_WIN_8 0x0C
1273 #define ACPI_OSI_WIN_10 0x0D
1274 #define ACPI_OSI_WIN_10_RS1 0x0E
1275 #define ACPI_OSI_WIN_10_RS2 0x0F
1276 #define ACPI_OSI_WIN_10_RS3 0x10
1278 /* Definitions of getopt */
1280 #define ACPI_OPT_END -1
1282 #endif /* __ACTYPES_H__ */