xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/exoparg2.c (revision a5a3b2d9a3d95cbae71eaf371708c73a1780ac0d)
1 /******************************************************************************
2  *
3  * Module Name: exoparg2 - AML execution - opcodes with 2 arguments
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2016, 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 #include "acpi.h"
117 #include "accommon.h"
118 #include "acparser.h"
119 #include "acinterp.h"
120 #include "acevents.h"
121 #include "amlcode.h"
122 
123 
124 #define _COMPONENT          ACPI_EXECUTER
125         ACPI_MODULE_NAME    ("exoparg2")
126 
127 
128 /*!
129  * Naming convention for AML interpreter execution routines.
130  *
131  * The routines that begin execution of AML opcodes are named with a common
132  * convention based upon the number of arguments, the number of target operands,
133  * and whether or not a value is returned:
134  *
135  *      AcpiExOpcode_xA_yT_zR
136  *
137  * Where:
138  *
139  * xA - ARGUMENTS:    The number of arguments (input operands) that are
140  *                    required for this opcode type (1 through 6 args).
141  * yT - TARGETS:      The number of targets (output operands) that are required
142  *                    for this opcode type (0, 1, or 2 targets).
143  * zR - RETURN VALUE: Indicates whether this opcode type returns a value
144  *                    as the function return (0 or 1).
145  *
146  * The AcpiExOpcode* functions are called via the Dispatcher component with
147  * fully resolved operands.
148 !*/
149 
150 
151 /*******************************************************************************
152  *
153  * FUNCTION:    AcpiExOpcode_2A_0T_0R
154  *
155  * PARAMETERS:  WalkState           - Current walk state
156  *
157  * RETURN:      Status
158  *
159  * DESCRIPTION: Execute opcode with two arguments, no target, and no return
160  *              value.
161  *
162  * ALLOCATION:  Deletes both operands
163  *
164  ******************************************************************************/
165 
166 ACPI_STATUS
167 AcpiExOpcode_2A_0T_0R (
168     ACPI_WALK_STATE         *WalkState)
169 {
170     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
171     ACPI_NAMESPACE_NODE     *Node;
172     UINT32                  Value;
173     ACPI_STATUS             Status = AE_OK;
174 
175 
176     ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_0T_0R,
177             AcpiPsGetOpcodeName (WalkState->Opcode));
178 
179 
180     /* Examine the opcode */
181 
182     switch (WalkState->Opcode)
183     {
184     case AML_NOTIFY_OP:         /* Notify (NotifyObject, NotifyValue) */
185 
186         /* The first operand is a namespace node */
187 
188         Node = (ACPI_NAMESPACE_NODE *) Operand[0];
189 
190         /* Second value is the notify value */
191 
192         Value = (UINT32) Operand[1]->Integer.Value;
193 
194         /* Are notifies allowed on this object? */
195 
196         if (!AcpiEvIsNotifyObject (Node))
197         {
198             ACPI_ERROR ((AE_INFO,
199                 "Unexpected notify object type [%s]",
200                 AcpiUtGetTypeName (Node->Type)));
201 
202             Status = AE_AML_OPERAND_TYPE;
203             break;
204         }
205 
206         /*
207          * Dispatch the notify to the appropriate handler
208          * NOTE: the request is queued for execution after this method
209          * completes. The notify handlers are NOT invoked synchronously
210          * from this thread -- because handlers may in turn run other
211          * control methods.
212          */
213         Status = AcpiEvQueueNotifyRequest (Node, Value);
214         break;
215 
216     default:
217 
218         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
219             WalkState->Opcode));
220         Status = AE_AML_BAD_OPCODE;
221     }
222 
223     return_ACPI_STATUS (Status);
224 }
225 
226 
227 /*******************************************************************************
228  *
229  * FUNCTION:    AcpiExOpcode_2A_2T_1R
230  *
231  * PARAMETERS:  WalkState           - Current walk state
232  *
233  * RETURN:      Status
234  *
235  * DESCRIPTION: Execute a dyadic operator (2 operands) with 2 output targets
236  *              and one implicit return value.
237  *
238  ******************************************************************************/
239 
240 ACPI_STATUS
241 AcpiExOpcode_2A_2T_1R (
242     ACPI_WALK_STATE         *WalkState)
243 {
244     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
245     ACPI_OPERAND_OBJECT     *ReturnDesc1 = NULL;
246     ACPI_OPERAND_OBJECT     *ReturnDesc2 = NULL;
247     ACPI_STATUS             Status;
248 
249 
250     ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_2T_1R,
251         AcpiPsGetOpcodeName (WalkState->Opcode));
252 
253 
254     /* Execute the opcode */
255 
256     switch (WalkState->Opcode)
257     {
258     case AML_DIVIDE_OP:
259 
260         /* Divide (Dividend, Divisor, RemainderResult QuotientResult) */
261 
262         ReturnDesc1 = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
263         if (!ReturnDesc1)
264         {
265             Status = AE_NO_MEMORY;
266             goto Cleanup;
267         }
268 
269         ReturnDesc2 = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
270         if (!ReturnDesc2)
271         {
272             Status = AE_NO_MEMORY;
273             goto Cleanup;
274         }
275 
276         /* Quotient to ReturnDesc1, remainder to ReturnDesc2 */
277 
278         Status = AcpiUtDivide (
279             Operand[0]->Integer.Value,
280             Operand[1]->Integer.Value,
281             &ReturnDesc1->Integer.Value,
282             &ReturnDesc2->Integer.Value);
283         if (ACPI_FAILURE (Status))
284         {
285             goto Cleanup;
286         }
287         break;
288 
289     default:
290 
291         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
292             WalkState->Opcode));
293 
294         Status = AE_AML_BAD_OPCODE;
295         goto Cleanup;
296     }
297 
298     /* Store the results to the target reference operands */
299 
300     Status = AcpiExStore (ReturnDesc2, Operand[2], WalkState);
301     if (ACPI_FAILURE (Status))
302     {
303         goto Cleanup;
304     }
305 
306     Status = AcpiExStore (ReturnDesc1, Operand[3], WalkState);
307     if (ACPI_FAILURE (Status))
308     {
309         goto Cleanup;
310     }
311 
312 Cleanup:
313     /*
314      * Since the remainder is not returned indirectly, remove a reference to
315      * it. Only the quotient is returned indirectly.
316      */
317     AcpiUtRemoveReference (ReturnDesc2);
318 
319     if (ACPI_FAILURE (Status))
320     {
321         /* Delete the return object */
322 
323         AcpiUtRemoveReference (ReturnDesc1);
324     }
325 
326     /* Save return object (the remainder) on success */
327 
328     else
329     {
330         WalkState->ResultObj = ReturnDesc1;
331     }
332 
333     return_ACPI_STATUS (Status);
334 }
335 
336 
337 /*******************************************************************************
338  *
339  * FUNCTION:    AcpiExOpcode_2A_1T_1R
340  *
341  * PARAMETERS:  WalkState           - Current walk state
342  *
343  * RETURN:      Status
344  *
345  * DESCRIPTION: Execute opcode with two arguments, one target, and a return
346  *              value.
347  *
348  ******************************************************************************/
349 
350 ACPI_STATUS
351 AcpiExOpcode_2A_1T_1R (
352     ACPI_WALK_STATE         *WalkState)
353 {
354     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
355     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
356     UINT64                  Index;
357     ACPI_STATUS             Status = AE_OK;
358     ACPI_SIZE               Length = 0;
359 
360 
361     ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_1T_1R,
362         AcpiPsGetOpcodeName (WalkState->Opcode));
363 
364 
365     /* Execute the opcode */
366 
367     if (WalkState->OpInfo->Flags & AML_MATH)
368     {
369         /* All simple math opcodes (add, etc.) */
370 
371         ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
372         if (!ReturnDesc)
373         {
374             Status = AE_NO_MEMORY;
375             goto Cleanup;
376         }
377 
378         ReturnDesc->Integer.Value = AcpiExDoMathOp (
379             WalkState->Opcode,
380             Operand[0]->Integer.Value,
381             Operand[1]->Integer.Value);
382         goto StoreResultToTarget;
383     }
384 
385     switch (WalkState->Opcode)
386     {
387     case AML_MOD_OP: /* Mod (Dividend, Divisor, RemainderResult (ACPI 2.0) */
388 
389         ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
390         if (!ReturnDesc)
391         {
392             Status = AE_NO_MEMORY;
393             goto Cleanup;
394         }
395 
396         /* ReturnDesc will contain the remainder */
397 
398         Status = AcpiUtDivide (
399             Operand[0]->Integer.Value,
400             Operand[1]->Integer.Value,
401             NULL,
402             &ReturnDesc->Integer.Value);
403         break;
404 
405     case AML_CONCAT_OP: /* Concatenate (Data1, Data2, Result) */
406 
407         Status = AcpiExDoConcatenate (
408             Operand[0], Operand[1], &ReturnDesc, WalkState);
409         break;
410 
411     case AML_TO_STRING_OP: /* ToString (Buffer, Length, Result) (ACPI 2.0) */
412         /*
413          * Input object is guaranteed to be a buffer at this point (it may have
414          * been converted.)  Copy the raw buffer data to a new object of
415          * type String.
416          */
417 
418         /*
419          * Get the length of the new string. It is the smallest of:
420          * 1) Length of the input buffer
421          * 2) Max length as specified in the ToString operator
422          * 3) Length of input buffer up to a zero byte (null terminator)
423          *
424          * NOTE: A length of zero is ok, and will create a zero-length, null
425          *       terminated string.
426          */
427         while ((Length < Operand[0]->Buffer.Length) &&
428                (Length < Operand[1]->Integer.Value) &&
429                (Operand[0]->Buffer.Pointer[Length]))
430         {
431             Length++;
432         }
433 
434         /* Allocate a new string object */
435 
436         ReturnDesc = AcpiUtCreateStringObject (Length);
437         if (!ReturnDesc)
438         {
439             Status = AE_NO_MEMORY;
440             goto Cleanup;
441         }
442 
443         /*
444          * Copy the raw buffer data with no transform.
445          * (NULL terminated already)
446          */
447         memcpy (ReturnDesc->String.Pointer,
448             Operand[0]->Buffer.Pointer, Length);
449         break;
450 
451     case AML_CONCAT_RES_OP:
452 
453         /* ConcatenateResTemplate (Buffer, Buffer, Result) (ACPI 2.0) */
454 
455         Status = AcpiExConcatTemplate (
456             Operand[0], Operand[1], &ReturnDesc, WalkState);
457         break;
458 
459     case AML_INDEX_OP:              /* Index (Source Index Result) */
460 
461         /* Create the internal return object */
462 
463         ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE);
464         if (!ReturnDesc)
465         {
466             Status = AE_NO_MEMORY;
467             goto Cleanup;
468         }
469 
470         /* Initialize the Index reference object */
471 
472         Index = Operand[1]->Integer.Value;
473         ReturnDesc->Reference.Value = (UINT32) Index;
474         ReturnDesc->Reference.Class = ACPI_REFCLASS_INDEX;
475 
476         /*
477          * At this point, the Source operand is a String, Buffer, or Package.
478          * Verify that the index is within range.
479          */
480         switch ((Operand[0])->Common.Type)
481         {
482         case ACPI_TYPE_STRING:
483 
484             if (Index >= Operand[0]->String.Length)
485             {
486                 Length = Operand[0]->String.Length;
487                 Status = AE_AML_STRING_LIMIT;
488             }
489 
490             ReturnDesc->Reference.TargetType = ACPI_TYPE_BUFFER_FIELD;
491             ReturnDesc->Reference.IndexPointer =
492                 &(Operand[0]->Buffer.Pointer [Index]);
493             break;
494 
495         case ACPI_TYPE_BUFFER:
496 
497             if (Index >= Operand[0]->Buffer.Length)
498             {
499                 Length = Operand[0]->Buffer.Length;
500                 Status = AE_AML_BUFFER_LIMIT;
501             }
502 
503             ReturnDesc->Reference.TargetType = ACPI_TYPE_BUFFER_FIELD;
504             ReturnDesc->Reference.IndexPointer =
505                 &(Operand[0]->Buffer.Pointer [Index]);
506             break;
507 
508         case ACPI_TYPE_PACKAGE:
509 
510             if (Index >= Operand[0]->Package.Count)
511             {
512                 Length = Operand[0]->Package.Count;
513                 Status = AE_AML_PACKAGE_LIMIT;
514             }
515 
516             ReturnDesc->Reference.TargetType = ACPI_TYPE_PACKAGE;
517             ReturnDesc->Reference.Where =
518                 &Operand[0]->Package.Elements [Index];
519             break;
520 
521         default:
522 
523             Status = AE_AML_INTERNAL;
524             goto Cleanup;
525         }
526 
527         /* Failure means that the Index was beyond the end of the object */
528 
529         if (ACPI_FAILURE (Status))
530         {
531             ACPI_EXCEPTION ((AE_INFO, Status,
532                 "Index (0x%X%8.8X) is beyond end of object (length 0x%X)",
533                 ACPI_FORMAT_UINT64 (Index), (UINT32) Length));
534             goto Cleanup;
535         }
536 
537         /*
538          * Save the target object and add a reference to it for the life
539          * of the index
540          */
541         ReturnDesc->Reference.Object = Operand[0];
542         AcpiUtAddReference (Operand[0]);
543 
544         /* Store the reference to the Target */
545 
546         Status = AcpiExStore (ReturnDesc, Operand[2], WalkState);
547 
548         /* Return the reference */
549 
550         WalkState->ResultObj = ReturnDesc;
551         goto Cleanup;
552 
553     default:
554 
555         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
556             WalkState->Opcode));
557         Status = AE_AML_BAD_OPCODE;
558         break;
559     }
560 
561 
562 StoreResultToTarget:
563 
564     if (ACPI_SUCCESS (Status))
565     {
566         /*
567          * Store the result of the operation (which is now in ReturnDesc) into
568          * the Target descriptor.
569          */
570         Status = AcpiExStore (ReturnDesc, Operand[2], WalkState);
571         if (ACPI_FAILURE (Status))
572         {
573             goto Cleanup;
574         }
575 
576         if (!WalkState->ResultObj)
577         {
578             WalkState->ResultObj = ReturnDesc;
579         }
580     }
581 
582 
583 Cleanup:
584 
585     /* Delete return object on error */
586 
587     if (ACPI_FAILURE (Status))
588     {
589         AcpiUtRemoveReference (ReturnDesc);
590         WalkState->ResultObj = NULL;
591     }
592 
593     return_ACPI_STATUS (Status);
594 }
595 
596 
597 /*******************************************************************************
598  *
599  * FUNCTION:    AcpiExOpcode_2A_0T_1R
600  *
601  * PARAMETERS:  WalkState           - Current walk state
602  *
603  * RETURN:      Status
604  *
605  * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
606  *
607  ******************************************************************************/
608 
609 ACPI_STATUS
610 AcpiExOpcode_2A_0T_1R (
611     ACPI_WALK_STATE         *WalkState)
612 {
613     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
614     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
615     ACPI_STATUS             Status = AE_OK;
616     BOOLEAN                 LogicalResult = FALSE;
617 
618 
619     ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_0T_1R,
620         AcpiPsGetOpcodeName (WalkState->Opcode));
621 
622 
623     /* Create the internal return object */
624 
625     ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
626     if (!ReturnDesc)
627     {
628         Status = AE_NO_MEMORY;
629         goto Cleanup;
630     }
631 
632     /* Execute the Opcode */
633 
634     if (WalkState->OpInfo->Flags & AML_LOGICAL_NUMERIC)
635     {
636         /* LogicalOp  (Operand0, Operand1) */
637 
638         Status = AcpiExDoLogicalNumericOp (WalkState->Opcode,
639             Operand[0]->Integer.Value, Operand[1]->Integer.Value,
640             &LogicalResult);
641         goto StoreLogicalResult;
642     }
643     else if (WalkState->OpInfo->Flags & AML_LOGICAL)
644     {
645         /* LogicalOp  (Operand0, Operand1) */
646 
647         Status = AcpiExDoLogicalOp (WalkState->Opcode, Operand[0],
648             Operand[1], &LogicalResult);
649         goto StoreLogicalResult;
650     }
651 
652     switch (WalkState->Opcode)
653     {
654     case AML_ACQUIRE_OP:            /* Acquire (MutexObject, Timeout) */
655 
656         Status = AcpiExAcquireMutex (Operand[1], Operand[0], WalkState);
657         if (Status == AE_TIME)
658         {
659             LogicalResult = TRUE;       /* TRUE = Acquire timed out */
660             Status = AE_OK;
661         }
662         break;
663 
664 
665     case AML_WAIT_OP:               /* Wait (EventObject, Timeout) */
666 
667         Status = AcpiExSystemWaitEvent (Operand[1], Operand[0]);
668         if (Status == AE_TIME)
669         {
670             LogicalResult = TRUE;       /* TRUE, Wait timed out */
671             Status = AE_OK;
672         }
673         break;
674 
675     default:
676 
677         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
678             WalkState->Opcode));
679 
680         Status = AE_AML_BAD_OPCODE;
681         goto Cleanup;
682     }
683 
684 
685 StoreLogicalResult:
686     /*
687      * Set return value to according to LogicalResult. logical TRUE (all ones)
688      * Default is FALSE (zero)
689      */
690     if (LogicalResult)
691     {
692         ReturnDesc->Integer.Value = ACPI_UINT64_MAX;
693     }
694 
695 Cleanup:
696 
697     /* Delete return object on error */
698 
699     if (ACPI_FAILURE (Status))
700     {
701         AcpiUtRemoveReference (ReturnDesc);
702     }
703 
704     /* Save return object on success */
705 
706     else
707     {
708         WalkState->ResultObj = ReturnDesc;
709     }
710 
711     return_ACPI_STATUS (Status);
712 }
713