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