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