ACPICA: Update version to 20150204
[linux-2.6-block.git] / include / acpi / actypes.h
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
4 *
5 *****************************************************************************/
6
7/*
82a80941 8 * Copyright (C) 2000 - 2015, Intel Corp.
1da177e4
LT
9 * All rights reserved.
10 *
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.
25 *
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.
29 *
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.
42 */
43
44#ifndef __ACTYPES_H__
45#define __ACTYPES_H__
46
61686124
BM
47/* acpisrc:struct_defs -- for acpisrc conversion */
48
defba1d8
BM
49/*
50 * ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
ea541578
BM
51 * and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
52 * 12/2006.
defba1d8
BM
53 */
54#ifndef ACPI_MACHINE_WIDTH
55#error ACPI_MACHINE_WIDTH not defined
56#endif
57
1da177e4
LT
58/*
59 * Data type ranges
60 * Note: These macros are designed to be compiler independent as well as
61 * working around problems that some 32-bit compilers have with 64-bit
62 * constants.
63 */
e252652f
LZ
64#define ACPI_UINT8_MAX (u8) (~((u8) 0)) /* 0xFF */
65#define ACPI_UINT16_MAX (u16)(~((u16) 0)) /* 0xFFFF */
66#define ACPI_UINT32_MAX (u32)(~((u32) 0)) /* 0xFFFFFFFF */
67#define ACPI_UINT64_MAX (u64)(~((u64) 0)) /* 0xFFFFFFFFFFFFFFFF */
1da177e4
LT
68#define ACPI_ASCII_MAX 0x7F
69
1da177e4 70/*
defba1d8
BM
71 * Architecture-specific ACPICA Subsystem Data Types
72 *
73 * The goal of these types is to provide source code portability across
74 * 16-bit, 32-bit, and 64-bit targets.
75 *
76 * 1) The following types are of fixed size for all targets (16/32/64):
77 *
e252652f 78 * u8 Logical boolean
defba1d8 79 *
e252652f
LZ
80 * u8 8-bit (1 byte) unsigned value
81 * u16 16-bit (2 byte) unsigned value
82 * u32 32-bit (4 byte) unsigned value
83 * u64 64-bit (8 byte) unsigned value
defba1d8 84 *
e252652f
LZ
85 * s16 16-bit (2 byte) signed value
86 * s32 32-bit (4 byte) signed value
87 * s64 64-bit (8 byte) signed value
defba1d8 88 *
e252652f 89 * COMPILER_DEPENDENT_UINT64/s64 - These types are defined in the
defba1d8
BM
90 * compiler-dependent header(s) and were introduced because there is no common
91 * 64-bit integer type across the various compilation models, as shown in
92 * the table below.
93 *
94 * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
95 * char 8 8 8 8 8 8
96 * short 16 16 16 16 16 16
97 * _int32 32
98 * int 32 64 32 32 16 16
99 * long 64 64 32 32 32 32
100 * long long 64 64
101 * pointer 64 64 64 32 32 32
102 *
103 * Note: ILP64 and LP32 are currently not supported.
104 *
105 *
106 * 2) These types represent the native word size of the target mode of the
107 * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
108 * usually used for memory allocation, efficient loop counters, and array
109 * indexes. The types are similar to the size_t type in the C library and are
110 * required because there is no C type that consistently represents the native
e252652f 111 * data width. acpi_size is needed because there is no guarantee that a
67a119f9 112 * kernel-level C library is present.
defba1d8 113 *
e252652f
LZ
114 * acpi_size 16/32/64-bit unsigned value
115 * acpi_native_int 16/32/64-bit signed value
1da177e4 116 */
1da177e4 117
defba1d8 118/*******************************************************************************
1da177e4 119 *
defba1d8
BM
120 * Common types for all compilers, all targets
121 *
122 ******************************************************************************/
123
e252652f
LZ
124#ifndef ACPI_USE_SYSTEM_INTTYPES
125
126typedef unsigned char u8;
127typedef unsigned char u8;
128typedef unsigned short u16;
80a648c1 129typedef short s16;
e252652f
LZ
130typedef COMPILER_DEPENDENT_UINT64 u64;
131typedef COMPILER_DEPENDENT_INT64 s64;
1da177e4 132
e252652f 133#endif /* ACPI_USE_SYSTEM_INTTYPES */
0897831b 134
28eb3fcf
LM
135/*
136 * Value returned by acpi_os_get_thread_id. There is no standard "thread_id"
137 * across operating systems or even the various UNIX systems. Since ACPICA
138 * only needs the thread ID as a unique thread identifier, we use a u64
139 * as the only common data type - it will accommodate any type of pointer or
140 * any type of integer. It is up to the host-dependent OSL to cast the
141 * native thread ID type to a u64 (in acpi_os_get_thread_id).
142 */
143#define acpi_thread_id u64
144
defba1d8
BM
145/*******************************************************************************
146 *
147 * Types specific to 64-bit targets
148 *
149 ******************************************************************************/
1da177e4
LT
150
151#if ACPI_MACHINE_WIDTH == 64
152
e252652f 153#ifndef ACPI_USE_SYSTEM_INTTYPES
1da177e4 154
e252652f
LZ
155typedef unsigned int u32;
156typedef int s32;
1da177e4 157
e252652f 158#endif /* ACPI_USE_SYSTEM_INTTYPES */
1da177e4 159
defba1d8
BM
160typedef s64 acpi_native_int;
161
67a119f9 162typedef u64 acpi_size;
4be44fcd
LB
163typedef u64 acpi_io_address;
164typedef u64 acpi_physical_address;
1da177e4 165
1da177e4
LT
166#define ACPI_MAX_PTR ACPI_UINT64_MAX
167#define ACPI_SIZE_MAX ACPI_UINT64_MAX
168
defba1d8
BM
169#define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */
170
0897831b
BM
171/*
172 * In the case of the Itanium Processor Family (IPF), the hardware does not
173 * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
174 * to indicate that special precautions must be taken to avoid alignment faults.
175 * (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
176 *
ba494bee 177 * Note: EM64T and other X86-64 processors support misaligned transfers,
0897831b
BM
178 * so there is no need to define this flag.
179 */
180#if defined (__IA64__) || defined (__ia64__)
181#define ACPI_MISALIGNMENT_NOT_SUPPORTED
182#endif
183
defba1d8
BM
184/*******************************************************************************
185 *
186 * Types specific to 32-bit targets
187 *
188 ******************************************************************************/
189
190#elif ACPI_MACHINE_WIDTH == 32
191
e252652f 192#ifndef ACPI_USE_SYSTEM_INTTYPES
defba1d8 193
e252652f
LZ
194typedef unsigned int u32;
195typedef int s32;
defba1d8 196
e252652f 197#endif /* ACPI_USE_SYSTEM_INTTYPES */
defba1d8 198
defba1d8
BM
199typedef s32 acpi_native_int;
200
67a119f9 201typedef u32 acpi_size;
defba1d8 202typedef u32 acpi_io_address;
f3d2e786 203typedef u32 acpi_physical_address;
defba1d8
BM
204
205#define ACPI_MAX_PTR ACPI_UINT32_MAX
206#define ACPI_SIZE_MAX ACPI_UINT32_MAX
207
defba1d8 208#else
1da177e4 209
59fa8505 210/* ACPI_MACHINE_WIDTH must be either 64 or 32 */
1da177e4 211
defba1d8
BM
212#error unknown ACPI_MACHINE_WIDTH
213#endif
1da177e4 214
defba1d8
BM
215/*******************************************************************************
216 *
1685bd40 217 * OS-dependent types
defba1d8 218 *
b8e4d893 219 * If the defaults below are not appropriate for the host system, they can
1685bd40 220 * be defined in the OS-specific header, and this will take precedence.
b8e4d893 221 *
defba1d8 222 ******************************************************************************/
1da177e4 223
967440e3
BM
224/* Flags for acpi_os_acquire_lock/acpi_os_release_lock */
225
b8e4d893 226#ifndef acpi_cpu_flags
67a119f9 227#define acpi_cpu_flags acpi_size
b8e4d893 228#endif
defba1d8 229
967440e3
BM
230/* Object returned from acpi_os_create_cache */
231
232#ifndef acpi_cache_t
50df4d8b 233#ifdef ACPI_USE_LOCAL_CACHE
967440e3 234#define acpi_cache_t struct acpi_memory_list
50df4d8b
BM
235#else
236#define acpi_cache_t void *
237#endif
967440e3
BM
238#endif
239
1685bd40
BM
240/*
241 * Synchronization objects - Mutexes, Semaphores, and spin_locks
242 */
243#if (ACPI_MUTEX_TYPE == ACPI_BINARY_SEMAPHORE)
244/*
245 * These macros are used if the host OS does not support a mutex object.
246 * Map the OSL Mutex interfaces to binary semaphores.
247 */
248#define acpi_mutex acpi_semaphore
249#define acpi_os_create_mutex(out_handle) acpi_os_create_semaphore (1, 1, out_handle)
250#define acpi_os_delete_mutex(handle) (void) acpi_os_delete_semaphore (handle)
251#define acpi_os_acquire_mutex(handle,time) acpi_os_wait_semaphore (handle, 1, time)
252#define acpi_os_release_mutex(handle) (void) acpi_os_signal_semaphore (handle, 1)
253#endif
254
255/* Configurable types for synchronization objects */
256
257#ifndef acpi_spinlock
258#define acpi_spinlock void *
259#endif
260
261#ifndef acpi_semaphore
262#define acpi_semaphore void *
263#endif
264
265#ifndef acpi_mutex
266#define acpi_mutex void *
267#endif
268
269/*******************************************************************************
270 *
271 * Compiler-dependent types
272 *
273 * If the defaults below are not appropriate for the host compiler, they can
274 * be defined in the compiler-specific header, and this will take precedence.
275 *
276 ******************************************************************************/
277
967440e3
BM
278/* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */
279
280#ifndef acpi_uintptr_t
281#define acpi_uintptr_t void *
282#endif
283
b8e4d893
BM
284/*
285 * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because
286 * some compilers can catch printf format string problems
287 */
288#ifndef ACPI_PRINTF_LIKE
289#define ACPI_PRINTF_LIKE(c)
290#endif
291
292/*
293 * Some compilers complain about unused variables. Sometimes we don't want to
294 * use all the variables (for example, _acpi_module_name). This allows us
fd589a8f 295 * to tell the compiler in a per-variable manner that a variable
b8e4d893
BM
296 * is unused
297 */
298#ifndef ACPI_UNUSED_VAR
299#define ACPI_UNUSED_VAR
300#endif
defba1d8 301
8313524a 302/*
d21f600b
LZ
303 * All ACPICA external functions that are available to the rest of the kernel
304 * are tagged with thes macros which can be defined as appropriate for the host.
305 *
306 * Notes:
307 * ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
308 * interfaces that may need special processing.
309 * ACPI_EXPORT_SYMBOL is used for all other public external functions.
8313524a 310 */
d21f600b
LZ
311#ifndef ACPI_EXPORT_SYMBOL_INIT
312#define ACPI_EXPORT_SYMBOL_INIT(symbol)
313#endif
314
8313524a
BM
315#ifndef ACPI_EXPORT_SYMBOL
316#define ACPI_EXPORT_SYMBOL(symbol)
317#endif
318
efb83542
LZ
319/*
320 * Compiler/Clibrary-dependent debug initialization. Used for ACPICA
321 * utilities only.
322 */
323#ifndef ACPI_DEBUG_INITIALIZE
324#define ACPI_DEBUG_INITIALIZE()
325#endif
326
b3c86c30
LZ
327/*******************************************************************************
328 *
329 * Configuration
330 *
331 ******************************************************************************/
332
d5caf1cd
LZ
333#ifdef ACPI_NO_MEM_ALLOCATIONS
334
335#define ACPI_ALLOCATE(a) NULL
336#define ACPI_ALLOCATE_ZEROED(a) NULL
337#define ACPI_FREE(a)
338#define ACPI_MEM_TRACKING(a)
339
340#else /* ACPI_NO_MEM_ALLOCATIONS */
341
b3c86c30
LZ
342#ifdef ACPI_DBG_TRACK_ALLOCATIONS
343/*
344 * Memory allocation tracking (used by acpi_exec to detect memory leaks)
345 */
346#define ACPI_MEM_PARAMETERS _COMPONENT, _acpi_module_name, __LINE__
347#define ACPI_ALLOCATE(a) acpi_ut_allocate_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
348#define ACPI_ALLOCATE_ZEROED(a) acpi_ut_allocate_zeroed_and_track ((acpi_size) (a), ACPI_MEM_PARAMETERS)
349#define ACPI_FREE(a) acpi_ut_free_and_track (a, ACPI_MEM_PARAMETERS)
350#define ACPI_MEM_TRACKING(a) a
351
352#else
353/*
354 * Normal memory allocation directly via the OS services layer
355 */
356#define ACPI_ALLOCATE(a) acpi_os_allocate ((acpi_size) (a))
357#define ACPI_ALLOCATE_ZEROED(a) acpi_os_allocate_zeroed ((acpi_size) (a))
358#define ACPI_FREE(a) acpi_os_free (a)
359#define ACPI_MEM_TRACKING(a)
360
361#endif /* ACPI_DBG_TRACK_ALLOCATIONS */
362
d5caf1cd
LZ
363#endif /* ACPI_NO_MEM_ALLOCATIONS */
364
50df4d8b
BM
365/******************************************************************************
366 *
367 * ACPI Specification constants (Do not change unless the specification changes)
368 *
369 *****************************************************************************/
370
06f55419 371/* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
50df4d8b
BM
372
373#define ACPI_MAX_GPE_BLOCKS 2
06f55419
BM
374
375/* Default ACPI register widths */
376
50df4d8b 377#define ACPI_GPE_REGISTER_WIDTH 8
06f55419
BM
378#define ACPI_PM1_REGISTER_WIDTH 16
379#define ACPI_PM2_REGISTER_WIDTH 8
380#define ACPI_PM_TIMER_WIDTH 32
e07fcfd8 381#define ACPI_RESET_REGISTER_WIDTH 8
50df4d8b
BM
382
383/* Names within the namespace are 4 bytes long */
384
385#define ACPI_NAME_SIZE 4
386#define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
387#define ACPI_PATH_SEPARATOR '.'
388
389/* Sizes for ACPI table headers */
390
391#define ACPI_OEM_ID_SIZE 6
392#define ACPI_OEM_TABLE_ID_SIZE 8
393
394/* ACPI/PNP hardware IDs */
395
396#define PCI_ROOT_HID_STRING "PNP0A03"
397#define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
398
399/* PM Timer ticks per second (HZ) */
400
c41679a4 401#define ACPI_PM_TIMER_FREQUENCY 3579545
50df4d8b 402
defba1d8
BM
403/*******************************************************************************
404 *
405 * Independent types
406 *
407 ******************************************************************************/
1da177e4 408
defba1d8 409/* Logical defines and NULL */
1da177e4 410
1da177e4
LT
411#ifdef FALSE
412#undef FALSE
413#endif
414#define FALSE (1 == 0)
415
416#ifdef TRUE
417#undef TRUE
418#endif
419#define TRUE (1 == 1)
420
421#ifndef NULL
422#define NULL (void *) 0
423#endif
424
1da177e4 425/*
6de4048a 426 * Miscellaneous types
1da177e4 427 */
4be44fcd
LB
428typedef u32 acpi_status; /* All ACPI Exceptions */
429typedef u32 acpi_name; /* 4-byte ACPI name */
430typedef char *acpi_string; /* Null terminated ASCII string */
defba1d8 431typedef void *acpi_handle; /* Actually a ptr to a NS Node */
4be44fcd 432
c41679a4
BM
433/* Time constants for timer calculations */
434
435#define ACPI_MSEC_PER_SEC 1000L
436
437#define ACPI_USEC_PER_MSEC 1000L
438#define ACPI_USEC_PER_SEC 1000000L
439
440#define ACPI_100NSEC_PER_USEC 10L
441#define ACPI_100NSEC_PER_MSEC 10000L
442#define ACPI_100NSEC_PER_SEC 10000000L
443
444#define ACPI_NSEC_PER_USEC 1000L
445#define ACPI_NSEC_PER_MSEC 1000000L
446#define ACPI_NSEC_PER_SEC 1000000000L
447
50df4d8b
BM
448/* Owner IDs are used to track namespace nodes for selective deletion */
449
450typedef u8 acpi_owner_id;
451#define ACPI_OWNER_ID_MAX 0xFF
452
1da177e4 453#define ACPI_INTEGER_BIT_SIZE 64
4be44fcd 454#define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
1da177e4
LT
455
456#if ACPI_MACHINE_WIDTH == 64
4be44fcd 457#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
1da177e4 458#endif
1da177e4
LT
459
460#define ACPI_MAX64_DECIMAL_DIGITS 20
461#define ACPI_MAX32_DECIMAL_DIGITS 10
462#define ACPI_MAX16_DECIMAL_DIGITS 5
463#define ACPI_MAX8_DECIMAL_DIGITS 3
464
465/*
466 * Constants with special meanings
467 */
c51a4de8 468#define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
50df4d8b
BM
469#define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
470#define ACPI_DO_NOT_WAIT 0
471
5df7e6cb
BM
472/*
473 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
474 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
475 * pertains to the ACPI integer type only, not to other integers used in the
476 * implementation of the ACPICA subsystem.
477 *
478 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
479 * code base. It remains here for compatibility with device drivers that use
480 * the type. However, it will be removed in the future.
481 */
482typedef u64 acpi_integer;
483#define ACPI_INTEGER_MAX ACPI_UINT64_MAX
484
50df4d8b
BM
485/*******************************************************************************
486 *
487 * Commonly used macros
488 *
489 ******************************************************************************/
490
491/* Data manipulation */
492
35d7c1cf
BM
493#define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
494#define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
495#define ACPI_LOWORD(integer) ((u16) (u32)(integer))
496#define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
497#define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
498#define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
50df4d8b
BM
499
500#define ACPI_SET_BIT(target,bit) ((target) |= (bit))
501#define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
502#define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
503#define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
504
505/* Size calculation */
506
507#define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
508
509/* Pointer manipulation */
510
511#define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
512#define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
513#define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
514#define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
515
516/* Pointer/Integer type conversions */
517
518#define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
519#define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
9b62da73 520#define ACPI_OFFSET(d, f) ACPI_PTR_DIFF (&(((d *) 0)->f), (void *) NULL)
50df4d8b
BM
521#define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
522#define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
523
ff600271
BM
524/* Optimizations for 4-character (32-bit) acpi_name manipulation */
525
50df4d8b
BM
526#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
527#define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
ff600271 528#define ACPI_MOVE_NAME(dest,src) (*ACPI_CAST_PTR (u32, (dest)) = *ACPI_CAST_PTR (u32, (src)))
50df4d8b
BM
529#else
530#define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
ff600271 531#define ACPI_MOVE_NAME(dest,src) (ACPI_STRNCPY (ACPI_CAST_PTR (char, (dest)), ACPI_CAST_PTR (char, (src)), ACPI_NAME_SIZE))
50df4d8b
BM
532#endif
533
cacba865
LZ
534/* Support for the special RSDP signature (8 characters) */
535
536#define ACPI_VALIDATE_RSDP_SIG(a) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_SIG_RSDP, 8))
537#define ACPI_MAKE_RSDP_SIG(dest) (ACPI_MEMCPY (ACPI_CAST_PTR (char, (dest)), ACPI_SIG_RSDP, 8))
538
50df4d8b
BM
539/*******************************************************************************
540 *
541 * Miscellaneous constants
542 *
543 ******************************************************************************/
1da177e4 544
1da177e4
LT
545/*
546 * Initialization sequence
547 */
548#define ACPI_FULL_INITIALIZATION 0x00
549#define ACPI_NO_ADDRESS_SPACE_INIT 0x01
739dcbb9 550#define ACPI_NO_HARDWARE_INIT 0x02
1da177e4
LT
551#define ACPI_NO_EVENT_INIT 0x04
552#define ACPI_NO_HANDLER_INIT 0x08
553#define ACPI_NO_ACPI_ENABLE 0x10
554#define ACPI_NO_DEVICE_INIT 0x20
555#define ACPI_NO_OBJECT_INIT 0x40
556
557/*
558 * Initialization state
559 */
cb219bb6
BM
560#define ACPI_SUBSYSTEM_INITIALIZE 0x01
561#define ACPI_INITIALIZED_OK 0x02
1da177e4
LT
562
563/*
564 * Power state values
565 */
566#define ACPI_STATE_UNKNOWN (u8) 0xFF
567
568#define ACPI_STATE_S0 (u8) 0
569#define ACPI_STATE_S1 (u8) 1
570#define ACPI_STATE_S2 (u8) 2
571#define ACPI_STATE_S3 (u8) 3
572#define ACPI_STATE_S4 (u8) 4
573#define ACPI_STATE_S5 (u8) 5
574#define ACPI_S_STATES_MAX ACPI_STATE_S5
575#define ACPI_S_STATE_COUNT 6
576
577#define ACPI_STATE_D0 (u8) 0
578#define ACPI_STATE_D1 (u8) 1
579#define ACPI_STATE_D2 (u8) 2
1cc0c998
LM
580#define ACPI_STATE_D3_HOT (u8) 3
581#define ACPI_STATE_D3 (u8) 4
582#define ACPI_STATE_D3_COLD ACPI_STATE_D3
583#define ACPI_D_STATES_MAX ACPI_STATE_D3
28c2103d 584#define ACPI_D_STATE_COUNT 5
1da177e4
LT
585
586#define ACPI_STATE_C0 (u8) 0
587#define ACPI_STATE_C1 (u8) 1
588#define ACPI_STATE_C2 (u8) 2
589#define ACPI_STATE_C3 (u8) 3
590#define ACPI_C_STATES_MAX ACPI_STATE_C3
591#define ACPI_C_STATE_COUNT 4
592
593/*
594 * Sleep type invalid value
595 */
596#define ACPI_SLEEP_TYPE_MAX 0x7
597#define ACPI_SLEEP_TYPE_INVALID 0xFF
598
599/*
600 * Standard notify values
601 */
514d18d7
ZR
602#define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
603#define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
604#define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
605#define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
606#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
607#define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
608#define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
609#define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
610#define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
611#define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
612#define ACPI_NOTIFY_RESERVED (u8) 0x0A
613#define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
ea143604 614#define ACPI_NOTIFY_SHUTDOWN_REQUEST (u8) 0x0C
b3cc1356 615#define ACPI_NOTIFY_AFFINITY_UPDATE (u8) 0x0D
514d18d7 616
b3cc1356 617#define ACPI_NOTIFY_MAX 0x0D
1da177e4 618
1da177e4 619/*
6de4048a 620 * Types associated with ACPI names and objects. The first group of
1da177e4
LT
621 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
622 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
623 * only add to the first group if the spec changes.
624 *
625 * NOTE: Types must be kept in sync with the global acpi_ns_properties
626 * and acpi_ns_type_names arrays.
627 */
4be44fcd 628typedef u32 acpi_object_type;
1da177e4
LT
629
630#define ACPI_TYPE_ANY 0x00
4be44fcd 631#define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
1da177e4
LT
632#define ACPI_TYPE_STRING 0x02
633#define ACPI_TYPE_BUFFER 0x03
4be44fcd 634#define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
1da177e4 635#define ACPI_TYPE_FIELD_UNIT 0x05
4be44fcd 636#define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
1da177e4 637#define ACPI_TYPE_EVENT 0x07
4be44fcd 638#define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
1da177e4
LT
639#define ACPI_TYPE_MUTEX 0x09
640#define ACPI_TYPE_REGION 0x0A
4be44fcd
LB
641#define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
642#define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
643#define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
1da177e4
LT
644#define ACPI_TYPE_BUFFER_FIELD 0x0E
645#define ACPI_TYPE_DDB_HANDLE 0x0F
646#define ACPI_TYPE_DEBUG_OBJECT 0x10
647
648#define ACPI_TYPE_EXTERNAL_MAX 0x10
649
650/*
651 * These are object types that do not map directly to the ACPI
652 * object_type() operator. They are used for various internal purposes only.
653 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
654 * internal types must move upwards. (There is code that depends on these
655 * values being contiguous with the external types above.)
656 */
657#define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
658#define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
659#define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
4be44fcd 660#define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
1da177e4
LT
661#define ACPI_TYPE_LOCAL_ALIAS 0x15
662#define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
663#define ACPI_TYPE_LOCAL_NOTIFY 0x17
664#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
665#define ACPI_TYPE_LOCAL_RESOURCE 0x19
666#define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
4be44fcd 667#define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
1da177e4 668
4be44fcd 669#define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
1da177e4
LT
670
671/*
672 * These are special object types that never appear in
75c8044f 673 * a Namespace node, only in an object of union acpi_operand_object
1da177e4
LT
674 */
675#define ACPI_TYPE_LOCAL_EXTRA 0x1C
676#define ACPI_TYPE_LOCAL_DATA 0x1D
677
678#define ACPI_TYPE_LOCAL_MAX 0x1D
679
680/* All types above here are invalid */
681
682#define ACPI_TYPE_INVALID 0x1E
683#define ACPI_TYPE_NOT_FOUND 0xFF
684
b7f9f042
BM
685#define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
686
1da177e4
LT
687/*
688 * All I/O
689 */
690#define ACPI_READ 0
691#define ACPI_WRITE 1
692#define ACPI_IO_MASK 1
693
694/*
695 * Event Types: Fixed & General Purpose
696 */
4be44fcd 697typedef u32 acpi_event_type;
1da177e4
LT
698
699/*
700 * Fixed events
701 */
702#define ACPI_EVENT_PMTIMER 0
703#define ACPI_EVENT_GLOBAL 1
704#define ACPI_EVENT_POWER_BUTTON 2
705#define ACPI_EVENT_SLEEP_BUTTON 3
706#define ACPI_EVENT_RTC 4
707#define ACPI_EVENT_MAX 4
708#define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
709
710/*
ba494bee 711 * Event status - Per event
1da177e4
LT
712 * -------------
713 * The encoding of acpi_event_status is illustrated below.
714 * Note that a set bit (1) indicates the property is TRUE
715 * (e.g. if bit 0 is set then the event is enabled).
34f8f103
ZR
716 * +-------------+-+-+-+-+
717 * | Bits 31:4 |3|2|1|0|
718 * +-------------+-+-+-+-+
719 * | | | | |
720 * | | | | +- Enabled?
721 * | | | +--- Enabled for wake?
722 * | | +----- Set?
723 * | +------- Has a handler?
a08f813e 724 * +------------- <Reserved>
1da177e4 725 */
4be44fcd 726typedef u32 acpi_event_status;
1da177e4
LT
727
728#define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
729#define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
730#define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
731#define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
2f857234 732#define ACPI_EVENT_FLAG_HAS_HANDLER (acpi_event_status) 0x08
1da177e4 733
75c8044f 734/* Actions for acpi_set_gpe, acpi_gpe_wakeup, acpi_hw_low_set_gpe */
0f849d2c 735
1da177e4
LT
736#define ACPI_GPE_ENABLE 0
737#define ACPI_GPE_DISABLE 1
3a37898d 738#define ACPI_GPE_CONDITIONAL_ENABLE 2
c50f13c6
RW
739#define ACPI_GPE_SAVE_MASK 4
740
741#define ACPI_GPE_ENABLE_SAVE (ACPI_GPE_ENABLE | ACPI_GPE_SAVE_MASK)
742#define ACPI_GPE_DISABLE_SAVE (ACPI_GPE_DISABLE | ACPI_GPE_SAVE_MASK)
1da177e4 743
1da177e4
LT
744/*
745 * GPE info flags - Per GPE
bba63a29
LM
746 * +-------+-+-+---+
747 * | 7:4 |3|2|1:0|
748 * +-------+-+-+---+
749 * | | | |
750 * | | | +-- Type of dispatch:to method, handler, notify, or none
751 * | | +----- Interrupt type: edge or level triggered
752 * | +------- Is a Wake GPE
753 * +------------ <Reserved>
754 */
755#define ACPI_GPE_DISPATCH_NONE (u8) 0x00
756#define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
757#define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
758#define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
759#define ACPI_GPE_DISPATCH_MASK (u8) 0x03
7c43312a 760#define ACPI_GPE_DISPATCH_TYPE(flags) ((u8) ((flags) & ACPI_GPE_DISPATCH_MASK))
bba63a29
LM
761
762#define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x04
1da177e4 763#define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
bba63a29 764#define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x04
1da177e4 765
bba63a29 766#define ACPI_GPE_CAN_WAKE (u8) 0x08
1da177e4 767
1da177e4
LT
768/*
769 * Flags for GPE and Lock interfaces
770 */
1da177e4
LT
771#define ACPI_NOT_ISR 0x1
772#define ACPI_ISR 0x0
773
1da177e4
LT
774/* Notify types */
775
776#define ACPI_SYSTEM_NOTIFY 0x1
777#define ACPI_DEVICE_NOTIFY 0x2
514d18d7 778#define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
1da177e4 779#define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
86ed4bc8 780#define ACPI_NUM_NOTIFY_TYPES 2
1da177e4 781
ea143604
BM
782#define ACPI_MAX_SYS_NOTIFY 0x7F
783#define ACPI_MAX_DEVICE_SPECIFIC_NOTIFY 0xBF
1da177e4 784
86ed4bc8
BM
785#define ACPI_SYSTEM_HANDLER_LIST 0 /* Used as index, must be SYSTEM_NOTIFY -1 */
786#define ACPI_DEVICE_HANDLER_LIST 1 /* Used as index, must be DEVICE_NOTIFY -1 */
787
1da177e4
LT
788/* Address Space (Operation Region) Types */
789
4be44fcd 790typedef u8 acpi_adr_space_type;
1da177e4
LT
791
792#define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
793#define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
794#define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
795#define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
796#define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
797#define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
798#define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
6557a49a 799#define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
2da120b6
BM
800#define ACPI_ADR_SPACE_GPIO (acpi_adr_space_type) 8
801#define ACPI_ADR_SPACE_GSBUS (acpi_adr_space_type) 9
43e1c689 802#define ACPI_ADR_SPACE_PLATFORM_COMM (acpi_adr_space_type) 10
82a1b7cb 803
43e1c689 804#define ACPI_NUM_PREDEFINED_REGIONS 11
07aa99e9 805
82a1b7cb 806/*
07aa99e9 807 * Special Address Spaces
82a1b7cb
BM
808 *
809 * Note: A Data Table region is a special type of operation region
810 * that has its own AML opcode. However, internally, the AML
811 * interpreter simply creates an operation region with an an address
812 * space type of ACPI_ADR_SPACE_DATA_TABLE.
813 */
814#define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 0x7E /* Internal to ACPICA only */
815#define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 0x7F
1da177e4 816
e2066ca1
BM
817/* Values for _REG connection code */
818
819#define ACPI_REG_DISCONNECT 0
820#define ACPI_REG_CONNECT 1
821
1da177e4
LT
822/*
823 * bit_register IDs
bbbbeb8e
LM
824 *
825 * These values are intended to be used by the hardware interfaces
826 * and are mapped to individual bitfields defined within the ACPI
827 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
828 * for this mapping.
1da177e4 829 */
bbbbeb8e
LM
830
831/* PM1 Status register */
832
1da177e4
LT
833#define ACPI_BITREG_TIMER_STATUS 0x00
834#define ACPI_BITREG_BUS_MASTER_STATUS 0x01
835#define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
836#define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
837#define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
838#define ACPI_BITREG_RT_CLOCK_STATUS 0x05
839#define ACPI_BITREG_WAKE_STATUS 0x06
840#define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
841
bbbbeb8e
LM
842/* PM1 Enable register */
843
1da177e4
LT
844#define ACPI_BITREG_TIMER_ENABLE 0x08
845#define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
846#define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
847#define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
848#define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
bbbbeb8e
LM
849#define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
850
851/* PM1 Control register */
852
853#define ACPI_BITREG_SCI_ENABLE 0x0E
854#define ACPI_BITREG_BUS_MASTER_RLD 0x0F
855#define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
82d79b86
BM
856#define ACPI_BITREG_SLEEP_TYPE 0x11
857#define ACPI_BITREG_SLEEP_ENABLE 0x12
1da177e4 858
bbbbeb8e 859/* PM2 Control register */
1da177e4 860
82d79b86 861#define ACPI_BITREG_ARB_DISABLE 0x13
1da177e4 862
82d79b86 863#define ACPI_BITREG_MAX 0x13
1da177e4
LT
864#define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
865
768aaaf1
BM
866/* Status register values. A 1 clears a status bit. 0 = no effect */
867
868#define ACPI_CLEAR_STATUS 1
869
870/* Enable and Control register values */
871
872#define ACPI_ENABLE_EVENT 1
873#define ACPI_DISABLE_EVENT 0
874
72a8887a
BM
875/* Sleep function dispatch */
876
644ef74e 877typedef acpi_status(*acpi_sleep_function) (u8 sleep_state);
72a8887a
BM
878
879struct acpi_sleep_functions {
644ef74e
LZ
880 acpi_sleep_function legacy_function;
881 acpi_sleep_function extended_function;
72a8887a
BM
882};
883
1da177e4
LT
884/*
885 * External ACPI object definition
886 */
7a5bb996
LM
887
888/*
889 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
890 * or an unresolved named reference.
891 */
4be44fcd
LB
892union acpi_object {
893 acpi_object_type type; /* See definition of acpi_ns_type for values */
894 struct {
7a5bb996 895 acpi_object_type type; /* ACPI_TYPE_INTEGER */
5df7e6cb 896 u64 value; /* The actual number */
1da177e4
LT
897 } integer;
898
4be44fcd 899 struct {
7a5bb996 900 acpi_object_type type; /* ACPI_TYPE_STRING */
4be44fcd
LB
901 u32 length; /* # of bytes in string, excluding trailing null */
902 char *pointer; /* points to the string value */
1da177e4
LT
903 } string;
904
4be44fcd 905 struct {
7a5bb996 906 acpi_object_type type; /* ACPI_TYPE_BUFFER */
4be44fcd
LB
907 u32 length; /* # of bytes in buffer */
908 u8 *pointer; /* points to the buffer */
1da177e4
LT
909 } buffer;
910
4be44fcd 911 struct {
7a5bb996 912 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
4be44fcd
LB
913 u32 count; /* # of elements in package */
914 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
1da177e4
LT
915 } package;
916
4be44fcd 917 struct {
7a5bb996
LM
918 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
919 acpi_object_type actual_type; /* Type associated with the Handle */
920 acpi_handle handle; /* object reference */
921 } reference;
922
923 struct {
924 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
4be44fcd
LB
925 u32 proc_id;
926 acpi_io_address pblk_address;
927 u32 pblk_length;
1da177e4
LT
928 } processor;
929
4be44fcd 930 struct {
7a5bb996 931 acpi_object_type type; /* ACPI_TYPE_POWER */
4be44fcd
LB
932 u32 system_level;
933 u32 resource_order;
1da177e4
LT
934 } power_resource;
935};
936
1da177e4
LT
937/*
938 * List of objects, used as a parameter list for control method evaluation
939 */
4be44fcd
LB
940struct acpi_object_list {
941 u32 count;
942 union acpi_object *pointer;
1da177e4
LT
943};
944
1da177e4
LT
945/*
946 * Miscellaneous common Data Structures used by the interfaces
947 */
948#define ACPI_NO_BUFFER 0
d5caf1cd
LZ
949
950#ifdef ACPI_NO_MEM_ALLOCATIONS
951
952#define ACPI_ALLOCATE_BUFFER (acpi_size) (0)
953#define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (0)
954
955#else /* ACPI_NO_MEM_ALLOCATIONS */
956
bb3fec14
LZ
957#define ACPI_ALLOCATE_BUFFER (acpi_size) (-1) /* Let ACPICA allocate buffer */
958#define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2) /* For internal use only (enables tracking) */
1da177e4 959
d5caf1cd
LZ
960#endif /* ACPI_NO_MEM_ALLOCATIONS */
961
4be44fcd
LB
962struct acpi_buffer {
963 acpi_size length; /* Length in bytes of the buffer */
964 void *pointer; /* pointer to buffer */
1da177e4
LT
965};
966
1da177e4
LT
967/*
968 * name_type for acpi_get_name
969 */
970#define ACPI_FULL_PATHNAME 0
971#define ACPI_SINGLE_NAME 1
972#define ACPI_NAME_TYPE_MAX 1
973
50df4d8b
BM
974/*
975 * Predefined Namespace items
976 */
977struct acpi_predefined_names {
978 char *name;
979 u8 type;
980 char *val;
981};
982
1da177e4
LT
983/*
984 * Structure and flags for acpi_get_system_info
985 */
986#define ACPI_SYS_MODE_UNKNOWN 0x0000
987#define ACPI_SYS_MODE_ACPI 0x0001
988#define ACPI_SYS_MODE_LEGACY 0x0002
989#define ACPI_SYS_MODES_MASK 0x0003
990
1da177e4
LT
991/*
992 * System info returned by acpi_get_system_info()
993 */
4be44fcd
LB
994struct acpi_system_info {
995 u32 acpi_ca_version;
996 u32 flags;
997 u32 timer_resolution;
998 u32 reserved1;
999 u32 reserved2;
1000 u32 debug_level;
1001 u32 debug_layer;
1da177e4
LT
1002};
1003
9187a415
LZ
1004/*
1005 * System statistics returned by acpi_get_statistics()
1006 */
1007struct acpi_statistics {
1008 u32 sci_count;
1009 u32 gpe_count;
1010 u32 fixed_event_count[ACPI_NUM_FIXED_EVENTS];
1011 u32 method_count;
1012};
1013
3e08e2d2
LM
1014/* Table Event Types */
1015
1016#define ACPI_TABLE_EVENT_LOAD 0x0
1017#define ACPI_TABLE_EVENT_UNLOAD 0x1
1018#define ACPI_NUM_TABLE_EVENTS 2
1019
1da177e4
LT
1020/*
1021 * Types specific to the OS service interfaces
1022 */
1f86e8c1
LZ
1023typedef u32
1024 (ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
1da177e4
LT
1025
1026typedef void
4be44fcd 1027 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
1da177e4
LT
1028
1029/*
1030 * Various handlers and callback procedures
1031 */
a2fd4b4b 1032typedef
c53ae3a6 1033u32 (*acpi_sci_handler) (void *context);
a2fd4b4b 1034
a0fcdb23 1035typedef
644ef74e 1036void (*acpi_gbl_event_handler) (u32 event_type,
a0fcdb23
LM
1037 acpi_handle device,
1038 u32 event_number, void *context);
1039
1040#define ACPI_EVENT_TYPE_GPE 0
1041#define ACPI_EVENT_TYPE_FIXED 1
1042
1f86e8c1
LZ
1043typedef
1044u32(*acpi_event_handler) (void *context);
1da177e4 1045
8b6cd8ad
LM
1046typedef
1047u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
1048
1da177e4 1049typedef
4be44fcd 1050void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
1da177e4
LT
1051
1052typedef
8e4319c4 1053void (*acpi_object_handler) (acpi_handle object, void *data);
1da177e4 1054
4be44fcd 1055typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
1da177e4
LT
1056
1057#define ACPI_INIT_DEVICE_INI 1
1058
1059typedef
4be44fcd
LB
1060acpi_status(*acpi_exception_handler) (acpi_status aml_status,
1061 acpi_name name,
1062 u16 opcode,
1063 u32 aml_offset, void *context);
1da177e4 1064
6de4048a 1065/* Table Event handler (Load, load_table, etc.) and types */
3e08e2d2
LM
1066
1067typedef
b43e1065 1068acpi_status(*acpi_table_handler) (u32 event, void *table, void *context);
3e08e2d2 1069
739dcbb9
LZ
1070#define ACPI_TABLE_LOAD 0x0
1071#define ACPI_TABLE_UNLOAD 0x1
1072#define ACPI_NUM_TABLE_EVENTS 2
1073
1da177e4
LT
1074/* Address Spaces (For Operation Regions) */
1075
1076typedef
4be44fcd
LB
1077acpi_status(*acpi_adr_space_handler) (u32 function,
1078 acpi_physical_address address,
1079 u32 bit_width,
5df7e6cb 1080 u64 *value,
4be44fcd
LB
1081 void *handler_context,
1082 void *region_context);
1da177e4 1083
61686124 1084#define ACPI_DEFAULT_HANDLER NULL
1da177e4 1085
9ce81784
BM
1086/* Special Context data for generic_serial_bus/general_purpose_io (ACPI 5.0) */
1087
1088struct acpi_connection_info {
1089 u8 *connection;
1090 u16 length;
1091 u8 access_length;
1092};
1093
1da177e4 1094typedef
4be44fcd
LB
1095acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
1096 u32 function,
1097 void *handler_context,
1098 void **region_context);
1da177e4
LT
1099
1100#define ACPI_REGION_ACTIVATE 0
1101#define ACPI_REGION_DEACTIVATE 1
1102
1103typedef
b47cf58e 1104acpi_status(*acpi_walk_callback) (acpi_handle object,
4be44fcd
LB
1105 u32 nesting_level,
1106 void *context, void **return_value);
1da177e4 1107
b0ed7a91
LM
1108typedef
1109u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
1110
1da177e4
LT
1111/* Interrupt handler return values */
1112
1113#define ACPI_INTERRUPT_NOT_HANDLED 0x00
1114#define ACPI_INTERRUPT_HANDLED 0x01
1115
bba63a29
LM
1116/* GPE handler return values */
1117
1118#define ACPI_REENABLE_GPE 0x80
1119
15b8dd53
BM
1120/* Length of 32-bit EISAID values when converted back to a string */
1121
1122#define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
1123
1124/* Length of UUID (string) values */
50df4d8b 1125
50df4d8b
BM
1126#define ACPI_UUID_LENGTH 16
1127
413fc3f5 1128/* Structures used for device/processor HID, UID, CID, and SUB */
1da177e4 1129
78e25fef 1130struct acpi_pnp_device_id {
15b8dd53
BM
1131 u32 length; /* Length of string + null */
1132 char *string;
1da177e4
LT
1133};
1134
78e25fef 1135struct acpi_pnp_device_id_list {
15b8dd53
BM
1136 u32 count; /* Number of IDs in Ids array */
1137 u32 list_size; /* Size of list, including ID strings */
78e25fef 1138 struct acpi_pnp_device_id ids[1]; /* ID array */
1da177e4
LT
1139};
1140
15b8dd53
BM
1141/*
1142 * Structure returned from acpi_get_object_info.
1143 * Optimized for both 32- and 64-bit builds
1144 */
1145struct acpi_device_info {
1146 u32 info_size; /* Size of info, including ID strings */
1147 u32 name; /* ACPI object Name */
1148 acpi_object_type type; /* ACPI object Type */
1149 u8 param_count; /* If a method, required parameter count */
1150 u8 valid; /* Indicates which optional fields are valid */
1151 u8 flags; /* Miscellaneous info */
1152 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1153 u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
1154 u32 current_status; /* _STA value */
5df7e6cb 1155 u64 address; /* _ADR value */
78e25fef
LZ
1156 struct acpi_pnp_device_id hardware_id; /* _HID value */
1157 struct acpi_pnp_device_id unique_id; /* _UID value */
413fc3f5 1158 struct acpi_pnp_device_id subsystem_id; /* _SUB value */
78e25fef 1159 struct acpi_pnp_device_id_list compatible_id_list; /* _CID list <must be last> */
1da177e4
LT
1160};
1161
15b8dd53
BM
1162/* Values for Flags field above (acpi_get_object_info) */
1163
1164#define ACPI_PCI_ROOT_BRIDGE 0x01
1da177e4 1165
15b8dd53
BM
1166/* Flags for Valid field above (acpi_get_object_info) */
1167
1168#define ACPI_VALID_STA 0x01
1169#define ACPI_VALID_ADR 0x02
1170#define ACPI_VALID_HID 0x04
1171#define ACPI_VALID_UID 0x08
413fc3f5
BM
1172#define ACPI_VALID_SUB 0x10
1173#define ACPI_VALID_CID 0x20
1174#define ACPI_VALID_SXDS 0x40
1175#define ACPI_VALID_SXWS 0x80
1da177e4 1176
413fc3f5 1177/* Flags for _STA return value (current_status above) */
defba1d8
BM
1178
1179#define ACPI_STA_DEVICE_PRESENT 0x01
1180#define ACPI_STA_DEVICE_ENABLED 0x02
1181#define ACPI_STA_DEVICE_UI 0x04
b229cf92
BM
1182#define ACPI_STA_DEVICE_FUNCTIONING 0x08
1183#define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
defba1d8
BM
1184#define ACPI_STA_BATTERY_PRESENT 0x10
1185
1da177e4
LT
1186/* Context structs for address space handlers */
1187
4be44fcd
LB
1188struct acpi_pci_id {
1189 u16 segment;
1190 u16 bus;
1191 u16 device;
1192 u16 function;
1da177e4
LT
1193};
1194
4be44fcd
LB
1195struct acpi_mem_space_context {
1196 u32 length;
1197 acpi_physical_address address;
1198 acpi_physical_address mapped_physical_address;
1199 u8 *mapped_logical_address;
1200 acpi_size mapped_length;
1da177e4
LT
1201};
1202
1da177e4 1203/*
50df4d8b 1204 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1da177e4 1205 */
50df4d8b
BM
1206struct acpi_memory_list {
1207 char *list_name;
1208 void *list_head;
1209 u16 object_size;
1210 u16 max_depth;
1211 u16 current_depth;
50df4d8b
BM
1212
1213#ifdef ACPI_DBG_TRACK_ALLOCATIONS
1214
1215 /* Statistics for debug memory tracking only */
1216
1217 u32 total_allocated;
1218 u32 total_freed;
1219 u32 max_occupied;
1220 u32 total_size;
1221 u32 current_total_size;
1222 u32 requests;
1223 u32 hits;
0897831b 1224#endif
1da177e4
LT
1225};
1226
2641f540
LZ
1227/* Definitions of _OSI support */
1228
1229#define ACPI_VENDOR_STRINGS 0x01
1230#define ACPI_FEATURE_STRINGS 0x02
1231#define ACPI_ENABLE_INTERFACES 0x00
1232#define ACPI_DISABLE_INTERFACES 0x04
1233
1234#define ACPI_DISABLE_ALL_VENDOR_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1235#define ACPI_DISABLE_ALL_FEATURE_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1236#define ACPI_DISABLE_ALL_STRINGS (ACPI_DISABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
1237#define ACPI_ENABLE_ALL_VENDOR_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS)
1238#define ACPI_ENABLE_ALL_FEATURE_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_FEATURE_STRINGS)
1239#define ACPI_ENABLE_ALL_STRINGS (ACPI_ENABLE_INTERFACES | ACPI_VENDOR_STRINGS | ACPI_FEATURE_STRINGS)
242b2287
AL
1240
1241#define ACPI_OSI_WIN_2000 0x01
1242#define ACPI_OSI_WIN_XP 0x02
1243#define ACPI_OSI_WIN_XP_SP1 0x03
1244#define ACPI_OSI_WINSRV_2003 0x04
1245#define ACPI_OSI_WIN_XP_SP2 0x05
1246#define ACPI_OSI_WINSRV_2003_SP1 0x06
1247#define ACPI_OSI_WIN_VISTA 0x07
1248#define ACPI_OSI_WINSRV_2008 0x08
1249#define ACPI_OSI_WIN_VISTA_SP1 0x09
1250#define ACPI_OSI_WIN_VISTA_SP2 0x0A
1251#define ACPI_OSI_WIN_7 0x0B
1252#define ACPI_OSI_WIN_8 0x0C
1253
7824f44e
LZ
1254/* Definitions of file IO */
1255
1256#define ACPI_FILE_READING 0x01
1257#define ACPI_FILE_WRITING 0x02
1258#define ACPI_FILE_BINARY 0x04
1259
1260#define ACPI_FILE_BEGIN 0x01
1261#define ACPI_FILE_END 0x02
1262
a92e9577
LZ
1263/* Definitions of getopt */
1264
1265#define ACPI_OPT_END -1
1266
4be44fcd 1267#endif /* __ACTYPES_H__ */