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