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.
48 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
49 * and must be either 16, 32, or 64
51 #ifndef ACPI_MACHINE_WIDTH
52 #error ACPI_MACHINE_WIDTH not defined
55 /*! [Begin] no source code translation */
59 * Note: These macros are designed to be compiler independent as well as
60 * working around problems that some 32-bit compilers have with 64-bit
63 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
64 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
65 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
66 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
67 #define ACPI_ASCII_MAX 0x7F
70 * Architecture-specific ACPICA Subsystem Data Types
72 * The goal of these types is to provide source code portability across
73 * 16-bit, 32-bit, and 64-bit targets.
75 * 1) The following types are of fixed size for all targets (16/32/64):
77 * BOOLEAN Logical boolean
79 * UINT8 8-bit (1 byte) unsigned value
80 * UINT16 16-bit (2 byte) unsigned value
81 * UINT32 32-bit (4 byte) unsigned value
82 * UINT64 64-bit (8 byte) unsigned value
84 * INT16 16-bit (2 byte) signed value
85 * INT32 32-bit (4 byte) signed value
86 * INT64 64-bit (8 byte) signed value
88 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
89 * compiler-dependent header(s) and were introduced because there is no common
90 * 64-bit integer type across the various compilation models, as shown in
93 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
95 * short 16 16 16 16 16 16
97 * int 32 64 32 32 16 16
98 * long 64 64 32 32 32 32
100 * pointer 64 64 64 32 32 32
102 * Note: ILP64 and LP32 are currently not supported.
105 * 2) These types represent the native word size of the target mode of the
106 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
107 * usually used for memory allocation, efficient loop counters, and array
108 * indexes. The types are similar to the size_t type in the C library and are
109 * required because there is no C type that consistently represents the native
112 * ACPI_SIZE 16/32/64-bit unsigned value
113 * ACPI_NATIVE_UINT 16/32/64-bit unsigned value
114 * ACPI_NATIVE_INT 16/32/64-bit signed value
118 /*******************************************************************************
120 * Common types for all compilers, all targets
122 ******************************************************************************/
124 typedef unsigned char BOOLEAN;
125 typedef unsigned char UINT8;
126 typedef unsigned short UINT16;
127 typedef COMPILER_DEPENDENT_UINT64 UINT64;
128 typedef COMPILER_DEPENDENT_INT64 INT64;
130 /*! [End] no source code translation !*/
132 /*******************************************************************************
134 * Types specific to 64-bit targets
136 ******************************************************************************/
138 #if ACPI_MACHINE_WIDTH == 64
140 /*! [Begin] no source code translation (keep the typedefs as-is) */
142 typedef unsigned int UINT32;
145 /*! [End] no source code translation !*/
147 typedef u64 acpi_native_uint;
148 typedef s64 acpi_native_int;
150 typedef u64 acpi_table_ptr;
151 typedef u64 acpi_io_address;
152 typedef u64 acpi_physical_address;
154 #define ACPI_MAX_PTR ACPI_UINT64_MAX
155 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
157 #define ALIGNED_ADDRESS_BOUNDARY 0x00000008
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 u64 acpi_table_ptr;
192 typedef u32 acpi_io_address;
193 typedef u64 acpi_physical_address;
195 #define ACPI_MAX_PTR ACPI_UINT32_MAX
196 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
198 #define ALIGNED_ADDRESS_BOUNDARY 0x00000004
200 /*******************************************************************************
202 * Types specific to 16-bit targets
204 ******************************************************************************/
206 #elif ACPI_MACHINE_WIDTH == 16
208 /*! [Begin] no source code translation (keep the typedefs as-is) */
210 typedef unsigned long UINT32;
214 /*! [End] no source code translation !*/
216 typedef u16 acpi_native_uint;
217 typedef s16 acpi_native_int;
219 typedef u32 acpi_table_ptr;
220 typedef u32 acpi_io_address;
221 typedef char *acpi_physical_address;
223 #define ACPI_MAX_PTR ACPI_UINT16_MAX
224 #define ACPI_SIZE_MAX ACPI_UINT16_MAX
226 #define ALIGNED_ADDRESS_BOUNDARY 0x00000002
227 #define ACPI_USE_NATIVE_DIVIDE /* No 64-bit integers, ok to use native divide */
229 /* 64-bit integers cannot be supported */
231 #define ACPI_NO_INTEGER64_SUPPORT
235 /* ACPI_MACHINE_WIDTH must be either 64, 32, or 16 */
237 #error unknown ACPI_MACHINE_WIDTH
240 /*******************************************************************************
242 * OS- or compiler-dependent types
244 ******************************************************************************/
247 * If acpi_uintptr_t was not defined in the OS- or compiler-dependent header,
248 * define it now (use C99 uintptr_t for pointer casting if available,
249 * "void *" otherwise)
251 #ifndef acpi_uintptr_t
252 #define acpi_uintptr_t void *
256 * If acpi_cache_t was not defined in the OS-dependent header,
257 * define it now. This is typically the case where the local cache
258 * manager implementation is to be used (ACPI_USE_LOCAL_CACHE)
261 #define acpi_cache_t struct acpi_memory_list
264 /* Variable-width type, used instead of clib size_t */
266 typedef acpi_native_uint acpi_size;
268 /*******************************************************************************
272 ******************************************************************************/
275 * Pointer overlays to avoid lots of typecasting for
276 * code that accepts both physical and logical pointers.
278 union acpi_pointers {
279 acpi_physical_address physical;
281 acpi_table_ptr value;
284 struct acpi_pointer {
286 union acpi_pointers pointer;
289 /* pointer_types for above */
291 #define ACPI_PHYSICAL_POINTER 0x01
292 #define ACPI_LOGICAL_POINTER 0x02
296 #define ACPI_PHYSICAL_ADDRESSING 0x04
297 #define ACPI_LOGICAL_ADDRESSING 0x08
298 #define ACPI_MEMORY_MODE 0x0C
300 #define ACPI_PHYSMODE_PHYSPTR ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
301 #define ACPI_LOGMODE_PHYSPTR ACPI_LOGICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
302 #define ACPI_LOGMODE_LOGPTR ACPI_LOGICAL_ADDRESSING | ACPI_LOGICAL_POINTER
304 /* Logical defines and NULL */
309 #define FALSE (1 == 0)
314 #define TRUE (1 == 1)
317 #define NULL (void *) 0
321 * Mescellaneous types
323 typedef u32 acpi_status; /* All ACPI Exceptions */
324 typedef u32 acpi_name; /* 4-byte ACPI name */
325 typedef char *acpi_string; /* Null terminated ASCII string */
326 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
328 struct uint64_struct {
333 union uint64_overlay {
335 struct uint64_struct part;
338 struct uint32_struct {
344 * Acpi integer width. In ACPI version 1, integers are
345 * 32 bits. In ACPI version 2, integers are 64 bits.
346 * Note that this pertains to the ACPI integer type only, not
347 * other integers used in the implementation of the ACPI CA
350 #ifdef ACPI_NO_INTEGER64_SUPPORT
352 /* 32-bit integers only, no 64-bit support */
354 typedef u32 acpi_integer;
355 #define ACPI_INTEGER_MAX ACPI_UINT32_MAX
356 #define ACPI_INTEGER_BIT_SIZE 32
357 #define ACPI_MAX_DECIMAL_DIGITS 10 /* 2^32 = 4,294,967,296 */
359 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */
363 /* 64-bit integers */
365 typedef u64 acpi_integer;
366 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
367 #define ACPI_INTEGER_BIT_SIZE 64
368 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
370 #if ACPI_MACHINE_WIDTH == 64
371 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
375 #define ACPI_MAX64_DECIMAL_DIGITS 20
376 #define ACPI_MAX32_DECIMAL_DIGITS 10
377 #define ACPI_MAX16_DECIMAL_DIGITS 5
378 #define ACPI_MAX8_DECIMAL_DIGITS 3
381 * Constants with special meanings
383 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
386 * Initialization sequence
388 #define ACPI_FULL_INITIALIZATION 0x00
389 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
390 #define ACPI_NO_HARDWARE_INIT 0x02
391 #define ACPI_NO_EVENT_INIT 0x04
392 #define ACPI_NO_HANDLER_INIT 0x08
393 #define ACPI_NO_ACPI_ENABLE 0x10
394 #define ACPI_NO_DEVICE_INIT 0x20
395 #define ACPI_NO_OBJECT_INIT 0x40
398 * Initialization state
400 #define ACPI_INITIALIZED_OK 0x01
405 #define ACPI_STATE_UNKNOWN (u8) 0xFF
407 #define ACPI_STATE_S0 (u8) 0
408 #define ACPI_STATE_S1 (u8) 1
409 #define ACPI_STATE_S2 (u8) 2
410 #define ACPI_STATE_S3 (u8) 3
411 #define ACPI_STATE_S4 (u8) 4
412 #define ACPI_STATE_S5 (u8) 5
413 #define ACPI_S_STATES_MAX ACPI_STATE_S5
414 #define ACPI_S_STATE_COUNT 6
416 #define ACPI_STATE_D0 (u8) 0
417 #define ACPI_STATE_D1 (u8) 1
418 #define ACPI_STATE_D2 (u8) 2
419 #define ACPI_STATE_D3 (u8) 3
420 #define ACPI_D_STATES_MAX ACPI_STATE_D3
421 #define ACPI_D_STATE_COUNT 4
423 #define ACPI_STATE_C0 (u8) 0
424 #define ACPI_STATE_C1 (u8) 1
425 #define ACPI_STATE_C2 (u8) 2
426 #define ACPI_STATE_C3 (u8) 3
427 #define ACPI_C_STATES_MAX ACPI_STATE_C3
428 #define ACPI_C_STATE_COUNT 4
431 * Sleep type invalid value
433 #define ACPI_SLEEP_TYPE_MAX 0x7
434 #define ACPI_SLEEP_TYPE_INVALID 0xFF
437 * Standard notify values
439 #define ACPI_NOTIFY_BUS_CHECK (u8) 0
440 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 1
441 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 2
442 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 3
443 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 4
444 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 5
445 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 6
446 #define ACPI_NOTIFY_POWER_FAULT (u8) 7
449 * Table types. These values are passed to the table related APIs
451 typedef u32 acpi_table_type;
453 #define ACPI_TABLE_RSDP (acpi_table_type) 0
454 #define ACPI_TABLE_DSDT (acpi_table_type) 1
455 #define ACPI_TABLE_FADT (acpi_table_type) 2
456 #define ACPI_TABLE_FACS (acpi_table_type) 3
457 #define ACPI_TABLE_PSDT (acpi_table_type) 4
458 #define ACPI_TABLE_SSDT (acpi_table_type) 5
459 #define ACPI_TABLE_XSDT (acpi_table_type) 6
460 #define ACPI_TABLE_MAX 6
461 #define NUM_ACPI_TABLE_TYPES (ACPI_TABLE_MAX+1)
464 * Types associated with ACPI names and objects. The first group of
465 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
466 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
467 * only add to the first group if the spec changes.
469 * NOTE: Types must be kept in sync with the global acpi_ns_properties
470 * and acpi_ns_type_names arrays.
472 typedef u32 acpi_object_type;
474 #define ACPI_TYPE_ANY 0x00
475 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
476 #define ACPI_TYPE_STRING 0x02
477 #define ACPI_TYPE_BUFFER 0x03
478 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
479 #define ACPI_TYPE_FIELD_UNIT 0x05
480 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
481 #define ACPI_TYPE_EVENT 0x07
482 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
483 #define ACPI_TYPE_MUTEX 0x09
484 #define ACPI_TYPE_REGION 0x0A
485 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
486 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
487 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
488 #define ACPI_TYPE_BUFFER_FIELD 0x0E
489 #define ACPI_TYPE_DDB_HANDLE 0x0F
490 #define ACPI_TYPE_DEBUG_OBJECT 0x10
492 #define ACPI_TYPE_EXTERNAL_MAX 0x10
495 * These are object types that do not map directly to the ACPI
496 * object_type() operator. They are used for various internal purposes only.
497 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
498 * internal types must move upwards. (There is code that depends on these
499 * values being contiguous with the external types above.)
501 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
502 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
503 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
504 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
505 #define ACPI_TYPE_LOCAL_ALIAS 0x15
506 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
507 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
508 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
509 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
510 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
511 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
513 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
516 * These are special object types that never appear in
517 * a Namespace node, only in an union acpi_operand_object
519 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
520 #define ACPI_TYPE_LOCAL_DATA 0x1D
522 #define ACPI_TYPE_LOCAL_MAX 0x1D
524 /* All types above here are invalid */
526 #define ACPI_TYPE_INVALID 0x1E
527 #define ACPI_TYPE_NOT_FOUND 0xFF
534 #define ACPI_IO_MASK 1
537 * Event Types: Fixed & General Purpose
539 typedef u32 acpi_event_type;
544 #define ACPI_EVENT_PMTIMER 0
545 #define ACPI_EVENT_GLOBAL 1
546 #define ACPI_EVENT_POWER_BUTTON 2
547 #define ACPI_EVENT_SLEEP_BUTTON 3
548 #define ACPI_EVENT_RTC 4
549 #define ACPI_EVENT_MAX 4
550 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
553 * Event Status - Per event
555 * The encoding of acpi_event_status is illustrated below.
556 * Note that a set bit (1) indicates the property is TRUE
557 * (e.g. if bit 0 is set then the event is enabled).
558 * +-------------+-+-+-+
559 * | Bits 31:3 |2|1|0|
560 * +-------------+-+-+-+
563 * | | +--- Enabled for wake?
565 * +----------- <Reserved>
567 typedef u32 acpi_event_status;
569 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
570 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
571 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
572 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
575 * General Purpose Events (GPE)
577 #define ACPI_GPE_INVALID 0xFF
578 #define ACPI_GPE_MAX 0xFF
579 #define ACPI_NUM_GPE 256
581 #define ACPI_GPE_ENABLE 0
582 #define ACPI_GPE_DISABLE 1
585 * GPE info flags - Per GPE
590 * | | | | | +--- Interrupt type: Edge or Level Triggered
591 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
592 * | | | +--- Type of dispatch -- to method, handler, or none
593 * | | +--- Enabled for runtime?
594 * | +--- Enabled for wake?
595 * +--- System state when GPE ocurred (running/waking)
597 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
598 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
599 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
601 #define ACPI_GPE_TYPE_MASK (u8) 0x06
602 #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
603 #define ACPI_GPE_TYPE_WAKE (u8) 0x02
604 #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
606 #define ACPI_GPE_DISPATCH_MASK (u8) 0x18
607 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
608 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
609 #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
611 #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
612 #define ACPI_GPE_RUN_ENABLED (u8) 0x20
613 #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
615 #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
616 #define ACPI_GPE_WAKE_ENABLED (u8) 0x40
617 #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
619 #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
621 #define ACPI_GPE_SYSTEM_MASK (u8) 0x80
622 #define ACPI_GPE_SYSTEM_RUNNING (u8) 0x80
623 #define ACPI_GPE_SYSTEM_WAKING (u8) 0x00
626 * Flags for GPE and Lock interfaces
628 #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
629 #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
631 #define ACPI_NOT_ISR 0x1
636 #define ACPI_SYSTEM_NOTIFY 0x1
637 #define ACPI_DEVICE_NOTIFY 0x2
638 #define ACPI_ALL_NOTIFY 0x3
639 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
641 #define ACPI_MAX_SYS_NOTIFY 0x7f
643 /* Address Space (Operation Region) Types */
645 typedef u8 acpi_adr_space_type;
647 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
648 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
649 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
650 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
651 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
652 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
653 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
654 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7
655 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
659 * These are bitfields defined within the full ACPI registers
661 #define ACPI_BITREG_TIMER_STATUS 0x00
662 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
663 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
664 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
665 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
666 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
667 #define ACPI_BITREG_WAKE_STATUS 0x06
668 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
670 #define ACPI_BITREG_TIMER_ENABLE 0x08
671 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
672 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
673 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
674 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
675 #define ACPI_BITREG_WAKE_ENABLE 0x0D
676 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E
678 #define ACPI_BITREG_SCI_ENABLE 0x0F
679 #define ACPI_BITREG_BUS_MASTER_RLD 0x10
680 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11
681 #define ACPI_BITREG_SLEEP_TYPE_A 0x12
682 #define ACPI_BITREG_SLEEP_TYPE_B 0x13
683 #define ACPI_BITREG_SLEEP_ENABLE 0x14
685 #define ACPI_BITREG_ARB_DISABLE 0x15
687 #define ACPI_BITREG_MAX 0x15
688 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
691 * External ACPI object definition
694 acpi_object_type type; /* See definition of acpi_ns_type for values */
696 acpi_object_type type;
697 acpi_integer value; /* The actual number */
701 acpi_object_type type;
702 u32 length; /* # of bytes in string, excluding trailing null */
703 char *pointer; /* points to the string value */
707 acpi_object_type type;
708 u32 length; /* # of bytes in buffer */
709 u8 *pointer; /* points to the buffer */
713 acpi_object_type type;
715 acpi_handle handle; /* object reference */
719 acpi_object_type type;
720 u32 count; /* # of elements in package */
721 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
725 acpi_object_type type;
727 acpi_io_address pblk_address;
732 acpi_object_type type;
739 * List of objects, used as a parameter list for control method evaluation
741 struct acpi_object_list {
743 union acpi_object *pointer;
747 * Miscellaneous common Data Structures used by the interfaces
749 #define ACPI_NO_BUFFER 0
750 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
751 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
754 acpi_size length; /* Length in bytes of the buffer */
755 void *pointer; /* pointer to buffer */
759 * name_type for acpi_get_name
761 #define ACPI_FULL_PATHNAME 0
762 #define ACPI_SINGLE_NAME 1
763 #define ACPI_NAME_TYPE_MAX 1
766 * Structure and flags for acpi_get_system_info
768 #define ACPI_SYS_MODE_UNKNOWN 0x0000
769 #define ACPI_SYS_MODE_ACPI 0x0001
770 #define ACPI_SYS_MODE_LEGACY 0x0002
771 #define ACPI_SYS_MODES_MASK 0x0003
774 * ACPI Table Info. One per ACPI table _type_
776 struct acpi_table_info {
781 * System info returned by acpi_get_system_info()
783 struct acpi_system_info {
786 u32 timer_resolution;
792 struct acpi_table_info table_info[NUM_ACPI_TABLE_TYPES];
796 * Types specific to the OS service interfaces
798 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
801 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
804 * Various handlers and callback procedures
806 typedef u32(*acpi_event_handler) (void *context);
809 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
812 void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
814 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
816 #define ACPI_INIT_DEVICE_INI 1
819 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
822 u32 aml_offset, void *context);
824 /* Address Spaces (For Operation Regions) */
827 acpi_status(*acpi_adr_space_handler) (u32 function,
828 acpi_physical_address address,
830 acpi_integer * value,
831 void *handler_context,
832 void *region_context);
834 #define ACPI_DEFAULT_HANDLER NULL
837 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
839 void *handler_context,
840 void **region_context);
842 #define ACPI_REGION_ACTIVATE 0
843 #define ACPI_REGION_DEACTIVATE 1
846 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
848 void *context, void **return_value);
850 /* Interrupt handler return values */
852 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
853 #define ACPI_INTERRUPT_HANDLED 0x01
855 /* Common string version of device HIDs and UIDs */
857 struct acpi_device_id {
858 char value[ACPI_DEVICE_ID_LENGTH];
861 /* Common string version of device CIDs */
863 struct acpi_compatible_id {
864 char value[ACPI_MAX_CID_LENGTH];
867 struct acpi_compatible_id_list {
870 struct acpi_compatible_id id[1];
873 /* Structure and flags for acpi_get_object_info */
875 #define ACPI_VALID_STA 0x0001
876 #define ACPI_VALID_ADR 0x0002
877 #define ACPI_VALID_HID 0x0004
878 #define ACPI_VALID_UID 0x0008
879 #define ACPI_VALID_CID 0x0010
880 #define ACPI_VALID_SXDS 0x0020
882 /* Flags for _STA method */
884 #define ACPI_STA_DEVICE_PRESENT 0x01
885 #define ACPI_STA_DEVICE_ENABLED 0x02
886 #define ACPI_STA_DEVICE_UI 0x04
887 #define ACPI_STA_DEVICE_OK 0x08
888 #define ACPI_STA_BATTERY_PRESENT 0x10
890 #define ACPI_COMMON_OBJ_INFO \
891 acpi_object_type type; /* ACPI object type */ \
892 acpi_name name /* ACPI object Name */
894 struct acpi_obj_info_header {
895 ACPI_COMMON_OBJ_INFO;
898 /* Structure returned from Get Object Info */
900 struct acpi_device_info {
901 ACPI_COMMON_OBJ_INFO;
903 u32 valid; /* Indicates which fields below are valid */
904 u32 current_status; /* _STA value */
905 acpi_integer address; /* _ADR value if any */
906 struct acpi_device_id hardware_id; /* _HID value if any */
907 struct acpi_device_id unique_id; /* _UID value if any */
908 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
909 struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */
912 /* Context structs for address space handlers */
921 struct acpi_mem_space_context {
923 acpi_physical_address address;
924 acpi_physical_address mapped_physical_address;
925 u8 *mapped_logical_address;
926 acpi_size mapped_length;
930 * Definitions for Resource Attributes
932 typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
933 typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (length+3) = (64_k-1)+3 */
938 #define ACPI_READ_ONLY_MEMORY (u8) 0x00
939 #define ACPI_READ_WRITE_MEMORY (u8) 0x01
941 #define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
942 #define ACPI_CACHABLE_MEMORY (u8) 0x01
943 #define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
944 #define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
948 * The ISA Io ranges are: n000-n0_ffh, n400-n4_ffh, n800-n8_ffh, n_c00-n_cFFh.
949 * The non-ISA Io ranges are: n100-n3_ffh, n500-n7_ffh, n900-n_bFfh, n_cd0-n_fFFh.
951 #define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
952 #define ACPI_ISA_ONLY_RANGES (u8) 0x02
953 #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
955 /* Type of translation - 1=Sparse, 0=Dense */
957 #define ACPI_SPARSE_TRANSLATION (u8) 0x01
960 * IO Port Descriptor Decode
962 #define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
963 #define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
968 #define ACPI_LEVEL_SENSITIVE (u8) 0x00
969 #define ACPI_EDGE_SENSITIVE (u8) 0x01
971 #define ACPI_ACTIVE_HIGH (u8) 0x00
972 #define ACPI_ACTIVE_LOW (u8) 0x01
974 #define ACPI_EXCLUSIVE (u8) 0x00
975 #define ACPI_SHARED (u8) 0x01
980 #define ACPI_COMPATIBILITY (u8) 0x00
981 #define ACPI_TYPE_A (u8) 0x01
982 #define ACPI_TYPE_B (u8) 0x02
983 #define ACPI_TYPE_F (u8) 0x03
985 #define ACPI_NOT_BUS_MASTER (u8) 0x00
986 #define ACPI_BUS_MASTER (u8) 0x01
988 #define ACPI_TRANSFER_8 (u8) 0x00
989 #define ACPI_TRANSFER_8_16 (u8) 0x01
990 #define ACPI_TRANSFER_16 (u8) 0x02
993 * Start Dependent Functions Priority definitions
995 #define ACPI_GOOD_CONFIGURATION (u8) 0x00
996 #define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
997 #define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
1000 * 16, 32 and 64-bit Address Descriptor resource types
1002 #define ACPI_MEMORY_RANGE (u8) 0x00
1003 #define ACPI_IO_RANGE (u8) 0x01
1004 #define ACPI_BUS_NUMBER_RANGE (u8) 0x02
1006 #define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
1007 #define ACPI_ADDRESS_FIXED (u8) 0x01
1009 #define ACPI_POS_DECODE (u8) 0x00
1010 #define ACPI_SUB_DECODE (u8) 0x01
1012 #define ACPI_PRODUCER (u8) 0x00
1013 #define ACPI_CONSUMER (u8) 0x01
1016 * If possible, pack the following structures to byte alignment
1018 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
1022 /* UUID data structures for use in vendor-defined resource descriptors */
1025 u8 data[ACPI_UUID_LENGTH];
1028 struct acpi_vendor_uuid {
1030 u8 data[ACPI_UUID_LENGTH];
1034 * Structures used to describe device resources
1036 struct acpi_resource_irq {
1044 struct acpi_resource_dma {
1052 struct acpi_resource_start_dependent {
1053 u8 compatibility_priority;
1054 u8 performance_robustness;
1058 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1059 * needed because it has no fields
1062 struct acpi_resource_io {
1070 struct acpi_resource_fixed_io {
1075 struct acpi_resource_vendor {
1080 /* Vendor resource with UUID info (introduced in ACPI 3.0) */
1082 struct acpi_resource_vendor_typed {
1085 u8 uuid[ACPI_UUID_LENGTH];
1089 struct acpi_resource_end_tag {
1093 struct acpi_resource_memory24 {
1101 struct acpi_resource_memory32 {
1109 struct acpi_resource_fixed_memory32 {
1115 struct acpi_memory_attribute {
1122 struct acpi_io_attribute {
1125 u8 translation_type;
1129 union acpi_resource_attribute {
1130 struct acpi_memory_attribute mem;
1131 struct acpi_io_attribute io;
1133 /* Used for the *word_space macros */
1138 struct acpi_resource_source {
1144 /* Fields common to all address descriptors, 16/32/64 bit */
1146 #define ACPI_RESOURCE_ADDRESS_COMMON \
1148 u8 producer_consumer; \
1150 u8 min_address_fixed; \
1151 u8 max_address_fixed; \
1152 union acpi_resource_attribute info;
1154 struct acpi_resource_address {
1155 ACPI_RESOURCE_ADDRESS_COMMON};
1157 struct acpi_resource_address16 {
1158 ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
1161 u16 translation_offset;
1163 struct acpi_resource_source resource_source;
1166 struct acpi_resource_address32 {
1167 ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
1170 u32 translation_offset;
1172 struct acpi_resource_source resource_source;
1175 struct acpi_resource_address64 {
1176 ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
1179 u64 translation_offset;
1181 struct acpi_resource_source resource_source;
1184 struct acpi_resource_extended_address64 {
1185 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD;
1189 u64 translation_offset;
1194 struct acpi_resource_extended_irq {
1195 u8 producer_consumer;
1200 struct acpi_resource_source resource_source;
1204 struct acpi_resource_generic_register {
1212 /* ACPI_RESOURCE_TYPEs */
1214 #define ACPI_RESOURCE_TYPE_IRQ 0
1215 #define ACPI_RESOURCE_TYPE_DMA 1
1216 #define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
1217 #define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
1218 #define ACPI_RESOURCE_TYPE_IO 4
1219 #define ACPI_RESOURCE_TYPE_FIXED_IO 5
1220 #define ACPI_RESOURCE_TYPE_VENDOR 6
1221 #define ACPI_RESOURCE_TYPE_END_TAG 7
1222 #define ACPI_RESOURCE_TYPE_MEMORY24 8
1223 #define ACPI_RESOURCE_TYPE_MEMORY32 9
1224 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
1225 #define ACPI_RESOURCE_TYPE_ADDRESS16 11
1226 #define ACPI_RESOURCE_TYPE_ADDRESS32 12
1227 #define ACPI_RESOURCE_TYPE_ADDRESS64 13
1228 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
1229 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
1230 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
1231 #define ACPI_RESOURCE_TYPE_MAX 16
1233 union acpi_resource_data {
1234 struct acpi_resource_irq irq;
1235 struct acpi_resource_dma dma;
1236 struct acpi_resource_start_dependent start_dpf;
1237 struct acpi_resource_io io;
1238 struct acpi_resource_fixed_io fixed_io;
1239 struct acpi_resource_vendor vendor;
1240 struct acpi_resource_vendor_typed vendor_typed;
1241 struct acpi_resource_end_tag end_tag;
1242 struct acpi_resource_memory24 memory24;
1243 struct acpi_resource_memory32 memory32;
1244 struct acpi_resource_fixed_memory32 fixed_memory32;
1245 struct acpi_resource_address16 address16;
1246 struct acpi_resource_address32 address32;
1247 struct acpi_resource_address64 address64;
1248 struct acpi_resource_extended_address64 ext_address64;
1249 struct acpi_resource_extended_irq extended_irq;
1250 struct acpi_resource_generic_register generic_reg;
1254 struct acpi_resource_address address; /* Common 16/32/64 address fields */
1257 struct acpi_resource {
1260 union acpi_resource_data data;
1263 /* restore default alignment */
1267 #define ACPI_RS_SIZE_MIN 12
1268 #define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
1269 #define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
1271 #define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length)
1273 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
1274 #define ACPI_ALIGN_RESOURCE_SIZE(length) (length)
1276 #define ACPI_ALIGN_RESOURCE_SIZE(length) ACPI_ROUND_UP_TO_NATIVE_WORD(length)
1280 * END: of definitions for Resource Attributes
1283 struct acpi_pci_routing_table {
1286 acpi_integer address; /* here for 64-bit alignment */
1288 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
1292 * END: of definitions for PCI Routing tables
1295 #endif /* __ACTYPES_H__ */