Commit | Line | Data |
---|---|---|
73459f73 RM |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: psloop - Main AML parse loop | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
75a44ce0 | 8 | * Copyright (C) 2000 - 2008, Intel Corp. |
73459f73 RM |
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 | ||
73459f73 | 44 | /* |
4d0b4af9 MK |
45 | * Parse the AML and build an operation tree as most interpreters, (such as |
46 | * Perl) do. Parsing is done by hand rather than with a YACC generated parser | |
47 | * to tightly constrain stack and dynamic memory usage. Parsing is kept | |
48 | * flexible and the code fairly compact by parsing based on a list of AML | |
49 | * opcode templates in aml_op_info[]. | |
73459f73 RM |
50 | */ |
51 | ||
52 | #include <acpi/acpi.h> | |
53 | #include <acpi/acparser.h> | |
54 | #include <acpi/acdispat.h> | |
55 | #include <acpi/amlcode.h> | |
73459f73 RM |
56 | |
57 | #define _COMPONENT ACPI_PARSER | |
4be44fcd | 58 | ACPI_MODULE_NAME("psloop") |
73459f73 | 59 | |
4be44fcd | 60 | static u32 acpi_gbl_depth = 0; |
73459f73 | 61 | |
4d0b4af9 MK |
62 | /* Local prototypes */ |
63 | ||
64 | static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state); | |
65 | ||
66 | static acpi_status | |
67 | acpi_ps_build_named_op(struct acpi_walk_state *walk_state, | |
68 | u8 * aml_op_start, | |
69 | union acpi_parse_object *unnamed_op, | |
70 | union acpi_parse_object **op); | |
71 | ||
72 | static acpi_status | |
73 | acpi_ps_create_op(struct acpi_walk_state *walk_state, | |
74 | u8 * aml_op_start, union acpi_parse_object **new_op); | |
75 | ||
76 | static acpi_status | |
77 | acpi_ps_get_arguments(struct acpi_walk_state *walk_state, | |
78 | u8 * aml_op_start, union acpi_parse_object *op); | |
79 | ||
80 | static acpi_status | |
81 | acpi_ps_complete_op(struct acpi_walk_state *walk_state, | |
82 | union acpi_parse_object **op, acpi_status status); | |
83 | ||
84 | static acpi_status | |
85 | acpi_ps_complete_final_op(struct acpi_walk_state *walk_state, | |
86 | union acpi_parse_object *op, acpi_status status); | |
87 | ||
88 | /******************************************************************************* | |
89 | * | |
90 | * FUNCTION: acpi_ps_get_aml_opcode | |
91 | * | |
92 | * PARAMETERS: walk_state - Current state | |
93 | * | |
94 | * RETURN: Status | |
95 | * | |
96 | * DESCRIPTION: Extract the next AML opcode from the input stream. | |
97 | * | |
98 | ******************************************************************************/ | |
99 | ||
100 | static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state) | |
101 | { | |
102 | ||
103 | ACPI_FUNCTION_TRACE_PTR(ps_get_aml_opcode, walk_state); | |
104 | ||
105 | walk_state->aml_offset = | |
106 | (u32) ACPI_PTR_DIFF(walk_state->parser_state.aml, | |
107 | walk_state->parser_state.aml_start); | |
108 | walk_state->opcode = acpi_ps_peek_opcode(&(walk_state->parser_state)); | |
109 | ||
110 | /* | |
111 | * First cut to determine what we have found: | |
112 | * 1) A valid AML opcode | |
113 | * 2) A name string | |
114 | * 3) An unknown/invalid opcode | |
115 | */ | |
116 | walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode); | |
117 | ||
118 | switch (walk_state->op_info->class) { | |
119 | case AML_CLASS_ASCII: | |
120 | case AML_CLASS_PREFIX: | |
121 | /* | |
122 | * Starts with a valid prefix or ASCII char, this is a name | |
123 | * string. Convert the bare name string to a namepath. | |
124 | */ | |
125 | walk_state->opcode = AML_INT_NAMEPATH_OP; | |
126 | walk_state->arg_types = ARGP_NAMESTRING; | |
127 | break; | |
128 | ||
129 | case AML_CLASS_UNKNOWN: | |
130 | ||
131 | /* The opcode is unrecognized. Just skip unknown opcodes */ | |
132 | ||
133 | ACPI_ERROR((AE_INFO, | |
134 | "Found unknown opcode %X at AML address %p offset %X, ignoring", | |
135 | walk_state->opcode, walk_state->parser_state.aml, | |
136 | walk_state->aml_offset)); | |
137 | ||
138 | ACPI_DUMP_BUFFER(walk_state->parser_state.aml, 128); | |
139 | ||
140 | /* Assume one-byte bad opcode */ | |
141 | ||
142 | walk_state->parser_state.aml++; | |
143 | return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE); | |
144 | ||
145 | default: | |
146 | ||
147 | /* Found opcode info, this is a normal opcode */ | |
148 | ||
149 | walk_state->parser_state.aml += | |
150 | acpi_ps_get_opcode_size(walk_state->opcode); | |
151 | walk_state->arg_types = walk_state->op_info->parse_args; | |
152 | break; | |
153 | } | |
154 | ||
155 | return_ACPI_STATUS(AE_OK); | |
156 | } | |
157 | ||
158 | /******************************************************************************* | |
159 | * | |
160 | * FUNCTION: acpi_ps_build_named_op | |
161 | * | |
162 | * PARAMETERS: walk_state - Current state | |
163 | * aml_op_start - Begin of named Op in AML | |
164 | * unnamed_op - Early Op (not a named Op) | |
165 | * Op - Returned Op | |
166 | * | |
167 | * RETURN: Status | |
168 | * | |
169 | * DESCRIPTION: Parse a named Op | |
170 | * | |
171 | ******************************************************************************/ | |
172 | ||
173 | static acpi_status | |
174 | acpi_ps_build_named_op(struct acpi_walk_state *walk_state, | |
175 | u8 * aml_op_start, | |
176 | union acpi_parse_object *unnamed_op, | |
177 | union acpi_parse_object **op) | |
178 | { | |
179 | acpi_status status = AE_OK; | |
180 | union acpi_parse_object *arg = NULL; | |
181 | ||
182 | ACPI_FUNCTION_TRACE_PTR(ps_build_named_op, walk_state); | |
183 | ||
184 | unnamed_op->common.value.arg = NULL; | |
4e3156b1 | 185 | unnamed_op->common.arg_list_length = 0; |
4d0b4af9 MK |
186 | unnamed_op->common.aml_opcode = walk_state->opcode; |
187 | ||
188 | /* | |
189 | * Get and append arguments until we find the node that contains | |
190 | * the name (the type ARGP_NAME). | |
191 | */ | |
192 | while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) && | |
193 | (GET_CURRENT_ARG_TYPE(walk_state->arg_types) != ARGP_NAME)) { | |
194 | status = | |
195 | acpi_ps_get_next_arg(walk_state, | |
196 | &(walk_state->parser_state), | |
197 | GET_CURRENT_ARG_TYPE(walk_state-> | |
198 | arg_types), &arg); | |
199 | if (ACPI_FAILURE(status)) { | |
200 | return_ACPI_STATUS(status); | |
201 | } | |
202 | ||
203 | acpi_ps_append_arg(unnamed_op, arg); | |
204 | INCREMENT_ARG_LIST(walk_state->arg_types); | |
205 | } | |
206 | ||
207 | /* | |
208 | * Make sure that we found a NAME and didn't run out of arguments | |
209 | */ | |
210 | if (!GET_CURRENT_ARG_TYPE(walk_state->arg_types)) { | |
211 | return_ACPI_STATUS(AE_AML_NO_OPERAND); | |
212 | } | |
213 | ||
214 | /* We know that this arg is a name, move to next arg */ | |
215 | ||
216 | INCREMENT_ARG_LIST(walk_state->arg_types); | |
217 | ||
218 | /* | |
219 | * Find the object. This will either insert the object into | |
220 | * the namespace or simply look it up | |
221 | */ | |
222 | walk_state->op = NULL; | |
223 | ||
224 | status = walk_state->descending_callback(walk_state, op); | |
225 | if (ACPI_FAILURE(status)) { | |
226 | ACPI_EXCEPTION((AE_INFO, status, "During name lookup/catalog")); | |
227 | return_ACPI_STATUS(status); | |
228 | } | |
229 | ||
9bc75cff | 230 | if (!*op) { |
4d0b4af9 MK |
231 | return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE); |
232 | } | |
233 | ||
234 | status = acpi_ps_next_parse_state(walk_state, *op, status); | |
235 | if (ACPI_FAILURE(status)) { | |
236 | if (status == AE_CTRL_PENDING) { | |
237 | return_ACPI_STATUS(AE_CTRL_PARSE_PENDING); | |
238 | } | |
239 | return_ACPI_STATUS(status); | |
240 | } | |
241 | ||
242 | acpi_ps_append_arg(*op, unnamed_op->common.value.arg); | |
243 | acpi_gbl_depth++; | |
244 | ||
941f48bb LM |
245 | if ((*op)->common.aml_opcode == AML_REGION_OP || |
246 | (*op)->common.aml_opcode == AML_DATA_REGION_OP) { | |
4d0b4af9 MK |
247 | /* |
248 | * Defer final parsing of an operation_region body, because we don't | |
249 | * have enough info in the first pass to parse it correctly (i.e., | |
250 | * there may be method calls within the term_arg elements of the body.) | |
251 | * | |
252 | * However, we must continue parsing because the opregion is not a | |
253 | * standalone package -- we don't know where the end is at this point. | |
254 | * | |
255 | * (Length is unknown until parse of the body complete) | |
256 | */ | |
257 | (*op)->named.data = aml_op_start; | |
258 | (*op)->named.length = 0; | |
259 | } | |
260 | ||
261 | return_ACPI_STATUS(AE_OK); | |
262 | } | |
263 | ||
264 | /******************************************************************************* | |
265 | * | |
266 | * FUNCTION: acpi_ps_create_op | |
267 | * | |
268 | * PARAMETERS: walk_state - Current state | |
269 | * aml_op_start - Op start in AML | |
270 | * new_op - Returned Op | |
271 | * | |
272 | * RETURN: Status | |
273 | * | |
274 | * DESCRIPTION: Get Op from AML | |
275 | * | |
276 | ******************************************************************************/ | |
277 | ||
278 | static acpi_status | |
279 | acpi_ps_create_op(struct acpi_walk_state *walk_state, | |
280 | u8 * aml_op_start, union acpi_parse_object **new_op) | |
281 | { | |
282 | acpi_status status = AE_OK; | |
283 | union acpi_parse_object *op; | |
284 | union acpi_parse_object *named_op = NULL; | |
4e3156b1 BM |
285 | union acpi_parse_object *parent_scope; |
286 | u8 argument_count; | |
287 | const struct acpi_opcode_info *op_info; | |
4d0b4af9 MK |
288 | |
289 | ACPI_FUNCTION_TRACE_PTR(ps_create_op, walk_state); | |
290 | ||
291 | status = acpi_ps_get_aml_opcode(walk_state); | |
292 | if (status == AE_CTRL_PARSE_CONTINUE) { | |
293 | return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE); | |
294 | } | |
295 | ||
296 | /* Create Op structure and append to parent's argument list */ | |
297 | ||
298 | walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode); | |
299 | op = acpi_ps_alloc_op(walk_state->opcode); | |
300 | if (!op) { | |
301 | return_ACPI_STATUS(AE_NO_MEMORY); | |
302 | } | |
303 | ||
304 | if (walk_state->op_info->flags & AML_NAMED) { | |
305 | status = | |
306 | acpi_ps_build_named_op(walk_state, aml_op_start, op, | |
307 | &named_op); | |
308 | acpi_ps_free_op(op); | |
309 | if (ACPI_FAILURE(status)) { | |
310 | return_ACPI_STATUS(status); | |
311 | } | |
312 | ||
313 | *new_op = named_op; | |
314 | return_ACPI_STATUS(AE_OK); | |
315 | } | |
316 | ||
317 | /* Not a named opcode, just allocate Op and append to parent */ | |
318 | ||
319 | if (walk_state->op_info->flags & AML_CREATE) { | |
320 | /* | |
321 | * Backup to beginning of create_xXXfield declaration | |
322 | * body_length is unknown until we parse the body | |
323 | */ | |
324 | op->named.data = aml_op_start; | |
325 | op->named.length = 0; | |
326 | } | |
327 | ||
ef805d95 LM |
328 | if (walk_state->opcode == AML_BANK_FIELD_OP) { |
329 | /* | |
330 | * Backup to beginning of bank_field declaration | |
331 | * body_length is unknown until we parse the body | |
332 | */ | |
333 | op->named.data = aml_op_start; | |
334 | op->named.length = 0; | |
335 | } | |
336 | ||
4e3156b1 BM |
337 | parent_scope = acpi_ps_get_parent_scope(&(walk_state->parser_state)); |
338 | acpi_ps_append_arg(parent_scope, op); | |
339 | ||
340 | if (parent_scope) { | |
341 | op_info = | |
342 | acpi_ps_get_opcode_info(parent_scope->common.aml_opcode); | |
343 | if (op_info->flags & AML_HAS_TARGET) { | |
344 | argument_count = | |
345 | acpi_ps_get_argument_count(op_info->type); | |
346 | if (parent_scope->common.arg_list_length > | |
347 | argument_count) { | |
348 | op->common.flags |= ACPI_PARSEOP_TARGET; | |
349 | } | |
350 | } else if (parent_scope->common.aml_opcode == AML_INCREMENT_OP) { | |
351 | op->common.flags |= ACPI_PARSEOP_TARGET; | |
352 | } | |
353 | } | |
4d0b4af9 MK |
354 | |
355 | if (walk_state->descending_callback != NULL) { | |
356 | /* | |
357 | * Find the object. This will either insert the object into | |
358 | * the namespace or simply look it up | |
359 | */ | |
360 | walk_state->op = *new_op = op; | |
361 | ||
362 | status = walk_state->descending_callback(walk_state, &op); | |
363 | status = acpi_ps_next_parse_state(walk_state, op, status); | |
364 | if (status == AE_CTRL_PENDING) { | |
365 | status = AE_CTRL_PARSE_PENDING; | |
366 | } | |
367 | } | |
368 | ||
369 | return_ACPI_STATUS(status); | |
370 | } | |
371 | ||
372 | /******************************************************************************* | |
373 | * | |
374 | * FUNCTION: acpi_ps_get_arguments | |
375 | * | |
376 | * PARAMETERS: walk_state - Current state | |
377 | * aml_op_start - Op start in AML | |
378 | * Op - Current Op | |
379 | * | |
380 | * RETURN: Status | |
381 | * | |
382 | * DESCRIPTION: Get arguments for passed Op. | |
383 | * | |
384 | ******************************************************************************/ | |
385 | ||
386 | static acpi_status | |
387 | acpi_ps_get_arguments(struct acpi_walk_state *walk_state, | |
388 | u8 * aml_op_start, union acpi_parse_object *op) | |
389 | { | |
390 | acpi_status status = AE_OK; | |
391 | union acpi_parse_object *arg = NULL; | |
392 | ||
393 | ACPI_FUNCTION_TRACE_PTR(ps_get_arguments, walk_state); | |
394 | ||
395 | switch (op->common.aml_opcode) { | |
396 | case AML_BYTE_OP: /* AML_BYTEDATA_ARG */ | |
397 | case AML_WORD_OP: /* AML_WORDDATA_ARG */ | |
398 | case AML_DWORD_OP: /* AML_DWORDATA_ARG */ | |
399 | case AML_QWORD_OP: /* AML_QWORDATA_ARG */ | |
400 | case AML_STRING_OP: /* AML_ASCIICHARLIST_ARG */ | |
401 | ||
402 | /* Fill in constant or string argument directly */ | |
403 | ||
404 | acpi_ps_get_next_simple_arg(&(walk_state->parser_state), | |
405 | GET_CURRENT_ARG_TYPE(walk_state-> | |
406 | arg_types), | |
407 | op); | |
408 | break; | |
409 | ||
410 | case AML_INT_NAMEPATH_OP: /* AML_NAMESTRING_ARG */ | |
411 | ||
412 | status = | |
413 | acpi_ps_get_next_namepath(walk_state, | |
414 | &(walk_state->parser_state), op, | |
415 | 1); | |
416 | if (ACPI_FAILURE(status)) { | |
417 | return_ACPI_STATUS(status); | |
418 | } | |
419 | ||
420 | walk_state->arg_types = 0; | |
421 | break; | |
422 | ||
423 | default: | |
424 | /* | |
425 | * Op is not a constant or string, append each argument to the Op | |
426 | */ | |
427 | while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) | |
428 | && !walk_state->arg_count) { | |
429 | walk_state->aml_offset = | |
430 | (u32) ACPI_PTR_DIFF(walk_state->parser_state.aml, | |
431 | walk_state->parser_state. | |
432 | aml_start); | |
433 | ||
434 | status = | |
435 | acpi_ps_get_next_arg(walk_state, | |
436 | &(walk_state->parser_state), | |
437 | GET_CURRENT_ARG_TYPE | |
438 | (walk_state->arg_types), &arg); | |
439 | if (ACPI_FAILURE(status)) { | |
440 | return_ACPI_STATUS(status); | |
441 | } | |
442 | ||
443 | if (arg) { | |
444 | arg->common.aml_offset = walk_state->aml_offset; | |
445 | acpi_ps_append_arg(op, arg); | |
446 | } | |
447 | ||
448 | INCREMENT_ARG_LIST(walk_state->arg_types); | |
449 | } | |
450 | ||
451 | /* Special processing for certain opcodes */ | |
452 | ||
453 | /* TBD (remove): Temporary mechanism to disable this code if needed */ | |
454 | ||
455 | #ifdef ACPI_ENABLE_MODULE_LEVEL_CODE | |
456 | ||
457 | if ((walk_state->pass_number <= ACPI_IMODE_LOAD_PASS1) && | |
458 | ((walk_state->parse_flags & ACPI_PARSE_DISASSEMBLE) == 0)) { | |
459 | /* | |
460 | * We want to skip If/Else/While constructs during Pass1 because we | |
461 | * want to actually conditionally execute the code during Pass2. | |
462 | * | |
463 | * Except for disassembly, where we always want to walk the | |
464 | * If/Else/While packages | |
465 | */ | |
466 | switch (op->common.aml_opcode) { | |
467 | case AML_IF_OP: | |
468 | case AML_ELSE_OP: | |
469 | case AML_WHILE_OP: | |
470 | ||
471 | ACPI_DEBUG_PRINT((ACPI_DB_PARSE, | |
472 | "Pass1: Skipping an If/Else/While body\n")); | |
473 | ||
474 | /* Skip body of if/else/while in pass 1 */ | |
475 | ||
476 | walk_state->parser_state.aml = | |
477 | walk_state->parser_state.pkg_end; | |
478 | walk_state->arg_count = 0; | |
479 | break; | |
480 | ||
481 | default: | |
482 | break; | |
483 | } | |
484 | } | |
485 | #endif | |
486 | ||
487 | switch (op->common.aml_opcode) { | |
488 | case AML_METHOD_OP: | |
489 | /* | |
490 | * Skip parsing of control method because we don't have enough | |
491 | * info in the first pass to parse it correctly. | |
492 | * | |
493 | * Save the length and address of the body | |
494 | */ | |
495 | op->named.data = walk_state->parser_state.aml; | |
496 | op->named.length = (u32) | |
497 | (walk_state->parser_state.pkg_end - | |
498 | walk_state->parser_state.aml); | |
499 | ||
500 | /* Skip body of method */ | |
501 | ||
502 | walk_state->parser_state.aml = | |
503 | walk_state->parser_state.pkg_end; | |
504 | walk_state->arg_count = 0; | |
505 | break; | |
506 | ||
507 | case AML_BUFFER_OP: | |
508 | case AML_PACKAGE_OP: | |
509 | case AML_VAR_PACKAGE_OP: | |
510 | ||
511 | if ((op->common.parent) && | |
512 | (op->common.parent->common.aml_opcode == | |
513 | AML_NAME_OP) | |
514 | && (walk_state->pass_number <= | |
515 | ACPI_IMODE_LOAD_PASS2)) { | |
516 | /* | |
517 | * Skip parsing of Buffers and Packages because we don't have | |
518 | * enough info in the first pass to parse them correctly. | |
519 | */ | |
520 | op->named.data = aml_op_start; | |
521 | op->named.length = (u32) | |
522 | (walk_state->parser_state.pkg_end - | |
523 | aml_op_start); | |
524 | ||
525 | /* Skip body */ | |
526 | ||
527 | walk_state->parser_state.aml = | |
528 | walk_state->parser_state.pkg_end; | |
529 | walk_state->arg_count = 0; | |
530 | } | |
531 | break; | |
532 | ||
533 | case AML_WHILE_OP: | |
534 | ||
535 | if (walk_state->control_state) { | |
536 | walk_state->control_state->control.package_end = | |
537 | walk_state->parser_state.pkg_end; | |
538 | } | |
539 | break; | |
540 | ||
541 | default: | |
542 | ||
543 | /* No action for all other opcodes */ | |
544 | break; | |
545 | } | |
546 | ||
547 | break; | |
548 | } | |
549 | ||
550 | return_ACPI_STATUS(AE_OK); | |
551 | } | |
552 | ||
553 | /******************************************************************************* | |
554 | * | |
555 | * FUNCTION: acpi_ps_complete_op | |
556 | * | |
557 | * PARAMETERS: walk_state - Current state | |
558 | * Op - Returned Op | |
559 | * Status - Parse status before complete Op | |
560 | * | |
561 | * RETURN: Status | |
562 | * | |
563 | * DESCRIPTION: Complete Op | |
564 | * | |
565 | ******************************************************************************/ | |
566 | ||
567 | static acpi_status | |
568 | acpi_ps_complete_op(struct acpi_walk_state *walk_state, | |
569 | union acpi_parse_object **op, acpi_status status) | |
570 | { | |
571 | acpi_status status2; | |
572 | ||
573 | ACPI_FUNCTION_TRACE_PTR(ps_complete_op, walk_state); | |
574 | ||
575 | /* | |
576 | * Finished one argument of the containing scope | |
577 | */ | |
578 | walk_state->parser_state.scope->parse_scope.arg_count--; | |
579 | ||
580 | /* Close this Op (will result in parse subtree deletion) */ | |
581 | ||
582 | status2 = acpi_ps_complete_this_op(walk_state, *op); | |
583 | if (ACPI_FAILURE(status2)) { | |
584 | return_ACPI_STATUS(status2); | |
585 | } | |
586 | ||
587 | *op = NULL; | |
588 | ||
589 | switch (status) { | |
590 | case AE_OK: | |
591 | break; | |
592 | ||
593 | case AE_CTRL_TRANSFER: | |
594 | ||
595 | /* We are about to transfer to a called method */ | |
596 | ||
597 | walk_state->prev_op = NULL; | |
598 | walk_state->prev_arg_types = walk_state->arg_types; | |
599 | return_ACPI_STATUS(status); | |
600 | ||
601 | case AE_CTRL_END: | |
602 | ||
603 | acpi_ps_pop_scope(&(walk_state->parser_state), op, | |
604 | &walk_state->arg_types, | |
605 | &walk_state->arg_count); | |
606 | ||
607 | if (*op) { | |
608 | walk_state->op = *op; | |
609 | walk_state->op_info = | |
610 | acpi_ps_get_opcode_info((*op)->common.aml_opcode); | |
611 | walk_state->opcode = (*op)->common.aml_opcode; | |
612 | ||
613 | status = walk_state->ascending_callback(walk_state); | |
614 | status = | |
615 | acpi_ps_next_parse_state(walk_state, *op, status); | |
616 | ||
617 | status2 = acpi_ps_complete_this_op(walk_state, *op); | |
618 | if (ACPI_FAILURE(status2)) { | |
619 | return_ACPI_STATUS(status2); | |
620 | } | |
621 | } | |
622 | ||
623 | status = AE_OK; | |
624 | break; | |
625 | ||
626 | case AE_CTRL_BREAK: | |
627 | case AE_CTRL_CONTINUE: | |
628 | ||
629 | /* Pop off scopes until we find the While */ | |
630 | ||
631 | while (!(*op) || ((*op)->common.aml_opcode != AML_WHILE_OP)) { | |
632 | acpi_ps_pop_scope(&(walk_state->parser_state), op, | |
633 | &walk_state->arg_types, | |
634 | &walk_state->arg_count); | |
4d0b4af9 MK |
635 | } |
636 | ||
637 | /* Close this iteration of the While loop */ | |
638 | ||
639 | walk_state->op = *op; | |
640 | walk_state->op_info = | |
641 | acpi_ps_get_opcode_info((*op)->common.aml_opcode); | |
642 | walk_state->opcode = (*op)->common.aml_opcode; | |
643 | ||
644 | status = walk_state->ascending_callback(walk_state); | |
645 | status = acpi_ps_next_parse_state(walk_state, *op, status); | |
646 | ||
647 | status2 = acpi_ps_complete_this_op(walk_state, *op); | |
648 | if (ACPI_FAILURE(status2)) { | |
649 | return_ACPI_STATUS(status2); | |
650 | } | |
651 | ||
652 | status = AE_OK; | |
653 | break; | |
654 | ||
655 | case AE_CTRL_TERMINATE: | |
656 | ||
657 | /* Clean up */ | |
658 | do { | |
659 | if (*op) { | |
660 | status2 = | |
661 | acpi_ps_complete_this_op(walk_state, *op); | |
662 | if (ACPI_FAILURE(status2)) { | |
663 | return_ACPI_STATUS(status2); | |
664 | } | |
4d0b4af9 MK |
665 | |
666 | acpi_ut_delete_generic_state | |
667 | (acpi_ut_pop_generic_state | |
668 | (&walk_state->control_state)); | |
669 | } | |
670 | ||
671 | acpi_ps_pop_scope(&(walk_state->parser_state), op, | |
672 | &walk_state->arg_types, | |
673 | &walk_state->arg_count); | |
674 | ||
675 | } while (*op); | |
676 | ||
677 | return_ACPI_STATUS(AE_OK); | |
678 | ||
679 | default: /* All other non-AE_OK status */ | |
680 | ||
681 | do { | |
682 | if (*op) { | |
683 | status2 = | |
684 | acpi_ps_complete_this_op(walk_state, *op); | |
685 | if (ACPI_FAILURE(status2)) { | |
686 | return_ACPI_STATUS(status2); | |
687 | } | |
688 | } | |
689 | ||
690 | acpi_ps_pop_scope(&(walk_state->parser_state), op, | |
691 | &walk_state->arg_types, | |
692 | &walk_state->arg_count); | |
693 | ||
694 | } while (*op); | |
695 | ||
696 | #if 0 | |
697 | /* | |
698 | * TBD: Cleanup parse ops on error | |
699 | */ | |
700 | if (*op == NULL) { | |
701 | acpi_ps_pop_scope(parser_state, op, | |
702 | &walk_state->arg_types, | |
703 | &walk_state->arg_count); | |
704 | } | |
705 | #endif | |
706 | walk_state->prev_op = NULL; | |
707 | walk_state->prev_arg_types = walk_state->arg_types; | |
708 | return_ACPI_STATUS(status); | |
709 | } | |
710 | ||
711 | /* This scope complete? */ | |
712 | ||
713 | if (acpi_ps_has_completed_scope(&(walk_state->parser_state))) { | |
714 | acpi_ps_pop_scope(&(walk_state->parser_state), op, | |
715 | &walk_state->arg_types, | |
716 | &walk_state->arg_count); | |
717 | ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Popped scope, Op=%p\n", *op)); | |
718 | } else { | |
719 | *op = NULL; | |
720 | } | |
721 | ||
722 | return_ACPI_STATUS(AE_OK); | |
723 | } | |
724 | ||
725 | /******************************************************************************* | |
726 | * | |
727 | * FUNCTION: acpi_ps_complete_final_op | |
728 | * | |
729 | * PARAMETERS: walk_state - Current state | |
730 | * Op - Current Op | |
731 | * Status - Current parse status before complete last | |
732 | * Op | |
733 | * | |
734 | * RETURN: Status | |
735 | * | |
736 | * DESCRIPTION: Complete last Op. | |
737 | * | |
738 | ******************************************************************************/ | |
739 | ||
740 | static acpi_status | |
741 | acpi_ps_complete_final_op(struct acpi_walk_state *walk_state, | |
742 | union acpi_parse_object *op, acpi_status status) | |
743 | { | |
744 | acpi_status status2; | |
745 | ||
746 | ACPI_FUNCTION_TRACE_PTR(ps_complete_final_op, walk_state); | |
747 | ||
748 | /* | |
749 | * Complete the last Op (if not completed), and clear the scope stack. | |
750 | * It is easily possible to end an AML "package" with an unbounded number | |
751 | * of open scopes (such as when several ASL blocks are closed with | |
752 | * sequential closing braces). We want to terminate each one cleanly. | |
753 | */ | |
754 | ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "AML package complete at Op %p\n", | |
755 | op)); | |
756 | do { | |
757 | if (op) { | |
758 | if (walk_state->ascending_callback != NULL) { | |
759 | walk_state->op = op; | |
760 | walk_state->op_info = | |
761 | acpi_ps_get_opcode_info(op->common. | |
762 | aml_opcode); | |
763 | walk_state->opcode = op->common.aml_opcode; | |
764 | ||
765 | status = | |
766 | walk_state->ascending_callback(walk_state); | |
767 | status = | |
768 | acpi_ps_next_parse_state(walk_state, op, | |
769 | status); | |
770 | if (status == AE_CTRL_PENDING) { | |
771 | status = | |
772 | acpi_ps_complete_op(walk_state, &op, | |
773 | AE_OK); | |
774 | if (ACPI_FAILURE(status)) { | |
775 | return_ACPI_STATUS(status); | |
776 | } | |
777 | } | |
778 | ||
779 | if (status == AE_CTRL_TERMINATE) { | |
780 | status = AE_OK; | |
781 | ||
782 | /* Clean up */ | |
783 | do { | |
784 | if (op) { | |
785 | status2 = | |
786 | acpi_ps_complete_this_op | |
787 | (walk_state, op); | |
788 | if (ACPI_FAILURE | |
789 | (status2)) { | |
790 | return_ACPI_STATUS | |
791 | (status2); | |
792 | } | |
793 | } | |
794 | ||
795 | acpi_ps_pop_scope(& | |
796 | (walk_state-> | |
797 | parser_state), | |
798 | &op, | |
799 | &walk_state-> | |
800 | arg_types, | |
801 | &walk_state-> | |
802 | arg_count); | |
803 | ||
804 | } while (op); | |
805 | ||
806 | return_ACPI_STATUS(status); | |
807 | } | |
808 | ||
809 | else if (ACPI_FAILURE(status)) { | |
810 | ||
811 | /* First error is most important */ | |
812 | ||
813 | (void) | |
814 | acpi_ps_complete_this_op(walk_state, | |
815 | op); | |
816 | return_ACPI_STATUS(status); | |
817 | } | |
818 | } | |
819 | ||
820 | status2 = acpi_ps_complete_this_op(walk_state, op); | |
821 | if (ACPI_FAILURE(status2)) { | |
822 | return_ACPI_STATUS(status2); | |
823 | } | |
824 | } | |
825 | ||
826 | acpi_ps_pop_scope(&(walk_state->parser_state), &op, | |
827 | &walk_state->arg_types, | |
828 | &walk_state->arg_count); | |
829 | ||
830 | } while (op); | |
831 | ||
832 | return_ACPI_STATUS(status); | |
833 | } | |
834 | ||
73459f73 RM |
835 | /******************************************************************************* |
836 | * | |
837 | * FUNCTION: acpi_ps_parse_loop | |
838 | * | |
839 | * PARAMETERS: walk_state - Current state | |
840 | * | |
841 | * RETURN: Status | |
842 | * | |
843 | * DESCRIPTION: Parse AML (pointed to by the current parser state) and return | |
844 | * a tree of ops. | |
845 | * | |
846 | ******************************************************************************/ | |
847 | ||
4be44fcd | 848 | acpi_status acpi_ps_parse_loop(struct acpi_walk_state *walk_state) |
73459f73 | 849 | { |
4be44fcd | 850 | acpi_status status = AE_OK; |
4be44fcd | 851 | union acpi_parse_object *op = NULL; /* current op */ |
4be44fcd LB |
852 | struct acpi_parse_state *parser_state; |
853 | u8 *aml_op_start = NULL; | |
73459f73 | 854 | |
b229cf92 | 855 | ACPI_FUNCTION_TRACE_PTR(ps_parse_loop, walk_state); |
73459f73 RM |
856 | |
857 | if (walk_state->descending_callback == NULL) { | |
4be44fcd | 858 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
73459f73 RM |
859 | } |
860 | ||
861 | parser_state = &walk_state->parser_state; | |
862 | walk_state->arg_types = 0; | |
863 | ||
864 | #if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY)) | |
865 | ||
866 | if (walk_state->walk_type & ACPI_WALK_METHOD_RESTART) { | |
52fc0b02 | 867 | |
73459f73 RM |
868 | /* We are restarting a preempted control method */ |
869 | ||
4be44fcd | 870 | if (acpi_ps_has_completed_scope(parser_state)) { |
73459f73 RM |
871 | /* |
872 | * We must check if a predicate to an IF or WHILE statement | |
873 | * was just completed | |
874 | */ | |
875 | if ((parser_state->scope->parse_scope.op) && | |
4be44fcd LB |
876 | ((parser_state->scope->parse_scope.op->common. |
877 | aml_opcode == AML_IF_OP) | |
878 | || (parser_state->scope->parse_scope.op->common. | |
879 | aml_opcode == AML_WHILE_OP)) | |
880 | && (walk_state->control_state) | |
881 | && (walk_state->control_state->common.state == | |
882 | ACPI_CONTROL_PREDICATE_EXECUTING)) { | |
73459f73 RM |
883 | /* |
884 | * A predicate was just completed, get the value of the | |
885 | * predicate and branch based on that value | |
886 | */ | |
887 | walk_state->op = NULL; | |
4be44fcd LB |
888 | status = |
889 | acpi_ds_get_predicate_value(walk_state, | |
890 | ACPI_TO_POINTER | |
891 | (TRUE)); | |
892 | if (ACPI_FAILURE(status) | |
893 | && ((status & AE_CODE_MASK) != | |
894 | AE_CODE_CONTROL)) { | |
73459f73 | 895 | if (status == AE_AML_NO_RETURN_VALUE) { |
b8e4d893 BM |
896 | ACPI_EXCEPTION((AE_INFO, status, |
897 | "Invoked method did not return a value")); | |
73459f73 RM |
898 | |
899 | } | |
4d0b4af9 | 900 | |
b8e4d893 | 901 | ACPI_EXCEPTION((AE_INFO, status, |
b229cf92 | 902 | "GetPredicate Failed")); |
4be44fcd | 903 | return_ACPI_STATUS(status); |
73459f73 RM |
904 | } |
905 | ||
4be44fcd LB |
906 | status = |
907 | acpi_ps_next_parse_state(walk_state, op, | |
908 | status); | |
73459f73 RM |
909 | } |
910 | ||
4be44fcd LB |
911 | acpi_ps_pop_scope(parser_state, &op, |
912 | &walk_state->arg_types, | |
913 | &walk_state->arg_count); | |
914 | ACPI_DEBUG_PRINT((ACPI_DB_PARSE, | |
915 | "Popped scope, Op=%p\n", op)); | |
916 | } else if (walk_state->prev_op) { | |
52fc0b02 | 917 | |
73459f73 RM |
918 | /* We were in the middle of an op */ |
919 | ||
4d0b4af9 MK |
920 | op = walk_state->prev_op; |
921 | walk_state->arg_types = walk_state->prev_arg_types; | |
922 | } | |
923 | } | |
924 | #endif | |
73459f73 | 925 | |
4d0b4af9 | 926 | /* Iterative parsing loop, while there is more AML to process: */ |
73459f73 | 927 | |
4d0b4af9 MK |
928 | while ((parser_state->aml < parser_state->aml_end) || (op)) { |
929 | aml_op_start = parser_state->aml; | |
930 | if (!op) { | |
931 | status = | |
932 | acpi_ps_create_op(walk_state, aml_op_start, &op); | |
933 | if (ACPI_FAILURE(status)) { | |
934 | if (status == AE_CTRL_PARSE_CONTINUE) { | |
73459f73 RM |
935 | continue; |
936 | } | |
937 | ||
4d0b4af9 | 938 | if (status == AE_CTRL_PARSE_PENDING) { |
73459f73 | 939 | status = AE_OK; |
73459f73 RM |
940 | } |
941 | ||
4d0b4af9 MK |
942 | status = |
943 | acpi_ps_complete_op(walk_state, &op, | |
944 | status); | |
4be44fcd | 945 | if (ACPI_FAILURE(status)) { |
4d0b4af9 | 946 | return_ACPI_STATUS(status); |
73459f73 RM |
947 | } |
948 | ||
4d0b4af9 | 949 | continue; |
73459f73 RM |
950 | } |
951 | ||
952 | op->common.aml_offset = walk_state->aml_offset; | |
953 | ||
954 | if (walk_state->op_info) { | |
4be44fcd | 955 | ACPI_DEBUG_PRINT((ACPI_DB_PARSE, |
b229cf92 | 956 | "Opcode %4.4X [%s] Op %p Aml %p AmlOffset %5.5X\n", |
4be44fcd LB |
957 | (u32) op->common.aml_opcode, |
958 | walk_state->op_info->name, op, | |
959 | parser_state->aml, | |
960 | op->common.aml_offset)); | |
73459f73 RM |
961 | } |
962 | } | |
963 | ||
73459f73 RM |
964 | /* |
965 | * Start arg_count at zero because we don't know if there are | |
966 | * any args yet | |
967 | */ | |
968 | walk_state->arg_count = 0; | |
969 | ||
970 | /* Are there any arguments that must be processed? */ | |
971 | ||
972 | if (walk_state->arg_types) { | |
52fc0b02 | 973 | |
73459f73 RM |
974 | /* Get arguments */ |
975 | ||
4d0b4af9 MK |
976 | status = |
977 | acpi_ps_get_arguments(walk_state, aml_op_start, op); | |
978 | if (ACPI_FAILURE(status)) { | |
4be44fcd | 979 | status = |
4d0b4af9 MK |
980 | acpi_ps_complete_op(walk_state, &op, |
981 | status); | |
4be44fcd | 982 | if (ACPI_FAILURE(status)) { |
4d0b4af9 | 983 | return_ACPI_STATUS(status); |
73459f73 | 984 | } |
73459f73 | 985 | |
4d0b4af9 | 986 | continue; |
73459f73 RM |
987 | } |
988 | } | |
989 | ||
990 | /* Check for arguments that need to be processed */ | |
991 | ||
992 | if (walk_state->arg_count) { | |
993 | /* | |
994 | * There are arguments (complex ones), push Op and | |
995 | * prepare for argument | |
996 | */ | |
4be44fcd LB |
997 | status = acpi_ps_push_scope(parser_state, op, |
998 | walk_state->arg_types, | |
999 | walk_state->arg_count); | |
1000 | if (ACPI_FAILURE(status)) { | |
4d0b4af9 MK |
1001 | status = |
1002 | acpi_ps_complete_op(walk_state, &op, | |
1003 | status); | |
1004 | if (ACPI_FAILURE(status)) { | |
1005 | return_ACPI_STATUS(status); | |
1006 | } | |
1007 | ||
1008 | continue; | |
73459f73 | 1009 | } |
4d0b4af9 | 1010 | |
73459f73 RM |
1011 | op = NULL; |
1012 | continue; | |
1013 | } | |
1014 | ||
1015 | /* | |
1016 | * All arguments have been processed -- Op is complete, | |
1017 | * prepare for next | |
1018 | */ | |
4be44fcd LB |
1019 | walk_state->op_info = |
1020 | acpi_ps_get_opcode_info(op->common.aml_opcode); | |
73459f73 RM |
1021 | if (walk_state->op_info->flags & AML_NAMED) { |
1022 | if (acpi_gbl_depth) { | |
1023 | acpi_gbl_depth--; | |
1024 | } | |
1025 | ||
941f48bb LM |
1026 | if (op->common.aml_opcode == AML_REGION_OP || |
1027 | op->common.aml_opcode == AML_DATA_REGION_OP) { | |
73459f73 RM |
1028 | /* |
1029 | * Skip parsing of control method or opregion body, | |
1030 | * because we don't have enough info in the first pass | |
1031 | * to parse them correctly. | |
1032 | * | |
1033 | * Completed parsing an op_region declaration, we now | |
1034 | * know the length. | |
1035 | */ | |
4be44fcd LB |
1036 | op->named.length = |
1037 | (u32) (parser_state->aml - op->named.data); | |
73459f73 RM |
1038 | } |
1039 | } | |
1040 | ||
1041 | if (walk_state->op_info->flags & AML_CREATE) { | |
1042 | /* | |
1043 | * Backup to beginning of create_xXXfield declaration (1 for | |
1044 | * Opcode) | |
1045 | * | |
1046 | * body_length is unknown until we parse the body | |
1047 | */ | |
4be44fcd LB |
1048 | op->named.length = |
1049 | (u32) (parser_state->aml - op->named.data); | |
73459f73 RM |
1050 | } |
1051 | ||
ef805d95 LM |
1052 | if (op->common.aml_opcode == AML_BANK_FIELD_OP) { |
1053 | /* | |
1054 | * Backup to beginning of bank_field declaration | |
1055 | * | |
1056 | * body_length is unknown until we parse the body | |
1057 | */ | |
1058 | op->named.length = | |
1059 | (u32) (parser_state->aml - op->named.data); | |
1060 | } | |
1061 | ||
73459f73 RM |
1062 | /* This op complete, notify the dispatcher */ |
1063 | ||
1064 | if (walk_state->ascending_callback != NULL) { | |
4be44fcd | 1065 | walk_state->op = op; |
73459f73 RM |
1066 | walk_state->opcode = op->common.aml_opcode; |
1067 | ||
4be44fcd LB |
1068 | status = walk_state->ascending_callback(walk_state); |
1069 | status = | |
1070 | acpi_ps_next_parse_state(walk_state, op, status); | |
73459f73 RM |
1071 | if (status == AE_CTRL_PENDING) { |
1072 | status = AE_OK; | |
73459f73 RM |
1073 | } |
1074 | } | |
1075 | ||
4d0b4af9 MK |
1076 | status = acpi_ps_complete_op(walk_state, &op, status); |
1077 | if (ACPI_FAILURE(status)) { | |
4be44fcd | 1078 | return_ACPI_STATUS(status); |
73459f73 RM |
1079 | } |
1080 | ||
4be44fcd | 1081 | } /* while parser_state->Aml */ |
73459f73 | 1082 | |
4d0b4af9 | 1083 | status = acpi_ps_complete_final_op(walk_state, op, status); |
4be44fcd | 1084 | return_ACPI_STATUS(status); |
73459f73 | 1085 | } |