1 /******************************************************************************
3 * Module Name: psloop - Main AML parse loop
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
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[].
52 #include <acpi/acpi.h>
58 #define _COMPONENT ACPI_PARSER
59 ACPI_MODULE_NAME("psloop")
61 static u32 acpi_gbl_depth
= 0;
63 /* Local prototypes */
65 static acpi_status
acpi_ps_get_aml_opcode(struct acpi_walk_state
*walk_state
);
68 acpi_ps_build_named_op(struct acpi_walk_state
*walk_state
,
70 union acpi_parse_object
*unnamed_op
,
71 union acpi_parse_object
**op
);
74 acpi_ps_create_op(struct acpi_walk_state
*walk_state
,
75 u8
* aml_op_start
, union acpi_parse_object
**new_op
);
78 acpi_ps_get_arguments(struct acpi_walk_state
*walk_state
,
79 u8
* aml_op_start
, union acpi_parse_object
*op
);
82 acpi_ps_complete_op(struct acpi_walk_state
*walk_state
,
83 union acpi_parse_object
**op
, acpi_status status
);
86 acpi_ps_complete_final_op(struct acpi_walk_state
*walk_state
,
87 union acpi_parse_object
*op
, acpi_status status
);
90 acpi_ps_link_module_code(u8
*aml_start
, u32 aml_length
, acpi_owner_id owner_id
);
92 /*******************************************************************************
94 * FUNCTION: acpi_ps_get_aml_opcode
96 * PARAMETERS: walk_state - Current state
100 * DESCRIPTION: Extract the next AML opcode from the input stream.
102 ******************************************************************************/
104 static acpi_status
acpi_ps_get_aml_opcode(struct acpi_walk_state
*walk_state
)
107 ACPI_FUNCTION_TRACE_PTR(ps_get_aml_opcode
, walk_state
);
109 walk_state
->aml_offset
=
110 (u32
) ACPI_PTR_DIFF(walk_state
->parser_state
.aml
,
111 walk_state
->parser_state
.aml_start
);
112 walk_state
->opcode
= acpi_ps_peek_opcode(&(walk_state
->parser_state
));
115 * First cut to determine what we have found:
116 * 1) A valid AML opcode
118 * 3) An unknown/invalid opcode
120 walk_state
->op_info
= acpi_ps_get_opcode_info(walk_state
->opcode
);
122 switch (walk_state
->op_info
->class) {
123 case AML_CLASS_ASCII
:
124 case AML_CLASS_PREFIX
:
126 * Starts with a valid prefix or ASCII char, this is a name
127 * string. Convert the bare name string to a namepath.
129 walk_state
->opcode
= AML_INT_NAMEPATH_OP
;
130 walk_state
->arg_types
= ARGP_NAMESTRING
;
133 case AML_CLASS_UNKNOWN
:
135 /* The opcode is unrecognized. Just skip unknown opcodes */
138 "Found unknown opcode %X at AML address %p offset %X, ignoring",
139 walk_state
->opcode
, walk_state
->parser_state
.aml
,
140 walk_state
->aml_offset
));
142 ACPI_DUMP_BUFFER(walk_state
->parser_state
.aml
, 128);
144 /* Assume one-byte bad opcode */
146 walk_state
->parser_state
.aml
++;
147 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE
);
151 /* Found opcode info, this is a normal opcode */
153 walk_state
->parser_state
.aml
+=
154 acpi_ps_get_opcode_size(walk_state
->opcode
);
155 walk_state
->arg_types
= walk_state
->op_info
->parse_args
;
159 return_ACPI_STATUS(AE_OK
);
162 /*******************************************************************************
164 * FUNCTION: acpi_ps_build_named_op
166 * PARAMETERS: walk_state - Current state
167 * aml_op_start - Begin of named Op in AML
168 * unnamed_op - Early Op (not a named Op)
173 * DESCRIPTION: Parse a named Op
175 ******************************************************************************/
178 acpi_ps_build_named_op(struct acpi_walk_state
*walk_state
,
180 union acpi_parse_object
*unnamed_op
,
181 union acpi_parse_object
**op
)
183 acpi_status status
= AE_OK
;
184 union acpi_parse_object
*arg
= NULL
;
186 ACPI_FUNCTION_TRACE_PTR(ps_build_named_op
, walk_state
);
188 unnamed_op
->common
.value
.arg
= NULL
;
189 unnamed_op
->common
.arg_list_length
= 0;
190 unnamed_op
->common
.aml_opcode
= walk_state
->opcode
;
193 * Get and append arguments until we find the node that contains
194 * the name (the type ARGP_NAME).
196 while (GET_CURRENT_ARG_TYPE(walk_state
->arg_types
) &&
197 (GET_CURRENT_ARG_TYPE(walk_state
->arg_types
) != ARGP_NAME
)) {
199 acpi_ps_get_next_arg(walk_state
,
200 &(walk_state
->parser_state
),
201 GET_CURRENT_ARG_TYPE(walk_state
->
203 if (ACPI_FAILURE(status
)) {
204 return_ACPI_STATUS(status
);
207 acpi_ps_append_arg(unnamed_op
, arg
);
208 INCREMENT_ARG_LIST(walk_state
->arg_types
);
212 * Make sure that we found a NAME and didn't run out of arguments
214 if (!GET_CURRENT_ARG_TYPE(walk_state
->arg_types
)) {
215 return_ACPI_STATUS(AE_AML_NO_OPERAND
);
218 /* We know that this arg is a name, move to next arg */
220 INCREMENT_ARG_LIST(walk_state
->arg_types
);
223 * Find the object. This will either insert the object into
224 * the namespace or simply look it up
226 walk_state
->op
= NULL
;
228 status
= walk_state
->descending_callback(walk_state
, op
);
229 if (ACPI_FAILURE(status
)) {
230 ACPI_EXCEPTION((AE_INFO
, status
, "During name lookup/catalog"));
231 return_ACPI_STATUS(status
);
235 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE
);
238 status
= acpi_ps_next_parse_state(walk_state
, *op
, status
);
239 if (ACPI_FAILURE(status
)) {
240 if (status
== AE_CTRL_PENDING
) {
241 return_ACPI_STATUS(AE_CTRL_PARSE_PENDING
);
243 return_ACPI_STATUS(status
);
246 acpi_ps_append_arg(*op
, unnamed_op
->common
.value
.arg
);
249 if ((*op
)->common
.aml_opcode
== AML_REGION_OP
||
250 (*op
)->common
.aml_opcode
== AML_DATA_REGION_OP
) {
252 * Defer final parsing of an operation_region body, because we don't
253 * have enough info in the first pass to parse it correctly (i.e.,
254 * there may be method calls within the term_arg elements of the body.)
256 * However, we must continue parsing because the opregion is not a
257 * standalone package -- we don't know where the end is at this point.
259 * (Length is unknown until parse of the body complete)
261 (*op
)->named
.data
= aml_op_start
;
262 (*op
)->named
.length
= 0;
265 return_ACPI_STATUS(AE_OK
);
268 /*******************************************************************************
270 * FUNCTION: acpi_ps_create_op
272 * PARAMETERS: walk_state - Current state
273 * aml_op_start - Op start in AML
274 * new_op - Returned Op
278 * DESCRIPTION: Get Op from AML
280 ******************************************************************************/
283 acpi_ps_create_op(struct acpi_walk_state
*walk_state
,
284 u8
* aml_op_start
, union acpi_parse_object
**new_op
)
286 acpi_status status
= AE_OK
;
287 union acpi_parse_object
*op
;
288 union acpi_parse_object
*named_op
= NULL
;
289 union acpi_parse_object
*parent_scope
;
291 const struct acpi_opcode_info
*op_info
;
293 ACPI_FUNCTION_TRACE_PTR(ps_create_op
, walk_state
);
295 status
= acpi_ps_get_aml_opcode(walk_state
);
296 if (status
== AE_CTRL_PARSE_CONTINUE
) {
297 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE
);
300 /* Create Op structure and append to parent's argument list */
302 walk_state
->op_info
= acpi_ps_get_opcode_info(walk_state
->opcode
);
303 op
= acpi_ps_alloc_op(walk_state
->opcode
);
305 return_ACPI_STATUS(AE_NO_MEMORY
);
308 if (walk_state
->op_info
->flags
& AML_NAMED
) {
310 acpi_ps_build_named_op(walk_state
, aml_op_start
, op
,
313 if (ACPI_FAILURE(status
)) {
314 return_ACPI_STATUS(status
);
318 return_ACPI_STATUS(AE_OK
);
321 /* Not a named opcode, just allocate Op and append to parent */
323 if (walk_state
->op_info
->flags
& AML_CREATE
) {
325 * Backup to beginning of create_xXXfield declaration
326 * body_length is unknown until we parse the body
328 op
->named
.data
= aml_op_start
;
329 op
->named
.length
= 0;
332 if (walk_state
->opcode
== AML_BANK_FIELD_OP
) {
334 * Backup to beginning of bank_field declaration
335 * body_length is unknown until we parse the body
337 op
->named
.data
= aml_op_start
;
338 op
->named
.length
= 0;
341 parent_scope
= acpi_ps_get_parent_scope(&(walk_state
->parser_state
));
342 acpi_ps_append_arg(parent_scope
, op
);
346 acpi_ps_get_opcode_info(parent_scope
->common
.aml_opcode
);
347 if (op_info
->flags
& AML_HAS_TARGET
) {
349 acpi_ps_get_argument_count(op_info
->type
);
350 if (parent_scope
->common
.arg_list_length
>
352 op
->common
.flags
|= ACPI_PARSEOP_TARGET
;
354 } else if (parent_scope
->common
.aml_opcode
== AML_INCREMENT_OP
) {
355 op
->common
.flags
|= ACPI_PARSEOP_TARGET
;
359 if (walk_state
->descending_callback
!= NULL
) {
361 * Find the object. This will either insert the object into
362 * the namespace or simply look it up
364 walk_state
->op
= *new_op
= op
;
366 status
= walk_state
->descending_callback(walk_state
, &op
);
367 status
= acpi_ps_next_parse_state(walk_state
, op
, status
);
368 if (status
== AE_CTRL_PENDING
) {
369 status
= AE_CTRL_PARSE_PENDING
;
373 return_ACPI_STATUS(status
);
376 /*******************************************************************************
378 * FUNCTION: acpi_ps_get_arguments
380 * PARAMETERS: walk_state - Current state
381 * aml_op_start - Op start in AML
386 * DESCRIPTION: Get arguments for passed Op.
388 ******************************************************************************/
391 acpi_ps_get_arguments(struct acpi_walk_state
*walk_state
,
392 u8
* aml_op_start
, union acpi_parse_object
*op
)
394 acpi_status status
= AE_OK
;
395 union acpi_parse_object
*arg
= NULL
;
396 const struct acpi_opcode_info
*op_info
;
398 ACPI_FUNCTION_TRACE_PTR(ps_get_arguments
, walk_state
);
400 switch (op
->common
.aml_opcode
) {
401 case AML_BYTE_OP
: /* AML_BYTEDATA_ARG */
402 case AML_WORD_OP
: /* AML_WORDDATA_ARG */
403 case AML_DWORD_OP
: /* AML_DWORDATA_ARG */
404 case AML_QWORD_OP
: /* AML_QWORDATA_ARG */
405 case AML_STRING_OP
: /* AML_ASCIICHARLIST_ARG */
407 /* Fill in constant or string argument directly */
409 acpi_ps_get_next_simple_arg(&(walk_state
->parser_state
),
410 GET_CURRENT_ARG_TYPE(walk_state
->
415 case AML_INT_NAMEPATH_OP
: /* AML_NAMESTRING_ARG */
418 acpi_ps_get_next_namepath(walk_state
,
419 &(walk_state
->parser_state
), op
,
421 if (ACPI_FAILURE(status
)) {
422 return_ACPI_STATUS(status
);
425 walk_state
->arg_types
= 0;
430 * Op is not a constant or string, append each argument to the Op
432 while (GET_CURRENT_ARG_TYPE(walk_state
->arg_types
)
433 && !walk_state
->arg_count
) {
434 walk_state
->aml_offset
=
435 (u32
) ACPI_PTR_DIFF(walk_state
->parser_state
.aml
,
436 walk_state
->parser_state
.
440 acpi_ps_get_next_arg(walk_state
,
441 &(walk_state
->parser_state
),
443 (walk_state
->arg_types
), &arg
);
444 if (ACPI_FAILURE(status
)) {
445 return_ACPI_STATUS(status
);
449 arg
->common
.aml_offset
= walk_state
->aml_offset
;
450 acpi_ps_append_arg(op
, arg
);
453 INCREMENT_ARG_LIST(walk_state
->arg_types
);
457 * Handle executable code at "module-level". This refers to
458 * executable opcodes that appear outside of any control method.
460 if ((walk_state
->pass_number
<= ACPI_IMODE_LOAD_PASS2
) &&
461 ((walk_state
->parse_flags
& ACPI_PARSE_DISASSEMBLE
) == 0)) {
463 * We want to skip If/Else/While constructs during Pass1 because we
464 * want to actually conditionally execute the code during Pass2.
466 * Except for disassembly, where we always want to walk the
467 * If/Else/While packages
469 switch (op
->common
.aml_opcode
) {
475 * Currently supported module-level opcodes are:
476 * IF/ELSE/WHILE. These appear to be the most common,
477 * and easiest to support since they open an AML
480 if (walk_state
->pass_number
==
481 ACPI_IMODE_LOAD_PASS1
) {
482 acpi_ps_link_module_code(aml_op_start
,
491 ACPI_DEBUG_PRINT((ACPI_DB_PARSE
,
492 "Pass1: Skipping an If/Else/While body\n"));
494 /* Skip body of if/else/while in pass 1 */
496 walk_state
->parser_state
.aml
=
497 walk_state
->parser_state
.pkg_end
;
498 walk_state
->arg_count
= 0;
503 * Check for an unsupported executable opcode at module
504 * level. We must be in PASS1, the parent must be a SCOPE,
505 * The opcode class must be EXECUTE, and the opcode must
506 * not be an argument to another opcode.
508 if ((walk_state
->pass_number
==
509 ACPI_IMODE_LOAD_PASS1
)
510 && (op
->common
.parent
->common
.aml_opcode
==
513 acpi_ps_get_opcode_info(op
->common
.
515 if ((op_info
->class ==
516 AML_CLASS_EXECUTE
) && (!arg
)) {
517 ACPI_WARNING((AE_INFO
,
518 "Detected an unsupported executable opcode "
519 "at module-level: [0x%.4X] at table offset 0x%.4X",
520 op
->common
.aml_opcode
,
521 (u32
)((aml_op_start
- walk_state
->parser_state
.aml_start
)
522 + sizeof(struct acpi_table_header
))));
529 /* Special processing for certain opcodes */
531 switch (op
->common
.aml_opcode
) {
534 * Skip parsing of control method because we don't have enough
535 * info in the first pass to parse it correctly.
537 * Save the length and address of the body
539 op
->named
.data
= walk_state
->parser_state
.aml
;
540 op
->named
.length
= (u32
)
541 (walk_state
->parser_state
.pkg_end
-
542 walk_state
->parser_state
.aml
);
544 /* Skip body of method */
546 walk_state
->parser_state
.aml
=
547 walk_state
->parser_state
.pkg_end
;
548 walk_state
->arg_count
= 0;
553 case AML_VAR_PACKAGE_OP
:
555 if ((op
->common
.parent
) &&
556 (op
->common
.parent
->common
.aml_opcode
==
558 && (walk_state
->pass_number
<=
559 ACPI_IMODE_LOAD_PASS2
)) {
561 * Skip parsing of Buffers and Packages because we don't have
562 * enough info in the first pass to parse them correctly.
564 op
->named
.data
= aml_op_start
;
565 op
->named
.length
= (u32
)
566 (walk_state
->parser_state
.pkg_end
-
571 walk_state
->parser_state
.aml
=
572 walk_state
->parser_state
.pkg_end
;
573 walk_state
->arg_count
= 0;
579 if (walk_state
->control_state
) {
580 walk_state
->control_state
->control
.package_end
=
581 walk_state
->parser_state
.pkg_end
;
587 /* No action for all other opcodes */
594 return_ACPI_STATUS(AE_OK
);
597 /*******************************************************************************
599 * FUNCTION: acpi_ps_link_module_code
601 * PARAMETERS: aml_start - Pointer to the AML
602 * aml_length - Length of executable AML
603 * owner_id - owner_id of module level code
607 * DESCRIPTION: Wrap the module-level code with a method object and link the
608 * object to the global list. Note, the mutex field of the method
609 * object is used to link multiple module-level code objects.
611 ******************************************************************************/
614 acpi_ps_link_module_code(u8
*aml_start
, u32 aml_length
, acpi_owner_id owner_id
)
616 union acpi_operand_object
*prev
;
617 union acpi_operand_object
*next
;
618 union acpi_operand_object
*method_obj
;
620 /* Get the tail of the list */
622 prev
= next
= acpi_gbl_module_code_list
;
625 next
= next
->method
.mutex
;
629 * Insert the module level code into the list. Merge it if it is
630 * adjacent to the previous element.
633 ((prev
->method
.aml_start
+ prev
->method
.aml_length
) != aml_start
)) {
635 /* Create, initialize, and link a new temporary method object */
637 method_obj
= acpi_ut_create_internal_object(ACPI_TYPE_METHOD
);
642 method_obj
->method
.aml_start
= aml_start
;
643 method_obj
->method
.aml_length
= aml_length
;
644 method_obj
->method
.owner_id
= owner_id
;
645 method_obj
->method
.flags
|= AOPOBJ_MODULE_LEVEL
;
648 acpi_gbl_module_code_list
= method_obj
;
650 prev
->method
.mutex
= method_obj
;
653 prev
->method
.aml_length
+= aml_length
;
657 /*******************************************************************************
659 * FUNCTION: acpi_ps_complete_op
661 * PARAMETERS: walk_state - Current state
663 * Status - Parse status before complete Op
667 * DESCRIPTION: Complete Op
669 ******************************************************************************/
672 acpi_ps_complete_op(struct acpi_walk_state
*walk_state
,
673 union acpi_parse_object
**op
, acpi_status status
)
677 ACPI_FUNCTION_TRACE_PTR(ps_complete_op
, walk_state
);
680 * Finished one argument of the containing scope
682 walk_state
->parser_state
.scope
->parse_scope
.arg_count
--;
684 /* Close this Op (will result in parse subtree deletion) */
686 status2
= acpi_ps_complete_this_op(walk_state
, *op
);
687 if (ACPI_FAILURE(status2
)) {
688 return_ACPI_STATUS(status2
);
697 case AE_CTRL_TRANSFER
:
699 /* We are about to transfer to a called method */
701 walk_state
->prev_op
= NULL
;
702 walk_state
->prev_arg_types
= walk_state
->arg_types
;
703 return_ACPI_STATUS(status
);
707 acpi_ps_pop_scope(&(walk_state
->parser_state
), op
,
708 &walk_state
->arg_types
,
709 &walk_state
->arg_count
);
712 walk_state
->op
= *op
;
713 walk_state
->op_info
=
714 acpi_ps_get_opcode_info((*op
)->common
.aml_opcode
);
715 walk_state
->opcode
= (*op
)->common
.aml_opcode
;
717 status
= walk_state
->ascending_callback(walk_state
);
719 acpi_ps_next_parse_state(walk_state
, *op
, status
);
721 status2
= acpi_ps_complete_this_op(walk_state
, *op
);
722 if (ACPI_FAILURE(status2
)) {
723 return_ACPI_STATUS(status2
);
731 case AE_CTRL_CONTINUE
:
733 /* Pop off scopes until we find the While */
735 while (!(*op
) || ((*op
)->common
.aml_opcode
!= AML_WHILE_OP
)) {
736 acpi_ps_pop_scope(&(walk_state
->parser_state
), op
,
737 &walk_state
->arg_types
,
738 &walk_state
->arg_count
);
741 /* Close this iteration of the While loop */
743 walk_state
->op
= *op
;
744 walk_state
->op_info
=
745 acpi_ps_get_opcode_info((*op
)->common
.aml_opcode
);
746 walk_state
->opcode
= (*op
)->common
.aml_opcode
;
748 status
= walk_state
->ascending_callback(walk_state
);
749 status
= acpi_ps_next_parse_state(walk_state
, *op
, status
);
751 status2
= acpi_ps_complete_this_op(walk_state
, *op
);
752 if (ACPI_FAILURE(status2
)) {
753 return_ACPI_STATUS(status2
);
759 case AE_CTRL_TERMINATE
:
765 acpi_ps_complete_this_op(walk_state
, *op
);
766 if (ACPI_FAILURE(status2
)) {
767 return_ACPI_STATUS(status2
);
770 acpi_ut_delete_generic_state
771 (acpi_ut_pop_generic_state
772 (&walk_state
->control_state
));
775 acpi_ps_pop_scope(&(walk_state
->parser_state
), op
,
776 &walk_state
->arg_types
,
777 &walk_state
->arg_count
);
781 return_ACPI_STATUS(AE_OK
);
783 default: /* All other non-AE_OK status */
788 acpi_ps_complete_this_op(walk_state
, *op
);
789 if (ACPI_FAILURE(status2
)) {
790 return_ACPI_STATUS(status2
);
794 acpi_ps_pop_scope(&(walk_state
->parser_state
), op
,
795 &walk_state
->arg_types
,
796 &walk_state
->arg_count
);
802 * TBD: Cleanup parse ops on error
805 acpi_ps_pop_scope(parser_state
, op
,
806 &walk_state
->arg_types
,
807 &walk_state
->arg_count
);
810 walk_state
->prev_op
= NULL
;
811 walk_state
->prev_arg_types
= walk_state
->arg_types
;
812 return_ACPI_STATUS(status
);
815 /* This scope complete? */
817 if (acpi_ps_has_completed_scope(&(walk_state
->parser_state
))) {
818 acpi_ps_pop_scope(&(walk_state
->parser_state
), op
,
819 &walk_state
->arg_types
,
820 &walk_state
->arg_count
);
821 ACPI_DEBUG_PRINT((ACPI_DB_PARSE
, "Popped scope, Op=%p\n", *op
));
826 ACPI_PREEMPTION_POINT();
828 return_ACPI_STATUS(AE_OK
);
831 /*******************************************************************************
833 * FUNCTION: acpi_ps_complete_final_op
835 * PARAMETERS: walk_state - Current state
837 * Status - Current parse status before complete last
842 * DESCRIPTION: Complete last Op.
844 ******************************************************************************/
847 acpi_ps_complete_final_op(struct acpi_walk_state
*walk_state
,
848 union acpi_parse_object
*op
, acpi_status status
)
852 ACPI_FUNCTION_TRACE_PTR(ps_complete_final_op
, walk_state
);
855 * Complete the last Op (if not completed), and clear the scope stack.
856 * It is easily possible to end an AML "package" with an unbounded number
857 * of open scopes (such as when several ASL blocks are closed with
858 * sequential closing braces). We want to terminate each one cleanly.
860 ACPI_DEBUG_PRINT((ACPI_DB_PARSE
, "AML package complete at Op %p\n",
864 if (walk_state
->ascending_callback
!= NULL
) {
866 walk_state
->op_info
=
867 acpi_ps_get_opcode_info(op
->common
.
869 walk_state
->opcode
= op
->common
.aml_opcode
;
872 walk_state
->ascending_callback(walk_state
);
874 acpi_ps_next_parse_state(walk_state
, op
,
876 if (status
== AE_CTRL_PENDING
) {
878 acpi_ps_complete_op(walk_state
, &op
,
880 if (ACPI_FAILURE(status
)) {
881 return_ACPI_STATUS(status
);
885 if (status
== AE_CTRL_TERMINATE
) {
892 acpi_ps_complete_this_op
912 return_ACPI_STATUS(status
);
915 else if (ACPI_FAILURE(status
)) {
917 /* First error is most important */
920 acpi_ps_complete_this_op(walk_state
,
922 return_ACPI_STATUS(status
);
926 status2
= acpi_ps_complete_this_op(walk_state
, op
);
927 if (ACPI_FAILURE(status2
)) {
928 return_ACPI_STATUS(status2
);
932 acpi_ps_pop_scope(&(walk_state
->parser_state
), &op
,
933 &walk_state
->arg_types
,
934 &walk_state
->arg_count
);
938 return_ACPI_STATUS(status
);
941 /*******************************************************************************
943 * FUNCTION: acpi_ps_parse_loop
945 * PARAMETERS: walk_state - Current state
949 * DESCRIPTION: Parse AML (pointed to by the current parser state) and return
952 ******************************************************************************/
954 acpi_status
acpi_ps_parse_loop(struct acpi_walk_state
*walk_state
)
956 acpi_status status
= AE_OK
;
957 union acpi_parse_object
*op
= NULL
; /* current op */
958 struct acpi_parse_state
*parser_state
;
959 u8
*aml_op_start
= NULL
;
961 ACPI_FUNCTION_TRACE_PTR(ps_parse_loop
, walk_state
);
963 if (walk_state
->descending_callback
== NULL
) {
964 return_ACPI_STATUS(AE_BAD_PARAMETER
);
967 parser_state
= &walk_state
->parser_state
;
968 walk_state
->arg_types
= 0;
970 #if (!defined (ACPI_NO_METHOD_EXECUTION) && !defined (ACPI_CONSTANT_EVAL_ONLY))
972 if (walk_state
->walk_type
& ACPI_WALK_METHOD_RESTART
) {
974 /* We are restarting a preempted control method */
976 if (acpi_ps_has_completed_scope(parser_state
)) {
978 * We must check if a predicate to an IF or WHILE statement
981 if ((parser_state
->scope
->parse_scope
.op
) &&
982 ((parser_state
->scope
->parse_scope
.op
->common
.
983 aml_opcode
== AML_IF_OP
)
984 || (parser_state
->scope
->parse_scope
.op
->common
.
985 aml_opcode
== AML_WHILE_OP
))
986 && (walk_state
->control_state
)
987 && (walk_state
->control_state
->common
.state
==
988 ACPI_CONTROL_PREDICATE_EXECUTING
)) {
990 * A predicate was just completed, get the value of the
991 * predicate and branch based on that value
993 walk_state
->op
= NULL
;
995 acpi_ds_get_predicate_value(walk_state
,
998 if (ACPI_FAILURE(status
)
999 && ((status
& AE_CODE_MASK
) !=
1001 if (status
== AE_AML_NO_RETURN_VALUE
) {
1002 ACPI_EXCEPTION((AE_INFO
, status
,
1003 "Invoked method did not return a value"));
1007 ACPI_EXCEPTION((AE_INFO
, status
,
1008 "GetPredicate Failed"));
1009 return_ACPI_STATUS(status
);
1013 acpi_ps_next_parse_state(walk_state
, op
,
1017 acpi_ps_pop_scope(parser_state
, &op
,
1018 &walk_state
->arg_types
,
1019 &walk_state
->arg_count
);
1020 ACPI_DEBUG_PRINT((ACPI_DB_PARSE
,
1021 "Popped scope, Op=%p\n", op
));
1022 } else if (walk_state
->prev_op
) {
1024 /* We were in the middle of an op */
1026 op
= walk_state
->prev_op
;
1027 walk_state
->arg_types
= walk_state
->prev_arg_types
;
1032 /* Iterative parsing loop, while there is more AML to process: */
1034 while ((parser_state
->aml
< parser_state
->aml_end
) || (op
)) {
1035 aml_op_start
= parser_state
->aml
;
1038 acpi_ps_create_op(walk_state
, aml_op_start
, &op
);
1039 if (ACPI_FAILURE(status
)) {
1040 if (status
== AE_CTRL_PARSE_CONTINUE
) {
1044 if (status
== AE_CTRL_PARSE_PENDING
) {
1049 acpi_ps_complete_op(walk_state
, &op
,
1051 if (ACPI_FAILURE(status
)) {
1052 return_ACPI_STATUS(status
);
1058 op
->common
.aml_offset
= walk_state
->aml_offset
;
1060 if (walk_state
->op_info
) {
1061 ACPI_DEBUG_PRINT((ACPI_DB_PARSE
,
1062 "Opcode %4.4X [%s] Op %p Aml %p AmlOffset %5.5X\n",
1063 (u32
) op
->common
.aml_opcode
,
1064 walk_state
->op_info
->name
, op
,
1066 op
->common
.aml_offset
));
1071 * Start arg_count at zero because we don't know if there are
1074 walk_state
->arg_count
= 0;
1076 /* Are there any arguments that must be processed? */
1078 if (walk_state
->arg_types
) {
1083 acpi_ps_get_arguments(walk_state
, aml_op_start
, op
);
1084 if (ACPI_FAILURE(status
)) {
1086 acpi_ps_complete_op(walk_state
, &op
,
1088 if (ACPI_FAILURE(status
)) {
1089 return_ACPI_STATUS(status
);
1096 /* Check for arguments that need to be processed */
1098 if (walk_state
->arg_count
) {
1100 * There are arguments (complex ones), push Op and
1101 * prepare for argument
1103 status
= acpi_ps_push_scope(parser_state
, op
,
1104 walk_state
->arg_types
,
1105 walk_state
->arg_count
);
1106 if (ACPI_FAILURE(status
)) {
1108 acpi_ps_complete_op(walk_state
, &op
,
1110 if (ACPI_FAILURE(status
)) {
1111 return_ACPI_STATUS(status
);
1122 * All arguments have been processed -- Op is complete,
1125 walk_state
->op_info
=
1126 acpi_ps_get_opcode_info(op
->common
.aml_opcode
);
1127 if (walk_state
->op_info
->flags
& AML_NAMED
) {
1128 if (acpi_gbl_depth
) {
1132 if (op
->common
.aml_opcode
== AML_REGION_OP
||
1133 op
->common
.aml_opcode
== AML_DATA_REGION_OP
) {
1135 * Skip parsing of control method or opregion body,
1136 * because we don't have enough info in the first pass
1137 * to parse them correctly.
1139 * Completed parsing an op_region declaration, we now
1143 (u32
) (parser_state
->aml
- op
->named
.data
);
1147 if (walk_state
->op_info
->flags
& AML_CREATE
) {
1149 * Backup to beginning of create_xXXfield declaration (1 for
1152 * body_length is unknown until we parse the body
1155 (u32
) (parser_state
->aml
- op
->named
.data
);
1158 if (op
->common
.aml_opcode
== AML_BANK_FIELD_OP
) {
1160 * Backup to beginning of bank_field declaration
1162 * body_length is unknown until we parse the body
1165 (u32
) (parser_state
->aml
- op
->named
.data
);
1168 /* This op complete, notify the dispatcher */
1170 if (walk_state
->ascending_callback
!= NULL
) {
1171 walk_state
->op
= op
;
1172 walk_state
->opcode
= op
->common
.aml_opcode
;
1174 status
= walk_state
->ascending_callback(walk_state
);
1176 acpi_ps_next_parse_state(walk_state
, op
, status
);
1177 if (status
== AE_CTRL_PENDING
) {
1182 status
= acpi_ps_complete_op(walk_state
, &op
, status
);
1183 if (ACPI_FAILURE(status
)) {
1184 return_ACPI_STATUS(status
);
1187 } /* while parser_state->Aml */
1189 status
= acpi_ps_complete_final_op(walk_state
, op
, status
);
1190 return_ACPI_STATUS(status
);