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