1 /******************************************************************************
3 * Module Name: psobject - Support for parse objects
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, 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.
44 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_PARSER
50 ACPI_MODULE_NAME("psobject")
52 /* Local prototypes */
53 static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state);
55 /*******************************************************************************
57 * FUNCTION: acpi_ps_get_aml_opcode
59 * PARAMETERS: walk_state - Current state
63 * DESCRIPTION: Extract the next AML opcode from the input stream.
65 ******************************************************************************/
67 static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state)
71 ACPI_FUNCTION_TRACE_PTR(ps_get_aml_opcode, walk_state);
73 walk_state->aml = walk_state->parser_state.aml;
74 walk_state->opcode = acpi_ps_peek_opcode(&(walk_state->parser_state));
77 * First cut to determine what we have found:
78 * 1) A valid AML opcode
80 * 3) An unknown/invalid opcode
82 walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode);
84 switch (walk_state->op_info->class) {
86 case AML_CLASS_PREFIX:
88 * Starts with a valid prefix or ASCII char, this is a name
89 * string. Convert the bare name string to a namepath.
91 walk_state->opcode = AML_INT_NAMEPATH_OP;
92 walk_state->arg_types = ARGP_NAMESTRING;
95 case AML_CLASS_UNKNOWN:
97 /* The opcode is unrecognized. Complain and skip unknown opcodes */
99 if (walk_state->pass_number == 2) {
100 aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml,
102 parser_state.aml_start);
105 "Unknown opcode 0x%.2X at table offset 0x%.4X, ignoring",
108 sizeof(struct acpi_table_header))));
110 ACPI_DUMP_BUFFER((walk_state->parser_state.aml - 16),
113 #ifdef ACPI_ASL_COMPILER
115 * This is executed for the disassembler only. Output goes
116 * to the disassembled ASL output file.
119 ("/*\nError: Unknown opcode 0x%.2X at table offset 0x%.4X, context:\n",
122 sizeof(struct acpi_table_header)));
124 /* Dump the context surrounding the invalid opcode */
126 acpi_ut_dump_buffer(((u8 *)walk_state->parser_state.
127 aml - 16), 48, DB_BYTE_DISPLAY,
129 sizeof(struct acpi_table_header) -
131 acpi_os_printf(" */\n");
135 /* Increment past one-byte or two-byte opcode */
137 walk_state->parser_state.aml++;
138 if (walk_state->opcode > 0xFF) { /* Can only happen if first byte is 0x5B */
139 walk_state->parser_state.aml++;
142 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
146 /* Found opcode info, this is a normal opcode */
148 walk_state->parser_state.aml +=
149 acpi_ps_get_opcode_size(walk_state->opcode);
150 walk_state->arg_types = walk_state->op_info->parse_args;
154 return_ACPI_STATUS(AE_OK);
157 /*******************************************************************************
159 * FUNCTION: acpi_ps_build_named_op
161 * PARAMETERS: walk_state - Current state
162 * aml_op_start - Begin of named Op in AML
163 * unnamed_op - Early Op (not a named Op)
168 * DESCRIPTION: Parse a named Op
170 ******************************************************************************/
173 acpi_ps_build_named_op(struct acpi_walk_state *walk_state,
175 union acpi_parse_object *unnamed_op,
176 union acpi_parse_object **op)
178 acpi_status status = AE_OK;
179 union acpi_parse_object *arg = NULL;
181 ACPI_FUNCTION_TRACE_PTR(ps_build_named_op, walk_state);
183 unnamed_op->common.value.arg = NULL;
184 unnamed_op->common.arg_list_length = 0;
185 unnamed_op->common.aml_opcode = walk_state->opcode;
188 * Get and append arguments until we find the node that contains
189 * the name (the type ARGP_NAME).
191 while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) &&
192 (GET_CURRENT_ARG_TYPE(walk_state->arg_types) != ARGP_NAME)) {
194 acpi_ps_get_next_arg(walk_state,
195 &(walk_state->parser_state),
196 GET_CURRENT_ARG_TYPE(walk_state->
198 if (ACPI_FAILURE(status)) {
199 return_ACPI_STATUS(status);
202 acpi_ps_append_arg(unnamed_op, arg);
203 INCREMENT_ARG_LIST(walk_state->arg_types);
207 * Make sure that we found a NAME and didn't run out of arguments
209 if (!GET_CURRENT_ARG_TYPE(walk_state->arg_types)) {
210 return_ACPI_STATUS(AE_AML_NO_OPERAND);
213 /* We know that this arg is a name, move to next arg */
215 INCREMENT_ARG_LIST(walk_state->arg_types);
218 * Find the object. This will either insert the object into
219 * the namespace or simply look it up
221 walk_state->op = NULL;
223 status = walk_state->descending_callback(walk_state, op);
224 if (ACPI_FAILURE(status)) {
225 if (status != AE_CTRL_TERMINATE) {
226 ACPI_EXCEPTION((AE_INFO, status,
227 "During name lookup/catalog"));
229 return_ACPI_STATUS(status);
233 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
236 status = acpi_ps_next_parse_state(walk_state, *op, status);
237 if (ACPI_FAILURE(status)) {
238 if (status == AE_CTRL_PENDING) {
239 status = AE_CTRL_PARSE_PENDING;
241 return_ACPI_STATUS(status);
244 acpi_ps_append_arg(*op, unnamed_op->common.value.arg);
246 if ((*op)->common.aml_opcode == AML_REGION_OP ||
247 (*op)->common.aml_opcode == AML_DATA_REGION_OP) {
249 * Defer final parsing of an operation_region body, because we don't
250 * have enough info in the first pass to parse it correctly (i.e.,
251 * there may be method calls within the term_arg elements of the body.)
253 * However, we must continue parsing because the opregion is not a
254 * standalone package -- we don't know where the end is at this point.
256 * (Length is unknown until parse of the body complete)
258 (*op)->named.data = aml_op_start;
259 (*op)->named.length = 0;
262 return_ACPI_STATUS(AE_OK);
265 /*******************************************************************************
267 * FUNCTION: acpi_ps_create_op
269 * PARAMETERS: walk_state - Current state
270 * aml_op_start - Op start in AML
271 * new_op - Returned Op
275 * DESCRIPTION: Get Op from AML
277 ******************************************************************************/
280 acpi_ps_create_op(struct acpi_walk_state *walk_state,
281 u8 *aml_op_start, union acpi_parse_object **new_op)
283 acpi_status status = AE_OK;
284 union acpi_parse_object *op;
285 union acpi_parse_object *named_op = NULL;
286 union acpi_parse_object *parent_scope;
288 const struct acpi_opcode_info *op_info;
290 ACPI_FUNCTION_TRACE_PTR(ps_create_op, walk_state);
292 status = acpi_ps_get_aml_opcode(walk_state);
293 if (status == AE_CTRL_PARSE_CONTINUE) {
294 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
297 /* Create Op structure and append to parent's argument list */
299 walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode);
300 op = acpi_ps_alloc_op(walk_state->opcode, aml_op_start);
302 return_ACPI_STATUS(AE_NO_MEMORY);
305 if (walk_state->op_info->flags & AML_NAMED) {
307 acpi_ps_build_named_op(walk_state, aml_op_start, op,
310 if (ACPI_FAILURE(status)) {
311 return_ACPI_STATUS(status);
315 return_ACPI_STATUS(AE_OK);
318 /* Not a named opcode, just allocate Op and append to parent */
320 if (walk_state->op_info->flags & AML_CREATE) {
322 * Backup to beginning of create_XXXfield declaration
323 * body_length is unknown until we parse the body
325 op->named.data = aml_op_start;
326 op->named.length = 0;
329 if (walk_state->opcode == AML_BANK_FIELD_OP) {
331 * Backup to beginning of bank_field declaration
332 * body_length is unknown until we parse the body
334 op->named.data = aml_op_start;
335 op->named.length = 0;
338 parent_scope = acpi_ps_get_parent_scope(&(walk_state->parser_state));
339 acpi_ps_append_arg(parent_scope, op);
343 acpi_ps_get_opcode_info(parent_scope->common.aml_opcode);
344 if (op_info->flags & AML_HAS_TARGET) {
346 acpi_ps_get_argument_count(op_info->type);
347 if (parent_scope->common.arg_list_length >
349 op->common.flags |= ACPI_PARSEOP_TARGET;
354 * Special case for both Increment() and Decrement(), where
355 * the lone argument is both a source and a target.
357 else if ((parent_scope->common.aml_opcode == AML_INCREMENT_OP)
358 || (parent_scope->common.aml_opcode ==
360 op->common.flags |= ACPI_PARSEOP_TARGET;
364 if (walk_state->descending_callback != NULL) {
366 * Find the object. This will either insert the object into
367 * the namespace or simply look it up
369 walk_state->op = *new_op = op;
371 status = walk_state->descending_callback(walk_state, &op);
372 status = acpi_ps_next_parse_state(walk_state, op, status);
373 if (status == AE_CTRL_PENDING) {
374 status = AE_CTRL_PARSE_PENDING;
378 return_ACPI_STATUS(status);
381 /*******************************************************************************
383 * FUNCTION: acpi_ps_complete_op
385 * PARAMETERS: walk_state - Current state
387 * status - Parse status before complete Op
391 * DESCRIPTION: Complete Op
393 ******************************************************************************/
396 acpi_ps_complete_op(struct acpi_walk_state *walk_state,
397 union acpi_parse_object **op, acpi_status status)
401 ACPI_FUNCTION_TRACE_PTR(ps_complete_op, walk_state);
404 * Finished one argument of the containing scope
406 walk_state->parser_state.scope->parse_scope.arg_count--;
408 /* Close this Op (will result in parse subtree deletion) */
410 status2 = acpi_ps_complete_this_op(walk_state, *op);
411 if (ACPI_FAILURE(status2)) {
412 return_ACPI_STATUS(status2);
422 case AE_CTRL_TRANSFER:
424 /* We are about to transfer to a called method */
426 walk_state->prev_op = NULL;
427 walk_state->prev_arg_types = walk_state->arg_types;
428 return_ACPI_STATUS(status);
432 acpi_ps_pop_scope(&(walk_state->parser_state), op,
433 &walk_state->arg_types,
434 &walk_state->arg_count);
437 walk_state->op = *op;
438 walk_state->op_info =
439 acpi_ps_get_opcode_info((*op)->common.aml_opcode);
440 walk_state->opcode = (*op)->common.aml_opcode;
442 status = walk_state->ascending_callback(walk_state);
444 acpi_ps_next_parse_state(walk_state, *op, status);
446 status2 = acpi_ps_complete_this_op(walk_state, *op);
447 if (ACPI_FAILURE(status2)) {
448 return_ACPI_STATUS(status2);
456 case AE_CTRL_CONTINUE:
458 /* Pop off scopes until we find the While */
460 while (!(*op) || ((*op)->common.aml_opcode != AML_WHILE_OP)) {
461 acpi_ps_pop_scope(&(walk_state->parser_state), op,
462 &walk_state->arg_types,
463 &walk_state->arg_count);
466 /* Close this iteration of the While loop */
468 walk_state->op = *op;
469 walk_state->op_info =
470 acpi_ps_get_opcode_info((*op)->common.aml_opcode);
471 walk_state->opcode = (*op)->common.aml_opcode;
473 status = walk_state->ascending_callback(walk_state);
474 status = acpi_ps_next_parse_state(walk_state, *op, status);
476 status2 = acpi_ps_complete_this_op(walk_state, *op);
477 if (ACPI_FAILURE(status2)) {
478 return_ACPI_STATUS(status2);
484 case AE_CTRL_TERMINATE:
490 acpi_ps_complete_this_op(walk_state, *op);
491 if (ACPI_FAILURE(status2)) {
492 return_ACPI_STATUS(status2);
495 acpi_ut_delete_generic_state
496 (acpi_ut_pop_generic_state
497 (&walk_state->control_state));
500 acpi_ps_pop_scope(&(walk_state->parser_state), op,
501 &walk_state->arg_types,
502 &walk_state->arg_count);
506 return_ACPI_STATUS(AE_OK);
508 default: /* All other non-AE_OK status */
513 acpi_ps_complete_this_op(walk_state, *op);
514 if (ACPI_FAILURE(status2)) {
515 return_ACPI_STATUS(status2);
519 acpi_ps_pop_scope(&(walk_state->parser_state), op,
520 &walk_state->arg_types,
521 &walk_state->arg_count);
527 * TBD: Cleanup parse ops on error
530 acpi_ps_pop_scope(parser_state, op,
531 &walk_state->arg_types,
532 &walk_state->arg_count);
535 walk_state->prev_op = NULL;
536 walk_state->prev_arg_types = walk_state->arg_types;
537 return_ACPI_STATUS(status);
540 /* This scope complete? */
542 if (acpi_ps_has_completed_scope(&(walk_state->parser_state))) {
543 acpi_ps_pop_scope(&(walk_state->parser_state), op,
544 &walk_state->arg_types,
545 &walk_state->arg_count);
546 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Popped scope, Op=%p\n", *op));
551 return_ACPI_STATUS(AE_OK);
554 /*******************************************************************************
556 * FUNCTION: acpi_ps_complete_final_op
558 * PARAMETERS: walk_state - Current state
560 * status - Current parse status before complete last
565 * DESCRIPTION: Complete last Op.
567 ******************************************************************************/
570 acpi_ps_complete_final_op(struct acpi_walk_state *walk_state,
571 union acpi_parse_object *op, acpi_status status)
575 ACPI_FUNCTION_TRACE_PTR(ps_complete_final_op, walk_state);
578 * Complete the last Op (if not completed), and clear the scope stack.
579 * It is easily possible to end an AML "package" with an unbounded number
580 * of open scopes (such as when several ASL blocks are closed with
581 * sequential closing braces). We want to terminate each one cleanly.
583 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "AML package complete at Op %p\n",
587 if (walk_state->ascending_callback != NULL) {
589 walk_state->op_info =
590 acpi_ps_get_opcode_info(op->common.
592 walk_state->opcode = op->common.aml_opcode;
595 walk_state->ascending_callback(walk_state);
597 acpi_ps_next_parse_state(walk_state, op,
599 if (status == AE_CTRL_PENDING) {
601 acpi_ps_complete_op(walk_state, &op,
603 if (ACPI_FAILURE(status)) {
604 return_ACPI_STATUS(status);
608 if (status == AE_CTRL_TERMINATE) {
615 acpi_ps_complete_this_op
635 return_ACPI_STATUS(status);
638 else if (ACPI_FAILURE(status)) {
640 /* First error is most important */
643 acpi_ps_complete_this_op(walk_state,
645 return_ACPI_STATUS(status);
649 status2 = acpi_ps_complete_this_op(walk_state, op);
650 if (ACPI_FAILURE(status2)) {
651 return_ACPI_STATUS(status2);
655 acpi_ps_pop_scope(&(walk_state->parser_state), &op,
656 &walk_state->arg_types,
657 &walk_state->arg_count);
661 return_ACPI_STATUS(status);