xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/parser/psobject.c (revision fae7ea18b62865f5e1159e1678c851d3aa1ddce0)
1 /******************************************************************************
2  *
3  * Module Name: psobject - Support for parse objects
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 
117 #include "acpi.h"
118 #include "accommon.h"
119 #include "acparser.h"
120 #include "amlcode.h"
121 
122 #define _COMPONENT          ACPI_PARSER
123         ACPI_MODULE_NAME    ("psobject")
124 
125 
126 /* Local prototypes */
127 
128 static ACPI_STATUS
129 AcpiPsGetAmlOpcode (
130     ACPI_WALK_STATE         *WalkState);
131 
132 
133 /*******************************************************************************
134  *
135  * FUNCTION:    AcpiPsGetAmlOpcode
136  *
137  * PARAMETERS:  WalkState           - Current state
138  *
139  * RETURN:      Status
140  *
141  * DESCRIPTION: Extract the next AML opcode from the input stream.
142  *
143  ******************************************************************************/
144 
145 static ACPI_STATUS
146 AcpiPsGetAmlOpcode (
147     ACPI_WALK_STATE         *WalkState)
148 {
149 
150     ACPI_FUNCTION_TRACE_PTR (PsGetAmlOpcode, WalkState);
151 
152 
153     WalkState->AmlOffset = (UINT32) ACPI_PTR_DIFF (WalkState->ParserState.Aml,
154                                 WalkState->ParserState.AmlStart);
155     WalkState->Opcode = AcpiPsPeekOpcode (&(WalkState->ParserState));
156 
157     /*
158      * First cut to determine what we have found:
159      * 1) A valid AML opcode
160      * 2) A name string
161      * 3) An unknown/invalid opcode
162      */
163     WalkState->OpInfo = AcpiPsGetOpcodeInfo (WalkState->Opcode);
164 
165     switch (WalkState->OpInfo->Class)
166     {
167     case AML_CLASS_ASCII:
168     case AML_CLASS_PREFIX:
169         /*
170          * Starts with a valid prefix or ASCII char, this is a name
171          * string. Convert the bare name string to a namepath.
172          */
173         WalkState->Opcode = AML_INT_NAMEPATH_OP;
174         WalkState->ArgTypes = ARGP_NAMESTRING;
175         break;
176 
177     case AML_CLASS_UNKNOWN:
178 
179         /* The opcode is unrecognized. Complain and skip unknown opcodes */
180 
181         if (WalkState->PassNumber == 2)
182         {
183             ACPI_ERROR ((AE_INFO,
184                 "Unknown opcode 0x%.2X at table offset 0x%.4X, ignoring",
185                 WalkState->Opcode,
186                 (UINT32) (WalkState->AmlOffset + sizeof (ACPI_TABLE_HEADER))));
187 
188             ACPI_DUMP_BUFFER ((WalkState->ParserState.Aml - 16), 48);
189 
190 #ifdef ACPI_ASL_COMPILER
191             /*
192              * This is executed for the disassembler only. Output goes
193              * to the disassembled ASL output file.
194              */
195             AcpiOsPrintf (
196                 "/*\nError: Unknown opcode 0x%.2X at table offset 0x%.4X, context:\n",
197                 WalkState->Opcode,
198                 (UINT32) (WalkState->AmlOffset + sizeof (ACPI_TABLE_HEADER)));
199 
200             /* Dump the context surrounding the invalid opcode */
201 
202             AcpiUtDumpBuffer (((UINT8 *) WalkState->ParserState.Aml - 16),
203                 48, DB_BYTE_DISPLAY,
204                 (WalkState->AmlOffset + sizeof (ACPI_TABLE_HEADER) - 16));
205             AcpiOsPrintf (" */\n");
206 #endif
207         }
208 
209         /* Increment past one-byte or two-byte opcode */
210 
211         WalkState->ParserState.Aml++;
212         if (WalkState->Opcode > 0xFF) /* Can only happen if first byte is 0x5B */
213         {
214             WalkState->ParserState.Aml++;
215         }
216 
217         return_ACPI_STATUS (AE_CTRL_PARSE_CONTINUE);
218 
219     default:
220 
221         /* Found opcode info, this is a normal opcode */
222 
223         WalkState->ParserState.Aml += AcpiPsGetOpcodeSize (WalkState->Opcode);
224         WalkState->ArgTypes = WalkState->OpInfo->ParseArgs;
225         break;
226     }
227 
228     return_ACPI_STATUS (AE_OK);
229 }
230 
231 
232 /*******************************************************************************
233  *
234  * FUNCTION:    AcpiPsBuildNamedOp
235  *
236  * PARAMETERS:  WalkState           - Current state
237  *              AmlOpStart          - Begin of named Op in AML
238  *              UnnamedOp           - Early Op (not a named Op)
239  *              Op                  - Returned Op
240  *
241  * RETURN:      Status
242  *
243  * DESCRIPTION: Parse a named Op
244  *
245  ******************************************************************************/
246 
247 ACPI_STATUS
248 AcpiPsBuildNamedOp (
249     ACPI_WALK_STATE         *WalkState,
250     UINT8                   *AmlOpStart,
251     ACPI_PARSE_OBJECT       *UnnamedOp,
252     ACPI_PARSE_OBJECT       **Op)
253 {
254     ACPI_STATUS             Status = AE_OK;
255     ACPI_PARSE_OBJECT       *Arg = NULL;
256 
257 
258     ACPI_FUNCTION_TRACE_PTR (PsBuildNamedOp, WalkState);
259 
260 
261     UnnamedOp->Common.Value.Arg = NULL;
262     UnnamedOp->Common.ArgListLength = 0;
263     UnnamedOp->Common.AmlOpcode = WalkState->Opcode;
264 
265     /*
266      * Get and append arguments until we find the node that contains
267      * the name (the type ARGP_NAME).
268      */
269     while (GET_CURRENT_ARG_TYPE (WalkState->ArgTypes) &&
270           (GET_CURRENT_ARG_TYPE (WalkState->ArgTypes) != ARGP_NAME))
271     {
272         Status = AcpiPsGetNextArg (WalkState, &(WalkState->ParserState),
273                     GET_CURRENT_ARG_TYPE (WalkState->ArgTypes), &Arg);
274         if (ACPI_FAILURE (Status))
275         {
276             return_ACPI_STATUS (Status);
277         }
278 
279         AcpiPsAppendArg (UnnamedOp, Arg);
280         INCREMENT_ARG_LIST (WalkState->ArgTypes);
281     }
282 
283     /*
284      * Make sure that we found a NAME and didn't run out of arguments
285      */
286     if (!GET_CURRENT_ARG_TYPE (WalkState->ArgTypes))
287     {
288         return_ACPI_STATUS (AE_AML_NO_OPERAND);
289     }
290 
291     /* We know that this arg is a name, move to next arg */
292 
293     INCREMENT_ARG_LIST (WalkState->ArgTypes);
294 
295     /*
296      * Find the object. This will either insert the object into
297      * the namespace or simply look it up
298      */
299     WalkState->Op = NULL;
300 
301     Status = WalkState->DescendingCallback (WalkState, Op);
302     if (ACPI_FAILURE (Status))
303     {
304         if (Status != AE_CTRL_TERMINATE)
305         {
306             ACPI_EXCEPTION ((AE_INFO, Status, "During name lookup/catalog"));
307         }
308         return_ACPI_STATUS (Status);
309     }
310 
311     if (!*Op)
312     {
313         return_ACPI_STATUS (AE_CTRL_PARSE_CONTINUE);
314     }
315 
316     Status = AcpiPsNextParseState (WalkState, *Op, Status);
317     if (ACPI_FAILURE (Status))
318     {
319         if (Status == AE_CTRL_PENDING)
320         {
321             Status = AE_CTRL_PARSE_PENDING;
322         }
323         return_ACPI_STATUS (Status);
324     }
325 
326     AcpiPsAppendArg (*Op, UnnamedOp->Common.Value.Arg);
327 
328     if ((*Op)->Common.AmlOpcode == AML_REGION_OP ||
329         (*Op)->Common.AmlOpcode == AML_DATA_REGION_OP)
330     {
331         /*
332          * Defer final parsing of an OperationRegion body, because we don't
333          * have enough info in the first pass to parse it correctly (i.e.,
334          * there may be method calls within the TermArg elements of the body.)
335          *
336          * However, we must continue parsing because the opregion is not a
337          * standalone package -- we don't know where the end is at this point.
338          *
339          * (Length is unknown until parse of the body complete)
340          */
341         (*Op)->Named.Data = AmlOpStart;
342         (*Op)->Named.Length = 0;
343     }
344 
345     return_ACPI_STATUS (AE_OK);
346 }
347 
348 
349 /*******************************************************************************
350  *
351  * FUNCTION:    AcpiPsCreateOp
352  *
353  * PARAMETERS:  WalkState           - Current state
354  *              AmlOpStart          - Op start in AML
355  *              NewOp               - Returned Op
356  *
357  * RETURN:      Status
358  *
359  * DESCRIPTION: Get Op from AML
360  *
361  ******************************************************************************/
362 
363 ACPI_STATUS
364 AcpiPsCreateOp (
365     ACPI_WALK_STATE         *WalkState,
366     UINT8                   *AmlOpStart,
367     ACPI_PARSE_OBJECT       **NewOp)
368 {
369     ACPI_STATUS             Status = AE_OK;
370     ACPI_PARSE_OBJECT       *Op;
371     ACPI_PARSE_OBJECT       *NamedOp = NULL;
372     ACPI_PARSE_OBJECT       *ParentScope;
373     UINT8                   ArgumentCount;
374     const ACPI_OPCODE_INFO  *OpInfo;
375 
376 
377     ACPI_FUNCTION_TRACE_PTR (PsCreateOp, WalkState);
378 
379 
380     Status = AcpiPsGetAmlOpcode (WalkState);
381     if (Status == AE_CTRL_PARSE_CONTINUE)
382     {
383         return_ACPI_STATUS (AE_CTRL_PARSE_CONTINUE);
384     }
385 
386     /* Create Op structure and append to parent's argument list */
387 
388     WalkState->OpInfo = AcpiPsGetOpcodeInfo (WalkState->Opcode);
389     Op = AcpiPsAllocOp (WalkState->Opcode);
390     if (!Op)
391     {
392         return_ACPI_STATUS (AE_NO_MEMORY);
393     }
394 
395     if (WalkState->OpInfo->Flags & AML_NAMED)
396     {
397         Status = AcpiPsBuildNamedOp (WalkState, AmlOpStart, Op, &NamedOp);
398         AcpiPsFreeOp (Op);
399         if (ACPI_FAILURE (Status))
400         {
401             return_ACPI_STATUS (Status);
402         }
403 
404         *NewOp = NamedOp;
405         return_ACPI_STATUS (AE_OK);
406     }
407 
408     /* Not a named opcode, just allocate Op and append to parent */
409 
410     if (WalkState->OpInfo->Flags & AML_CREATE)
411     {
412         /*
413          * Backup to beginning of CreateXXXfield declaration
414          * BodyLength is unknown until we parse the body
415          */
416         Op->Named.Data = AmlOpStart;
417         Op->Named.Length = 0;
418     }
419 
420     if (WalkState->Opcode == AML_BANK_FIELD_OP)
421     {
422         /*
423          * Backup to beginning of BankField declaration
424          * BodyLength is unknown until we parse the body
425          */
426         Op->Named.Data = AmlOpStart;
427         Op->Named.Length = 0;
428     }
429 
430     ParentScope = AcpiPsGetParentScope (&(WalkState->ParserState));
431     AcpiPsAppendArg (ParentScope, Op);
432 
433     if (ParentScope)
434     {
435         OpInfo = AcpiPsGetOpcodeInfo (ParentScope->Common.AmlOpcode);
436         if (OpInfo->Flags & AML_HAS_TARGET)
437         {
438             ArgumentCount = AcpiPsGetArgumentCount (OpInfo->Type);
439             if (ParentScope->Common.ArgListLength > ArgumentCount)
440             {
441                 Op->Common.Flags |= ACPI_PARSEOP_TARGET;
442             }
443         }
444         else if (ParentScope->Common.AmlOpcode == AML_INCREMENT_OP)
445         {
446             Op->Common.Flags |= ACPI_PARSEOP_TARGET;
447         }
448     }
449 
450     if (WalkState->DescendingCallback != NULL)
451     {
452         /*
453          * Find the object. This will either insert the object into
454          * the namespace or simply look it up
455          */
456         WalkState->Op = *NewOp = Op;
457 
458         Status = WalkState->DescendingCallback (WalkState, &Op);
459         Status = AcpiPsNextParseState (WalkState, Op, Status);
460         if (Status == AE_CTRL_PENDING)
461         {
462             Status = AE_CTRL_PARSE_PENDING;
463         }
464     }
465 
466     return_ACPI_STATUS (Status);
467 }
468 
469 
470 /*******************************************************************************
471  *
472  * FUNCTION:    AcpiPsCompleteOp
473  *
474  * PARAMETERS:  WalkState           - Current state
475  *              Op                  - Returned Op
476  *              Status              - Parse status before complete Op
477  *
478  * RETURN:      Status
479  *
480  * DESCRIPTION: Complete Op
481  *
482  ******************************************************************************/
483 
484 ACPI_STATUS
485 AcpiPsCompleteOp (
486     ACPI_WALK_STATE         *WalkState,
487     ACPI_PARSE_OBJECT       **Op,
488     ACPI_STATUS             Status)
489 {
490     ACPI_STATUS             Status2;
491 
492 
493     ACPI_FUNCTION_TRACE_PTR (PsCompleteOp, WalkState);
494 
495 
496     /*
497      * Finished one argument of the containing scope
498      */
499     WalkState->ParserState.Scope->ParseScope.ArgCount--;
500 
501     /* Close this Op (will result in parse subtree deletion) */
502 
503     Status2 = AcpiPsCompleteThisOp (WalkState, *Op);
504     if (ACPI_FAILURE (Status2))
505     {
506         return_ACPI_STATUS (Status2);
507     }
508 
509     *Op = NULL;
510 
511     switch (Status)
512     {
513     case AE_OK:
514 
515         break;
516 
517     case AE_CTRL_TRANSFER:
518 
519         /* We are about to transfer to a called method */
520 
521         WalkState->PrevOp = NULL;
522         WalkState->PrevArgTypes = WalkState->ArgTypes;
523         return_ACPI_STATUS (Status);
524 
525     case AE_CTRL_END:
526 
527         AcpiPsPopScope (&(WalkState->ParserState), Op,
528             &WalkState->ArgTypes, &WalkState->ArgCount);
529 
530         if (*Op)
531         {
532             WalkState->Op = *Op;
533             WalkState->OpInfo = AcpiPsGetOpcodeInfo ((*Op)->Common.AmlOpcode);
534             WalkState->Opcode = (*Op)->Common.AmlOpcode;
535 
536             Status = WalkState->AscendingCallback (WalkState);
537             Status = AcpiPsNextParseState (WalkState, *Op, Status);
538 
539             Status2 = AcpiPsCompleteThisOp (WalkState, *Op);
540             if (ACPI_FAILURE (Status2))
541             {
542                 return_ACPI_STATUS (Status2);
543             }
544         }
545 
546         Status = AE_OK;
547         break;
548 
549     case AE_CTRL_BREAK:
550     case AE_CTRL_CONTINUE:
551 
552         /* Pop off scopes until we find the While */
553 
554         while (!(*Op) || ((*Op)->Common.AmlOpcode != AML_WHILE_OP))
555         {
556             AcpiPsPopScope (&(WalkState->ParserState), Op,
557                 &WalkState->ArgTypes, &WalkState->ArgCount);
558         }
559 
560         /* Close this iteration of the While loop */
561 
562         WalkState->Op = *Op;
563         WalkState->OpInfo = AcpiPsGetOpcodeInfo ((*Op)->Common.AmlOpcode);
564         WalkState->Opcode = (*Op)->Common.AmlOpcode;
565 
566         Status = WalkState->AscendingCallback (WalkState);
567         Status = AcpiPsNextParseState (WalkState, *Op, Status);
568 
569         Status2 = AcpiPsCompleteThisOp (WalkState, *Op);
570         if (ACPI_FAILURE (Status2))
571         {
572             return_ACPI_STATUS (Status2);
573         }
574 
575         Status = AE_OK;
576         break;
577 
578     case AE_CTRL_TERMINATE:
579 
580         /* Clean up */
581         do
582         {
583             if (*Op)
584             {
585                 Status2 = AcpiPsCompleteThisOp (WalkState, *Op);
586                 if (ACPI_FAILURE (Status2))
587                 {
588                     return_ACPI_STATUS (Status2);
589                 }
590 
591                 AcpiUtDeleteGenericState (
592                     AcpiUtPopGenericState (&WalkState->ControlState));
593             }
594 
595             AcpiPsPopScope (&(WalkState->ParserState), Op,
596                 &WalkState->ArgTypes, &WalkState->ArgCount);
597 
598         } while (*Op);
599 
600         return_ACPI_STATUS (AE_OK);
601 
602     default:  /* All other non-AE_OK status */
603 
604         do
605         {
606             if (*Op)
607             {
608                 Status2 = AcpiPsCompleteThisOp (WalkState, *Op);
609                 if (ACPI_FAILURE (Status2))
610                 {
611                     return_ACPI_STATUS (Status2);
612                 }
613             }
614 
615             AcpiPsPopScope (&(WalkState->ParserState), Op,
616                 &WalkState->ArgTypes, &WalkState->ArgCount);
617 
618         } while (*Op);
619 
620 
621 #if 0
622         /*
623          * TBD: Cleanup parse ops on error
624          */
625         if (*Op == NULL)
626         {
627             AcpiPsPopScope (ParserState, Op,
628                 &WalkState->ArgTypes, &WalkState->ArgCount);
629         }
630 #endif
631         WalkState->PrevOp = NULL;
632         WalkState->PrevArgTypes = WalkState->ArgTypes;
633         return_ACPI_STATUS (Status);
634     }
635 
636     /* This scope complete? */
637 
638     if (AcpiPsHasCompletedScope (&(WalkState->ParserState)))
639     {
640         AcpiPsPopScope (&(WalkState->ParserState), Op,
641             &WalkState->ArgTypes, &WalkState->ArgCount);
642         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Popped scope, Op=%p\n", *Op));
643     }
644     else
645     {
646         *Op = NULL;
647     }
648 
649     return_ACPI_STATUS (AE_OK);
650 }
651 
652 
653 /*******************************************************************************
654  *
655  * FUNCTION:    AcpiPsCompleteFinalOp
656  *
657  * PARAMETERS:  WalkState           - Current state
658  *              Op                  - Current Op
659  *              Status              - Current parse status before complete last
660  *                                    Op
661  *
662  * RETURN:      Status
663  *
664  * DESCRIPTION: Complete last Op.
665  *
666  ******************************************************************************/
667 
668 ACPI_STATUS
669 AcpiPsCompleteFinalOp (
670     ACPI_WALK_STATE         *WalkState,
671     ACPI_PARSE_OBJECT       *Op,
672     ACPI_STATUS             Status)
673 {
674     ACPI_STATUS             Status2;
675 
676 
677     ACPI_FUNCTION_TRACE_PTR (PsCompleteFinalOp, WalkState);
678 
679 
680     /*
681      * Complete the last Op (if not completed), and clear the scope stack.
682      * It is easily possible to end an AML "package" with an unbounded number
683      * of open scopes (such as when several ASL blocks are closed with
684      * sequential closing braces). We want to terminate each one cleanly.
685      */
686     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "AML package complete at Op %p\n", Op));
687     do
688     {
689         if (Op)
690         {
691             if (WalkState->AscendingCallback != NULL)
692             {
693                 WalkState->Op = Op;
694                 WalkState->OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
695                 WalkState->Opcode = Op->Common.AmlOpcode;
696 
697                 Status = WalkState->AscendingCallback (WalkState);
698                 Status = AcpiPsNextParseState (WalkState, Op, Status);
699                 if (Status == AE_CTRL_PENDING)
700                 {
701                     Status = AcpiPsCompleteOp (WalkState, &Op, AE_OK);
702                     if (ACPI_FAILURE (Status))
703                     {
704                         return_ACPI_STATUS (Status);
705                     }
706                 }
707 
708                 if (Status == AE_CTRL_TERMINATE)
709                 {
710                     Status = AE_OK;
711 
712                     /* Clean up */
713                     do
714                     {
715                         if (Op)
716                         {
717                             Status2 = AcpiPsCompleteThisOp (WalkState, Op);
718                             if (ACPI_FAILURE (Status2))
719                             {
720                                 return_ACPI_STATUS (Status2);
721                             }
722                         }
723 
724                         AcpiPsPopScope (&(WalkState->ParserState), &Op,
725                             &WalkState->ArgTypes, &WalkState->ArgCount);
726 
727                     } while (Op);
728 
729                     return_ACPI_STATUS (Status);
730                 }
731 
732                 else if (ACPI_FAILURE (Status))
733                 {
734                     /* First error is most important */
735 
736                     (void) AcpiPsCompleteThisOp (WalkState, Op);
737                     return_ACPI_STATUS (Status);
738                 }
739             }
740 
741             Status2 = AcpiPsCompleteThisOp (WalkState, Op);
742             if (ACPI_FAILURE (Status2))
743             {
744                 return_ACPI_STATUS (Status2);
745             }
746         }
747 
748         AcpiPsPopScope (&(WalkState->ParserState), &Op, &WalkState->ArgTypes,
749             &WalkState->ArgCount);
750 
751     } while (Op);
752 
753     return_ACPI_STATUS (Status);
754 }
755