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