Loading...
1/*******************************************************************************
2 *
3 * Module Name: dsmthdat - control method arguments and local variables
4 *
5 ******************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2011, Intel Corp.
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 "accommon.h"
46#include "acdispat.h"
47#include "acnamesp.h"
48#include "acinterp.h"
49
50#define _COMPONENT ACPI_DISPATCHER
51ACPI_MODULE_NAME("dsmthdat")
52
53/* Local prototypes */
54static void
55acpi_ds_method_data_delete_value(u8 type,
56 u32 index, struct acpi_walk_state *walk_state);
57
58static acpi_status
59acpi_ds_method_data_set_value(u8 type,
60 u32 index,
61 union acpi_operand_object *object,
62 struct acpi_walk_state *walk_state);
63
64#ifdef ACPI_OBSOLETE_FUNCTIONS
65acpi_object_type
66acpi_ds_method_data_get_type(u16 opcode,
67 u32 index, struct acpi_walk_state *walk_state);
68#endif
69
70/*******************************************************************************
71 *
72 * FUNCTION: acpi_ds_method_data_init
73 *
74 * PARAMETERS: walk_state - Current walk state object
75 *
76 * RETURN: Status
77 *
78 * DESCRIPTION: Initialize the data structures that hold the method's arguments
79 * and locals. The data struct is an array of namespace nodes for
80 * each - this allows ref_of and de_ref_of to work properly for these
81 * special data types.
82 *
83 * NOTES: walk_state fields are initialized to zero by the
84 * ACPI_ALLOCATE_ZEROED().
85 *
86 * A pseudo-Namespace Node is assigned to each argument and local
87 * so that ref_of() can return a pointer to the Node.
88 *
89 ******************************************************************************/
90
91void acpi_ds_method_data_init(struct acpi_walk_state *walk_state)
92{
93 u32 i;
94
95 ACPI_FUNCTION_TRACE(ds_method_data_init);
96
97 /* Init the method arguments */
98
99 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) {
100 ACPI_MOVE_32_TO_32(&walk_state->arguments[i].name,
101 NAMEOF_ARG_NTE);
102 walk_state->arguments[i].name.integer |= (i << 24);
103 walk_state->arguments[i].descriptor_type = ACPI_DESC_TYPE_NAMED;
104 walk_state->arguments[i].type = ACPI_TYPE_ANY;
105 walk_state->arguments[i].flags = ANOBJ_METHOD_ARG;
106 }
107
108 /* Init the method locals */
109
110 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) {
111 ACPI_MOVE_32_TO_32(&walk_state->local_variables[i].name,
112 NAMEOF_LOCAL_NTE);
113
114 walk_state->local_variables[i].name.integer |= (i << 24);
115 walk_state->local_variables[i].descriptor_type =
116 ACPI_DESC_TYPE_NAMED;
117 walk_state->local_variables[i].type = ACPI_TYPE_ANY;
118 walk_state->local_variables[i].flags = ANOBJ_METHOD_LOCAL;
119 }
120
121 return_VOID;
122}
123
124/*******************************************************************************
125 *
126 * FUNCTION: acpi_ds_method_data_delete_all
127 *
128 * PARAMETERS: walk_state - Current walk state object
129 *
130 * RETURN: None
131 *
132 * DESCRIPTION: Delete method locals and arguments. Arguments are only
133 * deleted if this method was called from another method.
134 *
135 ******************************************************************************/
136
137void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state)
138{
139 u32 index;
140
141 ACPI_FUNCTION_TRACE(ds_method_data_delete_all);
142
143 /* Detach the locals */
144
145 for (index = 0; index < ACPI_METHOD_NUM_LOCALS; index++) {
146 if (walk_state->local_variables[index].object) {
147 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Local%u=%p\n",
148 index,
149 walk_state->local_variables[index].
150 object));
151
152 /* Detach object (if present) and remove a reference */
153
154 acpi_ns_detach_object(&walk_state->
155 local_variables[index]);
156 }
157 }
158
159 /* Detach the arguments */
160
161 for (index = 0; index < ACPI_METHOD_NUM_ARGS; index++) {
162 if (walk_state->arguments[index].object) {
163 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Arg%u=%p\n",
164 index,
165 walk_state->arguments[index].object));
166
167 /* Detach object (if present) and remove a reference */
168
169 acpi_ns_detach_object(&walk_state->arguments[index]);
170 }
171 }
172
173 return_VOID;
174}
175
176/*******************************************************************************
177 *
178 * FUNCTION: acpi_ds_method_data_init_args
179 *
180 * PARAMETERS: *Params - Pointer to a parameter list for the method
181 * max_param_count - The arg count for this method
182 * walk_state - Current walk state object
183 *
184 * RETURN: Status
185 *
186 * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
187 * of ACPI operand objects, either null terminated or whose length
188 * is defined by max_param_count.
189 *
190 ******************************************************************************/
191
192acpi_status
193acpi_ds_method_data_init_args(union acpi_operand_object **params,
194 u32 max_param_count,
195 struct acpi_walk_state *walk_state)
196{
197 acpi_status status;
198 u32 index = 0;
199
200 ACPI_FUNCTION_TRACE_PTR(ds_method_data_init_args, params);
201
202 if (!params) {
203 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
204 "No param list passed to method\n"));
205 return_ACPI_STATUS(AE_OK);
206 }
207
208 /* Copy passed parameters into the new method stack frame */
209
210 while ((index < ACPI_METHOD_NUM_ARGS) &&
211 (index < max_param_count) && params[index]) {
212 /*
213 * A valid parameter.
214 * Store the argument in the method/walk descriptor.
215 * Do not copy the arg in order to implement call by reference
216 */
217 status = acpi_ds_method_data_set_value(ACPI_REFCLASS_ARG, index,
218 params[index],
219 walk_state);
220 if (ACPI_FAILURE(status)) {
221 return_ACPI_STATUS(status);
222 }
223
224 index++;
225 }
226
227 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%u args passed to method\n", index));
228 return_ACPI_STATUS(AE_OK);
229}
230
231/*******************************************************************************
232 *
233 * FUNCTION: acpi_ds_method_data_get_node
234 *
235 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
236 * ACPI_REFCLASS_ARG
237 * Index - Which Local or Arg whose type to get
238 * walk_state - Current walk state object
239 * Node - Where the node is returned.
240 *
241 * RETURN: Status and node
242 *
243 * DESCRIPTION: Get the Node associated with a local or arg.
244 *
245 ******************************************************************************/
246
247acpi_status
248acpi_ds_method_data_get_node(u8 type,
249 u32 index,
250 struct acpi_walk_state *walk_state,
251 struct acpi_namespace_node **node)
252{
253 ACPI_FUNCTION_TRACE(ds_method_data_get_node);
254
255 /*
256 * Method Locals and Arguments are supported
257 */
258 switch (type) {
259 case ACPI_REFCLASS_LOCAL:
260
261 if (index > ACPI_METHOD_MAX_LOCAL) {
262 ACPI_ERROR((AE_INFO,
263 "Local index %u is invalid (max %u)",
264 index, ACPI_METHOD_MAX_LOCAL));
265 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
266 }
267
268 /* Return a pointer to the pseudo-node */
269
270 *node = &walk_state->local_variables[index];
271 break;
272
273 case ACPI_REFCLASS_ARG:
274
275 if (index > ACPI_METHOD_MAX_ARG) {
276 ACPI_ERROR((AE_INFO,
277 "Arg index %u is invalid (max %u)",
278 index, ACPI_METHOD_MAX_ARG));
279 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
280 }
281
282 /* Return a pointer to the pseudo-node */
283
284 *node = &walk_state->arguments[index];
285 break;
286
287 default:
288 ACPI_ERROR((AE_INFO, "Type %u is invalid", type));
289 return_ACPI_STATUS(AE_TYPE);
290 }
291
292 return_ACPI_STATUS(AE_OK);
293}
294
295/*******************************************************************************
296 *
297 * FUNCTION: acpi_ds_method_data_set_value
298 *
299 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
300 * ACPI_REFCLASS_ARG
301 * Index - Which Local or Arg to get
302 * Object - Object to be inserted into the stack entry
303 * walk_state - Current walk state object
304 *
305 * RETURN: Status
306 *
307 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
308 * Note: There is no "implicit conversion" for locals.
309 *
310 ******************************************************************************/
311
312static acpi_status
313acpi_ds_method_data_set_value(u8 type,
314 u32 index,
315 union acpi_operand_object *object,
316 struct acpi_walk_state *walk_state)
317{
318 acpi_status status;
319 struct acpi_namespace_node *node;
320
321 ACPI_FUNCTION_TRACE(ds_method_data_set_value);
322
323 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
324 "NewObj %p Type %2.2X, Refs=%u [%s]\n", object,
325 type, object->common.reference_count,
326 acpi_ut_get_type_name(object->common.type)));
327
328 /* Get the namespace node for the arg/local */
329
330 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
331 if (ACPI_FAILURE(status)) {
332 return_ACPI_STATUS(status);
333 }
334
335 /*
336 * Increment ref count so object can't be deleted while installed.
337 * NOTE: We do not copy the object in order to preserve the call by
338 * reference semantics of ACPI Control Method invocation.
339 * (See ACPI Specification 2.0_c)
340 */
341 acpi_ut_add_reference(object);
342
343 /* Install the object */
344
345 node->object = object;
346 return_ACPI_STATUS(status);
347}
348
349/*******************************************************************************
350 *
351 * FUNCTION: acpi_ds_method_data_get_value
352 *
353 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
354 * ACPI_REFCLASS_ARG
355 * Index - Which local_var or argument to get
356 * walk_state - Current walk state object
357 * dest_desc - Where Arg or Local value is returned
358 *
359 * RETURN: Status
360 *
361 * DESCRIPTION: Retrieve value of selected Arg or Local for this method
362 * Used only in acpi_ex_resolve_to_value().
363 *
364 ******************************************************************************/
365
366acpi_status
367acpi_ds_method_data_get_value(u8 type,
368 u32 index,
369 struct acpi_walk_state *walk_state,
370 union acpi_operand_object **dest_desc)
371{
372 acpi_status status;
373 struct acpi_namespace_node *node;
374 union acpi_operand_object *object;
375
376 ACPI_FUNCTION_TRACE(ds_method_data_get_value);
377
378 /* Validate the object descriptor */
379
380 if (!dest_desc) {
381 ACPI_ERROR((AE_INFO, "Null object descriptor pointer"));
382 return_ACPI_STATUS(AE_BAD_PARAMETER);
383 }
384
385 /* Get the namespace node for the arg/local */
386
387 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
388 if (ACPI_FAILURE(status)) {
389 return_ACPI_STATUS(status);
390 }
391
392 /* Get the object from the node */
393
394 object = node->object;
395
396 /* Examine the returned object, it must be valid. */
397
398 if (!object) {
399 /*
400 * Index points to uninitialized object.
401 * This means that either 1) The expected argument was
402 * not passed to the method, or 2) A local variable
403 * was referenced by the method (via the ASL)
404 * before it was initialized. Either case is an error.
405 */
406
407 /* If slack enabled, init the local_x/arg_x to an Integer of value zero */
408
409 if (acpi_gbl_enable_interpreter_slack) {
410 object = acpi_ut_create_integer_object((u64) 0);
411 if (!object) {
412 return_ACPI_STATUS(AE_NO_MEMORY);
413 }
414
415 node->object = object;
416 }
417
418 /* Otherwise, return the error */
419
420 else
421 switch (type) {
422 case ACPI_REFCLASS_ARG:
423
424 ACPI_ERROR((AE_INFO,
425 "Uninitialized Arg[%u] at node %p",
426 index, node));
427
428 return_ACPI_STATUS(AE_AML_UNINITIALIZED_ARG);
429
430 case ACPI_REFCLASS_LOCAL:
431
432 /*
433 * No error message for this case, will be trapped again later to
434 * detect and ignore cases of Store(local_x,local_x)
435 */
436 return_ACPI_STATUS(AE_AML_UNINITIALIZED_LOCAL);
437
438 default:
439
440 ACPI_ERROR((AE_INFO,
441 "Not a Arg/Local opcode: 0x%X",
442 type));
443 return_ACPI_STATUS(AE_AML_INTERNAL);
444 }
445 }
446
447 /*
448 * The Index points to an initialized and valid object.
449 * Return an additional reference to the object
450 */
451 *dest_desc = object;
452 acpi_ut_add_reference(object);
453
454 return_ACPI_STATUS(AE_OK);
455}
456
457/*******************************************************************************
458 *
459 * FUNCTION: acpi_ds_method_data_delete_value
460 *
461 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
462 * ACPI_REFCLASS_ARG
463 * Index - Which local_var or argument to delete
464 * walk_state - Current walk state object
465 *
466 * RETURN: None
467 *
468 * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
469 * a null into the stack slot after the object is deleted.
470 *
471 ******************************************************************************/
472
473static void
474acpi_ds_method_data_delete_value(u8 type,
475 u32 index, struct acpi_walk_state *walk_state)
476{
477 acpi_status status;
478 struct acpi_namespace_node *node;
479 union acpi_operand_object *object;
480
481 ACPI_FUNCTION_TRACE(ds_method_data_delete_value);
482
483 /* Get the namespace node for the arg/local */
484
485 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
486 if (ACPI_FAILURE(status)) {
487 return_VOID;
488 }
489
490 /* Get the associated object */
491
492 object = acpi_ns_get_attached_object(node);
493
494 /*
495 * Undefine the Arg or Local by setting its descriptor
496 * pointer to NULL. Locals/Args can contain both
497 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
498 */
499 node->object = NULL;
500
501 if ((object) &&
502 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_OPERAND)) {
503 /*
504 * There is a valid object.
505 * Decrement the reference count by one to balance the
506 * increment when the object was stored.
507 */
508 acpi_ut_remove_reference(object);
509 }
510
511 return_VOID;
512}
513
514/*******************************************************************************
515 *
516 * FUNCTION: acpi_ds_store_object_to_local
517 *
518 * PARAMETERS: Type - Either ACPI_REFCLASS_LOCAL or
519 * ACPI_REFCLASS_ARG
520 * Index - Which Local or Arg to set
521 * obj_desc - Value to be stored
522 * walk_state - Current walk state
523 *
524 * RETURN: Status
525 *
526 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
527 * as the new value for the Arg or Local and the reference count
528 * for obj_desc is incremented.
529 *
530 ******************************************************************************/
531
532acpi_status
533acpi_ds_store_object_to_local(u8 type,
534 u32 index,
535 union acpi_operand_object *obj_desc,
536 struct acpi_walk_state *walk_state)
537{
538 acpi_status status;
539 struct acpi_namespace_node *node;
540 union acpi_operand_object *current_obj_desc;
541 union acpi_operand_object *new_obj_desc;
542
543 ACPI_FUNCTION_TRACE(ds_store_object_to_local);
544 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Type=%2.2X Index=%u Obj=%p\n",
545 type, index, obj_desc));
546
547 /* Parameter validation */
548
549 if (!obj_desc) {
550 return_ACPI_STATUS(AE_BAD_PARAMETER);
551 }
552
553 /* Get the namespace node for the arg/local */
554
555 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
556 if (ACPI_FAILURE(status)) {
557 return_ACPI_STATUS(status);
558 }
559
560 current_obj_desc = acpi_ns_get_attached_object(node);
561 if (current_obj_desc == obj_desc) {
562 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Obj=%p already installed!\n",
563 obj_desc));
564 return_ACPI_STATUS(status);
565 }
566
567 /*
568 * If the reference count on the object is more than one, we must
569 * take a copy of the object before we store. A reference count
570 * of exactly 1 means that the object was just created during the
571 * evaluation of an expression, and we can safely use it since it
572 * is not used anywhere else.
573 */
574 new_obj_desc = obj_desc;
575 if (obj_desc->common.reference_count > 1) {
576 status =
577 acpi_ut_copy_iobject_to_iobject(obj_desc, &new_obj_desc,
578 walk_state);
579 if (ACPI_FAILURE(status)) {
580 return_ACPI_STATUS(status);
581 }
582 }
583
584 /*
585 * If there is an object already in this slot, we either
586 * have to delete it, or if this is an argument and there
587 * is an object reference stored there, we have to do
588 * an indirect store!
589 */
590 if (current_obj_desc) {
591 /*
592 * Check for an indirect store if an argument
593 * contains an object reference (stored as an Node).
594 * We don't allow this automatic dereferencing for
595 * locals, since a store to a local should overwrite
596 * anything there, including an object reference.
597 *
598 * If both Arg0 and Local0 contain ref_of (Local4):
599 *
600 * Store (1, Arg0) - Causes indirect store to local4
601 * Store (1, Local0) - Stores 1 in local0, overwriting
602 * the reference to local4
603 * Store (1, de_refof (Local0)) - Causes indirect store to local4
604 *
605 * Weird, but true.
606 */
607 if (type == ACPI_REFCLASS_ARG) {
608 /*
609 * If we have a valid reference object that came from ref_of(),
610 * do the indirect store
611 */
612 if ((ACPI_GET_DESCRIPTOR_TYPE(current_obj_desc) ==
613 ACPI_DESC_TYPE_OPERAND)
614 && (current_obj_desc->common.type ==
615 ACPI_TYPE_LOCAL_REFERENCE)
616 && (current_obj_desc->reference.class ==
617 ACPI_REFCLASS_REFOF)) {
618 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
619 "Arg (%p) is an ObjRef(Node), storing in node %p\n",
620 new_obj_desc,
621 current_obj_desc));
622
623 /*
624 * Store this object to the Node (perform the indirect store)
625 * NOTE: No implicit conversion is performed, as per the ACPI
626 * specification rules on storing to Locals/Args.
627 */
628 status =
629 acpi_ex_store_object_to_node(new_obj_desc,
630 current_obj_desc->
631 reference.
632 object,
633 walk_state,
634 ACPI_NO_IMPLICIT_CONVERSION);
635
636 /* Remove local reference if we copied the object above */
637
638 if (new_obj_desc != obj_desc) {
639 acpi_ut_remove_reference(new_obj_desc);
640 }
641 return_ACPI_STATUS(status);
642 }
643 }
644
645 /* Delete the existing object before storing the new one */
646
647 acpi_ds_method_data_delete_value(type, index, walk_state);
648 }
649
650 /*
651 * Install the Obj descriptor (*new_obj_desc) into
652 * the descriptor for the Arg or Local.
653 * (increments the object reference count by one)
654 */
655 status =
656 acpi_ds_method_data_set_value(type, index, new_obj_desc,
657 walk_state);
658
659 /* Remove local reference if we copied the object above */
660
661 if (new_obj_desc != obj_desc) {
662 acpi_ut_remove_reference(new_obj_desc);
663 }
664
665 return_ACPI_STATUS(status);
666}
667
668#ifdef ACPI_OBSOLETE_FUNCTIONS
669/*******************************************************************************
670 *
671 * FUNCTION: acpi_ds_method_data_get_type
672 *
673 * PARAMETERS: Opcode - Either AML_LOCAL_OP or AML_ARG_OP
674 * Index - Which Local or Arg whose type to get
675 * walk_state - Current walk state object
676 *
677 * RETURN: Data type of current value of the selected Arg or Local
678 *
679 * DESCRIPTION: Get the type of the object stored in the Local or Arg
680 *
681 ******************************************************************************/
682
683acpi_object_type
684acpi_ds_method_data_get_type(u16 opcode,
685 u32 index, struct acpi_walk_state *walk_state)
686{
687 acpi_status status;
688 struct acpi_namespace_node *node;
689 union acpi_operand_object *object;
690
691 ACPI_FUNCTION_TRACE(ds_method_data_get_type);
692
693 /* Get the namespace node for the arg/local */
694
695 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
696 if (ACPI_FAILURE(status)) {
697 return_VALUE((ACPI_TYPE_NOT_FOUND));
698 }
699
700 /* Get the object */
701
702 object = acpi_ns_get_attached_object(node);
703 if (!object) {
704
705 /* Uninitialized local/arg, return TYPE_ANY */
706
707 return_VALUE(ACPI_TYPE_ANY);
708 }
709
710 /* Get the object type */
711
712 return_VALUE(object->type);
713}
714#endif
1/*******************************************************************************
2 *
3 * Module Name: dsmthdat - control method arguments and local variables
4 *
5 ******************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, Intel Corp.
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 "accommon.h"
46#include "acdispat.h"
47#include "acnamesp.h"
48#include "acinterp.h"
49
50#define _COMPONENT ACPI_DISPATCHER
51ACPI_MODULE_NAME("dsmthdat")
52
53/* Local prototypes */
54static void
55acpi_ds_method_data_delete_value(u8 type,
56 u32 index, struct acpi_walk_state *walk_state);
57
58static acpi_status
59acpi_ds_method_data_set_value(u8 type,
60 u32 index,
61 union acpi_operand_object *object,
62 struct acpi_walk_state *walk_state);
63
64#ifdef ACPI_OBSOLETE_FUNCTIONS
65acpi_object_type
66acpi_ds_method_data_get_type(u16 opcode,
67 u32 index, struct acpi_walk_state *walk_state);
68#endif
69
70/*******************************************************************************
71 *
72 * FUNCTION: acpi_ds_method_data_init
73 *
74 * PARAMETERS: walk_state - Current walk state object
75 *
76 * RETURN: Status
77 *
78 * DESCRIPTION: Initialize the data structures that hold the method's arguments
79 * and locals. The data struct is an array of namespace nodes for
80 * each - this allows ref_of and de_ref_of to work properly for these
81 * special data types.
82 *
83 * NOTES: walk_state fields are initialized to zero by the
84 * ACPI_ALLOCATE_ZEROED().
85 *
86 * A pseudo-Namespace Node is assigned to each argument and local
87 * so that ref_of() can return a pointer to the Node.
88 *
89 ******************************************************************************/
90
91void acpi_ds_method_data_init(struct acpi_walk_state *walk_state)
92{
93 u32 i;
94
95 ACPI_FUNCTION_TRACE(ds_method_data_init);
96
97 /* Init the method arguments */
98
99 for (i = 0; i < ACPI_METHOD_NUM_ARGS; i++) {
100 ACPI_MOVE_32_TO_32(&walk_state->arguments[i].name,
101 NAMEOF_ARG_NTE);
102
103 walk_state->arguments[i].name.integer |= (i << 24);
104 walk_state->arguments[i].descriptor_type = ACPI_DESC_TYPE_NAMED;
105 walk_state->arguments[i].type = ACPI_TYPE_ANY;
106 walk_state->arguments[i].flags = ANOBJ_METHOD_ARG;
107 }
108
109 /* Init the method locals */
110
111 for (i = 0; i < ACPI_METHOD_NUM_LOCALS; i++) {
112 ACPI_MOVE_32_TO_32(&walk_state->local_variables[i].name,
113 NAMEOF_LOCAL_NTE);
114
115 walk_state->local_variables[i].name.integer |= (i << 24);
116 walk_state->local_variables[i].descriptor_type =
117 ACPI_DESC_TYPE_NAMED;
118 walk_state->local_variables[i].type = ACPI_TYPE_ANY;
119 walk_state->local_variables[i].flags = ANOBJ_METHOD_LOCAL;
120 }
121
122 return_VOID;
123}
124
125/*******************************************************************************
126 *
127 * FUNCTION: acpi_ds_method_data_delete_all
128 *
129 * PARAMETERS: walk_state - Current walk state object
130 *
131 * RETURN: None
132 *
133 * DESCRIPTION: Delete method locals and arguments. Arguments are only
134 * deleted if this method was called from another method.
135 *
136 ******************************************************************************/
137
138void acpi_ds_method_data_delete_all(struct acpi_walk_state *walk_state)
139{
140 u32 index;
141
142 ACPI_FUNCTION_TRACE(ds_method_data_delete_all);
143
144 /* Detach the locals */
145
146 for (index = 0; index < ACPI_METHOD_NUM_LOCALS; index++) {
147 if (walk_state->local_variables[index].object) {
148 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Local%u=%p\n",
149 index,
150 walk_state->local_variables[index].
151 object));
152
153 /* Detach object (if present) and remove a reference */
154
155 acpi_ns_detach_object(&walk_state->
156 local_variables[index]);
157 }
158 }
159
160 /* Detach the arguments */
161
162 for (index = 0; index < ACPI_METHOD_NUM_ARGS; index++) {
163 if (walk_state->arguments[index].object) {
164 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Deleting Arg%u=%p\n",
165 index,
166 walk_state->arguments[index].object));
167
168 /* Detach object (if present) and remove a reference */
169
170 acpi_ns_detach_object(&walk_state->arguments[index]);
171 }
172 }
173
174 return_VOID;
175}
176
177/*******************************************************************************
178 *
179 * FUNCTION: acpi_ds_method_data_init_args
180 *
181 * PARAMETERS: *params - Pointer to a parameter list for the method
182 * max_param_count - The arg count for this method
183 * walk_state - Current walk state object
184 *
185 * RETURN: Status
186 *
187 * DESCRIPTION: Initialize arguments for a method. The parameter list is a list
188 * of ACPI operand objects, either null terminated or whose length
189 * is defined by max_param_count.
190 *
191 ******************************************************************************/
192
193acpi_status
194acpi_ds_method_data_init_args(union acpi_operand_object **params,
195 u32 max_param_count,
196 struct acpi_walk_state *walk_state)
197{
198 acpi_status status;
199 u32 index = 0;
200
201 ACPI_FUNCTION_TRACE_PTR(ds_method_data_init_args, params);
202
203 if (!params) {
204 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
205 "No parameter list passed to method\n"));
206 return_ACPI_STATUS(AE_OK);
207 }
208
209 /* Copy passed parameters into the new method stack frame */
210
211 while ((index < ACPI_METHOD_NUM_ARGS) &&
212 (index < max_param_count) && params[index]) {
213 /*
214 * A valid parameter.
215 * Store the argument in the method/walk descriptor.
216 * Do not copy the arg in order to implement call by reference
217 */
218 status =
219 acpi_ds_method_data_set_value(ACPI_REFCLASS_ARG, index,
220 params[index], walk_state);
221 if (ACPI_FAILURE(status)) {
222 return_ACPI_STATUS(status);
223 }
224
225 index++;
226 }
227
228 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%u args passed to method\n", index));
229 return_ACPI_STATUS(AE_OK);
230}
231
232/*******************************************************************************
233 *
234 * FUNCTION: acpi_ds_method_data_get_node
235 *
236 * PARAMETERS: type - Either ACPI_REFCLASS_LOCAL or
237 * ACPI_REFCLASS_ARG
238 * index - Which Local or Arg whose type to get
239 * walk_state - Current walk state object
240 * node - Where the node is returned.
241 *
242 * RETURN: Status and node
243 *
244 * DESCRIPTION: Get the Node associated with a local or arg.
245 *
246 ******************************************************************************/
247
248acpi_status
249acpi_ds_method_data_get_node(u8 type,
250 u32 index,
251 struct acpi_walk_state *walk_state,
252 struct acpi_namespace_node **node)
253{
254 ACPI_FUNCTION_TRACE(ds_method_data_get_node);
255
256 /*
257 * Method Locals and Arguments are supported
258 */
259 switch (type) {
260 case ACPI_REFCLASS_LOCAL:
261
262 if (index > ACPI_METHOD_MAX_LOCAL) {
263 ACPI_ERROR((AE_INFO,
264 "Local index %u is invalid (max %u)",
265 index, ACPI_METHOD_MAX_LOCAL));
266 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
267 }
268
269 /* Return a pointer to the pseudo-node */
270
271 *node = &walk_state->local_variables[index];
272 break;
273
274 case ACPI_REFCLASS_ARG:
275
276 if (index > ACPI_METHOD_MAX_ARG) {
277 ACPI_ERROR((AE_INFO,
278 "Arg index %u is invalid (max %u)",
279 index, ACPI_METHOD_MAX_ARG));
280 return_ACPI_STATUS(AE_AML_INVALID_INDEX);
281 }
282
283 /* Return a pointer to the pseudo-node */
284
285 *node = &walk_state->arguments[index];
286 break;
287
288 default:
289
290 ACPI_ERROR((AE_INFO, "Type %u is invalid", type));
291 return_ACPI_STATUS(AE_TYPE);
292 }
293
294 return_ACPI_STATUS(AE_OK);
295}
296
297/*******************************************************************************
298 *
299 * FUNCTION: acpi_ds_method_data_set_value
300 *
301 * PARAMETERS: type - Either ACPI_REFCLASS_LOCAL or
302 * ACPI_REFCLASS_ARG
303 * index - Which Local or Arg to get
304 * object - Object to be inserted into the stack entry
305 * walk_state - Current walk state object
306 *
307 * RETURN: Status
308 *
309 * DESCRIPTION: Insert an object onto the method stack at entry Opcode:Index.
310 * Note: There is no "implicit conversion" for locals.
311 *
312 ******************************************************************************/
313
314static acpi_status
315acpi_ds_method_data_set_value(u8 type,
316 u32 index,
317 union acpi_operand_object *object,
318 struct acpi_walk_state *walk_state)
319{
320 acpi_status status;
321 struct acpi_namespace_node *node;
322
323 ACPI_FUNCTION_TRACE(ds_method_data_set_value);
324
325 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
326 "NewObj %p Type %2.2X, Refs=%u [%s]\n", object,
327 type, object->common.reference_count,
328 acpi_ut_get_type_name(object->common.type)));
329
330 /* Get the namespace node for the arg/local */
331
332 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
333 if (ACPI_FAILURE(status)) {
334 return_ACPI_STATUS(status);
335 }
336
337 /*
338 * Increment ref count so object can't be deleted while installed.
339 * NOTE: We do not copy the object in order to preserve the call by
340 * reference semantics of ACPI Control Method invocation.
341 * (See ACPI Specification 2.0C)
342 */
343 acpi_ut_add_reference(object);
344
345 /* Install the object */
346
347 node->object = object;
348 return_ACPI_STATUS(status);
349}
350
351/*******************************************************************************
352 *
353 * FUNCTION: acpi_ds_method_data_get_value
354 *
355 * PARAMETERS: type - Either ACPI_REFCLASS_LOCAL or
356 * ACPI_REFCLASS_ARG
357 * index - Which localVar or argument to get
358 * walk_state - Current walk state object
359 * dest_desc - Where Arg or Local value is returned
360 *
361 * RETURN: Status
362 *
363 * DESCRIPTION: Retrieve value of selected Arg or Local for this method
364 * Used only in acpi_ex_resolve_to_value().
365 *
366 ******************************************************************************/
367
368acpi_status
369acpi_ds_method_data_get_value(u8 type,
370 u32 index,
371 struct acpi_walk_state *walk_state,
372 union acpi_operand_object **dest_desc)
373{
374 acpi_status status;
375 struct acpi_namespace_node *node;
376 union acpi_operand_object *object;
377
378 ACPI_FUNCTION_TRACE(ds_method_data_get_value);
379
380 /* Validate the object descriptor */
381
382 if (!dest_desc) {
383 ACPI_ERROR((AE_INFO, "Null object descriptor pointer"));
384 return_ACPI_STATUS(AE_BAD_PARAMETER);
385 }
386
387 /* Get the namespace node for the arg/local */
388
389 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
390 if (ACPI_FAILURE(status)) {
391 return_ACPI_STATUS(status);
392 }
393
394 /* Get the object from the node */
395
396 object = node->object;
397
398 /* Examine the returned object, it must be valid. */
399
400 if (!object) {
401 /*
402 * Index points to uninitialized object.
403 * This means that either 1) The expected argument was
404 * not passed to the method, or 2) A local variable
405 * was referenced by the method (via the ASL)
406 * before it was initialized. Either case is an error.
407 */
408
409 /* If slack enabled, init the local_x/arg_x to an Integer of value zero */
410
411 if (acpi_gbl_enable_interpreter_slack) {
412 object = acpi_ut_create_integer_object((u64) 0);
413 if (!object) {
414 return_ACPI_STATUS(AE_NO_MEMORY);
415 }
416
417 node->object = object;
418 }
419
420 /* Otherwise, return the error */
421
422 else
423 switch (type) {
424 case ACPI_REFCLASS_ARG:
425
426 ACPI_ERROR((AE_INFO,
427 "Uninitialized Arg[%u] at node %p",
428 index, node));
429
430 return_ACPI_STATUS(AE_AML_UNINITIALIZED_ARG);
431
432 case ACPI_REFCLASS_LOCAL:
433 /*
434 * No error message for this case, will be trapped again later to
435 * detect and ignore cases of Store(local_x,local_x)
436 */
437 return_ACPI_STATUS(AE_AML_UNINITIALIZED_LOCAL);
438
439 default:
440
441 ACPI_ERROR((AE_INFO,
442 "Not a Arg/Local opcode: 0x%X",
443 type));
444 return_ACPI_STATUS(AE_AML_INTERNAL);
445 }
446 }
447
448 /*
449 * The Index points to an initialized and valid object.
450 * Return an additional reference to the object
451 */
452 *dest_desc = object;
453 acpi_ut_add_reference(object);
454
455 return_ACPI_STATUS(AE_OK);
456}
457
458/*******************************************************************************
459 *
460 * FUNCTION: acpi_ds_method_data_delete_value
461 *
462 * PARAMETERS: type - Either ACPI_REFCLASS_LOCAL or
463 * ACPI_REFCLASS_ARG
464 * index - Which localVar or argument to delete
465 * walk_state - Current walk state object
466 *
467 * RETURN: None
468 *
469 * DESCRIPTION: Delete the entry at Opcode:Index. Inserts
470 * a null into the stack slot after the object is deleted.
471 *
472 ******************************************************************************/
473
474static void
475acpi_ds_method_data_delete_value(u8 type,
476 u32 index, struct acpi_walk_state *walk_state)
477{
478 acpi_status status;
479 struct acpi_namespace_node *node;
480 union acpi_operand_object *object;
481
482 ACPI_FUNCTION_TRACE(ds_method_data_delete_value);
483
484 /* Get the namespace node for the arg/local */
485
486 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
487 if (ACPI_FAILURE(status)) {
488 return_VOID;
489 }
490
491 /* Get the associated object */
492
493 object = acpi_ns_get_attached_object(node);
494
495 /*
496 * Undefine the Arg or Local by setting its descriptor
497 * pointer to NULL. Locals/Args can contain both
498 * ACPI_OPERAND_OBJECTS and ACPI_NAMESPACE_NODEs
499 */
500 node->object = NULL;
501
502 if ((object) &&
503 (ACPI_GET_DESCRIPTOR_TYPE(object) == ACPI_DESC_TYPE_OPERAND)) {
504 /*
505 * There is a valid object.
506 * Decrement the reference count by one to balance the
507 * increment when the object was stored.
508 */
509 acpi_ut_remove_reference(object);
510 }
511
512 return_VOID;
513}
514
515/*******************************************************************************
516 *
517 * FUNCTION: acpi_ds_store_object_to_local
518 *
519 * PARAMETERS: type - Either ACPI_REFCLASS_LOCAL or
520 * ACPI_REFCLASS_ARG
521 * index - Which Local or Arg to set
522 * obj_desc - Value to be stored
523 * walk_state - Current walk state
524 *
525 * RETURN: Status
526 *
527 * DESCRIPTION: Store a value in an Arg or Local. The obj_desc is installed
528 * as the new value for the Arg or Local and the reference count
529 * for obj_desc is incremented.
530 *
531 ******************************************************************************/
532
533acpi_status
534acpi_ds_store_object_to_local(u8 type,
535 u32 index,
536 union acpi_operand_object *obj_desc,
537 struct acpi_walk_state *walk_state)
538{
539 acpi_status status;
540 struct acpi_namespace_node *node;
541 union acpi_operand_object *current_obj_desc;
542 union acpi_operand_object *new_obj_desc;
543
544 ACPI_FUNCTION_TRACE(ds_store_object_to_local);
545 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Type=%2.2X Index=%u Obj=%p\n",
546 type, index, obj_desc));
547
548 /* Parameter validation */
549
550 if (!obj_desc) {
551 return_ACPI_STATUS(AE_BAD_PARAMETER);
552 }
553
554 /* Get the namespace node for the arg/local */
555
556 status = acpi_ds_method_data_get_node(type, index, walk_state, &node);
557 if (ACPI_FAILURE(status)) {
558 return_ACPI_STATUS(status);
559 }
560
561 current_obj_desc = acpi_ns_get_attached_object(node);
562 if (current_obj_desc == obj_desc) {
563 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Obj=%p already installed!\n",
564 obj_desc));
565 return_ACPI_STATUS(status);
566 }
567
568 /*
569 * If the reference count on the object is more than one, we must
570 * take a copy of the object before we store. A reference count
571 * of exactly 1 means that the object was just created during the
572 * evaluation of an expression, and we can safely use it since it
573 * is not used anywhere else.
574 */
575 new_obj_desc = obj_desc;
576 if (obj_desc->common.reference_count > 1) {
577 status =
578 acpi_ut_copy_iobject_to_iobject(obj_desc, &new_obj_desc,
579 walk_state);
580 if (ACPI_FAILURE(status)) {
581 return_ACPI_STATUS(status);
582 }
583 }
584
585 /*
586 * If there is an object already in this slot, we either
587 * have to delete it, or if this is an argument and there
588 * is an object reference stored there, we have to do
589 * an indirect store!
590 */
591 if (current_obj_desc) {
592 /*
593 * Check for an indirect store if an argument
594 * contains an object reference (stored as an Node).
595 * We don't allow this automatic dereferencing for
596 * locals, since a store to a local should overwrite
597 * anything there, including an object reference.
598 *
599 * If both Arg0 and Local0 contain ref_of (Local4):
600 *
601 * Store (1, Arg0) - Causes indirect store to local4
602 * Store (1, Local0) - Stores 1 in local0, overwriting
603 * the reference to local4
604 * Store (1, de_refof (Local0)) - Causes indirect store to local4
605 *
606 * Weird, but true.
607 */
608 if (type == ACPI_REFCLASS_ARG) {
609 /*
610 * If we have a valid reference object that came from ref_of(),
611 * do the indirect store
612 */
613 if ((ACPI_GET_DESCRIPTOR_TYPE(current_obj_desc) ==
614 ACPI_DESC_TYPE_OPERAND) &&
615 (current_obj_desc->common.type ==
616 ACPI_TYPE_LOCAL_REFERENCE) &&
617 (current_obj_desc->reference.class ==
618 ACPI_REFCLASS_REFOF)) {
619 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
620 "Arg (%p) is an ObjRef(Node), storing in node %p\n",
621 new_obj_desc,
622 current_obj_desc));
623
624 /*
625 * Store this object to the Node (perform the indirect store)
626 * NOTE: No implicit conversion is performed, as per the ACPI
627 * specification rules on storing to Locals/Args.
628 */
629 status =
630 acpi_ex_store_object_to_node(new_obj_desc,
631 current_obj_desc->
632 reference.
633 object,
634 walk_state,
635 ACPI_NO_IMPLICIT_CONVERSION);
636
637 /* Remove local reference if we copied the object above */
638
639 if (new_obj_desc != obj_desc) {
640 acpi_ut_remove_reference(new_obj_desc);
641 }
642
643 return_ACPI_STATUS(status);
644 }
645 }
646
647 /* Delete the existing object before storing the new one */
648
649 acpi_ds_method_data_delete_value(type, index, walk_state);
650 }
651
652 /*
653 * Install the Obj descriptor (*new_obj_desc) into
654 * the descriptor for the Arg or Local.
655 * (increments the object reference count by one)
656 */
657 status =
658 acpi_ds_method_data_set_value(type, index, new_obj_desc,
659 walk_state);
660
661 /* Remove local reference if we copied the object above */
662
663 if (new_obj_desc != obj_desc) {
664 acpi_ut_remove_reference(new_obj_desc);
665 }
666
667 return_ACPI_STATUS(status);
668}
669
670#ifdef ACPI_OBSOLETE_FUNCTIONS
671/*******************************************************************************
672 *
673 * FUNCTION: acpi_ds_method_data_get_type
674 *
675 * PARAMETERS: opcode - Either AML_LOCAL_OP or AML_ARG_OP
676 * index - Which Local or Arg whose type to get
677 * walk_state - Current walk state object
678 *
679 * RETURN: Data type of current value of the selected Arg or Local
680 *
681 * DESCRIPTION: Get the type of the object stored in the Local or Arg
682 *
683 ******************************************************************************/
684
685acpi_object_type
686acpi_ds_method_data_get_type(u16 opcode,
687 u32 index, struct acpi_walk_state *walk_state)
688{
689 acpi_status status;
690 struct acpi_namespace_node *node;
691 union acpi_operand_object *object;
692
693 ACPI_FUNCTION_TRACE(ds_method_data_get_type);
694
695 /* Get the namespace node for the arg/local */
696
697 status = acpi_ds_method_data_get_node(opcode, index, walk_state, &node);
698 if (ACPI_FAILURE(status)) {
699 return_VALUE((ACPI_TYPE_NOT_FOUND));
700 }
701
702 /* Get the object */
703
704 object = acpi_ns_get_attached_object(node);
705 if (!object) {
706
707 /* Uninitialized local/arg, return TYPE_ANY */
708
709 return_VALUE(ACPI_TYPE_ANY);
710 }
711
712 /* Get the object type */
713
714 return_VALUE(object->type);
715}
716#endif