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