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