1 /******************************************************************************
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
47 /* acpisrc:struct_defs -- for acpisrc conversion */
50 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
51 * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
54 #ifndef ACPI_MACHINE_WIDTH
55 #error ACPI_MACHINE_WIDTH not defined
58 /*! [Begin] no source code translation */
62 * Note: These macros are designed to be compiler independent as well as
63 * working around problems that some 32-bit compilers have with 64-bit
66 #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */
67 #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */
68 #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */
69 #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
70 #define ACPI_ASCII_MAX 0x7F
73 * Architecture-specific ACPICA Subsystem Data Types
75 * The goal of these types is to provide source code portability across
76 * 16-bit, 32-bit, and 64-bit targets.
78 * 1) The following types are of fixed size for all targets (16/32/64):
80 * BOOLEAN Logical boolean
82 * UINT8 8-bit (1 byte) unsigned value
83 * UINT16 16-bit (2 byte) unsigned value
84 * UINT32 32-bit (4 byte) unsigned value
85 * UINT64 64-bit (8 byte) unsigned value
87 * INT16 16-bit (2 byte) signed value
88 * INT32 32-bit (4 byte) signed value
89 * INT64 64-bit (8 byte) signed value
91 * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
92 * compiler-dependent header(s) and were introduced because there is no common
93 * 64-bit integer type across the various compilation models, as shown in
96 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
98 * short 16 16 16 16 16 16
100 * int 32 64 32 32 16 16
101 * long 64 64 32 32 32 32
103 * pointer 64 64 64 32 32 32
105 * Note: ILP64 and LP32 are currently not supported.
108 * 2) These types represent the native word size of the target mode of the
109 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
110 * usually used for memory allocation, efficient loop counters, and array
111 * indexes. The types are similar to the size_t type in the C library and are
112 * required because there is no C type that consistently represents the native
113 * data width. ACPI_SIZE is needed because there is no guarantee that a
114 * kernel-level C library is present.
116 * ACPI_SIZE 16/32/64-bit unsigned value
117 * ACPI_NATIVE_INT 16/32/64-bit signed value
121 /*******************************************************************************
123 * Common types for all compilers, all targets
125 ******************************************************************************/
127 typedef unsigned char BOOLEAN;
128 typedef unsigned char UINT8;
129 typedef unsigned short UINT16;
130 typedef COMPILER_DEPENDENT_UINT64 UINT64;
131 typedef COMPILER_DEPENDENT_INT64 INT64;
133 /*! [End] no source code translation !*/
135 /*******************************************************************************
137 * Types specific to 64-bit targets
139 ******************************************************************************/
141 #if ACPI_MACHINE_WIDTH == 64
143 /*! [Begin] no source code translation (keep the typedefs as-is) */
145 typedef unsigned int UINT32;
148 /*! [End] no source code translation !*/
150 typedef s64 acpi_native_int;
152 typedef u64 acpi_size;
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_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
162 * In the case of the Itanium Processor Family (IPF), the hardware does not
163 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
164 * to indicate that special precautions must be taken to avoid alignment faults.
165 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
167 * Note: Em64_t and other X86-64 processors support misaligned transfers,
168 * so there is no need to define this flag.
170 #if defined (__IA64__) || defined (__ia64__)
171 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
174 /*******************************************************************************
176 * Types specific to 32-bit targets
178 ******************************************************************************/
180 #elif ACPI_MACHINE_WIDTH == 32
182 /*! [Begin] no source code translation (keep the typedefs as-is) */
184 typedef unsigned int UINT32;
187 /*! [End] no source code translation !*/
189 typedef s32 acpi_native_int;
191 typedef u32 acpi_size;
192 typedef u32 acpi_io_address;
193 typedef u32 acpi_physical_address;
195 #define ACPI_MAX_PTR ACPI_UINT32_MAX
196 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
200 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
202 #error unknown ACPI_MACHINE_WIDTH
205 /*******************************************************************************
207 * OS-dependent and compiler-dependent types
209 * If the defaults below are not appropriate for the host system, they can
210 * be defined in the compiler-specific or OS-specific header, and this will
213 ******************************************************************************/
215 /* Value returned by acpi_os_get_thread_id */
217 #ifndef acpi_thread_id
218 #define acpi_thread_id acpi_size
221 /* Object returned from acpi_os_create_lock */
223 #ifndef acpi_spinlock
224 #define acpi_spinlock void *
227 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
229 #ifndef acpi_cpu_flags
230 #define acpi_cpu_flags acpi_size
233 /* Object returned from acpi_os_create_cache */
236 #ifdef ACPI_USE_LOCAL_CACHE
237 #define acpi_cache_t struct acpi_memory_list
239 #define acpi_cache_t void *
243 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
245 #ifndef acpi_uintptr_t
246 #define acpi_uintptr_t void *
250 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
251 * some compilers can catch printf format string problems
253 #ifndef ACPI_PRINTF_LIKE
254 #define ACPI_PRINTF_LIKE(c)
258 * Some compilers complain about unused variables. Sometimes we don't want to
259 * use all the variables (for example, _acpi_module_name). This allows us
260 * to to tell the compiler in a per-variable manner that a variable
263 #ifndef ACPI_UNUSED_VAR
264 #define ACPI_UNUSED_VAR
268 * All ACPICA functions that are available to the rest of the kernel are
269 * tagged with this macro which can be defined as appropriate for the host.
271 #ifndef ACPI_EXPORT_SYMBOL
272 #define ACPI_EXPORT_SYMBOL(symbol)
275 /******************************************************************************
277 * ACPI Specification constants (Do not change unless the specification changes)
279 *****************************************************************************/
281 /* Number of distinct GPE register blocks and register width */
283 #define ACPI_MAX_GPE_BLOCKS 2
284 #define ACPI_GPE_REGISTER_WIDTH 8
286 /* Names within the namespace are 4 bytes long */
288 #define ACPI_NAME_SIZE 4
289 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
290 #define ACPI_PATH_SEPARATOR '.'
292 /* Sizes for ACPI table headers */
294 #define ACPI_OEM_ID_SIZE 6
295 #define ACPI_OEM_TABLE_ID_SIZE 8
297 /* ACPI/PNP hardware IDs */
299 #define PCI_ROOT_HID_STRING "PNP0A03"
300 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
302 /* PM Timer ticks per second (HZ) */
304 #define PM_TIMER_FREQUENCY 3579545
306 /*******************************************************************************
310 ******************************************************************************/
312 /* Logical defines and NULL */
317 #define FALSE (1 == 0)
322 #define TRUE (1 == 1)
325 #define NULL (void *) 0
329 * Miscellaneous types
331 typedef u32 acpi_status; /* All ACPI Exceptions */
332 typedef u32 acpi_name; /* 4-byte ACPI name */
333 typedef char *acpi_string; /* Null terminated ASCII string */
334 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
336 /* Owner IDs are used to track namespace nodes for selective deletion */
338 typedef u8 acpi_owner_id;
339 #define ACPI_OWNER_ID_MAX 0xFF
341 struct uint64_struct {
346 union uint64_overlay {
348 struct uint64_struct part;
351 struct uint32_struct {
356 /* Synchronization objects */
358 #define acpi_mutex void *
359 #define acpi_semaphore void *
362 * Acpi integer width. In ACPI version 1, integers are 32 bits. In ACPI
363 * version 2, integers are 64 bits. Note that this pertains to the ACPI integer
364 * type only, not other integers used in the implementation of the ACPI CA
367 typedef unsigned long long acpi_integer;
368 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
369 #define ACPI_INTEGER_BIT_SIZE 64
370 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
372 #if ACPI_MACHINE_WIDTH == 64
373 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
376 #define ACPI_MAX64_DECIMAL_DIGITS 20
377 #define ACPI_MAX32_DECIMAL_DIGITS 10
378 #define ACPI_MAX16_DECIMAL_DIGITS 5
379 #define ACPI_MAX8_DECIMAL_DIGITS 3
381 /* PM Timer ticks per second (HZ) */
383 #define PM_TIMER_FREQUENCY 3579545
386 * Constants with special meanings
388 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
389 #define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
390 #define ACPI_DO_NOT_WAIT 0
392 /*******************************************************************************
394 * Commonly used macros
396 ******************************************************************************/
398 /* Data manipulation */
400 #define ACPI_LOWORD(l) ((u16)(u32)(l))
401 #define ACPI_HIWORD(l) ((u16)((((u32)(l)) >> 16) & 0xFFFF))
402 #define ACPI_LOBYTE(l) ((u8)(u16)(l))
403 #define ACPI_HIBYTE(l) ((u8)((((u16)(l)) >> 8) & 0xFF))
405 /* Full 64-bit integer must be available on both 32-bit and 64-bit platforms */
407 struct acpi_integer_overlay {
412 #define ACPI_LODWORD(integer) (ACPI_CAST_PTR (struct acpi_integer_overlay, &integer)->lo_dword)
413 #define ACPI_HIDWORD(integer) (ACPI_CAST_PTR (struct acpi_integer_overlay, &integer)->hi_dword)
415 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
416 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
417 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
418 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
420 /* Size calculation */
422 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
424 /* Pointer manipulation */
426 #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
427 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
428 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
429 #define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
431 /* Pointer/Integer type conversions */
433 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
434 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
435 #define ACPI_OFFSET(d, f) (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
436 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
437 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
439 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
440 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
442 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
445 /*******************************************************************************
447 * Miscellaneous constants
449 ******************************************************************************/
452 * Initialization sequence
454 #define ACPI_FULL_INITIALIZATION 0x00
455 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
456 #define ACPI_NO_HARDWARE_INIT 0x02
457 #define ACPI_NO_EVENT_INIT 0x04
458 #define ACPI_NO_HANDLER_INIT 0x08
459 #define ACPI_NO_ACPI_ENABLE 0x10
460 #define ACPI_NO_DEVICE_INIT 0x20
461 #define ACPI_NO_OBJECT_INIT 0x40
464 * Initialization state
466 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
467 #define ACPI_INITIALIZED_OK 0x02
472 #define ACPI_STATE_UNKNOWN (u8) 0xFF
474 #define ACPI_STATE_S0 (u8) 0
475 #define ACPI_STATE_S1 (u8) 1
476 #define ACPI_STATE_S2 (u8) 2
477 #define ACPI_STATE_S3 (u8) 3
478 #define ACPI_STATE_S4 (u8) 4
479 #define ACPI_STATE_S5 (u8) 5
480 #define ACPI_S_STATES_MAX ACPI_STATE_S5
481 #define ACPI_S_STATE_COUNT 6
483 #define ACPI_STATE_D0 (u8) 0
484 #define ACPI_STATE_D1 (u8) 1
485 #define ACPI_STATE_D2 (u8) 2
486 #define ACPI_STATE_D3 (u8) 3
487 #define ACPI_D_STATES_MAX ACPI_STATE_D3
488 #define ACPI_D_STATE_COUNT 4
490 #define ACPI_STATE_C0 (u8) 0
491 #define ACPI_STATE_C1 (u8) 1
492 #define ACPI_STATE_C2 (u8) 2
493 #define ACPI_STATE_C3 (u8) 3
494 #define ACPI_C_STATES_MAX ACPI_STATE_C3
495 #define ACPI_C_STATE_COUNT 4
498 * Sleep type invalid value
500 #define ACPI_SLEEP_TYPE_MAX 0x7
501 #define ACPI_SLEEP_TYPE_INVALID 0xFF
504 * Standard notify values
506 #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
507 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
508 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
509 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
510 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
511 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
512 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
513 #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
514 #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
515 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
516 #define ACPI_NOTIFY_RESERVED (u8) 0x0A
517 #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
519 #define ACPI_NOTIFY_MAX 0x0B
522 * Types associated with ACPI names and objects. The first group of
523 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
524 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
525 * only add to the first group if the spec changes.
527 * NOTE: Types must be kept in sync with the global acpi_ns_properties
528 * and acpi_ns_type_names arrays.
530 typedef u32 acpi_object_type;
532 #define ACPI_TYPE_ANY 0x00
533 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
534 #define ACPI_TYPE_STRING 0x02
535 #define ACPI_TYPE_BUFFER 0x03
536 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
537 #define ACPI_TYPE_FIELD_UNIT 0x05
538 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
539 #define ACPI_TYPE_EVENT 0x07
540 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
541 #define ACPI_TYPE_MUTEX 0x09
542 #define ACPI_TYPE_REGION 0x0A
543 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
544 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
545 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
546 #define ACPI_TYPE_BUFFER_FIELD 0x0E
547 #define ACPI_TYPE_DDB_HANDLE 0x0F
548 #define ACPI_TYPE_DEBUG_OBJECT 0x10
550 #define ACPI_TYPE_EXTERNAL_MAX 0x10
553 * These are object types that do not map directly to the ACPI
554 * object_type() operator. They are used for various internal purposes only.
555 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
556 * internal types must move upwards. (There is code that depends on these
557 * values being contiguous with the external types above.)
559 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
560 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
561 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
562 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
563 #define ACPI_TYPE_LOCAL_ALIAS 0x15
564 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
565 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
566 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
567 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
568 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
569 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
571 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
574 * These are special object types that never appear in
575 * a Namespace node, only in an union acpi_operand_object
577 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
578 #define ACPI_TYPE_LOCAL_DATA 0x1D
580 #define ACPI_TYPE_LOCAL_MAX 0x1D
582 /* All types above here are invalid */
584 #define ACPI_TYPE_INVALID 0x1E
585 #define ACPI_TYPE_NOT_FOUND 0xFF
587 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
594 #define ACPI_IO_MASK 1
597 * Event Types: Fixed & General Purpose
599 typedef u32 acpi_event_type;
604 #define ACPI_EVENT_PMTIMER 0
605 #define ACPI_EVENT_GLOBAL 1
606 #define ACPI_EVENT_POWER_BUTTON 2
607 #define ACPI_EVENT_SLEEP_BUTTON 3
608 #define ACPI_EVENT_RTC 4
609 #define ACPI_EVENT_MAX 4
610 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
613 * Event Status - Per event
615 * The encoding of acpi_event_status is illustrated below.
616 * Note that a set bit (1) indicates the property is TRUE
617 * (e.g. if bit 0 is set then the event is enabled).
618 * +-------------+-+-+-+
619 * | Bits 31:3 |2|1|0|
620 * +-------------+-+-+-+
623 * | | +--- Enabled for wake?
625 * +----------- <Reserved>
627 typedef u32 acpi_event_status;
629 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
630 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
631 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
632 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
633 #define ACPI_EVENT_FLAG_HANDLE (acpi_event_status) 0x08
636 * General Purpose Events (GPE)
638 #define ACPI_GPE_INVALID 0xFF
639 #define ACPI_GPE_MAX 0xFF
640 #define ACPI_NUM_GPE 256
642 #define ACPI_GPE_ENABLE 0
643 #define ACPI_GPE_DISABLE 1
646 * GPE info flags - Per GPE
651 * | | | | | +--- Interrupt type: Edge or Level Triggered
652 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
653 * | | | +--- Type of dispatch -- to method, handler, or none
654 * | | +--- Enabled for runtime?
655 * | +--- Enabled for wake?
658 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
659 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
660 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
662 #define ACPI_GPE_TYPE_MASK (u8) 0x06
663 #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
664 #define ACPI_GPE_TYPE_WAKE (u8) 0x02
665 #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
667 #define ACPI_GPE_DISPATCH_MASK (u8) 0x18
668 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
669 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
670 #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
672 #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
673 #define ACPI_GPE_RUN_ENABLED (u8) 0x20
674 #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
676 #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
677 #define ACPI_GPE_WAKE_ENABLED (u8) 0x40
678 #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
680 #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
683 * Flags for GPE and Lock interfaces
685 #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
686 #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
688 #define ACPI_NOT_ISR 0x1
693 #define ACPI_SYSTEM_NOTIFY 0x1
694 #define ACPI_DEVICE_NOTIFY 0x2
695 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
696 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
698 #define ACPI_MAX_SYS_NOTIFY 0x7f
700 /* Address Space (Operation Region) Types */
702 typedef u8 acpi_adr_space_type;
704 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
705 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
706 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
707 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
708 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
709 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
710 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
711 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7
712 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
717 * These values are intended to be used by the hardware interfaces
718 * and are mapped to individual bitfields defined within the ACPI
719 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
723 /* PM1 Status register */
725 #define ACPI_BITREG_TIMER_STATUS 0x00
726 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
727 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
728 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
729 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
730 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
731 #define ACPI_BITREG_WAKE_STATUS 0x06
732 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
734 /* PM1 Enable register */
736 #define ACPI_BITREG_TIMER_ENABLE 0x08
737 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
738 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
739 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
740 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
741 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
743 /* PM1 Control register */
745 #define ACPI_BITREG_SCI_ENABLE 0x0E
746 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
747 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
748 #define ACPI_BITREG_SLEEP_TYPE_A 0x11
749 #define ACPI_BITREG_SLEEP_TYPE_B 0x12
750 #define ACPI_BITREG_SLEEP_ENABLE 0x13
752 /* PM2 Control register */
754 #define ACPI_BITREG_ARB_DISABLE 0x14
756 #define ACPI_BITREG_MAX 0x14
757 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
760 * External ACPI object definition
764 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
765 * or an unresolved named reference.
768 acpi_object_type type; /* See definition of acpi_ns_type for values */
770 acpi_object_type type; /* ACPI_TYPE_INTEGER */
771 acpi_integer value; /* The actual number */
775 acpi_object_type type; /* ACPI_TYPE_STRING */
776 u32 length; /* # of bytes in string, excluding trailing null */
777 char *pointer; /* points to the string value */
781 acpi_object_type type; /* ACPI_TYPE_BUFFER */
782 u32 length; /* # of bytes in buffer */
783 u8 *pointer; /* points to the buffer */
787 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
788 u32 count; /* # of elements in package */
789 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
793 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
794 acpi_object_type actual_type; /* Type associated with the Handle */
795 acpi_handle handle; /* object reference */
799 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
801 acpi_io_address pblk_address;
806 acpi_object_type type; /* ACPI_TYPE_POWER */
813 * List of objects, used as a parameter list for control method evaluation
815 struct acpi_object_list {
817 union acpi_object *pointer;
821 * Miscellaneous common Data Structures used by the interfaces
823 #define ACPI_NO_BUFFER 0
824 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
825 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
828 acpi_size length; /* Length in bytes of the buffer */
829 void *pointer; /* pointer to buffer */
833 * name_type for acpi_get_name
835 #define ACPI_FULL_PATHNAME 0
836 #define ACPI_SINGLE_NAME 1
837 #define ACPI_NAME_TYPE_MAX 1
840 * Predefined Namespace items
842 struct acpi_predefined_names {
849 * Structure and flags for acpi_get_system_info
851 #define ACPI_SYS_MODE_UNKNOWN 0x0000
852 #define ACPI_SYS_MODE_ACPI 0x0001
853 #define ACPI_SYS_MODE_LEGACY 0x0002
854 #define ACPI_SYS_MODES_MASK 0x0003
857 * System info returned by acpi_get_system_info()
859 struct acpi_system_info {
862 u32 timer_resolution;
869 /* Table Event Types */
871 #define ACPI_TABLE_EVENT_LOAD 0x0
872 #define ACPI_TABLE_EVENT_UNLOAD 0x1
873 #define ACPI_NUM_TABLE_EVENTS 2
876 * Types specific to the OS service interfaces
878 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
881 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
884 * Various handlers and callback procedures
886 typedef u32(*acpi_event_handler) (void *context);
889 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
892 void (*acpi_object_handler) (acpi_handle object, u32 function, void *data);
894 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
896 #define ACPI_INIT_DEVICE_INI 1
899 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
902 u32 aml_offset, void *context);
904 /* Table Event handler (Load, load_table, etc.) and types */
907 acpi_status(*acpi_tbl_handler) (u32 event, void *table, void *context);
909 /* Address Spaces (For Operation Regions) */
912 acpi_status(*acpi_adr_space_handler) (u32 function,
913 acpi_physical_address address,
915 acpi_integer * value,
916 void *handler_context,
917 void *region_context);
919 #define ACPI_DEFAULT_HANDLER NULL
922 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
924 void *handler_context,
925 void **region_context);
927 #define ACPI_REGION_ACTIVATE 0
928 #define ACPI_REGION_DEACTIVATE 1
931 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
933 void *context, void **return_value);
935 /* Interrupt handler return values */
937 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
938 #define ACPI_INTERRUPT_HANDLED 0x01
940 /* Length of _HID, _UID, _CID, and UUID values */
942 #define ACPI_DEVICE_ID_LENGTH 0x09
943 #define ACPI_MAX_CID_LENGTH 48
944 #define ACPI_UUID_LENGTH 16
946 /* Common string version of device HIDs and UIDs */
948 struct acpica_device_id {
949 char value[ACPI_DEVICE_ID_LENGTH];
952 /* Common string version of device CIDs */
954 struct acpi_compatible_id {
955 char value[ACPI_MAX_CID_LENGTH];
958 struct acpi_compatible_id_list {
961 struct acpi_compatible_id id[1];
964 /* Structure and flags for acpi_get_object_info */
966 #define ACPI_VALID_STA 0x0001
967 #define ACPI_VALID_ADR 0x0002
968 #define ACPI_VALID_HID 0x0004
969 #define ACPI_VALID_UID 0x0008
970 #define ACPI_VALID_CID 0x0010
971 #define ACPI_VALID_SXDS 0x0020
973 /* Flags for _STA method */
975 #define ACPI_STA_DEVICE_PRESENT 0x01
976 #define ACPI_STA_DEVICE_ENABLED 0x02
977 #define ACPI_STA_DEVICE_UI 0x04
978 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
979 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
980 #define ACPI_STA_BATTERY_PRESENT 0x10
982 #define ACPI_COMMON_OBJ_INFO \
983 acpi_object_type type; /* ACPI object type */ \
984 acpi_name name /* ACPI object Name */
986 struct acpi_obj_info_header {
987 ACPI_COMMON_OBJ_INFO;
990 /* Structure returned from Get Object Info */
992 struct acpi_device_info {
993 ACPI_COMMON_OBJ_INFO;
995 u32 param_count; /* If a method, required parameter count */
996 u32 valid; /* Indicates which fields below are valid */
997 u32 current_status; /* _STA value */
998 acpi_integer address; /* _ADR value if any */
999 struct acpica_device_id hardware_id; /* _HID value if any */
1000 struct acpica_device_id unique_id; /* _UID value if any */
1001 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1002 struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */
1005 /* Context structs for address space handlers */
1007 struct acpi_pci_id {
1014 struct acpi_mem_space_context {
1016 acpi_physical_address address;
1017 acpi_physical_address mapped_physical_address;
1018 u8 *mapped_logical_address;
1019 acpi_size mapped_length;
1023 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1025 struct acpi_memory_list {
1033 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1035 /* Statistics for debug memory tracking only */
1037 u32 total_allocated;
1041 u32 current_total_size;
1047 #endif /* __ACTYPES_H__ */