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