1 /******************************************************************************
3 * Module Name: exresop - AML Interpreter operand/object resolution
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
46 #include <contrib/dev/acpica/include/acpi.h>
47 #include <contrib/dev/acpica/include/accommon.h>
48 #include <contrib/dev/acpica/include/amlcode.h>
49 #include <contrib/dev/acpica/include/acparser.h>
50 #include <contrib/dev/acpica/include/acinterp.h>
51 #include <contrib/dev/acpica/include/acnamesp.h>
54 #define _COMPONENT ACPI_EXECUTER
55 ACPI_MODULE_NAME ("exresop")
57 /* Local prototypes */
60 AcpiExCheckObjectType (
61 ACPI_OBJECT_TYPE TypeNeeded,
62 ACPI_OBJECT_TYPE ThisType,
66 /*******************************************************************************
68 * FUNCTION: AcpiExCheckObjectType
70 * PARAMETERS: TypeNeeded Object type needed
71 * ThisType Actual object type
72 * Object Object pointer
76 * DESCRIPTION: Check required type against actual type
78 ******************************************************************************/
81 AcpiExCheckObjectType (
82 ACPI_OBJECT_TYPE TypeNeeded,
83 ACPI_OBJECT_TYPE ThisType,
86 ACPI_FUNCTION_ENTRY ();
89 if (TypeNeeded == ACPI_TYPE_ANY)
91 /* All types OK, so we don't perform any typechecks */
96 if (TypeNeeded == ACPI_TYPE_LOCAL_REFERENCE)
99 * Allow the AML "Constant" opcodes (Zero, One, etc.) to be reference
100 * objects and thus allow them to be targets. (As per the ACPI
101 * specification, a store to a constant is a noop.)
103 if ((ThisType == ACPI_TYPE_INTEGER) &&
104 (((ACPI_OPERAND_OBJECT *) Object)->Common.Flags & AOPOBJ_AML_CONSTANT))
110 if (TypeNeeded != ThisType)
112 ACPI_ERROR ((AE_INFO,
113 "Needed type [%s], found [%s] %p",
114 AcpiUtGetTypeName (TypeNeeded),
115 AcpiUtGetTypeName (ThisType), Object));
117 return (AE_AML_OPERAND_TYPE);
124 /*******************************************************************************
126 * FUNCTION: AcpiExResolveOperands
128 * PARAMETERS: Opcode - Opcode being interpreted
129 * StackPtr - Pointer to the operand stack to be
131 * WalkState - Current state
135 * DESCRIPTION: Convert multiple input operands to the types required by the
138 * Each 5-bit group in ArgTypes represents one required
139 * operand and indicates the required Type. The corresponding operand
140 * will be converted to the required type if possible, otherwise we
141 * abort with an exception.
143 ******************************************************************************/
146 AcpiExResolveOperands (
148 ACPI_OPERAND_OBJECT **StackPtr,
149 ACPI_WALK_STATE *WalkState)
151 ACPI_OPERAND_OBJECT *ObjDesc;
152 ACPI_STATUS Status = AE_OK;
155 const ACPI_OPCODE_INFO *OpInfo;
157 ACPI_OBJECT_TYPE TypeNeeded;
161 ACPI_FUNCTION_TRACE_U32 (ExResolveOperands, Opcode);
164 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
165 if (OpInfo->Class == AML_CLASS_UNKNOWN)
167 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
170 ArgTypes = OpInfo->RuntimeArgs;
171 if (ArgTypes == ARGI_INVALID_OPCODE)
173 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
176 return_ACPI_STATUS (AE_AML_INTERNAL);
179 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
180 "Opcode %X [%s] RequiredOperandTypes=%8.8X\n",
181 Opcode, OpInfo->Name, ArgTypes));
184 * Normal exit is with (ArgTypes == 0) at end of argument list.
185 * Function will return an exception from within the loop upon
186 * finding an entry which is not (or cannot be converted
187 * to) the required type; if stack underflows; or upon
188 * finding a NULL stack entry (which should not happen).
190 while (GET_CURRENT_ARG_TYPE (ArgTypes))
192 if (!StackPtr || !*StackPtr)
194 ACPI_ERROR ((AE_INFO, "Null stack entry at %p",
197 return_ACPI_STATUS (AE_AML_INTERNAL);
200 /* Extract useful items */
204 /* Decode the descriptor type */
206 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
208 case ACPI_DESC_TYPE_NAMED:
212 ObjectType = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
215 * Resolve an alias object. The construction of these objects
216 * guarantees that there is only one level of alias indirection;
217 * thus, the attached object is always the aliased namespace node
219 if (ObjectType == ACPI_TYPE_LOCAL_ALIAS)
221 ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
223 ObjectType = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
227 case ACPI_DESC_TYPE_OPERAND:
229 /* ACPI internal object */
231 ObjectType = ObjDesc->Common.Type;
233 /* Check for bad ACPI_OBJECT_TYPE */
235 if (!AcpiUtValidObjectType (ObjectType))
237 ACPI_ERROR ((AE_INFO,
238 "Bad operand object type [0x%X]", ObjectType));
240 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
243 if (ObjectType == (UINT8) ACPI_TYPE_LOCAL_REFERENCE)
245 /* Validate the Reference */
247 switch (ObjDesc->Reference.Class)
249 case ACPI_REFCLASS_DEBUG:
251 TargetOp = AML_DEBUG_OP;
253 /*lint -fallthrough */
255 case ACPI_REFCLASS_ARG:
256 case ACPI_REFCLASS_LOCAL:
257 case ACPI_REFCLASS_INDEX:
258 case ACPI_REFCLASS_REFOF:
259 case ACPI_REFCLASS_TABLE: /* DdbHandle from LOAD_OP or LOAD_TABLE_OP */
260 case ACPI_REFCLASS_NAME: /* Reference to a named object */
262 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
263 "Operand is a Reference, Class [%s] %2.2X\n",
264 AcpiUtGetReferenceName (ObjDesc),
265 ObjDesc->Reference.Class));
270 ACPI_ERROR ((AE_INFO,
271 "Unknown Reference Class 0x%2.2X in %p",
272 ObjDesc->Reference.Class, ObjDesc));
274 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
281 /* Invalid descriptor */
283 ACPI_ERROR ((AE_INFO, "Invalid descriptor %p [%s]",
284 ObjDesc, AcpiUtGetDescriptorName (ObjDesc)));
286 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
289 /* Get one argument type, point to the next */
291 ThisArgType = GET_CURRENT_ARG_TYPE (ArgTypes);
292 INCREMENT_ARG_LIST (ArgTypes);
295 * Handle cases where the object does not need to be
296 * resolved to a value
300 case ARGI_REF_OR_STRING: /* Can be a String or Reference */
302 if ((ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_OPERAND) &&
303 (ObjDesc->Common.Type == ACPI_TYPE_STRING))
306 * String found - the string references a named object and
307 * must be resolved to a node
313 * Else not a string - fall through to the normal Reference
316 /*lint -fallthrough */
318 case ARGI_REFERENCE: /* References: */
319 case ARGI_INTEGER_REF:
320 case ARGI_OBJECT_REF:
321 case ARGI_DEVICE_REF:
322 case ARGI_TARGETREF: /* Allows implicit conversion rules before store */
323 case ARGI_FIXED_TARGET: /* No implicit conversion before store to target */
324 case ARGI_SIMPLE_TARGET: /* Name, Local, or Arg - no implicit conversion */
326 * Need an operand of type ACPI_TYPE_LOCAL_REFERENCE
327 * A Namespace Node is OK as-is
329 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_NAMED)
334 Status = AcpiExCheckObjectType (ACPI_TYPE_LOCAL_REFERENCE,
335 ObjectType, ObjDesc);
336 if (ACPI_FAILURE (Status))
338 return_ACPI_STATUS (Status);
342 case ARGI_DATAREFOBJ: /* Store operator only */
344 * We don't want to resolve IndexOp reference objects during
345 * a store because this would be an implicit DeRefOf operation.
346 * Instead, we just want to store the reference object.
347 * -- All others must be resolved below.
349 if ((Opcode == AML_STORE_OP) &&
350 ((*StackPtr)->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
351 ((*StackPtr)->Reference.Class == ACPI_REFCLASS_INDEX))
359 /* All cases covered above */
365 * Resolve this object to a value
367 Status = AcpiExResolveToValue (StackPtr, WalkState);
368 if (ACPI_FAILURE (Status))
370 return_ACPI_STATUS (Status);
373 /* Get the resolved object */
378 * Check the resulting object (value) type
383 * For the simple cases, only one type of resolved object
388 /* Need an operand of type ACPI_TYPE_MUTEX */
390 TypeNeeded = ACPI_TYPE_MUTEX;
395 /* Need an operand of type ACPI_TYPE_EVENT */
397 TypeNeeded = ACPI_TYPE_EVENT;
400 case ARGI_PACKAGE: /* Package */
402 /* Need an operand of type ACPI_TYPE_PACKAGE */
404 TypeNeeded = ACPI_TYPE_PACKAGE;
409 /* Any operand type will do */
411 TypeNeeded = ACPI_TYPE_ANY;
416 /* Need an operand of type ACPI_TYPE_DDB_HANDLE */
418 TypeNeeded = ACPI_TYPE_LOCAL_REFERENCE;
423 * The more complex cases allow multiple resolved object types
428 * Need an operand of type ACPI_TYPE_INTEGER,
429 * But we can implicitly convert from a STRING or BUFFER
430 * Aka - "Implicit Source Operand Conversion"
432 Status = AcpiExConvertToInteger (ObjDesc, StackPtr, 16);
433 if (ACPI_FAILURE (Status))
435 if (Status == AE_TYPE)
437 ACPI_ERROR ((AE_INFO,
438 "Needed [Integer/String/Buffer], found [%s] %p",
439 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
441 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
444 return_ACPI_STATUS (Status);
447 if (ObjDesc != *StackPtr)
449 AcpiUtRemoveReference (ObjDesc);
455 * Need an operand of type ACPI_TYPE_BUFFER,
456 * But we can implicitly convert from a STRING or INTEGER
457 * Aka - "Implicit Source Operand Conversion"
459 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr);
460 if (ACPI_FAILURE (Status))
462 if (Status == AE_TYPE)
464 ACPI_ERROR ((AE_INFO,
465 "Needed [Integer/String/Buffer], found [%s] %p",
466 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
468 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
471 return_ACPI_STATUS (Status);
474 if (ObjDesc != *StackPtr)
476 AcpiUtRemoveReference (ObjDesc);
482 * Need an operand of type ACPI_TYPE_STRING,
483 * But we can implicitly convert from a BUFFER or INTEGER
484 * Aka - "Implicit Source Operand Conversion"
486 Status = AcpiExConvertToString (ObjDesc, StackPtr,
487 ACPI_IMPLICIT_CONVERT_HEX);
488 if (ACPI_FAILURE (Status))
490 if (Status == AE_TYPE)
492 ACPI_ERROR ((AE_INFO,
493 "Needed [Integer/String/Buffer], found [%s] %p",
494 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
496 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
499 return_ACPI_STATUS (Status);
502 if (ObjDesc != *StackPtr)
504 AcpiUtRemoveReference (ObjDesc);
508 case ARGI_COMPUTEDATA:
510 /* Need an operand of type INTEGER, STRING or BUFFER */
512 switch (ObjDesc->Common.Type)
514 case ACPI_TYPE_INTEGER:
515 case ACPI_TYPE_STRING:
516 case ACPI_TYPE_BUFFER:
522 ACPI_ERROR ((AE_INFO,
523 "Needed [Integer/String/Buffer], found [%s] %p",
524 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
526 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
530 case ARGI_BUFFER_OR_STRING:
532 /* Need an operand of type STRING or BUFFER */
534 switch (ObjDesc->Common.Type)
536 case ACPI_TYPE_STRING:
537 case ACPI_TYPE_BUFFER:
542 case ACPI_TYPE_INTEGER:
544 /* Highest priority conversion is to type Buffer */
546 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr);
547 if (ACPI_FAILURE (Status))
549 return_ACPI_STATUS (Status);
552 if (ObjDesc != *StackPtr)
554 AcpiUtRemoveReference (ObjDesc);
559 ACPI_ERROR ((AE_INFO,
560 "Needed [Integer/String/Buffer], found [%s] %p",
561 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
563 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
567 case ARGI_DATAOBJECT:
569 * ARGI_DATAOBJECT is only used by the SizeOf operator.
570 * Need a buffer, string, package, or RefOf reference.
572 * The only reference allowed here is a direct reference to
575 switch (ObjDesc->Common.Type)
577 case ACPI_TYPE_PACKAGE:
578 case ACPI_TYPE_STRING:
579 case ACPI_TYPE_BUFFER:
580 case ACPI_TYPE_LOCAL_REFERENCE:
587 ACPI_ERROR ((AE_INFO,
588 "Needed [Buffer/String/Package/Reference], found [%s] %p",
589 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
591 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
595 case ARGI_COMPLEXOBJ:
597 /* Need a buffer or package or (ACPI 2.0) String */
599 switch (ObjDesc->Common.Type)
601 case ACPI_TYPE_PACKAGE:
602 case ACPI_TYPE_STRING:
603 case ACPI_TYPE_BUFFER:
610 ACPI_ERROR ((AE_INFO,
611 "Needed [Buffer/String/Package], found [%s] %p",
612 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
614 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
618 case ARGI_REGION_OR_BUFFER: /* Used by Load() only */
620 /* Need an operand of type REGION or a BUFFER (which could be a resolved region field) */
622 switch (ObjDesc->Common.Type)
624 case ACPI_TYPE_BUFFER:
625 case ACPI_TYPE_REGION:
632 ACPI_ERROR ((AE_INFO,
633 "Needed [Region/Buffer], found [%s] %p",
634 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
636 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
640 case ARGI_DATAREFOBJ:
642 /* Used by the Store() operator only */
644 switch (ObjDesc->Common.Type)
646 case ACPI_TYPE_INTEGER:
647 case ACPI_TYPE_PACKAGE:
648 case ACPI_TYPE_STRING:
649 case ACPI_TYPE_BUFFER:
650 case ACPI_TYPE_BUFFER_FIELD:
651 case ACPI_TYPE_LOCAL_REFERENCE:
652 case ACPI_TYPE_LOCAL_REGION_FIELD:
653 case ACPI_TYPE_LOCAL_BANK_FIELD:
654 case ACPI_TYPE_LOCAL_INDEX_FIELD:
655 case ACPI_TYPE_DDB_HANDLE:
662 if (AcpiGbl_EnableInterpreterSlack)
665 * Enable original behavior of Store(), allowing any and all
666 * objects as the source operand. The ACPI spec does not
667 * allow this, however.
672 if (TargetOp == AML_DEBUG_OP)
674 /* Allow store of any object to the Debug object */
679 ACPI_ERROR ((AE_INFO,
680 "Needed Integer/Buffer/String/Package/Ref/Ddb], found [%s] %p",
681 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
683 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
691 ACPI_ERROR ((AE_INFO,
692 "Internal - Unknown ARGI (required operand) type 0x%X",
695 return_ACPI_STATUS (AE_BAD_PARAMETER);
699 * Make sure that the original object was resolved to the
700 * required object type (Simple cases only).
702 Status = AcpiExCheckObjectType (TypeNeeded,
703 (*StackPtr)->Common.Type, *StackPtr);
704 if (ACPI_FAILURE (Status))
706 return_ACPI_STATUS (Status);
711 * If more operands needed, decrement StackPtr to point
712 * to next operand on stack
714 if (GET_CURRENT_ARG_TYPE (ArgTypes))
720 ACPI_DUMP_OPERANDS (WalkState->Operands,
721 AcpiPsGetOpcodeName (Opcode), WalkState->NumOperands);
723 return_ACPI_STATUS (Status);