1 /******************************************************************************
3 * Module Name: exresop - AML Interpreter operand/object resolution
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2016, 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.
52 #define _COMPONENT ACPI_EXECUTER
53 ACPI_MODULE_NAME ("exresop")
55 /* Local prototypes */
58 AcpiExCheckObjectType (
59 ACPI_OBJECT_TYPE TypeNeeded,
60 ACPI_OBJECT_TYPE ThisType,
64 /*******************************************************************************
66 * FUNCTION: AcpiExCheckObjectType
68 * PARAMETERS: TypeNeeded Object type needed
69 * ThisType Actual object type
70 * Object Object pointer
74 * DESCRIPTION: Check required type against actual type
76 ******************************************************************************/
79 AcpiExCheckObjectType (
80 ACPI_OBJECT_TYPE TypeNeeded,
81 ACPI_OBJECT_TYPE ThisType,
84 ACPI_FUNCTION_ENTRY ();
87 if (TypeNeeded == ACPI_TYPE_ANY)
89 /* All types OK, so we don't perform any typechecks */
94 if (TypeNeeded == ACPI_TYPE_LOCAL_REFERENCE)
97 * Allow the AML "Constant" opcodes (Zero, One, etc.) to be reference
98 * objects and thus allow them to be targets. (As per the ACPI
99 * specification, a store to a constant is a noop.)
101 if ((ThisType == ACPI_TYPE_INTEGER) &&
102 (((ACPI_OPERAND_OBJECT *) Object)->Common.Flags &
103 AOPOBJ_AML_CONSTANT))
109 if (TypeNeeded != ThisType)
111 ACPI_ERROR ((AE_INFO,
112 "Needed type [%s], found [%s] %p",
113 AcpiUtGetTypeName (TypeNeeded),
114 AcpiUtGetTypeName (ThisType), Object));
116 return (AE_AML_OPERAND_TYPE);
123 /*******************************************************************************
125 * FUNCTION: AcpiExResolveOperands
127 * PARAMETERS: Opcode - Opcode being interpreted
128 * StackPtr - Pointer to the operand stack to be
130 * WalkState - Current state
134 * DESCRIPTION: Convert multiple input operands to the types required by the
137 * Each 5-bit group in ArgTypes represents one required
138 * operand and indicates the required Type. The corresponding operand
139 * will be converted to the required type if possible, otherwise we
140 * abort with an exception.
142 ******************************************************************************/
145 AcpiExResolveOperands (
147 ACPI_OPERAND_OBJECT **StackPtr,
148 ACPI_WALK_STATE *WalkState)
150 ACPI_OPERAND_OBJECT *ObjDesc;
151 ACPI_STATUS Status = AE_OK;
154 const ACPI_OPCODE_INFO *OpInfo;
156 ACPI_OBJECT_TYPE TypeNeeded;
160 ACPI_FUNCTION_TRACE_U32 (ExResolveOperands, Opcode);
163 OpInfo = AcpiPsGetOpcodeInfo (Opcode);
164 if (OpInfo->Class == AML_CLASS_UNKNOWN)
166 return_ACPI_STATUS (AE_AML_BAD_OPCODE);
169 ArgTypes = OpInfo->RuntimeArgs;
170 if (ArgTypes == ARGI_INVALID_OPCODE)
172 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
175 return_ACPI_STATUS (AE_AML_INTERNAL);
178 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
179 "Opcode %X [%s] RequiredOperandTypes=%8.8X\n",
180 Opcode, OpInfo->Name, ArgTypes));
183 * Normal exit is with (ArgTypes == 0) at end of argument list.
184 * Function will return an exception from within the loop upon
185 * finding an entry which is not (or cannot be converted
186 * to) the required type; if stack underflows; or upon
187 * finding a NULL stack entry (which should not happen).
189 while (GET_CURRENT_ARG_TYPE (ArgTypes))
191 if (!StackPtr || !*StackPtr)
193 ACPI_ERROR ((AE_INFO, "Null stack entry at %p",
196 return_ACPI_STATUS (AE_AML_INTERNAL);
199 /* Extract useful items */
203 /* Decode the descriptor type */
205 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
207 case ACPI_DESC_TYPE_NAMED:
211 ObjectType = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
214 * Resolve an alias object. The construction of these objects
215 * guarantees that there is only one level of alias indirection;
216 * thus, the attached object is always the aliased namespace node
218 if (ObjectType == ACPI_TYPE_LOCAL_ALIAS)
220 ObjDesc = AcpiNsGetAttachedObject (
221 (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) ==
303 ACPI_DESC_TYPE_OPERAND) &&
304 (ObjDesc->Common.Type == ACPI_TYPE_STRING))
307 * String found - the string references a named object and
308 * must be resolved to a node
314 * Else not a string - fall through to the normal Reference
317 /*lint -fallthrough */
319 case ARGI_REFERENCE: /* References: */
320 case ARGI_INTEGER_REF:
321 case ARGI_OBJECT_REF:
322 case ARGI_DEVICE_REF:
323 case ARGI_TARGETREF: /* Allows implicit conversion rules before store */
324 case ARGI_FIXED_TARGET: /* No implicit conversion before store to target */
325 case ARGI_SIMPLE_TARGET: /* Name, Local, or Arg - no implicit conversion */
326 case ARGI_STORE_TARGET:
329 * Need an operand of type ACPI_TYPE_LOCAL_REFERENCE
330 * A Namespace Node is OK as-is
332 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc) == ACPI_DESC_TYPE_NAMED)
337 Status = AcpiExCheckObjectType (
338 ACPI_TYPE_LOCAL_REFERENCE, ObjectType, ObjDesc);
339 if (ACPI_FAILURE (Status))
341 return_ACPI_STATUS (Status);
345 case ARGI_DATAREFOBJ: /* Store operator only */
347 * We don't want to resolve IndexOp reference objects during
348 * a store because this would be an implicit DeRefOf operation.
349 * Instead, we just want to store the reference object.
350 * -- All others must be resolved below.
352 if ((Opcode == AML_STORE_OP) &&
353 ((*StackPtr)->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
354 ((*StackPtr)->Reference.Class == ACPI_REFCLASS_INDEX))
362 /* All cases covered above */
368 * Resolve this object to a value
370 Status = AcpiExResolveToValue (StackPtr, WalkState);
371 if (ACPI_FAILURE (Status))
373 return_ACPI_STATUS (Status);
376 /* Get the resolved object */
381 * Check the resulting object (value) type
386 * For the simple cases, only one type of resolved object
391 /* Need an operand of type ACPI_TYPE_MUTEX */
393 TypeNeeded = ACPI_TYPE_MUTEX;
398 /* Need an operand of type ACPI_TYPE_EVENT */
400 TypeNeeded = ACPI_TYPE_EVENT;
403 case ARGI_PACKAGE: /* Package */
405 /* Need an operand of type ACPI_TYPE_PACKAGE */
407 TypeNeeded = ACPI_TYPE_PACKAGE;
412 /* Any operand type will do */
414 TypeNeeded = ACPI_TYPE_ANY;
419 /* Need an operand of type ACPI_TYPE_DDB_HANDLE */
421 TypeNeeded = ACPI_TYPE_LOCAL_REFERENCE;
426 * The more complex cases allow multiple resolved object types
431 * Need an operand of type ACPI_TYPE_INTEGER, but we can
432 * implicitly convert from a STRING or BUFFER.
434 * Known as "Implicit Source Operand Conversion"
436 Status = AcpiExConvertToInteger (ObjDesc, StackPtr,
437 ACPI_STRTOUL_BASE16);
438 if (ACPI_FAILURE (Status))
440 if (Status == AE_TYPE)
442 ACPI_ERROR ((AE_INFO,
443 "Needed [Integer/String/Buffer], found [%s] %p",
444 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
446 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
449 return_ACPI_STATUS (Status);
452 if (ObjDesc != *StackPtr)
454 AcpiUtRemoveReference (ObjDesc);
460 * Need an operand of type ACPI_TYPE_BUFFER,
461 * But we can implicitly convert from a STRING or INTEGER
462 * Aka - "Implicit Source Operand Conversion"
464 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr);
465 if (ACPI_FAILURE (Status))
467 if (Status == AE_TYPE)
469 ACPI_ERROR ((AE_INFO,
470 "Needed [Integer/String/Buffer], found [%s] %p",
471 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
473 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
476 return_ACPI_STATUS (Status);
479 if (ObjDesc != *StackPtr)
481 AcpiUtRemoveReference (ObjDesc);
487 * Need an operand of type ACPI_TYPE_STRING,
488 * But we can implicitly convert from a BUFFER or INTEGER
489 * Aka - "Implicit Source Operand Conversion"
491 Status = AcpiExConvertToString (
492 ObjDesc, StackPtr, ACPI_IMPLICIT_CONVERT_HEX);
493 if (ACPI_FAILURE (Status))
495 if (Status == AE_TYPE)
497 ACPI_ERROR ((AE_INFO,
498 "Needed [Integer/String/Buffer], found [%s] %p",
499 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
501 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
504 return_ACPI_STATUS (Status);
507 if (ObjDesc != *StackPtr)
509 AcpiUtRemoveReference (ObjDesc);
513 case ARGI_COMPUTEDATA:
515 /* Need an operand of type INTEGER, STRING or BUFFER */
517 switch (ObjDesc->Common.Type)
519 case ACPI_TYPE_INTEGER:
520 case ACPI_TYPE_STRING:
521 case ACPI_TYPE_BUFFER:
527 ACPI_ERROR ((AE_INFO,
528 "Needed [Integer/String/Buffer], found [%s] %p",
529 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
531 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
535 case ARGI_BUFFER_OR_STRING:
537 /* Need an operand of type STRING or BUFFER */
539 switch (ObjDesc->Common.Type)
541 case ACPI_TYPE_STRING:
542 case ACPI_TYPE_BUFFER:
547 case ACPI_TYPE_INTEGER:
549 /* Highest priority conversion is to type Buffer */
551 Status = AcpiExConvertToBuffer (ObjDesc, StackPtr);
552 if (ACPI_FAILURE (Status))
554 return_ACPI_STATUS (Status);
557 if (ObjDesc != *StackPtr)
559 AcpiUtRemoveReference (ObjDesc);
564 ACPI_ERROR ((AE_INFO,
565 "Needed [Integer/String/Buffer], found [%s] %p",
566 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
568 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
572 case ARGI_DATAOBJECT:
574 * ARGI_DATAOBJECT is only used by the SizeOf operator.
575 * Need a buffer, string, package, or RefOf reference.
577 * The only reference allowed here is a direct reference to
580 switch (ObjDesc->Common.Type)
582 case ACPI_TYPE_PACKAGE:
583 case ACPI_TYPE_STRING:
584 case ACPI_TYPE_BUFFER:
585 case ACPI_TYPE_LOCAL_REFERENCE:
592 ACPI_ERROR ((AE_INFO,
593 "Needed [Buffer/String/Package/Reference], found [%s] %p",
594 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
596 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
600 case ARGI_COMPLEXOBJ:
602 /* Need a buffer or package or (ACPI 2.0) String */
604 switch (ObjDesc->Common.Type)
606 case ACPI_TYPE_PACKAGE:
607 case ACPI_TYPE_STRING:
608 case ACPI_TYPE_BUFFER:
615 ACPI_ERROR ((AE_INFO,
616 "Needed [Buffer/String/Package], found [%s] %p",
617 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
619 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
623 case ARGI_REGION_OR_BUFFER: /* Used by Load() only */
626 * Need an operand of type REGION or a BUFFER
627 * (which could be a resolved region field)
629 switch (ObjDesc->Common.Type)
631 case ACPI_TYPE_BUFFER:
632 case ACPI_TYPE_REGION:
639 ACPI_ERROR ((AE_INFO,
640 "Needed [Region/Buffer], found [%s] %p",
641 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
643 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
647 case ARGI_DATAREFOBJ:
649 /* Used by the Store() operator only */
651 switch (ObjDesc->Common.Type)
653 case ACPI_TYPE_INTEGER:
654 case ACPI_TYPE_PACKAGE:
655 case ACPI_TYPE_STRING:
656 case ACPI_TYPE_BUFFER:
657 case ACPI_TYPE_BUFFER_FIELD:
658 case ACPI_TYPE_LOCAL_REFERENCE:
659 case ACPI_TYPE_LOCAL_REGION_FIELD:
660 case ACPI_TYPE_LOCAL_BANK_FIELD:
661 case ACPI_TYPE_LOCAL_INDEX_FIELD:
662 case ACPI_TYPE_DDB_HANDLE:
669 if (AcpiGbl_EnableInterpreterSlack)
672 * Enable original behavior of Store(), allowing any
673 * and all objects as the source operand. The ACPI
674 * spec does not allow this, however.
679 if (TargetOp == AML_DEBUG_OP)
681 /* Allow store of any object to the Debug object */
686 ACPI_ERROR ((AE_INFO,
687 "Needed Integer/Buffer/String/Package/Ref/Ddb]"
689 AcpiUtGetObjectTypeName (ObjDesc), ObjDesc));
691 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
699 ACPI_ERROR ((AE_INFO,
700 "Internal - Unknown ARGI (required operand) type 0x%X",
703 return_ACPI_STATUS (AE_BAD_PARAMETER);
707 * Make sure that the original object was resolved to the
708 * required object type (Simple cases only).
710 Status = AcpiExCheckObjectType (
711 TypeNeeded, (*StackPtr)->Common.Type, *StackPtr);
712 if (ACPI_FAILURE (Status))
714 return_ACPI_STATUS (Status);
719 * If more operands needed, decrement StackPtr to point
720 * to next operand on stack
722 if (GET_CURRENT_ARG_TYPE (ArgTypes))
728 ACPI_DUMP_OPERANDS (WalkState->Operands,
729 AcpiPsGetOpcodeName (Opcode), WalkState->NumOperands);
731 return_ACPI_STATUS (Status);