2 /******************************************************************************
4 * Module Name: exresop - AML Interpreter operand/object resolution
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #define __EXRESOP_C__
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/amlcode.h>
122 #include <contrib/dev/acpica/acparser.h>
123 #include <contrib/dev/acpica/acinterp.h>
124 #include <contrib/dev/acpica/acnamesp.h>
127 #define _COMPONENT ACPI_EXECUTER
128 ACPI_MODULE_NAME ("exresop")
130 /* Local prototypes */
133 AcpiExCheckObjectType (
134 ACPI_OBJECT_TYPE TypeNeeded,
135 ACPI_OBJECT_TYPE ThisType,
139 /*******************************************************************************
141 * FUNCTION: AcpiExCheckObjectType
143 * PARAMETERS: TypeNeeded Object type needed
144 * ThisType Actual object type
145 * Object Object pointer
149 * DESCRIPTION: Check required type against actual type
151 ******************************************************************************/
154 AcpiExCheckObjectType (
155 ACPI_OBJECT_TYPE TypeNeeded,
156 ACPI_OBJECT_TYPE ThisType,
159 ACPI_FUNCTION_ENTRY ();
162 if (TypeNeeded == ACPI_TYPE_ANY)
164 /* All types OK, so we don't perform any typechecks */
169 if (TypeNeeded == ACPI_TYPE_LOCAL_REFERENCE)
172 * Allow the AML "Constant" opcodes (Zero, One, etc.) to be reference
173 * objects and thus allow them to be targets. (As per the ACPI
174 * specification, a store to a constant is a noop.)
176 if ((ThisType == ACPI_TYPE_INTEGER) &&
177 (((ACPI_OPERAND_OBJECT *) Object)->Common.Flags & AOPOBJ_AML_CONSTANT))
183 if (TypeNeeded != ThisType)
185 ACPI_ERROR ((AE_INFO,
186 "Needed type [%s], found [%s] %p",
187 AcpiUtGetTypeName (TypeNeeded),
188 AcpiUtGetTypeName (ThisType), Object));
190 return (AE_AML_OPERAND_TYPE);
197 /*******************************************************************************
199 * FUNCTION: AcpiExResolveOperands
201 * PARAMETERS: Opcode - Opcode being interpreted
202 * StackPtr - Pointer to the operand stack to be
204 * WalkState - Current state
208 * DESCRIPTION: Convert multiple input operands to the types required by the
211 * Each 5-bit group in ArgTypes represents one required
212 * operand and indicates the required Type. The corresponding operand
213 * will be converted to the required type if possible, otherwise we
214 * abort with an exception.
216 ******************************************************************************/
219 AcpiExResolveOperands (
221 ACPI_OPERAND_OBJECT **StackPtr,
222 ACPI_WALK_STATE *WalkState)
224 ACPI_OPERAND_OBJECT *ObjDesc;
225 ACPI_STATUS Status = AE_OK;
228 const ACPI_OPCODE_INFO *OpInfo;
230 ACPI_OBJECT_TYPE TypeNeeded;
234 ACPI_FUNCTION_TRACE_U32 (ExResolveOperands, Opcode);
237 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
238 if (OpInfo->Class == AML_CLASS_UNKNOWN)
240 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
243 ArgTypes = OpInfo->RuntimeArgs;
244 if (ArgTypes == ARGI_INVALID_OPCODE)
246 ACPI_ERROR ((AE_INFO, "Unknown AML opcode %X",
249 return_ACPI_STATUS (AE_AML_INTERNAL);
252 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
253 "Opcode %X [%s] RequiredOperandTypes=%8.8X\n",
254 Opcode, OpInfo->Name, ArgTypes));
257 * Normal exit is with (ArgTypes == 0) at end of argument list.
258 * Function will return an exception from within the loop upon
259 * finding an entry which is not (or cannot be converted
260 * to) the required type; if stack underflows; or upon
261 * finding a NULL stack entry (which should not happen).
263 while (GET_CURRENT_ARG_TYPE (ArgTypes))
265 if (!StackPtr || !*StackPtr)
267 ACPI_ERROR ((AE_INFO, "Null stack entry at %p",
270 return_ACPI_STATUS (AE_AML_INTERNAL);
273 /* Extract useful items */
277 /* Decode the descriptor type */
279 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
281 case ACPI_DESC_TYPE_NAMED:
285 ObjectType = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
288 * Resolve an alias object. The construction of these objects
289 * guarantees that there is only one level of alias indirection;
290 * thus, the attached object is always the aliased namespace node
292 if (ObjectType == ACPI_TYPE_LOCAL_ALIAS)
294 ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
296 ObjectType = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
301 case ACPI_DESC_TYPE_OPERAND:
303 /* ACPI internal object */
305 ObjectType = ACPI_GET_OBJECT_TYPE (ObjDesc);
307 /* Check for bad ACPI_OBJECT_TYPE */
309 if (!AcpiUtValidObjectType (ObjectType))
311 ACPI_ERROR ((AE_INFO,
312 "Bad operand object type [%X]",
315 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
318 if (ObjectType == (UINT8) ACPI_TYPE_LOCAL_REFERENCE)
320 /* Decode the Reference */
322 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
323 if (OpInfo->Class == AML_CLASS_UNKNOWN)
325 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
328 switch (ObjDesc->Reference.Opcode)
331 TargetOp = AML_DEBUG_OP;
333 /*lint -fallthrough */
339 case AML_LOAD_OP: /* DdbHandle from LOAD_OP or LOAD_TABLE_OP */
340 case AML_INT_NAMEPATH_OP: /* Reference to a named object */
342 ACPI_DEBUG_ONLY_MEMBERS (ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
343 "Operand is a Reference, RefOpcode [%s]\n",
344 (AcpiPsGetOpcodeInfo (ObjDesc->Reference.Opcode))->Name)));
348 ACPI_ERROR ((AE_INFO,
349 "Operand is a Reference, Unknown Reference Opcode: %X",
350 ObjDesc->Reference.Opcode));
352 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
360 /* Invalid descriptor */
362 ACPI_ERROR ((AE_INFO,
363 "Invalid descriptor %p [%s]",
364 ObjDesc, AcpiUtGetDescriptorName (ObjDesc)));
366 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
369 /* Get one argument type, point to the next */
371 ThisArgType = GET_CURRENT_ARG_TYPE (ArgTypes);
372 INCREMENT_ARG_LIST (ArgTypes);
375 * Handle cases where the object does not need to be
376 * resolved to a value
380 case ARGI_REF_OR_STRING: /* Can be a String or Reference */
382 if ((ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND) &&
383 (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_STRING))
386 * String found - the string references a named object and
387 * must be resolved to a node
393 * Else not a string - fall through to the normal Reference
396 /*lint -fallthrough */
398 case ARGI_REFERENCE: /* References: */
399 case ARGI_INTEGER_REF:
400 case ARGI_OBJECT_REF:
401 case ARGI_DEVICE_REF:
402 case ARGI_TARGETREF: /* Allows implicit conversion rules before store */
403 case ARGI_FIXED_TARGET: /* No implicit conversion before store to target */
404 case ARGI_SIMPLE_TARGET: /* Name, Local, or Arg - no implicit conversion */
407 * Need an operand of type ACPI_TYPE_LOCAL_REFERENCE
408 * A Namespace Node is OK as-is
410 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_NAMED)
415 Status = AcpiExCheckObjectType (ACPI_TYPE_LOCAL_REFERENCE,
416 ObjectType, ObjDesc);
417 if (ACPI_FAILURE (Status))
419 return_ACPI_STATUS (Status);
424 case ARGI_DATAREFOBJ: /* Store operator only */
427 * We don't want to resolve IndexOp reference objects during
428 * a store because this would be an implicit DeRefOf operation.
429 * Instead, we just want to store the reference object.
430 * -- All others must be resolved below.
432 if ((Opcode == AML_STORE_OP) &&
433 (ACPI_GET_OBJECT_TYPE (*StackPtr) == ACPI_TYPE_LOCAL_REFERENCE) &&
434 ((*StackPtr)->Reference.Opcode == AML_INDEX_OP))
441 /* All cases covered above */
446 * Resolve this object to a value
448 Status = AcpiExResolveToValue (StackPtr, WalkState);
449 if (ACPI_FAILURE (Status))
451 return_ACPI_STATUS (Status);
454 /* Get the resolved object */
459 * Check the resulting object (value) type
464 * For the simple cases, only one type of resolved object
469 /* Need an operand of type ACPI_TYPE_MUTEX */
471 TypeNeeded = ACPI_TYPE_MUTEX;
476 /* Need an operand of type ACPI_TYPE_EVENT */
478 TypeNeeded = ACPI_TYPE_EVENT;
481 case ARGI_PACKAGE: /* Package */
483 /* Need an operand of type ACPI_TYPE_PACKAGE */
485 TypeNeeded = ACPI_TYPE_PACKAGE;
490 /* Any operand type will do */
492 TypeNeeded = ACPI_TYPE_ANY;
497 /* Need an operand of type ACPI_TYPE_DDB_HANDLE */
499 TypeNeeded = ACPI_TYPE_LOCAL_REFERENCE;
504 * The more complex cases allow multiple resolved object types
509 * Need an operand of type ACPI_TYPE_INTEGER,
510 * But we can implicitly convert from a STRING or BUFFER
511 * Aka - "Implicit Source Operand Conversion"
513 Status = AcpiExConvertToInteger (ObjDesc, StackPtr, 16);
514 if (ACPI_FAILURE (Status))
516 if (Status == AE_TYPE)
518 ACPI_ERROR ((AE_INFO,
519 "Needed [Integer/String/Buffer], found [%s] %p",
520 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
522 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
525 return_ACPI_STATUS (Status);
528 if (ObjDesc != *StackPtr)
530 AcpiUtRemoveReference (ObjDesc);
538 * Need an operand of type ACPI_TYPE_BUFFER,
539 * But we can implicitly convert from a STRING or INTEGER
540 * Aka - "Implicit Source Operand Conversion"
542 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr);
543 if (ACPI_FAILURE (Status))
545 if (Status == AE_TYPE)
547 ACPI_ERROR ((AE_INFO,
548 "Needed [Integer/String/Buffer], found [%s] %p",
549 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
551 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
554 return_ACPI_STATUS (Status);
557 if (ObjDesc != *StackPtr)
559 AcpiUtRemoveReference (ObjDesc);
567 * Need an operand of type ACPI_TYPE_STRING,
568 * But we can implicitly convert from a BUFFER or INTEGER
569 * Aka - "Implicit Source Operand Conversion"
571 Status = AcpiExConvertToString (ObjDesc, StackPtr,
572 ACPI_IMPLICIT_CONVERT_HEX);
573 if (ACPI_FAILURE (Status))
575 if (Status == AE_TYPE)
577 ACPI_ERROR ((AE_INFO,
578 "Needed [Integer/String/Buffer], found [%s] %p",
579 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
581 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
584 return_ACPI_STATUS (Status);
587 if (ObjDesc != *StackPtr)
589 AcpiUtRemoveReference (ObjDesc);
594 case ARGI_COMPUTEDATA:
596 /* Need an operand of type INTEGER, STRING or BUFFER */
598 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
600 case ACPI_TYPE_INTEGER:
601 case ACPI_TYPE_STRING:
602 case ACPI_TYPE_BUFFER:
608 ACPI_ERROR ((AE_INFO,
609 "Needed [Integer/String/Buffer], found [%s] %p",
610 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
612 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
617 case ARGI_BUFFER_OR_STRING:
619 /* Need an operand of type STRING or BUFFER */
621 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
623 case ACPI_TYPE_STRING:
624 case ACPI_TYPE_BUFFER:
629 case ACPI_TYPE_INTEGER:
631 /* Highest priority conversion is to type Buffer */
633 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr);
634 if (ACPI_FAILURE (Status))
636 return_ACPI_STATUS (Status);
639 if (ObjDesc != *StackPtr)
641 AcpiUtRemoveReference (ObjDesc);
646 ACPI_ERROR ((AE_INFO,
647 "Needed [Integer/String/Buffer], found [%s] %p",
648 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
650 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
655 case ARGI_DATAOBJECT:
657 * ARGI_DATAOBJECT is only used by the SizeOf operator.
658 * Need a buffer, string, package, or RefOf reference.
660 * The only reference allowed here is a direct reference to
663 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
665 case ACPI_TYPE_PACKAGE:
666 case ACPI_TYPE_STRING:
667 case ACPI_TYPE_BUFFER:
668 case ACPI_TYPE_LOCAL_REFERENCE:
674 ACPI_ERROR ((AE_INFO,
675 "Needed [Buffer/String/Package/Reference], found [%s] %p",
676 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
678 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
683 case ARGI_COMPLEXOBJ:
685 /* Need a buffer or package or (ACPI 2.0) String */
687 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
689 case ACPI_TYPE_PACKAGE:
690 case ACPI_TYPE_STRING:
691 case ACPI_TYPE_BUFFER:
697 ACPI_ERROR ((AE_INFO,
698 "Needed [Buffer/String/Package], found [%s] %p",
699 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
701 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
706 case ARGI_REGION_OR_BUFFER: /* Used by Load() only */
708 /* Need an operand of type REGION or a BUFFER (which could be a resolved region field) */
710 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
712 case ACPI_TYPE_BUFFER:
713 case ACPI_TYPE_REGION:
719 ACPI_ERROR ((AE_INFO,
720 "Needed [Region/Buffer], found [%s] %p",
721 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
723 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
728 case ARGI_DATAREFOBJ:
730 /* Used by the Store() operator only */
732 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
734 case ACPI_TYPE_INTEGER:
735 case ACPI_TYPE_PACKAGE:
736 case ACPI_TYPE_STRING:
737 case ACPI_TYPE_BUFFER:
738 case ACPI_TYPE_BUFFER_FIELD:
739 case ACPI_TYPE_LOCAL_REFERENCE:
740 case ACPI_TYPE_LOCAL_REGION_FIELD:
741 case ACPI_TYPE_LOCAL_BANK_FIELD:
742 case ACPI_TYPE_LOCAL_INDEX_FIELD:
743 case ACPI_TYPE_DDB_HANDLE:
750 if (AcpiGbl_EnableInterpreterSlack)
753 * Enable original behavior of Store(), allowing any and all
754 * objects as the source operand. The ACPI spec does not
755 * allow this, however.
760 if (TargetOp == AML_DEBUG_OP)
762 /* Allow store of any object to the Debug object */
767 ACPI_ERROR ((AE_INFO,
768 "Needed Integer/Buffer/String/Package/Ref/Ddb], found [%s] %p",
769 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
771 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
780 ACPI_ERROR ((AE_INFO,
781 "Internal - Unknown ARGI (required operand) type %X",
784 return_ACPI_STATUS (AE_BAD_PARAMETER);
788 * Make sure that the original object was resolved to the
789 * required object type (Simple cases only).
791 Status = AcpiExCheckObjectType (TypeNeeded,
792 ACPI_GET_OBJECT_TYPE (*StackPtr), *StackPtr);
793 if (ACPI_FAILURE (Status))
795 return_ACPI_STATUS (Status);
800 * If more operands needed, decrement StackPtr to point
801 * to next operand on stack
803 if (GET_CURRENT_ARG_TYPE (ArgTypes))
809 return_ACPI_STATUS (Status);