projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Linux 2.6.39
[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/*
b4e104ea 8 * Copyright (C) 2000 - 2011, 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 *
defba1d8 176 * Note: Em64_t 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
50df4d8b
BM		 309/******************************************************************************
310 *
311 * ACPI Specification constants (Do not change unless the specification changes)
312 *
313 *****************************************************************************/
314
06f55419 315/* Number of distinct FADT-based GPE register blocks (GPE0 and GPE1) */
50df4d8b
BM		 316
317#define ACPI_MAX_GPE_BLOCKS 2
06f55419
BM		 318
319/* Default ACPI register widths */
320
50df4d8b 321#define ACPI_GPE_REGISTER_WIDTH 8
06f55419
BM		 322#define ACPI_PM1_REGISTER_WIDTH 16
323#define ACPI_PM2_REGISTER_WIDTH 8
324#define ACPI_PM_TIMER_WIDTH 32
50df4d8b
BM		 325
326/* Names within the namespace are 4 bytes long */
327
328#define ACPI_NAME_SIZE 4
329#define ACPI_PATH_SEGMENT_LENGTH 5 /* 4 chars for name + 1 char for separator */
330#define ACPI_PATH_SEPARATOR '.'
331
332/* Sizes for ACPI table headers */
333
334#define ACPI_OEM_ID_SIZE 6
335#define ACPI_OEM_TABLE_ID_SIZE 8
336
337/* ACPI/PNP hardware IDs */
338
339#define PCI_ROOT_HID_STRING "PNP0A03"
340#define PCI_EXPRESS_ROOT_HID_STRING "PNP0A08"
341
342/* PM Timer ticks per second (HZ) */
343
15b8dd53 344#define PM_TIMER_FREQUENCY 3579545
50df4d8b 345
defba1d8
BM		 346/*******************************************************************************
347 *
348 * Independent types
349 *
350 ******************************************************************************/
1da177e4 351
defba1d8 352/* Logical defines and NULL */
1da177e4 353
1da177e4
LT		 354#ifdef FALSE
355#undef FALSE
356#endif
357#define FALSE (1 == 0)
358
359#ifdef TRUE
360#undef TRUE
361#endif
362#define TRUE (1 == 1)
363
364#ifndef NULL
365#define NULL (void *) 0
366#endif
367
1da177e4 368/*
6de4048a 369 * Miscellaneous types
1da177e4 370 */
4be44fcd
LB		 371typedef u32 acpi_status; /* All ACPI Exceptions */
372typedef u32 acpi_name; /* 4-byte ACPI name */
373typedef char *acpi_string; /* Null terminated ASCII string */
defba1d8 374typedef void *acpi_handle; /* Actually a ptr to a NS Node */
4be44fcd 375
50df4d8b
BM		 376/* Owner IDs are used to track namespace nodes for selective deletion */
377
378typedef u8 acpi_owner_id;
379#define ACPI_OWNER_ID_MAX 0xFF
380
1da177e4 381#define ACPI_INTEGER_BIT_SIZE 64
4be44fcd 382#define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */
1da177e4
LT		 383
384#if ACPI_MACHINE_WIDTH == 64
4be44fcd 385#define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */
1da177e4 386#endif
1da177e4
LT		 387
388#define ACPI_MAX64_DECIMAL_DIGITS 20
389#define ACPI_MAX32_DECIMAL_DIGITS 10
390#define ACPI_MAX16_DECIMAL_DIGITS 5
391#define ACPI_MAX8_DECIMAL_DIGITS 3
392
50df4d8b
BM		 393/* PM Timer ticks per second (HZ) */
394
395#define PM_TIMER_FREQUENCY 3579545
396
1da177e4
LT		 397/*
398 * Constants with special meanings
399 */
c51a4de8 400#define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR)
50df4d8b
BM		 401#define ACPI_WAIT_FOREVER 0xFFFF /* u16, as per ACPI spec */
402#define ACPI_DO_NOT_WAIT 0
403
5df7e6cb
BM		 404/*
405 * Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
406 * In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
407 * pertains to the ACPI integer type only, not to other integers used in the
408 * implementation of the ACPICA subsystem.
409 *
410 * 01/2010: This type is obsolete and has been removed from the entire ACPICA
411 * code base. It remains here for compatibility with device drivers that use
412 * the type. However, it will be removed in the future.
413 */
414typedef u64 acpi_integer;
415#define ACPI_INTEGER_MAX ACPI_UINT64_MAX
416
50df4d8b
BM		 417/*******************************************************************************
418 *
419 * Commonly used macros
420 *
421 ******************************************************************************/
422
423/* Data manipulation */
424
35d7c1cf
BM		 425#define ACPI_LOBYTE(integer) ((u8) (u16)(integer))
426#define ACPI_HIBYTE(integer) ((u8) (((u16)(integer)) >> 8))
427#define ACPI_LOWORD(integer) ((u16) (u32)(integer))
428#define ACPI_HIWORD(integer) ((u16)(((u32)(integer)) >> 16))
429#define ACPI_LODWORD(integer64) ((u32) (u64)(integer64))
430#define ACPI_HIDWORD(integer64) ((u32)(((u64)(integer64)) >> 32))
50df4d8b
BM		 431
432#define ACPI_SET_BIT(target,bit) ((target) |= (bit))
433#define ACPI_CLEAR_BIT(target,bit) ((target) &= ~(bit))
434#define ACPI_MIN(a,b) (((a)<(b))?(a):(b))
435#define ACPI_MAX(a,b) (((a)>(b))?(a):(b))
436
437/* Size calculation */
438
439#define ACPI_ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
440
441/* Pointer manipulation */
442
443#define ACPI_CAST_PTR(t, p) ((t *) (acpi_uintptr_t) (p))
444#define ACPI_CAST_INDIRECT_PTR(t, p) ((t **) (acpi_uintptr_t) (p))
445#define ACPI_ADD_PTR(t, a, b) ACPI_CAST_PTR (t, (ACPI_CAST_PTR (u8, (a)) + (acpi_size)(b)))
446#define ACPI_PTR_DIFF(a, b) (acpi_size) (ACPI_CAST_PTR (u8, (a)) - ACPI_CAST_PTR (u8, (b)))
447
448/* Pointer/Integer type conversions */
449
450#define ACPI_TO_POINTER(i) ACPI_ADD_PTR (void, (void *) NULL,(acpi_size) i)
451#define ACPI_TO_INTEGER(p) ACPI_PTR_DIFF (p, (void *) NULL)
452#define ACPI_OFFSET(d, f) (acpi_size) ACPI_PTR_DIFF (&(((d *)0)->f), (void *) NULL)
453#define ACPI_PHYSADDR_TO_PTR(i) ACPI_TO_POINTER(i)
454#define ACPI_PTR_TO_PHYSADDR(i) ACPI_TO_INTEGER(i)
455
456#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
457#define ACPI_COMPARE_NAME(a,b) (*ACPI_CAST_PTR (u32, (a)) == *ACPI_CAST_PTR (u32, (b)))
458#else
459#define ACPI_COMPARE_NAME(a,b) (!ACPI_STRNCMP (ACPI_CAST_PTR (char, (a)), ACPI_CAST_PTR (char, (b)), ACPI_NAME_SIZE))
460#endif
461
462/*******************************************************************************
463 *
464 * Miscellaneous constants
465 *
466 ******************************************************************************/
1da177e4 467
1da177e4
LT		 468/*
469 * Initialization sequence
470 */
471#define ACPI_FULL_INITIALIZATION 0x00
472#define ACPI_NO_ADDRESS_SPACE_INIT 0x01
473#define ACPI_NO_HARDWARE_INIT 0x02
474#define ACPI_NO_EVENT_INIT 0x04
475#define ACPI_NO_HANDLER_INIT 0x08
476#define ACPI_NO_ACPI_ENABLE 0x10
477#define ACPI_NO_DEVICE_INIT 0x20
478#define ACPI_NO_OBJECT_INIT 0x40
479
480/*
481 * Initialization state
482 */
cb219bb6
BM		 483#define ACPI_SUBSYSTEM_INITIALIZE 0x01
484#define ACPI_INITIALIZED_OK 0x02
1da177e4
LT		 485
486/*
487 * Power state values
488 */
489#define ACPI_STATE_UNKNOWN (u8) 0xFF
490
491#define ACPI_STATE_S0 (u8) 0
492#define ACPI_STATE_S1 (u8) 1
493#define ACPI_STATE_S2 (u8) 2
494#define ACPI_STATE_S3 (u8) 3
495#define ACPI_STATE_S4 (u8) 4
496#define ACPI_STATE_S5 (u8) 5
497#define ACPI_S_STATES_MAX ACPI_STATE_S5
498#define ACPI_S_STATE_COUNT 6
499
500#define ACPI_STATE_D0 (u8) 0
501#define ACPI_STATE_D1 (u8) 1
502#define ACPI_STATE_D2 (u8) 2
503#define ACPI_STATE_D3 (u8) 3
504#define ACPI_D_STATES_MAX ACPI_STATE_D3
505#define ACPI_D_STATE_COUNT 4
506
507#define ACPI_STATE_C0 (u8) 0
508#define ACPI_STATE_C1 (u8) 1
509#define ACPI_STATE_C2 (u8) 2
510#define ACPI_STATE_C3 (u8) 3
511#define ACPI_C_STATES_MAX ACPI_STATE_C3
512#define ACPI_C_STATE_COUNT 4
513
514/*
515 * Sleep type invalid value
516 */
517#define ACPI_SLEEP_TYPE_MAX 0x7
518#define ACPI_SLEEP_TYPE_INVALID 0xFF
519
520/*
521 * Standard notify values
522 */
514d18d7
ZR		 523#define ACPI_NOTIFY_BUS_CHECK (u8) 0x00
524#define ACPI_NOTIFY_DEVICE_CHECK (u8) 0x01
525#define ACPI_NOTIFY_DEVICE_WAKE (u8) 0x02
526#define ACPI_NOTIFY_EJECT_REQUEST (u8) 0x03
527#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 0x04
528#define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 0x05
529#define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 0x06
530#define ACPI_NOTIFY_POWER_FAULT (u8) 0x07
531#define ACPI_NOTIFY_CAPABILITIES_CHECK (u8) 0x08
532#define ACPI_NOTIFY_DEVICE_PLD_CHECK (u8) 0x09
533#define ACPI_NOTIFY_RESERVED (u8) 0x0A
534#define ACPI_NOTIFY_LOCALITY_UPDATE (u8) 0x0B
535
536#define ACPI_NOTIFY_MAX 0x0B
1da177e4 537
1da177e4 538/*
6de4048a 539 * Types associated with ACPI names and objects. The first group of
1da177e4
LT		 540 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
541 * of the ACPI object_type() operator (See the ACPI Spec). Therefore,
542 * only add to the first group if the spec changes.
543 *
544 * NOTE: Types must be kept in sync with the global acpi_ns_properties
545 * and acpi_ns_type_names arrays.
546 */
4be44fcd 547typedef u32 acpi_object_type;
1da177e4
LT		 548
549#define ACPI_TYPE_ANY 0x00
4be44fcd 550#define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */
1da177e4
LT		 551#define ACPI_TYPE_STRING 0x02
552#define ACPI_TYPE_BUFFER 0x03
4be44fcd 553#define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */
1da177e4 554#define ACPI_TYPE_FIELD_UNIT 0x05
4be44fcd 555#define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */
1da177e4 556#define ACPI_TYPE_EVENT 0x07
4be44fcd 557#define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */
1da177e4
LT		 558#define ACPI_TYPE_MUTEX 0x09
559#define ACPI_TYPE_REGION 0x0A
4be44fcd
LB		 560#define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */
561#define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */
562#define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */
1da177e4
LT		 563#define ACPI_TYPE_BUFFER_FIELD 0x0E
564#define ACPI_TYPE_DDB_HANDLE 0x0F
565#define ACPI_TYPE_DEBUG_OBJECT 0x10
566
567#define ACPI_TYPE_EXTERNAL_MAX 0x10
568
569/*
570 * These are object types that do not map directly to the ACPI
571 * object_type() operator. They are used for various internal purposes only.
572 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
573 * internal types must move upwards. (There is code that depends on these
574 * values being contiguous with the external types above.)
575 */
576#define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
577#define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
578#define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13
4be44fcd 579#define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */
1da177e4
LT		 580#define ACPI_TYPE_LOCAL_ALIAS 0x15
581#define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16
582#define ACPI_TYPE_LOCAL_NOTIFY 0x17
583#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18
584#define ACPI_TYPE_LOCAL_RESOURCE 0x19
585#define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A
4be44fcd 586#define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */
1da177e4 587
4be44fcd 588#define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */
1da177e4
LT		 589
590/*
591 * These are special object types that never appear in
0211a9c8 592 * a Namespace node, only in a union acpi_operand_object
1da177e4
LT		 593 */
594#define ACPI_TYPE_LOCAL_EXTRA 0x1C
595#define ACPI_TYPE_LOCAL_DATA 0x1D
596
597#define ACPI_TYPE_LOCAL_MAX 0x1D
598
599/* All types above here are invalid */
600
601#define ACPI_TYPE_INVALID 0x1E
602#define ACPI_TYPE_NOT_FOUND 0xFF
603
b7f9f042
BM		 604#define ACPI_NUM_NS_TYPES (ACPI_TYPE_INVALID + 1)
605
1da177e4
LT		 606/*
607 * All I/O
608 */
609#define ACPI_READ 0
610#define ACPI_WRITE 1
611#define ACPI_IO_MASK 1
612
613/*
614 * Event Types: Fixed & General Purpose
615 */
4be44fcd 616typedef u32 acpi_event_type;
1da177e4
LT		 617
618/*
619 * Fixed events
620 */
621#define ACPI_EVENT_PMTIMER 0
622#define ACPI_EVENT_GLOBAL 1
623#define ACPI_EVENT_POWER_BUTTON 2
624#define ACPI_EVENT_SLEEP_BUTTON 3
625#define ACPI_EVENT_RTC 4
626#define ACPI_EVENT_MAX 4
627#define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1
628
629/*
630 * Event Status - Per event
631 * -------------
632 * The encoding of acpi_event_status is illustrated below.
633 * Note that a set bit (1) indicates the property is TRUE
634 * (e.g. if bit 0 is set then the event is enabled).
635 * +-------------+-+-+-+
636 * | Bits 31:3 |2|1|0|
637 * +-------------+-+-+-+
638 * | | | |
639 * | | | +- Enabled?
640 * | | +--- Enabled for wake?
641 * | +----- Set?
642 * +----------- <Reserved>
643 */
4be44fcd 644typedef u32 acpi_event_status;
1da177e4
LT		 645
646#define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00
647#define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01
648#define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02
649#define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04
ed206fac 650#define ACPI_EVENT_FLAG_HANDLE (acpi_event_status) 0x08
1da177e4
LT		 651
652/*
653 * General Purpose Events (GPE)
654 */
655#define ACPI_GPE_INVALID 0xFF
656#define ACPI_GPE_MAX 0xFF
657#define ACPI_NUM_GPE 256
658
3a37898d 659/* Actions for acpi_set_gpe_wake_mask, acpi_hw_low_set_gpe */
0f849d2c 660
1da177e4
LT		 661#define ACPI_GPE_ENABLE 0
662#define ACPI_GPE_DISABLE 1
3a37898d 663#define ACPI_GPE_CONDITIONAL_ENABLE 2
1da177e4 664
1da177e4
LT		 665/*
666 * GPE info flags - Per GPE
bba63a29
LM		 667 * +-------+-+-+---+
668 * | 7:4 |3|2|1:0|
669 * +-------+-+-+---+
670 * | | | |
671 * | | | +-- Type of dispatch:to method, handler, notify, or none
672 * | | +----- Interrupt type: edge or level triggered
673 * | +------- Is a Wake GPE
674 * +------------ <Reserved>
675 */
676#define ACPI_GPE_DISPATCH_NONE (u8) 0x00
677#define ACPI_GPE_DISPATCH_METHOD (u8) 0x01
678#define ACPI_GPE_DISPATCH_HANDLER (u8) 0x02
679#define ACPI_GPE_DISPATCH_NOTIFY (u8) 0x03
680#define ACPI_GPE_DISPATCH_MASK (u8) 0x03
681
682#define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x04
1da177e4 683#define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00
bba63a29 684#define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x04
1da177e4 685
bba63a29 686#define ACPI_GPE_CAN_WAKE (u8) 0x08
1da177e4 687
1da177e4
LT		 688/*
689 * Flags for GPE and Lock interfaces
690 */
1da177e4
LT		 691#define ACPI_NOT_ISR 0x1
692#define ACPI_ISR 0x0
693
1da177e4
LT		 694/* Notify types */
695
696#define ACPI_SYSTEM_NOTIFY 0x1
697#define ACPI_DEVICE_NOTIFY 0x2
514d18d7 698#define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY)
1da177e4
LT		 699#define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3
700
701#define ACPI_MAX_SYS_NOTIFY 0x7f
702
1da177e4
LT		 703/* Address Space (Operation Region) Types */
704
4be44fcd 705typedef u8 acpi_adr_space_type;
1da177e4
LT		 706
707#define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0
708#define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1
709#define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2
710#define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3
711#define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4
712#define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5
713#define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6
6557a49a
LM		 714#define ACPI_ADR_SPACE_IPMI (acpi_adr_space_type) 7
715#define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 8
1da177e4
LT		 716#define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127
717
1da177e4
LT		 718/*
719 * bit_register IDs
bbbbeb8e
LM		 720 *
721 * These values are intended to be used by the hardware interfaces
722 * and are mapped to individual bitfields defined within the ACPI
723 * registers. See the acpi_gbl_bit_register_info global table in utglobal.c
724 * for this mapping.
1da177e4 725 */
bbbbeb8e
LM		 726
727/* PM1 Status register */
728
1da177e4
LT		 729#define ACPI_BITREG_TIMER_STATUS 0x00
730#define ACPI_BITREG_BUS_MASTER_STATUS 0x01
731#define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02
732#define ACPI_BITREG_POWER_BUTTON_STATUS 0x03
733#define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04
734#define ACPI_BITREG_RT_CLOCK_STATUS 0x05
735#define ACPI_BITREG_WAKE_STATUS 0x06
736#define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07
737
bbbbeb8e
LM		 738/* PM1 Enable register */
739
1da177e4
LT		 740#define ACPI_BITREG_TIMER_ENABLE 0x08
741#define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09
742#define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A
743#define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B
744#define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C
bbbbeb8e
LM		 745#define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0D
746
747/* PM1 Control register */
748
749#define ACPI_BITREG_SCI_ENABLE 0x0E
750#define ACPI_BITREG_BUS_MASTER_RLD 0x0F
751#define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x10
82d79b86
BM		 752#define ACPI_BITREG_SLEEP_TYPE 0x11
753#define ACPI_BITREG_SLEEP_ENABLE 0x12
1da177e4 754
bbbbeb8e 755/* PM2 Control register */
1da177e4 756
82d79b86 757#define ACPI_BITREG_ARB_DISABLE 0x13
1da177e4 758
82d79b86 759#define ACPI_BITREG_MAX 0x13
1da177e4
LT		 760#define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1
761
768aaaf1
BM		 762/* Status register values. A 1 clears a status bit. 0 = no effect */
763
764#define ACPI_CLEAR_STATUS 1
765
766/* Enable and Control register values */
767
768#define ACPI_ENABLE_EVENT 1
769#define ACPI_DISABLE_EVENT 0
770
1da177e4
LT		 771/*
772 * External ACPI object definition
773 */
7a5bb996
LM		 774
775/*
776 * Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
777 * or an unresolved named reference.
778 */
4be44fcd
LB		 779union acpi_object {
780 acpi_object_type type; /* See definition of acpi_ns_type for values */
781 struct {
7a5bb996 782 acpi_object_type type; /* ACPI_TYPE_INTEGER */
5df7e6cb 783 u64 value; /* The actual number */
1da177e4
LT		 784 } integer;
785
4be44fcd 786 struct {
7a5bb996 787 acpi_object_type type; /* ACPI_TYPE_STRING */
4be44fcd
LB		 788 u32 length; /* # of bytes in string, excluding trailing null */
789 char *pointer; /* points to the string value */
1da177e4
LT		 790 } string;
791
4be44fcd 792 struct {
7a5bb996 793 acpi_object_type type; /* ACPI_TYPE_BUFFER */
4be44fcd
LB		 794 u32 length; /* # of bytes in buffer */
795 u8 *pointer; /* points to the buffer */
1da177e4
LT		 796 } buffer;
797
4be44fcd 798 struct {
7a5bb996 799 acpi_object_type type; /* ACPI_TYPE_PACKAGE */
4be44fcd
LB		 800 u32 count; /* # of elements in package */
801 union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */
1da177e4
LT		 802 } package;
803
4be44fcd 804 struct {
7a5bb996
LM		 805 acpi_object_type type; /* ACPI_TYPE_LOCAL_REFERENCE */
806 acpi_object_type actual_type; /* Type associated with the Handle */
807 acpi_handle handle; /* object reference */
808 } reference;
809
810 struct {
811 acpi_object_type type; /* ACPI_TYPE_PROCESSOR */
4be44fcd
LB		 812 u32 proc_id;
813 acpi_io_address pblk_address;
814 u32 pblk_length;
1da177e4
LT		 815 } processor;
816
4be44fcd 817 struct {
7a5bb996 818 acpi_object_type type; /* ACPI_TYPE_POWER */
4be44fcd
LB		 819 u32 system_level;
820 u32 resource_order;
1da177e4
LT		 821 } power_resource;
822};
823
1da177e4
LT		 824/*
825 * List of objects, used as a parameter list for control method evaluation
826 */
4be44fcd
LB		 827struct acpi_object_list {
828 u32 count;
829 union acpi_object *pointer;
1da177e4
LT		 830};
831
1da177e4
LT		 832/*
833 * Miscellaneous common Data Structures used by the interfaces
834 */
835#define ACPI_NO_BUFFER 0
836#define ACPI_ALLOCATE_BUFFER (acpi_size) (-1)
837#define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2)
838
4be44fcd
LB		 839struct acpi_buffer {
840 acpi_size length; /* Length in bytes of the buffer */
841 void *pointer; /* pointer to buffer */
1da177e4
LT		 842};
843
1da177e4
LT		 844/*
845 * name_type for acpi_get_name
846 */
847#define ACPI_FULL_PATHNAME 0
848#define ACPI_SINGLE_NAME 1
849#define ACPI_NAME_TYPE_MAX 1
850
50df4d8b
BM		 851/*
852 * Predefined Namespace items
853 */
854struct acpi_predefined_names {
855 char *name;
856 u8 type;
857 char *val;
858};
859
1da177e4
LT		 860/*
861 * Structure and flags for acpi_get_system_info
862 */
863#define ACPI_SYS_MODE_UNKNOWN 0x0000
864#define ACPI_SYS_MODE_ACPI 0x0001
865#define ACPI_SYS_MODE_LEGACY 0x0002
866#define ACPI_SYS_MODES_MASK 0x0003
867
1da177e4
LT		 868/*
869 * System info returned by acpi_get_system_info()
870 */
4be44fcd
LB		 871struct acpi_system_info {
872 u32 acpi_ca_version;
873 u32 flags;
874 u32 timer_resolution;
875 u32 reserved1;
876 u32 reserved2;
877 u32 debug_level;
878 u32 debug_layer;
1da177e4
LT		 879};
880
3e08e2d2
LM		 881/* Table Event Types */
882
883#define ACPI_TABLE_EVENT_LOAD 0x0
884#define ACPI_TABLE_EVENT_UNLOAD 0x1
885#define ACPI_NUM_TABLE_EVENTS 2
886
1da177e4
LT		 887/*
888 * Types specific to the OS service interfaces
889 */
4be44fcd 890typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context);
1da177e4
LT		 891
892typedef void
4be44fcd 893 (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context);
1da177e4
LT		 894
895/*
896 * Various handlers and callback procedures
897 */
a0fcdb23
LM		 898typedef
899void (*ACPI_GBL_EVENT_HANDLER) (u32 event_type,
900 acpi_handle device,
901 u32 event_number, void *context);
902
903#define ACPI_EVENT_TYPE_GPE 0
904#define ACPI_EVENT_TYPE_FIXED 1
905
4be44fcd 906typedef u32(*acpi_event_handler) (void *context);
1da177e4 907
8b6cd8ad
LM		 908typedef
909u32 (*acpi_gpe_handler) (acpi_handle gpe_device, u32 gpe_number, void *context);
910
1da177e4 911typedef
4be44fcd 912void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context);
1da177e4
LT		 913
914typedef
8e4319c4 915void (*acpi_object_handler) (acpi_handle object, void *data);
1da177e4 916
4be44fcd 917typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function);
1da177e4
LT		 918
919#define ACPI_INIT_DEVICE_INI 1
920
921typedef
4be44fcd
LB		 922acpi_status(*acpi_exception_handler) (acpi_status aml_status,
923 acpi_name name,
924 u16 opcode,
925 u32 aml_offset, void *context);
1da177e4 926
6de4048a 927/* Table Event handler (Load, load_table, etc.) and types */
3e08e2d2
LM		 928
929typedef
930acpi_status(*acpi_tbl_handler) (u32 event, void *table, void *context);
931
1da177e4
LT		 932/* Address Spaces (For Operation Regions) */
933
934typedef
4be44fcd
LB		 935acpi_status(*acpi_adr_space_handler) (u32 function,
936 acpi_physical_address address,
937 u32 bit_width,
5df7e6cb 938 u64 *value,
4be44fcd
LB		 939 void *handler_context,
940 void *region_context);
1da177e4 941
61686124 942#define ACPI_DEFAULT_HANDLER NULL
1da177e4 943
1da177e4 944typedef
4be44fcd
LB		 945acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle,
946 u32 function,
947 void *handler_context,
948 void **region_context);
1da177e4
LT		 949
950#define ACPI_REGION_ACTIVATE 0
951#define ACPI_REGION_DEACTIVATE 1
952
953typedef
b47cf58e 954acpi_status(*acpi_walk_callback) (acpi_handle object,
4be44fcd
LB		 955 u32 nesting_level,
956 void *context, void **return_value);
1da177e4 957
b0ed7a91
LM		 958typedef
959u32 (*acpi_interface_handler) (acpi_string interface_name, u32 supported);
960
1da177e4
LT		 961/* Interrupt handler return values */
962
963#define ACPI_INTERRUPT_NOT_HANDLED 0x00
964#define ACPI_INTERRUPT_HANDLED 0x01
965
bba63a29
LM		 966/* GPE handler return values */
967
968#define ACPI_REENABLE_GPE 0x80
969
15b8dd53
BM		 970/* Length of 32-bit EISAID values when converted back to a string */
971
972#define ACPI_EISAID_STRING_SIZE 8 /* Includes null terminator */
973
974/* Length of UUID (string) values */
50df4d8b 975
50df4d8b
BM		 976#define ACPI_UUID_LENGTH 16
977
15b8dd53 978/* Structures used for device/processor HID, UID, CID */
1da177e4 979
8c8eb78f 980struct acpica_device_id {
15b8dd53
BM		 981 u32 length; /* Length of string + null */
982 char *string;
1da177e4
LT		 983};
984
15b8dd53
BM		 985struct acpica_device_id_list {
986 u32 count; /* Number of IDs in Ids array */
987 u32 list_size; /* Size of list, including ID strings */
988 struct acpica_device_id ids[1]; /* ID array */
1da177e4
LT		 989};
990
15b8dd53
BM		 991/*
992 * Structure returned from acpi_get_object_info.
993 * Optimized for both 32- and 64-bit builds
994 */
995struct acpi_device_info {
996 u32 info_size; /* Size of info, including ID strings */
997 u32 name; /* ACPI object Name */
998 acpi_object_type type; /* ACPI object Type */
999 u8 param_count; /* If a method, required parameter count */
1000 u8 valid; /* Indicates which optional fields are valid */
1001 u8 flags; /* Miscellaneous info */
1002 u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */
1003 u8 lowest_dstates[5]; /* _sx_w values: 0xFF indicates not valid */
1004 u32 current_status; /* _STA value */
5df7e6cb 1005 u64 address; /* _ADR value */
15b8dd53
BM		 1006 struct acpica_device_id hardware_id; /* _HID value */
1007 struct acpica_device_id unique_id; /* _UID value */
1008 struct acpica_device_id_list compatible_id_list; /* _CID list <must be last> */
1da177e4
LT		 1009};
1010
15b8dd53
BM		 1011/* Values for Flags field above (acpi_get_object_info) */
1012
1013#define ACPI_PCI_ROOT_BRIDGE 0x01
1da177e4 1014
15b8dd53
BM		 1015/* Flags for Valid field above (acpi_get_object_info) */
1016
1017#define ACPI_VALID_STA 0x01
1018#define ACPI_VALID_ADR 0x02
1019#define ACPI_VALID_HID 0x04
1020#define ACPI_VALID_UID 0x08
1021#define ACPI_VALID_CID 0x10
1022#define ACPI_VALID_SXDS 0x20
1023#define ACPI_VALID_SXWS 0x40
1da177e4 1024
defba1d8
BM		 1025/* Flags for _STA method */
1026
1027#define ACPI_STA_DEVICE_PRESENT 0x01
1028#define ACPI_STA_DEVICE_ENABLED 0x02
1029#define ACPI_STA_DEVICE_UI 0x04
b229cf92
BM		 1030#define ACPI_STA_DEVICE_FUNCTIONING 0x08
1031#define ACPI_STA_DEVICE_OK 0x08 /* Synonym */
defba1d8
BM		 1032#define ACPI_STA_BATTERY_PRESENT 0x10
1033
1da177e4
LT		 1034/* Context structs for address space handlers */
1035
4be44fcd
LB		 1036struct acpi_pci_id {
1037 u16 segment;
1038 u16 bus;
1039 u16 device;
1040 u16 function;
1da177e4
LT		 1041};
1042
4be44fcd
LB		 1043struct acpi_mem_space_context {
1044 u32 length;
1045 acpi_physical_address address;
1046 acpi_physical_address mapped_physical_address;
1047 u8 *mapped_logical_address;
1048 acpi_size mapped_length;
1da177e4
LT		 1049};
1050
1da177e4 1051/*
50df4d8b 1052 * struct acpi_memory_list is used only if the ACPICA local cache is enabled
1da177e4 1053 */
50df4d8b
BM		 1054struct acpi_memory_list {
1055 char *list_name;
1056 void *list_head;
1057 u16 object_size;
1058 u16 max_depth;
1059 u16 current_depth;
1060 u16 link_offset;
1061
1062#ifdef ACPI_DBG_TRACK_ALLOCATIONS
1063
1064 /* Statistics for debug memory tracking only */
1065
1066 u32 total_allocated;
1067 u32 total_freed;
1068 u32 max_occupied;
1069 u32 total_size;
1070 u32 current_total_size;
1071 u32 requests;
1072 u32 hits;
0897831b 1073#endif
1da177e4
LT		 1074};
1075
4be44fcd 1076#endif /* __ACTYPES_H__ */
Linux 6.x block layer and io_uring tree(s)