1 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/exresop.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
2 /******************************************************************************
4 * Module Name: exresop - AML Interpreter operand/object resolution
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2003, 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__
122 #include "acparser.h"
123 #include "acinterp.h"
126 #define _COMPONENT ACPI_EXECUTER
127 ACPI_MODULE_NAME ("exresop")
130 /*******************************************************************************
132 * FUNCTION: AcpiExCheckObjectType
134 * PARAMETERS: TypeNeeded Object type needed
135 * ThisType Actual object type
136 * Object Object pointer
140 * DESCRIPTION: Check required type against actual type
142 ******************************************************************************/
145 AcpiExCheckObjectType (
146 ACPI_OBJECT_TYPE TypeNeeded,
147 ACPI_OBJECT_TYPE ThisType,
150 ACPI_FUNCTION_NAME ("ExCheckObjectType");
153 if (TypeNeeded == ACPI_TYPE_ANY)
155 /* All types OK, so we don't perform any typechecks */
160 if (TypeNeeded == ACPI_TYPE_LOCAL_REFERENCE)
163 * Allow the AML "Constant" opcodes (Zero, One, etc.) to be reference
164 * objects and thus allow them to be targets. (As per the ACPI
165 * specification, a store to a constant is a noop.)
167 if ((ThisType == ACPI_TYPE_INTEGER) &&
168 (((ACPI_OPERAND_OBJECT *) Object)->Common.Flags & AOPOBJ_AML_CONSTANT))
174 if (TypeNeeded != ThisType)
176 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
177 "Needed [%s], found [%s] %p\n",
178 AcpiUtGetTypeName (TypeNeeded),
179 AcpiUtGetTypeName (ThisType), Object));
181 return (AE_AML_OPERAND_TYPE);
188 /*******************************************************************************
190 * FUNCTION: AcpiExResolveOperands
192 * PARAMETERS: Opcode - Opcode being interpreted
193 * StackPtr - Pointer to the operand stack to be
195 * WalkState - Current state
199 * DESCRIPTION: Convert multiple input operands to the types required by the
202 * Each 5-bit group in ArgTypes represents one required
203 * operand and indicates the required Type. The corresponding operand
204 * will be converted to the required type if possible, otherwise we
205 * abort with an exception.
207 ******************************************************************************/
210 AcpiExResolveOperands (
212 ACPI_OPERAND_OBJECT **StackPtr,
213 ACPI_WALK_STATE *WalkState)
215 ACPI_OPERAND_OBJECT *ObjDesc;
216 ACPI_STATUS Status = AE_OK;
220 const ACPI_OPCODE_INFO *OpInfo;
222 ACPI_OBJECT_TYPE TypeNeeded;
225 ACPI_FUNCTION_TRACE_U32 ("ExResolveOperands", Opcode);
228 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
229 if (OpInfo->Class == AML_CLASS_UNKNOWN)
231 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
234 ArgTypes = OpInfo->RuntimeArgs;
235 if (ArgTypes == ARGI_INVALID_OPCODE)
237 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Internal - %X is not a valid AML opcode\n",
240 return_ACPI_STATUS (AE_AML_INTERNAL);
243 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Opcode %X [%s] OperandTypes=%X \n",
244 Opcode, OpInfo->Name, ArgTypes));
247 * Normal exit is with (ArgTypes == 0) at end of argument list.
248 * Function will return an exception from within the loop upon
249 * finding an entry which is not (or cannot be converted
250 * to) the required type; if stack underflows; or upon
251 * finding a NULL stack entry (which should not happen).
253 while (GET_CURRENT_ARG_TYPE (ArgTypes))
255 if (!StackPtr || !*StackPtr)
257 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Internal - null stack entry at %p\n",
260 return_ACPI_STATUS (AE_AML_INTERNAL);
263 /* Extract useful items */
267 /* Decode the descriptor type */
269 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
271 case ACPI_DESC_TYPE_NAMED:
275 ObjectType = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
279 case ACPI_DESC_TYPE_OPERAND:
281 /* ACPI internal object */
283 ObjectType = ACPI_GET_OBJECT_TYPE (ObjDesc);
285 /* Check for bad ACPI_OBJECT_TYPE */
287 if (!AcpiUtValidObjectType (ObjectType))
289 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Bad operand object type [%X]\n",
292 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
295 if (ObjectType == (UINT8) ACPI_TYPE_LOCAL_REFERENCE)
298 * Decode the Reference
300 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
301 if (OpInfo->Class == AML_CLASS_UNKNOWN)
303 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
306 switch (ObjDesc->Reference.Opcode)
315 ACPI_DEBUG_ONLY_MEMBERS (ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
316 "Reference Opcode: %s\n", OpInfo->Name)));
320 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
321 "Unknown Reference Opcode %X\n",
322 ObjDesc->Reference.Opcode));
324 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
332 /* Invalid descriptor */
334 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
335 "Bad descriptor type %X in Obj %p\n",
336 ACPI_GET_DESCRIPTOR_TYPE (ObjDesc), ObjDesc));
338 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
343 * Get one argument type, point to the next
345 ThisArgType = GET_CURRENT_ARG_TYPE (ArgTypes);
346 INCREMENT_ARG_LIST (ArgTypes);
349 * Handle cases where the object does not need to be
350 * resolved to a value
354 case ARGI_REF_OR_STRING: /* Can be a String or Reference */
356 if ((ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND) &&
357 (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_STRING))
360 * String found - the string references a named object and must be
366 /* Else not a string - fall through to the normal Reference case below */
367 /*lint -fallthrough */
369 case ARGI_REFERENCE: /* References: */
370 case ARGI_INTEGER_REF:
371 case ARGI_OBJECT_REF:
372 case ARGI_DEVICE_REF:
373 case ARGI_TARGETREF: /* Allows implicit conversion rules before store */
374 case ARGI_FIXED_TARGET: /* No implicit conversion before store to target */
375 case ARGI_SIMPLE_TARGET: /* Name, Local, or Arg - no implicit conversion */
377 /* Need an operand of type ACPI_TYPE_LOCAL_REFERENCE */
379 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_NAMED) /* Node (name) ptr OK as-is */
384 Status = AcpiExCheckObjectType (ACPI_TYPE_LOCAL_REFERENCE,
385 ObjectType, ObjDesc);
386 if (ACPI_FAILURE (Status))
388 return_ACPI_STATUS (Status);
391 if (AML_NAME_OP == ObjDesc->Reference.Opcode)
394 * Convert an indirect name ptr to direct name ptr and put
397 TempNode = ObjDesc->Reference.Object;
398 AcpiUtRemoveReference (ObjDesc);
399 (*StackPtr) = TempNode;
407 * We don't want to resolve IndexOp reference objects during
408 * a store because this would be an implicit DeRefOf operation.
409 * Instead, we just want to store the reference object.
410 * -- All others must be resolved below.
412 if ((Opcode == AML_STORE_OP) &&
413 (ACPI_GET_OBJECT_TYPE (*StackPtr) == ACPI_TYPE_LOCAL_REFERENCE) &&
414 ((*StackPtr)->Reference.Opcode == AML_INDEX_OP))
421 /* All cases covered above */
427 * Resolve this object to a value
429 Status = AcpiExResolveToValue (StackPtr, WalkState);
430 if (ACPI_FAILURE (Status))
432 return_ACPI_STATUS (Status);
435 /* Get the resolved object */
440 * Check the resulting object (value) type
445 * For the simple cases, only one type of resolved object
450 /* Need an operand of type ACPI_TYPE_MUTEX */
452 TypeNeeded = ACPI_TYPE_MUTEX;
457 /* Need an operand of type ACPI_TYPE_EVENT */
459 TypeNeeded = ACPI_TYPE_EVENT;
462 case ARGI_PACKAGE: /* Package */
464 /* Need an operand of type ACPI_TYPE_PACKAGE */
466 TypeNeeded = ACPI_TYPE_PACKAGE;
471 /* Any operand type will do */
473 TypeNeeded = ACPI_TYPE_ANY;
478 * The more complex cases allow multiple resolved object types
480 case ARGI_INTEGER: /* Number */
483 * Need an operand of type ACPI_TYPE_INTEGER,
484 * But we can implicitly convert from a STRING or BUFFER
485 * Aka - "Implicit Source Operand Conversion"
487 Status = AcpiExConvertToInteger (ObjDesc, StackPtr, WalkState);
488 if (ACPI_FAILURE (Status))
490 if (Status == AE_TYPE)
492 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
493 "Needed [Integer/String/Buffer], found [%s] %p\n",
494 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
496 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
499 return_ACPI_STATUS (Status);
507 * Need an operand of type ACPI_TYPE_BUFFER,
508 * But we can implicitly convert from a STRING or INTEGER
509 * Aka - "Implicit Source Operand Conversion"
511 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr, WalkState);
512 if (ACPI_FAILURE (Status))
514 if (Status == AE_TYPE)
516 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
517 "Needed [Integer/String/Buffer], found [%s] %p\n",
518 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
520 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
523 return_ACPI_STATUS (Status);
531 * Need an operand of type ACPI_TYPE_STRING,
532 * But we can implicitly convert from a BUFFER or INTEGER
533 * Aka - "Implicit Source Operand Conversion"
535 Status = AcpiExConvertToString (ObjDesc, StackPtr, 16, ACPI_UINT32_MAX, WalkState);
536 if (ACPI_FAILURE (Status))
538 if (Status == AE_TYPE)
540 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
541 "Needed [Integer/String/Buffer], found [%s] %p\n",
542 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
544 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
547 return_ACPI_STATUS (Status);
552 case ARGI_COMPUTEDATA:
554 /* Need an operand of type INTEGER, STRING or BUFFER */
556 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
558 case ACPI_TYPE_INTEGER:
559 case ACPI_TYPE_STRING:
560 case ACPI_TYPE_BUFFER:
566 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
567 "Needed [Integer/String/Buffer], found [%s] %p\n",
568 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
570 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
575 case ARGI_BUFFER_OR_STRING:
577 /* Need an operand of type STRING or BUFFER */
579 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
581 case ACPI_TYPE_STRING:
582 case ACPI_TYPE_BUFFER:
587 case ACPI_TYPE_INTEGER:
589 /* Highest priority conversion is to type Buffer */
591 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr, WalkState);
592 if (ACPI_FAILURE (Status))
594 return_ACPI_STATUS (Status);
599 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
600 "Needed [Integer/String/Buffer], found [%s] %p\n",
601 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
603 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
608 case ARGI_DATAOBJECT:
610 * ARGI_DATAOBJECT is only used by the SizeOf operator.
611 * Need a buffer, string, package, or RefOf reference.
613 * The only reference allowed here is a direct reference to
616 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
618 case ACPI_TYPE_PACKAGE:
619 case ACPI_TYPE_STRING:
620 case ACPI_TYPE_BUFFER:
621 case ACPI_TYPE_LOCAL_REFERENCE:
627 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
628 "Needed [Buffer/String/Package/Reference], found [%s] %p\n",
629 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
631 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
636 case ARGI_COMPLEXOBJ:
638 /* Need a buffer or package or (ACPI 2.0) String */
640 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
642 case ACPI_TYPE_PACKAGE:
643 case ACPI_TYPE_STRING:
644 case ACPI_TYPE_BUFFER:
650 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
651 "Needed [Buffer/String/Package], found [%s] %p\n",
652 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
654 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
659 case ARGI_REGION_OR_FIELD:
661 /* Need an operand of type ACPI_TYPE_REGION or a FIELD in a region */
663 switch (ACPI_GET_OBJECT_TYPE (ObjDesc))
665 case ACPI_TYPE_REGION:
666 case ACPI_TYPE_LOCAL_REGION_FIELD:
667 case ACPI_TYPE_LOCAL_BANK_FIELD:
668 case ACPI_TYPE_LOCAL_INDEX_FIELD:
674 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
675 "Needed [Region/RegionField], found [%s] %p\n",
676 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
678 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
687 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
688 "Internal - Unknown ARGI (required operand) type %X\n",
691 return_ACPI_STATUS (AE_BAD_PARAMETER);
695 * Make sure that the original object was resolved to the
696 * required object type (Simple cases only).
698 Status = AcpiExCheckObjectType (TypeNeeded,
699 ACPI_GET_OBJECT_TYPE (*StackPtr), *StackPtr);
700 if (ACPI_FAILURE (Status))
702 return_ACPI_STATUS (Status);
707 * If more operands needed, decrement StackPtr to point
708 * to next operand on stack
710 if (GET_CURRENT_ARG_TYPE (ArgTypes))
715 } /* while (*Types) */
717 return_ACPI_STATUS (Status);