Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: actypes.h - Common data types for the entire ACPI subsystem | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
4a90c7e8 | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
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 | |
51 | * and must be either 16, 32, or 64 | |
52 | */ | |
53 | #ifndef ACPI_MACHINE_WIDTH | |
54 | #error ACPI_MACHINE_WIDTH not defined | |
55 | #endif | |
56 | ||
57 | /*! [Begin] no source code translation */ | |
1da177e4 | 58 | |
1da177e4 LT |
59 | /* |
60 | * Data type ranges | |
61 | * Note: These macros are designed to be compiler independent as well as | |
62 | * working around problems that some 32-bit compilers have with 64-bit | |
63 | * constants. | |
64 | */ | |
4be44fcd LB |
65 | #define ACPI_UINT8_MAX (UINT8) (~((UINT8) 0)) /* 0xFF */ |
66 | #define ACPI_UINT16_MAX (UINT16)(~((UINT16) 0)) /* 0xFFFF */ | |
67 | #define ACPI_UINT32_MAX (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF */ | |
68 | #define ACPI_UINT64_MAX (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */ | |
1da177e4 LT |
69 | #define ACPI_ASCII_MAX 0x7F |
70 | ||
1da177e4 | 71 | /* |
defba1d8 BM |
72 | * Architecture-specific ACPICA Subsystem Data Types |
73 | * | |
74 | * The goal of these types is to provide source code portability across | |
75 | * 16-bit, 32-bit, and 64-bit targets. | |
76 | * | |
77 | * 1) The following types are of fixed size for all targets (16/32/64): | |
78 | * | |
79 | * BOOLEAN Logical boolean | |
80 | * | |
81 | * UINT8 8-bit (1 byte) unsigned value | |
82 | * UINT16 16-bit (2 byte) unsigned value | |
83 | * UINT32 32-bit (4 byte) unsigned value | |
84 | * UINT64 64-bit (8 byte) unsigned value | |
85 | * | |
86 | * INT16 16-bit (2 byte) signed value | |
87 | * INT32 32-bit (4 byte) signed value | |
88 | * INT64 64-bit (8 byte) signed value | |
89 | * | |
90 | * COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the | |
91 | * compiler-dependent header(s) and were introduced because there is no common | |
92 | * 64-bit integer type across the various compilation models, as shown in | |
93 | * the table below. | |
94 | * | |
95 | * Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit | |
96 | * char 8 8 8 8 8 8 | |
97 | * short 16 16 16 16 16 16 | |
98 | * _int32 32 | |
99 | * int 32 64 32 32 16 16 | |
100 | * long 64 64 32 32 32 32 | |
101 | * long long 64 64 | |
102 | * pointer 64 64 64 32 32 32 | |
103 | * | |
104 | * Note: ILP64 and LP32 are currently not supported. | |
105 | * | |
106 | * | |
107 | * 2) These types represent the native word size of the target mode of the | |
108 | * processor, and may be 16-bit, 32-bit, or 64-bit as required. They are | |
109 | * usually used for memory allocation, efficient loop counters, and array | |
110 | * indexes. The types are similar to the size_t type in the C library and are | |
111 | * required because there is no C type that consistently represents the native | |
112 | * data width. | |
113 | * | |
114 | * ACPI_SIZE 16/32/64-bit unsigned value | |
115 | * ACPI_NATIVE_UINT 16/32/64-bit unsigned value | |
116 | * ACPI_NATIVE_INT 16/32/64-bit signed value | |
117 | * | |
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 | |
defba1d8 BM |
134 | /******************************************************************************* |
135 | * | |
136 | * Types specific to 64-bit targets | |
137 | * | |
138 | ******************************************************************************/ | |
1da177e4 LT |
139 | |
140 | #if ACPI_MACHINE_WIDTH == 64 | |
141 | ||
defba1d8 | 142 | /*! [Begin] no source code translation (keep the typedefs as-is) */ |
1da177e4 | 143 | |
4be44fcd | 144 | typedef unsigned int UINT32; |
defba1d8 | 145 | typedef int INT32; |
1da177e4 LT |
146 | |
147 | /*! [End] no source code translation !*/ | |
148 | ||
defba1d8 BM |
149 | typedef u64 acpi_native_uint; |
150 | typedef s64 acpi_native_int; | |
151 | ||
4be44fcd LB |
152 | typedef u64 acpi_table_ptr; |
153 | typedef u64 acpi_io_address; | |
154 | typedef u64 acpi_physical_address; | |
1da177e4 | 155 | |
1da177e4 LT |
156 | #define ACPI_MAX_PTR ACPI_UINT64_MAX |
157 | #define ACPI_SIZE_MAX ACPI_UINT64_MAX | |
158 | ||
7c9626ba | 159 | #define ACPI_NATIVE_BOUNDARY 8 |
defba1d8 BM |
160 | #define ACPI_USE_NATIVE_DIVIDE /* Has native 64-bit integer support */ |
161 | ||
0897831b BM |
162 | /* |
163 | * In the case of the Itanium Processor Family (IPF), the hardware does not | |
164 | * support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag | |
165 | * to indicate that special precautions must be taken to avoid alignment faults. | |
166 | * (IA64 or ia64 is currently used by existing compilers to indicate IPF.) | |
167 | * | |
defba1d8 | 168 | * Note: Em64_t and other X86-64 processors support misaligned transfers, |
0897831b BM |
169 | * so there is no need to define this flag. |
170 | */ | |
171 | #if defined (__IA64__) || defined (__ia64__) | |
172 | #define ACPI_MISALIGNMENT_NOT_SUPPORTED | |
173 | #endif | |
174 | ||
defba1d8 BM |
175 | /******************************************************************************* |
176 | * | |
177 | * Types specific to 32-bit targets | |
178 | * | |
179 | ******************************************************************************/ | |
180 | ||
181 | #elif ACPI_MACHINE_WIDTH == 32 | |
182 | ||
183 | /*! [Begin] no source code translation (keep the typedefs as-is) */ | |
184 | ||
185 | typedef unsigned int UINT32; | |
186 | typedef int INT32; | |
187 | ||
188 | /*! [End] no source code translation !*/ | |
189 | ||
190 | typedef u32 acpi_native_uint; | |
191 | typedef s32 acpi_native_int; | |
192 | ||
193 | typedef u64 acpi_table_ptr; | |
194 | typedef u32 acpi_io_address; | |
f3d2e786 | 195 | typedef u32 acpi_physical_address; |
defba1d8 BM |
196 | |
197 | #define ACPI_MAX_PTR ACPI_UINT32_MAX | |
198 | #define ACPI_SIZE_MAX ACPI_UINT32_MAX | |
199 | ||
7c9626ba BM |
200 | #define ACPI_NATIVE_BOUNDARY 4 |
201 | ||
defba1d8 BM |
202 | /******************************************************************************* |
203 | * | |
204 | * Types specific to 16-bit targets | |
205 | * | |
206 | ******************************************************************************/ | |
207 | ||
1da177e4 LT |
208 | #elif ACPI_MACHINE_WIDTH == 16 |
209 | ||
0897831b | 210 | /*! [Begin] no source code translation (keep the typedefs as-is) */ |
1da177e4 | 211 | |
4be44fcd | 212 | typedef unsigned long UINT32; |
defba1d8 BM |
213 | typedef short INT16; |
214 | typedef long INT32; | |
1da177e4 LT |
215 | |
216 | /*! [End] no source code translation !*/ | |
217 | ||
defba1d8 BM |
218 | typedef u16 acpi_native_uint; |
219 | typedef s16 acpi_native_int; | |
220 | ||
4be44fcd LB |
221 | typedef u32 acpi_table_ptr; |
222 | typedef u32 acpi_io_address; | |
223 | typedef char *acpi_physical_address; | |
1da177e4 | 224 | |
1da177e4 LT |
225 | #define ACPI_MAX_PTR ACPI_UINT16_MAX |
226 | #define ACPI_SIZE_MAX ACPI_UINT16_MAX | |
227 | ||
7c9626ba | 228 | #define ACPI_NATIVE_BOUNDARY 2 |
defba1d8 | 229 | #define ACPI_USE_NATIVE_DIVIDE /* No 64-bit integers, ok to use native divide */ |
1da177e4 | 230 | |
defba1d8 | 231 | /* 64-bit integers cannot be supported */ |
1da177e4 | 232 | |
defba1d8 | 233 | #define ACPI_NO_INTEGER64_SUPPORT |
1da177e4 | 234 | |
defba1d8 | 235 | #else |
1da177e4 | 236 | |
defba1d8 | 237 | /* ACPI_MACHINE_WIDTH must be either 64, 32, or 16 */ |
1da177e4 | 238 | |
defba1d8 BM |
239 | #error unknown ACPI_MACHINE_WIDTH |
240 | #endif | |
1da177e4 | 241 | |
b8e4d893 BM |
242 | /* Variable-width type, used instead of clib size_t */ |
243 | ||
244 | typedef acpi_native_uint acpi_size; | |
245 | ||
defba1d8 BM |
246 | /******************************************************************************* |
247 | * | |
967440e3 | 248 | * OS-dependent and compiler-dependent types |
defba1d8 | 249 | * |
b8e4d893 BM |
250 | * If the defaults below are not appropriate for the host system, they can |
251 | * be defined in the compiler-specific or OS-specific header, and this will | |
252 | * take precedence. | |
253 | * | |
defba1d8 | 254 | ******************************************************************************/ |
1da177e4 | 255 | |
967440e3 | 256 | /* Value returned by acpi_os_get_thread_id */ |
b8e4d893 | 257 | |
967440e3 BM |
258 | #ifndef acpi_thread_id |
259 | #define acpi_thread_id acpi_native_uint | |
1da177e4 LT |
260 | #endif |
261 | ||
967440e3 BM |
262 | /* Object returned from acpi_os_create_lock */ |
263 | ||
264 | #ifndef acpi_spinlock | |
265 | #define acpi_spinlock void * | |
defba1d8 BM |
266 | #endif |
267 | ||
967440e3 BM |
268 | /* Flags for acpi_os_acquire_lock/acpi_os_release_lock */ |
269 | ||
b8e4d893 | 270 | #ifndef acpi_cpu_flags |
61686124 | 271 | #define acpi_cpu_flags acpi_native_uint |
b8e4d893 | 272 | #endif |
defba1d8 | 273 | |
967440e3 BM |
274 | /* Object returned from acpi_os_create_cache */ |
275 | ||
276 | #ifndef acpi_cache_t | |
277 | #define acpi_cache_t struct acpi_memory_list | |
278 | #endif | |
279 | ||
280 | /* Use C99 uintptr_t for pointer casting if available, "void *" otherwise */ | |
281 | ||
282 | #ifndef acpi_uintptr_t | |
283 | #define acpi_uintptr_t void * | |
284 | #endif | |
285 | ||
b8e4d893 BM |
286 | /* |
287 | * ACPI_PRINTF_LIKE is used to tag functions as "printf-like" because | |
288 | * some compilers can catch printf format string problems | |
289 | */ | |
290 | #ifndef ACPI_PRINTF_LIKE | |
291 | #define ACPI_PRINTF_LIKE(c) | |
292 | #endif | |
293 | ||
294 | /* | |
295 | * Some compilers complain about unused variables. Sometimes we don't want to | |
296 | * use all the variables (for example, _acpi_module_name). This allows us | |
297 | * to to tell the compiler in a per-variable manner that a variable | |
298 | * is unused | |
299 | */ | |
300 | #ifndef ACPI_UNUSED_VAR | |
301 | #define ACPI_UNUSED_VAR | |
302 | #endif | |
defba1d8 | 303 | |
8313524a BM |
304 | /* |
305 | * All ACPICA functions that are available to the rest of the kernel are | |
306 | * tagged with this macro which can be defined as appropriate for the host. | |
307 | */ | |
308 | #ifndef ACPI_EXPORT_SYMBOL | |
309 | #define ACPI_EXPORT_SYMBOL(symbol) | |
310 | #endif | |
311 | ||
defba1d8 BM |
312 | /******************************************************************************* |
313 | * | |
314 | * Independent types | |
315 | * | |
316 | ******************************************************************************/ | |
1da177e4 | 317 | |
defba1d8 | 318 | /* Logical defines and NULL */ |
1da177e4 | 319 | |
1da177e4 LT |
320 | #ifdef FALSE |
321 | #undef FALSE | |
322 | #endif | |
323 | #define FALSE (1 == 0) | |
324 | ||
325 | #ifdef TRUE | |
326 | #undef TRUE | |
327 | #endif | |
328 | #define TRUE (1 == 1) | |
329 | ||
330 | #ifndef NULL | |
331 | #define NULL (void *) 0 | |
332 | #endif | |
333 | ||
1da177e4 | 334 | /* |
defba1d8 | 335 | * Mescellaneous types |
1da177e4 | 336 | */ |
4be44fcd LB |
337 | typedef u32 acpi_status; /* All ACPI Exceptions */ |
338 | typedef u32 acpi_name; /* 4-byte ACPI name */ | |
339 | typedef char *acpi_string; /* Null terminated ASCII string */ | |
defba1d8 | 340 | typedef void *acpi_handle; /* Actually a ptr to a NS Node */ |
4be44fcd LB |
341 | |
342 | struct uint64_struct { | |
343 | u32 lo; | |
344 | u32 hi; | |
1da177e4 LT |
345 | }; |
346 | ||
4be44fcd LB |
347 | union uint64_overlay { |
348 | u64 full; | |
349 | struct uint64_struct part; | |
1da177e4 LT |
350 | }; |
351 | ||
4be44fcd LB |
352 | struct uint32_struct { |
353 | u32 lo; | |
354 | u32 hi; | |
1da177e4 LT |
355 | }; |
356 | ||
967440e3 BM |
357 | /* Synchronization objects */ |
358 | ||
359 | #define acpi_mutex void * | |
360 | #define acpi_semaphore void * | |
361 | ||
1da177e4 LT |
362 | /* |
363 | * Acpi integer width. In ACPI version 1, integers are | |
364 | * 32 bits. In ACPI version 2, integers are 64 bits. | |
365 | * Note that this pertains to the ACPI integer type only, not | |
366 | * other integers used in the implementation of the ACPI CA | |
367 | * subsystem. | |
368 | */ | |
369 | #ifdef ACPI_NO_INTEGER64_SUPPORT | |
370 | ||
371 | /* 32-bit integers only, no 64-bit support */ | |
372 | ||
4be44fcd | 373 | typedef u32 acpi_integer; |
1da177e4 LT |
374 | #define ACPI_INTEGER_MAX ACPI_UINT32_MAX |
375 | #define ACPI_INTEGER_BIT_SIZE 32 | |
4be44fcd | 376 | #define ACPI_MAX_DECIMAL_DIGITS 10 /* 2^32 = 4,294,967,296 */ |
1da177e4 | 377 | |
4be44fcd | 378 | #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 32-bit divide */ |
1da177e4 LT |
379 | |
380 | #else | |
381 | ||
382 | /* 64-bit integers */ | |
383 | ||
4be44fcd | 384 | typedef u64 acpi_integer; |
1da177e4 LT |
385 | #define ACPI_INTEGER_MAX ACPI_UINT64_MAX |
386 | #define ACPI_INTEGER_BIT_SIZE 64 | |
4be44fcd | 387 | #define ACPI_MAX_DECIMAL_DIGITS 20 /* 2^64 = 18,446,744,073,709,551,616 */ |
1da177e4 LT |
388 | |
389 | #if ACPI_MACHINE_WIDTH == 64 | |
4be44fcd | 390 | #define ACPI_USE_NATIVE_DIVIDE /* Use compiler native 64-bit divide */ |
1da177e4 LT |
391 | #endif |
392 | #endif | |
393 | ||
394 | #define ACPI_MAX64_DECIMAL_DIGITS 20 | |
395 | #define ACPI_MAX32_DECIMAL_DIGITS 10 | |
396 | #define ACPI_MAX16_DECIMAL_DIGITS 5 | |
397 | #define ACPI_MAX8_DECIMAL_DIGITS 3 | |
398 | ||
399 | /* | |
400 | * Constants with special meanings | |
401 | */ | |
c51a4de8 | 402 | #define ACPI_ROOT_OBJECT ACPI_ADD_PTR (acpi_handle, NULL, ACPI_MAX_PTR) |
1da177e4 | 403 | |
1da177e4 LT |
404 | /* |
405 | * Initialization sequence | |
406 | */ | |
407 | #define ACPI_FULL_INITIALIZATION 0x00 | |
408 | #define ACPI_NO_ADDRESS_SPACE_INIT 0x01 | |
409 | #define ACPI_NO_HARDWARE_INIT 0x02 | |
410 | #define ACPI_NO_EVENT_INIT 0x04 | |
411 | #define ACPI_NO_HANDLER_INIT 0x08 | |
412 | #define ACPI_NO_ACPI_ENABLE 0x10 | |
413 | #define ACPI_NO_DEVICE_INIT 0x20 | |
414 | #define ACPI_NO_OBJECT_INIT 0x40 | |
415 | ||
416 | /* | |
417 | * Initialization state | |
418 | */ | |
cb219bb6 BM |
419 | #define ACPI_SUBSYSTEM_INITIALIZE 0x01 |
420 | #define ACPI_INITIALIZED_OK 0x02 | |
1da177e4 LT |
421 | |
422 | /* | |
423 | * Power state values | |
424 | */ | |
425 | #define ACPI_STATE_UNKNOWN (u8) 0xFF | |
426 | ||
427 | #define ACPI_STATE_S0 (u8) 0 | |
428 | #define ACPI_STATE_S1 (u8) 1 | |
429 | #define ACPI_STATE_S2 (u8) 2 | |
430 | #define ACPI_STATE_S3 (u8) 3 | |
431 | #define ACPI_STATE_S4 (u8) 4 | |
432 | #define ACPI_STATE_S5 (u8) 5 | |
433 | #define ACPI_S_STATES_MAX ACPI_STATE_S5 | |
434 | #define ACPI_S_STATE_COUNT 6 | |
435 | ||
436 | #define ACPI_STATE_D0 (u8) 0 | |
437 | #define ACPI_STATE_D1 (u8) 1 | |
438 | #define ACPI_STATE_D2 (u8) 2 | |
439 | #define ACPI_STATE_D3 (u8) 3 | |
440 | #define ACPI_D_STATES_MAX ACPI_STATE_D3 | |
441 | #define ACPI_D_STATE_COUNT 4 | |
442 | ||
443 | #define ACPI_STATE_C0 (u8) 0 | |
444 | #define ACPI_STATE_C1 (u8) 1 | |
445 | #define ACPI_STATE_C2 (u8) 2 | |
446 | #define ACPI_STATE_C3 (u8) 3 | |
447 | #define ACPI_C_STATES_MAX ACPI_STATE_C3 | |
448 | #define ACPI_C_STATE_COUNT 4 | |
449 | ||
450 | /* | |
451 | * Sleep type invalid value | |
452 | */ | |
453 | #define ACPI_SLEEP_TYPE_MAX 0x7 | |
454 | #define ACPI_SLEEP_TYPE_INVALID 0xFF | |
455 | ||
456 | /* | |
457 | * Standard notify values | |
458 | */ | |
459 | #define ACPI_NOTIFY_BUS_CHECK (u8) 0 | |
460 | #define ACPI_NOTIFY_DEVICE_CHECK (u8) 1 | |
461 | #define ACPI_NOTIFY_DEVICE_WAKE (u8) 2 | |
462 | #define ACPI_NOTIFY_EJECT_REQUEST (u8) 3 | |
463 | #define ACPI_NOTIFY_DEVICE_CHECK_LIGHT (u8) 4 | |
464 | #define ACPI_NOTIFY_FREQUENCY_MISMATCH (u8) 5 | |
465 | #define ACPI_NOTIFY_BUS_MODE_MISMATCH (u8) 6 | |
466 | #define ACPI_NOTIFY_POWER_FAULT (u8) 7 | |
467 | ||
1da177e4 LT |
468 | /* |
469 | * Types associated with ACPI names and objects. The first group of | |
470 | * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition | |
471 | * of the ACPI object_type() operator (See the ACPI Spec). Therefore, | |
472 | * only add to the first group if the spec changes. | |
473 | * | |
474 | * NOTE: Types must be kept in sync with the global acpi_ns_properties | |
475 | * and acpi_ns_type_names arrays. | |
476 | */ | |
4be44fcd | 477 | typedef u32 acpi_object_type; |
1da177e4 LT |
478 | |
479 | #define ACPI_TYPE_ANY 0x00 | |
4be44fcd | 480 | #define ACPI_TYPE_INTEGER 0x01 /* Byte/Word/Dword/Zero/One/Ones */ |
1da177e4 LT |
481 | #define ACPI_TYPE_STRING 0x02 |
482 | #define ACPI_TYPE_BUFFER 0x03 | |
4be44fcd | 483 | #define ACPI_TYPE_PACKAGE 0x04 /* byte_const, multiple data_term/Constant/super_name */ |
1da177e4 | 484 | #define ACPI_TYPE_FIELD_UNIT 0x05 |
4be44fcd | 485 | #define ACPI_TYPE_DEVICE 0x06 /* Name, multiple Node */ |
1da177e4 | 486 | #define ACPI_TYPE_EVENT 0x07 |
4be44fcd | 487 | #define ACPI_TYPE_METHOD 0x08 /* Name, byte_const, multiple Code */ |
1da177e4 LT |
488 | #define ACPI_TYPE_MUTEX 0x09 |
489 | #define ACPI_TYPE_REGION 0x0A | |
4be44fcd LB |
490 | #define ACPI_TYPE_POWER 0x0B /* Name,byte_const,word_const,multi Node */ |
491 | #define ACPI_TYPE_PROCESSOR 0x0C /* Name,byte_const,Dword_const,byte_const,multi nm_o */ | |
492 | #define ACPI_TYPE_THERMAL 0x0D /* Name, multiple Node */ | |
1da177e4 LT |
493 | #define ACPI_TYPE_BUFFER_FIELD 0x0E |
494 | #define ACPI_TYPE_DDB_HANDLE 0x0F | |
495 | #define ACPI_TYPE_DEBUG_OBJECT 0x10 | |
496 | ||
497 | #define ACPI_TYPE_EXTERNAL_MAX 0x10 | |
498 | ||
499 | /* | |
500 | * These are object types that do not map directly to the ACPI | |
501 | * object_type() operator. They are used for various internal purposes only. | |
502 | * If new predefined ACPI_TYPEs are added (via the ACPI specification), these | |
503 | * internal types must move upwards. (There is code that depends on these | |
504 | * values being contiguous with the external types above.) | |
505 | */ | |
506 | #define ACPI_TYPE_LOCAL_REGION_FIELD 0x11 | |
507 | #define ACPI_TYPE_LOCAL_BANK_FIELD 0x12 | |
508 | #define ACPI_TYPE_LOCAL_INDEX_FIELD 0x13 | |
4be44fcd | 509 | #define ACPI_TYPE_LOCAL_REFERENCE 0x14 /* Arg#, Local#, Name, Debug, ref_of, Index */ |
1da177e4 LT |
510 | #define ACPI_TYPE_LOCAL_ALIAS 0x15 |
511 | #define ACPI_TYPE_LOCAL_METHOD_ALIAS 0x16 | |
512 | #define ACPI_TYPE_LOCAL_NOTIFY 0x17 | |
513 | #define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x18 | |
514 | #define ACPI_TYPE_LOCAL_RESOURCE 0x19 | |
515 | #define ACPI_TYPE_LOCAL_RESOURCE_FIELD 0x1A | |
4be44fcd | 516 | #define ACPI_TYPE_LOCAL_SCOPE 0x1B /* 1 Name, multiple object_list Nodes */ |
1da177e4 | 517 | |
4be44fcd | 518 | #define ACPI_TYPE_NS_NODE_MAX 0x1B /* Last typecode used within a NS Node */ |
1da177e4 LT |
519 | |
520 | /* | |
521 | * These are special object types that never appear in | |
522 | * a Namespace node, only in an union acpi_operand_object | |
523 | */ | |
524 | #define ACPI_TYPE_LOCAL_EXTRA 0x1C | |
525 | #define ACPI_TYPE_LOCAL_DATA 0x1D | |
526 | ||
527 | #define ACPI_TYPE_LOCAL_MAX 0x1D | |
528 | ||
529 | /* All types above here are invalid */ | |
530 | ||
531 | #define ACPI_TYPE_INVALID 0x1E | |
532 | #define ACPI_TYPE_NOT_FOUND 0xFF | |
533 | ||
1da177e4 LT |
534 | /* |
535 | * All I/O | |
536 | */ | |
537 | #define ACPI_READ 0 | |
538 | #define ACPI_WRITE 1 | |
539 | #define ACPI_IO_MASK 1 | |
540 | ||
541 | /* | |
542 | * Event Types: Fixed & General Purpose | |
543 | */ | |
4be44fcd | 544 | typedef u32 acpi_event_type; |
1da177e4 LT |
545 | |
546 | /* | |
547 | * Fixed events | |
548 | */ | |
549 | #define ACPI_EVENT_PMTIMER 0 | |
550 | #define ACPI_EVENT_GLOBAL 1 | |
551 | #define ACPI_EVENT_POWER_BUTTON 2 | |
552 | #define ACPI_EVENT_SLEEP_BUTTON 3 | |
553 | #define ACPI_EVENT_RTC 4 | |
554 | #define ACPI_EVENT_MAX 4 | |
555 | #define ACPI_NUM_FIXED_EVENTS ACPI_EVENT_MAX + 1 | |
556 | ||
557 | /* | |
558 | * Event Status - Per event | |
559 | * ------------- | |
560 | * The encoding of acpi_event_status is illustrated below. | |
561 | * Note that a set bit (1) indicates the property is TRUE | |
562 | * (e.g. if bit 0 is set then the event is enabled). | |
563 | * +-------------+-+-+-+ | |
564 | * | Bits 31:3 |2|1|0| | |
565 | * +-------------+-+-+-+ | |
566 | * | | | | | |
567 | * | | | +- Enabled? | |
568 | * | | +--- Enabled for wake? | |
569 | * | +----- Set? | |
570 | * +----------- <Reserved> | |
571 | */ | |
4be44fcd | 572 | typedef u32 acpi_event_status; |
1da177e4 LT |
573 | |
574 | #define ACPI_EVENT_FLAG_DISABLED (acpi_event_status) 0x00 | |
575 | #define ACPI_EVENT_FLAG_ENABLED (acpi_event_status) 0x01 | |
576 | #define ACPI_EVENT_FLAG_WAKE_ENABLED (acpi_event_status) 0x02 | |
577 | #define ACPI_EVENT_FLAG_SET (acpi_event_status) 0x04 | |
578 | ||
579 | /* | |
580 | * General Purpose Events (GPE) | |
581 | */ | |
582 | #define ACPI_GPE_INVALID 0xFF | |
583 | #define ACPI_GPE_MAX 0xFF | |
584 | #define ACPI_NUM_GPE 256 | |
585 | ||
586 | #define ACPI_GPE_ENABLE 0 | |
587 | #define ACPI_GPE_DISABLE 1 | |
588 | ||
1da177e4 LT |
589 | /* |
590 | * GPE info flags - Per GPE | |
591 | * +-+-+-+---+---+-+ | |
592 | * |7|6|5|4:3|2:1|0| | |
593 | * +-+-+-+---+---+-+ | |
594 | * | | | | | | | |
595 | * | | | | | +--- Interrupt type: Edge or Level Triggered | |
596 | * | | | | +--- Type: Wake-only, Runtime-only, or wake/runtime | |
597 | * | | | +--- Type of dispatch -- to method, handler, or none | |
598 | * | | +--- Enabled for runtime? | |
599 | * | +--- Enabled for wake? | |
c5a71569 | 600 | * +--- Unused |
1da177e4 LT |
601 | */ |
602 | #define ACPI_GPE_XRUPT_TYPE_MASK (u8) 0x01 | |
603 | #define ACPI_GPE_LEVEL_TRIGGERED (u8) 0x01 | |
604 | #define ACPI_GPE_EDGE_TRIGGERED (u8) 0x00 | |
605 | ||
606 | #define ACPI_GPE_TYPE_MASK (u8) 0x06 | |
607 | #define ACPI_GPE_TYPE_WAKE_RUN (u8) 0x06 | |
608 | #define ACPI_GPE_TYPE_WAKE (u8) 0x02 | |
4be44fcd | 609 | #define ACPI_GPE_TYPE_RUNTIME (u8) 0x04 /* Default */ |
1da177e4 LT |
610 | |
611 | #define ACPI_GPE_DISPATCH_MASK (u8) 0x18 | |
612 | #define ACPI_GPE_DISPATCH_HANDLER (u8) 0x08 | |
613 | #define ACPI_GPE_DISPATCH_METHOD (u8) 0x10 | |
4be44fcd | 614 | #define ACPI_GPE_DISPATCH_NOT_USED (u8) 0x00 /* Default */ |
1da177e4 LT |
615 | |
616 | #define ACPI_GPE_RUN_ENABLE_MASK (u8) 0x20 | |
617 | #define ACPI_GPE_RUN_ENABLED (u8) 0x20 | |
4be44fcd | 618 | #define ACPI_GPE_RUN_DISABLED (u8) 0x00 /* Default */ |
1da177e4 LT |
619 | |
620 | #define ACPI_GPE_WAKE_ENABLE_MASK (u8) 0x40 | |
621 | #define ACPI_GPE_WAKE_ENABLED (u8) 0x40 | |
4be44fcd | 622 | #define ACPI_GPE_WAKE_DISABLED (u8) 0x00 /* Default */ |
1da177e4 | 623 | |
4be44fcd | 624 | #define ACPI_GPE_ENABLE_MASK (u8) 0x60 /* Both run/wake */ |
1da177e4 | 625 | |
1da177e4 LT |
626 | /* |
627 | * Flags for GPE and Lock interfaces | |
628 | */ | |
4be44fcd LB |
629 | #define ACPI_EVENT_WAKE_ENABLE 0x2 /* acpi_gpe_enable */ |
630 | #define ACPI_EVENT_WAKE_DISABLE 0x2 /* acpi_gpe_disable */ | |
1da177e4 LT |
631 | |
632 | #define ACPI_NOT_ISR 0x1 | |
633 | #define ACPI_ISR 0x0 | |
634 | ||
1da177e4 LT |
635 | /* Notify types */ |
636 | ||
637 | #define ACPI_SYSTEM_NOTIFY 0x1 | |
638 | #define ACPI_DEVICE_NOTIFY 0x2 | |
639 | #define ACPI_ALL_NOTIFY 0x3 | |
640 | #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3 | |
641 | ||
642 | #define ACPI_MAX_SYS_NOTIFY 0x7f | |
643 | ||
1da177e4 LT |
644 | /* Address Space (Operation Region) Types */ |
645 | ||
4be44fcd | 646 | typedef u8 acpi_adr_space_type; |
1da177e4 LT |
647 | |
648 | #define ACPI_ADR_SPACE_SYSTEM_MEMORY (acpi_adr_space_type) 0 | |
649 | #define ACPI_ADR_SPACE_SYSTEM_IO (acpi_adr_space_type) 1 | |
650 | #define ACPI_ADR_SPACE_PCI_CONFIG (acpi_adr_space_type) 2 | |
651 | #define ACPI_ADR_SPACE_EC (acpi_adr_space_type) 3 | |
652 | #define ACPI_ADR_SPACE_SMBUS (acpi_adr_space_type) 4 | |
653 | #define ACPI_ADR_SPACE_CMOS (acpi_adr_space_type) 5 | |
654 | #define ACPI_ADR_SPACE_PCI_BAR_TARGET (acpi_adr_space_type) 6 | |
655 | #define ACPI_ADR_SPACE_DATA_TABLE (acpi_adr_space_type) 7 | |
656 | #define ACPI_ADR_SPACE_FIXED_HARDWARE (acpi_adr_space_type) 127 | |
657 | ||
1da177e4 LT |
658 | /* |
659 | * bit_register IDs | |
660 | * These are bitfields defined within the full ACPI registers | |
661 | */ | |
662 | #define ACPI_BITREG_TIMER_STATUS 0x00 | |
663 | #define ACPI_BITREG_BUS_MASTER_STATUS 0x01 | |
664 | #define ACPI_BITREG_GLOBAL_LOCK_STATUS 0x02 | |
665 | #define ACPI_BITREG_POWER_BUTTON_STATUS 0x03 | |
666 | #define ACPI_BITREG_SLEEP_BUTTON_STATUS 0x04 | |
667 | #define ACPI_BITREG_RT_CLOCK_STATUS 0x05 | |
668 | #define ACPI_BITREG_WAKE_STATUS 0x06 | |
669 | #define ACPI_BITREG_PCIEXP_WAKE_STATUS 0x07 | |
670 | ||
671 | #define ACPI_BITREG_TIMER_ENABLE 0x08 | |
672 | #define ACPI_BITREG_GLOBAL_LOCK_ENABLE 0x09 | |
673 | #define ACPI_BITREG_POWER_BUTTON_ENABLE 0x0A | |
674 | #define ACPI_BITREG_SLEEP_BUTTON_ENABLE 0x0B | |
675 | #define ACPI_BITREG_RT_CLOCK_ENABLE 0x0C | |
676 | #define ACPI_BITREG_WAKE_ENABLE 0x0D | |
677 | #define ACPI_BITREG_PCIEXP_WAKE_DISABLE 0x0E | |
678 | ||
679 | #define ACPI_BITREG_SCI_ENABLE 0x0F | |
680 | #define ACPI_BITREG_BUS_MASTER_RLD 0x10 | |
681 | #define ACPI_BITREG_GLOBAL_LOCK_RELEASE 0x11 | |
682 | #define ACPI_BITREG_SLEEP_TYPE_A 0x12 | |
683 | #define ACPI_BITREG_SLEEP_TYPE_B 0x13 | |
684 | #define ACPI_BITREG_SLEEP_ENABLE 0x14 | |
685 | ||
686 | #define ACPI_BITREG_ARB_DISABLE 0x15 | |
687 | ||
688 | #define ACPI_BITREG_MAX 0x15 | |
689 | #define ACPI_NUM_BITREG ACPI_BITREG_MAX + 1 | |
690 | ||
1da177e4 LT |
691 | /* |
692 | * External ACPI object definition | |
693 | */ | |
4be44fcd LB |
694 | union acpi_object { |
695 | acpi_object_type type; /* See definition of acpi_ns_type for values */ | |
696 | struct { | |
697 | acpi_object_type type; | |
698 | acpi_integer value; /* The actual number */ | |
1da177e4 LT |
699 | } integer; |
700 | ||
4be44fcd LB |
701 | struct { |
702 | acpi_object_type type; | |
703 | u32 length; /* # of bytes in string, excluding trailing null */ | |
704 | char *pointer; /* points to the string value */ | |
1da177e4 LT |
705 | } string; |
706 | ||
4be44fcd LB |
707 | struct { |
708 | acpi_object_type type; | |
709 | u32 length; /* # of bytes in buffer */ | |
710 | u8 *pointer; /* points to the buffer */ | |
1da177e4 LT |
711 | } buffer; |
712 | ||
4be44fcd LB |
713 | struct { |
714 | acpi_object_type type; | |
715 | u32 fill1; | |
716 | acpi_handle handle; /* object reference */ | |
1da177e4 LT |
717 | } reference; |
718 | ||
4be44fcd LB |
719 | struct { |
720 | acpi_object_type type; | |
721 | u32 count; /* # of elements in package */ | |
722 | union acpi_object *elements; /* Pointer to an array of ACPI_OBJECTs */ | |
1da177e4 LT |
723 | } package; |
724 | ||
4be44fcd LB |
725 | struct { |
726 | acpi_object_type type; | |
727 | u32 proc_id; | |
728 | acpi_io_address pblk_address; | |
729 | u32 pblk_length; | |
1da177e4 LT |
730 | } processor; |
731 | ||
4be44fcd LB |
732 | struct { |
733 | acpi_object_type type; | |
734 | u32 system_level; | |
735 | u32 resource_order; | |
1da177e4 LT |
736 | } power_resource; |
737 | }; | |
738 | ||
1da177e4 LT |
739 | /* |
740 | * List of objects, used as a parameter list for control method evaluation | |
741 | */ | |
4be44fcd LB |
742 | struct acpi_object_list { |
743 | u32 count; | |
744 | union acpi_object *pointer; | |
1da177e4 LT |
745 | }; |
746 | ||
1da177e4 LT |
747 | /* |
748 | * Miscellaneous common Data Structures used by the interfaces | |
749 | */ | |
750 | #define ACPI_NO_BUFFER 0 | |
751 | #define ACPI_ALLOCATE_BUFFER (acpi_size) (-1) | |
752 | #define ACPI_ALLOCATE_LOCAL_BUFFER (acpi_size) (-2) | |
753 | ||
4be44fcd LB |
754 | struct acpi_buffer { |
755 | acpi_size length; /* Length in bytes of the buffer */ | |
756 | void *pointer; /* pointer to buffer */ | |
1da177e4 LT |
757 | }; |
758 | ||
1da177e4 LT |
759 | /* |
760 | * name_type for acpi_get_name | |
761 | */ | |
762 | #define ACPI_FULL_PATHNAME 0 | |
763 | #define ACPI_SINGLE_NAME 1 | |
764 | #define ACPI_NAME_TYPE_MAX 1 | |
765 | ||
1da177e4 LT |
766 | /* |
767 | * Structure and flags for acpi_get_system_info | |
768 | */ | |
769 | #define ACPI_SYS_MODE_UNKNOWN 0x0000 | |
770 | #define ACPI_SYS_MODE_ACPI 0x0001 | |
771 | #define ACPI_SYS_MODE_LEGACY 0x0002 | |
772 | #define ACPI_SYS_MODES_MASK 0x0003 | |
773 | ||
1da177e4 LT |
774 | /* |
775 | * System info returned by acpi_get_system_info() | |
776 | */ | |
4be44fcd LB |
777 | struct acpi_system_info { |
778 | u32 acpi_ca_version; | |
779 | u32 flags; | |
780 | u32 timer_resolution; | |
781 | u32 reserved1; | |
782 | u32 reserved2; | |
783 | u32 debug_level; | |
784 | u32 debug_layer; | |
1da177e4 LT |
785 | }; |
786 | ||
1da177e4 LT |
787 | /* |
788 | * Types specific to the OS service interfaces | |
789 | */ | |
4be44fcd | 790 | typedef u32(ACPI_SYSTEM_XFACE * acpi_osd_handler) (void *context); |
1da177e4 LT |
791 | |
792 | typedef void | |
4be44fcd | 793 | (ACPI_SYSTEM_XFACE * acpi_osd_exec_callback) (void *context); |
1da177e4 LT |
794 | |
795 | /* | |
796 | * Various handlers and callback procedures | |
797 | */ | |
4be44fcd | 798 | typedef u32(*acpi_event_handler) (void *context); |
1da177e4 LT |
799 | |
800 | typedef | |
4be44fcd | 801 | void (*acpi_notify_handler) (acpi_handle device, u32 value, void *context); |
1da177e4 LT |
802 | |
803 | typedef | |
4be44fcd | 804 | void (*acpi_object_handler) (acpi_handle object, u32 function, void *data); |
1da177e4 | 805 | |
4be44fcd | 806 | typedef acpi_status(*acpi_init_handler) (acpi_handle object, u32 function); |
1da177e4 LT |
807 | |
808 | #define ACPI_INIT_DEVICE_INI 1 | |
809 | ||
810 | typedef | |
4be44fcd LB |
811 | acpi_status(*acpi_exception_handler) (acpi_status aml_status, |
812 | acpi_name name, | |
813 | u16 opcode, | |
814 | u32 aml_offset, void *context); | |
1da177e4 LT |
815 | |
816 | /* Address Spaces (For Operation Regions) */ | |
817 | ||
818 | typedef | |
4be44fcd LB |
819 | acpi_status(*acpi_adr_space_handler) (u32 function, |
820 | acpi_physical_address address, | |
821 | u32 bit_width, | |
822 | acpi_integer * value, | |
823 | void *handler_context, | |
824 | void *region_context); | |
1da177e4 | 825 | |
61686124 | 826 | #define ACPI_DEFAULT_HANDLER NULL |
1da177e4 | 827 | |
1da177e4 | 828 | typedef |
4be44fcd LB |
829 | acpi_status(*acpi_adr_space_setup) (acpi_handle region_handle, |
830 | u32 function, | |
831 | void *handler_context, | |
832 | void **region_context); | |
1da177e4 LT |
833 | |
834 | #define ACPI_REGION_ACTIVATE 0 | |
835 | #define ACPI_REGION_DEACTIVATE 1 | |
836 | ||
837 | typedef | |
4be44fcd LB |
838 | acpi_status(*acpi_walk_callback) (acpi_handle obj_handle, |
839 | u32 nesting_level, | |
840 | void *context, void **return_value); | |
1da177e4 LT |
841 | |
842 | /* Interrupt handler return values */ | |
843 | ||
844 | #define ACPI_INTERRUPT_NOT_HANDLED 0x00 | |
845 | #define ACPI_INTERRUPT_HANDLED 0x01 | |
846 | ||
1da177e4 LT |
847 | /* Common string version of device HIDs and UIDs */ |
848 | ||
4be44fcd LB |
849 | struct acpi_device_id { |
850 | char value[ACPI_DEVICE_ID_LENGTH]; | |
1da177e4 LT |
851 | }; |
852 | ||
853 | /* Common string version of device CIDs */ | |
854 | ||
4be44fcd LB |
855 | struct acpi_compatible_id { |
856 | char value[ACPI_MAX_CID_LENGTH]; | |
1da177e4 LT |
857 | }; |
858 | ||
4be44fcd LB |
859 | struct acpi_compatible_id_list { |
860 | u32 count; | |
861 | u32 size; | |
862 | struct acpi_compatible_id id[1]; | |
1da177e4 LT |
863 | }; |
864 | ||
1da177e4 LT |
865 | /* Structure and flags for acpi_get_object_info */ |
866 | ||
867 | #define ACPI_VALID_STA 0x0001 | |
868 | #define ACPI_VALID_ADR 0x0002 | |
869 | #define ACPI_VALID_HID 0x0004 | |
870 | #define ACPI_VALID_UID 0x0008 | |
871 | #define ACPI_VALID_CID 0x0010 | |
872 | #define ACPI_VALID_SXDS 0x0020 | |
873 | ||
defba1d8 BM |
874 | /* Flags for _STA method */ |
875 | ||
876 | #define ACPI_STA_DEVICE_PRESENT 0x01 | |
877 | #define ACPI_STA_DEVICE_ENABLED 0x02 | |
878 | #define ACPI_STA_DEVICE_UI 0x04 | |
b229cf92 BM |
879 | #define ACPI_STA_DEVICE_FUNCTIONING 0x08 |
880 | #define ACPI_STA_DEVICE_OK 0x08 /* Synonym */ | |
defba1d8 BM |
881 | #define ACPI_STA_BATTERY_PRESENT 0x10 |
882 | ||
1da177e4 | 883 | #define ACPI_COMMON_OBJ_INFO \ |
61686124 BM |
884 | acpi_object_type type; /* ACPI object type */ \ |
885 | acpi_name name /* ACPI object Name */ | |
1da177e4 | 886 | |
4be44fcd | 887 | struct acpi_obj_info_header { |
1da177e4 LT |
888 | ACPI_COMMON_OBJ_INFO; |
889 | }; | |
890 | ||
1da177e4 LT |
891 | /* Structure returned from Get Object Info */ |
892 | ||
4be44fcd | 893 | struct acpi_device_info { |
1da177e4 LT |
894 | ACPI_COMMON_OBJ_INFO; |
895 | ||
4be44fcd LB |
896 | u32 valid; /* Indicates which fields below are valid */ |
897 | u32 current_status; /* _STA value */ | |
898 | acpi_integer address; /* _ADR value if any */ | |
899 | struct acpi_device_id hardware_id; /* _HID value if any */ | |
900 | struct acpi_device_id unique_id; /* _UID value if any */ | |
901 | u8 highest_dstates[4]; /* _sx_d values: 0xFF indicates not valid */ | |
902 | struct acpi_compatible_id_list compatibility_id; /* List of _CIDs if any */ | |
1da177e4 LT |
903 | }; |
904 | ||
1da177e4 LT |
905 | /* Context structs for address space handlers */ |
906 | ||
4be44fcd LB |
907 | struct acpi_pci_id { |
908 | u16 segment; | |
909 | u16 bus; | |
910 | u16 device; | |
911 | u16 function; | |
1da177e4 LT |
912 | }; |
913 | ||
4be44fcd LB |
914 | struct acpi_mem_space_context { |
915 | u32 length; | |
916 | acpi_physical_address address; | |
917 | acpi_physical_address mapped_physical_address; | |
918 | u8 *mapped_logical_address; | |
919 | acpi_size mapped_length; | |
1da177e4 LT |
920 | }; |
921 | ||
1da177e4 LT |
922 | /* |
923 | * Definitions for Resource Attributes | |
924 | */ | |
0897831b | 925 | typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */ |
958dd242 | 926 | typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64_k-1)+3 */ |
1da177e4 LT |
927 | |
928 | /* | |
929 | * Memory Attributes | |
930 | */ | |
931 | #define ACPI_READ_ONLY_MEMORY (u8) 0x00 | |
932 | #define ACPI_READ_WRITE_MEMORY (u8) 0x01 | |
933 | ||
934 | #define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00 | |
935 | #define ACPI_CACHABLE_MEMORY (u8) 0x01 | |
936 | #define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02 | |
937 | #define ACPI_PREFETCHABLE_MEMORY (u8) 0x03 | |
938 | ||
939 | /* | |
940 | * IO Attributes | |
958dd242 BM |
941 | * The ISA IO ranges are: n000-n0_fFh, n400-n4_fFh, n800-n8_fFh, n_c00-n_cFFh. |
942 | * The non-ISA IO ranges are: n100-n3_fFh, n500-n7_fFh, n900-n_bFFh, n_cd0-n_fFFh. | |
1da177e4 LT |
943 | */ |
944 | #define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01 | |
945 | #define ACPI_ISA_ONLY_RANGES (u8) 0x02 | |
946 | #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES) | |
947 | ||
defba1d8 BM |
948 | /* Type of translation - 1=Sparse, 0=Dense */ |
949 | ||
950 | #define ACPI_SPARSE_TRANSLATION (u8) 0x01 | |
1da177e4 LT |
951 | |
952 | /* | |
953 | * IO Port Descriptor Decode | |
954 | */ | |
4be44fcd LB |
955 | #define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */ |
956 | #define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */ | |
1da177e4 LT |
957 | |
958 | /* | |
959 | * IRQ Attributes | |
960 | */ | |
0897831b BM |
961 | #define ACPI_LEVEL_SENSITIVE (u8) 0x00 |
962 | #define ACPI_EDGE_SENSITIVE (u8) 0x01 | |
1da177e4 LT |
963 | |
964 | #define ACPI_ACTIVE_HIGH (u8) 0x00 | |
965 | #define ACPI_ACTIVE_LOW (u8) 0x01 | |
966 | ||
967 | #define ACPI_EXCLUSIVE (u8) 0x00 | |
968 | #define ACPI_SHARED (u8) 0x01 | |
969 | ||
970 | /* | |
971 | * DMA Attributes | |
972 | */ | |
973 | #define ACPI_COMPATIBILITY (u8) 0x00 | |
974 | #define ACPI_TYPE_A (u8) 0x01 | |
975 | #define ACPI_TYPE_B (u8) 0x02 | |
976 | #define ACPI_TYPE_F (u8) 0x03 | |
977 | ||
978 | #define ACPI_NOT_BUS_MASTER (u8) 0x00 | |
979 | #define ACPI_BUS_MASTER (u8) 0x01 | |
980 | ||
981 | #define ACPI_TRANSFER_8 (u8) 0x00 | |
982 | #define ACPI_TRANSFER_8_16 (u8) 0x01 | |
983 | #define ACPI_TRANSFER_16 (u8) 0x02 | |
984 | ||
985 | /* | |
986 | * Start Dependent Functions Priority definitions | |
987 | */ | |
988 | #define ACPI_GOOD_CONFIGURATION (u8) 0x00 | |
989 | #define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01 | |
990 | #define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02 | |
991 | ||
992 | /* | |
993 | * 16, 32 and 64-bit Address Descriptor resource types | |
994 | */ | |
995 | #define ACPI_MEMORY_RANGE (u8) 0x00 | |
996 | #define ACPI_IO_RANGE (u8) 0x01 | |
997 | #define ACPI_BUS_NUMBER_RANGE (u8) 0x02 | |
998 | ||
999 | #define ACPI_ADDRESS_NOT_FIXED (u8) 0x00 | |
1000 | #define ACPI_ADDRESS_FIXED (u8) 0x01 | |
1001 | ||
1002 | #define ACPI_POS_DECODE (u8) 0x00 | |
1003 | #define ACPI_SUB_DECODE (u8) 0x01 | |
1004 | ||
1005 | #define ACPI_PRODUCER (u8) 0x00 | |
1006 | #define ACPI_CONSUMER (u8) 0x01 | |
1007 | ||
0897831b BM |
1008 | /* |
1009 | * If possible, pack the following structures to byte alignment | |
1010 | */ | |
1011 | #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED | |
1012 | #pragma pack(1) | |
1013 | #endif | |
1014 | ||
c51a4de8 BM |
1015 | /* UUID data structures for use in vendor-defined resource descriptors */ |
1016 | ||
1017 | struct acpi_uuid { | |
1018 | u8 data[ACPI_UUID_LENGTH]; | |
1019 | }; | |
1020 | ||
1021 | struct acpi_vendor_uuid { | |
1022 | u8 subtype; | |
1023 | u8 data[ACPI_UUID_LENGTH]; | |
1024 | }; | |
1025 | ||
1da177e4 LT |
1026 | /* |
1027 | * Structures used to describe device resources | |
1028 | */ | |
4be44fcd | 1029 | struct acpi_resource_irq { |
0897831b BM |
1030 | u8 triggering; |
1031 | u8 polarity; | |
1032 | u8 sharable; | |
1033 | u8 interrupt_count; | |
1034 | u8 interrupts[1]; | |
1da177e4 LT |
1035 | }; |
1036 | ||
4be44fcd | 1037 | struct acpi_resource_dma { |
0897831b BM |
1038 | u8 type; |
1039 | u8 bus_master; | |
1040 | u8 transfer; | |
1041 | u8 channel_count; | |
1042 | u8 channels[1]; | |
1da177e4 LT |
1043 | }; |
1044 | ||
50eca3eb | 1045 | struct acpi_resource_start_dependent { |
0897831b BM |
1046 | u8 compatibility_priority; |
1047 | u8 performance_robustness; | |
1da177e4 LT |
1048 | }; |
1049 | ||
1050 | /* | |
1051 | * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not | |
1052 | * needed because it has no fields | |
1053 | */ | |
1054 | ||
4be44fcd | 1055 | struct acpi_resource_io { |
0897831b BM |
1056 | u8 io_decode; |
1057 | u8 alignment; | |
1058 | u8 address_length; | |
1059 | u16 minimum; | |
1060 | u16 maximum; | |
1da177e4 LT |
1061 | }; |
1062 | ||
4be44fcd | 1063 | struct acpi_resource_fixed_io { |
0897831b BM |
1064 | u16 address; |
1065 | u8 address_length; | |
1da177e4 LT |
1066 | }; |
1067 | ||
4be44fcd | 1068 | struct acpi_resource_vendor { |
0897831b | 1069 | u16 byte_length; |
50eca3eb | 1070 | u8 byte_data[1]; |
1da177e4 LT |
1071 | }; |
1072 | ||
c51a4de8 BM |
1073 | /* Vendor resource with UUID info (introduced in ACPI 3.0) */ |
1074 | ||
1075 | struct acpi_resource_vendor_typed { | |
1076 | u16 byte_length; | |
1077 | u8 uuid_subtype; | |
1078 | u8 uuid[ACPI_UUID_LENGTH]; | |
1079 | u8 byte_data[1]; | |
1080 | }; | |
1081 | ||
4be44fcd LB |
1082 | struct acpi_resource_end_tag { |
1083 | u8 checksum; | |
1da177e4 LT |
1084 | }; |
1085 | ||
50eca3eb | 1086 | struct acpi_resource_memory24 { |
0897831b BM |
1087 | u8 write_protect; |
1088 | u16 minimum; | |
1089 | u16 maximum; | |
1090 | u16 alignment; | |
1091 | u16 address_length; | |
1da177e4 LT |
1092 | }; |
1093 | ||
50eca3eb | 1094 | struct acpi_resource_memory32 { |
0897831b | 1095 | u8 write_protect; |
50eca3eb BM |
1096 | u32 minimum; |
1097 | u32 maximum; | |
4be44fcd | 1098 | u32 alignment; |
50eca3eb | 1099 | u32 address_length; |
1da177e4 LT |
1100 | }; |
1101 | ||
50eca3eb | 1102 | struct acpi_resource_fixed_memory32 { |
0897831b | 1103 | u8 write_protect; |
50eca3eb BM |
1104 | u32 address; |
1105 | u32 address_length; | |
1da177e4 LT |
1106 | }; |
1107 | ||
4be44fcd | 1108 | struct acpi_memory_attribute { |
0897831b BM |
1109 | u8 write_protect; |
1110 | u8 caching; | |
1111 | u8 range_type; | |
1112 | u8 translation; | |
1da177e4 LT |
1113 | }; |
1114 | ||
4be44fcd | 1115 | struct acpi_io_attribute { |
0897831b BM |
1116 | u8 range_type; |
1117 | u8 translation; | |
1118 | u8 translation_type; | |
1119 | u8 reserved1; | |
1da177e4 LT |
1120 | }; |
1121 | ||
4be44fcd | 1122 | union acpi_resource_attribute { |
0897831b | 1123 | struct acpi_memory_attribute mem; |
4be44fcd | 1124 | struct acpi_io_attribute io; |
0897831b BM |
1125 | |
1126 | /* Used for the *word_space macros */ | |
1127 | ||
1128 | u8 type_specific; | |
1da177e4 LT |
1129 | }; |
1130 | ||
4be44fcd | 1131 | struct acpi_resource_source { |
0897831b BM |
1132 | u8 index; |
1133 | u16 string_length; | |
4be44fcd | 1134 | char *string_ptr; |
1da177e4 LT |
1135 | }; |
1136 | ||
aff8c277 RM |
1137 | /* Fields common to all address descriptors, 16/32/64 bit */ |
1138 | ||
1139 | #define ACPI_RESOURCE_ADDRESS_COMMON \ | |
61686124 BM |
1140 | u8 resource_type; \ |
1141 | u8 producer_consumer; \ | |
1142 | u8 decode; \ | |
1143 | u8 min_address_fixed; \ | |
1144 | u8 max_address_fixed; \ | |
1145 | union acpi_resource_attribute info; | |
aff8c277 RM |
1146 | |
1147 | struct acpi_resource_address { | |
1148 | ACPI_RESOURCE_ADDRESS_COMMON}; | |
1149 | ||
4be44fcd | 1150 | struct acpi_resource_address16 { |
0897831b BM |
1151 | ACPI_RESOURCE_ADDRESS_COMMON u16 granularity; |
1152 | u16 minimum; | |
1153 | u16 maximum; | |
1154 | u16 translation_offset; | |
1155 | u16 address_length; | |
4be44fcd | 1156 | struct acpi_resource_source resource_source; |
1da177e4 LT |
1157 | }; |
1158 | ||
4be44fcd | 1159 | struct acpi_resource_address32 { |
aff8c277 | 1160 | ACPI_RESOURCE_ADDRESS_COMMON u32 granularity; |
50eca3eb BM |
1161 | u32 minimum; |
1162 | u32 maximum; | |
1163 | u32 translation_offset; | |
4be44fcd LB |
1164 | u32 address_length; |
1165 | struct acpi_resource_source resource_source; | |
1da177e4 LT |
1166 | }; |
1167 | ||
4be44fcd | 1168 | struct acpi_resource_address64 { |
aff8c277 | 1169 | ACPI_RESOURCE_ADDRESS_COMMON u64 granularity; |
50eca3eb BM |
1170 | u64 minimum; |
1171 | u64 maximum; | |
1172 | u64 translation_offset; | |
4be44fcd | 1173 | u64 address_length; |
4be44fcd | 1174 | struct acpi_resource_source resource_source; |
1da177e4 LT |
1175 | }; |
1176 | ||
50eca3eb | 1177 | struct acpi_resource_extended_address64 { |
0897831b BM |
1178 | ACPI_RESOURCE_ADDRESS_COMMON u8 revision_iD; |
1179 | u64 granularity; | |
50eca3eb BM |
1180 | u64 minimum; |
1181 | u64 maximum; | |
1182 | u64 translation_offset; | |
1183 | u64 address_length; | |
0897831b | 1184 | u64 type_specific; |
50eca3eb BM |
1185 | }; |
1186 | ||
1187 | struct acpi_resource_extended_irq { | |
0897831b BM |
1188 | u8 producer_consumer; |
1189 | u8 triggering; | |
1190 | u8 polarity; | |
1191 | u8 sharable; | |
1192 | u8 interrupt_count; | |
4be44fcd LB |
1193 | struct acpi_resource_source resource_source; |
1194 | u32 interrupts[1]; | |
1da177e4 LT |
1195 | }; |
1196 | ||
50eca3eb | 1197 | struct acpi_resource_generic_register { |
0897831b BM |
1198 | u8 space_id; |
1199 | u8 bit_width; | |
1200 | u8 bit_offset; | |
1201 | u8 access_size; | |
bda663d3 RM |
1202 | u64 address; |
1203 | }; | |
1204 | ||
1da177e4 LT |
1205 | /* ACPI_RESOURCE_TYPEs */ |
1206 | ||
50eca3eb BM |
1207 | #define ACPI_RESOURCE_TYPE_IRQ 0 |
1208 | #define ACPI_RESOURCE_TYPE_DMA 1 | |
1209 | #define ACPI_RESOURCE_TYPE_START_DEPENDENT 2 | |
1210 | #define ACPI_RESOURCE_TYPE_END_DEPENDENT 3 | |
1211 | #define ACPI_RESOURCE_TYPE_IO 4 | |
1212 | #define ACPI_RESOURCE_TYPE_FIXED_IO 5 | |
1213 | #define ACPI_RESOURCE_TYPE_VENDOR 6 | |
1214 | #define ACPI_RESOURCE_TYPE_END_TAG 7 | |
1215 | #define ACPI_RESOURCE_TYPE_MEMORY24 8 | |
1216 | #define ACPI_RESOURCE_TYPE_MEMORY32 9 | |
1217 | #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10 | |
1218 | #define ACPI_RESOURCE_TYPE_ADDRESS16 11 | |
1219 | #define ACPI_RESOURCE_TYPE_ADDRESS32 12 | |
1220 | #define ACPI_RESOURCE_TYPE_ADDRESS64 13 | |
1221 | #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */ | |
1222 | #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15 | |
1223 | #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16 | |
1224 | #define ACPI_RESOURCE_TYPE_MAX 16 | |
4be44fcd LB |
1225 | |
1226 | union acpi_resource_data { | |
1227 | struct acpi_resource_irq irq; | |
1228 | struct acpi_resource_dma dma; | |
50eca3eb | 1229 | struct acpi_resource_start_dependent start_dpf; |
4be44fcd LB |
1230 | struct acpi_resource_io io; |
1231 | struct acpi_resource_fixed_io fixed_io; | |
50eca3eb | 1232 | struct acpi_resource_vendor vendor; |
c51a4de8 | 1233 | struct acpi_resource_vendor_typed vendor_typed; |
4be44fcd | 1234 | struct acpi_resource_end_tag end_tag; |
50eca3eb BM |
1235 | struct acpi_resource_memory24 memory24; |
1236 | struct acpi_resource_memory32 memory32; | |
1237 | struct acpi_resource_fixed_memory32 fixed_memory32; | |
4be44fcd LB |
1238 | struct acpi_resource_address16 address16; |
1239 | struct acpi_resource_address32 address32; | |
1240 | struct acpi_resource_address64 address64; | |
50eca3eb BM |
1241 | struct acpi_resource_extended_address64 ext_address64; |
1242 | struct acpi_resource_extended_irq extended_irq; | |
1243 | struct acpi_resource_generic_register generic_reg; | |
1244 | ||
1245 | /* Common fields */ | |
1246 | ||
1247 | struct acpi_resource_address address; /* Common 16/32/64 address fields */ | |
1da177e4 LT |
1248 | }; |
1249 | ||
4be44fcd | 1250 | struct acpi_resource { |
50eca3eb | 1251 | u32 type; |
4be44fcd LB |
1252 | u32 length; |
1253 | union acpi_resource_data data; | |
1da177e4 LT |
1254 | }; |
1255 | ||
0897831b BM |
1256 | /* restore default alignment */ |
1257 | ||
1258 | #pragma pack() | |
1da177e4 | 1259 | |
0897831b BM |
1260 | #define ACPI_RS_SIZE_MIN 12 |
1261 | #define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */ | |
1262 | #define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type)) | |
1da177e4 LT |
1263 | |
1264 | #define ACPI_NEXT_RESOURCE(res) (struct acpi_resource *)((u8 *) res + res->length) | |
1265 | ||
4be44fcd LB |
1266 | struct acpi_pci_routing_table { |
1267 | u32 length; | |
1268 | u32 pin; | |
1269 | acpi_integer address; /* here for 64-bit alignment */ | |
1270 | u32 source_index; | |
1271 | char source[4]; /* pad to 64 bits so sizeof() works in all cases */ | |
1da177e4 LT |
1272 | }; |
1273 | ||
4be44fcd | 1274 | #endif /* __ACTYPES_H__ */ |