2 /******************************************************************************
4 * Module Name: exresop - AML Interpreter operand/object resolution
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2006, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acparser.h>
48 #include <acpi/acinterp.h>
49 #include <acpi/acnamesp.h>
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("exresop")
54 /* Local prototypes */
56 acpi_ex_check_object_type(acpi_object_type type_needed,
57 acpi_object_type this_type, void *object);
59 /*******************************************************************************
61 * FUNCTION: acpi_ex_check_object_type
63 * PARAMETERS: type_needed Object type needed
64 * this_type Actual object type
65 * Object Object pointer
69 * DESCRIPTION: Check required type against actual type
71 ******************************************************************************/
74 acpi_ex_check_object_type(acpi_object_type type_needed,
75 acpi_object_type this_type, void *object)
77 ACPI_FUNCTION_ENTRY();
79 if (type_needed == ACPI_TYPE_ANY) {
80 /* All types OK, so we don't perform any typechecks */
85 if (type_needed == ACPI_TYPE_LOCAL_REFERENCE) {
87 * Allow the AML "Constant" opcodes (Zero, One, etc.) to be reference
88 * objects and thus allow them to be targets. (As per the ACPI
89 * specification, a store to a constant is a noop.)
91 if ((this_type == ACPI_TYPE_INTEGER) &&
92 (((union acpi_operand_object *)object)->common.
93 flags & AOPOBJ_AML_CONSTANT)) {
98 if (type_needed != this_type) {
100 "Needed type [%s], found [%s] %p",
101 acpi_ut_get_type_name(type_needed),
102 acpi_ut_get_type_name(this_type), object));
104 return (AE_AML_OPERAND_TYPE);
110 /*******************************************************************************
112 * FUNCTION: acpi_ex_resolve_operands
114 * PARAMETERS: Opcode - Opcode being interpreted
115 * stack_ptr - Pointer to the operand stack to be
117 * walk_state - Current state
121 * DESCRIPTION: Convert multiple input operands to the types required by the
124 * Each 5-bit group in arg_types represents one required
125 * operand and indicates the required Type. The corresponding operand
126 * will be converted to the required type if possible, otherwise we
127 * abort with an exception.
129 ******************************************************************************/
132 acpi_ex_resolve_operands(u16 opcode,
133 union acpi_operand_object ** stack_ptr,
134 struct acpi_walk_state * walk_state)
136 union acpi_operand_object *obj_desc;
137 acpi_status status = AE_OK;
141 const struct acpi_opcode_info *op_info;
143 acpi_object_type type_needed;
146 ACPI_FUNCTION_TRACE_U32("ex_resolve_operands", opcode);
148 op_info = acpi_ps_get_opcode_info(opcode);
149 if (op_info->class == AML_CLASS_UNKNOWN) {
150 return_ACPI_STATUS(AE_AML_BAD_OPCODE);
153 arg_types = op_info->runtime_args;
154 if (arg_types == ARGI_INVALID_OPCODE) {
155 ACPI_ERROR((AE_INFO, "Unknown AML opcode %X", opcode));
157 return_ACPI_STATUS(AE_AML_INTERNAL);
160 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
161 "Opcode %X [%s] required_operand_types=%8.8X\n",
162 opcode, op_info->name, arg_types));
165 * Normal exit is with (arg_types == 0) at end of argument list.
166 * Function will return an exception from within the loop upon
167 * finding an entry which is not (or cannot be converted
168 * to) the required type; if stack underflows; or upon
169 * finding a NULL stack entry (which should not happen).
171 while (GET_CURRENT_ARG_TYPE(arg_types)) {
172 if (!stack_ptr || !*stack_ptr) {
173 ACPI_ERROR((AE_INFO, "Null stack entry at %p",
176 return_ACPI_STATUS(AE_AML_INTERNAL);
179 /* Extract useful items */
181 obj_desc = *stack_ptr;
183 /* Decode the descriptor type */
185 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) {
186 case ACPI_DESC_TYPE_NAMED:
191 ((struct acpi_namespace_node *)obj_desc)->type;
194 * Resolve an alias object. The construction of these objects
195 * guarantees that there is only one level of alias indirection;
196 * thus, the attached object is always the aliased namespace node
198 if (object_type == ACPI_TYPE_LOCAL_ALIAS) {
200 acpi_ns_get_attached_object((struct
203 *stack_ptr = obj_desc;
205 ((struct acpi_namespace_node *)obj_desc)->
210 case ACPI_DESC_TYPE_OPERAND:
212 /* ACPI internal object */
214 object_type = ACPI_GET_OBJECT_TYPE(obj_desc);
216 /* Check for bad acpi_object_type */
218 if (!acpi_ut_valid_object_type(object_type)) {
220 "Bad operand object type [%X]",
223 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
226 if (object_type == (u8) ACPI_TYPE_LOCAL_REFERENCE) {
227 /* Decode the Reference */
229 op_info = acpi_ps_get_opcode_info(opcode);
230 if (op_info->class == AML_CLASS_UNKNOWN) {
231 return_ACPI_STATUS(AE_AML_BAD_OPCODE);
234 switch (obj_desc->reference.opcode) {
236 target_op = AML_DEBUG_OP;
238 /*lint -fallthrough */
245 case AML_LOAD_OP: /* ddb_handle from LOAD_OP or LOAD_TABLE_OP */
246 case AML_INT_NAMEPATH_OP: /* Reference to a named object */
248 ACPI_DEBUG_ONLY_MEMBERS(ACPI_DEBUG_PRINT
250 "Operand is a Reference, ref_opcode [%s]\n",
251 (acpi_ps_get_opcode_info
260 "Operand is a Reference, Unknown Reference Opcode: %X",
264 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
271 /* Invalid descriptor */
274 "Invalid descriptor %p [%s]",
276 acpi_ut_get_descriptor_name(obj_desc)));
278 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
281 /* Get one argument type, point to the next */
283 this_arg_type = GET_CURRENT_ARG_TYPE(arg_types);
284 INCREMENT_ARG_LIST(arg_types);
287 * Handle cases where the object does not need to be
288 * resolved to a value
290 switch (this_arg_type) {
291 case ARGI_REF_OR_STRING: /* Can be a String or Reference */
293 if ((ACPI_GET_DESCRIPTOR_TYPE(obj_desc) ==
294 ACPI_DESC_TYPE_OPERAND)
295 && (ACPI_GET_OBJECT_TYPE(obj_desc) ==
298 * String found - the string references a named object and
299 * must be resolved to a node
305 * Else not a string - fall through to the normal Reference
308 /*lint -fallthrough */
310 case ARGI_REFERENCE: /* References: */
311 case ARGI_INTEGER_REF:
312 case ARGI_OBJECT_REF:
313 case ARGI_DEVICE_REF:
314 case ARGI_TARGETREF: /* Allows implicit conversion rules before store */
315 case ARGI_FIXED_TARGET: /* No implicit conversion before store to target */
316 case ARGI_SIMPLE_TARGET: /* Name, Local, or Arg - no implicit conversion */
319 * Need an operand of type ACPI_TYPE_LOCAL_REFERENCE
320 * A Namespace Node is OK as-is
322 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) ==
323 ACPI_DESC_TYPE_NAMED) {
328 acpi_ex_check_object_type(ACPI_TYPE_LOCAL_REFERENCE,
329 object_type, obj_desc);
330 if (ACPI_FAILURE(status)) {
331 return_ACPI_STATUS(status);
334 if (obj_desc->reference.opcode == AML_NAME_OP) {
335 /* Convert a named reference to the actual named object */
337 temp_node = obj_desc->reference.object;
338 acpi_ut_remove_reference(obj_desc);
339 (*stack_ptr) = temp_node;
343 case ARGI_DATAREFOBJ: /* Store operator only */
346 * We don't want to resolve index_op reference objects during
347 * a store because this would be an implicit de_ref_of 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 (ACPI_GET_OBJECT_TYPE(*stack_ptr) ==
353 ACPI_TYPE_LOCAL_REFERENCE)
354 && ((*stack_ptr)->reference.opcode ==
361 /* All cases covered above */
366 * Resolve this object to a value
368 status = acpi_ex_resolve_to_value(stack_ptr, walk_state);
369 if (ACPI_FAILURE(status)) {
370 return_ACPI_STATUS(status);
373 /* Get the resolved object */
375 obj_desc = *stack_ptr;
378 * Check the resulting object (value) type
380 switch (this_arg_type) {
382 * For the simple cases, only one type of resolved object
387 /* Need an operand of type ACPI_TYPE_MUTEX */
389 type_needed = ACPI_TYPE_MUTEX;
394 /* Need an operand of type ACPI_TYPE_EVENT */
396 type_needed = ACPI_TYPE_EVENT;
399 case ARGI_PACKAGE: /* Package */
401 /* Need an operand of type ACPI_TYPE_PACKAGE */
403 type_needed = ACPI_TYPE_PACKAGE;
408 /* Any operand type will do */
410 type_needed = ACPI_TYPE_ANY;
415 /* Need an operand of type ACPI_TYPE_DDB_HANDLE */
417 type_needed = ACPI_TYPE_LOCAL_REFERENCE;
421 * The more complex cases allow multiple resolved object types
426 * Need an operand of type ACPI_TYPE_INTEGER,
427 * But we can implicitly convert from a STRING or BUFFER
428 * Aka - "Implicit Source Operand Conversion"
431 acpi_ex_convert_to_integer(obj_desc, stack_ptr, 16);
432 if (ACPI_FAILURE(status)) {
433 if (status == AE_TYPE) {
435 "Needed [Integer/String/Buffer], found [%s] %p",
436 acpi_ut_get_object_type_name
437 (obj_desc), obj_desc));
439 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
442 return_ACPI_STATUS(status);
445 if (obj_desc != *stack_ptr) {
446 acpi_ut_remove_reference(obj_desc);
453 * Need an operand of type ACPI_TYPE_BUFFER,
454 * But we can implicitly convert from a STRING or INTEGER
455 * Aka - "Implicit Source Operand Conversion"
457 status = acpi_ex_convert_to_buffer(obj_desc, stack_ptr);
458 if (ACPI_FAILURE(status)) {
459 if (status == AE_TYPE) {
461 "Needed [Integer/String/Buffer], found [%s] %p",
462 acpi_ut_get_object_type_name
463 (obj_desc), obj_desc));
465 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
468 return_ACPI_STATUS(status);
471 if (obj_desc != *stack_ptr) {
472 acpi_ut_remove_reference(obj_desc);
479 * Need an operand of type ACPI_TYPE_STRING,
480 * But we can implicitly convert from a BUFFER or INTEGER
481 * Aka - "Implicit Source Operand Conversion"
483 status = acpi_ex_convert_to_string(obj_desc, stack_ptr,
484 ACPI_IMPLICIT_CONVERT_HEX);
485 if (ACPI_FAILURE(status)) {
486 if (status == AE_TYPE) {
488 "Needed [Integer/String/Buffer], found [%s] %p",
489 acpi_ut_get_object_type_name
490 (obj_desc), obj_desc));
492 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
495 return_ACPI_STATUS(status);
498 if (obj_desc != *stack_ptr) {
499 acpi_ut_remove_reference(obj_desc);
503 case ARGI_COMPUTEDATA:
505 /* Need an operand of type INTEGER, STRING or BUFFER */
507 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
508 case ACPI_TYPE_INTEGER:
509 case ACPI_TYPE_STRING:
510 case ACPI_TYPE_BUFFER:
517 "Needed [Integer/String/Buffer], found [%s] %p",
518 acpi_ut_get_object_type_name
519 (obj_desc), obj_desc));
521 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
525 case ARGI_BUFFER_OR_STRING:
527 /* Need an operand of type STRING or BUFFER */
529 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
530 case ACPI_TYPE_STRING:
531 case ACPI_TYPE_BUFFER:
536 case ACPI_TYPE_INTEGER:
538 /* Highest priority conversion is to type Buffer */
541 acpi_ex_convert_to_buffer(obj_desc,
543 if (ACPI_FAILURE(status)) {
544 return_ACPI_STATUS(status);
547 if (obj_desc != *stack_ptr) {
548 acpi_ut_remove_reference(obj_desc);
554 "Needed [Integer/String/Buffer], found [%s] %p",
555 acpi_ut_get_object_type_name
556 (obj_desc), obj_desc));
558 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
562 case ARGI_DATAOBJECT:
564 * ARGI_DATAOBJECT is only used by the size_of operator.
565 * Need a buffer, string, package, or ref_of reference.
567 * The only reference allowed here is a direct reference to
570 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
571 case ACPI_TYPE_PACKAGE:
572 case ACPI_TYPE_STRING:
573 case ACPI_TYPE_BUFFER:
574 case ACPI_TYPE_LOCAL_REFERENCE:
581 "Needed [Buffer/String/Package/Reference], found [%s] %p",
582 acpi_ut_get_object_type_name
583 (obj_desc), obj_desc));
585 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
589 case ARGI_COMPLEXOBJ:
591 /* Need a buffer or package or (ACPI 2.0) String */
593 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
594 case ACPI_TYPE_PACKAGE:
595 case ACPI_TYPE_STRING:
596 case ACPI_TYPE_BUFFER:
603 "Needed [Buffer/String/Package], found [%s] %p",
604 acpi_ut_get_object_type_name
605 (obj_desc), obj_desc));
607 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
611 case ARGI_REGION_OR_FIELD:
613 /* Need an operand of type REGION or a FIELD in a region */
615 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
616 case ACPI_TYPE_REGION:
617 case ACPI_TYPE_LOCAL_REGION_FIELD:
618 case ACPI_TYPE_LOCAL_BANK_FIELD:
619 case ACPI_TYPE_LOCAL_INDEX_FIELD:
626 "Needed [Region/region_field], found [%s] %p",
627 acpi_ut_get_object_type_name
628 (obj_desc), obj_desc));
630 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
634 case ARGI_DATAREFOBJ:
636 /* Used by the Store() operator only */
638 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
639 case ACPI_TYPE_INTEGER:
640 case ACPI_TYPE_PACKAGE:
641 case ACPI_TYPE_STRING:
642 case ACPI_TYPE_BUFFER:
643 case ACPI_TYPE_BUFFER_FIELD:
644 case ACPI_TYPE_LOCAL_REFERENCE:
645 case ACPI_TYPE_LOCAL_REGION_FIELD:
646 case ACPI_TYPE_LOCAL_BANK_FIELD:
647 case ACPI_TYPE_LOCAL_INDEX_FIELD:
648 case ACPI_TYPE_DDB_HANDLE:
655 if (acpi_gbl_enable_interpreter_slack) {
657 * Enable original behavior of Store(), allowing any and all
658 * objects as the source operand. The ACPI spec does not
659 * allow this, however.
664 if (target_op == AML_DEBUG_OP) {
665 /* Allow store of any object to the Debug object */
671 "Needed Integer/Buffer/String/Package/Ref/Ddb], found [%s] %p",
672 acpi_ut_get_object_type_name
673 (obj_desc), obj_desc));
675 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
684 "Internal - Unknown ARGI (required operand) type %X",
687 return_ACPI_STATUS(AE_BAD_PARAMETER);
691 * Make sure that the original object was resolved to the
692 * required object type (Simple cases only).
694 status = acpi_ex_check_object_type(type_needed,
696 (*stack_ptr), *stack_ptr);
697 if (ACPI_FAILURE(status)) {
698 return_ACPI_STATUS(status);
703 * If more operands needed, decrement stack_ptr to point
704 * to next operand on stack
706 if (GET_CURRENT_ARG_TYPE(arg_types)) {
711 return_ACPI_STATUS(status);