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_table_ptr;
153 typedef u64 acpi_io_address;
154 typedef u64 acpi_physical_address;
156 #define ACPI_MAX_PTR ACPI_UINT64_MAX
157 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
159 #define ACPI_NATIVE_BOUNDARY 8
160 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
163 * In the case of the Itanium Processor Family (IPF), the hardware does not
164 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
165 * to indicate that special precautions must be taken to avoid alignment faults.
166 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
168 * Note: Em64_t and other X86-64 processors support misaligned transfers,
169 * so there is no need to define this flag.
171 #if defined (__IA64__) || defined (__ia64__)
172 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
175 /*******************************************************************************
177 * Types specific to 32-bit targets
179 ******************************************************************************/
181 #elif ACPI_MACHINE_WIDTH == 32
183 /*! [Begin] no source code translation (keep the typedefs as-is) */
185 typedef unsigned int UINT32;
188 /*! [End] no source code translation !*/
190 typedef u32 acpi_native_uint;
191 typedef s32 acpi_native_int;
193 typedef u64 acpi_table_ptr;
194 typedef u32 acpi_io_address;
195 typedef u32 acpi_physical_address;
197 #define ACPI_MAX_PTR ACPI_UINT32_MAX
198 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
200 #define ACPI_NATIVE_BOUNDARY 4
202 /*******************************************************************************
204 * Types specific to 16-bit targets
206 ******************************************************************************/
208 #elif ACPI_MACHINE_WIDTH == 16
210 /*! [Begin] no source code translation (keep the typedefs as-is) */
212 typedef unsigned long UINT32;
216 /*! [End] no source code translation !*/
218 typedef u16 acpi_native_uint;
219 typedef s16 acpi_native_int;
221 typedef u32 acpi_table_ptr;
222 typedef u32 acpi_io_address;
223 typedef char *acpi_physical_address;
225 #define ACPI_MAX_PTR ACPI_UINT16_MAX
226 #define ACPI_SIZE_MAX ACPI_UINT16_MAX
228 #define ACPI_NATIVE_BOUNDARY 2
229 #define ACPI_USE_NATIVE_DIVIDE /* No 64-bit integers, ok to use native divide */
231 /* 64-bit integers cannot be supported */
233 #define ACPI_NO_INTEGER64_SUPPORT
237 /* ACPI_MACHINE_WIDTH must be either 64, 32, or 16 */
239 #error unknown ACPI_MACHINE_WIDTH
242 /* Variable-width type, used instead of clib size_t */
244 typedef acpi_native_uint acpi_size;
246 /*******************************************************************************
248 * OS-dependent and compiler-dependent types
250 * If the defaults below are not appropriate for the host system, they can
251 * be defined in the compiler-specific or OS-specific header, and this will
254 ******************************************************************************/
256 /* Value returned by acpi_os_get_thread_id */
258 #ifndef acpi_thread_id
259 #define acpi_thread_id acpi_native_uint
262 /* Object returned from acpi_os_create_lock */
264 #ifndef acpi_spinlock
265 #define acpi_spinlock void *
268 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
270 #ifndef acpi_cpu_flags
271 #define acpi_cpu_flags acpi_native_uint
274 /* Object returned from acpi_os_create_cache */
277 #define acpi_cache_t struct acpi_memory_list
280 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
282 #ifndef acpi_uintptr_t
283 #define acpi_uintptr_t void *
287 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
288 * some compilers can catch printf format string problems
290 #ifndef ACPI_PRINTF_LIKE
291 #define ACPI_PRINTF_LIKE(c)
295 * Some compilers complain about unused variables. Sometimes we don't want to
296 * use all the variables (for example, _acpi_module_name). This allows us
297 * to to tell the compiler in a per-variable manner that a variable
300 #ifndef ACPI_UNUSED_VAR
301 #define ACPI_UNUSED_VAR
305 * All ACPICA functions that are available to the rest of the kernel are
306 * tagged with this macro which can be defined as appropriate for the host.
308 #ifndef ACPI_EXPORT_SYMBOL
309 #define ACPI_EXPORT_SYMBOL(symbol)
312 /*******************************************************************************
316 ******************************************************************************/
318 /* Logical defines and NULL */
323 #define FALSE (1 == 0)
328 #define TRUE (1 == 1)
331 #define NULL (void *) 0
335 * Mescellaneous types
337 typedef u32 acpi_status; /* All ACPI Exceptions */
338 typedef u32 acpi_name; /* 4-byte ACPI name */
339 typedef char *acpi_string; /* Null terminated ASCII string */
340 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
342 struct uint64_struct {
347 union uint64_overlay {
349 struct uint64_struct part;
352 struct uint32_struct {
357 /* Synchronization objects */
359 #define acpi_mutex void *
360 #define acpi_semaphore void *
363 * Acpi integer width. In ACPI version 1, integers are
364 * 32 bits. In ACPI version 2, integers are 64 bits.
365 * Note that this pertains to the ACPI integer type only, not
366 * other integers used in the implementation of the ACPI CA
369 #ifdef ACPI_NO_INTEGER64_SUPPORT
371 /* 32-bit integers only, no 64-bit support */
373 typedef u32 acpi_integer;
374 #define ACPI_INTEGER_MAX ACPI_UINT32_MAX
375 #define ACPI_INTEGER_BIT_SIZE 32
376 #define ACPI_MAX_DECIMAL_DIGITS 10 /* 2^32 = 4,294,967,296 */
378 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */
382 /* 64-bit integers */
384 typedef u64 acpi_integer;
385 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
386 #define ACPI_INTEGER_BIT_SIZE 64
387 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
389 #if ACPI_MACHINE_WIDTH == 64
390 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
394 #define ACPI_MAX64_DECIMAL_DIGITS 20
395 #define ACPI_MAX32_DECIMAL_DIGITS 10
396 #define ACPI_MAX16_DECIMAL_DIGITS 5
397 #define ACPI_MAX8_DECIMAL_DIGITS 3
400 * Constants with special meanings
402 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
405 * Initialization sequence
407 #define ACPI_FULL_INITIALIZATION 0x00
408 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
409 #define ACPI_NO_HARDWARE_INIT 0x02
410 #define ACPI_NO_EVENT_INIT 0x04
411 #define ACPI_NO_HANDLER_INIT 0x08
412 #define ACPI_NO_ACPI_ENABLE 0x10
413 #define ACPI_NO_DEVICE_INIT 0x20
414 #define ACPI_NO_OBJECT_INIT 0x40
417 * Initialization state
419 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
420 #define ACPI_INITIALIZED_OK 0x02
425 #define ACPI_STATE_UNKNOWN (u8) 0xFF
427 #define ACPI_STATE_S0 (u8) 0
428 #define ACPI_STATE_S1 (u8) 1
429 #define ACPI_STATE_S2 (u8) 2
430 #define ACPI_STATE_S3 (u8) 3
431 #define ACPI_STATE_S4 (u8) 4
432 #define ACPI_STATE_S5 (u8) 5
433 #define ACPI_S_STATES_MAX ACPI_STATE_S5
434 #define ACPI_S_STATE_COUNT 6
436 #define ACPI_STATE_D0 (u8) 0
437 #define ACPI_STATE_D1 (u8) 1
438 #define ACPI_STATE_D2 (u8) 2
439 #define ACPI_STATE_D3 (u8) 3
440 #define ACPI_D_STATES_MAX ACPI_STATE_D3
441 #define ACPI_D_STATE_COUNT 4
443 #define ACPI_STATE_C0 (u8) 0
444 #define ACPI_STATE_C1 (u8) 1
445 #define ACPI_STATE_C2 (u8) 2
446 #define ACPI_STATE_C3 (u8) 3
447 #define ACPI_C_STATES_MAX ACPI_STATE_C3
448 #define ACPI_C_STATE_COUNT 4
451 * Sleep type invalid value
453 #define ACPI_SLEEP_TYPE_MAX 0x7
454 #define ACPI_SLEEP_TYPE_INVALID 0xFF
457 * Standard notify values
459 #define ACPI_NOTIFY_BUS_CHECK (u8) 0
460 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 1
461 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 2
462 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 3
463 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 4
464 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 5
465 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 6
466 #define ACPI_NOTIFY_POWER_FAULT (u8) 7
469 * Types associated with ACPI names and objects. The first group of
470 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
471 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
472 * only add to the first group if the spec changes.
474 * NOTE: Types must be kept in sync with the global acpi_ns_properties
475 * and acpi_ns_type_names arrays.
477 typedef u32 acpi_object_type;
479 #define ACPI_TYPE_ANY 0x00
480 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
481 #define ACPI_TYPE_STRING 0x02
482 #define ACPI_TYPE_BUFFER 0x03
483 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
484 #define ACPI_TYPE_FIELD_UNIT 0x05
485 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
486 #define ACPI_TYPE_EVENT 0x07
487 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
488 #define ACPI_TYPE_MUTEX 0x09
489 #define ACPI_TYPE_REGION 0x0A
490 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
491 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
492 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
493 #define ACPI_TYPE_BUFFER_FIELD 0x0E
494 #define ACPI_TYPE_DDB_HANDLE 0x0F
495 #define ACPI_TYPE_DEBUG_OBJECT 0x10
497 #define ACPI_TYPE_EXTERNAL_MAX 0x10
500 * These are object types that do not map directly to the ACPI
501 * object_type() operator. They are used for various internal purposes only.
502 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
503 * internal types must move upwards. (There is code that depends on these
504 * values being contiguous with the external types above.)
506 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
507 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
508 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
509 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
510 #define ACPI_TYPE_LOCAL_ALIAS 0x15
511 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
512 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
513 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
514 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
515 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
516 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
518 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
521 * These are special object types that never appear in
522 * a Namespace node, only in an union acpi_operand_object
524 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
525 #define ACPI_TYPE_LOCAL_DATA 0x1D
527 #define ACPI_TYPE_LOCAL_MAX 0x1D
529 /* All types above here are invalid */
531 #define ACPI_TYPE_INVALID 0x1E
532 #define ACPI_TYPE_NOT_FOUND 0xFF
539 #define ACPI_IO_MASK 1
542 * Event Types: Fixed & General Purpose
544 typedef u32 acpi_event_type;
549 #define ACPI_EVENT_PMTIMER 0
550 #define ACPI_EVENT_GLOBAL 1
551 #define ACPI_EVENT_POWER_BUTTON 2
552 #define ACPI_EVENT_SLEEP_BUTTON 3
553 #define ACPI_EVENT_RTC 4
554 #define ACPI_EVENT_MAX 4
555 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
558 * Event Status - Per event
560 * The encoding of acpi_event_status is illustrated below.
561 * Note that a set bit (1) indicates the property is TRUE
562 * (e.g. if bit 0 is set then the event is enabled).
563 * +-------------+-+-+-+
564 * | Bits 31:3 |2|1|0|
565 * +-------------+-+-+-+
568 * | | +--- Enabled for wake?
570 * +----------- <Reserved>
572 typedef u32 acpi_event_status;
574 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
575 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
576 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
577 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
580 * General Purpose Events (GPE)
582 #define ACPI_GPE_INVALID 0xFF
583 #define ACPI_GPE_MAX 0xFF
584 #define ACPI_NUM_GPE 256
586 #define ACPI_GPE_ENABLE 0
587 #define ACPI_GPE_DISABLE 1
590 * GPE info flags - Per GPE
595 * | | | | | +--- Interrupt type: Edge or Level Triggered
596 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
597 * | | | +--- Type of dispatch -- to method, handler, or none
598 * | | +--- Enabled for runtime?
599 * | +--- Enabled for wake?
602 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
603 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
604 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
606 #define ACPI_GPE_TYPE_MASK (u8) 0x06
607 #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
608 #define ACPI_GPE_TYPE_WAKE (u8) 0x02
609 #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
611 #define ACPI_GPE_DISPATCH_MASK (u8) 0x18
612 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
613 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
614 #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
616 #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
617 #define ACPI_GPE_RUN_ENABLED (u8) 0x20
618 #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
620 #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
621 #define ACPI_GPE_WAKE_ENABLED (u8) 0x40
622 #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
624 #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
627 * Flags for GPE and Lock interfaces
629 #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
630 #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
632 #define ACPI_NOT_ISR 0x1
637 #define ACPI_SYSTEM_NOTIFY 0x1
638 #define ACPI_DEVICE_NOTIFY 0x2
639 #define ACPI_ALL_NOTIFY 0x3
640 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
642 #define ACPI_MAX_SYS_NOTIFY 0x7f
644 /* Address Space (Operation Region) Types */
646 typedef u8 acpi_adr_space_type;
648 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
649 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
650 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
651 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
652 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
653 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
654 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
655 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7
656 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
660 * These are bitfields defined within the full ACPI registers
662 #define ACPI_BITREG_TIMER_STATUS 0x00
663 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
664 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
665 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
666 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
667 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
668 #define ACPI_BITREG_WAKE_STATUS 0x06
669 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
671 #define ACPI_BITREG_TIMER_ENABLE 0x08
672 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
673 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
674 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
675 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
676 #define ACPI_BITREG_WAKE_ENABLE 0x0D
677 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E
679 #define ACPI_BITREG_SCI_ENABLE 0x0F
680 #define ACPI_BITREG_BUS_MASTER_RLD 0x10
681 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11
682 #define ACPI_BITREG_SLEEP_TYPE_A 0x12
683 #define ACPI_BITREG_SLEEP_TYPE_B 0x13
684 #define ACPI_BITREG_SLEEP_ENABLE 0x14
686 #define ACPI_BITREG_ARB_DISABLE 0x15
688 #define ACPI_BITREG_MAX 0x15
689 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
692 * External ACPI object definition
695 acpi_object_type type; /* See definition of acpi_ns_type for values */
697 acpi_object_type type;
698 acpi_integer value; /* The actual number */
702 acpi_object_type type;
703 u32 length; /* # of bytes in string, excluding trailing null */
704 char *pointer; /* points to the string value */
708 acpi_object_type type;
709 u32 length; /* # of bytes in buffer */
710 u8 *pointer; /* points to the buffer */
714 acpi_object_type type;
716 acpi_handle handle; /* object reference */
720 acpi_object_type type;
721 u32 count; /* # of elements in package */
722 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
726 acpi_object_type type;
728 acpi_io_address pblk_address;
733 acpi_object_type type;
740 * List of objects, used as a parameter list for control method evaluation
742 struct acpi_object_list {
744 union acpi_object *pointer;
748 * Miscellaneous common Data Structures used by the interfaces
750 #define ACPI_NO_BUFFER 0
751 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
752 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
755 acpi_size length; /* Length in bytes of the buffer */
756 void *pointer; /* pointer to buffer */
760 * name_type for acpi_get_name
762 #define ACPI_FULL_PATHNAME 0
763 #define ACPI_SINGLE_NAME 1
764 #define ACPI_NAME_TYPE_MAX 1
767 * Structure and flags for acpi_get_system_info
769 #define ACPI_SYS_MODE_UNKNOWN 0x0000
770 #define ACPI_SYS_MODE_ACPI 0x0001
771 #define ACPI_SYS_MODE_LEGACY 0x0002
772 #define ACPI_SYS_MODES_MASK 0x0003
775 * System info returned by acpi_get_system_info()
777 struct acpi_system_info {
780 u32 timer_resolution;
788 * Types specific to the OS service interfaces
790 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
793 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
796 * Various handlers and callback procedures
798 typedef u32(*acpi_event_handler) (void *context);
801 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
804 void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
806 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
808 #define ACPI_INIT_DEVICE_INI 1
811 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
814 u32 aml_offset, void *context);
816 /* Address Spaces (For Operation Regions) */
819 acpi_status(*acpi_adr_space_handler) (u32 function,
820 acpi_physical_address address,
822 acpi_integer * value,
823 void *handler_context,
824 void *region_context);
826 #define ACPI_DEFAULT_HANDLER NULL
829 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
831 void *handler_context,
832 void **region_context);
834 #define ACPI_REGION_ACTIVATE 0
835 #define ACPI_REGION_DEACTIVATE 1
838 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
840 void *context, void **return_value);
842 /* Interrupt handler return values */
844 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
845 #define ACPI_INTERRUPT_HANDLED 0x01
847 /* Common string version of device HIDs and UIDs */
849 struct acpi_device_id {
850 char value[ACPI_DEVICE_ID_LENGTH];
853 /* Common string version of device CIDs */
855 struct acpi_compatible_id {
856 char value[ACPI_MAX_CID_LENGTH];
859 struct acpi_compatible_id_list {
862 struct acpi_compatible_id id[1];
865 /* Structure and flags for acpi_get_object_info */
867 #define ACPI_VALID_STA 0x0001
868 #define ACPI_VALID_ADR 0x0002
869 #define ACPI_VALID_HID 0x0004
870 #define ACPI_VALID_UID 0x0008
871 #define ACPI_VALID_CID 0x0010
872 #define ACPI_VALID_SXDS 0x0020
874 /* Flags for _STA method */
876 #define ACPI_STA_DEVICE_PRESENT 0x01
877 #define ACPI_STA_DEVICE_ENABLED 0x02
878 #define ACPI_STA_DEVICE_UI 0x04
879 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
880 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
881 #define ACPI_STA_BATTERY_PRESENT 0x10
883 #define ACPI_COMMON_OBJ_INFO \
884 acpi_object_type type; /* ACPI object type */ \
885 acpi_name name /* ACPI object Name */
887 struct acpi_obj_info_header {
888 ACPI_COMMON_OBJ_INFO;
891 /* Structure returned from Get Object Info */
893 struct acpi_device_info {
894 ACPI_COMMON_OBJ_INFO;
896 u32 valid; /* Indicates which fields below are valid */
897 u32 current_status; /* _STA value */
898 acpi_integer address; /* _ADR value if any */
899 struct acpi_device_id hardware_id; /* _HID value if any */
900 struct acpi_device_id unique_id; /* _UID value if any */
901 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
902 struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */
905 /* Context structs for address space handlers */
914 struct acpi_mem_space_context {
916 acpi_physical_address address;
917 acpi_physical_address mapped_physical_address;
918 u8 *mapped_logical_address;
919 acpi_size mapped_length;
923 * Definitions for Resource Attributes
925 typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
926 typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64_k-1)+3 */
931 #define ACPI_READ_ONLY_MEMORY (u8) 0x00
932 #define ACPI_READ_WRITE_MEMORY (u8) 0x01
934 #define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
935 #define ACPI_CACHABLE_MEMORY (u8) 0x01
936 #define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
937 #define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
941 * The ISA IO ranges are: n000-n0_fFh, n400-n4_fFh, n800-n8_fFh, n_c00-n_cFFh.
942 * The non-ISA IO ranges are: n100-n3_fFh, n500-n7_fFh, n900-n_bFFh, n_cd0-n_fFFh.
944 #define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
945 #define ACPI_ISA_ONLY_RANGES (u8) 0x02
946 #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
948 /* Type of translation - 1=Sparse, 0=Dense */
950 #define ACPI_SPARSE_TRANSLATION (u8) 0x01
953 * IO Port Descriptor Decode
955 #define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
956 #define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
961 #define ACPI_LEVEL_SENSITIVE (u8) 0x00
962 #define ACPI_EDGE_SENSITIVE (u8) 0x01
964 #define ACPI_ACTIVE_HIGH (u8) 0x00
965 #define ACPI_ACTIVE_LOW (u8) 0x01
967 #define ACPI_EXCLUSIVE (u8) 0x00
968 #define ACPI_SHARED (u8) 0x01
973 #define ACPI_COMPATIBILITY (u8) 0x00
974 #define ACPI_TYPE_A (u8) 0x01
975 #define ACPI_TYPE_B (u8) 0x02
976 #define ACPI_TYPE_F (u8) 0x03
978 #define ACPI_NOT_BUS_MASTER (u8) 0x00
979 #define ACPI_BUS_MASTER (u8) 0x01
981 #define ACPI_TRANSFER_8 (u8) 0x00
982 #define ACPI_TRANSFER_8_16 (u8) 0x01
983 #define ACPI_TRANSFER_16 (u8) 0x02
986 * Start Dependent Functions Priority definitions
988 #define ACPI_GOOD_CONFIGURATION (u8) 0x00
989 #define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
990 #define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
993 * 16, 32 and 64-bit Address Descriptor resource types
995 #define ACPI_MEMORY_RANGE (u8) 0x00
996 #define ACPI_IO_RANGE (u8) 0x01
997 #define ACPI_BUS_NUMBER_RANGE (u8) 0x02
999 #define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
1000 #define ACPI_ADDRESS_FIXED (u8) 0x01
1002 #define ACPI_POS_DECODE (u8) 0x00
1003 #define ACPI_SUB_DECODE (u8) 0x01
1005 #define ACPI_PRODUCER (u8) 0x00
1006 #define ACPI_CONSUMER (u8) 0x01
1009 * If possible, pack the following structures to byte alignment
1011 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
1015 /* UUID data structures for use in vendor-defined resource descriptors */
1018 u8 data[ACPI_UUID_LENGTH];
1021 struct acpi_vendor_uuid {
1023 u8 data[ACPI_UUID_LENGTH];
1027 * Structures used to describe device resources
1029 struct acpi_resource_irq {
1037 struct acpi_resource_dma {
1045 struct acpi_resource_start_dependent {
1046 u8 compatibility_priority;
1047 u8 performance_robustness;
1051 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1052 * needed because it has no fields
1055 struct acpi_resource_io {
1063 struct acpi_resource_fixed_io {
1068 struct acpi_resource_vendor {
1073 /* Vendor resource with UUID info (introduced in ACPI 3.0) */
1075 struct acpi_resource_vendor_typed {
1078 u8 uuid[ACPI_UUID_LENGTH];
1082 struct acpi_resource_end_tag {
1086 struct acpi_resource_memory24 {
1094 struct acpi_resource_memory32 {
1102 struct acpi_resource_fixed_memory32 {
1108 struct acpi_memory_attribute {
1115 struct acpi_io_attribute {
1118 u8 translation_type;
1122 union acpi_resource_attribute {
1123 struct acpi_memory_attribute mem;
1124 struct acpi_io_attribute io;
1126 /* Used for the *word_space macros */
1131 struct acpi_resource_source {
1137 /* Fields common to all address descriptors, 16/32/64 bit */
1139 #define ACPI_RESOURCE_ADDRESS_COMMON \
1141 u8 producer_consumer; \
1143 u8 min_address_fixed; \
1144 u8 max_address_fixed; \
1145 union acpi_resource_attribute info;
1147 struct acpi_resource_address {
1148 ACPI_RESOURCE_ADDRESS_COMMON};
1150 struct acpi_resource_address16 {
1151 ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
1154 u16 translation_offset;
1156 struct acpi_resource_source resource_source;
1159 struct acpi_resource_address32 {
1160 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1163 u32 translation_offset;
1165 struct acpi_resource_source resource_source;
1168 struct acpi_resource_address64 {
1169 ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
1172 u64 translation_offset;
1174 struct acpi_resource_source resource_source;
1177 struct acpi_resource_extended_address64 {
1178 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD;
1182 u64 translation_offset;
1187 struct acpi_resource_extended_irq {
1188 u8 producer_consumer;
1193 struct acpi_resource_source resource_source;
1197 struct acpi_resource_generic_register {
1205 /* ACPI_RESOURCE_TYPEs */
1207 #define ACPI_RESOURCE_TYPE_IRQ 0
1208 #define ACPI_RESOURCE_TYPE_DMA 1
1209 #define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
1210 #define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
1211 #define ACPI_RESOURCE_TYPE_IO 4
1212 #define ACPI_RESOURCE_TYPE_FIXED_IO 5
1213 #define ACPI_RESOURCE_TYPE_VENDOR 6
1214 #define ACPI_RESOURCE_TYPE_END_TAG 7
1215 #define ACPI_RESOURCE_TYPE_MEMORY24 8
1216 #define ACPI_RESOURCE_TYPE_MEMORY32 9
1217 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
1218 #define ACPI_RESOURCE_TYPE_ADDRESS16 11
1219 #define ACPI_RESOURCE_TYPE_ADDRESS32 12
1220 #define ACPI_RESOURCE_TYPE_ADDRESS64 13
1221 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
1222 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
1223 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
1224 #define ACPI_RESOURCE_TYPE_MAX 16
1226 union acpi_resource_data {
1227 struct acpi_resource_irq irq;
1228 struct acpi_resource_dma dma;
1229 struct acpi_resource_start_dependent start_dpf;
1230 struct acpi_resource_io io;
1231 struct acpi_resource_fixed_io fixed_io;
1232 struct acpi_resource_vendor vendor;
1233 struct acpi_resource_vendor_typed vendor_typed;
1234 struct acpi_resource_end_tag end_tag;
1235 struct acpi_resource_memory24 memory24;
1236 struct acpi_resource_memory32 memory32;
1237 struct acpi_resource_fixed_memory32 fixed_memory32;
1238 struct acpi_resource_address16 address16;
1239 struct acpi_resource_address32 address32;
1240 struct acpi_resource_address64 address64;
1241 struct acpi_resource_extended_address64 ext_address64;
1242 struct acpi_resource_extended_irq extended_irq;
1243 struct acpi_resource_generic_register generic_reg;
1247 struct acpi_resource_address address; /* Common 16/32/64 address fields */
1250 struct acpi_resource {
1253 union acpi_resource_data data;
1256 /* restore default alignment */
1260 #define ACPI_RS_SIZE_MIN 12
1261 #define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
1262 #define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
1264 #define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length)
1266 struct acpi_pci_routing_table {
1269 acpi_integer address; /* here for 64-bit alignment */
1271 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
1274 #endif /* __ACTYPES_H__ */