ACPICA: Cleanup debug operand dump mechanism
[linux-2.6/linux-2.6-openrd.git] / drivers / acpi / dispatcher / dswexec.c
blobb5072fa9c9205210ac731f45237a22cfd52c0d8a
1 /******************************************************************************
3 * Module Name: dswexec - Dispatcher method execution callbacks;
4 * dispatch to interpreter.
6 *****************************************************************************/
8 /*
9 * Copyright (C) 2000 - 2008, Intel Corp.
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
14 * are met:
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.
31 * NO WARRANTY
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/acparser.h>
47 #include <acpi/amlcode.h>
48 #include <acpi/acdispat.h>
49 #include <acpi/acinterp.h>
50 #include <acpi/acnamesp.h>
51 #include <acpi/acdebug.h>
53 #define _COMPONENT ACPI_DISPATCHER
54 ACPI_MODULE_NAME("dswexec")
57 * Dispatch table for opcode classes
59 static ACPI_EXECUTE_OP acpi_gbl_op_type_dispatch[] = {
60 acpi_ex_opcode_0A_0T_1R,
61 acpi_ex_opcode_1A_0T_0R,
62 acpi_ex_opcode_1A_0T_1R,
63 acpi_ex_opcode_1A_1T_0R,
64 acpi_ex_opcode_1A_1T_1R,
65 acpi_ex_opcode_2A_0T_0R,
66 acpi_ex_opcode_2A_0T_1R,
67 acpi_ex_opcode_2A_1T_1R,
68 acpi_ex_opcode_2A_2T_1R,
69 acpi_ex_opcode_3A_0T_0R,
70 acpi_ex_opcode_3A_1T_1R,
71 acpi_ex_opcode_6A_0T_1R
74 /*****************************************************************************
76 * FUNCTION: acpi_ds_get_predicate_value
78 * PARAMETERS: walk_state - Current state of the parse tree walk
79 * result_obj - if non-zero, pop result from result stack
81 * RETURN: Status
83 * DESCRIPTION: Get the result of a predicate evaluation
85 ****************************************************************************/
87 acpi_status
88 acpi_ds_get_predicate_value(struct acpi_walk_state *walk_state,
89 union acpi_operand_object *result_obj)
91 acpi_status status = AE_OK;
92 union acpi_operand_object *obj_desc;
93 union acpi_operand_object *local_obj_desc = NULL;
95 ACPI_FUNCTION_TRACE_PTR(ds_get_predicate_value, walk_state);
97 walk_state->control_state->common.state = 0;
99 if (result_obj) {
100 status = acpi_ds_result_pop(&obj_desc, walk_state);
101 if (ACPI_FAILURE(status)) {
102 ACPI_EXCEPTION((AE_INFO, status,
103 "Could not get result from predicate evaluation"));
105 return_ACPI_STATUS(status);
107 } else {
108 status = acpi_ds_create_operand(walk_state, walk_state->op, 0);
109 if (ACPI_FAILURE(status)) {
110 return_ACPI_STATUS(status);
113 status =
114 acpi_ex_resolve_to_value(&walk_state->operands[0],
115 walk_state);
116 if (ACPI_FAILURE(status)) {
117 return_ACPI_STATUS(status);
120 obj_desc = walk_state->operands[0];
123 if (!obj_desc) {
124 ACPI_ERROR((AE_INFO,
125 "No predicate ObjDesc=%p State=%p",
126 obj_desc, walk_state));
128 return_ACPI_STATUS(AE_AML_NO_OPERAND);
132 * Result of predicate evaluation must be an Integer
133 * object. Implicitly convert the argument if necessary.
135 status = acpi_ex_convert_to_integer(obj_desc, &local_obj_desc, 16);
136 if (ACPI_FAILURE(status)) {
137 goto cleanup;
140 if (ACPI_GET_OBJECT_TYPE(local_obj_desc) != ACPI_TYPE_INTEGER) {
141 ACPI_ERROR((AE_INFO,
142 "Bad predicate (not an integer) ObjDesc=%p State=%p Type=%X",
143 obj_desc, walk_state,
144 ACPI_GET_OBJECT_TYPE(obj_desc)));
146 status = AE_AML_OPERAND_TYPE;
147 goto cleanup;
150 /* Truncate the predicate to 32-bits if necessary */
152 acpi_ex_truncate_for32bit_table(local_obj_desc);
155 * Save the result of the predicate evaluation on
156 * the control stack
158 if (local_obj_desc->integer.value) {
159 walk_state->control_state->common.value = TRUE;
160 } else {
162 * Predicate is FALSE, we will just toss the
163 * rest of the package
165 walk_state->control_state->common.value = FALSE;
166 status = AE_CTRL_FALSE;
169 cleanup:
171 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Completed a predicate eval=%X Op=%p\n",
172 walk_state->control_state->common.value,
173 walk_state->op));
175 /* Break to debugger to display result */
177 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
178 (local_obj_desc, walk_state));
181 * Delete the predicate result object (we know that
182 * we don't need it anymore)
184 if (local_obj_desc != obj_desc) {
185 acpi_ut_remove_reference(local_obj_desc);
187 acpi_ut_remove_reference(obj_desc);
189 walk_state->control_state->common.state = ACPI_CONTROL_NORMAL;
190 return_ACPI_STATUS(status);
193 /*****************************************************************************
195 * FUNCTION: acpi_ds_exec_begin_op
197 * PARAMETERS: walk_state - Current state of the parse tree walk
198 * out_op - Where to return op if a new one is created
200 * RETURN: Status
202 * DESCRIPTION: Descending callback used during the execution of control
203 * methods. This is where most operators and operands are
204 * dispatched to the interpreter.
206 ****************************************************************************/
208 acpi_status
209 acpi_ds_exec_begin_op(struct acpi_walk_state *walk_state,
210 union acpi_parse_object **out_op)
212 union acpi_parse_object *op;
213 acpi_status status = AE_OK;
214 u32 opcode_class;
216 ACPI_FUNCTION_TRACE_PTR(ds_exec_begin_op, walk_state);
218 op = walk_state->op;
219 if (!op) {
220 status = acpi_ds_load2_begin_op(walk_state, out_op);
221 if (ACPI_FAILURE(status)) {
222 goto error_exit;
225 op = *out_op;
226 walk_state->op = op;
227 walk_state->opcode = op->common.aml_opcode;
228 walk_state->op_info =
229 acpi_ps_get_opcode_info(op->common.aml_opcode);
231 if (acpi_ns_opens_scope(walk_state->op_info->object_type)) {
232 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
233 "(%s) Popping scope for Op %p\n",
234 acpi_ut_get_type_name(walk_state->
235 op_info->
236 object_type),
237 op));
239 status = acpi_ds_scope_stack_pop(walk_state);
240 if (ACPI_FAILURE(status)) {
241 goto error_exit;
246 if (op == walk_state->origin) {
247 if (out_op) {
248 *out_op = op;
251 return_ACPI_STATUS(AE_OK);
255 * If the previous opcode was a conditional, this opcode
256 * must be the beginning of the associated predicate.
257 * Save this knowledge in the current scope descriptor
259 if ((walk_state->control_state) &&
260 (walk_state->control_state->common.state ==
261 ACPI_CONTROL_CONDITIONAL_EXECUTING)) {
262 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
263 "Exec predicate Op=%p State=%p\n", op,
264 walk_state));
266 walk_state->control_state->common.state =
267 ACPI_CONTROL_PREDICATE_EXECUTING;
269 /* Save start of predicate */
271 walk_state->control_state->control.predicate_op = op;
274 opcode_class = walk_state->op_info->class;
276 /* We want to send namepaths to the load code */
278 if (op->common.aml_opcode == AML_INT_NAMEPATH_OP) {
279 opcode_class = AML_CLASS_NAMED_OBJECT;
283 * Handle the opcode based upon the opcode type
285 switch (opcode_class) {
286 case AML_CLASS_CONTROL:
288 status = acpi_ds_exec_begin_control_op(walk_state, op);
289 break;
291 case AML_CLASS_NAMED_OBJECT:
293 if (walk_state->walk_type & ACPI_WALK_METHOD) {
295 * Found a named object declaration during method execution;
296 * we must enter this object into the namespace. The created
297 * object is temporary and will be deleted upon completion of
298 * the execution of this method.
300 status = acpi_ds_load2_begin_op(walk_state, NULL);
303 break;
305 case AML_CLASS_EXECUTE:
306 case AML_CLASS_CREATE:
308 break;
310 default:
311 break;
314 /* Nothing to do here during method execution */
316 return_ACPI_STATUS(status);
318 error_exit:
319 status = acpi_ds_method_error(status, walk_state);
320 return_ACPI_STATUS(status);
323 /*****************************************************************************
325 * FUNCTION: acpi_ds_exec_end_op
327 * PARAMETERS: walk_state - Current state of the parse tree walk
329 * RETURN: Status
331 * DESCRIPTION: Ascending callback used during the execution of control
332 * methods. The only thing we really need to do here is to
333 * notice the beginning of IF, ELSE, and WHILE blocks.
335 ****************************************************************************/
337 acpi_status acpi_ds_exec_end_op(struct acpi_walk_state *walk_state)
339 union acpi_parse_object *op;
340 acpi_status status = AE_OK;
341 u32 op_type;
342 u32 op_class;
343 union acpi_parse_object *next_op;
344 union acpi_parse_object *first_arg;
346 ACPI_FUNCTION_TRACE_PTR(ds_exec_end_op, walk_state);
348 op = walk_state->op;
349 op_type = walk_state->op_info->type;
350 op_class = walk_state->op_info->class;
352 if (op_class == AML_CLASS_UNKNOWN) {
353 ACPI_ERROR((AE_INFO, "Unknown opcode %X",
354 op->common.aml_opcode));
355 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
358 first_arg = op->common.value.arg;
360 /* Init the walk state */
362 walk_state->num_operands = 0;
363 walk_state->operand_index = 0;
364 walk_state->return_desc = NULL;
365 walk_state->result_obj = NULL;
367 /* Call debugger for single step support (DEBUG build only) */
369 ACPI_DEBUGGER_EXEC(status =
370 acpi_db_single_step(walk_state, op, op_class));
371 ACPI_DEBUGGER_EXEC(if (ACPI_FAILURE(status)) {
372 return_ACPI_STATUS(status);}
375 /* Decode the Opcode Class */
377 switch (op_class) {
378 case AML_CLASS_ARGUMENT: /* Constants, literals, etc. */
380 if (walk_state->opcode == AML_INT_NAMEPATH_OP) {
381 status = acpi_ds_evaluate_name_path(walk_state);
382 if (ACPI_FAILURE(status)) {
383 goto cleanup;
386 break;
388 case AML_CLASS_EXECUTE: /* Most operators with arguments */
390 /* Build resolved operand stack */
392 status = acpi_ds_create_operands(walk_state, first_arg);
393 if (ACPI_FAILURE(status)) {
394 goto cleanup;
398 * All opcodes require operand resolution, with the only exceptions
399 * being the object_type and size_of operators.
401 if (!(walk_state->op_info->flags & AML_NO_OPERAND_RESOLVE)) {
403 /* Resolve all operands */
405 status = acpi_ex_resolve_operands(walk_state->opcode,
406 &(walk_state->
407 operands
408 [walk_state->
409 num_operands - 1]),
410 walk_state);
413 if (ACPI_SUCCESS(status)) {
415 * Dispatch the request to the appropriate interpreter handler
416 * routine. There is one routine per opcode "type" based upon the
417 * number of opcode arguments and return type.
419 status =
420 acpi_gbl_op_type_dispatch[op_type] (walk_state);
421 } else {
423 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
424 * Local is uninitialized.
426 if ((status == AE_AML_UNINITIALIZED_LOCAL) &&
427 (walk_state->opcode == AML_STORE_OP) &&
428 (walk_state->operands[0]->common.type ==
429 ACPI_TYPE_LOCAL_REFERENCE)
430 && (walk_state->operands[1]->common.type ==
431 ACPI_TYPE_LOCAL_REFERENCE)
432 && (walk_state->operands[0]->reference.opcode ==
433 walk_state->operands[1]->reference.opcode)
434 && (walk_state->operands[0]->reference.offset ==
435 walk_state->operands[1]->reference.offset)) {
436 status = AE_OK;
437 } else {
438 ACPI_EXCEPTION((AE_INFO, status,
439 "While resolving operands for [%s]",
440 acpi_ps_get_opcode_name
441 (walk_state->opcode)));
445 /* Always delete the argument objects and clear the operand stack */
447 acpi_ds_clear_operands(walk_state);
450 * If a result object was returned from above, push it on the
451 * current result stack
453 if (ACPI_SUCCESS(status) && walk_state->result_obj) {
454 status =
455 acpi_ds_result_push(walk_state->result_obj,
456 walk_state);
458 break;
460 default:
462 switch (op_type) {
463 case AML_TYPE_CONTROL: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
465 /* 1 Operand, 0 external_result, 0 internal_result */
467 status = acpi_ds_exec_end_control_op(walk_state, op);
469 break;
471 case AML_TYPE_METHOD_CALL:
474 * If the method is referenced from within a package
475 * declaration, it is not a invocation of the method, just
476 * a reference to it.
478 if ((op->asl.parent) &&
479 ((op->asl.parent->asl.aml_opcode == AML_PACKAGE_OP)
480 || (op->asl.parent->asl.aml_opcode ==
481 AML_VAR_PACKAGE_OP))) {
482 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
483 "Method Reference in a Package, Op=%p\n",
484 op));
486 op->common.node =
487 (struct acpi_namespace_node *)op->asl.value.
488 arg->asl.node;
489 acpi_ut_add_reference(op->asl.value.arg->asl.
490 node->object);
491 return_ACPI_STATUS(AE_OK);
494 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
495 "Method invocation, Op=%p\n", op));
498 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
499 * the method Node pointer
501 /* next_op points to the op that holds the method name */
503 next_op = first_arg;
505 /* next_op points to first argument op */
507 next_op = next_op->common.next;
510 * Get the method's arguments and put them on the operand stack
512 status = acpi_ds_create_operands(walk_state, next_op);
513 if (ACPI_FAILURE(status)) {
514 break;
518 * Since the operands will be passed to another control method,
519 * we must resolve all local references here (Local variables,
520 * arguments to *this* method, etc.)
522 status = acpi_ds_resolve_operands(walk_state);
523 if (ACPI_FAILURE(status)) {
525 /* On error, clear all resolved operands */
527 acpi_ds_clear_operands(walk_state);
528 break;
532 * Tell the walk loop to preempt this running method and
533 * execute the new method
535 status = AE_CTRL_TRANSFER;
538 * Return now; we don't want to disturb anything,
539 * especially the operand count!
541 return_ACPI_STATUS(status);
543 case AML_TYPE_CREATE_FIELD:
545 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
546 "Executing CreateField Buffer/Index Op=%p\n",
547 op));
549 status = acpi_ds_load2_end_op(walk_state);
550 if (ACPI_FAILURE(status)) {
551 break;
554 status =
555 acpi_ds_eval_buffer_field_operands(walk_state, op);
556 break;
558 case AML_TYPE_CREATE_OBJECT:
560 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
561 "Executing CreateObject (Buffer/Package) Op=%p\n",
562 op));
564 switch (op->common.parent->common.aml_opcode) {
565 case AML_NAME_OP:
568 * Put the Node on the object stack (Contains the ACPI Name
569 * of this object)
571 walk_state->operands[0] =
572 (void *)op->common.parent->common.node;
573 walk_state->num_operands = 1;
575 status = acpi_ds_create_node(walk_state,
576 op->common.parent->
577 common.node,
578 op->common.parent);
579 if (ACPI_FAILURE(status)) {
580 break;
583 /* Fall through */
584 /*lint -fallthrough */
586 case AML_INT_EVAL_SUBTREE_OP:
588 status =
589 acpi_ds_eval_data_object_operands
590 (walk_state, op,
591 acpi_ns_get_attached_object(op->common.
592 parent->common.
593 node));
594 break;
596 default:
598 status =
599 acpi_ds_eval_data_object_operands
600 (walk_state, op, NULL);
601 break;
605 * If a result object was returned from above, push it on the
606 * current result stack
608 if (walk_state->result_obj) {
609 status =
610 acpi_ds_result_push(walk_state->result_obj,
611 walk_state);
613 break;
615 case AML_TYPE_NAMED_FIELD:
616 case AML_TYPE_NAMED_COMPLEX:
617 case AML_TYPE_NAMED_SIMPLE:
618 case AML_TYPE_NAMED_NO_OBJ:
620 status = acpi_ds_load2_end_op(walk_state);
621 if (ACPI_FAILURE(status)) {
622 break;
625 if (op->common.aml_opcode == AML_REGION_OP) {
626 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
627 "Executing OpRegion Address/Length Op=%p\n",
628 op));
630 status =
631 acpi_ds_eval_region_operands(walk_state,
632 op);
633 if (ACPI_FAILURE(status)) {
634 break;
636 } else if (op->common.aml_opcode == AML_DATA_REGION_OP) {
637 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
638 "Executing DataTableRegion Strings Op=%p\n",
639 op));
641 status =
642 acpi_ds_eval_table_region_operands
643 (walk_state, op);
644 if (ACPI_FAILURE(status)) {
645 break;
647 } else if (op->common.aml_opcode == AML_BANK_FIELD_OP) {
648 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
649 "Executing BankField Op=%p\n",
650 op));
652 status =
653 acpi_ds_eval_bank_field_operands(walk_state,
654 op);
655 if (ACPI_FAILURE(status)) {
656 break;
659 break;
661 case AML_TYPE_UNDEFINED:
663 ACPI_ERROR((AE_INFO,
664 "Undefined opcode type Op=%p", op));
665 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
667 case AML_TYPE_BOGUS:
669 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
670 "Internal opcode=%X type Op=%p\n",
671 walk_state->opcode, op));
672 break;
674 default:
676 ACPI_ERROR((AE_INFO,
677 "Unimplemented opcode, class=%X type=%X Opcode=%X Op=%p",
678 op_class, op_type, op->common.aml_opcode,
679 op));
681 status = AE_NOT_IMPLEMENTED;
682 break;
687 * ACPI 2.0 support for 64-bit integers: Truncate numeric
688 * result value if we are executing from a 32-bit ACPI table
690 acpi_ex_truncate_for32bit_table(walk_state->result_obj);
693 * Check if we just completed the evaluation of a
694 * conditional predicate
696 if ((ACPI_SUCCESS(status)) &&
697 (walk_state->control_state) &&
698 (walk_state->control_state->common.state ==
699 ACPI_CONTROL_PREDICATE_EXECUTING) &&
700 (walk_state->control_state->control.predicate_op == op)) {
701 status =
702 acpi_ds_get_predicate_value(walk_state,
703 walk_state->result_obj);
704 walk_state->result_obj = NULL;
707 cleanup:
709 if (walk_state->result_obj) {
711 /* Break to debugger to display result */
713 ACPI_DEBUGGER_EXEC(acpi_db_display_result_object
714 (walk_state->result_obj, walk_state));
717 * Delete the result op if and only if:
718 * Parent will not use the result -- such as any
719 * non-nested type2 op in a method (parent will be method)
721 acpi_ds_delete_result_if_not_used(op, walk_state->result_obj,
722 walk_state);
724 #ifdef _UNDER_DEVELOPMENT
726 if (walk_state->parser_state.aml == walk_state->parser_state.aml_end) {
727 acpi_db_method_end(walk_state);
729 #endif
731 /* Invoke exception handler on error */
733 if (ACPI_FAILURE(status)) {
734 status = acpi_ds_method_error(status, walk_state);
737 /* Always clear the object stack */
739 walk_state->num_operands = 0;
740 return_ACPI_STATUS(status);