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_SIMPLE_TARGET
: /* Name, Local, or Arg - no implicit conversion */
325 case ARGI_STORE_TARGET
:
328 * Need an operand of type ACPI_TYPE_LOCAL_REFERENCE
329 * A Namespace Node is OK as-is
331 if (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc
) == ACPI_DESC_TYPE_NAMED
)
336 Status
= AcpiExCheckObjectType (
337 ACPI_TYPE_LOCAL_REFERENCE
, ObjectType
, ObjDesc
);
338 if (ACPI_FAILURE (Status
))
340 return_ACPI_STATUS (Status
);
344 case ARGI_DATAREFOBJ
: /* Store operator only */
346 * We don't want to resolve IndexOp reference objects during
347 * a store because this would be an implicit DeRefOf operation.
348 * Instead, we just want to store the reference object.
349 * -- All others must be resolved below.
351 if ((Opcode
== AML_STORE_OP
) &&
352 ((*StackPtr
)->Common
.Type
== ACPI_TYPE_LOCAL_REFERENCE
) &&
353 ((*StackPtr
)->Reference
.Class
== ACPI_REFCLASS_INDEX
))
361 /* All cases covered above */
367 * Resolve this object to a value
369 Status
= AcpiExResolveToValue (StackPtr
, WalkState
);
370 if (ACPI_FAILURE (Status
))
372 return_ACPI_STATUS (Status
);
375 /* Get the resolved object */
380 * Check the resulting object (value) type
385 * For the simple cases, only one type of resolved object
390 /* Need an operand of type ACPI_TYPE_MUTEX */
392 TypeNeeded
= ACPI_TYPE_MUTEX
;
397 /* Need an operand of type ACPI_TYPE_EVENT */
399 TypeNeeded
= ACPI_TYPE_EVENT
;
402 case ARGI_PACKAGE
: /* Package */
404 /* Need an operand of type ACPI_TYPE_PACKAGE */
406 TypeNeeded
= ACPI_TYPE_PACKAGE
;
411 /* Any operand type will do */
413 TypeNeeded
= ACPI_TYPE_ANY
;
418 /* Need an operand of type ACPI_TYPE_DDB_HANDLE */
420 TypeNeeded
= ACPI_TYPE_LOCAL_REFERENCE
;
425 * The more complex cases allow multiple resolved object types
430 * Need an operand of type ACPI_TYPE_INTEGER, but we can
431 * implicitly convert from a STRING or BUFFER.
433 * Known as "Implicit Source Operand Conversion"
435 Status
= AcpiExConvertToInteger (ObjDesc
, StackPtr
,
436 ACPI_STRTOUL_BASE16
);
437 if (ACPI_FAILURE (Status
))
439 if (Status
== AE_TYPE
)
441 ACPI_ERROR ((AE_INFO
,
442 "Needed [Integer/String/Buffer], found [%s] %p",
443 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
445 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
448 return_ACPI_STATUS (Status
);
451 if (ObjDesc
!= *StackPtr
)
453 AcpiUtRemoveReference (ObjDesc
);
459 * Need an operand of type ACPI_TYPE_BUFFER,
460 * But we can implicitly convert from a STRING or INTEGER
461 * Aka - "Implicit Source Operand Conversion"
463 Status
= AcpiExConvertToBuffer (ObjDesc
, StackPtr
);
464 if (ACPI_FAILURE (Status
))
466 if (Status
== AE_TYPE
)
468 ACPI_ERROR ((AE_INFO
,
469 "Needed [Integer/String/Buffer], found [%s] %p",
470 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
472 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
475 return_ACPI_STATUS (Status
);
478 if (ObjDesc
!= *StackPtr
)
480 AcpiUtRemoveReference (ObjDesc
);
486 * Need an operand of type ACPI_TYPE_STRING,
487 * But we can implicitly convert from a BUFFER or INTEGER
488 * Aka - "Implicit Source Operand Conversion"
490 Status
= AcpiExConvertToString (
491 ObjDesc
, StackPtr
, ACPI_IMPLICIT_CONVERT_HEX
);
492 if (ACPI_FAILURE (Status
))
494 if (Status
== AE_TYPE
)
496 ACPI_ERROR ((AE_INFO
,
497 "Needed [Integer/String/Buffer], found [%s] %p",
498 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
500 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
503 return_ACPI_STATUS (Status
);
506 if (ObjDesc
!= *StackPtr
)
508 AcpiUtRemoveReference (ObjDesc
);
512 case ARGI_COMPUTEDATA
:
514 /* Need an operand of type INTEGER, STRING or BUFFER */
516 switch (ObjDesc
->Common
.Type
)
518 case ACPI_TYPE_INTEGER
:
519 case ACPI_TYPE_STRING
:
520 case ACPI_TYPE_BUFFER
:
526 ACPI_ERROR ((AE_INFO
,
527 "Needed [Integer/String/Buffer], found [%s] %p",
528 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
530 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
534 case ARGI_BUFFER_OR_STRING
:
536 /* Need an operand of type STRING or BUFFER */
538 switch (ObjDesc
->Common
.Type
)
540 case ACPI_TYPE_STRING
:
541 case ACPI_TYPE_BUFFER
:
546 case ACPI_TYPE_INTEGER
:
548 /* Highest priority conversion is to type Buffer */
550 Status
= AcpiExConvertToBuffer (ObjDesc
, StackPtr
);
551 if (ACPI_FAILURE (Status
))
553 return_ACPI_STATUS (Status
);
556 if (ObjDesc
!= *StackPtr
)
558 AcpiUtRemoveReference (ObjDesc
);
563 ACPI_ERROR ((AE_INFO
,
564 "Needed [Integer/String/Buffer], found [%s] %p",
565 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
567 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
571 case ARGI_DATAOBJECT
:
573 * ARGI_DATAOBJECT is only used by the SizeOf operator.
574 * Need a buffer, string, package, or RefOf reference.
576 * The only reference allowed here is a direct reference to
579 switch (ObjDesc
->Common
.Type
)
581 case ACPI_TYPE_PACKAGE
:
582 case ACPI_TYPE_STRING
:
583 case ACPI_TYPE_BUFFER
:
584 case ACPI_TYPE_LOCAL_REFERENCE
:
591 ACPI_ERROR ((AE_INFO
,
592 "Needed [Buffer/String/Package/Reference], found [%s] %p",
593 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
595 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
599 case ARGI_COMPLEXOBJ
:
601 /* Need a buffer or package or (ACPI 2.0) String */
603 switch (ObjDesc
->Common
.Type
)
605 case ACPI_TYPE_PACKAGE
:
606 case ACPI_TYPE_STRING
:
607 case ACPI_TYPE_BUFFER
:
614 ACPI_ERROR ((AE_INFO
,
615 "Needed [Buffer/String/Package], found [%s] %p",
616 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
618 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
622 case ARGI_REGION_OR_BUFFER
: /* Used by Load() only */
625 * Need an operand of type REGION or a BUFFER
626 * (which could be a resolved region field)
628 switch (ObjDesc
->Common
.Type
)
630 case ACPI_TYPE_BUFFER
:
631 case ACPI_TYPE_REGION
:
638 ACPI_ERROR ((AE_INFO
,
639 "Needed [Region/Buffer], found [%s] %p",
640 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
642 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
646 case ARGI_DATAREFOBJ
:
648 /* Used by the Store() operator only */
650 switch (ObjDesc
->Common
.Type
)
652 case ACPI_TYPE_INTEGER
:
653 case ACPI_TYPE_PACKAGE
:
654 case ACPI_TYPE_STRING
:
655 case ACPI_TYPE_BUFFER
:
656 case ACPI_TYPE_BUFFER_FIELD
:
657 case ACPI_TYPE_LOCAL_REFERENCE
:
658 case ACPI_TYPE_LOCAL_REGION_FIELD
:
659 case ACPI_TYPE_LOCAL_BANK_FIELD
:
660 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
661 case ACPI_TYPE_DDB_HANDLE
:
668 if (AcpiGbl_EnableInterpreterSlack
)
671 * Enable original behavior of Store(), allowing any
672 * and all objects as the source operand. The ACPI
673 * spec does not allow this, however.
678 if (TargetOp
== AML_DEBUG_OP
)
680 /* Allow store of any object to the Debug object */
685 ACPI_ERROR ((AE_INFO
,
686 "Needed Integer/Buffer/String/Package/Ref/Ddb]"
688 AcpiUtGetObjectTypeName (ObjDesc
), ObjDesc
));
690 return_ACPI_STATUS (AE_AML_OPERAND_TYPE
);
698 ACPI_ERROR ((AE_INFO
,
699 "Internal - Unknown ARGI (required operand) type 0x%X",
702 return_ACPI_STATUS (AE_BAD_PARAMETER
);
706 * Make sure that the original object was resolved to the
707 * required object type (Simple cases only).
709 Status
= AcpiExCheckObjectType (
710 TypeNeeded
, (*StackPtr
)->Common
.Type
, *StackPtr
);
711 if (ACPI_FAILURE (Status
))
713 return_ACPI_STATUS (Status
);
718 * If more operands needed, decrement StackPtr to point
719 * to next operand on stack
721 if (GET_CURRENT_ARG_TYPE (ArgTypes
))
727 ACPI_DUMP_OPERANDS (WalkState
->Operands
,
728 AcpiPsGetOpcodeName (Opcode
), WalkState
->NumOperands
);
730 return_ACPI_STATUS (Status
);