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:struct_defs -- 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
73 * Architecture-specific ACPICA Subsystem Data Types
75 * The goal of these types is to provide source code portability across
76 * 16-bit, 32-bit, and 64-bit targets.
78 * 1) The following types are of fixed size for all targets (16/32/64):
80 * BOOLEAN Logical boolean
82 * UINT8 8-bit (1 byte) unsigned value
83 * UINT16 16-bit (2 byte) unsigned value
84 * UINT32 32-bit (4 byte) unsigned value
85 * UINT64 64-bit (8 byte) unsigned value
87 * INT16 16-bit (2 byte) signed value
88 * INT32 32-bit (4 byte) signed value
89 * INT64 64-bit (8 byte) signed value
91 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
92 * compiler-dependent header(s) and were introduced because there is no common
93 * 64-bit integer type across the various compilation models, as shown in
96 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
98 * short 16 16 16 16 16 16
100 * int 32 64 32 32 16 16
101 * long 64 64 32 32 32 32
103 * pointer 64 64 64 32 32 32
105 * Note: ILP64 and LP32 are currently not supported.
108 * 2) These types represent the native word size of the target mode of the
109 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
110 * usually used for memory allocation, efficient loop counters, and array
111 * indexes. The types are similar to the size_t type in the C library and are
112 * required because there is no C type that consistently represents the native
113 * data width. ACPI_SIZE is needed because there is no guarantee that a
114 * kernel-level C library is present.
116 * ACPI_SIZE 16/32/64-bit unsigned value
117 * ACPI_NATIVE_INT 16/32/64-bit signed value
120 /*******************************************************************************
122 * Common types for all compilers, all targets
124 ******************************************************************************/
126 typedef unsigned char BOOLEAN;
127 typedef unsigned char UINT8;
128 typedef unsigned short UINT16;
129 typedef COMPILER_DEPENDENT_UINT64 UINT64;
130 typedef COMPILER_DEPENDENT_INT64 INT64;
132 /*! [End] no source code translation !*/
135 * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
136 * across operating systems or even the various UNIX systems. Since ACPICA
137 * only needs the thread ID as a unique thread identifier, we use a u64
138 * as the only common data type - it will accommodate any type of pointer or
139 * any type of integer. It is up to the host-dependent OSL to cast the
140 * native thread ID type to a u64 (in acpi_os_get_thread_id).
142 #define acpi_thread_id u64
144 /*******************************************************************************
146 * Types specific to 64-bit targets
148 ******************************************************************************/
150 #if ACPI_MACHINE_WIDTH == 64
152 /*! [Begin] no source code translation (keep the typedefs as-is) */
154 typedef unsigned int UINT32;
157 /*! [End] no source code translation !*/
159 typedef s64 acpi_native_int;
161 typedef u64 acpi_size;
162 typedef u64 acpi_io_address;
163 typedef u64 acpi_physical_address;
165 #define ACPI_MAX_PTR ACPI_UINT64_MAX
166 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
168 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
171 * In the case of the Itanium Processor Family (IPF), the hardware does not
172 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
173 * to indicate that special precautions must be taken to avoid alignment faults.
174 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
176 * Note: EM64T and other X86-64 processors support misaligned transfers,
177 * so there is no need to define this flag.
179 #if defined (__IA64__) || defined (__ia64__)
180 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
183 /*******************************************************************************
185 * Types specific to 32-bit targets
187 ******************************************************************************/
189 #elif ACPI_MACHINE_WIDTH == 32
191 /*! [Begin] no source code translation (keep the typedefs as-is) */
193 typedef unsigned int UINT32;
196 /*! [End] no source code translation !*/
198 typedef s32 acpi_native_int;
200 typedef u32 acpi_size;
202 #ifdef ACPI_32BIT_PHYSICAL_ADDRESS
205 * OSPMs can define this to shrink the size of the structures for 32-bit
206 * none PAE environment. ASL compiler may always define this to generate
207 * 32-bit OSPM compliant tables.
209 typedef u32 acpi_io_address;
210 typedef u32 acpi_physical_address;
212 #else /* ACPI_32BIT_PHYSICAL_ADDRESS */
215 * It is reported that, after some calculations, the physical addresses can
216 * wrap over the 32-bit boundary on 32-bit PAE environment.
217 * https://bugzilla.kernel.org/show_bug.cgi?id=87971
219 typedef u64 acpi_io_address;
220 typedef u64 acpi_physical_address;
222 #endif /* ACPI_32BIT_PHYSICAL_ADDRESS */
224 #define ACPI_MAX_PTR ACPI_UINT32_MAX
225 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
229 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
231 #error unknown ACPI_MACHINE_WIDTH
234 /*******************************************************************************
238 * If the defaults below are not appropriate for the host system, they can
239 * be defined in the OS-specific header, and this will take precedence.
241 ******************************************************************************/
243 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
245 #ifndef acpi_cpu_flags
246 #define acpi_cpu_flags acpi_size
249 /* Object returned from acpi_os_create_cache */
252 #ifdef ACPI_USE_LOCAL_CACHE
253 #define acpi_cache_t struct acpi_memory_list
255 #define acpi_cache_t void *
260 * Synchronization objects - Mutexes, Semaphores, and spin_locks
262 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
264 * These macros are used if the host OS does not support a mutex object.
265 * Map the OSL Mutex interfaces to binary semaphores.
267 #define acpi_mutex acpi_semaphore
268 #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
269 #define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
270 #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
271 #define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
274 /* Configurable types for synchronization objects */
276 #ifndef acpi_spinlock
277 #define acpi_spinlock void *
280 #ifndef acpi_semaphore
281 #define acpi_semaphore void *
285 #define acpi_mutex void *
288 /*******************************************************************************
290 * Compiler-dependent types
292 * If the defaults below are not appropriate for the host compiler, they can
293 * be defined in the compiler-specific header, and this will take precedence.
295 ******************************************************************************/
297 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
299 #ifndef acpi_uintptr_t
300 #define acpi_uintptr_t void *
304 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
305 * some compilers can catch printf format string problems
307 #ifndef ACPI_PRINTF_LIKE
308 #define ACPI_PRINTF_LIKE(c)
312 * Some compilers complain about unused variables. Sometimes we don't want to
313 * use all the variables (for example, _acpi_module_name). This allows us
314 * to tell the compiler in a per-variable manner that a variable
317 #ifndef ACPI_UNUSED_VAR
318 #define ACPI_UNUSED_VAR
322 * All ACPICA functions that are available to the rest of the kernel are
323 * tagged with this macro which can be defined as appropriate for the host.
325 #ifndef ACPI_EXPORT_SYMBOL
326 #define ACPI_EXPORT_SYMBOL(symbol)
329 /******************************************************************************
331 * ACPI Specification constants (Do not change unless the specification changes)
333 *****************************************************************************/
335 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
337 #define ACPI_MAX_GPE_BLOCKS 2
339 /* Default ACPI register widths */
341 #define ACPI_GPE_REGISTER_WIDTH 8
342 #define ACPI_PM1_REGISTER_WIDTH 16
343 #define ACPI_PM2_REGISTER_WIDTH 8
344 #define ACPI_PM_TIMER_WIDTH 32
346 /* Names within the namespace are 4 bytes long */
348 #define ACPI_NAME_SIZE 4
349 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
350 #define ACPI_PATH_SEPARATOR '.'
352 /* Sizes for ACPI table headers */
354 #define ACPI_OEM_ID_SIZE 6
355 #define ACPI_OEM_TABLE_ID_SIZE 8
357 /* ACPI/PNP hardware IDs */
359 #define PCI_ROOT_HID_STRING "PNP0A03"
360 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
362 /* PM Timer ticks per second (HZ) */
364 #define ACPI_PM_TIMER_FREQUENCY 3579545
366 /*******************************************************************************
370 ******************************************************************************/
372 /* Logical defines and NULL */
377 #define FALSE (1 == 0)
382 #define TRUE (1 == 1)
385 #define NULL (void *) 0
389 * Miscellaneous types
391 typedef u32 acpi_status; /* All ACPI Exceptions */
392 typedef u32 acpi_name; /* 4-byte ACPI name */
393 typedef char *acpi_string; /* Null terminated ASCII string */
394 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
396 /* Time constants for timer calculations */
398 #define ACPI_MSEC_PER_SEC 1000L
400 #define ACPI_USEC_PER_MSEC 1000L
401 #define ACPI_USEC_PER_SEC 1000000L
403 #define ACPI_100NSEC_PER_USEC 10L
404 #define ACPI_100NSEC_PER_MSEC 10000L
405 #define ACPI_100NSEC_PER_SEC 10000000L
407 #define ACPI_NSEC_PER_USEC 1000L
408 #define ACPI_NSEC_PER_MSEC 1000000L
409 #define ACPI_NSEC_PER_SEC 1000000000L
411 /* Owner IDs are used to track namespace nodes for selective deletion */
413 typedef u8 acpi_owner_id;
414 #define ACPI_OWNER_ID_MAX 0xFF
416 #define ACPI_INTEGER_BIT_SIZE 64
417 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
419 #if ACPI_MACHINE_WIDTH == 64
420 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
423 #define ACPI_MAX64_DECIMAL_DIGITS 20
424 #define ACPI_MAX32_DECIMAL_DIGITS 10
425 #define ACPI_MAX16_DECIMAL_DIGITS 5
426 #define ACPI_MAX8_DECIMAL_DIGITS 3
429 * Constants with special meanings
431 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
432 #define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
433 #define ACPI_DO_NOT_WAIT 0
436 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
437 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
438 * pertains to the ACPI integer type only, not to other integers used in the
439 * implementation of the ACPICA subsystem.
441 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
442 * code base. It remains here for compatibility with device drivers that use
443 * the type. However, it will be removed in the future.
445 typedef u64 acpi_integer;
446 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
448 /*******************************************************************************
450 * Commonly used macros
452 ******************************************************************************/
454 /* Data manipulation */
456 #define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
457 #define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
458 #define ACPI_LOWORD(integer) ((u16) (u32)(integer))
459 #define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
460 #define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
461 #define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
463 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
464 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
465 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
466 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
468 /* Size calculation */
470 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
472 /* Pointer manipulation */
474 #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
475 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
476 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
477 #define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
479 /* Pointer/Integer type conversions */
481 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
482 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
483 #define ACPI_OFFSET(d, f) (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
484 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
485 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
487 /* Optimizations for 4-character (32-bit) acpi_name manipulation */
489 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
490 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
491 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
493 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
494 #define ACPI_MOVE_NAME(dest,src) (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
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 (u8) 0xFF
526 #define ACPI_STATE_S0 (u8) 0
527 #define ACPI_STATE_S1 (u8) 1
528 #define ACPI_STATE_S2 (u8) 2
529 #define ACPI_STATE_S3 (u8) 3
530 #define ACPI_STATE_S4 (u8) 4
531 #define ACPI_STATE_S5 (u8) 5
532 #define ACPI_S_STATES_MAX ACPI_STATE_S5
533 #define ACPI_S_STATE_COUNT 6
535 #define ACPI_STATE_D0 (u8) 0
536 #define ACPI_STATE_D1 (u8) 1
537 #define ACPI_STATE_D2 (u8) 2
538 #define ACPI_STATE_D3_HOT (u8) 3
539 #define ACPI_STATE_D3 (u8) 4
540 #define ACPI_STATE_D3_COLD ACPI_STATE_D3
541 #define ACPI_D_STATES_MAX ACPI_STATE_D3
542 #define ACPI_D_STATE_COUNT 5
544 #define ACPI_STATE_C0 (u8) 0
545 #define ACPI_STATE_C1 (u8) 1
546 #define ACPI_STATE_C2 (u8) 2
547 #define ACPI_STATE_C3 (u8) 3
548 #define ACPI_C_STATES_MAX ACPI_STATE_C3
549 #define ACPI_C_STATE_COUNT 4
552 * Sleep type invalid value
554 #define ACPI_SLEEP_TYPE_MAX 0x7
555 #define ACPI_SLEEP_TYPE_INVALID 0xFF
558 * Standard notify values
560 #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
561 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
562 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
563 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
564 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
565 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
566 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
567 #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
568 #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
569 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
570 #define ACPI_NOTIFY_RESERVED (u8) 0x0A
571 #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
572 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (u8) 0x0C
574 #define ACPI_NOTIFY_MAX 0x0C
577 * Types associated with ACPI names and objects. The first group of
578 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
579 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
580 * only add to the first group if the spec changes.
582 * NOTE: Types must be kept in sync with the global acpi_ns_properties
583 * and acpi_ns_type_names arrays.
585 typedef u32 acpi_object_type;
587 #define ACPI_TYPE_ANY 0x00
588 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
589 #define ACPI_TYPE_STRING 0x02
590 #define ACPI_TYPE_BUFFER 0x03
591 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
592 #define ACPI_TYPE_FIELD_UNIT 0x05
593 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
594 #define ACPI_TYPE_EVENT 0x07
595 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
596 #define ACPI_TYPE_MUTEX 0x09
597 #define ACPI_TYPE_REGION 0x0A
598 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
599 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
600 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
601 #define ACPI_TYPE_BUFFER_FIELD 0x0E
602 #define ACPI_TYPE_DDB_HANDLE 0x0F
603 #define ACPI_TYPE_DEBUG_OBJECT 0x10
605 #define ACPI_TYPE_EXTERNAL_MAX 0x10
608 * These are object types that do not map directly to the ACPI
609 * object_type() operator. They are used for various internal purposes only.
610 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
611 * internal types must move upwards. (There is code that depends on these
612 * values being contiguous with the external types above.)
614 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
615 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
616 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
617 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
618 #define ACPI_TYPE_LOCAL_ALIAS 0x15
619 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
620 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
621 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
622 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
623 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
624 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
626 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
629 * These are special object types that never appear in
630 * a Namespace node, only in an object of union acpi_operand_object
632 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
633 #define ACPI_TYPE_LOCAL_DATA 0x1D
635 #define ACPI_TYPE_LOCAL_MAX 0x1D
637 /* All types above here are invalid */
639 #define ACPI_TYPE_INVALID 0x1E
640 #define ACPI_TYPE_NOT_FOUND 0xFF
642 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
649 #define ACPI_IO_MASK 1
652 * Event Types: Fixed & General Purpose
654 typedef u32 acpi_event_type;
659 #define ACPI_EVENT_PMTIMER 0
660 #define ACPI_EVENT_GLOBAL 1
661 #define ACPI_EVENT_POWER_BUTTON 2
662 #define ACPI_EVENT_SLEEP_BUTTON 3
663 #define ACPI_EVENT_RTC 4
664 #define ACPI_EVENT_MAX 4
665 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
668 * Event status - Per event
670 * The encoding of acpi_event_status is illustrated below.
671 * Note that a set bit (1) indicates the property is TRUE
672 * (e.g. if bit 0 is set then the event is enabled).
673 * +-------------+-+-+-+-+
674 * | Bits 31:4 |3|2|1|0|
675 * +-------------+-+-+-+-+
677 * | | | | +- Enabled?
678 * | | | +--- Enabled for wake?
680 * | +------- Has a handler?
681 * +----------- <Reserved>
683 typedef u32 acpi_event_status;
685 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
686 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
687 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
688 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
689 #define ACPI_EVENT_FLAG_HANDLE (acpi_event_status) 0x08
692 * General Purpose Events (GPE)
694 #define ACPI_GPE_INVALID 0xFF
695 #define ACPI_GPE_MAX 0xFF
696 #define ACPI_NUM_GPE 256
698 /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
700 #define ACPI_GPE_ENABLE 0
701 #define ACPI_GPE_DISABLE 1
702 #define ACPI_GPE_CONDITIONAL_ENABLE 2
705 * GPE info flags - Per GPE
710 * | | | +-- Type of dispatch:to method, handler, notify, or none
711 * | | +----- Interrupt type: edge or level triggered
712 * | +------- Is a Wake GPE
713 * +------------ <Reserved>
715 #define ACPI_GPE_DISPATCH_NONE (u8) 0x00
716 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
717 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
718 #define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
719 #define ACPI_GPE_DISPATCH_MASK (u8) 0x03
721 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x04
722 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
723 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x04
725 #define ACPI_GPE_CAN_WAKE (u8) 0x08
728 * Flags for GPE and Lock interfaces
730 #define ACPI_NOT_ISR 0x1
735 #define ACPI_SYSTEM_NOTIFY 0x1
736 #define ACPI_DEVICE_NOTIFY 0x2
737 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
738 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
739 #define ACPI_NUM_NOTIFY_TYPES 2
741 #define ACPI_MAX_SYS_NOTIFY 0x7F
742 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
744 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
745 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
747 /* Address Space (Operation Region) Types */
749 typedef u8 acpi_adr_space_type;
751 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
752 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
753 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
754 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
755 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
756 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
757 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
758 #define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
759 #define ACPI_ADR_SPACE_GPIO (acpi_adr_space_type) 8
760 #define ACPI_ADR_SPACE_GSBUS (acpi_adr_space_type) 9
761 #define ACPI_ADR_SPACE_PLATFORM_COMM (acpi_adr_space_type) 10
763 #define ACPI_NUM_PREDEFINED_REGIONS 11
766 * Special Address Spaces
768 * Note: A Data Table region is a special type of operation region
769 * that has its own AML opcode. However, internally, the AML
770 * interpreter simply creates an operation region with an an address
771 * space type of ACPI_ADR_SPACE_DATA_TABLE.
773 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */
774 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F
776 /* Values for _REG connection code */
778 #define ACPI_REG_DISCONNECT 0
779 #define ACPI_REG_CONNECT 1
784 * These values are intended to be used by the hardware interfaces
785 * and are mapped to individual bitfields defined within the ACPI
786 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
790 /* PM1 Status register */
792 #define ACPI_BITREG_TIMER_STATUS 0x00
793 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
794 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
795 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
796 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
797 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
798 #define ACPI_BITREG_WAKE_STATUS 0x06
799 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
801 /* PM1 Enable register */
803 #define ACPI_BITREG_TIMER_ENABLE 0x08
804 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
805 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
806 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
807 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
808 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
810 /* PM1 Control register */
812 #define ACPI_BITREG_SCI_ENABLE 0x0E
813 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
814 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
815 #define ACPI_BITREG_SLEEP_TYPE 0x11
816 #define ACPI_BITREG_SLEEP_ENABLE 0x12
818 /* PM2 Control register */
820 #define ACPI_BITREG_ARB_DISABLE 0x13
822 #define ACPI_BITREG_MAX 0x13
823 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
825 /* Status register values. A 1 clears a status bit. 0 = no effect */
827 #define ACPI_CLEAR_STATUS 1
829 /* Enable and Control register values */
831 #define ACPI_ENABLE_EVENT 1
832 #define ACPI_DISABLE_EVENT 0
834 /* Sleep function dispatch */
836 typedef acpi_status(*acpi_sleep_function) (u8 sleep_state);
838 struct acpi_sleep_functions {
839 acpi_sleep_function legacy_function;
840 acpi_sleep_function extended_function;
844 * External ACPI object definition
848 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
849 * or an unresolved named reference.
852 acpi_object_type type; /* See definition of acpi_ns_type for values */
854 acpi_object_type type; /* ACPI_TYPE_INTEGER */
855 u64 value; /* The actual number */
859 acpi_object_type type; /* ACPI_TYPE_STRING */
860 u32 length; /* # of bytes in string, excluding trailing null */
861 char *pointer; /* points to the string value */
865 acpi_object_type type; /* ACPI_TYPE_BUFFER */
866 u32 length; /* # of bytes in buffer */
867 u8 *pointer; /* points to the buffer */
871 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
872 u32 count; /* # of elements in package */
873 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
877 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
878 acpi_object_type actual_type; /* Type associated with the Handle */
879 acpi_handle handle; /* object reference */
883 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
885 acpi_io_address pblk_address;
890 acpi_object_type type; /* ACPI_TYPE_POWER */
897 * List of objects, used as a parameter list for control method evaluation
899 struct acpi_object_list {
901 union acpi_object *pointer;
905 * Miscellaneous common Data Structures used by the interfaces
907 #define ACPI_NO_BUFFER 0
908 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
909 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
912 acpi_size length; /* Length in bytes of the buffer */
913 void *pointer; /* pointer to buffer */
916 /* Free a buffer created in an struct acpi_buffer via ACPI_ALLOCATE_LOCAL_BUFFER */
918 #define ACPI_FREE_BUFFER(b) ACPI_FREE(b.pointer)
921 * name_type for acpi_get_name
923 #define ACPI_FULL_PATHNAME 0
924 #define ACPI_SINGLE_NAME 1
925 #define ACPI_NAME_TYPE_MAX 1
928 * Predefined Namespace items
930 struct acpi_predefined_names {
937 * Structure and flags for acpi_get_system_info
939 #define ACPI_SYS_MODE_UNKNOWN 0x0000
940 #define ACPI_SYS_MODE_ACPI 0x0001
941 #define ACPI_SYS_MODE_LEGACY 0x0002
942 #define ACPI_SYS_MODES_MASK 0x0003
945 * System info returned by acpi_get_system_info()
947 struct acpi_system_info {
950 u32 timer_resolution;
957 /* Table Event Types */
959 #define ACPI_TABLE_EVENT_LOAD 0x0
960 #define ACPI_TABLE_EVENT_UNLOAD 0x1
961 #define ACPI_NUM_TABLE_EVENTS 2
964 * Types specific to the OS service interfaces
967 (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
970 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
973 * Various handlers and callback procedures
976 void (*acpi_gbl_event_handler) (u32 event_type,
978 u32 event_number, void *context);
980 #define ACPI_EVENT_TYPE_GPE 0
981 #define ACPI_EVENT_TYPE_FIXED 1
984 u32(*acpi_event_handler) (void *context);
987 u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
990 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
993 void (*acpi_object_handler) (acpi_handle object, void *data);
995 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
997 #define ACPI_INIT_DEVICE_INI 1
1000 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
1003 u32 aml_offset, void *context);
1005 /* Table Event handler (Load, load_table, etc.) and types */
1008 acpi_status(*acpi_table_handler) (u32 event, void *table, void *context);
1010 #define ACPI_TABLE_LOAD 0x0
1011 #define ACPI_TABLE_UNLOAD 0x1
1012 #define ACPI_NUM_TABLE_EVENTS 2
1014 /* Address Spaces (For Operation Regions) */
1017 acpi_status(*acpi_adr_space_handler) (u32 function,
1018 acpi_physical_address address,
1021 void *handler_context,
1022 void *region_context);
1024 #define ACPI_DEFAULT_HANDLER NULL
1026 /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
1028 struct acpi_connection_info {
1035 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
1037 void *handler_context,
1038 void **region_context);
1040 #define ACPI_REGION_ACTIVATE 0
1041 #define ACPI_REGION_DEACTIVATE 1
1044 acpi_status(*acpi_walk_callback) (acpi_handle object,
1046 void *context, void **return_value);
1049 u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
1051 /* Interrupt handler return values */
1053 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
1054 #define ACPI_INTERRUPT_HANDLED 0x01
1056 /* GPE handler return values */
1058 #define ACPI_REENABLE_GPE 0x80
1060 /* Length of 32-bit EISAID values when converted back to a string */
1062 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1064 /* Length of UUID (string) values */
1066 #define ACPI_UUID_LENGTH 16
1068 /* Structures used for device/processor HID, UID, CID, and SUB */
1070 struct acpi_pnp_device_id {
1071 u32 length; /* Length of string + null */
1075 struct acpi_pnp_device_id_list {
1076 u32 count; /* Number of IDs in Ids array */
1077 u32 list_size; /* Size of list, including ID strings */
1078 struct acpi_pnp_device_id ids[1]; /* ID array */
1082 * Structure returned from acpi_get_object_info.
1083 * Optimized for both 32- and 64-bit builds
1085 struct acpi_device_info {
1086 u32 info_size; /* Size of info, including ID strings */
1087 u32 name; /* ACPI object Name */
1088 acpi_object_type type; /* ACPI object Type */
1089 u8 param_count; /* If a method, required parameter count */
1090 u8 valid; /* Indicates which optional fields are valid */
1091 u8 flags; /* Miscellaneous info */
1092 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1093 u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
1094 u32 current_status; /* _STA value */
1095 u64 address; /* _ADR value */
1096 struct acpi_pnp_device_id hardware_id; /* _HID value */
1097 struct acpi_pnp_device_id unique_id; /* _UID value */
1098 struct acpi_pnp_device_id subsystem_id; /* _SUB value */
1099 struct acpi_pnp_device_id_list compatible_id_list; /* _CID list <must be last> */
1102 /* Values for Flags field above (acpi_get_object_info) */
1104 #define ACPI_PCI_ROOT_BRIDGE 0x01
1106 /* Flags for Valid field above (acpi_get_object_info) */
1108 #define ACPI_VALID_STA 0x01
1109 #define ACPI_VALID_ADR 0x02
1110 #define ACPI_VALID_HID 0x04
1111 #define ACPI_VALID_UID 0x08
1112 #define ACPI_VALID_SUB 0x10
1113 #define ACPI_VALID_CID 0x20
1114 #define ACPI_VALID_SXDS 0x40
1115 #define ACPI_VALID_SXWS 0x80
1117 /* Flags for _STA return value (current_status above) */
1119 #define ACPI_STA_DEVICE_PRESENT 0x01
1120 #define ACPI_STA_DEVICE_ENABLED 0x02
1121 #define ACPI_STA_DEVICE_UI 0x04
1122 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1123 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1124 #define ACPI_STA_BATTERY_PRESENT 0x10
1126 /* Context structs for address space handlers */
1128 struct acpi_pci_id {
1135 struct acpi_mem_space_context {
1137 acpi_physical_address address;
1138 acpi_physical_address mapped_physical_address;
1139 u8 *mapped_logical_address;
1140 acpi_size mapped_length;
1144 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1146 struct acpi_memory_list {
1153 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1155 /* Statistics for debug memory tracking only */
1157 u32 total_allocated;
1161 u32 current_total_size;
1167 #endif /* __ACTYPES_H__ */