1 /******************************************************************************
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, R. Byron Moore
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 16, 32, or 64
53 #ifndef ACPI_MACHINE_WIDTH
54 #error ACPI_MACHINE_WIDTH not defined
57 /*! [Begin] no source code translation */
61 * Note: These macros are designed to be compiler independent as well as
62 * working around problems that some 32-bit compilers have with 64-bit
65 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
66 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
67 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
68 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
69 #define ACPI_ASCII_MAX 0x7F
72 * Architecture-specific ACPICA Subsystem Data Types
74 * The goal of these types is to provide source code portability across
75 * 16-bit, 32-bit, and 64-bit targets.
77 * 1) The following types are of fixed size for all targets (16/32/64):
79 * BOOLEAN Logical boolean
81 * UINT8 8-bit (1 byte) unsigned value
82 * UINT16 16-bit (2 byte) unsigned value
83 * UINT32 32-bit (4 byte) unsigned value
84 * UINT64 64-bit (8 byte) unsigned value
86 * INT16 16-bit (2 byte) signed value
87 * INT32 32-bit (4 byte) signed value
88 * INT64 64-bit (8 byte) signed value
90 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
91 * compiler-dependent header(s) and were introduced because there is no common
92 * 64-bit integer type across the various compilation models, as shown in
95 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
97 * short 16 16 16 16 16 16
99 * int 32 64 32 32 16 16
100 * long 64 64 32 32 32 32
102 * pointer 64 64 64 32 32 32
104 * Note: ILP64 and LP32 are currently not supported.
107 * 2) These types represent the native word size of the target mode of the
108 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
109 * usually used for memory allocation, efficient loop counters, and array
110 * indexes. The types are similar to the size_t type in the C library and are
111 * required because there is no C type that consistently represents the native
114 * ACPI_SIZE 16/32/64-bit unsigned value
115 * ACPI_NATIVE_UINT 16/32/64-bit unsigned value
116 * 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 !*/
134 /*******************************************************************************
136 * Types specific to 64-bit targets
138 ******************************************************************************/
140 #if ACPI_MACHINE_WIDTH == 64
142 /*! [Begin] no source code translation (keep the typedefs as-is) */
144 typedef unsigned int UINT32;
147 /*! [End] no source code translation !*/
149 typedef u64 acpi_native_uint;
150 typedef s64 acpi_native_int;
152 typedef u64 acpi_io_address;
153 typedef u64 acpi_physical_address;
155 #define ACPI_MAX_PTR ACPI_UINT64_MAX
156 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
158 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
161 * In the case of the Itanium Processor Family (IPF), the hardware does not
162 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
163 * to indicate that special precautions must be taken to avoid alignment faults.
164 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
166 * Note: Em64_t and other X86-64 processors support misaligned transfers,
167 * so there is no need to define this flag.
169 #if defined (__IA64__) || defined (__ia64__)
170 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
173 /*******************************************************************************
175 * Types specific to 32-bit targets
177 ******************************************************************************/
179 #elif ACPI_MACHINE_WIDTH == 32
181 /*! [Begin] no source code translation (keep the typedefs as-is) */
183 typedef unsigned int UINT32;
186 /*! [End] no source code translation !*/
188 typedef u32 acpi_native_uint;
189 typedef s32 acpi_native_int;
191 typedef u32 acpi_io_address;
192 typedef u32 acpi_physical_address;
194 #define ACPI_MAX_PTR ACPI_UINT32_MAX
195 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
199 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
201 #error unknown ACPI_MACHINE_WIDTH
204 /* Variable-width type, used instead of clib size_t */
206 typedef acpi_native_uint acpi_size;
208 /*******************************************************************************
210 * OS-dependent and compiler-dependent types
212 * If the defaults below are not appropriate for the host system, they can
213 * be defined in the compiler-specific or OS-specific header, and this will
216 ******************************************************************************/
218 /* Value returned by acpi_os_get_thread_id */
220 #ifndef acpi_thread_id
221 #define acpi_thread_id acpi_native_uint
224 /* Object returned from acpi_os_create_lock */
226 #ifndef acpi_spinlock
227 #define acpi_spinlock void *
230 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
232 #ifndef acpi_cpu_flags
233 #define acpi_cpu_flags acpi_native_uint
236 /* Object returned from acpi_os_create_cache */
239 #define acpi_cache_t struct acpi_memory_list
242 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
244 #ifndef acpi_uintptr_t
245 #define acpi_uintptr_t void *
249 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
250 * some compilers can catch printf format string problems
252 #ifndef ACPI_PRINTF_LIKE
253 #define ACPI_PRINTF_LIKE(c)
257 * Some compilers complain about unused variables. Sometimes we don't want to
258 * use all the variables (for example, _acpi_module_name). This allows us
259 * to to tell the compiler in a per-variable manner that a variable
262 #ifndef ACPI_UNUSED_VAR
263 #define ACPI_UNUSED_VAR
267 * All ACPICA functions that are available to the rest of the kernel are
268 * tagged with this macro which can be defined as appropriate for the host.
270 #ifndef ACPI_EXPORT_SYMBOL
271 #define ACPI_EXPORT_SYMBOL(symbol)
274 /*******************************************************************************
278 ******************************************************************************/
280 /* Logical defines and NULL */
285 #define FALSE (1 == 0)
290 #define TRUE (1 == 1)
293 #define NULL (void *) 0
297 * Mescellaneous types
299 typedef u32 acpi_status; /* All ACPI Exceptions */
300 typedef u32 acpi_name; /* 4-byte ACPI name */
301 typedef char *acpi_string; /* Null terminated ASCII string */
302 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
304 struct uint64_struct {
309 union uint64_overlay {
311 struct uint64_struct part;
314 struct uint32_struct {
319 /* Synchronization objects */
321 #define acpi_mutex void *
322 #define acpi_semaphore void *
325 * Acpi integer width. In ACPI version 1, integers are
326 * 32 bits. In ACPI version 2, integers are 64 bits.
327 * Note that this pertains to the ACPI integer type only, not
328 * other integers used in the implementation of the ACPI CA
331 #ifdef ACPI_NO_INTEGER64_SUPPORT
333 /* 32-bit integers only, no 64-bit support */
335 typedef u32 acpi_integer;
336 #define ACPI_INTEGER_MAX ACPI_UINT32_MAX
337 #define ACPI_INTEGER_BIT_SIZE 32
338 #define ACPI_MAX_DECIMAL_DIGITS 10 /* 2^32 = 4,294,967,296 */
340 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */
344 /* 64-bit integers */
346 typedef u64 acpi_integer;
347 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
348 #define ACPI_INTEGER_BIT_SIZE 64
349 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
351 #if ACPI_MACHINE_WIDTH == 64
352 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
356 #define ACPI_MAX64_DECIMAL_DIGITS 20
357 #define ACPI_MAX32_DECIMAL_DIGITS 10
358 #define ACPI_MAX16_DECIMAL_DIGITS 5
359 #define ACPI_MAX8_DECIMAL_DIGITS 3
362 * Constants with special meanings
364 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
367 * Initialization sequence
369 #define ACPI_FULL_INITIALIZATION 0x00
370 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
371 #define ACPI_NO_HARDWARE_INIT 0x02
372 #define ACPI_NO_EVENT_INIT 0x04
373 #define ACPI_NO_HANDLER_INIT 0x08
374 #define ACPI_NO_ACPI_ENABLE 0x10
375 #define ACPI_NO_DEVICE_INIT 0x20
376 #define ACPI_NO_OBJECT_INIT 0x40
379 * Initialization state
381 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
382 #define ACPI_INITIALIZED_OK 0x02
387 #define ACPI_STATE_UNKNOWN (u8) 0xFF
389 #define ACPI_STATE_S0 (u8) 0
390 #define ACPI_STATE_S1 (u8) 1
391 #define ACPI_STATE_S2 (u8) 2
392 #define ACPI_STATE_S3 (u8) 3
393 #define ACPI_STATE_S4 (u8) 4
394 #define ACPI_STATE_S5 (u8) 5
395 #define ACPI_S_STATES_MAX ACPI_STATE_S5
396 #define ACPI_S_STATE_COUNT 6
398 #define ACPI_STATE_D0 (u8) 0
399 #define ACPI_STATE_D1 (u8) 1
400 #define ACPI_STATE_D2 (u8) 2
401 #define ACPI_STATE_D3 (u8) 3
402 #define ACPI_D_STATES_MAX ACPI_STATE_D3
403 #define ACPI_D_STATE_COUNT 4
405 #define ACPI_STATE_C0 (u8) 0
406 #define ACPI_STATE_C1 (u8) 1
407 #define ACPI_STATE_C2 (u8) 2
408 #define ACPI_STATE_C3 (u8) 3
409 #define ACPI_C_STATES_MAX ACPI_STATE_C3
410 #define ACPI_C_STATE_COUNT 4
413 * Sleep type invalid value
415 #define ACPI_SLEEP_TYPE_MAX 0x7
416 #define ACPI_SLEEP_TYPE_INVALID 0xFF
419 * Standard notify values
421 #define ACPI_NOTIFY_BUS_CHECK (u8) 0
422 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 1
423 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 2
424 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 3
425 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 4
426 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 5
427 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 6
428 #define ACPI_NOTIFY_POWER_FAULT (u8) 7
431 * Types associated with ACPI names and objects. The first group of
432 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
433 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
434 * only add to the first group if the spec changes.
436 * NOTE: Types must be kept in sync with the global acpi_ns_properties
437 * and acpi_ns_type_names arrays.
439 typedef u32 acpi_object_type;
441 #define ACPI_TYPE_ANY 0x00
442 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
443 #define ACPI_TYPE_STRING 0x02
444 #define ACPI_TYPE_BUFFER 0x03
445 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
446 #define ACPI_TYPE_FIELD_UNIT 0x05
447 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
448 #define ACPI_TYPE_EVENT 0x07
449 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
450 #define ACPI_TYPE_MUTEX 0x09
451 #define ACPI_TYPE_REGION 0x0A
452 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
453 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
454 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
455 #define ACPI_TYPE_BUFFER_FIELD 0x0E
456 #define ACPI_TYPE_DDB_HANDLE 0x0F
457 #define ACPI_TYPE_DEBUG_OBJECT 0x10
459 #define ACPI_TYPE_EXTERNAL_MAX 0x10
462 * These are object types that do not map directly to the ACPI
463 * object_type() operator. They are used for various internal purposes only.
464 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
465 * internal types must move upwards. (There is code that depends on these
466 * values being contiguous with the external types above.)
468 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
469 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
470 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
471 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
472 #define ACPI_TYPE_LOCAL_ALIAS 0x15
473 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
474 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
475 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
476 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
477 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
478 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
480 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
483 * These are special object types that never appear in
484 * a Namespace node, only in an union acpi_operand_object
486 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
487 #define ACPI_TYPE_LOCAL_DATA 0x1D
489 #define ACPI_TYPE_LOCAL_MAX 0x1D
491 /* All types above here are invalid */
493 #define ACPI_TYPE_INVALID 0x1E
494 #define ACPI_TYPE_NOT_FOUND 0xFF
501 #define ACPI_IO_MASK 1
504 * Event Types: Fixed & General Purpose
506 typedef u32 acpi_event_type;
511 #define ACPI_EVENT_PMTIMER 0
512 #define ACPI_EVENT_GLOBAL 1
513 #define ACPI_EVENT_POWER_BUTTON 2
514 #define ACPI_EVENT_SLEEP_BUTTON 3
515 #define ACPI_EVENT_RTC 4
516 #define ACPI_EVENT_MAX 4
517 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
520 * Event Status - Per event
522 * The encoding of acpi_event_status is illustrated below.
523 * Note that a set bit (1) indicates the property is TRUE
524 * (e.g. if bit 0 is set then the event is enabled).
525 * +-------------+-+-+-+
526 * | Bits 31:3 |2|1|0|
527 * +-------------+-+-+-+
530 * | | +--- Enabled for wake?
532 * +----------- <Reserved>
534 typedef u32 acpi_event_status;
536 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
537 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
538 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
539 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
542 * General Purpose Events (GPE)
544 #define ACPI_GPE_INVALID 0xFF
545 #define ACPI_GPE_MAX 0xFF
546 #define ACPI_NUM_GPE 256
548 #define ACPI_GPE_ENABLE 0
549 #define ACPI_GPE_DISABLE 1
552 * GPE info flags - Per GPE
557 * | | | | | +--- Interrupt type: Edge or Level Triggered
558 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
559 * | | | +--- Type of dispatch -- to method, handler, or none
560 * | | +--- Enabled for runtime?
561 * | +--- Enabled for wake?
564 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
565 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
566 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
568 #define ACPI_GPE_TYPE_MASK (u8) 0x06
569 #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
570 #define ACPI_GPE_TYPE_WAKE (u8) 0x02
571 #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
573 #define ACPI_GPE_DISPATCH_MASK (u8) 0x18
574 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
575 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
576 #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
578 #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
579 #define ACPI_GPE_RUN_ENABLED (u8) 0x20
580 #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
582 #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
583 #define ACPI_GPE_WAKE_ENABLED (u8) 0x40
584 #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
586 #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
589 * Flags for GPE and Lock interfaces
591 #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
592 #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
594 #define ACPI_NOT_ISR 0x1
599 #define ACPI_SYSTEM_NOTIFY 0x1
600 #define ACPI_DEVICE_NOTIFY 0x2
601 #define ACPI_ALL_NOTIFY 0x3
602 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
604 #define ACPI_MAX_SYS_NOTIFY 0x7f
606 /* Address Space (Operation Region) Types */
608 typedef u8 acpi_adr_space_type;
610 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
611 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
612 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
613 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
614 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
615 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
616 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
617 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7
618 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
622 * These are bitfields defined within the full ACPI registers
624 #define ACPI_BITREG_TIMER_STATUS 0x00
625 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
626 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
627 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
628 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
629 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
630 #define ACPI_BITREG_WAKE_STATUS 0x06
631 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
633 #define ACPI_BITREG_TIMER_ENABLE 0x08
634 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
635 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
636 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
637 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
638 #define ACPI_BITREG_WAKE_ENABLE 0x0D
639 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E
641 #define ACPI_BITREG_SCI_ENABLE 0x0F
642 #define ACPI_BITREG_BUS_MASTER_RLD 0x10
643 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11
644 #define ACPI_BITREG_SLEEP_TYPE_A 0x12
645 #define ACPI_BITREG_SLEEP_TYPE_B 0x13
646 #define ACPI_BITREG_SLEEP_ENABLE 0x14
648 #define ACPI_BITREG_ARB_DISABLE 0x15
650 #define ACPI_BITREG_MAX 0x15
651 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
654 * External ACPI object definition
657 acpi_object_type type; /* See definition of acpi_ns_type for values */
659 acpi_object_type type;
660 acpi_integer value; /* The actual number */
664 acpi_object_type type;
665 u32 length; /* # of bytes in string, excluding trailing null */
666 char *pointer; /* points to the string value */
670 acpi_object_type type;
671 u32 length; /* # of bytes in buffer */
672 u8 *pointer; /* points to the buffer */
676 acpi_object_type type;
678 acpi_handle handle; /* object reference */
682 acpi_object_type type;
683 u32 count; /* # of elements in package */
684 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
688 acpi_object_type type;
690 acpi_io_address pblk_address;
695 acpi_object_type type;
702 * List of objects, used as a parameter list for control method evaluation
704 struct acpi_object_list {
706 union acpi_object *pointer;
710 * Miscellaneous common Data Structures used by the interfaces
712 #define ACPI_NO_BUFFER 0
713 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
714 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
717 acpi_size length; /* Length in bytes of the buffer */
718 void *pointer; /* pointer to buffer */
722 * name_type for acpi_get_name
724 #define ACPI_FULL_PATHNAME 0
725 #define ACPI_SINGLE_NAME 1
726 #define ACPI_NAME_TYPE_MAX 1
729 * Structure and flags for acpi_get_system_info
731 #define ACPI_SYS_MODE_UNKNOWN 0x0000
732 #define ACPI_SYS_MODE_ACPI 0x0001
733 #define ACPI_SYS_MODE_LEGACY 0x0002
734 #define ACPI_SYS_MODES_MASK 0x0003
737 * System info returned by acpi_get_system_info()
739 struct acpi_system_info {
742 u32 timer_resolution;
750 * Types specific to the OS service interfaces
752 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
755 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
758 * Various handlers and callback procedures
760 typedef u32(*acpi_event_handler) (void *context);
763 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
766 void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
768 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
770 #define ACPI_INIT_DEVICE_INI 1
773 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
776 u32 aml_offset, void *context);
778 /* Address Spaces (For Operation Regions) */
781 acpi_status(*acpi_adr_space_handler) (u32 function,
782 acpi_physical_address address,
784 acpi_integer * value,
785 void *handler_context,
786 void *region_context);
788 #define ACPI_DEFAULT_HANDLER NULL
791 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
793 void *handler_context,
794 void **region_context);
796 #define ACPI_REGION_ACTIVATE 0
797 #define ACPI_REGION_DEACTIVATE 1
800 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
802 void *context, void **return_value);
804 /* Interrupt handler return values */
806 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
807 #define ACPI_INTERRUPT_HANDLED 0x01
809 /* Common string version of device HIDs and UIDs */
811 struct acpi_device_id {
812 char value[ACPI_DEVICE_ID_LENGTH];
815 /* Common string version of device CIDs */
817 struct acpi_compatible_id {
818 char value[ACPI_MAX_CID_LENGTH];
821 struct acpi_compatible_id_list {
824 struct acpi_compatible_id id[1];
827 /* Structure and flags for acpi_get_object_info */
829 #define ACPI_VALID_STA 0x0001
830 #define ACPI_VALID_ADR 0x0002
831 #define ACPI_VALID_HID 0x0004
832 #define ACPI_VALID_UID 0x0008
833 #define ACPI_VALID_CID 0x0010
834 #define ACPI_VALID_SXDS 0x0020
836 /* Flags for _STA method */
838 #define ACPI_STA_DEVICE_PRESENT 0x01
839 #define ACPI_STA_DEVICE_ENABLED 0x02
840 #define ACPI_STA_DEVICE_UI 0x04
841 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
842 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
843 #define ACPI_STA_BATTERY_PRESENT 0x10
845 #define ACPI_COMMON_OBJ_INFO \
846 acpi_object_type type; /* ACPI object type */ \
847 acpi_name name /* ACPI object Name */
849 struct acpi_obj_info_header {
850 ACPI_COMMON_OBJ_INFO;
853 /* Structure returned from Get Object Info */
855 struct acpi_device_info {
856 ACPI_COMMON_OBJ_INFO;
858 u32 valid; /* Indicates which fields below are valid */
859 u32 current_status; /* _STA value */
860 acpi_integer address; /* _ADR value if any */
861 struct acpi_device_id hardware_id; /* _HID value if any */
862 struct acpi_device_id unique_id; /* _UID value if any */
863 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
864 struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */
867 /* Context structs for address space handlers */
876 struct acpi_mem_space_context {
878 acpi_physical_address address;
879 acpi_physical_address mapped_physical_address;
880 u8 *mapped_logical_address;
881 acpi_size mapped_length;
885 * Definitions for Resource Attributes
887 typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
888 typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64_k-1)+3 */
893 #define ACPI_READ_ONLY_MEMORY (u8) 0x00
894 #define ACPI_READ_WRITE_MEMORY (u8) 0x01
896 #define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
897 #define ACPI_CACHABLE_MEMORY (u8) 0x01
898 #define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
899 #define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
903 * The ISA IO ranges are: n000-n0_fFh, n400-n4_fFh, n800-n8_fFh, n_c00-n_cFFh.
904 * The non-ISA IO ranges are: n100-n3_fFh, n500-n7_fFh, n900-n_bFFh, n_cd0-n_fFFh.
906 #define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
907 #define ACPI_ISA_ONLY_RANGES (u8) 0x02
908 #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
910 /* Type of translation - 1=Sparse, 0=Dense */
912 #define ACPI_SPARSE_TRANSLATION (u8) 0x01
915 * IO Port Descriptor Decode
917 #define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
918 #define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
923 #define ACPI_LEVEL_SENSITIVE (u8) 0x00
924 #define ACPI_EDGE_SENSITIVE (u8) 0x01
926 #define ACPI_ACTIVE_HIGH (u8) 0x00
927 #define ACPI_ACTIVE_LOW (u8) 0x01
929 #define ACPI_EXCLUSIVE (u8) 0x00
930 #define ACPI_SHARED (u8) 0x01
935 #define ACPI_COMPATIBILITY (u8) 0x00
936 #define ACPI_TYPE_A (u8) 0x01
937 #define ACPI_TYPE_B (u8) 0x02
938 #define ACPI_TYPE_F (u8) 0x03
940 #define ACPI_NOT_BUS_MASTER (u8) 0x00
941 #define ACPI_BUS_MASTER (u8) 0x01
943 #define ACPI_TRANSFER_8 (u8) 0x00
944 #define ACPI_TRANSFER_8_16 (u8) 0x01
945 #define ACPI_TRANSFER_16 (u8) 0x02
948 * Start Dependent Functions Priority definitions
950 #define ACPI_GOOD_CONFIGURATION (u8) 0x00
951 #define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
952 #define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
955 * 16, 32 and 64-bit Address Descriptor resource types
957 #define ACPI_MEMORY_RANGE (u8) 0x00
958 #define ACPI_IO_RANGE (u8) 0x01
959 #define ACPI_BUS_NUMBER_RANGE (u8) 0x02
961 #define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
962 #define ACPI_ADDRESS_FIXED (u8) 0x01
964 #define ACPI_POS_DECODE (u8) 0x00
965 #define ACPI_SUB_DECODE (u8) 0x01
967 #define ACPI_PRODUCER (u8) 0x00
968 #define ACPI_CONSUMER (u8) 0x01
971 * If possible, pack the following structures to byte alignment
973 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
977 /* UUID data structures for use in vendor-defined resource descriptors */
980 u8 data[ACPI_UUID_LENGTH];
983 struct acpi_vendor_uuid {
985 u8 data[ACPI_UUID_LENGTH];
989 * Structures used to describe device resources
991 struct acpi_resource_irq {
999 struct acpi_resource_dma {
1007 struct acpi_resource_start_dependent {
1008 u8 compatibility_priority;
1009 u8 performance_robustness;
1013 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1014 * needed because it has no fields
1017 struct acpi_resource_io {
1025 struct acpi_resource_fixed_io {
1030 struct acpi_resource_vendor {
1035 /* Vendor resource with UUID info (introduced in ACPI 3.0) */
1037 struct acpi_resource_vendor_typed {
1040 u8 uuid[ACPI_UUID_LENGTH];
1044 struct acpi_resource_end_tag {
1048 struct acpi_resource_memory24 {
1056 struct acpi_resource_memory32 {
1064 struct acpi_resource_fixed_memory32 {
1070 struct acpi_memory_attribute {
1077 struct acpi_io_attribute {
1080 u8 translation_type;
1084 union acpi_resource_attribute {
1085 struct acpi_memory_attribute mem;
1086 struct acpi_io_attribute io;
1088 /* Used for the *word_space macros */
1093 struct acpi_resource_source {
1099 /* Fields common to all address descriptors, 16/32/64 bit */
1101 #define ACPI_RESOURCE_ADDRESS_COMMON \
1103 u8 producer_consumer; \
1105 u8 min_address_fixed; \
1106 u8 max_address_fixed; \
1107 union acpi_resource_attribute info;
1109 struct acpi_resource_address {
1110 ACPI_RESOURCE_ADDRESS_COMMON};
1112 struct acpi_resource_address16 {
1113 ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
1116 u16 translation_offset;
1118 struct acpi_resource_source resource_source;
1121 struct acpi_resource_address32 {
1122 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1125 u32 translation_offset;
1127 struct acpi_resource_source resource_source;
1130 struct acpi_resource_address64 {
1131 ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
1134 u64 translation_offset;
1136 struct acpi_resource_source resource_source;
1139 struct acpi_resource_extended_address64 {
1140 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD;
1144 u64 translation_offset;
1149 struct acpi_resource_extended_irq {
1150 u8 producer_consumer;
1155 struct acpi_resource_source resource_source;
1159 struct acpi_resource_generic_register {
1167 /* ACPI_RESOURCE_TYPEs */
1169 #define ACPI_RESOURCE_TYPE_IRQ 0
1170 #define ACPI_RESOURCE_TYPE_DMA 1
1171 #define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
1172 #define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
1173 #define ACPI_RESOURCE_TYPE_IO 4
1174 #define ACPI_RESOURCE_TYPE_FIXED_IO 5
1175 #define ACPI_RESOURCE_TYPE_VENDOR 6
1176 #define ACPI_RESOURCE_TYPE_END_TAG 7
1177 #define ACPI_RESOURCE_TYPE_MEMORY24 8
1178 #define ACPI_RESOURCE_TYPE_MEMORY32 9
1179 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
1180 #define ACPI_RESOURCE_TYPE_ADDRESS16 11
1181 #define ACPI_RESOURCE_TYPE_ADDRESS32 12
1182 #define ACPI_RESOURCE_TYPE_ADDRESS64 13
1183 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
1184 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
1185 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
1186 #define ACPI_RESOURCE_TYPE_MAX 16
1188 union acpi_resource_data {
1189 struct acpi_resource_irq irq;
1190 struct acpi_resource_dma dma;
1191 struct acpi_resource_start_dependent start_dpf;
1192 struct acpi_resource_io io;
1193 struct acpi_resource_fixed_io fixed_io;
1194 struct acpi_resource_vendor vendor;
1195 struct acpi_resource_vendor_typed vendor_typed;
1196 struct acpi_resource_end_tag end_tag;
1197 struct acpi_resource_memory24 memory24;
1198 struct acpi_resource_memory32 memory32;
1199 struct acpi_resource_fixed_memory32 fixed_memory32;
1200 struct acpi_resource_address16 address16;
1201 struct acpi_resource_address32 address32;
1202 struct acpi_resource_address64 address64;
1203 struct acpi_resource_extended_address64 ext_address64;
1204 struct acpi_resource_extended_irq extended_irq;
1205 struct acpi_resource_generic_register generic_reg;
1209 struct acpi_resource_address address; /* Common 16/32/64 address fields */
1212 struct acpi_resource {
1215 union acpi_resource_data data;
1218 /* restore default alignment */
1222 #define ACPI_RS_SIZE_MIN 12
1223 #define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
1224 #define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
1226 #define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length)
1228 struct acpi_pci_routing_table {
1231 acpi_integer address; /* here for 64-bit alignment */
1233 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
1236 #endif /* __ACTYPES_H__ */