drivers/acpi/acpica/psobject.c

   1 /******************************************************************************
   2  *
   3  * Module Name: psobject - Support for parse objects
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2018, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include "accommon.h"
  46 #include "acparser.h"
  47 #include "amlcode.h"
  48 #include "acconvert.h"
  49
  50 #define _COMPONENT          ACPI_PARSER
  51 ACPI_MODULE_NAME("psobject")
  52
  53 /* Local prototypes */
  54 static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state);
  55
  56 /*******************************************************************************
  57  *
  58  * FUNCTION:    acpi_ps_get_aml_opcode
  59  *
  60  * PARAMETERS:  walk_state          - Current state
  61  *
  62  * RETURN:      Status
  63  *
  64  * DESCRIPTION: Extract the next AML opcode from the input stream.
  65  *
  66  ******************************************************************************/
  67
  68 static acpi_status acpi_ps_get_aml_opcode(struct acpi_walk_state *walk_state)
  69 {
  70         u32 aml_offset;
  71
  72         ACPI_FUNCTION_TRACE_PTR(ps_get_aml_opcode, walk_state);
  73
  74         walk_state->aml = walk_state->parser_state.aml;
  75         walk_state->opcode = acpi_ps_peek_opcode(&(walk_state->parser_state));
  76
  77         /*
  78          * First cut to determine what we have found:
  79          * 1) A valid AML opcode
  80          * 2) A name string
  81          * 3) An unknown/invalid opcode
  82          */
  83         walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode);
  84
  85         switch (walk_state->op_info->class) {
  86         case AML_CLASS_ASCII:
  87         case AML_CLASS_PREFIX:
  88                 /*
  89                  * Starts with a valid prefix or ASCII char, this is a name
  90                  * string. Convert the bare name string to a namepath.
  91                  */
  92                 walk_state->opcode = AML_INT_NAMEPATH_OP;
  93                 walk_state->arg_types = ARGP_NAMESTRING;
  94                 break;
  95
  96         case AML_CLASS_UNKNOWN:
  97
  98                 /* The opcode is unrecognized. Complain and skip unknown opcodes */
  99
 100                 if (walk_state->pass_number == 2) {
 101                         aml_offset = (u32)ACPI_PTR_DIFF(walk_state->aml,
 102                                                         walk_state->
 103                                                         parser_state.aml_start);
 104
 105                         ACPI_ERROR((AE_INFO,
 106                                     "Unknown opcode 0x%.2X at table offset 0x%.4X, ignoring",
 107                                     walk_state->opcode,
 108                                     (u32)(aml_offset +
 109                                           sizeof(struct acpi_table_header))));
 110
 111                         ACPI_DUMP_BUFFER((walk_state->parser_state.aml - 16),
 112                                          48);
 113
 114 #ifdef ACPI_ASL_COMPILER
 115                         /*
 116                          * This is executed for the disassembler only. Output goes
 117                          * to the disassembled ASL output file.
 118                          */
 119                         acpi_os_printf
 120                             ("/*\nError: Unknown opcode 0x%.2X at table offset 0x%.4X, context:\n",
 121                              walk_state->opcode,
 122                              (u32)(aml_offset +
 123                                    sizeof(struct acpi_table_header)));
 124
 125                         ACPI_ERROR((AE_INFO,
 126                                     "Aborting disassembly, AML byte code is corrupt"));
 127
 128                         /* Dump the context surrounding the invalid opcode */
 129
 130                         acpi_ut_dump_buffer(((u8 *)walk_state->parser_state.
 131                                              aml - 16), 48, DB_BYTE_DISPLAY,
 132                                             (aml_offset +
 133                                              sizeof(struct acpi_table_header) -
 134                                              16));
 135                         acpi_os_printf(" */\n");
 136
 137                         /*
 138                          * Just abort the disassembly, cannot continue because the
 139                          * parser is essentially lost. The disassembler can then
 140                          * randomly fail because an ill-constructed parse tree
 141                          * can result.
 142                          */
 143                         return_ACPI_STATUS(AE_AML_BAD_OPCODE);
 144 #endif
 145                 }
 146
 147                 /* Increment past one-byte or two-byte opcode */
 148
 149                 walk_state->parser_state.aml++;
 150                 if (walk_state->opcode > 0xFF) {        /* Can only happen if first byte is 0x5B */
 151                         walk_state->parser_state.aml++;
 152                 }
 153
 154                 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
 155
 156         default:
 157
 158                 /* Found opcode info, this is a normal opcode */
 159
 160                 walk_state->parser_state.aml +=
 161                     acpi_ps_get_opcode_size(walk_state->opcode);
 162                 walk_state->arg_types = walk_state->op_info->parse_args;
 163                 break;
 164         }
 165
 166         return_ACPI_STATUS(AE_OK);
 167 }
 168
 169 /*******************************************************************************
 170  *
 171  * FUNCTION:    acpi_ps_build_named_op
 172  *
 173  * PARAMETERS:  walk_state          - Current state
 174  *              aml_op_start        - Begin of named Op in AML
 175  *              unnamed_op          - Early Op (not a named Op)
 176  *              op                  - Returned Op
 177  *
 178  * RETURN:      Status
 179  *
 180  * DESCRIPTION: Parse a named Op
 181  *
 182  ******************************************************************************/
 183
 184 acpi_status
 185 acpi_ps_build_named_op(struct acpi_walk_state *walk_state,
 186                        u8 *aml_op_start,
 187                        union acpi_parse_object *unnamed_op,
 188                        union acpi_parse_object **op)
 189 {
 190         acpi_status status = AE_OK;
 191         union acpi_parse_object *arg = NULL;
 192
 193         ACPI_FUNCTION_TRACE_PTR(ps_build_named_op, walk_state);
 194
 195         unnamed_op->common.value.arg = NULL;
 196         unnamed_op->common.arg_list_length = 0;
 197         unnamed_op->common.aml_opcode = walk_state->opcode;
 198
 199         /*
 200          * Get and append arguments until we find the node that contains
 201          * the name (the type ARGP_NAME).
 202          */
 203         while (GET_CURRENT_ARG_TYPE(walk_state->arg_types) &&
 204                (GET_CURRENT_ARG_TYPE(walk_state->arg_types) != ARGP_NAME)) {
 205                 ASL_CV_CAPTURE_COMMENTS(walk_state);
 206                 status =
 207                     acpi_ps_get_next_arg(walk_state,
 208                                          &(walk_state->parser_state),
 209                                          GET_CURRENT_ARG_TYPE(walk_state->
 210                                                               arg_types), &arg);
 211                 if (ACPI_FAILURE(status)) {
 212                         return_ACPI_STATUS(status);
 213                 }
 214
 215                 acpi_ps_append_arg(unnamed_op, arg);
 216                 INCREMENT_ARG_LIST(walk_state->arg_types);
 217         }
 218
 219         /* are there any inline comments associated with the name_seg?? If so, save this. */
 220
 221         ASL_CV_CAPTURE_COMMENTS(walk_state);
 222
 223 #ifdef ACPI_ASL_COMPILER
 224         if (acpi_gbl_current_inline_comment != NULL) {
 225                 unnamed_op->common.name_comment =
 226                     acpi_gbl_current_inline_comment;
 227                 acpi_gbl_current_inline_comment = NULL;
 228         }
 229 #endif
 230
 231         /*
 232          * Make sure that we found a NAME and didn't run out of arguments
 233          */
 234         if (!GET_CURRENT_ARG_TYPE(walk_state->arg_types)) {
 235                 return_ACPI_STATUS(AE_AML_NO_OPERAND);
 236         }
 237
 238         /* We know that this arg is a name, move to next arg */
 239
 240         INCREMENT_ARG_LIST(walk_state->arg_types);
 241
 242         /*
 243          * Find the object. This will either insert the object into
 244          * the namespace or simply look it up
 245          */
 246         walk_state->op = NULL;
 247
 248         status = walk_state->descending_callback(walk_state, op);
 249         if (ACPI_FAILURE(status)) {
 250                 if (status != AE_CTRL_TERMINATE) {
 251                         ACPI_EXCEPTION((AE_INFO, status,
 252                                         "During name lookup/catalog"));
 253                 }
 254                 return_ACPI_STATUS(status);
 255         }
 256
 257         if (!*op) {
 258                 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
 259         }
 260
 261         status = acpi_ps_next_parse_state(walk_state, *op, status);
 262         if (ACPI_FAILURE(status)) {
 263                 if (status == AE_CTRL_PENDING) {
 264                         status = AE_CTRL_PARSE_PENDING;
 265                 }
 266                 return_ACPI_STATUS(status);
 267         }
 268
 269         acpi_ps_append_arg(*op, unnamed_op->common.value.arg);
 270
 271 #ifdef ACPI_ASL_COMPILER
 272
 273         /* save any comments that might be associated with unnamed_op. */
 274
 275         (*op)->common.inline_comment = unnamed_op->common.inline_comment;
 276         (*op)->common.end_node_comment = unnamed_op->common.end_node_comment;
 277         (*op)->common.close_brace_comment =
 278             unnamed_op->common.close_brace_comment;
 279         (*op)->common.name_comment = unnamed_op->common.name_comment;
 280         (*op)->common.comment_list = unnamed_op->common.comment_list;
 281         (*op)->common.end_blk_comment = unnamed_op->common.end_blk_comment;
 282         (*op)->common.cv_filename = unnamed_op->common.cv_filename;
 283         (*op)->common.cv_parent_filename =
 284             unnamed_op->common.cv_parent_filename;
 285         (*op)->named.aml = unnamed_op->common.aml;
 286
 287         unnamed_op->common.inline_comment = NULL;
 288         unnamed_op->common.end_node_comment = NULL;
 289         unnamed_op->common.close_brace_comment = NULL;
 290         unnamed_op->common.name_comment = NULL;
 291         unnamed_op->common.comment_list = NULL;
 292         unnamed_op->common.end_blk_comment = NULL;
 293 #endif
 294
 295         if ((*op)->common.aml_opcode == AML_REGION_OP ||
 296             (*op)->common.aml_opcode == AML_DATA_REGION_OP) {
 297                 /*
 298                  * Defer final parsing of an operation_region body, because we don't
 299                  * have enough info in the first pass to parse it correctly (i.e.,
 300                  * there may be method calls within the term_arg elements of the body.)
 301                  *
 302                  * However, we must continue parsing because the opregion is not a
 303                  * standalone package -- we don't know where the end is at this point.
 304                  *
 305                  * (Length is unknown until parse of the body complete)
 306                  */
 307                 (*op)->named.data = aml_op_start;
 308                 (*op)->named.length = 0;
 309         }
 310
 311         return_ACPI_STATUS(AE_OK);
 312 }
 313
 314 /*******************************************************************************
 315  *
 316  * FUNCTION:    acpi_ps_create_op
 317  *
 318  * PARAMETERS:  walk_state          - Current state
 319  *              aml_op_start        - Op start in AML
 320  *              new_op              - Returned Op
 321  *
 322  * RETURN:      Status
 323  *
 324  * DESCRIPTION: Get Op from AML
 325  *
 326  ******************************************************************************/
 327
 328 acpi_status
 329 acpi_ps_create_op(struct acpi_walk_state *walk_state,
 330                   u8 *aml_op_start, union acpi_parse_object **new_op)
 331 {
 332         acpi_status status = AE_OK;
 333         union acpi_parse_object *op;
 334         union acpi_parse_object *named_op = NULL;
 335         union acpi_parse_object *parent_scope;
 336         u8 argument_count;
 337         const struct acpi_opcode_info *op_info;
 338
 339         ACPI_FUNCTION_TRACE_PTR(ps_create_op, walk_state);
 340
 341         status = acpi_ps_get_aml_opcode(walk_state);
 342         if (status == AE_CTRL_PARSE_CONTINUE) {
 343                 return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
 344         }
 345         if (ACPI_FAILURE(status)) {
 346                 return_ACPI_STATUS(status);
 347         }
 348
 349         /* Create Op structure and append to parent's argument list */
 350
 351         walk_state->op_info = acpi_ps_get_opcode_info(walk_state->opcode);
 352         op = acpi_ps_alloc_op(walk_state->opcode, aml_op_start);
 353         if (!op) {
 354                 return_ACPI_STATUS(AE_NO_MEMORY);
 355         }
 356
 357         if (walk_state->op_info->flags & AML_NAMED) {
 358                 status =
 359                     acpi_ps_build_named_op(walk_state, aml_op_start, op,
 360                                            &named_op);
 361                 acpi_ps_free_op(op);
 362
 363 #ifdef ACPI_ASL_COMPILER
 364                 if (acpi_gbl_disasm_flag
 365                     && walk_state->opcode == AML_EXTERNAL_OP
 366                     && status == AE_NOT_FOUND) {
 367                         /*
 368                          * If parsing of AML_EXTERNAL_OP's name path fails, then skip
 369                          * past this opcode and keep parsing. This is a much better
 370                          * alternative than to abort the entire disassembler. At this
 371                          * point, the parser_state is at the end of the namepath of the
 372                          * external declaration opcode. Setting walk_state->Aml to
 373                          * walk_state->parser_state.Aml + 2 moves increments the
 374                          * walk_state->Aml past the object type and the paramcount of the
 375                          * external opcode.
 376                          */
 377                         walk_state->aml = walk_state->parser_state.aml + 2;
 378                         walk_state->parser_state.aml = walk_state->aml;
 379                         return_ACPI_STATUS(AE_CTRL_PARSE_CONTINUE);
 380                 }
 381 #endif
 382                 if (ACPI_FAILURE(status)) {
 383                         return_ACPI_STATUS(status);
 384                 }
 385
 386                 *new_op = named_op;
 387                 return_ACPI_STATUS(AE_OK);
 388         }
 389
 390         /* Not a named opcode, just allocate Op and append to parent */
 391
 392         if (walk_state->op_info->flags & AML_CREATE) {
 393                 /*
 394                  * Backup to beginning of create_XXXfield declaration
 395                  * body_length is unknown until we parse the body
 396                  */
 397                 op->named.data = aml_op_start;
 398                 op->named.length = 0;
 399         }
 400
 401         if (walk_state->opcode == AML_BANK_FIELD_OP) {
 402                 /*
 403                  * Backup to beginning of bank_field declaration
 404                  * body_length is unknown until we parse the body
 405                  */
 406                 op->named.data = aml_op_start;
 407                 op->named.length = 0;
 408         }
 409
 410         parent_scope = acpi_ps_get_parent_scope(&(walk_state->parser_state));
 411         acpi_ps_append_arg(parent_scope, op);
 412
 413         if (parent_scope) {
 414                 op_info =
 415                     acpi_ps_get_opcode_info(parent_scope->common.aml_opcode);
 416                 if (op_info->flags & AML_HAS_TARGET) {
 417                         argument_count =
 418                             acpi_ps_get_argument_count(op_info->type);
 419                         if (parent_scope->common.arg_list_length >
 420                             argument_count) {
 421                                 op->common.flags |= ACPI_PARSEOP_TARGET;
 422                         }
 423                 }
 424
 425                 /*
 426                  * Special case for both Increment() and Decrement(), where
 427                  * the lone argument is both a source and a target.
 428                  */
 429                 else if ((parent_scope->common.aml_opcode == AML_INCREMENT_OP)
 430                          || (parent_scope->common.aml_opcode ==
 431                              AML_DECREMENT_OP)) {
 432                         op->common.flags |= ACPI_PARSEOP_TARGET;
 433                 }
 434         }
 435
 436         if (walk_state->descending_callback != NULL) {
 437                 /*
 438                  * Find the object. This will either insert the object into
 439                  * the namespace or simply look it up
 440                  */
 441                 walk_state->op = *new_op = op;
 442
 443                 status = walk_state->descending_callback(walk_state, &op);
 444                 status = acpi_ps_next_parse_state(walk_state, op, status);
 445                 if (status == AE_CTRL_PENDING) {
 446                         status = AE_CTRL_PARSE_PENDING;
 447                 }
 448         }
 449
 450         return_ACPI_STATUS(status);
 451 }
 452
 453 /*******************************************************************************
 454  *
 455  * FUNCTION:    acpi_ps_complete_op
 456  *
 457  * PARAMETERS:  walk_state          - Current state
 458  *              op                  - Returned Op
 459  *              status              - Parse status before complete Op
 460  *
 461  * RETURN:      Status
 462  *
 463  * DESCRIPTION: Complete Op
 464  *
 465  ******************************************************************************/
 466
 467 acpi_status
 468 acpi_ps_complete_op(struct acpi_walk_state *walk_state,
 469                     union acpi_parse_object **op, acpi_status status)
 470 {
 471         acpi_status status2;
 472
 473         ACPI_FUNCTION_TRACE_PTR(ps_complete_op, walk_state);
 474
 475         /*
 476          * Finished one argument of the containing scope
 477          */
 478         walk_state->parser_state.scope->parse_scope.arg_count--;
 479
 480         /* Close this Op (will result in parse subtree deletion) */
 481
 482         status2 = acpi_ps_complete_this_op(walk_state, *op);
 483         if (ACPI_FAILURE(status2)) {
 484                 return_ACPI_STATUS(status2);
 485         }
 486
 487         *op = NULL;
 488
 489         switch (status) {
 490         case AE_OK:
 491
 492                 break;
 493
 494         case AE_CTRL_TRANSFER:
 495
 496                 /* We are about to transfer to a called method */
 497
 498                 walk_state->prev_op = NULL;
 499                 walk_state->prev_arg_types = walk_state->arg_types;
 500                 return_ACPI_STATUS(status);
 501
 502         case AE_CTRL_END:
 503
 504                 acpi_ps_pop_scope(&(walk_state->parser_state), op,
 505                                   &walk_state->arg_types,
 506                                   &walk_state->arg_count);
 507
 508                 if (*op) {
 509                         walk_state->op = *op;
 510                         walk_state->op_info =
 511                             acpi_ps_get_opcode_info((*op)->common.aml_opcode);
 512                         walk_state->opcode = (*op)->common.aml_opcode;
 513
 514                         status = walk_state->ascending_callback(walk_state);
 515                         status =
 516                             acpi_ps_next_parse_state(walk_state, *op, status);
 517
 518                         status2 = acpi_ps_complete_this_op(walk_state, *op);
 519                         if (ACPI_FAILURE(status2)) {
 520                                 return_ACPI_STATUS(status2);
 521                         }
 522                 }
 523
 524                 status = AE_OK;
 525                 break;
 526
 527         case AE_CTRL_BREAK:
 528         case AE_CTRL_CONTINUE:
 529
 530                 /* Pop off scopes until we find the While */
 531
 532                 while (!(*op) || ((*op)->common.aml_opcode != AML_WHILE_OP)) {
 533                         acpi_ps_pop_scope(&(walk_state->parser_state), op,
 534                                           &walk_state->arg_types,
 535                                           &walk_state->arg_count);
 536                 }
 537
 538                 /* Close this iteration of the While loop */
 539
 540                 walk_state->op = *op;
 541                 walk_state->op_info =
 542                     acpi_ps_get_opcode_info((*op)->common.aml_opcode);
 543                 walk_state->opcode = (*op)->common.aml_opcode;
 544
 545                 status = walk_state->ascending_callback(walk_state);
 546                 status = acpi_ps_next_parse_state(walk_state, *op, status);
 547
 548                 status2 = acpi_ps_complete_this_op(walk_state, *op);
 549                 if (ACPI_FAILURE(status2)) {
 550                         return_ACPI_STATUS(status2);
 551                 }
 552
 553                 status = AE_OK;
 554                 break;
 555
 556         case AE_CTRL_TERMINATE:
 557
 558                 /* Clean up */
 559                 do {
 560                         if (*op) {
 561                                 status2 =
 562                                     acpi_ps_complete_this_op(walk_state, *op);
 563                                 if (ACPI_FAILURE(status2)) {
 564                                         return_ACPI_STATUS(status2);
 565                                 }
 566
 567                                 acpi_ut_delete_generic_state
 568                                     (acpi_ut_pop_generic_state
 569                                      (&walk_state->control_state));
 570                         }
 571
 572                         acpi_ps_pop_scope(&(walk_state->parser_state), op,
 573                                           &walk_state->arg_types,
 574                                           &walk_state->arg_count);
 575
 576                 } while (*op);
 577
 578                 return_ACPI_STATUS(AE_OK);
 579
 580         default:                /* All other non-AE_OK status */
 581
 582                 do {
 583                         if (*op) {
 584                                 status2 =
 585                                     acpi_ps_complete_this_op(walk_state, *op);
 586                                 if (ACPI_FAILURE(status2)) {
 587                                         return_ACPI_STATUS(status2);
 588                                 }
 589                         }
 590
 591                         acpi_ps_pop_scope(&(walk_state->parser_state), op,
 592                                           &walk_state->arg_types,
 593                                           &walk_state->arg_count);
 594
 595                 } while (*op);
 596
 597 #if 0
 598                 /*
 599                  * TBD: Cleanup parse ops on error
 600                  */
 601                 if (*op == NULL) {
 602                         acpi_ps_pop_scope(parser_state, op,
 603                                           &walk_state->arg_types,
 604                                           &walk_state->arg_count);
 605                 }
 606 #endif
 607                 walk_state->prev_op = NULL;
 608                 walk_state->prev_arg_types = walk_state->arg_types;
 609                 return_ACPI_STATUS(status);
 610         }
 611
 612         /* This scope complete? */
 613
 614         if (acpi_ps_has_completed_scope(&(walk_state->parser_state))) {
 615                 acpi_ps_pop_scope(&(walk_state->parser_state), op,
 616                                   &walk_state->arg_types,
 617                                   &walk_state->arg_count);
 618                 ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "Popped scope, Op=%p\n", *op));
 619         } else {
 620                 *op = NULL;
 621         }
 622
 623         return_ACPI_STATUS(AE_OK);
 624 }
 625
 626 /*******************************************************************************
 627  *
 628  * FUNCTION:    acpi_ps_complete_final_op
 629  *
 630  * PARAMETERS:  walk_state          - Current state
 631  *              op                  - Current Op
 632  *              status              - Current parse status before complete last
 633  *                                    Op
 634  *
 635  * RETURN:      Status
 636  *
 637  * DESCRIPTION: Complete last Op.
 638  *
 639  ******************************************************************************/
 640
 641 acpi_status
 642 acpi_ps_complete_final_op(struct acpi_walk_state *walk_state,
 643                           union acpi_parse_object *op, acpi_status status)
 644 {
 645         acpi_status status2;
 646
 647         ACPI_FUNCTION_TRACE_PTR(ps_complete_final_op, walk_state);
 648
 649         /*
 650          * Complete the last Op (if not completed), and clear the scope stack.
 651          * It is easily possible to end an AML "package" with an unbounded number
 652          * of open scopes (such as when several ASL blocks are closed with
 653          * sequential closing braces). We want to terminate each one cleanly.
 654          */
 655         ACPI_DEBUG_PRINT((ACPI_DB_PARSE, "AML package complete at Op %p\n",
 656                           op));
 657         do {
 658                 if (op) {
 659                         if (walk_state->ascending_callback != NULL) {
 660                                 walk_state->op = op;
 661                                 walk_state->op_info =
 662                                     acpi_ps_get_opcode_info(op->common.
 663                                                             aml_opcode);
 664                                 walk_state->opcode = op->common.aml_opcode;
 665
 666                                 status =
 667                                     walk_state->ascending_callback(walk_state);
 668                                 status =
 669                                     acpi_ps_next_parse_state(walk_state, op,
 670                                                              status);
 671                                 if (status == AE_CTRL_PENDING) {
 672                                         status =
 673                                             acpi_ps_complete_op(walk_state, &op,
 674                                                                 AE_OK);
 675                                         if (ACPI_FAILURE(status)) {
 676                                                 return_ACPI_STATUS(status);
 677                                         }
 678                                 }
 679
 680                                 if (status == AE_CTRL_TERMINATE) {
 681                                         status = AE_OK;
 682
 683                                         /* Clean up */
 684                                         do {
 685                                                 if (op) {
 686                                                         status2 =
 687                                                             acpi_ps_complete_this_op
 688                                                             (walk_state, op);
 689                                                         if (ACPI_FAILURE
 690                                                             (status2)) {
 691                                                                 return_ACPI_STATUS
 692                                                                     (status2);
 693                                                         }
 694                                                 }
 695
 696                                                 acpi_ps_pop_scope(&
 697                                                                   (walk_state->
 698                                                                    parser_state),
 699                                                                   &op,
 700                                                                   &walk_state->
 701                                                                   arg_types,
 702                                                                   &walk_state->
 703                                                                   arg_count);
 704
 705                                         } while (op);
 706
 707                                         return_ACPI_STATUS(status);
 708                                 }
 709
 710                                 else if (ACPI_FAILURE(status)) {
 711
 712                                         /* First error is most important */
 713
 714                                         (void)
 715                                             acpi_ps_complete_this_op(walk_state,
 716                                                                      op);
 717                                         return_ACPI_STATUS(status);
 718                                 }
 719                         }
 720
 721                         status2 = acpi_ps_complete_this_op(walk_state, op);
 722                         if (ACPI_FAILURE(status2)) {
 723                                 return_ACPI_STATUS(status2);
 724                         }
 725                 }
 726
 727                 acpi_ps_pop_scope(&(walk_state->parser_state), &op,
 728                                   &walk_state->arg_types,
 729                                   &walk_state->arg_count);
 730
 731         } while (op);
 732
 733         return_ACPI_STATUS(status);
 734 }