ACPI: ACPICA 20060421
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / acpi / dispatcher / dsmethod.c
1 /******************************************************************************
2 *
3 * Module Name: dsmethod - Parser/Interpreter interface - control method parsing
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2006, R. Byron Moore
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
25 *
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.
29 *
30 * NO WARRANTY
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.
42 */
43
44 #include <acpi/acpi.h>
45 #include <acpi/acparser.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acdispat.h>
48 #include <acpi/acinterp.h>
49 #include <acpi/acnamesp.h>
50 #include <acpi/acdisasm.h>
51
52 #define _COMPONENT ACPI_DISPATCHER
53 ACPI_MODULE_NAME("dsmethod")
54
55 /*******************************************************************************
56 *
57 * FUNCTION: acpi_ds_method_error
58 *
59 * PARAMETERS: Status - Execution status
60 * walk_state - Current state
61 *
62 * RETURN: Status
63 *
64 * DESCRIPTION: Called on method error. Invoke the global exception handler if
65 * present, dump the method data if the disassembler is configured
66 *
67 * Note: Allows the exception handler to change the status code
68 *
69 ******************************************************************************/
70 acpi_status
71 acpi_ds_method_error(acpi_status status, struct acpi_walk_state *walk_state)
72 {
73 ACPI_FUNCTION_ENTRY();
74
75 /* Ignore AE_OK and control exception codes */
76
77 if (ACPI_SUCCESS(status) || (status & AE_CODE_CONTROL)) {
78 return (status);
79 }
80
81 /* Invoke the global exception handler */
82
83 if (acpi_gbl_exception_handler) {
84
85 /* Exit the interpreter, allow handler to execute methods */
86
87 acpi_ex_exit_interpreter();
88
89 /*
90 * Handler can map the exception code to anything it wants, including
91 * AE_OK, in which case the executing method will not be aborted.
92 */
93 status = acpi_gbl_exception_handler(status,
94 walk_state->method_node ?
95 walk_state->method_node->
96 name.integer : 0,
97 walk_state->opcode,
98 walk_state->aml_offset,
99 NULL);
100 (void)acpi_ex_enter_interpreter();
101 }
102 #ifdef ACPI_DISASSEMBLER
103 if (ACPI_FAILURE(status)) {
104
105 /* Display method locals/args if disassembler is present */
106
107 acpi_dm_dump_method_info(status, walk_state, walk_state->op);
108 }
109 #endif
110
111 return (status);
112 }
113
114 /*******************************************************************************
115 *
116 * FUNCTION: acpi_ds_begin_method_execution
117 *
118 * PARAMETERS: method_node - Node of the method
119 * obj_desc - The method object
120 * calling_method_node - Caller of this method (if non-null)
121 *
122 * RETURN: Status
123 *
124 * DESCRIPTION: Prepare a method for execution. Parses the method if necessary,
125 * increments the thread count, and waits at the method semaphore
126 * for clearance to execute.
127 *
128 ******************************************************************************/
129
130 acpi_status
131 acpi_ds_begin_method_execution(struct acpi_namespace_node * method_node,
132 union acpi_operand_object * obj_desc,
133 struct acpi_namespace_node * calling_method_node)
134 {
135 acpi_status status = AE_OK;
136
137 ACPI_FUNCTION_TRACE_PTR(ds_begin_method_execution, method_node);
138
139 if (!method_node) {
140 return_ACPI_STATUS(AE_NULL_ENTRY);
141 }
142
143 /* Prevent wraparound of thread count */
144
145 if (obj_desc->method.thread_count == ACPI_UINT8_MAX) {
146 ACPI_ERROR((AE_INFO,
147 "Method reached maximum reentrancy limit (255)"));
148 return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
149 }
150
151 /*
152 * If there is a concurrency limit on this method, we need to
153 * obtain a unit from the method semaphore.
154 */
155 if (obj_desc->method.semaphore) {
156 /*
157 * Allow recursive method calls, up to the reentrancy/concurrency
158 * limit imposed by the SERIALIZED rule and the sync_level method
159 * parameter.
160 *
161 * The point of this code is to avoid permanently blocking a
162 * thread that is making recursive method calls.
163 */
164 if (method_node == calling_method_node) {
165 if (obj_desc->method.thread_count >=
166 obj_desc->method.concurrency) {
167 return_ACPI_STATUS(AE_AML_METHOD_LIMIT);
168 }
169 }
170
171 /*
172 * Get a unit from the method semaphore. This releases the
173 * interpreter if we block (then reacquires it)
174 */
175 status =
176 acpi_ex_system_wait_semaphore(obj_desc->method.semaphore,
177 ACPI_WAIT_FOREVER);
178 if (ACPI_FAILURE(status)) {
179 return_ACPI_STATUS(status);
180 }
181 }
182
183 /*
184 * Allocate an Owner ID for this method, only if this is the first thread
185 * to begin concurrent execution. We only need one owner_id, even if the
186 * method is invoked recursively.
187 */
188 if (!obj_desc->method.owner_id) {
189 status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
190 if (ACPI_FAILURE(status)) {
191 goto cleanup;
192 }
193 }
194
195 /*
196 * Increment the method parse tree thread count since it has been
197 * reentered one more time (even if it is the same thread)
198 */
199 obj_desc->method.thread_count++;
200 return_ACPI_STATUS(status);
201
202 cleanup:
203 /* On error, must signal the method semaphore if present */
204
205 if (obj_desc->method.semaphore) {
206 (void)acpi_os_signal_semaphore(obj_desc->method.semaphore, 1);
207 }
208 return_ACPI_STATUS(status);
209 }
210
211 /*******************************************************************************
212 *
213 * FUNCTION: acpi_ds_call_control_method
214 *
215 * PARAMETERS: Thread - Info for this thread
216 * this_walk_state - Current walk state
217 * Op - Current Op to be walked
218 *
219 * RETURN: Status
220 *
221 * DESCRIPTION: Transfer execution to a called control method
222 *
223 ******************************************************************************/
224
225 acpi_status
226 acpi_ds_call_control_method(struct acpi_thread_state *thread,
227 struct acpi_walk_state *this_walk_state,
228 union acpi_parse_object *op)
229 {
230 acpi_status status;
231 struct acpi_namespace_node *method_node;
232 struct acpi_walk_state *next_walk_state = NULL;
233 union acpi_operand_object *obj_desc;
234 struct acpi_parameter_info info;
235 u32 i;
236
237 ACPI_FUNCTION_TRACE_PTR(ds_call_control_method, this_walk_state);
238
239 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
240 "Execute method %p, currentstate=%p\n",
241 this_walk_state->prev_op, this_walk_state));
242
243 /*
244 * Get the namespace entry for the control method we are about to call
245 */
246 method_node = this_walk_state->method_call_node;
247 if (!method_node) {
248 return_ACPI_STATUS(AE_NULL_ENTRY);
249 }
250
251 obj_desc = acpi_ns_get_attached_object(method_node);
252 if (!obj_desc) {
253 return_ACPI_STATUS(AE_NULL_OBJECT);
254 }
255
256 /* Init for new method, possibly wait on concurrency semaphore */
257
258 status = acpi_ds_begin_method_execution(method_node, obj_desc,
259 this_walk_state->method_node);
260 if (ACPI_FAILURE(status)) {
261 return_ACPI_STATUS(status);
262 }
263
264 /*
265 * 1) Parse the method. All "normal" methods are parsed for each execution.
266 * Internal methods (_OSI, etc.) do not require parsing.
267 */
268 if (!(obj_desc->method.method_flags & AML_METHOD_INTERNAL_ONLY)) {
269
270 /* Create a new walk state for the parse */
271
272 next_walk_state =
273 acpi_ds_create_walk_state(obj_desc->method.owner_id, op,
274 obj_desc, NULL);
275 if (!next_walk_state) {
276 status = AE_NO_MEMORY;
277 goto cleanup;
278 }
279
280 /* Create and init a parse tree root */
281
282 op = acpi_ps_create_scope_op();
283 if (!op) {
284 status = AE_NO_MEMORY;
285 goto cleanup;
286 }
287
288 status = acpi_ds_init_aml_walk(next_walk_state, op, method_node,
289 obj_desc->method.aml_start,
290 obj_desc->method.aml_length,
291 NULL, 1);
292 if (ACPI_FAILURE(status)) {
293 acpi_ps_delete_parse_tree(op);
294 goto cleanup;
295 }
296
297 /* Begin AML parse (deletes next_walk_state) */
298
299 status = acpi_ps_parse_aml(next_walk_state);
300 acpi_ps_delete_parse_tree(op);
301 if (ACPI_FAILURE(status)) {
302 goto cleanup;
303 }
304 }
305
306 /* 2) Begin method execution. Create a new walk state */
307
308 next_walk_state = acpi_ds_create_walk_state(obj_desc->method.owner_id,
309 NULL, obj_desc, thread);
310 if (!next_walk_state) {
311 status = AE_NO_MEMORY;
312 goto cleanup;
313 }
314
315 /*
316 * The resolved arguments were put on the previous walk state's operand
317 * stack. Operands on the previous walk state stack always
318 * start at index 0. Also, null terminate the list of arguments
319 */
320 this_walk_state->operands[this_walk_state->num_operands] = NULL;
321
322 info.parameters = &this_walk_state->operands[0];
323 info.parameter_type = ACPI_PARAM_ARGS;
324
325 status = acpi_ds_init_aml_walk(next_walk_state, NULL, method_node,
326 obj_desc->method.aml_start,
327 obj_desc->method.aml_length, &info, 3);
328 if (ACPI_FAILURE(status)) {
329 goto cleanup;
330 }
331
332 /*
333 * Delete the operands on the previous walkstate operand stack
334 * (they were copied to new objects)
335 */
336 for (i = 0; i < obj_desc->method.param_count; i++) {
337 acpi_ut_remove_reference(this_walk_state->operands[i]);
338 this_walk_state->operands[i] = NULL;
339 }
340
341 /* Clear the operand stack */
342
343 this_walk_state->num_operands = 0;
344
345 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
346 "Starting nested execution, newstate=%p\n",
347 next_walk_state));
348
349 /* Invoke an internal method if necessary */
350
351 if (obj_desc->method.method_flags & AML_METHOD_INTERNAL_ONLY) {
352 status = obj_desc->method.implementation(next_walk_state);
353 }
354
355 return_ACPI_STATUS(status);
356
357 cleanup:
358
359 /* On error, we must terminate the method properly */
360
361 acpi_ds_terminate_control_method(obj_desc, next_walk_state);
362 if (next_walk_state) {
363 acpi_ds_delete_walk_state(next_walk_state);
364 }
365
366 return_ACPI_STATUS(status);
367 }
368
369 /*******************************************************************************
370 *
371 * FUNCTION: acpi_ds_restart_control_method
372 *
373 * PARAMETERS: walk_state - State for preempted method (caller)
374 * return_desc - Return value from the called method
375 *
376 * RETURN: Status
377 *
378 * DESCRIPTION: Restart a method that was preempted by another (nested) method
379 * invocation. Handle the return value (if any) from the callee.
380 *
381 ******************************************************************************/
382
383 acpi_status
384 acpi_ds_restart_control_method(struct acpi_walk_state *walk_state,
385 union acpi_operand_object *return_desc)
386 {
387 acpi_status status;
388
389 ACPI_FUNCTION_TRACE_PTR(ds_restart_control_method, walk_state);
390
391 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
392 "****Restart [%4.4s] Op %p ReturnValueFromCallee %p\n",
393 (char *)&walk_state->method_node->name,
394 walk_state->method_call_op, return_desc));
395
396 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
397 " ReturnFromThisMethodUsed?=%X ResStack %p Walk %p\n",
398 walk_state->return_used,
399 walk_state->results, walk_state));
400
401 /* Did the called method return a value? */
402
403 if (return_desc) {
404
405 /* Are we actually going to use the return value? */
406
407 if (walk_state->return_used) {
408
409 /* Save the return value from the previous method */
410
411 status = acpi_ds_result_push(return_desc, walk_state);
412 if (ACPI_FAILURE(status)) {
413 acpi_ut_remove_reference(return_desc);
414 return_ACPI_STATUS(status);
415 }
416
417 /*
418 * Save as THIS method's return value in case it is returned
419 * immediately to yet another method
420 */
421 walk_state->return_desc = return_desc;
422 }
423
424 /*
425 * The following code is the
426 * optional support for a so-called "implicit return". Some AML code
427 * assumes that the last value of the method is "implicitly" returned
428 * to the caller. Just save the last result as the return value.
429 * NOTE: this is optional because the ASL language does not actually
430 * support this behavior.
431 */
432 else if (!acpi_ds_do_implicit_return
433 (return_desc, walk_state, FALSE)) {
434 /*
435 * Delete the return value if it will not be used by the
436 * calling method
437 */
438 acpi_ut_remove_reference(return_desc);
439 }
440 }
441
442 return_ACPI_STATUS(AE_OK);
443 }
444
445 /*******************************************************************************
446 *
447 * FUNCTION: acpi_ds_terminate_control_method
448 *
449 * PARAMETERS: method_desc - Method object
450 * walk_state - State associated with the method
451 *
452 * RETURN: None
453 *
454 * DESCRIPTION: Terminate a control method. Delete everything that the method
455 * created, delete all locals and arguments, and delete the parse
456 * tree if requested.
457 *
458 ******************************************************************************/
459
460 void
461 acpi_ds_terminate_control_method(union acpi_operand_object *method_desc,
462 struct acpi_walk_state *walk_state)
463 {
464 struct acpi_namespace_node *method_node;
465 acpi_status status;
466
467 ACPI_FUNCTION_TRACE_PTR(ds_terminate_control_method, walk_state);
468
469 /* method_desc is required, walk_state is optional */
470
471 if (!method_desc) {
472 return_VOID;
473 }
474
475 if (walk_state) {
476
477 /* Delete all arguments and locals */
478
479 acpi_ds_method_data_delete_all(walk_state);
480 }
481
482 /*
483 * Lock the parser while we terminate this method.
484 * If this is the last thread executing the method,
485 * we have additional cleanup to perform
486 */
487 status = acpi_ut_acquire_mutex(ACPI_MTX_PARSER);
488 if (ACPI_FAILURE(status)) {
489 return_VOID;
490 }
491
492 /* Signal completion of the execution of this method if necessary */
493
494 if (method_desc->method.semaphore) {
495 status =
496 acpi_os_signal_semaphore(method_desc->method.semaphore, 1);
497 if (ACPI_FAILURE(status)) {
498
499 /* Ignore error and continue */
500
501 ACPI_EXCEPTION((AE_INFO, status,
502 "Could not signal method semaphore"));
503 }
504 }
505
506 if (walk_state) {
507 /*
508 * Delete any objects created by this method during execution.
509 * The method Node is stored in the walk state
510 */
511 method_node = walk_state->method_node;
512
513 /* Lock namespace for possible update */
514
515 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
516 if (ACPI_FAILURE(status)) {
517 goto exit;
518 }
519
520 /*
521 * Delete any namespace entries created immediately underneath
522 * the method
523 */
524 if (method_node && method_node->child) {
525 acpi_ns_delete_namespace_subtree(method_node);
526 }
527
528 /*
529 * Delete any namespace entries created anywhere else within
530 * the namespace by the execution of this method
531 */
532 acpi_ns_delete_namespace_by_owner(method_desc->method.owner_id);
533 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
534 }
535
536 /* Decrement the thread count on the method */
537
538 if (method_desc->method.thread_count) {
539 method_desc->method.thread_count--;
540 } else {
541 ACPI_ERROR((AE_INFO, "Invalid zero thread count in method"));
542 }
543
544 /* Are there any other threads currently executing this method? */
545
546 if (method_desc->method.thread_count) {
547 /*
548 * Additional threads. Do not release the owner_id in this case,
549 * we immediately reuse it for the next thread executing this method
550 */
551 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
552 "*** Completed execution of one thread, %d threads remaining\n",
553 method_desc->method.thread_count));
554 } else {
555 /* This is the only executing thread for this method */
556
557 /*
558 * Support to dynamically change a method from not_serialized to
559 * Serialized if it appears that the method is incorrectly written and
560 * does not support multiple thread execution. The best example of this
561 * is if such a method creates namespace objects and blocks. A second
562 * thread will fail with an AE_ALREADY_EXISTS exception
563 *
564 * This code is here because we must wait until the last thread exits
565 * before creating the synchronization semaphore.
566 */
567 if ((method_desc->method.concurrency == 1) &&
568 (!method_desc->method.semaphore)) {
569 status = acpi_os_create_semaphore(1, 1,
570 &method_desc->method.
571 semaphore);
572 }
573
574 /* No more threads, we can free the owner_id */
575
576 acpi_ut_release_owner_id(&method_desc->method.owner_id);
577 }
578
579 exit:
580 (void)acpi_ut_release_mutex(ACPI_MTX_PARSER);
581 return_VOID;
582 }
583
584 #ifdef ACPI_INIT_PARSE_METHODS
585 /*
586 * Note 11/2005: Removed this code to parse all methods during table
587 * load because it causes problems if there are any errors during the
588 * parse. Also, it seems like overkill and we probably don't want to
589 * abort a table load because of an issue with a single method.
590 */
591
592 /*******************************************************************************
593 *
594 * FUNCTION: acpi_ds_parse_method
595 *
596 * PARAMETERS: Node - Method node
597 *
598 * RETURN: Status
599 *
600 * DESCRIPTION: Parse the AML that is associated with the method.
601 *
602 * MUTEX: Assumes parser is locked
603 *
604 ******************************************************************************/
605
606 acpi_status acpi_ds_parse_method(struct acpi_namespace_node *node)
607 {
608 acpi_status status;
609 union acpi_operand_object *obj_desc;
610 union acpi_parse_object *op;
611 struct acpi_walk_state *walk_state;
612
613 ACPI_FUNCTION_TRACE_PTR(ds_parse_method, node);
614
615 /* Parameter Validation */
616
617 if (!node) {
618 return_ACPI_STATUS(AE_NULL_ENTRY);
619 }
620
621 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
622 "**** Parsing [%4.4s] **** NamedObj=%p\n",
623 acpi_ut_get_node_name(node), node));
624
625 /* Extract the method object from the method Node */
626
627 obj_desc = acpi_ns_get_attached_object(node);
628 if (!obj_desc) {
629 return_ACPI_STATUS(AE_NULL_OBJECT);
630 }
631
632 /* Create a mutex for the method if there is a concurrency limit */
633
634 if ((obj_desc->method.concurrency != ACPI_INFINITE_CONCURRENCY) &&
635 (!obj_desc->method.semaphore)) {
636 status = acpi_os_create_semaphore(obj_desc->method.concurrency,
637 obj_desc->method.concurrency,
638 &obj_desc->method.semaphore);
639 if (ACPI_FAILURE(status)) {
640 return_ACPI_STATUS(status);
641 }
642 }
643
644 /*
645 * Allocate a new parser op to be the root of the parsed
646 * method tree
647 */
648 op = acpi_ps_alloc_op(AML_METHOD_OP);
649 if (!op) {
650 return_ACPI_STATUS(AE_NO_MEMORY);
651 }
652
653 /* Init new op with the method name and pointer back to the Node */
654
655 acpi_ps_set_name(op, node->name.integer);
656 op->common.node = node;
657
658 /*
659 * Get a new owner_id for objects created by this method. Namespace
660 * objects (such as Operation Regions) can be created during the
661 * first pass parse.
662 */
663 status = acpi_ut_allocate_owner_id(&obj_desc->method.owner_id);
664 if (ACPI_FAILURE(status)) {
665 goto cleanup;
666 }
667
668 /* Create and initialize a new walk state */
669
670 walk_state =
671 acpi_ds_create_walk_state(obj_desc->method.owner_id, NULL, NULL,
672 NULL);
673 if (!walk_state) {
674 status = AE_NO_MEMORY;
675 goto cleanup2;
676 }
677
678 status = acpi_ds_init_aml_walk(walk_state, op, node,
679 obj_desc->method.aml_start,
680 obj_desc->method.aml_length, NULL, 1);
681 if (ACPI_FAILURE(status)) {
682 acpi_ds_delete_walk_state(walk_state);
683 goto cleanup2;
684 }
685
686 /*
687 * Parse the method, first pass
688 *
689 * The first pass load is where newly declared named objects are added into
690 * the namespace. Actual evaluation of the named objects (what would be
691 * called a "second pass") happens during the actual execution of the
692 * method so that operands to the named objects can take on dynamic
693 * run-time values.
694 */
695 status = acpi_ps_parse_aml(walk_state);
696 if (ACPI_FAILURE(status)) {
697 goto cleanup2;
698 }
699
700 ACPI_DEBUG_PRINT((ACPI_DB_PARSE,
701 "**** [%4.4s] Parsed **** NamedObj=%p Op=%p\n",
702 acpi_ut_get_node_name(node), node, op));
703
704 /*
705 * Delete the parse tree. We simply re-parse the method for every
706 * execution since there isn't much overhead (compared to keeping lots
707 * of parse trees around)
708 */
709 acpi_ns_delete_namespace_subtree(node);
710 acpi_ns_delete_namespace_by_owner(obj_desc->method.owner_id);
711
712 cleanup2:
713 acpi_ut_release_owner_id(&obj_desc->method.owner_id);
714
715 cleanup:
716 acpi_ps_delete_parse_tree(op);
717 return_ACPI_STATUS(status);
718 }
719 #endif