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