x86/amd-iommu: Add per IOMMU reference counting
[linux/fpc-iii.git] / include / acpi / actypes.h
blob153f12dc3373802798a59a8e595bb722f9b42d79
1 /******************************************************************************
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2008, Intel Corp.
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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.
44 #ifndef __ACTYPES_H__
45 #define __ACTYPES_H__
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
52 * 12/2006.
54 #ifndef ACPI_MACHINE_WIDTH
55 #error ACPI_MACHINE_WIDTH not defined
56 #endif
58 /*! [Begin] no source code translation */
61 * Data type ranges
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
64 * constants.
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
94 * the table below.
96 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
97 * char 8 8 8 8 8 8
98 * short 16 16 16 16 16 16
99 * _int32 32
100 * int 32 64 32 32 16 16
101 * long 64 64 32 32 32 32
102 * long long 64 64
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;
146 typedef int INT32;
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
172 #endif
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;
185 typedef int INT32;
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
198 #else
200 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
202 #error unknown ACPI_MACHINE_WIDTH
203 #endif
205 /*******************************************************************************
207 * OS-dependent types
209 * If the defaults below are not appropriate for the host system, they can
210 * be defined in the OS-specific header, and this will take precedence.
212 ******************************************************************************/
214 /* Value returned by acpi_os_get_thread_id */
216 #ifndef acpi_thread_id
217 #define acpi_thread_id acpi_size
218 #endif
220 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
222 #ifndef acpi_cpu_flags
223 #define acpi_cpu_flags acpi_size
224 #endif
226 /* Object returned from acpi_os_create_cache */
228 #ifndef acpi_cache_t
229 #ifdef ACPI_USE_LOCAL_CACHE
230 #define acpi_cache_t struct acpi_memory_list
231 #else
232 #define acpi_cache_t void *
233 #endif
234 #endif
237 * Synchronization objects - Mutexes, Semaphores, and spin_locks
239 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
241 * These macros are used if the host OS does not support a mutex object.
242 * Map the OSL Mutex interfaces to binary semaphores.
244 #define acpi_mutex acpi_semaphore
245 #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
246 #define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
247 #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
248 #define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
249 #endif
251 /* Configurable types for synchronization objects */
253 #ifndef acpi_spinlock
254 #define acpi_spinlock void *
255 #endif
257 #ifndef acpi_semaphore
258 #define acpi_semaphore void *
259 #endif
261 #ifndef acpi_mutex
262 #define acpi_mutex void *
263 #endif
265 /*******************************************************************************
267 * Compiler-dependent types
269 * If the defaults below are not appropriate for the host compiler, they can
270 * be defined in the compiler-specific header, and this will take precedence.
272 ******************************************************************************/
274 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
276 #ifndef acpi_uintptr_t
277 #define acpi_uintptr_t void *
278 #endif
281 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
282 * some compilers can catch printf format string problems
284 #ifndef ACPI_PRINTF_LIKE
285 #define ACPI_PRINTF_LIKE(c)
286 #endif
289 * Some compilers complain about unused variables. Sometimes we don't want to
290 * use all the variables (for example, _acpi_module_name). This allows us
291 * to tell the compiler in a per-variable manner that a variable
292 * is unused
294 #ifndef ACPI_UNUSED_VAR
295 #define ACPI_UNUSED_VAR
296 #endif
299 * All ACPICA functions that are available to the rest of the kernel are
300 * tagged with this macro which can be defined as appropriate for the host.
302 #ifndef ACPI_EXPORT_SYMBOL
303 #define ACPI_EXPORT_SYMBOL(symbol)
304 #endif
306 /******************************************************************************
308 * ACPI Specification constants (Do not change unless the specification changes)
310 *****************************************************************************/
312 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
314 #define ACPI_MAX_GPE_BLOCKS 2
316 /* Default ACPI register widths */
318 #define ACPI_GPE_REGISTER_WIDTH 8
319 #define ACPI_PM1_REGISTER_WIDTH 16
320 #define ACPI_PM2_REGISTER_WIDTH 8
321 #define ACPI_PM_TIMER_WIDTH 32
323 /* Names within the namespace are 4 bytes long */
325 #define ACPI_NAME_SIZE 4
326 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
327 #define ACPI_PATH_SEPARATOR '.'
329 /* Sizes for ACPI table headers */
331 #define ACPI_OEM_ID_SIZE 6
332 #define ACPI_OEM_TABLE_ID_SIZE 8
334 /* ACPI/PNP hardware IDs */
336 #define PCI_ROOT_HID_STRING "PNP0A03"
337 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
339 /* PM Timer ticks per second (HZ) */
341 #define PM_TIMER_FREQUENCY 3579545
343 /*******************************************************************************
345 * Independent types
347 ******************************************************************************/
349 /* Logical defines and NULL */
351 #ifdef FALSE
352 #undef FALSE
353 #endif
354 #define FALSE (1 == 0)
356 #ifdef TRUE
357 #undef TRUE
358 #endif
359 #define TRUE (1 == 1)
361 #ifndef NULL
362 #define NULL (void *) 0
363 #endif
366 * Miscellaneous types
368 typedef u32 acpi_status; /* All ACPI Exceptions */
369 typedef u32 acpi_name; /* 4-byte ACPI name */
370 typedef char *acpi_string; /* Null terminated ASCII string */
371 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
373 /* Owner IDs are used to track namespace nodes for selective deletion */
375 typedef u8 acpi_owner_id;
376 #define ACPI_OWNER_ID_MAX 0xFF
378 struct uint64_struct {
379 u32 lo;
380 u32 hi;
383 union uint64_overlay {
384 u64 full;
385 struct uint64_struct part;
388 struct uint32_struct {
389 u32 lo;
390 u32 hi;
394 * Acpi integer width. In ACPI version 1, integers are 32 bits. In ACPI
395 * version 2, integers are 64 bits. Note that this pertains to the ACPI integer
396 * type only, not other integers used in the implementation of the ACPI CA
397 * subsystem.
399 typedef unsigned long long acpi_integer;
400 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
401 #define ACPI_INTEGER_BIT_SIZE 64
402 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
404 #if ACPI_MACHINE_WIDTH == 64
405 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
406 #endif
408 #define ACPI_MAX64_DECIMAL_DIGITS 20
409 #define ACPI_MAX32_DECIMAL_DIGITS 10
410 #define ACPI_MAX16_DECIMAL_DIGITS 5
411 #define ACPI_MAX8_DECIMAL_DIGITS 3
413 /* PM Timer ticks per second (HZ) */
415 #define PM_TIMER_FREQUENCY 3579545
418 * Constants with special meanings
420 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
421 #define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
422 #define ACPI_DO_NOT_WAIT 0
424 /*******************************************************************************
426 * Commonly used macros
428 ******************************************************************************/
430 /* Data manipulation */
432 #define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
433 #define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
434 #define ACPI_LOWORD(integer) ((u16) (u32)(integer))
435 #define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
436 #define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
437 #define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
439 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
440 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
441 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
442 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
444 /* Size calculation */
446 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
448 /* Pointer manipulation */
450 #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
451 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
452 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
453 #define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
455 /* Pointer/Integer type conversions */
457 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
458 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
459 #define ACPI_OFFSET(d, f) (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
460 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
461 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
463 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
464 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
465 #else
466 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
467 #endif
469 /*******************************************************************************
471 * Miscellaneous constants
473 ******************************************************************************/
476 * Initialization sequence
478 #define ACPI_FULL_INITIALIZATION 0x00
479 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
480 #define ACPI_NO_HARDWARE_INIT 0x02
481 #define ACPI_NO_EVENT_INIT 0x04
482 #define ACPI_NO_HANDLER_INIT 0x08
483 #define ACPI_NO_ACPI_ENABLE 0x10
484 #define ACPI_NO_DEVICE_INIT 0x20
485 #define ACPI_NO_OBJECT_INIT 0x40
488 * Initialization state
490 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
491 #define ACPI_INITIALIZED_OK 0x02
494 * Power state values
496 #define ACPI_STATE_UNKNOWN (u8) 0xFF
498 #define ACPI_STATE_S0 (u8) 0
499 #define ACPI_STATE_S1 (u8) 1
500 #define ACPI_STATE_S2 (u8) 2
501 #define ACPI_STATE_S3 (u8) 3
502 #define ACPI_STATE_S4 (u8) 4
503 #define ACPI_STATE_S5 (u8) 5
504 #define ACPI_S_STATES_MAX ACPI_STATE_S5
505 #define ACPI_S_STATE_COUNT 6
507 #define ACPI_STATE_D0 (u8) 0
508 #define ACPI_STATE_D1 (u8) 1
509 #define ACPI_STATE_D2 (u8) 2
510 #define ACPI_STATE_D3 (u8) 3
511 #define ACPI_D_STATES_MAX ACPI_STATE_D3
512 #define ACPI_D_STATE_COUNT 4
514 #define ACPI_STATE_C0 (u8) 0
515 #define ACPI_STATE_C1 (u8) 1
516 #define ACPI_STATE_C2 (u8) 2
517 #define ACPI_STATE_C3 (u8) 3
518 #define ACPI_C_STATES_MAX ACPI_STATE_C3
519 #define ACPI_C_STATE_COUNT 4
522 * Sleep type invalid value
524 #define ACPI_SLEEP_TYPE_MAX 0x7
525 #define ACPI_SLEEP_TYPE_INVALID 0xFF
528 * Standard notify values
530 #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
531 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
532 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
533 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
534 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
535 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
536 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
537 #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
538 #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
539 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
540 #define ACPI_NOTIFY_RESERVED (u8) 0x0A
541 #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
543 #define ACPI_NOTIFY_MAX 0x0B
546 * Types associated with ACPI names and objects. The first group of
547 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
548 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
549 * only add to the first group if the spec changes.
551 * NOTE: Types must be kept in sync with the global acpi_ns_properties
552 * and acpi_ns_type_names arrays.
554 typedef u32 acpi_object_type;
556 #define ACPI_TYPE_ANY 0x00
557 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
558 #define ACPI_TYPE_STRING 0x02
559 #define ACPI_TYPE_BUFFER 0x03
560 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
561 #define ACPI_TYPE_FIELD_UNIT 0x05
562 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
563 #define ACPI_TYPE_EVENT 0x07
564 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
565 #define ACPI_TYPE_MUTEX 0x09
566 #define ACPI_TYPE_REGION 0x0A
567 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
568 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
569 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
570 #define ACPI_TYPE_BUFFER_FIELD 0x0E
571 #define ACPI_TYPE_DDB_HANDLE 0x0F
572 #define ACPI_TYPE_DEBUG_OBJECT 0x10
574 #define ACPI_TYPE_EXTERNAL_MAX 0x10
577 * These are object types that do not map directly to the ACPI
578 * object_type() operator. They are used for various internal purposes only.
579 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
580 * internal types must move upwards. (There is code that depends on these
581 * values being contiguous with the external types above.)
583 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
584 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
585 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
586 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
587 #define ACPI_TYPE_LOCAL_ALIAS 0x15
588 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
589 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
590 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
591 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
592 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
593 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
595 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
598 * These are special object types that never appear in
599 * a Namespace node, only in a union acpi_operand_object
601 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
602 #define ACPI_TYPE_LOCAL_DATA 0x1D
604 #define ACPI_TYPE_LOCAL_MAX 0x1D
606 /* All types above here are invalid */
608 #define ACPI_TYPE_INVALID 0x1E
609 #define ACPI_TYPE_NOT_FOUND 0xFF
611 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
614 * All I/O
616 #define ACPI_READ 0
617 #define ACPI_WRITE 1
618 #define ACPI_IO_MASK 1
621 * Event Types: Fixed & General Purpose
623 typedef u32 acpi_event_type;
626 * Fixed events
628 #define ACPI_EVENT_PMTIMER 0
629 #define ACPI_EVENT_GLOBAL 1
630 #define ACPI_EVENT_POWER_BUTTON 2
631 #define ACPI_EVENT_SLEEP_BUTTON 3
632 #define ACPI_EVENT_RTC 4
633 #define ACPI_EVENT_MAX 4
634 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
637 * Event Status - Per event
638 * -------------
639 * The encoding of acpi_event_status is illustrated below.
640 * Note that a set bit (1) indicates the property is TRUE
641 * (e.g. if bit 0 is set then the event is enabled).
642 * +-------------+-+-+-+
643 * | Bits 31:3 |2|1|0|
644 * +-------------+-+-+-+
645 * | | | |
646 * | | | +- Enabled?
647 * | | +--- Enabled for wake?
648 * | +----- Set?
649 * +----------- <Reserved>
651 typedef u32 acpi_event_status;
653 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
654 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
655 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
656 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
657 #define ACPI_EVENT_FLAG_HANDLE (acpi_event_status) 0x08
660 * General Purpose Events (GPE)
662 #define ACPI_GPE_INVALID 0xFF
663 #define ACPI_GPE_MAX 0xFF
664 #define ACPI_NUM_GPE 256
666 #define ACPI_GPE_ENABLE 0
667 #define ACPI_GPE_DISABLE 1
670 * GPE info flags - Per GPE
671 * +-+-+-+---+---+-+
672 * |7|6|5|4:3|2:1|0|
673 * +-+-+-+---+---+-+
674 * | | | | | |
675 * | | | | | +--- Interrupt type: Edge or Level Triggered
676 * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime
677 * | | | +--- Type of dispatch -- to method, handler, or none
678 * | | +--- Enabled for runtime?
679 * | +--- Enabled for wake?
680 * +--- Unused
682 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01
683 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01
684 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
686 #define ACPI_GPE_TYPE_MASK (u8) 0x06
687 #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06
688 #define ACPI_GPE_TYPE_WAKE (u8) 0x02
689 #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */
691 #define ACPI_GPE_DISPATCH_MASK (u8) 0x18
692 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08
693 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10
694 #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */
696 #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20
697 #define ACPI_GPE_RUN_ENABLED (u8) 0x20
698 #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */
700 #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40
701 #define ACPI_GPE_WAKE_ENABLED (u8) 0x40
702 #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */
704 #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */
707 * Flags for GPE and Lock interfaces
709 #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */
710 #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */
712 #define ACPI_NOT_ISR 0x1
713 #define ACPI_ISR 0x0
715 /* Notify types */
717 #define ACPI_SYSTEM_NOTIFY 0x1
718 #define ACPI_DEVICE_NOTIFY 0x2
719 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
720 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
722 #define ACPI_MAX_SYS_NOTIFY 0x7f
724 /* Address Space (Operation Region) Types */
726 typedef u8 acpi_adr_space_type;
728 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
729 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
730 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
731 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
732 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
733 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
734 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
735 #define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
736 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 8
737 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
740 * bit_register IDs
742 * These values are intended to be used by the hardware interfaces
743 * and are mapped to individual bitfields defined within the ACPI
744 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
745 * for this mapping.
748 /* PM1 Status register */
750 #define ACPI_BITREG_TIMER_STATUS 0x00
751 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
752 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
753 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
754 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
755 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
756 #define ACPI_BITREG_WAKE_STATUS 0x06
757 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
759 /* PM1 Enable register */
761 #define ACPI_BITREG_TIMER_ENABLE 0x08
762 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
763 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
764 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
765 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
766 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
768 /* PM1 Control register */
770 #define ACPI_BITREG_SCI_ENABLE 0x0E
771 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
772 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
773 #define ACPI_BITREG_SLEEP_TYPE 0x11
774 #define ACPI_BITREG_SLEEP_ENABLE 0x12
776 /* PM2 Control register */
778 #define ACPI_BITREG_ARB_DISABLE 0x13
780 #define ACPI_BITREG_MAX 0x13
781 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
783 /* Status register values. A 1 clears a status bit. 0 = no effect */
785 #define ACPI_CLEAR_STATUS 1
787 /* Enable and Control register values */
789 #define ACPI_ENABLE_EVENT 1
790 #define ACPI_DISABLE_EVENT 0
793 * External ACPI object definition
797 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
798 * or an unresolved named reference.
800 union acpi_object {
801 acpi_object_type type; /* See definition of acpi_ns_type for values */
802 struct {
803 acpi_object_type type; /* ACPI_TYPE_INTEGER */
804 acpi_integer value; /* The actual number */
805 } integer;
807 struct {
808 acpi_object_type type; /* ACPI_TYPE_STRING */
809 u32 length; /* # of bytes in string, excluding trailing null */
810 char *pointer; /* points to the string value */
811 } string;
813 struct {
814 acpi_object_type type; /* ACPI_TYPE_BUFFER */
815 u32 length; /* # of bytes in buffer */
816 u8 *pointer; /* points to the buffer */
817 } buffer;
819 struct {
820 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
821 u32 count; /* # of elements in package */
822 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
823 } package;
825 struct {
826 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
827 acpi_object_type actual_type; /* Type associated with the Handle */
828 acpi_handle handle; /* object reference */
829 } reference;
831 struct {
832 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
833 u32 proc_id;
834 acpi_io_address pblk_address;
835 u32 pblk_length;
836 } processor;
838 struct {
839 acpi_object_type type; /* ACPI_TYPE_POWER */
840 u32 system_level;
841 u32 resource_order;
842 } power_resource;
846 * List of objects, used as a parameter list for control method evaluation
848 struct acpi_object_list {
849 u32 count;
850 union acpi_object *pointer;
854 * Miscellaneous common Data Structures used by the interfaces
856 #define ACPI_NO_BUFFER 0
857 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
858 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
860 struct acpi_buffer {
861 acpi_size length; /* Length in bytes of the buffer */
862 void *pointer; /* pointer to buffer */
866 * name_type for acpi_get_name
868 #define ACPI_FULL_PATHNAME 0
869 #define ACPI_SINGLE_NAME 1
870 #define ACPI_NAME_TYPE_MAX 1
873 * Predefined Namespace items
875 struct acpi_predefined_names {
876 char *name;
877 u8 type;
878 char *val;
882 * Structure and flags for acpi_get_system_info
884 #define ACPI_SYS_MODE_UNKNOWN 0x0000
885 #define ACPI_SYS_MODE_ACPI 0x0001
886 #define ACPI_SYS_MODE_LEGACY 0x0002
887 #define ACPI_SYS_MODES_MASK 0x0003
890 * System info returned by acpi_get_system_info()
892 struct acpi_system_info {
893 u32 acpi_ca_version;
894 u32 flags;
895 u32 timer_resolution;
896 u32 reserved1;
897 u32 reserved2;
898 u32 debug_level;
899 u32 debug_layer;
902 /* Table Event Types */
904 #define ACPI_TABLE_EVENT_LOAD 0x0
905 #define ACPI_TABLE_EVENT_UNLOAD 0x1
906 #define ACPI_NUM_TABLE_EVENTS 2
909 * Types specific to the OS service interfaces
911 typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
913 typedef void
914 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
917 * Various handlers and callback procedures
919 typedef u32(*acpi_event_handler) (void *context);
921 typedef
922 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
924 typedef
925 void (*acpi_object_handler) (acpi_handle object, void *data);
927 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
929 #define ACPI_INIT_DEVICE_INI 1
931 typedef
932 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
933 acpi_name name,
934 u16 opcode,
935 u32 aml_offset, void *context);
937 /* Table Event handler (Load, load_table, etc.) and types */
939 typedef
940 acpi_status(*acpi_tbl_handler) (u32 event, void *table, void *context);
942 /* Address Spaces (For Operation Regions) */
944 typedef
945 acpi_status(*acpi_adr_space_handler) (u32 function,
946 acpi_physical_address address,
947 u32 bit_width,
948 acpi_integer * value,
949 void *handler_context,
950 void *region_context);
952 #define ACPI_DEFAULT_HANDLER NULL
954 typedef
955 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
956 u32 function,
957 void *handler_context,
958 void **region_context);
960 #define ACPI_REGION_ACTIVATE 0
961 #define ACPI_REGION_DEACTIVATE 1
963 typedef
964 acpi_status(*acpi_walk_callback) (acpi_handle obj_handle,
965 u32 nesting_level,
966 void *context, void **return_value);
968 /* Interrupt handler return values */
970 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
971 #define ACPI_INTERRUPT_HANDLED 0x01
973 /* Length of 32-bit EISAID values when converted back to a string */
975 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
977 /* Length of UUID (string) values */
979 #define ACPI_UUID_LENGTH 16
981 /* Structures used for device/processor HID, UID, CID */
983 struct acpica_device_id {
984 u32 length; /* Length of string + null */
985 char *string;
988 struct acpica_device_id_list {
989 u32 count; /* Number of IDs in Ids array */
990 u32 list_size; /* Size of list, including ID strings */
991 struct acpica_device_id ids[1]; /* ID array */
995 * Structure returned from acpi_get_object_info.
996 * Optimized for both 32- and 64-bit builds
998 struct acpi_device_info {
999 u32 info_size; /* Size of info, including ID strings */
1000 u32 name; /* ACPI object Name */
1001 acpi_object_type type; /* ACPI object Type */
1002 u8 param_count; /* If a method, required parameter count */
1003 u8 valid; /* Indicates which optional fields are valid */
1004 u8 flags; /* Miscellaneous info */
1005 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1006 u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
1007 u32 current_status; /* _STA value */
1008 acpi_integer address; /* _ADR value */
1009 struct acpica_device_id hardware_id; /* _HID value */
1010 struct acpica_device_id unique_id; /* _UID value */
1011 struct acpica_device_id_list compatible_id_list; /* _CID list <must be last> */
1014 /* Values for Flags field above (acpi_get_object_info) */
1016 #define ACPI_PCI_ROOT_BRIDGE 0x01
1018 /* Flags for Valid field above (acpi_get_object_info) */
1020 #define ACPI_VALID_STA 0x01
1021 #define ACPI_VALID_ADR 0x02
1022 #define ACPI_VALID_HID 0x04
1023 #define ACPI_VALID_UID 0x08
1024 #define ACPI_VALID_CID 0x10
1025 #define ACPI_VALID_SXDS 0x20
1026 #define ACPI_VALID_SXWS 0x40
1028 /* Flags for _STA method */
1030 #define ACPI_STA_DEVICE_PRESENT 0x01
1031 #define ACPI_STA_DEVICE_ENABLED 0x02
1032 #define ACPI_STA_DEVICE_UI 0x04
1033 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1034 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1035 #define ACPI_STA_BATTERY_PRESENT 0x10
1037 /* Context structs for address space handlers */
1039 struct acpi_pci_id {
1040 u16 segment;
1041 u16 bus;
1042 u16 device;
1043 u16 function;
1046 struct acpi_mem_space_context {
1047 u32 length;
1048 acpi_physical_address address;
1049 acpi_physical_address mapped_physical_address;
1050 u8 *mapped_logical_address;
1051 acpi_size mapped_length;
1055 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1057 struct acpi_memory_list {
1058 char *list_name;
1059 void *list_head;
1060 u16 object_size;
1061 u16 max_depth;
1062 u16 current_depth;
1063 u16 link_offset;
1065 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1067 /* Statistics for debug memory tracking only */
1069 u32 total_allocated;
1070 u32 total_freed;
1071 u32 max_occupied;
1072 u32 total_size;
1073 u32 current_total_size;
1074 u32 requests;
1075 u32 hits;
1076 #endif
1079 #endif /* __ACTYPES_H__ */