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