]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Name: aclocal.h - Internal data types used across the ACPI subsystem | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
7735ca0e | 8 | * Copyright (C) 2000 - 2017, 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 __ACLOCAL_H__ | |
45 | #define __ACLOCAL_H__ | |
46 | ||
61686124 BM |
47 | /* acpisrc:struct_defs -- for acpisrc conversion */ |
48 | ||
967440e3 | 49 | #define ACPI_SERIALIZED 0xFF |
1da177e4 | 50 | |
4be44fcd | 51 | typedef u32 acpi_mutex_handle; |
f3d2e786 | 52 | #define ACPI_GLOBAL_LOCK (acpi_semaphore) (-1) |
1da177e4 LT |
53 | |
54 | /* Total number of aml opcodes defined */ | |
55 | ||
9cf7adec | 56 | #define AML_NUM_OPCODES 0x83 |
1da177e4 | 57 | |
f9f4601f RM |
58 | /* Forward declarations */ |
59 | ||
4be44fcd | 60 | struct acpi_walk_state; |
f9f4601f | 61 | struct acpi_obj_mutex; |
4be44fcd | 62 | union acpi_parse_object; |
f9f4601f | 63 | |
1da177e4 LT |
64 | /***************************************************************************** |
65 | * | |
66 | * Mutex typedefs and structs | |
67 | * | |
68 | ****************************************************************************/ | |
69 | ||
1da177e4 LT |
70 | /* |
71 | * Predefined handles for the mutex objects used within the subsystem | |
72 | * All mutex objects are automatically created by acpi_ut_mutex_initialize. | |
73 | * | |
4c90ece2 | 74 | * The acquire/release ordering protocol is implied via this list. Mutexes |
1da177e4 LT |
75 | * with a lower value must be acquired before mutexes with a higher value. |
76 | * | |
4c90ece2 BM |
77 | * NOTE: any changes here must be reflected in the acpi_gbl_mutex_names |
78 | * table below also! | |
1da177e4 | 79 | */ |
4c90ece2 | 80 | #define ACPI_MTX_INTERPRETER 0 /* AML Interpreter, main lock */ |
f3d2e786 BM |
81 | #define ACPI_MTX_NAMESPACE 1 /* ACPI Namespace */ |
82 | #define ACPI_MTX_TABLES 2 /* Data for ACPI tables */ | |
967440e3 BM |
83 | #define ACPI_MTX_EVENTS 3 /* Data for ACPI events */ |
84 | #define ACPI_MTX_CACHES 4 /* Internal caches, general purposes */ | |
85 | #define ACPI_MTX_MEMORY 5 /* Debug memory tracking lists */ | |
967440e3 | 86 | |
cd64bbf8 | 87 | #define ACPI_MAX_MUTEX 5 |
3008ea9b | 88 | #define ACPI_NUM_MUTEX (ACPI_MAX_MUTEX+1) |
1da177e4 | 89 | |
8a335a23 BM |
90 | /* Lock structure for reader/writer interfaces */ |
91 | ||
92 | struct acpi_rw_lock { | |
93 | acpi_mutex writer_mutex; | |
94 | acpi_mutex reader_mutex; | |
95 | u32 num_readers; | |
96 | }; | |
97 | ||
4c90ece2 BM |
98 | /* |
99 | * Predefined handles for spinlocks used within the subsystem. | |
100 | * These spinlocks are created by acpi_ut_mutex_initialize | |
101 | */ | |
102 | #define ACPI_LOCK_GPES 0 | |
103 | #define ACPI_LOCK_HARDWARE 1 | |
104 | ||
105 | #define ACPI_MAX_LOCK 1 | |
3008ea9b | 106 | #define ACPI_NUM_LOCK (ACPI_MAX_LOCK+1) |
4c90ece2 | 107 | |
f9f4601f RM |
108 | /* This Thread ID means that the mutex is not in use (unlocked) */ |
109 | ||
3008ea9b | 110 | #define ACPI_MUTEX_NOT_ACQUIRED ((acpi_thread_id) 0) |
f9f4601f | 111 | |
f988f24e LZ |
112 | /* This Thread ID means an invalid thread ID */ |
113 | ||
114 | #ifdef ACPI_OS_INVALID_THREAD_ID | |
115 | #define ACPI_INVALID_THREAD_ID ACPI_OS_INVALID_THREAD_ID | |
116 | #else | |
117 | #define ACPI_INVALID_THREAD_ID ((acpi_thread_id) 0xFFFFFFFF) | |
118 | #endif | |
119 | ||
1da177e4 LT |
120 | /* Table for the global mutexes */ |
121 | ||
4be44fcd LB |
122 | struct acpi_mutex_info { |
123 | acpi_mutex mutex; | |
124 | u32 use_count; | |
8313524a | 125 | acpi_thread_id thread_id; |
1da177e4 LT |
126 | }; |
127 | ||
1da177e4 LT |
128 | /* Lock flag parameter for various interfaces */ |
129 | ||
130 | #define ACPI_MTX_DO_NOT_LOCK 0 | |
131 | #define ACPI_MTX_LOCK 1 | |
132 | ||
1da177e4 LT |
133 | /* Field access granularities */ |
134 | ||
135 | #define ACPI_FIELD_BYTE_GRANULARITY 1 | |
136 | #define ACPI_FIELD_WORD_GRANULARITY 2 | |
137 | #define ACPI_FIELD_DWORD_GRANULARITY 4 | |
138 | #define ACPI_FIELD_QWORD_GRANULARITY 8 | |
139 | ||
61686124 BM |
140 | #define ACPI_ENTRY_NOT_FOUND NULL |
141 | ||
1da177e4 LT |
142 | /***************************************************************************** |
143 | * | |
144 | * Namespace typedefs and structs | |
145 | * | |
146 | ****************************************************************************/ | |
147 | ||
1da177e4 LT |
148 | /* Operational modes of the AML interpreter/scanner */ |
149 | ||
4be44fcd LB |
150 | typedef enum { |
151 | ACPI_IMODE_LOAD_PASS1 = 0x01, | |
152 | ACPI_IMODE_LOAD_PASS2 = 0x02, | |
ec3153fb | 153 | ACPI_IMODE_EXECUTE = 0x03 |
1da177e4 LT |
154 | } acpi_interpreter_mode; |
155 | ||
61686124 BM |
156 | /* |
157 | * The Namespace Node describes a named object that appears in the AML. | |
158 | * descriptor_type is used to differentiate between internal descriptors. | |
159 | * | |
160 | * The node is optimized for both 32-bit and 64-bit platforms: | |
161 | * 20 bytes for the 32-bit case, 32 bytes for the 64-bit case. | |
793c2388 BM |
162 | * |
163 | * Note: The descriptor_type and Type fields must appear in the identical | |
164 | * position in both the struct acpi_namespace_node and union acpi_operand_object | |
165 | * structures. | |
61686124 | 166 | */ |
4be44fcd | 167 | struct acpi_namespace_node { |
61686124 BM |
168 | union acpi_operand_object *object; /* Interpreter object */ |
169 | u8 descriptor_type; /* Differentiate object descriptor types */ | |
793c2388 | 170 | u8 type; /* ACPI Type associated with this name */ |
61686124 BM |
171 | u8 flags; /* Miscellaneous flags */ |
172 | acpi_owner_id owner_id; /* Node creator */ | |
4be44fcd | 173 | union acpi_name_union name; /* ACPI Name, always 4 chars per ACPI spec */ |
c45b5c09 | 174 | struct acpi_namespace_node *parent; /* Parent node */ |
4be44fcd | 175 | struct acpi_namespace_node *child; /* First child */ |
c45b5c09 | 176 | struct acpi_namespace_node *peer; /* First peer */ |
f9f4601f | 177 | |
793c2388 BM |
178 | /* |
179 | * The following fields are used by the ASL compiler and disassembler only | |
180 | */ | |
8313524a | 181 | #ifdef ACPI_LARGE_NAMESPACE_NODE |
4be44fcd | 182 | union acpi_parse_object *op; |
53d9edce BM |
183 | void *method_locals; |
184 | void *method_args; | |
61686124 | 185 | u32 value; |
793c2388 | 186 | u32 length; |
53d9edce BM |
187 | u8 arg_count; |
188 | ||
f9f4601f | 189 | #endif |
1da177e4 LT |
190 | }; |
191 | ||
61686124 | 192 | /* Namespace Node flags */ |
1da177e4 | 193 | |
c45b5c09 | 194 | #define ANOBJ_RESERVED 0x01 /* Available for use */ |
d1fdda83 | 195 | #define ANOBJ_TEMPORARY 0x02 /* Node is create by a method and is temporary */ |
61686124 BM |
196 | #define ANOBJ_METHOD_ARG 0x04 /* Node is a method argument */ |
197 | #define ANOBJ_METHOD_LOCAL 0x08 /* Node is a method local */ | |
b229cf92 | 198 | #define ANOBJ_SUBTREE_HAS_INI 0x10 /* Used to optimize device initialization */ |
e8707b34 | 199 | #define ANOBJ_EVALUATED 0x20 /* Set on first evaluation of node */ |
b2f7ddcf | 200 | #define ANOBJ_ALLOCATED_BUFFER 0x40 /* Method AML buffer is dynamic (install_method) */ |
b229cf92 | 201 | |
75c8044f LZ |
202 | #define ANOBJ_IS_EXTERNAL 0x08 /* iASL only: This object created via External() */ |
203 | #define ANOBJ_METHOD_NO_RETVAL 0x10 /* iASL only: Method has no return value */ | |
204 | #define ANOBJ_METHOD_SOME_NO_RETVAL 0x20 /* iASL only: Method has at least one return value */ | |
205 | #define ANOBJ_IS_REFERENCED 0x80 /* iASL only: Object was referenced */ | |
1da177e4 | 206 | |
b9ee2043 | 207 | /* Internal ACPI table management - master table list */ |
c5fc42ac | 208 | |
b9ee2043 BM |
209 | struct acpi_table_list { |
210 | struct acpi_table_desc *tables; /* Table descriptor array */ | |
211 | u32 current_table_count; /* Tables currently in the array */ | |
212 | u32 max_table_count; /* Max tables array will hold */ | |
f3d2e786 | 213 | u8 flags; |
1da177e4 LT |
214 | }; |
215 | ||
c5fc42ac | 216 | /* Flags for above */ |
f3d2e786 | 217 | |
c5fc42ac BM |
218 | #define ACPI_ROOT_ORIGIN_UNKNOWN (0) /* ~ORIGIN_ALLOCATED */ |
219 | #define ACPI_ROOT_ORIGIN_ALLOCATED (1) | |
220 | #define ACPI_ROOT_ALLOW_RESIZE (2) | |
f3d2e786 | 221 | |
2ba7379b BM |
222 | /* List to manage incoming ACPI tables */ |
223 | ||
224 | struct acpi_new_table_desc { | |
225 | struct acpi_table_header *table; | |
226 | struct acpi_new_table_desc *next; | |
227 | }; | |
228 | ||
8ec3f459 | 229 | /* Predefined table indexes */ |
f3d2e786 | 230 | |
8ec3f459 | 231 | #define ACPI_INVALID_TABLE_INDEX (0xFFFFFFFF) |
f3d2e786 | 232 | |
4be44fcd LB |
233 | struct acpi_find_context { |
234 | char *search_for; | |
235 | acpi_handle *list; | |
236 | u32 *count; | |
1da177e4 LT |
237 | }; |
238 | ||
4be44fcd LB |
239 | struct acpi_ns_search_data { |
240 | struct acpi_namespace_node *node; | |
1da177e4 LT |
241 | }; |
242 | ||
1da177e4 LT |
243 | /* Object types used during package copies */ |
244 | ||
1da177e4 LT |
245 | #define ACPI_COPY_TYPE_SIMPLE 0 |
246 | #define ACPI_COPY_TYPE_PACKAGE 1 | |
247 | ||
248 | /* Info structure used to convert external<->internal namestrings */ | |
249 | ||
4be44fcd | 250 | struct acpi_namestring_info { |
4b8ed631 BM |
251 | const char *external_name; |
252 | const char *next_external_char; | |
4be44fcd LB |
253 | char *internal_name; |
254 | u32 length; | |
255 | u32 num_segments; | |
256 | u32 num_carats; | |
257 | u8 fully_qualified; | |
1da177e4 LT |
258 | }; |
259 | ||
1da177e4 LT |
260 | /* Field creation info */ |
261 | ||
4be44fcd LB |
262 | struct acpi_create_field_info { |
263 | struct acpi_namespace_node *region_node; | |
264 | struct acpi_namespace_node *field_node; | |
265 | struct acpi_namespace_node *register_node; | |
266 | struct acpi_namespace_node *data_register_node; | |
9ce81784 BM |
267 | struct acpi_namespace_node *connection_node; |
268 | u8 *resource_buffer; | |
4be44fcd LB |
269 | u32 bank_value; |
270 | u32 field_bit_position; | |
271 | u32 field_bit_length; | |
9ce81784 | 272 | u16 resource_length; |
75ec6e55 | 273 | u16 pin_number_index; |
4be44fcd LB |
274 | u8 field_flags; |
275 | u8 attribute; | |
276 | u8 field_type; | |
9ce81784 | 277 | u8 access_length; |
1da177e4 LT |
278 | }; |
279 | ||
61686124 | 280 | typedef |
f5c1e1c5 | 281 | acpi_status (*acpi_internal_method) (struct acpi_walk_state * walk_state); |
61686124 | 282 | |
defba1d8 | 283 | /* |
73a3090a | 284 | * Bitmapped ACPI types. Used internally only |
defba1d8 BM |
285 | */ |
286 | #define ACPI_BTYPE_ANY 0x00000000 | |
287 | #define ACPI_BTYPE_INTEGER 0x00000001 | |
288 | #define ACPI_BTYPE_STRING 0x00000002 | |
289 | #define ACPI_BTYPE_BUFFER 0x00000004 | |
290 | #define ACPI_BTYPE_PACKAGE 0x00000008 | |
291 | #define ACPI_BTYPE_FIELD_UNIT 0x00000010 | |
292 | #define ACPI_BTYPE_DEVICE 0x00000020 | |
293 | #define ACPI_BTYPE_EVENT 0x00000040 | |
294 | #define ACPI_BTYPE_METHOD 0x00000080 | |
295 | #define ACPI_BTYPE_MUTEX 0x00000100 | |
296 | #define ACPI_BTYPE_REGION 0x00000200 | |
297 | #define ACPI_BTYPE_POWER 0x00000400 | |
298 | #define ACPI_BTYPE_PROCESSOR 0x00000800 | |
299 | #define ACPI_BTYPE_THERMAL 0x00001000 | |
300 | #define ACPI_BTYPE_BUFFER_FIELD 0x00002000 | |
301 | #define ACPI_BTYPE_DDB_HANDLE 0x00004000 | |
302 | #define ACPI_BTYPE_DEBUG_OBJECT 0x00008000 | |
a5922a1f | 303 | #define ACPI_BTYPE_REFERENCE_OBJECT 0x00010000 /* From Index(), ref_of(), etc (type6_opcodes) */ |
defba1d8 | 304 | #define ACPI_BTYPE_RESOURCE 0x00020000 |
a5922a1f | 305 | #define ACPI_BTYPE_NAMED_REFERENCE 0x00040000 /* Generic unresolved Name or Namepath */ |
defba1d8 BM |
306 | |
307 | #define ACPI_BTYPE_COMPUTE_DATA (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER) | |
308 | ||
309 | #define ACPI_BTYPE_DATA (ACPI_BTYPE_COMPUTE_DATA | ACPI_BTYPE_PACKAGE) | |
a5922a1f BM |
310 | |
311 | /* Used by Copy, de_ref_of, Store, Printf, Fprintf */ | |
312 | ||
313 | #define ACPI_BTYPE_DATA_REFERENCE (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE_OBJECT | ACPI_BTYPE_DDB_HANDLE) | |
defba1d8 BM |
314 | #define ACPI_BTYPE_DEVICE_OBJECTS (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR) |
315 | #define ACPI_BTYPE_OBJECTS_AND_REFS 0x0001FFFF /* ARG or LOCAL */ | |
316 | #define ACPI_BTYPE_ALL_OBJECTS 0x0000FFFF | |
317 | ||
c34c82bc BM |
318 | #pragma pack(1) |
319 | ||
e8707b34 BM |
320 | /* |
321 | * Information structure for ACPI predefined names. | |
322 | * Each entry in the table contains the following items: | |
323 | * | |
ba494bee | 324 | * name - The ACPI reserved name |
e8707b34 BM |
325 | * param_count - Number of arguments to the method |
326 | * expected_return_btypes - Allowed type(s) for the return value | |
327 | */ | |
328 | struct acpi_name_info { | |
329 | char name[ACPI_NAME_SIZE]; | |
c34c82bc | 330 | u16 argument_list; |
e8707b34 BM |
331 | u8 expected_btypes; |
332 | }; | |
333 | ||
334 | /* | |
335 | * Secondary information structures for ACPI predefined objects that return | |
336 | * package objects. This structure appears as the next entry in the table | |
337 | * after the NAME_INFO structure above. | |
338 | * | |
339 | * The reason for this is to minimize the size of the predefined name table. | |
340 | */ | |
341 | ||
342 | /* | |
343 | * Used for ACPI_PTYPE1_FIXED, ACPI_PTYPE1_VAR, ACPI_PTYPE2, | |
7fce7a4b BM |
344 | * ACPI_PTYPE2_MIN, ACPI_PTYPE2_PKG_COUNT, ACPI_PTYPE2_COUNT, |
345 | * ACPI_PTYPE2_FIX_VAR | |
e8707b34 BM |
346 | */ |
347 | struct acpi_package_info { | |
348 | u8 type; | |
349 | u8 object_type1; | |
350 | u8 count1; | |
351 | u8 object_type2; | |
352 | u8 count2; | |
c34c82bc | 353 | u16 reserved; |
e8707b34 BM |
354 | }; |
355 | ||
356 | /* Used for ACPI_PTYPE2_FIXED */ | |
357 | ||
358 | struct acpi_package_info2 { | |
359 | u8 type; | |
360 | u8 count; | |
361 | u8 object_type[4]; | |
c34c82bc | 362 | u8 reserved; |
e8707b34 BM |
363 | }; |
364 | ||
365 | /* Used for ACPI_PTYPE1_OPTION */ | |
366 | ||
367 | struct acpi_package_info3 { | |
368 | u8 type; | |
369 | u8 count; | |
370 | u8 object_type[2]; | |
371 | u8 tail_object_type; | |
c34c82bc | 372 | u16 reserved; |
e8707b34 BM |
373 | }; |
374 | ||
e34a7813 BM |
375 | struct acpi_package_info4 { |
376 | u8 type; | |
377 | u8 object_type1; | |
378 | u8 count1; | |
379 | u8 sub_object_types; | |
380 | u8 pkg_count; | |
381 | u16 reserved; | |
382 | }; | |
383 | ||
e8707b34 BM |
384 | union acpi_predefined_info { |
385 | struct acpi_name_info info; | |
386 | struct acpi_package_info ret_info; | |
387 | struct acpi_package_info2 ret_info2; | |
388 | struct acpi_package_info3 ret_info3; | |
e34a7813 | 389 | struct acpi_package_info4 ret_info4; |
e8707b34 BM |
390 | }; |
391 | ||
c34c82bc BM |
392 | /* Reset to default packing */ |
393 | ||
394 | #pragma pack() | |
395 | ||
d5a36100 BM |
396 | /* Return object auto-repair info */ |
397 | ||
f5c1e1c5 LZ |
398 | typedef acpi_status (*acpi_object_converter) (struct acpi_namespace_node * |
399 | scope, | |
400 | union acpi_operand_object * | |
401 | original_object, | |
402 | union acpi_operand_object ** | |
403 | converted_object); | |
d5a36100 BM |
404 | |
405 | struct acpi_simple_repair_info { | |
406 | char name[ACPI_NAME_SIZE]; | |
407 | u32 unexpected_btypes; | |
408 | u32 package_index; | |
409 | acpi_object_converter object_converter; | |
410 | }; | |
411 | ||
e8707b34 BM |
412 | /* |
413 | * Bitmapped return value types | |
414 | * Note: the actual data types must be contiguous, a loop in nspredef.c | |
415 | * depends on this. | |
416 | */ | |
417 | #define ACPI_RTYPE_ANY 0x00 | |
418 | #define ACPI_RTYPE_NONE 0x01 | |
419 | #define ACPI_RTYPE_INTEGER 0x02 | |
420 | #define ACPI_RTYPE_STRING 0x04 | |
421 | #define ACPI_RTYPE_BUFFER 0x08 | |
422 | #define ACPI_RTYPE_PACKAGE 0x10 | |
423 | #define ACPI_RTYPE_REFERENCE 0x20 | |
424 | #define ACPI_RTYPE_ALL 0x3F | |
425 | ||
426 | #define ACPI_NUM_RTYPES 5 /* Number of actual object types */ | |
427 | ||
25823e78 BM |
428 | /* Info for running the _REG methods */ |
429 | ||
430 | struct acpi_reg_walk_info { | |
431 | acpi_adr_space_type space_id; | |
d815346f | 432 | u32 function; |
25823e78 BM |
433 | u32 reg_run_count; |
434 | }; | |
435 | ||
1da177e4 LT |
436 | /***************************************************************************** |
437 | * | |
438 | * Event typedefs and structs | |
439 | * | |
440 | ****************************************************************************/ | |
441 | ||
a2fd4b4b LZ |
442 | /* Dispatch info for each host-installed SCI handler */ |
443 | ||
444 | struct acpi_sci_handler_info { | |
445 | struct acpi_sci_handler_info *next; | |
446 | acpi_sci_handler address; /* Address of handler */ | |
447 | void *context; /* Context to be passed to handler */ | |
448 | }; | |
449 | ||
1da177e4 LT |
450 | /* Dispatch info for each GPE -- either a method or handler, cannot be both */ |
451 | ||
8b6cd8ad LM |
452 | struct acpi_gpe_handler_info { |
453 | acpi_gpe_handler address; /* Address of handler, if any */ | |
4be44fcd LB |
454 | void *context; /* Context to be passed to handler */ |
455 | struct acpi_namespace_node *method_node; /* Method node for this GPE level (saved) */ | |
f19f1a7e LZ |
456 | u8 original_flags; /* Original (pre-handler) GPE info */ |
457 | u8 originally_enabled; /* True if GPE was originally enabled */ | |
1da177e4 LT |
458 | }; |
459 | ||
5816b343 BM |
460 | /* Notify info for implicit notify, multiple device objects */ |
461 | ||
462 | struct acpi_gpe_notify_info { | |
463 | struct acpi_namespace_node *device_node; /* Device to be notified */ | |
464 | struct acpi_gpe_notify_info *next; | |
465 | }; | |
466 | ||
75c8044f LZ |
467 | /* |
468 | * GPE dispatch info. At any time, the GPE can have at most one type | |
469 | * of dispatch - Method, Handler, or Implicit Notify. | |
470 | */ | |
4be44fcd LB |
471 | union acpi_gpe_dispatch_info { |
472 | struct acpi_namespace_node *method_node; /* Method node for this GPE level */ | |
8b6cd8ad | 473 | struct acpi_gpe_handler_info *handler; /* Installed GPE handler */ |
5816b343 | 474 | struct acpi_gpe_notify_info *notify_list; /* List of _PRW devices for implicit notifies */ |
1da177e4 LT |
475 | }; |
476 | ||
477 | /* | |
478 | * Information about a GPE, one per each GPE in an array. | |
479 | * NOTE: Important to keep this struct as small as possible. | |
480 | */ | |
4be44fcd | 481 | struct acpi_gpe_event_info { |
5816b343 | 482 | union acpi_gpe_dispatch_info dispatch; /* Either Method, Handler, or notify_list */ |
4be44fcd LB |
483 | struct acpi_gpe_register_info *register_info; /* Backpointer to register info */ |
484 | u8 flags; /* Misc info about this GPE */ | |
69874165 | 485 | u8 gpe_number; /* This GPE */ |
0f849d2c | 486 | u8 runtime_count; /* References to a run GPE */ |
2af52c2b | 487 | u8 disable_for_dispatch; /* Masked during dispatching */ |
1da177e4 LT |
488 | }; |
489 | ||
490 | /* Information about a GPE register pair, one per each status/enable pair in an array */ | |
491 | ||
4be44fcd LB |
492 | struct acpi_gpe_register_info { |
493 | struct acpi_generic_address status_address; /* Address of status reg */ | |
494 | struct acpi_generic_address enable_address; /* Address of enable reg */ | |
7505da4c | 495 | u16 base_gpe_number; /* Base GPE number for this register */ |
4be44fcd LB |
496 | u8 enable_for_wake; /* GPEs to keep enabled when sleeping */ |
497 | u8 enable_for_run; /* GPEs to keep enabled when running */ | |
2af52c2b | 498 | u8 mask_for_run; /* GPEs to keep masked when running */ |
c50f13c6 | 499 | u8 enable_mask; /* Current mask of enabled GPEs */ |
1da177e4 LT |
500 | }; |
501 | ||
502 | /* | |
503 | * Information about a GPE register block, one per each installed block -- | |
504 | * GPE0, GPE1, and one per each installed GPE Block Device. | |
505 | */ | |
4be44fcd LB |
506 | struct acpi_gpe_block_info { |
507 | struct acpi_namespace_node *node; | |
508 | struct acpi_gpe_block_info *previous; | |
509 | struct acpi_gpe_block_info *next; | |
510 | struct acpi_gpe_xrupt_info *xrupt_block; /* Backpointer to interrupt block */ | |
511 | struct acpi_gpe_register_info *register_info; /* One per GPE register pair */ | |
512 | struct acpi_gpe_event_info *event_info; /* One for each GPE */ | |
7505da4c | 513 | u64 address; /* Base address of the block */ |
4be44fcd | 514 | u32 register_count; /* Number of register pairs in block */ |
0f849d2c | 515 | u16 gpe_count; /* Number of individual GPEs in block */ |
7505da4c BM |
516 | u16 block_base_number; /* Base GPE number for this block */ |
517 | u8 space_id; | |
518 | u8 initialized; /* TRUE if this block is initialized */ | |
1da177e4 LT |
519 | }; |
520 | ||
521 | /* Information about GPE interrupt handlers, one per each interrupt level used for GPEs */ | |
522 | ||
4be44fcd LB |
523 | struct acpi_gpe_xrupt_info { |
524 | struct acpi_gpe_xrupt_info *previous; | |
525 | struct acpi_gpe_xrupt_info *next; | |
526 | struct acpi_gpe_block_info *gpe_block_list_head; /* List of GPE blocks for this xrupt */ | |
527 | u32 interrupt_number; /* System interrupt number */ | |
1da177e4 LT |
528 | }; |
529 | ||
4be44fcd LB |
530 | struct acpi_gpe_walk_info { |
531 | struct acpi_namespace_node *gpe_device; | |
532 | struct acpi_gpe_block_info *gpe_block; | |
186c307f BM |
533 | u16 count; |
534 | acpi_owner_id owner_id; | |
186c307f | 535 | u8 execute_by_owner_id; |
1da177e4 LT |
536 | }; |
537 | ||
e97d6bf1 BM |
538 | struct acpi_gpe_device_info { |
539 | u32 index; | |
540 | u32 next_block_base_index; | |
541 | acpi_status status; | |
542 | struct acpi_namespace_node *gpe_device; | |
543 | }; | |
544 | ||
f5c1e1c5 LZ |
545 | typedef acpi_status (*acpi_gpe_callback) (struct acpi_gpe_xrupt_info * |
546 | gpe_xrupt_info, | |
547 | struct acpi_gpe_block_info * | |
548 | gpe_block, void *context); | |
1da177e4 LT |
549 | |
550 | /* Information about each particular fixed event */ | |
551 | ||
4be44fcd LB |
552 | struct acpi_fixed_event_handler { |
553 | acpi_event_handler handler; /* Address of handler. */ | |
554 | void *context; /* Context to be passed to handler */ | |
1da177e4 LT |
555 | }; |
556 | ||
4be44fcd LB |
557 | struct acpi_fixed_event_info { |
558 | u8 status_register_id; | |
559 | u8 enable_register_id; | |
560 | u16 status_bit_mask; | |
561 | u16 enable_bit_mask; | |
1da177e4 LT |
562 | }; |
563 | ||
564 | /* Information used during field processing */ | |
565 | ||
4be44fcd LB |
566 | struct acpi_field_info { |
567 | u8 skip_field; | |
568 | u8 field_flag; | |
569 | u32 pkg_length; | |
1da177e4 LT |
570 | }; |
571 | ||
1da177e4 LT |
572 | /***************************************************************************** |
573 | * | |
574 | * Generic "state" object for stacks | |
575 | * | |
576 | ****************************************************************************/ | |
577 | ||
1da177e4 LT |
578 | #define ACPI_CONTROL_NORMAL 0xC0 |
579 | #define ACPI_CONTROL_CONDITIONAL_EXECUTING 0xC1 | |
580 | #define ACPI_CONTROL_PREDICATE_EXECUTING 0xC2 | |
581 | #define ACPI_CONTROL_PREDICATE_FALSE 0xC3 | |
582 | #define ACPI_CONTROL_PREDICATE_TRUE 0xC4 | |
583 | ||
61686124 BM |
584 | #define ACPI_STATE_COMMON \ |
585 | void *next; \ | |
586 | u8 descriptor_type; /* To differentiate various internal objs */\ | |
587 | u8 flags; \ | |
588 | u16 value; \ | |
589 | u16 state; | |
590 | ||
591 | /* There are 2 bytes available here until the next natural alignment boundary */ | |
1da177e4 | 592 | |
4be44fcd LB |
593 | struct acpi_common_state { |
594 | ACPI_STATE_COMMON}; | |
1da177e4 LT |
595 | |
596 | /* | |
597 | * Update state - used to traverse complex objects such as packages | |
598 | */ | |
4be44fcd LB |
599 | struct acpi_update_state { |
600 | ACPI_STATE_COMMON union acpi_operand_object *object; | |
1da177e4 LT |
601 | }; |
602 | ||
1da177e4 LT |
603 | /* |
604 | * Pkg state - used to traverse nested package structures | |
605 | */ | |
4be44fcd | 606 | struct acpi_pkg_state { |
61686124 BM |
607 | ACPI_STATE_COMMON u16 index; |
608 | union acpi_operand_object *source_object; | |
4be44fcd LB |
609 | union acpi_operand_object *dest_object; |
610 | struct acpi_walk_state *walk_state; | |
611 | void *this_target_obj; | |
612 | u32 num_packages; | |
1da177e4 LT |
613 | }; |
614 | ||
1da177e4 LT |
615 | /* |
616 | * Control state - one per if/else and while constructs. | |
617 | * Allows nesting of these constructs | |
618 | */ | |
4be44fcd | 619 | struct acpi_control_state { |
61686124 BM |
620 | ACPI_STATE_COMMON u16 opcode; |
621 | union acpi_parse_object *predicate_op; | |
4be44fcd LB |
622 | u8 *aml_predicate_start; /* Start of if/while predicate */ |
623 | u8 *package_end; /* End of if/while block */ | |
fc374457 | 624 | u32 loop_count; /* While() loop counter */ |
1da177e4 LT |
625 | }; |
626 | ||
1da177e4 LT |
627 | /* |
628 | * Scope state - current scope during namespace lookups | |
629 | */ | |
4be44fcd LB |
630 | struct acpi_scope_state { |
631 | ACPI_STATE_COMMON struct acpi_namespace_node *node; | |
1da177e4 LT |
632 | }; |
633 | ||
4be44fcd | 634 | struct acpi_pscope_state { |
793c2388 | 635 | ACPI_STATE_COMMON u32 arg_count; /* Number of fixed arguments */ |
61686124 | 636 | union acpi_parse_object *op; /* Current op being parsed */ |
4be44fcd LB |
637 | u8 *arg_end; /* Current argument end */ |
638 | u8 *pkg_end; /* Current package end */ | |
639 | u32 arg_list; /* Next argument to parse */ | |
1da177e4 LT |
640 | }; |
641 | ||
1da177e4 | 642 | /* |
73a3090a | 643 | * Thread state - one per thread across multiple walk states. Multiple walk |
1da177e4 LT |
644 | * states are created when there are nested control methods executing. |
645 | */ | |
4be44fcd | 646 | struct acpi_thread_state { |
61686124 BM |
647 | ACPI_STATE_COMMON u8 current_sync_level; /* Mutex Sync (nested acquire) level */ |
648 | struct acpi_walk_state *walk_state_list; /* Head of list of walk_states for this thread */ | |
4be44fcd | 649 | union acpi_operand_object *acquired_mutex_list; /* List of all currently acquired mutexes */ |
8313524a | 650 | acpi_thread_id thread_id; /* Running thread ID */ |
1da177e4 LT |
651 | }; |
652 | ||
1da177e4 LT |
653 | /* |
654 | * Result values - used to accumulate the results of nested | |
655 | * AML arguments | |
656 | */ | |
4be44fcd | 657 | struct acpi_result_values { |
773069d4 BM |
658 | ACPI_STATE_COMMON |
659 | union acpi_operand_object *obj_desc[ACPI_RESULTS_FRAME_OBJ_NUM]; | |
1da177e4 LT |
660 | }; |
661 | ||
1da177e4 | 662 | typedef |
f5c1e1c5 LZ |
663 | acpi_status (*acpi_parse_downwards) (struct acpi_walk_state * walk_state, |
664 | union acpi_parse_object ** out_op); | |
1da177e4 | 665 | |
f5c1e1c5 LZ |
666 | typedef |
667 | acpi_status (*acpi_parse_upwards) (struct acpi_walk_state * walk_state); | |
1da177e4 | 668 | |
86ed4bc8 BM |
669 | /* Global handlers for AML Notifies */ |
670 | ||
671 | struct acpi_global_notify_handler { | |
672 | acpi_notify_handler handler; | |
673 | void *context; | |
674 | }; | |
675 | ||
1da177e4 LT |
676 | /* |
677 | * Notify info - used to pass info to the deferred notify | |
678 | * handler/dispatcher. | |
679 | */ | |
4be44fcd | 680 | struct acpi_notify_info { |
86ed4bc8 BM |
681 | ACPI_STATE_COMMON u8 handler_list_id; |
682 | struct acpi_namespace_node *node; | |
683 | union acpi_operand_object *handler_list_head; | |
684 | struct acpi_global_notify_handler *global; | |
1da177e4 LT |
685 | }; |
686 | ||
1da177e4 LT |
687 | /* Generic state is union of structs above */ |
688 | ||
4be44fcd LB |
689 | union acpi_generic_state { |
690 | struct acpi_common_state common; | |
691 | struct acpi_control_state control; | |
692 | struct acpi_update_state update; | |
693 | struct acpi_scope_state scope; | |
694 | struct acpi_pscope_state parse_scope; | |
695 | struct acpi_pkg_state pkg; | |
696 | struct acpi_thread_state thread; | |
697 | struct acpi_result_values results; | |
698 | struct acpi_notify_info notify; | |
1da177e4 LT |
699 | }; |
700 | ||
1da177e4 LT |
701 | /***************************************************************************** |
702 | * | |
703 | * Interpreter typedefs and structs | |
704 | * | |
705 | ****************************************************************************/ | |
706 | ||
f5c1e1c5 LZ |
707 | typedef |
708 | acpi_status (*acpi_execute_op) (struct acpi_walk_state * walk_state); | |
1da177e4 | 709 | |
f654c0fe LM |
710 | /* Address Range info block */ |
711 | ||
712 | struct acpi_address_range { | |
713 | struct acpi_address_range *next; | |
714 | struct acpi_namespace_node *region_node; | |
715 | acpi_physical_address start_address; | |
716 | acpi_physical_address end_address; | |
717 | }; | |
718 | ||
1da177e4 LT |
719 | /***************************************************************************** |
720 | * | |
721 | * Parser typedefs and structs | |
722 | * | |
723 | ****************************************************************************/ | |
724 | ||
725 | /* | |
726 | * AML opcode, name, and argument layout | |
727 | */ | |
4be44fcd | 728 | struct acpi_opcode_info { |
1da177e4 | 729 | #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT) |
4be44fcd | 730 | char *name; /* Opcode name (disassembler/debug only) */ |
1da177e4 | 731 | #endif |
4be44fcd LB |
732 | u32 parse_args; /* Grammar/Parse time arguments */ |
733 | u32 runtime_args; /* Interpret time arguments */ | |
61686124 | 734 | u16 flags; /* Misc flags */ |
4be44fcd LB |
735 | u8 object_type; /* Corresponding internal object type */ |
736 | u8 class; /* Opcode class */ | |
737 | u8 type; /* Opcode type */ | |
1da177e4 LT |
738 | }; |
739 | ||
75c8044f | 740 | /* Value associated with the parse object */ |
3e8214e5 | 741 | |
4be44fcd | 742 | union acpi_parse_value { |
5df7e6cb | 743 | u64 integer; /* Integer constant (Up to 64 bits) */ |
4be44fcd LB |
744 | u32 size; /* bytelist or field size */ |
745 | char *string; /* NULL terminated string */ | |
746 | u8 *buffer; /* buffer or string */ | |
747 | char *name; /* NULL terminated string */ | |
748 | union acpi_parse_object *arg; /* arguments and contained ops */ | |
1da177e4 LT |
749 | }; |
750 | ||
a616dc2f | 751 | #if defined(ACPI_DISASSEMBLER) || defined(ACPI_DEBUG_OUTPUT) |
50df4d8b BM |
752 | #define ACPI_DISASM_ONLY_MEMBERS(a) a; |
753 | #else | |
754 | #define ACPI_DISASM_ONLY_MEMBERS(a) | |
755 | #endif | |
756 | ||
9cf7adec BM |
757 | #if defined(ACPI_ASL_COMPILER) |
758 | #define ACPI_CONVERTER_ONLY_MEMBERS(a) a; | |
759 | #else | |
760 | #define ACPI_CONVERTER_ONLY_MEMBERS(a) | |
761 | #endif | |
762 | ||
1da177e4 | 763 | #define ACPI_PARSE_COMMON \ |
9cf7adec BM |
764 | union acpi_parse_object *parent; /* Parent op */\ |
765 | u8 descriptor_type; /* To differentiate various internal objs */\ | |
766 | u8 flags; /* Type of Op */\ | |
767 | u16 aml_opcode; /* AML opcode */\ | |
768 | u8 *aml; /* Address of declaration in AML */\ | |
769 | union acpi_parse_object *next; /* Next op */\ | |
770 | struct acpi_namespace_node *node; /* For use by interpreter */\ | |
771 | union acpi_parse_value value; /* Value or args associated with the opcode */\ | |
772 | u8 arg_list_length; /* Number of elements in the arg list */\ | |
773 | ACPI_DISASM_ONLY_MEMBERS (\ | |
774 | u16 disasm_flags; /* Used during AML disassembly */\ | |
775 | u8 disasm_opcode; /* Subtype used for disassembly */\ | |
776 | char *operator_symbol; /* Used for C-style operator name strings */\ | |
777 | char aml_op_name[16]) /* Op name (debug only) */\ | |
778 | ACPI_CONVERTER_ONLY_MEMBERS (\ | |
779 | char *inline_comment; /* Inline comment */\ | |
780 | char *end_node_comment; /* End of node comment */\ | |
781 | char *name_comment; /* Comment associated with the first parameter of the name node */\ | |
782 | char *close_brace_comment; /* Comments that come after } on the same as } */\ | |
783 | struct acpi_comment_node *comment_list; /* comments that appears before this node */\ | |
784 | struct acpi_comment_node *end_blk_comment; /* comments that at the end of a block but before ) or } */\ | |
785 | char *cv_filename; /* Filename associated with this node. Used for ASL/ASL+ converter */\ | |
786 | char *cv_parent_filename) /* Parent filename associated with this node. Used for ASL/ASL+ converter */ | |
787 | ||
788 | /* categories of comments */ | |
789 | ||
790 | typedef enum { | |
791 | STANDARD_COMMENT = 1, | |
792 | INLINE_COMMENT, | |
793 | ENDNODE_COMMENT, | |
794 | OPENBRACE_COMMENT, | |
795 | CLOSE_BRACE_COMMENT, | |
796 | STD_DEFBLK_COMMENT, | |
797 | END_DEFBLK_COMMENT, | |
798 | FILENAME_COMMENT, | |
799 | PARENTFILENAME_COMMENT, | |
800 | ENDBLK_COMMENT, | |
801 | INCLUDE_COMMENT | |
802 | } asl_comment_types; | |
61686124 | 803 | |
a654b8ca | 804 | /* Internal opcodes for disasm_opcode field above */ |
be030a57 BM |
805 | |
806 | #define ACPI_DASM_BUFFER 0x00 /* Buffer is a simple data buffer */ | |
807 | #define ACPI_DASM_RESOURCE 0x01 /* Buffer is a Resource Descriptor */ | |
808 | #define ACPI_DASM_STRING 0x02 /* Buffer is a ASCII string */ | |
809 | #define ACPI_DASM_UNICODE 0x03 /* Buffer is a Unicode string */ | |
810 | #define ACPI_DASM_PLD_METHOD 0x04 /* Buffer is a _PLD method bit-packed buffer */ | |
90da690b BM |
811 | #define ACPI_DASM_UUID 0x05 /* Buffer is a UUID/GUID */ |
812 | #define ACPI_DASM_EISAID 0x06 /* Integer is an EISAID */ | |
813 | #define ACPI_DASM_MATCHOP 0x07 /* Parent opcode is a Match() operator */ | |
814 | #define ACPI_DASM_LNOT_PREFIX 0x08 /* Start of a Lnot_equal (etc.) pair of opcodes */ | |
815 | #define ACPI_DASM_LNOT_SUFFIX 0x09 /* End of a Lnot_equal (etc.) pair of opcodes */ | |
816 | #define ACPI_DASM_HID_STRING 0x0A /* String is a _HID or _CID */ | |
a654b8ca | 817 | #define ACPI_DASM_IGNORE_SINGLE 0x0B /* Ignore the opcode but not it's children */ |
bee900db DB |
818 | #define ACPI_DASM_SWITCH 0x0C /* While is a Switch */ |
819 | #define ACPI_DASM_SWITCH_PREDICATE 0x0D /* Object is a predicate for a Switch or Case block */ | |
820 | #define ACPI_DASM_CASE 0x0E /* If/Else is a Case in a Switch/Case block */ | |
821 | #define ACPI_DASM_DEFAULT 0x0F /* Else is a Default in a Switch/Case block */ | |
1da177e4 | 822 | |
9cf7adec BM |
823 | /* |
824 | * List struct used in the -ca option | |
825 | */ | |
826 | struct acpi_comment_node { | |
827 | char *comment; | |
828 | struct acpi_comment_node *next; | |
829 | }; | |
830 | ||
831 | struct acpi_comment_addr_node { | |
832 | u8 *addr; | |
833 | struct acpi_comment_addr_node *next; | |
834 | }; | |
835 | ||
836 | /* | |
837 | * File node - used for "Include" operator file stack and | |
838 | * depdendency tree for the -ca option | |
839 | */ | |
840 | struct acpi_file_node { | |
841 | void *file; | |
842 | char *filename; | |
843 | char *file_start; /* Points to AML and indicates when the AML for this particular file starts. */ | |
844 | char *file_end; /* Points to AML and indicates when the AML for this particular file ends. */ | |
845 | struct acpi_file_node *next; | |
846 | struct acpi_file_node *parent; | |
847 | u8 include_written; | |
848 | struct acpi_comment_node *include_comment; | |
849 | }; | |
850 | ||
1da177e4 | 851 | /* |
61686124 | 852 | * Generic operation (for example: If, While, Store) |
1da177e4 | 853 | */ |
4be44fcd LB |
854 | struct acpi_parse_obj_common { |
855 | ACPI_PARSE_COMMON}; | |
1da177e4 LT |
856 | |
857 | /* | |
858 | * Extended Op for named ops (Scope, Method, etc.), deferred ops (Methods and op_regions), | |
859 | * and bytelists. | |
860 | */ | |
4be44fcd | 861 | struct acpi_parse_obj_named { |
05c3507c | 862 | ACPI_PARSE_COMMON char *path; |
4be44fcd LB |
863 | u8 *data; /* AML body or bytelist data */ |
864 | u32 length; /* AML length */ | |
865 | u32 name; /* 4-byte name or zero if no name */ | |
1da177e4 LT |
866 | }; |
867 | ||
ba494bee | 868 | /* This version is used by the iASL compiler only */ |
1da177e4 | 869 | |
c51a4de8 BM |
870 | #define ACPI_MAX_PARSEOP_NAME 20 |
871 | ||
4be44fcd LB |
872 | struct acpi_parse_obj_asl { |
873 | ACPI_PARSE_COMMON union acpi_parse_object *child; | |
874 | union acpi_parse_object *parent_method; | |
875 | char *filename; | |
9cf7adec BM |
876 | u8 file_changed; |
877 | char *parent_filename; | |
4be44fcd LB |
878 | char *external_name; |
879 | char *namepath; | |
880 | char name_seg[4]; | |
881 | u32 extra_value; | |
882 | u32 column; | |
883 | u32 line_number; | |
884 | u32 logical_line_number; | |
885 | u32 logical_byte_offset; | |
886 | u32 end_line; | |
887 | u32 end_logical_line; | |
888 | u32 acpi_btype; | |
889 | u32 aml_length; | |
890 | u32 aml_subtree_length; | |
891 | u32 final_aml_length; | |
892 | u32 final_aml_offset; | |
893 | u32 compile_flags; | |
894 | u16 parse_opcode; | |
895 | u8 aml_opcode_length; | |
896 | u8 aml_pkg_len_bytes; | |
897 | u8 extra; | |
c51a4de8 | 898 | char parse_op_name[ACPI_MAX_PARSEOP_NAME]; |
4be44fcd LB |
899 | }; |
900 | ||
901 | union acpi_parse_object { | |
902 | struct acpi_parse_obj_common common; | |
903 | struct acpi_parse_obj_named named; | |
904 | struct acpi_parse_obj_asl asl; | |
1da177e4 LT |
905 | }; |
906 | ||
9cf7adec BM |
907 | struct asl_comment_state { |
908 | u8 comment_type; | |
909 | u32 spaces_before; | |
910 | union acpi_parse_object *latest_parse_node; | |
911 | union acpi_parse_object *parsing_paren_brace_node; | |
912 | u8 capture_comments; | |
913 | }; | |
914 | ||
1da177e4 LT |
915 | /* |
916 | * Parse state - one state per parser invocation and each control | |
917 | * method. | |
918 | */ | |
4be44fcd | 919 | struct acpi_parse_state { |
4be44fcd LB |
920 | u8 *aml_start; /* First AML byte */ |
921 | u8 *aml; /* Next AML byte */ | |
922 | u8 *aml_end; /* (last + 1) AML byte */ | |
923 | u8 *pkg_start; /* Current package begin */ | |
924 | u8 *pkg_end; /* Current package end */ | |
925 | union acpi_parse_object *start_op; /* Root of parse tree */ | |
926 | struct acpi_namespace_node *start_node; | |
927 | union acpi_generic_state *scope; /* Current scope */ | |
928 | union acpi_parse_object *start_scope; | |
61686124 | 929 | u32 aml_size; |
1da177e4 LT |
930 | }; |
931 | ||
1da177e4 LT |
932 | /* Parse object flags */ |
933 | ||
5391abfd BM |
934 | #define ACPI_PARSEOP_GENERIC 0x01 |
935 | #define ACPI_PARSEOP_NAMED_OBJECT 0x02 | |
936 | #define ACPI_PARSEOP_DEFERRED 0x04 | |
937 | #define ACPI_PARSEOP_BYTELIST 0x08 | |
938 | #define ACPI_PARSEOP_IN_STACK 0x10 | |
939 | #define ACPI_PARSEOP_TARGET 0x20 | |
940 | #define ACPI_PARSEOP_IN_CACHE 0x80 | |
1da177e4 LT |
941 | |
942 | /* Parse object disasm_flags */ | |
943 | ||
a335e955 BM |
944 | #define ACPI_PARSEOP_IGNORE 0x0001 |
945 | #define ACPI_PARSEOP_PARAMETER_LIST 0x0002 | |
946 | #define ACPI_PARSEOP_EMPTY_TERMLIST 0x0004 | |
947 | #define ACPI_PARSEOP_PREDEFINED_CHECKED 0x0008 | |
948 | #define ACPI_PARSEOP_CLOSING_PAREN 0x0010 | |
949 | #define ACPI_PARSEOP_COMPOUND_ASSIGNMENT 0x0020 | |
950 | #define ACPI_PARSEOP_ASSIGNMENT 0x0040 | |
951 | #define ACPI_PARSEOP_ELSEIF 0x0080 | |
952 | #define ACPI_PARSEOP_LEGACY_ASL_ONLY 0x0100 | |
1da177e4 | 953 | |
1da177e4 LT |
954 | /***************************************************************************** |
955 | * | |
956 | * Hardware (ACPI registers) and PNP | |
957 | * | |
958 | ****************************************************************************/ | |
959 | ||
4be44fcd LB |
960 | struct acpi_bit_register_info { |
961 | u8 parent_register; | |
962 | u8 bit_position; | |
963 | u16 access_bit_mask; | |
1da177e4 LT |
964 | }; |
965 | ||
967440e3 BM |
966 | /* |
967 | * Some ACPI registers have bits that must be ignored -- meaning that they | |
968 | * must be preserved. | |
969 | */ | |
970 | #define ACPI_PM1_STATUS_PRESERVED_BITS 0x0800 /* Bit 11 */ | |
20869dcf | 971 | |
c3dd25f4 LM |
972 | /* Write-only bits must be zeroed by software */ |
973 | ||
974 | #define ACPI_PM1_CONTROL_WRITEONLY_BITS 0x2004 /* Bits 13, 2 */ | |
975 | ||
20869dcf BM |
976 | /* For control registers, both ignored and reserved bits must be preserved */ |
977 | ||
975b3c47 | 978 | /* |
b1cd843b BM |
979 | * For PM1 control, the SCI enable bit (bit 0, SCI_EN) is defined by the |
980 | * ACPI specification to be a "preserved" bit - "OSPM always preserves this | |
981 | * bit position", section 4.7.3.2.1. However, on some machines the OS must | |
982 | * write a one to this bit after resume for the machine to work properly. | |
983 | * To enable this, we no longer attempt to preserve this bit. No machines | |
984 | * are known to fail if the bit is not preserved. (May 2009) | |
975b3c47 | 985 | */ |
b1cd843b | 986 | #define ACPI_PM1_CONTROL_IGNORED_BITS 0x0200 /* Bit 9 */ |
20869dcf BM |
987 | #define ACPI_PM1_CONTROL_RESERVED_BITS 0xC1F8 /* Bits 14-15, 3-8 */ |
988 | #define ACPI_PM1_CONTROL_PRESERVED_BITS \ | |
989 | (ACPI_PM1_CONTROL_IGNORED_BITS | ACPI_PM1_CONTROL_RESERVED_BITS) | |
990 | ||
991 | #define ACPI_PM2_CONTROL_PRESERVED_BITS 0xFFFFFFFE /* All except bit 0 */ | |
967440e3 | 992 | |
1da177e4 LT |
993 | /* |
994 | * Register IDs | |
995 | * These are the full ACPI registers | |
996 | */ | |
997 | #define ACPI_REGISTER_PM1_STATUS 0x01 | |
998 | #define ACPI_REGISTER_PM1_ENABLE 0x02 | |
999 | #define ACPI_REGISTER_PM1_CONTROL 0x03 | |
32c9ef99 BM |
1000 | #define ACPI_REGISTER_PM2_CONTROL 0x04 |
1001 | #define ACPI_REGISTER_PM_TIMER 0x05 | |
1002 | #define ACPI_REGISTER_PROCESSOR_BLOCK 0x06 | |
1003 | #define ACPI_REGISTER_SMI_COMMAND_BLOCK 0x07 | |
1da177e4 | 1004 | |
1da177e4 LT |
1005 | /* Masks used to access the bit_registers */ |
1006 | ||
1007 | #define ACPI_BITMASK_TIMER_STATUS 0x0001 | |
1008 | #define ACPI_BITMASK_BUS_MASTER_STATUS 0x0010 | |
1009 | #define ACPI_BITMASK_GLOBAL_LOCK_STATUS 0x0020 | |
1010 | #define ACPI_BITMASK_POWER_BUTTON_STATUS 0x0100 | |
1011 | #define ACPI_BITMASK_SLEEP_BUTTON_STATUS 0x0200 | |
1012 | #define ACPI_BITMASK_RT_CLOCK_STATUS 0x0400 | |
4be44fcd | 1013 | #define ACPI_BITMASK_PCIEXP_WAKE_STATUS 0x4000 /* ACPI 3.0 */ |
1da177e4 LT |
1014 | #define ACPI_BITMASK_WAKE_STATUS 0x8000 |
1015 | ||
61686124 BM |
1016 | #define ACPI_BITMASK_ALL_FIXED_STATUS (\ |
1017 | ACPI_BITMASK_TIMER_STATUS | \ | |
1018 | ACPI_BITMASK_BUS_MASTER_STATUS | \ | |
1019 | ACPI_BITMASK_GLOBAL_LOCK_STATUS | \ | |
1020 | ACPI_BITMASK_POWER_BUTTON_STATUS | \ | |
1021 | ACPI_BITMASK_SLEEP_BUTTON_STATUS | \ | |
1022 | ACPI_BITMASK_RT_CLOCK_STATUS | \ | |
49b3c1e0 | 1023 | ACPI_BITMASK_PCIEXP_WAKE_STATUS | \ |
61686124 | 1024 | ACPI_BITMASK_WAKE_STATUS) |
1da177e4 LT |
1025 | |
1026 | #define ACPI_BITMASK_TIMER_ENABLE 0x0001 | |
1027 | #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE 0x0020 | |
1028 | #define ACPI_BITMASK_POWER_BUTTON_ENABLE 0x0100 | |
1029 | #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE 0x0200 | |
1030 | #define ACPI_BITMASK_RT_CLOCK_ENABLE 0x0400 | |
4be44fcd | 1031 | #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE 0x4000 /* ACPI 3.0 */ |
1da177e4 LT |
1032 | |
1033 | #define ACPI_BITMASK_SCI_ENABLE 0x0001 | |
1034 | #define ACPI_BITMASK_BUS_MASTER_RLD 0x0002 | |
1035 | #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE 0x0004 | |
82d79b86 | 1036 | #define ACPI_BITMASK_SLEEP_TYPE 0x1C00 |
1da177e4 LT |
1037 | #define ACPI_BITMASK_SLEEP_ENABLE 0x2000 |
1038 | ||
1039 | #define ACPI_BITMASK_ARB_DISABLE 0x0001 | |
1040 | ||
1da177e4 LT |
1041 | /* Raw bit position of each bit_register */ |
1042 | ||
1043 | #define ACPI_BITPOSITION_TIMER_STATUS 0x00 | |
1044 | #define ACPI_BITPOSITION_BUS_MASTER_STATUS 0x04 | |
1045 | #define ACPI_BITPOSITION_GLOBAL_LOCK_STATUS 0x05 | |
1046 | #define ACPI_BITPOSITION_POWER_BUTTON_STATUS 0x08 | |
1047 | #define ACPI_BITPOSITION_SLEEP_BUTTON_STATUS 0x09 | |
1048 | #define ACPI_BITPOSITION_RT_CLOCK_STATUS 0x0A | |
4be44fcd | 1049 | #define ACPI_BITPOSITION_PCIEXP_WAKE_STATUS 0x0E /* ACPI 3.0 */ |
1da177e4 LT |
1050 | #define ACPI_BITPOSITION_WAKE_STATUS 0x0F |
1051 | ||
1052 | #define ACPI_BITPOSITION_TIMER_ENABLE 0x00 | |
1053 | #define ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE 0x05 | |
1054 | #define ACPI_BITPOSITION_POWER_BUTTON_ENABLE 0x08 | |
1055 | #define ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE 0x09 | |
1056 | #define ACPI_BITPOSITION_RT_CLOCK_ENABLE 0x0A | |
4be44fcd | 1057 | #define ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE 0x0E /* ACPI 3.0 */ |
1da177e4 LT |
1058 | |
1059 | #define ACPI_BITPOSITION_SCI_ENABLE 0x00 | |
1060 | #define ACPI_BITPOSITION_BUS_MASTER_RLD 0x01 | |
1061 | #define ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE 0x02 | |
82d79b86 | 1062 | #define ACPI_BITPOSITION_SLEEP_TYPE 0x0A |
1da177e4 LT |
1063 | #define ACPI_BITPOSITION_SLEEP_ENABLE 0x0D |
1064 | ||
1065 | #define ACPI_BITPOSITION_ARB_DISABLE 0x00 | |
1066 | ||
7f071903 BM |
1067 | /* Structs and definitions for _OSI support and I/O port validation */ |
1068 | ||
7f071903 BM |
1069 | #define ACPI_ALWAYS_ILLEGAL 0x00 |
1070 | ||
1071 | struct acpi_interface_info { | |
1072 | char *name; | |
b0ed7a91 LM |
1073 | struct acpi_interface_info *next; |
1074 | u8 flags; | |
7f071903 BM |
1075 | u8 value; |
1076 | }; | |
1077 | ||
b0ed7a91 LM |
1078 | #define ACPI_OSI_INVALID 0x01 |
1079 | #define ACPI_OSI_DYNAMIC 0x02 | |
2cf9f5bc LZ |
1080 | #define ACPI_OSI_FEATURE 0x04 |
1081 | #define ACPI_OSI_DEFAULT_INVALID 0x08 | |
1082 | #define ACPI_OSI_OPTIONAL_FEATURE (ACPI_OSI_FEATURE | ACPI_OSI_DEFAULT_INVALID | ACPI_OSI_INVALID) | |
b0ed7a91 | 1083 | |
7f071903 BM |
1084 | struct acpi_port_info { |
1085 | char *name; | |
1086 | u16 start; | |
1087 | u16 end; | |
1088 | u8 osi_dependency; | |
1089 | }; | |
1090 | ||
1da177e4 LT |
1091 | /***************************************************************************** |
1092 | * | |
1093 | * Resource descriptors | |
1094 | * | |
1095 | ****************************************************************************/ | |
1096 | ||
1da177e4 LT |
1097 | /* resource_type values */ |
1098 | ||
50eca3eb BM |
1099 | #define ACPI_ADDRESS_TYPE_MEMORY_RANGE 0 |
1100 | #define ACPI_ADDRESS_TYPE_IO_RANGE 1 | |
1101 | #define ACPI_ADDRESS_TYPE_BUS_NUMBER_RANGE 2 | |
1da177e4 LT |
1102 | |
1103 | /* Resource descriptor types and masks */ | |
1104 | ||
50eca3eb BM |
1105 | #define ACPI_RESOURCE_NAME_LARGE 0x80 |
1106 | #define ACPI_RESOURCE_NAME_SMALL 0x00 | |
1da177e4 | 1107 | |
50eca3eb BM |
1108 | #define ACPI_RESOURCE_NAME_SMALL_MASK 0x78 /* Bits 6:3 contain the type */ |
1109 | #define ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK 0x07 /* Bits 2:0 contain the length */ | |
1110 | #define ACPI_RESOURCE_NAME_LARGE_MASK 0x7F /* Bits 6:0 contain the type */ | |
1da177e4 LT |
1111 | |
1112 | /* | |
50eca3eb | 1113 | * Small resource descriptor "names" as defined by the ACPI specification. |
bda663d3 | 1114 | * Note: Bits 2:0 are used for the descriptor length |
1da177e4 | 1115 | */ |
50eca3eb BM |
1116 | #define ACPI_RESOURCE_NAME_IRQ 0x20 |
1117 | #define ACPI_RESOURCE_NAME_DMA 0x28 | |
1118 | #define ACPI_RESOURCE_NAME_START_DEPENDENT 0x30 | |
1119 | #define ACPI_RESOURCE_NAME_END_DEPENDENT 0x38 | |
1120 | #define ACPI_RESOURCE_NAME_IO 0x40 | |
1121 | #define ACPI_RESOURCE_NAME_FIXED_IO 0x48 | |
e0fe0a8d | 1122 | #define ACPI_RESOURCE_NAME_FIXED_DMA 0x50 |
50eca3eb BM |
1123 | #define ACPI_RESOURCE_NAME_RESERVED_S2 0x58 |
1124 | #define ACPI_RESOURCE_NAME_RESERVED_S3 0x60 | |
1125 | #define ACPI_RESOURCE_NAME_RESERVED_S4 0x68 | |
1126 | #define ACPI_RESOURCE_NAME_VENDOR_SMALL 0x70 | |
1127 | #define ACPI_RESOURCE_NAME_END_TAG 0x78 | |
1da177e4 LT |
1128 | |
1129 | /* | |
50eca3eb BM |
1130 | * Large resource descriptor "names" as defined by the ACPI specification. |
1131 | * Note: includes the Large Descriptor bit in bit[7] | |
1da177e4 | 1132 | */ |
50eca3eb BM |
1133 | #define ACPI_RESOURCE_NAME_MEMORY24 0x81 |
1134 | #define ACPI_RESOURCE_NAME_GENERIC_REGISTER 0x82 | |
1135 | #define ACPI_RESOURCE_NAME_RESERVED_L1 0x83 | |
1136 | #define ACPI_RESOURCE_NAME_VENDOR_LARGE 0x84 | |
1137 | #define ACPI_RESOURCE_NAME_MEMORY32 0x85 | |
1138 | #define ACPI_RESOURCE_NAME_FIXED_MEMORY32 0x86 | |
1139 | #define ACPI_RESOURCE_NAME_ADDRESS32 0x87 | |
1140 | #define ACPI_RESOURCE_NAME_ADDRESS16 0x88 | |
1141 | #define ACPI_RESOURCE_NAME_EXTENDED_IRQ 0x89 | |
1142 | #define ACPI_RESOURCE_NAME_ADDRESS64 0x8A | |
1143 | #define ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64 0x8B | |
e0fe0a8d | 1144 | #define ACPI_RESOURCE_NAME_GPIO 0x8C |
2b726930 | 1145 | #define ACPI_RESOURCE_NAME_PIN_FUNCTION 0x8D |
e0fe0a8d | 1146 | #define ACPI_RESOURCE_NAME_SERIAL_BUS 0x8E |
97028ce6 MW |
1147 | #define ACPI_RESOURCE_NAME_PIN_CONFIG 0x8F |
1148 | #define ACPI_RESOURCE_NAME_LARGE_MAX 0x8F | |
1da177e4 | 1149 | |
1da177e4 LT |
1150 | /***************************************************************************** |
1151 | * | |
1152 | * Miscellaneous | |
1153 | * | |
1154 | ****************************************************************************/ | |
1155 | ||
61686124 | 1156 | #define ACPI_ASCII_ZERO 0x30 |
1da177e4 | 1157 | |
56324c10 LZ |
1158 | /***************************************************************************** |
1159 | * | |
1160 | * Disassembler | |
1161 | * | |
1162 | ****************************************************************************/ | |
1163 | ||
1164 | struct acpi_external_list { | |
1165 | char *path; | |
1166 | char *internal_path; | |
1167 | struct acpi_external_list *next; | |
1168 | u32 value; | |
1169 | u16 length; | |
5af2b635 | 1170 | u16 flags; |
56324c10 | 1171 | u8 type; |
56324c10 LZ |
1172 | }; |
1173 | ||
1174 | /* Values for Flags field above */ | |
1175 | ||
5af2b635 BM |
1176 | #define ACPI_EXT_RESOLVED_REFERENCE 0x01 /* Object was resolved during cross ref */ |
1177 | #define ACPI_EXT_ORIGIN_FROM_FILE 0x02 /* External came from a file */ | |
1178 | #define ACPI_EXT_INTERNAL_PATH_ALLOCATED 0x04 /* Deallocate internal path on completion */ | |
1179 | #define ACPI_EXT_EXTERNAL_EMITTED 0x08 /* External() statement has been emitted */ | |
7447bc1e | 1180 | #define ACPI_EXT_ORIGIN_FROM_OPCODE 0x10 /* External came from a External() opcode */ |
56324c10 LZ |
1181 | |
1182 | struct acpi_external_file { | |
1183 | char *path; | |
1184 | struct acpi_external_file *next; | |
1185 | }; | |
1186 | ||
a86c856e DB |
1187 | struct acpi_parse_object_list { |
1188 | union acpi_parse_object *op; | |
1189 | struct acpi_parse_object_list *next; | |
1190 | }; | |
1191 | ||
1da177e4 LT |
1192 | /***************************************************************************** |
1193 | * | |
1194 | * Debugger | |
1195 | * | |
1196 | ****************************************************************************/ | |
1197 | ||
4be44fcd | 1198 | struct acpi_db_method_info { |
be030a57 | 1199 | acpi_handle method; |
2e23f851 BM |
1200 | acpi_handle main_thread_gate; |
1201 | acpi_handle thread_complete_gate; | |
f540fadf | 1202 | acpi_handle info_gate; |
28eb3fcf | 1203 | acpi_thread_id *threads; |
2e23f851 BM |
1204 | u32 num_threads; |
1205 | u32 num_created; | |
1206 | u32 num_completed; | |
1207 | ||
4be44fcd | 1208 | char *name; |
4be44fcd LB |
1209 | u32 flags; |
1210 | u32 num_loops; | |
73424473 | 1211 | char pathname[ACPI_DB_LINE_BUFFER_SIZE]; |
2e23f851 | 1212 | char **args; |
f540fadf | 1213 | acpi_object_type *types; |
2e23f851 BM |
1214 | |
1215 | /* | |
1216 | * Arguments to be passed to method for the command | |
1217 | * Threads - | |
1218 | * the Number of threads, ID of current thread and | |
1219 | * Index of current thread inside all them created. | |
1220 | */ | |
1221 | char init_args; | |
02ca26be LZ |
1222 | #ifdef ACPI_DEBUGGER |
1223 | acpi_object_type arg_types[4]; | |
1224 | #endif | |
2e23f851 BM |
1225 | char *arguments[4]; |
1226 | char num_threads_str[11]; | |
1227 | char id_of_thread_str[11]; | |
1228 | char index_of_thread_str[11]; | |
1da177e4 LT |
1229 | }; |
1230 | ||
4be44fcd LB |
1231 | struct acpi_integrity_info { |
1232 | u32 nodes; | |
1233 | u32 objects; | |
1da177e4 LT |
1234 | }; |
1235 | ||
1b673f23 | 1236 | #define ACPI_DB_DISABLE_OUTPUT 0x00 |
61686124 BM |
1237 | #define ACPI_DB_REDIRECTABLE_OUTPUT 0x01 |
1238 | #define ACPI_DB_CONSOLE_OUTPUT 0x02 | |
1239 | #define ACPI_DB_DUPLICATE_OUTPUT 0x03 | |
1da177e4 | 1240 | |
e69ab9a9 BM |
1241 | struct acpi_object_info { |
1242 | u32 types[ACPI_TOTAL_TYPES]; | |
1243 | }; | |
1244 | ||
1da177e4 LT |
1245 | /***************************************************************************** |
1246 | * | |
1247 | * Debug | |
1248 | * | |
1249 | ****************************************************************************/ | |
1250 | ||
1da177e4 LT |
1251 | /* Entry for a memory allocation (debug only) */ |
1252 | ||
61686124 BM |
1253 | #define ACPI_MEM_MALLOC 0 |
1254 | #define ACPI_MEM_CALLOC 1 | |
1255 | #define ACPI_MAX_MODULE_NAME 16 | |
1da177e4 LT |
1256 | |
1257 | #define ACPI_COMMON_DEBUG_MEM_HEADER \ | |
61686124 BM |
1258 | struct acpi_debug_mem_block *previous; \ |
1259 | struct acpi_debug_mem_block *next; \ | |
1260 | u32 size; \ | |
1261 | u32 component; \ | |
1262 | u32 line; \ | |
1263 | char module[ACPI_MAX_MODULE_NAME]; \ | |
1264 | u8 alloc_type; | |
1da177e4 | 1265 | |
4be44fcd LB |
1266 | struct acpi_debug_mem_header { |
1267 | ACPI_COMMON_DEBUG_MEM_HEADER}; | |
1da177e4 | 1268 | |
4be44fcd LB |
1269 | struct acpi_debug_mem_block { |
1270 | ACPI_COMMON_DEBUG_MEM_HEADER u64 user_space; | |
1da177e4 LT |
1271 | }; |
1272 | ||
1da177e4 LT |
1273 | #define ACPI_MEM_LIST_GLOBAL 0 |
1274 | #define ACPI_MEM_LIST_NSNODE 1 | |
73459f73 RM |
1275 | #define ACPI_MEM_LIST_MAX 1 |
1276 | #define ACPI_NUM_MEM_LISTS 2 | |
1da177e4 | 1277 | |
40cdb368 BM |
1278 | /***************************************************************************** |
1279 | * | |
1280 | * Info/help support | |
1281 | * | |
1282 | ****************************************************************************/ | |
1283 | ||
1284 | struct ah_predefined_name { | |
1285 | char *name; | |
1286 | char *description; | |
1287 | #ifndef ACPI_ASL_COMPILER | |
1288 | char *action; | |
1289 | #endif | |
1290 | }; | |
1291 | ||
b944b29c BM |
1292 | struct ah_device_id { |
1293 | char *name; | |
1294 | char *description; | |
1295 | }; | |
1296 | ||
73bbca04 BM |
1297 | struct ah_uuid { |
1298 | char *description; | |
1299 | char *string; | |
1300 | }; | |
1301 | ||
0bb346cc BM |
1302 | struct ah_table { |
1303 | char *signature; | |
1304 | char *description; | |
1305 | }; | |
1306 | ||
4be44fcd | 1307 | #endif /* __ACLOCAL_H__ */ |