Linux 3.12.28
[linux/fpc-iii.git] / include / acpi / actypes.h
blobb748aefce929983cf94d3729db782e62c2843768
1 /******************************************************************************
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2013, 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
120 /*******************************************************************************
122 * Common types for all compilers, all targets
124 ******************************************************************************/
126 typedef unsigned char BOOLEAN;
127 typedef unsigned char UINT8;
128 typedef unsigned short UINT16;
129 typedef COMPILER_DEPENDENT_UINT64 UINT64;
130 typedef COMPILER_DEPENDENT_INT64 INT64;
132 /*! [End] no source code translation !*/
135 * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
136 * across operating systems or even the various UNIX systems. Since ACPICA
137 * only needs the thread ID as a unique thread identifier, we use a u64
138 * as the only common data type - it will accommodate any type of pointer or
139 * any type of integer. It is up to the host-dependent OSL to cast the
140 * native thread ID type to a u64 (in acpi_os_get_thread_id).
142 #define acpi_thread_id u64
144 /*******************************************************************************
146 * Types specific to 64-bit targets
148 ******************************************************************************/
150 #if ACPI_MACHINE_WIDTH == 64
152 /*! [Begin] no source code translation (keep the typedefs as-is) */
154 typedef unsigned int UINT32;
155 typedef int INT32;
157 /*! [End] no source code translation !*/
159 typedef s64 acpi_native_int;
161 typedef u64 acpi_size;
162 typedef u64 acpi_io_address;
163 typedef u64 acpi_physical_address;
165 #define ACPI_MAX_PTR ACPI_UINT64_MAX
166 #define ACPI_SIZE_MAX ACPI_UINT64_MAX
168 #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
171 * In the case of the Itanium Processor Family (IPF), the hardware does not
172 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
173 * to indicate that special precautions must be taken to avoid alignment faults.
174 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
176 * Note: EM64T and other X86-64 processors support misaligned transfers,
177 * so there is no need to define this flag.
179 #if defined (__IA64__) || defined (__ia64__)
180 #define ACPI_MISALIGNMENT_NOT_SUPPORTED
181 #endif
183 /*******************************************************************************
185 * Types specific to 32-bit targets
187 ******************************************************************************/
189 #elif ACPI_MACHINE_WIDTH == 32
191 /*! [Begin] no source code translation (keep the typedefs as-is) */
193 typedef unsigned int UINT32;
194 typedef int INT32;
196 /*! [End] no source code translation !*/
198 typedef s32 acpi_native_int;
200 typedef u32 acpi_size;
201 typedef u32 acpi_io_address;
202 typedef u32 acpi_physical_address;
204 #define ACPI_MAX_PTR ACPI_UINT32_MAX
205 #define ACPI_SIZE_MAX ACPI_UINT32_MAX
207 #else
209 /* ACPI_MACHINE_WIDTH must be either 64 or 32 */
211 #error unknown ACPI_MACHINE_WIDTH
212 #endif
214 /*******************************************************************************
216 * OS-dependent types
218 * If the defaults below are not appropriate for the host system, they can
219 * be defined in the OS-specific header, and this will take precedence.
221 ******************************************************************************/
223 /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
225 #ifndef acpi_cpu_flags
226 #define acpi_cpu_flags acpi_size
227 #endif
229 /* Object returned from acpi_os_create_cache */
231 #ifndef acpi_cache_t
232 #ifdef ACPI_USE_LOCAL_CACHE
233 #define acpi_cache_t struct acpi_memory_list
234 #else
235 #define acpi_cache_t void *
236 #endif
237 #endif
240 * Synchronization objects - Mutexes, Semaphores, and spin_locks
242 #if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
244 * These macros are used if the host OS does not support a mutex object.
245 * Map the OSL Mutex interfaces to binary semaphores.
247 #define acpi_mutex acpi_semaphore
248 #define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
249 #define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
250 #define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
251 #define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
252 #endif
254 /* Configurable types for synchronization objects */
256 #ifndef acpi_spinlock
257 #define acpi_spinlock void *
258 #endif
260 #ifndef acpi_semaphore
261 #define acpi_semaphore void *
262 #endif
264 #ifndef acpi_mutex
265 #define acpi_mutex void *
266 #endif
268 /*******************************************************************************
270 * Compiler-dependent types
272 * If the defaults below are not appropriate for the host compiler, they can
273 * be defined in the compiler-specific header, and this will take precedence.
275 ******************************************************************************/
277 /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
279 #ifndef acpi_uintptr_t
280 #define acpi_uintptr_t void *
281 #endif
284 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
285 * some compilers can catch printf format string problems
287 #ifndef ACPI_PRINTF_LIKE
288 #define ACPI_PRINTF_LIKE(c)
289 #endif
292 * Some compilers complain about unused variables. Sometimes we don't want to
293 * use all the variables (for example, _acpi_module_name). This allows us
294 * to tell the compiler in a per-variable manner that a variable
295 * is unused
297 #ifndef ACPI_UNUSED_VAR
298 #define ACPI_UNUSED_VAR
299 #endif
302 * All ACPICA functions that are available to the rest of the kernel are
303 * tagged with this macro which can be defined as appropriate for the host.
305 #ifndef ACPI_EXPORT_SYMBOL
306 #define ACPI_EXPORT_SYMBOL(symbol)
307 #endif
309 /******************************************************************************
311 * ACPI Specification constants (Do not change unless the specification changes)
313 *****************************************************************************/
315 /* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
317 #define ACPI_MAX_GPE_BLOCKS 2
319 /* Default ACPI register widths */
321 #define ACPI_GPE_REGISTER_WIDTH 8
322 #define ACPI_PM1_REGISTER_WIDTH 16
323 #define ACPI_PM2_REGISTER_WIDTH 8
324 #define ACPI_PM_TIMER_WIDTH 32
326 /* Names within the namespace are 4 bytes long */
328 #define ACPI_NAME_SIZE 4
329 #define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
330 #define ACPI_PATH_SEPARATOR '.'
332 /* Sizes for ACPI table headers */
334 #define ACPI_OEM_ID_SIZE 6
335 #define ACPI_OEM_TABLE_ID_SIZE 8
337 /* ACPI/PNP hardware IDs */
339 #define PCI_ROOT_HID_STRING "PNP0A03"
340 #define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
342 /* PM Timer ticks per second (HZ) */
344 #define ACPI_PM_TIMER_FREQUENCY 3579545
346 /*******************************************************************************
348 * Independent types
350 ******************************************************************************/
352 /* Logical defines and NULL */
354 #ifdef FALSE
355 #undef FALSE
356 #endif
357 #define FALSE (1 == 0)
359 #ifdef TRUE
360 #undef TRUE
361 #endif
362 #define TRUE (1 == 1)
364 #ifndef NULL
365 #define NULL (void *) 0
366 #endif
369 * Miscellaneous types
371 typedef u32 acpi_status; /* All ACPI Exceptions */
372 typedef u32 acpi_name; /* 4-byte ACPI name */
373 typedef char *acpi_string; /* Null terminated ASCII string */
374 typedef void *acpi_handle; /* Actually a ptr to a NS Node */
376 /* Time constants for timer calculations */
378 #define ACPI_MSEC_PER_SEC 1000L
380 #define ACPI_USEC_PER_MSEC 1000L
381 #define ACPI_USEC_PER_SEC 1000000L
383 #define ACPI_100NSEC_PER_USEC 10L
384 #define ACPI_100NSEC_PER_MSEC 10000L
385 #define ACPI_100NSEC_PER_SEC 10000000L
387 #define ACPI_NSEC_PER_USEC 1000L
388 #define ACPI_NSEC_PER_MSEC 1000000L
389 #define ACPI_NSEC_PER_SEC 1000000000L
391 /* Owner IDs are used to track namespace nodes for selective deletion */
393 typedef u8 acpi_owner_id;
394 #define ACPI_OWNER_ID_MAX 0xFF
396 #define ACPI_INTEGER_BIT_SIZE 64
397 #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
399 #if ACPI_MACHINE_WIDTH == 64
400 #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
401 #endif
403 #define ACPI_MAX64_DECIMAL_DIGITS 20
404 #define ACPI_MAX32_DECIMAL_DIGITS 10
405 #define ACPI_MAX16_DECIMAL_DIGITS 5
406 #define ACPI_MAX8_DECIMAL_DIGITS 3
409 * Constants with special meanings
411 #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
412 #define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
413 #define ACPI_DO_NOT_WAIT 0
416 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
417 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
418 * pertains to the ACPI integer type only, not to other integers used in the
419 * implementation of the ACPICA subsystem.
421 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
422 * code base. It remains here for compatibility with device drivers that use
423 * the type. However, it will be removed in the future.
425 typedef u64 acpi_integer;
426 #define ACPI_INTEGER_MAX ACPI_UINT64_MAX
428 /*******************************************************************************
430 * Commonly used macros
432 ******************************************************************************/
434 /* Data manipulation */
436 #define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
437 #define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
438 #define ACPI_LOWORD(integer) ((u16) (u32)(integer))
439 #define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
440 #define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
441 #define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
443 #define ACPI_SET_BIT(target,bit) ((target) |= (bit))
444 #define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
445 #define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
446 #define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
448 /* Size calculation */
450 #define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
452 /* Pointer manipulation */
454 #define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
455 #define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
456 #define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
457 #define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
459 /* Pointer/Integer type conversions */
461 #define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
462 #define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
463 #define ACPI_OFFSET(d, f) (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
464 #define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
465 #define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
467 /* Optimizations for 4-character (32-bit) acpi_name manipulation */
469 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
470 #define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
471 #define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
472 #else
473 #define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
474 #define ACPI_MOVE_NAME(dest,src) (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
475 #endif
477 /*******************************************************************************
479 * Miscellaneous constants
481 ******************************************************************************/
484 * Initialization sequence
486 #define ACPI_FULL_INITIALIZATION 0x00
487 #define ACPI_NO_ADDRESS_SPACE_INIT 0x01
488 #define ACPI_NO_HARDWARE_INIT 0x02
489 #define ACPI_NO_EVENT_INIT 0x04
490 #define ACPI_NO_HANDLER_INIT 0x08
491 #define ACPI_NO_ACPI_ENABLE 0x10
492 #define ACPI_NO_DEVICE_INIT 0x20
493 #define ACPI_NO_OBJECT_INIT 0x40
496 * Initialization state
498 #define ACPI_SUBSYSTEM_INITIALIZE 0x01
499 #define ACPI_INITIALIZED_OK 0x02
502 * Power state values
504 #define ACPI_STATE_UNKNOWN (u8) 0xFF
506 #define ACPI_STATE_S0 (u8) 0
507 #define ACPI_STATE_S1 (u8) 1
508 #define ACPI_STATE_S2 (u8) 2
509 #define ACPI_STATE_S3 (u8) 3
510 #define ACPI_STATE_S4 (u8) 4
511 #define ACPI_STATE_S5 (u8) 5
512 #define ACPI_S_STATES_MAX ACPI_STATE_S5
513 #define ACPI_S_STATE_COUNT 6
515 #define ACPI_STATE_D0 (u8) 0
516 #define ACPI_STATE_D1 (u8) 1
517 #define ACPI_STATE_D2 (u8) 2
518 #define ACPI_STATE_D3_HOT (u8) 3
519 #define ACPI_STATE_D3 (u8) 4
520 #define ACPI_STATE_D3_COLD ACPI_STATE_D3
521 #define ACPI_D_STATES_MAX ACPI_STATE_D3
522 #define ACPI_D_STATE_COUNT 5
524 #define ACPI_STATE_C0 (u8) 0
525 #define ACPI_STATE_C1 (u8) 1
526 #define ACPI_STATE_C2 (u8) 2
527 #define ACPI_STATE_C3 (u8) 3
528 #define ACPI_C_STATES_MAX ACPI_STATE_C3
529 #define ACPI_C_STATE_COUNT 4
532 * Sleep type invalid value
534 #define ACPI_SLEEP_TYPE_MAX 0x7
535 #define ACPI_SLEEP_TYPE_INVALID 0xFF
538 * Standard notify values
540 #define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
541 #define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
542 #define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
543 #define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
544 #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
545 #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
546 #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
547 #define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
548 #define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
549 #define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
550 #define ACPI_NOTIFY_RESERVED (u8) 0x0A
551 #define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
552 #define ACPI_NOTIFY_SHUTDOWN_REQUEST (u8) 0x0C
554 #define ACPI_NOTIFY_MAX 0x0C
557 * Types associated with ACPI names and objects. The first group of
558 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
559 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
560 * only add to the first group if the spec changes.
562 * NOTE: Types must be kept in sync with the global acpi_ns_properties
563 * and acpi_ns_type_names arrays.
565 typedef u32 acpi_object_type;
567 #define ACPI_TYPE_ANY 0x00
568 #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
569 #define ACPI_TYPE_STRING 0x02
570 #define ACPI_TYPE_BUFFER 0x03
571 #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
572 #define ACPI_TYPE_FIELD_UNIT 0x05
573 #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
574 #define ACPI_TYPE_EVENT 0x07
575 #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
576 #define ACPI_TYPE_MUTEX 0x09
577 #define ACPI_TYPE_REGION 0x0A
578 #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
579 #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
580 #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
581 #define ACPI_TYPE_BUFFER_FIELD 0x0E
582 #define ACPI_TYPE_DDB_HANDLE 0x0F
583 #define ACPI_TYPE_DEBUG_OBJECT 0x10
585 #define ACPI_TYPE_EXTERNAL_MAX 0x10
588 * These are object types that do not map directly to the ACPI
589 * object_type() operator. They are used for various internal purposes only.
590 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
591 * internal types must move upwards. (There is code that depends on these
592 * values being contiguous with the external types above.)
594 #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
595 #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
596 #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
597 #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
598 #define ACPI_TYPE_LOCAL_ALIAS 0x15
599 #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
600 #define ACPI_TYPE_LOCAL_NOTIFY 0x17
601 #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
602 #define ACPI_TYPE_LOCAL_RESOURCE 0x19
603 #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
604 #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
606 #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
609 * These are special object types that never appear in
610 * a Namespace node, only in an object of union acpi_operand_object
612 #define ACPI_TYPE_LOCAL_EXTRA 0x1C
613 #define ACPI_TYPE_LOCAL_DATA 0x1D
615 #define ACPI_TYPE_LOCAL_MAX 0x1D
617 /* All types above here are invalid */
619 #define ACPI_TYPE_INVALID 0x1E
620 #define ACPI_TYPE_NOT_FOUND 0xFF
622 #define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
625 * All I/O
627 #define ACPI_READ 0
628 #define ACPI_WRITE 1
629 #define ACPI_IO_MASK 1
632 * Event Types: Fixed & General Purpose
634 typedef u32 acpi_event_type;
637 * Fixed events
639 #define ACPI_EVENT_PMTIMER 0
640 #define ACPI_EVENT_GLOBAL 1
641 #define ACPI_EVENT_POWER_BUTTON 2
642 #define ACPI_EVENT_SLEEP_BUTTON 3
643 #define ACPI_EVENT_RTC 4
644 #define ACPI_EVENT_MAX 4
645 #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
648 * Event status - Per event
649 * -------------
650 * The encoding of acpi_event_status is illustrated below.
651 * Note that a set bit (1) indicates the property is TRUE
652 * (e.g. if bit 0 is set then the event is enabled).
653 * +-------------+-+-+-+-+
654 * | Bits 31:4 |3|2|1|0|
655 * +-------------+-+-+-+-+
656 * | | | | |
657 * | | | | +- Enabled?
658 * | | | +--- Enabled for wake?
659 * | | +----- Set?
660 * | +------- Has a handler?
661 * +----------- <Reserved>
663 typedef u32 acpi_event_status;
665 #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
666 #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
667 #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
668 #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
669 #define ACPI_EVENT_FLAG_HANDLE (acpi_event_status) 0x08
671 /* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
673 #define ACPI_GPE_ENABLE 0
674 #define ACPI_GPE_DISABLE 1
675 #define ACPI_GPE_CONDITIONAL_ENABLE 2
678 * GPE info flags - Per GPE
679 * +-------+-+-+---+
680 * | 7:4 |3|2|1:0|
681 * +-------+-+-+---+
682 * | | | |
683 * | | | +-- Type of dispatch:to method, handler, notify, or none
684 * | | +----- Interrupt type: edge or level triggered
685 * | +------- Is a Wake GPE
686 * +------------ <Reserved>
688 #define ACPI_GPE_DISPATCH_NONE (u8) 0x00
689 #define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
690 #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
691 #define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
692 #define ACPI_GPE_DISPATCH_MASK (u8) 0x03
694 #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x04
695 #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
696 #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x04
698 #define ACPI_GPE_CAN_WAKE (u8) 0x08
701 * Flags for GPE and Lock interfaces
703 #define ACPI_NOT_ISR 0x1
704 #define ACPI_ISR 0x0
706 /* Notify types */
708 #define ACPI_SYSTEM_NOTIFY 0x1
709 #define ACPI_DEVICE_NOTIFY 0x2
710 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
711 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
712 #define ACPI_NUM_NOTIFY_TYPES 2
714 #define ACPI_MAX_SYS_NOTIFY 0x7F
715 #define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
717 #define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
718 #define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
720 /* Address Space (Operation Region) Types */
722 typedef u8 acpi_adr_space_type;
724 #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
725 #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
726 #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
727 #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
728 #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
729 #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
730 #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
731 #define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
732 #define ACPI_ADR_SPACE_GPIO (acpi_adr_space_type) 8
733 #define ACPI_ADR_SPACE_GSBUS (acpi_adr_space_type) 9
734 #define ACPI_ADR_SPACE_PLATFORM_COMM (acpi_adr_space_type) 10
736 #define ACPI_NUM_PREDEFINED_REGIONS 11
739 * Special Address Spaces
741 * Note: A Data Table region is a special type of operation region
742 * that has its own AML opcode. However, internally, the AML
743 * interpreter simply creates an operation region with an an address
744 * space type of ACPI_ADR_SPACE_DATA_TABLE.
746 #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */
747 #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F
749 /* Values for _REG connection code */
751 #define ACPI_REG_DISCONNECT 0
752 #define ACPI_REG_CONNECT 1
755 * bit_register IDs
757 * These values are intended to be used by the hardware interfaces
758 * and are mapped to individual bitfields defined within the ACPI
759 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
760 * for this mapping.
763 /* PM1 Status register */
765 #define ACPI_BITREG_TIMER_STATUS 0x00
766 #define ACPI_BITREG_BUS_MASTER_STATUS 0x01
767 #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
768 #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
769 #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
770 #define ACPI_BITREG_RT_CLOCK_STATUS 0x05
771 #define ACPI_BITREG_WAKE_STATUS 0x06
772 #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
774 /* PM1 Enable register */
776 #define ACPI_BITREG_TIMER_ENABLE 0x08
777 #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
778 #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
779 #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
780 #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
781 #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
783 /* PM1 Control register */
785 #define ACPI_BITREG_SCI_ENABLE 0x0E
786 #define ACPI_BITREG_BUS_MASTER_RLD 0x0F
787 #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
788 #define ACPI_BITREG_SLEEP_TYPE 0x11
789 #define ACPI_BITREG_SLEEP_ENABLE 0x12
791 /* PM2 Control register */
793 #define ACPI_BITREG_ARB_DISABLE 0x13
795 #define ACPI_BITREG_MAX 0x13
796 #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
798 /* Status register values. A 1 clears a status bit. 0 = no effect */
800 #define ACPI_CLEAR_STATUS 1
802 /* Enable and Control register values */
804 #define ACPI_ENABLE_EVENT 1
805 #define ACPI_DISABLE_EVENT 0
807 /* Sleep function dispatch */
809 typedef acpi_status(*acpi_sleep_function) (u8 sleep_state);
811 struct acpi_sleep_functions {
812 acpi_sleep_function legacy_function;
813 acpi_sleep_function extended_function;
817 * External ACPI object definition
821 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
822 * or an unresolved named reference.
824 union acpi_object {
825 acpi_object_type type; /* See definition of acpi_ns_type for values */
826 struct {
827 acpi_object_type type; /* ACPI_TYPE_INTEGER */
828 u64 value; /* The actual number */
829 } integer;
831 struct {
832 acpi_object_type type; /* ACPI_TYPE_STRING */
833 u32 length; /* # of bytes in string, excluding trailing null */
834 char *pointer; /* points to the string value */
835 } string;
837 struct {
838 acpi_object_type type; /* ACPI_TYPE_BUFFER */
839 u32 length; /* # of bytes in buffer */
840 u8 *pointer; /* points to the buffer */
841 } buffer;
843 struct {
844 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
845 u32 count; /* # of elements in package */
846 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
847 } package;
849 struct {
850 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
851 acpi_object_type actual_type; /* Type associated with the Handle */
852 acpi_handle handle; /* object reference */
853 } reference;
855 struct {
856 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
857 u32 proc_id;
858 acpi_io_address pblk_address;
859 u32 pblk_length;
860 } processor;
862 struct {
863 acpi_object_type type; /* ACPI_TYPE_POWER */
864 u32 system_level;
865 u32 resource_order;
866 } power_resource;
870 * List of objects, used as a parameter list for control method evaluation
872 struct acpi_object_list {
873 u32 count;
874 union acpi_object *pointer;
878 * Miscellaneous common Data Structures used by the interfaces
880 #define ACPI_NO_BUFFER 0
881 #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
882 #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
884 struct acpi_buffer {
885 acpi_size length; /* Length in bytes of the buffer */
886 void *pointer; /* pointer to buffer */
889 /* Free a buffer created in an struct acpi_buffer via ACPI_ALLOCATE_LOCAL_BUFFER */
891 #define ACPI_FREE_BUFFER(b) ACPI_FREE(b.pointer)
894 * name_type for acpi_get_name
896 #define ACPI_FULL_PATHNAME 0
897 #define ACPI_SINGLE_NAME 1
898 #define ACPI_NAME_TYPE_MAX 1
901 * Predefined Namespace items
903 struct acpi_predefined_names {
904 char *name;
905 u8 type;
906 char *val;
910 * Structure and flags for acpi_get_system_info
912 #define ACPI_SYS_MODE_UNKNOWN 0x0000
913 #define ACPI_SYS_MODE_ACPI 0x0001
914 #define ACPI_SYS_MODE_LEGACY 0x0002
915 #define ACPI_SYS_MODES_MASK 0x0003
918 * System info returned by acpi_get_system_info()
920 struct acpi_system_info {
921 u32 acpi_ca_version;
922 u32 flags;
923 u32 timer_resolution;
924 u32 reserved1;
925 u32 reserved2;
926 u32 debug_level;
927 u32 debug_layer;
930 /* Table Event Types */
932 #define ACPI_TABLE_EVENT_LOAD 0x0
933 #define ACPI_TABLE_EVENT_UNLOAD 0x1
934 #define ACPI_NUM_TABLE_EVENTS 2
937 * Types specific to the OS service interfaces
939 typedef u32
940 (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
942 typedef void
943 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
946 * Various handlers and callback procedures
948 typedef
949 void (*acpi_gbl_event_handler) (u32 event_type,
950 acpi_handle device,
951 u32 event_number, void *context);
953 #define ACPI_EVENT_TYPE_GPE 0
954 #define ACPI_EVENT_TYPE_FIXED 1
956 typedef
957 u32(*acpi_event_handler) (void *context);
959 typedef
960 u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
962 typedef
963 void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
965 typedef
966 void (*acpi_object_handler) (acpi_handle object, void *data);
968 typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
970 #define ACPI_INIT_DEVICE_INI 1
972 typedef
973 acpi_status(*acpi_exception_handler) (acpi_status aml_status,
974 acpi_name name,
975 u16 opcode,
976 u32 aml_offset, void *context);
978 /* Table Event handler (Load, load_table, etc.) and types */
980 typedef
981 acpi_status(*acpi_table_handler) (u32 event, void *table, void *context);
983 #define ACPI_TABLE_LOAD 0x0
984 #define ACPI_TABLE_UNLOAD 0x1
985 #define ACPI_NUM_TABLE_EVENTS 2
987 /* Address Spaces (For Operation Regions) */
989 typedef
990 acpi_status(*acpi_adr_space_handler) (u32 function,
991 acpi_physical_address address,
992 u32 bit_width,
993 u64 *value,
994 void *handler_context,
995 void *region_context);
997 #define ACPI_DEFAULT_HANDLER NULL
999 /* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
1001 struct acpi_connection_info {
1002 u8 *connection;
1003 u16 length;
1004 u8 access_length;
1007 typedef
1008 acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
1009 u32 function,
1010 void *handler_context,
1011 void **region_context);
1013 #define ACPI_REGION_ACTIVATE 0
1014 #define ACPI_REGION_DEACTIVATE 1
1016 typedef
1017 acpi_status(*acpi_walk_callback) (acpi_handle object,
1018 u32 nesting_level,
1019 void *context, void **return_value);
1021 typedef
1022 u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
1024 /* Interrupt handler return values */
1026 #define ACPI_INTERRUPT_NOT_HANDLED 0x00
1027 #define ACPI_INTERRUPT_HANDLED 0x01
1029 /* GPE handler return values */
1031 #define ACPI_REENABLE_GPE 0x80
1033 /* Length of 32-bit EISAID values when converted back to a string */
1035 #define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1037 /* Length of UUID (string) values */
1039 #define ACPI_UUID_LENGTH 16
1041 /* Structures used for device/processor HID, UID, CID, and SUB */
1043 struct acpi_pnp_device_id {
1044 u32 length; /* Length of string + null */
1045 char *string;
1048 struct acpi_pnp_device_id_list {
1049 u32 count; /* Number of IDs in Ids array */
1050 u32 list_size; /* Size of list, including ID strings */
1051 struct acpi_pnp_device_id ids[1]; /* ID array */
1055 * Structure returned from acpi_get_object_info.
1056 * Optimized for both 32- and 64-bit builds
1058 struct acpi_device_info {
1059 u32 info_size; /* Size of info, including ID strings */
1060 u32 name; /* ACPI object Name */
1061 acpi_object_type type; /* ACPI object Type */
1062 u8 param_count; /* If a method, required parameter count */
1063 u8 valid; /* Indicates which optional fields are valid */
1064 u8 flags; /* Miscellaneous info */
1065 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1066 u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
1067 u32 current_status; /* _STA value */
1068 u64 address; /* _ADR value */
1069 struct acpi_pnp_device_id hardware_id; /* _HID value */
1070 struct acpi_pnp_device_id unique_id; /* _UID value */
1071 struct acpi_pnp_device_id subsystem_id; /* _SUB value */
1072 struct acpi_pnp_device_id_list compatible_id_list; /* _CID list <must be last> */
1075 /* Values for Flags field above (acpi_get_object_info) */
1077 #define ACPI_PCI_ROOT_BRIDGE 0x01
1079 /* Flags for Valid field above (acpi_get_object_info) */
1081 #define ACPI_VALID_STA 0x01
1082 #define ACPI_VALID_ADR 0x02
1083 #define ACPI_VALID_HID 0x04
1084 #define ACPI_VALID_UID 0x08
1085 #define ACPI_VALID_SUB 0x10
1086 #define ACPI_VALID_CID 0x20
1087 #define ACPI_VALID_SXDS 0x40
1088 #define ACPI_VALID_SXWS 0x80
1090 /* Flags for _STA return value (current_status above) */
1092 #define ACPI_STA_DEVICE_PRESENT 0x01
1093 #define ACPI_STA_DEVICE_ENABLED 0x02
1094 #define ACPI_STA_DEVICE_UI 0x04
1095 #define ACPI_STA_DEVICE_FUNCTIONING 0x08
1096 #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
1097 #define ACPI_STA_BATTERY_PRESENT 0x10
1099 /* Context structs for address space handlers */
1101 struct acpi_pci_id {
1102 u16 segment;
1103 u16 bus;
1104 u16 device;
1105 u16 function;
1108 struct acpi_mem_space_context {
1109 u32 length;
1110 acpi_physical_address address;
1111 acpi_physical_address mapped_physical_address;
1112 u8 *mapped_logical_address;
1113 acpi_size mapped_length;
1117 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1119 struct acpi_memory_list {
1120 char *list_name;
1121 void *list_head;
1122 u16 object_size;
1123 u16 max_depth;
1124 u16 current_depth;
1126 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
1128 /* Statistics for debug memory tracking only */
1130 u32 total_allocated;
1131 u32 total_freed;
1132 u32 max_occupied;
1133 u32 total_size;
1134 u32 current_total_size;
1135 u32 requests;
1136 u32 hits;
1137 #endif
1140 /* Definitions of _OSI support */
1142 #define ACPI_VENDOR_STRINGS 0x01
1143 #define ACPI_FEATURE_STRINGS 0x02
1144 #define ACPI_ENABLE_INTERFACES 0x00
1145 #define ACPI_DISABLE_INTERFACES 0x04
1147 #define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1148 #define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1149 #define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1150 #define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1151 #define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1152 #define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1154 #define ACPI_OSI_WIN_2000 0x01
1155 #define ACPI_OSI_WIN_XP 0x02
1156 #define ACPI_OSI_WIN_XP_SP1 0x03
1157 #define ACPI_OSI_WINSRV_2003 0x04
1158 #define ACPI_OSI_WIN_XP_SP2 0x05
1159 #define ACPI_OSI_WINSRV_2003_SP1 0x06
1160 #define ACPI_OSI_WIN_VISTA 0x07
1161 #define ACPI_OSI_WINSRV_2008 0x08
1162 #define ACPI_OSI_WIN_VISTA_SP1 0x09
1163 #define ACPI_OSI_WIN_VISTA_SP2 0x0A
1164 #define ACPI_OSI_WIN_7 0x0B
1165 #define ACPI_OSI_WIN_8 0x0C
1167 #endif /* __ACTYPES_H__ */